diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 4fc7a5b73..b2aa76450 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -9,12 +9,9 @@ ARG INSTALL_NODE="true" ARG NODE_VERSION="lts/*" RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi -# [Optional] Uncomment this section to install additional OS packages. +# Install additional OS packages RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ - && apt-get -y install --no-install-recommends libtag1-dev ffmpeg - -# [Optional] Uncomment the next line to use go get to install anything else you need -# RUN go get -x + && apt-get -y install --no-install-recommends ffmpeg # [Optional] Uncomment this line to install global node packages. # RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g " 2>&1 diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f339f62f7..c9e4ba2bf 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -4,10 +4,10 @@ "dockerfile": "Dockerfile", "args": { // Update the VARIANT arg to pick a version of Go: 1, 1.15, 1.14 - "VARIANT": "1.24", + "VARIANT": "1.26", // Options "INSTALL_NODE": "true", - "NODE_VERSION": "v20" + "NODE_VERSION": "v24" } }, "workspaceMount": "", @@ -54,12 +54,10 @@ 4533, 4633 ], - // Use 'postCreateCommand' to run commands after the container is created. - // "postCreateCommand": "make setup-dev", // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. "remoteUser": "vscode", "remoteEnv": { "ND_MUSICFOLDER": "./music", "ND_DATAFOLDER": "./data" } -} +} \ No newline at end of file diff --git a/.dockerignore b/.dockerignore index 596aa2955..eb012c6e2 100644 --- a/.dockerignore +++ b/.dockerignore @@ -15,4 +15,5 @@ dist binaries cache music +music.old !Dockerfile \ No newline at end of file diff --git a/.github/actions/download-taglib/action.yml b/.github/actions/download-taglib/action.yml deleted file mode 100644 index ea6de8783..000000000 --- a/.github/actions/download-taglib/action.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: 'Download TagLib' -description: 'Downloads and extracts the TagLib library, adding it to PKG_CONFIG_PATH' -inputs: - version: - description: 'Version of TagLib to download' - required: true - platform: - description: 'Platform to download TagLib for' - default: 'linux-amd64' -runs: - using: 'composite' - steps: - - name: Download TagLib - shell: bash - run: | - mkdir -p /tmp/taglib - cd /tmp - FILE=taglib-${{ inputs.platform }}.tar.gz - wget https://github.com/navidrome/cross-taglib/releases/download/v${{ inputs.version }}/${FILE} - tar -xzf ${FILE} -C taglib - PKG_CONFIG_PREFIX=/tmp/taglib - echo "PKG_CONFIG_PREFIX=${PKG_CONFIG_PREFIX}" >> $GITHUB_ENV - echo "PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:${PKG_CONFIG_PREFIX}/lib/pkgconfig" >> $GITHUB_ENV diff --git a/.github/actions/prepare-docker/action.yml b/.github/actions/prepare-docker/action.yml index 760a0528b..b8cde4aaf 100644 --- a/.github/actions/prepare-docker/action.yml +++ b/.github/actions/prepare-docker/action.yml @@ -53,13 +53,13 @@ runs: - name: Login to Docker Hub if: inputs.hub_username != '' && inputs.hub_password != '' - uses: docker/login-action@v3 + uses: docker/login-action@v4 with: username: ${{ inputs.hub_username }} password: ${{ inputs.hub_password }} - name: Login to GitHub Container Registry - uses: docker/login-action@v3 + uses: docker/login-action@v4 with: registry: ghcr.io username: ${{ github.actor }} @@ -67,12 +67,13 @@ runs: - name: Set up Docker Buildx id: buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Extract metadata for Docker image id: meta - uses: docker/metadata-action@v5 + uses: docker/metadata-action@v6 with: + github-token: ${{ inputs.github_token }} labels: | maintainer=deluan@navidrome.org images: | diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md deleted file mode 100644 index 73ad6e727..000000000 --- a/.github/copilot-instructions.md +++ /dev/null @@ -1,53 +0,0 @@ -# Navidrome Code Guidelines - -This is a music streaming server written in Go with a React frontend. The application manages music libraries, provides streaming capabilities, and offers various features like artist information, artwork handling, and external service integrations. - -## Code Standards - -### Backend (Go) -- Follow standard Go conventions and idioms -- Use context propagation for cancellation signals -- Write unit tests for new functionality using Ginkgo/Gomega -- Use mutex appropriately for concurrent operations -- Implement interfaces for dependencies to facilitate testing - -### Frontend (React) -- Use functional components with hooks -- Follow React best practices for state management -- Implement PropTypes for component properties -- Prefer using React-Admin and Material-UI components -- Icons should be imported from `react-icons` only -- Follow existing patterns for API interaction - -## Repository Structure -- `core/`: Server-side business logic (artwork handling, playback, etc.) -- `ui/`: React frontend components -- `model/`: Data models and repository interfaces -- `server/`: API endpoints and server implementation -- `utils/`: Shared utility functions -- `persistence/`: Database access layer -- `scanner/`: Music library scanning functionality - -## Key Guidelines -1. Maintain cache management patterns for performance -2. Follow the existing concurrency patterns (mutex, atomic) -3. Use the testing framework appropriately (Ginkgo/Gomega for Go) -4. Keep UI components focused and reusable -5. Document configuration options in code -6. Consider performance implications when working with music libraries -7. Follow existing error handling patterns -8. Ensure compatibility with external services (LastFM, Spotify) - -## Development Workflow -- Test changes thoroughly, especially around concurrent operations -- Validate both backend and frontend interactions -- Consider how changes will affect user experience and performance -- Test with different music library sizes and configurations -- Before committing, ALWAYS run `make format lint test`, and make sure there are no issues - -## Important commands -- `make build`: Build the application -- `make test`: Run Go tests -- To run tests for a specific package, use `make test PKG=./pkgname/...` -- `make lintall`: Run linters -- `make format`: Format code \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..10431e909 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,38 @@ +### Description + + +### Related Issues + + +### Type of Change +- [ ] Bug fix +- [ ] New feature +- [ ] Documentation update +- [ ] Refactor +- [ ] Other (please describe): + +### Checklist +Please review and check all that apply: + +- [ ] My code follows the project’s coding style +- [ ] I have tested the changes locally +- [ ] I have added or updated documentation as needed +- [ ] I have added tests that prove my fix/feature works (or explain why not) +- [ ] All existing and new tests pass + +### How to Test + + +### Screenshots / Demos (if applicable) + + +### Additional Notes + + + \ No newline at end of file diff --git a/.github/workflows/download-link-on-pr.yml b/.github/workflows/download-link-on-pr.yml index 38b7b8a86..076f963d4 100644 --- a/.github/workflows/download-link-on-pr.yml +++ b/.github/workflows/download-link-on-pr.yml @@ -8,7 +8,7 @@ jobs: if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' runs-on: ubuntu-latest steps: - - uses: actions/github-script@v3 + - uses: actions/github-script@v7 with: # This snippet is public-domain, taken from # https://github.com/oprypin/nightly.link/blob/master/.github/workflows/pr-comment.yml @@ -19,8 +19,7 @@ jobs: const pull_user_id = ${{github.event.sender.id}}; const issue_number = await (async () => { - const pulls = await github.pulls.list({owner, repo}); - for await (const {data} of github.paginate.iterator(pulls)) { + for await (const {data} of github.paginate.iterator(github.rest.pulls.list, {owner, repo})) { for (const pull of data) { if (pull.head.sha === pull_head_sha && pull.user.id === pull_user_id) { return pull.number; @@ -34,7 +33,7 @@ jobs: return core.error(`No matching pull request found`); } - const {data: {artifacts}} = await github.actions.listWorkflowRunArtifacts({owner, repo, run_id}); + const {data: {artifacts}} = await github.rest.actions.listWorkflowRunArtifacts({owner, repo, run_id}); if (!artifacts.length) { return core.error(`No artifacts found`); } @@ -43,12 +42,12 @@ jobs: body += `\n* [${art.name}.zip](https://nightly.link/${owner}/${repo}/actions/artifacts/${art.id}.zip)`; } - const {data: comments} = await github.issues.listComments({repo, owner, issue_number}); + const {data: comments} = await github.rest.issues.listComments({repo, owner, issue_number}); const existing_comment = comments.find((c) => c.user.login === 'github-actions[bot]'); if (existing_comment) { core.info(`Updating comment ${existing_comment.id}`); - await github.issues.updateComment({repo, owner, comment_id: existing_comment.id, body}); + await github.rest.issues.updateComment({repo, owner, comment_id: existing_comment.id, body}); } else { core.info(`Creating a comment`); - await github.issues.createComment({repo, owner, issue_number, body}); + await github.rest.issues.createComment({repo, owner, issue_number, body}); } diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml index 4ac1b2c6b..6f858a5a7 100644 --- a/.github/workflows/pipeline.yml +++ b/.github/workflows/pipeline.yml @@ -14,7 +14,6 @@ concurrency: cancel-in-progress: true env: - CROSS_TAGLIB_VERSION: "2.0.2-1" IS_RELEASE: ${{ startsWith(github.ref, 'refs/tags/') && 'true' || 'false' }} jobs: @@ -25,7 +24,7 @@ jobs: git_tag: ${{ steps.git-version.outputs.GIT_TAG }} git_sha: ${{ steps.git-version.outputs.GIT_SHA }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 with: fetch-depth: 0 fetch-tags: true @@ -63,22 +62,21 @@ jobs: name: Lint Go code runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - - name: Download TagLib - uses: ./.github/actions/download-taglib + - uses: actions/setup-go@v6 with: - version: ${{ env.CROSS_TAGLIB_VERSION }} + go-version-file: go.mod - name: golangci-lint - uses: golangci/golangci-lint-action@v8 + uses: golangci/golangci-lint-action@v9 with: version: latest problem-matchers: true args: --timeout 2m - name: Run go goimports - run: go run golang.org/x/tools/cmd/goimports@latest -w `find . -name '*.go' | grep -v '_gen.go$'` + run: go run golang.org/x/tools/cmd/goimports@latest -w `find . -name '*.go' | grep -v '_gen.go$' | grep -v '.pb.go$'` - run: go mod tidy - name: Verify no changes from goimports and go mod tidy run: | @@ -88,25 +86,112 @@ jobs: exit 1 fi + - name: Run go generate + run: go generate ./... + - name: Verify no changes from go generate + run: | + git status --porcelain + if [ -n "$(git status --porcelain)" ]; then + echo 'Generated code is out of date. Run "make gen" and commit the changes' + exit 1 + fi + go: name: Test Go code runs-on: ubuntu-latest steps: - name: Check out code into the Go module directory - uses: actions/checkout@v4 + uses: actions/checkout@v6 - - name: Download TagLib - uses: ./.github/actions/download-taglib + - uses: actions/setup-go@v6 with: - version: ${{ env.CROSS_TAGLIB_VERSION }} + go-version-file: go.mod - name: Download dependencies run: go mod download - name: Test + run: go test -shuffle=on -tags netgo,sqlite_fts5 -race ./... -v + + - name: Test ndpgen run: | - pkg-config --define-prefix --cflags --libs taglib # for debugging - go test -shuffle=on -tags netgo -race -cover ./... -v + cd plugins/cmd/ndpgen + go test -shuffle=on -v + go build -o ndpgen . + ./ndpgen --help + + go-windows: + name: Test Go code (Windows) + runs-on: windows-2022 + env: + FFMPEG_VERSION: "7.1" + FFMPEG_REPOSITORY: navidrome/ffmpeg-windows-builds + steps: + - uses: actions/checkout@v6 + + - uses: actions/setup-go@v6 + with: + go-version-file: go.mod + + - uses: msys2/setup-msys2@v2 + with: + msystem: MINGW64 + install: mingw-w64-x86_64-gcc + update: false + + - name: Add mingw64 to PATH + shell: bash + run: echo "C:/msys64/mingw64/bin" >> $GITHUB_PATH + + - name: Cache ffmpeg + id: ffmpeg-cache + uses: actions/cache@v5 + with: + path: C:\ffmpeg + key: ffmpeg-${{ env.FFMPEG_VERSION }}-win64 + + - name: Download ffmpeg + if: steps.ffmpeg-cache.outputs.cache-hit != 'true' + shell: pwsh + run: | + $asset = "ffmpeg-n${env:FFMPEG_VERSION}-latest-win64-gpl-${env:FFMPEG_VERSION}" + $url = "https://github.com/${env:FFMPEG_REPOSITORY}/releases/download/latest/$asset.zip" + Invoke-WebRequest -Uri $url -OutFile ffmpeg.zip + Expand-Archive ffmpeg.zip -DestinationPath C:\ffmpeg-extracted + New-Item -ItemType Directory -Force -Path C:\ffmpeg\bin | Out-Null + Copy-Item "C:\ffmpeg-extracted\$asset\bin\ffmpeg.exe" C:\ffmpeg\bin + Copy-Item "C:\ffmpeg-extracted\$asset\bin\ffprobe.exe" C:\ffmpeg\bin + + - name: Add ffmpeg to PATH + shell: bash + run: echo "C:/ffmpeg/bin" >> $GITHUB_PATH + + - name: Verify toolchain + shell: pwsh + run: | + go version + where.exe gcc + gcc --version + ffmpeg -version + ffprobe -version + + - name: Download dependencies + shell: bash + run: go mod download + + - name: Test + shell: bash + env: + CGO_ENABLED: "1" + run: go test -shuffle=on -tags netgo,sqlite_fts5 ./... -v + + - name: Test ndpgen + shell: pwsh + run: | + cd plugins\cmd\ndpgen + go test -shuffle=on -v + go build -o ndpgen.exe . + .\ndpgen.exe --help js: name: Test JS code @@ -114,10 +199,10 @@ jobs: env: NODE_OPTIONS: "--max_old_space_size=4096" steps: - - uses: actions/checkout@v4 - - uses: actions/setup-node@v4 + - uses: actions/checkout@v6 + - uses: actions/setup-node@v6 with: - node-version: 20 + node-version: 24 cache: "npm" cache-dependency-path: "**/package-lock.json" @@ -145,7 +230,7 @@ jobs: name: Lint i18n files runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - run: | set -e for file in resources/i18n/*.json; do @@ -157,6 +242,8 @@ jobs: exit 1 fi done + - run: ./.github/workflows/validate-translations.sh -v + check-push-enabled: name: Check Docker configuration @@ -170,10 +257,10 @@ jobs: build: name: Build - needs: [js, go, go-lint, i18n-lint, git-version, check-push-enabled] + needs: [js, go, go-windows, go-lint, i18n-lint, git-version, check-push-enabled] strategy: matrix: - platform: [ linux/amd64, linux/arm64, linux/arm/v5, linux/arm/v6, linux/arm/v7, linux/386, darwin/amd64, darwin/arm64, windows/amd64, windows/386 ] + platform: [ linux/amd64, linux/arm64, linux/arm/v5, linux/arm/v6, linux/arm/v7, linux/386, linux/riscv64, darwin/amd64, darwin/arm64, windows/amd64, windows/386 ] runs-on: ubuntu-latest env: IS_LINUX: ${{ startsWith(matrix.platform, 'linux/') && 'true' || 'false' }} @@ -189,7 +276,7 @@ jobs: PLATFORM=$(echo ${{ matrix.platform }} | tr '/' '_') echo "PLATFORM=$PLATFORM" >> $GITHUB_ENV - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Prepare Docker Buildx uses: ./.github/actions/prepare-docker @@ -201,7 +288,7 @@ jobs: hub_password: ${{ secrets.DOCKER_HUB_PASSWORD }} - name: Build Binaries - uses: docker/build-push-action@v6 + uses: docker/build-push-action@v7 with: context: . file: Dockerfile @@ -212,10 +299,9 @@ jobs: build-args: | GIT_SHA=${{ env.GIT_SHA }} GIT_TAG=${{ env.GIT_TAG }} - CROSS_TAGLIB_VERSION=${{ env.CROSS_TAGLIB_VERSION }} - name: Upload Binaries - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: navidrome-${{ env.PLATFORM }} path: ./output @@ -224,7 +310,7 @@ jobs: - name: Build and push image by digest id: push-image if: env.IS_LINUX == 'true' && env.IS_DOCKER_PUSH_CONFIGURED == 'true' && env.IS_ARMV5 == 'false' - uses: docker/build-push-action@v6 + uses: docker/build-push-action@v7 with: context: . file: Dockerfile @@ -233,7 +319,6 @@ jobs: build-args: | GIT_SHA=${{ env.GIT_SHA }} GIT_TAG=${{ env.GIT_TAG }} - CROSS_TAGLIB_VERSION=${{ env.CROSS_TAGLIB_VERSION }} outputs: | type=image,name=${{ steps.docker.outputs.hub_repository }},push-by-digest=true,name-canonical=true,push=${{ steps.docker.outputs.hub_enabled }} type=image,name=ghcr.io/${{ github.repository }},push-by-digest=true,name-canonical=true,push=true @@ -246,7 +331,7 @@ jobs: touch "/tmp/digests/${digest#sha256:}" - name: Upload digest - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 if: env.IS_LINUX == 'true' && env.IS_DOCKER_PUSH_CONFIGURED == 'true' && env.IS_ARMV5 == 'false' with: name: digests-${{ env.PLATFORM }} @@ -254,18 +339,55 @@ jobs: if-no-files-found: error retention-days: 1 - push-manifest: - name: Push Docker manifest + push-manifest-ghcr: + name: Push to GHCR + permissions: + contents: read + packages: write runs-on: ubuntu-latest needs: [build, check-push-enabled] if: needs.check-push-enabled.outputs.is_enabled == 'true' env: REGISTRY_IMAGE: ghcr.io/${{ github.repository }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Download digests - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 + with: + path: /tmp/digests + pattern: digests-* + merge-multiple: true + + - name: Prepare Docker Buildx + uses: ./.github/actions/prepare-docker + id: docker + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + + - name: Create manifest list and push to ghcr.io + working-directory: /tmp/digests + run: | + docker buildx imagetools create $(jq -cr '.tags | map(select(startswith("ghcr.io"))) | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ + $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *) + + - name: Inspect image in ghcr.io + run: | + docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.docker.outputs.version }} + + push-manifest-dockerhub: + name: Push to Docker Hub + runs-on: ubuntu-latest + permissions: + contents: read + needs: [build, check-push-enabled] + if: needs.check-push-enabled.outputs.is_enabled == 'true' && vars.DOCKER_HUB_REPO != '' + continue-on-error: true + steps: + - uses: actions/checkout@v6 + + - name: Download digests + uses: actions/download-artifact@v8 with: path: /tmp/digests pattern: digests-* @@ -280,28 +402,27 @@ jobs: hub_username: ${{ secrets.DOCKER_HUB_USERNAME }} hub_password: ${{ secrets.DOCKER_HUB_PASSWORD }} - - name: Create manifest list and push to ghcr.io - working-directory: /tmp/digests - run: | - docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ - $(printf '${{ env.REGISTRY_IMAGE }}@sha256:%s ' *) - - name: Create manifest list and push to Docker Hub - working-directory: /tmp/digests - if: vars.DOCKER_HUB_REPO != '' - run: | - docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ - $(printf '${{ vars.DOCKER_HUB_REPO }}@sha256:%s ' *) - - - name: Inspect image in ghcr.io - run: | - docker buildx imagetools inspect ${{ env.REGISTRY_IMAGE }}:${{ steps.docker.outputs.version }} + uses: nick-fields/retry@v4 + with: + timeout_minutes: 5 + max_attempts: 3 + retry_wait_seconds: 30 + command: | + cd /tmp/digests + docker buildx imagetools create $(jq -cr '.tags | map(select(startswith("ghcr.io") | not)) | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \ + $(printf 'ghcr.io/${{ github.repository }}@sha256:%s ' *) - name: Inspect image in Docker Hub - if: vars.DOCKER_HUB_REPO != '' run: | docker buildx imagetools inspect ${{ vars.DOCKER_HUB_REPO }}:${{ steps.docker.outputs.version }} + cleanup-digests: + name: Cleanup digest artifacts + runs-on: ubuntu-latest + needs: [push-manifest-ghcr, push-manifest-dockerhub] + if: always() && needs.push-manifest-ghcr.result == 'success' + steps: - name: Delete unnecessary digest artifacts env: GH_TOKEN: ${{ github.token }} @@ -316,9 +437,9 @@ jobs: runs-on: ubuntu-24.04 steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - - uses: actions/download-artifact@v4 + - uses: actions/download-artifact@v8 with: path: ./binaries pattern: navidrome-windows* @@ -337,7 +458,7 @@ jobs: du -h binaries/msi/*.msi - name: Upload MSI files - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: navidrome-windows-installers path: binaries/msi/*.msi @@ -350,12 +471,12 @@ jobs: outputs: package_list: ${{ steps.set-package-list.outputs.package_list }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 with: fetch-depth: 0 fetch-tags: true - - uses: actions/download-artifact@v4 + - uses: actions/download-artifact@v8 with: path: ./binaries pattern: navidrome-* @@ -368,7 +489,7 @@ jobs: run: echo 'RELEASE_FLAGS=--skip=publish --snapshot' >> $GITHUB_ENV - name: Run GoReleaser - uses: goreleaser/goreleaser-action@v6 + uses: goreleaser/goreleaser-action@v7 with: version: '~> v2' args: "release --clean -f release/goreleaser.yml ${{ env.RELEASE_FLAGS }}" @@ -381,7 +502,7 @@ jobs: rm ./dist/*.tar.gz ./dist/*.zip - name: Upload all-packages artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: packages path: dist/navidrome_0* @@ -404,13 +525,13 @@ jobs: item: ${{ fromJson(needs.release.outputs.package_list) }} steps: - name: Download all-packages artifact - uses: actions/download-artifact@v4 + uses: actions/download-artifact@v8 with: name: packages path: ./dist - name: Upload all-packages artifact - uses: actions/upload-artifact@v4 + uses: actions/upload-artifact@v7 with: name: navidrome_linux_${{ matrix.item }} path: dist/navidrome_0*_linux_${{ matrix.item }} diff --git a/.github/workflows/push-translations.sh b/.github/workflows/push-translations.sh new file mode 100755 index 000000000..be153eea8 --- /dev/null +++ b/.github/workflows/push-translations.sh @@ -0,0 +1,138 @@ +#!/bin/sh + +set -e + +I18N_DIR=resources/i18n + +# Normalize JSON for deterministic comparison: +# remove empty/null attributes, sort keys alphabetically +process_json() { + jq 'walk(if type == "object" then with_entries(select(.value != null and .value != "" and .value != [] and .value != {})) | to_entries | sort_by(.key) | from_entries else . end)' "$1" +} + +# Get list of all languages configured in the POEditor project +get_language_list() { + curl -s -X POST https://api.poeditor.com/v2/languages/list \ + -d api_token="${POEDITOR_APIKEY}" \ + -d id="${POEDITOR_PROJECTID}" +} + +# Extract language name from the language list JSON given a language code +get_language_name() { + lang_code="$1" + lang_list="$2" + echo "$lang_list" | jq -r ".result.languages[] | select(.code == \"$lang_code\") | .name" +} + +# Extract language code from a file path (e.g., "resources/i18n/fr.json" -> "fr") +get_lang_code() { + filepath="$1" + filename=$(basename "$filepath") + echo "${filename%.*}" +} + +# Export the current translation for a language from POEditor (v2 API) +export_language() { + lang_code="$1" + response=$(curl -s -X POST https://api.poeditor.com/v2/projects/export \ + -d api_token="${POEDITOR_APIKEY}" \ + -d id="${POEDITOR_PROJECTID}" \ + -d language="$lang_code" \ + -d type="key_value_json") + + url=$(echo "$response" | jq -r '.result.url') + if [ -z "$url" ] || [ "$url" = "null" ]; then + echo "Failed to export $lang_code: $response" >&2 + return 1 + fi + echo "$url" +} + +# Flatten nested JSON to POEditor languages/update format. +# POEditor uses term + context pairs, where: +# term = the leaf key name +# context = the parent path as "key1"."key2"."key3" (empty for root keys) +flatten_to_poeditor() { + jq -c '[paths(scalars) as $p | + { + "term": ($p | last | tostring), + "context": (if ($p | length) > 1 then ($p[:-1] | map("\"" + tostring + "\"") | join(".")) else "" end), + "translation": {"content": getpath($p)} + } + ]' "$1" +} + +# Update translations for a language in POEditor via languages/update API +update_language() { + lang_code="$1" + file="$2" + + flatten_to_poeditor "$file" > /tmp/poeditor_data.json + response=$(curl -s -X POST https://api.poeditor.com/v2/languages/update \ + -d api_token="${POEDITOR_APIKEY}" \ + -d id="${POEDITOR_PROJECTID}" \ + -d language="$lang_code" \ + --data-urlencode data@/tmp/poeditor_data.json) + rm -f /tmp/poeditor_data.json + + status=$(echo "$response" | jq -r '.response.status') + if [ "$status" != "success" ]; then + echo "Failed to update $lang_code: $response" >&2 + return 1 + fi + + parsed=$(echo "$response" | jq -r '.result.translations.parsed') + added=$(echo "$response" | jq -r '.result.translations.added') + updated=$(echo "$response" | jq -r '.result.translations.updated') + echo " Translations - parsed: $parsed, added: $added, updated: $updated" +} + +# --- Main --- + +if [ $# -eq 0 ]; then + echo "Usage: $0 [file2] ..." + echo "No files specified. Nothing to do." + exit 0 +fi + +lang_list=$(get_language_list) +upload_count=0 + +for file in "$@"; do + if [ ! -f "$file" ]; then + echo "Warning: File not found: $file, skipping" + continue + fi + + lang_code=$(get_lang_code "$file") + lang_name=$(get_language_name "$lang_code" "$lang_list") + + if [ -z "$lang_name" ]; then + echo "Warning: Language code '$lang_code' not found in POEditor, skipping $file" + continue + fi + + echo "Processing $lang_name ($lang_code)..." + + # Export current state from POEditor + url=$(export_language "$lang_code") + curl -sSL "$url" -o poeditor_export.json + + # Normalize both files for comparison + process_json "$file" > local_normalized.json + process_json poeditor_export.json > remote_normalized.json + + # Compare normalized versions + if diff -q local_normalized.json remote_normalized.json > /dev/null 2>&1; then + echo " No differences, skipping" + else + echo " Differences found, updating POEditor..." + update_language "$lang_code" "$file" + upload_count=$((upload_count + 1)) + fi + + rm -f poeditor_export.json local_normalized.json remote_normalized.json +done + +echo "" +echo "Done. Updated $upload_count translation(s) in POEditor." diff --git a/.github/workflows/push-translations.yml b/.github/workflows/push-translations.yml new file mode 100644 index 000000000..f7cf00621 --- /dev/null +++ b/.github/workflows/push-translations.yml @@ -0,0 +1,32 @@ +name: POEditor export + +on: + push: + branches: + - master + paths: + - 'resources/i18n/*.json' + +jobs: + push-translations: + runs-on: ubuntu-latest + if: ${{ github.repository_owner == 'navidrome' }} + steps: + - uses: actions/checkout@v6 + with: + fetch-depth: 2 + + - name: Detect changed translation files + id: changed + run: | + CHANGED_FILES=$(git diff --name-only HEAD~1 HEAD -- 'resources/i18n/*.json' | tr '\n' ' ') + echo "files=$CHANGED_FILES" >> $GITHUB_OUTPUT + echo "Changed translation files: $CHANGED_FILES" + + - name: Push translations to POEditor + if: ${{ steps.changed.outputs.files != '' }} + env: + POEDITOR_APIKEY: ${{ secrets.POEDITOR_APIKEY }} + POEDITOR_PROJECTID: ${{ secrets.POEDITOR_PROJECTID }} + run: | + .github/workflows/push-translations.sh ${{ steps.changed.outputs.files }} diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index c8bf3ae7f..33c8fadbd 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -12,7 +12,7 @@ jobs: pull-requests: write runs-on: ubuntu-latest steps: - - uses: dessant/lock-threads@v5 + - uses: dessant/lock-threads@v6 with: process-only: 'issues, prs' issue-inactive-days: 120 @@ -28,7 +28,7 @@ jobs: This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. - - uses: actions/stale@v9 + - uses: actions/stale@v10 with: operations-per-run: 999 days-before-issue-stale: 180 diff --git a/.github/workflows/update-translations.yml b/.github/workflows/update-translations.yml index 70a9de3d8..8fe0b5379 100644 --- a/.github/workflows/update-translations.yml +++ b/.github/workflows/update-translations.yml @@ -8,7 +8,7 @@ jobs: runs-on: ubuntu-latest if: ${{ github.repository_owner == 'navidrome' }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Get updated translations id: poeditor env: @@ -24,7 +24,7 @@ jobs: git status --porcelain git diff - name: Create Pull Request - uses: peter-evans/create-pull-request@v7 + uses: peter-evans/create-pull-request@v8 with: token: ${{ secrets.PAT }} author: "navidrome-bot " diff --git a/.github/workflows/validate-translations.sh b/.github/workflows/validate-translations.sh new file mode 100755 index 000000000..a6b346e78 --- /dev/null +++ b/.github/workflows/validate-translations.sh @@ -0,0 +1,236 @@ +#!/bin/bash + +# validate-translations.sh +# +# This script validates the structure of JSON translation files by comparing them +# against the reference English translation file (ui/src/i18n/en.json). +# +# The script performs the following validations: +# 1. JSON syntax validation using jq +# 2. Structural validation - ensures all keys from English file are present +# 3. Reports missing keys (translation incomplete) +# 4. Reports extra keys (keys not in English reference, possibly deprecated) +# 5. Emits GitHub Actions annotations for CI/CD integration +# +# Usage: +# ./validate-translations.sh +# +# Environment Variables: +# EN_FILE - Path to reference English file (default: ui/src/i18n/en.json) +# TRANSLATION_DIR - Directory containing translation files (default: resources/i18n) +# +# Exit codes: +# 0 - All translations are valid +# 1 - One or more translations have structural issues +# +# GitHub Actions Integration: +# The script outputs GitHub Actions annotations using ::error and ::warning +# format that will be displayed in PR checks and workflow summaries. + +# Script to validate JSON translation files structure against en.json +set -e + +# Path to the reference English translation file +EN_FILE="${EN_FILE:-ui/src/i18n/en.json}" +TRANSLATION_DIR="${TRANSLATION_DIR:-resources/i18n}" +VERBOSE=false + +# Parse command line arguments +while [[ $# -gt 0 ]]; do + case "$1" in + -v|--verbose) + VERBOSE=true + shift + ;; + -h|--help) + echo "Usage: $0 [options]" + echo "" + echo "Validates JSON translation files structure against English reference file." + echo "" + echo "Options:" + echo " -h, --help Show this help message" + echo " -v, --verbose Show detailed output (default: only show errors)" + echo "" + echo "Environment Variables:" + echo " EN_FILE Path to reference English file (default: ui/src/i18n/en.json)" + echo " TRANSLATION_DIR Directory with translation files (default: resources/i18n)" + echo "" + echo "Examples:" + echo " $0 # Validate all translation files (quiet mode)" + echo " $0 -v # Validate with detailed output" + echo " EN_FILE=custom/en.json $0 # Use custom reference file" + echo " TRANSLATION_DIR=custom/i18n $0 # Use custom translations directory" + exit 0 + ;; + *) + echo "Unknown option: $1" >&2 + echo "Use --help for usage information" >&2 + exit 1 + ;; + esac +done + +# Color codes for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' # No Color + +if [[ "$VERBOSE" == "true" ]]; then + echo "Validating translation files structure against ${EN_FILE}..." +fi + +# Check if English reference file exists +if [[ ! -f "$EN_FILE" ]]; then + echo "::error::Reference file $EN_FILE not found" + exit 1 +fi + +# Function to extract all JSON keys from a file, creating a flat list of dot-separated paths +extract_keys() { + local file="$1" + jq -r 'paths(scalars) as $p | $p | join(".")' "$file" 2>/dev/null | sort +} + +# Function to extract all non-empty string keys (to identify structural issues) +extract_structure_keys() { + local file="$1" + # Get only keys where values are not empty strings + jq -r 'paths(scalars) as $p | select(getpath($p) != "") | $p | join(".")' "$file" 2>/dev/null | sort +} + +# Function to validate a single translation file +validate_translation() { + local translation_file="$1" + local filename=$(basename "$translation_file") + local has_errors=false + local verbose=${2:-false} + + if [[ "$verbose" == "true" ]]; then + echo "Validating $filename..." + fi + + # First validate JSON syntax + if ! jq empty "$translation_file" 2>/dev/null; then + echo "::error file=$translation_file::Invalid JSON syntax" + echo -e "${RED}✗ $filename has invalid JSON syntax${NC}" + return 1 + fi + + # Extract all keys from both files (for statistics) + local en_keys_file=$(mktemp) + local translation_keys_file=$(mktemp) + + extract_keys "$EN_FILE" > "$en_keys_file" + extract_keys "$translation_file" > "$translation_keys_file" + + # Extract only non-empty structure keys (to validate structural issues) + local en_structure_file=$(mktemp) + local translation_structure_file=$(mktemp) + + extract_structure_keys "$EN_FILE" > "$en_structure_file" + extract_structure_keys "$translation_file" > "$translation_structure_file" + + # Find structural issues: keys in translation not in English (misplaced) + local extra_keys=$(comm -13 "$en_keys_file" "$translation_keys_file") + + # Find missing keys (for statistics only) + local missing_keys=$(comm -23 "$en_keys_file" "$translation_keys_file") + + # Count keys for statistics + local total_en_keys=$(wc -l < "$en_keys_file") + local total_translation_keys=$(wc -l < "$translation_keys_file") + local missing_count=0 + local extra_count=0 + + if [[ -n "$missing_keys" ]]; then + missing_count=$(echo "$missing_keys" | grep -c '^' || echo 0) + fi + + if [[ -n "$extra_keys" ]]; then + extra_count=$(echo "$extra_keys" | grep -c '^' || echo 0) + has_errors=true + fi + + # Report extra/misplaced keys (these are structural issues) + if [[ -n "$extra_keys" ]]; then + if [[ "$verbose" == "true" ]]; then + echo -e "${YELLOW}Misplaced keys in $filename ($extra_count):${NC}" + fi + + while IFS= read -r key; do + # Try to find the line number + line=$(grep -n "\"$(echo "$key" | sed 's/.*\.//')" "$translation_file" | head -1 | cut -d: -f1) + line=${line:-1} # Default to line 1 if not found + + echo "::error file=$translation_file,line=$line::Misplaced key: $key" + + if [[ "$verbose" == "true" ]]; then + echo " + $key (line ~$line)" + fi + done <<< "$extra_keys" + fi + + # Clean up temp files + rm -f "$en_keys_file" "$translation_keys_file" "$en_structure_file" "$translation_structure_file" + + # Print statistics + if [[ "$verbose" == "true" ]]; then + echo " Keys: $total_translation_keys/$total_en_keys (Missing: $missing_count, Extra/Misplaced: $extra_count)" + + if [[ "$has_errors" == "true" ]]; then + echo -e "${RED}✗ $filename has structural issues${NC}" + else + echo -e "${GREEN}✓ $filename structure is valid${NC}" + fi + elif [[ "$has_errors" == "true" ]]; then + echo -e "${RED}✗ $filename has structural issues (Extra/Misplaced: $extra_count)${NC}" + fi + + return $([[ "$has_errors" == "true" ]] && echo 1 || echo 0) +} + +# Main validation loop +validation_failed=false +total_files=0 +failed_files=0 +valid_files=0 + +for translation_file in "$TRANSLATION_DIR"/*.json; do + if [[ -f "$translation_file" ]]; then + total_files=$((total_files + 1)) + if ! validate_translation "$translation_file" "$VERBOSE"; then + validation_failed=true + failed_files=$((failed_files + 1)) + else + valid_files=$((valid_files + 1)) + fi + + if [[ "$VERBOSE" == "true" ]]; then + echo "" # Add spacing between files + fi + fi +done + +# Summary +if [[ "$VERBOSE" == "true" ]]; then + echo "=========================================" + echo "Translation Validation Summary:" + echo " Total files: $total_files" + echo " Valid files: $valid_files" + echo " Files with structural issues: $failed_files" + echo "=========================================" +fi + +if [[ "$validation_failed" == "true" ]]; then + if [[ "$VERBOSE" == "true" ]]; then + echo -e "${RED}Translation validation failed - $failed_files file(s) have structural issues${NC}" + else + echo -e "${RED}Translation validation failed - $failed_files/$total_files file(s) have structural issues${NC}" + fi + exit 1 +elif [[ "$VERBOSE" == "true" ]]; then + echo -e "${GREEN}All translation files are structurally valid${NC}" +fi + +exit 0 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 4e32e14fd..fc8eaac69 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ /navidrome /iTunes*.xml /tmp +/bin data/* vendor/*/ wiki @@ -16,14 +17,26 @@ master.zip testDB cache/* *.swp +coverage.out dist music +music.old *.db* .gitinfo docker-compose.yml !contrib/docker-compose.yml binaries -navidrome-master +navidrome-* +/ndpgen AGENTS.md +.github/prompts +.github/instructions +.github/git-commit-instructions.md *.exe -bin/ \ No newline at end of file +*.test +*.wasm +*.ndp +openspec/ +.agents +go.work* +.worktrees/ diff --git a/.golangci.yml b/.golangci.yml index 996dafccb..28eb375a5 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -2,6 +2,7 @@ version: "2" run: build-tags: - netgo + - sqlite_fts5 linters: enable: - asasalint @@ -39,6 +40,11 @@ linters: enable: - nilness exclusions: + rules: + - linters: + - gosec + path: _test\.go + text: "G703" generated: lax presets: - comments @@ -49,6 +55,7 @@ linters: - third_party$ - builtin$ - examples$ + - node_modules formatters: exclusions: generated: lax @@ -56,3 +63,4 @@ formatters: - third_party$ - builtin$ - examples$ + - node_modules diff --git a/.nvmrc b/.nvmrc index 9a2a0e219..54c65116f 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -v20 +v24 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f2631f597..71c13b497 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ Before submitting a pull request, ensure that you go through the following: ### Commit Conventions Each commit message must adhere to the following format: ``` -(scope): - +(scope): [optional body] ``` diff --git a/Dockerfile b/Dockerfile index 4b4c3d18c..ad1e2a41c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,11 +1,11 @@ FROM --platform=$BUILDPLATFORM ghcr.io/crazy-max/osxcross:14.5-debian AS osxcross ######################################################################################################################## -### Build xx (orignal image: tonistiigi/xx) -FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/alpine:3.21 AS xx-build +### Build xx (original image: tonistiigi/xx) +FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/alpine:3.20 AS xx-build -# v1.5.0 -ENV XX_VERSION=b4e4c451c778822e6742bfc9d9a91d7c7d885c8a +# v1.9.0 +ENV XX_VERSION=a5592eab7a57895e8d385394ff12241bc65ecd50 RUN apk add -U --no-cache git RUN git clone https://github.com/tonistiigi/xx && \ @@ -24,24 +24,6 @@ RUN cd /out && \ FROM scratch AS xx COPY --from=xx-build /out/ /usr/bin/ -######################################################################################################################## -### Get TagLib -FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/alpine:3.21 AS taglib-build -ARG TARGETPLATFORM -ARG CROSS_TAGLIB_VERSION=2.0.2-1 -ENV CROSS_TAGLIB_RELEASES_URL=https://github.com/navidrome/cross-taglib/releases/download/v${CROSS_TAGLIB_VERSION}/ - -RUN </dev/null | head -1) && \ + [ -n "$target" ] && ln -sf "$target" /usr/lib/$lib.so; \ + done -# Copy navidrome binary -COPY --from=build /out/navidrome /app/ +# Copy navidrome binary (musl build for Docker, enables native libwebp) +COPY --from=build-alpine /out/navidrome /app/ VOLUME ["/data", "/music"] ENV ND_MUSICFOLDER=/music ENV ND_DATAFOLDER=/data ENV ND_CONFIGFILE=/data/navidrome.toml ENV ND_PORT=4533 -ENV GODEBUG="asyncpreemptoff=1" +ENV ND_ENABLEWEBPENCODING=true RUN touch /.nddockerenv EXPOSE ${ND_PORT} WORKDIR /app +ENV PATH="/app:${PATH}" ENTRYPOINT ["/app/navidrome"] diff --git a/Makefile b/Makefile index 8425f6998..e303017c7 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,12 @@ GO_VERSION=$(shell grep "^go " go.mod | cut -f 2 -d ' ') NODE_VERSION=$(shell cat .nvmrc) +comma:=, +GO_BUILD_TAGS=netgo,sqlite_fts5$(if $(EXTRA_BUILD_TAGS),$(comma)$(EXTRA_BUILD_TAGS)) + +# Set global environment variables, required for most targets +export ND_ENABLEINSIGHTSCOLLECTOR=false + ifneq ("$(wildcard .git/HEAD)","") GIT_SHA=$(shell git rev-parse --short HEAD) GIT_TAG=$(shell git describe --tags `git rev-list --tags --max-count=1`)-SNAPSHOT @@ -9,52 +15,85 @@ GIT_SHA=source_archive GIT_TAG=$(patsubst navidrome-%,v%,$(notdir $(PWD)))-SNAPSHOT endif -SUPPORTED_PLATFORMS ?= linux/amd64,linux/arm64,linux/arm/v5,linux/arm/v6,linux/arm/v7,linux/386,darwin/amd64,darwin/arm64,windows/amd64,windows/386 +SUPPORTED_PLATFORMS ?= linux/amd64,linux/arm64,linux/arm/v5,linux/arm/v6,linux/arm/v7,linux/386,linux/riscv64,darwin/amd64,darwin/arm64,windows/amd64,windows/386 IMAGE_PLATFORMS ?= $(shell echo $(SUPPORTED_PLATFORMS) | tr ',' '\n' | grep "linux" | grep -v "arm/v5" | tr '\n' ',' | sed 's/,$$//') PLATFORMS ?= $(SUPPORTED_PLATFORMS) DOCKER_TAG ?= deluan/navidrome:develop -# Taglib version to use in cross-compilation, from https://github.com/navidrome/cross-taglib -CROSS_TAGLIB_VERSION ?= 2.0.2-1 +GOLANGCI_LINT_VERSION ?= v2.12.0 UI_SRC_FILES := $(shell find ui -type f -not -path "ui/build/*" -not -path "ui/node_modules/*") -setup: check_env download-deps setup-git ##@1_Run_First Install dependencies and prepare development environment +setup: check_env download-deps install-golangci-lint setup-git ##@1_Run_First Install dependencies and prepare development environment @echo Downloading Node dependencies... @(cd ./ui && npm ci) .PHONY: setup dev: check_env ##@Development Start Navidrome in development mode, with hot-reload for both frontend and backend - ND_ENABLEINSIGHTSCOLLECTOR="false" npx foreman -j Procfile.dev -p 4533 start + npx foreman -j Procfile.dev -p 4533 start .PHONY: dev server: check_go_env buildjs ##@Development Start the backend in development mode - @ND_ENABLEINSIGHTSCOLLECTOR="false" go tool reflex -d none -c reflex.conf + go tool reflex -d none -c reflex.conf .PHONY: server +stop: ##@Development Stop development servers (UI and backend) + @echo "Stopping development servers..." + @-pkill -f "vite" + @-pkill -f "go tool reflex.*reflex.conf" + @-pkill -f "go run.*netgo" + @echo "Development servers stopped." +.PHONY: stop + watch: ##@Development Start Go tests in watch mode (re-run when code changes) - go tool ginkgo watch -tags=netgo -notify ./... + go tool ginkgo watch -tags=$(GO_BUILD_TAGS) -notify ./... .PHONY: watch PKG ?= ./... -test: ##@Development Run Go tests - go test -tags netgo $(PKG) +test: ##@Development Run Go tests. Use PKG variable to specify packages to test, e.g. make test PKG=./server + go test -tags $(GO_BUILD_TAGS) $(PKG) .PHONY: test -testrace: ##@Development Run Go tests with race detector - go test -tags netgo -race -shuffle=on ./... -.PHONY: test +test-ndpgen: ##@Development Run tests for ndpgen plugin + cd plugins/cmd/ndpgen && go test ./...... +.PHONY: test-ndpgen -testall: testrace ##@Development Run Go and JS tests - @(cd ./ui && npm run test) +testall: test test-ndpgen test-i18n test-js ##@Development Run Go and JS tests .PHONY: testall +test-race: ##@Development Run Go tests with race detector + go test -tags $(GO_BUILD_TAGS) -race -shuffle=on $(PKG) +.PHONY: test-race + +test-js: ##@Development Run JS tests + @(cd ./ui && npm run test) +.PHONY: test-js + +test-i18n: ##@Development Validate all translations files + ./.github/workflows/validate-translations.sh +.PHONY: test-i18n + install-golangci-lint: ##@Development Install golangci-lint if not present - @PATH=$$PATH:./bin which golangci-lint > /dev/null || (echo "Installing golangci-lint..." && curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s v2.1.6) + @INSTALL=false; \ + if PATH=./bin:$$PATH which golangci-lint > /dev/null 2>&1; then \ + CURRENT_VERSION=$$(PATH=./bin:$$PATH golangci-lint version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -n1); \ + REQUIRED_VERSION=$$(echo "$(GOLANGCI_LINT_VERSION)" | sed 's/^v//'); \ + if [ "$$CURRENT_VERSION" != "$$REQUIRED_VERSION" ]; then \ + echo "Found golangci-lint $$CURRENT_VERSION, but $$REQUIRED_VERSION is required. Reinstalling..."; \ + rm -f ./bin/golangci-lint; \ + INSTALL=true; \ + fi; \ + else \ + INSTALL=true; \ + fi; \ + if [ "$$INSTALL" = "true" ]; then \ + echo "Installing golangci-lint $(GOLANGCI_LINT_VERSION)..."; \ + curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s $(GOLANGCI_LINT_VERSION); \ + fi .PHONY: install-golangci-lint lint: install-golangci-lint ##@Development Lint Go code - PATH=$$PATH:./bin golangci-lint run -v --timeout 5m + PATH=./bin:$$PATH golangci-lint run --timeout 5m .PHONY: lint lintall: lint ##@Development Lint Go and JS code @@ -64,14 +103,23 @@ lintall: lint ##@Development Lint Go and JS code format: ##@Development Format code @(cd ./ui && npm run prettier) - @go tool goimports -w `find . -name '*.go' | grep -v _gen.go$$` + @go tool goimports -w `find . -name '*.go' | grep -v _gen.go$$ | grep -v .pb.go$$` @go mod tidy .PHONY: format wire: check_go_env ##@Development Update Dependency Injection - go tool wire gen -tags=netgo ./... + go tool wire gen -tags="$$(echo '$(GO_BUILD_TAGS)' | tr ',' ' ')" ./... .PHONY: wire +gen: check_go_env ##@Development Run go generate for code generation + go generate ./... + cd plugins/cmd/ndpgen && go run . -host-wrappers -input=../../host -package=host + cd plugins/cmd/ndpgen && go run . -input=../../host -output=../../pdk -go -python -rust + cd plugins/cmd/ndpgen && go run . -capability-only -input=../../capabilities -output=../../pdk -go -rust + cd plugins/cmd/ndpgen && go run . -schemas -input=../../capabilities + go mod tidy -C plugins/pdk/go +.PHONY: gen + snapshots: ##@Development Update (GoLang) Snapshot tests UPDATE_SNAPSHOTS=true go tool ginkgo ./server/subsonic/responses/... .PHONY: snapshots @@ -96,14 +144,14 @@ setup-git: ##@Development Setup Git hooks (pre-commit and pre-push) .PHONY: setup-git build: check_go_env buildjs ##@Build Build the project - go build -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=netgo + go build -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=$(GO_BUILD_TAGS) .PHONY: build buildall: deprecated build .PHONY: buildall debug-build: check_go_env buildjs ##@Build Build the project (with remote debug on) - go build -gcflags="all=-N -l" -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=netgo + go build -gcflags="all=-N -l" -ldflags="-X github.com/navidrome/navidrome/consts.gitSha=$(GIT_SHA) -X github.com/navidrome/navidrome/consts.gitTag=$(GIT_TAG)" -tags=$(GO_BUILD_TAGS) .PHONY: debug-build buildjs: check_node_env ui/build/index.html ##@Build Build only frontend @@ -128,7 +176,6 @@ docker-build: ##@Cross_Compilation Cross-compile for any supported platform (che --platform $(PLATFORMS) \ --build-arg GIT_TAG=${GIT_TAG} \ --build-arg GIT_SHA=${GIT_SHA} \ - --build-arg CROSS_TAGLIB_VERSION=${CROSS_TAGLIB_VERSION} \ --output "./binaries" --target binary . .PHONY: docker-build @@ -140,7 +187,6 @@ docker-image: ##@Cross_Compilation Build Docker image, tagged as `deluan/navidro --platform $(IMAGE_PLATFORMS) \ --build-arg GIT_TAG=${GIT_TAG} \ --build-arg GIT_SHA=${GIT_SHA} \ - --build-arg CROSS_TAGLIB_VERSION=${CROSS_TAGLIB_VERSION} \ --tag $(DOCKER_TAG) . .PHONY: docker-image @@ -153,6 +199,20 @@ docker-msi: ##@Cross_Compilation Build MSI installer for Windows @du -h binaries/msi/*.msi .PHONY: docker-msi +docker-run: ##@Development Run a Navidrome Docker image. Usage: make docker-run tag= + @if [ -z "$(tag)" ]; then echo "Usage: make docker-run tag="; exit 1; fi + @TAG_DIR="tmp/$$(echo '$(tag)' | tr '/:' '_')"; mkdir -p "$$TAG_DIR"; \ + VOLUMES="-v $(PWD)/$$TAG_DIR:/data"; \ + if [ -f navidrome.toml ]; then \ + VOLUMES="$$VOLUMES -v $(PWD)/navidrome.toml:/data/navidrome.toml:ro"; \ + MUSIC_FOLDER=$$(grep '^MusicFolder' navidrome.toml | head -n1 | sed 's/.*= *"//' | sed 's/".*//'); \ + if [ -n "$$MUSIC_FOLDER" ] && [ -d "$$MUSIC_FOLDER" ]; then \ + VOLUMES="$$VOLUMES -v $$MUSIC_FOLDER:/music:ro"; \ + fi; \ + fi; \ + echo "Running: docker run --rm -p 4533:4533 $$VOLUMES $(tag)"; docker run --rm -p 4533:4533 $$VOLUMES $(tag) +.PHONY: docker-run + package: docker-build ##@Cross_Compilation Create binaries and packages for ALL supported platforms @if [ -z `which goreleaser` ]; then echo "Please install goreleaser first: https://goreleaser.com/install/"; exit 1; fi goreleaser release -f release/goreleaser.yml --clean --skip=publish --snapshot @@ -170,6 +230,39 @@ get-music: ##@Development Download some free music from Navidrome's demo instanc .PHONY: get-music +########################################## +#### Worktrees + +WORKTREES_DIR := .worktrees + +wt: check_go_env ##@Worktrees Create and setup a git worktree. Usage: make wt name=feature-name [go=1] + @if [ -z "${name}" ]; then echo "Usage: make wt name= [go=1]"; exit 1; fi + @mkdir -p $(WORKTREES_DIR) + @echo "Creating worktree for branch '${name}'..." + @git worktree add $(WORKTREES_DIR)/${name} -b ${name} 2>/dev/null || \ + git worktree add $(WORKTREES_DIR)/${name} ${name} + @if [ -n "${go}" ]; then \ + ./scripts/setup-worktree.sh $(WORKTREES_DIR)/${name} --go-only; \ + else \ + ./scripts/setup-worktree.sh $(WORKTREES_DIR)/${name}; \ + fi + @echo "\nWorktree ready at $(WORKTREES_DIR)/${name}" + @echo " cd $(WORKTREES_DIR)/${name}" +.PHONY: wt + +rm-wt: ##@Worktrees Remove a git worktree. Usage: make rm-wt name=feature-name + @if [ -z "${name}" ]; then echo "Usage: make rm-wt name="; exit 1; fi + @if [ ! -d "$(WORKTREES_DIR)/${name}" ]; then echo "Worktree '${name}' not found in $(WORKTREES_DIR)/"; exit 1; fi + @echo "Removing worktree '${name}'..." + @git worktree remove --force $(WORKTREES_DIR)/${name} + @echo "Worktree '${name}' removed." + @echo "Note: branch '${name}' still exists. Delete it with: git branch -D ${name}" +.PHONY: rm-wt + +ls-wt: ##@Worktrees List all active git worktrees + @git worktree list +.PHONY: ls-wt + ########################################## #### Miscellaneous diff --git a/adapters/deezer/client.go b/adapters/deezer/client.go new file mode 100644 index 000000000..d51f65dd9 --- /dev/null +++ b/adapters/deezer/client.go @@ -0,0 +1,217 @@ +package deezer + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "strconv" + "strings" + + "github.com/microcosm-cc/bluemonday" + "github.com/navidrome/navidrome/log" +) + +const apiBaseURL = "https://api.deezer.com" +const authBaseURL = "https://auth.deezer.com" + +var ( + ErrNotFound = errors.New("deezer: not found") +) + +type httpDoer interface { + Do(req *http.Request) (*http.Response, error) +} + +type client struct { + httpDoer httpDoer + jwt jwtToken +} + +func newClient(hc httpDoer) *client { + return &client{ + httpDoer: hc, + } +} + +func (c *client) searchArtists(ctx context.Context, name string, limit int) ([]Artist, error) { + params := url.Values{} + params.Add("q", name) + params.Add("order", "RANKING") + params.Add("limit", strconv.Itoa(limit)) + req, err := http.NewRequestWithContext(ctx, "GET", apiBaseURL+"/search/artist", nil) + if err != nil { + return nil, err + } + req.URL.RawQuery = params.Encode() + + var results SearchArtistResults + err = c.makeRequest(req, &results) + if err != nil { + return nil, err + } + + if len(results.Data) == 0 { + return nil, ErrNotFound + } + return results.Data, nil +} + +func (c *client) makeRequest(req *http.Request, response any) error { + log.Trace(req.Context(), fmt.Sprintf("Sending Deezer %s request", req.Method), "url", req.URL) + resp, err := c.httpDoer.Do(req) + if err != nil { + return err + } + + defer resp.Body.Close() + data, err := io.ReadAll(resp.Body) + if err != nil { + return err + } + + if resp.StatusCode != 200 { + return c.parseError(data) + } + + return json.Unmarshal(data, response) +} + +func (c *client) parseError(data []byte) error { + var deezerError Error + err := json.Unmarshal(data, &deezerError) + if err != nil { + return err + } + return fmt.Errorf("deezer error(%d): %s", deezerError.Error.Code, deezerError.Error.Message) +} + +func (c *client) getRelatedArtists(ctx context.Context, artistID int) ([]Artist, error) { + req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/artist/%d/related", apiBaseURL, artistID), nil) + if err != nil { + return nil, err + } + + var results RelatedArtists + err = c.makeRequest(req, &results) + if err != nil { + return nil, err + } + + return results.Data, nil +} + +func (c *client) getTopTracks(ctx context.Context, artistID int, limit int) ([]Track, error) { + params := url.Values{} + params.Add("limit", strconv.Itoa(limit)) + req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("%s/artist/%d/top", apiBaseURL, artistID), nil) + if err != nil { + return nil, err + } + req.URL.RawQuery = params.Encode() + + var results TopTracks + err = c.makeRequest(req, &results) + if err != nil { + return nil, err + } + + return results.Data, nil +} + +const pipeAPIURL = "https://pipe.deezer.com/api" + +var strictPolicy = bluemonday.StrictPolicy() + +func (c *client) getArtistBio(ctx context.Context, artistID int, lang string) (string, error) { + jwt, err := c.getJWT(ctx) + if err != nil { + return "", fmt.Errorf("deezer: failed to get JWT: %w", err) + } + + query := map[string]any{ + "operationName": "ArtistBio", + "variables": map[string]any{ + "artistId": strconv.Itoa(artistID), + }, + "query": `query ArtistBio($artistId: String!) { + artist(artistId: $artistId) { + bio { + full + } + } + }`, + } + + body, err := json.Marshal(query) + if err != nil { + return "", err + } + + req, err := http.NewRequestWithContext(ctx, "POST", pipeAPIURL, bytes.NewReader(body)) + if err != nil { + return "", err + } + + req.Header.Set("Content-Type", "application/json") + req.Header.Set("Accept-Language", lang) + req.Header.Set("Authorization", "Bearer "+jwt) + + log.Trace(ctx, "Fetching Deezer artist biography via GraphQL", "artistId", artistID, "language", lang) + resp, err := c.httpDoer.Do(req) + if err != nil { + return "", err + } + defer resp.Body.Close() + + if resp.StatusCode != 200 { + return "", fmt.Errorf("deezer: failed to fetch biography: %s", resp.Status) + } + + data, err := io.ReadAll(resp.Body) + if err != nil { + return "", err + } + + type graphQLResponse struct { + Data struct { + Artist struct { + Bio struct { + Full string `json:"full"` + } `json:"bio"` + } `json:"artist"` + } `json:"data"` + Errors []struct { + Message string `json:"message"` + } + } + + var result graphQLResponse + if err := json.Unmarshal(data, &result); err != nil { + return "", fmt.Errorf("deezer: failed to parse GraphQL response: %w", err) + } + + if len(result.Errors) > 0 { + var errs []error + for m := range result.Errors { + errs = append(errs, errors.New(result.Errors[m].Message)) + } + err := errors.Join(errs...) + return "", fmt.Errorf("deezer: GraphQL error: %w", err) + } + + if result.Data.Artist.Bio.Full == "" { + return "", errors.New("deezer: biography not found") + } + + return cleanBio(result.Data.Artist.Bio.Full), nil +} + +func cleanBio(bio string) string { + bio = strings.ReplaceAll(bio, "

", "\n") + return strictPolicy.Sanitize(bio) +} diff --git a/adapters/deezer/client_auth.go b/adapters/deezer/client_auth.go new file mode 100644 index 000000000..eb664c00b --- /dev/null +++ b/adapters/deezer/client_auth.go @@ -0,0 +1,101 @@ +package deezer + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "sync" + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" + "github.com/navidrome/navidrome/log" +) + +type jwtToken struct { + token string + expiresAt time.Time + mu sync.RWMutex +} + +func (j *jwtToken) get() (string, bool) { + j.mu.RLock() + defer j.mu.RUnlock() + if time.Now().Before(j.expiresAt) { + return j.token, true + } + return "", false +} + +func (j *jwtToken) set(token string, expiresIn time.Duration) { + j.mu.Lock() + defer j.mu.Unlock() + j.token = token + j.expiresAt = time.Now().Add(expiresIn) +} + +func (c *client) getJWT(ctx context.Context) (string, error) { + // Check if we have a valid cached token + if token, valid := c.jwt.get(); valid { + return token, nil + } + + // Fetch a new anonymous token + req, err := http.NewRequestWithContext(ctx, "GET", authBaseURL+"/login/anonymous?jo=p&rto=c", nil) + if err != nil { + return "", err + } + req.Header.Set("Accept", "application/json") + + resp, err := c.httpDoer.Do(req) + if err != nil { + return "", err + } + defer resp.Body.Close() + + if resp.StatusCode != 200 { + return "", fmt.Errorf("deezer: failed to get JWT token: %s", resp.Status) + } + + data, err := io.ReadAll(resp.Body) + if err != nil { + return "", err + } + + type authResponse struct { + JWT string `json:"jwt"` //nolint:gosec + } + + var result authResponse + if err := json.Unmarshal(data, &result); err != nil { + return "", fmt.Errorf("deezer: failed to parse auth response: %w", err) + } + + if result.JWT == "" { + return "", errors.New("deezer: no JWT token in response") + } + + // Parse JWT to get actual expiration time + token, err := jwt.ParseString(result.JWT, jwt.WithVerify(false), jwt.WithValidate(false)) + if err != nil { + return "", fmt.Errorf("deezer: failed to parse JWT token: %w", err) + } + + // Calculate TTL with a 1-minute buffer for clock skew and network delays + expiresAt, ok := token.Expiration() + if !ok || expiresAt.IsZero() { + return "", errors.New("deezer: JWT token has no expiration time") + } + + ttl := time.Until(expiresAt) - 1*time.Minute + if ttl <= 0 { + return "", errors.New("deezer: JWT token already expired or expires too soon") + } + + c.jwt.set(result.JWT, ttl) + log.Trace(ctx, "Fetched new Deezer JWT token", "expiresAt", expiresAt, "ttl", ttl) + + return result.JWT, nil +} diff --git a/adapters/deezer/client_auth_test.go b/adapters/deezer/client_auth_test.go new file mode 100644 index 000000000..005a84e1a --- /dev/null +++ b/adapters/deezer/client_auth_test.go @@ -0,0 +1,294 @@ +package deezer + +import ( + "bytes" + "context" + "fmt" + "io" + "net/http" + "sync" + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("JWT Authentication", func() { + var httpClient *fakeHttpClient + var client *client + var ctx context.Context + + BeforeEach(func() { + httpClient = &fakeHttpClient{} + client = newClient(httpClient) + ctx = context.Background() + }) + + Describe("getJWT", func() { + Context("with a valid JWT response", func() { + It("successfully fetches and caches a JWT token", func() { + testJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + token, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token).To(Equal(testJWT)) + }) + + It("returns the cached token on subsequent calls", func() { + testJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + // First call should fetch from API + token1, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token1).To(Equal(testJWT)) + Expect(httpClient.lastRequest.URL.Path).To(Equal("/login/anonymous")) + + // Second call should return cached token without hitting API + httpClient.lastRequest = nil // Clear last request to verify no new request is made + token2, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token2).To(Equal(testJWT)) + Expect(httpClient.lastRequest).To(BeNil()) // No new request made + }) + + It("parses the JWT expiration time correctly", func() { + expectedExpiration := time.Now().Add(5 * time.Minute) + testToken, err := jwt.NewBuilder(). + Expiration(expectedExpiration). + Build() + Expect(err).To(BeNil()) + testJWT, err := jwt.Sign(testToken, jwt.WithInsecureNoSignature()) + Expect(err).To(BeNil()) + + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, string(testJWT)))), + }) + + token, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token).ToNot(BeEmpty()) + + // Verify the token is cached until close to expiration + // The cache should expire 1 minute before the JWT expires + expectedCacheExpiry := expectedExpiration.Add(-1 * time.Minute) + Expect(client.jwt.expiresAt).To(BeTemporally("~", expectedCacheExpiry, 2*time.Second)) + }) + }) + + Context("with JWT tokens that expire soon", func() { + It("rejects tokens that expire in less than 1 minute", func() { + // Create a token that expires in 30 seconds (less than 1-minute buffer) + testJWT := createTestJWT(30 * time.Second) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JWT token already expired or expires too soon")) + }) + + It("rejects already expired tokens", func() { + // Create a token that expired 1 minute ago + testJWT := createTestJWT(-1 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JWT token already expired or expires too soon")) + }) + + It("accepts tokens that expire in more than 1 minute", func() { + // Create a token that expires in 2 minutes (just over the 1-minute buffer) + testJWT := createTestJWT(2 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, testJWT))), + }) + + token, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token).ToNot(BeEmpty()) + }) + }) + + Context("with invalid responses", func() { + It("handles HTTP error responses", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 500, + Body: io.NopCloser(bytes.NewBufferString(`{"error":"Internal server error"}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to get JWT token")) + }) + + It("handles malformed JSON responses", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{invalid json}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to parse auth response")) + }) + + It("handles responses with empty JWT field", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"jwt":""}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(Equal("deezer: no JWT token in response")) + }) + + It("handles invalid JWT tokens", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"jwt":"not-a-valid-jwt"}`)), + }) + + _, err := client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to parse JWT token")) + }) + + It("rejects JWT tokens without expiration", func() { + // Create a JWT without expiration claim + testToken, err := jwt.NewBuilder(). + Claim("custom", "value"). + Build() + Expect(err).To(BeNil()) + + // Verify token has no expiration + _, hasExp := testToken.Expiration() + Expect(hasExp).To(BeFalse()) + + testJWT, err := jwt.Sign(testToken, jwt.WithInsecureNoSignature()) + Expect(err).To(BeNil()) + + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, string(testJWT)))), + }) + + _, err = client.getJWT(ctx) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(Equal("deezer: JWT token has no expiration time")) + }) + }) + + Context("token caching behavior", func() { + It("fetches a new token when the cached token expires", func() { + // First token expires in 5 minutes + firstJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, firstJWT))), + }) + + token1, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token1).To(Equal(firstJWT)) + + // Manually expire the cached token + client.jwt.expiresAt = time.Now().Add(-1 * time.Second) + + // Second token with different expiration (10 minutes) + secondJWT := createTestJWT(10 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s"}`, secondJWT))), + }) + + token2, err := client.getJWT(ctx) + Expect(err).To(BeNil()) + Expect(token2).To(Equal(secondJWT)) + Expect(token2).ToNot(Equal(token1)) + }) + }) + }) + + Describe("jwtToken cache", func() { + var cache *jwtToken + + BeforeEach(func() { + cache = &jwtToken{} + }) + + It("returns false for expired tokens", func() { + cache.set("test-token", -1*time.Second) // Already expired + token, valid := cache.get() + Expect(valid).To(BeFalse()) + Expect(token).To(BeEmpty()) + }) + + It("returns true for valid tokens", func() { + cache.set("test-token", 4*time.Minute) + token, valid := cache.get() + Expect(valid).To(BeTrue()) + Expect(token).To(Equal("test-token")) + }) + + It("is thread-safe for concurrent access", func() { + wg := sync.WaitGroup{} + + // Writer goroutine + wg.Go(func() { + for i := range 100 { + cache.set(fmt.Sprintf("token-%d", i), 1*time.Hour) + time.Sleep(1 * time.Millisecond) + } + }) + + // Reader goroutine + wg.Go(func() { + for range 100 { + cache.get() + time.Sleep(1 * time.Millisecond) + } + }) + + // Wait for both goroutines to complete + wg.Wait() + + // Verify final state is valid + token, valid := cache.get() + Expect(valid).To(BeTrue()) + Expect(token).To(HavePrefix("token-")) + }) + }) +}) + +// createTestJWT creates a valid JWT token for testing purposes +func createTestJWT(expiresIn time.Duration) string { + token, err := jwt.NewBuilder(). + Expiration(time.Now().Add(expiresIn)). + Build() + if err != nil { + panic(fmt.Sprintf("failed to create test JWT: %v", err)) + } + signed, err := jwt.Sign(token, jwt.WithInsecureNoSignature()) + if err != nil { + panic(fmt.Sprintf("failed to sign test JWT: %v", err)) + } + return string(signed) +} diff --git a/adapters/deezer/client_test.go b/adapters/deezer/client_test.go new file mode 100644 index 000000000..9fa7afdd9 --- /dev/null +++ b/adapters/deezer/client_test.go @@ -0,0 +1,210 @@ +package deezer + +import ( + "bytes" + "fmt" + "io" + "net/http" + "os" + "time" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("client", func() { + var httpClient *fakeHttpClient + var client *client + + BeforeEach(func() { + httpClient = &fakeHttpClient{} + client = newClient(httpClient) + }) + + Describe("ArtistImages", func() { + It("returns artist images from a successful request", func() { + f, err := os.Open("tests/fixtures/deezer.search.artist.json") + Expect(err).To(BeNil()) + httpClient.mock("https://api.deezer.com/search/artist", http.Response{Body: f, StatusCode: 200}) + + artists, err := client.searchArtists(GinkgoT().Context(), "Michael Jackson", 20) + Expect(err).To(BeNil()) + Expect(artists).To(HaveLen(17)) + Expect(artists[0].Name).To(Equal("Michael Jackson")) + Expect(artists[0].PictureXl).To(Equal("https://cdn-images.dzcdn.net/images/artist/97fae13b2b30e4aec2e8c9e0c7839d92/1000x1000-000000-80-0-0.jpg")) + }) + + It("fails if artist was not found", func() { + httpClient.mock("https://api.deezer.com/search/artist", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":[],"total":0}`)), + }) + + _, err := client.searchArtists(GinkgoT().Context(), "Michael Jackson", 20) + Expect(err).To(MatchError(ErrNotFound)) + }) + }) + + Describe("TopTracks", func() { + It("returns top tracks with artist and album info from a successful request", func() { + f, err := os.Open("tests/fixtures/deezer.artist.top.json") + Expect(err).To(BeNil()) + httpClient.mock("https://api.deezer.com/artist/27/top", http.Response{Body: f, StatusCode: 200}) + + tracks, err := client.getTopTracks(GinkgoT().Context(), 27, 5) + Expect(err).To(BeNil()) + Expect(tracks).To(HaveLen(5)) + + // Verify first track has all expected fields + Expect(tracks[0].Title).To(Equal("Instant Crush (feat. Julian Casablancas)")) + Expect(tracks[0].Artist.Name).To(Equal("Daft Punk")) + Expect(tracks[0].Album.Title).To(Equal("Random Access Memories")) + + // Verify second track + Expect(tracks[1].Title).To(Equal("One More Time")) + Expect(tracks[1].Artist.Name).To(Equal("Daft Punk")) + Expect(tracks[1].Album.Title).To(Equal("Discovery")) + }) + }) + + Describe("ArtistBio", func() { + BeforeEach(func() { + // Mock the JWT token endpoint with a valid JWT that expires in 5 minutes + testJWT := createTestJWT(5 * time.Minute) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, testJWT))), + }) + }) + + It("returns artist bio from a successful request", func() { + f, err := os.Open("tests/fixtures/deezer.artist.bio.en.json") + Expect(err).To(BeNil()) + httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) + + bio, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(BeNil()) + Expect(bio).To(ContainSubstring("Schoolmates Thomas and Guy-Manuel")) + Expect(bio).ToNot(ContainSubstring("

")) + Expect(bio).ToNot(ContainSubstring("

")) + }) + + It("uses the provided language", func() { + f, err := os.Open("tests/fixtures/deezer.artist.bio.fr.json") + Expect(err).To(BeNil()) + httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) + + _, err = client.getArtistBio(GinkgoT().Context(), 27, "fr") + Expect(err).To(BeNil()) + Expect(httpClient.lastRequest.Header.Get("Accept-Language")).To(Equal("fr")) + }) + + It("includes the JWT token in the request", func() { + f, err := os.Open("tests/fixtures/deezer.artist.bio.en.json") + Expect(err).To(BeNil()) + httpClient.mock("https://pipe.deezer.com/api", http.Response{Body: f, StatusCode: 200}) + + _, err = client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(BeNil()) + // Verify that the Authorization header has the Bearer token format + authHeader := httpClient.lastRequest.Header.Get("Authorization") + Expect(authHeader).To(HavePrefix("Bearer ")) + Expect(len(authHeader)).To(BeNumerically(">", 20)) // JWT tokens are longer than 20 chars + }) + + It("handles GraphQL errors", func() { + errorResponse := `{ + "data": { + "artist": { + "bio": { + "full": "" + } + } + }, + "errors": [ + { + "message": "Artist not found" + }, + { + "message": "Invalid artist ID" + } + ] + }` + httpClient.mock("https://pipe.deezer.com/api", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(errorResponse)), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 999, "en") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("GraphQL error")) + Expect(err.Error()).To(ContainSubstring("Artist not found")) + Expect(err.Error()).To(ContainSubstring("Invalid artist ID")) + }) + + It("handles empty biography", func() { + emptyBioResponse := `{ + "data": { + "artist": { + "bio": { + "full": "" + } + } + } + }` + httpClient.mock("https://pipe.deezer.com/api", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(emptyBioResponse)), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(MatchError("deezer: biography not found")) + }) + + It("handles JWT token fetch failure", func() { + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 500, + Body: io.NopCloser(bytes.NewBufferString(`{"error":"Internal server error"}`)), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to get JWT")) + }) + + It("handles JWT token that expires too soon", func() { + // Create a JWT that expires in 30 seconds (less than the 1-minute buffer) + expiredJWT := createTestJWT(30 * time.Second) + httpClient.mock("https://auth.deezer.com/login/anonymous", http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, expiredJWT))), + }) + + _, err := client.getArtistBio(GinkgoT().Context(), 27, "en") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JWT token already expired or expires too soon")) + }) + }) +}) + +type fakeHttpClient struct { + responses map[string]*http.Response + lastRequest *http.Request +} + +func (c *fakeHttpClient) mock(url string, response http.Response) { + if c.responses == nil { + c.responses = make(map[string]*http.Response) + } + c.responses[url] = &response +} + +func (c *fakeHttpClient) Do(req *http.Request) (*http.Response, error) { + c.lastRequest = req + u := req.URL + u.RawQuery = "" + if resp, ok := c.responses[u.String()]; ok { + return resp, nil + } + panic("URL not mocked: " + u.String()) +} diff --git a/adapters/deezer/deezer.go b/adapters/deezer/deezer.go new file mode 100644 index 000000000..ed3071766 --- /dev/null +++ b/adapters/deezer/deezer.go @@ -0,0 +1,172 @@ +package deezer + +import ( + "context" + "errors" + "fmt" + "net/http" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/cache" + "github.com/navidrome/navidrome/utils/slice" +) + +const deezerAgentName = "deezer" +const deezerApiPictureXlSize = 1000 +const deezerApiPictureBigSize = 500 +const deezerApiPictureMediumSize = 250 +const deezerApiPictureSmallSize = 56 +const deezerArtistSearchLimit = 50 + +type deezerAgent struct { + dataStore model.DataStore + client *client + languages []string +} + +func deezerConstructor(dataStore model.DataStore) agents.Interface { + agent := &deezerAgent{ + dataStore: dataStore, + languages: conf.Server.Deezer.Languages, + } + httpClient := &http.Client{ + Timeout: consts.DefaultHttpClientTimeOut, + } + cachedHttpClient := cache.NewHTTPClient(httpClient, consts.DefaultHttpClientTimeOut) + agent.client = newClient(cachedHttpClient) + return agent +} + +func (s *deezerAgent) AgentName() string { + return deezerAgentName +} + +func (s *deezerAgent) GetArtistImages(ctx context.Context, _, name, _ string) ([]agents.ExternalImage, error) { + artist, err := s.searchArtist(ctx, name) + if err != nil { + if errors.Is(err, agents.ErrNotFound) { + log.Warn(ctx, "Artist not found in deezer", "artist", name) + } else { + log.Error(ctx, "Error calling deezer", "artist", name, err) + } + return nil, err + } + + var res []agents.ExternalImage + possibleImages := []struct { + URL string + Size int + }{ + {artist.PictureXl, deezerApiPictureXlSize}, + {artist.PictureBig, deezerApiPictureBigSize}, + {artist.PictureMedium, deezerApiPictureMediumSize}, + {artist.PictureSmall, deezerApiPictureSmallSize}, + } + for _, imgData := range possibleImages { + if imgData.URL != "" { + res = append(res, agents.ExternalImage{ + URL: imgData.URL, + Size: imgData.Size, + }) + } + } + return res, nil +} + +func (s *deezerAgent) searchArtist(ctx context.Context, name string) (*Artist, error) { + artists, err := s.client.searchArtists(ctx, name, deezerArtistSearchLimit) + if errors.Is(err, ErrNotFound) || len(artists) == 0 { + return nil, agents.ErrNotFound + } + if err != nil { + return nil, err + } + + log.Trace(ctx, "Artists found", "count", len(artists), "searched_name", name) + for i := range artists { + log.Trace(ctx, fmt.Sprintf("Artists found #%d", i), "name", artists[i].Name, "id", artists[i].ID, "link", artists[i].Link) + if i > 2 { + break + } + } + + // If the first one has the same name, that's the one + if !strings.EqualFold(artists[0].Name, name) { + log.Trace(ctx, "Top artist do not match", "searched_name", name, "found_name", artists[0].Name) + return nil, agents.ErrNotFound + } + log.Trace(ctx, "Found artist", "name", artists[0].Name, "id", artists[0].ID, "link", artists[0].Link) + return &artists[0], err +} + +func (s *deezerAgent) GetSimilarArtists(ctx context.Context, _, name, _ string, limit int) ([]agents.Artist, error) { + artist, err := s.searchArtist(ctx, name) + if err != nil { + return nil, err + } + + related, err := s.client.getRelatedArtists(ctx, artist.ID) + if err != nil { + return nil, err + } + + res := slice.Map(related, func(r Artist) agents.Artist { + return agents.Artist{ + Name: r.Name, + } + }) + if len(res) > limit { + res = res[:limit] + } + return res, nil +} + +func (s *deezerAgent) GetArtistTopSongs(ctx context.Context, _, artistName, _ string, count int) ([]agents.Song, error) { + artist, err := s.searchArtist(ctx, artistName) + if err != nil { + return nil, err + } + + tracks, err := s.client.getTopTracks(ctx, artist.ID, count) + if err != nil { + return nil, err + } + + res := slice.Map(tracks, func(r Track) agents.Song { + return agents.Song{ + Name: r.Title, + Album: r.Album.Title, + Duration: uint32(r.Duration * 1000), // Convert seconds to milliseconds + } + }) + return res, nil +} + +func (s *deezerAgent) GetArtistBiography(ctx context.Context, _, name, _ string) (string, error) { + artist, err := s.searchArtist(ctx, name) + if err != nil { + return "", err + } + + for _, lang := range s.languages { + bio, err := s.client.getArtistBio(ctx, artist.ID, lang) + if err == nil && bio != "" { + return bio, nil + } + log.Debug(ctx, "Deezer/artist.bio returned empty/error, trying next language", "artist", name, "lang", lang, err) + } + return "", agents.ErrNotFound +} + +func init() { + conf.AddHook(func() { + if conf.Server.Deezer.Enabled { + agents.Register(deezerAgentName, deezerConstructor) + } + }) +} diff --git a/core/agents/spotify/spotify_suite_test.go b/adapters/deezer/deezer_suite_test.go similarity index 74% rename from core/agents/spotify/spotify_suite_test.go rename to adapters/deezer/deezer_suite_test.go index 275b05e73..a42282da7 100644 --- a/core/agents/spotify/spotify_suite_test.go +++ b/adapters/deezer/deezer_suite_test.go @@ -1,4 +1,4 @@ -package spotify +package deezer import ( "testing" @@ -9,9 +9,9 @@ import ( . "github.com/onsi/gomega" ) -func TestSpotify(t *testing.T) { +func TestDeezer(t *testing.T) { tests.Init(t, false) log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) - RunSpecs(t, "Spotify Test Suite") + RunSpecs(t, "Deezer Test Suite") } diff --git a/adapters/deezer/deezer_test.go b/adapters/deezer/deezer_test.go new file mode 100644 index 000000000..4dd251585 --- /dev/null +++ b/adapters/deezer/deezer_test.go @@ -0,0 +1,171 @@ +package deezer + +import ( + "bytes" + "context" + "fmt" + "io" + "net/http" + "os" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("deezerAgent", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + DeferCleanup(configtest.SetupConfig()) + conf.Server.Deezer.Enabled = true + }) + + Describe("deezerConstructor", func() { + It("uses configured languages", func() { + conf.Server.Deezer.Languages = []string{"pt", "en"} + agent := deezerConstructor(&tests.MockDataStore{}).(*deezerAgent) + Expect(agent.languages).To(Equal([]string{"pt", "en"})) + }) + }) + + Describe("GetArtistBiography - Language Fallback", func() { + var agent *deezerAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + + // Mock search artist (returns Michael Jackson) + fSearch, _ := os.Open("tests/fixtures/deezer.search.artist.json") + httpClient.searchResponse = &http.Response{Body: fSearch, StatusCode: 200} + + // Mock JWT token + testJWT := createTestJWT(5 * time.Minute) + httpClient.jwtResponse = &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(fmt.Sprintf(`{"jwt":"%s","refresh_token":""}`, testJWT))), + } + }) + + setupAgent := func(languages []string) { + conf.Server.Deezer.Languages = languages + agent = &deezerAgent{ + dataStore: &tests.MockDataStore{}, + client: newClient(httpClient), + languages: languages, + } + } + + It("returns content in first language when available (1 bio API call)", func() { + setupAgent([]string{"fr", "en"}) + + // French biography available + fFr, _ := os.Open("tests/fixtures/deezer.artist.bio.fr.json") + httpClient.bioResponses["fr"] = &http.Response{Body: fFr, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Guy-Manuel de Homem Christo et Thomas Bangalter")) + Expect(httpClient.bioRequestCount).To(Equal(1)) + Expect(httpClient.bioRequests[0].Header.Get("Accept-Language")).To(Equal("fr")) + }) + + It("falls back to second language when first returns empty (2 bio API calls)", func() { + setupAgent([]string{"ja", "en"}) + + // Japanese returns empty biography + fJa, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["ja"] = &http.Response{Body: fJa, StatusCode: 200} + // English returns full biography + fEn, _ := os.Open("tests/fixtures/deezer.artist.bio.en.json") + httpClient.bioResponses["en"] = &http.Response{Body: fEn, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Schoolmates Thomas and Guy-Manuel")) + Expect(httpClient.bioRequestCount).To(Equal(2)) + Expect(httpClient.bioRequests[0].Header.Get("Accept-Language")).To(Equal("ja")) + Expect(httpClient.bioRequests[1].Header.Get("Accept-Language")).To(Equal("en")) + }) + + It("returns ErrNotFound when all languages return empty", func() { + setupAgent([]string{"ja", "xx"}) + + // Both languages return empty biography + fJa, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["ja"] = &http.Response{Body: fJa, StatusCode: 200} + fXx, _ := os.Open("tests/fixtures/deezer.artist.bio.empty.json") + httpClient.bioResponses["xx"] = &http.Response{Body: fXx, StatusCode: 200} + + _, err := agent.GetArtistBiography(ctx, "", "Michael Jackson", "") + + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.bioRequestCount).To(Equal(2)) + }) + }) +}) + +// langAwareHttpClient is a mock HTTP client that returns different responses based on the Accept-Language header +type langAwareHttpClient struct { + searchResponse *http.Response + jwtResponse *http.Response + bioResponses map[string]*http.Response + bioRequests []*http.Request + bioRequestCount int +} + +func newLangAwareHttpClient() *langAwareHttpClient { + return &langAwareHttpClient{ + bioResponses: make(map[string]*http.Response), + bioRequests: make([]*http.Request, 0), + } +} + +func (c *langAwareHttpClient) Do(req *http.Request) (*http.Response, error) { + // Handle search artist request + if req.URL.Host == "api.deezer.com" && req.URL.Path == "/search/artist" { + if c.searchResponse != nil { + return c.searchResponse, nil + } + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":[],"total":0}`)), + }, nil + } + + // Handle JWT token request + if req.URL.Host == "auth.deezer.com" && req.URL.Path == "/login/anonymous" { + if c.jwtResponse != nil { + return c.jwtResponse, nil + } + return &http.Response{ + StatusCode: 500, + Body: io.NopCloser(bytes.NewBufferString(`{"error":"no mock"}`)), + }, nil + } + + // Handle bio request (GraphQL API) + if req.URL.Host == "pipe.deezer.com" && req.URL.Path == "/api" { + c.bioRequestCount++ + c.bioRequests = append(c.bioRequests, req) + lang := req.Header.Get("Accept-Language") + if resp, ok := c.bioResponses[lang]; ok { + return resp, nil + } + // Return empty bio by default + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{"data":{"artist":{"bio":{"full":""}}}}`)), + }, nil + } + + panic("URL not mocked: " + req.URL.String()) +} diff --git a/adapters/deezer/responses.go b/adapters/deezer/responses.go new file mode 100644 index 000000000..266c44c62 --- /dev/null +++ b/adapters/deezer/responses.go @@ -0,0 +1,66 @@ +package deezer + +type SearchArtistResults struct { + Data []Artist `json:"data"` + Total int `json:"total"` + Next string `json:"next"` +} + +type Artist struct { + ID int `json:"id"` + Name string `json:"name"` + Link string `json:"link"` + Picture string `json:"picture"` + PictureSmall string `json:"picture_small"` + PictureMedium string `json:"picture_medium"` + PictureBig string `json:"picture_big"` + PictureXl string `json:"picture_xl"` + NbAlbum int `json:"nb_album"` + NbFan int `json:"nb_fan"` + Radio bool `json:"radio"` + Tracklist string `json:"tracklist"` + Type string `json:"type"` +} + +type Error struct { + Error struct { + Type string `json:"type"` + Message string `json:"message"` + Code int `json:"code"` + } `json:"error"` +} + +type RelatedArtists struct { + Data []Artist `json:"data"` + Total int `json:"total"` +} + +type TopTracks struct { + Data []Track `json:"data"` + Total int `json:"total"` + Next string `json:"next"` +} + +type Track struct { + ID int `json:"id"` + Title string `json:"title"` + Link string `json:"link"` + Duration int `json:"duration"` + Rank int `json:"rank"` + Preview string `json:"preview"` + Artist Artist `json:"artist"` + Album Album `json:"album"` + Contributors []Artist `json:"contributors"` +} + +type Album struct { + ID int `json:"id"` + Title string `json:"title"` + Cover string `json:"cover"` + CoverSmall string `json:"cover_small"` + CoverMedium string `json:"cover_medium"` + CoverBig string `json:"cover_big"` + CoverXl string `json:"cover_xl"` + Tracklist string `json:"tracklist"` + Type string `json:"type"` +} diff --git a/adapters/deezer/responses_test.go b/adapters/deezer/responses_test.go new file mode 100644 index 000000000..a9de5c5fb --- /dev/null +++ b/adapters/deezer/responses_test.go @@ -0,0 +1,69 @@ +package deezer + +import ( + "encoding/json" + "os" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Responses", func() { + Describe("Search type=artist", func() { + It("parses the artist search result correctly ", func() { + var resp SearchArtistResults + body, err := os.ReadFile("tests/fixtures/deezer.search.artist.json") + Expect(err).To(BeNil()) + err = json.Unmarshal(body, &resp) + Expect(err).To(BeNil()) + + Expect(resp.Data).To(HaveLen(17)) + michael := resp.Data[0] + Expect(michael.Name).To(Equal("Michael Jackson")) + Expect(michael.PictureXl).To(Equal("https://cdn-images.dzcdn.net/images/artist/97fae13b2b30e4aec2e8c9e0c7839d92/1000x1000-000000-80-0-0.jpg")) + }) + }) + + Describe("Error", func() { + It("parses the error response correctly", func() { + var errorResp Error + body := []byte(`{"error":{"type":"MissingParameterException","message":"Missing parameters: q","code":501}}`) + err := json.Unmarshal(body, &errorResp) + Expect(err).To(BeNil()) + + Expect(errorResp.Error.Code).To(Equal(501)) + Expect(errorResp.Error.Message).To(Equal("Missing parameters: q")) + }) + }) + + Describe("Related Artists", func() { + It("parses the related artists response correctly", func() { + var resp RelatedArtists + body, err := os.ReadFile("tests/fixtures/deezer.artist.related.json") + Expect(err).To(BeNil()) + err = json.Unmarshal(body, &resp) + Expect(err).To(BeNil()) + + Expect(resp.Data).To(HaveLen(20)) + justice := resp.Data[0] + Expect(justice.Name).To(Equal("Justice")) + Expect(justice.ID).To(Equal(6404)) + }) + }) + + Describe("Top Tracks", func() { + It("parses the top tracks response correctly", func() { + var resp TopTracks + body, err := os.ReadFile("tests/fixtures/deezer.artist.top.json") + Expect(err).To(BeNil()) + err = json.Unmarshal(body, &resp) + Expect(err).To(BeNil()) + + Expect(resp.Data).To(HaveLen(5)) + track := resp.Data[0] + Expect(track.Title).To(Equal("Instant Crush (feat. Julian Casablancas)")) + Expect(track.ID).To(Equal(67238732)) + Expect(track.Album.Title).To(Equal("Random Access Memories")) + }) + }) +}) diff --git a/adapters/taglib/end_to_end_test.go b/adapters/gotaglib/end_to_end_test.go similarity index 53% rename from adapters/taglib/end_to_end_test.go rename to adapters/gotaglib/end_to_end_test.go index 08fc1a506..e7dd18ac1 100644 --- a/adapters/taglib/end_to_end_test.go +++ b/adapters/gotaglib/end_to_end_test.go @@ -1,4 +1,4 @@ -package taglib +package gotaglib import ( "io/fs" @@ -78,22 +78,111 @@ var _ = Describe("Extractor", func() { var e *extractor + parseTestFile := func(path string) *model.MediaFile { + mds, err := e.Parse(path) + Expect(err).ToNot(HaveOccurred()) + + info, ok := mds[path] + Expect(ok).To(BeTrue()) + + fileInfo, err := os.Stat(path) + Expect(err).ToNot(HaveOccurred()) + info.FileInfo = testFileInfo{FileInfo: fileInfo} + + metadata := metadata.New(path, info) + return new(metadata.ToMediaFile(1, "folderID")) + } + BeforeEach(func() { - e = &extractor{} + e = &extractor{fs: os.DirFS(".")} + }) + + Describe("ReplayGain", func() { + DescribeTable("test replaygain end-to-end", func(file string, trackGain, trackPeak, albumGain, albumPeak *float64) { + mf := parseTestFile("tests/fixtures/" + file) + + Expect(mf.RGTrackGain).To(Equal(trackGain)) + Expect(mf.RGTrackPeak).To(Equal(trackPeak)) + Expect(mf.RGAlbumGain).To(Equal(albumGain)) + Expect(mf.RGAlbumPeak).To(Equal(albumPeak)) + }, + Entry("mp3 with no replaygain", "no_replaygain.mp3", nil, nil, nil, nil), + Entry("mp3 with no zero replaygain", "zero_replaygain.mp3", new(0.0), new(1.0), new(0.0), new(1.0)), + ) + }) + + Describe("lyrics", func() { + makeLyrics := func(code, secondLine string) model.Lyrics { + return model.Lyrics{ + DisplayArtist: "", + DisplayTitle: "", + Lang: code, + Line: []model.Line{ + {Start: new(int64(0)), Value: "This is"}, + {Start: new(int64(2500)), Value: secondLine}, + }, + Offset: nil, + Synced: true, + } + } + + It("should fetch both synced and unsynced lyrics in mixed flac", func() { + mf := parseTestFile("tests/fixtures/mixed-lyrics.flac") + + lyrics, err := mf.StructuredLyrics() + Expect(err).ToNot(HaveOccurred()) + Expect(lyrics).To(HaveLen(2)) + + Expect(lyrics[0].Synced).To(BeTrue()) + Expect(lyrics[1].Synced).To(BeFalse()) + }) + + It("should handle mp3 with uslt and sylt", func() { + mf := parseTestFile("tests/fixtures/test.mp3") + + lyrics, err := mf.StructuredLyrics() + Expect(err).ToNot(HaveOccurred()) + Expect(lyrics).To(HaveLen(4)) + + engSylt := makeLyrics("eng", "English SYLT") + engUslt := makeLyrics("eng", "English") + unsSylt := makeLyrics("xxx", "unspecified SYLT") + unsUslt := makeLyrics("xxx", "unspecified") + + Expect(lyrics).To(ConsistOf(engSylt, engUslt, unsSylt, unsUslt)) + }) + + DescribeTable("format-specific lyrics", func(file string, isId3 bool) { + mf := parseTestFile("tests/fixtures/" + file) + + lyrics, err := mf.StructuredLyrics() + Expect(err).To(Not(HaveOccurred())) + Expect(lyrics).To(HaveLen(2)) + + unspec := makeLyrics("xxx", "unspecified") + eng := makeLyrics("xxx", "English") + + if isId3 { + eng.Lang = "eng" + } + + Expect(lyrics).To(Or( + Equal(model.LyricList{unspec, eng}), + Equal(model.LyricList{eng, unspec}))) + }, + Entry("flac", "test.flac", false), + Entry("m4a", "test.m4a", false), + Entry("ogg", "test.ogg", false), + Entry("wma", "test.wma", false), + Entry("wv", "test.wv", false), + Entry("wav", "test.wav", true), + Entry("aiff", "test.aiff", true), + ) }) Describe("Participants", func() { DescribeTable("test tags consistent across formats", func(format string) { - path := "tests/fixtures/test." + format - mds, err := e.Parse(path) - Expect(err).ToNot(HaveOccurred()) - - info := mds[path] - fileInfo, _ := os.Stat(path) - info.FileInfo = testFileInfo{FileInfo: fileInfo} - - metadata := metadata.New(path, info) - mf := metadata.ToMediaFile(1, "folderID") + mf := parseTestFile("tests/fixtures/test." + format) for _, data := range roles { role := data.Role @@ -144,11 +233,40 @@ var _ = Describe("Extractor", func() { Entry("FLAC format", "flac"), Entry("M4a format", "m4a"), Entry("OGG format", "ogg"), - Entry("WMA format", "wv"), + Entry("WV format", "wv"), Entry("MP3 format", "mp3"), Entry("WAV format", "wav"), Entry("AIFF format", "aiff"), ) + + It("should parse wma", func() { + mf := parseTestFile("tests/fixtures/test.wma") + + for _, data := range roles { + role := data.Role + artists := data.ParticipantList + actual := mf.Participants[role] + + // WMA has no Arranger role + if role == model.RoleArranger { + Expect(actual).To(HaveLen(0)) + continue + } + + Expect(actual).To(HaveLen(len(artists)), role.String()) + + // For some bizarre reason, the order is inverted. We also don't get + // sort names or MBIDs + for i := range artists { + idx := len(artists) - 1 - i + + actualArtist := actual[i] + expectedArtist := artists[idx] + + Expect(actualArtist.Name).To(Equal(expectedArtist.Name)) + } + } + }) }) }) diff --git a/adapters/gotaglib/gotaglib.go b/adapters/gotaglib/gotaglib.go new file mode 100644 index 000000000..7ea98a442 --- /dev/null +++ b/adapters/gotaglib/gotaglib.go @@ -0,0 +1,301 @@ +// Package gotaglib provides an alternative metadata extractor using go-taglib, +// a pure Go (WASM-based) implementation of TagLib. +// +// This extractor aims for parity with the CGO-based taglib extractor. It uses +// TagLib's PropertyMap interface for standard tags. The File handle API provides +// efficient access to format-specific tags (ID3v2 frames, MP4 atoms, ASF attributes) +// through a single file open operation. +// +// This extractor is registered under the name "taglib". It only works with a filesystem +// (fs.FS) and does not support direct local file paths. Files returned by the filesystem +// must implement io.ReadSeeker for go-taglib to read them. +package gotaglib + +import ( + "errors" + "fmt" + "io" + "io/fs" + "runtime/debug" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/storage/local" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model/metadata" + "go.senan.xyz/taglib" +) + +type extractor struct { + fs fs.FS +} + +func (e extractor) Parse(files ...string) (map[string]metadata.Info, error) { + results := make(map[string]metadata.Info) + for _, path := range files { + props, err := e.extractMetadata(path) + if err != nil { + continue + } + results[path] = *props + } + return results, nil +} + +func (e extractor) Version() string { + bi, ok := debug.ReadBuildInfo() + if ok { + for _, dep := range bi.Deps { + if dep.Path == "go.senan.xyz/taglib" { + if dep.Replace != nil { + return dep.Replace.Version + } + return dep.Version + } + } + } + return "unknown" +} + +func (e extractor) extractMetadata(filePath string) (info *metadata.Info, err error) { + // Recover from panics in the WASM runtime that can occur during any taglib + // operation (opening, reading tags, or reading properties). This catches crashes + // from malformed files or WASM runtime issues (e.g., wazero mmap failures on + // hardened systems with MemoryDenyWriteExecute=true). + debug.SetPanicOnFault(true) + defer func() { + if r := recover(); r != nil { + log.Error("gotaglib: WASM runtime panic reading file. Skipping", "filePath", filePath, "panic", r) + debug.PrintStack() + err = fmt.Errorf("WASM runtime panic: %v", r) + } + }() + + f, close, err := e.openFile(filePath) + if err != nil { + log.Warn("gotaglib: Error reading metadata from file. Skipping", "filePath", filePath, err) + return nil, err + } + defer close() + + // Get all tags and properties in one go + allTags := f.AllTags() + props := f.Properties() + + // Map properties to AudioProperties + ap := metadata.AudioProperties{ + Duration: props.Length.Round(time.Millisecond * 10), + BitRate: int(props.Bitrate), + Channels: int(props.Channels), + SampleRate: int(props.SampleRate), + BitDepth: int(props.BitsPerSample), + Codec: props.Codec, + } + + // Convert normalized tags to lowercase keys (go-taglib returns UPPERCASE keys) + normalizedTags := make(map[string][]string, len(allTags.Tags)) + for key, values := range allTags.Tags { + lowerKey := strings.ToLower(key) + normalizedTags[lowerKey] = values + } + + // Process format-specific raw tags + processRawTags(allTags, normalizedTags) + + // Parse track/disc totals from "N/Total" format + parseTuple(normalizedTags, "track") + parseTuple(normalizedTags, "disc") + + // Adjust some ID3 tags + parseLyrics(normalizedTags) + parseTIPL(normalizedTags) + delete(normalizedTags, "tmcl") // TMCL is already parsed by TagLib + + // Determine if file has embedded picture + hasPicture := len(props.Images) > 0 + + return &metadata.Info{ + Tags: normalizedTags, + AudioProperties: ap, + HasPicture: hasPicture, + }, nil +} + +// openFile opens the file at filePath using the extractor's filesystem. +// It returns a TagLib File handle and a cleanup function to close resources. +func (e extractor) openFile(filePath string) (f *taglib.File, closeFunc func(), err error) { + // Open the file from the filesystem + file, err := e.fs.Open(filePath) + if err != nil { + return nil, nil, err + } + rs, isSeekable := file.(io.ReadSeeker) + if !isSeekable { + file.Close() + return nil, nil, errors.New("file is not seekable") + } + // WithFilename provides a format detection hint via the file extension, + // since OpenStream alone relies on content-sniffing which fails for some files. + f, err = taglib.OpenStream(rs, + taglib.WithReadStyle(taglib.ReadStyleFast), + taglib.WithFilename(filePath), + ) + if err != nil { + file.Close() + return nil, nil, err + } + closeFunc = func() { + f.Close() + file.Close() + } + return f, closeFunc, nil +} + +// parseTuple parses track/disc numbers in "N/Total" format and separates them. +// For example, tracknumber="2/10" becomes tracknumber="2" and tracktotal="10". +func parseTuple(tags map[string][]string, prop string) { + tagName := prop + "number" + tagTotal := prop + "total" + if value, ok := tags[tagName]; ok && len(value) > 0 { + parts := strings.Split(value[0], "/") + tags[tagName] = []string{parts[0]} + if len(parts) == 2 { + tags[tagTotal] = []string{parts[1]} + } + } +} + +// parseLyrics ensures lyrics tags have a language code. +// If lyrics exist without a language code, they are moved to "lyrics:xxx". +func parseLyrics(tags map[string][]string) { + lyrics := tags["lyrics"] + if len(lyrics) > 0 { + tags["lyrics:xxx"] = lyrics + delete(tags, "lyrics") + } +} + +// processRawTags processes format-specific raw tags based on the detected file format. +// This handles ID3v2 frames (MP3/WAV/AIFF), MP4 atoms, and ASF attributes. +func processRawTags(allTags taglib.AllTags, normalizedTags map[string][]string) { + switch allTags.Format { + case taglib.FormatMPEG, taglib.FormatWAV, taglib.FormatAIFF: + parseID3v2Frames(allTags.Raw, normalizedTags) + case taglib.FormatMP4: + parseMP4Atoms(allTags.Raw, normalizedTags) + case taglib.FormatASF: + parseASFAttributes(allTags.Raw, normalizedTags) + } +} + +// parseID3v2Frames processes ID3v2 raw frames to extract USLT/SYLT with language codes. +// This extracts language-specific lyrics that the standard Tags() doesn't provide. +func parseID3v2Frames(rawFrames map[string][]string, tags map[string][]string) { + // Process frames that have language-specific data + for key, values := range rawFrames { + lowerKey := strings.ToLower(key) + + // Handle USLT:xxx and SYLT:xxx (lyrics with language codes) + if strings.HasPrefix(lowerKey, "uslt:") || strings.HasPrefix(lowerKey, "sylt:") { + parts := strings.SplitN(lowerKey, ":", 2) + if len(parts) == 2 && parts[1] != "" { + lang := parts[1] + lyricsKey := "lyrics:" + lang + tags[lyricsKey] = append(tags[lyricsKey], values...) + } + } + } + + // If we found any language-specific lyrics from ID3v2 frames, remove the generic lyrics + for key := range tags { + if strings.HasPrefix(key, "lyrics:") && key != "lyrics" { + delete(tags, "lyrics") + break + } + } +} + +const iTunesKeyPrefix = "----:com.apple.iTunes:" + +// parseMP4Atoms processes MP4 raw atoms to get iTunes-specific tags. +func parseMP4Atoms(rawAtoms map[string][]string, tags map[string][]string) { + // Process all atoms and add them to tags + for key, values := range rawAtoms { + // Strip iTunes prefix and convert to lowercase + normalizedKey := strings.TrimPrefix(key, iTunesKeyPrefix) + normalizedKey = strings.ToLower(normalizedKey) + + // Only add if the tag doesn't already exist (avoid duplication with PropertyMap) + if _, exists := tags[normalizedKey]; !exists { + tags[normalizedKey] = values + } + } +} + +// parseASFAttributes processes ASF raw attributes to get WMA-specific tags. +func parseASFAttributes(rawAttrs map[string][]string, tags map[string][]string) { + // Process all attributes and add them to tags + for key, values := range rawAttrs { + normalizedKey := strings.ToLower(key) + + // Only add if the tag doesn't already exist (avoid duplication with PropertyMap) + if _, exists := tags[normalizedKey]; !exists { + tags[normalizedKey] = values + } + } +} + +// These are the only roles we support, based on Picard's tag map: +// https://picard-docs.musicbrainz.org/downloads/MusicBrainz_Picard_Tag_Map.html +var tiplMapping = map[string]string{ + "arranger": "arranger", + "engineer": "engineer", + "producer": "producer", + "mix": "mixer", + "DJ-mix": "djmixer", +} + +// parseTIPL parses the ID3v2.4 TIPL frame string, which is received from TagLib in the format: +// +// "arranger Andrew Powell engineer Chris Blair engineer Pat Stapley producer Eric Woolfson". +// +// and breaks it down into a map of roles and names, e.g.: +// +// {"arranger": ["Andrew Powell"], "engineer": ["Chris Blair", "Pat Stapley"], "producer": ["Eric Woolfson"]}. +func parseTIPL(tags map[string][]string) { + tipl := tags["tipl"] + if len(tipl) == 0 { + return + } + addRole := func(currentRole string, currentValue []string) { + if currentRole != "" && len(currentValue) > 0 { + role := tiplMapping[currentRole] + tags[role] = append(tags[role], strings.Join(currentValue, " ")) + } + } + var currentRole string + var currentValue []string + for part := range strings.SplitSeq(tipl[0], " ") { + if _, ok := tiplMapping[part]; ok { + addRole(currentRole, currentValue) + currentRole = part + currentValue = nil + continue + } + currentValue = append(currentValue, part) + } + addRole(currentRole, currentValue) + delete(tags, "tipl") +} + +var _ local.Extractor = (*extractor)(nil) + +func init() { + local.RegisterExtractor("taglib", func(fsys fs.FS, baseDir string) local.Extractor { + return &extractor{fsys} + }) + conf.AddHook(func() { + log.Debug("go-taglib version", "version", extractor{}.Version()) + }) +} diff --git a/adapters/taglib/taglib_suite_test.go b/adapters/gotaglib/gotaglib_suite_test.go similarity index 74% rename from adapters/taglib/taglib_suite_test.go rename to adapters/gotaglib/gotaglib_suite_test.go index 2b26612cf..cc7ddc471 100644 --- a/adapters/taglib/taglib_suite_test.go +++ b/adapters/gotaglib/gotaglib_suite_test.go @@ -1,4 +1,4 @@ -package taglib +package gotaglib import ( "testing" @@ -9,9 +9,9 @@ import ( . "github.com/onsi/gomega" ) -func TestTagLib(t *testing.T) { +func TestGoTagLib(t *testing.T) { tests.Init(t, true) log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) - RunSpecs(t, "TagLib Suite") + RunSpecs(t, "GoTagLib Suite") } diff --git a/adapters/taglib/taglib_test.go b/adapters/gotaglib/gotaglib_test.go similarity index 86% rename from adapters/taglib/taglib_test.go rename to adapters/gotaglib/gotaglib_test.go index 37b012763..05924914d 100644 --- a/adapters/taglib/taglib_test.go +++ b/adapters/gotaglib/gotaglib_test.go @@ -1,10 +1,11 @@ -package taglib +package gotaglib import ( "io/fs" "os" "strings" + "github.com/navidrome/navidrome/tests" "github.com/navidrome/navidrome/utils" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -14,7 +15,7 @@ var _ = Describe("Extractor", func() { var e *extractor BeforeEach(func() { - e = &extractor{} + e = &extractor{fs: os.DirFS(".")} }) Describe("Parse", func() { @@ -80,12 +81,11 @@ var _ = Describe("Extractor", func() { Expect(err).To(BeNil()) Expect(m.Tags).To(HaveKeyWithValue("fbpm", []string{"141.7"})) - // TabLib 1.12 returns 18, previous versions return 39. + // TagLib 1.12 returns 18, previous versions return 39. // See https://github.com/taglib/taglib/commit/2f238921824741b2cfe6fbfbfc9701d9827ab06b Expect(m.AudioProperties.BitRate).To(BeElementOf(18, 19, 39, 40, 43, 49)) Expect(m.AudioProperties.Channels).To(BeElementOf(2)) Expect(m.AudioProperties.SampleRate).To(BeElementOf(8000)) - Expect(m.AudioProperties.SampleRate).To(BeElementOf(8000)) Expect(m.HasPicture).To(BeTrue()) }) @@ -106,7 +106,7 @@ var _ = Describe("Extractor", func() { Expect(m.Tags).To(Or( HaveKeyWithValue("replaygain_album_gain", []string{albumGain}), - HaveKeyWithValue("----:com.apple.itunes:replaygain_track_gain", []string{albumGain}), + HaveKeyWithValue("----:com.apple.itunes:replaygain_album_gain", []string{albumGain}), )) Expect(m.Tags).To(Or( @@ -128,6 +128,17 @@ var _ = Describe("Extractor", func() { Expect(m.Tags).To(HaveKeyWithValue("albumartist", []string{"Album Artist"})) Expect(m.Tags).To(HaveKeyWithValue("genre", []string{"Rock"})) Expect(m.Tags).To(HaveKeyWithValue("date", []string{"2014"})) + // Still as of TagLib v2.2.1, TagLib only maps values in ID3, MP4, and ASF tags + // to `originaldate`. + if strings.HasSuffix(file, ".mp3") || strings.HasSuffix(file, ".wav") || strings.HasSuffix(file, ".aiff") || strings.HasSuffix(file, ".m4a") || strings.HasSuffix(file, ".wma") { + Expect(m.Tags).To(HaveKeyWithValue("originaldate", []string{"1996-11-21"})) + } + // MP3Tag sets `ORIGYEAR` in several formats for which it has no built-in mapping + // for original release dates. + Expect(m.Tags).To(Or( + HaveKeyWithValue("origyear", []string{"1998-07-28"}), + HaveKeyWithValue("----:com.apple.itunes:origyear", []string{"1998-07-28"}), + )) Expect(m.Tags).To(HaveKeyWithValue("bpm", []string{"123"})) Expect(m.Tags).To(Or( @@ -174,12 +185,15 @@ var _ = Describe("Extractor", func() { Entry("correctly parses m4a (aac) gain tags (uppercase)", "test.m4a", "1.04s", 2, 44100, 16, "0.37", "0.48", "0.37", "0.48", false, true), Entry("correctly parses ogg (vorbis) tags", "test.ogg", "1.04s", 2, 8000, 0, "+7.64 dB", "0.11772506", "+7.64 dB", "0.11772506", false, true), + // ffmpeg -f lavfi -i "sine=frequency=1100:duration=1" -c:a libopus test.opus (tags added via mutagen) + Entry("correctly parses opus tags (#4998)", "test.opus", "1s", 1, 48000, 0, "+5.12 dB", "0.11345678", "+5.12 dB", "0.11345678", false, true), + // ffmpeg -f lavfi -i "sine=frequency=900:duration=1" test.wma // Weird note: for the tag parsing to work, the lyrics are actually stored in the reverse order Entry("correctly parses wma/asf tags", "test.wma", "1.02s", 1, 44100, 16, "3.27 dB", "0.132914", "3.27 dB", "0.132914", false, true), // ffmpeg -f lavfi -i "sine=frequency=800:duration=1" test.wv - Entry("correctly parses wv (wavpak) tags", "test.wv", "1s", 1, 44100, 16, "3.43 dB", "0.125061", "3.43 dB", "0.125061", false, false), + Entry("correctly parses wv (wavpak) tags", "test.wv", "1s", 1, 44100, 16, "3.43 dB", "0.125061", "3.43 dB", "0.125061", false, true), // ffmpeg -f lavfi -i "sine=frequency=1000:duration=1" test.wav Entry("correctly parses wav tags", "test.wav", "1s", 1, 44100, 16, "3.06 dB", "0.125056", "3.06 dB", "0.125056", true, true), @@ -200,6 +214,9 @@ var _ = Describe("Extractor", func() { // Only run permission tests if we are not root RegularUserContext("when run without root privileges", func() { BeforeEach(func() { + tests.SkipOnWindows("uses Unix file permission bits") + // Use root fs for absolute paths in temp directory + e = &extractor{fs: os.DirFS("/")} accessForbiddenFile = utils.TempFileName("access_forbidden-", ".mp3") f, err := os.OpenFile(accessForbiddenFile, os.O_WRONLY|os.O_CREATE, 0222) @@ -212,20 +229,25 @@ var _ = Describe("Extractor", func() { }) It("correctly handle unreadable file due to insufficient read permission", func() { - _, err := e.extractMetadata(accessForbiddenFile) + // Strip leading slash for DirFS rooted at "/" + _, err := e.extractMetadata(accessForbiddenFile[1:]) Expect(err).To(MatchError(os.ErrPermission)) }) It("skips the file if it cannot be read", func() { + // Get current working directory to construct paths relative to root + cwd, err := os.Getwd() + Expect(err).ToNot(HaveOccurred()) + // Strip leading slash for DirFS rooted at "/" files := []string{ - "tests/fixtures/test.mp3", - "tests/fixtures/test.ogg", - accessForbiddenFile, + cwd[1:] + "/tests/fixtures/test.mp3", + cwd[1:] + "/tests/fixtures/test.ogg", + accessForbiddenFile[1:], } mds, err := e.Parse(files...) Expect(err).NotTo(HaveOccurred()) Expect(mds).To(HaveLen(2)) - Expect(mds).ToNot(HaveKey(accessForbiddenFile)) + Expect(mds).ToNot(HaveKey(accessForbiddenFile[1:])) }) }) }) diff --git a/core/agents/lastfm/agent.go b/adapters/lastfm/agent.go similarity index 63% rename from core/agents/lastfm/agent.go rename to adapters/lastfm/agent.go index 3f5f44d20..02c198120 100644 --- a/core/agents/lastfm/agent.go +++ b/adapters/lastfm/agent.go @@ -26,18 +26,25 @@ const ( sessionKeyProperty = "LastFMSessionKey" ) -var ignoredBiographies = []string{ - // Unknown Artist +var ignoredContent = []string{ + // Empty Artist/Album `Read more on Last\.fm\.?`) + +func cleanContent(content string) string { + return strings.TrimSpace(lastFMReadMoreRegex.ReplaceAllString(content, "")) +} + type lastfmAgent struct { ds model.DataStore sessionKeys *agents.SessionKeys apiKey string secret string - lang string + languages []string client *client + httpClient httpDoer getInfoMutex sync.Mutex } @@ -47,7 +54,7 @@ func lastFMConstructor(ds model.DataStore) *lastfmAgent { } l := &lastfmAgent{ ds: ds, - lang: conf.Server.LastFM.Language, + languages: conf.Server.LastFM.Languages, apiKey: conf.Server.LastFM.ApiKey, secret: conf.Server.LastFM.Secret, sessionKeys: &agents.SessionKeys{DataStore: ds, KeyName: sessionKeyProperty}, @@ -56,7 +63,8 @@ func lastFMConstructor(ds model.DataStore) *lastfmAgent { Timeout: consts.DefaultHttpClientTimeOut, } chc := cache.NewHTTPClient(hc, consts.DefaultHttpClientTimeOut) - l.client = newClient(l.apiKey, l.secret, l.lang, chc) + l.httpClient = chc + l.client = newClient(l.apiKey, l.secret, chc) return l } @@ -66,22 +74,54 @@ func (l *lastfmAgent) AgentName() string { var imageRegex = regexp.MustCompile(`u\/(\d+)`) +// isValidContent checks if content is non-empty and not in the ignored list +func isValidContent(content string) bool { + content = strings.TrimSpace(content) + if content == "" { + return false + } + for _, ign := range ignoredContent { + if strings.HasPrefix(content, ign) { + return false + } + } + return true +} + func (l *lastfmAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*agents.AlbumInfo, error) { - a, err := l.callAlbumGetInfo(ctx, name, artist, mbid) + var a *Album + var resp agents.AlbumInfo + for _, lang := range l.languages { + var err error + a, err = l.callAlbumGetInfo(ctx, name, artist, mbid, lang) + if err != nil { + return nil, err + } + resp.Name = a.Name + resp.MBID = a.MBID + resp.URL = a.URL + if isValidContent(a.Description.Summary) { + resp.Description = cleanContent(a.Description.Summary) + return &resp, nil + } + log.Debug(ctx, "LastFM/album.getInfo returned empty/ignored description, trying next language", "album", name, "artist", artist, "lang", lang) + } + // This condition should not be hit (languages default to ["en"]), but just in case + if a == nil { + return nil, agents.ErrNotFound + } + return &resp, nil +} + +func (l *lastfmAgent) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) { + a, err := l.callAlbumGetInfo(ctx, name, artist, mbid, l.languages[0]) if err != nil { return nil, err } - response := agents.AlbumInfo{ - Name: a.Name, - MBID: a.MBID, - Description: a.Description.Summary, - URL: a.URL, - Images: make([]agents.ExternalImage, 0), - } - // Last.fm can return duplicate sizes. seenSizes := map[int]bool{} + images := make([]agents.ExternalImage, 0) // This assumes that Last.fm returns images with size small, medium, and large. // This is true as of December 29, 2022 @@ -92,27 +132,24 @@ func (l *lastfmAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid strin log.Trace(ctx, "LastFM/albuminfo image URL does not match expected regex or is empty", "url", img.URL, "size", img.Size) continue } - numericSize, err := strconv.Atoi(size[0][2:]) if err != nil { log.Error(ctx, "LastFM/albuminfo image URL does not match expected regex", "url", img.URL, "size", img.Size, err) return nil, err - } else { - if _, exists := seenSizes[numericSize]; !exists { - response.Images = append(response.Images, agents.ExternalImage{ - Size: numericSize, - URL: img.URL, - }) - seenSizes[numericSize] = true - } + } + if _, exists := seenSizes[numericSize]; !exists { + images = append(images, agents.ExternalImage{ + Size: numericSize, + URL: img.URL, + }) + seenSizes[numericSize] = true } } - - return &response, nil + return images, nil } func (l *lastfmAgent) GetArtistMBID(ctx context.Context, id string, name string) (string, error) { - a, err := l.callArtistGetInfo(ctx, name) + a, err := l.callArtistGetInfo(ctx, name, l.languages[0]) if err != nil { return "", err } @@ -123,7 +160,7 @@ func (l *lastfmAgent) GetArtistMBID(ctx context.Context, id string, name string) } func (l *lastfmAgent) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { - a, err := l.callArtistGetInfo(ctx, name) + a, err := l.callArtistGetInfo(ctx, name, l.languages[0]) if err != nil { return "", err } @@ -134,20 +171,17 @@ func (l *lastfmAgent) GetArtistURL(ctx context.Context, id, name, mbid string) ( } func (l *lastfmAgent) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { - a, err := l.callArtistGetInfo(ctx, name) - if err != nil { - return "", err - } - a.Bio.Summary = strings.TrimSpace(a.Bio.Summary) - if a.Bio.Summary == "" { - return "", agents.ErrNotFound - } - for _, ign := range ignoredBiographies { - if strings.HasPrefix(a.Bio.Summary, ign) { - return "", nil + for _, lang := range l.languages { + a, err := l.callArtistGetInfo(ctx, name, lang) + if err != nil { + return "", err } + if isValidContent(a.Bio.Summary) { + return cleanContent(a.Bio.Summary), nil + } + log.Debug(ctx, "LastFM/artist.getInfo returned empty/ignored biography, trying next language", "artist", name, "lang", lang) } - return a.Bio.Summary, nil + return "", agents.ErrNotFound } func (l *lastfmAgent) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]agents.Artist, error) { @@ -186,14 +220,34 @@ func (l *lastfmAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbi return res, nil } -var artistOpenGraphQuery = cascadia.MustCompile(`html > head > meta[property="og:image"]`) +func (l *lastfmAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + resp, err := l.callTrackGetSimilar(ctx, name, artist, count) + if err != nil { + return nil, err + } + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + res := make([]agents.Song, 0, len(resp)) + for _, t := range resp { + res = append(res, agents.Song{ + Name: t.Name, + MBID: t.MBID, + Artist: t.Artist.Name, + ArtistMBID: t.Artist.MBID, + }) + } + return res, nil +} + +var ( + artistOpenGraphQuery = cascadia.MustCompile(`html > head > meta[property="og:image"]`) + artistIgnoredImage = "2a96cbd8b46e442fc41c2b86b821562f" // Last.fm artist placeholder image name +) func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) ([]agents.ExternalImage, error) { log.Debug(ctx, "Getting artist images from Last.fm", "name", name) - hc := http.Client{ - Timeout: consts.DefaultHttpClientTimeOut, - } - a, err := l.callArtistGetInfo(ctx, name) + a, err := l.callArtistGetInfo(ctx, name, l.languages[0]) if err != nil { return nil, fmt.Errorf("get artist info: %w", err) } @@ -201,7 +255,7 @@ func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) if err != nil { return nil, fmt.Errorf("create artist image request: %w", err) } - resp, err := hc.Do(req) + resp, err := l.httpClient.Do(req) if err != nil { return nil, fmt.Errorf("get artist url: %w", err) } @@ -218,24 +272,29 @@ func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) return res, nil } for _, attr := range n.Attr { - if attr.Key == "content" { - res = []agents.ExternalImage{ - {URL: attr.Val}, - } - break + if attr.Key != "content" { + continue + } + if strings.Contains(attr.Val, artistIgnoredImage) { + log.Debug(ctx, "Artist image is ignored default image", "name", name, "url", attr.Val) + return res, nil + } + + res = []agents.ExternalImage{ + {URL: attr.Val}, } } return res, nil } -func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid string) (*Album, error) { - a, err := l.client.albumGetInfo(ctx, name, artist, mbid) +func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid string, lang string) (*Album, error) { + a, err := l.client.albumGetInfo(ctx, name, artist, mbid, lang) var lfErr *lastFMError isLastFMError := errors.As(err, &lfErr) if mbid != "" && (isLastFMError && lfErr.Code == 6) { log.Debug(ctx, "LastFM/album.getInfo could not find album by mbid, trying again", "album", name, "mbid", mbid) - return l.callAlbumGetInfo(ctx, name, artist, "") + return l.callAlbumGetInfo(ctx, name, artist, "", lang) } if err != nil { @@ -249,11 +308,11 @@ func (l *lastfmAgent) callAlbumGetInfo(ctx context.Context, name, artist, mbid s return a, nil } -func (l *lastfmAgent) callArtistGetInfo(ctx context.Context, name string) (*Artist, error) { +func (l *lastfmAgent) callArtistGetInfo(ctx context.Context, name string, lang string) (*Artist, error) { l.getInfoMutex.Lock() defer l.getInfoMutex.Unlock() - a, err := l.client.artistGetInfo(ctx, name) + a, err := l.client.artistGetInfo(ctx, name, lang) if err != nil { log.Error(ctx, "Error calling LastFM/artist.getInfo", "artist", name, err) return nil, err @@ -279,20 +338,36 @@ func (l *lastfmAgent) callArtistGetTopTracks(ctx context.Context, artistName str return t.Track, nil } -func (l *lastfmAgent) NowPlaying(ctx context.Context, userId string, track *model.MediaFile) error { +func (l *lastfmAgent) callTrackGetSimilar(ctx context.Context, name, artist string, count int) ([]SimilarTrack, error) { + s, err := l.client.trackGetSimilar(ctx, name, artist, count) + if err != nil { + log.Error(ctx, "Error calling LastFM/track.getSimilar", "track", name, "artist", artist, err) + return nil, err + } + return s.Track, nil +} + +func (l *lastfmAgent) getArtistForScrobble(track *model.MediaFile, role model.Role, displayName string) string { + if conf.Server.LastFM.ScrobbleFirstArtistOnly && len(track.Participants[role]) > 0 { + return track.Participants[role][0].Name + } + return displayName +} + +func (l *lastfmAgent) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { sk, err := l.sessionKeys.Get(ctx, userId) if err != nil || sk == "" { return scrobbler.ErrNotAuthorized } err = l.client.updateNowPlaying(ctx, sk, ScrobbleInfo{ - artist: track.Artist, + artist: l.getArtistForScrobble(track, model.RoleArtist, track.Artist), track: track.Title, album: track.Album, trackNumber: track.TrackNumber, mbid: track.MbzRecordingID, duration: int(track.Duration), - albumArtist: track.AlbumArtist, + albumArtist: l.getArtistForScrobble(track, model.RoleAlbumArtist, track.AlbumArtist), }) if err != nil { log.Warn(ctx, "Last.fm client.updateNowPlaying returned error", "track", track.Title, err) @@ -312,13 +387,13 @@ func (l *lastfmAgent) Scrobble(ctx context.Context, userId string, s scrobbler.S return nil } err = l.client.scrobble(ctx, sk, ScrobbleInfo{ - artist: s.Artist, + artist: l.getArtistForScrobble(&s.MediaFile, model.RoleArtist, s.Artist), track: s.Title, album: s.Album, trackNumber: s.TrackNumber, mbid: s.MbzRecordingID, duration: int(s.Duration), - albumArtist: s.AlbumArtist, + albumArtist: l.getArtistForScrobble(&s.MediaFile, model.RoleAlbumArtist, s.AlbumArtist), timestamp: s.TimeStamp, }) if err == nil { @@ -341,6 +416,10 @@ func (l *lastfmAgent) IsAuthorized(ctx context.Context, userId string) bool { return err == nil && sk != "" } +func (l *lastfmAgent) PlaybackReport(context.Context, scrobbler.PlaybackSession) error { + return nil +} + func init() { conf.AddHook(func() { agents.Register(lastFMAgentName, func(ds model.DataStore) agents.Interface { diff --git a/core/agents/lastfm/agent_test.go b/adapters/lastfm/agent_test.go similarity index 52% rename from core/agents/lastfm/agent_test.go rename to adapters/lastfm/agent_test.go index de4fac6d6..94788b8bd 100644 --- a/core/agents/lastfm/agent_test.go +++ b/adapters/lastfm/agent_test.go @@ -6,6 +6,7 @@ import ( "errors" "io" "net/http" + "net/url" "os" "strconv" "time" @@ -38,12 +39,12 @@ var _ = Describe("lastfmAgent", func() { }) Describe("lastFMConstructor", func() { When("Agent is properly configured", func() { - It("uses configured api key and language", func() { - conf.Server.LastFM.Language = "pt" + It("uses configured api key and languages", func() { + conf.Server.LastFM.Languages = []string{"pt", "en"} agent := lastFMConstructor(ds) Expect(agent.apiKey).To(Equal("123")) Expect(agent.secret).To(Equal("secret")) - Expect(agent.lang).To(Equal("pt")) + Expect(agent.languages).To(Equal([]string{"pt", "en"})) }) }) When("Agent is disabled", func() { @@ -71,7 +72,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -79,7 +80,7 @@ var _ = Describe("lastfmAgent", func() { It("returns the biography", func() { f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - Expect(agent.GetArtistBiography(ctx, "123", "U2", "")).To(Equal("U2 é uma das mais importantes bandas de rock de todos os tempos. Formada em 1976 em Dublin, composta por Bono (vocalista e guitarrista), The Edge (guitarrista, pianista e backing vocal), Adam Clayton (baixista), Larry Mullen, Jr. (baterista e percussionista).\n\nDesde a década de 80, U2 é uma das bandas mais populares no mundo. Seus shows são únicos e um verdadeiro festival de efeitos especiais, além de serem um dos que mais arrecadam anualmente. Read more on Last.fm")) + Expect(agent.GetArtistBiography(ctx, "123", "U2", "")).To(Equal("U2 é uma das mais importantes bandas de rock de todos os tempos. Formada em 1976 em Dublin, composta por Bono (vocalista e guitarrista), The Edge (guitarrista, pianista e backing vocal), Adam Clayton (baixista), Larry Mullen, Jr. (baterista e percussionista).\n\nDesde a década de 80, U2 é uma das bandas mais populares no mundo. Seus shows são únicos e um verdadeiro festival de efeitos especiais, além de serem um dos que mais arrecadam anualmente.")) Expect(httpClient.RequestCount).To(Equal(1)) Expect(httpClient.SavedRequest.URL.Query().Get("artist")).To(Equal("U2")) }) @@ -101,12 +102,129 @@ var _ = Describe("lastfmAgent", func() { }) }) + Describe("Language Fallback", func() { + Describe("GetArtistBiography", func() { + var agent *lastfmAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + }) + + It("returns content in first language when available (1 API call)", func() { + conf.Server.LastFM.Languages = []string{"pt", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Portuguese biography available + f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + httpClient.responses["pt"] = http.Response{Body: f, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "123", "U2", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("U2 é uma das mais importantes bandas de rock")) + Expect(httpClient.requestCount).To(Equal(1)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("pt")) + }) + + It("falls back to second language when first returns empty (2 API calls)", func() { + conf.Server.LastFM.Languages = []string{"ja", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Japanese returns empty/ignored biography (actual Last.fm response with just "Read more" link) + fJa, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // English returns full biography + fEn, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.en.json") + httpClient.responses["en"] = http.Response{Body: fEn, StatusCode: 200} + + bio, err := agent.GetArtistBiography(ctx, "123", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(ContainSubstring("Legião Urbana was a Brazilian post-punk band")) + Expect(httpClient.requestCount).To(Equal(2)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("ja")) + Expect(httpClient.requests[1].URL.Query().Get("lang")).To(Equal("en")) + }) + + It("returns ErrNotFound when all languages return empty", func() { + conf.Server.LastFM.Languages = []string{"ja", "xx"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Both languages return empty/ignored biography (using actual Last.fm response format) + fJa, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // Second language also returns empty + fXx, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.empty.json") + httpClient.responses["xx"] = http.Response{Body: fXx, StatusCode: 200} + + _, err := agent.GetArtistBiography(ctx, "123", "Legião Urbana", "") + + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.requestCount).To(Equal(2)) + }) + }) + + Describe("GetAlbumInfo", func() { + var agent *lastfmAgent + var httpClient *langAwareHttpClient + + BeforeEach(func() { + httpClient = newLangAwareHttpClient() + }) + + It("falls back to second language when first returns empty description (2 API calls)", func() { + conf.Server.LastFM.Languages = []string{"ja", "en"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Japanese returns album without wiki/description (actual Last.fm response) + fJa, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + // English returns album with description + fEn, _ := os.Open("tests/fixtures/lastfm.album.getinfo.en.json") + httpClient.responses["en"] = http.Response{Body: fEn, StatusCode: 200} + + albumInfo, err := agent.GetAlbumInfo(ctx, "Dois", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(albumInfo.Name).To(Equal("Dois")) + Expect(albumInfo.Description).To(ContainSubstring("segundo álbum de estúdio")) + Expect(httpClient.requestCount).To(Equal(2)) + Expect(httpClient.requests[0].URL.Query().Get("lang")).To(Equal("ja")) + Expect(httpClient.requests[1].URL.Query().Get("lang")).To(Equal("en")) + }) + + It("returns album without description when all languages return empty", func() { + conf.Server.LastFM.Languages = []string{"ja", "xx"} + agent = lastFMConstructor(ds) + agent.client = newClient("API_KEY", "SECRET", httpClient) + + // Both languages return album without description + fJa, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["ja"] = http.Response{Body: fJa, StatusCode: 200} + fXx, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty.json") + httpClient.responses["xx"] = http.Response{Body: fXx, StatusCode: 200} + + albumInfo, err := agent.GetAlbumInfo(ctx, "Dois", "Legião Urbana", "") + + Expect(err).ToNot(HaveOccurred()) + Expect(albumInfo.Name).To(Equal("Dois")) + Expect(albumInfo.Description).To(BeEmpty()) + Expect(httpClient.requestCount).To(Equal(2)) + }) + }) + }) + Describe("GetSimilarArtists", func() { var agent *lastfmAgent var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -144,7 +262,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -177,6 +295,54 @@ var _ = Describe("lastfmAgent", func() { }) }) + Describe("GetSimilarSongsByTrack", func() { + var agent *lastfmAgent + var httpClient *tests.FakeHttpClient + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("API_KEY", "SECRET", httpClient) + agent = lastFMConstructor(ds) + agent.client = client + }) + + It("returns similar songs", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + Expect(agent.GetSimilarSongsByTrack(ctx, "123", "Just Can't Get Enough", "Depeche Mode", "", 5)).To(Equal([]agents.Song{ + {Name: "Dreaming of Me", MBID: "027b553e-7c74-3ed4-a95e-1d4fea51f174", Artist: "Depeche Mode", ArtistMBID: "8538e728-ca0b-4321-b7e5-cff6565dd4c0"}, + {Name: "Everything Counts", MBID: "5a5a3ca4-bdb8-4641-a674-9b54b9b319a6", Artist: "Depeche Mode", ArtistMBID: "8538e728-ca0b-4321-b7e5-cff6565dd4c0"}, + {Name: "Don't You Want Me", MBID: "", Artist: "The Human League", ArtistMBID: "7adaabfb-acfb-47bc-8c7c-59471c2f0db8"}, + {Name: "Tainted Love", MBID: "", Artist: "Soft Cell", ArtistMBID: "7fb50287-029d-47cc-825a-235ca28024b2"}, + {Name: "Blue Monday", MBID: "727e84c6-1b56-31dd-a958-a5f46305cec0", Artist: "New Order", ArtistMBID: "f1106b17-dcbb-45f6-b938-199ccfab50cc"}, + })) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("track")).To(Equal("Just Can't Get Enough")) + Expect(httpClient.SavedRequest.URL.Query().Get("artist")).To(Equal("Depeche Mode")) + }) + + It("returns ErrNotFound when no similar songs found", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.unknown.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "UnknownTrack", "UnknownArtist", "", 3) + Expect(err).To(MatchError(agents.ErrNotFound)) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + + It("returns an error if Last.fm call fails", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "Believe", "Cher", "", 3) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + + It("returns an error if Last.fm call returns an error", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(lastfmError3)), StatusCode: 200} + _, err := agent.GetSimilarSongsByTrack(ctx, "123", "Believe", "Cher", "", 3) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + }) + }) + Describe("Scrobbling", func() { var agent *lastfmAgent var httpClient *tests.FakeHttpClient @@ -184,7 +350,7 @@ var _ = Describe("lastfmAgent", func() { BeforeEach(func() { _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1") httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "en", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client track = &model.MediaFile{ @@ -196,6 +362,16 @@ var _ = Describe("lastfmAgent", func() { TrackNumber: 1, Duration: 180, MbzRecordingID: "mbz-123", + Participants: map[model.Role]model.ParticipantList{ + model.RoleArtist: []model.Participant{ + {Artist: model.Artist{ID: "ar-1", Name: "First Artist"}}, + {Artist: model.Artist{ID: "ar-2", Name: "Second Artist"}}, + }, + model.RoleAlbumArtist: []model.Participant{ + {Artist: model.Artist{ID: "ar-1", Name: "First Album Artist"}}, + {Artist: model.Artist{ID: "ar-2", Name: "Second Album Artist"}}, + }, + }, } }) @@ -203,11 +379,12 @@ var _ = Describe("lastfmAgent", func() { It("calls Last.fm with correct params", func() { httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString("{}")), StatusCode: 200} - err := agent.NowPlaying(ctx, "user-1", track) + err := agent.NowPlaying(ctx, "user-1", track, 0) Expect(err).ToNot(HaveOccurred()) Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("method")).To(Equal("track.updateNowPlaying")) Expect(sentParams.Get("sk")).To(Equal("SK-1")) Expect(sentParams.Get("track")).To(Equal(track.Title)) @@ -220,9 +397,27 @@ var _ = Describe("lastfmAgent", func() { }) It("returns ErrNotAuthorized if user is not linked", func() { - err := agent.NowPlaying(ctx, "user-2", track) + err := agent.NowPlaying(ctx, "user-2", track, 0) Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) }) + + When("ScrobbleFirstArtistOnly is true", func() { + BeforeEach(func() { + conf.Server.LastFM.ScrobbleFirstArtistOnly = true + }) + + It("uses only the first artist", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString("{}")), StatusCode: 200} + + err := agent.NowPlaying(ctx, "user-1", track, 0) + + Expect(err).ToNot(HaveOccurred()) + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) + Expect(sentParams.Get("artist")).To(Equal("First Artist")) + Expect(sentParams.Get("albumArtist")).To(Equal("First Album Artist")) + }) + }) }) Describe("scrobble", func() { @@ -234,7 +429,8 @@ var _ = Describe("lastfmAgent", func() { Expect(err).ToNot(HaveOccurred()) Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - sentParams := httpClient.SavedRequest.URL.Query() + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) Expect(sentParams.Get("method")).To(Equal("track.scrobble")) Expect(sentParams.Get("sk")).To(Equal("SK-1")) Expect(sentParams.Get("track")).To(Equal(track.Title)) @@ -247,6 +443,25 @@ var _ = Describe("lastfmAgent", func() { Expect(sentParams.Get("timestamp")).To(Equal(strconv.FormatInt(ts.Unix(), 10))) }) + When("ScrobbleFirstArtistOnly is true", func() { + BeforeEach(func() { + conf.Server.LastFM.ScrobbleFirstArtistOnly = true + }) + + It("uses only the first artist", func() { + ts := time.Now() + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString("{}")), StatusCode: 200} + + err := agent.Scrobble(ctx, "user-1", scrobbler.Scrobble{MediaFile: *track, TimeStamp: ts}) + + Expect(err).ToNot(HaveOccurred()) + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + sentParams, _ := url.ParseQuery(string(body)) + Expect(sentParams.Get("artist")).To(Equal("First Artist")) + Expect(sentParams.Get("albumArtist")).To(Equal("First Album Artist")) + }) + }) + It("skips songs with less than 31 seconds", func() { track.Duration = 29 httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString("{}")), StatusCode: 200} @@ -309,7 +524,7 @@ var _ = Describe("lastfmAgent", func() { var httpClient *tests.FakeHttpClient BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client := newClient("API_KEY", "SECRET", "pt", httpClient) + client := newClient("API_KEY", "SECRET", httpClient) agent = lastFMConstructor(ds) agent.client = client }) @@ -320,26 +535,8 @@ var _ = Describe("lastfmAgent", func() { Expect(agent.GetAlbumInfo(ctx, "Believe", "Cher", "03c91c40-49a6-44a7-90e7-a700edf97a62")).To(Equal(&agents.AlbumInfo{ Name: "Believe", MBID: "03c91c40-49a6-44a7-90e7-a700edf97a62", - Description: "Believe is the twenty-third studio album by American singer-actress Cher, released on November 10, 1998 by Warner Bros. Records. The RIAA certified it Quadruple Platinum on December 23, 1999, recognizing four million shipments in the United States; Worldwide, the album has sold more than 20 million copies, making it the biggest-selling album of her career. In 1999 the album received three Grammy Awards nominations including \"Record of the Year\", \"Best Pop Album\" and winning \"Best Dance Recording\" for the single \"Believe\". It was released by Warner Bros. Records at the end of 1998. The album was executive produced by Rob Read more on Last.fm.", + Description: "Believe is the twenty-third studio album by American singer-actress Cher, released on November 10, 1998 by Warner Bros. Records. The RIAA certified it Quadruple Platinum on December 23, 1999, recognizing four million shipments in the United States; Worldwide, the album has sold more than 20 million copies, making it the biggest-selling album of her career. In 1999 the album received three Grammy Awards nominations including \"Record of the Year\", \"Best Pop Album\" and winning \"Best Dance Recording\" for the single \"Believe\". It was released by Warner Bros. Records at the end of 1998. The album was executive produced by Rob", URL: "https://www.last.fm/music/Cher/Believe", - Images: []agents.ExternalImage{ - { - URL: "https://lastfm.freetls.fastly.net/i/u/34s/3b54885952161aaea4ce2965b2db1638.png", - Size: 34, - }, - { - URL: "https://lastfm.freetls.fastly.net/i/u/64s/3b54885952161aaea4ce2965b2db1638.png", - Size: 64, - }, - { - URL: "https://lastfm.freetls.fastly.net/i/u/174s/3b54885952161aaea4ce2965b2db1638.png", - Size: 174, - }, - { - URL: "https://lastfm.freetls.fastly.net/i/u/300x300/3b54885952161aaea4ce2965b2db1638.png", - Size: 300, - }, - }, })) Expect(httpClient.RequestCount).To(Equal(1)) Expect(httpClient.SavedRequest.URL.Query().Get("mbid")).To(Equal("03c91c40-49a6-44a7-90e7-a700edf97a62")) @@ -349,9 +546,8 @@ var _ = Describe("lastfmAgent", func() { f, _ := os.Open("tests/fixtures/lastfm.album.getinfo.empty_urls.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} Expect(agent.GetAlbumInfo(ctx, "The Definitive Less Damage And More Joy", "The Jesus and Mary Chain", "")).To(Equal(&agents.AlbumInfo{ - Name: "The Definitive Less Damage And More Joy", - URL: "https://www.last.fm/music/The+Jesus+and+Mary+Chain/The+Definitive+Less+Damage+And+More+Joy", - Images: []agents.ExternalImage{}, + Name: "The Definitive Less Damage And More Joy", + URL: "https://www.last.fm/music/The+Jesus+and+Mary+Chain/The+Definitive+Less+Damage+And+More+Joy", })) Expect(httpClient.RequestCount).To(Equal(1)) Expect(httpClient.SavedRequest.URL.Query().Get("album")).To(Equal("The Definitive Less Damage And More Joy")) @@ -389,4 +585,101 @@ var _ = Describe("lastfmAgent", func() { }) }) }) + + Describe("GetArtistImages", func() { + var agent *lastfmAgent + var apiClient *tests.FakeHttpClient + var httpClient *tests.FakeHttpClient + + BeforeEach(func() { + apiClient = &tests.FakeHttpClient{} + httpClient = &tests.FakeHttpClient{} + client := newClient("API_KEY", "SECRET", apiClient) + agent = lastFMConstructor(ds) + agent.client = client + agent.httpClient = httpClient + }) + + It("returns the artist image from the page", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.html") + httpClient.Res = http.Response{Body: fScraper, StatusCode: 200} + + images, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(HaveLen(1)) + Expect(images[0].URL).To(Equal("https://lastfm.freetls.fastly.net/i/u/ar0/818148bf682d429dc21b59a73ef6f68e.png")) + }) + + It("returns empty list if image is the ignored default image", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.ignored.html") + httpClient.Res = http.Response{Body: fScraper, StatusCode: 200} + + images, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(BeEmpty()) + }) + + It("returns empty list if page has no meta tags", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.no_meta.html") + httpClient.Res = http.Response{Body: fScraper, StatusCode: 200} + + images, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(BeEmpty()) + }) + + It("returns error if API call fails", func() { + apiClient.Err = errors.New("api error") + _, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("get artist info")) + }) + + It("returns error if scraper call fails", func() { + fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") + apiClient.Res = http.Response{Body: fApi, StatusCode: 200} + + httpClient.Err = errors.New("scraper error") + _, err := agent.GetArtistImages(ctx, "123", "U2", "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("get artist url")) + }) + }) }) + +// langAwareHttpClient is a mock HTTP client that returns different responses based on the lang parameter +type langAwareHttpClient struct { + responses map[string]http.Response + requests []*http.Request + requestCount int +} + +func newLangAwareHttpClient() *langAwareHttpClient { + return &langAwareHttpClient{ + responses: make(map[string]http.Response), + requests: make([]*http.Request, 0), + } +} + +func (c *langAwareHttpClient) Do(req *http.Request) (*http.Response, error) { + c.requestCount++ + c.requests = append(c.requests, req) + lang := req.URL.Query().Get("lang") + if resp, ok := c.responses[lang]; ok { + return &resp, nil + } + // Return default empty response if no specific response is configured + return &http.Response{ + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`{}`)), + }, nil +} diff --git a/core/agents/lastfm/auth_router.go b/adapters/lastfm/auth_router.go similarity index 83% rename from core/agents/lastfm/auth_router.go rename to adapters/lastfm/auth_router.go index 290caaad3..499863e28 100644 --- a/core/agents/lastfm/auth_router.go +++ b/adapters/lastfm/auth_router.go @@ -44,7 +44,7 @@ func NewRouter(ds model.DataStore) *Router { hc := &http.Client{ Timeout: consts.DefaultHttpClientTimeOut, } - r.client = newClient(r.apiKey, r.secret, "en", hc) + r.client = newClient(r.apiKey, r.secret, hc) return r } @@ -65,7 +65,7 @@ func (s *Router) routes() http.Handler { } func (s *Router) getLinkStatus(w http.ResponseWriter, r *http.Request) { - resp := map[string]interface{}{ + resp := map[string]any{ "apiKey": s.apiKey, } u, _ := request.UserFrom(r.Context()) @@ -77,6 +77,13 @@ func (s *Router) getLinkStatus(w http.ResponseWriter, r *http.Request) { return } resp["status"] = key != "" + linkToken, err := createLinkToken(u.ID) + if err != nil { + log.Error(r.Context(), "Could not create LastFM link token", "userId", u.ID, err) + _ = rest.RespondWithError(w, http.StatusInternalServerError, err.Error()) + return + } + resp["linkToken"] = linkToken _ = rest.RespondWithJSON(w, http.StatusOK, resp) } @@ -97,11 +104,17 @@ func (s *Router) callback(w http.ResponseWriter, r *http.Request) { _ = rest.RespondWithError(w, http.StatusBadRequest, "token not received") return } - uid, err := p.String("uid") + linkToken, err := p.String("uid") if err != nil { _ = rest.RespondWithError(w, http.StatusBadRequest, "uid not received") return } + uid, err := verifyLinkToken(linkToken) + if err != nil { + log.Warn(r.Context(), "Rejected LastFM callback with invalid link token", "requestId", middleware.GetReqID(r.Context()), err) + _ = rest.RespondWithError(w, http.StatusBadRequest, "invalid link token") + return + } // Need to add user to context, as this is a non-authenticated endpoint, so it does not // automatically contain any user info @@ -110,7 +123,7 @@ func (s *Router) callback(w http.ResponseWriter, r *http.Request) { if err != nil { w.Header().Set("Content-Type", "text/plain; charset=utf-8") w.WriteHeader(http.StatusBadRequest) - _, _ = w.Write([]byte("An error occurred while authorizing with Last.fm. \n\nRequest ID: " + middleware.GetReqID(ctx))) + _, _ = w.Write([]byte("An error occurred while authorizing with Last.fm. \n\nRequest ID: " + middleware.GetReqID(ctx))) //nolint:gosec return } diff --git a/adapters/lastfm/auth_router_test.go b/adapters/lastfm/auth_router_test.go new file mode 100644 index 000000000..4cbbd4298 --- /dev/null +++ b/adapters/lastfm/auth_router_test.go @@ -0,0 +1,218 @@ +package lastfm + +import ( + "bytes" + "encoding/json" + "io" + "net/http" + "net/http/httptest" + "time" + + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("auth_router", func() { + var ( + ds *tests.MockDataStore + userProps *tests.MockedUserPropsRepo + httpClient *tests.FakeHttpClient + router *Router + ) + + const ( + victimID = "victim-user-id" + attackerID = "attacker-user-id" + ) + + BeforeEach(func() { + userProps = &tests.MockedUserPropsRepo{} + ds = &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedUserProps: userProps, + } + auth.Init(ds) + + httpClient = &tests.FakeHttpClient{} + router = &Router{ + ds: ds, + apiKey: "API_KEY", + secret: "SECRET", + sessionKeys: &agents.SessionKeys{DataStore: ds, KeyName: sessionKeyProperty}, + } + router.client = newClient(router.apiKey, router.secret, httpClient) + router.Handler = router.routes() + }) + + storedSessionKey := func(userID string) string { + key, _ := userProps.Get(userID, sessionKeyProperty) + return key + } + + stubGetSessionOK := func(sessionKey string) { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"session":{"name":"Navidrome","key":"` + sessionKey + `","subscriber":0}}`)), + StatusCode: 200, + } + } + + Describe("getLinkStatus", func() { + It("includes a signed linkToken for the authenticated user", func() { + req := httptest.NewRequest(http.MethodGet, "/link", nil) + ctx := request.WithUser(req.Context(), model.User{ID: victimID}) + req = req.WithContext(ctx) + rec := httptest.NewRecorder() + + router.getLinkStatus(rec, req) + + Expect(rec.Code).To(Equal(http.StatusOK)) + var body map[string]any + Expect(json.Unmarshal(rec.Body.Bytes(), &body)).To(Succeed()) + Expect(body["apiKey"]).To(Equal("API_KEY")) + Expect(body["status"]).To(Equal(false)) + token, ok := body["linkToken"].(string) + Expect(ok).To(BeTrue()) + Expect(token).ToNot(BeEmpty()) + + verified, err := verifyLinkToken(token) + Expect(err).ToNot(HaveOccurred()) + Expect(verified).To(Equal(victimID)) + }) + }) + + Describe("callback", func() { + It("stores the session key under the user encoded in the signed token", func() { + stubGetSessionOK("LEGIT_SESSION") + linkToken, err := createLinkToken(victimID) + Expect(err).ToNot(HaveOccurred()) + + req := httptest.NewRequest(http.MethodGet, "/link/callback?uid="+linkToken+"&token=LASTFM_TOKEN", nil) + rec := httptest.NewRecorder() + router.callback(rec, req) + + Expect(rec.Code).To(Equal(http.StatusOK)) + Expect(storedSessionKey(victimID)).To(Equal("LEGIT_SESSION")) + }) + + It("rejects a raw (unsigned) uid value", func() { + req := httptest.NewRequest(http.MethodGet, "/link/callback?uid="+victimID+"&token=LASTFM_TOKEN", nil) + rec := httptest.NewRecorder() + router.callback(rec, req) + + Expect(rec.Code).To(Equal(http.StatusBadRequest)) + Expect(storedSessionKey(victimID)).To(BeEmpty()) + Expect(httpClient.SavedRequest).To(BeNil()) + }) + + It("rejects an expired link token", func() { + expiredToken, err := auth.EncodeToken(map[string]any{ + "uid": victimID, + "scope": linkTokenScope, + "exp": time.Now().Add(-1 * time.Minute).UTC().Unix(), + }) + Expect(err).ToNot(HaveOccurred()) + + req := httptest.NewRequest(http.MethodGet, "/link/callback?uid="+expiredToken+"&token=LASTFM_TOKEN", nil) + rec := httptest.NewRecorder() + router.callback(rec, req) + + Expect(rec.Code).To(Equal(http.StatusBadRequest)) + Expect(storedSessionKey(victimID)).To(BeEmpty()) + Expect(httpClient.SavedRequest).To(BeNil()) + }) + + It("rejects a token with the wrong scope (e.g. a regular session JWT)", func() { + sessionJWT, err := auth.CreateToken(&model.User{ID: attackerID, UserName: "attacker"}) + Expect(err).ToNot(HaveOccurred()) + + req := httptest.NewRequest(http.MethodGet, "/link/callback?uid="+sessionJWT+"&token=LASTFM_TOKEN", nil) + rec := httptest.NewRecorder() + router.callback(rec, req) + + Expect(rec.Code).To(Equal(http.StatusBadRequest)) + Expect(storedSessionKey(attackerID)).To(BeEmpty()) + Expect(httpClient.SavedRequest).To(BeNil()) + }) + + It("writes only under the user encoded in the token, regardless of query manipulation", func() { + // An attacker holds a legitimate link token for their own account. + // They attempt to call the callback hoping to overwrite the victim's + // session key — but the handler must derive the user ID from the + // signed token, not from any other input. + stubGetSessionOK("ATTACKER_SESSION") + attackerToken, err := createLinkToken(attackerID) + Expect(err).ToNot(HaveOccurred()) + + req := httptest.NewRequest(http.MethodGet, "/link/callback?uid="+attackerToken+"&token=LASTFM_TOKEN&user="+victimID, nil) + rec := httptest.NewRecorder() + router.callback(rec, req) + + Expect(rec.Code).To(Equal(http.StatusOK)) + Expect(storedSessionKey(attackerID)).To(Equal("ATTACKER_SESSION")) + Expect(storedSessionKey(victimID)).To(BeEmpty()) + }) + + It("returns 400 when uid is missing", func() { + req := httptest.NewRequest(http.MethodGet, "/link/callback?token=LASTFM_TOKEN", nil) + rec := httptest.NewRecorder() + router.callback(rec, req) + + Expect(rec.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 when token is missing", func() { + linkToken, err := createLinkToken(victimID) + Expect(err).ToNot(HaveOccurred()) + + req := httptest.NewRequest(http.MethodGet, "/link/callback?uid="+linkToken, nil) + rec := httptest.NewRecorder() + router.callback(rec, req) + + Expect(rec.Code).To(Equal(http.StatusBadRequest)) + }) + }) + + Describe("link token helpers", func() { + It("round-trips a freshly issued token", func() { + token, err := createLinkToken(victimID) + Expect(err).ToNot(HaveOccurred()) + + uid, err := verifyLinkToken(token) + Expect(err).ToNot(HaveOccurred()) + Expect(uid).To(Equal(victimID)) + }) + + It("rejects garbage", func() { + _, err := verifyLinkToken("not-a-jwt") + Expect(err).To(HaveOccurred()) + }) + + It("rejects a token whose scope claim is wrong", func() { + wrongScopeToken, err := auth.EncodeToken(map[string]any{ + "uid": victimID, + "scope": "some-other-scope", + "exp": time.Now().Add(linkTokenTTL).UTC().Unix(), + }) + Expect(err).ToNot(HaveOccurred()) + + _, err = verifyLinkToken(wrongScopeToken) + Expect(err).To(MatchError("invalid link token scope")) + }) + + It("rejects a scoped token that has no expiration", func() { + nonExpiringToken, err := auth.EncodeToken(map[string]any{ + "uid": victimID, + "scope": linkTokenScope, + }) + Expect(err).ToNot(HaveOccurred()) + + _, err = verifyLinkToken(nonExpiringToken) + Expect(err).To(MatchError("link token missing expiration")) + }) + }) +}) diff --git a/core/agents/lastfm/client.go b/adapters/lastfm/client.go similarity index 84% rename from core/agents/lastfm/client.go rename to adapters/lastfm/client.go index 6a24ac80a..726df1360 100644 --- a/core/agents/lastfm/client.go +++ b/adapters/lastfm/client.go @@ -34,24 +34,23 @@ type httpDoer interface { Do(req *http.Request) (*http.Response, error) } -func newClient(apiKey string, secret string, lang string, hc httpDoer) *client { - return &client{apiKey, secret, lang, hc} +func newClient(apiKey string, secret string, hc httpDoer) *client { + return &client{apiKey, secret, hc} } type client struct { apiKey string secret string - lang string hc httpDoer } -func (c *client) albumGetInfo(ctx context.Context, name string, artist string, mbid string) (*Album, error) { +func (c *client) albumGetInfo(ctx context.Context, name string, artist string, mbid string, lang string) (*Album, error) { params := url.Values{} params.Add("method", "album.getInfo") params.Add("album", name) params.Add("artist", artist) params.Add("mbid", mbid) - params.Add("lang", c.lang) + params.Add("lang", lang) response, err := c.makeRequest(ctx, http.MethodGet, params, false) if err != nil { return nil, err @@ -59,11 +58,11 @@ func (c *client) albumGetInfo(ctx context.Context, name string, artist string, m return &response.Album, nil } -func (c *client) artistGetInfo(ctx context.Context, name string) (*Artist, error) { +func (c *client) artistGetInfo(ctx context.Context, name string, lang string) (*Artist, error) { params := url.Values{} params.Add("method", "artist.getInfo") params.Add("artist", name) - params.Add("lang", c.lang) + params.Add("lang", lang) response, err := c.makeRequest(ctx, http.MethodGet, params, false) if err != nil { return nil, err @@ -95,6 +94,19 @@ func (c *client) artistGetTopTracks(ctx context.Context, name string, limit int) return &response.TopTracks, nil } +func (c *client) trackGetSimilar(ctx context.Context, name, artist string, limit int) (*SimilarTracks, error) { + params := url.Values{} + params.Add("method", "track.getSimilar") + params.Add("track", name) + params.Add("artist", artist) + params.Add("limit", strconv.Itoa(limit)) + response, err := c.makeRequest(ctx, http.MethodGet, params, false) + if err != nil { + return nil, err + } + return &response.SimilarTracks, nil +} + func (c *client) GetToken(ctx context.Context) (string, error) { params := url.Values{} params.Add("method", "auth.getToken") @@ -185,8 +197,15 @@ func (c *client) makeRequest(ctx context.Context, method string, params url.Valu c.sign(params) } - req, _ := http.NewRequestWithContext(ctx, method, apiBaseUrl, nil) - req.URL.RawQuery = params.Encode() + var req *http.Request + if method == http.MethodPost { + body := strings.NewReader(params.Encode()) + req, _ = http.NewRequestWithContext(ctx, method, apiBaseUrl, body) + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + } else { + req, _ = http.NewRequestWithContext(ctx, method, apiBaseUrl, nil) + req.URL.RawQuery = params.Encode() + } log.Trace(ctx, fmt.Sprintf("Sending Last.fm %s request", req.Method), "url", req.URL) resp, err := c.hc.Do(req) diff --git a/core/agents/lastfm/client_test.go b/adapters/lastfm/client_test.go similarity index 59% rename from core/agents/lastfm/client_test.go rename to adapters/lastfm/client_test.go index 85ec11506..271ae1419 100644 --- a/core/agents/lastfm/client_test.go +++ b/adapters/lastfm/client_test.go @@ -22,7 +22,7 @@ var _ = Describe("client", func() { BeforeEach(func() { httpClient = &tests.FakeHttpClient{} - client = newClient("API_KEY", "SECRET", "pt", httpClient) + client = newClient("API_KEY", "SECRET", httpClient) }) Describe("albumGetInfo", func() { @@ -30,7 +30,7 @@ var _ = Describe("client", func() { f, _ := os.Open("tests/fixtures/lastfm.album.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - album, err := client.albumGetInfo(context.Background(), "Believe", "U2", "mbid-1234") + album, err := client.albumGetInfo(context.Background(), "Believe", "U2", "mbid-1234", "pt") Expect(err).To(BeNil()) Expect(album.Name).To(Equal("Believe")) Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?album=Believe&api_key=API_KEY&artist=U2&format=json&lang=pt&mbid=mbid-1234&method=album.getInfo")) @@ -42,7 +42,7 @@ var _ = Describe("client", func() { f, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json") httpClient.Res = http.Response{Body: f, StatusCode: 200} - artist, err := client.artistGetInfo(context.Background(), "U2") + artist, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(BeNil()) Expect(artist.Name).To(Equal("U2")) Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?api_key=API_KEY&artist=U2&format=json&lang=pt&method=artist.getInfo")) @@ -54,7 +54,7 @@ var _ = Describe("client", func() { StatusCode: 500, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("last.fm http status: (500)")) }) @@ -64,7 +64,7 @@ var _ = Describe("client", func() { StatusCode: 400, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError(&lastFMError{Code: 3, Message: "Invalid Method - No method with that name in this package"})) }) @@ -74,14 +74,14 @@ var _ = Describe("client", func() { StatusCode: 200, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError(&lastFMError{Code: 6, Message: "The artist you supplied could not be found"})) }) It("fails if HttpClient.Do() returns error", func() { httpClient.Err = errors.New("generic error") - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("generic error")) }) @@ -91,7 +91,7 @@ var _ = Describe("client", func() { StatusCode: 200, } - _, err := client.artistGetInfo(context.Background(), "U2") + _, err := client.artistGetInfo(context.Background(), "U2", "pt") Expect(err).To(MatchError("invalid character '<' looking for beginning of value")) }) @@ -121,6 +121,30 @@ var _ = Describe("client", func() { }) }) + Describe("trackGetSimilar", func() { + It("returns similar tracks for a successful response", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + similar, err := client.trackGetSimilar(context.Background(), "Just Can't Get Enough", "Depeche Mode", 5) + Expect(err).To(BeNil()) + Expect(len(similar.Track)).To(Equal(5)) + Expect(similar.Track[0].Name).To(Equal("Dreaming of Me")) + Expect(similar.Track[0].Artist.Name).To(Equal("Depeche Mode")) + Expect(similar.Track[0].Match).To(Equal(1.0)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(apiBaseUrl + "?api_key=API_KEY&artist=Depeche+Mode&format=json&limit=5&method=track.getSimilar&track=Just+Can%27t+Get+Enough")) + }) + + It("returns empty list when no similar tracks found", func() { + f, _ := os.Open("tests/fixtures/lastfm.track.getsimilar.unknown.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + similar, err := client.trackGetSimilar(context.Background(), "UnknownTrack", "UnknownArtist", 3) + Expect(err).To(BeNil()) + Expect(similar.Track).To(BeEmpty()) + }) + }) + Describe("GetToken", func() { It("returns a token when the request is successful", func() { httpClient.Res = http.Response{ @@ -154,6 +178,74 @@ var _ = Describe("client", func() { }) }) + Describe("scrobble", func() { + It("sends parameters in request body for POST", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"scrobbles":{"scrobble":{"ignoredMessage":{"code":"0"}},"@attr":{"accepted":1}}}`)), + StatusCode: 200, + } + + info := ScrobbleInfo{ + artist: "U2", + track: "One", + album: "Achtung Baby", + trackNumber: 1, + duration: 276, + albumArtist: "U2", + } + err := client.scrobble(context.Background(), "SESSION_KEY", info) + Expect(err).To(BeNil()) + + req := httpClient.SavedRequest + Expect(req.Method).To(Equal(http.MethodPost)) + Expect(req.Header.Get("Content-Type")).To(Equal("application/x-www-form-urlencoded")) + Expect(req.URL.RawQuery).To(BeEmpty()) + + body, _ := io.ReadAll(req.Body) + bodyParams, _ := url.ParseQuery(string(body)) + Expect(bodyParams.Get("method")).To(Equal("track.scrobble")) + Expect(bodyParams.Get("artist")).To(Equal("U2")) + Expect(bodyParams.Get("track")).To(Equal("One")) + Expect(bodyParams.Get("sk")).To(Equal("SESSION_KEY")) + Expect(bodyParams.Get("api_key")).To(Equal("API_KEY")) + Expect(bodyParams.Get("api_sig")).ToNot(BeEmpty()) + }) + }) + + Describe("updateNowPlaying", func() { + It("sends parameters in request body for POST", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"nowplaying":{"ignoredMessage":{"code":"0"}}}`)), + StatusCode: 200, + } + + info := ScrobbleInfo{ + artist: "U2", + track: "One", + album: "Achtung Baby", + trackNumber: 1, + duration: 276, + albumArtist: "U2", + } + err := client.updateNowPlaying(context.Background(), "SESSION_KEY", info) + Expect(err).To(BeNil()) + + req := httpClient.SavedRequest + Expect(req.Method).To(Equal(http.MethodPost)) + Expect(req.Header.Get("Content-Type")).To(Equal("application/x-www-form-urlencoded")) + Expect(req.URL.RawQuery).To(BeEmpty()) + + body, _ := io.ReadAll(req.Body) + bodyParams, _ := url.ParseQuery(string(body)) + Expect(bodyParams.Get("method")).To(Equal("track.updateNowPlaying")) + Expect(bodyParams.Get("artist")).To(Equal("U2")) + Expect(bodyParams.Get("track")).To(Equal("One")) + Expect(bodyParams.Get("sk")).To(Equal("SESSION_KEY")) + Expect(bodyParams.Get("api_key")).To(Equal("API_KEY")) + Expect(bodyParams.Get("api_sig")).ToNot(BeEmpty()) + }) + }) + Describe("sign", func() { It("adds an api_sig param with the signature", func() { params := url.Values{} diff --git a/core/agents/lastfm/lastfm_suite_test.go b/adapters/lastfm/lastfm_suite_test.go similarity index 100% rename from core/agents/lastfm/lastfm_suite_test.go rename to adapters/lastfm/lastfm_suite_test.go diff --git a/adapters/lastfm/link_token.go b/adapters/lastfm/link_token.go new file mode 100644 index 000000000..fd8ceb3c9 --- /dev/null +++ b/adapters/lastfm/link_token.go @@ -0,0 +1,50 @@ +package lastfm + +import ( + "errors" + "time" + + "github.com/navidrome/navidrome/core/auth" +) + +const ( + linkTokenScope = "lastfm-link" + linkTokenTTL = 5 * time.Minute +) + +// createLinkToken issues a signed token binding the Last.fm callback to the +// user who initiated the OAuth flow. It travels back through Last.fm via the +// `cb` URL in place of the previously-trusted raw `uid` query parameter. +func createLinkToken(userID string) (string, error) { + claims := map[string]any{ + "uid": userID, + "scope": linkTokenScope, + "exp": time.Now().Add(linkTokenTTL).UTC().Unix(), + } + return auth.EncodeToken(claims) +} + +// verifyLinkToken validates a signed link token and returns the encoded user ID. +// It enforces both the signature/expiry (via the underlying JWT verifier) and a +// dedicated scope claim, preventing tokens minted for other purposes (e.g. a +// regular session JWT) from being accepted here. +func verifyLinkToken(tokenStr string) (string, error) { + token, err := auth.DecodeAndVerifyToken(tokenStr) + if err != nil { + return "", err + } + // jwtauth treats a token without `exp` as non-expiring; require it + // explicitly so an accidental regression cannot mint permanent tokens. + if exp, ok := token.Expiration(); !ok || exp.IsZero() { + return "", errors.New("link token missing expiration") + } + var scope string + if err := token.Get("scope", &scope); err != nil || scope != linkTokenScope { + return "", errors.New("invalid link token scope") + } + var uid string + if err := token.Get("uid", &uid); err != nil || uid == "" { + return "", errors.New("invalid link token user ID") + } + return uid, nil +} diff --git a/core/agents/lastfm/responses.go b/adapters/lastfm/responses.go similarity index 84% rename from core/agents/lastfm/responses.go rename to adapters/lastfm/responses.go index 1ceebe767..026741672 100644 --- a/core/agents/lastfm/responses.go +++ b/adapters/lastfm/responses.go @@ -5,6 +5,7 @@ type Response struct { SimilarArtists SimilarArtists `json:"similarartists"` TopTracks TopTracks `json:"toptracks"` Album Album `json:"album"` + SimilarTracks SimilarTracks `json:"similartracks"` Error int `json:"error"` Message string `json:"message"` Token string `json:"token"` @@ -59,6 +60,28 @@ type TopTracks struct { Attr Attr `json:"@attr"` } +type SimilarTracks struct { + Track []SimilarTrack `json:"track"` + Attr SimilarAttr `json:"@attr"` +} + +type SimilarTrack struct { + Name string `json:"name"` + MBID string `json:"mbid"` + Match float64 `json:"match"` + Artist SimilarTrackArtist `json:"artist"` +} + +type SimilarTrackArtist struct { + Name string `json:"name"` + MBID string `json:"mbid"` +} + +type SimilarAttr struct { + Artist string `json:"artist"` + Track string `json:"track"` +} + type Session struct { Name string `json:"name"` Key string `json:"key"` diff --git a/core/agents/lastfm/responses_test.go b/adapters/lastfm/responses_test.go similarity index 100% rename from core/agents/lastfm/responses_test.go rename to adapters/lastfm/responses_test.go diff --git a/core/agents/lastfm/token_received.html b/adapters/lastfm/token_received.html similarity index 100% rename from core/agents/lastfm/token_received.html rename to adapters/lastfm/token_received.html diff --git a/core/agents/listenbrainz/agent.go b/adapters/listenbrainz/agent.go similarity index 54% rename from core/agents/listenbrainz/agent.go rename to adapters/listenbrainz/agent.go index 200e9f63c..826a9672e 100644 --- a/core/agents/listenbrainz/agent.go +++ b/adapters/listenbrainz/agent.go @@ -73,7 +73,7 @@ func (l *listenBrainzAgent) formatListen(track *model.MediaFile) listenInfo { return li } -func (l *listenBrainzAgent) NowPlaying(ctx context.Context, userId string, track *model.MediaFile) error { +func (l *listenBrainzAgent) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { sk, err := l.sessionKeys.Get(ctx, userId) if err != nil || sk == "" { return errors.Join(err, scrobbler.ErrNotAuthorized) @@ -118,12 +118,133 @@ func (l *listenBrainzAgent) IsAuthorized(ctx context.Context, userId string) boo return err == nil && sk != "" } +func (l *listenBrainzAgent) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { + if mbid == "" { + return "", agents.ErrNotFound + } + + url, err := l.client.getArtistUrl(ctx, mbid) + if err != nil { + return "", err + } + return url, nil +} + +func (l *listenBrainzAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]agents.Song, error) { + resp, err := l.client.getArtistTopSongs(ctx, mbid, count) + if err != nil { + return nil, err + } + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + + res := make([]agents.Song, len(resp)) + for i, t := range resp { + mbid := "" + if len(t.ArtistMBIDs) > 0 { + mbid = t.ArtistMBIDs[0] + } + + res[i] = agents.Song{ + Album: t.ReleaseName, + AlbumMBID: t.ReleaseMBID, + Artist: t.ArtistName, + ArtistMBID: mbid, + Duration: t.DurationMs, + Name: t.RecordingName, + MBID: t.RecordingMbid, + } + } + return res, nil +} + +func (l *listenBrainzAgent) GetSimilarArtists(ctx context.Context, id string, name string, mbid string, limit int) ([]agents.Artist, error) { + if mbid == "" { + return nil, agents.ErrNotFound + } + + resp, err := l.client.getSimilarArtists(ctx, mbid, limit) + if err != nil { + return nil, err + } + + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + + artists := make([]agents.Artist, len(resp)) + for i, artist := range resp { + artists[i] = agents.Artist{ + MBID: artist.MBID, + Name: artist.Name, + } + } + + return artists, nil +} + +func (l *listenBrainzAgent) GetSimilarSongsByTrack(ctx context.Context, id string, name string, artist string, mbid string, limit int) ([]agents.Song, error) { + if mbid == "" { + return nil, agents.ErrNotFound + } + + resp, err := l.client.getSimilarRecordings(ctx, mbid, limit) + if err != nil { + return nil, err + } + + if len(resp) == 0 { + return nil, agents.ErrNotFound + } + + songs := make([]agents.Song, len(resp)) + for i, song := range resp { + songs[i] = agents.Song{ + Album: song.ReleaseName, + AlbumMBID: song.ReleaseMBID, + Artist: song.Artist, + MBID: song.MBID, + Name: song.Name, + } + } + + return songs, nil +} + +func (l *listenBrainzAgent) PlaybackReport(context.Context, scrobbler.PlaybackSession) error { + return nil +} + func init() { conf.AddHook(func() { if conf.Server.ListenBrainz.Enabled { scrobbler.Register(listenBrainzAgentName, func(ds model.DataStore) scrobbler.Scrobbler { - return listenBrainzConstructor(ds) + // This is a workaround for the fact that a (Interface)(nil) is not the same as a (*listenBrainzAgent)(nil) + // See https://go.dev/doc/faq#nil_error + a := listenBrainzConstructor(ds) + if a != nil { + return a + } + return nil + }) + + agents.Register(listenBrainzAgentName, func(ds model.DataStore) agents.Interface { + // This is a workaround for the fact that a (Interface)(nil) is not the same as a (*listenBrainzAgent)(nil) + // See https://go.dev/doc/faq#nil_error + a := listenBrainzConstructor(ds) + if a != nil { + return a + } + return nil }) } }) } + +var ( + _ agents.ArtistTopSongsRetriever = (*listenBrainzAgent)(nil) + _ agents.ArtistURLRetriever = (*listenBrainzAgent)(nil) + _ agents.ArtistSimilarRetriever = (*listenBrainzAgent)(nil) + _ agents.SimilarSongsByTrackRetriever = (*listenBrainzAgent)(nil) +) diff --git a/adapters/listenbrainz/agent_test.go b/adapters/listenbrainz/agent_test.go new file mode 100644 index 000000000..df70ec9c4 --- /dev/null +++ b/adapters/listenbrainz/agent_test.go @@ -0,0 +1,443 @@ +package listenbrainz + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "io" + "net/http" + "os" + "time" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + . "github.com/onsi/gomega/gstruct" +) + +var _ = Describe("listenBrainzAgent", func() { + var ds model.DataStore + var ctx context.Context + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + var track *model.MediaFile + + BeforeEach(func() { + ds = &tests.MockDataStore{} + ctx = context.Background() + _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1") + httpClient = &tests.FakeHttpClient{} + agent = listenBrainzConstructor(ds) + agent.client = newClient("http://localhost:8080", httpClient) + track = &model.MediaFile{ + ID: "123", + Title: "Track Title", + Album: "Track Album", + Artist: "Track Artist", + TrackNumber: 1, + MbzRecordingID: "mbz-123", + MbzAlbumID: "mbz-456", + MbzReleaseGroupID: "mbz-789", + Duration: 142.2, + Participants: map[model.Role]model.ParticipantList{ + model.RoleArtist: []model.Participant{ + {Artist: model.Artist{ID: "ar-1", Name: "Artist 1", MbzArtistID: "mbz-111"}}, + {Artist: model.Artist{ID: "ar-2", Name: "Artist 2", MbzArtistID: "mbz-222"}}, + }, + }, + } + }) + + Describe("formatListen", func() { + It("constructs the listenInfo properly", func() { + lr := agent.formatListen(track) + Expect(lr).To(MatchAllFields(Fields{ + "ListenedAt": Equal(0), + "TrackMetadata": MatchAllFields(Fields{ + "ArtistName": Equal(track.Artist), + "TrackName": Equal(track.Title), + "ReleaseName": Equal(track.Album), + "AdditionalInfo": MatchAllFields(Fields{ + "SubmissionClient": Equal(consts.AppName), + "SubmissionClientVersion": Equal(consts.Version), + "TrackNumber": Equal(track.TrackNumber), + "RecordingMBID": Equal(track.MbzRecordingID), + "ReleaseMBID": Equal(track.MbzAlbumID), + "ReleaseGroupMBID": Equal(track.MbzReleaseGroupID), + "ArtistNames": ConsistOf("Artist 1", "Artist 2"), + "ArtistMBIDs": ConsistOf("mbz-111", "mbz-222"), + "DurationMs": Equal(142200), + }), + }), + })) + }) + }) + + Describe("NowPlaying", func() { + It("updates NowPlaying successfully", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} + + err := agent.NowPlaying(ctx, "user-1", track, 0) + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns ErrNotAuthorized if user is not linked", func() { + err := agent.NowPlaying(ctx, "user-2", track, 0) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + }) + + Describe("Scrobble", func() { + var sc scrobbler.Scrobble + + BeforeEach(func() { + sc = scrobbler.Scrobble{MediaFile: *track, TimeStamp: time.Now()} + }) + + It("sends a Scrobble successfully", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).ToNot(HaveOccurred()) + }) + + It("sets the Timestamp properly", func() { + httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).ToNot(HaveOccurred()) + + decoder := json.NewDecoder(httpClient.SavedRequest.Body) + var lr listenBrainzRequestBody + err = decoder.Decode(&lr) + + Expect(err).ToNot(HaveOccurred()) + Expect(lr.Payload[0].ListenedAt).To(Equal(int(sc.TimeStamp.Unix()))) + }) + + It("returns ErrNotAuthorized if user is not linked", func() { + err := agent.Scrobble(ctx, "user-2", sc) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + + It("returns ErrRetryLater on error 503", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 503, "error": "Cannot submit listens to queue, please try again later."}`)), + StatusCode: 503, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrRetryLater on error 500", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 500, "error": "Something went wrong. Please try again."}`)), + StatusCode: 500, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrRetryLater on http errors", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad Gateway`)), + StatusCode: 500, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrUnrecoverable on other errors", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 400, "error": "BadRequest: Invalid JSON document submitted."}`)), + StatusCode: 400, + } + + err := agent.Scrobble(ctx, "user-1", sc) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) + }) + + Describe("GetArtistUrl", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns artist url when MBID present", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + Expect(agent.GetArtistURL(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")).To(Equal("http://projectmili.com/")) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + }) + + It("returns error when url not present", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.no_homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + _, err := agent.GetArtistURL(ctx, "", "", "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("7c2cc610-f998-43ef-a08f-dae3344b8973")) + }) + + It("returns error when fetch calls fails", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetArtistURL(ctx, "", "", "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("7c2cc610-f998-43ef-a08f-dae3344b8973")) + }) + + It("returns error when ListenBrainz returns an error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 400,"error": "artist mbid 1 is not valid."}`)), + StatusCode: 400, + } + _, err := agent.GetArtistURL(ctx, "", "", "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Query().Get("artist_mbids")).To(Equal("7c2cc610-f998-43ef-a08f-dae3344b8973")) + }) + }) + + Describe("GetTopSongs", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns error when fetch calls", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetArtistTopSongs(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Path).To(Equal("/1/popularity/top-recordings-for-artist/d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + }) + + It("returns an error on listenbrainz error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code":400,"error":"artist_mbid: '1' is not a valid uuid"}`)), + StatusCode: 400, + } + _, err := agent.GetArtistTopSongs(ctx, "", "", "1", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.Path).To(Equal("/1/popularity/top-recordings-for-artist/1")) + }) + + It("returns all tracks when asked", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := agent.GetArtistTopSongs(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 2) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]agents.Song{ + { + ID: "", + Name: "world.execute(me);", + MBID: "9980309d-3480-4e7e-89ce-fce971a452be", + Artist: "Mili", + ArtistMBID: "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + Album: "Miracle Milk", + AlbumMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + Duration: 211912, + }, + { + ID: "", + Name: "String Theocracy", + MBID: "afa2c83d-b17f-4029-b9da-790ea9250cf9", + Artist: "Mili", + ArtistMBID: "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + Album: "String Theocracy", + AlbumMBID: "d79a38e3-7016-4f39-a31a-f495ce914b8e", + Duration: 174000, + }, + })) + }) + + It("returns only one track when prompted", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := agent.GetArtistTopSongs(ctx, "", "", "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]agents.Song{ + { + ID: "", + Name: "world.execute(me);", + MBID: "9980309d-3480-4e7e-89ce-fce971a452be", + Artist: "Mili", + ArtistMBID: "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + Album: "Miracle Milk", + AlbumMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + Duration: 211912, + }, + })) + }) + }) + + Describe("GetSimilarArtists", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + baseUrl := "https://labs.api.listenbrainz.org/similar-artists/json?algorithm=session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30&artist_mbids=" + mbid := "db92a151-1ac2-438b-bc43-b82e149ddd50" + + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns error when fetch calls", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetSimilarArtists(ctx, "", "", mbid, 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + }) + + It("returns an error on listenbrainz error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := agent.GetSimilarArtists(ctx, "", "", "1", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + }) + + It("returns all data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarArtists(ctx, "", "", "db92a151-1ac2-438b-bc43-b82e149ddd50", 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson"}, + {MBID: "7364dea6-ca9a-48e3-be01-b44ad0d19897", Name: "a-ha"}, + })) + }) + + It("returns subset of data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarArtists(ctx, "", "", "db92a151-1ac2-438b-bc43-b82e149ddd50", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson"}, + })) + }) + }) + + Describe("GetSimilarTracks", func() { + var agent *listenBrainzAgent + var httpClient *tests.FakeHttpClient + mbid := "8f3471b5-7e6a-48da-86a9-c1c07a0f47ae" + baseUrl := "https://labs.api.listenbrainz.org/similar-recordings/json?algorithm=session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30&recording_mbids=" + + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client := newClient("BASE_URL", httpClient) + agent = listenBrainzConstructor(ds) + agent.client = client + }) + + It("returns error when fetch calls", func() { + httpClient.Err = errors.New("error") + _, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", mbid, 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + }) + + It("returns an error on listenbrainz error", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", "1", 1) + Expect(err).To(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + }) + + It("returns all data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Song{ + { + ID: "", + Name: "Take On Me", + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + ISRC: "", + Artist: "a‐ha", + ArtistMBID: "", + Album: "Hunting High and Low", + AlbumMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Duration: 0, + }, + { + ID: "", + Name: "Wake Me Up Before You Go‐Go", + MBID: "80033c72-aa19-4ba8-9227-afb075fec46e", + ISRC: "", + Artist: "Wham!", + ArtistMBID: "", + Album: "Make It Big", + AlbumMBID: "c143d542-48dc-446b-b523-1762da721638", + Duration: 0, + }, + })) + }) + + It("returns subset of data on call", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + + resp, err := agent.GetSimilarSongsByTrack(ctx, "", "", "", mbid, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.RequestCount).To(Equal(1)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + mbid)) + Expect(resp).To(Equal([]agents.Song{ + { + ID: "", + Name: "Take On Me", + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + ISRC: "", + Artist: "a‐ha", + ArtistMBID: "", + Album: "Hunting High and Low", + AlbumMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Duration: 0, + }, + })) + }) + }) +}) diff --git a/core/agents/listenbrainz/auth_router.go b/adapters/listenbrainz/auth_router.go similarity index 95% rename from core/agents/listenbrainz/auth_router.go rename to adapters/listenbrainz/auth_router.go index 2382aeb73..7cb9eb16a 100644 --- a/core/agents/listenbrainz/auth_router.go +++ b/adapters/listenbrainz/auth_router.go @@ -60,7 +60,7 @@ func (s *Router) routes() http.Handler { } func (s *Router) getLinkStatus(w http.ResponseWriter, r *http.Request) { - resp := map[string]interface{}{} + resp := map[string]any{} u, _ := request.UserFrom(r.Context()) key, err := s.sessionKeys.Get(r.Context(), u.ID) if err != nil && !errors.Is(err, model.ErrNotFound) { @@ -107,7 +107,7 @@ func (s *Router) link(w http.ResponseWriter, r *http.Request) { return } - _ = rest.RespondWithJSON(w, http.StatusOK, map[string]interface{}{"status": resp.Valid, "user": resp.UserName}) + _ = rest.RespondWithJSON(w, http.StatusOK, map[string]any{"status": resp.Valid, "user": resp.UserName}) } func (s *Router) unlink(w http.ResponseWriter, r *http.Request) { diff --git a/core/agents/listenbrainz/auth_router_test.go b/adapters/listenbrainz/auth_router_test.go similarity index 97% rename from core/agents/listenbrainz/auth_router_test.go rename to adapters/listenbrainz/auth_router_test.go index dc705dbc9..c3861799a 100644 --- a/core/agents/listenbrainz/auth_router_test.go +++ b/adapters/listenbrainz/auth_router_test.go @@ -37,7 +37,7 @@ var _ = Describe("ListenBrainz Auth Router", func() { req = httptest.NewRequest("GET", "/listenbrainz/link", nil) r.getLinkStatus(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["status"]).To(Equal(false)) }) @@ -47,7 +47,7 @@ var _ = Describe("ListenBrainz Auth Router", func() { req = httptest.NewRequest("GET", "/listenbrainz/link", nil) r.getLinkStatus(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["status"]).To(Equal(true)) }) @@ -80,7 +80,7 @@ var _ = Describe("ListenBrainz Auth Router", func() { req = httptest.NewRequest("PUT", "/listenbrainz/link", strings.NewReader(`{"token": "tok-1"}`)) r.link(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["status"]).To(Equal(true)) Expect(parsed["user"]).To(Equal("ListenBrainzUser")) diff --git a/adapters/listenbrainz/client.go b/adapters/listenbrainz/client.go new file mode 100644 index 000000000..708f02f28 --- /dev/null +++ b/adapters/listenbrainz/client.go @@ -0,0 +1,378 @@ +package listenbrainz + +import ( + "bytes" + "cmp" + "context" + "encoding/json" + "errors" + "fmt" + "net/http" + "net/url" + "path" + "slices" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" +) + +const ( + lbzApiUrl = "https://api.listenbrainz.org/1/" + labsBase = "https://labs.api.listenbrainz.org/" +) + +var ( + ErrorNotFound = errors.New("listenbrainz: not found") +) + +type listenBrainzError struct { + Code int + Message string +} + +func (e *listenBrainzError) Error() string { + return fmt.Sprintf("ListenBrainz error(%d): %s", e.Code, e.Message) +} + +type httpDoer interface { + Do(req *http.Request) (*http.Response, error) +} + +func newClient(baseURL string, hc httpDoer) *client { + return &client{baseURL, hc} +} + +type client struct { + baseURL string + hc httpDoer +} + +type listenBrainzResponse struct { + Code int `json:"code"` + Message string `json:"message"` + Error string `json:"error"` + Status string `json:"status"` + Valid bool `json:"valid"` + UserName string `json:"user_name"` +} + +type listenBrainzRequest struct { + ApiKey string //nolint:gosec + Body listenBrainzRequestBody +} + +type listenBrainzRequestBody struct { + ListenType listenType `json:"listen_type,omitempty"` + Payload []listenInfo `json:"payload,omitempty"` +} + +type listenType string + +const ( + Single listenType = "single" + PlayingNow listenType = "playing_now" +) + +type listenInfo struct { + ListenedAt int `json:"listened_at,omitempty"` + TrackMetadata trackMetadata `json:"track_metadata"` +} + +type trackMetadata struct { + ArtistName string `json:"artist_name,omitempty"` + TrackName string `json:"track_name,omitempty"` + ReleaseName string `json:"release_name,omitempty"` + AdditionalInfo additionalInfo `json:"additional_info"` +} + +type additionalInfo struct { + SubmissionClient string `json:"submission_client,omitempty"` + SubmissionClientVersion string `json:"submission_client_version,omitempty"` + TrackNumber int `json:"tracknumber,omitempty"` + ArtistNames []string `json:"artist_names,omitempty"` + ArtistMBIDs []string `json:"artist_mbids,omitempty"` + RecordingMBID string `json:"recording_mbid,omitempty"` + ReleaseMBID string `json:"release_mbid,omitempty"` + ReleaseGroupMBID string `json:"release_group_mbid,omitempty"` + DurationMs int `json:"duration_ms,omitempty"` +} + +func (c *client) validateToken(ctx context.Context, apiKey string) (*listenBrainzResponse, error) { + r := &listenBrainzRequest{ + ApiKey: apiKey, + } + response, err := c.makeAuthenticatedRequest(ctx, http.MethodGet, "validate-token", r) + if err != nil { + return nil, err + } + return response, nil +} + +func (c *client) updateNowPlaying(ctx context.Context, apiKey string, li listenInfo) error { + r := &listenBrainzRequest{ + ApiKey: apiKey, + Body: listenBrainzRequestBody{ + ListenType: PlayingNow, + Payload: []listenInfo{li}, + }, + } + + resp, err := c.makeAuthenticatedRequest(ctx, http.MethodPost, "submit-listens", r) + if err != nil { + return err + } + if resp.Status != "ok" { + log.Warn(ctx, "ListenBrainz: NowPlaying was not accepted", "status", resp.Status) + } + return nil +} + +func (c *client) scrobble(ctx context.Context, apiKey string, li listenInfo) error { + r := &listenBrainzRequest{ + ApiKey: apiKey, + Body: listenBrainzRequestBody{ + ListenType: Single, + Payload: []listenInfo{li}, + }, + } + resp, err := c.makeAuthenticatedRequest(ctx, http.MethodPost, "submit-listens", r) + if err != nil { + return err + } + if resp.Status != "ok" { + log.Warn(ctx, "ListenBrainz: Scrobble was not accepted", "status", resp.Status) + } + return nil +} + +func (c *client) path(endpoint string) (string, error) { + u, err := url.Parse(c.baseURL) + if err != nil { + return "", err + } + u.Path = path.Join(u.Path, endpoint) + return u.String(), nil +} + +func (c *client) makeAuthenticatedRequest(ctx context.Context, method string, endpoint string, r *listenBrainzRequest) (*listenBrainzResponse, error) { + b, _ := json.Marshal(r.Body) + uri, err := c.path(endpoint) + if err != nil { + return nil, err + } + req, _ := http.NewRequestWithContext(ctx, method, uri, bytes.NewBuffer(b)) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + + if r.ApiKey != "" { + req.Header.Add("Authorization", fmt.Sprintf("Token %s", r.ApiKey)) + } + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var response listenBrainzResponse + jsonErr := decoder.Decode(&response) + if resp.StatusCode != 200 && jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + if jsonErr != nil { + return nil, jsonErr + } + if response.Code != 0 && response.Code != 200 { + return &response, &listenBrainzError{Code: response.Code, Message: response.Error} + } + + return &response, nil +} + +type lbzHttpError struct { + Code int `json:"code"` + Error string `json:"error"` +} + +func (c *client) makeGenericRequest(ctx context.Context, method string, endpoint string, params url.Values) (*http.Response, error) { + req, _ := http.NewRequestWithContext(ctx, method, lbzApiUrl+endpoint, nil) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + req.URL.RawQuery = params.Encode() + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + + if err != nil { + return nil, err + } + + // On a 200 code, there is no code. Decode using using error message if it exists + if resp.StatusCode != 200 { + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var lbzError lbzHttpError + jsonErr := decoder.Decode(&lbzError) + + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + return nil, &listenBrainzError{Code: lbzError.Code, Message: lbzError.Error} + } + + return resp, err +} + +type artistMetadataResult struct { + Rels struct { + OfficialHomepage string `json:"official homepage,omitempty"` + } `json:"rels,omitzero"` +} + +func (c *client) getArtistUrl(ctx context.Context, mbid string) (string, error) { + params := url.Values{} + params.Add("artist_mbids", mbid) + resp, err := c.makeGenericRequest(ctx, http.MethodGet, "metadata/artist", params) + if err != nil { + return "", err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var response []artistMetadataResult + jsonErr := decoder.Decode(&response) + if jsonErr != nil { + return "", fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + if len(response) == 0 || response[0].Rels.OfficialHomepage == "" { + return "", ErrorNotFound + } + + return response[0].Rels.OfficialHomepage, nil +} + +type trackInfo struct { + ArtistName string `json:"artist_name"` + ArtistMBIDs []string `json:"artist_mbids"` + DurationMs uint32 `json:"length"` + RecordingName string `json:"recording_name"` + RecordingMbid string `json:"recording_mbid"` + ReleaseName string `json:"release_name"` + ReleaseMBID string `json:"release_mbid"` +} + +func (c *client) getArtistTopSongs(ctx context.Context, mbid string, count int) ([]trackInfo, error) { + resp, err := c.makeGenericRequest(ctx, http.MethodGet, "popularity/top-recordings-for-artist/"+mbid, url.Values{}) + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var response []trackInfo + jsonErr := decoder.Decode(&response) + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + if len(response) > count { + return response[0:count], nil + } + + return response, nil +} + +type artist struct { + MBID string `json:"artist_mbid"` + Name string `json:"name"` + Score int `json:"score"` +} + +func (c *client) getSimilarArtists(ctx context.Context, mbid string, limit int) ([]artist, error) { + req, _ := http.NewRequestWithContext(ctx, http.MethodGet, labsBase+"similar-artists/json", nil) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + req.URL.RawQuery = url.Values{ + "artist_mbids": []string{mbid}, "algorithm": []string{conf.Server.ListenBrainz.ArtistAlgorithm}, + }.Encode() + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz Labs %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var artists []artist + jsonErr := decoder.Decode(&artists) + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + if len(artists) > limit { + return artists[:limit], nil + } + + return artists, nil +} + +type recording struct { + MBID string `json:"recording_mbid"` + Name string `json:"recording_name"` + Artist string `json:"artist_credit_name"` + ReleaseName string `json:"release_name"` + ReleaseMBID string `json:"release_mbid"` + Score int `json:"score"` +} + +func (c *client) getSimilarRecordings(ctx context.Context, mbid string, limit int) ([]recording, error) { + req, _ := http.NewRequestWithContext(ctx, http.MethodGet, labsBase+"similar-recordings/json", nil) + req.Header.Add("Content-Type", "application/json; charset=UTF-8") + req.URL.RawQuery = url.Values{ + "recording_mbids": []string{mbid}, "algorithm": []string{conf.Server.ListenBrainz.TrackAlgorithm}, + }.Encode() + + log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz Labs %s request", req.Method), "url", req.URL) + resp, err := c.hc.Do(req) + + if err != nil { + return nil, err + } + + defer resp.Body.Close() + decoder := json.NewDecoder(resp.Body) + + var recordings []recording + jsonErr := decoder.Decode(&recordings) + if jsonErr != nil { + return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) + } + + // For whatever reason, labs API isn't guaranteed to give results in the proper order + // and may also provide duplicates. See listenbrainz.labs.similar-recordings-real-out-of-order.json + // generated from https://labs.api.listenbrainz.org/similar-recordings/json?recording_mbids=8f3471b5-7e6a-48da-86a9-c1c07a0f47ae&algorithm=session_based_days_180_session_300_contribution_5_threshold_15_limit_50_skip_30 + slices.SortFunc(recordings, func(a, b recording) int { + return cmp.Or( + cmp.Compare(b.Score, a.Score), // Sort by score descending + cmp.Compare(a.MBID, b.MBID), // Then by MBID ascending to ensure deterministic order for duplicates + ) + }) + + recordings = slices.CompactFunc(recordings, func(a, b recording) bool { + return a.MBID == b.MBID + }) + + if len(recordings) > limit { + return recordings[:limit], nil + } + + return recordings, nil +} diff --git a/adapters/listenbrainz/client_test.go b/adapters/listenbrainz/client_test.go new file mode 100644 index 000000000..319cf01ab --- /dev/null +++ b/adapters/listenbrainz/client_test.go @@ -0,0 +1,464 @@ +package listenbrainz + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "os" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("client", func() { + var httpClient *tests.FakeHttpClient + var client *client + BeforeEach(func() { + httpClient = &tests.FakeHttpClient{} + client = newClient("BASE_URL/", httpClient) + }) + + Describe("listenBrainzResponse", func() { + It("parses a response properly", func() { + var response listenBrainzResponse + err := json.Unmarshal([]byte(`{"code": 200, "message": "Message", "user_name": "UserName", "valid": true, "status": "ok", "error": "Error"}`), &response) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.Code).To(Equal(200)) + Expect(response.Message).To(Equal("Message")) + Expect(response.UserName).To(Equal("UserName")) + Expect(response.Valid).To(BeTrue()) + Expect(response.Status).To(Equal("ok")) + Expect(response.Error).To(Equal("Error")) + }) + }) + + Describe("validateToken", func() { + BeforeEach(func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 200, "message": "Token valid.", "user_name": "ListenBrainzUser", "valid": true}`)), + StatusCode: 200, + } + }) + + It("formats the request properly", func() { + _, err := client.validateToken(context.Background(), "LB-TOKEN") + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/validate-token")) + Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("parses and returns the response", func() { + res, err := client.validateToken(context.Background(), "LB-TOKEN") + Expect(err).ToNot(HaveOccurred()) + Expect(res.Valid).To(Equal(true)) + Expect(res.UserName).To(Equal("ListenBrainzUser")) + }) + }) + + Context("with listenInfo", func() { + var li listenInfo + BeforeEach(func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), + StatusCode: 200, + } + li = listenInfo{ + TrackMetadata: trackMetadata{ + ArtistName: "Track Artist", + TrackName: "Track Title", + ReleaseName: "Track Album", + AdditionalInfo: additionalInfo{ + TrackNumber: 1, + ArtistNames: []string{"Artist 1", "Artist 2"}, + ArtistMBIDs: []string{"mbz-789", "mbz-012"}, + RecordingMBID: "mbz-123", + ReleaseMBID: "mbz-456", + DurationMs: 142200, + }, + }, + } + }) + + Describe("updateNowPlaying", func() { + It("formats the request properly", func() { + Expect(client.updateNowPlaying(context.Background(), "LB-TOKEN", li)).To(Succeed()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) + Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + f, _ := os.ReadFile("tests/fixtures/listenbrainz.nowplaying.request.json") + Expect(body).To(MatchJSON(f)) + }) + }) + + Describe("scrobble", func() { + BeforeEach(func() { + li.ListenedAt = 1635000000 + }) + + It("formats the request properly", func() { + Expect(client.scrobble(context.Background(), "LB-TOKEN", li)).To(Succeed()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) + Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + + body, _ := io.ReadAll(httpClient.SavedRequest.Body) + f, _ := os.ReadFile("tests/fixtures/listenbrainz.scrobble.request.json") + Expect(body).To(MatchJSON(f)) + }) + }) + }) + + Context("getArtistUrl", func() { + baseUrl := "https://api.listenbrainz.org/1/metadata/artist?" + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code": 400,"error": "artist mbid 1 is not valid."}`)), + StatusCode: 400, + } + _, err := client.getArtistUrl(context.Background(), "1") + Expect(err.Error()).To(Equal("ListenBrainz error(400): artist mbid 1 is not valid.")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles a malformed request without meaningful body", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(``)), + StatusCode: 501, + } + _, err := client.getArtistUrl(context.Background(), "1") + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (501)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns not found when the artist has no official homepage", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.no_homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + _, err := client.getArtistUrl(context.Background(), "7c2cc610-f998-43ef-a08f-dae3344b8973") + Expect(err.Error()).To(Equal("listenbrainz: not found")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=7c2cc610-f998-43ef-a08f-dae3344b8973")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns data when the artist has a homepage", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.artist.metadata.homepage.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + url, err := client.getArtistUrl(context.Background(), "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56") + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(Equal("http://projectmili.com/")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "artist_mbids=d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + }) + + Context("getArtistTopSongs", func() { + baseUrl := "https://api.listenbrainz.org/1/popularity/top-recordings-for-artist/" + + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`{"code":400,"error":"artist_mbid: '1' is not a valid uuid"}`)), + StatusCode: 400, + } + _, err := client.getArtistTopSongs(context.Background(), "1", 50) + Expect(err.Error()).To(Equal("ListenBrainz error(400): artist_mbid: '1' is not a valid uuid")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles a malformed request without standard body", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(``)), + StatusCode: 500, + } + _, err := client.getArtistTopSongs(context.Background(), "1", 1) + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (500)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "1")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns all tracks when given the opportunity", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := client.getArtistTopSongs(context.Background(), "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 5) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]trackInfo{ + { + ArtistName: "Mili", + ArtistMBIDs: []string{"d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"}, + DurationMs: 211912, + RecordingName: "world.execute(me);", + RecordingMbid: "9980309d-3480-4e7e-89ce-fce971a452be", + ReleaseName: "Miracle Milk", + ReleaseMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + }, + { + ArtistName: "Mili", + ArtistMBIDs: []string{"d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"}, + DurationMs: 174000, + RecordingName: "String Theocracy", + RecordingMbid: "afa2c83d-b17f-4029-b9da-790ea9250cf9", + ReleaseName: "String Theocracy", + ReleaseMBID: "d79a38e3-7016-4f39-a31a-f495ce914b8e", + }, + })) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("It returns a subset of tracks when allowed", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.popularity.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + data, err := client.getArtistTopSongs(context.Background(), "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(data).To(Equal([]trackInfo{ + { + ArtistName: "Mili", + ArtistMBIDs: []string{"d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"}, + DurationMs: 211912, + RecordingName: "world.execute(me);", + RecordingMbid: "9980309d-3480-4e7e-89ce-fce971a452be", + ReleaseName: "Miracle Milk", + ReleaseMBID: "38a8f6e1-0e34-4418-a89d-78240a367408", + }, + })) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(baseUrl + "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56")) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + }) + + Context("getSimilarArtists", func() { + var algorithm string + + BeforeEach(func() { + algorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DeferCleanup(configtest.SetupConfig()) + }) + + getUrl := func(mbid string) string { + return fmt.Sprintf("https://labs.api.listenbrainz.org/similar-artists/json?algorithm=%s&artist_mbids=%s", algorithm, mbid) + } + + mbid := "db92a151-1ac2-438b-bc43-b82e149ddd50" + + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := client.getSimilarArtists(context.Background(), "1", 2) + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (400)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl("1"))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles real data properly", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarArtists(context.Background(), mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson", Score: 800}, + {MBID: "7364dea6-ca9a-48e3-be01-b44ad0d19897", Name: "a-ha", Score: 792}, + })) + }) + + It("truncates data when requested", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarArtists(context.Background(), "db92a151-1ac2-438b-bc43-b82e149ddd50", 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson", Score: 800}, + })) + }) + + It("fetches a different endpoint when algorithm changes", func() { + algorithm = "session_based_days_1825_session_300_contribution_3_threshold_10_limit_100_filter_True_skip_30" + conf.Server.ListenBrainz.ArtistAlgorithm = algorithm + + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-artists.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarArtists(context.Background(), mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]artist{ + {MBID: "f27ec8db-af05-4f36-916e-3d57f91ecf5e", Name: "Michael Jackson", Score: 800}, + {MBID: "7364dea6-ca9a-48e3-be01-b44ad0d19897", Name: "a-ha", Score: 792}, + })) + }) + }) + + Context("getSimilarRecordings", func() { + var algorithm string + + BeforeEach(func() { + algorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DeferCleanup(configtest.SetupConfig()) + }) + + getUrl := func(mbid string) string { + return fmt.Sprintf("https://labs.api.listenbrainz.org/similar-recordings/json?algorithm=%s&recording_mbids=%s", algorithm, mbid) + } + + mbid := "8f3471b5-7e6a-48da-86a9-c1c07a0f47ae" + + It("handles a malformed request with status code", func() { + httpClient.Res = http.Response{ + Body: io.NopCloser(bytes.NewBufferString(`Bad request`)), + StatusCode: 400, + } + _, err := client.getSimilarRecordings(context.Background(), "1", 2) + Expect(err.Error()).To(Equal("ListenBrainz: HTTP Error, Status: (400)")) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl("1"))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + }) + + It("handles real data properly", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarRecordings(context.Background(), mbid, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + { + MBID: "80033c72-aa19-4ba8-9227-afb075fec46e", + Name: "Wake Me Up Before You Go‐Go", + Artist: "Wham!", + ReleaseName: "Make It Big", + ReleaseMBID: "c143d542-48dc-446b-b523-1762da721638", + Score: 65, + }, + })) + }) + + It("truncates data when requested", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarRecordings(context.Background(), mbid, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + })) + }) + + It("properly sorts by score and truncates duplicates", func() { + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + // There are actually 5 items. The dedup should happen FIRST + resp, err := client.getSimilarRecordings(context.Background(), mbid, 4) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + { + MBID: "e4b347be-ecb2-44ff-aaa8-3d4c517d7ea5", + Name: "Everybody Wants to Rule the World", + Artist: "Tears for Fears", + ReleaseName: "Songs From the Big Chair", + ReleaseMBID: "21f19b06-81f1-347a-add5-5d0c77696597", + Score: 68, + }, + { + MBID: "80033c72-aa19-4ba8-9227-afb075fec46e", + Name: "Wake Me Up Before You Go‐Go", + Artist: "Wham!", + ReleaseName: "Make It Big", + ReleaseMBID: "c143d542-48dc-446b-b523-1762da721638", + Score: 65, + }, + { + MBID: "ef4c6855-949e-4e22-b41e-8e0a2d372d5f", + Name: "Tainted Love", + Artist: "Soft Cell", + ReleaseName: "Non-Stop Erotic Cabaret", + ReleaseMBID: "1acaa870-6e0c-4b6e-9e91-fdec4e5ea4b1", + Score: 61, + }, + })) + }) + + It("uses a different algorithm when configured", func() { + algorithm = "session_based_days_180_session_300_contribution_5_threshold_15_limit_50_skip_30" + conf.Server.ListenBrainz.TrackAlgorithm = algorithm + + f, _ := os.Open("tests/fixtures/listenbrainz.labs.similar-recordings.json") + httpClient.Res = http.Response{Body: f, StatusCode: 200} + resp, err := client.getSimilarRecordings(context.Background(), mbid, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) + Expect(httpClient.SavedRequest.URL.String()).To(Equal(getUrl(mbid))) + Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) + Expect(resp).To(Equal([]recording{ + { + MBID: "12f65dca-de8f-43fe-a65d-f12a02aaadf3", + Name: "Take On Me", + Artist: "a‐ha", + ReleaseName: "Hunting High and Low", + ReleaseMBID: "4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc", + Score: 124, + }, + })) + }) + }) +}) diff --git a/core/agents/listenbrainz/listenbrainz_suite_test.go b/adapters/listenbrainz/listenbrainz_suite_test.go similarity index 100% rename from core/agents/listenbrainz/listenbrainz_suite_test.go rename to adapters/listenbrainz/listenbrainz_suite_test.go diff --git a/adapters/taglib/get_filename.go b/adapters/taglib/get_filename.go deleted file mode 100644 index df7cab860..000000000 --- a/adapters/taglib/get_filename.go +++ /dev/null @@ -1,9 +0,0 @@ -//go:build !windows - -package taglib - -import "C" - -func getFilename(s string) *C.char { - return C.CString(s) -} diff --git a/adapters/taglib/get_filename_win.go b/adapters/taglib/get_filename_win.go deleted file mode 100644 index 2093616c8..000000000 --- a/adapters/taglib/get_filename_win.go +++ /dev/null @@ -1,96 +0,0 @@ -//go:build windows - -package taglib - -// From https://github.com/orofarne/gowchar - -/* -#include - -const size_t SIZEOF_WCHAR_T = sizeof(wchar_t); - -void gowchar_set (wchar_t *arr, int pos, wchar_t val) -{ - arr[pos] = val; -} - -wchar_t gowchar_get (wchar_t *arr, int pos) -{ - return arr[pos]; -} -*/ -import "C" - -import ( - "fmt" - "unicode/utf16" - "unicode/utf8" -) - -var SIZEOF_WCHAR_T C.size_t = C.size_t(C.SIZEOF_WCHAR_T) - -func getFilename(s string) *C.wchar_t { - wstr, _ := StringToWcharT(s) - return wstr -} - -func StringToWcharT(s string) (*C.wchar_t, C.size_t) { - switch SIZEOF_WCHAR_T { - case 2: - return stringToWchar2(s) // Windows - case 4: - return stringToWchar4(s) // Unix - default: - panic(fmt.Sprintf("Invalid sizeof(wchar_t) = %v", SIZEOF_WCHAR_T)) - } - panic("?!!") -} - -// Windows -func stringToWchar2(s string) (*C.wchar_t, C.size_t) { - var slen int - s1 := s - for len(s1) > 0 { - r, size := utf8.DecodeRuneInString(s1) - if er, _ := utf16.EncodeRune(r); er == '\uFFFD' { - slen += 1 - } else { - slen += 2 - } - s1 = s1[size:] - } - slen++ // \0 - res := C.malloc(C.size_t(slen) * SIZEOF_WCHAR_T) - var i int - for len(s) > 0 { - r, size := utf8.DecodeRuneInString(s) - if r1, r2 := utf16.EncodeRune(r); r1 != '\uFFFD' { - C.gowchar_set((*C.wchar_t)(res), C.int(i), C.wchar_t(r1)) - i++ - C.gowchar_set((*C.wchar_t)(res), C.int(i), C.wchar_t(r2)) - i++ - } else { - C.gowchar_set((*C.wchar_t)(res), C.int(i), C.wchar_t(r)) - i++ - } - s = s[size:] - } - C.gowchar_set((*C.wchar_t)(res), C.int(slen-1), C.wchar_t(0)) // \0 - return (*C.wchar_t)(res), C.size_t(slen) -} - -// Unix -func stringToWchar4(s string) (*C.wchar_t, C.size_t) { - slen := utf8.RuneCountInString(s) - slen++ // \0 - res := C.malloc(C.size_t(slen) * SIZEOF_WCHAR_T) - var i int - for len(s) > 0 { - r, size := utf8.DecodeRuneInString(s) - C.gowchar_set((*C.wchar_t)(res), C.int(i), C.wchar_t(r)) - s = s[size:] - i++ - } - C.gowchar_set((*C.wchar_t)(res), C.int(slen-1), C.wchar_t(0)) // \0 - return (*C.wchar_t)(res), C.size_t(slen) -} diff --git a/adapters/taglib/taglib.go b/adapters/taglib/taglib.go deleted file mode 100644 index c89dabf62..000000000 --- a/adapters/taglib/taglib.go +++ /dev/null @@ -1,151 +0,0 @@ -package taglib - -import ( - "io/fs" - "path/filepath" - "strconv" - "strings" - "time" - - "github.com/navidrome/navidrome/core/storage/local" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model/metadata" -) - -type extractor struct { - baseDir string -} - -func (e extractor) Parse(files ...string) (map[string]metadata.Info, error) { - results := make(map[string]metadata.Info) - for _, path := range files { - props, err := e.extractMetadata(path) - if err != nil { - continue - } - results[path] = *props - } - return results, nil -} - -func (e extractor) Version() string { - return Version() -} - -func (e extractor) extractMetadata(filePath string) (*metadata.Info, error) { - fullPath := filepath.Join(e.baseDir, filePath) - tags, err := Read(fullPath) - if err != nil { - log.Warn("extractor: Error reading metadata from file. Skipping", "filePath", fullPath, err) - return nil, err - } - - // Parse audio properties - ap := metadata.AudioProperties{} - if length, ok := tags["_lengthinmilliseconds"]; ok && len(length) > 0 { - millis, _ := strconv.Atoi(length[0]) - if millis > 0 { - ap.Duration = (time.Millisecond * time.Duration(millis)).Round(time.Millisecond * 10) - } - delete(tags, "_lengthinmilliseconds") - } - parseProp := func(prop string, target *int) { - if value, ok := tags[prop]; ok && len(value) > 0 { - *target, _ = strconv.Atoi(value[0]) - delete(tags, prop) - } - } - parseProp("_bitrate", &ap.BitRate) - parseProp("_channels", &ap.Channels) - parseProp("_samplerate", &ap.SampleRate) - parseProp("_bitspersample", &ap.BitDepth) - - // Parse track/disc totals - parseTuple := func(prop string) { - tagName := prop + "number" - tagTotal := prop + "total" - if value, ok := tags[tagName]; ok && len(value) > 0 { - parts := strings.Split(value[0], "/") - tags[tagName] = []string{parts[0]} - if len(parts) == 2 { - tags[tagTotal] = []string{parts[1]} - } - } - } - parseTuple("track") - parseTuple("disc") - - // Adjust some ID3 tags - parseLyrics(tags) - parseTIPL(tags) - delete(tags, "tmcl") // TMCL is already parsed by TagLib - - return &metadata.Info{ - Tags: tags, - AudioProperties: ap, - HasPicture: tags["has_picture"] != nil && len(tags["has_picture"]) > 0 && tags["has_picture"][0] == "true", - }, nil -} - -// parseLyrics make sure lyrics tags have language -func parseLyrics(tags map[string][]string) { - lyrics := tags["lyrics"] - if len(lyrics) > 0 { - tags["lyrics:xxx"] = lyrics - delete(tags, "lyrics") - } -} - -// These are the only roles we support, based on Picard's tag map: -// https://picard-docs.musicbrainz.org/downloads/MusicBrainz_Picard_Tag_Map.html -var tiplMapping = map[string]string{ - "arranger": "arranger", - "engineer": "engineer", - "producer": "producer", - "mix": "mixer", - "DJ-mix": "djmixer", -} - -// parseTIPL parses the ID3v2.4 TIPL frame string, which is received from TagLib in the format: -// -// "arranger Andrew Powell engineer Chris Blair engineer Pat Stapley producer Eric Woolfson". -// -// and breaks it down into a map of roles and names, e.g.: -// -// {"arranger": ["Andrew Powell"], "engineer": ["Chris Blair", "Pat Stapley"], "producer": ["Eric Woolfson"]}. -func parseTIPL(tags map[string][]string) { - tipl := tags["tipl"] - if len(tipl) == 0 { - return - } - - addRole := func(currentRole string, currentValue []string) { - if currentRole != "" && len(currentValue) > 0 { - role := tiplMapping[currentRole] - tags[role] = append(tags[role], strings.Join(currentValue, " ")) - } - } - - var currentRole string - var currentValue []string - for _, part := range strings.Split(tipl[0], " ") { - if _, ok := tiplMapping[part]; ok { - addRole(currentRole, currentValue) - currentRole = part - currentValue = nil - continue - } - currentValue = append(currentValue, part) - } - addRole(currentRole, currentValue) - delete(tags, "tipl") -} - -var _ local.Extractor = (*extractor)(nil) - -func init() { - local.RegisterExtractor("taglib", func(_ fs.FS, baseDir string) local.Extractor { - // ignores fs, as taglib extractor only works with local files - return &extractor{baseDir} - }) -} diff --git a/adapters/taglib/taglib_wrapper.cpp b/adapters/taglib/taglib_wrapper.cpp deleted file mode 100644 index 17c95bfc0..000000000 --- a/adapters/taglib/taglib_wrapper.cpp +++ /dev/null @@ -1,249 +0,0 @@ -#include -#include -#include - -#define TAGLIB_STATIC -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "taglib_wrapper.h" - -char has_cover(const TagLib::FileRef f); - -static char TAGLIB_VERSION[16]; - -char* taglib_version() { - snprintf((char *)TAGLIB_VERSION, 16, "%d.%d.%d", TAGLIB_MAJOR_VERSION, TAGLIB_MINOR_VERSION, TAGLIB_PATCH_VERSION); - return (char *)TAGLIB_VERSION; -} - -int taglib_read(const FILENAME_CHAR_T *filename, unsigned long id) { - TagLib::FileRef f(filename, true, TagLib::AudioProperties::Fast); - - if (f.isNull()) { - return TAGLIB_ERR_PARSE; - } - - if (!f.audioProperties()) { - return TAGLIB_ERR_AUDIO_PROPS; - } - - // Add audio properties to the tags - const TagLib::AudioProperties *props(f.audioProperties()); - goPutInt(id, (char *)"_lengthinmilliseconds", props->lengthInMilliseconds()); - goPutInt(id, (char *)"_bitrate", props->bitrate()); - goPutInt(id, (char *)"_channels", props->channels()); - goPutInt(id, (char *)"_samplerate", props->sampleRate()); - - if (const auto* apeProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", apeProperties->bitsPerSample()); - if (const auto* asfProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", asfProperties->bitsPerSample()); - else if (const auto* flacProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", flacProperties->bitsPerSample()); - else if (const auto* mp4Properties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", mp4Properties->bitsPerSample()); - else if (const auto* wavePackProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", wavePackProperties->bitsPerSample()); - else if (const auto* aiffProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", aiffProperties->bitsPerSample()); - else if (const auto* wavProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", wavProperties->bitsPerSample()); - else if (const auto* dsfProperties{ dynamic_cast(props) }) - goPutInt(id, (char *)"_bitspersample", dsfProperties->bitsPerSample()); - - // Send all properties to the Go map - TagLib::PropertyMap tags = f.file()->properties(); - - TagLib::ID3v2::Tag *id3Tags = NULL; - - // Get some extended/non-standard ID3-only tags (ex: iTunes extended frames) - TagLib::MPEG::File *mp3File(dynamic_cast(f.file())); - if (mp3File != NULL) { - id3Tags = mp3File->ID3v2Tag(); - } - - if (id3Tags == NULL) { - TagLib::RIFF::WAV::File *wavFile(dynamic_cast(f.file())); - if (wavFile != NULL && wavFile->hasID3v2Tag()) { - id3Tags = wavFile->ID3v2Tag(); - } - } - - if (id3Tags == NULL) { - TagLib::RIFF::AIFF::File *aiffFile(dynamic_cast(f.file())); - if (aiffFile && aiffFile->hasID3v2Tag()) { - id3Tags = aiffFile->tag(); - } - } - - // Yes, it is possible to have ID3v2 tags in FLAC. However, that can cause problems - // with many players, so they will not be parsed - - if (id3Tags != NULL) { - const auto &frames = id3Tags->frameListMap(); - - for (const auto &kv: frames) { - if (kv.first == "USLT") { - for (const auto &tag: kv.second) { - TagLib::ID3v2::UnsynchronizedLyricsFrame *frame = dynamic_cast(tag); - if (frame == NULL) continue; - - tags.erase("LYRICS"); - - const auto bv = frame->language(); - char language[4] = {'x', 'x', 'x', '\0'}; - if (bv.size() == 3) { - strncpy(language, bv.data(), 3); - } - - char *val = (char *)frame->text().toCString(true); - - goPutLyrics(id, language, val); - } - } else if (kv.first == "SYLT") { - for (const auto &tag: kv.second) { - TagLib::ID3v2::SynchronizedLyricsFrame *frame = dynamic_cast(tag); - if (frame == NULL) continue; - - const auto bv = frame->language(); - char language[4] = {'x', 'x', 'x', '\0'}; - if (bv.size() == 3) { - strncpy(language, bv.data(), 3); - } - - const auto format = frame->timestampFormat(); - if (format == TagLib::ID3v2::SynchronizedLyricsFrame::AbsoluteMilliseconds) { - - for (const auto &line: frame->synchedText()) { - char *text = (char *)line.text.toCString(true); - goPutLyricLine(id, language, text, line.time); - } - } else if (format == TagLib::ID3v2::SynchronizedLyricsFrame::AbsoluteMpegFrames) { - const int sampleRate = props->sampleRate(); - - if (sampleRate != 0) { - for (const auto &line: frame->synchedText()) { - const int timeInMs = (line.time * 1000) / sampleRate; - char *text = (char *)line.text.toCString(true); - goPutLyricLine(id, language, text, timeInMs); - } - } - } - } - } else if (kv.first == "TIPL"){ - if (!kv.second.isEmpty()) { - tags.insert(kv.first, kv.second.front()->toString()); - } - } - } - } - - // M4A may have some iTunes specific tags not captured by the PropertyMap interface - TagLib::MP4::File *m4afile(dynamic_cast(f.file())); - if (m4afile != NULL) { - const auto itemListMap = m4afile->tag()->itemMap(); - for (const auto item: itemListMap) { - char *key = (char *)item.first.toCString(true); - for (const auto value: item.second.toStringList()) { - char *val = (char *)value.toCString(true); - goPutM4AStr(id, key, val); - } - } - } - - // WMA/ASF files may have additional tags not captured by the PropertyMap interface - TagLib::ASF::File *asfFile(dynamic_cast(f.file())); - if (asfFile != NULL) { - const TagLib::ASF::Tag *asfTags{asfFile->tag()}; - const auto itemListMap = asfTags->attributeListMap(); - for (const auto item : itemListMap) { - tags.insert(item.first, item.second.front().toString()); - } - } - - // Send all collected tags to the Go map - for (TagLib::PropertyMap::ConstIterator i = tags.begin(); i != tags.end(); - ++i) { - char *key = (char *)i->first.toCString(true); - for (TagLib::StringList::ConstIterator j = i->second.begin(); - j != i->second.end(); ++j) { - char *val = (char *)(*j).toCString(true); - goPutStr(id, key, val); - } - } - - // Cover art has to be handled separately - if (has_cover(f)) { - goPutStr(id, (char *)"has_picture", (char *)"true"); - } - - return 0; -} - -// Detect if the file has cover art. Returns 1 if the file has cover art, 0 otherwise. -char has_cover(const TagLib::FileRef f) { - char hasCover = 0; - // ----- MP3 - if (TagLib::MPEG::File * mp3File{dynamic_cast(f.file())}) { - if (mp3File->ID3v2Tag()) { - const auto &frameListMap{mp3File->ID3v2Tag()->frameListMap()}; - hasCover = !frameListMap["APIC"].isEmpty(); - } - } - // ----- FLAC - else if (TagLib::FLAC::File * flacFile{dynamic_cast(f.file())}) { - hasCover = !flacFile->pictureList().isEmpty(); - } - // ----- MP4 - else if (TagLib::MP4::File * mp4File{dynamic_cast(f.file())}) { - auto &coverItem{mp4File->tag()->itemMap()["covr"]}; - TagLib::MP4::CoverArtList coverArtList{coverItem.toCoverArtList()}; - hasCover = !coverArtList.isEmpty(); - } - // ----- Ogg - else if (TagLib::Ogg::Vorbis::File * vorbisFile{dynamic_cast(f.file())}) { - hasCover = !vorbisFile->tag()->pictureList().isEmpty(); - } - // ----- Opus - else if (TagLib::Ogg::Opus::File * opusFile{dynamic_cast(f.file())}) { - hasCover = !opusFile->tag()->pictureList().isEmpty(); - } - // ----- WAV - else if (TagLib::RIFF::WAV::File * wavFile{ dynamic_cast(f.file()) }) { - if (wavFile->hasID3v2Tag()) { - const auto& frameListMap{ wavFile->ID3v2Tag()->frameListMap() }; - hasCover = !frameListMap["APIC"].isEmpty(); - } - } - // ----- AIFF - else if (TagLib::RIFF::AIFF::File * aiffFile{ dynamic_cast(f.file())}) { - if (aiffFile->hasID3v2Tag()) { - const auto& frameListMap{ aiffFile->tag()->frameListMap() }; - hasCover = !frameListMap["APIC"].isEmpty(); - } - } - // ----- WMA - else if (TagLib::ASF::File * asfFile{dynamic_cast(f.file())}) { - const TagLib::ASF::Tag *tag{ asfFile->tag() }; - hasCover = tag && asfFile->tag()->attributeListMap().contains("WM/Picture"); - } - - return hasCover; -} diff --git a/adapters/taglib/taglib_wrapper.go b/adapters/taglib/taglib_wrapper.go deleted file mode 100644 index 4a979920a..000000000 --- a/adapters/taglib/taglib_wrapper.go +++ /dev/null @@ -1,157 +0,0 @@ -package taglib - -/* -#cgo !windows pkg-config: --define-prefix taglib -#cgo windows pkg-config: taglib -#cgo illumos LDFLAGS: -lstdc++ -lsendfile -#cgo linux darwin CXXFLAGS: -std=c++11 -#cgo darwin LDFLAGS: -L/opt/homebrew/opt/taglib/lib -#include -#include -#include -#include "taglib_wrapper.h" -*/ -import "C" -import ( - "encoding/json" - "fmt" - "os" - "runtime/debug" - "strconv" - "strings" - "sync" - "sync/atomic" - "unsafe" - - "github.com/navidrome/navidrome/log" -) - -const iTunesKeyPrefix = "----:com.apple.itunes:" - -func Version() string { - return C.GoString(C.taglib_version()) -} - -func Read(filename string) (tags map[string][]string, err error) { - // Do not crash on failures in the C code/library - debug.SetPanicOnFault(true) - defer func() { - if r := recover(); r != nil { - log.Error("extractor: recovered from panic when reading tags", "file", filename, "error", r) - err = fmt.Errorf("extractor: recovered from panic: %s", r) - } - }() - - fp := getFilename(filename) - defer C.free(unsafe.Pointer(fp)) - id, m, release := newMap() - defer release() - - log.Trace("extractor: reading tags", "filename", filename, "map_id", id) - res := C.taglib_read(fp, C.ulong(id)) - switch res { - case C.TAGLIB_ERR_PARSE: - // Check additional case whether the file is unreadable due to permission - file, fileErr := os.OpenFile(filename, os.O_RDONLY, 0600) - defer file.Close() - - if os.IsPermission(fileErr) { - return nil, fmt.Errorf("navidrome does not have permission: %w", fileErr) - } else if fileErr != nil { - return nil, fmt.Errorf("cannot parse file media file: %w", fileErr) - } else { - return nil, fmt.Errorf("cannot parse file media file") - } - case C.TAGLIB_ERR_AUDIO_PROPS: - return nil, fmt.Errorf("can't get audio properties from file") - } - if log.IsGreaterOrEqualTo(log.LevelDebug) { - j, _ := json.Marshal(m) - log.Trace("extractor: read tags", "tags", string(j), "filename", filename, "id", id) - } else { - log.Trace("extractor: read tags", "tags", m, "filename", filename, "id", id) - } - - return m, nil -} - -type tagMap map[string][]string - -var allMaps sync.Map -var mapsNextID atomic.Uint32 - -func newMap() (uint32, tagMap, func()) { - id := mapsNextID.Add(1) - - m := tagMap{} - allMaps.Store(id, m) - - return id, m, func() { - allMaps.Delete(id) - } -} - -func doPutTag(id C.ulong, key string, val *C.char) { - if key == "" { - return - } - - r, _ := allMaps.Load(uint32(id)) - m := r.(tagMap) - k := strings.ToLower(key) - v := strings.TrimSpace(C.GoString(val)) - m[k] = append(m[k], v) -} - -//export goPutM4AStr -func goPutM4AStr(id C.ulong, key *C.char, val *C.char) { - k := C.GoString(key) - - // Special for M4A, do not catch keys that have no actual name - k = strings.TrimPrefix(k, iTunesKeyPrefix) - doPutTag(id, k, val) -} - -//export goPutStr -func goPutStr(id C.ulong, key *C.char, val *C.char) { - doPutTag(id, C.GoString(key), val) -} - -//export goPutInt -func goPutInt(id C.ulong, key *C.char, val C.int) { - valStr := strconv.Itoa(int(val)) - vp := C.CString(valStr) - defer C.free(unsafe.Pointer(vp)) - goPutStr(id, key, vp) -} - -//export goPutLyrics -func goPutLyrics(id C.ulong, lang *C.char, val *C.char) { - doPutTag(id, "lyrics:"+C.GoString(lang), val) -} - -//export goPutLyricLine -func goPutLyricLine(id C.ulong, lang *C.char, text *C.char, time C.int) { - language := C.GoString(lang) - line := C.GoString(text) - timeGo := int64(time) - - ms := timeGo % 1000 - timeGo /= 1000 - sec := timeGo % 60 - timeGo /= 60 - minimum := timeGo % 60 - formattedLine := fmt.Sprintf("[%02d:%02d.%02d]%s\n", minimum, sec, ms/10, line) - - key := "lyrics:" + language - - r, _ := allMaps.Load(uint32(id)) - m := r.(tagMap) - k := strings.ToLower(key) - existing, ok := m[k] - if ok { - existing[0] += formattedLine - } else { - m[k] = []string{formattedLine} - } -} diff --git a/adapters/taglib/taglib_wrapper.h b/adapters/taglib/taglib_wrapper.h deleted file mode 100644 index c93f4c14a..000000000 --- a/adapters/taglib/taglib_wrapper.h +++ /dev/null @@ -1,24 +0,0 @@ -#define TAGLIB_ERR_PARSE -1 -#define TAGLIB_ERR_AUDIO_PROPS -2 - -#ifdef __cplusplus -extern "C" { -#endif - -#ifdef WIN32 -#define FILENAME_CHAR_T wchar_t -#else -#define FILENAME_CHAR_T char -#endif - -extern void goPutM4AStr(unsigned long id, char *key, char *val); -extern void goPutStr(unsigned long id, char *key, char *val); -extern void goPutInt(unsigned long id, char *key, int val); -extern void goPutLyrics(unsigned long id, char *lang, char *val); -extern void goPutLyricLine(unsigned long id, char *lang, char *text, int time); -int taglib_read(const FILENAME_CHAR_T *filename, unsigned long id); -char* taglib_version(); - -#ifdef __cplusplus -} -#endif diff --git a/cmd/backup.go b/cmd/backup.go index ab73f7537..c02f3a19f 100644 --- a/cmd/backup.go +++ b/cmd/backup.go @@ -75,7 +75,7 @@ var ( func runBackup(ctx context.Context) { if backupDir != "" { - conf.Server.Backup.Path = backupDir + conf.Server.Backup.Path = conf.NewDir(backupDir) } idx := strings.LastIndex(conf.Server.DbPath, "?") @@ -104,7 +104,7 @@ func runBackup(ctx context.Context) { func runPrune(ctx context.Context) { if backupDir != "" { - conf.Server.Backup.Path = backupDir + conf.Server.Backup.Path = conf.NewDir(backupDir) } if backupCount != -1 { diff --git a/cmd/cmd_suite_test.go b/cmd/cmd_suite_test.go new file mode 100644 index 000000000..f2ddf6a9c --- /dev/null +++ b/cmd/cmd_suite_test.go @@ -0,0 +1,17 @@ +package cmd + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestCmd(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Cmd Suite") +} diff --git a/cmd/inspect.go b/cmd/inspect.go index 9f9270b1e..5e88793cc 100644 --- a/cmd/inspect.go +++ b/cmd/inspect.go @@ -32,17 +32,17 @@ var inspectCmd = &cobra.Command{ }, } -var marshalers = map[string]func(interface{}) ([]byte, error){ +var marshalers = map[string]func(any) ([]byte, error){ "pretty": prettyMarshal, "toml": toml.Marshal, "yaml": yaml.Marshal, "json": json.Marshal, - "jsonindent": func(v interface{}) ([]byte, error) { + "jsonindent": func(v any) ([]byte, error) { return json.MarshalIndent(v, "", " ") }, } -func prettyMarshal(v interface{}) ([]byte, error) { +func prettyMarshal(v any) ([]byte, error) { out := v.([]core.InspectOutput) var res strings.Builder for i := range out { diff --git a/cmd/pls.go b/cmd/pls.go index fc0f22fba..95cbe4eec 100644 --- a/cmd/pls.go +++ b/cmd/pls.go @@ -7,14 +7,19 @@ import ( "errors" "fmt" "os" + "path/filepath" "strconv" + "strings" "github.com/Masterminds/squirrel" - "github.com/navidrome/navidrome/core/auth" - "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/ioutils" + "github.com/navidrome/navidrome/utils/slice" + "github.com/navidrome/navidrome/utils/str" "github.com/spf13/cobra" ) @@ -23,6 +28,7 @@ var ( outputFile string userID string outputFormat string + syncFlag bool ) type displayPlaylist struct { @@ -44,6 +50,15 @@ func init() { listCommand.Flags().StringVarP(&userID, "user", "u", "", "username or ID") listCommand.Flags().StringVarP(&outputFormat, "format", "f", "csv", "output format [supported values: csv, json]") plsCmd.AddCommand(listCommand) + + exportCommand.Flags().StringVarP(&playlistID, "playlist", "p", "", "playlist name or ID") + exportCommand.Flags().StringVarP(&outputFile, "output", "o", "", "output directory") + exportCommand.Flags().StringVarP(&userID, "user", "u", "", "username or ID") + plsCmd.AddCommand(exportCommand) + + importCommand.Flags().StringVarP(&userID, "user", "u", "", "owner username or ID (default: first admin)") + importCommand.Flags().BoolVar(&syncFlag, "sync", false, "mark imported playlists as synced") + plsCmd.AddCommand(importCommand) } var ( @@ -52,7 +67,7 @@ var ( Short: "Export playlists", Long: "Export Navidrome playlists to M3U files", Run: func(cmd *cobra.Command, args []string) { - runExporter() + runExporter(cmd.Context()) }, } @@ -60,89 +75,168 @@ var ( Use: "list", Short: "List playlists", Run: func(cmd *cobra.Command, args []string) { - runList() + runList(cmd.Context()) + }, + } + + exportCommand = &cobra.Command{ + Use: "export", + Short: "Export playlists to M3U files", + Long: "Export one or more Navidrome playlists to M3U files", + Run: func(cmd *cobra.Command, args []string) { + runExport(cmd.Context()) + }, + } + + importCommand = &cobra.Command{ + Use: "import [files...]", + Short: "Import M3U playlists", + Long: "Import one or more M3U files as Navidrome playlists", + Args: cobra.MinimumNArgs(1), + Run: func(cmd *cobra.Command, args []string) { + runImport(cmd.Context(), args) }, } ) -func runExporter() { - sqlDB := db.Db() - ds := persistence.New(sqlDB) - ctx := auth.WithAdminUser(context.Background(), ds) - playlist, err := ds.Playlist(ctx).GetWithTracks(playlistID, true, false) +func fetchPlaylists(ctx context.Context, ds model.DataStore, sort string) model.Playlists { + options := model.QueryOptions{Sort: sort} + if userID != "" { + user, err := getUser(ctx, userID, ds) + if err != nil { + log.Fatal(ctx, "Error retrieving user", "username or id", userID) + } + options.Filters = squirrel.Eq{"owner_id": user.ID} + } + pls, err := ds.Playlist(ctx).GetAll(options) + if err != nil { + log.Fatal(ctx, "Failed to retrieve playlists", err) + } + return pls +} + +func findPlaylist(ctx context.Context, ds model.DataStore, nameOrID string) *model.Playlist { + playlist, err := ds.Playlist(ctx).GetWithTracks(nameOrID, true, false) if err != nil && !errors.Is(err, model.ErrNotFound) { - log.Fatal("Error retrieving playlist", "name", playlistID, err) + log.Fatal("Error retrieving playlist", "name", nameOrID, err) } if errors.Is(err, model.ErrNotFound) { - playlists, err := ds.Playlist(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"playlist.name": playlistID}}) + playlists, err := ds.Playlist(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"playlist.name": nameOrID}}) if err != nil { - log.Fatal("Error retrieving playlist", "name", playlistID, err) + log.Fatal("Error retrieving playlist", "name", nameOrID, err) } if len(playlists) > 0 { playlist, err = ds.Playlist(ctx).GetWithTracks(playlists[0].ID, true, false) if err != nil { - log.Fatal("Error retrieving playlist", "name", playlistID, err) + log.Fatal("Error retrieving playlist", "name", nameOrID, err) } } } if playlist == nil { - log.Fatal("Playlist not found", "name", playlistID) + log.Fatal("Playlist not found", "name", nameOrID) } + return playlist +} + +func runExporter(ctx context.Context) { + ds, ctx := getAdminContext(ctx) + playlist := findPlaylist(ctx, ds, playlistID) pls := playlist.ToM3U8() if outputFile == "-" || outputFile == "" { println(pls) return } - - err = os.WriteFile(outputFile, []byte(pls), 0600) + err := os.WriteFile(outputFile, []byte(pls), 0600) if err != nil { log.Fatal("Error writing to the output file", "file", outputFile, err) } } -func runList() { +func runExport(ctx context.Context) { + ds, ctx := getAdminContext(ctx) + + if playlistID != "" && outputFile == "" { + playlist := findPlaylist(ctx, ds, playlistID) + println(playlist.ToM3U8()) + return + } + + if outputFile == "" { + log.Fatal("Output directory (-o) is required for bulk export or when filtering by user") + } + + info, err := os.Stat(outputFile) + if err != nil || !info.IsDir() { + log.Fatal("Output path must be an existing directory", "path", outputFile) + } + + if playlistID != "" { + pls := findPlaylist(ctx, ds, playlistID) + filename := str.SanitizeFilename(pls.Name) + ".m3u" + path := filepath.Join(outputFile, filename) + err := os.WriteFile(path, []byte(pls.ToM3U8()), 0600) + if err != nil { + log.Fatal("Error writing playlist", "file", path, err) + } + fmt.Printf("Exported \"%s\" to %s\n", pls.Name, path) + return + } + + allPls := fetchPlaylists(ctx, ds, "name") + + nameCounts := make(map[string]int) + for _, pls := range allPls { + nameCounts[str.SanitizeFilename(pls.Name)]++ + } + + exported := 0 + for _, pls := range allPls { + plsWithTracks, err := ds.Playlist(ctx).GetWithTracks(pls.ID, true, false) + if err != nil { + log.Error("Error loading playlist tracks", "playlist", pls.Name, err) + continue + } + + sanitized := str.SanitizeFilename(pls.Name) + filename := sanitized + ".m3u" + if nameCounts[sanitized] > 1 { + shortID := pls.ID + if len(shortID) > 6 { + shortID = shortID[:6] + } + filename = sanitized + "_" + shortID + ".m3u" + } + + path := filepath.Join(outputFile, filename) + err = os.WriteFile(path, []byte(plsWithTracks.ToM3U8()), 0600) + if err != nil { + log.Error("Error writing playlist", "file", path, err) + continue + } + fmt.Printf("Exported \"%s\" to %s\n", pls.Name, path) + exported++ + } + fmt.Printf("\nExported %d playlists to %s\n", exported, outputFile) +} + +func runList(ctx context.Context) { if outputFormat != "csv" && outputFormat != "json" { log.Fatal("Invalid output format. Must be one of csv, json", "format", outputFormat) } - sqlDB := db.Db() - ds := persistence.New(sqlDB) - ctx := auth.WithAdminUser(context.Background(), ds) - - options := model.QueryOptions{Sort: "owner_name"} - - if userID != "" { - user, err := ds.User(ctx).FindByUsername(userID) - - if err != nil && !errors.Is(err, model.ErrNotFound) { - log.Fatal("Error retrieving user by name", "name", userID, err) - } - - if errors.Is(err, model.ErrNotFound) { - user, err = ds.User(ctx).Get(userID) - if err != nil { - log.Fatal("Error retrieving user by id", "id", userID, err) - } - } - - options.Filters = squirrel.Eq{"owner_id": user.ID} - } - - playlists, err := ds.Playlist(ctx).GetAll(options) - if err != nil { - log.Fatal(ctx, "Failed to retrieve playlists", err) - } + ds, ctx := getAdminContext(ctx) + allPls := fetchPlaylists(ctx, ds, "owner_name") if outputFormat == "csv" { w := csv.NewWriter(os.Stdout) _ = w.Write([]string{"playlist id", "playlist name", "owner id", "owner name", "public"}) - for _, playlist := range playlists { + for _, playlist := range allPls { _ = w.Write([]string{playlist.ID, playlist.Name, playlist.OwnerID, playlist.OwnerName, strconv.FormatBool(playlist.Public)}) } w.Flush() } else { - display := make(displayPlaylists, len(playlists)) - for idx, playlist := range playlists { + display := make(displayPlaylists, len(allPls)) + for idx, playlist := range allPls { display[idx].Id = playlist.ID display[idx].Name = playlist.Name display[idx].OwnerId = playlist.OwnerID @@ -154,3 +248,62 @@ func runList() { fmt.Printf("%s\n", j) } } + +func runImport(ctx context.Context, files []string) { + ds, ctx := getAdminContext(ctx) + + if userID != "" { + user, err := getUser(ctx, userID, ds) + if err != nil { + log.Fatal(ctx, "Error retrieving user", "username or id", userID) + } + ctx = request.WithUser(ctx, *user) + } + + pls := playlists.NewPlaylists(ds, core.NewImageUploadService()) + + for _, file := range files { + absPath, err := filepath.Abs(file) + if err != nil { + log.Error("Error resolving path", "file", file, err) + fmt.Fprintf(os.Stderr, "Error: could not resolve path %s: %v\n", file, err) + continue + } + + totalLines := countM3UTrackLines(absPath) + + imported, err := pls.ImportFile(ctx, absPath, syncFlag) + if err != nil { + log.Error("Error importing playlist", "file", absPath, err) + fmt.Fprintf(os.Stderr, "Error importing %s: %v\n", file, err) + continue + } + + matched := len(imported.Tracks) + if totalLines > 0 { + notFound := totalLines - matched + fmt.Printf("Imported \"%s\" — %d/%d tracks matched (%d not found)\n", imported.Name, matched, totalLines, notFound) + } else { + fmt.Printf("Imported \"%s\" — %d tracks\n", imported.Name, matched) + } + } +} + +func countM3UTrackLines(path string) int { + file, err := os.Open(path) + if err != nil { + return 0 + } + defer file.Close() + + count := 0 + reader := ioutils.UTF8Reader(file) + for line := range slice.LinesFrom(reader) { + line = strings.TrimSpace(line) + if line == "" || strings.HasPrefix(line, "#") { + continue + } + count++ + } + return count +} diff --git a/cmd/root.go b/cmd/root.go index e1e92228f..08773176a 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -9,7 +9,6 @@ import ( "time" "github.com/go-chi/chi/v5/middleware" - _ "github.com/navidrome/navidrome/adapters/taglib" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/db" @@ -22,6 +21,12 @@ import ( "github.com/spf13/cobra" "github.com/spf13/viper" "golang.org/x/sync/errgroup" + + // Import adapters to register them + _ "github.com/navidrome/navidrome/adapters/deezer" + _ "github.com/navidrome/navidrome/adapters/gotaglib" + _ "github.com/navidrome/navidrome/adapters/lastfm" + _ "github.com/navidrome/navidrome/adapters/listenbrainz" ) var ( @@ -82,8 +87,9 @@ func runNavidrome(ctx context.Context) { g.Go(schedulePeriodicBackup(ctx)) g.Go(startInsightsCollector(ctx)) g.Go(scheduleDBOptimizer(ctx)) + g.Go(startPluginManager(ctx)) + g.Go(runInitialScan(ctx)) if conf.Server.Scanner.Enabled { - g.Go(runInitialScan(ctx)) g.Go(startScanWatcher(ctx)) g.Go(schedulePeriodicScan(ctx)) } else { @@ -109,7 +115,7 @@ func mainContext(ctx context.Context) (context.Context, context.CancelFunc) { func startServer(ctx context.Context) func() error { return func() error { a := CreateServer() - a.MountRouter("Native API", consts.URLPathNativeAPI, CreateNativeAPIRouter()) + a.MountRouter("Native API", consts.URLPathNativeAPI, CreateNativeAPIRouter(ctx)) a.MountRouter("Subsonic API", consts.URLPathSubsonicAPI, CreateSubsonicAPIRouter(ctx)) a.MountRouter("Public Endpoints", consts.URLPathPublic, CreatePublicRouter()) if conf.Server.LastFM.Enabled { @@ -147,7 +153,7 @@ func schedulePeriodicScan(ctx context.Context) func() error { schedulerInstance := scheduler.GetInstance() log.Info("Scheduling periodic scan", "schedule", schedule) - err := schedulerInstance.Add(schedule, func() { + _, err := schedulerInstance.Add(schedule, func() { _, err := s.ScanAll(ctx, false) if err != nil { log.Error(ctx, "Error executing periodic scan", err) @@ -172,6 +178,7 @@ func pidHashChanged(ds model.DataStore) (bool, error) { return !strings.EqualFold(pidAlbum, conf.Server.PID.Album) || !strings.EqualFold(pidTrack, conf.Server.PID.Track), nil } +// runInitialScan runs an initial scan of the music library if needed. func runInitialScan(ctx context.Context) func() error { return func() error { ds := CreateDataStore() @@ -187,10 +194,11 @@ func runInitialScan(ctx context.Context) func() error { if err != nil { return err } - scanNeeded := conf.Server.Scanner.ScanOnStartup || inProgress || fullScanRequired == "1" || pidHasChanged + scanOnStartup := conf.Server.Scanner.Enabled && conf.Server.Scanner.ScanOnStartup + scanNeeded := scanOnStartup || inProgress || fullScanRequired == "1" || pidHasChanged time.Sleep(2 * time.Second) // Wait 2 seconds before the initial scan if scanNeeded { - scanner := CreateScanner(ctx) + s := CreateScanner(ctx) switch { case fullScanRequired == "1": log.Warn(ctx, "Full scan required after migration") @@ -204,7 +212,7 @@ func runInitialScan(ctx context.Context) func() error { log.Info("Executing initial scan") } - _, err = scanner.ScanAll(ctx, fullScanRequired == "1") + _, err = s.ScanAll(ctx, fullScanRequired == "1") if err != nil { log.Error(ctx, "Scan failed", err) } else { @@ -243,7 +251,7 @@ func schedulePeriodicBackup(ctx context.Context) func() error { schedulerInstance := scheduler.GetInstance() log.Info("Scheduling periodic backup", "schedule", schedule) - err := schedulerInstance.Add(schedule, func() { + _, err := schedulerInstance.Add(schedule, func() { start := time.Now() path, err := db.Backup(ctx) elapsed := time.Since(start) @@ -271,7 +279,7 @@ func scheduleDBOptimizer(ctx context.Context) func() error { return func() error { log.Info(ctx, "Scheduling DB optimizer", "schedule", consts.OptimizeDBSchedule) schedulerInstance := scheduler.GetInstance() - err := schedulerInstance.Add(consts.OptimizeDBSchedule, func() { + _, err := schedulerInstance.Add(consts.OptimizeDBSchedule, func() { if scanner.IsScanning() { log.Debug(ctx, "Skipping DB optimization because a scan is in progress") return @@ -325,10 +333,23 @@ func startPlaybackServer(ctx context.Context) func() error { } } +// startPluginManager starts the plugin manager, if configured. +func startPluginManager(ctx context.Context) func() error { + return func() error { + manager := GetPluginManager(ctx) + if !conf.Server.Plugins.Enabled { + log.Debug("Plugin system is DISABLED") + return nil + } + log.Info(ctx, "Starting plugin manager") + return manager.Start(ctx) + } +} + // TODO: Implement some struct tags to map flags to viper func init() { cobra.OnInitialize(func() { - conf.InitConfig(cfgFile) + conf.InitConfig(cfgFile, true) }) rootCmd.PersistentFlags().StringVarP(&cfgFile, "configfile", "c", "", `config file (default "./navidrome.toml")`) @@ -356,6 +377,7 @@ func init() { rootCmd.Flags().Duration("scaninterval", viper.GetDuration("scaninterval"), "how frequently to scan for changes in your music library") rootCmd.Flags().String("uiloginbackgroundurl", viper.GetString("uiloginbackgroundurl"), "URL to a backaground image used in the Login page") rootCmd.Flags().Bool("enabletranscodingconfig", viper.GetBool("enabletranscodingconfig"), "enables transcoding configuration in the UI") + rootCmd.Flags().Bool("enabletranscodingcancellation", viper.GetBool("enabletranscodingcancellation"), "enables transcoding context cancellation") rootCmd.Flags().String("transcodingcachesize", viper.GetString("transcodingcachesize"), "size of transcoding cache") rootCmd.Flags().String("imagecachesize", viper.GetString("imagecachesize"), "size of image (art work) cache. set to 0 to disable cache") rootCmd.Flags().String("albumplaycountmode", viper.GetString("albumplaycountmode"), "how to compute playcount for albums. absolute (default) or normalized") @@ -379,6 +401,7 @@ func init() { _ = viper.BindPFlag("prometheus.metricspath", rootCmd.Flags().Lookup("prometheus.metricspath")) _ = viper.BindPFlag("enabletranscodingconfig", rootCmd.Flags().Lookup("enabletranscodingconfig")) + _ = viper.BindPFlag("enabletranscodingcancellation", rootCmd.Flags().Lookup("enabletranscodingcancellation")) _ = viper.BindPFlag("transcodingcachesize", rootCmd.Flags().Lookup("transcodingcachesize")) _ = viper.BindPFlag("imagecachesize", rootCmd.Flags().Lookup("imagecachesize")) } diff --git a/cmd/scan.go b/cmd/scan.go index 26eb7d7a2..d8a563396 100644 --- a/cmd/scan.go +++ b/cmd/scan.go @@ -1,15 +1,18 @@ package cmd import ( + "bufio" "context" "encoding/gob" + "fmt" "os" + "strings" "github.com/navidrome/navidrome/core" - "github.com/navidrome/navidrome/core/artwork" - "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/persistence" "github.com/navidrome/navidrome/scanner" "github.com/navidrome/navidrome/utils/pl" @@ -19,11 +22,15 @@ import ( var ( fullScan bool subprocess bool + targets []string + targetFile string ) func init() { scanCmd.Flags().BoolVarP(&fullScan, "full", "f", false, "check all subfolders, ignoring timestamps") scanCmd.Flags().BoolVarP(&subprocess, "subprocess", "", false, "run as subprocess (internal use)") + scanCmd.Flags().StringArrayVarP(&targets, "target", "t", []string{}, "list of libraryID:folderPath pairs, can be repeated (e.g., \"-t 1:Music/Rock -t 1:Music/Jazz -t 2:Classical\")") + scanCmd.Flags().StringVar(&targetFile, "target-file", "", "path to file containing targets (one libraryID:folderPath per line)") rootCmd.AddCommand(scanCmd) } @@ -68,9 +75,27 @@ func runScanner(ctx context.Context) { sqlDB := db.Db() defer db.Db().Close() ds := persistence.New(sqlDB) - pls := core.NewPlaylists(ds) + pls := playlists.NewPlaylists(ds, core.NewImageUploadService()) - progress, err := scanner.CallScan(ctx, ds, artwork.NoopCacheWarmer(), pls, metrics.NewNoopInstance(), fullScan) + // Parse targets from command line or file + var scanTargets []model.ScanTarget + var err error + + if targetFile != "" { + scanTargets, err = readTargetsFromFile(targetFile) + if err != nil { + log.Fatal(ctx, "Failed to read targets from file", err) + } + log.Info(ctx, "Scanning specific folders from file", "numTargets", len(scanTargets)) + } else if len(targets) > 0 { + scanTargets, err = model.ParseTargets(targets) + if err != nil { + log.Fatal(ctx, "Failed to parse targets", err) + } + log.Info(ctx, "Scanning specific folders", "numTargets", len(scanTargets)) + } + + progress, err := scanner.CallScan(ctx, ds, pls, fullScan, scanTargets) if err != nil { log.Fatal(ctx, "Failed to scan", err) } @@ -82,3 +107,31 @@ func runScanner(ctx context.Context) { trackScanInteractively(ctx, progress) } } + +// readTargetsFromFile reads scan targets from a file, one per line. +// Each line should be in the format "libraryID:folderPath". +// Empty lines and lines starting with # are ignored. +func readTargetsFromFile(filePath string) ([]model.ScanTarget, error) { + file, err := os.Open(filePath) + if err != nil { + return nil, fmt.Errorf("failed to open target file: %w", err) + } + defer file.Close() + + var targetStrings []string + scanner := bufio.NewScanner(file) + for scanner.Scan() { + line := strings.TrimSpace(scanner.Text()) + // Skip empty lines and comments + if line == "" { + continue + } + targetStrings = append(targetStrings, line) + } + + if err := scanner.Err(); err != nil { + return nil, fmt.Errorf("failed to read target file: %w", err) + } + + return model.ParseTargets(targetStrings) +} diff --git a/cmd/scan_test.go b/cmd/scan_test.go new file mode 100644 index 000000000..beeecca19 --- /dev/null +++ b/cmd/scan_test.go @@ -0,0 +1,89 @@ +package cmd + +import ( + "os" + "path/filepath" + + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("readTargetsFromFile", func() { + var tempDir string + + BeforeEach(func() { + var err error + tempDir, err = os.MkdirTemp("", "navidrome-test-") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tempDir) + }) + + It("reads valid targets from file", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "1:Music/Rock\n2:Music/Jazz\n3:Classical\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(3)) + Expect(targets[0]).To(Equal(model.ScanTarget{LibraryID: 1, FolderPath: "Music/Rock"})) + Expect(targets[1]).To(Equal(model.ScanTarget{LibraryID: 2, FolderPath: "Music/Jazz"})) + Expect(targets[2]).To(Equal(model.ScanTarget{LibraryID: 3, FolderPath: "Classical"})) + }) + + It("skips empty lines", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "1:Music/Rock\n\n2:Music/Jazz\n\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + }) + + It("trims whitespace", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := " 1:Music/Rock \n\t2:Music/Jazz\t\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + Expect(targets[1].FolderPath).To(Equal("Music/Jazz")) + }) + + It("returns error for non-existent file", func() { + _, err := readTargetsFromFile("/nonexistent/file.txt") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("failed to open target file")) + }) + + It("returns error for invalid target format", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "invalid-format\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + _, err = readTargetsFromFile(filePath) + Expect(err).To(HaveOccurred()) + }) + + It("handles mixed valid and empty lines", func() { + filePath := filepath.Join(tempDir, "targets.txt") + content := "\n1:Music/Rock\n\n\n2:Music/Jazz\n\n" + err := os.WriteFile(filePath, []byte(content), 0600) + Expect(err).ToNot(HaveOccurred()) + + targets, err := readTargetsFromFile(filePath) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + }) +}) diff --git a/cmd/svc.go b/cmd/svc.go index e277bd459..cc8d6bb54 100644 --- a/cmd/svc.go +++ b/cmd/svc.go @@ -76,13 +76,13 @@ var svcInstance = sync.OnceValue(func() service.Service { options["Restart"] = "on-failure" options["SuccessExitStatus"] = "1 2 8 SIGKILL" options["UserService"] = false - options["LogDirectory"] = conf.Server.DataFolder + options["LogDirectory"] = conf.Server.DataFolder.String() options["SystemdScript"] = systemdScript if conf.Server.LogFile != "" { options["LogOutput"] = false } else { options["LogOutput"] = true - options["LogDirectory"] = conf.Server.DataFolder + options["LogDirectory"] = conf.Server.DataFolder.String() } svcConfig := &service.Config{ UserName: installUser, @@ -131,11 +131,11 @@ func buildInstallCmd() *cobra.Command { println("Installing service with:") println(" working directory: " + executablePath()) println(" music folder: " + conf.Server.MusicFolder) - println(" data folder: " + conf.Server.DataFolder) + println(" data folder: " + conf.Server.DataFolder.String()) if conf.Server.LogFile != "" { println(" log file: " + conf.Server.LogFile) } else { - println(" logs folder: " + conf.Server.DataFolder) + println(" logs folder: " + conf.Server.DataFolder.String()) } if cfgFile != "" { conf.Server.ConfigFile, err = filepath.Abs(cfgFile) @@ -248,6 +248,7 @@ ExecStart={{.Path|cmdEscape}}{{range .Arguments}} {{.|cmd}}{{end}} TimeoutStopSec=20 RestartSec=120 EnvironmentFile=-/etc/sysconfig/{{.Name}} +Environment="ND_SYSTEMD_PRIORITY_LOGGING=1" DevicePolicy=closed NoNewPrivileges=yes diff --git a/cmd/user.go b/cmd/user.go new file mode 100644 index 000000000..1abf157b7 --- /dev/null +++ b/cmd/user.go @@ -0,0 +1,477 @@ +package cmd + +import ( + "context" + "encoding/csv" + "encoding/json" + "errors" + "fmt" + "os" + "strconv" + "strings" + "syscall" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/spf13/cobra" + "golang.org/x/term" +) + +var ( + email string + libraryIds []int + name string + + removeEmail bool + removeName bool + setAdmin bool + setPassword bool + setRegularUser bool +) + +func init() { + rootCmd.AddCommand(userRoot) + + userCreateCommand.Flags().StringVarP(&userID, "username", "u", "", "username") + + userCreateCommand.Flags().StringVarP(&email, "email", "e", "", "New user email") + userCreateCommand.Flags().IntSliceVarP(&libraryIds, "library-ids", "i", []int{}, "Comma-separated list of library IDs. Set the user's accessible libraries. If empty, the user can access all libraries. This is incompatible with admin, as admin can always access all libraries") + + userCreateCommand.Flags().BoolVarP(&setAdmin, "admin", "a", false, "If set, make the user an admin. This user will have access to every library") + userCreateCommand.Flags().StringVar(&name, "name", "", "New user's name (this is separate from username used to log in)") + + _ = userCreateCommand.MarkFlagRequired("username") + + userRoot.AddCommand(userCreateCommand) + + userDeleteCommand.Flags().StringVarP(&userID, "user", "u", "", "username or id") + _ = userDeleteCommand.MarkFlagRequired("user") + userRoot.AddCommand(userDeleteCommand) + + userEditCommand.Flags().StringVarP(&userID, "user", "u", "", "username or id") + + userEditCommand.Flags().BoolVar(&setAdmin, "set-admin", false, "If set, make the user an admin") + userEditCommand.Flags().BoolVar(&setRegularUser, "set-regular", false, "If set, make the user a non-admin") + userEditCommand.MarkFlagsMutuallyExclusive("set-admin", "set-regular") + + userEditCommand.Flags().BoolVar(&removeEmail, "remove-email", false, "If set, clear the user's email") + userEditCommand.Flags().StringVarP(&email, "email", "e", "", "New user email") + userEditCommand.MarkFlagsMutuallyExclusive("email", "remove-email") + + userEditCommand.Flags().BoolVar(&removeName, "remove-name", false, "If set, clear the user's name") + userEditCommand.Flags().StringVar(&name, "name", "", "New user name (this is separate from username used to log in)") + userEditCommand.MarkFlagsMutuallyExclusive("name", "remove-name") + + userEditCommand.Flags().BoolVar(&setPassword, "set-password", false, "If set, the user's new password will be prompted on the CLI") + + userEditCommand.Flags().IntSliceVarP(&libraryIds, "library-ids", "i", []int{}, "Comma-separated list of library IDs. Set the user's accessible libraries by id") + + _ = userEditCommand.MarkFlagRequired("user") + userRoot.AddCommand(userEditCommand) + + userListCommand.Flags().StringVarP(&outputFormat, "format", "f", "csv", "output format [supported values: csv, json]") + userRoot.AddCommand(userListCommand) +} + +var ( + userRoot = &cobra.Command{ + Use: "user", + Short: "Administer users", + Long: "Create, delete, list, or update users", + } + + userCreateCommand = &cobra.Command{ + Use: "create", + Aliases: []string{"c"}, + Short: "Create a new user", + Run: func(cmd *cobra.Command, args []string) { + runCreateUser(cmd.Context()) + }, + } + + userDeleteCommand = &cobra.Command{ + Use: "delete", + Aliases: []string{"d"}, + Short: "Deletes an existing user", + Run: func(cmd *cobra.Command, args []string) { + runDeleteUser(cmd.Context()) + }, + } + + userEditCommand = &cobra.Command{ + Use: "edit", + Aliases: []string{"e"}, + Short: "Edit a user", + Long: "Edit the password, admin status, and/or library access", + Run: func(cmd *cobra.Command, args []string) { + runUserEdit(cmd.Context()) + }, + } + + userListCommand = &cobra.Command{ + Use: "list", + Short: "List users", + Run: func(cmd *cobra.Command, args []string) { + runUserList(cmd.Context()) + }, + } +) + +func promptPassword() string { + for { + fmt.Print("Enter new password (press enter with no password to cancel): ") + // This cast is necessary for some platforms + password, err := term.ReadPassword(int(syscall.Stdin)) //nolint:unconvert + + if err != nil { + log.Fatal("Error getting password", err) + } + + fmt.Print("\nConfirm new password (press enter with no password to cancel): ") + confirmation, err := term.ReadPassword(int(syscall.Stdin)) //nolint:unconvert + + if err != nil { + log.Fatal("Error getting password confirmation", err) + } + + // clear the line. + fmt.Println() + + pass := string(password) + confirm := string(confirmation) + + if pass == "" { + return "" + } + + if pass == confirm { + return pass + } + + fmt.Println("Password and password confirmation do not match") + } +} + +func libraryError(libraries model.Libraries) error { + ids := make([]int, len(libraries)) + for idx, library := range libraries { + ids[idx] = library.ID + } + return fmt.Errorf("not all available libraries found. Requested ids: %v, Found libraries: %v", libraryIds, ids) +} + +func runCreateUser(ctx context.Context) { + password := promptPassword() + if password == "" { + log.Fatal("Empty password provided, user creation cancelled") + } + + user := model.User{ + UserName: userID, + Email: email, + Name: name, + IsAdmin: setAdmin, + NewPassword: password, + } + + if user.Name == "" { + user.Name = userID + } + + ds, ctx := getAdminContext(ctx) + + err := ds.WithTx(func(tx model.DataStore) error { + existingUser, err := tx.User(ctx).FindByUsername(userID) + if existingUser != nil { + return fmt.Errorf("existing user '%s'", userID) + } + + if err != nil && !errors.Is(err, model.ErrNotFound) { + return fmt.Errorf("failed to check existing username: %w", err) + } + + if len(libraryIds) > 0 && !setAdmin { + user.Libraries, err = tx.Library(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}}) + if err != nil { + return err + } + + if len(user.Libraries) != len(libraryIds) { + return libraryError(user.Libraries) + } + } else { + user.Libraries, err = tx.Library(ctx).GetAll() + if err != nil { + return err + } + } + + err = tx.User(ctx).Put(&user) + if err != nil { + return err + } + + updatedIds := make([]int, len(user.Libraries)) + for idx, lib := range user.Libraries { + updatedIds[idx] = lib.ID + } + + err = tx.User(ctx).SetUserLibraries(user.ID, updatedIds) + return err + }) + + if err != nil { + log.Fatal(ctx, err) + } + + log.Info(ctx, "Successfully created user", "id", user.ID, "username", user.UserName) +} + +func runDeleteUser(ctx context.Context) { + ds, ctx := getAdminContext(ctx) + + var err error + var user *model.User + + err = ds.WithTx(func(tx model.DataStore) error { + count, err := tx.User(ctx).CountAll() + if err != nil { + return err + } + + if count == 1 { + return errors.New("refusing to delete the last user") + } + + user, err = getUser(ctx, userID, tx) + if err != nil { + return err + } + + return tx.User(ctx).Delete(user.ID) + }) + + if err != nil { + log.Fatal(ctx, "Failed to delete user", err) + } + + log.Info(ctx, "Deleted user", "username", user.UserName) +} + +func runUserEdit(ctx context.Context) { + ds, ctx := getAdminContext(ctx) + + var err error + var user *model.User + changes := []string{} + + err = ds.WithTx(func(tx model.DataStore) error { + var newLibraries model.Libraries + + user, err = getUser(ctx, userID, tx) + if err != nil { + return err + } + + if len(libraryIds) > 0 && !setAdmin { + libraries, err := tx.Library(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}}) + + if err != nil { + return err + } + + if len(libraries) != len(libraryIds) { + return libraryError(libraries) + } + + newLibraries = libraries + changes = append(changes, "updated library ids") + } + + if setAdmin && !user.IsAdmin { + libraries, err := tx.Library(ctx).GetAll() + if err != nil { + return err + } + + user.IsAdmin = true + user.Libraries = libraries + changes = append(changes, "set admin") + + newLibraries = libraries + } + + if setRegularUser && user.IsAdmin { + user.IsAdmin = false + changes = append(changes, "set regular user") + } + + if setPassword { + password := promptPassword() + + if password != "" { + user.NewPassword = password + changes = append(changes, "updated password") + } + } + + if email != "" && email != user.Email { + user.Email = email + changes = append(changes, "updated email") + } else if removeEmail && user.Email != "" { + user.Email = "" + changes = append(changes, "removed email") + } + + if name != "" && name != user.Name { + user.Name = name + changes = append(changes, "updated name") + } else if removeName && user.Name != "" { + user.Name = "" + changes = append(changes, "removed name") + } + + if len(changes) == 0 { + return nil + } + + err := tx.User(ctx).Put(user) + if err != nil { + return err + } + + if len(newLibraries) > 0 { + updatedIds := make([]int, len(newLibraries)) + for idx, lib := range newLibraries { + updatedIds[idx] = lib.ID + } + + err := tx.User(ctx).SetUserLibraries(user.ID, updatedIds) + if err != nil { + return err + } + } + + return nil + }) + + if err != nil { + log.Fatal(ctx, "Failed to update user", err) + } + + if len(changes) == 0 { + log.Info(ctx, "No changes for user", "user", user.UserName) + } else { + log.Info(ctx, "Updated user", "user", user.UserName, "changes", strings.Join(changes, ", ")) + } +} + +type displayLibrary struct { + ID int `json:"id"` + Path string `json:"path"` +} + +type displayUser struct { + Id string `json:"id"` + Username string `json:"username"` + Name string `json:"name"` + Email string `json:"email"` + Admin bool `json:"admin"` + CreatedAt time.Time `json:"createdAt"` + UpdatedAt time.Time `json:"updatedAt"` + LastAccess *time.Time `json:"lastAccess"` + LastLogin *time.Time `json:"lastLogin"` + Libraries []displayLibrary `json:"libraries"` +} + +func runUserList(ctx context.Context) { + if outputFormat != "csv" && outputFormat != "json" { + log.Fatal("Invalid output format. Must be one of csv, json", "format", outputFormat) + } + + ds, ctx := getAdminContext(ctx) + + users, err := ds.User(ctx).ReadAll() + if err != nil { + log.Fatal(ctx, "Failed to retrieve users", err) + } + + userList := users.(model.Users) + + if outputFormat == "csv" { + w := csv.NewWriter(os.Stdout) + _ = w.Write([]string{ + "user id", + "username", + "user's name", + "user email", + "admin", + "created at", + "updated at", + "last access", + "last login", + "libraries", + }) + for _, user := range userList { + paths := make([]string, len(user.Libraries)) + + for idx, library := range user.Libraries { + paths[idx] = fmt.Sprintf("%d:%s", library.ID, library.Path) + } + + var lastAccess, lastLogin string + + if user.LastAccessAt != nil { + lastAccess = user.LastAccessAt.Format(time.RFC3339Nano) + } else { + lastAccess = "never" + } + + if user.LastLoginAt != nil { + lastLogin = user.LastLoginAt.Format(time.RFC3339Nano) + } else { + lastLogin = "never" + } + + _ = w.Write([]string{ + user.ID, + user.UserName, + user.Name, + user.Email, + strconv.FormatBool(user.IsAdmin), + user.CreatedAt.Format(time.RFC3339Nano), + user.UpdatedAt.Format(time.RFC3339Nano), + lastAccess, + lastLogin, + fmt.Sprintf("'%s'", strings.Join(paths, "|")), + }) + } + w.Flush() + } else { + users := make([]displayUser, len(userList)) + for idx, user := range userList { + paths := make([]displayLibrary, len(user.Libraries)) + + for idx, library := range user.Libraries { + paths[idx].ID = library.ID + paths[idx].Path = library.Path + } + + users[idx].Id = user.ID + users[idx].Username = user.UserName + users[idx].Name = user.Name + users[idx].Email = user.Email + users[idx].Admin = user.IsAdmin + users[idx].CreatedAt = user.CreatedAt + users[idx].UpdatedAt = user.UpdatedAt + users[idx].LastAccess = user.LastAccessAt + users[idx].LastLogin = user.LastLoginAt + users[idx].Libraries = paths + } + + j, _ := json.Marshal(users) + fmt.Printf("%s\n", j) + } +} diff --git a/cmd/utils.go b/cmd/utils.go new file mode 100644 index 000000000..81d646cf1 --- /dev/null +++ b/cmd/utils.go @@ -0,0 +1,42 @@ +package cmd + +import ( + "context" + "errors" + "fmt" + + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" +) + +func getAdminContext(ctx context.Context) (model.DataStore, context.Context) { + sqlDB := db.Db() + ds := persistence.New(sqlDB) + ctx = auth.WithAdminUser(ctx, ds) + u, _ := request.UserFrom(ctx) + if !u.IsAdmin { + log.Fatal(ctx, "There must be at least one admin user to run this command.") + } + return ds, ctx +} + +func getUser(ctx context.Context, id string, ds model.DataStore) (*model.User, error) { + user, err := ds.User(ctx).FindByUsername(id) + + if err != nil && !errors.Is(err, model.ErrNotFound) { + return nil, fmt.Errorf("finding user by name: %w", err) + } + + if errors.Is(err, model.ErrNotFound) { + user, err = ds.User(ctx).Get(id) + if err != nil { + return nil, fmt.Errorf("finding user by id: %w", err) + } + } + + return user, nil +} diff --git a/cmd/wire_gen.go b/cmd/wire_gen.go index d57aadc71..0939eef4d 100644 --- a/cmd/wire_gen.go +++ b/cmd/wire_gen.go @@ -1,6 +1,6 @@ // Code generated by Wire. DO NOT EDIT. -//go:generate go run -mod=mod github.com/google/wire/cmd/wire gen -tags "netgo" +//go:generate go run -mod=mod github.com/google/wire/cmd/wire gen -tags "netgo sqlite_fts5" //go:build !wireinject // +build !wireinject @@ -9,19 +9,25 @@ package cmd import ( "context" "github.com/google/wire" + "github.com/navidrome/navidrome/adapters/lastfm" + "github.com/navidrome/navidrome/adapters/listenbrainz" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/core/agents/lastfm" - "github.com/navidrome/navidrome/core/agents/listenbrainz" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/core/lyrics" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/plugins" "github.com/navidrome/navidrome/scanner" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/server/events" @@ -31,7 +37,10 @@ import ( ) import ( - _ "github.com/navidrome/navidrome/adapters/taglib" + _ "github.com/navidrome/navidrome/adapters/deezer" + _ "github.com/navidrome/navidrome/adapters/gotaglib" + _ "github.com/navidrome/navidrome/adapters/lastfm" + _ "github.com/navidrome/navidrome/adapters/listenbrainz" ) // Injectors from wire_injectors.go: @@ -51,13 +60,29 @@ func CreateServer() *server.Server { return serverServer } -func CreateNativeAPIRouter() *nativeapi.Router { +func CreateNativeAPIRouter(ctx context.Context) *nativeapi.Router { sqlDB := db.Db() dataStore := persistence.New(sqlDB) share := core.NewShare(dataStore) - playlists := core.NewPlaylists(dataStore) + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) insights := metrics.GetInstance(dataStore) - router := nativeapi.New(dataStore, share, playlists, insights) + fileCache := artwork.GetImageCache() + fFmpeg := ffmpeg.New() + broker := events.GetBroker() + metricsMetrics := metrics.GetPrometheusInstance(dataStore) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) + agentsAgents := agents.GetAgents(dataStore, manager) + matcherMatcher := matcher.New(dataStore) + provider := external.NewProvider(dataStore, agentsAgents, matcherMatcher) + artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) + cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) + watcher := scanner.GetWatcher(dataStore, modelScanner) + library := core.NewLibrary(dataStore, modelScanner, watcher, broker, manager) + user := core.NewUser(dataStore, manager) + maintenance := core.NewMaintenance(dataStore) + router := nativeapi.New(dataStore, share, playlistsPlaylists, insights, library, user, maintenance, manager, imageUploadService) return router } @@ -66,22 +91,28 @@ func CreateSubsonicAPIRouter(ctx context.Context) *subsonic.Router { dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() - agentsAgents := agents.GetAgents(dataStore) - provider := external.NewProvider(dataStore, agentsAgents) + broker := events.GetBroker() + metricsMetrics := metrics.GetPrometheusInstance(dataStore) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) + agentsAgents := agents.GetAgents(dataStore, manager) + matcherMatcher := matcher.New(dataStore) + provider := external.NewProvider(dataStore, agentsAgents, matcherMatcher) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) - transcodingCache := core.GetTranscodingCache() - mediaStreamer := core.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) + transcodingCache := stream.GetTranscodingCache() + mediaStreamer := stream.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) share := core.NewShare(dataStore) archiver := core.NewArchiver(mediaStreamer, dataStore, share) players := core.NewPlayers(dataStore) cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) - broker := events.GetBroker() - playlists := core.NewPlaylists(dataStore) - metricsMetrics := metrics.NewPrometheusInstance(dataStore) - scannerScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlists, metricsMetrics) - playTracker := scrobbler.GetPlayTracker(dataStore, broker) + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) + playTracker := scrobbler.GetPlayTracker(dataStore, broker, manager) playbackServer := playback.GetInstance(dataStore) - router := subsonic.New(dataStore, artworkArtwork, mediaStreamer, archiver, players, provider, scannerScanner, broker, playlists, playTracker, share, playbackServer) + lyricsLyrics := lyrics.NewLyrics(manager) + transcodeDecider := stream.NewTranscodeDecider(dataStore, fFmpeg) + sonicSonic := sonic.New(dataStore, manager, matcherMatcher) + router := subsonic.New(dataStore, artworkArtwork, mediaStreamer, archiver, players, provider, modelScanner, broker, playlistsPlaylists, playTracker, share, playbackServer, metricsMetrics, lyricsLyrics, transcodeDecider, sonicSonic) return router } @@ -90,11 +121,15 @@ func CreatePublicRouter() *public.Router { dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() - agentsAgents := agents.GetAgents(dataStore) - provider := external.NewProvider(dataStore, agentsAgents) + broker := events.GetBroker() + metricsMetrics := metrics.GetPrometheusInstance(dataStore) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) + agentsAgents := agents.GetAgents(dataStore, manager) + matcherMatcher := matcher.New(dataStore) + provider := external.NewProvider(dataStore, agentsAgents, matcherMatcher) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) - transcodingCache := core.GetTranscodingCache() - mediaStreamer := core.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) + transcodingCache := stream.GetTranscodingCache() + mediaStreamer := stream.NewMediaStreamer(dataStore, fFmpeg, transcodingCache) share := core.NewShare(dataStore) archiver := core.NewArchiver(mediaStreamer, dataStore, share) router := public.New(dataStore, artworkArtwork, mediaStreamer, share, archiver) @@ -125,24 +160,27 @@ func CreateInsights() metrics.Insights { func CreatePrometheus() metrics.Metrics { sqlDB := db.Db() dataStore := persistence.New(sqlDB) - metricsMetrics := metrics.NewPrometheusInstance(dataStore) + metricsMetrics := metrics.GetPrometheusInstance(dataStore) return metricsMetrics } -func CreateScanner(ctx context.Context) scanner.Scanner { +func CreateScanner(ctx context.Context) model.Scanner { sqlDB := db.Db() dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() - agentsAgents := agents.GetAgents(dataStore) - provider := external.NewProvider(dataStore, agentsAgents) + broker := events.GetBroker() + metricsMetrics := metrics.GetPrometheusInstance(dataStore) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) + agentsAgents := agents.GetAgents(dataStore, manager) + matcherMatcher := matcher.New(dataStore) + provider := external.NewProvider(dataStore, agentsAgents, matcherMatcher) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) - broker := events.GetBroker() - playlists := core.NewPlaylists(dataStore) - metricsMetrics := metrics.NewPrometheusInstance(dataStore) - scannerScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlists, metricsMetrics) - return scannerScanner + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) + return modelScanner } func CreateScanWatcher(ctx context.Context) scanner.Watcher { @@ -150,15 +188,18 @@ func CreateScanWatcher(ctx context.Context) scanner.Watcher { dataStore := persistence.New(sqlDB) fileCache := artwork.GetImageCache() fFmpeg := ffmpeg.New() - agentsAgents := agents.GetAgents(dataStore) - provider := external.NewProvider(dataStore, agentsAgents) + broker := events.GetBroker() + metricsMetrics := metrics.GetPrometheusInstance(dataStore) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) + agentsAgents := agents.GetAgents(dataStore, manager) + matcherMatcher := matcher.New(dataStore) + provider := external.NewProvider(dataStore, agentsAgents, matcherMatcher) artworkArtwork := artwork.NewArtwork(dataStore, fileCache, fFmpeg, provider) cacheWarmer := artwork.NewCacheWarmer(artworkArtwork, fileCache) - broker := events.GetBroker() - playlists := core.NewPlaylists(dataStore) - metricsMetrics := metrics.NewPrometheusInstance(dataStore) - scannerScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlists, metricsMetrics) - watcher := scanner.NewWatcher(dataStore, scannerScanner) + imageUploadService := core.NewImageUploadService() + playlistsPlaylists := playlists.NewPlaylists(dataStore, imageUploadService) + modelScanner := scanner.New(ctx, dataStore, cacheWarmer, broker, playlistsPlaylists, metricsMetrics) + watcher := scanner.GetWatcher(dataStore, modelScanner) return watcher } @@ -169,6 +210,21 @@ func GetPlaybackServer() playback.PlaybackServer { return playbackServer } +func getPluginManager() *plugins.Manager { + sqlDB := db.Db() + dataStore := persistence.New(sqlDB) + broker := events.GetBroker() + metricsMetrics := metrics.GetPrometheusInstance(dataStore) + manager := plugins.GetManager(dataStore, broker, metricsMetrics) + return manager +} + // wire_injectors.go: -var allProviders = wire.NewSet(core.Set, artwork.Set, server.New, subsonic.New, nativeapi.New, public.New, persistence.New, lastfm.NewRouter, listenbrainz.NewRouter, events.GetBroker, scanner.New, scanner.NewWatcher, metrics.NewPrometheusInstance, db.Db) +var allProviders = wire.NewSet(core.Set, artwork.Set, server.New, subsonic.New, nativeapi.New, public.New, persistence.New, lastfm.NewRouter, listenbrainz.NewRouter, events.GetBroker, scanner.New, scanner.GetWatcher, metrics.GetPrometheusInstance, db.Db, plugins.GetManager, sonic.New, wire.Bind(new(agents.PluginLoader), new(*plugins.Manager)), wire.Bind(new(scrobbler.PluginLoader), new(*plugins.Manager)), wire.Bind(new(lyrics.PluginLoader), new(*plugins.Manager)), wire.Bind(new(sonic.PluginLoader), new(*plugins.Manager)), wire.Bind(new(nativeapi.PluginManager), new(*plugins.Manager)), wire.Bind(new(core.PluginUnloader), new(*plugins.Manager)), wire.Bind(new(plugins.PluginMetricsRecorder), new(metrics.Metrics)), wire.Bind(new(core.Watcher), new(scanner.Watcher))) + +func GetPluginManager(ctx context.Context) *plugins.Manager { + manager := getPluginManager() + manager.SetSubsonicRouter(CreateSubsonicAPIRouter(ctx)) + return manager +} diff --git a/cmd/wire_injectors.go b/cmd/wire_injectors.go index c431945dc..bb5c5b5f3 100644 --- a/cmd/wire_injectors.go +++ b/cmd/wire_injectors.go @@ -6,15 +6,20 @@ import ( "context" "github.com/google/wire" + "github.com/navidrome/navidrome/adapters/lastfm" + "github.com/navidrome/navidrome/adapters/listenbrainz" "github.com/navidrome/navidrome/core" - "github.com/navidrome/navidrome/core/agents/lastfm" - "github.com/navidrome/navidrome/core/agents/listenbrainz" + "github.com/navidrome/navidrome/core/agents" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/sonic" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/plugins" "github.com/navidrome/navidrome/scanner" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/server/events" @@ -35,9 +40,19 @@ var allProviders = wire.NewSet( listenbrainz.NewRouter, events.GetBroker, scanner.New, - scanner.NewWatcher, - metrics.NewPrometheusInstance, + scanner.GetWatcher, + metrics.GetPrometheusInstance, db.Db, + plugins.GetManager, + sonic.New, + wire.Bind(new(agents.PluginLoader), new(*plugins.Manager)), + wire.Bind(new(scrobbler.PluginLoader), new(*plugins.Manager)), + wire.Bind(new(lyrics.PluginLoader), new(*plugins.Manager)), + wire.Bind(new(sonic.PluginLoader), new(*plugins.Manager)), + wire.Bind(new(nativeapi.PluginManager), new(*plugins.Manager)), + wire.Bind(new(core.PluginUnloader), new(*plugins.Manager)), + wire.Bind(new(plugins.PluginMetricsRecorder), new(metrics.Metrics)), + wire.Bind(new(core.Watcher), new(scanner.Watcher)), ) func CreateDataStore() model.DataStore { @@ -52,7 +67,7 @@ func CreateServer() *server.Server { )) } -func CreateNativeAPIRouter() *nativeapi.Router { +func CreateNativeAPIRouter(ctx context.Context) *nativeapi.Router { panic(wire.Build( allProviders, )) @@ -94,7 +109,7 @@ func CreatePrometheus() metrics.Metrics { )) } -func CreateScanner(ctx context.Context) scanner.Scanner { +func CreateScanner(ctx context.Context) model.Scanner { panic(wire.Build( allProviders, )) @@ -111,3 +126,15 @@ func GetPlaybackServer() playback.PlaybackServer { allProviders, )) } + +func getPluginManager() *plugins.Manager { + panic(wire.Build( + allProviders, + )) +} + +func GetPluginManager(ctx context.Context) *plugins.Manager { + manager := getPluginManager() + manager.SetSubsonicRouter(CreateSubsonicAPIRouter(ctx)) + return manager +} diff --git a/conf/buildtags/buildtags.go b/conf/buildtags/buildtags.go deleted file mode 100644 index 5fc125087..000000000 --- a/conf/buildtags/buildtags.go +++ /dev/null @@ -1,4 +0,0 @@ -package buildtags - -// This file is left intentionally empty. It is used to make sure the package is not empty, in the case all -// required build tags are disabled. diff --git a/conf/buildtags/doc.go b/conf/buildtags/doc.go new file mode 100644 index 000000000..f637b6355 --- /dev/null +++ b/conf/buildtags/doc.go @@ -0,0 +1,6 @@ +// Package buildtags provides compile-time enforcement of required build tags. +// +// Each file in this package is guarded by a build constraint and exports a variable +// that main.go references. If a required tag is missing during compilation, the build +// fails with an "undefined" error, directing the developer to use `make build`. +package buildtags diff --git a/conf/buildtags/netgo.go b/conf/buildtags/netgo.go index 0062ad2bc..407004703 100644 --- a/conf/buildtags/netgo.go +++ b/conf/buildtags/netgo.go @@ -2,10 +2,6 @@ package buildtags -// NOTICE: This file was created to force the inclusion of the `netgo` tag when compiling the project. -// If the tag is not included, the compilation will fail because this variable won't be defined, and the `main.go` -// file requires it. - -// Why this tag is required? See https://github.com/navidrome/navidrome/issues/700 +// The `netgo` tag is required when compiling the project. See https://github.com/navidrome/navidrome/issues/700 var NETGO = true diff --git a/conf/buildtags/sqlite_fts5.go b/conf/buildtags/sqlite_fts5.go new file mode 100644 index 000000000..1476e04cd --- /dev/null +++ b/conf/buildtags/sqlite_fts5.go @@ -0,0 +1,8 @@ +//go:build sqlite_fts5 + +package buildtags + +// FTS5 is required for full-text search. Without this tag, the SQLite driver +// won't include FTS5 support, causing runtime failures on migrations and search queries. + +var SQLITE_FTS5 = true diff --git a/conf/configtest/configtest.go b/conf/configtest/configtest.go index b947e6263..cd0ac41ed 100644 --- a/conf/configtest/configtest.go +++ b/conf/configtest/configtest.go @@ -2,9 +2,7 @@ package configtest import "github.com/navidrome/navidrome/conf" +// TODO Remove this redirection and call SnapshotConfig directly from tests func SetupConfig() func() { - oldValues := *conf.Server - return func() { - conf.Server = &oldValues - } + return conf.SnapshotConfig() } diff --git a/conf/configuration.go b/conf/configuration.go index 8561f343f..08f12fc94 100644 --- a/conf/configuration.go +++ b/conf/configuration.go @@ -1,21 +1,26 @@ package conf import ( + "cmp" + "encoding/json" "fmt" "net/url" "os" "path/filepath" "runtime" + "slices" "strings" "time" "github.com/bmatcuk/doublestar/v4" + "github.com/dustin/go-humanize" "github.com/go-viper/encoding/ini" + "github.com/go-viper/mapstructure/v2" "github.com/kr/pretty" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/utils/chain" - "github.com/robfig/cron/v3" + "github.com/navidrome/navidrome/scheduler" + "github.com/navidrome/navidrome/utils/run" "github.com/spf13/viper" ) @@ -24,9 +29,10 @@ type configOptions struct { Address string Port int UnixSocketPerm string + EnforceNonRootUser bool MusicFolder string - DataFolder string - CacheFolder string + DataFolder Dir + CacheFolder Dir DbPath string LogLevel string LogFile string @@ -43,6 +49,7 @@ type configOptions struct { EnableTranscodingConfig bool EnableDownloads bool EnableExternalServices bool + EnableM3UExternalAlbumArt bool EnableInsightsCollector bool EnableMediaFileCoverArt bool TranscodingCacheSize string @@ -55,7 +62,8 @@ type configOptions struct { SmartPlaylistRefreshDelay time.Duration AutoTranscodeDownload bool DefaultDownsamplingFormat string - SearchFullString bool + Search searchOptions `json:",omitzero"` + Matcher matcherOptions `json:",omitzero"` RecentlyAddedByModTime bool PreferSortTags bool IgnoredArticles string @@ -64,12 +72,18 @@ type configOptions struct { MPVPath string MPVCmdTemplate string CoverArtPriority string - CoverJpegQuality int + CoverArtQuality int + EnableWebPEncoding bool ArtistArtPriority string + ArtistImageFolder string + DiscArtPriority string + LyricsPriority string EnableGravatar bool EnableFavourites bool EnableStarRating bool EnableUserEditing bool + EnableArtworkUpload bool + MaxImageUploadSize string EnableSharing bool ShareURL string DefaultShareExpiration time.Duration @@ -77,51 +91,65 @@ type configOptions struct { DefaultTheme string DefaultLanguage string DefaultUIVolume int + UISearchDebounceMs int + UICoverArtSize int EnableReplayGain bool EnableCoverAnimation bool + EnableNowPlaying bool + UIPlaybackReportInterval time.Duration GATrackingID string EnableLogRedacting bool AuthRequestLimit int AuthWindowLength time.Duration PasswordEncryptionKey string - ReverseProxyUserHeader string - ReverseProxyWhitelist string - HTTPSecurityHeaders secureOptions - Prometheus prometheusOptions - Scanner scannerOptions - Jukebox jukeboxOptions - Backup backupOptions - PID pidOptions - Inspect inspectOptions - Subsonic subsonicOptions - LyricsPriority string - - Agents string - LastFM lastfmOptions - Spotify spotifyOptions - ListenBrainz listenBrainzOptions - Tags map[string]TagConf + ExtAuth extAuthOptions + Plugins pluginsOptions + HTTPHeaders httpHeaderOptions `json:",omitzero"` + Prometheus prometheusOptions `json:",omitzero"` + Scanner scannerOptions `json:",omitzero"` + Jukebox jukeboxOptions `json:",omitzero"` + Backup backupOptions `json:",omitzero"` + PID pidOptions `json:",omitzero"` + Inspect inspectOptions `json:",omitzero"` + Subsonic subsonicOptions `json:",omitzero"` + Transcoding transcodingOptions `json:",omitzero"` + LastFM lastfmOptions `json:",omitzero"` + Deezer deezerOptions `json:",omitzero"` + ListenBrainz listenBrainzOptions `json:",omitzero"` + EnableScrobbleHistory bool + Tags map[string]TagConf `json:",omitempty"` + Agents string // DevFlags. These are used to enable/disable debugging and incomplete features - DevLogSourceLine bool - DevLogLevels map[string]string - DevEnableProfiler bool - DevAutoCreateAdminPassword string - DevAutoLoginUsername string - DevActivityPanel bool - DevActivityPanelUpdateRate time.Duration - DevSidebarPlaylists bool - DevShowArtistPage bool - DevOffsetOptimize int - DevArtworkMaxRequests int - DevArtworkThrottleBacklogLimit int - DevArtworkThrottleBacklogTimeout time.Duration - DevArtistInfoTimeToLive time.Duration - DevAlbumInfoTimeToLive time.Duration - DevExternalScanner bool - DevScannerThreads uint - DevInsightsInitialDelay time.Duration - DevEnablePlayerInsights bool + DevLogLevels map[string]string `json:",omitempty"` + DevLogSourceLine bool + DevEnableProfiler bool + DevAutoCreateAdminPassword string + DevAutoLoginUsername string + DevActivityPanel bool + DevActivityPanelUpdateRate time.Duration + DevSidebarPlaylists bool + DevShowArtistPage bool + DevUIShowConfig bool + DevNewEventStream bool + DevOffsetOptimize int + DevArtworkMaxRequests int + DevArtworkThrottleBacklogLimit int + DevArtworkThrottleBacklogTimeout time.Duration + DevArtworkThrottleBuffered bool + DevArtistInfoTimeToLive time.Duration + DevAlbumInfoTimeToLive time.Duration + DevExternalScanner bool + DevScannerThreads uint + DevSelectiveWatcher bool + DevInsightsInitialDelay time.Duration + DevEnablePlayerInsights bool + DevEnablePluginsInsights bool + DevPluginCompilationTimeout time.Duration + DevExternalArtistFetchMultiplier float64 + DevOptimizeDB bool + DevPreserveUnicodeInExternalCalls bool + DevEnableMediaFileProbe bool } type scannerOptions struct { @@ -137,47 +165,65 @@ type scannerOptions struct { PurgeMissing string // Values: "never", "always", "full" } +type transcodingOptions struct { + MaxConcurrent int + MaxConcurrentPerUser int + EnableCancellation bool +} + type subsonicOptions struct { AppendSubtitle bool + AppendAlbumVersion bool ArtistParticipations bool DefaultReportRealPath bool + EnableAverageRating bool LegacyClients string + MinimalClients string } type TagConf struct { - Ignore bool `yaml:"ignore"` - Aliases []string `yaml:"aliases"` - Type string `yaml:"type"` - MaxLength int `yaml:"maxLength"` - Split []string `yaml:"split"` - Album bool `yaml:"album"` + Ignore bool `yaml:"ignore" json:",omitempty"` + Aliases []string `yaml:"aliases" json:",omitempty"` + Type string `yaml:"type" json:",omitempty"` + MaxLength int `yaml:"maxLength" json:",omitempty"` + Split []string `yaml:"split" json:",omitempty"` + Album bool `yaml:"album" json:",omitempty"` } type lastfmOptions struct { - Enabled bool - ApiKey string - Secret string - Language string + Enabled bool + ApiKey string //nolint:gosec + Secret string //nolint:gosec + Language string + ScrobbleFirstArtistOnly bool + + // Computed values + Languages []string // Computed from Language, split by comma } -type spotifyOptions struct { - ID string - Secret string +type deezerOptions struct { + Enabled bool + Language string + + // Computed values + Languages []string // Computed from Language, split by comma } type listenBrainzOptions struct { - Enabled bool - BaseURL string + Enabled bool + BaseURL string + ArtistAlgorithm string + TrackAlgorithm string } -type secureOptions struct { - CustomFrameOptionsValue string +type httpHeaderOptions struct { + FrameOptions string } type prometheusOptions struct { Enabled bool MetricsPath string - Password string + Password string //nolint:gosec } type AudioDeviceDefinition []string @@ -191,7 +237,7 @@ type jukeboxOptions struct { type backupOptions struct { Count int - Path string + Path Dir Schedule string } @@ -207,66 +253,134 @@ type inspectOptions struct { BacklogTimeout int } +type pluginsOptions struct { + Enabled bool + Folder Dir + CacheSize string + AutoReload bool + LogLevel string +} + +type extAuthOptions struct { + TrustedSources string + UserHeader string + LogoutURL string +} + +type searchOptions struct { + Backend string + FullString bool +} + +type matcherOptions struct { + PreferStarred bool + FuzzyThreshold int +} + +// logFatal prints a fatal error message to stderr and exits. +// Overridden in tests to allow testing fatal paths. +var logFatal = func(args ...any) { + _, _ = fmt.Fprintln(os.Stderr, append([]any{"FATAL:"}, args...)...) + os.Exit(1) +} + +var getEUID = os.Geteuid + +var currentGOOS = func() string { + return runtime.GOOS +} + var ( Server = &configOptions{} hooks []func() ) +// SnapshotConfig returns a function that restores Server to its current state. +// Uses JSON round-tripping so Dir fields get fresh sync.Once values. +func SnapshotConfig() func() { + snapshot, err := json.Marshal(Server) + if err != nil { + panic(fmt.Sprintf("SnapshotConfig: marshal failed: %v", err)) + } + return func() { + var restored configOptions + if err := json.Unmarshal(snapshot, &restored); err != nil { + panic(fmt.Sprintf("SnapshotConfig: unmarshal failed: %v", err)) + } + Server = &restored + } +} + func LoadFromFile(confFile string) { viper.SetConfigFile(confFile) err := viper.ReadInConfig() if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error reading config file:", err) - os.Exit(1) + logFatal("Error reading config file:", err) } Load(true) } func Load(noConfigDump bool) { parseIniFileConfiguration() + remapEnvVarKeysFromConfig() - err := viper.Unmarshal(&Server) + // Map deprecated options to their new names for backwards compatibility + mapDeprecatedOption("ReverseProxyWhitelist", "ExtAuth.TrustedSources") + mapDeprecatedOption("ReverseProxyUserHeader", "ExtAuth.UserHeader") + mapDeprecatedOption("HTTPSecurityHeaders.CustomFrameOptionsValue", "HTTPHeaders.FrameOptions") + mapDeprecatedOption("CoverJpegQuality", "CoverArtQuality") + mapDeprecatedOption("SimilarSongsMatchThreshold", "Matcher.FuzzyThreshold") + mapDeprecatedOption("EnableTranscodingCancellation", "Transcoding.EnableCancellation") + + err := viper.Unmarshal(&Server, viper.DecodeHook( + mapstructure.ComposeDecodeHookFunc( + mapstructure.TextUnmarshallerHookFunc(), + mapstructure.StringToTimeDurationHookFunc(), + mapstructure.StringToSliceHookFunc(","), + ), + )) if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error parsing config:", err) - os.Exit(1) + logFatal("Error parsing config:", err) } - err = os.MkdirAll(Server.DataFolder, os.ModePerm) - if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error creating data path:", err) - os.Exit(1) + // Validate non-root user early, before any filesystem operations + if err := validateEnforceNonRootUser(); err != nil { + logFatal(err) } - if Server.CacheFolder == "" { - Server.CacheFolder = filepath.Join(Server.DataFolder, "cache") + if Server.CacheFolder.String() == "" { + Server.CacheFolder = NewDir(filepath.Join(Server.DataFolder.String(), "cache")) } - err = os.MkdirAll(Server.CacheFolder, os.ModePerm) - if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error creating cache path:", err) - os.Exit(1) + + if Server.Plugins.Enabled { + if Server.Plugins.Folder.String() == "" { + Server.Plugins.Folder = NewDirWithPerm(filepath.Join(Server.DataFolder.String(), "plugins"), 0700) + } else { + Server.Plugins.Folder = NewDirWithPerm(Server.Plugins.Folder.String(), 0700) + } } Server.ConfigFile = viper.GetViper().ConfigFileUsed() if Server.DbPath == "" { - Server.DbPath = filepath.Join(Server.DataFolder, consts.DefaultDbPath) - } - - if Server.Backup.Path != "" { - err = os.MkdirAll(Server.Backup.Path, os.ModePerm) - if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error creating backup path:", err) - os.Exit(1) - } + Server.DbPath = filepath.Join(Server.DataFolder.String(), consts.DefaultDbPath) } out := os.Stderr if Server.LogFile != "" { + if mkErr := os.MkdirAll(filepath.Dir(Server.LogFile), os.ModePerm); mkErr != nil { + logFatal(fmt.Sprintf("Error creating log file directory: %s", mkErr.Error())) + } out, err = os.OpenFile(Server.LogFile, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) if err != nil { - _, _ = fmt.Fprintf(os.Stderr, "FATAL: Error opening log file %s: %s\n", Server.LogFile, err.Error()) - os.Exit(1) + logFatal(fmt.Sprintf("Error opening log file %s: %s", Server.LogFile, err.Error())) } log.SetOutput(out) + } else if os.Getenv("ND_SYSTEMD_PRIORITY_LOGGING") != "" && os.Getenv("JOURNAL_STREAM") != "" { + // When running under systemd, prepend syslog priority prefixes so + // journald assigns the correct severity to each log line. + // Note that we have an additional environment variable, as JOURNAL_STREAM + // can be present in a systemd environment even if not running as a systemd service + log.EnableJournalFormat() } log.SetLevelString(Server.LogLevel) @@ -274,21 +388,24 @@ func Load(noConfigDump bool) { log.SetLogSourceLine(Server.DevLogSourceLine) log.SetRedacting(Server.EnableLogRedacting) - err = chain.RunSequentially( + err = run.Sequentially( validateScanSchedule, validateBackupSchedule, validatePlaylistsPath, validatePurgeMissingOption, + validateMaxImageUploadSize, + validateURL("ExtAuth.LogoutURL", Server.ExtAuth.LogoutURL), ) if err != nil { - os.Exit(1) + logFatal(err) } + Server.Search.Backend = normalizeSearchBackend(Server.Search.Backend) + if Server.BaseURL != "" { u, err := url.Parse(Server.BaseURL) if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Invalid BaseURL:", err) - os.Exit(1) + logFatal("Invalid BaseURL:", err) } Server.BasePath = u.Path u.Path = "" @@ -297,9 +414,18 @@ func Load(noConfigDump bool) { Server.BaseScheme = u.Scheme } + // Log configuration source + if Server.ConfigFile != "" { + log.Info("Loaded configuration", "file", Server.ConfigFile) + } else if hasNDEnvVars() { + log.Info("No configuration file found. Loaded configuration only from environment variables") + } else { + log.Warn("No configuration file found. Using default values. To specify a config file, use the --configfile flag or set the ND_CONFIGFILE environment variable.") + } + // Print current configuration if log level is Debug if log.IsGreaterOrEqualTo(log.LevelDebug) && !noConfigDump { - prettyConf := pretty.Sprintf("Loaded configuration from '%s': %# v", Server.ConfigFile, Server) + prettyConf := pretty.Sprintf("Configuration: %# v", Server) if Server.EnableLogRedacting { prettyConf = log.Redact(prettyConf) } @@ -310,13 +436,37 @@ func Load(noConfigDump bool) { disableExternalServices() } - if Server.Scanner.Extractor != consts.DefaultScannerExtractor { - log.Warn(fmt.Sprintf("Extractor '%s' is not implemented, using 'taglib'", Server.Scanner.Extractor)) - Server.Scanner.Extractor = consts.DefaultScannerExtractor + // Make sure we don't have empty PIDs + Server.PID.Album = cmp.Or(Server.PID.Album, consts.DefaultAlbumPID) + Server.PID.Track = cmp.Or(Server.PID.Track, consts.DefaultTrackPID) + + // Parse LastFM.Language into Languages slice (comma-separated, with fallback to DefaultInfoLanguage) + Server.LastFM.Languages = parseLanguages(Server.LastFM.Language) + + // Parse Deezer.Language into Languages slice (comma-separated, with fallback to DefaultInfoLanguage) + Server.Deezer.Languages = parseLanguages(Server.Deezer.Language) + + // Deprecated options + logDeprecatedOptions("Scanner.GenreSeparators", "") + logDeprecatedOptions("Scanner.GroupAlbumReleases", "") + logDeprecatedOptions("DevEnableBufferedScrobble", "") // Deprecated: Buffered scrobbling is now always enabled and this option is ignored + logDeprecatedOptions("SearchFullString", "Search.FullString") + logDeprecatedOptions("ReverseProxyWhitelist", "ExtAuth.TrustedSources") + logDeprecatedOptions("ReverseProxyUserHeader", "ExtAuth.UserHeader") + logDeprecatedOptions("HTTPSecurityHeaders.CustomFrameOptionsValue", "HTTPHeaders.FrameOptions") + logDeprecatedOptions("CoverJpegQuality", "CoverArtQuality") + logDeprecatedOptions("SimilarSongsMatchThreshold", "Matcher.FuzzyThreshold") + logDeprecatedOptions("EnableTranscodingCancellation", "Transcoding.EnableCancellation") + + // Removed options + logRemovedOptions("Spotify.ID", "Spotify.Secret") + + // Validate other options + if Server.UICoverArtSize < 200 || Server.UICoverArtSize > 1200 { + newValue := max(200, min(1200, Server.UICoverArtSize)) + log.Warn("UICoverArtSize must be between 200 and 1200, clamping", "value", Server.UICoverArtSize, "newValue", newValue) + Server.UICoverArtSize = newValue } - logDeprecatedOptions("Scanner.GenreSeparators") - logDeprecatedOptions("Scanner.GroupAlbumReleases") - logDeprecatedOptions("DevEnableBufferedScrobble") // Deprecated: Buffered scrobbling is now always enabled and this option is ignored // Call init hooks for _, hook := range hooks { @@ -324,15 +474,75 @@ func Load(noConfigDump bool) { } } -func logDeprecatedOptions(options ...string) { +func logDeprecatedOptions(oldName, newName string) { + envVar := "ND_" + strings.ToUpper(strings.ReplaceAll(oldName, ".", "_")) + newEnvVar := "ND_" + strings.ToUpper(strings.ReplaceAll(newName, ".", "_")) + logWarning := func(oldName, newName string) { + if newName != "" { + log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release. Please use the new '%s'", oldName, newName)) + } else { + log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release", oldName)) + } + } + if os.Getenv(envVar) != "" { + logWarning(envVar, newEnvVar) + } + if viper.InConfig(oldName) { + logWarning(oldName, newName) + } +} + +// logRemovedOptions checks if the option is set, and if yes, outputs a warning message saying the option is +// not available anymore +func logRemovedOptions(options ...string) { for _, option := range options { envVar := "ND_" + strings.ToUpper(strings.ReplaceAll(option, ".", "_")) - if os.Getenv(envVar) != "" { - log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release", envVar)) + logWarning := func(option string) { + log.Warn(fmt.Sprintf("Option '%s' is not available anymore and will be ignored. Please remove it from your config", option)) } if viper.InConfig(option) { - log.Warn(fmt.Sprintf("Option '%s' is deprecated and will be ignored in a future release", option)) + logWarning(option) } + if os.Getenv(envVar) != "" { + logWarning(envVar) + } + } +} + +// remapEnvVarKeysFromConfig detects ND_-prefixed keys in the config file (users mistakenly +// using environment variable names) and remaps them to canonical Viper keys with a warning. +func remapEnvVarKeysFromConfig() { + for _, key := range viper.AllKeys() { + if !strings.HasPrefix(key, "nd_") || !viper.InConfig(key) { + continue + } + stripped := strings.TrimPrefix(key, "nd_") + canonicalKey := strings.ReplaceAll(stripped, "_", ".") + displayNDKey := "ND_" + strings.ToUpper(stripped) + displayCanonical := toPascalCase(canonicalKey) + + if viper.InConfig(canonicalKey) { + logFatal(fmt.Sprintf( + "Config file contains both '%s' and '%s'. Remove the ND_-prefixed version. "+ + "The 'ND_' prefix is only needed for environment variables, not config file keys.", + displayNDKey, displayCanonical, + )) + return + } + + viper.Set(canonicalKey, viper.Get(key)) + _, _ = fmt.Fprintf(os.Stderr, "WARNING: Config key '%s' uses environment variable naming. Use '%s' instead. "+ + "The 'ND_' prefix is only needed for environment variables.\n", + displayNDKey, displayCanonical, + ) + } +} + +// mapDeprecatedOption is used to provide backwards compatibility for deprecated options. It should be called after +// the config has been read by viper, but before unmarshalling it into the Config struct. +func mapDeprecatedOption(legacyName, newName string) { + if viper.IsSet(legacyName) { + viper.Set(newName, viper.Get(legacyName)) } } @@ -342,21 +552,18 @@ func logDeprecatedOptions(options ...string) { func parseIniFileConfiguration() { cfgFile := viper.ConfigFileUsed() if strings.ToLower(filepath.Ext(cfgFile)) == ".ini" { - var iniConfig map[string]interface{} + var iniConfig map[string]any err := viper.Unmarshal(&iniConfig) if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error parsing config:", err) - os.Exit(1) + logFatal("Error parsing config:", err) } cfg, ok := iniConfig["default"].(map[string]any) if !ok { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error parsing config: missing [default] section:", iniConfig) - os.Exit(1) + logFatal("Error parsing config: missing [default] section:", iniConfig) } err = viper.MergeConfigMap(cfg) if err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Error parsing config:", err) - os.Exit(1) + logFatal("Error parsing config:", err) } } } @@ -364,8 +571,9 @@ func parseIniFileConfiguration() { func disableExternalServices() { log.Info("All external integrations are DISABLED!") Server.EnableInsightsCollector = false + Server.EnableM3UExternalAlbumArt = false Server.LastFM.Enabled = false - Server.Spotify.ID = "" + Server.Deezer.Enabled = false Server.ListenBrainz.Enabled = false Server.Agents = "" if Server.UILoginBackgroundURL == consts.DefaultUILoginBackgroundURL { @@ -374,34 +582,61 @@ func disableExternalServices() { } func validatePlaylistsPath() error { - for _, path := range strings.Split(Server.PlaylistsPath, string(filepath.ListSeparator)) { + for path := range strings.SplitSeq(Server.PlaylistsPath, string(filepath.ListSeparator)) { _, err := doublestar.Match(path, "") if err != nil { - log.Error("Invalid PlaylistsPath", "path", path, err) - return err + return fmt.Errorf("invalid PlaylistsPath %q: %w", path, err) } } return nil } -func validatePurgeMissingOption() error { - allowedValues := []string{consts.PurgeMissingNever, consts.PurgeMissingAlways, consts.PurgeMissingFull} - valid := false - for _, v := range allowedValues { - if v == Server.Scanner.PurgeMissing { - valid = true - break +// parseLanguages parses a comma-separated language string into a slice. +// It trims whitespace from each entry and ensures at least [DefaultInfoLanguage] is returned. +func parseLanguages(lang string) []string { + var languages []string + for l := range strings.SplitSeq(lang, ",") { + l = strings.TrimSpace(l) + if l != "" { + languages = append(languages, l) } } + if len(languages) == 0 { + return []string{consts.DefaultInfoLanguage} + } + return languages +} + +func validatePurgeMissingOption() error { + allowedValues := []string{consts.PurgeMissingNever, consts.PurgeMissingAlways, consts.PurgeMissingFull} + valid := slices.Contains(allowedValues, Server.Scanner.PurgeMissing) if !valid { - err := fmt.Errorf("Invalid Scanner.PurgeMissing value: '%s'. Must be one of: %v", Server.Scanner.PurgeMissing, allowedValues) - log.Error(err.Error()) + err := fmt.Errorf("invalid Scanner.PurgeMissing value: '%s'. Must be one of: %v", Server.Scanner.PurgeMissing, allowedValues) Server.Scanner.PurgeMissing = consts.PurgeMissingNever return err } return nil } +func validateMaxImageUploadSize() error { + if _, err := humanize.ParseBytes(Server.MaxImageUploadSize); err != nil { + return fmt.Errorf("invalid MaxImageUploadSize %q: use values like '10MB', '1GB', or raw bytes like '10485760': %w", Server.MaxImageUploadSize, err) + } + return nil +} + +func validateEnforceNonRootUser() error { + if !Server.EnforceNonRootUser || currentGOOS() == "windows" { + return nil + } + + if getEUID() == 0 { + return fmt.Errorf("EnforceNonRootUser is enabled but Navidrome is running as root") + } + + return nil +} + func validateScanSchedule() error { if Server.Scanner.Schedule == "0" || Server.Scanner.Schedule == "" { Server.Scanner.Schedule = "" @@ -413,7 +648,7 @@ func validateScanSchedule() error { } func validateBackupSchedule() error { - if Server.Backup.Path == "" || Server.Backup.Schedule == "" || Server.Backup.Count == 0 { + if Server.Backup.Path.String() == "" || Server.Backup.Schedule == "" || Server.Backup.Count == 0 { Server.Backup.Schedule = "" return nil } @@ -423,17 +658,58 @@ func validateBackupSchedule() error { } func validateSchedule(schedule, field string) (string, error) { - if _, err := time.ParseDuration(schedule); err == nil { - schedule = "@every " + schedule - } - c := cron.New() - id, err := c.AddFunc(schedule, func() {}) + _, err := scheduler.ParseCrontab(schedule) if err != nil { - log.Error(fmt.Sprintf("Invalid %s. Please read format spec at https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format", field), "schedule", schedule, err) - } else { - c.Remove(id) + return schedule, fmt.Errorf("invalid %s %q (see https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format): %w", field, schedule, err) } - return schedule, err + return schedule, nil +} + +// validateURL checks if the provided URL is valid and has either http or https scheme. +// It returns a function that can be used as a hook to validate URLs in the config. +func validateURL(optionName, optionURL string) func() error { + return func() error { + if optionURL == "" { + return nil + } + u, err := url.Parse(optionURL) + if err != nil { + return fmt.Errorf("invalid %s %q: %w", optionName, optionURL, err) + } + if u.Scheme != "http" && u.Scheme != "https" { + return fmt.Errorf("invalid scheme for %s: '%s'. Only 'http' and 'https' are allowed", optionName, u.Scheme) + } + if u.Host == "" || u.Opaque != "" { + return fmt.Errorf("invalid %s: '%s'. A full http(s) URL with a non-empty host is required", optionName, optionURL) + } + return nil + } +} + +func normalizeSearchBackend(value string) string { + v := strings.ToLower(strings.TrimSpace(value)) + switch v { + case "fts", "legacy": + return v + default: + log.Error("Invalid Search.Backend value, falling back to 'fts'", "value", value) + return "fts" + } +} + +// toPascalCase converts a dotted lowercase config key to PascalCase for display. +// Example: "scanner.schedule" → "Scanner.Schedule" +func toPascalCase(key string) string { + if key == "" { + return "" + } + parts := strings.Split(key, ".") + for i, part := range parts { + if len(part) > 0 { + parts[i] = strings.ToUpper(part[:1]) + part[1:] + } + } + return strings.Join(parts, ".") } // AddHook is used to register initialization code that should run as soon as the config is loaded @@ -441,6 +717,16 @@ func AddHook(hook func()) { hooks = append(hooks, hook) } +// hasNDEnvVars checks if any ND_ prefixed environment variables are set (excluding ND_CONFIGFILE) +func hasNDEnvVars() bool { + for _, env := range os.Environ() { + if strings.HasPrefix(env, "ND_") && !strings.HasPrefix(env, "ND_CONFIGFILE=") { + return true + } + } + return false +} + func setViperDefaults() { viper.SetDefault("musicfolder", filepath.Join(".", "music")) viper.SetDefault("cachefolder", "") @@ -450,6 +736,7 @@ func setViperDefaults() { viper.SetDefault("address", "0.0.0.0") viper.SetDefault("port", 4533) viper.SetDefault("unixsocketperm", "0660") + viper.SetDefault("enforcenonrootuser", false) viper.SetDefault("sessiontimeout", consts.DefaultSessionTimeout) viper.SetDefault("baseurl", "") viper.SetDefault("tlscert", "") @@ -468,19 +755,28 @@ func setViperDefaults() { viper.SetDefault("smartPlaylistRefreshDelay", 5*time.Second) viper.SetDefault("enabledownloads", true) viper.SetDefault("enableexternalservices", true) + viper.SetDefault("enablem3uexternalalbumart", false) viper.SetDefault("enablemediafilecoverart", true) viper.SetDefault("autotranscodedownload", false) viper.SetDefault("defaultdownsamplingformat", consts.DefaultDownsamplingFormat) - viper.SetDefault("searchfullstring", false) + viper.SetDefault("search.fullstring", false) + viper.SetDefault("search.backend", "fts") + viper.SetDefault("matcher.preferstarred", true) + viper.SetDefault("matcher.fuzzythreshold", 85) viper.SetDefault("recentlyaddedbymodtime", false) viper.SetDefault("prefersorttags", false) viper.SetDefault("ignoredarticles", "The El La Los Las Le Les Os As O A") viper.SetDefault("indexgroups", "A B C D E F G H I J K L M N O P Q R S T U V W X-Z(XYZ) [Unknown]([)") viper.SetDefault("ffmpegpath", "") - viper.SetDefault("mpvcmdtemplate", "mpv --audio-device=%d --no-audio-display --pause %f --input-ipc-server=%s") + viper.SetDefault("mpvpath", "") + viper.SetDefault("mpvcmdtemplate", "mpv --audio-device=%d --no-audio-display %f --input-ipc-server=%s") viper.SetDefault("coverartpriority", "cover.*, folder.*, front.*, embedded, external") - viper.SetDefault("coverjpegquality", 75) + viper.SetDefault("coverartquality", 75) + viper.SetDefault("enablewebpencoding", false) viper.SetDefault("artistartpriority", "artist.*, album/artist.*, external") + viper.SetDefault("artistimagefolder", "") + viper.SetDefault("discartpriority", "disc*.*, cd*.*, cover.*, folder.*, front.*, discsubtitle, embedded") + viper.SetDefault("lyricspriority", ".lrc,.txt,embedded") viper.SetDefault("enablegravatar", false) viper.SetDefault("enablefavourites", true) viper.SetDefault("enablestarrating", true) @@ -488,8 +784,14 @@ func setViperDefaults() { viper.SetDefault("defaulttheme", "Dark") viper.SetDefault("defaultlanguage", "") viper.SetDefault("defaultuivolume", consts.DefaultUIVolume) + viper.SetDefault("uisearchdebouncems", consts.DefaultUISearchDebounceMs) + viper.SetDefault("uicoverartsize", consts.DefaultUICoverArtSize) viper.SetDefault("enablereplaygain", true) viper.SetDefault("enablecoveranimation", true) + viper.SetDefault("enablenowplaying", true) + viper.SetDefault("uiplaybackreportinterval", consts.DefaultUIPlaybackReportInterval) + viper.SetDefault("enableartworkupload", true) + viper.SetDefault("maximageuploadsize", consts.DefaultMaxImageUploadSize) viper.SetDefault("enablesharing", false) viper.SetDefault("shareurl", "") viper.SetDefault("defaultshareexpiration", 8760*time.Hour) @@ -500,8 +802,9 @@ func setViperDefaults() { viper.SetDefault("authrequestlimit", 5) viper.SetDefault("authwindowlength", 20*time.Second) viper.SetDefault("passwordencryptionkey", "") - viper.SetDefault("reverseproxyuserheader", "Remote-User") - viper.SetDefault("reverseproxywhitelist", "") + viper.SetDefault("extauth.userheader", "Remote-User") + viper.SetDefault("extauth.trustedsources", "") + viper.SetDefault("extauth.logouturl", "") viper.SetDefault("prometheus.enabled", false) viper.SetDefault("prometheus.metricspath", consts.PrometheusDefaultPath) viper.SetDefault("prometheus.password", "") @@ -518,21 +821,31 @@ func setViperDefaults() { viper.SetDefault("scanner.genreseparators", "") viper.SetDefault("scanner.groupalbumreleases", false) viper.SetDefault("scanner.followsymlinks", true) - viper.SetDefault("scanner.purgemissing", "never") + viper.SetDefault("scanner.purgemissing", consts.PurgeMissingNever) viper.SetDefault("subsonic.appendsubtitle", true) + viper.SetDefault("subsonic.appendalbumversion", true) viper.SetDefault("subsonic.artistparticipations", false) viper.SetDefault("subsonic.defaultreportrealpath", false) + viper.SetDefault("subsonic.enableaveragerating", true) viper.SetDefault("subsonic.legacyclients", "DSub") - viper.SetDefault("agents", "lastfm,spotify") + viper.SetDefault("subsonic.minimalclients", "SubMusic") + viper.SetDefault("transcoding.maxconcurrent", 0) + viper.SetDefault("transcoding.maxconcurrentperuser", 0) + viper.SetDefault("transcoding.enablecancellation", false) + viper.SetDefault("agents", "deezer,lastfm,listenbrainz") viper.SetDefault("lastfm.enabled", true) - viper.SetDefault("lastfm.language", "en") + viper.SetDefault("lastfm.language", consts.DefaultInfoLanguage) viper.SetDefault("lastfm.apikey", "") viper.SetDefault("lastfm.secret", "") - viper.SetDefault("spotify.id", "") - viper.SetDefault("spotify.secret", "") + viper.SetDefault("lastfm.scrobblefirstartistonly", false) + viper.SetDefault("deezer.enabled", true) + viper.SetDefault("deezer.language", consts.DefaultInfoLanguage) viper.SetDefault("listenbrainz.enabled", true) - viper.SetDefault("listenbrainz.baseurl", "https://api.listenbrainz.org/1/") - viper.SetDefault("httpsecurityheaders.customframeoptionsvalue", "DENY") + viper.SetDefault("listenbrainz.baseurl", consts.DefaultListenBrainzBaseURL) + viper.SetDefault("listenbrainz.artistalgorithm", consts.DefaultListenBrainzArtistAlgorithm) + viper.SetDefault("listenbrainz.trackalgorithm", consts.DefaultListenBrainzTrackAlgorithm) + viper.SetDefault("enablescrobblehistory", true) + viper.SetDefault("httpheaders.frameoptions", "DENY") viper.SetDefault("backup.path", "") viper.SetDefault("backup.schedule", "") viper.SetDefault("backup.count", 0) @@ -542,7 +855,13 @@ func setViperDefaults() { viper.SetDefault("inspect.maxrequests", 1) viper.SetDefault("inspect.backloglimit", consts.RequestThrottleBacklogLimit) viper.SetDefault("inspect.backlogtimeout", consts.RequestThrottleBacklogTimeout) - viper.SetDefault("lyricspriority", ".lrc,.txt,embedded") + viper.SetDefault("plugins.folder", "") + viper.SetDefault("plugins.enabled", true) + viper.SetDefault("plugins.cachesize", "200MB") + viper.SetDefault("plugins.autoreload", false) + viper.SetDefault("plugins.loglevel", "") + + // DevFlags. These are used to enable/disable debugging and incomplete features viper.SetDefault("devlogsourceline", false) viper.SetDefault("devenableprofiler", false) viper.SetDefault("devautocreateadminpassword", "") @@ -551,25 +870,40 @@ func setViperDefaults() { viper.SetDefault("devactivitypanelupdaterate", 300*time.Millisecond) viper.SetDefault("devsidebarplaylists", true) viper.SetDefault("devshowartistpage", true) + viper.SetDefault("devuishowconfig", true) + viper.SetDefault("devneweventstream", true) viper.SetDefault("devoffsetoptimize", 50000) - viper.SetDefault("devartworkmaxrequests", max(2, runtime.NumCPU()/3)) + viper.SetDefault("devartworkmaxrequests", max(2, runtime.NumCPU()/2)) viper.SetDefault("devartworkthrottlebackloglimit", consts.RequestThrottleBacklogLimit) viper.SetDefault("devartworkthrottlebacklogtimeout", consts.RequestThrottleBacklogTimeout) + viper.SetDefault("devartworkthrottlebuffered", true) viper.SetDefault("devartistinfotimetolive", consts.ArtistInfoTimeToLive) viper.SetDefault("devalbuminfotimetolive", consts.AlbumInfoTimeToLive) viper.SetDefault("devexternalscanner", true) viper.SetDefault("devscannerthreads", 5) + viper.SetDefault("devselectivewatcher", true) viper.SetDefault("devinsightsinitialdelay", consts.InsightsInitialDelay) viper.SetDefault("devenableplayerinsights", true) + viper.SetDefault("devenablepluginsinsights", true) + viper.SetDefault("devplugincompilationtimeout", time.Minute) + viper.SetDefault("devexternalartistfetchmultiplier", 1.5) + viper.SetDefault("devoptimizedb", true) + viper.SetDefault("devpreserveunicodeinexternalcalls", false) + viper.SetDefault("devenablemediafileprobe", true) } func init() { setViperDefaults() } -func InitConfig(cfgFile string) { +func InitConfig(cfgFile string, loadEnvVars bool) { codecRegistry := viper.NewCodecRegistry() - _ = codecRegistry.RegisterCodec("ini", ini.Codec{}) + _ = codecRegistry.RegisterCodec("ini", ini.Codec{ + LoadOptions: ini.LoadOptions{ + UnescapeValueDoubleQuotes: true, + UnescapeValueCommentSymbols: true, + }, + }) viper.SetOptions(viper.WithCodecRegistry(codecRegistry)) cfgFile = getConfigFile(cfgFile) @@ -583,15 +917,16 @@ func InitConfig(cfgFile string) { } _ = viper.BindEnv("port") - viper.SetEnvPrefix("ND") - replacer := strings.NewReplacer(".", "_") - viper.SetEnvKeyReplacer(replacer) - viper.AutomaticEnv() + if loadEnvVars { + viper.SetEnvPrefix("ND") + replacer := strings.NewReplacer(".", "_") + viper.SetEnvKeyReplacer(replacer) + viper.AutomaticEnv() + } err := viper.ReadInConfig() if viper.ConfigFileUsed() != "" && err != nil { - _, _ = fmt.Fprintln(os.Stderr, "FATAL: Navidrome could not open config file: ", err) - os.Exit(1) + logFatal("Navidrome could not open config file:", err) } } @@ -603,7 +938,7 @@ func getConfigFile(cfgFile string) string { } cfgFile = os.Getenv("ND_CONFIGFILE") if cfgFile != "" { - if _, err := os.Stat(cfgFile); err == nil { + if _, err := os.Stat(cfgFile); err == nil { //nolint:gosec return cfgFile } } diff --git a/conf/configuration_test.go b/conf/configuration_test.go index 5b54e4975..9c25a0d19 100644 --- a/conf/configuration_test.go +++ b/conf/configuration_test.go @@ -2,6 +2,7 @@ package conf_test import ( "fmt" + "os" "path/filepath" "testing" @@ -24,6 +25,257 @@ var _ = Describe("Configuration", func() { viper.SetDefault("datafolder", GinkgoT().TempDir()) viper.SetDefault("loglevel", "error") conf.ResetConf() + + // Panic instead of exiting on fatal errors to allow testing error conditions + DeferCleanup(conf.SetLogFatal(func(args ...any) { + panic(fmt.Sprint(args...)) + })) + }) + + Describe("ParseLanguages", func() { + It("parses single language", func() { + Expect(conf.ParseLanguages("en")).To(Equal([]string{"en"})) + }) + + It("parses multiple comma-separated languages", func() { + Expect(conf.ParseLanguages("pt,en")).To(Equal([]string{"pt", "en"})) + }) + + It("trims whitespace from languages", func() { + Expect(conf.ParseLanguages(" pt , en ")).To(Equal([]string{"pt", "en"})) + }) + + It("returns default 'en' when empty", func() { + Expect(conf.ParseLanguages("")).To(Equal([]string{"en"})) + }) + + It("returns default 'en' when only whitespace", func() { + Expect(conf.ParseLanguages(" ")).To(Equal([]string{"en"})) + }) + + It("handles multiple languages with various spacing", func() { + Expect(conf.ParseLanguages("ja, pt, en")).To(Equal([]string{"ja", "pt", "en"})) + }) + }) + + Describe("ValidateURL", func() { + It("accepts a valid http URL", func() { + fn := conf.ValidateURL("TestOption", "http://example.com/path") + Expect(fn()).To(Succeed()) + }) + + It("accepts a valid https URL", func() { + fn := conf.ValidateURL("TestOption", "https://example.com/path") + Expect(fn()).To(Succeed()) + }) + + It("rejects a URL with no scheme", func() { + fn := conf.ValidateURL("TestOption", "example.com/path") + Expect(fn()).To(MatchError(ContainSubstring("invalid scheme"))) + }) + + It("rejects a URL with an unsupported scheme", func() { + fn := conf.ValidateURL("TestOption", "javascript://example.com/path") + Expect(fn()).To(MatchError(ContainSubstring("invalid scheme"))) + }) + + It("accepts an empty URL (optional config)", func() { + fn := conf.ValidateURL("TestOption", "") + Expect(fn()).To(Succeed()) + }) + + It("includes the option name in the error message", func() { + fn := conf.ValidateURL("MyOption", "ftp://example.com") + Expect(fn()).To(MatchError(ContainSubstring("MyOption"))) + }) + + It("rejects a URL that cannot be parsed", func() { + fn := conf.ValidateURL("TestOption", "://invalid") + Expect(fn()).To(HaveOccurred()) + }) + + It("rejects a URL without a host", func() { + fn := conf.ValidateURL("TestOption", "http:///path") + Expect(fn()).To(MatchError(ContainSubstring("non-empty host is required"))) + }) + }) + + DescribeTable("NormalizeSearchBackend", + func(input, expected string) { + Expect(conf.NormalizeSearchBackend(input)).To(Equal(expected)) + }, + Entry("accepts 'fts'", "fts", "fts"), + Entry("accepts 'legacy'", "legacy", "legacy"), + Entry("normalizes 'FTS' to lowercase", "FTS", "fts"), + Entry("normalizes 'Legacy' to lowercase", "Legacy", "legacy"), + Entry("trims whitespace", " fts ", "fts"), + Entry("falls back to 'fts' for 'fts5'", "fts5", "fts"), + Entry("falls back to 'fts' for unrecognized values", "invalid", "fts"), + Entry("falls back to 'fts' for empty string", "", "fts"), + ) + + DescribeTable("ToPascalCase", + func(input, expected string) { + Expect(conf.ToPascalCase(input)).To(Equal(expected)) + }, + Entry("simple key", "address", "Address"), + Entry("dotted key", "scanner.schedule", "Scanner.Schedule"), + Entry("already capitalized", "Address", "Address"), + Entry("multi-segment", "lastfm.enabled", "Lastfm.Enabled"), + Entry("empty string", "", ""), + ) + + Describe("remapEnvVarKeysFromConfig", func() { + BeforeEach(func() { + viper.Reset() + conf.SetViperDefaults() + viper.SetDefault("datafolder", GinkgoT().TempDir()) + viper.SetDefault("loglevel", "error") + conf.ResetConf() + }) + + It("remaps ND_-prefixed keys to canonical keys", func() { + filename := filepath.Join("testdata", "cfg_nd_keys.toml") + conf.InitConfig(filename, false) + conf.Load(true) + + Expect(conf.Server.Address).To(Equal("127.0.0.1")) + Expect(conf.Server.Port).To(Equal(4531)) + Expect(conf.Server.Scanner.Schedule).To(Equal("@every 1h")) + }) + + It("exits with fatal error when both ND_ and canonical key exist", func() { + filename := filepath.Join("testdata", "cfg_nd_conflict.toml") + conf.InitConfig(filename, false) + + Expect(func() { conf.Load(true) }).To(PanicWith(And( + ContainSubstring("ND_ADDRESS"), + ContainSubstring("Address"), + ContainSubstring("only needed for environment variables"), + ))) + }) + + It("does nothing when no ND_ keys are present", func() { + filename := filepath.Join("testdata", "cfg.toml") + conf.InitConfig(filename, false) + conf.Load(true) + + // Verify normal config loading still works + Expect(conf.Server.MusicFolder).To(Equal("/toml/music")) + }) + }) + + Describe("logFatal", func() { + var invalidPath string + BeforeEach(func() { + viper.Reset() + conf.SetViperDefaults() + viper.SetDefault("loglevel", "error") + conf.ResetConf() + + // Create a file so that any path under it is invalid on all OSes + f, err := os.CreateTemp(GinkgoT().TempDir(), "blocker") + Expect(err).ToNot(HaveOccurred()) + f.Close() + invalidPath = filepath.Join(f.Name(), "subdir") + }) + + It("is called when LoadFromFile gets an invalid config file", func() { + Expect(func() { + conf.LoadFromFile(filepath.Join(invalidPath, "file.toml")) + }).To(PanicWith(ContainSubstring("Error reading config file"))) + }) + + It("is called when LogFile path is not writable", func() { + viper.SetDefault("datafolder", GinkgoT().TempDir()) + viper.SetDefault("logfile", filepath.Join(invalidPath, "log.txt")) + Expect(func() { + conf.Load(true) + }).To(PanicWith(ContainSubstring("Error creating log file directory"))) + }) + + It("is called when BaseURL is invalid", func() { + viper.SetDefault("datafolder", GinkgoT().TempDir()) + viper.SetDefault("baseurl", "://invalid") + Expect(func() { + conf.Load(true) + }).To(PanicWith(ContainSubstring("Invalid BaseURL"))) + }) + + }) + + Describe("ValidateMaxImageUploadSize", func() { + BeforeEach(func() { + viper.Reset() + conf.SetViperDefaults() + viper.SetDefault("datafolder", GinkgoT().TempDir()) + viper.SetDefault("loglevel", "error") + conf.ResetConf() + }) + + DescribeTable("accepts valid size values", + func(input string) { + conf.Server.MaxImageUploadSize = input + Expect(conf.ValidateMaxImageUploadSize()).To(Succeed()) + }, + Entry("megabytes", "10MB"), + Entry("gigabytes", "1GB"), + Entry("raw bytes", "10485760"), + Entry("mebibytes", "10MiB"), + Entry("lower case", "50mb"), + ) + + DescribeTable("rejects invalid size values", + func(input string) { + conf.Server.MaxImageUploadSize = input + Expect(conf.ValidateMaxImageUploadSize()).To(MatchError(ContainSubstring("invalid MaxImageUploadSize"))) + }, + Entry("garbage string", "not-a-size"), + Entry("negative-looking", "-10MB"), + ) + }) + + Describe("EnforceNonRootUser", func() { + It("defaults to false", func() { + conf.Load(true) + + Expect(conf.Server.EnforceNonRootUser).To(BeFalse()) + }) + + It("allows startup for non-root users when enabled", func() { + DeferCleanup(conf.SetRuntimeInfoForTest("linux", 1000)) + viper.Set("enforcenonrootuser", true) + + conf.Load(true) + + Expect(conf.Server.EnforceNonRootUser).To(BeTrue()) + }) + + It("exits when enabled and running as root without having created a data folder", func() { + // Create a path that doesn't exist yet + tempBase := GinkgoT().TempDir() + nonExistentDataFolder := filepath.Join(tempBase, "nonexistent", "data") + DeferCleanup(conf.SetRuntimeInfoForTest("linux", 0)) + viper.Set("enforcenonrootuser", true) + viper.Set("datafolder", nonExistentDataFolder) + + // Attempt to load config as root user - should fail before creating directories + Expect(func() { + conf.Load(true) + }).To(PanicWith(ContainSubstring("EnforceNonRootUser is enabled but Navidrome is running as root"))) + + // Verify that the data folder was NOT created + Expect(nonExistentDataFolder).ToNot(BeAnExistingFile()) + }) + + It("is a no-op on non-unix platforms", func() { + DeferCleanup(conf.SetRuntimeInfoForTest("windows", 0)) + viper.Set("enforcenonrootuser", true) + + conf.Load(true) + + Expect(conf.Server.EnforceNonRootUser).To(BeTrue()) + }) }) DescribeTable("should load configuration from", @@ -31,7 +283,7 @@ var _ = Describe("Configuration", func() { filename := filepath.Join("testdata", "cfg."+format) // Initialize config with the test file - conf.InitConfig(filename) + conf.InitConfig(filename, false) // Load the configuration (with noConfigDump=true) conf.Load(true) @@ -39,6 +291,10 @@ var _ = Describe("Configuration", func() { Expect(conf.Server.MusicFolder).To(Equal(fmt.Sprintf("/%s/music", format))) Expect(conf.Server.UIWelcomeMessage).To(Equal("Welcome " + format)) Expect(conf.Server.Tags["custom"].Aliases).To(Equal([]string{format, "test"})) + Expect(conf.Server.Tags["artist"].Split).To(Equal([]string{";"})) + + // Check deprecated option mapping + Expect(conf.Server.ExtAuth.UserHeader).To(Equal("X-Auth-User")) // The config file used should be the one we created Expect(conf.Server.ConfigFile).To(Equal(filename)) diff --git a/conf/dir.go b/conf/dir.go new file mode 100644 index 000000000..f7a14b933 --- /dev/null +++ b/conf/dir.go @@ -0,0 +1,77 @@ +package conf + +import ( + "cmp" + "fmt" + "os" +) + +// Dir wraps a directory path and creates the directory on demand. Dir is a +// plain value type — safe to copy, compare, and print via reflection-based +// formatters (pretty.Sprintf("%# v", ...)) without any concurrency hazards. +// Directory creation is delegated to os.MkdirAll on every Path() call; +// MkdirAll is idempotent, so repeated calls cost one stat syscall when the +// directory already exists. +type Dir struct { + path string + perm os.FileMode +} + +// NewDir creates a new Dir with the given path and default permissions (os.ModePerm). +func NewDir(path string) Dir { + return Dir{path: path, perm: os.ModePerm} +} + +// NewDirWithPerm creates a new Dir with the given path and permissions. +// A perm of 0 is treated as "default" and resolves to os.ModePerm at +// directory-creation time; pass an explicit non-zero mode to constrain the +// permissions. +func NewDirWithPerm(path string, perm os.FileMode) Dir { + return Dir{path: path, perm: perm} +} + +// String returns the raw path without creating the directory. Satisfies fmt.Stringer. +func (d Dir) String() string { + return d.path +} + +// Path ensures the directory exists and returns its path. Safe to call +// repeatedly; an empty path is returned as-is with no error. +func (d Dir) Path() (string, error) { + if d.path == "" { + return "", nil + } + if err := os.MkdirAll(d.path, cmp.Or(d.perm, os.ModePerm)); err != nil { + return d.path, fmt.Errorf("creating directory %q: %w", d.path, err) + } + return d.path, nil +} + +// MustPath calls Path() and calls logFatal on error. +func (d Dir) MustPath() string { + path, err := d.Path() + if err != nil { + logFatal("creating directory:", err) + } + return path +} + +// GoString implements fmt.GoStringer so that %#v (used by pretty.Sprintf) +// prints the path string instead of the internal struct fields. +func (d Dir) GoString() string { + return fmt.Sprintf("%q", d.path) +} + +// MarshalText returns the raw path bytes. No side effects. +func (d Dir) MarshalText() ([]byte, error) { + return []byte(d.path), nil +} + +// UnmarshalText sets the path from bytes. No side effects. +func (d *Dir) UnmarshalText(text []byte) error { + d.path = string(text) + if d.perm == 0 { + d.perm = os.ModePerm + } + return nil +} diff --git a/conf/dir_test.go b/conf/dir_test.go new file mode 100644 index 000000000..79db379d2 --- /dev/null +++ b/conf/dir_test.go @@ -0,0 +1,164 @@ +package conf_test + +import ( + "os" + "sync" + + "github.com/kr/pretty" + "github.com/navidrome/navidrome/conf" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Dir", func() { + Describe("NewDir", func() { + It("creates a Dir with the given path without side effects", func() { + d := conf.NewDir("/some/path") + Expect(d.String()).To(Equal("/some/path")) + }) + }) + + Describe("String", func() { + It("returns the raw path without creating the directory", func() { + d := conf.NewDir("/nonexistent/path/that/should/not/be/created") + Expect(d.String()).To(Equal("/nonexistent/path/that/should/not/be/created")) + }) + }) + + Describe("Path", func() { + It("creates the directory and returns the path on first call", func() { + dir := GinkgoT().TempDir() + target := dir + "/subdir/nested" + d := conf.NewDir(target) + + path, err := d.Path() + Expect(err).ToNot(HaveOccurred()) + Expect(path).To(Equal(target)) + Expect(target).To(BeADirectory()) + }) + + It("is idempotent on subsequent calls", func() { + dir := GinkgoT().TempDir() + target := dir + "/idempotent" + d := conf.NewDir(target) + + path1, err1 := d.Path() + path2, err2 := d.Path() + Expect(err1).ToNot(HaveOccurred()) + Expect(err2).ToNot(HaveOccurred()) + Expect(path1).To(Equal(path2)) + Expect(target).To(BeADirectory()) + }) + + It("returns an error when directory cannot be created", func() { + f := GinkgoT().TempDir() + blocker := f + "/blocker" + By("creating a file that blocks directory creation") + Expect(os.WriteFile(blocker, []byte("x"), 0600)).To(Succeed()) + invalid := blocker + "/subdir" + + d := conf.NewDir(invalid) + _, pathErr := d.Path() + Expect(pathErr).To(HaveOccurred()) + }) + + It("returns empty path and no error for empty path", func() { + d := conf.NewDir("") + path, err := d.Path() + Expect(err).ToNot(HaveOccurred()) + Expect(path).To(BeEmpty()) + }) + }) + + Describe("MustPath", func() { + It("returns the path when directory is created successfully", func() { + dir := GinkgoT().TempDir() + target := dir + "/mustpath" + d := conf.NewDir(target) + + path := d.MustPath() + Expect(path).To(Equal(target)) + Expect(target).To(BeADirectory()) + }) + + It("calls logFatal on error", func() { + var fatalMsg []any + restore := conf.SetLogFatal(func(args ...any) { + fatalMsg = args + panic("logFatal called") + }) + DeferCleanup(restore) + + f := GinkgoT().TempDir() + "/blocker" + Expect(os.WriteFile(f, []byte("x"), 0600)).To(Succeed()) + invalid := f + "/subdir" + + d := conf.NewDir(invalid) + Expect(func() { d.MustPath() }).To(Panic()) + Expect(fatalMsg).ToNot(BeEmpty()) + }) + }) + + Describe("MarshalText", func() { + It("returns the raw path bytes without side effects", func() { + d := conf.NewDir("/marshal/path") + b, err := d.MarshalText() + Expect(err).ToNot(HaveOccurred()) + Expect(string(b)).To(Equal("/marshal/path")) + }) + }) + + Describe("UnmarshalText", func() { + It("sets the path from bytes without side effects", func() { + d := conf.NewDir("") + err := d.UnmarshalText([]byte("/unmarshal/path")) + Expect(err).ToNot(HaveOccurred()) + Expect(d.String()).To(Equal("/unmarshal/path")) + }) + + It("allows round-trip marshal/unmarshal", func() { + d1 := conf.NewDir("/round/trip") + b, err := d1.MarshalText() + Expect(err).ToNot(HaveOccurred()) + + var d2 conf.Dir + err = d2.UnmarshalText(b) + Expect(err).ToNot(HaveOccurred()) + Expect(d2.String()).To(Equal(d1.String())) + }) + }) + + Describe("GoString", func() { + // Regression: pretty.Sprintf("%# v", ...) is used by the + // configuration dump. It must render Dir as a quoted path via + // GoString, not dump the internal struct fields. + It("renders Dir as a quoted path under pretty.Sprintf", func() { + type host struct { + DataFolder conf.Dir + } + h := host{DataFolder: conf.NewDir("./data")} + out := pretty.Sprintf("%# v", h) + Expect(out).To(ContainSubstring(`DataFolder: "./data"`)) + Expect(out).ToNot(ContainSubstring("perm:")) + Expect(out).ToNot(ContainSubstring("path:")) + }) + + It("is safe to copy and use concurrently", func() { + // Regression for the Windows "sync: unlock of unlocked mutex" + // crash that was caused by copying a Dir embedding sync.Once. + // Dir is a plain value type now, but keep the concurrent stress + // test to lock in the property. + dir := GinkgoT().TempDir() + d := conf.NewDir(dir + "/race") + var wg sync.WaitGroup + for range 10 { + wg.Go(func() { + copy1 := d + _ = pretty.Sprintf("%# v", copy1) + _, _ = copy1.Path() + }) + } + wg.Wait() + }) + }) +}) diff --git a/conf/export_test.go b/conf/export_test.go index 1b6daf036..acebca551 100644 --- a/conf/export_test.go +++ b/conf/export_test.go @@ -5,3 +5,30 @@ func ResetConf() { } var SetViperDefaults = setViperDefaults + +var ParseLanguages = parseLanguages + +var ValidateURL = validateURL + +var NormalizeSearchBackend = normalizeSearchBackend + +var ToPascalCase = toPascalCase + +var ValidateMaxImageUploadSize = validateMaxImageUploadSize + +func SetRuntimeInfoForTest(goos string, euid int) func() { + oldGOOS := currentGOOS + oldEUID := getEUID + currentGOOS = func() string { return goos } + getEUID = func() int { return euid } + return func() { + currentGOOS = oldGOOS + getEUID = oldEUID + } +} + +func SetLogFatal(f func(...any)) func() { + old := logFatal + logFatal = f + return func() { logFatal = old } +} diff --git a/conf/testdata/cfg.ini b/conf/testdata/cfg.ini index cec7d3c70..cc8b2a4a5 100644 --- a/conf/testdata/cfg.ini +++ b/conf/testdata/cfg.ini @@ -1,6 +1,8 @@ [default] MusicFolder = /ini/music -UIWelcomeMessage = Welcome ini +UIWelcomeMessage = 'Welcome ini' ; Just a comment to test the LoadOptions +ReverseProxyUserHeader = 'X-Auth-User' [Tags] -Custom.Aliases = ini,test \ No newline at end of file +Custom.Aliases = ini,test +artist.Split = ";" # Should be able to read ; as a separator \ No newline at end of file diff --git a/conf/testdata/cfg.json b/conf/testdata/cfg.json index 37cf74f08..28fb039d2 100644 --- a/conf/testdata/cfg.json +++ b/conf/testdata/cfg.json @@ -1,7 +1,11 @@ { "musicFolder": "/json/music", "uiWelcomeMessage": "Welcome json", + "reverseProxyUserHeader": "X-Auth-User", "Tags": { + "artist": { + "split": ";" + }, "custom": { "aliases": [ "json", diff --git a/conf/testdata/cfg.toml b/conf/testdata/cfg.toml index 1dc852b18..589e2a100 100644 --- a/conf/testdata/cfg.toml +++ b/conf/testdata/cfg.toml @@ -1,5 +1,8 @@ musicFolder = "/toml/music" uiWelcomeMessage = "Welcome toml" +ReverseProxyUserHeader = "X-Auth-User" + +Tags.artist.Split = ';' [Tags.custom] aliases = ["toml", "test"] diff --git a/conf/testdata/cfg.yaml b/conf/testdata/cfg.yaml index 38b98d4aa..e44d2ebbb 100644 --- a/conf/testdata/cfg.yaml +++ b/conf/testdata/cfg.yaml @@ -1,6 +1,9 @@ musicFolder: "/yaml/music" uiWelcomeMessage: "Welcome yaml" +reverseProxyUserHeader: "X-Auth-User" Tags: + artist: + split: [";"] custom: aliases: - yaml diff --git a/conf/testdata/cfg_nd_conflict.toml b/conf/testdata/cfg_nd_conflict.toml new file mode 100644 index 000000000..2e8b94bc3 --- /dev/null +++ b/conf/testdata/cfg_nd_conflict.toml @@ -0,0 +1,2 @@ +ND_ADDRESS = "127.0.0.1" +Address = "0.0.0.0" diff --git a/conf/testdata/cfg_nd_keys.toml b/conf/testdata/cfg_nd_keys.toml new file mode 100644 index 000000000..de441ce66 --- /dev/null +++ b/conf/testdata/cfg_nd_keys.toml @@ -0,0 +1,3 @@ +ND_ADDRESS = "127.0.0.1" +ND_PORT = 4531 +ND_SCANNER_SCHEDULE = "@every 1h" diff --git a/consts/consts.go b/consts/consts.go index fbb2c9429..edd8f2b54 100644 --- a/consts/consts.go +++ b/consts/consts.go @@ -56,6 +56,8 @@ const ( ServerReadHeaderTimeout = 3 * time.Second + DefaultInfoLanguage = "en" + ArtistInfoTimeToLive = 24 * time.Hour AlbumInfoTimeToLive = 7 * 24 * time.Hour UpdateLastAccessFrequency = time.Minute @@ -63,20 +65,31 @@ const ( I18nFolder = "i18n" ScanIgnoreFile = ".ndignore" + ArtworkFolder = "artwork" - PlaceholderArtistArt = "artist-placeholder.webp" - PlaceholderAlbumArt = "album-placeholder.webp" - PlaceholderAvatar = "logo-192x192.png" - UICoverArtSize = 300 - DefaultUIVolume = 100 + PlaceholderArtistArt = "artist-placeholder.webp" + PlaceholderAlbumArt = "album-placeholder.webp" + PlaceholderAvatar = "logo-192x192.png" + DefaultUIVolume = 100 + DefaultUISearchDebounceMs = 200 + DefaultUIPlaybackReportInterval = time.Minute DefaultHttpClientTimeOut = 10 * time.Second + DefaultListenBrainzBaseURL = "https://api.listenbrainz.org/1/" + DefaultListenBrainzArtistAlgorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DefaultListenBrainzTrackAlgorithm = "session_based_days_9000_session_300_contribution_5_threshold_15_limit_50_skip_30" + DefaultScannerExtractor = "taglib" DefaultWatcherWait = 5 * time.Second Zwsp = string('\u200b') ) +const ( + DefaultUICoverArtSize = 300 + DefaultMaxImageUploadSize = "10MB" +) + // Prometheus options const ( PrometheusDefaultPath = "/metrics" @@ -95,6 +108,13 @@ const ( DefaultCacheCleanUpInterval = 10 * time.Minute ) +// Entity types +const ( + EntityArtist = "artist" + EntityPlaylist = "playlist" + EntityRadio = "radio" +) + const ( AlbumPlayCountModeAbsolute = "absolute" AlbumPlayCountModeNormalized = "normalized" @@ -133,23 +153,31 @@ var ( Name: "mp3 audio", TargetFormat: "mp3", DefaultBitRate: 192, - Command: "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -f mp3 -", + Command: "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -f mp3 -", }, { Name: "opus audio", TargetFormat: "opus", DefaultBitRate: 128, - Command: "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a libopus -f opus -", + Command: "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a libopus -f opus -", }, { Name: "aac audio", TargetFormat: "aac", DefaultBitRate: 256, - Command: "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -", + Command: "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -", + }, + { + Name: "flac audio", + TargetFormat: "flac", + DefaultBitRate: 0, + Command: "ffmpeg -ss %t -i %s -map 0:a:0 -v 0 -c:a flac -f flac -", }, } ) +var HTTPUserAgent = "Navidrome" + "/" + Version + var ( VariousArtists = "Various Artists" // TODO This will be dynamic when using disambiguation diff --git a/context7.json b/context7.json new file mode 100644 index 000000000..343873063 --- /dev/null +++ b/context7.json @@ -0,0 +1,4 @@ +{ + "url": "https://context7.com/navidrome/navidrome", + "public_key": "pk_WqzhKScNKWQ84J4n0oG0J" +} diff --git a/core/agents/README.md b/core/agents/README.md index 1a3a8e96e..cce62889c 100644 --- a/core/agents/README.md +++ b/core/agents/README.md @@ -7,6 +7,6 @@ A new agent must comply with these simple implementation rules: 2) Implement one or more of the `*Retriever()` interfaces. That's where the agent's logic resides. 3) Register itself (in its `init()` function). -For an agent to be used it needs to be listed in the `Agents` config option (default is `"lastfm,spotify"`). The order dictates the priority of the agents +For an agent to be used it needs to be listed in the `Agents` config option (default is `"deezer,lastfm"`). The order dictates the priority of the agents For a simple Agent example, look at the [local_agent](local_agent.go) agent source code. diff --git a/core/agents/agents.go b/core/agents/agents.go index 50a1e04ad..ead6dacd0 100644 --- a/core/agents/agents.go +++ b/core/agents/agents.go @@ -2,6 +2,7 @@ package agents import ( "context" + "slices" "strings" "time" @@ -13,43 +14,110 @@ import ( "github.com/navidrome/navidrome/utils/singleton" ) -type Agents struct { - ds model.DataStore - agents []Interface +// PluginLoader defines an interface for loading plugins +type PluginLoader interface { + // PluginNames returns the names of all plugins that implement a particular service + PluginNames(capability string) []string + // LoadMediaAgent loads and returns a media agent plugin + LoadMediaAgent(name string) (Interface, bool) } -func GetAgents(ds model.DataStore) *Agents { +// Agents is a meta-agent that aggregates multiple built-in and plugin agents. It tries each enabled agent in order +// until one returns valid data. +type Agents struct { + ds model.DataStore + pluginLoader PluginLoader +} + +// GetAgents returns the singleton instance of Agents +func GetAgents(ds model.DataStore, pluginLoader PluginLoader) *Agents { return singleton.GetInstance(func() *Agents { - return createAgents(ds) + return createAgents(ds, pluginLoader) }) } -func createAgents(ds model.DataStore) *Agents { - var order []string - if conf.Server.Agents != "" { - order = strings.Split(conf.Server.Agents, ",") +// createAgents creates a new Agents instance. Used in tests +func createAgents(ds model.DataStore, pluginLoader PluginLoader) *Agents { + return &Agents{ + ds: ds, + pluginLoader: pluginLoader, } - order = append(order, LocalAgentName) - var res []Interface - var enabled []string - for _, name := range order { - init, ok := Map[name] - if !ok { - log.Error("Invalid agent. Check `Agents` configuration", "name", name, "conf", conf.Server.Agents) - continue - } +} - agent := init(ds) - if agent == nil { - log.Debug("Agent not available. Missing configuration?", "name", name) - continue - } - enabled = append(enabled, name) - res = append(res, init(ds)) +// enabledAgent represents an enabled agent with its type information +type enabledAgent struct { + name string + isPlugin bool +} + +// getEnabledAgentNames returns the current list of enabled agents, including: +// 1. Built-in agents and plugins from config (in the specified order) +// 2. Always include LocalAgentName +// 3. If config is empty, include ONLY LocalAgentName +// Each enabledAgent contains the name and whether it's a plugin (true) or built-in (false) +func (a *Agents) getEnabledAgentNames() []enabledAgent { + // If no agents configured, ONLY use the local agent + if conf.Server.Agents == "" { + return []enabledAgent{{name: LocalAgentName, isPlugin: false}} } - log.Debug("List of agents enabled", "names", enabled) - return &Agents{ds: ds, agents: res} + // Get all available plugin names + var availablePlugins []string + if a.pluginLoader != nil { + availablePlugins = a.pluginLoader.PluginNames("MetadataAgent") + } + log.Trace("Available MetadataAgent plugins", "plugins", availablePlugins) + + configuredAgents := strings.Split(conf.Server.Agents, ",") + + // Always add LocalAgentName if not already included + hasLocalAgent := slices.Contains(configuredAgents, LocalAgentName) + if !hasLocalAgent { + configuredAgents = append(configuredAgents, LocalAgentName) + } + + // Filter to only include valid agents (built-in or plugins) + var validAgents []enabledAgent + for _, name := range configuredAgents { + // Check if it's a built-in agent + isBuiltIn := Map[name] != nil + + // Check if it's a plugin + isPlugin := slices.Contains(availablePlugins, name) + + if isBuiltIn { + validAgents = append(validAgents, enabledAgent{name: name, isPlugin: false}) + } else if isPlugin { + validAgents = append(validAgents, enabledAgent{name: name, isPlugin: true}) + } else { + log.Debug("Unknown agent ignored", "name", name) + } + } + return validAgents +} + +func (a *Agents) getAgent(ea enabledAgent) Interface { + if ea.isPlugin { + // Try to load WASM plugin agent (if plugin loader is available) + if a.pluginLoader != nil { + agent, ok := a.pluginLoader.LoadMediaAgent(ea.name) + if ok && agent != nil { + return agent + } + } + } else { + // Try to get built-in agent + constructor, ok := Map[ea.name] + if ok { + agent := constructor(a.ds) + if agent != nil { + return agent + } + log.Debug("Built-in agent not available. Missing configuration?", "name", ea.name) + } + } + + return nil } func (a *Agents) AgentName() string { @@ -63,22 +131,14 @@ func (a *Agents) GetArtistMBID(ctx context.Context, id string, name string) (str case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, ag := range a.agents { - if utils.IsCtxDone(ctx) { - break - } - agent, ok := ag.(ArtistMBIDRetriever) + + return callAgentMethod(ctx, a, "GetArtistMBID", func(ag Interface) (string, error) { + retriever, ok := ag.(ArtistMBIDRetriever) if !ok { - continue + return "", ErrNotFound } - mbid, err := agent.GetArtistMBID(ctx, id, name) - if mbid != "" && err == nil { - log.Debug(ctx, "Got MBID", "agent", ag.AgentName(), "artist", name, "mbid", mbid, "elapsed", time.Since(start)) - return mbid, nil - } - } - return "", ErrNotFound + return retriever.GetArtistMBID(ctx, id, name) + }) } func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { @@ -88,22 +148,14 @@ func (a *Agents) GetArtistURL(ctx context.Context, id, name, mbid string) (strin case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, ag := range a.agents { - if utils.IsCtxDone(ctx) { - break - } - agent, ok := ag.(ArtistURLRetriever) + + return callAgentMethod(ctx, a, "GetArtistURL", func(ag Interface) (string, error) { + retriever, ok := ag.(ArtistURLRetriever) if !ok { - continue + return "", ErrNotFound } - url, err := agent.GetArtistURL(ctx, id, name, mbid) - if url != "" && err == nil { - log.Debug(ctx, "Got External Url", "agent", ag.AgentName(), "artist", name, "url", url, "elapsed", time.Since(start)) - return url, nil - } - } - return "", ErrNotFound + return retriever.GetArtistURL(ctx, id, name, mbid) + }) } func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { @@ -113,24 +165,18 @@ func (a *Agents) GetArtistBiography(ctx context.Context, id, name, mbid string) case consts.VariousArtistsID: return "", nil } - start := time.Now() - for _, ag := range a.agents { - if utils.IsCtxDone(ctx) { - break - } - agent, ok := ag.(ArtistBiographyRetriever) + + return callAgentMethod(ctx, a, "GetArtistBiography", func(ag Interface) (string, error) { + retriever, ok := ag.(ArtistBiographyRetriever) if !ok { - continue + return "", ErrNotFound } - bio, err := agent.GetArtistBiography(ctx, id, name, mbid) - if err == nil { - log.Debug(ctx, "Got Biography", "agent", ag.AgentName(), "artist", name, "len", len(bio), "elapsed", time.Since(start)) - return bio, nil - } - } - return "", ErrNotFound + return retriever.GetArtistBiography(ctx, id, name, mbid) + }) } +// GetSimilarArtists returns similar artists by id, name, and/or mbid. Because some artists returned from an enabled +// agent may not exist in the database, return at most limit * conf.Server.DevExternalArtistFetchMultiplier items. func (a *Agents) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]Artist, error) { switch id { case consts.UnknownArtistID: @@ -138,16 +184,23 @@ func (a *Agents) GetSimilarArtists(ctx context.Context, id, name, mbid string, l case consts.VariousArtistsID: return nil, nil } + + overLimit := int(float64(limit) * conf.Server.DevExternalArtistFetchMultiplier) + start := time.Now() - for _, ag := range a.agents { + for _, enabledAgent := range a.getEnabledAgentNames() { + ag := a.getAgent(enabledAgent) + if ag == nil { + continue + } if utils.IsCtxDone(ctx) { break } - agent, ok := ag.(ArtistSimilarRetriever) + retriever, ok := ag.(ArtistSimilarRetriever) if !ok { continue } - similar, err := agent.GetSimilarArtists(ctx, id, name, mbid, limit) + similar, err := retriever.GetSimilarArtists(ctx, id, name, mbid, overLimit) if len(similar) > 0 && err == nil { if log.IsGreaterOrEqualTo(log.LevelTrace) { log.Debug(ctx, "Got Similar Artists", "agent", ag.AgentName(), "artist", name, "similar", similar, "elapsed", time.Since(start)) @@ -167,24 +220,18 @@ func (a *Agents) GetArtistImages(ctx context.Context, id, name, mbid string) ([] case consts.VariousArtistsID: return nil, nil } - start := time.Now() - for _, ag := range a.agents { - if utils.IsCtxDone(ctx) { - break - } - agent, ok := ag.(ArtistImageRetriever) + + return callAgentSliceMethod(ctx, a, "GetArtistImages", func(ag Interface) ([]ExternalImage, error) { + retriever, ok := ag.(ArtistImageRetriever) if !ok { - continue + return nil, ErrNotFound } - images, err := agent.GetArtistImages(ctx, id, name, mbid) - if len(images) > 0 && err == nil { - log.Debug(ctx, "Got Images", "agent", ag.AgentName(), "artist", name, "images", images, "elapsed", time.Since(start)) - return images, nil - } - } - return nil, ErrNotFound + return retriever.GetArtistImages(ctx, id, name, mbid) + }) } +// GetArtistTopSongs returns top songs by id, name, and/or mbid. Because some songs returned from an enabled +// agent may not exist in the database, return at most limit * conf.Server.DevExternalArtistFetchMultiplier items. func (a *Agents) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error) { switch id { case consts.UnknownArtistID: @@ -192,42 +239,130 @@ func (a *Agents) GetArtistTopSongs(ctx context.Context, id, artistName, mbid str case consts.VariousArtistsID: return nil, nil } - start := time.Now() - for _, ag := range a.agents { - if utils.IsCtxDone(ctx) { - break - } - agent, ok := ag.(ArtistTopSongsRetriever) + + overLimit := int(float64(count) * conf.Server.DevExternalArtistFetchMultiplier) + + return callAgentSliceMethod(ctx, a, "GetArtistTopSongs", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(ArtistTopSongsRetriever) if !ok { - continue + return nil, ErrNotFound } - songs, err := agent.GetArtistTopSongs(ctx, id, artistName, mbid, count) - if len(songs) > 0 && err == nil { - log.Debug(ctx, "Got Top Songs", "agent", ag.AgentName(), "artist", artistName, "songs", songs, "elapsed", time.Since(start)) - return songs, nil - } - } - return nil, ErrNotFound + return retriever.GetArtistTopSongs(ctx, id, artistName, mbid, overLimit) + }) } func (a *Agents) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error) { if name == consts.UnknownAlbum { return nil, ErrNotFound } + + return callAgentMethod(ctx, a, "GetAlbumInfo", func(ag Interface) (*AlbumInfo, error) { + retriever, ok := ag.(AlbumInfoRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetAlbumInfo(ctx, name, artist, mbid) + }) +} + +func (a *Agents) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]ExternalImage, error) { + if name == consts.UnknownAlbum { + return nil, ErrNotFound + } + + return callAgentSliceMethod(ctx, a, "GetAlbumImages", func(ag Interface) ([]ExternalImage, error) { + retriever, ok := ag.(AlbumImageRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetAlbumImages(ctx, name, artist, mbid) + }) +} + +// GetSimilarSongsByTrack returns similar songs for a given track. +func (a *Agents) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByTrack", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByTrackRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByTrack(ctx, id, name, artist, mbid, count) + }) +} + +// GetSimilarSongsByAlbum returns similar songs for a given album. +func (a *Agents) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByAlbum", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByAlbumRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByAlbum(ctx, id, name, artist, mbid, count) + }) +} + +// GetSimilarSongsByArtist returns similar songs for a given artist. +func (a *Agents) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]Song, error) { + switch id { + case consts.UnknownArtistID: + return nil, ErrNotFound + case consts.VariousArtistsID: + return nil, nil + } + + return callAgentSliceMethod(ctx, a, "GetSimilarSongsByArtist", func(ag Interface) ([]Song, error) { + retriever, ok := ag.(SimilarSongsByArtistRetriever) + if !ok { + return nil, ErrNotFound + } + return retriever.GetSimilarSongsByArtist(ctx, id, name, mbid, count) + }) +} + +func callAgentMethod[T comparable](ctx context.Context, agents *Agents, methodName string, fn func(Interface) (T, error)) (T, error) { + var zero T start := time.Now() - for _, ag := range a.agents { + for _, enabledAgent := range agents.getEnabledAgentNames() { + ag := agents.getAgent(enabledAgent) + if ag == nil { + continue + } if utils.IsCtxDone(ctx) { break } - agent, ok := ag.(AlbumInfoRetriever) - if !ok { + result, err := fn(ag) + if err != nil { + log.Trace(ctx, "Agent method call error", "method", methodName, "agent", ag.AgentName(), "error", err) continue } - album, err := agent.GetAlbumInfo(ctx, name, artist, mbid) - if err == nil { - log.Debug(ctx, "Got Album Info", "agent", ag.AgentName(), "album", name, "artist", artist, - "mbid", mbid, "elapsed", time.Since(start)) - return album, nil + + if result != zero { + log.Debug(ctx, "Got result", "method", methodName, "agent", ag.AgentName(), "elapsed", time.Since(start)) + return result, nil + } + } + return zero, ErrNotFound +} + +func callAgentSliceMethod[T any](ctx context.Context, agents *Agents, methodName string, fn func(Interface) ([]T, error)) ([]T, error) { + start := time.Now() + for _, enabledAgent := range agents.getEnabledAgentNames() { + ag := agents.getAgent(enabledAgent) + if ag == nil { + continue + } + if utils.IsCtxDone(ctx) { + break + } + results, err := fn(ag) + if err != nil { + log.Trace(ctx, "Agent method call error", "method", methodName, "agent", ag.AgentName(), "error", err) + continue + } + + if len(results) > 0 { + log.Debug(ctx, "Got results", "method", methodName, "agent", ag.AgentName(), "count", len(results), "elapsed", time.Since(start)) + return results, nil } } return nil, ErrNotFound @@ -241,3 +376,7 @@ var _ ArtistSimilarRetriever = (*Agents)(nil) var _ ArtistImageRetriever = (*Agents)(nil) var _ ArtistTopSongsRetriever = (*Agents)(nil) var _ AlbumInfoRetriever = (*Agents)(nil) +var _ AlbumImageRetriever = (*Agents)(nil) +var _ SimilarSongsByTrackRetriever = (*Agents)(nil) +var _ SimilarSongsByAlbumRetriever = (*Agents)(nil) +var _ SimilarSongsByArtistRetriever = (*Agents)(nil) diff --git a/core/agents/agents_plugin_test.go b/core/agents/agents_plugin_test.go new file mode 100644 index 000000000..b2791c00e --- /dev/null +++ b/core/agents/agents_plugin_test.go @@ -0,0 +1,281 @@ +package agents + +import ( + "context" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/slice" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// MockPluginLoader implements PluginLoader for testing +type MockPluginLoader struct { + pluginNames []string + loadedAgents map[string]*MockAgent + pluginCallCount map[string]int +} + +func NewMockPluginLoader() *MockPluginLoader { + return &MockPluginLoader{ + pluginNames: []string{}, + loadedAgents: make(map[string]*MockAgent), + pluginCallCount: make(map[string]int), + } +} + +func (m *MockPluginLoader) PluginNames(serviceName string) []string { + return m.pluginNames +} + +func (m *MockPluginLoader) LoadMediaAgent(name string) (Interface, bool) { + m.pluginCallCount[name]++ + agent, exists := m.loadedAgents[name] + return agent, exists +} + +// MockAgent is a mock agent implementation for testing +type MockAgent struct { + name string + mbid string +} + +func (m *MockAgent) AgentName() string { + return m.name +} + +func (m *MockAgent) GetArtistMBID(ctx context.Context, id string, name string) (string, error) { + return m.mbid, nil +} + +var _ Interface = (*MockAgent)(nil) +var _ ArtistMBIDRetriever = (*MockAgent)(nil) + +var _ PluginLoader = (*MockPluginLoader)(nil) + +var _ = Describe("Agents with Plugin Loading", func() { + var mockLoader *MockPluginLoader + var agents *Agents + + BeforeEach(func() { + mockLoader = NewMockPluginLoader() + + // Create the agents instance with our mock loader + agents = createAgents(nil, mockLoader) + }) + + Context("Dynamic agent discovery", func() { + It("should include ONLY local agent when no config is specified", func() { + // Ensure no specific agents are configured + conf.Server.Agents = "" + + // Add some plugin agents that should be ignored + mockLoader.pluginNames = append(mockLoader.pluginNames, "plugin_agent", "another_plugin") + + // Should only include the local agent + enabledAgents := agents.getEnabledAgentNames() + Expect(enabledAgents).To(HaveLen(1)) + Expect(enabledAgents[0].name).To(Equal(LocalAgentName)) + Expect(enabledAgents[0].isPlugin).To(BeFalse()) // LocalAgent is built-in, not plugin + }) + + It("should NOT include plugin agents when no config is specified", func() { + // Ensure no specific agents are configured + conf.Server.Agents = "" + + // Add a plugin agent + mockLoader.pluginNames = append(mockLoader.pluginNames, "plugin_agent") + + // Should only include the local agent + enabledAgents := agents.getEnabledAgentNames() + Expect(enabledAgents).To(HaveLen(1)) + Expect(enabledAgents[0].name).To(Equal(LocalAgentName)) + Expect(enabledAgents[0].isPlugin).To(BeFalse()) // LocalAgent is built-in, not plugin + }) + + It("should include plugin agents in the enabled agents list ONLY when explicitly configured", func() { + // Add a plugin agent + mockLoader.pluginNames = append(mockLoader.pluginNames, "plugin_agent") + + // With no config, should not include plugin + conf.Server.Agents = "" + enabledAgents := agents.getEnabledAgentNames() + Expect(enabledAgents).To(HaveLen(1)) + Expect(enabledAgents[0].name).To(Equal(LocalAgentName)) + + // When explicitly configured, should include plugin + conf.Server.Agents = "plugin_agent" + enabledAgents = agents.getEnabledAgentNames() + var agentNames []string + var pluginAgentFound bool + for _, agent := range enabledAgents { + agentNames = append(agentNames, agent.name) + if agent.name == "plugin_agent" { + pluginAgentFound = true + Expect(agent.isPlugin).To(BeTrue()) // plugin_agent is a plugin + } + } + Expect(agentNames).To(ContainElements(LocalAgentName, "plugin_agent")) + Expect(pluginAgentFound).To(BeTrue()) + }) + + It("should only include configured plugin agents when config is specified", func() { + // Add two plugin agents + mockLoader.pluginNames = append(mockLoader.pluginNames, "plugin_one", "plugin_two") + + // Configure only one of them + conf.Server.Agents = "plugin_one" + + // Verify only the configured one is included + enabledAgents := agents.getEnabledAgentNames() + var agentNames []string + var pluginOneFound bool + for _, agent := range enabledAgents { + agentNames = append(agentNames, agent.name) + if agent.name == "plugin_one" { + pluginOneFound = true + Expect(agent.isPlugin).To(BeTrue()) // plugin_one is a plugin + } + } + Expect(agentNames).To(ContainElements(LocalAgentName, "plugin_one")) + Expect(agentNames).NotTo(ContainElement("plugin_two")) + Expect(pluginOneFound).To(BeTrue()) + }) + + It("should load plugin agents on demand", func() { + ctx := context.Background() + + // Configure to use our plugin + conf.Server.Agents = "plugin_agent" + + // Add a plugin agent + mockLoader.pluginNames = append(mockLoader.pluginNames, "plugin_agent") + mockLoader.loadedAgents["plugin_agent"] = &MockAgent{ + name: "plugin_agent", + mbid: "plugin-mbid", + } + + // Try to get data from it + mbid, err := agents.GetArtistMBID(ctx, "123", "Artist") + + Expect(err).ToNot(HaveOccurred()) + Expect(mbid).To(Equal("plugin-mbid")) + Expect(mockLoader.pluginCallCount["plugin_agent"]).To(Equal(1)) + }) + + It("should try both built-in and plugin agents", func() { + // Create a mock built-in agent + Register("built_in", func(ds model.DataStore) Interface { + return &MockAgent{ + name: "built_in", + mbid: "built-in-mbid", + } + }) + defer func() { + delete(Map, "built_in") + }() + + // Configure to use both built-in and plugin + conf.Server.Agents = "built_in,plugin_agent" + + // Add a plugin agent + mockLoader.pluginNames = append(mockLoader.pluginNames, "plugin_agent") + mockLoader.loadedAgents["plugin_agent"] = &MockAgent{ + name: "plugin_agent", + mbid: "plugin-mbid", + } + + // Verify that both are in the enabled list + enabledAgents := agents.getEnabledAgentNames() + var agentNames []string + var builtInFound, pluginFound bool + for _, agent := range enabledAgents { + agentNames = append(agentNames, agent.name) + if agent.name == "built_in" { + builtInFound = true + Expect(agent.isPlugin).To(BeFalse()) // built-in agent + } + if agent.name == "plugin_agent" { + pluginFound = true + Expect(agent.isPlugin).To(BeTrue()) // plugin agent + } + } + Expect(agentNames).To(ContainElements("built_in", "plugin_agent", LocalAgentName)) + Expect(builtInFound).To(BeTrue()) + Expect(pluginFound).To(BeTrue()) + }) + + It("should respect the order specified in configuration", func() { + // Create mock built-in agents + Register("agent_a", func(ds model.DataStore) Interface { + return &MockAgent{name: "agent_a"} + }) + Register("agent_b", func(ds model.DataStore) Interface { + return &MockAgent{name: "agent_b"} + }) + defer func() { + delete(Map, "agent_a") + delete(Map, "agent_b") + }() + + // Add plugin agents + mockLoader.pluginNames = append(mockLoader.pluginNames, "plugin_x", "plugin_y") + + // Configure specific order - plugin first, then built-ins + conf.Server.Agents = "plugin_y,agent_b,plugin_x,agent_a" + + // Get the agent names + enabledAgents := agents.getEnabledAgentNames() + + // Extract just the names to verify the order + agentNames := slice.Map(enabledAgents, func(a enabledAgent) string { return a.name }) + + // Verify the order matches configuration, with LocalAgentName at the end + Expect(agentNames).To(HaveExactElements("plugin_y", "agent_b", "plugin_x", "agent_a", LocalAgentName)) + }) + + It("should NOT call LoadMediaAgent for built-in agents", func() { + ctx := context.Background() + + // Create a mock built-in agent + Register("builtin_agent", func(ds model.DataStore) Interface { + return &MockAgent{ + name: "builtin_agent", + mbid: "builtin-mbid", + } + }) + defer func() { + delete(Map, "builtin_agent") + }() + + // Configure to use only built-in agents + conf.Server.Agents = "builtin_agent" + + // Call GetArtistMBID which should only use the built-in agent + mbid, err := agents.GetArtistMBID(ctx, "123", "Artist") + + Expect(err).ToNot(HaveOccurred()) + Expect(mbid).To(Equal("builtin-mbid")) + + // Verify LoadMediaAgent was NEVER called (no plugin loading for built-in agents) + Expect(mockLoader.pluginCallCount).To(BeEmpty()) + }) + + It("should NOT call LoadMediaAgent for invalid agent names", func() { + ctx := context.Background() + + // Configure with an invalid agent name (not built-in, not a plugin) + conf.Server.Agents = "invalid_agent" + + // This should only result in using the local agent (as the invalid one is ignored) + _, err := agents.GetArtistMBID(ctx, "123", "Artist") + + // Should get ErrNotFound since only local agent is available and it returns not found for this operation + Expect(err).To(MatchError(ErrNotFound)) + + // Verify LoadMediaAgent was NEVER called for the invalid agent + Expect(mockLoader.pluginCallCount).To(BeEmpty()) + }) + }) +}) diff --git a/core/agents/agents_test.go b/core/agents/agents_test.go index ea12fb746..50285a084 100644 --- a/core/agents/agents_test.go +++ b/core/agents/agents_test.go @@ -4,10 +4,10 @@ import ( "context" "errors" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" - "github.com/navidrome/navidrome/utils/slice" "github.com/navidrome/navidrome/conf" . "github.com/onsi/ginkgo/v2" @@ -20,6 +20,7 @@ var _ = Describe("Agents", func() { var ds model.DataStore var mfRepo *tests.MockMediaFileRepo BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) ctx, cancel = context.WithCancel(context.Background()) mfRepo = tests.CreateMockMediaFileRepo() ds = &tests.MockDataStore{MockedMediaFile: mfRepo} @@ -29,7 +30,7 @@ var _ = Describe("Agents", func() { var ag *Agents BeforeEach(func() { conf.Server.Agents = "" - ag = createAgents(ds) + ag = createAgents(ds, nil) }) It("calls the placeholder GetArtistImages", func() { @@ -49,12 +50,18 @@ var _ = Describe("Agents", func() { Register("disabled", func(model.DataStore) Interface { return nil }) Register("empty", func(model.DataStore) Interface { return &emptyAgent{} }) conf.Server.Agents = "empty,fake,disabled" - ag = createAgents(ds) + ag = createAgents(ds, nil) Expect(ag.AgentName()).To(Equal("agents")) }) It("does not register disabled agents", func() { - ags := slice.Map(ag.agents, func(a Interface) string { return a.AgentName() }) + var ags []string + for _, enabledAgent := range ag.getEnabledAgentNames() { + agent := ag.getAgent(enabledAgent) + if agent != nil { + ags = append(ags, agent.AgentName()) + } + } // local agent is always appended to the end of the agents list Expect(ags).To(HaveExactElements("empty", "fake", "local")) Expect(ags).ToNot(ContainElement("disabled")) @@ -173,6 +180,42 @@ var _ = Describe("Agents", func() { Expect(err).To(MatchError(ErrNotFound)) Expect(mock.Args).To(BeEmpty()) }) + + Context("with multiple image agents", func() { + var first *testImageAgent + var second *testImageAgent + + BeforeEach(func() { + first = &testImageAgent{Name: "imgFail", Err: errors.New("fail")} + second = &testImageAgent{Name: "imgOk", Images: []ExternalImage{{URL: "ok", Size: 1}}} + Register("imgFail", func(model.DataStore) Interface { return first }) + Register("imgOk", func(model.DataStore) Interface { return second }) + }) + + It("falls back to the next agent on error", func() { + conf.Server.Agents = "imgFail,imgOk" + ag = createAgents(ds, nil) + + images, err := ag.GetArtistImages(ctx, "id", "artist", "mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(Equal([]ExternalImage{{URL: "ok", Size: 1}})) + Expect(first.Args).To(HaveExactElements("id", "artist", "mbid")) + Expect(second.Args).To(HaveExactElements("id", "artist", "mbid")) + }) + + It("falls back if the first agent returns no images", func() { + first.Err = nil + first.Images = []ExternalImage{} + conf.Server.Agents = "imgFail,imgOk" + ag = createAgents(ds, nil) + + images, err := ag.GetArtistImages(ctx, "id", "artist", "mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(Equal([]ExternalImage{{URL: "ok", Size: 1}})) + Expect(first.Args).To(HaveExactElements("id", "artist", "mbid")) + Expect(second.Args).To(HaveExactElements("id", "artist", "mbid")) + }) + }) }) Describe("GetSimilarArtists", func() { @@ -199,6 +242,7 @@ var _ = Describe("Agents", func() { Describe("GetArtistTopSongs", func() { It("returns on first match", func() { + conf.Server.DevExternalArtistFetchMultiplier = 1 Expect(ag.GetArtistTopSongs(ctx, "123", "test", "mb123", 2)).To(Equal([]Song{{ Name: "A Song", MBID: "mbid444", @@ -206,6 +250,7 @@ var _ = Describe("Agents", func() { Expect(mock.Args).To(HaveExactElements("123", "test", "mb123", 2)) }) It("skips the agent if it returns an error", func() { + conf.Server.DevExternalArtistFetchMultiplier = 1 mock.Err = errors.New("error") _, err := ag.GetArtistTopSongs(ctx, "123", "test", "mb123", 2) Expect(err).To(MatchError(ErrNotFound)) @@ -217,6 +262,14 @@ var _ = Describe("Agents", func() { Expect(err).To(MatchError(ErrNotFound)) Expect(mock.Args).To(BeEmpty()) }) + It("fetches with multiplier", func() { + conf.Server.DevExternalArtistFetchMultiplier = 2 + Expect(ag.GetArtistTopSongs(ctx, "123", "test", "mb123", 2)).To(Equal([]Song{{ + Name: "A Song", + MBID: "mbid444", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test", "mb123", 4)) + }) }) Describe("GetAlbumInfo", func() { @@ -226,18 +279,6 @@ var _ = Describe("Agents", func() { MBID: "mbid444", Description: "A Description", URL: "External URL", - Images: []ExternalImage{ - { - Size: 174, - URL: "https://lastfm.freetls.fastly.net/i/u/174s/00000000000000000000000000000000.png", - }, { - Size: 64, - URL: "https://lastfm.freetls.fastly.net/i/u/64s/00000000000000000000000000000000.png", - }, { - Size: 34, - URL: "https://lastfm.freetls.fastly.net/i/u/34s/00000000000000000000000000000000.png", - }, - }, })) Expect(mock.Args).To(HaveExactElements("album", "artist", "mbid")) }) @@ -254,11 +295,77 @@ var _ = Describe("Agents", func() { Expect(mock.Args).To(BeEmpty()) }) }) + + Describe("GetSimilarSongsByTrack", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Similar Song", + MBID: "mbid555", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test song", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test song", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByTrack(ctx, "123", "test song", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) + + Describe("GetSimilarSongsByAlbum", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Album Similar Song", + MBID: "mbid666", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test album", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test album", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByAlbum(ctx, "123", "test album", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) + + Describe("GetSimilarSongsByArtist", func() { + It("returns on first match", func() { + Expect(ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2)).To(Equal([]Song{{ + Name: "Artist Similar Song", + MBID: "mbid777", + }})) + Expect(mock.Args).To(HaveExactElements("123", "test artist", "mb123", 2)) + }) + It("skips the agent if it returns an error", func() { + mock.Err = errors.New("error") + _, err := ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(HaveExactElements("123", "test artist", "mb123", 2)) + }) + It("interrupts if the context is canceled", func() { + cancel() + _, err := ag.GetSimilarSongsByArtist(ctx, "123", "test artist", "mb123", 2) + Expect(err).To(MatchError(ErrNotFound)) + Expect(mock.Args).To(BeEmpty()) + }) + }) }) }) type mockAgent struct { - Args []interface{} + Args []any Err error } @@ -267,7 +374,7 @@ func (a *mockAgent) AgentName() string { } func (a *mockAgent) GetArtistMBID(_ context.Context, id string, name string) (string, error) { - a.Args = []interface{}{id, name} + a.Args = []any{id, name} if a.Err != nil { return "", a.Err } @@ -275,7 +382,7 @@ func (a *mockAgent) GetArtistMBID(_ context.Context, id string, name string) (st } func (a *mockAgent) GetArtistURL(_ context.Context, id, name, mbid string) (string, error) { - a.Args = []interface{}{id, name, mbid} + a.Args = []any{id, name, mbid} if a.Err != nil { return "", a.Err } @@ -283,7 +390,7 @@ func (a *mockAgent) GetArtistURL(_ context.Context, id, name, mbid string) (stri } func (a *mockAgent) GetArtistBiography(_ context.Context, id, name, mbid string) (string, error) { - a.Args = []interface{}{id, name, mbid} + a.Args = []any{id, name, mbid} if a.Err != nil { return "", a.Err } @@ -291,7 +398,7 @@ func (a *mockAgent) GetArtistBiography(_ context.Context, id, name, mbid string) } func (a *mockAgent) GetArtistImages(_ context.Context, id, name, mbid string) ([]ExternalImage, error) { - a.Args = []interface{}{id, name, mbid} + a.Args = []any{id, name, mbid} if a.Err != nil { return nil, a.Err } @@ -302,7 +409,7 @@ func (a *mockAgent) GetArtistImages(_ context.Context, id, name, mbid string) ([ } func (a *mockAgent) GetSimilarArtists(_ context.Context, id, name, mbid string, limit int) ([]Artist, error) { - a.Args = []interface{}{id, name, mbid, limit} + a.Args = []any{id, name, mbid, limit} if a.Err != nil { return nil, a.Err } @@ -313,7 +420,7 @@ func (a *mockAgent) GetSimilarArtists(_ context.Context, id, name, mbid string, } func (a *mockAgent) GetArtistTopSongs(_ context.Context, id, artistName, mbid string, count int) ([]Song, error) { - a.Args = []interface{}{id, artistName, mbid, count} + a.Args = []any{id, artistName, mbid, count} if a.Err != nil { return nil, a.Err } @@ -324,7 +431,7 @@ func (a *mockAgent) GetArtistTopSongs(_ context.Context, id, artistName, mbid st } func (a *mockAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error) { - a.Args = []interface{}{name, artist, mbid} + a.Args = []any{name, artist, mbid} if a.Err != nil { return nil, a.Err } @@ -333,21 +440,42 @@ func (a *mockAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) MBID: "mbid444", Description: "A Description", URL: "External URL", - Images: []ExternalImage{ - { - Size: 174, - URL: "https://lastfm.freetls.fastly.net/i/u/174s/00000000000000000000000000000000.png", - }, { - Size: 64, - URL: "https://lastfm.freetls.fastly.net/i/u/64s/00000000000000000000000000000000.png", - }, { - Size: 34, - URL: "https://lastfm.freetls.fastly.net/i/u/34s/00000000000000000000000000000000.png", - }, - }, }, nil } +func (a *mockAgent) GetSimilarSongsByTrack(_ context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + a.Args = []any{id, name, artist, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Similar Song", + MBID: "mbid555", + }}, nil +} + +func (a *mockAgent) GetSimilarSongsByAlbum(_ context.Context, id, name, artist, mbid string, count int) ([]Song, error) { + a.Args = []any{id, name, artist, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Album Similar Song", + MBID: "mbid666", + }}, nil +} + +func (a *mockAgent) GetSimilarSongsByArtist(_ context.Context, id, name, mbid string, count int) ([]Song, error) { + a.Args = []any{id, name, mbid, count} + if a.Err != nil { + return nil, a.Err + } + return []Song{{ + Name: "Artist Similar Song", + MBID: "mbid777", + }}, nil +} + type emptyAgent struct { Interface } @@ -355,3 +483,17 @@ type emptyAgent struct { func (e *emptyAgent) AgentName() string { return "empty" } + +type testImageAgent struct { + Name string + Images []ExternalImage + Err error + Args []any +} + +func (t *testImageAgent) AgentName() string { return t.Name } + +func (t *testImageAgent) GetArtistImages(_ context.Context, id, name, mbid string) ([]ExternalImage, error) { + t.Args = []any{id, name, mbid} + return t.Images, t.Err +} diff --git a/core/agents/interfaces.go b/core/agents/interfaces.go index 00f75627d..19df91d02 100644 --- a/core/agents/interfaces.go +++ b/core/agents/interfaces.go @@ -13,15 +13,16 @@ type Interface interface { AgentName() string } +// AlbumInfo contains album metadata (no images) type AlbumInfo struct { Name string MBID string Description string URL string - Images []ExternalImage } type Artist struct { + ID string Name string MBID string } @@ -32,19 +33,31 @@ type ExternalImage struct { } type Song struct { - Name string - MBID string + ID string + Name string + MBID string + ISRC string + Artist string + ArtistMBID string + Album string + AlbumMBID string + Duration uint32 // Duration in milliseconds, 0 means unknown } var ( ErrNotFound = errors.New("not found") ) -// TODO Break up this interface in more specific methods, like artists +// AlbumInfoRetriever provides album info (no images) type AlbumInfoRetriever interface { GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*AlbumInfo, error) } +// AlbumImageRetriever provides album images +type AlbumImageRetriever interface { + GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]ExternalImage, error) +} + type ArtistMBIDRetriever interface { GetArtistMBID(ctx context.Context, id string, name string) (string, error) } @@ -69,6 +82,41 @@ type ArtistTopSongsRetriever interface { GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error) } +// SimilarSongsByTrackRetriever provides similar songs based on a specific track +type SimilarSongsByTrackRetriever interface { + // GetSimilarSongsByTrack returns songs similar to the given track. + // Parameters: + // - id: local mediafile ID + // - name: track title + // - artist: artist name + // - mbid: MusicBrainz recording ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) +} + +// SimilarSongsByAlbumRetriever provides similar songs based on an album +type SimilarSongsByAlbumRetriever interface { + // GetSimilarSongsByAlbum returns songs similar to tracks on the given album. + // Parameters: + // - id: local album ID + // - name: album name + // - artist: album artist name + // - mbid: MusicBrainz release ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) +} + +// SimilarSongsByArtistRetriever provides similar songs based on an artist +type SimilarSongsByArtistRetriever interface { + // GetSimilarSongsByArtist returns songs similar to the artist's catalog. + // Parameters: + // - id: local artist ID + // - name: artist name + // - mbid: MusicBrainz artist ID (may be empty) + // - count: maximum number of results + GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]Song, error) +} + var Map map[string]Constructor func Register(name string, init Constructor) { diff --git a/core/agents/listenbrainz/agent_test.go b/core/agents/listenbrainz/agent_test.go deleted file mode 100644 index 86a95d5bf..000000000 --- a/core/agents/listenbrainz/agent_test.go +++ /dev/null @@ -1,165 +0,0 @@ -package listenbrainz - -import ( - "bytes" - "context" - "encoding/json" - "io" - "net/http" - "time" - - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/scrobbler" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" - . "github.com/onsi/gomega/gstruct" -) - -var _ = Describe("listenBrainzAgent", func() { - var ds model.DataStore - var ctx context.Context - var agent *listenBrainzAgent - var httpClient *tests.FakeHttpClient - var track *model.MediaFile - - BeforeEach(func() { - ds = &tests.MockDataStore{} - ctx = context.Background() - _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1") - httpClient = &tests.FakeHttpClient{} - agent = listenBrainzConstructor(ds) - agent.client = newClient("http://localhost:8080", httpClient) - track = &model.MediaFile{ - ID: "123", - Title: "Track Title", - Album: "Track Album", - Artist: "Track Artist", - TrackNumber: 1, - MbzRecordingID: "mbz-123", - MbzAlbumID: "mbz-456", - MbzReleaseGroupID: "mbz-789", - Duration: 142.2, - Participants: map[model.Role]model.ParticipantList{ - model.RoleArtist: []model.Participant{ - {Artist: model.Artist{ID: "ar-1", Name: "Artist 1", MbzArtistID: "mbz-111"}}, - {Artist: model.Artist{ID: "ar-2", Name: "Artist 2", MbzArtistID: "mbz-222"}}, - }, - }, - } - }) - - Describe("formatListen", func() { - It("constructs the listenInfo properly", func() { - lr := agent.formatListen(track) - Expect(lr).To(MatchAllFields(Fields{ - "ListenedAt": Equal(0), - "TrackMetadata": MatchAllFields(Fields{ - "ArtistName": Equal(track.Artist), - "TrackName": Equal(track.Title), - "ReleaseName": Equal(track.Album), - "AdditionalInfo": MatchAllFields(Fields{ - "SubmissionClient": Equal(consts.AppName), - "SubmissionClientVersion": Equal(consts.Version), - "TrackNumber": Equal(track.TrackNumber), - "RecordingMBID": Equal(track.MbzRecordingID), - "ReleaseMBID": Equal(track.MbzAlbumID), - "ReleaseGroupMBID": Equal(track.MbzReleaseGroupID), - "ArtistNames": ConsistOf("Artist 1", "Artist 2"), - "ArtistMBIDs": ConsistOf("mbz-111", "mbz-222"), - "DurationMs": Equal(142200), - }), - }), - })) - }) - }) - - Describe("NowPlaying", func() { - It("updates NowPlaying successfully", func() { - httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} - - err := agent.NowPlaying(ctx, "user-1", track) - Expect(err).ToNot(HaveOccurred()) - }) - - It("returns ErrNotAuthorized if user is not linked", func() { - err := agent.NowPlaying(ctx, "user-2", track) - Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) - }) - }) - - Describe("Scrobble", func() { - var sc scrobbler.Scrobble - - BeforeEach(func() { - sc = scrobbler.Scrobble{MediaFile: *track, TimeStamp: time.Now()} - }) - - It("sends a Scrobble successfully", func() { - httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).ToNot(HaveOccurred()) - }) - - It("sets the Timestamp properly", func() { - httpClient.Res = http.Response{Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), StatusCode: 200} - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).ToNot(HaveOccurred()) - - decoder := json.NewDecoder(httpClient.SavedRequest.Body) - var lr listenBrainzRequestBody - err = decoder.Decode(&lr) - - Expect(err).ToNot(HaveOccurred()) - Expect(lr.Payload[0].ListenedAt).To(Equal(int(sc.TimeStamp.Unix()))) - }) - - It("returns ErrNotAuthorized if user is not linked", func() { - err := agent.Scrobble(ctx, "user-2", sc) - Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) - }) - - It("returns ErrRetryLater on error 503", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 503, "error": "Cannot submit listens to queue, please try again later."}`)), - StatusCode: 503, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrRetryLater)) - }) - - It("returns ErrRetryLater on error 500", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 500, "error": "Something went wrong. Please try again."}`)), - StatusCode: 500, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrRetryLater)) - }) - - It("returns ErrRetryLater on http errors", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`Bad Gateway`)), - StatusCode: 500, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrRetryLater)) - }) - - It("returns ErrUnrecoverable on other errors", func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 400, "error": "BadRequest: Invalid JSON document submitted."}`)), - StatusCode: 400, - } - - err := agent.Scrobble(ctx, "user-1", sc) - Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) - }) - }) -}) diff --git a/core/agents/listenbrainz/client.go b/core/agents/listenbrainz/client.go deleted file mode 100644 index 168aad549..000000000 --- a/core/agents/listenbrainz/client.go +++ /dev/null @@ -1,179 +0,0 @@ -package listenbrainz - -import ( - "bytes" - "context" - "encoding/json" - "fmt" - "net/http" - "net/url" - "path" - - "github.com/navidrome/navidrome/log" -) - -type listenBrainzError struct { - Code int - Message string -} - -func (e *listenBrainzError) Error() string { - return fmt.Sprintf("ListenBrainz error(%d): %s", e.Code, e.Message) -} - -type httpDoer interface { - Do(req *http.Request) (*http.Response, error) -} - -func newClient(baseURL string, hc httpDoer) *client { - return &client{baseURL, hc} -} - -type client struct { - baseURL string - hc httpDoer -} - -type listenBrainzResponse struct { - Code int `json:"code"` - Message string `json:"message"` - Error string `json:"error"` - Status string `json:"status"` - Valid bool `json:"valid"` - UserName string `json:"user_name"` -} - -type listenBrainzRequest struct { - ApiKey string - Body listenBrainzRequestBody -} - -type listenBrainzRequestBody struct { - ListenType listenType `json:"listen_type,omitempty"` - Payload []listenInfo `json:"payload,omitempty"` -} - -type listenType string - -const ( - Single listenType = "single" - PlayingNow listenType = "playing_now" -) - -type listenInfo struct { - ListenedAt int `json:"listened_at,omitempty"` - TrackMetadata trackMetadata `json:"track_metadata,omitempty"` -} - -type trackMetadata struct { - ArtistName string `json:"artist_name,omitempty"` - TrackName string `json:"track_name,omitempty"` - ReleaseName string `json:"release_name,omitempty"` - AdditionalInfo additionalInfo `json:"additional_info,omitempty"` -} - -type additionalInfo struct { - SubmissionClient string `json:"submission_client,omitempty"` - SubmissionClientVersion string `json:"submission_client_version,omitempty"` - TrackNumber int `json:"tracknumber,omitempty"` - ArtistNames []string `json:"artist_names,omitempty"` - ArtistMBIDs []string `json:"artist_mbids,omitempty"` - RecordingMBID string `json:"recording_mbid,omitempty"` - ReleaseMBID string `json:"release_mbid,omitempty"` - ReleaseGroupMBID string `json:"release_group_mbid,omitempty"` - DurationMs int `json:"duration_ms,omitempty"` -} - -func (c *client) validateToken(ctx context.Context, apiKey string) (*listenBrainzResponse, error) { - r := &listenBrainzRequest{ - ApiKey: apiKey, - } - response, err := c.makeRequest(ctx, http.MethodGet, "validate-token", r) - if err != nil { - return nil, err - } - return response, nil -} - -func (c *client) updateNowPlaying(ctx context.Context, apiKey string, li listenInfo) error { - r := &listenBrainzRequest{ - ApiKey: apiKey, - Body: listenBrainzRequestBody{ - ListenType: PlayingNow, - Payload: []listenInfo{li}, - }, - } - - resp, err := c.makeRequest(ctx, http.MethodPost, "submit-listens", r) - if err != nil { - return err - } - if resp.Status != "ok" { - log.Warn(ctx, "ListenBrainz: NowPlaying was not accepted", "status", resp.Status) - } - return nil -} - -func (c *client) scrobble(ctx context.Context, apiKey string, li listenInfo) error { - r := &listenBrainzRequest{ - ApiKey: apiKey, - Body: listenBrainzRequestBody{ - ListenType: Single, - Payload: []listenInfo{li}, - }, - } - resp, err := c.makeRequest(ctx, http.MethodPost, "submit-listens", r) - if err != nil { - return err - } - if resp.Status != "ok" { - log.Warn(ctx, "ListenBrainz: Scrobble was not accepted", "status", resp.Status) - } - return nil -} - -func (c *client) path(endpoint string) (string, error) { - u, err := url.Parse(c.baseURL) - if err != nil { - return "", err - } - u.Path = path.Join(u.Path, endpoint) - return u.String(), nil -} - -func (c *client) makeRequest(ctx context.Context, method string, endpoint string, r *listenBrainzRequest) (*listenBrainzResponse, error) { - b, _ := json.Marshal(r.Body) - uri, err := c.path(endpoint) - if err != nil { - return nil, err - } - req, _ := http.NewRequestWithContext(ctx, method, uri, bytes.NewBuffer(b)) - req.Header.Add("Content-Type", "application/json; charset=UTF-8") - - if r.ApiKey != "" { - req.Header.Add("Authorization", fmt.Sprintf("Token %s", r.ApiKey)) - } - - log.Trace(ctx, fmt.Sprintf("Sending ListenBrainz %s request", req.Method), "url", req.URL) - resp, err := c.hc.Do(req) - if err != nil { - return nil, err - } - - defer resp.Body.Close() - decoder := json.NewDecoder(resp.Body) - - var response listenBrainzResponse - jsonErr := decoder.Decode(&response) - if resp.StatusCode != 200 && jsonErr != nil { - return nil, fmt.Errorf("ListenBrainz: HTTP Error, Status: (%d)", resp.StatusCode) - } - if jsonErr != nil { - return nil, jsonErr - } - if response.Code != 0 && response.Code != 200 { - return &response, &listenBrainzError{Code: response.Code, Message: response.Error} - } - - return &response, nil -} diff --git a/core/agents/listenbrainz/client_test.go b/core/agents/listenbrainz/client_test.go deleted file mode 100644 index 680a7d185..000000000 --- a/core/agents/listenbrainz/client_test.go +++ /dev/null @@ -1,120 +0,0 @@ -package listenbrainz - -import ( - "bytes" - "context" - "encoding/json" - "io" - "net/http" - "os" - - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("client", func() { - var httpClient *tests.FakeHttpClient - var client *client - BeforeEach(func() { - httpClient = &tests.FakeHttpClient{} - client = newClient("BASE_URL/", httpClient) - }) - - Describe("listenBrainzResponse", func() { - It("parses a response properly", func() { - var response listenBrainzResponse - err := json.Unmarshal([]byte(`{"code": 200, "message": "Message", "user_name": "UserName", "valid": true, "status": "ok", "error": "Error"}`), &response) - - Expect(err).ToNot(HaveOccurred()) - Expect(response.Code).To(Equal(200)) - Expect(response.Message).To(Equal("Message")) - Expect(response.UserName).To(Equal("UserName")) - Expect(response.Valid).To(BeTrue()) - Expect(response.Status).To(Equal("ok")) - Expect(response.Error).To(Equal("Error")) - }) - }) - - Describe("validateToken", func() { - BeforeEach(func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"code": 200, "message": "Token valid.", "user_name": "ListenBrainzUser", "valid": true}`)), - StatusCode: 200, - } - }) - - It("formats the request properly", func() { - _, err := client.validateToken(context.Background(), "LB-TOKEN") - Expect(err).ToNot(HaveOccurred()) - Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodGet)) - Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/validate-token")) - Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) - Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) - }) - - It("parses and returns the response", func() { - res, err := client.validateToken(context.Background(), "LB-TOKEN") - Expect(err).ToNot(HaveOccurred()) - Expect(res.Valid).To(Equal(true)) - Expect(res.UserName).To(Equal("ListenBrainzUser")) - }) - }) - - Context("with listenInfo", func() { - var li listenInfo - BeforeEach(func() { - httpClient.Res = http.Response{ - Body: io.NopCloser(bytes.NewBufferString(`{"status": "ok"}`)), - StatusCode: 200, - } - li = listenInfo{ - TrackMetadata: trackMetadata{ - ArtistName: "Track Artist", - TrackName: "Track Title", - ReleaseName: "Track Album", - AdditionalInfo: additionalInfo{ - TrackNumber: 1, - ArtistNames: []string{"Artist 1", "Artist 2"}, - ArtistMBIDs: []string{"mbz-789", "mbz-012"}, - RecordingMBID: "mbz-123", - ReleaseMBID: "mbz-456", - DurationMs: 142200, - }, - }, - } - }) - - Describe("updateNowPlaying", func() { - It("formats the request properly", func() { - Expect(client.updateNowPlaying(context.Background(), "LB-TOKEN", li)).To(Succeed()) - Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) - Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) - Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) - - body, _ := io.ReadAll(httpClient.SavedRequest.Body) - f, _ := os.ReadFile("tests/fixtures/listenbrainz.nowplaying.request.json") - Expect(body).To(MatchJSON(f)) - }) - }) - - Describe("scrobble", func() { - BeforeEach(func() { - li.ListenedAt = 1635000000 - }) - - It("formats the request properly", func() { - Expect(client.scrobble(context.Background(), "LB-TOKEN", li)).To(Succeed()) - Expect(httpClient.SavedRequest.Method).To(Equal(http.MethodPost)) - Expect(httpClient.SavedRequest.URL.String()).To(Equal("BASE_URL/submit-listens")) - Expect(httpClient.SavedRequest.Header.Get("Authorization")).To(Equal("Token LB-TOKEN")) - Expect(httpClient.SavedRequest.Header.Get("Content-Type")).To(Equal("application/json; charset=UTF-8")) - - body, _ := io.ReadAll(httpClient.SavedRequest.Body) - f, _ := os.ReadFile("tests/fixtures/listenbrainz.scrobble.request.json") - Expect(body).To(MatchJSON(f)) - }) - }) - }) -}) diff --git a/core/agents/spotify/client.go b/core/agents/spotify/client.go deleted file mode 100644 index 25b1f9ede..000000000 --- a/core/agents/spotify/client.go +++ /dev/null @@ -1,116 +0,0 @@ -package spotify - -import ( - "context" - "encoding/base64" - "encoding/json" - "errors" - "fmt" - "io" - "net/http" - "net/url" - "strconv" - "strings" - - "github.com/navidrome/navidrome/log" -) - -const apiBaseUrl = "https://api.spotify.com/v1/" - -var ( - ErrNotFound = errors.New("spotify: not found") -) - -type httpDoer interface { - Do(req *http.Request) (*http.Response, error) -} - -func newClient(id, secret string, hc httpDoer) *client { - return &client{id, secret, hc} -} - -type client struct { - id string - secret string - hc httpDoer -} - -func (c *client) searchArtists(ctx context.Context, name string, limit int) ([]Artist, error) { - token, err := c.authorize(ctx) - if err != nil { - return nil, err - } - - params := url.Values{} - params.Add("type", "artist") - params.Add("q", name) - params.Add("offset", "0") - params.Add("limit", strconv.Itoa(limit)) - req, _ := http.NewRequestWithContext(ctx, "GET", apiBaseUrl+"search", nil) - req.URL.RawQuery = params.Encode() - req.Header.Add("Authorization", "Bearer "+token) - - var results SearchResults - err = c.makeRequest(req, &results) - if err != nil { - return nil, err - } - - if len(results.Artists.Items) == 0 { - return nil, ErrNotFound - } - return results.Artists.Items, err -} - -func (c *client) authorize(ctx context.Context) (string, error) { - payload := url.Values{} - payload.Add("grant_type", "client_credentials") - - encodePayload := payload.Encode() - req, _ := http.NewRequestWithContext(ctx, "POST", "https://accounts.spotify.com/api/token", strings.NewReader(encodePayload)) - req.Header.Add("Content-Type", "application/x-www-form-urlencoded") - req.Header.Add("Content-Length", strconv.Itoa(len(encodePayload))) - auth := c.id + ":" + c.secret - req.Header.Add("Authorization", "Basic "+base64.StdEncoding.EncodeToString([]byte(auth))) - - response := map[string]interface{}{} - err := c.makeRequest(req, &response) - if err != nil { - return "", err - } - - if v, ok := response["access_token"]; ok { - return v.(string), nil - } - log.Error(ctx, "Invalid spotify response", "resp", response) - return "", errors.New("invalid response") -} - -func (c *client) makeRequest(req *http.Request, response interface{}) error { - log.Trace(req.Context(), fmt.Sprintf("Sending Spotify %s request", req.Method), "url", req.URL) - resp, err := c.hc.Do(req) - if err != nil { - return err - } - - defer resp.Body.Close() - data, err := io.ReadAll(resp.Body) - if err != nil { - return err - } - - if resp.StatusCode != 200 { - return c.parseError(data) - } - - return json.Unmarshal(data, response) -} - -func (c *client) parseError(data []byte) error { - var e Error - err := json.Unmarshal(data, &e) - if err != nil { - return err - } - return fmt.Errorf("spotify error(%s): %s", e.Code, e.Message) -} diff --git a/core/agents/spotify/client_test.go b/core/agents/spotify/client_test.go deleted file mode 100644 index 2782d2122..000000000 --- a/core/agents/spotify/client_test.go +++ /dev/null @@ -1,131 +0,0 @@ -package spotify - -import ( - "bytes" - "context" - "io" - "net/http" - "os" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("client", func() { - var httpClient *fakeHttpClient - var client *client - - BeforeEach(func() { - httpClient = &fakeHttpClient{} - client = newClient("SPOTIFY_ID", "SPOTIFY_SECRET", httpClient) - }) - - Describe("ArtistImages", func() { - It("returns artist images from a successful request", func() { - f, _ := os.Open("tests/fixtures/spotify.search.artist.json") - httpClient.mock("https://api.spotify.com/v1/search", http.Response{Body: f, StatusCode: 200}) - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{"access_token": "NEW_ACCESS_TOKEN","token_type": "Bearer","expires_in": 3600}`)), - }) - - artists, err := client.searchArtists(context.TODO(), "U2", 10) - Expect(err).To(BeNil()) - Expect(artists).To(HaveLen(20)) - Expect(artists[0].Popularity).To(Equal(82)) - - images := artists[0].Images - Expect(images).To(HaveLen(3)) - Expect(images[0].Width).To(Equal(640)) - Expect(images[1].Width).To(Equal(320)) - Expect(images[2].Width).To(Equal(160)) - }) - - It("fails if artist was not found", func() { - httpClient.mock("https://api.spotify.com/v1/search", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{ - "artists" : { - "href" : "https://api.spotify.com/v1/search?query=dasdasdas%2Cdna&type=artist&offset=0&limit=20", - "items" : [ ], "limit" : 20, "next" : null, "offset" : 0, "previous" : null, "total" : 0 - }}`)), - }) - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{"access_token": "NEW_ACCESS_TOKEN","token_type": "Bearer","expires_in": 3600}`)), - }) - - _, err := client.searchArtists(context.TODO(), "U2", 10) - Expect(err).To(MatchError(ErrNotFound)) - }) - - It("fails if not able to authorize", func() { - f, _ := os.Open("tests/fixtures/spotify.search.artist.json") - httpClient.mock("https://api.spotify.com/v1/search", http.Response{Body: f, StatusCode: 200}) - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 400, - Body: io.NopCloser(bytes.NewBufferString(`{"error":"invalid_client","error_description":"Invalid client"}`)), - }) - - _, err := client.searchArtists(context.TODO(), "U2", 10) - Expect(err).To(MatchError("spotify error(invalid_client): Invalid client")) - }) - }) - - Describe("authorize", func() { - It("returns an access_token on successful authorization", func() { - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{"access_token": "NEW_ACCESS_TOKEN","token_type": "Bearer","expires_in": 3600}`)), - }) - - token, err := client.authorize(context.TODO()) - Expect(err).To(BeNil()) - Expect(token).To(Equal("NEW_ACCESS_TOKEN")) - auth := httpClient.lastRequest.Header.Get("Authorization") - Expect(auth).To(Equal("Basic U1BPVElGWV9JRDpTUE9USUZZX1NFQ1JFVA==")) - }) - - It("fails on unsuccessful authorization", func() { - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 400, - Body: io.NopCloser(bytes.NewBufferString(`{"error":"invalid_client","error_description":"Invalid client"}`)), - }) - - _, err := client.authorize(context.TODO()) - Expect(err).To(MatchError("spotify error(invalid_client): Invalid client")) - }) - - It("fails on invalid JSON response", func() { - httpClient.mock("https://accounts.spotify.com/api/token", http.Response{ - StatusCode: 200, - Body: io.NopCloser(bytes.NewBufferString(`{NOT_VALID}`)), - }) - - _, err := client.authorize(context.TODO()) - Expect(err).To(MatchError("invalid character 'N' looking for beginning of object key string")) - }) - }) -}) - -type fakeHttpClient struct { - responses map[string]*http.Response - lastRequest *http.Request -} - -func (c *fakeHttpClient) mock(url string, response http.Response) { - if c.responses == nil { - c.responses = make(map[string]*http.Response) - } - c.responses[url] = &response -} - -func (c *fakeHttpClient) Do(req *http.Request) (*http.Response, error) { - c.lastRequest = req - u := req.URL - u.RawQuery = "" - if resp, ok := c.responses[u.String()]; ok { - return resp, nil - } - panic("URL not mocked: " + u.String()) -} diff --git a/core/agents/spotify/responses.go b/core/agents/spotify/responses.go deleted file mode 100644 index 21166bf74..000000000 --- a/core/agents/spotify/responses.go +++ /dev/null @@ -1,30 +0,0 @@ -package spotify - -type SearchResults struct { - Artists ArtistsResult `json:"artists"` -} - -type ArtistsResult struct { - HRef string `json:"href"` - Items []Artist `json:"items"` -} - -type Artist struct { - Genres []string `json:"genres"` - HRef string `json:"href"` - ID string `json:"id"` - Popularity int `json:"popularity"` - Images []Image `json:"images"` - Name string `json:"name"` -} - -type Image struct { - URL string `json:"url"` - Width int `json:"width"` - Height int `json:"height"` -} - -type Error struct { - Code string `json:"error"` - Message string `json:"error_description"` -} diff --git a/core/agents/spotify/responses_test.go b/core/agents/spotify/responses_test.go deleted file mode 100644 index 704119816..000000000 --- a/core/agents/spotify/responses_test.go +++ /dev/null @@ -1,48 +0,0 @@ -package spotify - -import ( - "encoding/json" - "os" - - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("Responses", func() { - Describe("Search type=artist", func() { - It("parses the artist search result correctly ", func() { - var resp SearchResults - body, _ := os.ReadFile("tests/fixtures/spotify.search.artist.json") - err := json.Unmarshal(body, &resp) - Expect(err).To(BeNil()) - - Expect(resp.Artists.Items).To(HaveLen(20)) - u2 := resp.Artists.Items[0] - Expect(u2.Name).To(Equal("U2")) - Expect(u2.Genres).To(ContainElements("irish rock", "permanent wave", "rock")) - Expect(u2.ID).To(Equal("51Blml2LZPmy7TTiAg47vQ")) - Expect(u2.HRef).To(Equal("https://api.spotify.com/v1/artists/51Blml2LZPmy7TTiAg47vQ")) - Expect(u2.Images[0].URL).To(Equal("https://i.scdn.co/image/e22d5c0c8139b8439440a69854ed66efae91112d")) - Expect(u2.Images[0].Width).To(Equal(640)) - Expect(u2.Images[0].Height).To(Equal(640)) - Expect(u2.Images[1].URL).To(Equal("https://i.scdn.co/image/40d6c5c14355cfc127b70da221233315497ec91d")) - Expect(u2.Images[1].Width).To(Equal(320)) - Expect(u2.Images[1].Height).To(Equal(320)) - Expect(u2.Images[2].URL).To(Equal("https://i.scdn.co/image/7293d6752ae8a64e34adee5086858e408185b534")) - Expect(u2.Images[2].Width).To(Equal(160)) - Expect(u2.Images[2].Height).To(Equal(160)) - }) - }) - - Describe("Error", func() { - It("parses the error response correctly", func() { - var errorResp Error - body := []byte(`{"error":"invalid_client","error_description":"Invalid client"}`) - err := json.Unmarshal(body, &errorResp) - Expect(err).To(BeNil()) - - Expect(errorResp.Code).To(Equal("invalid_client")) - Expect(errorResp.Message).To(Equal("Invalid client")) - }) - }) -}) diff --git a/core/agents/spotify/spotify.go b/core/agents/spotify/spotify.go deleted file mode 100644 index 633c32984..000000000 --- a/core/agents/spotify/spotify.go +++ /dev/null @@ -1,96 +0,0 @@ -package spotify - -import ( - "context" - "errors" - "fmt" - "net/http" - "sort" - "strings" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/agents" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/utils/cache" - "github.com/xrash/smetrics" -) - -const spotifyAgentName = "spotify" - -type spotifyAgent struct { - ds model.DataStore - id string - secret string - client *client -} - -func spotifyConstructor(ds model.DataStore) agents.Interface { - if conf.Server.Spotify.ID == "" || conf.Server.Spotify.Secret == "" { - return nil - } - l := &spotifyAgent{ - ds: ds, - id: conf.Server.Spotify.ID, - secret: conf.Server.Spotify.Secret, - } - hc := &http.Client{ - Timeout: consts.DefaultHttpClientTimeOut, - } - chc := cache.NewHTTPClient(hc, consts.DefaultHttpClientTimeOut) - l.client = newClient(l.id, l.secret, chc) - return l -} - -func (s *spotifyAgent) AgentName() string { - return spotifyAgentName -} - -func (s *spotifyAgent) GetArtistImages(ctx context.Context, id, name, mbid string) ([]agents.ExternalImage, error) { - a, err := s.searchArtist(ctx, name) - if err != nil { - if errors.Is(err, model.ErrNotFound) { - log.Warn(ctx, "Artist not found in Spotify", "artist", name) - } else { - log.Error(ctx, "Error calling Spotify", "artist", name, err) - } - return nil, err - } - - var res []agents.ExternalImage - for _, img := range a.Images { - res = append(res, agents.ExternalImage{ - URL: img.URL, - Size: img.Width, - }) - } - return res, nil -} - -func (s *spotifyAgent) searchArtist(ctx context.Context, name string) (*Artist, error) { - artists, err := s.client.searchArtists(ctx, name, 40) - if err != nil || len(artists) == 0 { - return nil, model.ErrNotFound - } - name = strings.ToLower(name) - - // Sort results, prioritizing artists with images, with similar names and with high popularity, in this order - sort.Slice(artists, func(i, j int) bool { - ai := fmt.Sprintf("%-5t-%03d-%04d", len(artists[i].Images) == 0, smetrics.WagnerFischer(name, strings.ToLower(artists[i].Name), 1, 1, 2), 1000-artists[i].Popularity) - aj := fmt.Sprintf("%-5t-%03d-%04d", len(artists[j].Images) == 0, smetrics.WagnerFischer(name, strings.ToLower(artists[j].Name), 1, 1, 2), 1000-artists[j].Popularity) - return ai < aj - }) - - // If the first one has the same name, that's the one - if strings.ToLower(artists[0].Name) != name { - return nil, model.ErrNotFound - } - return &artists[0], err -} - -func init() { - conf.AddHook(func() { - agents.Register(spotifyAgentName, spotifyConstructor) - }) -} diff --git a/core/archiver.go b/core/archiver.go index a15d0d713..5d1c090cd 100644 --- a/core/archiver.go +++ b/core/archiver.go @@ -3,6 +3,7 @@ package core import ( "archive/zip" "context" + "errors" "fmt" "io" "os" @@ -10,9 +11,11 @@ import ( "strings" "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/slice" + "github.com/navidrome/navidrome/utils/str" ) type Archiver interface { @@ -22,13 +25,13 @@ type Archiver interface { ZipPlaylist(ctx context.Context, id string, format string, bitrate int, w io.Writer) error } -func NewArchiver(ms MediaStreamer, ds model.DataStore, shares Share) Archiver { +func NewArchiver(ms stream.MediaStreamer, ds model.DataStore, shares Share) Archiver { return &archiver{ds: ds, ms: ms, shares: shares} } type archiver struct { ds model.DataStore - ms MediaStreamer + ms stream.MediaStreamer shares Share } @@ -58,7 +61,15 @@ func (a *archiver) zipAlbums(ctx context.Context, id string, format string, bitr "format", format, "bitrate", bitrate, "isMultiDisc", isMultiDisc, "numTracks", len(album)) for _, mf := range album { file := a.albumFilename(mf, format, isMultiDisc) - _ = a.addFileToZip(ctx, z, mf, format, bitrate, file) + if addErr := a.addFileToZip(ctx, z, mf, format, bitrate, file); errors.Is(addErr, stream.ErrTooManyTranscodes) { + // Stop iterating: continuing would just rack up more + // rejections from the limiter. Close finalises whatever + // tracks were already written; the rejected one is not + // present in the archive (addFileToZip aborts before + // writing its entry header). + _ = z.Close() + return addErr + } } } err = z.Close() @@ -86,7 +97,7 @@ func (a *archiver) albumFilename(mf model.MediaFile, format string, isMultiDisc if isMultiDisc { file = fmt.Sprintf("Disc %02d/%s", mf.DiscNumber, file) } - return fmt.Sprintf("%s/%s", sanitizeName(mf.Album), file) + return fmt.Sprintf("%s/%s", str.SanitizeFilename(mf.Album), file) } func (a *archiver) ZipShare(ctx context.Context, id string, out io.Writer) error { @@ -98,7 +109,7 @@ func (a *archiver) ZipShare(ctx context.Context, id string, out io.Writer) error return model.ErrNotAuthorized } log.Debug(ctx, "Zipping share", "name", s.ID, "format", s.Format, "bitrate", s.MaxBitRate, "numTracks", len(s.Tracks)) - return a.zipMediaFiles(ctx, id, s.Format, s.MaxBitRate, out, s.Tracks) + return a.zipMediaFiles(ctx, id, s.ID, s.Format, s.MaxBitRate, out, s.Tracks, false) } func (a *archiver) ZipPlaylist(ctx context.Context, id string, format string, bitrate int, out io.Writer) error { @@ -109,15 +120,45 @@ func (a *archiver) ZipPlaylist(ctx context.Context, id string, format string, bi } mfs := pls.MediaFiles() log.Debug(ctx, "Zipping playlist", "name", pls.Name, "format", format, "bitrate", bitrate, "numTracks", len(mfs)) - return a.zipMediaFiles(ctx, id, format, bitrate, out, mfs) + return a.zipMediaFiles(ctx, id, pls.Name, format, bitrate, out, mfs, true) } -func (a *archiver) zipMediaFiles(ctx context.Context, id string, format string, bitrate int, out io.Writer, mfs model.MediaFiles) error { +func (a *archiver) zipMediaFiles(ctx context.Context, id, name string, format string, bitrate int, out io.Writer, mfs model.MediaFiles, addM3U bool) error { z := createZipWriter(out, format, bitrate) + + zippedMfs := make(model.MediaFiles, len(mfs)) for idx, mf := range mfs { file := a.playlistFilename(mf, format, idx) - _ = a.addFileToZip(ctx, z, mf, format, bitrate, file) + if addErr := a.addFileToZip(ctx, z, mf, format, bitrate, file); errors.Is(addErr, stream.ErrTooManyTranscodes) { + // Abort the whole archive: continuing would silently emit + // empty zip entries since the headers are already written. + _ = z.Close() + return addErr + } + mf.Path = file + zippedMfs[idx] = mf } + + // Add M3U file if requested + if addM3U && len(zippedMfs) > 0 { + plsName := str.SanitizeFilename(name) + w, err := z.CreateHeader(&zip.FileHeader{ + Name: plsName + ".m3u", + Modified: mfs[0].UpdatedAt, + Method: zip.Store, + }) + if err != nil { + log.Error(ctx, "Error creating playlist zip entry", err) + return err + } + + _, err = w.Write([]byte(zippedMfs.ToM3U8(plsName, false))) + if err != nil { + log.Error(ctx, "Error writing m3u in zip", err) + return err + } + } + err := z.Close() if err != nil { log.Error(ctx, "Error closing zip file", "id", id, err) @@ -130,15 +171,32 @@ func (a *archiver) playlistFilename(mf model.MediaFile, format string, idx int) if format != "" && format != "raw" { ext = format } - return fmt.Sprintf("%02d - %s - %s.%s", idx+1, sanitizeName(mf.Artist), sanitizeName(mf.Title), ext) -} - -func sanitizeName(target string) string { - return strings.ReplaceAll(target, "/", "_") + return fmt.Sprintf("%02d - %s - %s.%s", idx+1, str.SanitizeFilename(mf.Artist), str.SanitizeFilename(mf.Title), ext) } func (a *archiver) addFileToZip(ctx context.Context, z *zip.Writer, mf model.MediaFile, format string, bitrate int, filename string) error { path := mf.AbsolutePath() + + // Open the source before writing the zip entry header so a rejection + // (limiter, missing file, etc.) does not leave an empty entry in the + // archive. + var r io.ReadCloser + var err error + if format != "raw" && format != "" { + r, err = a.ms.NewStream(ctx, &mf, stream.Request{Format: format, BitRate: bitrate}) + } else { + r, err = os.Open(path) + } + if err != nil { + log.Error(ctx, "Error opening file for zipping", "file", path, "format", format, err) + return err + } + defer func() { + if err := r.Close(); err != nil && log.IsGreaterOrEqualTo(log.LevelDebug) { + log.Error(ctx, "Error closing stream", "id", mf.ID, "file", path, err) + } + }() + w, err := z.CreateHeader(&zip.FileHeader{ Name: filename, Modified: mf.UpdatedAt, @@ -149,23 +207,6 @@ func (a *archiver) addFileToZip(ctx context.Context, z *zip.Writer, mf model.Med return err } - var r io.ReadCloser - if format != "raw" && format != "" { - r, err = a.ms.DoStream(ctx, &mf, format, bitrate, 0) - } else { - r, err = os.Open(path) - } - if err != nil { - log.Error(ctx, "Error opening file for zipping", "file", path, "format", format, err) - return err - } - - defer func() { - if err := r.Close(); err != nil && log.IsGreaterOrEqualTo(log.LevelDebug) { - log.Error(ctx, "Error closing stream", "id", mf.ID, "file", path, err) - } - }() - _, err = io.Copy(w, r) if err != nil { log.Error(ctx, "Error zipping file", "file", path, err) diff --git a/core/archiver_test.go b/core/archiver_test.go index f1db5520f..f432139d8 100644 --- a/core/archiver_test.go +++ b/core/archiver_test.go @@ -9,6 +9,7 @@ import ( "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/model" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -44,7 +45,7 @@ var _ = Describe("Archiver", func() { }}).Return(mfs, nil) ds.On("MediaFile", mock.Anything).Return(mfRepo) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(3) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(3) out := new(bytes.Buffer) err := arch.ZipAlbum(context.Background(), "1", "mp3", 128, out) @@ -73,7 +74,7 @@ var _ = Describe("Archiver", func() { }}).Return(mfs, nil) ds.On("MediaFile", mock.Anything).Return(mfRepo) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) out := new(bytes.Buffer) err := arch.ZipArtist(context.Background(), "1", "mp3", 128, out) @@ -88,6 +89,32 @@ var _ = Describe("Archiver", func() { }) }) + Context("when the transcode limiter rejects a file", func() { + It("aborts the archive instead of continuing with empty entries", func() { + mfs := model.MediaFiles{ + {Path: "test_data/01 - track1.mp3", Suffix: "mp3", AlbumID: "1", Album: "Album", DiscNumber: 1}, + {Path: "test_data/02 - track2.mp3", Suffix: "mp3", AlbumID: "1", Album: "Album", DiscNumber: 1}, + } + + mfRepo := &mockMediaFileRepository{} + mfRepo.On("GetAll", []model.QueryOptions{{ + Filters: squirrel.Eq{"album_id": "1"}, + Sort: "album", + }}).Return(mfs, nil) + ds.On("MediaFile", mock.Anything).Return(mfRepo) + + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}). + Return(nil, stream.ErrTooManyTranscodes).Once() + + out := new(bytes.Buffer) + err := arch.ZipAlbum(context.Background(), "1", "mp3", 128, out) + Expect(err).To(MatchError(stream.ErrTooManyTranscodes)) + // NewStream should only have been called once: the loop must bail + // out on the rejection instead of trying every remaining track. + ms.AssertNumberOfCalls(GinkgoT(), "NewStream", 1) + }) + }) + Context("ZipShare", func() { It("zips a share correctly", func() { mfs := model.MediaFiles{ @@ -104,7 +131,7 @@ var _ = Describe("Archiver", func() { } sh.On("Load", mock.Anything, "1").Return(share, nil) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) out := new(bytes.Buffer) err := arch.ZipShare(context.Background(), "1", out) @@ -136,7 +163,7 @@ var _ = Describe("Archiver", func() { plRepo := &mockPlaylistRepository{} plRepo.On("GetWithTracks", "1", true, false).Return(pls, nil) ds.On("Playlist", mock.Anything).Return(plRepo) - ms.On("DoStream", mock.Anything, mock.Anything, "mp3", 128, 0).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) + ms.On("NewStream", mock.Anything, mock.Anything, stream.Request{Format: "mp3", BitRate: 128}).Return(io.NopCloser(strings.NewReader("test")), nil).Times(2) out := new(bytes.Buffer) err := arch.ZipPlaylist(context.Background(), "1", "mp3", 128, out) @@ -145,9 +172,21 @@ var _ = Describe("Archiver", func() { zr, err := zip.NewReader(bytes.NewReader(out.Bytes()), int64(out.Len())) Expect(err).To(BeNil()) - Expect(len(zr.File)).To(Equal(2)) + Expect(len(zr.File)).To(Equal(3)) Expect(zr.File[0].Name).To(Equal("01 - AC_DC - track1.mp3")) Expect(zr.File[1].Name).To(Equal("02 - Artist 2 - track2.mp3")) + Expect(zr.File[2].Name).To(Equal("Test Playlist.m3u")) + + // Verify M3U content + m3uFile, err := zr.File[2].Open() + Expect(err).To(BeNil()) + defer m3uFile.Close() + + m3uContent, err := io.ReadAll(m3uFile) + Expect(err).To(BeNil()) + + expectedM3U := "#EXTM3U\n#PLAYLIST:Test Playlist\n#EXTINF:0,AC/DC - track1\n01 - AC_DC - track1.mp3\n#EXTINF:0,Artist 2 - track2\n02 - Artist 2 - track2.mp3\n" + Expect(string(m3uContent)).To(Equal(expectedM3U)) }) }) }) @@ -202,15 +241,15 @@ func (m *mockPlaylistRepository) GetWithTracks(id string, refreshSmartPlaylists, type mockMediaStreamer struct { mock.Mock - core.MediaStreamer + stream.MediaStreamer } -func (m *mockMediaStreamer) DoStream(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, reqOffset int) (*core.Stream, error) { - args := m.Called(ctx, mf, reqFormat, reqBitRate, reqOffset) +func (m *mockMediaStreamer) NewStream(ctx context.Context, mf *model.MediaFile, req stream.Request) (*stream.Stream, error) { + args := m.Called(ctx, mf, req) if args.Error(1) != nil { return nil, args.Error(1) } - return &core.Stream{ReadCloser: args.Get(0).(io.ReadCloser)}, nil + return &stream.Stream{ReadCloser: args.Get(0).(io.ReadCloser)}, nil } type mockShare struct { diff --git a/core/artwork/animation.go b/core/artwork/animation.go new file mode 100644 index 000000000..07f493eb4 --- /dev/null +++ b/core/artwork/animation.go @@ -0,0 +1,120 @@ +package artwork + +import ( + "bytes" + "encoding/binary" +) + +// isAnimatedGIF checks for multiple image descriptor blocks (0x2C) in a GIF file. +// Animated GIFs use GIF89a and contain multiple image blocks. +func isAnimatedGIF(data []byte) bool { + // GIF header: "GIF87a" or "GIF89a" + if !bytes.HasPrefix(data, []byte("GIF")) { + return false + } + + // Skip header (6 bytes) + logical screen descriptor (7 bytes) + pos := 13 + if pos >= len(data) { + return false + } + + // Skip Global Color Table if present (bit 7 of packed byte at offset 10) + if len(data) > 10 && data[10]&0x80 != 0 { + // GCT size = 3 * 2^(N+1) where N = bits 0-2 of packed byte + gctSize := 3 * (1 << ((data[10] & 0x07) + 1)) + pos += gctSize + } + + frameCount := 0 + for pos < len(data) { + switch data[pos] { + case 0x2C: // Image Descriptor - marks a frame + frameCount++ + if frameCount > 1 { + return true + } + pos++ // skip introducer + if pos+8 >= len(data) { + return false + } + pos += 8 // skip x, y, w, h (each 2 bytes) + packed := data[pos] + pos++ // skip packed byte + // Skip Local Color Table if present + if packed&0x80 != 0 { + lctSize := 3 * (1 << ((packed & 0x07) + 1)) + pos += lctSize + } + // Skip LZW minimum code size + pos++ + // Skip sub-blocks + pos = skipGIFSubBlocks(data, pos) + case 0x21: // Extension block + pos++ // skip introducer + if pos >= len(data) { + return false + } + pos++ // skip extension label + // Skip sub-blocks + pos = skipGIFSubBlocks(data, pos) + case 0x3B: // Trailer + return false + default: + // Unknown block, bail + return false + } + } + return false +} + +// skipGIFSubBlocks advances past a sequence of GIF sub-blocks (terminated by a zero-length block). +func skipGIFSubBlocks(data []byte, pos int) int { + for pos < len(data) { + blockSize := int(data[pos]) + pos++ // skip size byte + if blockSize == 0 { + break + } + pos += blockSize + } + return pos +} + +// isAnimatedWebP checks for ANMF (animation frame) chunks in a WebP RIFF container. +func isAnimatedWebP(data []byte) bool { + // WebP header: "RIFF" + 4 bytes size + "WEBP" + if !bytes.HasPrefix(data, []byte("RIFF")) || len(data) < 12 { + return false + } + if !bytes.Equal(data[8:12], []byte("WEBP")) { + return false + } + // Scan for ANMF chunk identifier + return bytes.Contains(data[12:], []byte("ANMF")) +} + +// isAnimatedPNG checks for the acTL (animation control) chunk in a PNG file. +// APNG files contain an acTL chunk that is not present in static PNGs. +func isAnimatedPNG(data []byte) bool { + // PNG signature: 8 bytes + pngSig := []byte{0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A} + if !bytes.HasPrefix(data, pngSig) { + return false + } + + // Scan chunks for "acTL" (animation control) + pos := uint64(8) + dataLen := uint64(len(data)) + for pos+8 <= dataLen { + chunkLen := uint64(binary.BigEndian.Uint32(data[pos : pos+4])) + chunkType := string(data[pos+4 : pos+8]) + + if chunkType == "acTL" { + return true + } + // Move to next chunk: 4 (length) + 4 (type) + chunkLen (data) + 4 (CRC) + pos += 12 + chunkLen + } + return false +} diff --git a/core/artwork/animation_test.go b/core/artwork/animation_test.go new file mode 100644 index 000000000..9000a8511 --- /dev/null +++ b/core/artwork/animation_test.go @@ -0,0 +1,161 @@ +package artwork + +import ( + "bytes" + "encoding/binary" + "image" + "image/color" + "image/gif" + "image/png" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Animation detection", func() { + Describe("isAnimatedGIF", func() { + It("detects an animated GIF with multiple frames", func() { + Expect(isAnimatedGIF(createAnimatedGIF(2))).To(BeTrue()) + }) + + It("detects an animated GIF with many frames", func() { + Expect(isAnimatedGIF(createAnimatedGIF(5))).To(BeTrue()) + }) + + It("does not flag a static GIF (single frame)", func() { + Expect(isAnimatedGIF(createAnimatedGIF(1))).To(BeFalse()) + }) + + It("returns false for non-GIF data", func() { + Expect(isAnimatedGIF(nil)).To(BeFalse()) + Expect(isAnimatedGIF([]byte{0xFF, 0xD8})).To(BeFalse()) + }) + }) + + Describe("isAnimatedWebP", func() { + It("detects an animated WebP with ANMF chunk", func() { + Expect(isAnimatedWebP(createAnimatedWebPBytes())).To(BeTrue()) + }) + + It("does not flag a static WebP (no ANMF chunk)", func() { + Expect(isAnimatedWebP(createStaticWebPBytes())).To(BeFalse()) + }) + + It("returns false for non-WebP data", func() { + Expect(isAnimatedWebP(nil)).To(BeFalse()) + Expect(isAnimatedWebP([]byte{0xFF, 0xD8})).To(BeFalse()) + }) + }) + + Describe("isAnimatedPNG", func() { + It("detects an APNG with acTL chunk", func() { + Expect(isAnimatedPNG(createAPNGBytes())).To(BeTrue()) + }) + + It("does not flag a static PNG (no acTL chunk)", func() { + Expect(isAnimatedPNG(createStaticPNGBytes())).To(BeFalse()) + }) + + It("returns false for non-PNG data", func() { + Expect(isAnimatedPNG(nil)).To(BeFalse()) + Expect(isAnimatedPNG([]byte{0xFF, 0xD8})).To(BeFalse()) + }) + }) +}) + +// createAnimatedGIF creates a minimal animated GIF with the given number of frames. +func createAnimatedGIF(frames int) []byte { + g := &gif.GIF{ + LoopCount: 0, + } + for range frames { + img := image.NewPaletted(image.Rect(0, 0, 2, 2), color.Palette{color.Black, color.White}) + g.Image = append(g.Image, img) + g.Delay = append(g.Delay, 10) + } + var buf bytes.Buffer + err := gif.EncodeAll(&buf, g) + if err != nil { + panic(err) + } + return buf.Bytes() +} + +// writeUint32LE appends a little-endian uint32 to the buffer. +func writeUint32LE(buf *bytes.Buffer, v uint32) { + b := make([]byte, 4) + binary.LittleEndian.PutUint32(b, v) + buf.Write(b) +} + +// writeUint32BE appends a big-endian uint32 to the buffer. +func writeUint32BE(buf *bytes.Buffer, v uint32) { + b := make([]byte, 4) + binary.BigEndian.PutUint32(b, v) + buf.Write(b) +} + +// createAnimatedWebPBytes creates a minimal RIFF/WEBP container with an ANMF chunk. +func createAnimatedWebPBytes() []byte { + var buf bytes.Buffer + buf.WriteString("RIFF") + writeUint32LE(&buf, 100) // file size placeholder + buf.WriteString("WEBP") + // VP8X chunk (extended format, required for animation) + buf.WriteString("VP8X") + writeUint32LE(&buf, 10) + buf.Write(make([]byte, 10)) + // ANIM chunk (animation parameters) + buf.WriteString("ANIM") + writeUint32LE(&buf, 6) + buf.Write(make([]byte, 6)) + // ANMF chunk (animation frame) + buf.WriteString("ANMF") + writeUint32LE(&buf, 16) + buf.Write(make([]byte, 16)) + return buf.Bytes() +} + +// createStaticWebPBytes creates a minimal RIFF/WEBP container without ANMF chunks. +func createStaticWebPBytes() []byte { + var buf bytes.Buffer + buf.WriteString("RIFF") + writeUint32LE(&buf, 20) // file size + buf.WriteString("WEBP") + // VP8 chunk (simple lossy format) + buf.WriteString("VP8 ") + writeUint32LE(&buf, 4) + buf.Write(make([]byte, 4)) + return buf.Bytes() +} + +// createAPNGBytes creates a minimal PNG with an acTL chunk (making it APNG). +func createAPNGBytes() []byte { + // Start with a real PNG + staticPNG := createStaticPNGBytes() + + // Insert an acTL chunk after the IHDR chunk. + // PNG structure: signature (8) + IHDR chunk (4 len + 4 type + 13 data + 4 crc = 25) + ihdrEnd := 8 + 25 + var buf bytes.Buffer + buf.Write(staticPNG[:ihdrEnd]) + // Write acTL chunk: length=8, type="acTL", data=num_frames(4)+num_plays(4), CRC=4 + writeUint32BE(&buf, 8) // chunk data length + buf.WriteString("acTL") + writeUint32BE(&buf, 2) // num_frames + writeUint32BE(&buf, 0) // num_plays (0 = infinite) + writeUint32BE(&buf, 0) // CRC placeholder + buf.Write(staticPNG[ihdrEnd:]) + return buf.Bytes() +} + +// createStaticPNGBytes creates a minimal valid static PNG. +func createStaticPNGBytes() []byte { + img := image.NewRGBA(image.Rect(0, 0, 2, 2)) + var buf bytes.Buffer + err := png.Encode(&buf, img) + if err != nil { + panic(err) + } + return buf.Bytes() +} diff --git a/core/artwork/artwork.go b/core/artwork/artwork.go index 2e92b24c8..b8c395c12 100644 --- a/core/artwork/artwork.go +++ b/core/artwork/artwork.go @@ -122,6 +122,10 @@ func (a *artwork) getArtworkReader(ctx context.Context, artID model.ArtworkID, s artReader, err = newMediafileArtworkReader(ctx, a, artID) case model.KindPlaylistArtwork: artReader, err = newPlaylistArtworkReader(ctx, a, artID) + case model.KindDiscArtwork: + artReader, err = newDiscArtworkReader(ctx, a, artID) + case model.KindRadioArtwork: + artReader, err = newRadioArtworkReader(ctx, a, artID) default: return nil, ErrUnavailable } diff --git a/core/artwork/artwork_internal_test.go b/core/artwork/artwork_internal_test.go index cfb7850bd..c95371959 100644 --- a/core/artwork/artwork_internal_test.go +++ b/core/artwork/artwork_internal_test.go @@ -9,7 +9,9 @@ import ( "io" "os" "path/filepath" + "time" + _ "github.com/gen2brain/webp" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" @@ -25,7 +27,7 @@ var _ = Describe("Artwork", func() { var ffmpeg *tests.MockFFmpeg var folderRepo *fakeFolderRepo ctx := log.NewContext(context.TODO()) - var alOnlyEmbed, alEmbedNotFound, alOnlyExternal, alExternalNotFound, alMultipleCovers model.Album + var alOnlyEmbed, alEmbedNotFound, alOnlyExternal, alExternalNotFound, alMultipleCovers, alSingleDisc model.Album var arMultipleCovers model.Artist var mfWithEmbed, mfAnotherWithEmbed, mfWithoutEmbed, mfCorruptedCover model.MediaFile @@ -35,14 +37,20 @@ var _ = Describe("Artwork", func() { conf.Server.CoverArtPriority = "folder.*, cover.*, embedded , front.*" folderRepo = &fakeFolderRepo{} + libRepo := &tests.MockLibraryRepo{} + repoRoot, _ := os.Getwd() + libRepo.SetData(model.Libraries{{ID: 0, Path: testFileLibPath(repoRoot)}}) ds = &tests.MockDataStore{ MockedTranscoding: &tests.MockTranscodingRepo{}, MockedFolder: folderRepo, + MockedLibrary: libRepo, } + // Paths use forward slashes because the scanner stores fs.FS-relative paths in the DB. alOnlyEmbed = model.Album{ID: "222", Name: "Only embed", EmbedArtPath: "tests/fixtures/artist/an-album/test.mp3", FolderIDs: []string{"f1"}} alEmbedNotFound = model.Album{ID: "333", Name: "Embed not found", EmbedArtPath: "tests/fixtures/NON_EXISTENT.mp3", FolderIDs: []string{"f1"}} - alOnlyExternal = model.Album{ID: "444", Name: "Only external", FolderIDs: []string{"f1"}} + alOnlyExternal = model.Album{ID: "444", Name: "Only external", FolderIDs: []string{"f1"}, Discs: model.Discs{1: "", 2: ""}} alExternalNotFound = model.Album{ID: "555", Name: "External not found", FolderIDs: []string{"f2"}} + alSingleDisc = model.Album{ID: "888", Name: "Single disc", FolderIDs: []string{"f1"}, Discs: model.Discs{1: ""}} arMultipleCovers = model.Artist{ID: "777", Name: "All options"} alMultipleCovers = model.Album{ ID: "666", @@ -142,13 +150,61 @@ var _ = Describe("Artwork", func() { Entry(nil, " embedded , front.* , cover.*,folder.*", "tests/fixtures/artist/an-album/test.mp3"), ) }) + Context("LastUpdated", func() { + // Regression test for #5377: LastUpdated feeds the HTTP Last-Modified header. + // It must return max(album.UpdatedAt, ImagesUpdatedAt) so browsers revalidate + // cached cover art when only the image file changes. + now := time.Now().Truncate(time.Second) + DescribeTable("returns the max of album.UpdatedAt and ImagesUpdatedAt", + func(albumUpdatedAt, imagesUpdatedAt, expected time.Time) { + album := model.Album{ID: "al1", UpdatedAt: albumUpdatedAt} + folderRepo.result = []model.Folder{{ImagesUpdatedAt: imagesUpdatedAt}} + ds.Album(ctx).(*tests.MockAlbumRepo).SetData(model.Albums{album}) + + ar, err := newAlbumArtworkReader(ctx, aw, album.CoverArtID(), nil) + Expect(err).ToNot(HaveOccurred()) + Expect(ar.LastUpdated()).To(Equal(expected)) + }, + Entry("album newer than images", now, now.Add(-1*time.Hour), now), + Entry("images newer than album", now.Add(-24*time.Hour), now.Add(-1*time.Hour), now.Add(-1*time.Hour)), + Entry("equal timestamps", now, now, now), + ) + }) + }) + Describe("discArtworkReader", func() { + Context("LastUpdated", func() { + // Regression test for #5377: same bug as albumArtworkReader — disc covers + // must also revalidate when the image file changes, not only when media files do. + now := time.Now().Truncate(time.Second) + DescribeTable("returns the max of album.UpdatedAt and ImagesUpdatedAt", + func(albumUpdatedAt, imagesUpdatedAt, expected time.Time) { + album := model.Album{ID: "al1", UpdatedAt: albumUpdatedAt} + folderRepo.result = []model.Folder{{ImagesUpdatedAt: imagesUpdatedAt}} + ds.Album(ctx).(*tests.MockAlbumRepo).SetData(model.Albums{album}) + ds.MediaFile(ctx).(*tests.MockMediaFileRepo).SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "al1", DiscNumber: 1, Path: "tests/fixtures/test.mp3"}, + }) + + artID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID("al1", 1), nil) + dr, err := newDiscArtworkReader(ctx, aw, artID) + Expect(err).ToNot(HaveOccurred()) + Expect(dr.LastUpdated()).To(Equal(expected)) + }, + Entry("album newer than images", now, now.Add(-1*time.Hour), now), + Entry("images newer than album", now.Add(-24*time.Hour), now.Add(-1*time.Hour), now.Add(-1*time.Hour)), + Entry("equal timestamps", now, now, now), + ) + }) }) Describe("artistArtworkReader", func() { Context("Multiple covers", func() { BeforeEach(func() { + repoRoot, err := os.Getwd() + Expect(err).ToNot(HaveOccurred()) folderRepo.result = []model.Folder{{ - Path: "tests/fixtures/artist/an-album", - ImageFiles: []string{"artist.png"}, + LibraryPath: testFileLibPath(repoRoot), + Path: "tests/fixtures/artist/an-album", + ImageFiles: []string{"artist.png"}, }} ds.Artist(ctx).(*tests.MockArtistRepo).SetData(model.Artists{ arMultipleCovers, @@ -167,7 +223,7 @@ var _ = Describe("Artwork", func() { Expect(err).ToNot(HaveOccurred()) _, path, err := aw.Reader(ctx) Expect(err).ToNot(HaveOccurred()) - Expect(path).To(Equal(expected)) + Expect(filepath.ToSlash(path)).To(HaveSuffix(expected)) }, Entry(nil, " folder.* , artist.*,album/artist.*", "tests/fixtures/artist/artist.jpg"), Entry(nil, "album/artist.*, folder.*,artist.*", "tests/fixtures/artist/an-album/artist.png"), @@ -190,6 +246,7 @@ var _ = Describe("Artwork", func() { ds.Album(ctx).(*tests.MockAlbumRepo).SetData(model.Albums{ alOnlyEmbed, alOnlyExternal, + alSingleDisc, }) ds.MediaFile(ctx).(*tests.MockMediaFileRepo).SetData(model.MediaFiles{ mfWithEmbed, @@ -233,8 +290,137 @@ var _ = Describe("Artwork", func() { Expect(err).ToNot(HaveOccurred()) Expect(path).To(Equal("al-444_0")) }) + It("falls back to disc cover art when media file has a disc number on a multi-disc album", func() { + mfWithDisc := model.MediaFile{ID: "46", Path: "tests/fixtures/test.ogg", AlbumID: "444", DiscNumber: 2} + Expect(ds.MediaFile(ctx).(*tests.MockMediaFileRepo).Put(&mfWithDisc)).To(Succeed()) + + aw, err := newMediafileArtworkReader(ctx, aw, model.MustParseArtworkID("mf-"+mfWithDisc.ID)) + Expect(err).ToNot(HaveOccurred()) + _, path, err := aw.Reader(ctx) + Expect(err).ToNot(HaveOccurred()) + // Should fall back to disc art, which itself falls back to album art + Expect(path).To(Equal("dc-444:2_0")) + }) + It("falls back to album cover art for single-disc albums even with a disc number", func() { + mfOnSingleDisc := model.MediaFile{ID: "47", Path: "tests/fixtures/test.ogg", AlbumID: "888", DiscNumber: 1} + Expect(ds.MediaFile(ctx).(*tests.MockMediaFileRepo).Put(&mfOnSingleDisc)).To(Succeed()) + + aw, err := newMediafileArtworkReader(ctx, aw, model.MustParseArtworkID("mf-"+mfOnSingleDisc.ID)) + Expect(err).ToNot(HaveOccurred()) + _, path, err := aw.Reader(ctx) + Expect(err).ToNot(HaveOccurred()) + // Single-disc album should skip disc art and go straight to album art + Expect(path).To(Equal("al-888_0")) + }) }) }) + Describe("playlistArtworkReader", func() { + Describe("findPlaylistSidecarPath", func() { + It("discovers sidecar image next to playlist file", func() { + tmpDir := GinkgoT().TempDir() + plsPath := filepath.Join(tmpDir, "MyPlaylist.m3u") + imgPath := filepath.Join(tmpDir, "MyPlaylist.jpg") + Expect(os.WriteFile(plsPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + result := findPlaylistSidecarPath(GinkgoT().Context(), plsPath) + Expect(result).To(Equal(imgPath)) + }) + + It("returns empty string when no sidecar image exists", func() { + tmpDir := GinkgoT().TempDir() + plsPath := filepath.Join(tmpDir, "MyPlaylist.m3u") + Expect(os.WriteFile(plsPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + + result := findPlaylistSidecarPath(GinkgoT().Context(), plsPath) + Expect(result).To(BeEmpty()) + }) + + It("returns empty string when playlist has no path", func() { + result := findPlaylistSidecarPath(GinkgoT().Context(), "") + Expect(result).To(BeEmpty()) + }) + + It("finds sidecar with different case base name", func() { + tmpDir := GinkgoT().TempDir() + plsPath := filepath.Join(tmpDir, "myplaylist.m3u") + imgPath := filepath.Join(tmpDir, "MyPlaylist.jpg") + Expect(os.WriteFile(plsPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + result := findPlaylistSidecarPath(GinkgoT().Context(), plsPath) + Expect(result).To(Equal(imgPath)) + }) + }) + + Describe("fromPlaylistExternalImage", func() { + It("opens local path from ExternalImageURL", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "cover.jpg") + Expect(os.WriteFile(imgPath, []byte("external image data"), 0600)).To(Succeed()) + + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: imgPath}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + data, _ := io.ReadAll(r) + Expect(string(data)).To(Equal("external image data")) + r.Close() + }) + + It("returns nil when ExternalImageURL is empty", func() { + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: ""}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + + It("returns error when local file does not exist", func() { + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: "/non/existent/path/cover.jpg"}, + } + r, _, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).To(HaveOccurred()) + Expect(r).To(BeNil()) + }) + + It("skips HTTP URL when EnableM3UExternalAlbumArt is false", func() { + conf.Server.EnableM3UExternalAlbumArt = false + + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: "https://example.com/cover.jpg"}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + + It("still opens local path when EnableM3UExternalAlbumArt is false", func() { + conf.Server.EnableM3UExternalAlbumArt = false + + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "cover.jpg") + Expect(os.WriteFile(imgPath, []byte("local image"), 0600)).To(Succeed()) + + reader := &playlistArtworkReader{ + pl: model.Playlist{ExternalImageURL: imgPath}, + } + r, path, err := reader.fromPlaylistExternalImage(ctx)() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + }) + Describe("resizedArtworkReader", func() { BeforeEach(func() { folderRepo.result = []model.Folder{{ @@ -246,7 +432,7 @@ var _ = Describe("Artwork", func() { }) }) When("Square is false", func() { - It("returns a PNG if original image is a PNG", func() { + It("returns PNG if original image is a PNG", func() { conf.Server.CoverArtPriority = "front.png" r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 15, false) Expect(err).ToNot(HaveOccurred()) @@ -257,7 +443,7 @@ var _ = Describe("Artwork", func() { Expect(img.Bounds().Size().X).To(Equal(15)) Expect(img.Bounds().Size().Y).To(Equal(15)) }) - It("returns a JPEG if original image is not a PNG", func() { + It("returns JPEG if original image is not a PNG", func() { conf.Server.CoverArtPriority = "cover.jpg" r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 200, false) Expect(err).ToNot(HaveOccurred()) @@ -273,15 +459,18 @@ var _ = Describe("Artwork", func() { var alCover model.Album DescribeTable("resize", - func(format string, landscape bool, size int) { - coverFileName := "cover." + format - dirName := createImage(format, landscape, size) + func(srcFormat string, expectedFormat string, landscape bool, size int) { + coverFileName := "cover." + srcFormat + dirName := createImage(srcFormat, landscape, size) alCover = model.Album{ ID: "444", Name: "Only external", FolderIDs: []string{"tmp"}, } - folderRepo.result = []model.Folder{{Path: dirName, ImageFiles: []string{coverFileName}}} + folderRepo.result = []model.Folder{{ImageFiles: []string{coverFileName}}} + rootLibRepo := &tests.MockLibraryRepo{} + rootLibRepo.SetData(model.Libraries{{ID: 0, Path: testFileLibPath(dirName)}}) + ds.(*tests.MockDataStore).MockedLibrary = rootLibRepo ds.Album(ctx).(*tests.MockAlbumRepo).SetData(model.Albums{ alCover, }) @@ -292,16 +481,127 @@ var _ = Describe("Artwork", func() { img, format, err := image.Decode(r) Expect(err).ToNot(HaveOccurred()) - Expect(format).To(Equal("png")) + Expect(format).To(Equal(expectedFormat)) Expect(img.Bounds().Size().X).To(Equal(size)) Expect(img.Bounds().Size().Y).To(Equal(size)) }, - Entry("portrait png image", "png", false, 200), - Entry("landscape png image", "png", true, 200), - Entry("portrait jpg image", "jpg", false, 200), - Entry("landscape jpg image", "jpg", true, 200), + Entry("portrait png image", "png", "png", false, 200), + Entry("landscape png image", "png", "png", true, 200), + Entry("portrait jpg image", "jpg", "png", false, 200), + Entry("landscape jpg image", "jpg", "png", true, 200), ) }) + When("EnableWebPEncoding is true and square is false", func() { + BeforeEach(func() { + conf.Server.EnableWebPEncoding = true + }) + It("returns WebP even if original image is a PNG", func() { + conf.Server.CoverArtPriority = "front.png" + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 15, false) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + Expect(format).To(Equal("webp")) + Expect(img.Bounds().Size().X).To(Equal(15)) + Expect(img.Bounds().Size().Y).To(Equal(15)) + }) + It("returns WebP if original image is not a PNG", func() { + conf.Server.CoverArtPriority = "cover.jpg" + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 200, false) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(format).To(Equal("webp")) + Expect(err).ToNot(HaveOccurred()) + Expect(img.Bounds().Size().X).To(Equal(200)) + Expect(img.Bounds().Size().Y).To(Equal(200)) + }) + }) + When("EnableWebPEncoding is false and square is false", func() { + BeforeEach(func() { + conf.Server.EnableWebPEncoding = false + }) + It("returns PNG if original image is a PNG", func() { + conf.Server.CoverArtPriority = "front.png" + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 15, false) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + Expect(format).To(Equal("png")) + Expect(img.Bounds().Size().X).To(Equal(15)) + Expect(img.Bounds().Size().Y).To(Equal(15)) + }) + It("returns JPEG if original image is a JPG", func() { + conf.Server.CoverArtPriority = "cover.jpg" + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 200, false) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + Expect(format).To(Equal("jpeg")) + Expect(img.Bounds().Size().X).To(Equal(200)) + Expect(img.Bounds().Size().Y).To(Equal(200)) + }) + }) + When("EnableWebPEncoding is false and square is true", func() { + var alCover model.Album + + BeforeEach(func() { + conf.Server.EnableWebPEncoding = false + }) + It("returns PNG for square mode", func() { + dirName := createImage("png", false, 200) + alCover = model.Album{ + ID: "444", + Name: "Only external", + FolderIDs: []string{"tmp"}, + } + folderRepo.result = []model.Folder{{ImageFiles: []string{"cover.png"}}} + rootLibRepo := &tests.MockLibraryRepo{} + rootLibRepo.SetData(model.Libraries{{ID: 0, Path: testFileLibPath(dirName)}}) + ds.(*tests.MockDataStore).MockedLibrary = rootLibRepo + ds.Album(ctx).(*tests.MockAlbumRepo).SetData(model.Albums{alCover}) + + conf.Server.CoverArtPriority = "cover.png" + r, _, err := aw.Get(context.Background(), alCover.CoverArtID(), 200, true) + Expect(err).ToNot(HaveOccurred()) + + img, format, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + Expect(format).To(Equal("png")) + Expect(img.Bounds().Size().X).To(Equal(200)) + Expect(img.Bounds().Size().Y).To(Equal(200)) + }) + }) + When("Requested size is larger than original", func() { + It("clamps size to original dimensions", func() { + conf.Server.CoverArtPriority = "front.png" + // front.png is 16x16, requesting 99999 should return at original size + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 99999, false) + Expect(err).ToNot(HaveOccurred()) + + img, _, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + // Should be clamped to original size (16), not 99999 + Expect(img.Bounds().Size().X).To(Equal(16)) + Expect(img.Bounds().Size().Y).To(Equal(16)) + }) + + It("clamps square size to original dimensions", func() { + conf.Server.CoverArtPriority = "front.png" + // front.png is 16x16, requesting 99999 with square should return 16x16 square + r, _, err := aw.Get(context.Background(), alMultipleCovers.CoverArtID(), 99999, true) + Expect(err).ToNot(HaveOccurred()) + + img, _, err := image.Decode(r) + Expect(err).ToNot(HaveOccurred()) + // Should be clamped to original size (16), not 99999 + Expect(img.Bounds().Size().X).To(Equal(16)) + Expect(img.Bounds().Size().Y).To(Equal(16)) + }) + }) }) }) diff --git a/core/artwork/artwork_suite_test.go b/core/artwork/artwork_suite_test.go index dfd66e5e5..d42d7f3e4 100644 --- a/core/artwork/artwork_suite_test.go +++ b/core/artwork/artwork_suite_test.go @@ -1,9 +1,17 @@ package artwork import ( + "io/fs" + "net/url" + "os" + "path/filepath" + "runtime" + "strings" "testing" + "github.com/navidrome/navidrome/core/storage" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model/metadata" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -15,3 +23,49 @@ func TestArtwork(t *testing.T) { RegisterFailHandler(Fail) RunSpecs(t, "Artwork Suite") } + +// osDirFS wraps os.DirFS as a storage.MusicFS for integration tests. +// ReadTags is not used by albumArtworkReader, so it is left as a stub. +type osDirFS struct{ fs.FS } + +func (o osDirFS) ReadTags(...string) (map[string]metadata.Info, error) { return nil, nil } + +// testFileScheme is the URL scheme registered to expose a tempdir as a +// storage.MusicFS for artwork integration tests. +const testFileScheme = "testfile" + +// testFileLibPath builds a `testfile://` library URL for the given absolute +// filesystem path. On Windows, the native path (e.g. `C:\foo`) has no leading +// slash after ToSlash, which makes url.Parse treat the drive letter as a +// host. We prepend a `/` so parsing yields `u.Path == /C:/foo`, and the +// registered constructor below strips that leading slash back off. +func testFileLibPath(absPath string) string { + p := filepath.ToSlash(absPath) + if !strings.HasPrefix(p, "/") { + p = "/" + p + } + return testFileScheme + "://" + p +} + +func init() { + // Register the testfile storage scheme (os.DirFS-backed MusicFS). Used by + // integration tests that need real files but not the taglib extractor. + storage.Register(testFileScheme, func(u url.URL) storage.Storage { + root := u.Path + // Undo the leading slash added by testFileLibPath on Windows so that + // os.Stat / os.DirFS receive a native path like `C:\foo`. + if runtime.GOOS == "windows" && len(root) >= 3 && root[0] == '/' && root[2] == ':' { + root = root[1:] + } + return &osDirStorage{root: filepath.FromSlash(root)} + }) +} + +type osDirStorage struct{ root string } + +func (s *osDirStorage) FS() (storage.MusicFS, error) { + if _, err := os.Stat(s.root); err != nil { + return nil, err + } + return osDirFS{os.DirFS(s.root)}, nil +} diff --git a/core/artwork/benchmark_decode_test.go b/core/artwork/benchmark_decode_test.go new file mode 100644 index 000000000..cfbfe5605 --- /dev/null +++ b/core/artwork/benchmark_decode_test.go @@ -0,0 +1,37 @@ +package artwork + +import ( + "bytes" + "fmt" + "image" + _ "image/jpeg" + _ "image/png" + "testing" +) + +func BenchmarkImageDecode(b *testing.B) { + sizes := []int{300, 1000, 3000} + formats := []struct { + name string + gen func(tb testing.TB, w, h int) []byte + }{ + {"jpeg", func(tb testing.TB, w, h int) []byte { return generateJPEG(tb, w, h, 75) }}, + {"png", func(tb testing.TB, w, h int) []byte { return generatePNG(tb, w, h) }}, + } + + for _, format := range formats { + for _, size := range sizes { + data := format.gen(b, size, size) + b.Run(fmt.Sprintf("%s/%dx%d", format.name, size, size), func(b *testing.B) { + b.SetBytes(int64(len(data))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + _, _, err := image.Decode(bytes.NewReader(data)) + if err != nil { + b.Fatal(err) + } + } + }) + } + } +} diff --git a/core/artwork/benchmark_e2e_test.go b/core/artwork/benchmark_e2e_test.go new file mode 100644 index 000000000..bf3d435a8 --- /dev/null +++ b/core/artwork/benchmark_e2e_test.go @@ -0,0 +1,189 @@ +package artwork + +import ( + "context" + "fmt" + "image/jpeg" + "io" + "os" + "path/filepath" + "runtime" + "sync" + "testing" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + "github.com/navidrome/navidrome/utils/cache" +) + +// setupE2EBenchmark creates an artwork instance with a real album cover image on disk, +// backed by either a real file cache or disabled cache depending on cacheSize. +// Note: This benchmarks artwork.Get() directly (not the full HTTP handler), which covers +// the critical path (source selection, decode, resize, encode, cache). This is a deliberate +// spec deviation — the full HTTP round-trip benchmark requires significant infrastructure +// (DB, scanner, fake filesystem) and can be added later if HTTP overhead proves significant. +// +// Depends on fakeFolderRepo defined in reader_artist_test.go (same package, compiled together). +func setupE2EBenchmark(b *testing.B, cacheSize string) (Artwork, model.ArtworkID, func()) { + b.Helper() + cleanup := configtest.SetupConfig() + b.Cleanup(cleanup) + + tmpDir, err := os.MkdirTemp("", "artwork-bench-*") + if err != nil { + b.Fatal(err) + } + + // Create a realistic cover image on disk + coverPath := filepath.Join(tmpDir, "cover.jpg") + coverImg := generateGradientImage(1000, 1000) + f, err := os.Create(coverPath) + if err != nil { + b.Fatal(err) + } + if err := jpeg.Encode(f, coverImg, &jpeg.Options{Quality: 90}); err != nil { + f.Close() + b.Fatal(err) + } + f.Close() + + // Configure cache + conf.Server.ImageCacheSize = cacheSize + conf.Server.CacheFolder = conf.NewDir(tmpDir) + conf.Server.CoverArtQuality = 75 + conf.Server.CoverArtPriority = "cover.*" + + // Set up mock data store with album pointing to our cover. + // Set UpdatedAt so CoverArtID().LastUpdate is consistent across calls. + album := model.Album{ + ID: "bench-album-1", + Name: "Benchmark Album", + FolderIDs: []string{"f1"}, + UpdatedAt: time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC), + } + folderRepo := &fakeFolderRepo{ + result: []model.Folder{{ + Path: tmpDir, + ImageFiles: []string{"cover.jpg"}, + }}, + } + ds := &tests.MockDataStore{ + MockedTranscoding: &tests.MockTranscodingRepo{}, + MockedFolder: folderRepo, + } + ds.Album(context.Background()).(*tests.MockAlbumRepo).SetData(model.Albums{album}) + + artID := album.CoverArtID() + + imgCache := cache.NewFileCache("BenchImage", cacheSize, "bench-images", 0, + func(ctx context.Context, arg cache.Item) (io.Reader, error) { + r, _, err := arg.(artworkReader).Reader(ctx) + return r, err + }) + + // Wait for cache init if enabled + if cacheSize != "0" { + for !imgCache.Available(context.Background()) && !imgCache.Disabled(context.Background()) { + runtime.Gosched() // Yield to allow background init goroutine to run + } + } + + ffmpeg := tests.NewMockFFmpeg("fallback content") + aw := NewArtwork(ds, imgCache, ffmpeg, nil) + + cleanupAll := func() { + os.RemoveAll(tmpDir) + } + return aw, artID, cleanupAll +} + +func BenchmarkArtworkGetE2E(b *testing.B) { + cacheConfigs := []struct { + name string + cacheSize string + }{ + {"no_cache", "0"}, + {"with_cache", "100MB"}, + } + sizes := []int{0, 300} + + for _, cc := range cacheConfigs { + for _, size := range sizes { + b.Run(fmt.Sprintf("%s/size_%d", cc.name, size), func(b *testing.B) { + aw, artID, cleanup := setupE2EBenchmark(b, cc.cacheSize) + defer cleanup() + + // Warm the cache on first call if cache is enabled + if cc.cacheSize != "0" { + r, _, err := aw.Get(context.Background(), artID, size, size > 0) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(r) + r.Close() + } + + b.ResetTimer() + for i := 0; i < b.N; i++ { + r, _, err := aw.Get(context.Background(), artID, size, size > 0) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(r) + r.Close() + } + }) + } + } +} + +func BenchmarkArtworkGetE2EConcurrent(b *testing.B) { + cacheConfigs := []struct { + name string + cacheSize string + }{ + {"no_cache", "0"}, + {"with_cache", "100MB"}, + } + concurrencyLevels := []int{10, 50} + + for _, cc := range cacheConfigs { + for _, n := range concurrencyLevels { + b.Run(fmt.Sprintf("%s/goroutines_%d", cc.name, n), func(b *testing.B) { + aw, artID, cleanup := setupE2EBenchmark(b, cc.cacheSize) + defer cleanup() + + // Warm cache + if cc.cacheSize != "0" { + r, _, _ := aw.Get(context.Background(), artID, 300, true) + if r != nil { + _, _ = io.ReadAll(r) + r.Close() + } + } + + b.ResetTimer() + for i := 0; i < b.N; i++ { + var wg sync.WaitGroup + wg.Add(n) + for range n { + go func() { + defer wg.Done() + r, _, err := aw.Get(context.Background(), artID, 300, true) + if err != nil { + b.Error(err) + return + } + _, _ = io.ReadAll(r) + r.Close() + }() + } + wg.Wait() + } + }) + } + } +} diff --git a/core/artwork/benchmark_encode_test.go b/core/artwork/benchmark_encode_test.go new file mode 100644 index 000000000..d8ab858f5 --- /dev/null +++ b/core/artwork/benchmark_encode_test.go @@ -0,0 +1,40 @@ +package artwork + +import ( + "bytes" + "fmt" + "image/jpeg" + "image/png" + "testing" +) + +func BenchmarkImageEncode(b *testing.B) { + img := generateGradientImage(300, 300) + + jpegQualities := []int{60, 75, 90} + for _, q := range jpegQualities { + b.Run(fmt.Sprintf("jpeg/q%d/300x300", q), func(b *testing.B) { + var buf bytes.Buffer + b.ResetTimer() + for i := 0; i < b.N; i++ { + buf.Reset() + if err := jpeg.Encode(&buf, img, &jpeg.Options{Quality: q}); err != nil { + b.Fatal(err) + } + } + b.ReportMetric(float64(buf.Len()), "bytes") + }) + } + + b.Run("png/300x300", func(b *testing.B) { + var buf bytes.Buffer + b.ResetTimer() + for i := 0; i < b.N; i++ { + buf.Reset() + if err := png.Encode(&buf, img); err != nil { + b.Fatal(err) + } + } + b.ReportMetric(float64(buf.Len()), "bytes") + }) +} diff --git a/core/artwork/benchmark_helpers_test.go b/core/artwork/benchmark_helpers_test.go new file mode 100644 index 000000000..0076506f3 --- /dev/null +++ b/core/artwork/benchmark_helpers_test.go @@ -0,0 +1,47 @@ +package artwork + +import ( + "bytes" + "image" + "image/color" + "image/jpeg" + "image/png" + "testing" +) + +// generateJPEG creates a JPEG image of the given dimensions with a gradient pattern. +// The gradient ensures the image has realistic entropy (not trivially compressible). +func generateJPEG(t testing.TB, width, height, quality int) []byte { + t.Helper() + img := generateGradientImage(width, height) + var buf bytes.Buffer + if err := jpeg.Encode(&buf, img, &jpeg.Options{Quality: quality}); err != nil { + t.Fatal(err) + } + return buf.Bytes() +} + +// generatePNG creates a PNG image of the given dimensions with a gradient pattern. +func generatePNG(t testing.TB, width, height int) []byte { + t.Helper() + img := generateGradientImage(width, height) + var buf bytes.Buffer + if err := png.Encode(&buf, img); err != nil { + t.Fatal(err) + } + return buf.Bytes() +} + +// generateGradientImage creates an RGBA image with a diagonal gradient pattern. +func generateGradientImage(width, height int) *image.RGBA { + img := image.NewRGBA(image.Rect(0, 0, width, height)) + for y := range height { + for x := range width { + r := uint8((x * 255) / width) + g := uint8((y * 255) / height) + b := uint8(((x + y) * 255) / (width + height)) + img.Set(x, y, color.RGBA{R: r, G: g, B: b, A: 255}) + } + } + return img +} diff --git a/core/artwork/benchmark_pipeline_test.go b/core/artwork/benchmark_pipeline_test.go new file mode 100644 index 000000000..23d5954df --- /dev/null +++ b/core/artwork/benchmark_pipeline_test.go @@ -0,0 +1,50 @@ +package artwork + +import ( + "fmt" + "testing" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" +) + +func BenchmarkResizeFullPipeline(b *testing.B) { + cleanup := configtest.SetupConfig() + b.Cleanup(cleanup) + conf.Server.CoverArtQuality = 75 + + sourceSizes := []int{1000, 3000} + targetSize := 300 + + for _, srcSize := range sourceSizes { + jpegData := generateJPEG(b, srcSize, srcSize, 90) + + b.Run(fmt.Sprintf("jpeg/%dx%d_to_%d", srcSize, srcSize, targetSize), func(b *testing.B) { + b.SetBytes(int64(len(jpegData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + result, _, err := resizeStaticImage(jpegData, targetSize, false) + if err != nil { + b.Fatal(err) + } + if result == nil { + b.Fatal("expected non-nil resized image") + } + } + }) + + b.Run(fmt.Sprintf("jpeg/%dx%d_to_%d_square", srcSize, srcSize, targetSize), func(b *testing.B) { + b.SetBytes(int64(len(jpegData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + result, _, err := resizeStaticImage(jpegData, targetSize, true) + if err != nil { + b.Fatal(err) + } + if result == nil { + b.Fatal("expected non-nil resized image") + } + } + }) + } +} diff --git a/core/artwork/benchmark_tag_test.go b/core/artwork/benchmark_tag_test.go new file mode 100644 index 000000000..fd649beab --- /dev/null +++ b/core/artwork/benchmark_tag_test.go @@ -0,0 +1,38 @@ +package artwork + +import ( + "path/filepath" + "runtime" + "testing" + + "go.senan.xyz/taglib" +) + +func BenchmarkTagExtraction(b *testing.B) { + // Ensure working directory is the project root (tests.Init not called with -run='^$') + _, file, _, ok := runtime.Caller(0) + if !ok { + b.Fatal("runtime.Caller failed") + } + appPath, _ := filepath.Abs(filepath.Join(filepath.Dir(file), "..", "..")) + + // Use existing test fixture with embedded artwork + testFile := filepath.Join(appPath, "tests/fixtures/artist/an-album/test.mp3") + + b.ResetTimer() + for i := 0; i < b.N; i++ { + f, err := taglib.OpenReadOnly(testFile, taglib.WithReadStyle(taglib.ReadStyleFast)) + if err != nil { + b.Fatal(err) + } + images := f.Properties().Images + if len(images) == 0 { + b.Fatal("no images found in test file") + } + data, err := f.Image(0) + if err != nil || len(data) == 0 { + b.Fatal("failed to extract image data") + } + f.Close() + } +} diff --git a/core/artwork/cache_warmer.go b/core/artwork/cache_warmer.go index 2e60ca00b..5090d638e 100644 --- a/core/artwork/cache_warmer.go +++ b/core/artwork/cache_warmer.go @@ -10,7 +10,6 @@ import ( "time" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" @@ -24,7 +23,7 @@ type CacheWarmer interface { // NewCacheWarmer creates a new CacheWarmer instance. The CacheWarmer will pre-cache Artwork images in the background // to speed up the response time when the image is requested by the UI. The cache is pre-populated with the original -// image size, as well as the size defined in the UICoverArtSize constant. +// image size, as well as the size defined by the UICoverArtSize config option. func NewCacheWarmer(artwork Artwork, cache cache.FileCache) CacheWarmer { // If image cache is disabled, return a NOOP implementation if conf.Server.ImageCacheSize == "0" || !conf.Server.EnableArtworkPrecache { @@ -38,10 +37,11 @@ func NewCacheWarmer(artwork Artwork, cache cache.FileCache) CacheWarmer { } a := &cacheWarmer{ - artwork: artwork, - cache: cache, - buffer: make(map[model.ArtworkID]struct{}), - wakeSignal: make(chan struct{}, 1), + artwork: artwork, + cache: cache, + buffer: make(map[model.ArtworkID]struct{}), + wakeSignal: make(chan struct{}, 1), + coverArtSize: conf.Server.UICoverArtSize, } // Create a context with a fake admin user, to be able to pre-cache Playlist CoverArts @@ -51,11 +51,12 @@ func NewCacheWarmer(artwork Artwork, cache cache.FileCache) CacheWarmer { } type cacheWarmer struct { - artwork Artwork - buffer map[model.ArtworkID]struct{} - mutex sync.Mutex - cache cache.FileCache - wakeSignal chan struct{} + artwork Artwork + buffer map[model.ArtworkID]struct{} + mutex sync.Mutex + cache cache.FileCache + wakeSignal chan struct{} + coverArtSize int } func (a *cacheWarmer) PreCache(artID model.ArtworkID) { @@ -96,8 +97,11 @@ func (a *cacheWarmer) run(ctx context.Context) { // If cache not available, keep waiting if !a.cache.Available(ctx) { - if len(a.buffer) > 0 { - log.Trace(ctx, "Cache not available, buffering precache request", "bufferLen", len(a.buffer)) + a.mutex.Lock() + bufferLen := len(a.buffer) + a.mutex.Unlock() + if bufferLen > 0 { + log.Trace(ctx, "Cache not available, buffering precache request", "bufferLen", bufferLen) } continue } @@ -129,7 +133,7 @@ func (a *cacheWarmer) waitSignal(ctx context.Context, timeout time.Duration) { func (a *cacheWarmer) processBatch(ctx context.Context, batch []model.ArtworkID) { log.Trace(ctx, "PreCaching a new batch of artwork", "batchSize", len(batch)) input := pl.FromSlice(ctx, batch) - errs := pl.Sink(ctx, 2, input, a.doCacheImage) + errs := pl.Sink(ctx, 4, input, a.doCacheImage) for err := range errs { log.Debug(ctx, "Error warming cache", err) } @@ -139,16 +143,14 @@ func (a *cacheWarmer) doCacheImage(ctx context.Context, id model.ArtworkID) erro ctx, cancel := context.WithTimeout(ctx, 10*time.Second) defer cancel() - r, _, err := a.artwork.Get(ctx, id, consts.UICoverArtSize, true) + size := a.coverArtSize + r, _, err := a.artwork.Get(ctx, id, size, true) if err != nil { - return fmt.Errorf("caching id='%s': %w", id, err) + return fmt.Errorf("caching id='%s', size=%d: %w", id, size, err) } - defer r.Close() _, err = io.Copy(io.Discard, r) - if err != nil { - return err - } - return nil + r.Close() + return err } func NoopCacheWarmer() CacheWarmer { diff --git a/core/artwork/cache_warmer_test.go b/core/artwork/cache_warmer_test.go index d35fb6e82..a5da2004c 100644 --- a/core/artwork/cache_warmer_test.go +++ b/core/artwork/cache_warmer_test.go @@ -6,6 +6,7 @@ import ( "fmt" "io" "strings" + "sync" "sync/atomic" "time" @@ -80,6 +81,7 @@ var _ = Describe("CacheWarmer", func() { }) It("adds multiple items to buffer", func() { + fc.SetReady(false) // Make cache unavailable so items stay in buffer cw := NewCacheWarmer(aw, fc).(*cacheWarmer) cw.PreCache(model.MustParseArtworkID("al-1")) cw.PreCache(model.MustParseArtworkID("al-2")) @@ -89,6 +91,7 @@ var _ = Describe("CacheWarmer", func() { }) It("deduplicates items in buffer", func() { + fc.SetReady(false) // Make cache unavailable so items stay in buffer cw := NewCacheWarmer(aw, fc).(*cacheWarmer) cw.PreCache(model.MustParseArtworkID("al-1")) cw.PreCache(model.MustParseArtworkID("al-1")) @@ -141,7 +144,7 @@ var _ = Describe("CacheWarmer", func() { It("processes items in batches", func() { cw := NewCacheWarmer(aw, fc).(*cacheWarmer) - for i := 0; i < 5; i++ { + for i := range 5 { cw.PreCache(model.MustParseArtworkID(fmt.Sprintf("al-%d", i))) } @@ -171,20 +174,42 @@ var _ = Describe("CacheWarmer", func() { return len(cw.buffer) }).Should(Equal(0)) }) + + It("pre-caches UICoverArtSize", func() { + cw := NewCacheWarmer(aw, fc).(*cacheWarmer) + cw.PreCache(model.MustParseArtworkID("al-1")) + + Eventually(func() []int { + return aw.getCachedSizes() + }).Should(ContainElements(conf.Server.UICoverArtSize)) + }) }) }) type mockArtwork struct { - err error + err error + mu sync.Mutex + cachedSizes []int } func (m *mockArtwork) Get(ctx context.Context, artID model.ArtworkID, size int, square bool) (io.ReadCloser, time.Time, error) { if m.err != nil { return nil, time.Time{}, m.err } + m.mu.Lock() + m.cachedSizes = append(m.cachedSizes, size) + m.mu.Unlock() return io.NopCloser(strings.NewReader("test")), time.Now(), nil } +func (m *mockArtwork) getCachedSizes() []int { + m.mu.Lock() + defer m.mu.Unlock() + result := make([]int, len(m.cachedSizes)) + copy(result, m.cachedSizes) + return result +} + func (m *mockArtwork) GetOrPlaceholder(ctx context.Context, id string, size int, square bool) (io.ReadCloser, time.Time, error) { return m.Get(ctx, model.ArtworkID{}, size, square) } @@ -214,3 +239,7 @@ func (f *mockFileCache) SetDisabled(v bool) { f.disabled.Store(v) f.ready.Store(true) } + +func (f *mockFileCache) SetReady(v bool) { + f.ready.Store(v) +} diff --git a/core/artwork/e2e/album_test.go b/core/artwork/e2e/album_test.go new file mode 100644 index 000000000..e765e1b1b --- /dev/null +++ b/core/artwork/e2e/album_test.go @@ -0,0 +1,377 @@ +package artworke2e_test + +import ( + "testing/fstest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +const ( + defaultCoverPriority = "cover.*, folder.*, front.*, embedded, external" + defaultDiscPriority = "disc*.*, cd*.*, cover.*, folder.*, front.*, discsubtitle, embedded" +) + +var _ = Describe("Album artwork resolution", func() { + BeforeEach(func() { + setupHarness() + }) + + When("an album has a single folder with cover.jpg at the album root", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── cover.jpg ← matched by cover.* + It("returns the album-root cover", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("album-root"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root"))) + }) + }) + + // https://github.com/navidrome/navidrome/issues/5376 + // cover.* basenames tie across album-root and per-disc folders; + // compareImageFiles must prefer shallower paths. + When("a multi-disc album has a cover.jpg at the album root and per-disc covers", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── cover.jpg ← should not win + // ├── CD2/ + // │ ├── 01 - Track.mp3 + // │ └── cover.jpg + // └── cover.jpg ← should win (album-root fallback) + It("prefers the album-root cover over per-disc covers", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "Track CD1"), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "Track CD2"), + "Artist/Album/cover.jpg": imageFile("album-root"), + "Artist/Album/CD1/cover.jpg": imageFile("disc1"), + "Artist/Album/CD2/cover.jpg": imageFile("disc2"), + }) + scan() + + al := firstAlbum() + Expect(al.FolderIDs).To(HaveLen(2), + "sanity check: scanner should treat the two disc subfolders as one multi-disc album") + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root"))) + }) + }) + + // https://github.com/navidrome/navidrome/issues/5376 + // folder.jpg basenames tie across album-root and per-disc folders; + // compareImageFiles must prefer shallower paths. + When("a multi-disc album has folder.jpg at the album root AND in each disc subfolder", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg ← should not win + // ├── CD2/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg + // └── folder.jpg ← should win (album-root fallback) + It("prefers the album-root folder.jpg over per-disc folder.jpg", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "Track CD1"), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "Track CD2"), + "Artist/Album/folder.jpg": imageFile("album-root"), + "Artist/Album/CD1/folder.jpg": imageFile("disc1"), + "Artist/Album/CD2/folder.jpg": imageFile("disc2"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root"))) + }) + }) + + // https://github.com/navidrome/navidrome/issues/5376 + // Single-subfolder albums must still consider the parent folder's images. + When("an album lives entirely under a single disc subfolder with cover.jpg at the parent", func() { + // Artist/ + // └── Album/ + // ├── disc1/ + // │ └── 01 - Track.mp3 + // └── cover.jpg ← should win (parent-folder fallback) + It("uses the parent-folder cover for single-disc-subfolder albums", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/disc1/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("album-root"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root"))) + }) + }) + + // https://github.com/navidrome/navidrome/issues/5456 + When("a top-level multi-disc album has cover.jpg at the album root and per-disc folder.jpg", func() { + // Album/ (top-level folder, Path=".") + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg + // ├── CD2/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg + // └── cover.jpg ← should win (album-root) + It("prefers the album-root cover.jpg", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Album/CD1/01 - Track.mp3": trackFile(1, "Track CD1"), + "Album/CD2/01 - Track.mp3": trackFile(1, "Track CD2"), + "Album/cover.jpg": imageFile("album-root"), + "Album/CD1/folder.jpg": imageFile("disc1"), + "Album/CD2/folder.jpg": imageFile("disc2"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root"))) + }) + }) + + When("CoverArtPriority puts embedded first and the album has both embedded and external art", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 ← has embedded picture (wins via "embedded") + // └── cover.jpg + It("returns the embedded image", func() { + conf.Server.CoverArtPriority = "embedded, cover.*, folder.*, front.*, external" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"has_picture": "true"}), + "Artist/Album/cover.jpg": imageFile("external"), + }) + scan() + // Swap in real MP3 bytes so libFS.Open returns a taglib-readable stream. + replaceWithRealMP3("Artist/Album/01 - Track.mp3") + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(embeddedArtBytes)) + }) + }) + + When("CoverArtPriority lists external first but no external file is present", func() { + // Artist/ + // └── Album/ + // └── 01 - Track.mp3 ← has embedded picture (falls through to "embedded") + It("falls through to embedded artwork", func() { + conf.Server.CoverArtPriority = "external, embedded" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"has_picture": "true"}), + }) + scan() + replaceWithRealMP3("Artist/Album/01 - Track.mp3") + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(embeddedArtBytes)) + }) + }) + + When("the only cover file uses uppercase extension and a different case in its name", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── Cover.JPG ← matched case-insensitively by cover.* + It("matches case-insensitively against cover.*", func() { + conf.Server.CoverArtPriority = "cover.*, folder.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/Cover.JPG": imageFile("case-insensitive"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("case-insensitive"))) + }) + }) + + When("two cover files have basenames that tie under the natural-sort tiebreaker", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // ├── cover.jpg ← wins (no numeric suffix) + // └── cover.1.jpg + It("prefers the file without a numeric suffix", func() { + conf.Server.CoverArtPriority = "cover.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("primary"), + "Artist/Album/cover.1.jpg": imageFile("secondary"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("primary"))) + }) + }) + + When("the album has no cover and CoverArtPriority lists only file patterns", func() { + // Artist/ + // └── Album/ + // └── 01 - Track.mp3 (no image files — returns ErrUnavailable) + It("returns ErrUnavailable", func() { + conf.Server.CoverArtPriority = "cover.*, folder.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + }) + scan() + + al := firstAlbum() + _, err := readArtworkOrErr(model.NewArtworkID(model.KindAlbumArtwork, al.ID, &al.UpdatedAt)) + Expect(err).To(HaveOccurred()) + }) + }) + + // Doc scenarios from: + // https://www.navidrome.org/docs/usage/library/artwork/#albums + // Default CoverArtPriority is "cover.*, folder.*, front.*, embedded, external". + When("only folder.jpg is present (cover.* and front.* missing)", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── folder.jpg ← matched by folder.* + It("falls through to folder.jpg", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/folder.jpg": imageFile("folder"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("folder"))) + }) + }) + + When("only front.jpg is present (cover.* and folder.* missing)", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── front.jpg ← matched by front.* + It("falls through to front.jpg", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/front.jpg": imageFile("front"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("front"))) + }) + }) + + When("cover.*, folder.*, and front.* all exist in the same folder", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // ├── cover.jpg ← wins (cover.* is first in priority) + // ├── folder.jpg + // └── front.jpg + It("prefers cover.* (first in CoverArtPriority)", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("cover"), + "Artist/Album/folder.jpg": imageFile("folder"), + "Artist/Album/front.jpg": imageFile("front"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("cover"))) + }) + }) + + When("only folder.* and front.* exist (priority order check)", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // ├── folder.jpg ← wins (folder.* comes before front.*) + // └── front.jpg + It("prefers folder.* over front.*", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/folder.jpg": imageFile("folder"), + "Artist/Album/front.jpg": imageFile("front"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("folder"))) + }) + }) + + When("three cover files tie by basename and differ only by numeric suffix", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // ├── cover.jpg ← wins (no numeric suffix) + // ├── cover.1.jpg + // └── cover.2.jpg + It("selects the unsuffixed file first regardless of numeric-suffix order", func() { + conf.Server.CoverArtPriority = "cover.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.2.jpg": imageFile("second"), + "Artist/Album/cover.jpg": imageFile("primary"), + "Artist/Album/cover.1.jpg": imageFile("first"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("primary"))) + }) + }) + + When("CoverArtPriority contains an unknown pattern before a matching one", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── cover.jpg ← wins (unknown "bogus.*" is skipped) + It("skips the unknown pattern and falls through to the matching one", func() { + conf.Server.CoverArtPriority = "bogus.*, cover.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("cover"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("cover"))) + }) + }) + + When("embedded is first in CoverArtPriority but the track has no embedded art", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 (no embedded picture) + // └── cover.jpg ← wins (embedded skipped, falls through) + It("falls through to the next priority entry", func() { + conf.Server.CoverArtPriority = "embedded, cover.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("cover"), + }) + scan() + + al := firstAlbum() + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("cover"))) + }) + }) +}) diff --git a/core/artwork/e2e/artist_test.go b/core/artwork/e2e/artist_test.go new file mode 100644 index 000000000..d959b1d60 --- /dev/null +++ b/core/artwork/e2e/artist_test.go @@ -0,0 +1,167 @@ +package artworke2e_test + +import ( + "os" + "path/filepath" + "testing/fstest" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// Doc reference: +// https://www.navidrome.org/docs/usage/library/artwork/#artists +// Default ArtistArtPriority is "artist.*, album/artist.*, external". +var _ = Describe("Artist artwork resolution", func() { + BeforeEach(func() { + setupHarness() + }) + + When("the artist folder contains an artist.jpg", func() { + // Artist/ + // ├── artist.jpg ← matched by artist.* + // └── Album/ + // └── 01 - Track.mp3 + It("returns the artist.* image from the artist folder", func() { + conf.Server.ArtistArtPriority = "artist.*, album/artist.*, external" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"albumartist": "Artist"}), + "Artist/artist.jpg": imageFile("artist-folder"), + }) + scan() + + ar := soleArtist() + artID := model.NewArtworkID(model.KindArtistArtwork, ar.ID, nil) + Expect(readArtwork(artID)).To(Equal(imageBytes("artist-folder"))) + }) + }) + + When("artist.* only exists inside an album folder", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── artist.jpg ← matched by album/artist.* + It("falls through to album/artist.* and returns that image", func() { + conf.Server.ArtistArtPriority = "artist.*, album/artist.*, external" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"albumartist": "Artist"}), + "Artist/Album/artist.jpg": imageFile("album-artist"), + }) + scan() + + ar := soleArtist() + artID := model.NewArtworkID(model.KindArtistArtwork, ar.ID, nil) + Expect(readArtwork(artID)).To(Equal(imageBytes("album-artist"))) + }) + }) + + When("both the artist folder and an album folder have an artist.* image", func() { + // Artist/ + // ├── artist.jpg ← wins (artist.* before album/artist.*) + // └── Album/ + // ├── 01 - Track.mp3 + // └── artist.jpg + It("prefers the artist-folder image (artist.* comes before album/artist.*)", func() { + conf.Server.ArtistArtPriority = "artist.*, album/artist.*, external" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"albumartist": "Artist"}), + "Artist/artist.jpg": imageFile("artist-folder"), + "Artist/Album/artist.jpg": imageFile("album-artist"), + }) + scan() + + ar := soleArtist() + artID := model.NewArtworkID(model.KindArtistArtwork, ar.ID, nil) + Expect(readArtwork(artID)).To(Equal(imageBytes("artist-folder"))) + }) + }) + + When("an artist has an uploaded image and a matching artist.* file", func() { + // / + // └── artwork/ + // └── artist/ + // └── _upload.jpg ← wins (uploaded image beats the priority chain) + // Library: + // Artist/ + // ├── artist.jpg (ignored — uploaded image comes first) + // └── Album/ + // └── 01 - Track.mp3 + It("prefers the uploaded image over any priority-chain match", func() { + conf.Server.ArtistArtPriority = "artist.*, album/artist.*, external" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"albumartist": "Artist"}), + "Artist/artist.jpg": imageFile("artist-folder"), + }) + scan() + ar := soleArtist() + + uploaded := ar.ID + "_upload.jpg" + writeUploadedImage(consts.EntityArtist, uploaded, imageBytes("artist-uploaded")) + ar.UploadedImage = uploaded + Expect(ds.Artist(ctx).Put(&ar)).To(Succeed()) + + artID := model.NewArtworkID(model.KindArtistArtwork, ar.ID, nil) + Expect(readArtwork(artID)).To(Equal(imageBytes("artist-uploaded"))) + }) + }) + + When("ArtistArtPriority uses album/ (not just album/artist.*)", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── artist.jpg ← matched by album/artist.* + It("resolves the pattern against the artist's album image files", func() { + conf.Server.ArtistArtPriority = "album/artist.*, external" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"albumartist": "Artist"}), + "Artist/Album/artist.jpg": imageFile("album-artist"), + }) + scan() + + ar := soleArtist() + artID := model.NewArtworkID(model.KindArtistArtwork, ar.ID, nil) + Expect(readArtwork(artID)).To(Equal(imageBytes("album-artist"))) + }) + }) + + When("ArtistArtPriority starts with image-folder and ArtistImageFolder has a name-matching image", func() { + // / + // └── Artist.jpg ← matched by artist name (image-folder source) + // Library: + // Artist/ + // └── Album/ + // └── 01 - Track.mp3 (no artist.* present in library) + It("returns the image from the configured artist image folder", func() { + imgFolder := GinkgoT().TempDir() + Expect(os.WriteFile(filepath.Join(imgFolder, "Artist.jpg"), imageBytes("image-folder"), 0600)).To(Succeed()) + conf.Server.ArtistImageFolder = imgFolder + conf.Server.ArtistArtPriority = "image-folder, artist.*, album/artist.*" + + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track", map[string]any{"albumartist": "Artist"}), + }) + scan() + + ar := soleArtist() + artID := model.NewArtworkID(model.KindArtistArtwork, ar.ID, nil) + Expect(readArtwork(artID)).To(Equal(imageBytes("image-folder"))) + }) + }) +}) + +func soleArtist() model.Artist { + GinkgoHelper() + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"artist.name": "Artist"}, + }) + Expect(err).ToNot(HaveOccurred()) + if len(artists) == 0 { + Fail("sole artist not found") + return model.Artist{} + } + return artists[0] +} diff --git a/core/artwork/e2e/disc_test.go b/core/artwork/e2e/disc_test.go new file mode 100644 index 000000000..667079458 --- /dev/null +++ b/core/artwork/e2e/disc_test.go @@ -0,0 +1,371 @@ +package artworke2e_test + +import ( + "fmt" + "testing/fstest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Disc artwork resolution", func() { + BeforeEach(func() { + setupHarness() + }) + + When("the album is single-disc with a disc1.jpg in the only folder", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── disc1.jpg ← matched by disc*.* + It("returns the disc1.jpg image (matched as disc*.*)", func() { + conf.Server.DiscArtPriority = "disc*.*, cd*.*, cover.*, folder.*, front.*, embedded" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/disc1.jpg": imageFile("disc1-image"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("disc1-image"))) + }) + }) + + When("the album has no per-disc image and no album cover", func() { + // Artist/ + // └── Album/ + // └── 01 - Track.mp3 (no disc or album art — returns ErrUnavailable) + It("returns ErrUnavailable for the disc lookup", func() { + conf.Server.DiscArtPriority = "disc*.*, cd*.*" + conf.Server.CoverArtPriority = "cover.*, folder.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + _, err := readArtworkOrErr(discID) + Expect(err).To(HaveOccurred()) + }) + }) + + When("the album has no per-disc image but has an album cover", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // └── cover.jpg ← album-level fallback (no disc art present) + It("falls back to the album cover", func() { + conf.Server.DiscArtPriority = "disc*.*, cd*.*" + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("album-cover"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("album-cover"))) + }) + }) + + When("multiple disc images exist in the same folder (disc1 vs disc10)", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 + // ├── disc1.jpg ← matches request for disc 1 + // └── disc10.jpg + It("matches the requested disc number, not a higher-numbered one", func() { + conf.Server.DiscArtPriority = "disc*.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/disc1.jpg": imageFile("disc-one"), + "Artist/Album/disc10.jpg": imageFile("disc-ten"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("disc-one"))) + }) + }) + + When("a multi-disc album has per-disc covers", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── disc1.jpg ← matches request for disc 1 + // └── CD2/ + // ├── 01 - Track.mp3 + // └── disc2.jpg ← matches request for disc 2 + It("returns the requested disc's image", func() { + conf.Server.DiscArtPriority = "disc*.*" + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}), + "Artist/Album/CD1/disc1.jpg": imageFile("disc-1"), + "Artist/Album/CD2/disc2.jpg": imageFile("disc-2"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 2), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("disc-2"))) + }) + }) + + // Doc scenarios from: + // https://www.navidrome.org/docs/usage/library/artwork/#disc-cover-art + // Default DiscArtPriority is "disc*.*, cd*.*, cover.*, folder.*, front.*, discsubtitle, embedded". + When("a disc subfolder has a cd2.png image", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── disc1.jpg + // └── CD2/ + // ├── 01 - Track.mp3 + // └── cd2.png ← matched by cd*.* for disc 2 + It("matches via the cd*.* pattern", func() { + conf.Server.DiscArtPriority = defaultDiscPriority + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}), + "Artist/Album/CD1/disc1.jpg": imageFile("disc-1"), + "Artist/Album/CD2/cd2.png": imageFile("cd-2"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 2), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("cd-2"))) + }) + }) + + When("a disc subfolder has cover.jpg but no disc*.*/cd*.* image", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── cover.jpg ← matched by cover.* inside disc folder + // └── CD2/ + // ├── 01 - Track.mp3 + // └── cover.jpg + It("falls through to cover.* inside the disc folder", func() { + conf.Server.DiscArtPriority = defaultDiscPriority + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}), + "Artist/Album/CD1/cover.jpg": imageFile("disc1-cover"), + "Artist/Album/CD2/cover.jpg": imageFile("disc2-cover"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("disc1-cover"))) + }) + }) + + When("DiscArtPriority is the empty string", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── disc1.jpg (ignored — DiscArtPriority is empty) + // ├── CD2/ + // │ ├── 01 - Track.mp3 + // │ └── cd2.png (ignored — DiscArtPriority is empty) + // └── cover.jpg ← used for every disc (album-level fallback) + It("skips every disc-level source and returns the album cover", func() { + conf.Server.DiscArtPriority = "" + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}), + "Artist/Album/CD1/disc1.jpg": imageFile("disc-1"), + "Artist/Album/CD2/cd2.png": imageFile("cd-2"), + "Artist/Album/cover.jpg": imageFile("album-cover"), + }) + scan() + + al := firstAlbum() + for _, n := range []int{1, 2} { + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, n), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("album-cover")), + "disc %d should use the album cover when DiscArtPriority is empty", n) + } + }) + }) + + When("the documented multi-disc layout is used (disc1.jpg + cd2.png + album-root cover.jpg)", func() { + // Artist/ + // └── Album/ + // ├── disc1/ + // │ ├── disc1.jpg ← matched by disc*.* for disc 1 + // │ ├── 01 - Track.mp3 + // │ └── 02 - Track.mp3 + // ├── disc2/ + // │ ├── cd2.png ← matched by cd*.* for disc 2 + // │ ├── 01 - Track.mp3 + // │ └── 02 - Track.mp3 + // └── cover.jpg (album-level fallback, unused here) + It("matches the per-disc image for each disc", func() { + conf.Server.DiscArtPriority = defaultDiscPriority + conf.Server.CoverArtPriority = defaultCoverPriority + setLayout(fstest.MapFS{ + "Artist/Album/disc1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}), + "Artist/Album/disc1/02 - Track.mp3": trackFile(2, "T2", map[string]any{"disc": "1"}), + "Artist/Album/disc2/01 - Track.mp3": trackFile(1, "T3", map[string]any{"disc": "2"}), + "Artist/Album/disc2/02 - Track.mp3": trackFile(2, "T4", map[string]any{"disc": "2"}), + "Artist/Album/disc1/disc1.jpg": imageFile("disc-1"), + "Artist/Album/disc2/cd2.png": imageFile("cd-2"), + "Artist/Album/cover.jpg": imageFile("album-root"), + }) + scan() + + al := firstAlbum() + disc1ID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + disc2ID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 2), &al.UpdatedAt) + Expect(readArtwork(disc1ID)).To(Equal(imageBytes("disc-1"))) + Expect(readArtwork(disc2ID)).To(Equal(imageBytes("cd-2"))) + }) + }) + + When("discsubtitle keyword matches an image whose stem equals the disc's subtitle", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 (discsubtitle="Bonus Tracks") + // └── Bonus Tracks.jpg ← matched by "discsubtitle" keyword + It("selects the subtitle-named image", func() { + conf.Server.DiscArtPriority = "discsubtitle" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1", "discsubtitle": "Bonus Tracks"}), + "Artist/Album/Bonus Tracks.jpg": imageFile("bonus-tracks"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("bonus-tracks"))) + }) + }) + + // Reproduces https://github.com/navidrome/navidrome/issues/5456 + // Deeply nested layout matching the reporter's actual structure. + When("a deeply nested multi-disc album has cover.jpg and per-disc folder.jpg", func() { + // Genre/Artist/Album/ ← album root with cover.jpg + // ├── cover.jpg ← album-level cover + // ├── Disc 01 (Subtitle)/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg ← disc 1 art + // ├── Disc 02 (Subtitle)/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg + // └── ... (12 discs) + It("uses album-root cover.jpg for album art and per-disc folder.jpg for each disc", func() { + conf.Server.DiscArtPriority = defaultDiscPriority + conf.Server.CoverArtPriority = defaultCoverPriority + discNames := []string{ + "Disc 01 (Birth of the Dead - The Studio Sides)", + "Disc 02 (Birth of the Dead - The Live Sides)", + "Disc 03 (The Grateful Dead)", + "Disc 04 (Anthem of the Sun)", + "Disc 05 (Aoxomoxoa)", + "Disc 06 (Live; Dead)", + "Disc 07 (Workingman's Dead)", + "Disc 08 (American Beauty)", + "Disc 09 (Grateful Dead)", + "Disc 10 (Europe '72)", + "Disc 11 (Europe '72)", + "Disc 12 (History of the Grateful Dead, Volume One (Bear's Choice))", + } + layout := fstest.MapFS{ + "Pop; Rock/Grateful Dead/(2001) The Golden Road/cover.jpg": imageFile("album-root-cover"), + } + for i, name := range discNames { + discNum := i + 1 + prefix := fmt.Sprintf("Pop; Rock/Grateful Dead/(2001) The Golden Road/%s/", name) + layout[prefix+"01 - Track.mp3"] = trackFile(1, fmt.Sprintf("T%d", discNum), map[string]any{"disc": fmt.Sprintf("%d", discNum)}) + layout[prefix+"folder.jpg"] = imageFile(fmt.Sprintf("disc-%02d-folder", discNum)) + } + setLayout(layout) + scan() + + al := firstAlbum() + + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root-cover"))) + + for i := range discNames { + discNum := i + 1 + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, discNum), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes(fmt.Sprintf("disc-%02d-folder", discNum))), + "disc %d should use its own folder.jpg", discNum) + } + }) + }) + + // https://github.com/navidrome/navidrome/issues/5456 + // Top-level album variant — album folder at library root (Path="."). + When("a top-level multi-disc album has cover.jpg and per-disc folder.jpg", func() { + // Album/ (top-level, Path=".") + // ├── cover.jpg ← album-level cover + // ├── Disc 01/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg ← disc 1 art + // ├── Disc 02/ + // │ ├── 01 - Track.mp3 + // │ └── folder.jpg + // └── Disc 03/ + // ├── 01 - Track.mp3 + // └── folder.jpg + It("uses album-root cover.jpg for album art and per-disc folder.jpg for each disc", func() { + conf.Server.DiscArtPriority = defaultDiscPriority + conf.Server.CoverArtPriority = defaultCoverPriority + layout := fstest.MapFS{ + "Album/cover.jpg": imageFile("album-root-cover"), + } + for i := 1; i <= 3; i++ { + prefix := fmt.Sprintf("Album/Disc %02d/", i) + layout[prefix+"01 - Track.mp3"] = trackFile(1, fmt.Sprintf("T%d", i), map[string]any{"disc": fmt.Sprintf("%d", i)}) + layout[prefix+"folder.jpg"] = imageFile(fmt.Sprintf("disc-%02d-folder", i)) + } + setLayout(layout) + scan() + + al := firstAlbum() + + Expect(readArtwork(al.CoverArtID())).To(Equal(imageBytes("album-root-cover"))) + + for i := 1; i <= 3; i++ { + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, i), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes(fmt.Sprintf("disc-%02d-folder", i))), + "disc %d should use its own folder.jpg", i) + } + }) + }) + + When("discsubtitle is set but no image filename matches the subtitle", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 (discsubtitle="Bonus Tracks") + // └── cover.jpg ← wins (discsubtitle has no match, falls through) + It("falls through to the next priority entry", func() { + conf.Server.DiscArtPriority = "discsubtitle, cover.*" + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1", "discsubtitle": "Bonus Tracks"}), + "Artist/Album/cover.jpg": imageFile("cover"), + }) + scan() + + al := firstAlbum() + discID := model.NewArtworkID(model.KindDiscArtwork, model.DiscArtworkID(al.ID, 1), &al.UpdatedAt) + Expect(readArtwork(discID)).To(Equal(imageBytes("cover"))) + }) + }) +}) diff --git a/core/artwork/e2e/helpers_test.go b/core/artwork/e2e/helpers_test.go new file mode 100644 index 000000000..e3abca097 --- /dev/null +++ b/core/artwork/e2e/helpers_test.go @@ -0,0 +1,184 @@ +package artworke2e_test + +import ( + "bytes" + "context" + _ "embed" + "errors" + "hash/fnv" + "image" + "image/color" + "image/png" + "io" + "maps" + "net/url" + "os" + "path/filepath" + "testing/fstest" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/resources" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "go.senan.xyz/taglib" +) + +// realMP3WithEmbeddedArt is the bytes of the canonical test fixture that +// contains a valid MP3 stream with an embedded picture. Used in the +// embedded-art e2e scenarios where FakeFS's JSON-encoded tag data isn't +// readable by taglib. Swap this into fakeFS.MapFS *after* scanning so the +// scanner still populates EmbedArtPath via the JSON-tagged track, and the +// artwork reader gets real bytes when it calls libFS.Open. +// +//go:embed testdata/embedded_art.mp3 +var realMP3WithEmbeddedArt []byte + +// embeddedArtBytes is the exact image payload that the artwork reader will +// extract from realMP3WithEmbeddedArt. Computed once via taglib so tests can +// assert byte-for-byte equality — if this ever differs it means the reader +// pulled from a different source. +var embeddedArtBytes = extractEmbeddedArt(realMP3WithEmbeddedArt) + +func extractEmbeddedArt(mp3 []byte) []byte { + tf, err := taglib.OpenStream(bytes.NewReader(mp3)) + if err != nil { + panic("embedded-art fixture: taglib.OpenStream failed: " + err.Error()) + } + defer tf.Close() + images := tf.Properties().Images + if len(images) == 0 { + panic("embedded-art fixture has no embedded images") + } + data, err := tf.Image(0) + if err != nil || len(data) == 0 { + panic("embedded-art fixture: could not read image 0") + } + return data +} + +// replaceWithRealMP3 swaps the FakeFS entry at the given library-relative +// path so libFS.Open returns an MP3 stream taglib can parse. +func replaceWithRealMP3(relPath string) { + GinkgoHelper() + fakeFS.MapFS[relPath] = &fstest.MapFile{Data: realMP3WithEmbeddedArt} +} + +// placeholderBytes returns the bundled album-placeholder image bytes — the +// same stream the artwork reader emits when every source falls through. +func placeholderBytes() []byte { + GinkgoHelper() + r, err := resources.FS().Open(consts.PlaceholderAlbumArt) + Expect(err).ToNot(HaveOccurred()) + defer r.Close() + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + return data +} + +// writeUploadedImage drops `filename` into /artwork// with +// the given bytes, matching the on-disk layout expected by +// model.UploadedImagePath. +func writeUploadedImage(entity, filename string, data []byte) { + GinkgoHelper() + dir := filepath.Dir(model.UploadedImagePath(entity, filename)) + Expect(os.MkdirAll(dir, 0755)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(dir, filename), data, 0600)).To(Succeed()) +} + +func newNoopFFmpeg() *tests.MockFFmpeg { + ff := tests.NewMockFFmpeg("") + ff.Error = errors.New("noop") + return ff +} + +// trackFile builds a FakeFS MP3 entry with optional tag overrides. +func trackFile(num int, title string, extra ...map[string]any) *fstest.MapFile { + tags := storagetest.Track(num, title) + for _, e := range extra { + maps.Copy(tags, e) + } + return storagetest.MP3(tags) +} + +// imageFile builds a label-keyed image entry. The bytes are deterministic +// per-label so tests can assert which file won. +func imageFile(label string) *fstest.MapFile { + return &fstest.MapFile{Data: []byte("image:" + label)} +} + +// realPNG builds a minimal 2x2 PNG with a color derived from label. Needed by +// tests that feed the bytes into image.Decode (e.g. playlist tiled covers). +func realPNG(label string) *fstest.MapFile { + img := image.NewRGBA(image.Rect(0, 0, 2, 2)) + // Derive a deterministic color per label. + h := fnv.New32a() + _, _ = h.Write([]byte(label)) + sum := h.Sum32() + c := color.RGBA{R: byte(sum), G: byte(sum >> 8), B: byte(sum >> 16), A: 255} + for y := range 2 { + for x := range 2 { + img.Set(x, y, c) + } + } + var buf bytes.Buffer + Expect(png.Encode(&buf, img)).To(Succeed()) + return &fstest.MapFile{Data: buf.Bytes()} +} + +// imageBytes returns the bytes that imageFile(label) writes. +func imageBytes(label string) []byte { return imageFile(label).Data } + +// setLayout populates fakeFS with the given map. Call after setupHarness. +// All paths must be forward-slash and relative (no leading "/"). +func setLayout(files fstest.MapFS) { + GinkgoHelper() + fakeFS.SetFiles(files) +} + +func readArtwork(artID model.ArtworkID) []byte { + GinkgoHelper() + r, _, err := aw.Get(ctx, artID, 0, false) + Expect(err).ToNot(HaveOccurred()) + defer r.Close() + b, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + return b +} + +func readArtworkOrErr(artID model.ArtworkID) ([]byte, error) { + r, _, err := aw.Get(ctx, artID, 0, false) + if err != nil { + return nil, err + } + defer r.Close() + return io.ReadAll(r) +} + +// noopProvider implements external.Provider with not-found returns so the +// "external" priority entry never produces a result. +type noopProvider struct{} + +func (n *noopProvider) UpdateAlbumInfo(context.Context, string) (*model.Album, error) { + return nil, model.ErrNotFound +} +func (n *noopProvider) UpdateArtistInfo(context.Context, string, int, bool) (*model.Artist, error) { + return nil, model.ErrNotFound +} +func (n *noopProvider) SimilarSongs(context.Context, string, int) (model.MediaFiles, error) { + return nil, nil +} +func (n *noopProvider) TopSongs(context.Context, string, int) (model.MediaFiles, error) { + return nil, nil +} +func (n *noopProvider) ArtistImage(context.Context, string) (*url.URL, error) { + return nil, model.ErrNotFound +} +func (n *noopProvider) AlbumImage(context.Context, string) (*url.URL, error) { + return nil, model.ErrNotFound +} + +var _ external.Provider = (*noopProvider)(nil) diff --git a/core/artwork/e2e/mediafile_test.go b/core/artwork/e2e/mediafile_test.go new file mode 100644 index 000000000..1f43a3827 --- /dev/null +++ b/core/artwork/e2e/mediafile_test.go @@ -0,0 +1,110 @@ +package artworke2e_test + +import ( + "testing/fstest" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// Doc reference: +// https://www.navidrome.org/docs/usage/library/artwork/#mediafiles +// Navidrome resolves mediafile artwork in this order: +// 1. Embedded image from the mediafile itself +// 2. For multi-disc albums, disc-level artwork +// 3. Album cover art +// +// FakeFS cannot synthesize taglib-readable embedded JPEGs, so scenario (1) +// is covered by the existing embedded-art album tests (which currently +// Skip under FakeFS). The tests below cover (2) and (3): the fallback +// chain for tracks without embedded art. +var _ = Describe("MediaFile artwork fallback", func() { + BeforeEach(func() { + setupHarness() + }) + + When("a multi-disc album track has no embedded art", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ ├── 01 - Track.mp3 + // │ └── disc1.jpg + // ├── CD2/ + // │ ├── 01 - Track.mp3 ← track requested + // │ └── disc2.jpg ← wins (disc-level before album-level) + // └── cover.jpg + It("falls back to the disc-level artwork (not the album cover)", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + conf.Server.DiscArtPriority = defaultDiscPriority + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}), + "Artist/Album/CD1/disc1.jpg": imageFile("disc-1"), + "Artist/Album/CD2/disc2.jpg": imageFile("disc-2"), + "Artist/Album/cover.jpg": imageFile("album-root"), + }) + scan() + + mf := mediafileOn("Artist/Album/CD2/01 - Track.mp3") + Expect(readArtwork(mf.CoverArtID())).To(Equal(imageBytes("disc-2"))) + }) + }) + + When("a single-disc album track has no embedded art", func() { + // Artist/ + // └── Album/ + // ├── 01 - Track.mp3 ← track requested + // └── cover.jpg ← wins (album-level fallback, no disc subfolder) + It("falls back to the album cover", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + conf.Server.DiscArtPriority = defaultDiscPriority + setLayout(fstest.MapFS{ + "Artist/Album/01 - Track.mp3": trackFile(1, "Track"), + "Artist/Album/cover.jpg": imageFile("album-cover"), + }) + scan() + + mf := mediafileOn("Artist/Album/01 - Track.mp3") + Expect(readArtwork(mf.CoverArtID())).To(Equal(imageBytes("album-cover"))) + }) + }) + + When("a multi-disc album track has no embedded art and the disc has no disc-level image", func() { + // Artist/ + // └── Album/ + // ├── CD1/ + // │ └── 01 - Track.mp3 + // ├── CD2/ + // │ └── 01 - Track.mp3 ← track requested + // └── cover.jpg ← wins (no disc image → album-level fallback) + It("falls through from disc to album cover", func() { + conf.Server.CoverArtPriority = defaultCoverPriority + conf.Server.DiscArtPriority = defaultDiscPriority + setLayout(fstest.MapFS{ + "Artist/Album/CD1/01 - Track.mp3": trackFile(1, "T1", map[string]any{"disc": "1"}), + "Artist/Album/CD2/01 - Track.mp3": trackFile(1, "T2", map[string]any{"disc": "2"}), + "Artist/Album/cover.jpg": imageFile("album-root"), + }) + scan() + + mf := mediafileOn("Artist/Album/CD2/01 - Track.mp3") + Expect(readArtwork(mf.CoverArtID())).To(Equal(imageBytes("album-root"))) + }) + }) +}) + +func mediafileOn(relPath string) model.MediaFile { + GinkgoHelper() + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Like{"media_file.path": relPath}, + }) + Expect(err).ToNot(HaveOccurred()) + if len(mfs) == 0 { + Fail("mediafile not found: " + relPath) + return model.MediaFile{} + } + return mfs[0] +} diff --git a/core/artwork/e2e/playlist_test.go b/core/artwork/e2e/playlist_test.go new file mode 100644 index 000000000..d28efca8e --- /dev/null +++ b/core/artwork/e2e/playlist_test.go @@ -0,0 +1,158 @@ +package artworke2e_test + +import ( + "os" + "path/filepath" + "testing/fstest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// Playlist artwork resolves in this priority order: +// 1. Uploaded image (/artwork/playlist/) +// 2. Sidecar image next to the .m3u file (same basename, any image ext) +// 3. ExternalImageURL (http/https requires EnableM3UExternalAlbumArt; local path always allowed) +// 4. Generated 2x2 tiled cover from the playlist's albums +// 5. Album placeholder image +// +// The library FS is FakeFS, but uploaded/sidecar/local-external images are +// real files on disk — the reader reads them via os.Open, so the tests +// place them in a real tempdir under DataFolder. +var _ = Describe("Playlist artwork resolution", func() { + BeforeEach(func() { + setupHarness() + }) + + When("a playlist has an uploaded image", func() { + // / + // └── artwork/ + // └── playlist/ + // └── pl-1_upload.jpg ← matched by UploadedImagePath() (highest priority) + It("returns the uploaded image bytes", func() { + writeUploadedImage(consts.EntityPlaylist, "pl-1_upload.jpg", imageBytes("playlist-upload")) + + pl := putPlaylist(model.Playlist{ID: "pl-1", Name: "Test", UploadedImage: "pl-1_upload.jpg"}) + + Expect(readArtwork(pl.CoverArtID())).To(Equal(imageBytes("playlist-upload"))) + }) + }) + + When("a playlist has no uploaded image but a sidecar image beside its .m3u file", func() { + // / + // ├── MyList.m3u + // └── MyList.jpg ← matched by sidecar (same basename, case-insensitive) + It("returns the sidecar image", func() { + dir := GinkgoT().TempDir() + m3uPath := filepath.Join(dir, "MyList.m3u") + Expect(os.WriteFile(m3uPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(dir, "MyList.jpg"), imageBytes("sidecar"), 0600)).To(Succeed()) + + pl := putPlaylist(model.Playlist{ID: "pl-2", Name: "MyList", Path: m3uPath}) + + Expect(readArtwork(pl.CoverArtID())).To(Equal(imageBytes("sidecar"))) + }) + }) + + When("a playlist's sidecar uses a different extension case", func() { + // / + // ├── MyList.m3u + // └── MyList.PNG ← matched case-insensitively + It("matches case-insensitively", func() { + dir := GinkgoT().TempDir() + m3uPath := filepath.Join(dir, "MyList.m3u") + Expect(os.WriteFile(m3uPath, []byte("#EXTM3U\n"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(dir, "MyList.PNG"), imageBytes("sidecar-png"), 0600)).To(Succeed()) + + pl := putPlaylist(model.Playlist{ID: "pl-3", Name: "MyList", Path: m3uPath}) + + Expect(readArtwork(pl.CoverArtID())).To(Equal(imageBytes("sidecar-png"))) + }) + }) + + When("a playlist has an ExternalImageURL pointing to a local file", func() { + // / + // └── cover.jpg ← absolute path stored in ExternalImageURL + It("returns the local file regardless of EnableM3UExternalAlbumArt", func() { + conf.Server.EnableM3UExternalAlbumArt = false // local paths bypass the toggle + dir := GinkgoT().TempDir() + imgPath := filepath.Join(dir, "cover.jpg") + Expect(os.WriteFile(imgPath, imageBytes("external-local"), 0600)).To(Succeed()) + + pl := putPlaylist(model.Playlist{ID: "pl-4", Name: "WithExt", ExternalImageURL: imgPath}) + + Expect(readArtwork(pl.CoverArtID())).To(Equal(imageBytes("external-local"))) + }) + }) + + When("a playlist has an http(s) ExternalImageURL and EnableM3UExternalAlbumArt is false", func() { + // (no local files — http source is gated off, reader falls through to placeholder) + It("skips the URL and falls through to the bundled placeholder", func() { + conf.Server.EnableM3UExternalAlbumArt = false + + pl := putPlaylist(model.Playlist{ID: "pl-5", Name: "HttpGated", ExternalImageURL: "https://example.com/cover.jpg"}) + + Expect(readArtwork(pl.CoverArtID())).To(Equal(placeholderBytes())) + }) + }) + + When("a playlist has no images and no tracks", func() { + // (reader falls all the way through to the bundled album placeholder) + It("returns the album placeholder", func() { + pl := putPlaylist(model.Playlist{ID: "pl-6", Name: "Empty"}) + + Expect(readArtwork(pl.CoverArtID())).To(Equal(placeholderBytes())) + }) + }) + + When("a playlist has no uploaded/sidecar/external image but has tracks with album covers", func() { + // Library: + // Artist/ + // ├── AlbumA/ + // │ ├── 01 - Track.mp3 + // │ └── cover.png (real PNG — wins as tile 1 source) + // └── AlbumB/ + // ├── 01 - Track.mp3 + // └── cover.png (real PNG — wins as tile 2 source) + // Playlist "pl-7" references tracks from both albums, so the reader + // generates a 2x2 tiled cover from 2 distinct album art tiles (the + // tiled generator mirrors when it has fewer than 4 unique tiles). + It("generates a tiled cover from album art", func() { + conf.Server.CoverArtPriority = "cover.*" + setLayout(fstest.MapFS{ + "Artist/AlbumA/01 - Track.mp3": trackFile(1, "TA", map[string]any{"album": "AlbumA"}), + "Artist/AlbumA/cover.png": realPNG("albumA"), + "Artist/AlbumB/01 - Track.mp3": trackFile(1, "TB", map[string]any{"album": "AlbumB"}), + "Artist/AlbumB/cover.png": realPNG("albumB"), + }) + scan() + + // Pull the scanned mediafile IDs so we can attach them to the playlist. + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(2)) + + pl := model.Playlist{ID: "pl-7", Name: "Mix", OwnerID: "admin-1"} + pl.AddMediaFilesByID([]string{mfs[0].ID, mfs[1].ID}) + Expect(ds.Playlist(ctx).Put(&pl)).To(Succeed()) + + data := readArtwork(pl.CoverArtID()) + // The tiled cover is a PNG-encoded 600x600 image (tileSize const). + // Exact bytes vary (random album order), so assert format + non-trivial size. + Expect(data[:8]).To(Equal([]byte{0x89, 'P', 'N', 'G', 0x0d, 0x0a, 0x1a, 0x0a})) + Expect(len(data)).To(BeNumerically(">", 1000)) + }) + }) +}) + +func putPlaylist(pl model.Playlist) model.Playlist { + GinkgoHelper() + if pl.OwnerID == "" { + pl.OwnerID = "admin-1" + } + Expect(ds.Playlist(ctx).Put(&pl)).To(Succeed()) + return pl +} diff --git a/core/artwork/e2e/radio_test.go b/core/artwork/e2e/radio_test.go new file mode 100644 index 000000000..73ee5f377 --- /dev/null +++ b/core/artwork/e2e/radio_test.go @@ -0,0 +1,42 @@ +package artworke2e_test + +import ( + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Radio artwork resolution", func() { + BeforeEach(func() { + setupHarness() + }) + + When("a radio has an uploaded image", func() { + // / + // └── artwork/ + // └── radio/ + // └── rd-1_logo.jpg ← matched by UploadedImagePath() + It("returns the uploaded image bytes", func() { + writeUploadedImage(consts.EntityRadio, "rd-1_logo.jpg", imageBytes("radio-logo")) + + rd := model.Radio{ID: "rd-1", Name: "Test Radio", StreamUrl: "https://example.com/stream", UploadedImage: "rd-1_logo.jpg"} + Expect(ds.Radio(ctx).Put(&rd)).To(Succeed()) + + artID := model.NewArtworkID(model.KindRadioArtwork, rd.ID, nil) + Expect(readArtwork(artID)).To(Equal(imageBytes("radio-logo"))) + }) + }) + + When("a radio has no uploaded image", func() { + // (no files on disk — reader has no sources to fall back to) + It("returns ErrUnavailable", func() { + rd := model.Radio{ID: "rd-2", Name: "Bare Radio", StreamUrl: "https://example.com/stream"} + Expect(ds.Radio(ctx).Put(&rd)).To(Succeed()) + + artID := model.NewArtworkID(model.KindRadioArtwork, rd.ID, nil) + _, err := readArtworkOrErr(artID) + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/core/artwork/e2e/suite_test.go b/core/artwork/e2e/suite_test.go new file mode 100644 index 000000000..733e2e98c --- /dev/null +++ b/core/artwork/e2e/suite_test.go @@ -0,0 +1,106 @@ +package artworke2e_test + +import ( + "context" + "path/filepath" + "testing" + + _ "github.com/navidrome/navidrome/adapters/gotaglib" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestArtworkE2E(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Artwork E2E Suite") +} + +const fakeLibScheme = "artworkfake" +const fakeLibPath = fakeLibScheme + ":///music" + +var ( + ctx context.Context + ds *tests.MockDataStore + aw artwork.Artwork + fakeFS *storagetest.FakeFS +) + +// The DB file lives in a suite-level tempdir: the go-sqlite3 singleton keeps +// the file open for the whole suite, and Ginkgo's per-spec TempDir cleanup +// can't unlink a file with a live handle on Windows. A suite-level tempdir +// combined with an AfterSuite close avoids the lock conflict. +var suiteDBTempDir string + +var _ = BeforeSuite(func() { + suiteDBTempDir = GinkgoT().TempDir() +}) + +var _ = AfterSuite(func() { + db.Close(GinkgoT().Context()) +}) + +func setupHarness() { + DeferCleanup(configtest.SetupConfig()) + + tempDir := GinkgoT().TempDir() + // Reuse the suite-level DB path so the singleton connection keeps working + // across specs (see suiteDBTempDir comment). + conf.Server.DbPath = filepath.Join(suiteDBTempDir, "artwork-e2e.db") + "?_journal_mode=WAL" + conf.Server.DataFolder = conf.NewDir(tempDir) + conf.Server.MusicFolder = fakeLibPath + conf.Server.DevExternalScanner = false + conf.Server.ImageCacheSize = "0" // disabled cache → reader runs on every call + conf.Server.EnableExternalServices = false + + db.Db().SetMaxOpenConns(1) + ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "admin-1", UserName: "admin", IsAdmin: true}) + db.Init(ctx) + DeferCleanup(func() { Expect(tests.ClearDB()).To(Succeed()) }) + + ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} + + adminUser := model.User{ID: "admin-1", UserName: "admin", Name: "Admin", IsAdmin: true, NewPassword: "password"} + Expect(ds.User(ctx).Put(&adminUser)).To(Succeed()) + + lib := model.Library{ID: 1, Name: "Music", Path: fakeLibPath} + Expect(ds.Library(ctx).Put(&lib)).To(Succeed()) + Expect(ds.User(ctx).SetUserLibraries(adminUser.ID, []int{lib.ID})).To(Succeed()) + + fakeFS = &storagetest.FakeFS{} + storagetest.Register(fakeLibScheme, fakeFS) + + aw = artwork.NewArtwork(ds, artwork.GetImageCache(), newNoopFFmpeg(), &noopProvider{}) +} + +func scan() { + GinkgoHelper() + s := scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + _, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) +} + +func firstAlbum() model.Album { + GinkgoHelper() + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).To(HaveLen(1), "expected exactly one album, got %d", len(albums)) + return albums[0] +} diff --git a/core/artwork/e2e/testdata/embedded_art.mp3 b/core/artwork/e2e/testdata/embedded_art.mp3 new file mode 100644 index 000000000..18cb90674 Binary files /dev/null and b/core/artwork/e2e/testdata/embedded_art.mp3 differ diff --git a/core/artwork/library_fs.go b/core/artwork/library_fs.go new file mode 100644 index 000000000..ff557294e --- /dev/null +++ b/core/artwork/library_fs.go @@ -0,0 +1,44 @@ +package artwork + +import ( + "context" + "path/filepath" + + "github.com/navidrome/navidrome/core/storage" + "github.com/navidrome/navidrome/model" +) + +// libraryView bundles the MusicFS for a library with its absolute root path, +// so readers can open library-relative paths through FS and compose absolute +// paths (for ffmpeg, which is path-based) via Abs. +type libraryView struct { + FS storage.MusicFS + absRoot string +} + +// Abs returns the absolute path for a library-relative path. Returns "" for an +// empty rel so callers (fromFFmpegTag) can treat it as "no path available". +func (v libraryView) Abs(rel string) string { + if rel == "" { + return "" + } + return filepath.Join(v.absRoot, rel) +} + +// loadLibraryView resolves the MusicFS and absolute root path in a single +// library lookup. +func loadLibraryView(ctx context.Context, ds model.DataStore, libID int) (libraryView, error) { + lib, err := ds.Library(ctx).Get(libID) + if err != nil { + return libraryView{}, err + } + s, err := storage.For(lib.Path) + if err != nil { + return libraryView{}, err + } + fs, err := s.FS() + if err != nil { + return libraryView{}, err + } + return libraryView{FS: fs, absRoot: lib.Path}, nil +} diff --git a/core/artwork/library_fs_test.go b/core/artwork/library_fs_test.go new file mode 100644 index 000000000..acf08fda3 --- /dev/null +++ b/core/artwork/library_fs_test.go @@ -0,0 +1,45 @@ +package artwork + +import ( + "context" + + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("loadLibraryView", Ordered, func() { + var ctx context.Context + var ds *tests.MockDataStore + + BeforeAll(func() { + storagetest.Register("fake", &storagetest.FakeFS{}) + }) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{MockedLibrary: &tests.MockLibraryRepo{}} + }) + + It("returns a view for a library backed by registered storage", func() { + Expect(ds.Library(ctx).Put(&model.Library{ID: 1, Path: "fake:///music"})).To(Succeed()) + + lib, err := loadLibraryView(ctx, ds, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(lib.FS).ToNot(BeNil()) + Expect(lib.absRoot).To(Equal("fake:///music")) + }) + + It("returns an error when the library does not exist", func() { + _, err := loadLibraryView(ctx, ds, 999) + Expect(err).To(HaveOccurred()) + }) + + It("returns an error when the library path uses an unregistered scheme", func() { + Expect(ds.Library(ctx).Put(&model.Library{ID: 2, Path: "unsupported:///music"})).To(Succeed()) + _, err := loadLibraryView(ctx, ds, 2) + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/core/artwork/reader_album.go b/core/artwork/reader_album.go index 55d8b4352..73ba9b5ee 100644 --- a/core/artwork/reader_album.go +++ b/core/artwork/reader_album.go @@ -1,31 +1,35 @@ package artwork import ( + "cmp" "context" "crypto/md5" + "errors" "fmt" "io" - "path/filepath" + "path" "slices" "strings" "time" "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils" + "github.com/navidrome/navidrome/utils/natural" ) type albumArtworkReader struct { cacheKey - a *artwork - provider external.Provider - album model.Album - updatedAt *time.Time - imgFiles []string - rootFolder string + a *artwork + provider external.Provider + album model.Album + updatedAt *time.Time + imgFiles []string // library-relative, forward-slash, no leading slash + lib libraryView } func newAlbumArtworkReader(ctx context.Context, artwork *artwork, artID model.ArtworkID, provider external.Provider) (*albumArtworkReader, error) { @@ -37,28 +41,32 @@ func newAlbumArtworkReader(ctx context.Context, artwork *artwork, artID model.Ar if err != nil { return nil, err } + lib, err := loadLibraryView(ctx, artwork.ds, al.LibraryID) + if err != nil { + return nil, err + } a := &albumArtworkReader{ - a: artwork, - provider: provider, - album: *al, - updatedAt: imagesUpdateAt, - imgFiles: imgFiles, - rootFolder: core.AbsolutePath(ctx, artwork.ds, al.LibraryID, ""), + a: artwork, + provider: provider, + album: *al, + updatedAt: imagesUpdateAt, + imgFiles: imgFiles, + lib: lib, } a.cacheKey.artID = artID - if a.updatedAt != nil && a.updatedAt.After(al.UpdatedAt) { - a.cacheKey.lastUpdate = *a.updatedAt - } else { - a.cacheKey.lastUpdate = al.UpdatedAt + a.cacheKey.lastUpdate = utils.TimeNewest(al.UpdatedAt, al.ImportedAt) + if imagesUpdateAt != nil { + a.cacheKey.lastUpdate = utils.TimeNewest(a.cacheKey.lastUpdate, *imagesUpdateAt) } return a, nil } func (a *albumArtworkReader) Key() string { - var hash [16]byte + hashInput := conf.Server.CoverArtPriority if conf.Server.EnableExternalServices { - hash = md5.Sum([]byte(conf.Server.Agents + conf.Server.CoverArtPriority)) + hashInput = conf.Server.Agents + hashInput } + hash := md5.Sum([]byte(hashInput)) return fmt.Sprintf( "%s.%x.%t", a.cacheKey.Key(), @@ -67,7 +75,7 @@ func (a *albumArtworkReader) Key() string { ) } func (a *albumArtworkReader) LastUpdated() time.Time { - return a.album.UpdatedAt + return a.lastUpdate } func (a *albumArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { @@ -77,16 +85,19 @@ func (a *albumArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, func (a *albumArtworkReader) fromCoverArtPriority(ctx context.Context, ffmpeg ffmpeg.FFmpeg, priority string) []sourceFunc { var ff []sourceFunc - for _, pattern := range strings.Split(strings.ToLower(priority), ",") { + for pattern := range strings.SplitSeq(strings.ToLower(priority), ",") { pattern = strings.TrimSpace(pattern) switch { case pattern == "embedded": - embedArtPath := filepath.Join(a.rootFolder, a.album.EmbedArtPath) - ff = append(ff, fromTag(ctx, embedArtPath), fromFFmpegTag(ctx, ffmpeg, embedArtPath)) + embedRel := a.album.EmbedArtPath + ff = append(ff, + fromTag(ctx, a.lib.FS, embedRel), + fromFFmpegTag(ctx, ffmpeg, a.lib.Abs(embedRel)), + ) case pattern == "external": ff = append(ff, fromAlbumExternalSource(ctx, a.album, a.provider)) case len(a.imgFiles) > 0: - ff = append(ff, fromExternalFile(ctx, a.imgFiles, pattern)) + ff = append(ff, fromExternalFile(ctx, a.lib.FS, a.imgFiles, pattern)) } } return ff @@ -101,23 +112,95 @@ func loadAlbumFoldersPaths(ctx context.Context, ds model.DataStore, albums ...mo if err != nil { return nil, nil, nil, err } + + folderIDSet := make(map[string]bool, len(folderIDs)) + for _, id := range folderIDs { + folderIDSet[id] = true + } + + // Check if all folders share a common parent that is not already included. + // This finds cover art in the album root folder (e.g., "Artist/Album/cover.jpg" + // when tracks are in disc subfolders like "Artist/Album/CD1/" and "Artist/Album/CD2/"). + // For single-folder albums, the parent is only included when the folder has no + // images of its own (indicating a disc subfolder needing parent artwork). + if commonParentID := commonParentFolder(folders, folderIDSet); commonParentID != "" { + if len(folders) >= 2 || !anyFolderHasImages(folders) { + parentFolder, err := ds.Folder(ctx).Get(commonParentID) + if errors.Is(err, model.ErrNotFound) { + log.Warn(ctx, "Parent folder not found for album cover art lookup", "parentID", commonParentID) + } else if err != nil { + return nil, nil, nil, err + } + if parentFolder != nil && parentFolder.ParentID != "" { + folders = append(folders, *parentFolder) + } + } + } + var paths []string var imgFiles []string var updatedAt time.Time for _, f := range folders { - path := f.AbsolutePath() - paths = append(paths, path) + paths = append(paths, f.AbsolutePath()) if f.ImagesUpdatedAt.After(updatedAt) { updatedAt = f.ImagesUpdatedAt } + rel := strings.TrimPrefix(path.Join(f.Path, f.Name), "/") for _, img := range f.ImageFiles { - imgFiles = append(imgFiles, filepath.Join(path, img)) + imgFiles = append(imgFiles, path.Join(rel, img)) } } // Sort image files to ensure consistent selection of cover art - // This prioritizes files from lower-numbered disc folders by sorting the paths - slices.Sort(imgFiles) + // This prioritizes files without numeric suffixes (e.g., cover.jpg over cover.1.jpg) + // by comparing base filenames without extensions + slices.SortFunc(imgFiles, compareImageFiles) return paths, imgFiles, &updatedAt, nil } + +func anyFolderHasImages(folders []model.Folder) bool { + for _, f := range folders { + if len(f.ImageFiles) > 0 { + return true + } + } + return false +} + +// commonParentFolder returns the shared parent folder ID when all folders have the +// same parent and that parent is not already in folderIDSet. Returns "" otherwise. +func commonParentFolder(folders []model.Folder, folderIDSet map[string]bool) string { + if len(folders) == 0 { + return "" + } + parentID := folders[0].ParentID + if parentID == "" || folderIDSet[parentID] { + return "" + } + for _, f := range folders[1:] { + if f.ParentID != parentID { + return "" + } + } + return parentID +} + +// compareImageFiles sorts image paths by: base filename (natural order), +// then path depth (shallower first), then full path (stable tiebreaker). +func compareImageFiles(a, b string) int { + // Case-insensitive comparison + a = strings.ToLower(a) + b = strings.ToLower(b) + + // Extract base filenames without extensions + baseA := strings.TrimSuffix(path.Base(a), path.Ext(a)) + baseB := strings.TrimSuffix(path.Base(b), path.Ext(b)) + + // Compare base names first, then prefer shallower paths, then full path as tiebreaker + return cmp.Or( + natural.Compare(baseA, baseB), + cmp.Compare(strings.Count(a, "/"), strings.Count(b, "/")), + natural.Compare(a, b), + ) +} diff --git a/core/artwork/reader_album_test.go b/core/artwork/reader_album_test.go index 2665632b9..1cf039bee 100644 --- a/core/artwork/reader_album_test.go +++ b/core/artwork/reader_album_test.go @@ -2,7 +2,7 @@ package artwork import ( "context" - "path/filepath" + "errors" "time" "github.com/navidrome/navidrome/model" @@ -27,26 +27,7 @@ var _ = Describe("Album Artwork Reader", func() { expectedAt = now.Add(5 * time.Minute) // Set up the test folders with image files - repo = &fakeFolderRepo{ - result: []model.Folder{ - { - Path: "Artist/Album/Disc1", - ImagesUpdatedAt: expectedAt, - ImageFiles: []string{"cover.jpg", "back.jpg"}, - }, - { - Path: "Artist/Album/Disc2", - ImagesUpdatedAt: now, - ImageFiles: []string{"cover.jpg"}, - }, - { - Path: "Artist/Album/Disc10", - ImagesUpdatedAt: now, - ImageFiles: []string{"cover.jpg"}, - }, - }, - err: nil, - } + repo = &fakeFolderRepo{} ds = &fakeDataStore{ folderRepo: repo, } @@ -58,19 +39,361 @@ var _ = Describe("Album Artwork Reader", func() { }) It("returns sorted image files", func() { + repo.result = []model.Folder{ + { + Path: "Artist/Album/Disc1", + ImagesUpdatedAt: expectedAt, + ImageFiles: []string{"cover.jpg", "back.jpg", "cover.1.jpg"}, + }, + { + Path: "Artist/Album/Disc2", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + Path: "Artist/Album/Disc10", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + } + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, ds, album) Expect(err).ToNot(HaveOccurred()) Expect(*imagesUpdatedAt).To(Equal(expectedAt)) - // Check that image files are sorted alphabetically - Expect(imgFiles).To(HaveLen(4)) + // Check that image files are sorted by base name (without extension) + Expect(imgFiles).To(HaveLen(5)) - // The files should be sorted by full path - Expect(imgFiles[0]).To(Equal(filepath.FromSlash("Artist/Album/Disc1/back.jpg"))) - Expect(imgFiles[1]).To(Equal(filepath.FromSlash("Artist/Album/Disc1/cover.jpg"))) - Expect(imgFiles[2]).To(Equal(filepath.FromSlash("Artist/Album/Disc10/cover.jpg"))) - Expect(imgFiles[3]).To(Equal(filepath.FromSlash("Artist/Album/Disc2/cover.jpg"))) + // Files should be sorted by base filename without extension, then by full path + // "back" < "cover", so back.jpg comes first + // Then all cover.jpg files, sorted by path + Expect(imgFiles[0]).To(Equal("Artist/Album/Disc1/back.jpg")) + Expect(imgFiles[1]).To(Equal("Artist/Album/Disc1/cover.jpg")) + Expect(imgFiles[2]).To(Equal("Artist/Album/Disc2/cover.jpg")) + Expect(imgFiles[3]).To(Equal("Artist/Album/Disc10/cover.jpg")) + Expect(imgFiles[4]).To(Equal("Artist/Album/Disc1/cover.1.jpg")) + }) + + It("prioritizes files without numeric suffixes", func() { + // Test case for issue #4683: cover.jpg should come before cover.1.jpg + repo.result = []model.Folder{ + { + Path: "Artist/Album", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.1.jpg", "cover.jpg", "cover.2.jpg"}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(3)) + + // cover.jpg should come first because "cover" < "cover.1" < "cover.2" + Expect(imgFiles[0]).To(Equal("Artist/Album/cover.jpg")) + Expect(imgFiles[1]).To(Equal("Artist/Album/cover.1.jpg")) + Expect(imgFiles[2]).To(Equal("Artist/Album/cover.2.jpg")) + }) + + It("handles case-insensitive sorting", func() { + // Test that Cover.jpg and cover.jpg are treated as equivalent + repo.result = []model.Folder{ + { + Path: "Artist/Album", + ImagesUpdatedAt: now, + ImageFiles: []string{"Folder.jpg", "cover.jpg", "BACK.jpg"}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(3)) + + // Files should be sorted case-insensitively: BACK, cover, Folder + Expect(imgFiles[0]).To(Equal("Artist/Album/BACK.jpg")) + Expect(imgFiles[1]).To(Equal("Artist/Album/cover.jpg")) + Expect(imgFiles[2]).To(Equal("Artist/Album/Folder.jpg")) + }) + + It("includes images from parent folder for multi-disc albums", func() { + // Simulates: Artist/Album/cover.jpg with tracks in Artist/Album/CD1/ and Artist/Album/CD2/ + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist/Album", + Name: "CD1", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + { + ID: "folder2", + Path: "Artist/Album", + Name: "CD2", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + repo.parentResult = &model.Folder{ + ID: "parentFolder", + Path: "Artist", + Name: "Album", + ParentID: "artistFolder", + ImagesUpdatedAt: expectedAt, + ImageFiles: []string{"cover.jpg", "back.jpg"}, + } + + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(*imagesUpdatedAt).To(Equal(expectedAt)) + Expect(imgFiles).To(HaveLen(2)) + Expect(imgFiles[0]).To(Equal("Artist/Album/back.jpg")) + Expect(imgFiles[1]).To(Equal("Artist/Album/cover.jpg")) + }) + + It("does not query parent when parent ID is already in album folders", func() { + // When the parent folder is already one of the album's folders, skip it + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist", + Name: "Album", + ParentID: "folder2", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "", + Name: "Artist", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal("Artist/Album/cover.jpg")) + // Get should not have been called (parent already in folder set) + Expect(repo.getCallCount).To(Equal(0)) + }) + + It("does not query parent when folders have different parents", func() { + // When album folders span different parents, don't search any parent + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist1/Album", + Name: "part1", + ParentID: "parentA", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "Artist2/Album", + Name: "part2", + ParentID: "parentB", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal("Artist1/Album/part1/cover.jpg")) + // Get should not have been called (different parents) + Expect(repo.getCallCount).To(Equal(0)) + }) + + It("does not include library root parent for multi-folder albums", func() { + // Two album parts directly under the library root — parent is the root itself + repo.result = []model.Folder{ + { + ID: "folder1", + Path: ".", + Name: "AlbumPart1", + ParentID: "rootFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: ".", + Name: "AlbumPart2", + ParentID: "rootFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + repo.parentResult = &model.Folder{ + ID: "rootFolder", + Path: "", + Name: ".", + ParentID: "", + ImageFiles: []string{"unrelated.jpg"}, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal("AlbumPart1/cover.jpg")) + Expect(repo.getCallCount).To(Equal(1)) + }) + + It("includes top-level album folder for multi-disc albums", func() { + // Album folder directly under library root, with disc subfolders + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Album", + Name: "Disc1", + ParentID: "albumFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{"folder.jpg"}, + }, + { + ID: "folder2", + Path: "Album", + Name: "Disc2", + ParentID: "albumFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{"folder.jpg"}, + }, + } + repo.parentResult = &model.Folder{ + ID: "albumFolder", + Path: ".", + Name: "Album", + ParentID: "rootFolder", + ImagesUpdatedAt: expectedAt, + ImageFiles: []string{"cover.jpg"}, + } + + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(*imagesUpdatedAt).To(Equal(expectedAt)) + Expect(imgFiles).To(HaveLen(3)) + Expect(imgFiles[0]).To(Equal("Album/cover.jpg")) + Expect(imgFiles[1]).To(Equal("Album/Disc1/folder.jpg")) + Expect(imgFiles[2]).To(Equal("Album/Disc2/folder.jpg")) + Expect(repo.getCallCount).To(Equal(1)) + }) + + It("does not query parent for single-folder albums that already have images", func() { + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist", + Name: "Album", + ParentID: "artistFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + } + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal("Artist/Album/cover.jpg")) + Expect(repo.getCallCount).To(Equal(0)) + }) + + It("includes parent images for single-disc-subfolder albums", func() { + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist/Album", + Name: "disc1", + ParentID: "albumFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + repo.parentResult = &model.Folder{ + ID: "albumFolder", + Path: "Artist", + Name: "Album", + ParentID: "artistFolder", + ImagesUpdatedAt: expectedAt, + ImageFiles: []string{"cover.jpg"}, + } + + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(*imagesUpdatedAt).To(Equal(expectedAt)) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal("Artist/Album/cover.jpg")) + Expect(repo.getCallCount).To(Equal(1)) + }) + + It("propagates non-ErrNotFound errors from parent folder lookup", func() { + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist/Album", + Name: "CD1", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "Artist/Album", + Name: "CD2", + ParentID: "parentFolder", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + repo.getErr = errors.New("db connection failed") + + _, _, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).To(MatchError("db connection failed")) + Expect(repo.getCallCount).To(Equal(1)) + }) + + It("continues gracefully when parent folder is not found", func() { + // Parent folder may have been deleted; should log a warning and continue + repo.result = []model.Folder{ + { + ID: "folder1", + Path: "Artist/Album", + Name: "CD1", + ParentID: "missingParent", + ImagesUpdatedAt: now, + ImageFiles: []string{"cover.jpg"}, + }, + { + ID: "folder2", + Path: "Artist/Album", + Name: "CD2", + ParentID: "missingParent", + ImagesUpdatedAt: now, + ImageFiles: []string{}, + }, + } + // parentResult is nil, so Get will return ErrNotFound + + _, imgFiles, _, err := loadAlbumFoldersPaths(ctx, ds, album) + + Expect(err).ToNot(HaveOccurred()) + Expect(imgFiles).To(HaveLen(1)) + Expect(imgFiles[0]).To(Equal("Artist/Album/CD1/cover.jpg")) + Expect(repo.getCallCount).To(Equal(1)) }) }) }) diff --git a/core/artwork/reader_artist.go b/core/artwork/reader_artist.go index 487346b4d..37b7b6dee 100644 --- a/core/artwork/reader_artist.go +++ b/core/artwork/reader_artist.go @@ -7,7 +7,9 @@ import ( "io" "io/fs" "os" + "path" "path/filepath" + "slices" "strings" "time" @@ -20,13 +22,21 @@ import ( "github.com/navidrome/navidrome/utils/str" ) +const ( + // maxArtistFolderTraversalDepth defines how many directory levels to search + // when looking for artist images (artist folder + parent directories) + maxArtistFolderTraversalDepth = 3 +) + type artistReader struct { cacheKey - a *artwork - provider external.Provider - artist model.Artist - artistFolder string - imgFiles []string + a *artwork + provider external.Provider + artist model.Artist + artistFolder string + imgFiles []string + imgFolderImgPath string // cached path from ArtistImageFolder lookup + lib libraryView } func newArtistArtworkReader(ctx context.Context, artwork *artwork, artID model.ArtworkID, provider external.Provider) (*artistReader, error) { @@ -52,27 +62,46 @@ func newArtistArtworkReader(ctx context.Context, artwork *artwork, artID model.A if err != nil { return nil, err } + var lib libraryView + if len(als) > 0 { + lib, err = loadLibraryView(ctx, artwork.ds, als[0].LibraryID) + if err != nil { + return nil, err + } + } a := &artistReader{ a: artwork, provider: provider, artist: *ar, artistFolder: artistFolder, imgFiles: imgFiles, + lib: lib, } // TODO Find a way to factor in the ExternalUpdateInfoAt in the cache key. Problem is that it can // change _after_ retrieving from external sources, making the key invalid //a.cacheKey.lastUpdate = ar.ExternalInfoUpdatedAt a.cacheKey.lastUpdate = *imagesUpdatedAt + if ar.UpdatedAt != nil && ar.UpdatedAt.After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = *ar.UpdatedAt + } if artistFolderLastUpdate.After(a.cacheKey.lastUpdate) { a.cacheKey.lastUpdate = artistFolderLastUpdate } + if conf.Server.ArtistImageFolder != "" && strings.Contains(strings.ToLower(conf.Server.ArtistArtPriority), "image-folder") { + a.imgFolderImgPath = findImageInArtistFolder(conf.Server.ArtistImageFolder, ar.MbzArtistID, ar.Name) + if a.imgFolderImgPath != "" { + if info, err := os.Stat(a.imgFolderImgPath); err == nil && info.ModTime().After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = info.ModTime() + } + } + } a.cacheKey.artID = artID return a, nil } func (a *artistReader) Key() string { - hash := md5.Sum([]byte(conf.Server.Agents + conf.Server.Spotify.ID)) + hash := md5.Sum([]byte(conf.Server.Agents)) return fmt.Sprintf( "%s.%t.%x", a.cacheKey.Key(), @@ -86,58 +115,128 @@ func (a *artistReader) LastUpdated() time.Time { } func (a *artistReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { - var ff = a.fromArtistArtPriority(ctx, conf.Server.ArtistArtPriority) + ff := []sourceFunc{a.fromArtistUploadedImage()} + ff = append(ff, a.fromArtistArtPriority(ctx, conf.Server.ArtistArtPriority)...) return selectImageReader(ctx, a.artID, ff...) } +func (a *artistReader) fromArtistUploadedImage() sourceFunc { + return fromLocalFile(a.artist.UploadedImagePath()) +} + func (a *artistReader) fromArtistArtPriority(ctx context.Context, priority string) []sourceFunc { var ff []sourceFunc - for _, pattern := range strings.Split(strings.ToLower(priority), ",") { + for pattern := range strings.SplitSeq(strings.ToLower(priority), ",") { pattern = strings.TrimSpace(pattern) switch { case pattern == "external": ff = append(ff, fromArtistExternalSource(ctx, a.artist, a.provider)) + case pattern == "image-folder": + ff = append(ff, a.fromArtistImageFolder(ctx)) case strings.HasPrefix(pattern, "album/"): - ff = append(ff, fromExternalFile(ctx, a.imgFiles, strings.TrimPrefix(pattern, "album/"))) + if a.lib.FS != nil { + ff = append(ff, fromExternalFile(ctx, a.lib.FS, a.imgFiles, strings.TrimPrefix(pattern, "album/"))) + } default: - ff = append(ff, fromArtistFolder(ctx, a.artistFolder, pattern)) + ff = append(ff, fromArtistFolder(ctx, a.lib.FS, a.lib.absRoot, a.artistFolder, pattern)) } } return ff } -func fromArtistFolder(ctx context.Context, artistFolder string, pattern string) sourceFunc { +// fromArtistFolder walks up from artistFolder toward libPath looking for a +// file matching pattern. Traversal is bounded by both maxArtistFolderTraversalDepth +// and the library root: once we reach libPath (or if artistFolder is outside +// libPath), the walk stops. All reads go through libFS, which keeps artwork +// resolution scoped to the configured library. +func fromArtistFolder(ctx context.Context, libFS fs.FS, libPath, artistFolder, pattern string) sourceFunc { return func() (io.ReadCloser, string, error) { - fsys := os.DirFS(artistFolder) - matches, err := fs.Glob(fsys, pattern) - if err != nil { - log.Warn(ctx, "Error matching artist image pattern", "pattern", pattern, "folder", artistFolder) - return nil, "", err + if libFS == nil { + return nil, "", fmt.Errorf("artist folder lookup unavailable") } - if len(matches) == 0 { - return nil, "", fmt.Errorf(`no matches for '%s' in '%s'`, pattern, artistFolder) + rel, err := filepath.Rel(libPath, artistFolder) + if err != nil || rel == ".." || strings.HasPrefix(rel, ".."+string(filepath.Separator)) { + return nil, "", fmt.Errorf(`artist folder '%s' is outside library '%s'`, artistFolder, libPath) } - for _, m := range matches { - filePath := filepath.Join(artistFolder, m) - if !model.IsImageFile(m) { - continue + // fs.Glob / path.Join below expect forward-slash paths; filepath.Rel may + // return backslash separators on Windows. + rel = filepath.ToSlash(rel) + current := artistFolder + for range maxArtistFolderTraversalDepth { + reader, hit, err := findImageInFolder(ctx, libFS, rel, current, pattern) + if err == nil { + return reader, hit, nil } - f, err := os.Open(filePath) - if err != nil { - log.Warn(ctx, "Could not open cover art file", "file", filePath, err) - return nil, "", err + if rel == "." { + break // reached library root; don't traverse above it } - return f, filePath, nil + rel = path.Dir(rel) + current = filepath.Dir(current) } - return nil, "", nil + return nil, "", fmt.Errorf(`no matches for '%s' in '%s' or its parent directories (within library)`, pattern, artistFolder) } } +// findImageInFolder globs libFS at relFolder for pattern and returns the first +// matching image. absFolder is used only for the returned display path and log +// messages so callers see absolute-looking paths consistent with the rest of +// the artwork pipeline. +func findImageInFolder(ctx context.Context, libFS fs.FS, relFolder, absFolder, pattern string) (io.ReadCloser, string, error) { + log.Trace(ctx, "looking for artist image", "pattern", pattern, "folder", absFolder) + globPattern := pattern + if relFolder != "." { + globPattern = path.Join(escapeGlobLiteral(relFolder), pattern) + } + matches, err := fs.Glob(libFS, globPattern) + if err != nil { + log.Warn(ctx, "Error matching artist image pattern", "pattern", pattern, "folder", absFolder, err) + return nil, "", err + } + + // Filter to valid image files + var imagePaths []string + for _, m := range matches { + if !model.IsImageFile(m) { + continue + } + imagePaths = append(imagePaths, m) + } + + // Sort image files by prioritizing base filenames without numeric + // suffixes (e.g., artist.jpg before artist.1.jpg) + slices.SortFunc(imagePaths, compareImageFiles) + + for _, p := range imagePaths { + f, err := libFS.Open(p) + if err != nil { + log.Warn(ctx, "Could not open cover art file", "file", p, err) + continue + } + _, name := path.Split(p) + return f, filepath.Join(absFolder, name), nil + } + + return nil, "", fmt.Errorf(`no matches for '%s' in '%s'`, pattern, absFolder) +} + +func escapeGlobLiteral(s string) string { + var b strings.Builder + b.Grow(len(s)) + for _, r := range s { + switch r { + case '\\', '*', '?', '[', ']': + b.WriteByte('\\') + } + b.WriteRune(r) + } + return b.String() +} + func loadArtistFolder(ctx context.Context, ds model.DataStore, albums model.Albums, paths []string) (string, time.Time, error) { if len(albums) == 0 { return "", time.Time{}, nil } - libID := albums[0].LibraryID // Just need one of the albums, as they should all be in the same Library + libID := albums[0].LibraryID // Just need one of the albums, as they should all be in the same Library - for now! TODO: Support multiple libraries folderPath := str.LongestCommonPrefix(paths) if !strings.HasSuffix(folderPath, string(filepath.Separator)) { @@ -162,3 +261,51 @@ func loadArtistFolder(ctx context.Context, ds model.DataStore, albums model.Albu } return folderPath, folders[0].ImagesUpdatedAt, nil } + +func (a *artistReader) fromArtistImageFolder(ctx context.Context) sourceFunc { + return func() (io.ReadCloser, string, error) { + folder := conf.Server.ArtistImageFolder + if folder == "" { + return nil, "", nil + } + // Use cached path from newArtistArtworkReader if available, + // avoiding a second directory scan. + path := a.imgFolderImgPath + if path == "" { + path = findImageInArtistFolder(folder, a.artist.MbzArtistID, a.artist.Name) + } + if path == "" { + return nil, "", fmt.Errorf("no image found for artist %q in %s", a.artist.Name, folder) + } + f, err := os.Open(path) + if err != nil { + return nil, "", err + } + return f, path, nil + } +} + +// findImageInArtistFolder scans a folder for an image file matching the artist's MBID or name +// (case-insensitive). Returns the full path, or empty string if not found. +func findImageInArtistFolder(folder, mbzArtistID, artistName string) string { + entries, err := os.ReadDir(folder) + if err != nil { + return "" + } + for _, candidate := range []string{mbzArtistID, artistName} { + if candidate == "" { + continue + } + for _, entry := range entries { + if entry.IsDir() { + continue + } + name := entry.Name() + base := strings.TrimSuffix(name, filepath.Ext(name)) + if strings.EqualFold(base, candidate) && model.IsImageFile(name) { + return filepath.Join(folder, name) + } + } + } + return "" +} diff --git a/core/artwork/reader_artist_test.go b/core/artwork/reader_artist_test.go index 294a5db0b..50ca3a2ce 100644 --- a/core/artwork/reader_artist_test.go +++ b/core/artwork/reader_artist_test.go @@ -3,9 +3,14 @@ package artwork import ( "context" "errors" + "io" + "io/fs" + "os" "path/filepath" "time" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/model" . "github.com/onsi/ginkgo/v2" @@ -62,7 +67,7 @@ var _ = Describe("artistArtworkReader", func() { } folder, upd, err := loadArtistFolder(ctx, fds, albums, paths) Expect(err).ToNot(HaveOccurred()) - Expect(folder).To(Equal("/music/artist")) + Expect(folder).To(Equal(filepath.FromSlash("/music/artist"))) Expect(upd).To(Equal(expectedUpdTime)) }) }) @@ -88,7 +93,7 @@ var _ = Describe("artistArtworkReader", func() { } folder, upd, err := loadArtistFolder(ctx, fds, albums, paths) Expect(err).ToNot(HaveOccurred()) - Expect(folder).To(Equal("/music/artist")) + Expect(folder).To(Equal(filepath.FromSlash("/music/artist"))) Expect(upd).To(Equal(expectedUpdTime)) }) }) @@ -108,18 +113,612 @@ var _ = Describe("artistArtworkReader", func() { }) }) }) + + var _ = Describe("fromArtistFolder", func() { + var ( + ctx context.Context + tempDir string + libFS fs.FS + testFunc sourceFunc + ) + + BeforeEach(func() { + ctx = context.Background() + tempDir = GinkgoT().TempDir() + libFS = os.DirFS(tempDir) + }) + + When("artist folder contains matching image", func() { + BeforeEach(func() { + // Create test structure: /temp/artist/artist.jpg + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + artistImagePath := filepath.Join(artistDir, "artist.jpg") + Expect(os.WriteFile(artistImagePath, []byte("fake image data"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("finds and returns the image", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("artist.jpg")) + + // Verify we can read the content + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("fake image data")) + reader.Close() + }) + }) + + When("artist folder name contains glob metacharacters", func() { + BeforeEach(func() { + artistDir := filepath.Join(tempDir, "Artist [Live]") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + artistImagePath := filepath.Join(artistDir, "artist.jpg") + Expect(os.WriteFile(artistImagePath, []byte("bracketed artist image"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("treats the folder path literally when globbing through the library fs", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("Artist [Live]" + string(filepath.Separator) + "artist.jpg")) + + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("bracketed artist image")) + reader.Close() + }) + }) + + When("artist folder is empty but parent contains image", func() { + BeforeEach(func() { + // Create test structure: /temp/parent/artist.jpg and /temp/parent/artist/album/ + parentDir := filepath.Join(tempDir, "parent") + artistDir := filepath.Join(parentDir, "artist") + albumDir := filepath.Join(artistDir, "album") + Expect(os.MkdirAll(albumDir, 0755)).To(Succeed()) + + // Put artist image in parent directory + artistImagePath := filepath.Join(parentDir, "artist.jpg") + Expect(os.WriteFile(artistImagePath, []byte("parent image"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("finds image in parent directory", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("parent" + string(filepath.Separator) + "artist.jpg")) + + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("parent image")) + reader.Close() + }) + }) + + When("image is two levels up", func() { + BeforeEach(func() { + // Create test structure: /temp/grandparent/artist.jpg and /temp/grandparent/parent/artist/ + grandparentDir := filepath.Join(tempDir, "grandparent") + parentDir := filepath.Join(grandparentDir, "parent") + artistDir := filepath.Join(parentDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Put artist image in grandparent directory + artistImagePath := filepath.Join(grandparentDir, "artist.jpg") + Expect(os.WriteFile(artistImagePath, []byte("grandparent image"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("finds image in grandparent directory", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("grandparent" + string(filepath.Separator) + "artist.jpg")) + + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("grandparent image")) + reader.Close() + }) + }) + + When("images exist at multiple levels", func() { + BeforeEach(func() { + // Create test structure with images at multiple levels + grandparentDir := filepath.Join(tempDir, "grandparent") + parentDir := filepath.Join(grandparentDir, "parent") + artistDir := filepath.Join(parentDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Put artist images at all levels + Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("artist level"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(parentDir, "artist.jpg"), []byte("parent level"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(grandparentDir, "artist.jpg"), []byte("grandparent level"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("prioritizes the closest (artist folder) image", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("artist" + string(filepath.Separator) + "artist.jpg")) + + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("artist level")) + reader.Close() + }) + }) + + When("pattern matches multiple files", func() { + BeforeEach(func() { + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Create multiple matching files + Expect(os.WriteFile(filepath.Join(artistDir, "artist.abc"), []byte("text file"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.png"), []byte("png image"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("jpg image"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("returns the first valid image file in sorted order", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + + // Should return an image file, + // Files are sorted: jpg comes before png alphabetically. + // .abc comes first, but it's not an image. + Expect(path).To(ContainSubstring("artist.jpg")) + reader.Close() + }) + }) + + When("prioritizing files without numeric suffixes", func() { + BeforeEach(func() { + // Test case for issue #4683: artist.jpg should come before artist.1.jpg + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Create multiple matches with and without numeric suffixes + Expect(os.WriteFile(filepath.Join(artistDir, "artist.1.jpg"), []byte("artist 1"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("artist main"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.2.jpg"), []byte("artist 2"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("returns artist.jpg before artist.1.jpg and artist.2.jpg", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("artist.jpg")) + + // Verify it's the main file, not a numbered variant + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("artist main")) + reader.Close() + }) + }) + + When("handling case-insensitive sorting", func() { + BeforeEach(func() { + // Test case to ensure case-insensitive natural sorting + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Create files with mixed case names + Expect(os.WriteFile(filepath.Join(artistDir, "Folder.jpg"), []byte("folder"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "artist.jpg"), []byte("artist"), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(artistDir, "BACK.jpg"), []byte("back"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "*.*") + }) + + It("sorts case-insensitively", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + + // Should return artist.jpg first (case-insensitive: "artist" < "back" < "folder") + Expect(path).To(ContainSubstring("artist.jpg")) + + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("artist")) + reader.Close() + }) + }) + + When("no matching files exist anywhere", func() { + BeforeEach(func() { + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Create non-matching files + Expect(os.WriteFile(filepath.Join(artistDir, "cover.jpg"), []byte("cover image"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("returns an error", func() { + reader, path, err := testFunc() + Expect(err).To(HaveOccurred()) + Expect(reader).To(BeNil()) + Expect(path).To(BeEmpty()) + Expect(err.Error()).To(ContainSubstring("no matches for 'artist.*'")) + Expect(err.Error()).To(ContainSubstring("parent directories")) + }) + }) + + When("directory traversal reaches filesystem root", func() { + BeforeEach(func() { + // Start from a shallow directory to test root boundary + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("handles root boundary gracefully", func() { + reader, path, err := testFunc() + Expect(err).To(HaveOccurred()) + Expect(reader).To(BeNil()) + Expect(path).To(BeEmpty()) + // Should not panic or cause infinite loop + }) + }) + + When("file exists but cannot be opened", func() { + BeforeEach(func() { + artistDir := filepath.Join(tempDir, "artist") + Expect(os.MkdirAll(artistDir, 0755)).To(Succeed()) + + // Create a file that cannot be opened (permission denied) + restrictedFile := filepath.Join(artistDir, "artist.jpg") + Expect(os.WriteFile(restrictedFile, []byte("restricted"), 0600)).To(Succeed()) + + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("logs warning and continues searching", func() { + // This test depends on the ability to restrict file permissions + // For now, we'll just ensure it doesn't panic and returns appropriate error + reader, _, err := testFunc() + // The file should be readable in test environment, so this will succeed + // In a real scenario with permission issues, it would continue searching + if err == nil { + Expect(reader).ToNot(BeNil()) + reader.Close() + } + }) + }) + + When("single album artist scenario (original issue)", func() { + BeforeEach(func() { + // Simulate the exact folder structure from the issue: + // /music/artist/album1/ (single album) + // /music/artist/artist.jpg (artist image that should be found) + artistDir := filepath.Join(tempDir, "music", "artist") + albumDir := filepath.Join(artistDir, "album1") + Expect(os.MkdirAll(albumDir, 0755)).To(Succeed()) + + // Create artist.jpg in the artist folder (this was not being found before) + artistImagePath := filepath.Join(artistDir, "artist.jpg") + Expect(os.WriteFile(artistImagePath, []byte("single album artist image"), 0600)).To(Succeed()) + + // The fromArtistFolder is called with the artist folder path + testFunc = fromArtistFolder(ctx, libFS, tempDir, artistDir, "artist.*") + }) + + It("finds artist.jpg in artist folder for single album artist", func() { + reader, path, err := testFunc() + Expect(err).ToNot(HaveOccurred()) + Expect(reader).ToNot(BeNil()) + Expect(path).To(ContainSubstring("artist.jpg")) + Expect(path).To(ContainSubstring("artist")) + + // Verify the content + data, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("single album artist image")) + reader.Close() + }) + }) + }) + + Describe("fromArtistUploadedImage", func() { + var ( + tempDir string + reader *artistReader + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tempDir = GinkgoT().TempDir() + conf.Server.DataFolder = conf.NewDir(tempDir) + + // Create the artwork/artist directory + Expect(os.MkdirAll(filepath.Join(tempDir, "artwork", "artist"), 0755)).To(Succeed()) + + reader = &artistReader{} + }) + + When("artist has an uploaded image", func() { + It("returns the uploaded image", func() { + imgPath := filepath.Join(tempDir, "artwork", "artist", "ar-1_test.jpg") + Expect(os.WriteFile(imgPath, []byte("uploaded artist image"), 0600)).To(Succeed()) + + reader.artist = model.Artist{ID: "ar-1", UploadedImage: "ar-1_test.jpg"} + sf := reader.fromArtistUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("uploaded artist image")) + r.Close() + }) + }) + + When("artist has no uploaded image", func() { + It("returns nil reader (falls through)", func() { + reader.artist = model.Artist{ID: "ar-1"} + sf := reader.fromArtistUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + }) + }) + + Describe("fromArtistImageFolder", func() { + var ( + ctx context.Context + tempDir string + ar *artistReader + ) + + BeforeEach(func() { + ctx = context.Background() + DeferCleanup(configtest.SetupConfig()) + tempDir = GinkgoT().TempDir() + ar = &artistReader{} + }) + + When("ArtistImageFolder is not configured", func() { + It("returns nil (skips)", func() { + conf.Server.ArtistImageFolder = "" + ar.artist = model.Artist{Name: "Test Artist"} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + }) + + When("image exists matching MBID", func() { + It("finds the image by MBID", func() { + conf.Server.ArtistImageFolder = tempDir + mbid := "f27ec8db-af05-4f36-916e-3d57f91ecf5e" + imgPath := filepath.Join(tempDir, mbid+".jpg") + Expect(os.WriteFile(imgPath, []byte("mbid image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: mbid} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("mbid image")) + r.Close() + }) + }) + + When("MBID match is case-insensitive", func() { + It("finds the image regardless of case", func() { + conf.Server.ArtistImageFolder = tempDir + mbid := "F27EC8DB-AF05-4F36-916E-3D57F91ECF5E" + imgPath := filepath.Join(tempDir, "f27ec8db-af05-4f36-916e-3d57f91ecf5e.png") + Expect(os.WriteFile(imgPath, []byte("mbid case image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: mbid} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + + When("no MBID file exists but artist name file does", func() { + It("falls back to artist name match", func() { + conf.Server.ArtistImageFolder = tempDir + imgPath := filepath.Join(tempDir, "Test Artist.jpg") + Expect(os.WriteFile(imgPath, []byte("name image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: "nonexistent-mbid"} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("name image")) + r.Close() + }) + }) + + When("artist name match is case-insensitive", func() { + It("matches regardless of case", func() { + conf.Server.ArtistImageFolder = tempDir + imgPath := filepath.Join(tempDir, "test artist.jpg") + Expect(os.WriteFile(imgPath, []byte("case insensitive"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist"} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + + When("both MBID and name files exist", func() { + It("prefers MBID over name match", func() { + conf.Server.ArtistImageFolder = tempDir + mbid := "f27ec8db-af05-4f36-916e-3d57f91ecf5e" + mbidPath := filepath.Join(tempDir, mbid+".jpg") + namePath := filepath.Join(tempDir, "Test Artist.jpg") + Expect(os.WriteFile(mbidPath, []byte("mbid image"), 0600)).To(Succeed()) + Expect(os.WriteFile(namePath, []byte("name image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist", MbzArtistID: mbid} + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(mbidPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("mbid image")) + r.Close() + }) + }) + + When("no matching image found", func() { + It("returns an error", func() { + conf.Server.ArtistImageFolder = tempDir + // Create an unrelated file + Expect(os.WriteFile(filepath.Join(tempDir, "other.jpg"), []byte("other"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist"} + sf := ar.fromArtistImageFolder(ctx) + r, _, err := sf() + Expect(err).To(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(err.Error()).To(ContainSubstring("no image found")) + }) + }) + + When("cached imgFolderImgPath is set", func() { + It("uses cached path instead of scanning", func() { + conf.Server.ArtistImageFolder = tempDir + imgPath := filepath.Join(tempDir, "cached.jpg") + Expect(os.WriteFile(imgPath, []byte("cached image"), 0600)).To(Succeed()) + + ar.artist = model.Artist{Name: "Test Artist"} + ar.imgFolderImgPath = imgPath + sf := ar.fromArtistImageFolder(ctx) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + + data, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("cached image")) + r.Close() + }) + }) + }) + + Describe("findImageInArtistFolder", func() { + var tempDir string + + BeforeEach(func() { + tempDir = GinkgoT().TempDir() + }) + + When("matching file exists by MBID", func() { + It("returns the file path", func() { + mbid := "f27ec8db-af05-4f36-916e-3d57f91ecf5e" + imgPath := filepath.Join(tempDir, mbid+".jpg") + Expect(os.WriteFile(imgPath, []byte("image"), 0600)).To(Succeed()) + + path := findImageInArtistFolder(tempDir, mbid, "Test") + Expect(path).To(Equal(imgPath)) + }) + }) + + When("matching file exists by name", func() { + It("returns the file path", func() { + imgPath := filepath.Join(tempDir, "Test Artist.png") + Expect(os.WriteFile(imgPath, []byte("image"), 0600)).To(Succeed()) + + path := findImageInArtistFolder(tempDir, "", "Test Artist") + Expect(path).To(Equal(imgPath)) + }) + }) + + When("no matching file exists", func() { + It("returns empty string", func() { + path := findImageInArtistFolder(tempDir, "", "Unknown Artist") + Expect(path).To(BeEmpty()) + }) + }) + + When("folder does not exist", func() { + It("returns empty string", func() { + path := findImageInArtistFolder("/nonexistent/path", "", "Test") + Expect(path).To(BeEmpty()) + }) + }) + }) }) type fakeFolderRepo struct { model.FolderRepository - result []model.Folder - err error + result []model.Folder + parentResult *model.Folder + getErr error + getCallCount int + err error } func (f *fakeFolderRepo) GetAll(...model.QueryOptions) ([]model.Folder, error) { return f.result, f.err } +func (f *fakeFolderRepo) Get(id string) (*model.Folder, error) { + f.getCallCount++ + if f.getErr != nil { + return nil, f.getErr + } + if f.parentResult != nil { + return f.parentResult, nil + } + return nil, model.ErrNotFound +} + type fakeDataStore struct { model.DataStore folderRepo *fakeFolderRepo diff --git a/core/artwork/reader_disc.go b/core/artwork/reader_disc.go new file mode 100644 index 000000000..0f648c987 --- /dev/null +++ b/core/artwork/reader_disc.go @@ -0,0 +1,267 @@ +package artwork + +import ( + "context" + "crypto/md5" + "fmt" + "io" + "path" + "path/filepath" + "strconv" + "strings" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils" +) + +type discArtworkReader struct { + cacheKey + a *artwork + album model.Album + discNumber int + imgFiles []string // library-relative, forward-slash, no leading slash + discFoldersRel map[string]bool // library-relative folder paths + isMultiFolder bool + firstTrackRel string // library-relative; for fromTag / ffmpeg via lib.Abs + lib libraryView + updatedAt *time.Time +} + +func newDiscArtworkReader(ctx context.Context, a *artwork, artID model.ArtworkID) (*discArtworkReader, error) { + albumID, discNumber, err := model.ParseDiscArtworkID(artID.ID) + if err != nil { + return nil, fmt.Errorf("invalid disc artwork id '%s': %w", artID.ID, err) + } + + al, err := a.ds.Album(ctx).Get(albumID) + if err != nil { + return nil, err + } + + _, imgFiles, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, a.ds, *al) + if err != nil { + return nil, err + } + + // Query mediafiles for this album + disc to find folder associations and first track + mfs, err := a.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Sort: "track_number", + Order: "ASC", + Filters: squirrel.Eq{"album_id": albumID, "disc_number": discNumber}, + }) + if err != nil { + return nil, err + } + + lib, err := loadLibraryView(ctx, a.ds, al.LibraryID) + if err != nil { + return nil, err + } + + // Build disc folder set and find first track. mf.Path is already library-relative. + var firstTrackRel string + allFolderIDs := make(map[string]bool) + for _, mf := range mfs { + allFolderIDs[mf.FolderID] = true + if firstTrackRel == "" { + firstTrackRel = filepath.ToSlash(mf.Path) + } + } + + // Resolve folder IDs to library-relative paths + discFoldersRel := make(map[string]bool) + if len(allFolderIDs) > 0 { + folderIDs := make([]string, 0, len(allFolderIDs)) + for id := range allFolderIDs { + folderIDs = append(folderIDs, id) + } + folders, err := a.ds.Folder(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"folder.id": folderIDs}, + }) + if err != nil { + return nil, err + } + for _, f := range folders { + rel := strings.TrimPrefix(path.Join(f.Path, f.Name), "/") + discFoldersRel[rel] = true + } + } + + isMultiFolder := len(al.FolderIDs) > 1 + + r := &discArtworkReader{ + a: a, + album: *al, + discNumber: discNumber, + imgFiles: imgFiles, + discFoldersRel: discFoldersRel, + isMultiFolder: isMultiFolder, + firstTrackRel: firstTrackRel, + lib: lib, + updatedAt: imagesUpdatedAt, + } + r.cacheKey.artID = artID + r.cacheKey.lastUpdate = utils.TimeNewest(al.UpdatedAt, al.ImportedAt) + if imagesUpdatedAt != nil { + r.cacheKey.lastUpdate = utils.TimeNewest(r.cacheKey.lastUpdate, *imagesUpdatedAt) + } + return r, nil +} + +func (d *discArtworkReader) Key() string { + hash := md5.Sum([]byte(conf.Server.DiscArtPriority)) + return fmt.Sprintf( + "%s.%x", + d.cacheKey.Key(), + hash, + ) +} + +func (d *discArtworkReader) LastUpdated() time.Time { + return d.lastUpdate +} + +func (d *discArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { + var ff = d.fromDiscArtPriority(ctx, d.a.ffmpeg, conf.Server.DiscArtPriority) + // Fallback to album cover art + albumArtID := model.NewArtworkID(model.KindAlbumArtwork, d.album.ID, &d.album.UpdatedAt) + ff = append(ff, fromAlbum(ctx, d.a, albumArtID)) + return selectImageReader(ctx, d.cacheKey.artID, ff...) +} + +func (d *discArtworkReader) fromDiscArtPriority(ctx context.Context, ffmpeg ffmpeg.FFmpeg, priority string) []sourceFunc { + var ff []sourceFunc + for pattern := range strings.SplitSeq(strings.ToLower(priority), ",") { + pattern = strings.TrimSpace(pattern) + switch { + case pattern == "embedded": + ff = append(ff, + fromTag(ctx, d.lib.FS, d.firstTrackRel), + fromFFmpegTag(ctx, ffmpeg, d.lib.Abs(d.firstTrackRel)), + ) + case pattern == "external": + // Not supported for disc art, silently ignore + case pattern == "discsubtitle": + if subtitle := strings.TrimSpace(d.album.Discs[d.discNumber]); subtitle != "" { + ff = append(ff, d.fromDiscSubtitle(ctx, subtitle)) + } + case len(d.imgFiles) > 0: + ff = append(ff, d.fromExternalFile(ctx, pattern)) + } + } + return ff +} + +// fromDiscSubtitle returns a sourceFunc that matches image files whose stem +// (filename without extension) equals the disc subtitle (case-insensitive). +func (d *discArtworkReader) fromDiscSubtitle(ctx context.Context, subtitle string) sourceFunc { + return func() (io.ReadCloser, string, error) { + for _, file := range d.imgFiles { + name := path.Base(file) + stem := strings.TrimSuffix(name, path.Ext(name)) + if !strings.EqualFold(stem, subtitle) { + continue + } + f, err := d.lib.FS.Open(file) + if err != nil { + log.Warn(ctx, "Could not open disc art file", "file", file, err) + continue + } + return f, file, nil + } + return nil, "", fmt.Errorf("disc %d: no image file matching subtitle %q", d.discNumber, subtitle) + } +} + +// globMetaChars holds the substitution metacharacters understood by +// filepath.Match. The '\' escape character is intentionally excluded: +// disc art patterns come from user config and never include escaped +// metachars in practice, and treating '\' as a metachar would misalign +// the literal-prefix extraction in extractDiscNumber. +const globMetaChars = "*?[" + +// extractDiscNumber parses the disc number from a filename matched by a +// filepath.Match-style glob pattern. +// +// Both pattern and filename must already be lowercased by the caller, which +// is also expected to have verified that filepath.Match(pattern, filename) +// is true before calling this function. +func extractDiscNumber(pattern, filename string) (int, bool) { + metaIdx := strings.IndexAny(pattern, globMetaChars) + if metaIdx < 0 { + return 0, false + } + prefix := pattern[:metaIdx] + if !strings.HasPrefix(filename, prefix) { + return 0, false + } + + start := len(prefix) + end := start + for end < len(filename) && filename[end] >= '0' && filename[end] <= '9' { + end++ + } + if end == start { + return 0, false + } + num, err := strconv.Atoi(filename[start:end]) + if err != nil { + return 0, false + } + return num, true +} + +// fromExternalFile returns a sourceFunc that matches image files against a glob +// pattern. A numbered filename whose number equals the target disc wins over +// any unnumbered candidate; callers must pass a lowercase pattern. +func (d *discArtworkReader) fromExternalFile(ctx context.Context, pattern string) sourceFunc { + isLiteral := !strings.ContainsAny(pattern, globMetaChars) + return func() (io.ReadCloser, string, error) { + var fallbacks []string + for _, file := range d.imgFiles { + name := strings.ToLower(path.Base(file)) + match, err := filepath.Match(pattern, name) + if err != nil { + log.Warn(ctx, "Error matching disc art file to pattern", "pattern", pattern, "file", file) + continue + } + if !match { + continue + } + + if !isLiteral { + if num, hasNum := extractDiscNumber(pattern, name); hasNum { + if num != d.discNumber { + continue + } + f, err := d.lib.FS.Open(file) + if err != nil { + log.Warn(ctx, "Could not open disc art file", "file", file, err) + continue + } + return f, file, nil + } + } + + if d.isMultiFolder && !d.discFoldersRel[path.Dir(file)] { + continue + } + fallbacks = append(fallbacks, file) + } + + for _, file := range fallbacks { + f, err := d.lib.FS.Open(file) + if err != nil { + log.Warn(ctx, "Could not open disc art file", "file", file, err) + continue + } + return f, file, nil + } + return nil, "", fmt.Errorf("disc %d: pattern '%s' not matched by files", d.discNumber, pattern) + } +} diff --git a/core/artwork/reader_disc_test.go b/core/artwork/reader_disc_test.go new file mode 100644 index 000000000..8264ee27b --- /dev/null +++ b/core/artwork/reader_disc_test.go @@ -0,0 +1,492 @@ +package artwork + +import ( + "context" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Disc Artwork Reader", func() { + Describe("extractDiscNumber", func() { + DescribeTable("extracts disc number from filename based on glob pattern", + func(pattern, filename string, expectedNum int, expectedOk bool) { + num, ok := extractDiscNumber(pattern, filename) + Expect(ok).To(Equal(expectedOk)) + if expectedOk { + Expect(num).To(Equal(expectedNum)) + } + }, + // Standard disc patterns + Entry("disc1.jpg", "disc*.*", "disc1.jpg", 1, true), + Entry("disc2.png", "disc*.*", "disc2.png", 2, true), + Entry("disc01.jpg", "disc*.*", "disc01.jpg", 1, true), + Entry("disc02.png", "disc*.*", "disc02.png", 2, true), + Entry("disc10.jpg", "disc*.*", "disc10.jpg", 10, true), + + // CD patterns + Entry("cd1.jpg", "cd*.*", "cd1.jpg", 1, true), + Entry("cd02.png", "cd*.*", "cd02.png", 2, true), + + // No number in filename + Entry("disc.jpg has no number", "disc*.*", "disc.jpg", 0, false), + Entry("cd.jpg has no number", "cd*.*", "cd.jpg", 0, false), + + // Extra text after number + Entry("disc2-bonus.jpg", "disc*.*", "disc2-bonus.jpg", 2, true), + Entry("disc01_front.png", "disc*.*", "disc01_front.png", 1, true), + + // Case insensitive (filename already lowered by caller) + Entry("Disc1.jpg lowered", "disc*.*", "disc1.jpg", 1, true), + + // HasPrefix guard: filename doesn't share the pattern's literal prefix + Entry("cover.jpg with disc*.* (no prefix match)", "disc*.*", "cover.jpg", 0, false), + + // Pattern with no wildcard before dot + Entry("front1.jpg with front*.*", "front*.*", "front1.jpg", 1, true), + + // '?' single-char wildcard + Entry("disc?.jpg with disc1.jpg", "disc?.jpg", "disc1.jpg", 1, true), + Entry("disc?.jpg with disc2.jpg", "disc?.jpg", "disc2.jpg", 2, true), + Entry("cd??.jpg with cd07.jpg", "cd??.jpg", "cd07.jpg", 7, true), + + // '[...]' character class wildcard + Entry("cd[12].jpg with cd1.jpg", "cd[12].jpg", "cd1.jpg", 1, true), + Entry("cd[12].jpg with cd2.jpg", "cd[12].jpg", "cd2.jpg", 2, true), + Entry("disc[0-9].jpg with disc5.jpg", "disc[0-9].jpg", "disc5.jpg", 5, true), + + // Literal pattern (no wildcard) returns false + Entry("shellac.png literal", "shellac.png", "shellac.png", 0, false), + ) + }) + + Describe("fromExternalFile", func() { + var ( + ctx context.Context + tmpDir string + ) + + BeforeEach(func() { + ctx = context.Background() + tmpDir = GinkgoT().TempDir() + }) + + // createFile creates the file on disk and returns its library-relative forward-slash path. + createFile := func(relPath string) string { + fullPath := filepath.Join(tmpDir, filepath.FromSlash(relPath)) + Expect(os.MkdirAll(filepath.Dir(fullPath), 0755)).To(Succeed()) + Expect(os.WriteFile(fullPath, []byte("image data"), 0600)).To(Succeed()) + return relPath + } + + // removeFile removes a library-relative file from disk. + removeFile := func(relPath string) { + Expect(os.Remove(filepath.Join(tmpDir, filepath.FromSlash(relPath)))).To(Succeed()) + } + + It("matches file with disc number in single-folder album", func() { + f1 := createFile("album/disc1.jpg") + f2 := createFile("album/disc2.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("matches file without number in single-folder album (shared disc art)", func() { + f1 := createFile("album/cover.png") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "cover.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("returns shared disc art for every disc number in single-folder album", func() { + f1 := createFile("album/shellac.png") + makeReader := func(discNum int) *discArtworkReader { + return &discArtworkReader{ + discNumber: discNum, + imgFiles: []string{f1}, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + } + + for _, disc := range []int{1, 2, 5} { + sf := makeReader(disc).fromExternalFile(ctx, "shellac.png") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred(), "disc %d", disc) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1), "disc %d", disc) + } + }) + + It("numbered and unnumbered patterns both resolve against the same reader", func() { + f1 := createFile("album/cover.png") + f2 := createFile("album/disc1.jpg") + f3 := createFile("album/disc2.jpg") + reader := &discArtworkReader{ + discNumber: 2, + imgFiles: []string{f1, f2, f3}, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f3)) + + sf = reader.fromExternalFile(ctx, "cover.*") + r, path, err = sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("respects DiscArtPriority order when both numbered and unnumbered patterns match", func() { + f1 := createFile("album/cover.png") + f2 := createFile("album/disc1.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + ff := reader.fromDiscArtPriority(ctx, nil, "disc*.*, cover.*") + Expect(ff).To(HaveLen(2)) + r, path, err := ff[0]() + Expect(err).ToNot(HaveOccurred()) + Expect(path).To(Equal(f2)) + r.Close() + + ff = reader.fromDiscArtPriority(ctx, nil, "cover.*, disc*.*") + Expect(ff).To(HaveLen(2)) + r, path, err = ff[0]() + Expect(err).ToNot(HaveOccurred()) + Expect(path).To(Equal(f1)) + r.Close() + }) + + DescribeTable("numbered match wins over shared fallback within a pattern", + func(discNumber, expectedIdx int) { + files := []string{ + createFile("album/disc.jpg"), + createFile("album/disc1.jpg"), + createFile("album/disc2.jpg"), + } + reader := &discArtworkReader{ + discNumber: discNumber, + imgFiles: files, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(files[expectedIdx])) + }, + Entry("disc 2 picks disc2.jpg over the shared disc.jpg", 2, 2), + Entry("disc 3 falls back to disc.jpg when no numbered match exists", 3, 0), + ) + + It("tries the next fallback candidate when the first one cannot be opened", func() { + f1 := createFile("album/cover.jpg") + f2 := createFile("album/cover.png") + // Remove f1 so Open will fail on it; f2 should still win. + removeFile(f1) + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "cover.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f2)) + }) + + It("keeps scanning literal-pattern matches so fallback retry still works", func() { + // Guards against an 'early break on first literal match' optimization. + // Multiple imgFiles entries can share a basename (symlinks, case-variant + // duplicates on case-sensitive filesystems). If the loop breaks after + // recording just the first, the fallback retry cannot recover when + // that first file is unreadable. + f1 := createFile("album/stale/cover.png") + f2 := createFile("album/cover.png") + removeFile(f1) + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + discFoldersRel: map[string]bool{ + "album": true, + "album/stale": true, + }, + isMultiFolder: true, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "cover.png") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f2)) + }) + + DescribeTable("filters by disc number for non-'*' wildcard patterns", + func(pattern string, discNumber, expectedIdx int) { + files := []string{ + createFile("album/disc1.jpg"), + createFile("album/disc2.jpg"), + } + reader := &discArtworkReader{ + discNumber: discNumber, + imgFiles: files, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, pattern) + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(files[expectedIdx])) + }, + Entry("disc?.jpg, target disc 1 → disc1.jpg", "disc?.jpg", 1, 0), + Entry("disc?.jpg, target disc 2 → disc2.jpg", "disc?.jpg", 2, 1), + Entry("disc[0-9].jpg, target disc 1 → disc1.jpg", "disc[0-9].jpg", 1, 0), + Entry("disc[0-9].jpg, target disc 2 → disc2.jpg", "disc[0-9].jpg", 2, 1), + ) + + It("matches file without number in multi-folder album by folder", func() { + f1 := createFile("album/cd1/disc.jpg") + f2 := createFile("album/cd2/disc.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + discFoldersRel: map[string]bool{"album/cd1": true}, + isMultiFolder: true, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("prefers disc number over folder when number is present", func() { + // disc2.jpg in cd1 folder should match disc 2, not disc 1 + f1 := createFile("album/cd1/disc2.jpg") + reader := &discArtworkReader{ + discNumber: 2, + imgFiles: []string{f1}, + discFoldersRel: map[string]bool{"album/cd1": true}, + isMultiFolder: true, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("does not match disc2.jpg when looking for disc 1", func() { + f1 := createFile("album/disc2.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + discFoldersRel: map[string]bool{"album": true}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromExternalFile(ctx, "disc*.*") + r, _, _ := sf() + Expect(r).To(BeNil()) + }) + }) + + Describe("fromDiscSubtitle", func() { + var ( + ctx context.Context + tmpDir string + ) + + BeforeEach(func() { + ctx = context.Background() + tmpDir = GinkgoT().TempDir() + }) + + createFile := func(relPath string) string { + fullPath := filepath.Join(tmpDir, filepath.FromSlash(relPath)) + Expect(os.MkdirAll(filepath.Dir(fullPath), 0755)).To(Succeed()) + Expect(os.WriteFile(fullPath, []byte("image data"), 0600)).To(Succeed()) + return relPath + } + + It("matches image file whose stem equals the disc subtitle (case-insensitive)", func() { + f1 := createFile("album/The Blue Disc.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromDiscSubtitle(ctx, "The Blue Disc") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("matches case-insensitively", func() { + f1 := createFile("album/bonus tracks.png") + reader := &discArtworkReader{ + discNumber: 2, + imgFiles: []string{f1}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromDiscSubtitle(ctx, "Bonus Tracks") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + + It("returns error when no matching file found", func() { + f1 := createFile("album/cover.jpg") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromDiscSubtitle(ctx, "The Blue Disc") + _, _, err := sf() + Expect(err).To(HaveOccurred()) + }) + + It("matches first file when multiple extensions exist", func() { + f1 := createFile("album/The Blue Disc.jpg") + f2 := createFile("album/The Blue Disc.png") + reader := &discArtworkReader{ + discNumber: 1, + imgFiles: []string{f1, f2}, + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + + sf := reader.fromDiscSubtitle(ctx, "The Blue Disc") + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + Expect(path).To(Equal(f1)) + }) + }) + + Describe("discArtworkReader", func() { + Describe("fromDiscArtPriority", func() { + var ( + reader *discArtworkReader + tmpDir string + ) + + BeforeEach(func() { + tmpDir = GinkgoT().TempDir() + reader = &discArtworkReader{ + discNumber: 2, + isMultiFolder: true, + discFoldersRel: map[string]bool{"music/album/cd2": true}, + imgFiles: []string{ + "music/album/cd1/disc.jpg", + "music/album/cd2/disc.jpg", + "music/album/cd2/disc2.jpg", + }, + firstTrackRel: "music/album/cd2/track1.flac", + lib: libraryView{FS: osDirFS{os.DirFS(tmpDir)}, absRoot: tmpDir}, + } + }) + + It("returns source funcs for glob patterns", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "disc*.*") + Expect(ff).To(HaveLen(1)) + }) + + It("returns source funcs for embedded pattern", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "embedded") + Expect(ff).To(HaveLen(2)) // fromTag + fromFFmpegTag + }) + + It("handles multiple comma-separated patterns", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "disc*.*, cd*.*, embedded") + Expect(ff).To(HaveLen(4)) // disc*.* + cd*.* + fromTag + fromFFmpegTag + }) + + It("ignores 'external' pattern silently", func() { + ff := reader.fromDiscArtPriority(context.Background(), nil, "external") + Expect(ff).To(HaveLen(0)) + }) + + It("returns no source funcs when imgFiles is empty and pattern is not embedded", func() { + reader.imgFiles = nil + ff := reader.fromDiscArtPriority(context.Background(), nil, "disc*.*") + Expect(ff).To(HaveLen(0)) + }) + + It("returns source func for discsubtitle pattern", func() { + reader.album = model.Album{Discs: model.Discs{2: "Bonus Tracks"}} + ff := reader.fromDiscArtPriority(context.Background(), nil, "discsubtitle") + Expect(ff).To(HaveLen(1)) + }) + + It("returns no source func for discsubtitle when disc has no subtitle", func() { + reader.album = model.Album{Discs: model.Discs{2: ""}} + ff := reader.fromDiscArtPriority(context.Background(), nil, "discsubtitle") + Expect(ff).To(HaveLen(0)) + }) + }) + }) +}) diff --git a/core/artwork/reader_mediafile.go b/core/artwork/reader_mediafile.go index c72d9543d..eac3c5e70 100644 --- a/core/artwork/reader_mediafile.go +++ b/core/artwork/reader_mediafile.go @@ -15,6 +15,7 @@ type mediafileArtworkReader struct { a *artwork mediafile model.MediaFile album model.Album + lib libraryView } func newMediafileArtworkReader(ctx context.Context, artwork *artwork, artID model.ArtworkID) (*mediafileArtworkReader, error) { @@ -26,16 +27,27 @@ func newMediafileArtworkReader(ctx context.Context, artwork *artwork, artID mode if err != nil { return nil, err } + _, _, imagesUpdatedAt, err := loadAlbumFoldersPaths(ctx, artwork.ds, *al) + if err != nil { + return nil, err + } + lib, err := loadLibraryView(ctx, artwork.ds, mf.LibraryID) + if err != nil { + return nil, err + } a := &mediafileArtworkReader{ a: artwork, mediafile: *mf, album: *al, + lib: lib, } a.cacheKey.artID = artID - if al.UpdatedAt.After(mf.UpdatedAt) { + a.cacheKey.lastUpdate = mf.UpdatedAt + if al.UpdatedAt.After(a.cacheKey.lastUpdate) { a.cacheKey.lastUpdate = al.UpdatedAt - } else { - a.cacheKey.lastUpdate = mf.UpdatedAt + } + if imagesUpdatedAt != nil && imagesUpdatedAt.After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = *imagesUpdatedAt } return a, nil } @@ -54,12 +66,17 @@ func (a *mediafileArtworkReader) LastUpdated() time.Time { func (a *mediafileArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { var ff []sourceFunc if a.mediafile.CoverArtID().Kind == model.KindMediaFileArtwork { - path := a.mediafile.AbsolutePath() ff = []sourceFunc{ - fromTag(ctx, path), - fromFFmpegTag(ctx, a.a.ffmpeg, path), + fromTag(ctx, a.lib.FS, a.mediafile.Path), + fromFFmpegTag(ctx, a.a.ffmpeg, a.lib.Abs(a.mediafile.Path)), } } - ff = append(ff, fromAlbum(ctx, a.a, a.mediafile.AlbumCoverArtID())) + // For multi-disc albums, fall back to disc artwork first; for single-disc albums, + // skip disc resolution (it would just fall through to album art anyway). + if len(a.album.Discs) > 1 { + ff = append(ff, fromAlbum(ctx, a.a, a.mediafile.DiscCoverArtID())) + } else { + ff = append(ff, fromAlbum(ctx, a.a, a.mediafile.AlbumCoverArtID())) + } return selectImageReader(ctx, a.artID, ff...) } diff --git a/core/artwork/reader_playlist.go b/core/artwork/reader_playlist.go index a9f289ad8..09707843d 100644 --- a/core/artwork/reader_playlist.go +++ b/core/artwork/reader_playlist.go @@ -8,12 +8,17 @@ import ( "image/draw" "image/png" "io" + "net/url" + "os" + "path/filepath" + "strings" "time" - "github.com/disintegration/imaging" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/slice" + xdraw "golang.org/x/image/draw" ) type playlistArtworkReader struct { @@ -35,6 +40,24 @@ func newPlaylistArtworkReader(ctx context.Context, artwork *artwork, artID model } a.cacheKey.artID = artID a.cacheKey.lastUpdate = pl.UpdatedAt + + // Check sidecar and ExternalImageURL local file ModTimes for cache invalidation. + // If either is newer than the playlist's UpdatedAt, use that instead so the + // cache is busted when a user replaces a sidecar image or local file reference. + for _, path := range []string{ + findPlaylistSidecarPath(ctx, pl.Path), + pl.ExternalImageURL, + } { + if path == "" || strings.HasPrefix(path, "http://") || strings.HasPrefix(path, "https://") { + continue + } + if info, err := os.Stat(path); err == nil { + if info.ModTime().After(a.cacheKey.lastUpdate) { + a.cacheKey.lastUpdate = info.ModTime() + } + } + } + return a, nil } @@ -43,11 +66,81 @@ func (a *playlistArtworkReader) LastUpdated() time.Time { } func (a *playlistArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { - ff := []sourceFunc{ + return selectImageReader(ctx, a.artID, + a.fromPlaylistUploadedImage(), + a.fromPlaylistSidecar(ctx), + a.fromPlaylistExternalImage(ctx), a.fromGeneratedTiledCover(ctx), fromAlbumPlaceholder(), + ) +} + +func (a *playlistArtworkReader) fromPlaylistUploadedImage() sourceFunc { + return fromLocalFile(a.pl.UploadedImagePath()) +} + +func (a *playlistArtworkReader) fromPlaylistSidecar(ctx context.Context) sourceFunc { + return fromLocalFile(findPlaylistSidecarPath(ctx, a.pl.Path)) +} + +func (a *playlistArtworkReader) fromPlaylistExternalImage(ctx context.Context) sourceFunc { + return func() (io.ReadCloser, string, error) { + imgURL := a.pl.ExternalImageURL + if imgURL == "" { + return nil, "", nil + } + parsed, err := url.Parse(imgURL) + if err != nil { + return nil, "", err + } + if parsed.Scheme == "http" || parsed.Scheme == "https" { + if !conf.Server.EnableM3UExternalAlbumArt { + return nil, "", nil + } + return fromURL(ctx, parsed) + } + return fromLocalFile(imgURL)() } - return selectImageReader(ctx, a.artID, ff...) +} + +// fromLocalFile returns a sourceFunc that opens the given local path. +// Returns (nil, "", nil) if path is empty — signalling "not found, try next source". +func fromLocalFile(path string) sourceFunc { + return func() (io.ReadCloser, string, error) { + if path == "" { + return nil, "", nil + } + f, err := os.Open(path) + if err != nil { + return nil, "", err + } + return f, path, nil + } +} + +// findPlaylistSidecarPath scans the directory of the playlist file for a sidecar +// image file with the same base name (case-insensitive). Returns empty string if +// no matching image is found or if plsPath is empty. +func findPlaylistSidecarPath(ctx context.Context, plsPath string) string { + if plsPath == "" { + return "" + } + dir := filepath.Dir(plsPath) + base := strings.TrimSuffix(filepath.Base(plsPath), filepath.Ext(plsPath)) + + entries, err := os.ReadDir(dir) + if err != nil { + log.Warn(ctx, "Could not read directory for playlist sidecar", "dir", dir, err) + return "" + } + for _, entry := range entries { + name := entry.Name() + nameBase := strings.TrimSuffix(name, filepath.Ext(name)) + if !entry.IsDir() && strings.EqualFold(nameBase, base) && model.IsImageFile(name) { + return filepath.Join(dir, name) + } + } + return "" } func (a *playlistArtworkReader) fromGeneratedTiledCover(ctx context.Context) sourceFunc { @@ -107,7 +200,7 @@ func (a *playlistArtworkReader) createTile(_ context.Context, r io.ReadCloser) ( if err != nil { return nil, err } - return imaging.Fill(img, tileSize/2, tileSize/2, imaging.Center, imaging.Lanczos), nil + return fillCenter(img, tileSize/2, tileSize/2), nil } func (a *playlistArtworkReader) createTiledImage(_ context.Context, tiles []image.Image) (io.ReadCloser, error) { @@ -145,3 +238,32 @@ func rect(pos int) image.Rectangle { r.Max.Y = r.Min.Y + tileSize/2 return r } + +// fillCenter crops the source image from the center and scales it to fill dstW x dstH exactly, +// equivalent to imaging.Fill with Center anchor. +func fillCenter(src image.Image, dstW, dstH int) image.Image { + srcBounds := src.Bounds() + srcW := srcBounds.Dx() + srcH := srcBounds.Dy() + + // Calculate crop rectangle (center crop to match destination aspect ratio) + srcAspect := float64(srcW) / float64(srcH) + dstAspect := float64(dstW) / float64(dstH) + + var cropRect image.Rectangle + if srcAspect > dstAspect { + // Source is wider — crop horizontally + cropW := int(float64(srcH) * dstAspect) + cropX := (srcW - cropW) / 2 + cropRect = image.Rect(srcBounds.Min.X+cropX, srcBounds.Min.Y, srcBounds.Min.X+cropX+cropW, srcBounds.Max.Y) + } else { + // Source is taller — crop vertically + cropH := int(float64(srcW) / dstAspect) + cropY := (srcH - cropH) / 2 + cropRect = image.Rect(srcBounds.Min.X, srcBounds.Min.Y+cropY, srcBounds.Max.X, srcBounds.Min.Y+cropY+cropH) + } + + dst := image.NewNRGBA(image.Rect(0, 0, dstW, dstH)) + xdraw.CatmullRom.Scale(dst, dst.Bounds(), src, cropRect, draw.Src, nil) + return dst +} diff --git a/core/artwork/reader_radio.go b/core/artwork/reader_radio.go new file mode 100644 index 000000000..22db6e302 --- /dev/null +++ b/core/artwork/reader_radio.go @@ -0,0 +1,40 @@ +package artwork + +import ( + "context" + "io" + "time" + + "github.com/navidrome/navidrome/model" +) + +type radioArtworkReader struct { + cacheKey + a *artwork + radio model.Radio +} + +func newRadioArtworkReader(ctx context.Context, artwork *artwork, artID model.ArtworkID) (*radioArtworkReader, error) { + r, err := artwork.ds.Radio(ctx).Get(artID.ID) + if err != nil { + return nil, err + } + a := &radioArtworkReader{a: artwork, radio: *r} + a.cacheKey.artID = artID + a.cacheKey.lastUpdate = r.UpdatedAt + return a, nil +} + +func (a *radioArtworkReader) LastUpdated() time.Time { + return a.lastUpdate +} + +func (a *radioArtworkReader) Reader(ctx context.Context) (io.ReadCloser, string, error) { + return selectImageReader(ctx, a.artID, + a.fromRadioUploadedImage(), + ) +} + +func (a *radioArtworkReader) fromRadioUploadedImage() sourceFunc { + return fromLocalFile(a.radio.UploadedImagePath()) +} diff --git a/core/artwork/reader_radio_test.go b/core/artwork/reader_radio_test.go new file mode 100644 index 000000000..37ce1d827 --- /dev/null +++ b/core/artwork/reader_radio_test.go @@ -0,0 +1,84 @@ +package artwork + +import ( + "context" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("radioArtworkReader", func() { + var ( + tempDir string + reader *radioArtworkReader + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tempDir = GinkgoT().TempDir() + conf.Server.DataFolder = conf.NewDir(tempDir) + + Expect(os.MkdirAll(filepath.Join(tempDir, "artwork", "radio"), 0755)).To(Succeed()) + + reader = &radioArtworkReader{} + }) + + Describe("fromRadioUploadedImage", func() { + When("radio has an uploaded image", func() { + It("returns the uploaded image", func() { + imgPath := filepath.Join(tempDir, "artwork", "radio", "rd-1_test.jpg") + Expect(os.WriteFile(imgPath, []byte("uploaded radio image"), 0600)).To(Succeed()) + + reader.radio = model.Radio{ID: "rd-1", UploadedImage: "rd-1_test.jpg"} + sf := reader.fromRadioUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + Expect(path).To(Equal(imgPath)) + r.Close() + }) + }) + + When("radio has no uploaded image", func() { + It("returns nil reader (falls through)", func() { + reader.radio = model.Radio{ID: "rd-1"} + sf := reader.fromRadioUploadedImage() + r, path, err := sf() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + Expect(path).To(BeEmpty()) + }) + }) + }) + + Describe("Reader", func() { + When("radio has an uploaded image", func() { + It("returns the image reader", func() { + imgPath := filepath.Join(tempDir, "artwork", "radio", "rd-1_test.jpg") + Expect(os.WriteFile(imgPath, []byte("uploaded radio image"), 0600)).To(Succeed()) + + reader.radio = model.Radio{ID: "rd-1", UploadedImage: "rd-1_test.jpg"} + reader.cacheKey.artID = model.ArtworkID{Kind: model.KindRadioArtwork, ID: "rd-1"} + r, _, err := reader.Reader(context.Background()) + Expect(err).ToNot(HaveOccurred()) + Expect(r).ToNot(BeNil()) + r.Close() + }) + }) + + When("radio has no uploaded image", func() { + It("returns ErrUnavailable", func() { + reader.radio = model.Radio{ID: "rd-1"} + reader.cacheKey.artID = model.ArtworkID{Kind: model.KindRadioArtwork, ID: "rd-1"} + r, _, err := reader.Reader(context.Background()) + Expect(err).To(MatchError(ErrUnavailable)) + Expect(r).To(BeNil()) + }) + }) + }) +}) diff --git a/core/artwork/reader_resized.go b/core/artwork/reader_resized.go index 83e6e25c2..85a19a4c3 100644 --- a/core/artwork/reader_resized.go +++ b/core/artwork/reader_resized.go @@ -5,17 +5,36 @@ import ( "context" "fmt" "image" + "image/draw" "image/jpeg" "image/png" "io" + "sync" "time" - "github.com/disintegration/imaging" + "github.com/gen2brain/webp" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + xdraw "golang.org/x/image/draw" ) +func init() { + conf.AddHook(func() { + if err := webp.Dynamic(); err != nil { + log.Debug("Using WASM WebP encoder/decoder", "reason", err) + } else { + log.Debug("Using native libwebp for WebP encoding/decoding") + } + }) +} + +var bufPool = sync.Pool{ + New: func() any { + return new(bytes.Buffer) + }, +} + type resizedArtworkReader struct { artID model.ArtworkID cacheKey string @@ -46,7 +65,7 @@ func (a *resizedArtworkReader) Key() string { if a.square { return baseKey + ".square" } - return fmt.Sprintf("%s.%d", baseKey, conf.Server.CoverJpegQuality) + return fmt.Sprintf("%s.%d", baseKey, conf.Server.CoverArtQuality) } func (a *resizedArtworkReader) LastUpdated() time.Time { @@ -61,7 +80,7 @@ func (a *resizedArtworkReader) Reader(ctx context.Context) (io.ReadCloser, strin } defer orig.Close() - resized, origSize, err := resizeImage(orig, a.size, a.square) + resized, origSize, err := a.resizeImage(ctx, orig) if resized == nil { log.Trace(ctx, "Image smaller than requested size", "artID", a.artID, "original", origSize, "resized", a.size, "square", a.square) } else { @@ -75,11 +94,40 @@ func (a *resizedArtworkReader) Reader(ctx context.Context) (io.ReadCloser, strin orig, _, err = a.a.Get(ctx, a.artID, 0, false) return orig, "", err } + // Preserve ReadCloser semantics if the resized reader already supports Close + // (e.g., ffmpeg pipe), otherwise wrap with NopCloser + if rc, ok := resized.(io.ReadCloser); ok { + return rc, fmt.Sprintf("%s@%d", a.artID, a.size), nil + } return io.NopCloser(resized), fmt.Sprintf("%s@%d", a.artID, a.size), nil } -func resizeImage(reader io.Reader, size int, square bool) (io.Reader, int, error) { - original, format, err := image.Decode(reader) +func (a *resizedArtworkReader) resizeImage(ctx context.Context, reader io.Reader) (io.Reader, int, error) { + data, err := io.ReadAll(reader) + if err != nil { + return nil, 0, fmt.Errorf("reading image data: %w", err) + } + + // Preserve animation for animated images + if isAnimatedGIF(data) { + if a.a.ffmpeg.IsAvailable() { + // Animated GIF: convert to animated WebP via ffmpeg (with optional resize) + r, err := a.a.ffmpeg.ConvertAnimatedImage(ctx, bytes.NewReader(data), a.size, conf.Server.CoverArtQuality) + if err == nil { + return r, 0, nil + } + log.Warn(ctx, "Could not convert animated GIF, falling back to static", err) + } + } else if isAnimatedWebP(data) || isAnimatedPNG(data) { + // Animated WebP/APNG: return original as-is (ffmpeg can't re-encode these) + return bytes.NewReader(data), 0, nil + } + + return resizeStaticImage(data, a.size, a.square) +} + +func resizeStaticImage(data []byte, size int, square bool) (io.Reader, int, error) { + original, format, err := image.Decode(bytes.NewReader(data)) if err != nil { return nil, 0, err } @@ -87,30 +135,52 @@ func resizeImage(reader io.Reader, size int, square bool) (io.Reader, int, error bounds := original.Bounds() originalSize := max(bounds.Max.X, bounds.Max.Y) + // Clamp size to original dimensions - upscaling wastes resources and adds no information + if size > originalSize { + size = originalSize + } + if originalSize <= size && !square { return nil, originalSize, nil } - var resized image.Image - if originalSize >= size { - resized = imaging.Fit(original, size, size, imaging.Lanczos) - } else { - if bounds.Max.Y < bounds.Max.X { - resized = imaging.Resize(original, size, 0, imaging.Lanczos) - } else { - resized = imaging.Resize(original, 0, size, imaging.Lanczos) - } - } - if square { - bg := image.NewRGBA(image.Rect(0, 0, size, size)) - resized = imaging.OverlayCenter(bg, resized, 1) - } + // Calculate aspect-fit dimensions + srcW, srcH := bounds.Dx(), bounds.Dy() + scale := float64(size) / float64(max(srcW, srcH)) + dstW := int(float64(srcW) * scale) + dstH := int(float64(srcH) * scale) - buf := new(bytes.Buffer) - if format == "png" || square { - err = png.Encode(buf, resized) + var dst *image.NRGBA + var dstRect image.Rectangle + if square { + // Square canvas with image centered (transparent padding via zero-initialized NRGBA) + dst = image.NewNRGBA(image.Rect(0, 0, size, size)) + offsetX := (size - dstW) / 2 + offsetY := (size - dstH) / 2 + dstRect = image.Rect(offsetX, offsetY, offsetX+dstW, offsetY+dstH) } else { - err = jpeg.Encode(buf, resized, &jpeg.Options{Quality: conf.Server.CoverJpegQuality}) + // Tight-fit canvas + dst = image.NewNRGBA(image.Rect(0, 0, dstW, dstH)) + dstRect = dst.Bounds() } - return buf, originalSize, err + xdraw.CatmullRom.Scale(dst, dstRect, original, bounds, draw.Src, nil) + + buf := bufPool.Get().(*bytes.Buffer) + buf.Reset() + if conf.Server.EnableWebPEncoding { + err = webp.Encode(buf, dst, webp.Options{Quality: conf.Server.CoverArtQuality}) + } else if format == "png" || square { + err = png.Encode(buf, dst) + } else { + err = jpeg.Encode(buf, dst, &jpeg.Options{Quality: conf.Server.CoverArtQuality}) + } + if err != nil { + bufPool.Put(buf) + return nil, originalSize, err + } + // Copy bytes before returning buffer to pool (pool may reuse the buffer) + encoded := make([]byte, buf.Len()) + copy(encoded, buf.Bytes()) + bufPool.Put(buf) + return bytes.NewReader(encoded), originalSize, nil } diff --git a/core/artwork/reader_resized_test.go b/core/artwork/reader_resized_test.go new file mode 100644 index 000000000..7c14f5e44 --- /dev/null +++ b/core/artwork/reader_resized_test.go @@ -0,0 +1,176 @@ +package artwork + +import ( + "bytes" + "context" + "errors" + "io" + + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("resizeImage", func() { + var mockFF *tests.MockFFmpeg + var r *resizedArtworkReader + + BeforeEach(func() { + mockFF = tests.NewMockFFmpeg("converted-animated-data") + r = &resizedArtworkReader{ + size: 300, + square: false, + a: &artwork{ffmpeg: mockFF}, + } + }) + + Describe("animated GIF handling", func() { + It("converts animated GIF via ffmpeg when available", func() { + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should have been processed by ffmpeg (mock returns "converted-animated-data") + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) // MockFFmpeg echoes input back + }) + + It("falls back to static resize when ffmpeg fails for animated GIF", func() { + mockFF.Error = errors.New("ffmpeg failed") + // Use size smaller than image so static resize actually produces output + r.size = 1 + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + // Should fall through to static resize successfully (no ffmpeg error propagated) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Verify it's a static image (WebP encoded), not the ffmpeg error + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(len(output)).To(BeNumerically(">", 0)) + }) + + It("preserves animation for square thumbnails with animated GIF", func() { + r.square = true + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should have been processed by ffmpeg (mock returns input data) + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) + }) + }) + + Describe("animated WebP handling", func() { + It("returns animated WebP data as-is when not square", func() { + data := createAnimatedWebPBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should return original data unchanged + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) + }) + + It("preserves animated WebP for square thumbnails", func() { + r.square = true + data := createAnimatedWebPBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should return original data unchanged + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) + }) + }) + + Describe("animated PNG handling", func() { + It("returns animated PNG data as-is when not square", func() { + data := createAPNGBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should return original data unchanged + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) + }) + + It("preserves animated PNG for square thumbnails", func() { + r.square = true + data := createAPNGBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + + // Should return original data unchanged + output, err := io.ReadAll(result) + Expect(err).ToNot(HaveOccurred()) + Expect(output).To(Equal(data)) + }) + }) + + Describe("static image handling", func() { + It("resizes a static PNG normally", func() { + data := createStaticPNGBytes() + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + // Static PNG is 2x2, size 300 is larger, so should return nil (no upscale) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeNil()) + }) + }) + + Describe("ReadCloser preservation", func() { + It("preserves Close semantics from ffmpeg ReadCloser", func() { + // Create a trackable ReadCloser + tracker := &closeTracker{Reader: bytes.NewReader([]byte("test data"))} + mockFF2 := &mockFFmpegWithCloser{tracker: tracker} + r.a = &artwork{ffmpeg: mockFF2} + + data := createAnimatedGIF(3) + result, _, err := r.resizeImage(context.Background(), bytes.NewReader(data)) + Expect(err).ToNot(HaveOccurred()) + + // The result should be an io.ReadCloser (the tracker) + rc, ok := result.(io.ReadCloser) + Expect(ok).To(BeTrue()) + Expect(rc.Close()).ToNot(HaveOccurred()) + Expect(tracker.closed).To(BeTrue()) + }) + }) +}) + +// closeTracker is an io.ReadCloser that tracks whether Close was called. +type closeTracker struct { + io.Reader + closed bool +} + +func (c *closeTracker) Close() error { + c.closed = true + return nil +} + +// mockFFmpegWithCloser is a minimal FFmpeg mock that returns a specific ReadCloser +// for ConvertAnimatedImage, allowing us to verify Close propagation. +type mockFFmpegWithCloser struct { + ffmpeg.FFmpeg + tracker *closeTracker +} + +func (m *mockFFmpegWithCloser) IsAvailable() bool { return true } +func (m *mockFFmpegWithCloser) ConvertAnimatedImage(_ context.Context, _ io.Reader, _ int, _ int) (io.ReadCloser, error) { + return m.tracker, nil +} diff --git a/core/artwork/sources.go b/core/artwork/sources.go index 121e6c38b..04a9257fb 100644 --- a/core/artwork/sources.go +++ b/core/artwork/sources.go @@ -5,9 +5,9 @@ import ( "context" "fmt" "io" + "io/fs" "net/http" "net/url" - "os" "path/filepath" "reflect" "regexp" @@ -15,13 +15,13 @@ import ( "strings" "time" - "github.com/dhowden/tag" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/resources" + "go.senan.xyz/taglib" ) func selectImageReader(ctx context.Context, artID model.ArtworkID, extractFuncs ...sourceFunc) (io.ReadCloser, string, error) { @@ -53,7 +53,7 @@ func (f sourceFunc) String() string { return name } -func fromExternalFile(ctx context.Context, files []string, pattern string) sourceFunc { +func fromExternalFile(ctx context.Context, libFS fs.FS, files []string, pattern string) sourceFunc { return func() (io.ReadCloser, string, error) { for _, file := range files { _, name := filepath.Split(file) @@ -65,12 +65,12 @@ func fromExternalFile(ctx context.Context, files []string, pattern string) sourc if !match { continue } - f, err := os.Open(file) + f, err := libFS.Open(file) if err != nil { log.Warn(ctx, "Could not open cover art file", "file", file, err) continue } - return f, file, err + return f, file, nil } return nil, "", fmt.Errorf("pattern '%s' not matched by files %v", pattern, files) } @@ -83,51 +83,66 @@ var picTypeRegexes = []*regexp.Regexp{ regexp.MustCompile(`(?i).*cover.*`), } -func fromTag(ctx context.Context, path string) sourceFunc { +func fromTag(ctx context.Context, libFS fs.FS, relPath string) sourceFunc { return func() (io.ReadCloser, string, error) { - if path == "" { + if relPath == "" { return nil, "", nil } - f, err := os.Open(path) + f, err := libFS.Open(relPath) if err != nil { return nil, "", err } + rs, ok := f.(io.ReadSeeker) + if !ok { + f.Close() + return nil, "", fmt.Errorf("FS file %s is not seekable; cannot read tags", relPath) + } + tf, err := taglib.OpenStream(rs, + taglib.WithReadStyle(taglib.ReadStyleFast), + taglib.WithFilename(relPath), + ) + if err != nil { + f.Close() + return nil, "", err + } + // Close in LIFO order: tf first (it holds rs internally), then f. defer f.Close() + defer tf.Close() - m, err := tag.ReadFrom(f) - if err != nil { - return nil, "", err + images := tf.Properties().Images + if len(images) == 0 { + return nil, "", fmt.Errorf("no embedded image found in %s", relPath) } - types := m.PictureTypes() - if len(types) == 0 { - return nil, "", fmt.Errorf("no embedded image found in %s", path) + imageIndex := findBestImageIndex(ctx, images, relPath) + data, err := tf.Image(imageIndex) + if err != nil || len(data) == 0 { + return nil, "", fmt.Errorf("could not load embedded image from %s", relPath) } - - var picture *tag.Picture - for _, regex := range picTypeRegexes { - for _, t := range types { - if regex.MatchString(t) { - log.Trace(ctx, "Found embedded image", "type", t, "path", path) - picture = m.Pictures(t) - break - } - } - if picture != nil { - break - } - } - if picture == nil { - log.Trace(ctx, "Could not find a front image. Getting the first one", "type", types[0], "path", path) - picture = m.Picture() - } - if picture == nil { - return nil, "", fmt.Errorf("could not load embedded image from %s", path) - } - return io.NopCloser(bytes.NewReader(picture.Data)), path, nil + return io.NopCloser(bytes.NewReader(data)), relPath, nil } } +func findBestImageIndex(ctx context.Context, images []taglib.ImageDesc, path string) int { + for _, regex := range picTypeRegexes { + for i, img := range images { + if regex.MatchString(img.Type) { + log.Trace(ctx, "Found embedded image", "type", img.Type, "path", path) + return i + } + } + } + log.Trace(ctx, "Could not find a front image. Getting the first one", "type", images[0].Type, "path", path) + return 0 +} + +// fromFFmpegTag is intentionally absolute-path-based. ffmpeg is a subprocess +// and cannot read from arbitrary fs.FS implementations; piping via stdin is a +// non-trivial refactor with stream/seek implications. +// +// TODO(artwork-musicfs): when the storage backing the library is not local +// (e.g. a future S3 backend, or FakeFS in tests), short-circuit this source +// func to return (nil, "", nil) so callers fall through cleanly. func fromFFmpegTag(ctx context.Context, ffmpeg ffmpeg.FFmpeg, path string) sourceFunc { return func() (io.ReadCloser, string, error) { if path == "" { @@ -137,10 +152,25 @@ func fromFFmpegTag(ctx context.Context, ffmpeg ffmpeg.FFmpeg, path string) sourc if err != nil { return nil, "", err } - return r, path, nil + // Validate that the stream actually contains image data by reading the first byte. + // ffmpeg.ExtractImage returns a pipe reader that may fail asynchronously if the + // file has no video/image stream (e.g., an MP3 without embedded art). + buf := make([]byte, 1) + n, err := r.Read(buf) + if n == 0 || err != nil { + r.Close() + return nil, "", fmt.Errorf("ffmpeg produced no image data for %s: %w", path, err) + } + return readCloser{Reader: io.MultiReader(bytes.NewReader(buf[:n]), r), Closer: r}, path, nil } } +// readCloser combines a Reader and a Closer into an io.ReadCloser. +type readCloser struct { + io.Reader + io.Closer +} + func fromAlbum(ctx context.Context, a *artwork, id model.ArtworkID) sourceFunc { return func() (io.ReadCloser, string, error) { r, _, err := a.Get(ctx, id, 0, false) @@ -182,13 +212,14 @@ func fromAlbumExternalSource(ctx context.Context, al model.Album, provider exter func fromURL(ctx context.Context, imageUrl *url.URL) (io.ReadCloser, string, error) { hc := http.Client{Timeout: 5 * time.Second} req, _ := http.NewRequestWithContext(ctx, http.MethodGet, imageUrl.String(), nil) - resp, err := hc.Do(req) + req.Header.Set("User-Agent", consts.HTTPUserAgent) + resp, err := hc.Do(req) //nolint:gosec if err != nil { return nil, "", err } if resp.StatusCode != http.StatusOK { resp.Body.Close() - return nil, "", fmt.Errorf("error retrieveing artwork from %s: %s", imageUrl, resp.Status) + return nil, "", fmt.Errorf("error retrieving artwork from %s: %s", imageUrl, resp.Status) } return resp.Body, imageUrl.String(), nil } diff --git a/core/artwork/sources_internal_test.go b/core/artwork/sources_internal_test.go new file mode 100644 index 000000000..4282575a5 --- /dev/null +++ b/core/artwork/sources_internal_test.go @@ -0,0 +1,92 @@ +package artwork + +import ( + "bytes" + "errors" + "io" + "io/fs" + "os" + "testing/fstest" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("fromExternalFile", func() { + It("opens a matching file via the library FS", func() { + fsys := fstest.MapFS{ + "Artist/Album/cover.jpg": &fstest.MapFile{Data: []byte("cover-bytes")}, + } + f := fromExternalFile(GinkgoT().Context(), fsys, []string{"Artist/Album/cover.jpg"}, "cover.*") + r, path, err := f() + Expect(err).ToNot(HaveOccurred()) + defer r.Close() + b, _ := io.ReadAll(r) + Expect(b).To(Equal([]byte("cover-bytes"))) + Expect(path).To(Equal("Artist/Album/cover.jpg")) + }) + + It("returns an error when no file matches", func() { + fsys := fstest.MapFS{ + "Artist/Album/something.txt": &fstest.MapFile{Data: []byte("x")}, + } + f := fromExternalFile(GinkgoT().Context(), fsys, []string{"Artist/Album/something.txt"}, "cover.*") + _, _, err := f() + Expect(err).To(HaveOccurred()) + }) + + It("skips files that fail to open and tries the next match", func() { + fsys := fstest.MapFS{ + "a/cover.jpg": &fstest.MapFile{Data: []byte("a")}, + } + // "missing/cover.jpg" is in candidates but not in the FS — should be skipped. + f := fromExternalFile(GinkgoT().Context(), fsys, []string{"missing/cover.jpg", "a/cover.jpg"}, "cover.*") + r, path, err := f() + Expect(err).ToNot(HaveOccurred()) + defer r.Close() + b, _ := io.ReadAll(r) + Expect(b).To(Equal([]byte("a"))) + Expect(path).To(Equal("a/cover.jpg")) + }) +}) + +var _ = Describe("fromTag", func() { + It("opens an embedded image via fs.FS", func() { + fsys := os.DirFS("tests/fixtures/artist/an-album") + f := fromTag(GinkgoT().Context(), fsys, "test.mp3") + r, path, err := f() + Expect(err).ToNot(HaveOccurred()) + defer r.Close() + Expect(path).To(Equal("test.mp3")) + b, _ := io.ReadAll(r) + Expect(b).ToNot(BeEmpty()) + }) + + It("returns nil reader when the relative path is empty", func() { + f := fromTag(GinkgoT().Context(), os.DirFS("."), "") + r, _, err := f() + Expect(err).ToNot(HaveOccurred()) + Expect(r).To(BeNil()) + }) + + It("errors when the FS file is not seekable", func() { + fsys := nonSeekableFS{data: []byte("garbage")} + f := fromTag(GinkgoT().Context(), fsys, "x.mp3") + _, _, err := f() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not seekable")) + }) +}) + +// nonSeekableFS is a single-file fs.FS whose Open returns a non-seekable file. +type nonSeekableFS struct{ data []byte } + +func (n nonSeekableFS) Open(name string) (fs.File, error) { + return &nonSeekableFile{r: bytes.NewReader(n.data)}, nil +} + +type nonSeekableFile struct{ r *bytes.Reader } + +func (n *nonSeekableFile) Read(p []byte) (int, error) { return n.r.Read(p) } +func (n *nonSeekableFile) Close() error { return nil } +func (n *nonSeekableFile) Stat() (fs.FileInfo, error) { return nil, errors.New("not implemented") } diff --git a/core/auth/auth.go b/core/auth/auth.go index fd2b670a4..7b3511bdf 100644 --- a/core/auth/auth.go +++ b/core/auth/auth.go @@ -8,7 +8,7 @@ import ( "time" "github.com/go-chi/jwtauth/v5" - "github.com/lestrrat-go/jwx/v2/jwt" + "github.com/lestrrat-go/jwx/v3/jwt" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" @@ -45,42 +45,30 @@ func Init(ds model.DataStore) { }) } -func createBaseClaims() map[string]any { - tokenClaims := map[string]any{} - tokenClaims[jwt.IssuerKey] = consts.JWTIssuer - return tokenClaims -} - -func CreatePublicToken(claims map[string]any) (string, error) { - tokenClaims := createBaseClaims() - for k, v := range claims { - tokenClaims[k] = v - } - _, token, err := TokenAuth.Encode(tokenClaims) - +func CreatePublicToken(claims Claims) (string, error) { + claims.Issuer = consts.JWTIssuer + _, token, err := TokenAuth.Encode(claims.ToMap()) return token, err } -func CreateExpiringPublicToken(exp time.Time, claims map[string]any) (string, error) { - tokenClaims := createBaseClaims() +func CreateExpiringPublicToken(exp time.Time, claims Claims) (string, error) { + claims.Issuer = consts.JWTIssuer if !exp.IsZero() { - tokenClaims[jwt.ExpirationKey] = exp.UTC().Unix() + claims.ExpiresAt = exp } - for k, v := range claims { - tokenClaims[k] = v - } - _, token, err := TokenAuth.Encode(tokenClaims) - + _, token, err := TokenAuth.Encode(claims.ToMap()) return token, err } func CreateToken(u *model.User) (string, error) { - claims := createBaseClaims() - claims[jwt.SubjectKey] = u.UserName - claims[jwt.IssuedAtKey] = time.Now().UTC().Unix() - claims["uid"] = u.ID - claims["adm"] = u.IsAdmin - token, _, err := TokenAuth.Encode(claims) + claims := Claims{ + Issuer: consts.JWTIssuer, + Subject: u.UserName, + IssuedAt: time.Now(), + UserID: u.ID, + IsAdmin: u.IsAdmin, + } + token, _, err := TokenAuth.Encode(claims.ToMap()) if err != nil { return "", err } @@ -89,23 +77,18 @@ func CreateToken(u *model.User) (string, error) { } func TouchToken(token jwt.Token) (string, error) { - claims, err := token.AsMap(context.Background()) - if err != nil { - return "", err - } - - claims[jwt.ExpirationKey] = time.Now().UTC().Add(conf.Server.SessionTimeout).Unix() - _, newToken, err := TokenAuth.Encode(claims) - + claims := ClaimsFromToken(token). + WithExpiresAt(time.Now().UTC().Add(conf.Server.SessionTimeout)) + _, newToken, err := TokenAuth.Encode(claims.ToMap()) return newToken, err } -func Validate(tokenStr string) (map[string]interface{}, error) { +func Validate(tokenStr string) (Claims, error) { token, err := jwtauth.VerifyToken(TokenAuth, tokenStr) if err != nil { - return nil, err + return Claims{}, err } - return token.AsMap(context.Background()) + return ClaimsFromToken(token), nil } func WithAdminUser(ctx context.Context, ds model.DataStore) context.Context { @@ -113,11 +96,11 @@ func WithAdminUser(ctx context.Context, ds model.DataStore) context.Context { if err != nil { c, err := ds.User(ctx).CountAll() if c == 0 && err == nil { - log.Debug(ctx, "Scanner: No admin user yet!", err) + log.Debug(ctx, "No admin user yet!", err) } else { - log.Error(ctx, "Scanner: No admin user found!", err) + log.Error(ctx, "No admin user found!", err) } - u = &model.User{} + u = &model.User{IsAdmin: true, UserName: "admin"} } ctx = request.WithUsername(ctx, u.UserName) @@ -137,6 +120,19 @@ func createNewSecret(ctx context.Context, ds model.DataStore) string { return secret } +// EncodeToken creates a signed JWT from an arbitrary claims map. +// It sets the issuer claim automatically. +func EncodeToken(claims map[string]any) (string, error) { + claims[jwt.IssuerKey] = consts.JWTIssuer + _, token, err := TokenAuth.Encode(claims) + return token, err +} + +// DecodeAndVerifyToken verifies a JWT string and returns the parsed token. +func DecodeAndVerifyToken(tokenStr string) (jwt.Token, error) { + return jwtauth.VerifyToken(TokenAuth, tokenStr) +} + func getEncKey() []byte { key := cmp.Or( conf.Server.PasswordEncryptionKey, diff --git a/core/auth/auth_test.go b/core/auth/auth_test.go index 504e56a52..3a3585e53 100644 --- a/core/auth/auth_test.go +++ b/core/auth/auth_test.go @@ -21,8 +21,7 @@ func TestAuth(t *testing.T) { } const ( - testJWTSecret = "not so secret" - oneDay = 24 * time.Hour + oneDay = 24 * time.Hour ) var _ = BeforeSuite(func() { @@ -45,7 +44,7 @@ var _ = Describe("Auth", func() { }) It("returns the claims from a valid JWT token", func() { - claims := map[string]interface{}{} + claims := map[string]any{} claims["iss"] = "issuer" claims["iat"] = time.Now().Unix() claims["exp"] = time.Now().Add(1 * time.Minute).Unix() @@ -54,11 +53,11 @@ var _ = Describe("Auth", func() { decodedClaims, err := auth.Validate(tokenStr) Expect(err).NotTo(HaveOccurred()) - Expect(decodedClaims["iss"]).To(Equal("issuer")) + Expect(decodedClaims.Issuer).To(Equal("issuer")) }) It("returns ErrExpired if the `exp` field is in the past", func() { - claims := map[string]interface{}{} + claims := map[string]any{} claims["iss"] = "issuer" claims["exp"] = time.Now().Add(-1 * time.Minute).Unix() _, tokenStr, err := auth.TokenAuth.Encode(claims) @@ -82,18 +81,18 @@ var _ = Describe("Auth", func() { claims, err := auth.Validate(tokenStr) Expect(err).NotTo(HaveOccurred()) - Expect(claims["iss"]).To(Equal(consts.JWTIssuer)) - Expect(claims["sub"]).To(Equal("johndoe")) - Expect(claims["uid"]).To(Equal("123")) - Expect(claims["adm"]).To(Equal(true)) - Expect(claims["exp"]).To(BeTemporally(">", time.Now())) + Expect(claims.Issuer).To(Equal(consts.JWTIssuer)) + Expect(claims.Subject).To(Equal("johndoe")) + Expect(claims.UserID).To(Equal("123")) + Expect(claims.IsAdmin).To(Equal(true)) + Expect(claims.ExpiresAt).To(BeTemporally(">", time.Now())) }) }) Describe("TouchToken", func() { It("updates the expiration time", func() { yesterday := time.Now().Add(-oneDay) - claims := map[string]interface{}{} + claims := map[string]any{} claims["iss"] = "issuer" claims["exp"] = yesterday.Unix() token, _, err := auth.TokenAuth.Encode(claims) @@ -104,8 +103,7 @@ var _ = Describe("Auth", func() { decodedClaims, err := auth.Validate(touched) Expect(err).NotTo(HaveOccurred()) - exp := decodedClaims["exp"].(time.Time) - Expect(exp.Sub(yesterday)).To(BeNumerically(">=", oneDay)) + Expect(decodedClaims.ExpiresAt.Sub(yesterday)).To(BeNumerically(">=", oneDay)) }) }) }) diff --git a/core/auth/claims.go b/core/auth/claims.go new file mode 100644 index 000000000..c7e6f02fe --- /dev/null +++ b/core/auth/claims.go @@ -0,0 +1,104 @@ +package auth + +import ( + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" +) + +// Claims represents the typed JWT claims used throughout Navidrome, +// replacing the untyped map[string]any approach. +type Claims struct { + // Standard JWT claims + Issuer string + Subject string // username for session tokens + IssuedAt time.Time + ExpiresAt time.Time + + // Custom claims + UserID string // "uid" + IsAdmin bool // "adm" + ID string // "id" - artwork/mediafile ID + Format string // "f" - audio format + BitRate int // "b" - audio bitrate + ShareID string // "sid" - share ID for share stream tokens +} + +// ToMap converts Claims to a map[string]any for use with TokenAuth.Encode(). +// Only non-zero fields are included. +func (c Claims) ToMap() map[string]any { + m := make(map[string]any) + if c.Issuer != "" { + m[jwt.IssuerKey] = c.Issuer + } + if c.Subject != "" { + m[jwt.SubjectKey] = c.Subject + } + if !c.IssuedAt.IsZero() { + m[jwt.IssuedAtKey] = c.IssuedAt.UTC().Unix() + } + if !c.ExpiresAt.IsZero() { + m[jwt.ExpirationKey] = c.ExpiresAt.UTC().Unix() + } + if c.UserID != "" { + m["uid"] = c.UserID + } + if c.IsAdmin { + m["adm"] = c.IsAdmin + } + if c.ID != "" { + m["id"] = c.ID + } + if c.Format != "" { + m["f"] = c.Format + } + if c.BitRate != 0 { + m["b"] = c.BitRate + } + if c.ShareID != "" { + m["sid"] = c.ShareID + } + return m +} + +func (c Claims) WithExpiresAt(t time.Time) Claims { + c.ExpiresAt = t + return c +} + +// ClaimsFromToken extracts Claims directly from a jwt.Token using token.Get(). +func ClaimsFromToken(token jwt.Token) Claims { + var c Claims + c.Issuer, _ = token.Issuer() + c.Subject, _ = token.Subject() + c.IssuedAt, _ = token.IssuedAt() + c.ExpiresAt, _ = token.Expiration() + + var uid string + if err := token.Get("uid", &uid); err == nil { + c.UserID = uid + } + var adm bool + if err := token.Get("adm", &adm); err == nil { + c.IsAdmin = adm + } + var id string + if err := token.Get("id", &id); err == nil { + c.ID = id + } + var f string + if err := token.Get("f", &f); err == nil { + c.Format = f + } + if err := token.Get("b", &c.BitRate); err != nil { + var bf float64 + if err := token.Get("b", &bf); err == nil { + c.BitRate = int(bf) + } + } + var sid string + if err := token.Get("sid", &sid); err == nil { + c.ShareID = sid + } + return c +} diff --git a/core/auth/claims_test.go b/core/auth/claims_test.go new file mode 100644 index 000000000..8820fd295 --- /dev/null +++ b/core/auth/claims_test.go @@ -0,0 +1,108 @@ +package auth_test + +import ( + "time" + + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/core/auth" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Claims", func() { + Describe("ToMap", func() { + It("includes only non-zero fields", func() { + c := auth.Claims{ + Issuer: "ND", + Subject: "johndoe", + UserID: "123", + IsAdmin: true, + } + m := c.ToMap() + Expect(m).To(HaveKeyWithValue("iss", "ND")) + Expect(m).To(HaveKeyWithValue("sub", "johndoe")) + Expect(m).To(HaveKeyWithValue("uid", "123")) + Expect(m).To(HaveKeyWithValue("adm", true)) + Expect(m).NotTo(HaveKey("exp")) + Expect(m).NotTo(HaveKey("iat")) + Expect(m).NotTo(HaveKey("id")) + Expect(m).NotTo(HaveKey("f")) + Expect(m).NotTo(HaveKey("b")) + Expect(m).NotTo(HaveKey("sid")) + }) + + It("includes expiration and issued-at when set", func() { + now := time.Now() + c := auth.Claims{ + IssuedAt: now, + ExpiresAt: now.Add(time.Hour), + } + m := c.ToMap() + Expect(m).To(HaveKey("iat")) + Expect(m).To(HaveKey("exp")) + }) + + It("includes custom claims for public tokens", func() { + c := auth.Claims{ + ID: "al-123", + Format: "mp3", + BitRate: 192, + } + m := c.ToMap() + Expect(m).To(HaveKeyWithValue("id", "al-123")) + Expect(m).To(HaveKeyWithValue("f", "mp3")) + Expect(m).To(HaveKeyWithValue("b", 192)) + }) + + It("includes share ID claim when set", func() { + c := auth.Claims{ShareID: "abc1234567"} + m := c.ToMap() + Expect(m).To(HaveKeyWithValue("sid", "abc1234567")) + }) + }) + + Describe("ClaimsFromToken", func() { + It("round-trips session claims through encode/decode", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + now := time.Now().Truncate(time.Second) + original := auth.Claims{ + Issuer: "ND", + Subject: "johndoe", + UserID: "123", + IsAdmin: true, + } + m := original.ToMap() + m["iat"] = now.UTC().Unix() + token, _, err := tokenAuth.Encode(m) + Expect(err).NotTo(HaveOccurred()) + + c := auth.ClaimsFromToken(token) + Expect(c.Issuer).To(Equal("ND")) + Expect(c.Subject).To(Equal("johndoe")) + Expect(c.UserID).To(Equal("123")) + Expect(c.IsAdmin).To(BeTrue()) + Expect(c.IssuedAt.UTC()).To(Equal(now.UTC())) + }) + + It("round-trips public token claims through encode/decode", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + original := auth.Claims{ + Issuer: "ND", + ID: "al-456", + Format: "opus", + BitRate: 128, + ShareID: "abc1234567", + } + token, _, err := tokenAuth.Encode(original.ToMap()) + Expect(err).NotTo(HaveOccurred()) + + c := auth.ClaimsFromToken(token) + Expect(c.Issuer).To(Equal("ND")) + Expect(c.ID).To(Equal("al-456")) + Expect(c.ShareID).To(Equal("abc1234567")) + Expect(c.Format).To(Equal("opus")) + Expect(c.BitRate).To(Equal(128)) + }) + }) + +}) diff --git a/core/common_test.go b/core/common_test.go index c8dde12d9..0d6e3a299 100644 --- a/core/common_test.go +++ b/core/common_test.go @@ -41,6 +41,7 @@ var _ = Describe("common.go", func() { }) It("returns the absolute path when library exists", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-core)") ctx := context.Background() abs := AbsolutePath(ctx, ds, libId, path) Expect(abs).To(Equal("/library/root/music/file.mp3")) diff --git a/core/external/extdata_helper_test.go b/core/external/extdata_helper_test.go index 367437815..8fabf4490 100644 --- a/core/external/extdata_helper_test.go +++ b/core/external/extdata_helper_test.go @@ -40,7 +40,7 @@ func (m *mockArtistRepo) Get(id string) (*model.Artist, error) { // GetAll implements model.ArtistRepository. func (m *mockArtistRepo) GetAll(options ...model.QueryOptions) (model.Artists, error) { - argsSlice := make([]interface{}, len(options)) + argsSlice := make([]any, len(options)) for i, v := range options { argsSlice[i] = v } @@ -92,9 +92,14 @@ func (m *mockMediaFileRepo) Get(id string) (*model.MediaFile, error) { return args.Get(0).(*model.MediaFile), args.Error(1) } +// GetAllByTags implements model.MediaFileRepository. +func (m *mockMediaFileRepo) GetAllByTags(_ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) { + return m.GetAll(options...) +} + // GetAll implements model.MediaFileRepository. func (m *mockMediaFileRepo) GetAll(options ...model.QueryOptions) (model.MediaFiles, error) { - argsSlice := make([]interface{}, len(options)) + argsSlice := make([]any, len(options)) for i, v := range options { argsSlice[i] = v } @@ -147,7 +152,7 @@ func (m *mockAlbumRepo) Get(id string) (*model.Album, error) { // GetAll implements model.AlbumRepository. func (m *mockAlbumRepo) GetAll(options ...model.QueryOptions) (model.Albums, error) { - argsSlice := make([]interface{}, len(options)) + argsSlice := make([]any, len(options)) for i, v := range options { argsSlice[i] = v } @@ -190,10 +195,13 @@ type mockAgents struct { topSongsAgent agents.ArtistTopSongsRetriever similarAgent agents.ArtistSimilarRetriever imageAgent agents.ArtistImageRetriever - albumInfoAgent agents.AlbumInfoRetriever - bioAgent agents.ArtistBiographyRetriever - mbidAgent agents.ArtistMBIDRetriever - urlAgent agents.ArtistURLRetriever + albumInfoAgent interface { + agents.AlbumInfoRetriever + agents.AlbumImageRetriever + } + bioAgent agents.ArtistBiographyRetriever + mbidAgent agents.ArtistMBIDRetriever + urlAgent agents.ArtistURLRetriever agents.Interface } @@ -268,3 +276,38 @@ func (m *mockAgents) GetArtistImages(ctx context.Context, id, name, mbid string) } return nil, args.Error(1) } + +func (m *mockAgents) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) { + if m.albumInfoAgent != nil { + return m.albumInfoAgent.GetAlbumImages(ctx, name, artist, mbid) + } + args := m.Called(ctx, name, artist, mbid) + if args.Get(0) != nil { + return args.Get(0).([]agents.ExternalImage), args.Error(1) + } + return nil, args.Error(1) +} + +func (m *mockAgents) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, artist, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} + +func (m *mockAgents) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, artist, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} + +func (m *mockAgents) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]agents.Song, error) { + args := m.Called(ctx, id, name, mbid, count) + if args.Get(0) != nil { + return args.Get(0).([]agents.Song), args.Error(1) + } + return nil, args.Error(1) +} diff --git a/core/external/provider.go b/core/external/provider.go index f27ded11b..74dab4972 100644 --- a/core/external/provider.go +++ b/core/external/provider.go @@ -3,6 +3,7 @@ package external import ( "context" "errors" + "fmt" "net/url" "sort" "strings" @@ -11,9 +12,7 @@ import ( "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core/agents" - _ "github.com/navidrome/navidrome/core/agents/lastfm" - _ "github.com/navidrome/navidrome/core/agents/listenbrainz" - _ "github.com/navidrome/navidrome/core/agents/spotify" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils" @@ -43,39 +42,60 @@ type Provider interface { type provider struct { ds model.DataStore ag Agents + matcher *matcher.Matcher artistQueue refreshQueue[auxArtist] albumQueue refreshQueue[auxAlbum] } type auxAlbum struct { model.Album - Name string +} + +// Name returns the appropriate album name for external API calls +// based on the DevPreserveUnicodeInExternalCalls configuration option +func (a *auxAlbum) Name() string { + if conf.Server.DevPreserveUnicodeInExternalCalls { + return a.Album.Name + } + return str.Clear(a.Album.Name) } type auxArtist struct { model.Artist - Name string +} + +// Name returns the appropriate artist name for external API calls +// based on the DevPreserveUnicodeInExternalCalls configuration option +func (a *auxArtist) Name() string { + if conf.Server.DevPreserveUnicodeInExternalCalls { + return a.Artist.Name + } + return str.Clear(a.Artist.Name) } type Agents interface { agents.AlbumInfoRetriever + agents.AlbumImageRetriever agents.ArtistBiographyRetriever agents.ArtistMBIDRetriever agents.ArtistImageRetriever agents.ArtistSimilarRetriever agents.ArtistTopSongsRetriever agents.ArtistURLRetriever + agents.SimilarSongsByTrackRetriever + agents.SimilarSongsByAlbumRetriever + agents.SimilarSongsByArtistRetriever } -func NewProvider(ds model.DataStore, agents Agents) Provider { - e := &provider{ds: ds, ag: agents} +func NewProvider(ds model.DataStore, agents Agents, m *matcher.Matcher) Provider { + e := &provider{ds: ds, ag: agents, matcher: m} e.artistQueue = newRefreshQueue(context.TODO(), e.populateArtistInfo) e.albumQueue = newRefreshQueue(context.TODO(), e.populateAlbumInfo) return e } func (e *provider) getAlbum(ctx context.Context, id string) (auxAlbum, error) { - var entity interface{} + var entity any entity, err := model.GetEntityByID(ctx, e.ds, id) if err != nil { return auxAlbum{}, err @@ -85,7 +105,6 @@ func (e *provider) getAlbum(ctx context.Context, id string) (auxAlbum, error) { switch v := entity.(type) { case *model.Album: album.Album = *v - album.Name = str.Clear(v.Name) case *model.MediaFile: return e.getAlbum(ctx, v.AlbumID) default: @@ -103,8 +122,9 @@ func (e *provider) UpdateAlbumInfo(ctx context.Context, id string) (*model.Album } updatedAt := V(album.ExternalInfoUpdatedAt) + albumName := album.Name() if updatedAt.IsZero() { - log.Debug(ctx, "AlbumInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", album.Name) + log.Debug(ctx, "AlbumInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", albumName) album, err = e.populateAlbumInfo(ctx, album) if err != nil { return nil, err @@ -113,7 +133,7 @@ func (e *provider) UpdateAlbumInfo(ctx context.Context, id string) (*model.Album // If info is expired, trigger a populateAlbumInfo in the background if time.Since(updatedAt) > conf.Server.DevAlbumInfoTimeToLive { - log.Debug("Found expired cached AlbumInfo, refreshing in the background", "updatedAt", album.ExternalInfoUpdatedAt, "name", album.Name) + log.Debug("Found expired cached AlbumInfo, refreshing in the background", "updatedAt", album.ExternalInfoUpdatedAt, "name", albumName) e.albumQueue.enqueue(&album) } @@ -122,42 +142,44 @@ func (e *provider) UpdateAlbumInfo(ctx context.Context, id string) (*model.Album func (e *provider) populateAlbumInfo(ctx context.Context, album auxAlbum) (auxAlbum, error) { start := time.Now() - info, err := e.ag.GetAlbumInfo(ctx, album.Name, album.AlbumArtist, album.MbzAlbumID) + albumName := album.Name() + info, err := e.ag.GetAlbumInfo(ctx, albumName, album.AlbumArtist, album.MbzAlbumID) if errors.Is(err, agents.ErrNotFound) { return album, nil } if err != nil { - log.Error("Error refreshing AlbumInfo", "id", album.ID, "name", album.Name, "artist", album.AlbumArtist, + log.Error("Error refreshing AlbumInfo", "id", album.ID, "name", albumName, "artist", album.AlbumArtist, "elapsed", time.Since(start), err) return album, err } - album.ExternalInfoUpdatedAt = P(time.Now()) + album.ExternalInfoUpdatedAt = new(time.Now()) album.ExternalUrl = info.URL if info.Description != "" { album.Description = info.Description } - if len(info.Images) > 0 { - sort.Slice(info.Images, func(i, j int) bool { - return info.Images[i].Size > info.Images[j].Size + images, err := e.ag.GetAlbumImages(ctx, albumName, album.AlbumArtist, album.MbzAlbumID) + if err == nil && len(images) > 0 { + sort.Slice(images, func(i, j int) bool { + return images[i].Size > images[j].Size }) - album.LargeImageUrl = info.Images[0].URL + album.LargeImageUrl = images[0].URL - if len(info.Images) >= 2 { - album.MediumImageUrl = info.Images[1].URL + if len(images) >= 2 { + album.MediumImageUrl = images[1].URL } - if len(info.Images) >= 3 { - album.SmallImageUrl = info.Images[2].URL + if len(images) >= 3 { + album.SmallImageUrl = images[2].URL } } err = e.ds.Album(ctx).UpdateExternalInfo(&album.Album) if err != nil { - log.Error(ctx, "Error trying to update album external information", "id", album.ID, "name", album.Name, + log.Error(ctx, "Error trying to update album external information", "id", album.ID, "name", albumName, "elapsed", time.Since(start), err) } else { log.Trace(ctx, "AlbumInfo collected", "album", album, "elapsed", time.Since(start)) @@ -167,7 +189,7 @@ func (e *provider) populateAlbumInfo(ctx context.Context, album auxAlbum) (auxAl } func (e *provider) getArtist(ctx context.Context, id string) (auxArtist, error) { - var entity interface{} + var entity any entity, err := model.GetEntityByID(ctx, e.ds, id) if err != nil { return auxArtist{}, err @@ -177,7 +199,6 @@ func (e *provider) getArtist(ctx context.Context, id string) (auxArtist, error) switch v := entity.(type) { case *model.Artist: artist.Artist = *v - artist.Name = str.Clear(v.Name) case *model.MediaFile: return e.getArtist(ctx, v.ArtistID) case *model.Album: @@ -206,8 +227,9 @@ func (e *provider) refreshArtistInfo(ctx context.Context, id string) (auxArtist, // If we don't have any info, retrieves it now updatedAt := V(artist.ExternalInfoUpdatedAt) + artistName := artist.Name() if updatedAt.IsZero() { - log.Debug(ctx, "ArtistInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", artist.Name) + log.Debug(ctx, "ArtistInfo not cached. Retrieving it now", "updatedAt", updatedAt, "id", id, "name", artistName) artist, err = e.populateArtistInfo(ctx, artist) if err != nil { return auxArtist{}, err @@ -216,7 +238,7 @@ func (e *provider) refreshArtistInfo(ctx context.Context, id string) (auxArtist, // If info is expired, trigger a populateArtistInfo in the background if time.Since(updatedAt) > conf.Server.DevArtistInfoTimeToLive { - log.Debug("Found expired cached ArtistInfo, refreshing in the background", "updatedAt", updatedAt, "name", artist.Name) + log.Debug("Found expired cached ArtistInfo, refreshing in the background", "updatedAt", updatedAt, "name", artistName) e.artistQueue.enqueue(&artist) } return artist, nil @@ -225,8 +247,9 @@ func (e *provider) refreshArtistInfo(ctx context.Context, id string) (auxArtist, func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (auxArtist, error) { start := time.Now() // Get MBID first, if it is not yet available + artistName := artist.Name() if artist.MbzArtistID == "" { - mbid, err := e.ag.GetArtistMBID(ctx, artist.ID, artist.Name) + mbid, err := e.ag.GetArtistMBID(ctx, artist.ID, artistName) if mbid != "" && err == nil { artist.MbzArtistID = mbid } @@ -238,18 +261,18 @@ func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (au g.Go(func() error { e.callGetImage(ctx, e.ag, &artist); return nil }) g.Go(func() error { e.callGetBiography(ctx, e.ag, &artist); return nil }) g.Go(func() error { e.callGetURL(ctx, e.ag, &artist); return nil }) - g.Go(func() error { e.callGetSimilar(ctx, e.ag, &artist, maxSimilarArtists, true); return nil }) + g.Go(func() error { e.callGetSimilarArtists(ctx, e.ag, &artist, maxSimilarArtists, true); return nil }) _ = g.Wait() if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistInfo update canceled", "elapsed", "id", artist.ID, "name", artist.Name, time.Since(start), ctx.Err()) + log.Warn(ctx, "ArtistInfo update canceled", "id", artist.ID, "name", artistName, "elapsed", time.Since(start), ctx.Err()) return artist, ctx.Err() } - artist.ExternalInfoUpdatedAt = P(time.Now()) + artist.ExternalInfoUpdatedAt = new(time.Now()) err := e.ds.Artist(ctx).UpdateExternalInfo(&artist.Artist) if err != nil { - log.Error(ctx, "Error trying to update artist external information", "id", artist.ID, "name", artist.Name, + log.Error(ctx, "Error trying to update artist external information", "id", artist.ID, "name", artistName, "elapsed", time.Since(start), err) } else { log.Trace(ctx, "ArtistInfo collected", "artist", artist, "elapsed", time.Since(start)) @@ -258,12 +281,44 @@ func (e *provider) populateArtistInfo(ctx context.Context, artist auxArtist) (au } func (e *provider) SimilarSongs(ctx context.Context, id string, count int) (model.MediaFiles, error) { + entity, err := model.GetEntityByID(ctx, e.ds, id) + if err != nil { + return nil, err + } + + var songs []agents.Song + + // Try entity-specific similarity first + switch v := entity.(type) { + case *model.MediaFile: + songs, err = e.ag.GetSimilarSongsByTrack(ctx, v.ID, v.Title, v.Artist, v.MbzRecordingID, count) + case *model.Album: + songs, err = e.ag.GetSimilarSongsByAlbum(ctx, v.ID, v.Name, v.AlbumArtist, v.MbzAlbumID, count) + case *model.Artist: + songs, err = e.ag.GetSimilarSongsByArtist(ctx, v.ID, v.Name, v.MbzArtistID, count) + default: + log.Warn(ctx, "Unknown entity type", "id", id, "type", fmt.Sprintf("%T", entity)) + return nil, model.ErrNotFound + } + + if err == nil && len(songs) > 0 { + return e.matcher.MatchSongs(ctx, songs, count) + } + + // Fallback to existing similar artists + top songs algorithm + return e.similarSongsFallback(ctx, id, count) +} + +// similarSongsFallback uses the original similar artists + top songs algorithm. The idea is to +// get the artist of the given entity, retrieve similar artists, get their top songs, and pick +// a weighted random selection of songs to return as similar songs. +func (e *provider) similarSongsFallback(ctx context.Context, id string, count int) (model.MediaFiles, error) { artist, err := e.getArtist(ctx, id) if err != nil { return nil, err } - e.callGetSimilar(ctx, e.ag, &artist, 15, false) + e.callGetSimilarArtists(ctx, e.ag, &artist, 15, false) if utils.IsCtxDone(ctx) { log.Warn(ctx, "SimilarSongs call canceled", ctx.Err()) return nil, ctx.Err() @@ -277,7 +332,7 @@ func (e *provider) SimilarSongs(ctx context.Context, id string, count int) (mode } topCount := max(count, 20) - topSongs, err := e.getMatchingTopSongs(ctx, e.ag, &auxArtist{Name: a.Name, Artist: a}, topCount) + topSongs, err := e.getMatchingTopSongs(ctx, e.ag, &auxArtist{Artist: a}, topCount) if err != nil { log.Warn(ctx, "Error getting artist's top songs", "artist", a.Name, err) return nil @@ -321,13 +376,25 @@ func (e *provider) ArtistImage(ctx context.Context, id string) (*url.URL, error) return nil, err } - e.callGetImage(ctx, e.ag, &artist) - if utils.IsCtxDone(ctx) { - log.Warn(ctx, "ArtistImage call canceled", ctx.Err()) - return nil, ctx.Err() + imageUrl := artist.ArtistImageUrl() + if imageUrl == "" { + // No cached URL — must fetch from external source synchronously + e.callGetImage(ctx, e.ag, &artist) + if utils.IsCtxDone(ctx) { + log.Warn(ctx, "ArtistImage call canceled", ctx.Err()) + return nil, ctx.Err() + } + imageUrl = artist.ArtistImageUrl() + } else { + // If cached info is expired, enqueue a background refresh so that config changes + // (e.g. disabling an agent) take effect without waiting for a full artist info refresh. + updatedAt := V(artist.ExternalInfoUpdatedAt) + if !updatedAt.IsZero() && time.Since(updatedAt) > conf.Server.DevArtistInfoTimeToLive { + log.Debug(ctx, "Artist image info expired, enqueuing background refresh", "artist", artist.Name(), "updatedAt", updatedAt) + e.artistQueue.enqueue(&artist) + } } - imageUrl := artist.ArtistImageUrl() if imageUrl == "" { return nil, model.ErrNotFound } @@ -340,29 +407,29 @@ func (e *provider) AlbumImage(ctx context.Context, id string) (*url.URL, error) return nil, err } - info, err := e.ag.GetAlbumInfo(ctx, album.Name, album.AlbumArtist, album.MbzAlbumID) + albumName := album.Name() + images, err := e.ag.GetAlbumImages(ctx, albumName, album.AlbumArtist, album.MbzAlbumID) if err != nil { switch { case errors.Is(err, agents.ErrNotFound): - log.Trace(ctx, "Album not found in agent", "albumID", id, "name", album.Name, "artist", album.AlbumArtist) + log.Trace(ctx, "Album not found in agent", "albumID", id, "name", albumName, "artist", album.AlbumArtist) return nil, model.ErrNotFound case errors.Is(err, context.Canceled): - log.Debug(ctx, "GetAlbumInfo call canceled", err) + log.Debug(ctx, "GetAlbumImages call canceled", err) default: - log.Warn(ctx, "Error getting album info from agent", "albumID", id, "name", album.Name, "artist", album.AlbumArtist, err) + log.Warn(ctx, "Error getting album images from agent", "albumID", id, "name", albumName, "artist", album.AlbumArtist, err) } - return nil, err } - if info == nil { - log.Warn(ctx, "Agent returned nil info without error", "albumID", id, "name", album.Name, "artist", album.AlbumArtist) + if len(images) == 0 { + log.Warn(ctx, "Agent returned no images without error", "albumID", id, "name", albumName, "artist", album.AlbumArtist) return nil, model.ErrNotFound } // Return the biggest image var img agents.ExternalImage - for _, i := range info.Images { + for _, i := range images { if img.Size <= i.Size { img = i } @@ -398,64 +465,38 @@ func (e *provider) TopSongs(ctx context.Context, artistName string, count int) ( } func (e *provider) getMatchingTopSongs(ctx context.Context, agent agents.ArtistTopSongsRetriever, artist *auxArtist, count int) (model.MediaFiles, error) { - songs, err := agent.GetArtistTopSongs(ctx, artist.ID, artist.Name, artist.MbzArtistID, count) + artistName := artist.Name() + songs, err := agent.GetArtistTopSongs(ctx, artist.ID, artistName, artist.MbzArtistID, count) + if err != nil { + return nil, fmt.Errorf("failed to get top songs for artist %s: %w", artistName, err) + } + + // Enrich songs with artist info if not already present (for top songs, we know the artist) + for i := range songs { + if songs[i].Artist == "" { + songs[i].Artist = artistName + } + if songs[i].ArtistMBID == "" { + songs[i].ArtistMBID = artist.MbzArtistID + } + } + + mfs, err := e.matcher.MatchSongs(ctx, songs, count) if err != nil { return nil, err } - var mfs model.MediaFiles - for _, t := range songs { - mf, err := e.findMatchingTrack(ctx, t.MBID, artist.ID, t.Name) - if err != nil { - continue - } - mfs = append(mfs, *mf) - if len(mfs) == count { - break - } - } if len(mfs) == 0 { - log.Debug(ctx, "No matching top songs found", "name", artist.Name) + log.Debug(ctx, "No matching top songs found", "name", artistName) } else { - log.Debug(ctx, "Found matching top songs", "name", artist.Name, "numSongs", len(mfs)) + log.Debug(ctx, "Found matching top songs", "name", artistName, "numSongs", len(mfs)) } return mfs, nil } -func (e *provider) findMatchingTrack(ctx context.Context, mbid string, artistID, title string) (*model.MediaFile, error) { - if mbid != "" { - mfs, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Eq{"mbz_recording_id": mbid}, - squirrel.Eq{"missing": false}, - }, - }) - if err == nil && len(mfs) > 0 { - return &mfs[0], nil - } - return e.findMatchingTrack(ctx, "", artistID, title) - } - mfs, err := e.ds.MediaFile(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Or{ - squirrel.Eq{"artist_id": artistID}, - squirrel.Eq{"album_artist_id": artistID}, - }, - squirrel.Like{"order_title": str.SanitizeFieldForSorting(title)}, - squirrel.Eq{"missing": false}, - }, - Sort: "starred desc, rating desc, year asc, compilation asc ", - Max: 1, - }) - if err != nil || len(mfs) == 0 { - return nil, model.ErrNotFound - } - return &mfs[0], nil -} - func (e *provider) callGetURL(ctx context.Context, agent agents.ArtistURLRetriever, artist *auxArtist) { - artisURL, err := agent.GetArtistURL(ctx, artist.ID, artist.Name, artist.MbzArtistID) + artisURL, err := agent.GetArtistURL(ctx, artist.ID, artist.Name(), artist.MbzArtistID) if err != nil { return } @@ -463,7 +504,7 @@ func (e *provider) callGetURL(ctx context.Context, agent agents.ArtistURLRetriev } func (e *provider) callGetBiography(ctx context.Context, agent agents.ArtistBiographyRetriever, artist *auxArtist) { - bio, err := agent.GetArtistBiography(ctx, artist.ID, str.Clear(artist.Name), artist.MbzArtistID) + bio, err := agent.GetArtistBiography(ctx, artist.ID, artist.Name(), artist.MbzArtistID) if err != nil { return } @@ -473,7 +514,7 @@ func (e *provider) callGetBiography(ctx context.Context, agent agents.ArtistBiog } func (e *provider) callGetImage(ctx context.Context, agent agents.ArtistImageRetriever, artist *auxArtist) { - images, err := agent.GetArtistImages(ctx, artist.ID, artist.Name, artist.MbzArtistID) + images, err := agent.GetArtistImages(ctx, artist.ID, artist.Name(), artist.MbzArtistID) if err != nil { return } @@ -490,65 +531,182 @@ func (e *provider) callGetImage(ctx context.Context, agent agents.ArtistImageRet } } -func (e *provider) callGetSimilar(ctx context.Context, agent agents.ArtistSimilarRetriever, artist *auxArtist, +func (e *provider) callGetSimilarArtists(ctx context.Context, agent agents.ArtistSimilarRetriever, artist *auxArtist, limit int, includeNotPresent bool) { - similar, err := agent.GetSimilarArtists(ctx, artist.ID, artist.Name, artist.MbzArtistID, limit) + artistName := artist.Name() + similar, err := agent.GetSimilarArtists(ctx, artist.ID, artistName, artist.MbzArtistID, limit) if len(similar) == 0 || err != nil { return } start := time.Now() - sa, err := e.mapSimilarArtists(ctx, similar, includeNotPresent) - log.Debug(ctx, "Mapped Similar Artists", "artist", artist.Name, "numSimilar", len(sa), "elapsed", time.Since(start)) + sa, err := e.mapSimilarArtists(ctx, similar, limit, includeNotPresent) + log.Debug(ctx, "Mapped Similar Artists", "artist", artistName, "numSimilar", len(sa), "elapsed", time.Since(start)) if err != nil { return } artist.SimilarArtists = sa } -func (e *provider) mapSimilarArtists(ctx context.Context, similar []agents.Artist, includeNotPresent bool) (model.Artists, error) { +func (e *provider) mapSimilarArtists(ctx context.Context, similar []agents.Artist, limit int, includeNotPresent bool) (model.Artists, error) { var result model.Artists var notPresent []string - artistNames := slice.Map(similar, func(artist agents.Artist) string { return artist.Name }) - - // Query all artists at once - clauses := slice.Map(artistNames, func(name string) squirrel.Sqlizer { - return squirrel.Like{"artist.name": name} - }) - artists, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ - Filters: squirrel.Or(clauses), - }) + // Load artists by ID (highest priority) + idMatches, err := e.loadArtistsByID(ctx, similar) if err != nil { return nil, err } - // Create a map for quick lookup - artistMap := make(map[string]model.Artist) - for _, artist := range artists { - artistMap[artist.Name] = artist + // Load artists by MBID (second priority) + mbidMatches, err := e.loadArtistsByMBID(ctx, similar, idMatches) + if err != nil { + return nil, err } - // Process the similar artists + // Load artists by name (lowest priority, fallback) + nameMatches, err := e.loadArtistsByName(ctx, similar, idMatches, mbidMatches) + if err != nil { + return nil, err + } + + count := 0 + + // Process the similar artists using priority: ID → MBID → Name for _, s := range similar { - if artist, found := artistMap[s.Name]; found { + if count >= limit { + break + } + // Try ID match first + if s.ID != "" { + if artist, found := idMatches[s.ID]; found { + result = append(result, artist) + count++ + continue + } + } + // Try MBID match second + if s.MBID != "" { + if artist, found := mbidMatches[s.MBID]; found { + result = append(result, artist) + count++ + continue + } + } + // Fall back to name match + if artist, found := nameMatches[s.Name]; found { result = append(result, artist) + count++ } else { notPresent = append(notPresent, s.Name) } } // Then fill up with non-present artists - if includeNotPresent { + if includeNotPresent && count < limit { for _, s := range notPresent { // Let the ID empty to indicate that the artist is not present in the DB sa := model.Artist{Name: s} result = append(result, sa) + + count++ + if count >= limit { + break + } } } return result, nil } +func (e *provider) loadArtistsByID(ctx context.Context, similar []agents.Artist) (map[string]model.Artist, error) { + var ids []string + for _, s := range similar { + if s.ID != "" { + ids = append(ids, s.ID) + } + } + matches := map[string]model.Artist{} + if len(ids) == 0 { + return matches, nil + } + res, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"artist.id": ids}, + }) + if err != nil { + return matches, err + } + for _, a := range res { + if _, ok := matches[a.ID]; !ok { + matches[a.ID] = a + } + } + return matches, nil +} + +func (e *provider) loadArtistsByMBID(ctx context.Context, similar []agents.Artist, idMatches map[string]model.Artist) (map[string]model.Artist, error) { + var mbids []string + for _, s := range similar { + // Skip if already matched by ID + if s.ID != "" && idMatches[s.ID].ID != "" { + continue + } + if s.MBID != "" { + mbids = append(mbids, s.MBID) + } + } + matches := map[string]model.Artist{} + if len(mbids) == 0 { + return matches, nil + } + res, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"mbz_artist_id": mbids}, + }) + if err != nil { + return matches, err + } + for _, a := range res { + if id := a.MbzArtistID; id != "" { + if _, ok := matches[id]; !ok { + matches[id] = a + } + } + } + return matches, nil +} + +func (e *provider) loadArtistsByName(ctx context.Context, similar []agents.Artist, idMatches map[string]model.Artist, mbidMatches map[string]model.Artist) (map[string]model.Artist, error) { + var names []string + for _, s := range similar { + // Skip if already matched by ID or MBID + if s.ID != "" && idMatches[s.ID].ID != "" { + continue + } + if s.MBID != "" && mbidMatches[s.MBID].ID != "" { + continue + } + names = append(names, s.Name) + } + matches := map[string]model.Artist{} + if len(names) == 0 { + return matches, nil + } + clauses := slice.Map(names, func(name string) squirrel.Sqlizer { + return squirrel.Like{"artist.name": name} + }) + res, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Or(clauses), + }) + if err != nil { + return matches, err + } + for _, a := range res { + if _, ok := matches[a.Name]; !ok { + matches[a.Name] = a + } + } + return matches, nil +} + func (e *provider) findArtistByName(ctx context.Context, artistName string) (*auxArtist, error) { artists, err := e.ds.Artist(ctx).GetAll(model.QueryOptions{ Filters: squirrel.Like{"artist.name": artistName}, @@ -560,11 +718,7 @@ func (e *provider) findArtistByName(ctx context.Context, artistName string) (*au if len(artists) == 0 { return nil, model.ErrNotFound } - artist := &auxArtist{ - Artist: artists[0], - Name: str.Clear(artists[0].Name), - } - return artist, nil + return &auxArtist{Artist: artists[0]}, nil } func (e *provider) loadSimilar(ctx context.Context, artist *auxArtist, count int, includeNotPresent bool) error { @@ -580,7 +734,7 @@ func (e *provider) loadSimilar(ctx context.Context, artist *auxArtist, count int Filters: squirrel.Eq{"artist.id": ids}, }) if err != nil { - log.Error("Error loading similar artists", "id", artist.ID, "name", artist.Name, err) + log.Error("Error loading similar artists", "id", artist.ID, "name", artist.Name(), err) return err } diff --git a/core/external/provider_albumimage_test.go b/core/external/provider_albumimage_test.go index e248813c1..e801b7cce 100644 --- a/core/external/provider_albumimage_test.go +++ b/core/external/provider_albumimage_test.go @@ -9,6 +9,7 @@ import ( "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/agents" . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" @@ -23,7 +24,6 @@ var _ = Describe("Provider - AlbumImage", func() { var mockAlbumRepo *mockAlbumRepo var mockMediaFileRepo *mockMediaFileRepo var mockAlbumAgent *mockAlbumInfoAgent - var agentsCombined *mockAgents var ctx context.Context BeforeEach(func() { @@ -43,11 +43,8 @@ var _ = Describe("Provider - AlbumImage", func() { mockAlbumAgent = newMockAlbumInfoAgent() - agentsCombined = &mockAgents{ - albumInfoAgent: mockAlbumAgent, - } - - provider = NewProvider(ds, agentsCombined) + agentsCombined := &mockAgents{albumInfoAgent: mockAlbumAgent} + provider = NewProvider(ds, agentsCombined, matcher.New(ds)) // Default mocks // Mocks for GetEntityByID sequence (initial failed lookups) @@ -66,13 +63,11 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() // Expect GetEntityByID sequence mockAlbumRepo.On("Get", "album-1").Return(&model.Album{ID: "album-1", Name: "Album One", AlbumArtistID: "artist-1"}, nil).Once() // Explicitly mock agent call for this test - mockAlbumAgent.On("GetAlbumInfo", ctx, "Album One", "", ""). - Return(&agents.AlbumInfo{ - Images: []agents.ExternalImage{ - {URL: "http://example.com/large.jpg", Size: 1000}, - {URL: "http://example.com/medium.jpg", Size: 500}, - {URL: "http://example.com/small.jpg", Size: 200}, - }, + mockAlbumAgent.On("GetAlbumImages", ctx, "Album One", "", ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/large.jpg", Size: 1000}, + {URL: "http://example.com/medium.jpg", Size: 500}, + {URL: "http://example.com/small.jpg", Size: 200}, }, nil).Once() expectedURL, _ := url.Parse("http://example.com/large.jpg") @@ -82,8 +77,8 @@ var _ = Describe("Provider - AlbumImage", func() { Expect(imgURL).To(Equal(expectedURL)) mockArtistRepo.AssertCalled(GinkgoT(), "Get", "album-1") // From GetEntityByID mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-1") - mockArtistRepo.AssertNotCalled(GinkgoT(), "Get", "artist-1") // Artist lookup no longer happens in getAlbum - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", ctx, "Album One", "", "") // Expect empty artist name + mockArtistRepo.AssertNotCalled(GinkgoT(), "Get", "artist-1") // Artist lookup no longer happens in getAlbum + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, "Album One", "", "") // Expect empty artist name }) It("returns ErrNotFound if the album is not found in the DB", func() { @@ -99,7 +94,7 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.AssertCalled(GinkgoT(), "Get", "not-found") mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "not-found") mockMediaFileRepo.AssertCalled(GinkgoT(), "Get", "not-found") - mockAlbumAgent.AssertNotCalled(GinkgoT(), "GetAlbumInfo", mock.Anything, mock.Anything, mock.Anything, mock.Anything) + mockAlbumAgent.AssertNotCalled(GinkgoT(), "GetAlbumImages", mock.Anything, mock.Anything, mock.Anything) }) It("returns the agent error if the agent fails", func() { @@ -109,7 +104,7 @@ var _ = Describe("Provider - AlbumImage", func() { agentErr := errors.New("agent failure") // Explicitly mock agent call for this test - mockAlbumAgent.On("GetAlbumInfo", ctx, "Album One", "", "").Return(nil, agentErr).Once() // Expect empty artist + mockAlbumAgent.On("GetAlbumImages", ctx, "Album One", "", "").Return(nil, agentErr).Once() // Expect empty artist imgURL, err := provider.AlbumImage(ctx, "album-1") @@ -118,7 +113,7 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.AssertCalled(GinkgoT(), "Get", "album-1") mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-1") mockArtistRepo.AssertNotCalled(GinkgoT(), "Get", "artist-1") - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", ctx, "Album One", "", "") // Expect empty artist + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, "Album One", "", "") // Expect empty artist }) It("returns ErrNotFound if the agent returns ErrNotFound", func() { @@ -127,7 +122,7 @@ var _ = Describe("Provider - AlbumImage", func() { mockAlbumRepo.On("Get", "album-1").Return(&model.Album{ID: "album-1", Name: "Album One", AlbumArtistID: "artist-1"}, nil).Once() // Explicitly mock agent call for this test - mockAlbumAgent.On("GetAlbumInfo", ctx, "Album One", "", "").Return(nil, agents.ErrNotFound).Once() // Expect empty artist + mockAlbumAgent.On("GetAlbumImages", ctx, "Album One", "", "").Return(nil, agents.ErrNotFound).Once() // Expect empty artist imgURL, err := provider.AlbumImage(ctx, "album-1") @@ -135,7 +130,7 @@ var _ = Describe("Provider - AlbumImage", func() { Expect(imgURL).To(BeNil()) mockArtistRepo.AssertCalled(GinkgoT(), "Get", "album-1") mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-1") - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", ctx, "Album One", "", "") // Expect empty artist + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, "Album One", "", "") // Expect empty artist }) It("returns ErrNotFound if the agent returns no images", func() { @@ -144,8 +139,8 @@ var _ = Describe("Provider - AlbumImage", func() { mockAlbumRepo.On("Get", "album-1").Return(&model.Album{ID: "album-1", Name: "Album One", AlbumArtistID: "artist-1"}, nil).Once() // Explicitly mock agent call for this test - mockAlbumAgent.On("GetAlbumInfo", ctx, "Album One", "", ""). - Return(&agents.AlbumInfo{Images: []agents.ExternalImage{}}, nil).Once() // Expect empty artist + mockAlbumAgent.On("GetAlbumImages", ctx, "Album One", "", ""). + Return([]agents.ExternalImage{}, nil).Once() // Expect empty artist imgURL, err := provider.AlbumImage(ctx, "album-1") @@ -153,7 +148,7 @@ var _ = Describe("Provider - AlbumImage", func() { Expect(imgURL).To(BeNil()) mockArtistRepo.AssertCalled(GinkgoT(), "Get", "album-1") mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-1") - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", ctx, "Album One", "", "") // Expect empty artist + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, "Album One", "", "") // Expect empty artist }) It("returns context error if context is canceled", func() { @@ -163,7 +158,7 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() mockAlbumRepo.On("Get", "album-1").Return(&model.Album{ID: "album-1", Name: "Album One", AlbumArtistID: "artist-1"}, nil).Once() // Expect the agent call even if context is cancelled, returning the context error - mockAlbumAgent.On("GetAlbumInfo", cctx, "Album One", "", "").Return(nil, context.Canceled).Once() + mockAlbumAgent.On("GetAlbumImages", cctx, "Album One", "", "").Return(nil, context.Canceled).Once() // Cancel the context *before* calling the function under test cancelCtx() @@ -174,7 +169,7 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.AssertCalled(GinkgoT(), "Get", "album-1") mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-1") // Agent should now be called, verify this expectation - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", cctx, "Album One", "", "") + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", cctx, "Album One", "", "") }) It("derives album ID from MediaFile ID", func() { @@ -186,13 +181,11 @@ var _ = Describe("Provider - AlbumImage", func() { mockAlbumRepo.On("Get", "album-1").Return(&model.Album{ID: "album-1", Name: "Album One", AlbumArtistID: "artist-1"}, nil).Once() // Explicitly mock agent call for this test - mockAlbumAgent.On("GetAlbumInfo", ctx, "Album One", "", ""). - Return(&agents.AlbumInfo{ - Images: []agents.ExternalImage{ - {URL: "http://example.com/large.jpg", Size: 1000}, - {URL: "http://example.com/medium.jpg", Size: 500}, - {URL: "http://example.com/small.jpg", Size: 200}, - }, + mockAlbumAgent.On("GetAlbumImages", ctx, "Album One", "", ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/large.jpg", Size: 1000}, + {URL: "http://example.com/medium.jpg", Size: 500}, + {URL: "http://example.com/small.jpg", Size: 200}, }, nil).Once() expectedURL, _ := url.Parse("http://example.com/large.jpg") @@ -206,7 +199,7 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.AssertCalled(GinkgoT(), "Get", "album-1") mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-1") mockArtistRepo.AssertNotCalled(GinkgoT(), "Get", "artist-1") - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", ctx, "Album One", "", "") + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, "Album One", "", "") }) It("handles different image orders from agent", func() { @@ -214,13 +207,11 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() // Expect GetEntityByID sequence mockAlbumRepo.On("Get", "album-1").Return(&model.Album{ID: "album-1", Name: "Album One", AlbumArtistID: "artist-1"}, nil).Once() // Explicitly mock agent call for this test - mockAlbumAgent.On("GetAlbumInfo", ctx, "Album One", "", ""). - Return(&agents.AlbumInfo{ - Images: []agents.ExternalImage{ - {URL: "http://example.com/small.jpg", Size: 200}, - {URL: "http://example.com/large.jpg", Size: 1000}, - {URL: "http://example.com/medium.jpg", Size: 500}, - }, + mockAlbumAgent.On("GetAlbumImages", ctx, "Album One", "", ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/small.jpg", Size: 200}, + {URL: "http://example.com/large.jpg", Size: 1000}, + {URL: "http://example.com/medium.jpg", Size: 500}, }, nil).Once() expectedURL, _ := url.Parse("http://example.com/large.jpg") @@ -228,7 +219,7 @@ var _ = Describe("Provider - AlbumImage", func() { Expect(err).ToNot(HaveOccurred()) Expect(imgURL).To(Equal(expectedURL)) // Should still pick the largest - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", ctx, "Album One", "", "") + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, "Album One", "", "") }) It("handles agent returning only one image", func() { @@ -236,11 +227,9 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() // Expect GetEntityByID sequence mockAlbumRepo.On("Get", "album-1").Return(&model.Album{ID: "album-1", Name: "Album One", AlbumArtistID: "artist-1"}, nil).Once() // Explicitly mock agent call for this test - mockAlbumAgent.On("GetAlbumInfo", ctx, "Album One", "", ""). - Return(&agents.AlbumInfo{ - Images: []agents.ExternalImage{ - {URL: "http://example.com/single.jpg", Size: 700}, - }, + mockAlbumAgent.On("GetAlbumImages", ctx, "Album One", "", ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/single.jpg", Size: 700}, }, nil).Once() expectedURL, _ := url.Parse("http://example.com/single.jpg") @@ -248,7 +237,7 @@ var _ = Describe("Provider - AlbumImage", func() { Expect(err).ToNot(HaveOccurred()) Expect(imgURL).To(Equal(expectedURL)) - mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumInfo", ctx, "Album One", "", "") + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, "Album One", "", "") }) It("returns ErrNotFound if deriving album ID fails", func() { @@ -270,14 +259,78 @@ var _ = Describe("Provider - AlbumImage", func() { mockArtistRepo.AssertCalled(GinkgoT(), "Get", "not-found") mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "not-found") mockMediaFileRepo.AssertCalled(GinkgoT(), "Get", "not-found") - mockAlbumAgent.AssertNotCalled(GinkgoT(), "GetAlbumInfo", mock.Anything, mock.Anything, mock.Anything, mock.Anything) + mockAlbumAgent.AssertNotCalled(GinkgoT(), "GetAlbumImages", mock.Anything, mock.Anything, mock.Anything) + }) + + Context("Unicode handling in album names", func() { + var albumWithEnDash *model.Album + var expectedURL *url.URL + + const ( + originalAlbumName = "Raising Hell–Deluxe" // Album name with en dash + normalizedAlbumName = "Raising Hell-Deluxe" // Normalized version with hyphen + ) + + BeforeEach(func() { + // Test with en dash (–) in album name + albumWithEnDash = &model.Album{ID: "album-endash", Name: originalAlbumName, AlbumArtistID: "artist-1"} + mockArtistRepo.Mock = mock.Mock{} // Reset default expectations + mockAlbumRepo.Mock = mock.Mock{} // Reset default expectations + mockArtistRepo.On("Get", "album-endash").Return(nil, model.ErrNotFound).Once() + mockAlbumRepo.On("Get", "album-endash").Return(albumWithEnDash, nil).Once() + + expectedURL, _ = url.Parse("http://example.com/album.jpg") + + // Mock the album agent to return an image for the album + mockAlbumAgent.On("GetAlbumImages", ctx, mock.AnythingOfType("string"), "", ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/album.jpg", Size: 1000}, + }, nil).Once() + }) + + When("DevPreserveUnicodeInExternalCalls is true", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = true + }) + + It("preserves Unicode characters in album names", func() { + // Act + imgURL, err := provider.AlbumImage(ctx, "album-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-endash") + // This is the key assertion: ensure the original Unicode name is used + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, originalAlbumName, "", "") + }) + }) + + When("DevPreserveUnicodeInExternalCalls is false", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = false + }) + + It("normalizes Unicode characters", func() { + // Act + imgURL, err := provider.AlbumImage(ctx, "album-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockAlbumRepo.AssertCalled(GinkgoT(), "Get", "album-endash") + // This assertion ensures the normalized name is used (en dash → hyphen) + mockAlbumAgent.AssertCalled(GinkgoT(), "GetAlbumImages", ctx, normalizedAlbumName, "", "") + }) + }) }) }) // mockAlbumInfoAgent implementation type mockAlbumInfoAgent struct { mock.Mock - agents.AlbumInfoRetriever // Embed interface + agents.AlbumInfoRetriever + agents.AlbumImageRetriever } func newMockAlbumInfoAgent() *mockAlbumInfoAgent { @@ -299,5 +352,14 @@ func (m *mockAlbumInfoAgent) GetAlbumInfo(ctx context.Context, name, artist, mbi return args.Get(0).(*agents.AlbumInfo), args.Error(1) } -// Ensure mockAgent implements the interface +func (m *mockAlbumInfoAgent) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) { + args := m.Called(ctx, name, artist, mbid) + if args.Get(0) == nil { + return nil, args.Error(1) + } + return args.Get(0).([]agents.ExternalImage), args.Error(1) +} + +// Ensure mockAgent implements the interfaces var _ agents.AlbumInfoRetriever = (*mockAlbumInfoAgent)(nil) +var _ agents.AlbumImageRetriever = (*mockAlbumInfoAgent)(nil) diff --git a/core/external/provider_artistimage_test.go b/core/external/provider_artistimage_test.go index 96341836a..79612d651 100644 --- a/core/external/provider_artistimage_test.go +++ b/core/external/provider_artistimage_test.go @@ -1,14 +1,18 @@ package external_test import ( + "bytes" "context" "errors" "net/url" + "time" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/agents" . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/matcher" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" @@ -48,7 +52,7 @@ var _ = Describe("Provider - ArtistImage", func() { imageAgent: mockImageAgent, } - provider = NewProvider(ds, agentsCombined) + provider = NewProvider(ds, agentsCombined, matcher.New(ds)) // Default mocks for successful Get calls mockArtistRepo.On("Get", "artist-1").Return(&model.Artist{ID: "artist-1", Name: "Artist One"}, nil).Maybe() @@ -265,6 +269,127 @@ var _ = Describe("Provider - ArtistImage", func() { mockArtistRepo.AssertCalled(GinkgoT(), "Get", "artist-1") mockImageAgent.AssertCalled(GinkgoT(), "GetArtistImages", ctx, "artist-1", "Artist One", "") }) + + It("returns cached URL and does not call agent when info is not expired", func() { + // Arrange: artist has a cached image URL with recent ExternalInfoUpdatedAt + cachedArtist := &model.Artist{ + ID: "artist-cached", + Name: "Cached Artist", + LargeImageUrl: "http://example.com/cached-large.jpg", + ExternalInfoUpdatedAt: new(time.Now().Add(-1 * time.Minute)), + } + mockArtistRepo.On("Get", "artist-cached").Return(cachedArtist, nil).Maybe() + expectedURL, _ := url.Parse("http://example.com/cached-large.jpg") + + // Capture log output + var logBuf bytes.Buffer + log.SetOutput(&logBuf) + defer log.SetOutput(GinkgoWriter) + log.SetLevel(log.LevelDebug) + + // Act + imgURL, err := provider.ArtistImage(ctx, "artist-cached") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockImageAgent.AssertNotCalled(GinkgoT(), "GetArtistImages", mock.Anything, "artist-cached", mock.Anything, mock.Anything) + + // Assert: background refresh was NOT enqueued + Expect(logBuf.String()).ToNot(ContainSubstring("Artist image info expired, enqueuing background refresh")) + + }) + + It("returns stale URL and enqueues refresh when info is expired", func() { + // Arrange + conf.Server.DevArtistInfoTimeToLive = 1 * time.Nanosecond + staleArtist := &model.Artist{ + ID: "artist-expired", + Name: "Expired Artist", + LargeImageUrl: "http://example.com/expired-large.jpg", + ExternalInfoUpdatedAt: new(time.Now().Add(-1 * time.Hour)), + } + mockArtistRepo.On("Get", "artist-expired").Return(staleArtist, nil).Maybe() + expectedURL, _ := url.Parse("http://example.com/expired-large.jpg") + + // Capture log output + var logBuf bytes.Buffer + log.SetOutput(&logBuf) + defer log.SetOutput(GinkgoWriter) + log.SetLevel(log.LevelDebug) + + // Act + imgURL, err := provider.ArtistImage(ctx, "artist-expired") + + // Assert: returns stale URL immediately, no agent call + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockImageAgent.AssertNotCalled(GinkgoT(), "GetArtistImages", mock.Anything, "artist-expired", mock.Anything, mock.Anything) + + // Assert: background refresh was enqueued + Expect(logBuf.String()).To(ContainSubstring("Artist image info expired, enqueuing background refresh")) + }) + + Context("Unicode handling in artist names", func() { + var artistWithEnDash *model.Artist + var expectedURL *url.URL + + const ( + originalArtistName = "Run–D.M.C." // Artist name with en dash + normalizedArtistName = "Run-D.M.C." // Normalized version with hyphen + ) + + BeforeEach(func() { + // Test with en dash (–) in artist name like "Run–D.M.C." + artistWithEnDash = &model.Artist{ID: "artist-endash", Name: originalArtistName} + mockArtistRepo.Mock = mock.Mock{} // Reset default expectations + mockArtistRepo.On("Get", "artist-endash").Return(artistWithEnDash, nil).Once() + + expectedURL, _ = url.Parse("http://example.com/rundmc.jpg") + + // Mock the image agent to return an image for the artist + mockImageAgent.On("GetArtistImages", ctx, "artist-endash", mock.AnythingOfType("string"), ""). + Return([]agents.ExternalImage{ + {URL: "http://example.com/rundmc.jpg", Size: 1000}, + }, nil).Once() + + }) + + When("DevPreserveUnicodeInExternalCalls is true", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = true + }) + It("preserves Unicode characters in artist names", func() { + // Act + imgURL, err := provider.ArtistImage(ctx, "artist-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockArtistRepo.AssertCalled(GinkgoT(), "Get", "artist-endash") + // This is the key assertion: ensure the original Unicode name is used + mockImageAgent.AssertCalled(GinkgoT(), "GetArtistImages", ctx, "artist-endash", originalArtistName, "") + }) + }) + + When("DevPreserveUnicodeInExternalCalls is false", func() { + BeforeEach(func() { + conf.Server.DevPreserveUnicodeInExternalCalls = false + }) + + It("normalizes Unicode characters", func() { + // Act + imgURL, err := provider.ArtistImage(ctx, "artist-endash") + + // Assert + Expect(err).ToNot(HaveOccurred()) + Expect(imgURL).To(Equal(expectedURL)) + mockArtistRepo.AssertCalled(GinkgoT(), "Get", "artist-endash") + // This assertion ensures the normalized name is used (en dash → hyphen) + mockImageAgent.AssertCalled(GinkgoT(), "GetArtistImages", ctx, "artist-endash", normalizedArtistName, "") + }) + }) + }) }) // mockArtistImageAgent implementation using testify/mock diff --git a/core/external/provider_similarsongs_test.go b/core/external/provider_similarsongs_test.go index fd622746a..c9a1a64ef 100644 --- a/core/external/provider_similarsongs_test.go +++ b/core/external/provider_similarsongs_test.go @@ -4,8 +4,10 @@ import ( "context" "errors" + "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/core/agents" . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" @@ -19,9 +21,10 @@ var _ = Describe("Provider - SimilarSongs", func() { var mockAgent *mockSimilarArtistAgent var mockTopAgent agents.ArtistTopSongsRetriever var mockSimilarAgent agents.ArtistSimilarRetriever - var agentsCombined Agents + var agentsCombined *mockAgents var artistRepo *mockArtistRepo var mediaFileRepo *mockMediaFileRepo + var albumRepo *mockAlbumRepo var ctx context.Context BeforeEach(func() { @@ -29,10 +32,12 @@ var _ = Describe("Provider - SimilarSongs", func() { artistRepo = newMockArtistRepo() mediaFileRepo = newMockMediaFileRepo() + albumRepo = newMockAlbumRepo() ds = &tests.MockDataStore{ MockedArtist: artistRepo, MockedMediaFile: mediaFileRepo, + MockedAlbum: albumRepo, } mockAgent = &mockSimilarArtistAgent{} @@ -44,15 +49,233 @@ var _ = Describe("Provider - SimilarSongs", func() { similarAgent: mockSimilarAgent, } - provider = NewProvider(ds, agentsCombined) + provider = NewProvider(ds, agentsCombined, matcher.New(ds)) + }) + + Describe("dispatch by entity type", func() { + Context("when ID is a MediaFile (track)", func() { + It("calls GetSimilarSongsByTrack and returns matched songs", func() { + track := model.MediaFile{ID: "track-1", Title: "Just Can't Get Enough", Artist: "Depeche Mode", MbzRecordingID: "track-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "Dreaming of Me", Artist: "Depeche Mode"} + + // GetEntityByID tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, "track-1", "Just Can't Get Enough", "Depeche Mode", "track-mbid", 5). + Return([]agents.Song{ + {Name: "Dreaming of Me", MBID: "", Artist: "Depeche Mode", ArtistMBID: "artist-mbid"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - no MBID matches (empty MBID means this won't be called) + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasMBID := eq["mbz_recording_id"] + return hasMBID + })).Return(model.MediaFiles{}, nil).Maybe() + + // Mock loadTracksByTitleAndArtist - queries by artist name + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasArtist := eq["order_artist_name"] + return hasArtist + })).Return(model.MediaFiles{matchedSong}, nil).Maybe() + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + + It("falls back to artist-based algorithm when GetSimilarSongsByTrack returns empty", func() { + track := model.MediaFile{ID: "track-1", Title: "Track", Artist: "Artist", ArtistID: "artist-1"} + artist := model.Artist{ID: "artist-1", Name: "Artist"} + song := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + // GetEntityByID for the initial call tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + agentsCombined.On("GetSimilarSongsByTrack", mock.Anything, "track-1", "Track", "Artist", "", mock.Anything). + Return([]agents.Song{}, nil).Once() + + // Fallback calls getArtist(id) which calls GetEntityByID again - this time it finds the mediafile + // and recursively calls getArtist(v.ArtistID) + artistRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "track-1").Return(nil, model.ErrNotFound).Once() + mediaFileRepo.On("Get", "track-1").Return(&track, nil).Once() + + // Then it recurses with the artist-1 ID + artistRepo.On("Get", "artist-1").Return(&artist, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist}, nil).Maybe() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist", "", mock.Anything). + Return([]agents.Song{{Name: "Song One", MBID: "mbid-1"}}, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "track-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + }) + + Context("when ID is an Album", func() { + It("calls GetSimilarSongsByAlbum and returns matched songs", func() { + album := model.Album{ID: "album-1", Name: "Speak & Spell", AlbumArtist: "Depeche Mode", MbzAlbumID: "album-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "New Life", Artist: "Depeche Mode", MbzRecordingID: "song-mbid"} + + // GetEntityByID tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + agentsCombined.On("GetSimilarSongsByAlbum", mock.Anything, "album-1", "Speak & Spell", "Depeche Mode", "album-mbid", 5). + Return([]agents.Song{ + {Name: "New Life", MBID: "song-mbid", Artist: "Depeche Mode"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - MBID match + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + _, hasEq := and[0].(squirrel.Eq) + return hasEq + })).Return(model.MediaFiles{matchedSong}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "album-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + + It("falls back when GetSimilarSongsByAlbum returns ErrNotFound", func() { + album := model.Album{ID: "album-1", Name: "Album", AlbumArtist: "Artist", AlbumArtistID: "artist-1"} + artist := model.Artist{ID: "artist-1", Name: "Artist"} + song := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + + // GetEntityByID for the initial call tries Artist, Album, Playlist, then MediaFile + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + agentsCombined.On("GetSimilarSongsByAlbum", mock.Anything, "album-1", "Album", "Artist", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + + // Fallback calls getArtist(id) which calls GetEntityByID again - this time it finds the album + // and recursively calls getArtist(v.AlbumArtistID) + artistRepo.On("Get", "album-1").Return(nil, model.ErrNotFound).Once() + albumRepo.On("Get", "album-1").Return(&album, nil).Once() + + // Then it recurses with the artist-1 ID + artistRepo.On("Get", "artist-1").Return(&artist, nil).Maybe() + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 1 && opt.Filters != nil + })).Return(model.Artists{artist}, nil).Maybe() + + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist", "", 15). + Return([]agents.Artist{}, nil).Once() + + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + return opt.Max == 0 && opt.Filters != nil + })).Return(model.Artists{}, nil).Once() + + mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist", "", mock.Anything). + Return([]agents.Song{{Name: "Song One", MBID: "mbid-1"}}, nil).Once() + + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "album-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + }) + }) + + Context("when ID is an Artist", func() { + It("calls GetSimilarSongsByArtist and returns matched songs", func() { + artist := model.Artist{ID: "artist-1", Name: "Depeche Mode", MbzArtistID: "artist-mbid"} + matchedSong := model.MediaFile{ID: "matched-1", Title: "Enjoy the Silence", Artist: "Depeche Mode", MbzRecordingID: "song-mbid"} + + artistRepo.On("Get", "artist-1").Return(&artist, nil).Once() + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Depeche Mode", "artist-mbid", 5). + Return([]agents.Song{ + {Name: "Enjoy the Silence", MBID: "song-mbid", Artist: "Depeche Mode"}, + }, nil).Once() + + // Mock loadTracksByID - no ID matches + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Eq) + return ok + })).Return(model.MediaFiles{}, nil).Once() + + // Mock loadTracksByMBID - MBID match + mediaFileRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 1 { + return false + } + _, hasEq := and[0].(squirrel.Eq) + return hasEq + })).Return(model.MediaFiles{matchedSong}, nil).Once() + + songs, err := provider.SimilarSongs(ctx, "artist-1", 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("matched-1")) + }) + }) }) It("returns similar songs from main artist and similar artists", func() { artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} similarArtist := model.Artist{ID: "artist-3", Name: "Similar Artist"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1"} - song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1"} - song3 := model.MediaFile{ID: "song-3", Title: "Song Three", ArtistID: "artist-3"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} + song3 := model.MediaFile{ID: "song-3", Title: "Song Three", ArtistID: "artist-3", MbzRecordingID: "mbid-3"} artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() artistRepo.On("Get", "artist-3").Return(&similarArtist, nil).Maybe() @@ -61,14 +284,26 @@ var _ = Describe("Provider - SimilarSongs", func() { return opt.Max == 1 && opt.Filters != nil })).Return(model.Artists{artist1}, nil).Once() + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + similarAgentsResp := []agents.Artist{ {Name: "Similar Artist", MBID: "similar-mbid"}, } mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). Return(similarAgentsResp, nil).Once() + // Mock the three-phase artist lookup: ID (skipped - no IDs), MBID, then Name + // MBID lookup returns empty (no match) artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { - return opt.Max == 0 && opt.Filters != nil + _, ok := opt.Filters.(squirrel.Eq) + return opt.Max == 0 && ok + })).Return(model.Artists{}, nil).Once() + // Name lookup returns the similar artist + artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { + _, ok := opt.Filters.(squirrel.Or) + return opt.Max == 0 && ok })).Return(model.Artists{similarArtist}, nil).Once() mockAgent.On("GetArtistTopSongs", mock.Anything, "artist-1", "Artist One", "", mock.Anything). @@ -82,9 +317,8 @@ var _ = Describe("Provider - SimilarSongs", func() { {Name: "Song Three", MBID: "mbid-3"}, }, nil).Once() - mediaFileRepo.FindByMBID("mbid-1", song1) - mediaFileRepo.FindByMBID("mbid-2", song2) - mediaFileRepo.FindByMBID("mbid-3", song3) + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song3}, nil).Once() songs, err := provider.SimilarSongs(ctx, "artist-1", 3) @@ -98,6 +332,7 @@ var _ = Describe("Provider - SimilarSongs", func() { It("returns ErrNotFound when artist is not found", func() { artistRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) mediaFileRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) + albumRepo.On("Get", "artist-unknown-artist").Return(nil, model.ErrNotFound) artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { return opt.Max == 1 && opt.Filters != nil @@ -111,13 +346,17 @@ var _ = Describe("Provider - SimilarSongs", func() { It("returns songs from main artist when GetSimilarArtists returns error", func() { artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { return opt.Max == 1 && opt.Filters != nil })).Return(model.Artists{artist1}, nil).Maybe() + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). Return(nil, errors.New("error getting similar artists")).Once() @@ -130,7 +369,7 @@ var _ = Describe("Provider - SimilarSongs", func() { {Name: "Song One", MBID: "mbid-1"}, }, nil).Once() - mediaFileRepo.FindByMBID("mbid-1", song1) + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() songs, err := provider.SimilarSongs(ctx, "artist-1", 5) @@ -147,6 +386,10 @@ var _ = Describe("Provider - SimilarSongs", func() { return opt.Max == 1 && opt.Filters != nil })).Return(model.Artists{artist1}, nil).Maybe() + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). Return([]agents.Artist{}, nil).Once() @@ -165,14 +408,18 @@ var _ = Describe("Provider - SimilarSongs", func() { It("respects count parameter", func() { artist1 := model.Artist{ID: "artist-1", Name: "Artist One"} - song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1"} - song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1"} + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-2"} artistRepo.On("Get", "artist-1").Return(&artist1, nil).Maybe() artistRepo.On("GetAll", mock.MatchedBy(func(opt model.QueryOptions) bool { return opt.Max == 1 && opt.Filters != nil })).Return(model.Artists{artist1}, nil).Maybe() + // New similar songs by artist returns ErrNotFound to trigger fallback + agentsCombined.On("GetSimilarSongsByArtist", mock.Anything, "artist-1", "Artist One", "", mock.Anything). + Return(nil, agents.ErrNotFound).Once() + mockAgent.On("GetSimilarArtists", mock.Anything, "artist-1", "Artist One", "", 15). Return([]agents.Artist{}, nil).Once() @@ -186,8 +433,7 @@ var _ = Describe("Provider - SimilarSongs", func() { {Name: "Song Two", MBID: "mbid-2"}, }, nil).Once() - mediaFileRepo.FindByMBID("mbid-1", song1) - mediaFileRepo.FindByMBID("mbid-2", song2) + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() songs, err := provider.SimilarSongs(ctx, "artist-1", 1) diff --git a/core/external/provider_topsongs_test.go b/core/external/provider_topsongs_test.go index 4ce7911de..0d9b5800d 100644 --- a/core/external/provider_topsongs_test.go +++ b/core/external/provider_topsongs_test.go @@ -4,11 +4,13 @@ import ( "context" "errors" + _ "github.com/navidrome/navidrome/adapters/lastfm" + _ "github.com/navidrome/navidrome/adapters/listenbrainz" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/agents" - _ "github.com/navidrome/navidrome/core/agents/lastfm" - _ "github.com/navidrome/navidrome/core/agents/listenbrainz" - _ "github.com/navidrome/navidrome/core/agents/spotify" . "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" @@ -26,6 +28,10 @@ var _ = Describe("Provider - TopSongs", func() { ) BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + // Disable fuzzy matching for these tests to avoid unexpected GetAll calls + conf.Server.Matcher.FuzzyThreshold = 100 + ctx = GinkgoT().Context() artistRepo = newMockArtistRepo() // Use helper mock @@ -39,11 +45,7 @@ var _ = Describe("Provider - TopSongs", func() { ag = new(mockAgents) - p = NewProvider(ds, ag) - }) - - BeforeEach(func() { - // Setup expectations in individual tests + p = NewProvider(ds, ag, matcher.New(ds)) }) It("returns top songs for a known artist", func() { @@ -58,11 +60,10 @@ var _ = Describe("Provider - TopSongs", func() { } ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 2).Return(agentSongs, nil).Once() - // Mock finding matching tracks + // Mock finding matching tracks (both returned in a single query) song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-song-1"} song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-song-2"} - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song2}, nil).Once() + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() songs, err := p.TopSongs(ctx, "Artist One", 2) @@ -155,11 +156,10 @@ var _ = Describe("Provider - TopSongs", func() { } ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 2).Return(agentSongs, nil).Once() - // Mock finding matching tracks (only find song 1) + // Mock finding matching tracks (only find song 1 on bulk query) song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-song-1"} - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{}, nil).Once() // For mbid-song-2 (fails) - mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{}, nil).Once() // For title fallback (fails) + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() // bulk MBID query + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{}, nil).Once() // title fallback for song2 songs, err := p.TopSongs(ctx, "Artist One", 2) @@ -190,4 +190,147 @@ var _ = Describe("Provider - TopSongs", func() { artistRepo.AssertExpectations(GinkgoT()) ag.AssertExpectations(GinkgoT()) }) + + It("falls back to title matching when MbzRecordingID is missing", func() { + // Mock finding the artist + artist1 := model.Artist{ID: "artist-1", Name: "Artist One", MbzArtistID: "mbid-artist-1"} + artistRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.Artists{artist1}, nil).Once() + + // Mock agent response with songs that have NO MBID (empty string) + agentSongs := []agents.Song{ + {Name: "Song One", MBID: ""}, // No MBID, should fall back to title matching + {Name: "Song Two", MBID: ""}, // No MBID, should fall back to title matching + } + ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 2).Return(agentSongs, nil).Once() + + // Since there are no MBIDs, loadTracksByMBID should not make any database call + // loadTracksByTitle should make a database call for title matching + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "", OrderTitle: "song one"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "", OrderTitle: "song two"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + + songs, err := p.TopSongs(ctx, "Artist One", 2) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("song-1")) + Expect(songs[1].ID).To(Equal("song-2")) + artistRepo.AssertExpectations(GinkgoT()) + ag.AssertExpectations(GinkgoT()) + mediaFileRepo.AssertExpectations(GinkgoT()) + }) + + It("combines MBID and title matching when some songs have missing MbzRecordingID", func() { + // Mock finding the artist + artist1 := model.Artist{ID: "artist-1", Name: "Artist One", MbzArtistID: "mbid-artist-1"} + artistRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.Artists{artist1}, nil).Once() + + // Mock agent response with mixed MBID availability + agentSongs := []agents.Song{ + {Name: "Song One", MBID: "mbid-song-1"}, // Has MBID, should match by MBID + {Name: "Song Two", MBID: ""}, // No MBID, should fall back to title matching + } + ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 2).Return(agentSongs, nil).Once() + + // Mock the MBID query (finds song1 by MBID) + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-song-1", OrderTitle: "song one"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() + + // Mock the title fallback query (finds song2 by title) + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "", OrderTitle: "song two"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song2}, nil).Once() + + songs, err := p.TopSongs(ctx, "Artist One", 2) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("song-1")) // Found by MBID + Expect(songs[1].ID).To(Equal("song-2")) // Found by title + artistRepo.AssertExpectations(GinkgoT()) + ag.AssertExpectations(GinkgoT()) + mediaFileRepo.AssertExpectations(GinkgoT()) + }) + + It("only returns requested count when provider returns additional items", func() { + // Mock finding the artist + artist1 := model.Artist{ID: "artist-1", Name: "Artist One", MbzArtistID: "mbid-artist-1"} + artistRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.Artists{artist1}, nil).Once() + + // Mock agent response + agentSongs := []agents.Song{ + {Name: "Song One", MBID: "mbid-song-1"}, + {Name: "Song Two", MBID: "mbid-song-2"}, + } + ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 1).Return(agentSongs, nil).Once() + + // Mock finding matching tracks (both returned in a single query) + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-song-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1", MbzRecordingID: "mbid-song-2"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + + songs, err := p.TopSongs(ctx, "Artist One", 1) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + artistRepo.AssertExpectations(GinkgoT()) + ag.AssertExpectations(GinkgoT()) + mediaFileRepo.AssertExpectations(GinkgoT()) + }) + + It("matches songs by ID first when agent provides IDs", func() { + // Mock finding the artist + artist1 := model.Artist{ID: "artist-1", Name: "Artist One", MbzArtistID: "mbid-artist-1"} + artistRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.Artists{artist1}, nil).Once() + + // Mock agent response with IDs provided (highest priority matching) + // Note: Songs have no MBID to ensure only ID matching is used + agentSongs := []agents.Song{ + {ID: "song-1", Name: "Song One"}, + {ID: "song-2", Name: "Song Two"}, + } + ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 2).Return(agentSongs, nil).Once() + + // Mock ID lookup (first query - should match both songs directly) + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1"} + song2 := model.MediaFile{ID: "song-2", Title: "Song Two", ArtistID: "artist-1"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1, song2}, nil).Once() + + songs, err := p.TopSongs(ctx, "Artist One", 2) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(2)) + Expect(songs[0].ID).To(Equal("song-1")) + Expect(songs[1].ID).To(Equal("song-2")) + artistRepo.AssertExpectations(GinkgoT()) + ag.AssertExpectations(GinkgoT()) + mediaFileRepo.AssertExpectations(GinkgoT()) + }) + + It("falls back to MBID when ID is not found", func() { + // Mock finding the artist + artist1 := model.Artist{ID: "artist-1", Name: "Artist One", MbzArtistID: "mbid-artist-1"} + artistRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.Artists{artist1}, nil).Once() + + // Mock agent response with ID that won't be found, but MBID that will + agentSongs := []agents.Song{ + {ID: "non-existent-id", Name: "Song One", MBID: "mbid-song-1"}, + } + ag.On("GetArtistTopSongs", ctx, "artist-1", "Artist One", "mbid-artist-1", 1).Return(agentSongs, nil).Once() + + // Mock ID lookup - returns empty (ID not found) + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{}, nil).Once() + // Mock MBID lookup - finds the song + song1 := model.MediaFile{ID: "song-1", Title: "Song One", ArtistID: "artist-1", MbzRecordingID: "mbid-song-1"} + mediaFileRepo.On("GetAll", mock.AnythingOfType("model.QueryOptions")).Return(model.MediaFiles{song1}, nil).Once() + + songs, err := p.TopSongs(ctx, "Artist One", 1) + + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(1)) + Expect(songs[0].ID).To(Equal("song-1")) + artistRepo.AssertExpectations(GinkgoT()) + ag.AssertExpectations(GinkgoT()) + mediaFileRepo.AssertExpectations(GinkgoT()) + }) }) diff --git a/core/external/provider_updatealbuminfo_test.go b/core/external/provider_updatealbuminfo_test.go index 0622849f0..21824c93f 100644 --- a/core/external/provider_updatealbuminfo_test.go +++ b/core/external/provider_updatealbuminfo_test.go @@ -8,10 +8,10 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core/agents" "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" - "github.com/navidrome/navidrome/utils/gg" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" "github.com/stretchr/testify/mock" @@ -34,7 +34,7 @@ var _ = Describe("Provider - UpdateAlbumInfo", func() { ctx = GinkgoT().Context() ds = new(tests.MockDataStore) ag = new(mockAgents) - p = external.NewProvider(ds, ag) + p = external.NewProvider(ds, ag, matcher.New(ds)) mockAlbumRepo = ds.Album(ctx).(*tests.MockAlbumRepo) conf.Server.DevAlbumInfoTimeToLive = 1 * time.Hour }) @@ -59,13 +59,13 @@ var _ = Describe("Provider - UpdateAlbumInfo", func() { expectedInfo := &agents.AlbumInfo{ URL: "http://example.com/album", Description: "Album Description", - Images: []agents.ExternalImage{ - {URL: "http://example.com/large.jpg", Size: 300}, - {URL: "http://example.com/medium.jpg", Size: 200}, - {URL: "http://example.com/small.jpg", Size: 100}, - }, } ag.On("GetAlbumInfo", ctx, "Test Album", "Test Artist", "mbid-album").Return(expectedInfo, nil) + ag.On("GetAlbumImages", ctx, "Test Album", "Test Artist", "mbid-album").Return([]agents.ExternalImage{ + {URL: "http://example.com/large.jpg", Size: 300}, + {URL: "http://example.com/medium.jpg", Size: 200}, + {URL: "http://example.com/small.jpg", Size: 100}, + }, nil) updatedAlbum, err := p.UpdateAlbumInfo(ctx, "al-existing") @@ -74,9 +74,6 @@ var _ = Describe("Provider - UpdateAlbumInfo", func() { Expect(updatedAlbum.ID).To(Equal("al-existing")) Expect(updatedAlbum.ExternalUrl).To(Equal("http://example.com/album")) Expect(updatedAlbum.Description).To(Equal("Album Description")) - Expect(updatedAlbum.LargeImageUrl).To(Equal("http://example.com/large.jpg")) - Expect(updatedAlbum.MediumImageUrl).To(Equal("http://example.com/medium.jpg")) - Expect(updatedAlbum.SmallImageUrl).To(Equal("http://example.com/small.jpg")) Expect(updatedAlbum.ExternalInfoUpdatedAt).NotTo(BeNil()) Expect(*updatedAlbum.ExternalInfoUpdatedAt).To(BeTemporally("~", time.Now(), time.Second)) @@ -92,7 +89,7 @@ var _ = Describe("Provider - UpdateAlbumInfo", func() { ExternalUrl: "http://cached.com/album", Description: "Cached Desc", LargeImageUrl: "http://cached.com/large.jpg", - ExternalInfoUpdatedAt: gg.P(now.Add(-conf.Server.DevAlbumInfoTimeToLive / 2)), + ExternalInfoUpdatedAt: new(now.Add(-conf.Server.DevAlbumInfoTimeToLive / 2)), } mockAlbumRepo.SetData(model.Albums{*originalAlbum}) @@ -115,7 +112,7 @@ var _ = Describe("Provider - UpdateAlbumInfo", func() { ExternalUrl: "http://expired.com/album", Description: "Expired Desc", LargeImageUrl: "http://expired.com/large.jpg", - ExternalInfoUpdatedAt: gg.P(expiredTime), + ExternalInfoUpdatedAt: new(expiredTime), } mockAlbumRepo.SetData(model.Albums{*originalAlbum}) diff --git a/core/external/provider_updateartistinfo_test.go b/core/external/provider_updateartistinfo_test.go index 9b1e8d866..d783128fb 100644 --- a/core/external/provider_updateartistinfo_test.go +++ b/core/external/provider_updateartistinfo_test.go @@ -9,10 +9,10 @@ import ( "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/agents" "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/tests" - "github.com/navidrome/navidrome/utils/gg" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" "github.com/stretchr/testify/mock" @@ -37,7 +37,7 @@ var _ = Describe("Provider - UpdateArtistInfo", func() { ctx = GinkgoT().Context() ds = new(tests.MockDataStore) ag = new(mockAgents) - p = external.NewProvider(ds, ag) + p = external.NewProvider(ds, ag, matcher.New(ds)) mockArtistRepo = ds.Artist(ctx).(*tests.MockArtistRepo) }) @@ -104,6 +104,29 @@ var _ = Describe("Provider - UpdateArtistInfo", func() { ag.AssertExpectations(GinkgoT()) }) + It("preserves decoded plain text in biography storage", func() { + originalArtist := &model.Artist{ + ID: "ar-encoded-bio", + Name: "Encoded Bio Artist", + } + mockArtistRepo.SetData(model.Artists{*originalArtist}) + + expectedMBID := "mbid-encoded-bio" + expectedBio := "R&B" + + ag.On("GetArtistMBID", ctx, "ar-encoded-bio", "Encoded Bio Artist").Return(expectedMBID, nil).Once() + ag.On("GetArtistImages", ctx, "ar-encoded-bio", "Encoded Bio Artist", expectedMBID).Return(nil, nil).Maybe() + ag.On("GetArtistBiography", ctx, "ar-encoded-bio", "Encoded Bio Artist", expectedMBID).Return(expectedBio, nil).Once() + ag.On("GetArtistURL", ctx, "ar-encoded-bio", "Encoded Bio Artist", expectedMBID).Return("", nil).Maybe() + ag.On("GetSimilarArtists", ctx, "ar-encoded-bio", "Encoded Bio Artist", expectedMBID, 100).Return(nil, nil).Maybe() + + updatedArtist, err := p.UpdateArtistInfo(ctx, "ar-encoded-bio", 10, false) + + Expect(err).NotTo(HaveOccurred()) + Expect(updatedArtist).NotTo(BeNil()) + Expect(updatedArtist.Biography).To(Equal("R&B")) + }) + It("returns cached info when artist exists and info is not expired", func() { now := time.Now() originalArtist := &model.Artist{ @@ -113,7 +136,7 @@ var _ = Describe("Provider - UpdateArtistInfo", func() { ExternalUrl: "http://cached.url", Biography: "Cached Bio", LargeImageUrl: "http://cached_large.jpg", - ExternalInfoUpdatedAt: gg.P(now.Add(-conf.Server.DevArtistInfoTimeToLive / 2)), + ExternalInfoUpdatedAt: new(now.Add(-conf.Server.DevArtistInfoTimeToLive / 2)), SimilarArtists: model.Artists{ {ID: "ar-similar-present", Name: "Similar Present"}, {ID: "ar-similar-absent", Name: "Similar Absent"}, @@ -150,7 +173,7 @@ var _ = Describe("Provider - UpdateArtistInfo", func() { originalArtist := &model.Artist{ ID: "ar-expired", Name: "Expired Artist", - ExternalInfoUpdatedAt: gg.P(expiredTime), + ExternalInfoUpdatedAt: new(expiredTime), SimilarArtists: model.Artists{ {ID: "ar-exp-similar", Name: "Expired Similar"}, }, @@ -181,7 +204,7 @@ var _ = Describe("Provider - UpdateArtistInfo", func() { originalArtist := &model.Artist{ ID: "ar-similar-test", Name: "Similar Test Artist", - ExternalInfoUpdatedAt: gg.P(now.Add(-conf.Server.DevArtistInfoTimeToLive / 2)), + ExternalInfoUpdatedAt: new(now.Add(-conf.Server.DevArtistInfoTimeToLive / 2)), SimilarArtists: model.Artists{ {ID: "ar-sim-present", Name: "Similar Present"}, {ID: "", Name: "Similar Absent Raw"}, @@ -226,4 +249,88 @@ var _ = Describe("Provider - UpdateArtistInfo", func() { Expect(updatedArtist.ID).To(Equal("ar-agent-fail")) ag.AssertExpectations(GinkgoT()) }) + + It("matches similar artists by ID first when agent provides IDs", func() { + originalArtist := &model.Artist{ + ID: "ar-id-match", + Name: "ID Match Artist", + } + similarByID := model.Artist{ID: "ar-similar-by-id", Name: "Similar By ID", MbzArtistID: "mbid-similar"} + mockArtistRepo.SetData(model.Artists{*originalArtist, similarByID}) + + // Agent returns similar artist with ID (highest priority matching) + rawSimilar := []agents.Artist{ + {ID: "ar-similar-by-id", Name: "Different Name", MBID: "different-mbid"}, + } + + ag.On("GetArtistMBID", ctx, "ar-id-match", "ID Match Artist").Return("", nil).Once() + ag.On("GetArtistImages", ctx, "ar-id-match", "ID Match Artist", mock.Anything).Return(nil, nil).Maybe() + ag.On("GetArtistBiography", ctx, "ar-id-match", "ID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetArtistURL", ctx, "ar-id-match", "ID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetSimilarArtists", ctx, "ar-id-match", "ID Match Artist", mock.Anything, 100).Return(rawSimilar, nil).Once() + + updatedArtist, err := p.UpdateArtistInfo(ctx, "ar-id-match", 10, false) + + Expect(err).NotTo(HaveOccurred()) + Expect(updatedArtist.SimilarArtists).To(HaveLen(1)) + // Should match by ID, not by name or MBID + Expect(updatedArtist.SimilarArtists[0].ID).To(Equal("ar-similar-by-id")) + Expect(updatedArtist.SimilarArtists[0].Name).To(Equal("Similar By ID")) + }) + + It("matches similar artists by MBID when ID is empty", func() { + originalArtist := &model.Artist{ + ID: "ar-mbid-match", + Name: "MBID Match Artist", + } + similarByMBID := model.Artist{ID: "ar-similar-by-mbid", Name: "Similar By MBID", MbzArtistID: "mbid-similar"} + mockArtistRepo.SetData(model.Artists{*originalArtist, similarByMBID}) + + // Agent returns similar artist with only MBID (no ID) + rawSimilar := []agents.Artist{ + {Name: "Different Name", MBID: "mbid-similar"}, + } + + ag.On("GetArtistMBID", ctx, "ar-mbid-match", "MBID Match Artist").Return("", nil).Once() + ag.On("GetArtistImages", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything).Return(nil, nil).Maybe() + ag.On("GetArtistBiography", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetArtistURL", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetSimilarArtists", ctx, "ar-mbid-match", "MBID Match Artist", mock.Anything, 100).Return(rawSimilar, nil).Once() + + updatedArtist, err := p.UpdateArtistInfo(ctx, "ar-mbid-match", 10, false) + + Expect(err).NotTo(HaveOccurred()) + Expect(updatedArtist.SimilarArtists).To(HaveLen(1)) + // Should match by MBID since ID was empty + Expect(updatedArtist.SimilarArtists[0].ID).To(Equal("ar-similar-by-mbid")) + Expect(updatedArtist.SimilarArtists[0].Name).To(Equal("Similar By MBID")) + }) + + It("falls back to name matching when ID and MBID don't match", func() { + originalArtist := &model.Artist{ + ID: "ar-name-match", + Name: "Name Match Artist", + } + similarByName := model.Artist{ID: "ar-similar-by-name", Name: "Similar By Name"} + mockArtistRepo.SetData(model.Artists{*originalArtist, similarByName}) + + // Agent returns similar artist with non-matching ID and MBID + rawSimilar := []agents.Artist{ + {ID: "non-existent-id", Name: "Similar By Name", MBID: "non-existent-mbid"}, + } + + ag.On("GetArtistMBID", ctx, "ar-name-match", "Name Match Artist").Return("", nil).Once() + ag.On("GetArtistImages", ctx, "ar-name-match", "Name Match Artist", mock.Anything).Return(nil, nil).Maybe() + ag.On("GetArtistBiography", ctx, "ar-name-match", "Name Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetArtistURL", ctx, "ar-name-match", "Name Match Artist", mock.Anything).Return("", nil).Maybe() + ag.On("GetSimilarArtists", ctx, "ar-name-match", "Name Match Artist", mock.Anything, 100).Return(rawSimilar, nil).Once() + + updatedArtist, err := p.UpdateArtistInfo(ctx, "ar-name-match", 10, false) + + Expect(err).NotTo(HaveOccurred()) + Expect(updatedArtist.SimilarArtists).To(HaveLen(1)) + // Should fall back to name matching since ID and MBID didn't match + Expect(updatedArtist.SimilarArtists[0].ID).To(Equal("ar-similar-by-name")) + Expect(updatedArtist.SimilarArtists[0].Name).To(Equal("Similar By Name")) + }) }) diff --git a/core/ffmpeg/ffmpeg.go b/core/ffmpeg/ffmpeg.go index 2e0d5a4b7..58e9fd152 100644 --- a/core/ffmpeg/ffmpeg.go +++ b/core/ffmpeg/ffmpeg.go @@ -1,26 +1,57 @@ package ffmpeg import ( + "bytes" "context" + "encoding/json" "errors" "fmt" "io" "os" "os/exec" + "path/filepath" + "slices" "strconv" "strings" "sync" + "time" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" ) +// TranscodeOptions contains all parameters for a transcoding operation. +type TranscodeOptions struct { + Command string // DB command template (used to detect custom vs default) + Format string // Target format (mp3, opus, aac, flac) + FilePath string + BitRate int // kbps, 0 = codec default + SampleRate int // 0 = no constraint + Channels int // 0 = no constraint + BitDepth int // 0 = no constraint; valid values: 16, 24, 32 + Offset int // seconds +} + +// AudioProbeResult contains authoritative audio stream properties from ffprobe. +type AudioProbeResult struct { + Codec string `json:"codec"` + Profile string `json:"profile,omitempty"` + BitRate int `json:"bitRate"` + SampleRate int `json:"sampleRate"` + BitDepth int `json:"bitDepth"` + Channels int `json:"channels"` +} + type FFmpeg interface { - Transcode(ctx context.Context, command, path string, maxBitRate, offset int) (io.ReadCloser, error) + Transcode(ctx context.Context, opts TranscodeOptions) (io.ReadCloser, error) ExtractImage(ctx context.Context, path string) (io.ReadCloser, error) + ConvertAnimatedImage(ctx context.Context, reader io.Reader, maxSize int, quality int) (io.ReadCloser, error) Probe(ctx context.Context, files []string) (string, error) + ProbeAudioStream(ctx context.Context, filePath string) (*AudioProbeResult, error) CmdPath() (string, error) IsAvailable() bool + IsProbeAvailable() bool Version() string } @@ -28,30 +59,72 @@ func New() FFmpeg { return &ffmpeg{} } +// ErrAnimatedWebPUnsupported is returned by ConvertAnimatedImage when the +// ffmpeg binary lacks the libwebp_anim encoder. Callers can use errors.Is to +// detect this specific case and fall back to static resize. +var ErrAnimatedWebPUnsupported = errors.New("ffmpeg lacks libwebp_anim encoder — install an ffmpeg build with libwebp") + const ( - extractImageCmd = "ffmpeg -i %s -map 0:v -map -0:V -vcodec copy -f image2pipe -" - probeCmd = "ffmpeg %s -f ffmetadata" + extractImageCmd = "ffmpeg -i %s -map 0:v -map -0:V -vcodec copy -f image2pipe -" + probeCmd = "ffmpeg %s -f ffmetadata" + probeAudioStreamCmd = "ffprobe -v quiet -select_streams a:0 -print_format json -show_streams -show_format %s" ) type ffmpeg struct{} -func (e *ffmpeg) Transcode(ctx context.Context, command, path string, maxBitRate, offset int) (io.ReadCloser, error) { +func (e *ffmpeg) Transcode(ctx context.Context, opts TranscodeOptions) (io.ReadCloser, error) { if _, err := ffmpegCmd(); err != nil { return nil, err } - // First make sure the file exists - if err := fileExists(path); err != nil { + if err := fileExists(opts.FilePath); err != nil { return nil, err } - args := createFFmpegCommand(command, path, maxBitRate, offset) + var args []string + if isDefaultCommand(opts.Format, opts.Command) { + args = buildDynamicArgs(opts) + } else { + args = buildTemplateArgs(opts) + } return e.start(ctx, args) } +func (e *ffmpeg) ConvertAnimatedImage(ctx context.Context, reader io.Reader, maxSize int, quality int) (io.ReadCloser, error) { + cmdPath, err := ffmpegCmd() + if err != nil { + return nil, err + } + if !animWebP.has(cmdPath, "libwebp_anim") { + return nil, ErrAnimatedWebPUnsupported + } + + args := []string{cmdPath, "-i", "pipe:0"} + if maxSize > 0 { + vf := fmt.Sprintf("scale='min(%d,iw)':'min(%d,ih)':force_original_aspect_ratio=decrease", maxSize, maxSize) + args = append(args, "-vf", vf) + } + args = append(args, "-loop", "0", "-c:v", "libwebp_anim", + "-quality", strconv.Itoa(quality), "-f", "webp", "-") + + return e.start(ctx, args, reader) +} + +// parseEncodersOutput scans the stdout of `ffmpeg -encoders` for a whole-word +// match of encoder name. The output has rows like " V....D libwebp_anim ..." +// where the name is the 2nd whitespace-separated field. +func parseEncodersOutput(out []byte, name string) bool { + for line := range strings.SplitSeq(string(out), "\n") { + fields := strings.Fields(line) + if len(fields) >= 2 && fields[1] == name { + return true + } + } + return false +} + func (e *ffmpeg) ExtractImage(ctx context.Context, path string) (io.ReadCloser, error) { if _, err := ffmpegCmd(); err != nil { return nil, err } - // First make sure the file exists if err := fileExists(path); err != nil { return nil, err } @@ -81,6 +154,91 @@ func (e *ffmpeg) Probe(ctx context.Context, files []string) (string, error) { return string(output), nil } +func (e *ffmpeg) ProbeAudioStream(ctx context.Context, filePath string) (*AudioProbeResult, error) { + if _, err := ffmpegCmd(); err != nil { + return nil, err + } + if err := fileExists(filePath); err != nil { + return nil, err + } + args := createFFmpegCommand(probeAudioStreamCmd, filePath, 0, 0) + log.Trace(ctx, "Executing ffprobe command", "args", args) + cmd := exec.CommandContext(ctx, args[0], args[1:]...) // #nosec + output, err := cmd.Output() + if err != nil { + return nil, fmt.Errorf("running ffprobe on %q: %w", filePath, err) + } + return parseProbeOutput(output) +} + +type probeOutput struct { + Streams []probeStream `json:"streams"` + Format probeFormat `json:"format"` +} + +type probeFormat struct { + BitRate string `json:"bit_rate"` +} + +type probeStream struct { + CodecName string `json:"codec_name"` + CodecType string `json:"codec_type"` + Profile string `json:"profile"` + SampleRate string `json:"sample_rate"` + BitRate string `json:"bit_rate"` + Channels int `json:"channels"` + BitsPerSample int `json:"bits_per_sample"` + BitsPerRawSample string `json:"bits_per_raw_sample"` +} + +func parseProbeOutput(data []byte) (*AudioProbeResult, error) { + var output probeOutput + if err := json.Unmarshal(data, &output); err != nil { + return nil, fmt.Errorf("parsing ffprobe output: %w", err) + } + + for _, s := range output.Streams { + if s.CodecType != "audio" { + continue + } + bitDepth := s.BitsPerSample + if bitDepth == 0 && s.BitsPerRawSample != "" { + bitDepth, _ = strconv.Atoi(s.BitsPerRawSample) + } + result := &AudioProbeResult{ + Codec: s.CodecName, + Channels: s.Channels, + BitDepth: bitDepth, + } + + // Profile: "unknown" → empty + if s.Profile != "" && !strings.EqualFold(s.Profile, "unknown") { + result.Profile = s.Profile + } + + // Sample rate: string → int + if s.SampleRate != "" { + result.SampleRate, _ = strconv.Atoi(s.SampleRate) + } + + // Bit rate: bps string → kbps int + if s.BitRate != "" { + bps, _ := strconv.Atoi(s.BitRate) + result.BitRate = bps / 1000 + } + + // Fallback to format-level bit_rate (needed for FLAC, Opus, etc.) + if result.BitRate == 0 && output.Format.BitRate != "" { + bps, _ := strconv.Atoi(output.Format.BitRate) + result.BitRate = bps / 1000 + } + + return result, nil + } + + return nil, fmt.Errorf("no audio stream found in ffprobe output") +} + func (e *ffmpeg) CmdPath() (string, error) { return ffmpegCmd() } @@ -90,6 +248,19 @@ func (e *ffmpeg) IsAvailable() bool { return err == nil } +func (e *ffmpeg) IsProbeAvailable() bool { + if _, err := ffmpegCmd(); err != nil { + return false + } + probeOnce.Do(func() { + probePath := ffprobePath(ffmpegPath) + if _, err := exec.LookPath(probePath); err == nil { + probeAvail = true + } + }) + return probeAvail +} + // Version executes ffmpeg -version and extracts the version from the output. // Sample output: ffmpeg version 6.0 Copyright (c) 2000-2023 the FFmpeg developers func (e *ffmpeg) Version() string { @@ -108,11 +279,14 @@ func (e *ffmpeg) Version() string { return parts[2] } -func (e *ffmpeg) start(ctx context.Context, args []string) (io.ReadCloser, error) { +func (e *ffmpeg) start(ctx context.Context, args []string, input ...io.Reader) (io.ReadCloser, error) { log.Trace(ctx, "Executing ffmpeg command", "cmd", args) j := &ffCmd{args: args} + if len(input) > 0 { + j.input = input[0] + } j.PipeReader, j.out = io.Pipe() - err := j.start() + err := j.start(ctx) if err != nil { return nil, err } @@ -122,18 +296,25 @@ func (e *ffmpeg) start(ctx context.Context, args []string) (io.ReadCloser, error type ffCmd struct { *io.PipeReader - out *io.PipeWriter - args []string - cmd *exec.Cmd + out *io.PipeWriter + args []string + cmd *exec.Cmd + input io.Reader // optional stdin source + stderr *bytes.Buffer } -func (j *ffCmd) start() error { - cmd := exec.Command(j.args[0], j.args[1:]...) // #nosec +func (j *ffCmd) start(ctx context.Context) error { + cmd := exec.CommandContext(ctx, j.args[0], j.args[1:]...) // #nosec cmd.Stdout = j.out + if j.input != nil { + cmd.Stdin = j.input + } + j.stderr = &bytes.Buffer{} + stderrWriter := &limitedWriter{buf: j.stderr, limit: 4096} if log.IsGreaterOrEqualTo(log.LevelTrace) { - cmd.Stderr = os.Stderr + cmd.Stderr = io.MultiWriter(os.Stderr, stderrWriter) } else { - cmd.Stderr = io.Discard + cmd.Stderr = stderrWriter } j.cmd = cmd @@ -145,9 +326,12 @@ func (j *ffCmd) start() error { func (j *ffCmd) wait() { if err := j.cmd.Wait(); err != nil { - var exitErr *exec.ExitError - if errors.As(err, &exitErr) { - _ = j.out.CloseWithError(fmt.Errorf("%s exited with non-zero status code: %d", j.args[0], exitErr.ExitCode())) + if exitErr, ok := errors.AsType[*exec.ExitError](err); ok { + errMsg := fmt.Sprintf("%s exited with non-zero status code: %d", j.args[0], exitErr.ExitCode()) + if stderrOutput := strings.TrimSpace(j.stderr.String()); stderrOutput != "" { + errMsg += ": " + stderrOutput + } + _ = j.out.CloseWithError(errors.New(errMsg)) } else { _ = j.out.CloseWithError(fmt.Errorf("waiting %s cmd: %w", j.args[0], err)) } @@ -156,16 +340,172 @@ func (j *ffCmd) wait() { _ = j.out.Close() } +// limitedWriter wraps a bytes.Buffer and stops writing once the limit is reached. +// Writes that would exceed the limit are silently discarded to prevent unbounded memory usage. +type limitedWriter struct { + buf *bytes.Buffer + limit int +} + +func (w *limitedWriter) Write(p []byte) (int, error) { + n := len(p) + remaining := w.limit - w.buf.Len() + if remaining <= 0 { + return n, nil // Discard but report success to avoid breaking the writer + } + if len(p) > remaining { + p = p[:remaining] + } + w.buf.Write(p) + return n, nil // Always report full write to avoid ErrShortWrite from io.MultiWriter +} + +// formatCodecMap maps target format to ffmpeg codec flag. +var formatCodecMap = map[string]string{ + "mp3": "libmp3lame", + "opus": "libopus", + "aac": "aac", + "flac": "flac", +} + +// formatOutputMap maps target format to ffmpeg output format flag (-f). +var formatOutputMap = map[string]string{ + "mp3": "mp3", + "opus": "opus", + "aac": "adts", + "flac": "flac", +} + +// defaultCommands is used to detect whether a user has customized their transcoding command. +var defaultCommands = func() map[string]string { + m := make(map[string]string, len(consts.DefaultTranscodings)) + for _, t := range consts.DefaultTranscodings { + m[t.TargetFormat] = t.Command + } + return m +}() + +// isDefaultCommand returns true if the command matches the known default for this format. +func isDefaultCommand(format, command string) bool { + return defaultCommands[format] == command +} + +// buildDynamicArgs programmatically constructs ffmpeg arguments for known formats, +// including all transcoding parameters (bitrate, sample rate, channels). +func buildDynamicArgs(opts TranscodeOptions) []string { + cmdPath, _ := ffmpegCmd() + args := []string{cmdPath} + + if opts.Offset > 0 { + args = append(args, "-ss", strconv.Itoa(opts.Offset)) + } + + args = append(args, "-i", opts.FilePath) + args = append(args, "-map", "0:a:0") + + if codec, ok := formatCodecMap[opts.Format]; ok { + args = append(args, "-c:a", codec) + } + + if opts.BitRate > 0 { + args = append(args, "-b:a", strconv.Itoa(opts.BitRate)+"k") + } + args = injectDynamicAudioFlags(args, opts) + + args = append(args, "-v", "0") + + if outputFmt, ok := formatOutputMap[opts.Format]; ok { + args = append(args, "-f", outputFmt) + } + + args = append(args, "-") + return args +} + +// buildTemplateArgs handles user-customized command templates, with dynamic injection +// of sample rate, channels, and bit depth when requested by the transcode decision. +// Values in opts have already been clamped to codec limits upstream (see +// core/stream/codec.go codecMax* helpers), so injecting them unconditionally is safe — +// ffmpeg honors the last occurrence of a duplicate flag. +func buildTemplateArgs(opts TranscodeOptions) []string { + args := createFFmpegCommand(opts.Command, opts.FilePath, opts.BitRate, opts.Offset) + return injectDynamicAudioFlags(args, opts) +} + +// injectDynamicAudioFlags appends -ar, -ac, and -sample_fmt flags based on opts. +// Only passes -sample_fmt for lossless output formats where bit depth matters: +// lossy codecs (mp3, aac, opus) handle sample format conversion internally, and +// passing interleaved formats like "s16" causes silent failures. +func injectDynamicAudioFlags(args []string, opts TranscodeOptions) []string { + if opts.SampleRate > 0 { + args = injectBeforeOutput(args, "-ar", strconv.Itoa(opts.SampleRate)) + } + if opts.Channels > 0 { + args = injectBeforeOutput(args, "-ac", strconv.Itoa(opts.Channels)) + } + if opts.BitDepth >= 16 && isLosslessOutputFormat(opts.Format) { + args = injectBeforeOutput(args, "-sample_fmt", bitDepthToSampleFmt(opts.BitDepth)) + } + return args +} + +// injectBeforeOutput inserts a flag and value before the trailing "-" (stdout output). +func injectBeforeOutput(args []string, flag, value string) []string { + if len(args) > 0 && args[len(args)-1] == "-" { + result := make([]string, 0, len(args)+2) + result = append(result, args[:len(args)-1]...) + result = append(result, flag, value, "-") + return result + } + return append(args, flag, value) +} + +// isLosslessOutputFormat returns true if the format is a lossless audio format +// where preserving bit depth via -sample_fmt is meaningful. +// Note: this covers only formats ffmpeg can produce as output. For the full set of +// lossless formats used in transcoding decisions, see core/stream/codec.go:isLosslessFormat. +func isLosslessOutputFormat(format string) bool { + switch strings.ToLower(format) { + case "flac", "alac", "wav", "aiff": + return true + } + return false +} + +// bitDepthToSampleFmt converts a bit depth value to the ffmpeg sample_fmt string. +// FLAC only supports s16 and s32; for 24-bit sources, s32 is the correct format +// (ffmpeg packs 24-bit samples into 32-bit containers). +func bitDepthToSampleFmt(bitDepth int) string { + switch bitDepth { + case 16: + return "s16" + case 32: + return "s32" + default: + // 24-bit and other depths: use s32 (the next valid container size) + return "s32" + } +} + // Path will always be an absolute path func createFFmpegCommand(cmd, path string, maxBitRate, offset int) []string { var args []string for _, s := range fixCmd(cmd) { if strings.Contains(s, "%s") { + if offset > 0 && !strings.Contains(cmd, "%t") { + // Pre-input seeking: ffmpeg seeks at the demuxer level (fast) + // instead of decoding all frames up to the offset (slow). + insertAt := len(args) + for i, arg := range slices.Backward(args) { + if arg == "-i" { + insertAt = i + break + } + } + args = slices.Insert(args, insertAt, "-ss", strconv.Itoa(offset)) + } s = strings.ReplaceAll(s, "%s", path) args = append(args, s) - if offset > 0 && !strings.Contains(cmd, "%t") { - args = append(args, "-ss", strconv.Itoa(offset)) - } } else { s = strings.ReplaceAll(s, "%t", strconv.Itoa(offset)) s = strings.ReplaceAll(s, "%b", strconv.Itoa(maxBitRate)) @@ -196,10 +536,20 @@ func fixCmd(cmd string) []string { if s == "ffmpeg" || s == "ffmpeg.exe" { split[i] = cmdPath } + if s == "ffprobe" || s == "ffprobe.exe" { + split[i] = ffprobePath(cmdPath) + } } return split } +// ffprobePath derives the ffprobe binary path from the resolved ffmpeg path. +func ffprobePath(ffmpegCmd string) string { + dir := filepath.Dir(ffmpegCmd) + base := filepath.Base(ffmpegCmd) + return filepath.Join(dir, strings.Replace(base, "ffmpeg", "ffprobe", 1)) +} + func ffmpegCmd() (string, error) { ffOnce.Do(func() { if conf.Server.FFmpegPath != "" { @@ -220,9 +570,55 @@ func ffmpegCmd() (string, error) { return ffmpegPath, ffmpegErr } +type encoderProbeState uint8 + +const ( + encoderProbeUnknown encoderProbeState = iota + encoderProbeAvailable + encoderProbeUnavailable +) + +type encoderProbe struct { + mu sync.Mutex + state encoderProbeState +} + +func (p *encoderProbe) has(cmdPath, encoder string) bool { + p.mu.Lock() + defer p.mu.Unlock() + + switch p.state { + case encoderProbeAvailable: + return true + case encoderProbeUnavailable: + return false + } + + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + out, err := exec.CommandContext(ctx, cmdPath, "-hide_banner", "-encoders").Output() // #nosec + if err != nil { + log.Warn(ctx, "Could not probe ffmpeg encoders; will retry on next animated cover", err) + return false + } + + if parseEncodersOutput(out, encoder) { + p.state = encoderProbeAvailable + return true + } + + p.state = encoderProbeUnavailable + log.Warn(ctx, "ffmpeg has no libwebp_anim encoder; animated covers will be served as static images", + "path", cmdPath, "hint", "install ffmpeg built with libwebp (e.g. `brew install ffmpeg@7`)") + return false +} + // These variables are accessible here for tests. Do not use them directly in production code. Use ffmpegCmd() instead. var ( ffOnce sync.Once ffmpegPath string ffmpegErr error + probeOnce sync.Once + probeAvail bool + animWebP encoderProbe ) diff --git a/core/ffmpeg/ffmpeg_test.go b/core/ffmpeg/ffmpeg_test.go index 7e67a2a6a..2e2895738 100644 --- a/core/ffmpeg/ffmpeg_test.go +++ b/core/ffmpeg/ffmpeg_test.go @@ -1,16 +1,30 @@ package ffmpeg import ( + "context" + "os" + "os/exec" + "path/filepath" + "runtime" + "strings" + "sync" "testing" + "time" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) func TestFFmpeg(t *testing.T) { - tests.Init(t, false) + // Inline test init to avoid import cycle with tests package + //nolint:dogsled + _, file, _, _ := runtime.Caller(0) + appPath, _ := filepath.Abs(filepath.Join(filepath.Dir(file), "..", "..")) + confPath := filepath.Join(appPath, "tests", "navidrome-test.toml") + _ = os.Chdir(appPath) + conf.LoadFromFile(confPath) log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) RunSpecs(t, "FFmpeg Suite") @@ -33,15 +47,15 @@ var _ = Describe("ffmpeg", func() { }) Context("when command has time offset param", func() { It("creates a valid command line with offset", func() { - args := createFFmpegCommand("ffmpeg -i %s -b:a %bk -ss %t mp3 -", "/music library/file.mp3", 123, 456) - Expect(args).To(Equal([]string{"ffmpeg", "-i", "/music library/file.mp3", "-b:a", "123k", "-ss", "456", "mp3", "-"})) + args := createFFmpegCommand("ffmpeg -ss %t -i %s -b:a %bk mp3 -", "/music library/file.mp3", 123, 456) + Expect(args).To(Equal([]string{"ffmpeg", "-ss", "456", "-i", "/music library/file.mp3", "-b:a", "123k", "mp3", "-"})) }) }) Context("when command does not have time offset param", func() { - It("adds time offset after the input file name", func() { + It("adds time offset before the input file name", func() { args := createFFmpegCommand("ffmpeg -i %s -b:a %bk mp3 -", "/music library/file.mp3", 123, 456) - Expect(args).To(Equal([]string{"ffmpeg", "-i", "/music library/file.mp3", "-ss", "456", "-b:a", "123k", "mp3", "-"})) + Expect(args).To(Equal([]string{"ffmpeg", "-ss", "456", "-i", "/music library/file.mp3", "-b:a", "123k", "mp3", "-"})) }) }) }) @@ -65,4 +79,674 @@ var _ = Describe("ffmpeg", func() { Expect(args).To(Equal([]string{"/usr/bin/with spaces/ffmpeg.exe", "-i", "one.mp3", "-f", "ffmetadata"})) }) }) + + Describe("isDefaultCommand", func() { + It("returns true for known default mp3 command", func() { + Expect(isDefaultCommand("mp3", "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -f mp3 -")).To(BeTrue()) + }) + It("returns true for known default opus command", func() { + Expect(isDefaultCommand("opus", "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a libopus -f opus -")).To(BeTrue()) + }) + It("returns true for known default aac command", func() { + Expect(isDefaultCommand("aac", "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -")).To(BeTrue()) + }) + It("returns true for known default flac command", func() { + Expect(isDefaultCommand("flac", "ffmpeg -ss %t -i %s -map 0:a:0 -v 0 -c:a flac -f flac -")).To(BeTrue()) + }) + It("returns false for a custom command", func() { + Expect(isDefaultCommand("mp3", "ffmpeg -i %s -b:a %bk -custom-flag -f mp3 -")).To(BeFalse()) + }) + It("returns false for unknown format", func() { + Expect(isDefaultCommand("wav", "ffmpeg -i %s -f wav -")).To(BeFalse()) + }) + }) + + Describe("buildDynamicArgs", func() { + It("builds mp3 args with bitrate, samplerate, and channels", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "mp3", + FilePath: "/music/file.flac", + BitRate: 256, + SampleRate: 48000, + Channels: 2, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-map", "0:a:0", + "-c:a", "libmp3lame", + "-b:a", "256k", + "-ar", "48000", + "-ac", "2", + "-v", "0", + "-f", "mp3", + "-", + })) + }) + + It("builds flac args without bitrate", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.dsf", + SampleRate: 48000, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.dsf", + "-map", "0:a:0", + "-c:a", "flac", + "-ar", "48000", + "-v", "0", + "-f", "flac", + "-", + })) + }) + + It("builds opus args with bitrate only", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "opus", + FilePath: "/music/file.flac", + BitRate: 128, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-map", "0:a:0", + "-c:a", "libopus", + "-b:a", "128k", + "-v", "0", + "-f", "opus", + "-", + })) + }) + + It("includes offset when specified", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "mp3", + FilePath: "/music/file.mp3", + BitRate: 192, + Offset: 30, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", + "-ss", "30", + "-i", "/music/file.mp3", + "-map", "0:a:0", + "-c:a", "libmp3lame", + "-b:a", "192k", + "-v", "0", + "-f", "mp3", + "-", + })) + }) + + It("builds aac args with ADTS output", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "aac", + FilePath: "/music/file.flac", + BitRate: 256, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-map", "0:a:0", + "-c:a", "aac", + "-b:a", "256k", + "-v", "0", + "-f", "adts", + "-", + })) + }) + + It("builds flac args with bit depth", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.dsf", + BitDepth: 24, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.dsf", + "-map", "0:a:0", + "-c:a", "flac", + "-sample_fmt", "s32", + "-v", "0", + "-f", "flac", + "-", + })) + }) + + It("omits -sample_fmt when bit depth is 0", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.flac", + BitDepth: 0, + }) + Expect(args).ToNot(ContainElement("-sample_fmt")) + }) + + It("omits -sample_fmt when bit depth is too low (DSD)", func() { + args := buildDynamicArgs(TranscodeOptions{ + Format: "flac", + FilePath: "/music/file.dsf", + BitDepth: 1, + }) + Expect(args).ToNot(ContainElement("-sample_fmt")) + }) + + DescribeTable("omits -sample_fmt for lossy formats even when bit depth >= 16", + func(format string, bitRate int) { + args := buildDynamicArgs(TranscodeOptions{ + Format: format, + FilePath: "/music/file.flac", + BitRate: bitRate, + BitDepth: 16, + }) + Expect(args).ToNot(ContainElement("-sample_fmt")) + }, + Entry("mp3", "mp3", 256), + Entry("aac", "aac", 256), + Entry("opus", "opus", 128), + ) + }) + + Describe("bitDepthToSampleFmt", func() { + It("converts 16-bit", func() { + Expect(bitDepthToSampleFmt(16)).To(Equal("s16")) + }) + It("converts 24-bit to s32 (FLAC only supports s16/s32)", func() { + Expect(bitDepthToSampleFmt(24)).To(Equal("s32")) + }) + It("converts 32-bit", func() { + Expect(bitDepthToSampleFmt(32)).To(Equal("s32")) + }) + }) + + Describe("buildTemplateArgs", func() { + It("injects -ar and -ac into custom template", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + FilePath: "/music/file.flac", + BitRate: 192, + SampleRate: 44100, + Channels: 2, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-ar", "44100", "-ac", "2", + "-", + })) + }) + + It("injects only -ar when channels is 0", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + FilePath: "/music/file.flac", + BitRate: 192, + SampleRate: 48000, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-ar", "48000", + "-", + })) + }) + + It("does not inject anything when sample rate and channels are 0", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + FilePath: "/music/file.flac", + BitRate: 192, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-", + })) + }) + + It("injects -sample_fmt for lossless output format with bit depth", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -v 0 -c:a flac -f flac -", + Format: "flac", + FilePath: "/music/file.dsf", + BitDepth: 24, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.dsf", + "-v", "0", "-c:a", "flac", "-f", "flac", + "-sample_fmt", "s32", + "-", + })) + }) + + It("does not inject -sample_fmt for lossy output format even with bit depth", func() { + args := buildTemplateArgs(TranscodeOptions{ + Command: "ffmpeg -i %s -b:a %bk -v 0 -f mp3 -", + Format: "mp3", + FilePath: "/music/file.flac", + BitRate: 192, + BitDepth: 16, + }) + Expect(args).To(Equal([]string{ + "ffmpeg", "-i", "/music/file.flac", + "-b:a", "192k", "-v", "0", "-f", "mp3", + "-", + })) + }) + }) + + Describe("injectBeforeOutput", func() { + It("inserts flag before trailing dash", func() { + args := injectBeforeOutput([]string{"ffmpeg", "-i", "file.mp3", "-f", "mp3", "-"}, "-ar", "48000") + Expect(args).To(Equal([]string{"ffmpeg", "-i", "file.mp3", "-f", "mp3", "-ar", "48000", "-"})) + }) + + It("appends when no trailing dash", func() { + args := injectBeforeOutput([]string{"ffmpeg", "-i", "file.mp3"}, "-ar", "48000") + Expect(args).To(Equal([]string{"ffmpeg", "-i", "file.mp3", "-ar", "48000"})) + }) + }) + + Describe("parseProbeOutput", func() { + It("parses MP3 with embedded artwork (real ffprobe output)", func() { + // Real: MP3 file with mjpeg artwork stream after audio + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"mp3","codec_long_name":"MP3 (MPEG audio layer 3)","codec_type":"audio",` + + `"sample_fmt":"fltp","sample_rate":"44100","channels":2,"channel_layout":"stereo",` + + `"bits_per_sample":0,"bit_rate":"198314","tags":{"encoder":"LAME3.99r"}},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline","width":400,"height":400}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("mp3")) + Expect(result.Profile).To(BeEmpty()) // MP3 has no profile field + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(198)) // 198314 bps -> 198 kbps + Expect(result.BitDepth).To(Equal(0)) // lossy codec + }) + + It("parses AAC-LC in m4a container (real ffprobe output)", func() { + // Real: AAC LC file with profile and artwork + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"aac","codec_long_name":"AAC (Advanced Audio Coding)",` + + `"profile":"LC","codec_type":"audio","sample_fmt":"fltp","sample_rate":"44100",` + + `"channels":2,"channel_layout":"stereo","bits_per_sample":0,"bit_rate":"279958"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("aac")) + Expect(result.Profile).To(Equal("LC")) + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(279)) // 279958 bps -> 279 kbps + }) + + It("parses HE-AACv2 in mp4 container with video stream (real ffprobe output)", func() { + // Real: Fraunhofer HE-AACv2 sample (LFE-SBRstereo.mp4), video stream before audio + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"h264","codec_type":"video","profile":"Main"},` + + `{"index":1,"codec_name":"aac","codec_long_name":"AAC (Advanced Audio Coding)",` + + `"profile":"HE-AACv2","codec_type":"audio","sample_fmt":"fltp",` + + `"sample_rate":"48000","channels":2,"channel_layout":"stereo",` + + `"bits_per_sample":0,"bit_rate":"55999"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("aac")) + Expect(result.Profile).To(Equal("HE-AACv2")) + Expect(result.SampleRate).To(Equal(48000)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(55)) // 55999 bps -> 55 kbps + }) + + It("parses FLAC using bits_per_raw_sample and format-level bit_rate (real ffprobe output)", func() { + // Real: FLAC reports bit depth in bits_per_raw_sample, not bits_per_sample. + // Stream-level bit_rate is absent; format-level bit_rate is used as fallback. + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"flac","codec_long_name":"FLAC (Free Lossless Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"s16","sample_rate":"44100","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":0,"bits_per_raw_sample":"16"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}],` + + `"format":{"bit_rate":"906900"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("flac")) + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.BitDepth).To(Equal(16)) // from bits_per_raw_sample + Expect(result.BitRate).To(Equal(906)) // format-level: 906900 bps -> 906 kbps + Expect(result.Profile).To(BeEmpty()) // no profile field in real output + }) + + It("parses Opus with format-level bit_rate fallback (real ffprobe output)", func() { + // Real: Opus stream-level bit_rate is absent; format-level is used as fallback. + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"opus","codec_long_name":"Opus (Opus Interactive Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"fltp","sample_rate":"48000","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":0}],` + + `"format":{"bit_rate":"128000"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("opus")) + Expect(result.SampleRate).To(Equal(48000)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(128)) // format-level: 128000 bps -> 128 kbps + Expect(result.BitDepth).To(Equal(0)) + }) + + It("parses WAV/PCM with bits_per_sample (real ffprobe output)", func() { + // Real: WAV uses bits_per_sample directly + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"pcm_s16le","codec_long_name":"PCM signed 16-bit little-endian",` + + `"codec_type":"audio","sample_fmt":"s16","sample_rate":"44100","channels":2,` + + `"bits_per_sample":16,"bit_rate":"1411200"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("pcm_s16le")) + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitDepth).To(Equal(16)) + Expect(result.BitRate).To(Equal(1411)) + }) + + It("parses ALAC in m4a container (real ffprobe output)", func() { + // Real: Beatles - You Can't Do That (2023 Mix), ALAC 16-bit + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"alac","codec_long_name":"ALAC (Apple Lossless Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"s16p","sample_rate":"44100","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":0,"bit_rate":"1011003",` + + `"bits_per_raw_sample":"16"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("alac")) + Expect(result.BitDepth).To(Equal(16)) // from bits_per_raw_sample + Expect(result.SampleRate).To(Equal(44100)) + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(1011)) // 1011003 bps -> 1011 kbps + }) + + It("skips video-only streams", func() { + data := []byte(`{"streams":[{"index":0,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + _, err := parseProbeOutput(data) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no audio stream")) + }) + + It("returns error for empty streams array", func() { + data := []byte(`{"streams":[]}`) + _, err := parseProbeOutput(data) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for invalid JSON", func() { + data := []byte(`not json`) + _, err := parseProbeOutput(data) + Expect(err).To(HaveOccurred()) + }) + + It("parses HiRes multichannel FLAC with format-level bit_rate (real ffprobe output)", func() { + // Real: Pink Floyd - 192kHz/24-bit/7.1 surround FLAC + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"flac","codec_long_name":"FLAC (Free Lossless Audio Codec)",` + + `"codec_type":"audio","sample_fmt":"s32","sample_rate":"192000","channels":8,` + + `"channel_layout":"7.1","bits_per_sample":0,"bits_per_raw_sample":"24"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Progressive"}],` + + `"format":{"bit_rate":"18432000"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("flac")) + Expect(result.SampleRate).To(Equal(192000)) + Expect(result.BitDepth).To(Equal(24)) + Expect(result.Channels).To(Equal(8)) + Expect(result.BitRate).To(Equal(18432)) // format-level: 18432000 bps -> 18432 kbps + }) + + It("parses DSD/DSF file (real ffprobe output)", func() { + // Real: Yes - Owner of a Lonely Heart, DSD64 DSF + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"dsd_lsbf_planar",` + + `"codec_long_name":"DSD (Direct Stream Digital), least significant bit first, planar",` + + `"codec_type":"audio","sample_fmt":"fltp","sample_rate":"352800","channels":2,` + + `"channel_layout":"stereo","bits_per_sample":8,"bit_rate":"5644800"},` + + `{"index":1,"codec_name":"mjpeg","codec_type":"video","profile":"Baseline"}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Codec).To(Equal("dsd_lsbf_planar")) + Expect(result.BitDepth).To(Equal(8)) // DSD reports 8 bits_per_sample + Expect(result.SampleRate).To(Equal(352800)) // DSD64 sample rate + Expect(result.Channels).To(Equal(2)) + Expect(result.BitRate).To(Equal(5644)) // 5644800 bps -> 5644 kbps + }) + + It("prefers stream-level bit_rate over format-level when both are present", func() { + // ALAC/DSD: stream has bit_rate, format also has bit_rate — stream wins + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"alac","codec_type":"audio","sample_fmt":"s16p",` + + `"sample_rate":"44100","channels":2,"bits_per_sample":0,` + + `"bit_rate":"1011003","bits_per_raw_sample":"16"}],` + + `"format":{"bit_rate":"1050000"}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.BitRate).To(Equal(1011)) // stream-level: 1011003 bps -> 1011 kbps (not format's 1050) + }) + + It("returns BitRate 0 when neither stream nor format has bit_rate", func() { + data := []byte(`{"streams":[` + + `{"index":0,"codec_name":"flac","codec_type":"audio","sample_fmt":"s16",` + + `"sample_rate":"44100","channels":2,"bits_per_sample":0,"bits_per_raw_sample":"16"}],` + + `"format":{}}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.BitRate).To(Equal(0)) + }) + + It("clears 'unknown' profile to empty string", func() { + data := []byte(`{"streams":[{"index":0,"codec_name":"flac",` + + `"codec_type":"audio","profile":"unknown","sample_rate":"44100",` + + `"channels":2,"bits_per_sample":0}]}`) + result, err := parseProbeOutput(data) + Expect(err).ToNot(HaveOccurred()) + Expect(result.Profile).To(BeEmpty()) + }) + }) + + Describe("FFmpeg", func() { + Context("when FFmpeg is available", func() { + var ff FFmpeg + + BeforeEach(func() { + ffOnce = sync.Once{} + ff = New() + // Skip if FFmpeg is not available + if !ff.IsAvailable() { + Skip("FFmpeg not available on this system") + } + }) + + It("should interrupt transcoding when context is cancelled", func() { + ctx, cancel := context.WithTimeout(GinkgoT().Context(), 5*time.Second) + defer cancel() + + // Use a command that generates audio indefinitely + // -f lavfi uses FFmpeg's built-in audio source + // -t 0 means no time limit (runs forever) + command := "ffmpeg -f lavfi -i sine=frequency=1000:duration=0 -f mp3 -" + + // The input file is not used here, but we need to provide a valid path to the Transcode function + stream, err := ff.Transcode(ctx, TranscodeOptions{ + Command: command, + Format: "mp3", + FilePath: "tests/fixtures/test.mp3", + BitRate: 128, + }) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + // Read some data first to ensure FFmpeg is running + buf := make([]byte, 1024) + _, err = stream.Read(buf) + Expect(err).ToNot(HaveOccurred()) + + // Cancel the context + cancel() + + // Subsequent reads should eventually fail due to cancelled context. + // There may be buffered data in the pipe, so we drain until an error occurs. + Eventually(func() error { + _, err = stream.Read(buf) + return err + }).WithTimeout(5 * time.Second).WithPolling(10 * time.Millisecond).Should(HaveOccurred()) + }) + + It("should handle immediate context cancellation", func() { + ctx, cancel := context.WithCancel(GinkgoT().Context()) + cancel() // Cancel immediately + + // This should fail immediately + _, err := ff.Transcode(ctx, TranscodeOptions{ + Command: "ffmpeg -i %s -f mp3 -", + Format: "mp3", + FilePath: "tests/fixtures/test.mp3", + BitRate: 128, + }) + Expect(err).To(MatchError(context.Canceled)) + }) + }) + + Context("stderr capture", func() { + BeforeEach(func() { + if runtime.GOOS == "windows" { + Skip("stderr capture tests use /bin/sh, skipping on Windows") + } + }) + + It("should include stderr in error when process fails", func() { + ff := &ffmpeg{} + ctx := GinkgoT().Context() + + // Directly call start() with a bash command that writes to stderr and fails + args := []string{"/bin/sh", "-c", "echo 'codec not found: libopus' >&2; exit 1"} + stream, err := ff.start(ctx, args) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + buf := make([]byte, 1024) + _, err = stream.Read(buf) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("codec not found: libopus")) + }) + + It("should not include stderr in error when process succeeds", func() { + ff := &ffmpeg{} + ctx := GinkgoT().Context() + + // Command that writes to stderr but exits successfully + args := []string{"/bin/sh", "-c", "echo 'warning: something' >&2; printf 'output'"} + stream, err := ff.start(ctx, args) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + buf := make([]byte, 1024) + n, err := stream.Read(buf) + Expect(err).ToNot(HaveOccurred()) + Expect(string(buf[:n])).To(Equal("output")) + }) + }) + + Context("with mock process behavior", func() { + var longRunningCmd string + BeforeEach(func() { + // Use a long-running command for testing cancellation + switch runtime.GOOS { + case "windows": + // Use PowerShell's Start-Sleep + ffmpegPath = "powershell" + longRunningCmd = "powershell -Command Start-Sleep -Seconds 10" + default: + // Use sleep on Unix-like systems + ffmpegPath = "sleep" + longRunningCmd = "sleep 10" + } + }) + + It("should terminate the underlying process when context is cancelled", func() { + ff := New() + ctx, cancel := context.WithTimeout(GinkgoT().Context(), 5*time.Second) + defer cancel() + + // Start a process that will run for a while + stream, err := ff.Transcode(ctx, TranscodeOptions{ + Command: longRunningCmd, + FilePath: "tests/fixtures/test.mp3", + }) + Expect(err).ToNot(HaveOccurred()) + defer stream.Close() + + // Give the process time to start + time.Sleep(50 * time.Millisecond) + + // Cancel the context + cancel() + + // Try to read from the stream, which should fail + buf := make([]byte, 100) + _, err = stream.Read(buf) + Expect(err).To(HaveOccurred(), "Expected stream to be closed due to process termination") + + // Verify the stream is closed by attempting another read + _, err = stream.Read(buf) + Expect(err).To(HaveOccurred()) + }) + }) + }) + + Describe("parseEncodersOutput", func() { + const sample = `Encoders: + V..... = Video + ------ + V....D apng APNG (Animated Portable Network Graphics) image + V....D libwebp_anim libwebp WebP image (codec webp) + V....D libwebp libwebp WebP image (codec webp) + A....D aac AAC (Advanced Audio Coding) +` + It("returns true when the encoder is present", func() { + Expect(parseEncodersOutput([]byte(sample), "libwebp_anim")).To(BeTrue()) + Expect(parseEncodersOutput([]byte(sample), "libwebp")).To(BeTrue()) + Expect(parseEncodersOutput([]byte(sample), "aac")).To(BeTrue()) + }) + It("returns false when the encoder is absent", func() { + Expect(parseEncodersOutput([]byte(sample), "libwebp_missing")).To(BeFalse()) + Expect(parseEncodersOutput([]byte(sample), "")).To(BeFalse()) + }) + It("does not match partial names", func() { + // libwebp is a prefix of libwebp_anim; the parser must treat names as whole-word. + stripped := `Encoders: + V....D libwebp libwebp WebP image (codec webp) +` + Expect(parseEncodersOutput([]byte(stripped), "libwebp_anim")).To(BeFalse()) + }) + It("handles empty output", func() { + Expect(parseEncodersOutput(nil, "libwebp_anim")).To(BeFalse()) + Expect(parseEncodersOutput([]byte(""), "libwebp_anim")).To(BeFalse()) + }) + }) + + Describe("ConvertAnimatedImage", func() { + // Point ffmpegCmd at a stand-in binary that produces empty `-encoders` + // output so hasAnimatedWebPEncoder returns false. /usr/bin/true is + // portable across POSIX systems. + It("returns ErrAnimatedWebPUnsupported when the binary lacks libwebp_anim", func() { + truePath, err := exec.LookPath("true") + if err != nil { + Skip("true(1) not available") + } + origPath, origErr := ffmpegPath, ffmpegErr + ffmpegPath = truePath + ffmpegErr = nil + defer func() { + ffmpegPath, ffmpegErr = origPath, origErr + }() + + ff := &ffmpeg{} + _, err = ff.ConvertAnimatedImage(GinkgoT().Context(), strings.NewReader("x"), 100, 75) + Expect(err).To(MatchError(ErrAnimatedWebPUnsupported)) + }) + }) }) diff --git a/core/image_upload.go b/core/image_upload.go new file mode 100644 index 000000000..c2432b647 --- /dev/null +++ b/core/image_upload.go @@ -0,0 +1,71 @@ +package core + +import ( + "context" + "fmt" + "io" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils" +) + +type ImageUploadService interface { + SetImage(ctx context.Context, entityType string, entityID string, name string, oldPath string, reader io.Reader, ext string) (filename string, err error) + RemoveImage(ctx context.Context, path string) error +} + +type imageUploadService struct{} + +func NewImageUploadService() ImageUploadService { + return &imageUploadService{} +} + +func (s *imageUploadService) SetImage(ctx context.Context, entityType string, entityID string, name string, oldPath string, reader io.Reader, ext string) (string, error) { + filename := imageFilename(entityID, name, ext) + absPath := model.UploadedImagePath(entityType, filename) + + if err := os.MkdirAll(filepath.Dir(absPath), 0755); err != nil { + return "", fmt.Errorf("creating image directory: %w", err) + } + + // Remove old image if it exists + if oldPath != "" { + if err := os.Remove(oldPath); err != nil && !os.IsNotExist(err) { + log.Warn(ctx, "Failed to remove old image", "path", oldPath, err) + } + } + + // Save new image + f, err := os.Create(absPath) + if err != nil { + return "", fmt.Errorf("creating image file: %w", err) + } + defer f.Close() + + if _, err := io.Copy(f, reader); err != nil { + return "", fmt.Errorf("writing image file: %w", err) + } + + return filename, nil +} + +func (s *imageUploadService) RemoveImage(ctx context.Context, path string) error { + if path == "" { + return nil + } + if err := os.Remove(path); err != nil && !os.IsNotExist(err) { + return fmt.Errorf("removing image %q: %w", path, err) + } + return nil +} + +func imageFilename(id, name, ext string) string { + clean := utils.CleanFileName(name) + if clean == "" { + return id + ext + } + return id + "_" + clean + ext +} diff --git a/core/image_upload_test.go b/core/image_upload_test.go new file mode 100644 index 000000000..265f60a95 --- /dev/null +++ b/core/image_upload_test.go @@ -0,0 +1,99 @@ +package core_test + +import ( + "context" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ImageUploadService", func() { + var svc core.ImageUploadService + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = conf.NewDir(tmpDir) + svc = core.NewImageUploadService() + }) + + Describe("SetImage", func() { + It("creates directory and saves image file", func() { + ctx := context.Background() + reader := strings.NewReader("fake image data") + filename, err := svc.SetImage(ctx, consts.EntityArtist, "ar-1", "Pink Floyd", "", reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + Expect(filename).To(Equal("ar-1_pink_floyd.jpg")) + + absPath := filepath.Join(tmpDir, "artwork", "artist", "ar-1_pink_floyd.jpg") + data, err := os.ReadFile(absPath) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("fake image data")) + }) + + It("falls back to ID-only filename when name cleans to empty", func() { + ctx := context.Background() + reader := strings.NewReader("data") + filename, err := svc.SetImage(ctx, consts.EntityPlaylist, "pl-1", "!!!", "", reader, ".png") + Expect(err).ToNot(HaveOccurred()) + Expect(filename).To(Equal("pl-1.png")) + }) + + It("removes old image when replacing", func() { + ctx := context.Background() + oldDir := filepath.Join(tmpDir, "artwork", "artist") + Expect(os.MkdirAll(oldDir, 0755)).To(Succeed()) + oldFile := filepath.Join(oldDir, "ar-1_old.png") + Expect(os.WriteFile(oldFile, []byte("old"), 0600)).To(Succeed()) + + reader := strings.NewReader("new image") + _, err := svc.SetImage(ctx, consts.EntityArtist, "ar-1", "New Name", oldFile, reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + Expect(oldFile).ToNot(BeAnExistingFile()) + + newPath := filepath.Join(oldDir, "ar-1_new_name.jpg") + Expect(newPath).To(BeAnExistingFile()) + }) + + It("ignores missing old file without error", func() { + ctx := context.Background() + reader := strings.NewReader("data") + _, err := svc.SetImage(ctx, consts.EntityArtist, "ar-1", "Name", "/nonexistent/path.jpg", reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("RemoveImage", func() { + It("removes the file at the given path", func() { + ctx := context.Background() + dir := filepath.Join(tmpDir, "artwork", "artist") + Expect(os.MkdirAll(dir, 0755)).To(Succeed()) + path := filepath.Join(dir, "ar-1_test.jpg") + Expect(os.WriteFile(path, []byte("img"), 0600)).To(Succeed()) + + err := svc.RemoveImage(ctx, path) + Expect(err).ToNot(HaveOccurred()) + Expect(path).ToNot(BeAnExistingFile()) + }) + + It("succeeds when file does not exist", func() { + ctx := context.Background() + err := svc.RemoveImage(ctx, "/nonexistent/file.jpg") + Expect(err).ToNot(HaveOccurred()) + }) + + It("succeeds with empty path", func() { + ctx := context.Background() + err := svc.RemoveImage(ctx, "") + Expect(err).ToNot(HaveOccurred()) + }) + }) +}) diff --git a/core/inspect.go b/core/inspect.go index 751cf063f..01ec33760 100644 --- a/core/inspect.go +++ b/core/inspect.go @@ -7,7 +7,6 @@ import ( "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/metadata" - . "github.com/navidrome/navidrome/utils/gg" ) type InspectOutput struct { @@ -44,7 +43,7 @@ func Inspect(filePath string, libraryId int, folderId string) (*InspectOutput, e result := &InspectOutput{ File: filePath, RawTags: tags[file].Tags, - MappedTags: P(md.ToMediaFile(libraryId, folderId)), + MappedTags: new(md.ToMediaFile(libraryId, folderId)), } return result, nil diff --git a/core/library.go b/core/library.go new file mode 100644 index 000000000..0bf3be9fa --- /dev/null +++ b/core/library.go @@ -0,0 +1,415 @@ +package core + +import ( + "context" + "errors" + "fmt" + "io/fs" + "os" + "path/filepath" + "strconv" + "strings" + "time" + + "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/core/storage" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/utils/slice" +) + +// Watcher interface for managing file system watchers +type Watcher interface { + Watch(ctx context.Context, lib *model.Library) error + StopWatching(ctx context.Context, libraryID int) error +} + +// Library provides business logic for library management and user-library associations +type Library interface { + GetUserLibraries(ctx context.Context, userID string) (model.Libraries, error) + SetUserLibraries(ctx context.Context, userID string, libraryIDs []int) error + ValidateLibraryAccess(ctx context.Context, userID string, libraryID int) error + + NewRepository(ctx context.Context) rest.Repository +} + +type libraryService struct { + ds model.DataStore + scanner model.Scanner + watcher Watcher + broker events.Broker + pluginManager PluginUnloader +} + +// NewLibrary creates a new Library service +func NewLibrary(ds model.DataStore, scanner model.Scanner, watcher Watcher, broker events.Broker, pluginManager PluginUnloader) Library { + return &libraryService{ + ds: ds, + scanner: scanner, + watcher: watcher, + broker: broker, + pluginManager: pluginManager, + } +} + +// User-library association operations + +func (s *libraryService) GetUserLibraries(ctx context.Context, userID string) (model.Libraries, error) { + // Verify user exists + if _, err := s.ds.User(ctx).Get(userID); err != nil { + return nil, err + } + + return s.ds.User(ctx).GetUserLibraries(userID) +} + +func (s *libraryService) SetUserLibraries(ctx context.Context, userID string, libraryIDs []int) error { + // Verify user exists + user, err := s.ds.User(ctx).Get(userID) + if err != nil { + return err + } + + // Admin users get all libraries automatically - don't allow manual assignment + if user.IsAdmin { + return fmt.Errorf("%w: cannot manually assign libraries to admin users", model.ErrValidation) + } + + // Regular users must have at least one library + if len(libraryIDs) == 0 { + return fmt.Errorf("%w: at least one library must be assigned to non-admin users", model.ErrValidation) + } + + // Validate all library IDs exist + if len(libraryIDs) > 0 { + if err := s.validateLibraryIDs(ctx, libraryIDs); err != nil { + return err + } + } + + // Set user libraries + err = s.ds.User(ctx).SetUserLibraries(userID, libraryIDs) + if err != nil { + return fmt.Errorf("error setting user libraries: %w", err) + } + + // Send refresh event to all clients + event := &events.RefreshResource{} + libIDs := slice.Map(libraryIDs, func(id int) string { return strconv.Itoa(id) }) + event = event.With("user", userID).With("library", libIDs...) + s.broker.SendBroadcastMessage(ctx, event) + return nil +} + +func (s *libraryService) ValidateLibraryAccess(ctx context.Context, userID string, libraryID int) error { + user, ok := request.UserFrom(ctx) + if !ok { + return fmt.Errorf("user not found in context") + } + + // Admin users have access to all libraries + if user.IsAdmin { + return nil + } + + // Check if user has explicit access to this library + libraries, err := s.ds.User(ctx).GetUserLibraries(userID) + if err != nil { + log.Error(ctx, "Error checking library access", "userID", userID, "libraryID", libraryID, err) + return fmt.Errorf("error checking library access: %w", err) + } + + for _, lib := range libraries { + if lib.ID == libraryID { + return nil + } + } + + return fmt.Errorf("%w: user does not have access to library %d", model.ErrNotAuthorized, libraryID) +} + +// REST repository wrapper + +func (s *libraryService) NewRepository(ctx context.Context) rest.Repository { + repo := s.ds.Library(ctx) + wrapper := &libraryRepositoryWrapper{ + ctx: ctx, + LibraryRepository: repo, + Repository: repo.(rest.Repository), + ds: s.ds, + scanner: s.scanner, + watcher: s.watcher, + broker: s.broker, + pluginManager: s.pluginManager, + } + return wrapper +} + +type libraryRepositoryWrapper struct { + rest.Repository + model.LibraryRepository + ctx context.Context + ds model.DataStore + scanner model.Scanner + watcher Watcher + broker events.Broker + pluginManager PluginUnloader +} + +func (r *libraryRepositoryWrapper) Save(entity any) (string, error) { + lib := entity.(*model.Library) + if err := r.validateLibrary(lib); err != nil { + return "", err + } + + err := r.LibraryRepository.Put(lib) + if err != nil { + return "", r.mapError(err) + } + + // Start watcher and trigger scan after successful library creation + if r.watcher != nil { + if err := r.watcher.Watch(r.ctx, lib); err != nil { + log.Warn(r.ctx, "Failed to start watcher for new library", "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, err) + } + } + + if r.scanner != nil { + go r.triggerScan(lib, "new") + } + + // Send library refresh event to all clients + if r.broker != nil { + event := &events.RefreshResource{} + r.broker.SendBroadcastMessage(r.ctx, event.With("library", strconv.Itoa(lib.ID))) + log.Debug(r.ctx, "Library created - sent refresh event", "libraryID", lib.ID, "name", lib.Name) + } + + return strconv.Itoa(lib.ID), nil +} + +func (r *libraryRepositoryWrapper) Update(id string, entity any, _ ...string) error { + lib := entity.(*model.Library) + libID, err := strconv.Atoi(id) + if err != nil { + return fmt.Errorf("invalid library ID: %s", id) + } + + lib.ID = libID + if err := r.validateLibrary(lib); err != nil { + return err + } + + // Get the original library to check if path changed + originalLib, err := r.Get(libID) + if err != nil { + return r.mapError(err) + } + + pathChanged := originalLib.Path != lib.Path + + err = r.LibraryRepository.Put(lib) + if err != nil { + return r.mapError(err) + } + + // Restart watcher and trigger scan if path was updated + if pathChanged { + if r.watcher != nil { + if err := r.watcher.Watch(r.ctx, lib); err != nil { + log.Warn(r.ctx, "Failed to restart watcher for updated library", "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, err) + } + } + + if r.scanner != nil { + go r.triggerScan(lib, "updated") + } + } + + // Send library refresh event to all clients + if r.broker != nil { + event := &events.RefreshResource{} + r.broker.SendBroadcastMessage(r.ctx, event.With("library", id)) + log.Debug(r.ctx, "Library updated - sent refresh event", "libraryID", libID, "name", lib.Name) + } + + return nil +} + +func (r *libraryRepositoryWrapper) Delete(id string) error { + libID, err := strconv.Atoi(id) + if err != nil { + return &rest.ValidationError{Errors: map[string]string{ + "id": "invalid library ID format", + }} + } + + // Get library info before deletion for logging + lib, err := r.Get(libID) + if err != nil { + return r.mapError(err) + } + + err = r.LibraryRepository.Delete(libID) + if err != nil { + return r.mapError(err) + } + + // Stop watcher and trigger scan after successful library deletion to clean up orphaned data + if r.watcher != nil { + if err := r.watcher.StopWatching(r.ctx, libID); err != nil { + log.Warn(r.ctx, "Failed to stop watcher for deleted library", "libraryID", libID, "name", lib.Name, "path", lib.Path, err) + } + } + + if r.scanner != nil { + go r.triggerScan(lib, "deleted") + } + + // Send library refresh event to all clients + if r.broker != nil { + event := &events.RefreshResource{} + r.broker.SendBroadcastMessage(r.ctx, event.With("library", id)) + log.Debug(r.ctx, "Library deleted - sent refresh event", "libraryID", libID, "name", lib.Name) + } + + // After successful deletion, check if any plugins were auto-disabled + // and need to be unloaded from memory + r.pluginManager.UnloadDisabledPlugins(r.ctx) + + return nil +} + +// Helper methods + +func (r *libraryRepositoryWrapper) mapError(err error) error { + if err == nil { + return nil + } + + errStr := err.Error() + + // Handle database constraint violations. + // TODO: Being tied to react-admin translations is not ideal, but this will probably go away with the new UI/API + if strings.Contains(errStr, "UNIQUE constraint failed") { + if strings.Contains(errStr, "library.name") { + return &rest.ValidationError{Errors: map[string]string{"name": "ra.validation.unique"}} + } + if strings.Contains(errStr, "library.path") { + return &rest.ValidationError{Errors: map[string]string{"path": "ra.validation.unique"}} + } + } + + switch { + case errors.Is(err, model.ErrNotFound): + return rest.ErrNotFound + case errors.Is(err, model.ErrNotAuthorized): + return rest.ErrPermissionDenied + default: + return err + } +} + +func (r *libraryRepositoryWrapper) validateLibrary(library *model.Library) error { + validationErrors := make(map[string]string) + + if library.Name == "" { + validationErrors["name"] = "ra.validation.required" + } + + if library.Path == "" { + validationErrors["path"] = "ra.validation.required" + } else { + // Validate path format and accessibility + if err := r.validateLibraryPath(library); err != nil { + validationErrors["path"] = err.Error() + } + } + + if len(validationErrors) > 0 { + return &rest.ValidationError{Errors: validationErrors} + } + + return nil +} + +func (r *libraryRepositoryWrapper) validateLibraryPath(library *model.Library) error { + // Validate path format + if !filepath.IsAbs(library.Path) { + return fmt.Errorf("library path must be absolute") + } + + // Clean the path to normalize it + cleanPath := filepath.Clean(library.Path) + library.Path = cleanPath + + // Check if path exists and is accessible using storage abstraction + fileStore, err := storage.For(library.Path) + if err != nil { + return fmt.Errorf("invalid storage scheme: %w", err) + } + + fsys, err := fileStore.FS() + if err != nil { + log.Warn(r.ctx, "Error validating library.path", "path", library.Path, err) + return fmt.Errorf("resources.library.validation.pathInvalid") + } + + // Check if root directory exists + info, err := fs.Stat(fsys, ".") + if err != nil { + // Parse the error message to check for "not a directory" + log.Warn(r.ctx, "Error stating library.path", "path", library.Path, err) + errStr := err.Error() + if strings.Contains(errStr, "not a directory") || + strings.Contains(errStr, "The directory name is invalid.") { + return fmt.Errorf("resources.library.validation.pathNotDirectory") + } else if os.IsNotExist(err) { + return fmt.Errorf("resources.library.validation.pathNotFound") + } else if os.IsPermission(err) { + return fmt.Errorf("resources.library.validation.pathNotAccessible") + } else { + return fmt.Errorf("resources.library.validation.pathInvalid") + } + } + + if !info.IsDir() { + return fmt.Errorf("resources.library.validation.pathNotDirectory") + } + + return nil +} + +func (s *libraryService) validateLibraryIDs(ctx context.Context, libraryIDs []int) error { + if len(libraryIDs) == 0 { + return nil + } + + // Use CountAll to efficiently validate library IDs exist + count, err := s.ds.Library(ctx).CountAll(model.QueryOptions{ + Filters: squirrel.Eq{"id": libraryIDs}, + }) + if err != nil { + return fmt.Errorf("error validating library IDs: %w", err) + } + + if int(count) != len(libraryIDs) { + return fmt.Errorf("%w: one or more library IDs are invalid", model.ErrValidation) + } + + return nil +} + +func (r *libraryRepositoryWrapper) triggerScan(lib *model.Library, action string) { + log.Info(r.ctx, fmt.Sprintf("Triggering scan for %s library", action), "libraryID", lib.ID, "name", lib.Name, "path", lib.Path) + start := time.Now() + warnings, err := r.scanner.ScanAll(r.ctx, false) // Quick scan for new library + if err != nil { + log.Error(r.ctx, fmt.Sprintf("Error scanning %s library", action), "libraryID", lib.ID, "name", lib.Name, err) + } else { + log.Info(r.ctx, fmt.Sprintf("Scan completed for %s library", action), "libraryID", lib.ID, "name", lib.Name, "warnings", len(warnings), "elapsed", time.Since(start)) + } +} diff --git a/core/library_test.go b/core/library_test.go new file mode 100644 index 000000000..175d9c37d --- /dev/null +++ b/core/library_test.go @@ -0,0 +1,998 @@ +package core_test + +import ( + "context" + "errors" + "net/http" + "os" + "path/filepath" + "sync" + + "github.com/deluan/rest" + _ "github.com/navidrome/navidrome/adapters/gotaglib" // Register taglib extractor + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + _ "github.com/navidrome/navidrome/core/storage/local" // Register local storage + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// These tests require the local storage adapter and the taglib extractor to be registered. +var _ = Describe("Library Service", func() { + var service core.Library + var ds *tests.MockDataStore + var libraryRepo *tests.MockLibraryRepo + var userRepo *tests.MockedUserRepo + var ctx context.Context + var tempDir string + var scanner *tests.MockScanner + var watcherManager *mockWatcherManager + var broker *mockEventBroker + var pluginManager *mockPluginUnloader + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + + ds = &tests.MockDataStore{} + libraryRepo = &tests.MockLibraryRepo{} + userRepo = tests.CreateMockUserRepo() + ds.MockedLibrary = libraryRepo + ds.MockedUser = userRepo + + // Create a mock scanner that tracks calls + scanner = tests.NewMockScanner() + // Create a mock watcher manager + watcherManager = &mockWatcherManager{ + libraryStates: make(map[int]model.Library), + } + // Create a mock event broker + broker = &mockEventBroker{} + // Create a mock plugin unloader + pluginManager = &mockPluginUnloader{} + service = core.NewLibrary(ds, scanner, watcherManager, broker, pluginManager) + ctx = context.Background() + + // Create a temporary directory for testing valid paths + var err error + tempDir, err = os.MkdirTemp("", "navidrome-library-test-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { + os.RemoveAll(tempDir) + }) + }) + + Describe("Library CRUD Operations", func() { + var repo rest.Persistable + + BeforeEach(func() { + r := service.NewRepository(ctx) + repo = r.(rest.Persistable) + }) + + Describe("Create", func() { + It("creates a new library successfully", func() { + library := &model.Library{ID: 1, Name: "New Library", Path: tempDir} + + _, err := repo.Save(library) + + Expect(err).NotTo(HaveOccurred()) + Expect(libraryRepo.Data[1].Name).To(Equal("New Library")) + Expect(libraryRepo.Data[1].Path).To(Equal(tempDir)) + }) + + It("fails when library name is empty", func() { + library := &model.Library{Path: tempDir} + + _, err := repo.Save(library) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ra.validation.required")) + }) + + It("fails when library path is empty", func() { + library := &model.Library{Name: "Test"} + + _, err := repo.Save(library) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ra.validation.required")) + }) + + It("fails when library path is not absolute", func() { + library := &model.Library{Name: "Test", Path: "relative/path"} + + _, err := repo.Save(library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("library path must be absolute")) + }) + + Context("Database constraint violations", func() { + BeforeEach(func() { + // Set up an existing library that will cause constraint violations + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Existing Library", Path: tempDir}, + }) + }) + + AfterEach(func() { + // Reset custom PutFn after each test + libraryRepo.PutFn = nil + }) + + It("handles name uniqueness constraint violation from database", func() { + // Create the directory that will be used for the test + otherTempDir, err := os.MkdirTemp("", "navidrome-other-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(otherTempDir) }) + + // Try to create another library with the same name + library := &model.Library{ID: 2, Name: "Existing Library", Path: otherTempDir} + + // Mock the repository to return a UNIQUE constraint error + libraryRepo.PutFn = func(library *model.Library) error { + return errors.New("UNIQUE constraint failed: library.name") + } + + _, err = repo.Save(library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["name"]).To(Equal("ra.validation.unique")) + }) + + It("handles path uniqueness constraint violation from database", func() { + // Try to create another library with the same path + library := &model.Library{ID: 2, Name: "Different Library", Path: tempDir} + + // Mock the repository to return a UNIQUE constraint error + libraryRepo.PutFn = func(library *model.Library) error { + return errors.New("UNIQUE constraint failed: library.path") + } + + _, err := repo.Save(library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("ra.validation.unique")) + }) + }) + }) + + Describe("Update", func() { + BeforeEach(func() { + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Original Library", Path: tempDir}, + }) + }) + + It("updates an existing library successfully", func() { + newTempDir, err := os.MkdirTemp("", "navidrome-library-update-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(newTempDir) }) + + library := &model.Library{ID: 1, Name: "Updated Library", Path: newTempDir} + + err = repo.Update("1", library) + + Expect(err).NotTo(HaveOccurred()) + Expect(libraryRepo.Data[1].Name).To(Equal("Updated Library")) + Expect(libraryRepo.Data[1].Path).To(Equal(newTempDir)) + }) + + It("fails when library doesn't exist", func() { + // Create a unique temporary directory to avoid path conflicts + uniqueTempDir, err := os.MkdirTemp("", "navidrome-nonexistent-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(uniqueTempDir) }) + + library := &model.Library{ID: 999, Name: "Non-existent", Path: uniqueTempDir} + + err = repo.Update("999", library) + + Expect(err).To(HaveOccurred()) + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("fails when library name is empty", func() { + library := &model.Library{ID: 1, Path: tempDir} + + err := repo.Update("1", library) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ra.validation.required")) + }) + + It("cleans and normalizes the path on update", func() { + unnormalizedPath := tempDir + "//../" + filepath.Base(tempDir) + library := &model.Library{ID: 1, Name: "Updated Library", Path: unnormalizedPath} + + err := repo.Update("1", library) + + Expect(err).NotTo(HaveOccurred()) + Expect(libraryRepo.Data[1].Path).To(Equal(filepath.Clean(unnormalizedPath))) + }) + + It("allows updating library with same name (no change)", func() { + // Set up a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library", Path: tempDir}, + }) + + // Update the library keeping the same name (should be allowed) + library := &model.Library{ID: 1, Name: "Test Library", Path: tempDir} + + err := repo.Update("1", library) + + Expect(err).NotTo(HaveOccurred()) + }) + + It("allows updating library with same path (no change)", func() { + // Set up a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library", Path: tempDir}, + }) + + // Update the library keeping the same path (should be allowed) + library := &model.Library{ID: 1, Name: "Test Library", Path: tempDir} + + err := repo.Update("1", library) + + Expect(err).NotTo(HaveOccurred()) + }) + + Context("Database constraint violations during update", func() { + BeforeEach(func() { + // Reset any custom PutFn from previous tests + libraryRepo.PutFn = nil + }) + + It("handles name uniqueness constraint violation during update", func() { + // Create additional temp directory for the test + otherTempDir, err := os.MkdirTemp("", "navidrome-other-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(otherTempDir) }) + + // Set up two libraries + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Library One", Path: tempDir}, + {ID: 2, Name: "Library Two", Path: otherTempDir}, + }) + + // Mock database constraint violation + libraryRepo.PutFn = func(library *model.Library) error { + return errors.New("UNIQUE constraint failed: library.name") + } + + // Try to update library 2 to have the same name as library 1 + library := &model.Library{ID: 2, Name: "Library One", Path: otherTempDir} + + err = repo.Update("2", library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["name"]).To(Equal("ra.validation.unique")) + }) + + It("handles path uniqueness constraint violation during update", func() { + // Create additional temp directory for the test + otherTempDir, err := os.MkdirTemp("", "navidrome-other-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(otherTempDir) }) + + // Set up two libraries + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Library One", Path: tempDir}, + {ID: 2, Name: "Library Two", Path: otherTempDir}, + }) + + // Mock database constraint violation + libraryRepo.PutFn = func(library *model.Library) error { + return errors.New("UNIQUE constraint failed: library.path") + } + + // Try to update library 2 to have the same path as library 1 + library := &model.Library{ID: 2, Name: "Library Two", Path: tempDir} + + err = repo.Update("2", library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("ra.validation.unique")) + }) + }) + }) + + Describe("Path Validation", func() { + Context("Create operation", func() { + It("fails when path is not absolute", func() { + library := &model.Library{Name: "Test", Path: "relative/path"} + + _, err := repo.Save(library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("library path must be absolute")) + }) + + It("fails when path does not exist", func() { + nonExistentPath := filepath.Join(tempDir, "nonexistent") + library := &model.Library{Name: "Test", Path: nonExistentPath} + + _, err := repo.Save(library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("resources.library.validation.pathInvalid")) + }) + + It("fails when path is a file instead of directory", func() { + testFile := filepath.Join(tempDir, "testfile.txt") + err := os.WriteFile(testFile, []byte("test"), 0600) + Expect(err).NotTo(HaveOccurred()) + + library := &model.Library{Name: "Test", Path: testFile} + + _, err = repo.Save(library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("resources.library.validation.pathNotDirectory")) + }) + + It("fails when path is not accessible due to permissions", func() { + Skip("Permission tests are environment-dependent and may fail in CI") + // This test is skipped because creating a directory with no read permissions + // is complex and may not work consistently across different environments + }) + + It("handles multiple validation errors", func() { + library := &model.Library{Name: "", Path: "relative/path"} + + _, err := repo.Save(library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors).To(HaveKey("name")) + Expect(validationErr.Errors).To(HaveKey("path")) + Expect(validationErr.Errors["name"]).To(Equal("ra.validation.required")) + Expect(validationErr.Errors["path"]).To(Equal("library path must be absolute")) + }) + }) + + Context("Update operation", func() { + BeforeEach(func() { + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library", Path: tempDir}, + }) + }) + + It("fails when updated path is not absolute", func() { + library := &model.Library{ID: 1, Name: "Test", Path: "relative/path"} + + err := repo.Update("1", library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("library path must be absolute")) + }) + + It("allows updating library with same name (no change)", func() { + // Set up a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library", Path: tempDir}, + }) + + // Update the library keeping the same name (should be allowed) + library := &model.Library{ID: 1, Name: "Test Library", Path: tempDir} + + err := repo.Update("1", library) + + Expect(err).NotTo(HaveOccurred()) + }) + + It("fails when updated path does not exist", func() { + nonExistentPath := filepath.Join(tempDir, "nonexistent") + library := &model.Library{ID: 1, Name: "Test", Path: nonExistentPath} + + err := repo.Update("1", library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("resources.library.validation.pathInvalid")) + }) + + It("fails when updated path is a file instead of directory", func() { + testFile := filepath.Join(tempDir, "updatefile.txt") + err := os.WriteFile(testFile, []byte("test"), 0600) + Expect(err).NotTo(HaveOccurred()) + + library := &model.Library{ID: 1, Name: "Test", Path: testFile} + + err = repo.Update("1", library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors["path"]).To(Equal("resources.library.validation.pathNotDirectory")) + }) + + It("handles multiple validation errors on update", func() { + // Try to update with empty name and invalid path + library := &model.Library{ID: 1, Name: "", Path: "relative/path"} + + err := repo.Update("1", library) + + Expect(err).To(HaveOccurred()) + var validationErr *rest.ValidationError + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors).To(HaveKey("name")) + Expect(validationErr.Errors).To(HaveKey("path")) + Expect(validationErr.Errors["name"]).To(Equal("ra.validation.required")) + Expect(validationErr.Errors["path"]).To(Equal("library path must be absolute")) + }) + }) + }) + + Describe("Delete", func() { + BeforeEach(func() { + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Library to Delete", Path: tempDir}, + }) + }) + + It("deletes an existing library successfully", func() { + err := repo.Delete("1") + + Expect(err).NotTo(HaveOccurred()) + Expect(libraryRepo.Data).To(HaveLen(0)) + }) + + It("fails when library doesn't exist", func() { + err := repo.Delete("999") + + Expect(err).To(HaveOccurred()) + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + }) + + Describe("User-Library Association Operations", func() { + var regularUser, adminUser *model.User + + BeforeEach(func() { + regularUser = &model.User{ID: "user1", UserName: "regular", IsAdmin: false} + adminUser = &model.User{ID: "admin1", UserName: "admin", IsAdmin: true} + + userRepo.Data = map[string]*model.User{ + "regular": regularUser, + "admin": adminUser, + } + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Library 1", Path: "/music1"}, + {ID: 2, Name: "Library 2", Path: "/music2"}, + {ID: 3, Name: "Library 3", Path: "/music3"}, + }) + }) + + Describe("GetUserLibraries", func() { + It("returns user's libraries", func() { + userRepo.UserLibraries = map[string][]int{ + "user1": {1}, + } + + result, err := service.GetUserLibraries(ctx, "user1") + + Expect(err).NotTo(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal(1)) + }) + + It("fails when user doesn't exist", func() { + _, err := service.GetUserLibraries(ctx, "nonexistent") + + Expect(err).To(HaveOccurred()) + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + + Describe("SetUserLibraries", func() { + It("sets libraries for regular user successfully", func() { + err := service.SetUserLibraries(ctx, "user1", []int{1, 2}) + + Expect(err).NotTo(HaveOccurred()) + libraries := userRepo.UserLibraries["user1"] + Expect(libraries).To(HaveLen(2)) + }) + + It("fails when user doesn't exist", func() { + err := service.SetUserLibraries(ctx, "nonexistent", []int{1}) + + Expect(err).To(HaveOccurred()) + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("fails when trying to set libraries for admin user", func() { + err := service.SetUserLibraries(ctx, "admin1", []int{1}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("cannot manually assign libraries to admin users")) + }) + + It("fails when no libraries provided for regular user", func() { + err := service.SetUserLibraries(ctx, "user1", []int{}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("at least one library must be assigned to non-admin users")) + }) + + It("fails when library doesn't exist", func() { + err := service.SetUserLibraries(ctx, "user1", []int{999}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("one or more library IDs are invalid")) + }) + + It("fails when some libraries don't exist", func() { + err := service.SetUserLibraries(ctx, "user1", []int{1, 999, 2}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("one or more library IDs are invalid")) + }) + }) + + Describe("ValidateLibraryAccess", func() { + Context("admin user", func() { + BeforeEach(func() { + ctx = request.WithUser(ctx, *adminUser) + }) + + It("allows access to any library", func() { + err := service.ValidateLibraryAccess(ctx, "admin1", 1) + + Expect(err).NotTo(HaveOccurred()) + }) + }) + + Context("regular user", func() { + BeforeEach(func() { + ctx = request.WithUser(ctx, *regularUser) + userRepo.UserLibraries = map[string][]int{ + "user1": {1}, + } + }) + + It("allows access to user's libraries", func() { + err := service.ValidateLibraryAccess(ctx, "user1", 1) + + Expect(err).NotTo(HaveOccurred()) + }) + + It("denies access to libraries user doesn't have", func() { + err := service.ValidateLibraryAccess(ctx, "user1", 2) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("user does not have access to library 2")) + }) + }) + + Context("no user in context", func() { + It("fails with user not found error", func() { + err := service.ValidateLibraryAccess(ctx, "user1", 1) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("user not found in context")) + }) + }) + }) + }) + + Describe("Scan Triggering", func() { + var repo rest.Persistable + + BeforeEach(func() { + r := service.NewRepository(ctx) + repo = r.(rest.Persistable) + }) + + It("triggers scan when creating a new library", func() { + library := &model.Library{ID: 1, Name: "New Library", Path: tempDir} + + _, err := repo.Save(library) + Expect(err).NotTo(HaveOccurred()) + + // Wait briefly for the goroutine to complete + Eventually(func() int { + return scanner.GetScanAllCallCount() + }, "1s", "10ms").Should(Equal(1)) + + // Verify scan was called with correct parameters + calls := scanner.GetScanAllCalls() + Expect(calls[0].FullScan).To(BeFalse()) // Should be quick scan + }) + + It("triggers scan when updating library path", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Original Library", Path: tempDir}, + }) + + // Create a new temporary directory for the update + newTempDir, err := os.MkdirTemp("", "navidrome-library-update-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(newTempDir) }) + + // Update the library with a new path + library := &model.Library{ID: 1, Name: "Updated Library", Path: newTempDir} + err = repo.Update("1", library) + Expect(err).NotTo(HaveOccurred()) + + // Wait briefly for the goroutine to complete + Eventually(func() int { + return scanner.GetScanAllCallCount() + }, "1s", "10ms").Should(Equal(1)) + + // Verify scan was called with correct parameters + calls := scanner.GetScanAllCalls() + Expect(calls[0].FullScan).To(BeFalse()) // Should be quick scan + }) + + It("does not trigger scan when updating library without path change", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Original Library", Path: tempDir}, + }) + + // Update the library name only (same path) + library := &model.Library{ID: 1, Name: "Updated Name", Path: tempDir} + err := repo.Update("1", library) + Expect(err).NotTo(HaveOccurred()) + + // Wait a bit to ensure no scan was triggered + Consistently(func() int { + return scanner.GetScanAllCallCount() + }, "100ms", "10ms").Should(Equal(0)) + }) + + It("does not trigger scan when library creation fails", func() { + // Try to create library with invalid data (empty name) + library := &model.Library{Path: tempDir} + + _, err := repo.Save(library) + Expect(err).To(HaveOccurred()) + + // Ensure no scan was triggered since creation failed + Consistently(func() int { + return scanner.GetScanAllCallCount() + }, "100ms", "10ms").Should(Equal(0)) + }) + + It("does not trigger scan when library update fails", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Original Library", Path: tempDir}, + }) + + // Try to update with invalid data (empty name) + library := &model.Library{ID: 1, Name: "", Path: tempDir} + err := repo.Update("1", library) + Expect(err).To(HaveOccurred()) + + // Ensure no scan was triggered since update failed + Consistently(func() int { + return scanner.GetScanAllCallCount() + }, "100ms", "10ms").Should(Equal(0)) + }) + + It("triggers scan when deleting a library", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Library to Delete", Path: tempDir}, + }) + + // Delete the library + err := repo.Delete("1") + Expect(err).NotTo(HaveOccurred()) + + // Wait briefly for the goroutine to complete + Eventually(func() int { + return scanner.GetScanAllCallCount() + }, "1s", "10ms").Should(Equal(1)) + + // Verify scan was called with correct parameters + calls := scanner.GetScanAllCalls() + Expect(calls[0].FullScan).To(BeFalse()) // Should be quick scan + }) + + It("does not trigger scan when library deletion fails", func() { + // Try to delete a non-existent library + err := repo.Delete("999") + Expect(err).To(HaveOccurred()) + + // Ensure no scan was triggered since deletion failed + Consistently(func() int { + return scanner.GetScanAllCallCount() + }, "100ms", "10ms").Should(Equal(0)) + }) + + Context("Watcher Integration", func() { + It("starts watcher when creating a new library", func() { + library := &model.Library{ID: 1, Name: "New Library", Path: tempDir} + + _, err := repo.Save(library) + Expect(err).NotTo(HaveOccurred()) + + // Verify watcher was started + Eventually(func() int { + return watcherManager.lenStarted() + }, "1s", "10ms").Should(Equal(1)) + + Expect(watcherManager.StartedWatchers[0].ID).To(Equal(1)) + Expect(watcherManager.StartedWatchers[0].Name).To(Equal("New Library")) + Expect(watcherManager.StartedWatchers[0].Path).To(Equal(tempDir)) + }) + + It("restarts watcher when library path is updated", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Original Library", Path: tempDir}, + }) + + // Simulate that this library already has a watcher + watcherManager.simulateExistingLibrary(model.Library{ID: 1, Name: "Original Library", Path: tempDir}) + + // Create a new temp directory for the update + newTempDir, err := os.MkdirTemp("", "navidrome-library-update-") + Expect(err).NotTo(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(newTempDir) }) + + // Update library with new path + library := &model.Library{ID: 1, Name: "Updated Library", Path: newTempDir} + err = repo.Update("1", library) + Expect(err).NotTo(HaveOccurred()) + + // Verify watcher was restarted + Eventually(func() int { + return watcherManager.lenRestarted() + }, "1s", "10ms").Should(Equal(1)) + + Expect(watcherManager.RestartedWatchers[0].ID).To(Equal(1)) + Expect(watcherManager.RestartedWatchers[0].Path).To(Equal(newTempDir)) + }) + + It("does not restart watcher when only library name is updated", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Original Library", Path: tempDir}, + }) + + // Update library with same path but different name + library := &model.Library{ID: 1, Name: "Updated Name", Path: tempDir} + err := repo.Update("1", library) + Expect(err).NotTo(HaveOccurred()) + + // Verify watcher was NOT restarted (since path didn't change) + Consistently(func() int { + return watcherManager.lenRestarted() + }, "100ms", "10ms").Should(Equal(0)) + }) + + It("stops watcher when library is deleted", func() { + // Set up a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library", Path: tempDir}, + }) + + err := repo.Delete("1") + Expect(err).NotTo(HaveOccurred()) + + // Verify watcher was stopped + Eventually(func() int { + return watcherManager.lenStopped() + }, "1s", "10ms").Should(Equal(1)) + + Expect(watcherManager.StoppedWatchers[0]).To(Equal(1)) + }) + + It("does not stop watcher when library deletion fails", func() { + // Set up a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library", Path: tempDir}, + }) + + // Mock deletion to fail by trying to delete non-existent library + err := repo.Delete("999") + Expect(err).To(HaveOccurred()) + + // Verify watcher was NOT stopped since deletion failed + Consistently(func() int { + return watcherManager.lenStopped() + }, "100ms", "10ms").Should(Equal(0)) + }) + }) + }) + + Describe("Event Broadcasting", func() { + var repo rest.Persistable + + BeforeEach(func() { + r := service.NewRepository(ctx) + repo = r.(rest.Persistable) + // Clear any events from broker + broker.Events = []events.Event{} + }) + + It("sends refresh event when creating a library", func() { + library := &model.Library{ID: 1, Name: "New Library", Path: tempDir} + + _, err := repo.Save(library) + + Expect(err).NotTo(HaveOccurred()) + Expect(broker.Events).To(HaveLen(1)) + }) + + It("sends refresh event when updating a library", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Original Library", Path: tempDir}, + }) + + library := &model.Library{ID: 1, Name: "Updated Library", Path: tempDir} + err := repo.Update("1", library) + + Expect(err).NotTo(HaveOccurred()) + Expect(broker.Events).To(HaveLen(1)) + }) + + It("sends refresh event when deleting a library", func() { + // First create a library + libraryRepo.SetData(model.Libraries{ + {ID: 2, Name: "Library to Delete", Path: tempDir}, + }) + + err := repo.Delete("2") + + Expect(err).NotTo(HaveOccurred()) + Expect(broker.Events).To(HaveLen(1)) + }) + }) + + Describe("Plugin Manager Integration", func() { + var repo rest.Persistable + + BeforeEach(func() { + // Reset the call count for each test + pluginManager.unloadCalls = 0 + r := service.NewRepository(ctx) + repo = r.(rest.Persistable) + }) + + It("calls UnloadDisabledPlugins after successful library deletion", func() { + libraryRepo.SetData(model.Libraries{ + {ID: 2, Name: "Library to Delete", Path: tempDir}, + }) + + err := repo.Delete("2") + Expect(err).NotTo(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(1)) + }) + + It("does not call UnloadDisabledPlugins when library deletion fails", func() { + // Try to delete non-existent library + err := repo.Delete("999") + Expect(err).To(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(0)) + }) + }) +}) + +// mockPluginUnloader is a simple mock for testing UnloadDisabledPlugins calls +type mockPluginUnloader struct { + unloadCalls int +} + +func (m *mockPluginUnloader) UnloadDisabledPlugins(ctx context.Context) { + m.unloadCalls++ +} + +// mockWatcherManager provides a simple mock implementation of core.Watcher for testing +type mockWatcherManager struct { + StartedWatchers []model.Library + StoppedWatchers []int + RestartedWatchers []model.Library + libraryStates map[int]model.Library // Track which libraries we know about + mu sync.RWMutex +} + +func (m *mockWatcherManager) Watch(ctx context.Context, lib *model.Library) error { + m.mu.Lock() + defer m.mu.Unlock() + + // Check if we already know about this library ID + if _, exists := m.libraryStates[lib.ID]; exists { + // This is a restart - the library already existed + // Update our tracking and record the restart + for i, startedLib := range m.StartedWatchers { + if startedLib.ID == lib.ID { + m.StartedWatchers[i] = *lib + break + } + } + m.RestartedWatchers = append(m.RestartedWatchers, *lib) + m.libraryStates[lib.ID] = *lib + return nil + } + + // This is a new library - first time we're seeing it + m.StartedWatchers = append(m.StartedWatchers, *lib) + m.libraryStates[lib.ID] = *lib + return nil +} + +func (m *mockWatcherManager) StopWatching(ctx context.Context, libraryID int) error { + m.mu.Lock() + defer m.mu.Unlock() + m.StoppedWatchers = append(m.StoppedWatchers, libraryID) + return nil +} + +func (m *mockWatcherManager) lenStarted() int { + m.mu.RLock() + defer m.mu.RUnlock() + return len(m.StartedWatchers) +} + +func (m *mockWatcherManager) lenStopped() int { + m.mu.RLock() + defer m.mu.RUnlock() + return len(m.StoppedWatchers) +} + +func (m *mockWatcherManager) lenRestarted() int { + m.mu.RLock() + defer m.mu.RUnlock() + return len(m.RestartedWatchers) +} + +// simulateExistingLibrary simulates the scenario where a library already exists +// and has a watcher running (used by tests to set up the initial state) +func (m *mockWatcherManager) simulateExistingLibrary(lib model.Library) { + m.mu.Lock() + defer m.mu.Unlock() + m.libraryStates[lib.ID] = lib +} + +// mockEventBroker provides a mock implementation of events.Broker for testing +type mockEventBroker struct { + http.Handler + Events []events.Event + mu sync.RWMutex +} + +func (m *mockEventBroker) SendMessage(ctx context.Context, event events.Event) { + m.mu.Lock() + defer m.mu.Unlock() + m.Events = append(m.Events, event) +} + +func (m *mockEventBroker) SendBroadcastMessage(ctx context.Context, event events.Event) { + m.mu.Lock() + defer m.mu.Unlock() + m.Events = append(m.Events, event) +} diff --git a/core/lyrics/lyrics.go b/core/lyrics/lyrics.go index 858a3ffd8..758053042 100644 --- a/core/lyrics/lyrics.go +++ b/core/lyrics/lyrics.go @@ -9,23 +9,45 @@ import ( "github.com/navidrome/navidrome/model" ) -func GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { +// Lyrics can fetch lyrics for a media file. +type Lyrics interface { + GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) +} + +// PluginLoader discovers and loads lyrics provider plugins. +type PluginLoader interface { + LoadLyricsProvider(name string) (Lyrics, bool) +} + +type lyricsService struct { + pluginLoader PluginLoader +} + +// NewLyrics creates a new lyrics service. pluginLoader may be nil if no plugin +// system is available. +func NewLyrics(pluginLoader PluginLoader) Lyrics { + return &lyricsService{pluginLoader: pluginLoader} +} + +// GetLyrics returns lyrics for the given media file, trying sources in the +// order specified by conf.Server.LyricsPriority. +func (l *lyricsService) GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { var lyricsList model.LyricList var err error - for pattern := range strings.SplitSeq(strings.ToLower(conf.Server.LyricsPriority), ",") { + for pattern := range strings.SplitSeq(conf.Server.LyricsPriority, ",") { pattern = strings.TrimSpace(pattern) switch { - case pattern == "embedded": + case strings.EqualFold(pattern, "embedded"): lyricsList, err = fromEmbedded(ctx, mf) case strings.HasPrefix(pattern, "."): - lyricsList, err = fromExternalFile(ctx, mf, pattern) + lyricsList, err = fromExternalFile(ctx, mf, strings.ToLower(pattern)) default: - log.Error(ctx, "Invalid lyric pattern", "pattern", pattern) + lyricsList, err = l.fromPlugin(ctx, mf, pattern) } if err != nil { - log.Error(ctx, "error parsing lyrics", "source", pattern, err) + log.Error(ctx, "error getting lyrics", "source", pattern, err) } if len(lyricsList) > 0 { diff --git a/core/lyrics/lyrics_test.go b/core/lyrics/lyrics_test.go index f4197ccf6..9ab732ad1 100644 --- a/core/lyrics/lyrics_test.go +++ b/core/lyrics/lyrics_test.go @@ -3,14 +3,15 @@ package lyrics_test import ( "context" "encoding/json" + "fmt" "os" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" "github.com/navidrome/navidrome/utils" - "github.com/navidrome/navidrome/utils/gg" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -30,15 +31,15 @@ var _ = Describe("sources", func() { Lang: "eng", Line: []model.Line{ { - Start: gg.P(int64(18800)), + Start: new(int64(18800)), Value: "We're no strangers to love", }, { - Start: gg.P(int64(22801)), + Start: new(int64(22801)), Value: "You know the rules and so do I", }, }, - Offset: gg.P(int64(-100)), + Offset: new(int64(-100)), Synced: true, }, } @@ -72,7 +73,8 @@ var _ = Describe("sources", func() { DescribeTable("Lyrics Priority", func(priority string, expected model.LyricList) { conf.Server.LyricsPriority = priority - list, err := lyrics.GetLyrics(ctx, &mf) + svc := lyrics.NewLyrics(nil) + list, err := svc.GetLyrics(ctx, &mf) Expect(err).To(BeNil()) Expect(list).To(Equal(expected)) }, @@ -91,6 +93,7 @@ var _ = Describe("sources", func() { var accessForbiddenFile string BeforeEach(func() { + tests.SkipOnWindows("uses Unix file permission bits") accessForbiddenFile = utils.TempFileName("access_forbidden-", ".mp3") f, err := os.OpenFile(accessForbiddenFile, os.O_WRONLY|os.O_CREATE, 0222) @@ -107,7 +110,8 @@ var _ = Describe("sources", func() { It("should fallback to embedded if an error happens when parsing file", func() { conf.Server.LyricsPriority = ".mp3,embedded" - list, err := lyrics.GetLyrics(ctx, &mf) + svc := lyrics.NewLyrics(nil) + list, err := svc.GetLyrics(ctx, &mf) Expect(err).To(BeNil()) Expect(list).To(Equal(embeddedLyrics)) }) @@ -115,10 +119,109 @@ var _ = Describe("sources", func() { It("should return nothing if error happens when trying to parse file", func() { conf.Server.LyricsPriority = ".mp3" - list, err := lyrics.GetLyrics(ctx, &mf) + svc := lyrics.NewLyrics(nil) + list, err := svc.GetLyrics(ctx, &mf) Expect(err).To(BeNil()) Expect(list).To(BeEmpty()) }) }) }) + + Context("plugin sources", func() { + var mockLoader *mockPluginLoader + + BeforeEach(func() { + mockLoader = &mockPluginLoader{} + }) + + It("should return lyrics from a plugin", func() { + conf.Server.LyricsPriority = "test-lyrics-plugin" + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(unsyncedLyrics)) + }) + + It("should try plugin after embedded returns nothing", func() { + conf.Server.LyricsPriority = "embedded,test-lyrics-plugin" + mf.Lyrics = "" // No embedded lyrics + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(unsyncedLyrics)) + }) + + It("should skip plugin if embedded has lyrics", func() { + conf.Server.LyricsPriority = "embedded,test-lyrics-plugin" + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(embeddedLyrics)) // embedded wins + }) + + It("should skip unknown plugin names gracefully", func() { + conf.Server.LyricsPriority = "nonexistent-plugin,embedded" + mockLoader.notFound = true + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(embeddedLyrics)) // falls through to embedded + }) + + It("should preserve plugin name case from config", func() { + conf.Server.LyricsPriority = "MyLyricsPlugin" + mockLoader.pluginName = "MyLyricsPlugin" + mockLoader.lyrics = unsyncedLyrics + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(unsyncedLyrics)) + }) + + It("should handle plugin error gracefully", func() { + conf.Server.LyricsPriority = "test-lyrics-plugin,embedded" + mockLoader.err = fmt.Errorf("plugin error") + svc := lyrics.NewLyrics(mockLoader) + list, err := svc.GetLyrics(ctx, &mf) + Expect(err).To(BeNil()) + Expect(list).To(Equal(embeddedLyrics)) // falls through to embedded + }) + }) }) + +type mockPluginLoader struct { + lyrics model.LyricList + err error + notFound bool + pluginName string // expected plugin name (exact match, like real manager) +} + +func (m *mockPluginLoader) PluginNames(_ string) []string { + if m.notFound { + return nil + } + return []string{"test-lyrics-plugin"} +} + +func (m *mockPluginLoader) LoadLyricsProvider(name string) (lyrics.Lyrics, bool) { + if m.notFound { + return nil, false + } + // If pluginName is set, require exact match (like the real plugin manager) + if m.pluginName != "" && name != m.pluginName { + return nil, false + } + return &mockLyricsProvider{lyrics: m.lyrics, err: m.err}, true +} + +type mockLyricsProvider struct { + lyrics model.LyricList + err error +} + +func (m *mockLyricsProvider) GetLyrics(_ context.Context, _ *model.MediaFile) (model.LyricList, error) { + return m.lyrics, m.err +} diff --git a/core/lyrics/sources.go b/core/lyrics/sources.go index 6d4a4cc6f..82a10ca41 100644 --- a/core/lyrics/sources.go +++ b/core/lyrics/sources.go @@ -8,6 +8,7 @@ import ( "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/ioutils" ) func fromEmbedded(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { @@ -27,8 +28,7 @@ func fromExternalFile(ctx context.Context, mf *model.MediaFile, suffix string) ( externalLyric := basePath[0:len(basePath)-len(ext)] + suffix - contents, err := os.ReadFile(externalLyric) - + contents, err := ioutils.UTF8ReadFile(externalLyric) if errors.Is(err, os.ErrNotExist) { log.Trace(ctx, "no lyrics found at path", "path", externalLyric) return nil, nil @@ -49,3 +49,27 @@ func fromExternalFile(ctx context.Context, mf *model.MediaFile, suffix string) ( return model.LyricList{*lyrics}, nil } + +// fromPlugin attempts to load lyrics from a plugin with the given name. +func (l *lyricsService) fromPlugin(ctx context.Context, mf *model.MediaFile, pluginName string) (model.LyricList, error) { + if l.pluginLoader == nil { + log.Debug(ctx, "Invalid lyric source", "source", pluginName) + return nil, nil + } + + provider, ok := l.pluginLoader.LoadLyricsProvider(pluginName) + if !ok { + log.Warn(ctx, "Lyrics plugin not found", "plugin", pluginName) + return nil, nil + } + + lyricsList, err := provider.GetLyrics(ctx, mf) + if err != nil { + return nil, err + } + + if len(lyricsList) > 0 { + log.Trace(ctx, "Retrieved lyrics from plugin", "plugin", pluginName, "count", len(lyricsList)) + } + return lyricsList, nil +} diff --git a/core/lyrics/sources_test.go b/core/lyrics/sources_test.go index e92564c00..d1aefcb5d 100644 --- a/core/lyrics/sources_test.go +++ b/core/lyrics/sources_test.go @@ -5,7 +5,6 @@ import ( "encoding/json" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/utils/gg" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -74,15 +73,15 @@ var _ = Describe("sources", func() { Lang: "eng", Line: []model.Line{ { - Start: gg.P(int64(18800)), + Start: new(int64(18800)), Value: "We're no strangers to love", }, { - Start: gg.P(int64(22801)), + Start: new(int64(22801)), Value: "You know the rules and so do I", }, }, - Offset: gg.P(int64(-100)), + Offset: new(int64(-100)), Synced: true, }, })) @@ -108,5 +107,39 @@ var _ = Describe("sources", func() { }, })) }) + + It("should handle LRC files with UTF-8 BOM marker (issue #4631)", func() { + // The function looks for , so we need to pass + // a MediaFile with .mp3 path and look for .lrc suffix + mf := model.MediaFile{Path: "tests/fixtures/bom-test.mp3"} + lyrics, err := fromExternalFile(ctx, &mf, ".lrc") + + Expect(err).To(BeNil()) + Expect(lyrics).ToNot(BeNil()) + Expect(lyrics).To(HaveLen(1)) + + // The critical assertion: even with BOM, synced should be true + Expect(lyrics[0].Synced).To(BeTrue(), "Lyrics with BOM marker should be recognized as synced") + Expect(lyrics[0].Line).To(HaveLen(1)) + Expect(lyrics[0].Line[0].Start).To(Equal(new(int64(0)))) + Expect(lyrics[0].Line[0].Value).To(ContainSubstring("作曲")) + }) + + It("should handle UTF-16 LE encoded LRC files", func() { + mf := model.MediaFile{Path: "tests/fixtures/bom-utf16-test.mp3"} + lyrics, err := fromExternalFile(ctx, &mf, ".lrc") + + Expect(err).To(BeNil()) + Expect(lyrics).ToNot(BeNil()) + Expect(lyrics).To(HaveLen(1)) + + // UTF-16 should be properly converted to UTF-8 + Expect(lyrics[0].Synced).To(BeTrue(), "UTF-16 encoded lyrics should be recognized as synced") + Expect(lyrics[0].Line).To(HaveLen(2)) + Expect(lyrics[0].Line[0].Start).To(Equal(new(int64(18800)))) + Expect(lyrics[0].Line[0].Value).To(Equal("We're no strangers to love")) + Expect(lyrics[0].Line[1].Start).To(Equal(new(int64(22801)))) + Expect(lyrics[0].Line[1].Value).To(Equal("You know the rules and so do I")) + }) }) }) diff --git a/core/maintenance.go b/core/maintenance.go new file mode 100644 index 000000000..13d1141d3 --- /dev/null +++ b/core/maintenance.go @@ -0,0 +1,224 @@ +package core + +import ( + "context" + "fmt" + "slices" + "sync" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/slice" +) + +type Maintenance interface { + // DeleteMissingFiles deletes specific missing files by their IDs + DeleteMissingFiles(ctx context.Context, ids []string) error + // DeleteAllMissingFiles deletes all files marked as missing + DeleteAllMissingFiles(ctx context.Context) error +} + +type maintenanceService struct { + ds model.DataStore + wg sync.WaitGroup +} + +func NewMaintenance(ds model.DataStore) Maintenance { + return &maintenanceService{ + ds: ds, + } +} + +func (s *maintenanceService) DeleteMissingFiles(ctx context.Context, ids []string) error { + return s.deleteMissing(ctx, ids) +} + +func (s *maintenanceService) DeleteAllMissingFiles(ctx context.Context) error { + return s.deleteMissing(ctx, nil) +} + +// deleteMissing handles the deletion of missing files and triggers necessary cleanup operations +func (s *maintenanceService) deleteMissing(ctx context.Context, ids []string) error { + // Track affected album IDs before deletion for refresh + affectedAlbumIDs, err := s.getAffectedAlbumIDs(ctx, ids) + if err != nil { + log.Warn(ctx, "Error tracking affected albums for refresh", err) + // Don't fail the operation, just log the warning + } + + // Delete missing files within a transaction + err = s.ds.WithTx(func(tx model.DataStore) error { + if len(ids) == 0 { + _, err := tx.MediaFile(ctx).DeleteAllMissing() + return err + } + return tx.MediaFile(ctx).DeleteMissing(ids) + }) + if err != nil { + log.Error(ctx, "Error deleting missing tracks from DB", "ids", ids, err) + return err + } + + // Run garbage collection to clean up orphaned records + if err := s.ds.GC(ctx); err != nil { + log.Error(ctx, "Error running GC after deleting missing tracks", err) + return err + } + + // Refresh statistics in background + s.refreshStatsAsync(ctx, affectedAlbumIDs) + + return nil +} + +// refreshAlbums recalculates album attributes (size, duration, song count, etc.) from media files. +// It uses batch queries to minimize database round-trips for efficiency. +func (s *maintenanceService) refreshAlbums(ctx context.Context, albumIDs []string) error { + if len(albumIDs) == 0 { + return nil + } + + log.Debug(ctx, "Refreshing albums", "count", len(albumIDs)) + + // Process in chunks to avoid query size limits + const chunkSize = 100 + for chunk := range slice.CollectChunks(slices.Values(albumIDs), chunkSize) { + if err := s.refreshAlbumChunk(ctx, chunk); err != nil { + return fmt.Errorf("refreshing album chunk: %w", err) + } + } + + log.Debug(ctx, "Successfully refreshed albums", "count", len(albumIDs)) + return nil +} + +// refreshAlbumChunk processes a single chunk of album IDs +func (s *maintenanceService) refreshAlbumChunk(ctx context.Context, albumIDs []string) error { + albumRepo := s.ds.Album(ctx) + mfRepo := s.ds.MediaFile(ctx) + + // Batch load existing albums + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.id": albumIDs}, + }) + if err != nil { + return fmt.Errorf("loading albums: %w", err) + } + + // Create a map for quick lookup + albumMap := make(map[string]*model.Album, len(albums)) + for i := range albums { + albumMap[albums[i].ID] = &albums[i] + } + + // Batch load all media files for these albums + mediaFiles, err := mfRepo.GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album_id": albumIDs}, + Sort: "album_id, path", + }) + if err != nil { + return fmt.Errorf("loading media files: %w", err) + } + + // Group media files by album ID + filesByAlbum := make(map[string]model.MediaFiles) + for i := range mediaFiles { + albumID := mediaFiles[i].AlbumID + filesByAlbum[albumID] = append(filesByAlbum[albumID], mediaFiles[i]) + } + + // Recalculate each album from its media files + for albumID, oldAlbum := range albumMap { + mfs, hasTracks := filesByAlbum[albumID] + if !hasTracks { + // Album has no tracks anymore, skip (will be cleaned up by GC) + log.Debug(ctx, "Skipping album with no tracks", "albumID", albumID) + continue + } + + // Recalculate album from media files + newAlbum := mfs.ToAlbum() + + // Only update if something changed (avoid unnecessary writes) + if !oldAlbum.Equals(newAlbum) { + // Preserve original timestamps + newAlbum.UpdatedAt = time.Now() + newAlbum.CreatedAt = oldAlbum.CreatedAt + + if err := albumRepo.Put(&newAlbum); err != nil { + log.Error(ctx, "Error updating album during refresh", "albumID", albumID, err) + // Continue with other albums instead of failing entirely + continue + } + log.Trace(ctx, "Refreshed album", "albumID", albumID, "name", newAlbum.Name) + } + } + + return nil +} + +// getAffectedAlbumIDs returns distinct album IDs from missing media files +func (s *maintenanceService) getAffectedAlbumIDs(ctx context.Context, ids []string) ([]string, error) { + var filters squirrel.Sqlizer = squirrel.Eq{"missing": true} + if len(ids) > 0 { + filters = squirrel.And{ + squirrel.Eq{"missing": true}, + squirrel.Eq{"media_file.id": ids}, + } + } + + mfs, err := s.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: filters, + }) + if err != nil { + return nil, err + } + + // Extract unique album IDs + albumIDMap := make(map[string]struct{}, len(mfs)) + for _, mf := range mfs { + if mf.AlbumID != "" { + albumIDMap[mf.AlbumID] = struct{}{} + } + } + + albumIDs := make([]string, 0, len(albumIDMap)) + for id := range albumIDMap { + albumIDs = append(albumIDs, id) + } + + return albumIDs, nil +} + +// refreshStatsAsync refreshes artist and album statistics in background goroutines +func (s *maintenanceService) refreshStatsAsync(ctx context.Context, affectedAlbumIDs []string) { + // Refresh artist stats in background + s.wg.Go(func() { + bgCtx := request.AddValues(context.Background(), ctx) + if _, err := s.ds.Artist(bgCtx).RefreshStats(true); err != nil { + log.Error(bgCtx, "Error refreshing artist stats after deleting missing files", err) + } else { + log.Debug(bgCtx, "Successfully refreshed artist stats after deleting missing files") + } + + // Refresh album stats in background if we have affected albums + if len(affectedAlbumIDs) > 0 { + if err := s.refreshAlbums(bgCtx, affectedAlbumIDs); err != nil { + log.Error(bgCtx, "Error refreshing album stats after deleting missing files", err) + } else { + log.Debug(bgCtx, "Successfully refreshed album stats after deleting missing files", "count", len(affectedAlbumIDs)) + } + } + }) +} + +// Wait waits for all background goroutines to complete. +// WARNING: This method is ONLY for testing. Never call this in production code. +// Calling Wait() in production will block until ALL background operations complete +// and may cause race conditions with new operations starting. +func (s *maintenanceService) wait() { + s.wg.Wait() +} diff --git a/core/maintenance_test.go b/core/maintenance_test.go new file mode 100644 index 000000000..09b442438 --- /dev/null +++ b/core/maintenance_test.go @@ -0,0 +1,364 @@ +package core + +import ( + "context" + "errors" + "sync" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/sirupsen/logrus" +) + +var _ = Describe("Maintenance", func() { + var ds *tests.MockDataStore + var mfRepo *extendedMediaFileRepo + var service Maintenance + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + ctx = request.WithUser(ctx, model.User{ID: "user1", IsAdmin: true}) + + ds = createTestDataStore() + mfRepo = ds.MockedMediaFile.(*extendedMediaFileRepo) + service = NewMaintenance(ds) + }) + + Describe("DeleteMissingFiles", func() { + Context("with specific IDs", func() { + It("deletes specific missing files and runs GC", func() { + // Setup: mock missing files with album IDs + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album2", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf2"}) + + Expect(err).ToNot(HaveOccurred()) + Expect(mfRepo.deleteMissingCalled).To(BeTrue()) + Expect(mfRepo.deletedIDs).To(Equal([]string{"mf1", "mf2"})) + Expect(ds.GCCalled).To(BeTrue(), "GC should be called after deletion") + }) + + It("triggers artist stats refresh and album refresh after deletion", func() { + artistRepo := ds.MockedArtist.(*extendedArtistRepo) + // Setup: mock missing files with albums + albumRepo := ds.MockedAlbum.(*extendedAlbumRepo) + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Test Album", SongCount: 5}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: false, Size: 1000, Duration: 180}, + {ID: "mf3", AlbumID: "album1", Missing: false, Size: 2000, Duration: 200}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).ToNot(HaveOccurred()) + + // Wait for background goroutines to complete + service.(*maintenanceService).wait() + + // RefreshStats should be called + Expect(artistRepo.IsRefreshStatsCalled()).To(BeTrue(), "Artist stats should be refreshed") + + // Album should be updated with new calculated values + Expect(albumRepo.GetPutCallCount()).To(BeNumerically(">", 0), "Album.Put() should be called to refresh album data") + }) + + It("returns error if deletion fails", func() { + mfRepo.deleteMissingError = errors.New("delete failed") + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("delete failed")) + }) + + It("continues even if album tracking fails", func() { + mfRepo.SetError(true) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + // Should not fail, just log warning + Expect(err).ToNot(HaveOccurred()) + Expect(mfRepo.deleteMissingCalled).To(BeTrue()) + }) + + It("returns error if GC fails", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + }) + + // Set GC to return error + ds.GCError = errors.New("gc failed") + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("gc failed")) + }) + }) + + Context("album ID extraction", func() { + It("extracts unique album IDs from missing files", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: true}, + {ID: "mf3", AlbumID: "album2", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf2", "mf3"}) + + Expect(err).ToNot(HaveOccurred()) + }) + + It("skips files without album IDs", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf2"}) + + Expect(err).ToNot(HaveOccurred()) + }) + }) + }) + + Describe("DeleteAllMissingFiles", func() { + It("deletes all missing files and runs GC", func() { + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album2", Missing: true}, + {ID: "mf3", AlbumID: "album3", Missing: true}, + }) + + err := service.DeleteAllMissingFiles(ctx) + + Expect(err).ToNot(HaveOccurred()) + Expect(ds.GCCalled).To(BeTrue(), "GC should be called after deletion") + }) + + It("returns error if deletion fails", func() { + mfRepo.SetError(true) + + err := service.DeleteAllMissingFiles(ctx) + + Expect(err).To(HaveOccurred()) + }) + + It("handles empty result gracefully", func() { + mfRepo.SetData(model.MediaFiles{}) + + err := service.DeleteAllMissingFiles(ctx) + + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Album refresh logic", func() { + var albumRepo *extendedAlbumRepo + + BeforeEach(func() { + albumRepo = ds.MockedAlbum.(*extendedAlbumRepo) + }) + + Context("when album has no tracks after deletion", func() { + It("skips the album without updating it", func() { + // Setup album with no remaining tracks + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Empty Album", SongCount: 1}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + }) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + Expect(err).ToNot(HaveOccurred()) + + // Wait for background goroutines to complete + service.(*maintenanceService).wait() + + // Album should NOT be updated because it has no tracks left + Expect(albumRepo.GetPutCallCount()).To(Equal(0), "Album with no tracks should not be updated") + }) + }) + + Context("when Put fails for one album", func() { + It("continues processing other albums", func() { + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Album 1"}, + {ID: "album2", Name: "Album 2"}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + {ID: "mf2", AlbumID: "album1", Missing: false, Size: 1000, Duration: 180}, + {ID: "mf3", AlbumID: "album2", Missing: true}, + {ID: "mf4", AlbumID: "album2", Missing: false, Size: 2000, Duration: 200}, + }) + + // Make Put fail on first call but succeed on subsequent calls + albumRepo.putError = errors.New("put failed") + albumRepo.failOnce = true + + err := service.DeleteMissingFiles(ctx, []string{"mf1", "mf3"}) + + // Should not fail even if one album's Put fails + Expect(err).ToNot(HaveOccurred()) + + // Wait for background goroutines to complete + service.(*maintenanceService).wait() + + // Put should have been called multiple times + Expect(albumRepo.GetPutCallCount()).To(BeNumerically(">", 0), "Put should be attempted") + }) + }) + + Context("when media file loading fails", func() { + It("logs warning but continues when tracking affected albums fails", func() { + // Set up log capturing + hook, cleanup := tests.LogHook() + defer cleanup() + + albumRepo.SetData(model.Albums{ + {ID: "album1", Name: "Album 1"}, + }) + mfRepo.SetData(model.MediaFiles{ + {ID: "mf1", AlbumID: "album1", Missing: true}, + }) + // Make GetAll fail when loading media files + mfRepo.SetError(true) + + err := service.DeleteMissingFiles(ctx, []string{"mf1"}) + + // Deletion should succeed despite the tracking error + Expect(err).ToNot(HaveOccurred()) + Expect(mfRepo.deleteMissingCalled).To(BeTrue()) + + // Verify the warning was logged + Expect(hook.LastEntry()).ToNot(BeNil()) + Expect(hook.LastEntry().Level).To(Equal(logrus.WarnLevel)) + Expect(hook.LastEntry().Message).To(Equal("Error tracking affected albums for refresh")) + }) + }) + }) +}) + +// Test helper to create a mock DataStore with controllable behavior +func createTestDataStore() *tests.MockDataStore { + ds := &tests.MockDataStore{} + + // Create extended album repo with Put tracking + albumRepo := &extendedAlbumRepo{ + MockAlbumRepo: tests.CreateMockAlbumRepo(), + } + ds.MockedAlbum = albumRepo + + // Create extended artist repo with RefreshStats tracking + artistRepo := &extendedArtistRepo{ + MockArtistRepo: tests.CreateMockArtistRepo(), + } + ds.MockedArtist = artistRepo + + // Create extended media file repo with DeleteMissing support + mfRepo := &extendedMediaFileRepo{ + MockMediaFileRepo: tests.CreateMockMediaFileRepo(), + } + ds.MockedMediaFile = mfRepo + + return ds +} + +// Extension of MockMediaFileRepo to add DeleteMissing method +type extendedMediaFileRepo struct { + *tests.MockMediaFileRepo + deleteMissingCalled bool + deletedIDs []string + deleteMissingError error +} + +func (m *extendedMediaFileRepo) DeleteMissing(ids []string) error { + m.deleteMissingCalled = true + m.deletedIDs = ids + if m.deleteMissingError != nil { + return m.deleteMissingError + } + // Actually delete from the mock data + for _, id := range ids { + delete(m.Data, id) + } + return nil +} + +// Extension of MockAlbumRepo to track Put calls +type extendedAlbumRepo struct { + *tests.MockAlbumRepo + mu sync.RWMutex + putCallCount int + lastPutData *model.Album + putError error + failOnce bool +} + +func (m *extendedAlbumRepo) Put(album *model.Album) error { + m.mu.Lock() + m.putCallCount++ + m.lastPutData = album + + // Handle failOnce behavior + var err error + if m.putError != nil { + if m.failOnce { + err = m.putError + m.putError = nil // Clear error after first failure + m.mu.Unlock() + return err + } + err = m.putError + m.mu.Unlock() + return err + } + m.mu.Unlock() + + return m.MockAlbumRepo.Put(album) +} + +func (m *extendedAlbumRepo) GetPutCallCount() int { + m.mu.RLock() + defer m.mu.RUnlock() + return m.putCallCount +} + +// Extension of MockArtistRepo to track RefreshStats calls +type extendedArtistRepo struct { + *tests.MockArtistRepo + mu sync.RWMutex + refreshStatsCalled bool + refreshStatsError error +} + +func (m *extendedArtistRepo) RefreshStats(allArtists bool) (int64, error) { + m.mu.Lock() + m.refreshStatsCalled = true + err := m.refreshStatsError + m.mu.Unlock() + + if err != nil { + return 0, err + } + return m.MockArtistRepo.RefreshStats(allArtists) +} + +func (m *extendedArtistRepo) IsRefreshStatsCalled() bool { + m.mu.RLock() + defer m.mu.RUnlock() + return m.refreshStatsCalled +} diff --git a/core/matcher/matcher.go b/core/matcher/matcher.go new file mode 100644 index 000000000..54c2a368e --- /dev/null +++ b/core/matcher/matcher.go @@ -0,0 +1,522 @@ +package matcher + +import ( + "context" + "fmt" + "math" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/str" + "github.com/xrash/smetrics" +) + +// Matcher matches agent song results to local library tracks. +type Matcher struct { + ds model.DataStore +} + +// New creates a new Matcher with the given DataStore. +func New(ds model.DataStore) *Matcher { + return &Matcher{ds: ds} +} + +// MatchSongs matches agent song results to local library tracks using a multi-phase +// matching algorithm that prioritizes accuracy over recall. +// +// # Algorithm Overview +// +// The algorithm matches songs from external agents (Last.fm, Deezer, etc.) to tracks in the +// local music library using four matching strategies in priority order: +// +// 1. Direct ID match: Songs with an ID field are matched directly to MediaFiles by ID +// 2. MusicBrainz Recording ID (MBID) match: Songs with MBID are matched to tracks with +// matching mbz_recording_id +// 3. ISRC match: Songs with ISRC are matched to tracks with matching ISRC tag +// 4. Title+Artist fuzzy match: Remaining songs are matched using fuzzy string comparison +// with metadata specificity scoring +// +// # Matching Priority +// +// When selecting the final result, matches are prioritized in order: ID > MBID > ISRC > Title+Artist. +// This ensures that more reliable identifiers take precedence over fuzzy text matching. +// +// # Fuzzy Matching Details +// +// For title+artist matching, the algorithm uses Jaro-Winkler similarity (threshold configurable +// via Matcher.FuzzyThreshold, default 85%). Matches are ranked by: +// +// 1. Title similarity (Jaro-Winkler score, 0.0-1.0) +// 2. Duration proximity (closer duration = higher score, 1.0 if unknown) +// 3. Preferred track flag (enabled by Matcher.PreferStarred; prioritized when the track is +// starred or has rating >= 4) +// 4. Specificity level (0-5, based on metadata precision): +// - Level 5: Title + Artist MBID + Album MBID (most specific) +// - Level 4: Title + Artist MBID + Album name (fuzzy) +// - Level 3: Title + Artist name + Album name (fuzzy) +// - Level 2: Title + Artist MBID +// - Level 1: Title + Artist name +// - Level 0: Title only +// 5. Album similarity (Jaro-Winkler, as final tiebreaker) +// +// # Examples +// +// Example 1 - MBID Priority: +// +// Agent returns: {Name: "Paranoid Android", MBID: "abc-123", Artist: "Radiohead"} +// Library has: [ +// {ID: "t1", Title: "Paranoid Android", MbzRecordingID: "abc-123"}, +// {ID: "t2", Title: "Paranoid Android", Artist: "Radiohead"}, +// ] +// Result: t1 (MBID match takes priority over title+artist) +// +// Example 2 - ISRC Priority: +// +// Agent returns: {Name: "Paranoid Android", ISRC: "GBAYE0000351", Artist: "Radiohead"} +// Library has: [ +// {ID: "t1", Title: "Paranoid Android", Tags: {isrc: ["GBAYE0000351"]}}, +// {ID: "t2", Title: "Paranoid Android", Artist: "Radiohead"}, +// ] +// Result: t1 (ISRC match takes priority over title+artist) +// +// Example 3 - Specificity Ranking: +// +// Agent returns: {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"} +// Library has: [ +// {ID: "t1", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "101"}, // Level 1 +// {ID: "t2", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, // Level 3 +// ] +// Result: t2 (Level 3 beats Level 1 due to album match) +// +// Example 4 - Fuzzy Title Matching: +// +// Agent returns: {Name: "Bohemian Rhapsody", Artist: "Queen"} +// Library has: {ID: "t1", Title: "Bohemian Rhapsody - Remastered", Artist: "Queen"} +// With threshold=85%: Match succeeds (similarity ~0.87) +// With threshold=100%: No match (not exact) +// +// # Parameters +// +// - ctx: Context for database operations +// - songs: Slice of agent.Song results from external providers +// - count: Maximum number of matches to return +// +// # Returns +// +// Returns up to 'count' MediaFiles from the library that best match the input songs, +// preserving the original order from the agent. Songs that cannot be matched are skipped. +func (m *Matcher) MatchSongs(ctx context.Context, songs []agents.Song, count int) (model.MediaFiles, error) { + if len(songs) == 0 { + return nil, nil + } + + byID, byMBID, byISRC, byTitle, err := m.loadAllMatches(ctx, songs) + if err != nil { + return nil, err + } + return m.selectBestMatchingSongs(songs, byID, byMBID, byISRC, byTitle, count), nil +} + +// MatchSongsIndexed matches agent song results to local library tracks and returns a map +// from input song index to matched MediaFile. Songs that cannot be matched are omitted from the map. +// This preserves original indices, allowing callers to correlate results back to the input slice. +func (m *Matcher) MatchSongsIndexed(ctx context.Context, songs []agents.Song) (map[int]model.MediaFile, error) { + if len(songs) == 0 { + return nil, nil + } + + byID, byMBID, byISRC, byTitle, err := m.loadAllMatches(ctx, songs) + if err != nil { + return nil, err + } + + result := make(map[int]model.MediaFile, len(songs)) + for i, t := range songs { + if mf, found := findMatchingTrack(t, byID, byMBID, byISRC, byTitle); found { + result[i] = mf + } + } + return result, nil +} + +func (m *Matcher) loadAllMatches(ctx context.Context, songs []agents.Song) (byID, byMBID, byISRC, byTitle map[string]model.MediaFile, err error) { + byID, err = m.loadTracksByID(ctx, songs) + if err != nil { + return nil, nil, nil, nil, fmt.Errorf("failed to load tracks by ID: %w", err) + } + byMBID, err = m.loadTracksByMBID(ctx, songs, byID) + if err != nil { + return nil, nil, nil, nil, fmt.Errorf("failed to load tracks by MBID: %w", err) + } + byISRC, err = m.loadTracksByISRC(ctx, songs, byID, byMBID) + if err != nil { + return nil, nil, nil, nil, fmt.Errorf("failed to load tracks by ISRC: %w", err) + } + byTitle, err = m.loadTracksByTitleAndArtist(ctx, songs, byID, byMBID, byISRC) + if err != nil { + return nil, nil, nil, nil, fmt.Errorf("failed to load tracks by title: %w", err) + } + return byID, byMBID, byISRC, byTitle, nil +} + +// songMatchedIn checks if a song has already been matched in any of the provided match maps. +func songMatchedIn(s agents.Song, priorMatches ...map[string]model.MediaFile) bool { + _, found := lookupByIdentifiers(s, priorMatches...) + return found +} + +// lookupByIdentifiers searches for a song's identifiers (ID, MBID, ISRC) in the provided maps. +func lookupByIdentifiers(s agents.Song, maps ...map[string]model.MediaFile) (model.MediaFile, bool) { + keys := []string{s.ID, s.MBID, s.ISRC} + for _, m := range maps { + for _, key := range keys { + if key != "" { + if mf, ok := m[key]; ok && mf.ID != "" { + return mf, true + } + } + } + } + return model.MediaFile{}, false +} + +// loadTracksByID fetches MediaFiles from the library using direct ID matching. +func (m *Matcher) loadTracksByID(ctx context.Context, songs []agents.Song) (map[string]model.MediaFile, error) { + var ids []string + for _, s := range songs { + if s.ID != "" { + ids = append(ids, s.ID) + } + } + matches := map[string]model.MediaFile{} + if len(ids) == 0 { + return matches, nil + } + res, err := m.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"media_file.id": ids}, + squirrel.Eq{"missing": false}, + }, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + if _, ok := matches[mf.ID]; !ok { + matches[mf.ID] = mf + } + } + return matches, nil +} + +// loadTracksByMBID fetches MediaFiles from the library using MusicBrainz Recording IDs. +func (m *Matcher) loadTracksByMBID(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + var mbids []string + for _, s := range songs { + if s.MBID != "" && !songMatchedIn(s, priorMatches...) { + mbids = append(mbids, s.MBID) + } + } + matches := map[string]model.MediaFile{} + if len(mbids) == 0 { + return matches, nil + } + res, err := m.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"mbz_recording_id": mbids}, + squirrel.Eq{"missing": false}, + }, + }) + if err != nil { + return matches, err + } + for _, mf := range res { + if id := mf.MbzRecordingID; id != "" { + if _, ok := matches[id]; !ok { + matches[id] = mf + } + } + } + return matches, nil +} + +// loadTracksByISRC fetches MediaFiles from the library using ISRC matching. +func (m *Matcher) loadTracksByISRC(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + var isrcs []string + for _, s := range songs { + if s.ISRC != "" && !songMatchedIn(s, priorMatches...) { + isrcs = append(isrcs, s.ISRC) + } + } + matches := map[string]model.MediaFile{} + if len(isrcs) == 0 { + return matches, nil + } + res, err := m.ds.MediaFile(ctx).GetAllByTags(model.TagISRC, isrcs, model.QueryOptions{ + Filters: squirrel.Eq{"missing": false}, + Sort: "starred desc, rating desc, year asc, compilation asc", + }) + if err != nil { + return matches, err + } + for _, mf := range res { + for _, isrc := range mf.Tags.Values(model.TagISRC) { + if _, ok := matches[isrc]; !ok { + matches[isrc] = mf + } + } + } + return matches, nil +} + +// songQuery represents a normalized query for matching a song to library tracks. +type songQuery struct { + title string + artist string + artistMBID string + album string + albumMBID string + durationMs uint32 +} + +// matchScore combines title/album similarity with metadata specificity for ranking matches. +type matchScore struct { + titleSimilarity float64 + durationProximity float64 + preferredMatch bool + albumSimilarity float64 + specificityLevel int +} + +// betterThan returns true if this score beats another. +func (s matchScore) betterThan(other matchScore) bool { + if s.titleSimilarity != other.titleSimilarity { + return s.titleSimilarity > other.titleSimilarity + } + if s.durationProximity != other.durationProximity { + return s.durationProximity > other.durationProximity + } + if s.preferredMatch != other.preferredMatch { + return s.preferredMatch + } + if s.specificityLevel != other.specificityLevel { + return s.specificityLevel > other.specificityLevel + } + return s.albumSimilarity > other.albumSimilarity +} + +// sanitizedTrack holds pre-sanitized fields for a media file, avoiding redundant sanitization +// when the same track is scored against multiple queries in the inner loop. The `mf` field +// is a pointer to avoid copying the large MediaFile struct into each entry of the per-artist +// sanitized slice. +type sanitizedTrack struct { + mf *model.MediaFile + title string + artist string + album string +} + +func newSanitizedTrack(mf *model.MediaFile) sanitizedTrack { + return sanitizedTrack{ + mf: mf, + title: str.SanitizeFieldForSorting(mf.Title), + artist: str.SanitizeFieldForSortingNoArticle(mf.Artist), + album: str.SanitizeFieldForSorting(mf.Album), + } +} + +// computeSpecificityLevel determines how well query metadata matches a track (0-5). +// The track's title, artist, and album fields must be pre-sanitized. +func computeSpecificityLevel(q songQuery, t sanitizedTrack, albumThreshold float64) int { + if q.artistMBID != "" && q.albumMBID != "" && + t.mf.MbzArtistID == q.artistMBID && t.mf.MbzAlbumID == q.albumMBID { + return 5 + } + if q.artistMBID != "" && q.album != "" && + t.mf.MbzArtistID == q.artistMBID && similarityRatio(t.album, q.album) >= albumThreshold { + return 4 + } + if q.artist != "" && q.album != "" && + t.artist == q.artist && similarityRatio(t.album, q.album) >= albumThreshold { + return 3 + } + if q.artistMBID != "" && t.mf.MbzArtistID == q.artistMBID { + return 2 + } + if q.artist != "" && t.artist == q.artist { + return 1 + } + if t.title == q.title { + return 0 + } + return -1 +} + +// loadTracksByTitleAndArtist loads tracks matching by title with optional artist/album filtering. +func (m *Matcher) loadTracksByTitleAndArtist(ctx context.Context, songs []agents.Song, priorMatches ...map[string]model.MediaFile) (map[string]model.MediaFile, error) { + queries := m.buildTitleQueries(songs, priorMatches...) + if len(queries) == 0 { + return map[string]model.MediaFile{}, nil + } + + threshold := float64(conf.Server.Matcher.FuzzyThreshold) / 100.0 + + byArtist := map[string][]songQuery{} + for _, q := range queries { + if q.artist != "" { + byArtist[q.artist] = append(byArtist[q.artist], q) + } + } + + matches := map[string]model.MediaFile{} + for artist, artistQueries := range byArtist { + tracks, err := m.ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"order_artist_name": artist}, + squirrel.Eq{"missing": false}, + }, + Sort: "starred desc, rating desc, year asc, compilation asc", + }) + if err != nil { + continue + } + + sanitized := make([]sanitizedTrack, len(tracks)) + for i := range tracks { + sanitized[i] = newSanitizedTrack(&tracks[i]) + } + + for _, q := range artistQueries { + if mf, found := m.findBestMatch(q, sanitized, threshold); found { + key := q.title + "|" + q.artist + if _, exists := matches[key]; !exists { + matches[key] = mf + } + } + } + } + return matches, nil +} + +// durationProximity returns a score from 0.0 to 1.0 indicating how close the track's duration +// is to the target. Returns 1.0 if durationMs is 0 (unknown). +func durationProximity(durationMs uint32, mediaFileDurationSec float32) float64 { + if durationMs == 0 { + return 1.0 + } + durationSec := float64(durationMs) / 1000.0 + diff := math.Abs(durationSec - float64(mediaFileDurationSec)) + return 1.0 / (1.0 + diff) +} + +// findBestMatch finds the best matching track using combined title/album similarity and specificity scoring. +func (m *Matcher) findBestMatch(q songQuery, sanitizedTracks []sanitizedTrack, threshold float64) (model.MediaFile, bool) { + var bestMatch model.MediaFile + bestScore := matchScore{titleSimilarity: -1} + found := false + + for _, t := range sanitizedTracks { + titleSim := similarityRatio(q.title, t.title) + + if titleSim < threshold { + continue + } + + var albumSim float64 + if q.album != "" { + albumSim = similarityRatio(q.album, t.album) + } + + score := matchScore{ + titleSimilarity: titleSim, + durationProximity: durationProximity(q.durationMs, t.mf.Duration), + preferredMatch: conf.Server.Matcher.PreferStarred && isPreferredTrack(t.mf), + albumSimilarity: albumSim, + specificityLevel: computeSpecificityLevel(q, t, threshold), + } + + if score.betterThan(bestScore) { + bestScore = score + bestMatch = *t.mf + found = true + } + } + return bestMatch, found +} + +func isPreferredTrack(mf *model.MediaFile) bool { + return mf.Starred || mf.Rating >= 4 +} + +// buildTitleQueries converts agent songs into normalized songQuery structs for title+artist matching. +func (m *Matcher) buildTitleQueries(songs []agents.Song, priorMatches ...map[string]model.MediaFile) []songQuery { + var queries []songQuery + for _, s := range songs { + if songMatchedIn(s, priorMatches...) { + continue + } + queries = append(queries, songQuery{ + title: str.SanitizeFieldForSorting(s.Name), + artist: str.SanitizeFieldForSortingNoArticle(s.Artist), + artistMBID: s.ArtistMBID, + album: str.SanitizeFieldForSorting(s.Album), + albumMBID: s.AlbumMBID, + durationMs: s.Duration, + }) + } + return queries +} + +// selectBestMatchingSongs assembles the final result by mapping input songs to their best matching +// library tracks using priority order: ID > MBID > ISRC > title+artist. +func (m *Matcher) selectBestMatchingSongs(songs []agents.Song, byID, byMBID, byISRC, byTitleArtist map[string]model.MediaFile, count int) model.MediaFiles { + mfs := make(model.MediaFiles, 0, len(songs)) + addedBy := make(map[string]agents.Song, len(songs)) + + for _, t := range songs { + if len(mfs) == count { + break + } + + mf, found := findMatchingTrack(t, byID, byMBID, byISRC, byTitleArtist) + if !found { + continue + } + + if prevSong, alreadyAdded := addedBy[mf.ID]; alreadyAdded { + if t != prevSong { + continue + } + } else { + addedBy[mf.ID] = t + } + + mfs = append(mfs, mf) + } + return mfs +} + +// findMatchingTrack looks up a song in the match maps using priority order. +func findMatchingTrack(t agents.Song, byID, byMBID, byISRC, byTitleArtist map[string]model.MediaFile) (model.MediaFile, bool) { + if mf, found := lookupByIdentifiers(t, byID, byMBID, byISRC); found { + return mf, true + } + key := str.SanitizeFieldForSorting(t.Name) + "|" + str.SanitizeFieldForSortingNoArticle(t.Artist) + if mf, ok := byTitleArtist[key]; ok { + return mf, true + } + return model.MediaFile{}, false +} + +// similarityRatio calculates the similarity between two strings using Jaro-Winkler algorithm. +func similarityRatio(a, b string) float64 { + if a == b { + return 1.0 + } + if len(a) == 0 || len(b) == 0 { + return 0.0 + } + return smetrics.JaroWinkler(a, b, 0.7, 4) +} diff --git a/core/matcher/matcher_internal_test.go b/core/matcher/matcher_internal_test.go new file mode 100644 index 000000000..f111364c1 --- /dev/null +++ b/core/matcher/matcher_internal_test.go @@ -0,0 +1,53 @@ +package matcher + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("similarityRatio", func() { + It("returns 1.0 for identical strings", func() { + Expect(similarityRatio("hello", "hello")).To(BeNumerically("==", 1.0)) + }) + + It("returns 0.0 for empty strings", func() { + Expect(similarityRatio("", "test")).To(BeNumerically("==", 0.0)) + Expect(similarityRatio("test", "")).To(BeNumerically("==", 0.0)) + }) + + It("returns high similarity for remastered suffix", func() { + ratio := similarityRatio("paranoid android", "paranoid android remastered") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns high similarity for suffix additions like (Live)", func() { + ratio := similarityRatio("bohemian rhapsody", "bohemian rhapsody live") + Expect(ratio).To(BeNumerically(">=", 0.90)) + }) + + It("returns high similarity for 'yesterday' variants (common prefix)", func() { + ratio := similarityRatio("yesterday", "yesterday once more") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns low similarity for same suffix", func() { + ratio := similarityRatio("postman (live)", "taxman (live)") + Expect(ratio).To(BeNumerically("<", 0.85)) + }) + + It("handles unicode characters", func() { + ratio := similarityRatio("dont stop believin", "don't stop believin'") + Expect(ratio).To(BeNumerically(">=", 0.85)) + }) + + It("returns low similarity for completely different strings", func() { + ratio := similarityRatio("abc", "xyz") + Expect(ratio).To(BeNumerically("<", 0.5)) + }) + + It("is symmetric", func() { + ratio1 := similarityRatio("hello world", "hello") + ratio2 := similarityRatio("hello", "hello world") + Expect(ratio1).To(Equal(ratio2)) + }) +}) diff --git a/core/matcher/matcher_suite_test.go b/core/matcher/matcher_suite_test.go new file mode 100644 index 000000000..44877a3c8 --- /dev/null +++ b/core/matcher/matcher_suite_test.go @@ -0,0 +1,17 @@ +package matcher_test + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestMatcher(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Matcher Suite") +} diff --git a/core/matcher/matcher_test.go b/core/matcher/matcher_test.go new file mode 100644 index 000000000..42e3ec88d --- /dev/null +++ b/core/matcher/matcher_test.go @@ -0,0 +1,897 @@ +package matcher_test + +import ( + "context" + "errors" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/matcher" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/stretchr/testify/mock" +) + +var _ = Describe("Matcher", func() { + var ds model.DataStore + var mediaFileRepo *mockMediaFileRepo + var ctx context.Context + var m *matcher.Matcher + + BeforeEach(func() { + ctx = GinkgoT().Context() + DeferCleanup(configtest.SetupConfig()) + mediaFileRepo = newMockMediaFileRepo() + DeferCleanup(func() { + mediaFileRepo.AssertExpectations(GinkgoT()) + }) + ds = &tests.MockDataStore{ + MockedMediaFile: mediaFileRepo, + } + m = matcher.New(ds) + }) + + // Per-phase expectation helpers. Each `expect*Phase` registers a .Once() expectation + // that will fail the suite via AssertExpectations if the phase is NOT called. Tests + // use these to deterministically verify which matching phases fire. Phases that may + // or may not fire should use the `allow*Phase` variants instead, which register + // .Maybe() fallbacks. + expectIDPhase := func(matches model.MediaFiles) { + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInAnd("media_file.id"))). + Return(matches, nil).Once() + } + expectMBIDPhase := func(matches model.MediaFiles) { + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInAnd("mbz_recording_id"))). + Return(matches, nil).Once() + } + expectISRCPhase := func(matches model.MediaFiles) { + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInEq("missing"))). + Return(matches, nil).Once() + } + + // allowOtherPhases installs .Maybe() catch-alls so phases that short-circuit (return + // early without hitting the DB) don't cause test failures for unexpected calls. Call + // this after expect*Phase for the phases the test actually wants to verify. + allowOtherPhases := func() { + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInAnd("media_file.id"))). + Return(model.MediaFiles{}, nil).Maybe() + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInAnd("mbz_recording_id"))). + Return(model.MediaFiles{}, nil).Maybe() + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInEq("missing"))). + Return(model.MediaFiles{}, nil).Maybe() + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInAnd("order_artist_name"))). + Return(model.MediaFiles{}, nil).Maybe() + } + + // setupTitleOnlyExpectations is a convenience for fuzzy-match tests that only exercise + // the title+artist phase. The title phase uses .Maybe() because it may short-circuit + // when no songs have an artist. + setupTitleOnlyExpectations := func(artistTracks model.MediaFiles) { + mediaFileRepo.On("GetAll", mock.MatchedBy(matchFieldInAnd("order_artist_name"))). + Return(artistTracks, nil).Maybe() + } + + Describe("MatchSongs", func() { + Context("matching by direct ID", func() { + It("matches songs with an ID field to MediaFiles by ID", func() { + conf.Server.Matcher.FuzzyThreshold = 100 + songs := []agents.Song{ + {ID: "track-1", Name: "Some Song", Artist: "Some Artist"}, + } + idMatch := model.MediaFile{ + ID: "track-1", Title: "Some Song", Artist: "Some Artist", + } + expectIDPhase(model.MediaFiles{idMatch}) + allowOtherPhases() + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("track-1")) + }) + }) + + Context("matching by MBID", func() { + It("matches songs with MBID to tracks with matching mbz_recording_id", func() { + conf.Server.Matcher.FuzzyThreshold = 100 + songs := []agents.Song{ + {Name: "Paranoid Android", MBID: "abc-123", Artist: "Radiohead"}, + } + mbidMatch := model.MediaFile{ + ID: "track-mbid", Title: "Paranoid Android", Artist: "Radiohead", + MbzRecordingID: "abc-123", + } + expectMBIDPhase(model.MediaFiles{mbidMatch}) + allowOtherPhases() + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("track-mbid")) + }) + }) + + Context("matching by ISRC", func() { + It("matches songs with ISRC to tracks with matching ISRC tag", func() { + conf.Server.Matcher.FuzzyThreshold = 100 + songs := []agents.Song{ + {Name: "Paranoid Android", ISRC: "GBAYE0000351", Artist: "Radiohead"}, + } + isrcMatch := model.MediaFile{ + ID: "track-isrc", Title: "Paranoid Android", Artist: "Radiohead", + Tags: model.Tags{model.TagISRC: []string{"GBAYE0000351"}}, + } + expectISRCPhase(model.MediaFiles{isrcMatch}) + allowOtherPhases() + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("track-isrc")) + }) + }) + + Context("fuzzy title+artist matching", func() { + It("matches songs by title and artist name", func() { + conf.Server.Matcher.FuzzyThreshold = 100 + songs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode"}, + } + titleMatch := model.MediaFile{ + ID: "track-title", Title: "Enjoy the Silence", Artist: "Depeche Mode", + } + setupTitleOnlyExpectations(model.MediaFiles{titleMatch}) + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("track-title")) + }) + + It("matches songs with fuzzy title similarity", func() { + conf.Server.Matcher.FuzzyThreshold = 85 + songs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen"}, + } + fuzzyMatch := model.MediaFile{ + ID: "track-fuzzy", Title: "Bohemian Rhapsody (Live)", Artist: "Queen", + } + setupTitleOnlyExpectations(model.MediaFiles{fuzzyMatch}) + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("track-fuzzy")) + }) + + It("does not match completely different titles", func() { + conf.Server.Matcher.FuzzyThreshold = 85 + songs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles"}, + } + differentTracks := model.MediaFiles{ + {ID: "different", Title: "Tomorrow Never Knows", Artist: "The Beatles"}, + } + setupTitleOnlyExpectations(differentTracks) + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeEmpty()) + }) + }) + + Context("deduplication", func() { + It("removes duplicates when different input songs match the same library track", func() { + conf.Server.Matcher.FuzzyThreshold = 85 + songs := []agents.Song{ + {Name: "Bohemian Rhapsody (Live)", Artist: "Queen"}, + {Name: "Bohemian Rhapsody (Original Mix)", Artist: "Queen"}, + } + libraryTrack := model.MediaFile{ + ID: "br-live", Title: "Bohemian Rhapsody (Live)", Artist: "Queen", + } + setupTitleOnlyExpectations(model.MediaFiles{libraryTrack}) + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("br-live")) + }) + + It("preserves duplicates when identical input songs match the same library track", func() { + conf.Server.Matcher.FuzzyThreshold = 85 + songs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + } + libraryTrack := model.MediaFile{ + ID: "br", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera", + } + setupTitleOnlyExpectations(model.MediaFiles{libraryTrack}) + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(2)) + Expect(result[0].ID).To(Equal("br")) + Expect(result[1].ID).To(Equal("br")) + }) + }) + + Context("priority ordering", func() { + It("prefers ID match over MBID match", func() { + conf.Server.Matcher.FuzzyThreshold = 100 + // Song has both ID and MBID set. The matcher should resolve via ID + // and short-circuit the MBID phase entirely, so no MBID fetch should + // occur even though an mbz_recording_id exists in the input. + songs := []agents.Song{ + {ID: "track-id", Name: "Song", MBID: "mbid-1", Artist: "Artist"}, + } + idMatch := model.MediaFile{ + ID: "track-id", Title: "Song", Artist: "Artist", + } + expectIDPhase(model.MediaFiles{idMatch}) + allowOtherPhases() + result, err := m.MatchSongs(ctx, songs, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("track-id")) + }) + }) + + Context("count limit", func() { + It("returns at most 'count' results", func() { + conf.Server.Matcher.FuzzyThreshold = 100 + songs := []agents.Song{ + {Name: "Song A", Artist: "Artist"}, + {Name: "Song B", Artist: "Artist"}, + {Name: "Song C", Artist: "Artist"}, + } + tracks := model.MediaFiles{ + {ID: "a", Title: "Song A", Artist: "Artist"}, + {ID: "b", Title: "Song B", Artist: "Artist"}, + {ID: "c", Title: "Song C", Artist: "Artist"}, + } + setupTitleOnlyExpectations(tracks) + result, err := m.MatchSongs(ctx, songs, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(2)) + }) + }) + + Context("empty input", func() { + It("returns empty results for no songs", func() { + result, err := m.MatchSongs(ctx, []agents.Song{}, 5) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeEmpty()) + }) + }) + }) + + Describe("MatchSongsIndexed", func() { + It("returns index-keyed map of matched songs", func() { + songs := []agents.Song{ + {ID: "track-1", Name: "Song One", Artist: "Artist A"}, + {ID: "track-2", Name: "Song Two", Artist: "Artist B"}, + {ID: "track-3", Name: "Song Three", Artist: "Artist C"}, + } + mf1 := model.MediaFile{ID: "track-1", Title: "Song One", Artist: "Artist A"} + mf2 := model.MediaFile{ID: "track-2", Title: "Song Two", Artist: "Artist B"} + + expectIDPhase(model.MediaFiles{mf1, mf2}) + allowOtherPhases() + + result, err := m.MatchSongsIndexed(ctx, songs) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(2)) + Expect(result[0].ID).To(Equal("track-1")) + Expect(result[1].ID).To(Equal("track-2")) + _, exists := result[2] + Expect(exists).To(BeFalse()) + }) + + It("preserves original indices when some songs don't match", func() { + songs := []agents.Song{ + {Name: "Unknown Song", Artist: "Unknown Artist"}, + {ID: "track-1", Name: "Known Song", Artist: "Known Artist"}, + } + mf1 := model.MediaFile{ID: "track-1", Title: "Known Song", Artist: "Known Artist"} + + expectIDPhase(model.MediaFiles{mf1}) + allowOtherPhases() + + result, err := m.MatchSongsIndexed(ctx, songs) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + _, exists := result[0] + Expect(exists).To(BeFalse()) + Expect(result[1].ID).To(Equal("track-1")) + }) + + It("returns empty map for empty input", func() { + result, err := m.MatchSongsIndexed(ctx, nil) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeEmpty()) + }) + }) + + Describe("specificity level matching", func() { + BeforeEach(func() { + conf.Server.Matcher.FuzzyThreshold = 100 + }) + + It("matches by title + artist MBID + album MBID (highest priority)", func() { + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "Depeche Mode", Album: "Violator", + MbzArtistID: "artist-mbid-123", MbzAlbumID: "album-mbid-456", + } + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Depeche Mode", Album: "Some Other Album", + MbzArtistID: "artist-mbid-123", MbzAlbumID: "different-album-mbid", + } + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode", ArtistMBID: "artist-mbid-123", Album: "Violator", AlbumMBID: "album-mbid-456"}, + } + + setupTitleOnlyExpectations(model.MediaFiles{wrongMatch, correctMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("correct-match")) + }) + + It("matches by title + artist name + album name when MBIDs unavailable", func() { + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "depeche mode", Album: "violator", + } + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Other Artist", Album: "Other Album", + } + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode", Album: "Violator"}, + } + + setupTitleOnlyExpectations(model.MediaFiles{wrongMatch, correctMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("correct-match")) + }) + + It("matches by title + artist only when album info unavailable", func() { + correctMatch := model.MediaFile{ + ID: "correct-match", Title: "Similar Song", Artist: "depeche mode", Album: "Some Album", + } + wrongMatch := model.MediaFile{ + ID: "wrong-match", Title: "Similar Song", Artist: "Other Artist", Album: "Other Album", + } + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Depeche Mode"}, + } + + setupTitleOnlyExpectations(model.MediaFiles{wrongMatch, correctMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("correct-match")) + }) + + It("does not match songs without artist info", func() { + songs := []agents.Song{ + {Name: "Similar Song"}, + } + + setupTitleOnlyExpectations(model.MediaFiles{}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeEmpty()) + }) + + It("returns distinct matches for each artist's version (covers scenario)", func() { + cover1 := model.MediaFile{ID: "cover-1", Title: "Yesterday", Artist: "The Beatles", Album: "Help!"} + cover2 := model.MediaFile{ID: "cover-2", Title: "Yesterday", Artist: "Ray Charles", Album: "Greatest Hits"} + cover3 := model.MediaFile{ID: "cover-3", Title: "Yesterday", Artist: "Frank Sinatra", Album: "My Way"} + + songs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, + {Name: "Yesterday", Artist: "Ray Charles", Album: "Greatest Hits"}, + {Name: "Yesterday", Artist: "Frank Sinatra", Album: "My Way"}, + } + + setupTitleOnlyExpectations(model.MediaFiles{cover1, cover2, cover3}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(3)) + ids := []string{result[0].ID, result[1].ID, result[2].ID} + Expect(ids).To(ContainElements("cover-1", "cover-2", "cover-3")) + }) + + It("prefers more precise matches for each song", func() { + preciseMatch := model.MediaFile{ + ID: "precise", Title: "Song A", Artist: "Artist One", Album: "Album One", + MbzArtistID: "mbid-1", MbzAlbumID: "album-mbid-1", + } + lessAccurateMatch := model.MediaFile{ + ID: "less-accurate", Title: "Song A", Artist: "Artist One", Album: "Compilation", + MbzArtistID: "mbid-1", + } + artistTwoMatch := model.MediaFile{ + ID: "artist-two", Title: "Song B", Artist: "Artist Two", + } + + songs := []agents.Song{ + {Name: "Song A", Artist: "Artist One", ArtistMBID: "mbid-1", Album: "Album One", AlbumMBID: "album-mbid-1"}, + {Name: "Song B", Artist: "Artist Two"}, + } + + setupTitleOnlyExpectations(model.MediaFiles{lessAccurateMatch, preciseMatch, artistTwoMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(2)) + Expect(result[0].ID).To(Equal("precise")) + Expect(result[1].ID).To(Equal("artist-two")) + }) + }) + + Describe("fuzzy matching thresholds", func() { + Context("with default threshold (85%)", func() { + It("matches songs with remastered suffix", func() { + conf.Server.Matcher.FuzzyThreshold = 85 + + songs := []agents.Song{ + {Name: "Paranoid Android", Artist: "Radiohead"}, + } + artistTracks := model.MediaFiles{ + {ID: "remastered", Title: "Paranoid Android - Remastered", Artist: "Radiohead"}, + } + + setupTitleOnlyExpectations(artistTracks) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("remastered")) + }) + + It("matches songs with live suffix", func() { + conf.Server.Matcher.FuzzyThreshold = 85 + + songs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen"}, + } + artistTracks := model.MediaFiles{ + {ID: "live", Title: "Bohemian Rhapsody (Live)", Artist: "Queen"}, + } + + setupTitleOnlyExpectations(artistTracks) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("live")) + }) + }) + + Context("with threshold set to 100 (exact match only)", func() { + It("only matches exact titles", func() { + conf.Server.Matcher.FuzzyThreshold = 100 + + songs := []agents.Song{ + {Name: "Paranoid Android", Artist: "Radiohead"}, + } + artistTracks := model.MediaFiles{ + {ID: "remastered", Title: "Paranoid Android - Remastered", Artist: "Radiohead"}, + } + + setupTitleOnlyExpectations(artistTracks) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeEmpty()) + }) + }) + + Context("with lower threshold (75%)", func() { + It("matches more aggressively", func() { + conf.Server.Matcher.FuzzyThreshold = 75 + + songs := []agents.Song{ + {Name: "Song", Artist: "Artist"}, + } + artistTracks := model.MediaFiles{ + {ID: "extended", Title: "Song (Extended Mix)", Artist: "Artist"}, + } + + setupTitleOnlyExpectations(artistTracks) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("extended")) + }) + }) + }) + + Describe("fuzzy album matching", func() { + BeforeEach(func() { + conf.Server.Matcher.FuzzyThreshold = 85 + conf.Server.Matcher.PreferStarred = false + }) + + It("matches album with (Remaster) suffix", func() { + songs := []agents.Song{ + {Name: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera"}, + } + correctMatch := model.MediaFile{ + ID: "correct", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "A Night at the Opera (2011 Remaster)", + } + wrongMatch := model.MediaFile{ + ID: "wrong", Title: "Bohemian Rhapsody", Artist: "Queen", Album: "Greatest Hits", + } + + setupTitleOnlyExpectations(model.MediaFiles{wrongMatch, correctMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("correct")) + }) + + It("matches album with (Deluxe Edition) suffix", func() { + songs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + correctMatch := model.MediaFile{ + ID: "correct", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator (Deluxe Edition)", + } + wrongMatch := model.MediaFile{ + ID: "wrong", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "101", + } + + setupTitleOnlyExpectations(model.MediaFiles{wrongMatch, correctMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("correct")) + }) + + It("prefers exact album match over fuzzy album match", func() { + songs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + exactMatch := model.MediaFile{ + ID: "exact", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator", + } + fuzzyMatch := model.MediaFile{ + ID: "fuzzy", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator (Deluxe Edition)", + } + + setupTitleOnlyExpectations(model.MediaFiles{fuzzyMatch, exactMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("exact")) + }) + + It("prefers starred songs over better album match when enabled", func() { + conf.Server.Matcher.PreferStarred = true + songs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + albumMatch := model.MediaFile{ + ID: "album-match", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator", + } + starredTrack := model.MediaFile{ + ID: "starred", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Singles", Annotations: model.Annotations{Starred: true}, + } + + setupTitleOnlyExpectations(model.MediaFiles{albumMatch, starredTrack}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("starred")) + }) + + It("prefers 4-star songs over better album match when enabled", func() { + conf.Server.Matcher.PreferStarred = true + songs := []agents.Song{ + {Name: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator"}, + } + albumMatch := model.MediaFile{ + ID: "album-match", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Violator", + } + ratedTrack := model.MediaFile{ + ID: "rated", Title: "Enjoy the Silence", Artist: "Depeche Mode", Album: "Singles", Annotations: model.Annotations{Rating: 4}, + } + + setupTitleOnlyExpectations(model.MediaFiles{albumMatch, ratedTrack}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("rated")) + }) + }) + + Describe("duration matching", func() { + BeforeEach(func() { + conf.Server.Matcher.FuzzyThreshold = 100 + }) + + It("prefers tracks with matching duration", func() { + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + correctMatch := model.MediaFile{ + ID: "correct", Title: "Similar Song", Artist: "Test Artist", Duration: 180.0, + } + wrongDuration := model.MediaFile{ + ID: "wrong", Title: "Similar Song", Artist: "Test Artist", Duration: 240.0, + } + + setupTitleOnlyExpectations(model.MediaFiles{wrongDuration, correctMatch}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("correct")) + }) + + It("matches tracks with close duration", func() { + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + closeDuration := model.MediaFile{ + ID: "close-duration", Title: "Similar Song", Artist: "Test Artist", Duration: 182.5, + } + + setupTitleOnlyExpectations(model.MediaFiles{closeDuration}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("close-duration")) + }) + + It("prefers closer duration over farther duration", func() { + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + closeDuration := model.MediaFile{ + ID: "close", Title: "Similar Song", Artist: "Test Artist", Duration: 181.0, + } + farDuration := model.MediaFile{ + ID: "far", Title: "Similar Song", Artist: "Test Artist", Duration: 190.0, + } + + setupTitleOnlyExpectations(model.MediaFiles{farDuration, closeDuration}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("close")) + }) + + It("still matches when no tracks have matching duration", func() { + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + differentDuration := model.MediaFile{ + ID: "different", Title: "Similar Song", Artist: "Test Artist", Duration: 300.0, + } + + setupTitleOnlyExpectations(model.MediaFiles{differentDuration}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("different")) + }) + + It("prefers title match over duration match when titles differ", func() { + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 180000}, + } + differentTitle := model.MediaFile{ + ID: "wrong-title", Title: "Different Song", Artist: "Test Artist", Duration: 180.0, + } + correctTitle := model.MediaFile{ + ID: "correct-title", Title: "Similar Song", Artist: "Test Artist", Duration: 300.0, + } + + setupTitleOnlyExpectations(model.MediaFiles{differentTitle, correctTitle}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("correct-title")) + }) + + It("matches without duration filtering when agent duration is 0", func() { + songs := []agents.Song{ + {Name: "Similar Song", Artist: "Test Artist", Duration: 0}, + } + anyTrack := model.MediaFile{ + ID: "any", Title: "Similar Song", Artist: "Test Artist", Duration: 999.0, + } + + setupTitleOnlyExpectations(model.MediaFiles{anyTrack}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("any")) + }) + + It("handles very short songs with close duration", func() { + songs := []agents.Song{ + {Name: "Short Song", Artist: "Test Artist", Duration: 30000}, + } + shortTrack := model.MediaFile{ + ID: "short", Title: "Short Song", Artist: "Test Artist", Duration: 31.0, + } + + setupTitleOnlyExpectations(model.MediaFiles{shortTrack}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].ID).To(Equal("short")) + }) + }) + + Describe("deduplication edge cases", func() { + BeforeEach(func() { + conf.Server.Matcher.FuzzyThreshold = 85 + }) + + It("handles mixed scenario with both identical and different input songs", func() { + songs := []agents.Song{ + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, + {Name: "Yesterday (Remastered)", Artist: "The Beatles", Album: "1"}, + {Name: "Yesterday", Artist: "The Beatles", Album: "Help!"}, + {Name: "Yesterday (Anthology)", Artist: "The Beatles", Album: "Anthology"}, + } + libraryTrack := model.MediaFile{ + ID: "yesterday", Title: "Yesterday", Artist: "The Beatles", Album: "Help!", + } + + setupTitleOnlyExpectations(model.MediaFiles{libraryTrack}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(2)) + Expect(result[0].ID).To(Equal("yesterday")) + Expect(result[1].ID).To(Equal("yesterday")) + }) + + It("does not deduplicate songs that match different library tracks", func() { + songs := []agents.Song{ + {Name: "Song A", Artist: "Artist"}, + {Name: "Song B", Artist: "Artist"}, + {Name: "Song C", Artist: "Artist"}, + } + trackA := model.MediaFile{ID: "track-a", Title: "Song A", Artist: "Artist"} + trackB := model.MediaFile{ID: "track-b", Title: "Song B", Artist: "Artist"} + trackC := model.MediaFile{ID: "track-c", Title: "Song C", Artist: "Artist"} + + setupTitleOnlyExpectations(model.MediaFiles{trackA, trackB, trackC}) + + result, err := m.MatchSongs(ctx, songs, 5) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(3)) + Expect(result[0].ID).To(Equal("track-a")) + Expect(result[1].ID).To(Equal("track-b")) + Expect(result[2].ID).To(Equal("track-c")) + }) + + It("respects count limit after deduplication", func() { + songs := []agents.Song{ + {Name: "Song A", Artist: "Artist"}, + {Name: "Song A (Live)", Artist: "Artist"}, + {Name: "Song B", Artist: "Artist"}, + {Name: "Song B (Remix)", Artist: "Artist"}, + } + trackA := model.MediaFile{ID: "track-a", Title: "Song A", Artist: "Artist"} + trackB := model.MediaFile{ID: "track-b", Title: "Song B", Artist: "Artist"} + + setupTitleOnlyExpectations(model.MediaFiles{trackA, trackB}) + + result, err := m.MatchSongs(ctx, songs, 2) + + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(2)) + Expect(result[0].ID).To(Equal("track-a")) + Expect(result[1].ID).To(Equal("track-b")) + }) + }) +}) + +type mockMediaFileRepo struct { + mock.Mock + model.MediaFileRepository +} + +func newMockMediaFileRepo() *mockMediaFileRepo { + return &mockMediaFileRepo{} +} + +func (m *mockMediaFileRepo) GetAll(options ...model.QueryOptions) (model.MediaFiles, error) { + argsSlice := make([]any, len(options)) + for i, v := range options { + argsSlice[i] = v + } + args := m.Called(argsSlice...) + if args.Get(0) == nil { + return nil, args.Error(1) + } + return args.Get(0).(model.MediaFiles), args.Error(1) +} + +func (m *mockMediaFileRepo) GetAllByTags(_ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) { + return m.GetAll(options...) +} + +func (m *mockMediaFileRepo) SetError(hasError bool) { + if hasError { + m.On("GetAll", mock.Anything).Return(nil, errors.New("mock repo error")) + } +} + +// matchFieldInAnd returns a matcher that checks whether QueryOptions.Filters is a +// squirrel.And whose first element is a squirrel.Eq containing the given field name. +func matchFieldInAnd(fieldName string) func(opt model.QueryOptions) bool { + return func(opt model.QueryOptions) bool { + and, ok := opt.Filters.(squirrel.And) + if !ok || len(and) < 2 { + return false + } + eq, hasEq := and[0].(squirrel.Eq) + if !hasEq { + return false + } + _, hasField := eq[fieldName] + return hasField + } +} + +// matchFieldInEq returns a matcher that checks whether QueryOptions.Filters is a +// squirrel.Eq containing the given field name. +func matchFieldInEq(fieldName string) func(opt model.QueryOptions) bool { + return func(opt model.QueryOptions) bool { + eq, ok := opt.Filters.(squirrel.Eq) + if !ok { + return false + } + _, hasField := eq[fieldName] + return hasField + } +} diff --git a/core/media_streamer.go b/core/media_streamer.go deleted file mode 100644 index b3593c4eb..000000000 --- a/core/media_streamer.go +++ /dev/null @@ -1,214 +0,0 @@ -package core - -import ( - "context" - "fmt" - "io" - "mime" - "os" - "sync" - "time" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/ffmpeg" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/utils/cache" -) - -type MediaStreamer interface { - NewStream(ctx context.Context, id string, reqFormat string, reqBitRate int, offset int) (*Stream, error) - DoStream(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, reqOffset int) (*Stream, error) -} - -type TranscodingCache cache.FileCache - -func NewMediaStreamer(ds model.DataStore, t ffmpeg.FFmpeg, cache TranscodingCache) MediaStreamer { - return &mediaStreamer{ds: ds, transcoder: t, cache: cache} -} - -type mediaStreamer struct { - ds model.DataStore - transcoder ffmpeg.FFmpeg - cache cache.FileCache -} - -type streamJob struct { - ms *mediaStreamer - mf *model.MediaFile - filePath string - format string - bitRate int - offset int -} - -func (j *streamJob) Key() string { - return fmt.Sprintf("%s.%s.%d.%s.%d", j.mf.ID, j.mf.UpdatedAt.Format(time.RFC3339Nano), j.bitRate, j.format, j.offset) -} - -func (ms *mediaStreamer) NewStream(ctx context.Context, id string, reqFormat string, reqBitRate int, reqOffset int) (*Stream, error) { - mf, err := ms.ds.MediaFile(ctx).Get(id) - if err != nil { - return nil, err - } - - return ms.DoStream(ctx, mf, reqFormat, reqBitRate, reqOffset) -} - -func (ms *mediaStreamer) DoStream(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, reqOffset int) (*Stream, error) { - var format string - var bitRate int - var cached bool - defer func() { - log.Info(ctx, "Streaming file", "title", mf.Title, "artist", mf.Artist, "format", format, "cached", cached, - "bitRate", bitRate, "user", userName(ctx), "transcoding", format != "raw", - "originalFormat", mf.Suffix, "originalBitRate", mf.BitRate) - }() - - format, bitRate = selectTranscodingOptions(ctx, ms.ds, mf, reqFormat, reqBitRate) - s := &Stream{ctx: ctx, mf: mf, format: format, bitRate: bitRate} - filePath := mf.AbsolutePath() - - if format == "raw" { - log.Debug(ctx, "Streaming RAW file", "id", mf.ID, "path", filePath, - "requestBitrate", reqBitRate, "requestFormat", reqFormat, "requestOffset", reqOffset, - "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, - "selectedBitrate", bitRate, "selectedFormat", format) - f, err := os.Open(filePath) - if err != nil { - return nil, err - } - s.ReadCloser = f - s.Seeker = f - s.format = mf.Suffix - return s, nil - } - - job := &streamJob{ - ms: ms, - mf: mf, - filePath: filePath, - format: format, - bitRate: bitRate, - offset: reqOffset, - } - r, err := ms.cache.Get(ctx, job) - if err != nil { - log.Error(ctx, "Error accessing transcoding cache", "id", mf.ID, err) - return nil, err - } - cached = r.Cached - - s.ReadCloser = r - s.Seeker = r.Seeker - - log.Debug(ctx, "Streaming TRANSCODED file", "id", mf.ID, "path", filePath, - "requestBitrate", reqBitRate, "requestFormat", reqFormat, "requestOffset", reqOffset, - "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, - "selectedBitrate", bitRate, "selectedFormat", format, "cached", cached, "seekable", s.Seekable()) - - return s, nil -} - -type Stream struct { - ctx context.Context - mf *model.MediaFile - bitRate int - format string - io.ReadCloser - io.Seeker -} - -func (s *Stream) Seekable() bool { return s.Seeker != nil } -func (s *Stream) Duration() float32 { return s.mf.Duration } -func (s *Stream) ContentType() string { return mime.TypeByExtension("." + s.format) } -func (s *Stream) Name() string { return s.mf.Title + "." + s.format } -func (s *Stream) ModTime() time.Time { return s.mf.UpdatedAt } -func (s *Stream) EstimatedContentLength() int { - return int(s.mf.Duration * float32(s.bitRate) / 8 * 1024) -} - -// TODO This function deserves some love (refactoring) -func selectTranscodingOptions(ctx context.Context, ds model.DataStore, mf *model.MediaFile, reqFormat string, reqBitRate int) (format string, bitRate int) { - format = "raw" - if reqFormat == "raw" { - return format, 0 - } - if reqFormat == mf.Suffix && reqBitRate == 0 { - bitRate = mf.BitRate - return format, bitRate - } - trc, hasDefault := request.TranscodingFrom(ctx) - var cFormat string - var cBitRate int - if reqFormat != "" { - cFormat = reqFormat - } else { - if hasDefault { - cFormat = trc.TargetFormat - cBitRate = trc.DefaultBitRate - if p, ok := request.PlayerFrom(ctx); ok { - cBitRate = p.MaxBitRate - } - } else if reqBitRate > 0 && reqBitRate < mf.BitRate && conf.Server.DefaultDownsamplingFormat != "" { - // If no format is specified and no transcoding associated to the player, but a bitrate is specified, - // and there is no transcoding set for the player, we use the default downsampling format. - // But only if the requested bitRate is lower than the original bitRate. - log.Debug("Default Downsampling", "Using default downsampling format", conf.Server.DefaultDownsamplingFormat) - cFormat = conf.Server.DefaultDownsamplingFormat - } - } - if reqBitRate > 0 { - cBitRate = reqBitRate - } - if cBitRate == 0 && cFormat == "" { - return format, bitRate - } - t, err := ds.Transcoding(ctx).FindByFormat(cFormat) - if err == nil { - format = t.TargetFormat - if cBitRate != 0 { - bitRate = cBitRate - } else { - bitRate = t.DefaultBitRate - } - } - if format == mf.Suffix && bitRate >= mf.BitRate { - format = "raw" - bitRate = 0 - } - return format, bitRate -} - -var ( - onceTranscodingCache sync.Once - instanceTranscodingCache TranscodingCache -) - -func GetTranscodingCache() TranscodingCache { - onceTranscodingCache.Do(func() { - instanceTranscodingCache = NewTranscodingCache() - }) - return instanceTranscodingCache -} - -func NewTranscodingCache() TranscodingCache { - return cache.NewFileCache("Transcoding", conf.Server.TranscodingCacheSize, - consts.TranscodingCacheDir, consts.DefaultTranscodingCacheMaxItems, - func(ctx context.Context, arg cache.Item) (io.Reader, error) { - job := arg.(*streamJob) - t, err := job.ms.ds.Transcoding(ctx).FindByFormat(job.format) - if err != nil { - log.Error(ctx, "Error loading transcoding command", "format", job.format, err) - return nil, os.ErrInvalid - } - out, err := job.ms.transcoder.Transcode(ctx, t.Command, job.filePath, job.bitRate, job.offset) - if err != nil { - log.Error(ctx, "Error starting transcoder", "id", job.mf.ID, err) - return nil, os.ErrInvalid - } - return out, nil - }) -} diff --git a/core/media_streamer_Internal_test.go b/core/media_streamer_Internal_test.go deleted file mode 100644 index 44fbf701c..000000000 --- a/core/media_streamer_Internal_test.go +++ /dev/null @@ -1,162 +0,0 @@ -package core - -import ( - "context" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("MediaStreamer", func() { - var ds model.DataStore - ctx := log.NewContext(context.Background()) - - BeforeEach(func() { - ds = &tests.MockDataStore{MockedTranscoding: &tests.MockTranscodingRepo{}} - }) - - Context("selectTranscodingOptions", func() { - mf := &model.MediaFile{} - Context("player is not configured", func() { - It("returns raw if raw is requested", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "raw", 0) - Expect(format).To(Equal("raw")) - }) - It("returns raw if a transcoder does not exists", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "m4a", 0) - Expect(format).To(Equal("raw")) - }) - It("returns the requested format if a transcoder exists", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(160)) // Default Bit Rate - }) - It("returns raw if requested format is the same as the original and it is not necessary to downsample", func() { - mf.Suffix = "mp3" - mf.BitRate = 112 - format, _ := selectTranscodingOptions(ctx, ds, mf, "mp3", 128) - Expect(format).To(Equal("raw")) - }) - It("returns the requested format if requested BitRate is lower than original", func() { - mf.Suffix = "mp3" - mf.BitRate = 320 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 192) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(192)) - }) - It("returns raw if requested format is the same as the original, but requested BitRate is 0", func() { - mf.Suffix = "mp3" - mf.BitRate = 320 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("raw")) - Expect(bitRate).To(Equal(320)) - }) - Context("Downsampling", func() { - BeforeEach(func() { - conf.Server.DefaultDownsamplingFormat = "opus" - mf.Suffix = "FLAC" - mf.BitRate = 960 - }) - It("returns the DefaultDownsamplingFormat if a maxBitrate is requested but not the format", func() { - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 128) - Expect(format).To(Equal("opus")) - Expect(bitRate).To(Equal(128)) - }) - It("returns raw if maxBitrate is equal or greater than original", func() { - // This happens with DSub (and maybe other clients?). See https://github.com/navidrome/navidrome/issues/2066 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 960) - Expect(format).To(Equal("raw")) - Expect(bitRate).To(Equal(0)) - }) - }) - }) - - Context("player has format configured", func() { - BeforeEach(func() { - t := model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 96} - ctx = request.WithTranscoding(ctx, t) - }) - It("returns raw if raw is requested", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "raw", 0) - Expect(format).To(Equal("raw")) - }) - It("returns configured format/bitrate as default", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 0) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(96)) - }) - It("returns requested format", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(160)) // Default Bit Rate - }) - It("returns requested bitrate", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 80) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(80)) - }) - It("returns raw if selected bitrate and format is the same as original", func() { - mf.Suffix = "mp3" - mf.BitRate = 192 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 192) - Expect(format).To(Equal("raw")) - Expect(bitRate).To(Equal(0)) - }) - }) - - Context("player has maxBitRate configured", func() { - BeforeEach(func() { - t := model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 96} - p := model.Player{ID: "player1", TranscodingId: t.ID, MaxBitRate: 192} - ctx = request.WithTranscoding(ctx, t) - ctx = request.WithPlayer(ctx, p) - }) - It("returns raw if raw is requested", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, _ := selectTranscodingOptions(ctx, ds, mf, "raw", 0) - Expect(format).To(Equal("raw")) - }) - It("returns configured format/bitrate as default", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 0) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(192)) - }) - It("returns requested format", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "mp3", 0) - Expect(format).To(Equal("mp3")) - Expect(bitRate).To(Equal(160)) // Default Bit Rate - }) - It("returns requested bitrate", func() { - mf.Suffix = "flac" - mf.BitRate = 1000 - format, bitRate := selectTranscodingOptions(ctx, ds, mf, "", 160) - Expect(format).To(Equal("oga")) - Expect(bitRate).To(Equal(160)) - }) - }) - }) -}) diff --git a/core/media_streamer_test.go b/core/media_streamer_test.go deleted file mode 100644 index f5175495b..000000000 --- a/core/media_streamer_test.go +++ /dev/null @@ -1,74 +0,0 @@ -package core_test - -import ( - "context" - "io" - "os" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/core" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("MediaStreamer", func() { - var streamer core.MediaStreamer - var ds model.DataStore - ffmpeg := tests.NewMockFFmpeg("fake data") - ctx := log.NewContext(context.TODO()) - - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - conf.Server.CacheFolder, _ = os.MkdirTemp("", "file_caches") - conf.Server.TranscodingCacheSize = "100MB" - ds = &tests.MockDataStore{MockedTranscoding: &tests.MockTranscodingRepo{}} - ds.MediaFile(ctx).(*tests.MockMediaFileRepo).SetData(model.MediaFiles{ - {ID: "123", Path: "tests/fixtures/test.mp3", Suffix: "mp3", BitRate: 128, Duration: 257.0}, - }) - testCache := core.NewTranscodingCache() - Eventually(func() bool { return testCache.Available(context.TODO()) }).Should(BeTrue()) - streamer = core.NewMediaStreamer(ds, ffmpeg, testCache) - }) - AfterEach(func() { - _ = os.RemoveAll(conf.Server.CacheFolder) - }) - - Context("NewStream", func() { - It("returns a seekable stream if format is 'raw'", func() { - s, err := streamer.NewStream(ctx, "123", "raw", 0, 0) - Expect(err).ToNot(HaveOccurred()) - Expect(s.Seekable()).To(BeTrue()) - }) - It("returns a seekable stream if maxBitRate is 0", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 0, 0) - Expect(err).ToNot(HaveOccurred()) - Expect(s.Seekable()).To(BeTrue()) - }) - It("returns a seekable stream if maxBitRate is higher than file bitRate", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 320, 0) - Expect(err).ToNot(HaveOccurred()) - Expect(s.Seekable()).To(BeTrue()) - }) - It("returns a NON seekable stream if transcode is required", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 64, 0) - Expect(err).To(BeNil()) - Expect(s.Seekable()).To(BeFalse()) - Expect(s.Duration()).To(Equal(float32(257.0))) - }) - It("returns a seekable stream if the file is complete in the cache", func() { - s, err := streamer.NewStream(ctx, "123", "mp3", 32, 0) - Expect(err).To(BeNil()) - _, _ = io.ReadAll(s) - _ = s.Close() - Eventually(func() bool { return ffmpeg.IsClosed() }, "3s").Should(BeTrue()) - - s, err = streamer.NewStream(ctx, "123", "mp3", 32, 0) - Expect(err).To(BeNil()) - Expect(s.Seekable()).To(BeTrue()) - }) - }) -}) diff --git a/core/metrics/insights.go b/core/metrics/insights.go index 6076be0a5..bcd0343c2 100644 --- a/core/metrics/insights.go +++ b/core/metrics/insights.go @@ -6,6 +6,7 @@ import ( "encoding/json" "math" "net/http" + "os" "path/filepath" "runtime" "runtime/debug" @@ -21,6 +22,9 @@ import ( "github.com/navidrome/navidrome/core/metrics/insights" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/plugins" + "github.com/navidrome/navidrome/server/events" "github.com/navidrome/navidrome/utils/singleton" ) @@ -56,9 +60,16 @@ func GetInstance(ds model.DataStore) Insights { } func (c *insightsCollector) Run(ctx context.Context) { - ctx = auth.WithAdminUser(ctx, c.ds) for { - c.sendInsights(ctx) + // Refresh admin context on each iteration to handle cases where + // admin user wasn't available on previous runs + insightsCtx := auth.WithAdminUser(ctx, c.ds) + u, _ := request.UserFrom(insightsCtx) + if !u.IsAdmin { + log.Trace(insightsCtx, "No admin user available, skipping insights collection") + } else { + c.sendInsights(insightsCtx) + } select { case <-time.After(consts.InsightsUpdateInterval): continue @@ -97,7 +108,7 @@ func (c *insightsCollector) sendInsights(ctx context.Context) { return } req.Header.Set("Content-Type", "application/json") - resp, err := hc.Do(req) + resp, err := hc.Do(req) //nolint:gosec if err != nil { log.Trace(ctx, "Could not send Insights data", err) return @@ -153,6 +164,13 @@ var staticData = sync.OnceValue(func() insights.Data { data.Build.Settings, data.Build.GoVersion = buildInfo() data.OS.Containerized = consts.InContainer + // Install info + packageFilename := filepath.Join(conf.Server.DataFolder.String(), ".package") + packageFileData, err := os.ReadFile(packageFilename) + if err == nil { + data.OS.Package = string(packageFileData) + } + // OS info data.OS.Type = runtime.GOOS data.OS.Arch = runtime.GOARCH @@ -161,12 +179,12 @@ var staticData = sync.OnceValue(func() insights.Data { // FS info data.FS.Music = getFSInfo(conf.Server.MusicFolder) - data.FS.Data = getFSInfo(conf.Server.DataFolder) - if conf.Server.CacheFolder != "" { - data.FS.Cache = getFSInfo(conf.Server.CacheFolder) + data.FS.Data = getFSInfo(conf.Server.DataFolder.String()) + if conf.Server.CacheFolder.String() != "" { + data.FS.Cache = getFSInfo(conf.Server.CacheFolder.String()) } - if conf.Server.Backup.Path != "" { - data.FS.Backup = getFSInfo(conf.Server.Backup.Path) + if conf.Server.Backup.Path.String() != "" { + data.FS.Backup = getFSInfo(conf.Server.Backup.Path.String()) } // Config info @@ -175,29 +193,39 @@ var staticData = sync.OnceValue(func() insights.Data { data.Config.TLSConfigured = conf.Server.TLSCert != "" && conf.Server.TLSKey != "" data.Config.DefaultBackgroundURLSet = conf.Server.UILoginBackgroundURL == consts.DefaultUILoginBackgroundURL data.Config.EnableArtworkPrecache = conf.Server.EnableArtworkPrecache + data.Config.EnableArtworkUpload = conf.Server.EnableArtworkUpload + data.Config.CoverArtQuality = conf.Server.CoverArtQuality + data.Config.EnableWebPEncoding = conf.Server.EnableWebPEncoding + data.Config.UICoverArtSize = conf.Server.UICoverArtSize data.Config.EnableCoverAnimation = conf.Server.EnableCoverAnimation + data.Config.EnableNowPlaying = conf.Server.EnableNowPlaying data.Config.EnableDownloads = conf.Server.EnableDownloads data.Config.EnableSharing = conf.Server.EnableSharing data.Config.EnableStarRating = conf.Server.EnableStarRating - data.Config.EnableLastFM = conf.Server.LastFM.Enabled + data.Config.EnableLastFM = conf.Server.LastFM.Enabled && conf.Server.LastFM.ApiKey != "" && conf.Server.LastFM.Secret != "" data.Config.EnableListenBrainz = conf.Server.ListenBrainz.Enabled + data.Config.EnableDeezer = conf.Server.Deezer.Enabled data.Config.EnableMediaFileCoverArt = conf.Server.EnableMediaFileCoverArt - data.Config.EnableSpotify = conf.Server.Spotify.ID != "" data.Config.EnableJukebox = conf.Server.Jukebox.Enabled data.Config.EnablePrometheus = conf.Server.Prometheus.Enabled data.Config.TranscodingCacheSize = conf.Server.TranscodingCacheSize data.Config.ImageCacheSize = conf.Server.ImageCacheSize data.Config.SessionTimeout = uint64(math.Trunc(conf.Server.SessionTimeout.Seconds())) - data.Config.SearchFullString = conf.Server.SearchFullString + data.Config.SearchFullString = conf.Server.Search.FullString + data.Config.SearchBackend = conf.Server.Search.Backend data.Config.RecentlyAddedByModTime = conf.Server.RecentlyAddedByModTime data.Config.PreferSortTags = conf.Server.PreferSortTags data.Config.BackupSchedule = conf.Server.Backup.Schedule data.Config.BackupCount = conf.Server.Backup.Count data.Config.DevActivityPanel = conf.Server.DevActivityPanel data.Config.ScannerEnabled = conf.Server.Scanner.Enabled + data.Config.ScannerExtractor = conf.Server.Scanner.Extractor data.Config.ScanSchedule = conf.Server.Scanner.Schedule data.Config.ScanWatcherWait = uint64(math.Trunc(conf.Server.Scanner.WatcherWait.Seconds())) data.Config.ScanOnStartup = conf.Server.Scanner.ScanOnStartup + data.Config.ReverseProxyConfigured = conf.Server.ExtAuth.TrustedSources != "" + data.Config.HasCustomPID = conf.Server.PID.Track != consts.DefaultTrackPID || conf.Server.PID.Album != consts.DefaultAlbumPID + data.Config.HasCustomTags = len(conf.Server.Tags) > 0 return data }) @@ -232,12 +260,33 @@ func (c *insightsCollector) collect(ctx context.Context) []byte { if err != nil { log.Trace(ctx, "Error reading radios count", err) } + data.Library.Libraries, err = c.ds.Library(ctx).CountAll() + if err != nil { + log.Trace(ctx, "Error reading libraries count", err) + } data.Library.ActiveUsers, err = c.ds.User(ctx).CountAll(model.QueryOptions{ Filters: squirrel.Gt{"last_access_at": time.Now().Add(-7 * 24 * time.Hour)}, }) if err != nil { log.Trace(ctx, "Error reading active users count", err) } + data.Library.FileSuffixes, err = c.ds.MediaFile(ctx).CountBySuffix() + if err != nil { + log.Trace(ctx, "Error reading file suffixes count", err) + } + + // Check for smart playlists + data.Config.HasSmartPlaylists, err = c.hasSmartPlaylists(ctx) + if err != nil { + log.Trace(ctx, "Error checking for smart playlists", err) + } + + // Collect plugins if permitted and enabled + if conf.Server.DevEnablePluginsInsights && conf.Server.Plugins.Enabled { + data.Plugins = c.collectPlugins(ctx) + } + + // Collect active players if permitted if conf.Server.DevEnablePlayerInsights { data.Library.ActivePlayers, err = c.ds.Player(ctx).CountByClient(model.QueryOptions{ Filters: squirrel.Gt{"last_seen": time.Now().Add(-7 * 24 * time.Hour)}, @@ -263,3 +312,27 @@ func (c *insightsCollector) collect(ctx context.Context) []byte { } return resp } + +// hasSmartPlaylists checks if there are any smart playlists (playlists with rules) +func (c *insightsCollector) hasSmartPlaylists(ctx context.Context) (bool, error) { + count, err := c.ds.Playlist(ctx).CountAll(model.QueryOptions{ + Filters: squirrel.And{squirrel.NotEq{"rules": ""}, squirrel.NotEq{"rules": nil}}, + }) + return count > 0, err +} + +// collectPlugins collects information about installed plugins +func (c *insightsCollector) collectPlugins(_ context.Context) map[string]insights.PluginInfo { + // TODO Fix import/inject cycles + manager := plugins.GetManager(c.ds, events.GetBroker(), nil) + info := manager.GetPluginInfo() + + result := make(map[string]insights.PluginInfo, len(info)) + for name, p := range info { + result[name] = insights.PluginInfo{ + Name: p.Name, + Version: p.Version, + } + } + return result +} diff --git a/core/metrics/insights/data.go b/core/metrics/insights/data.go index 9df547b4a..34648a49b 100644 --- a/core/metrics/insights/data.go +++ b/core/metrics/insights/data.go @@ -16,6 +16,7 @@ type Data struct { Containerized bool `json:"containerized"` Arch string `json:"arch"` NumCPU int `json:"numCPU"` + Package string `json:"package,omitempty"` } `json:"os"` Mem struct { Alloc uint64 `json:"alloc"` @@ -36,14 +37,17 @@ type Data struct { Playlists int64 `json:"playlists"` Shares int64 `json:"shares"` Radios int64 `json:"radios"` + Libraries int64 `json:"libraries"` ActiveUsers int64 `json:"activeUsers"` ActivePlayers map[string]int64 `json:"activePlayers,omitempty"` + FileSuffixes map[string]int64 `json:"fileSuffixes,omitempty"` } `json:"library"` Config struct { LogLevel string `json:"logLevel,omitempty"` LogFileConfigured bool `json:"logFileConfigured,omitempty"` TLSConfigured bool `json:"tlsConfigured,omitempty"` ScannerEnabled bool `json:"scannerEnabled,omitempty"` + ScannerExtractor string `json:"scannerExtractor,omitempty"` ScanSchedule string `json:"scanSchedule,omitempty"` ScanWatcherWait uint64 `json:"scanWatcherWait,omitempty"` ScanOnStartup bool `json:"scanOnStartup,omitempty"` @@ -55,20 +59,36 @@ type Data struct { EnableStarRating bool `json:"enableStarRating,omitempty"` EnableLastFM bool `json:"enableLastFM,omitempty"` EnableListenBrainz bool `json:"enableListenBrainz,omitempty"` + EnableDeezer bool `json:"enableDeezer,omitempty"` EnableMediaFileCoverArt bool `json:"enableMediaFileCoverArt,omitempty"` - EnableSpotify bool `json:"enableSpotify,omitempty"` EnableJukebox bool `json:"enableJukebox,omitempty"` EnablePrometheus bool `json:"enablePrometheus,omitempty"` + EnableArtworkUpload bool `json:"enableArtworkUpload,omitempty"` + CoverArtQuality int `json:"coverArtQuality,omitempty"` + EnableWebPEncoding bool `json:"enableWebPEncoding,omitempty"` + UICoverArtSize int `json:"uiCoverArtSize,omitempty"` EnableCoverAnimation bool `json:"enableCoverAnimation,omitempty"` + EnableNowPlaying bool `json:"enableNowPlaying,omitempty"` SessionTimeout uint64 `json:"sessionTimeout,omitempty"` SearchFullString bool `json:"searchFullString,omitempty"` + SearchBackend string `json:"searchBackend,omitempty"` RecentlyAddedByModTime bool `json:"recentlyAddedByModTime,omitempty"` PreferSortTags bool `json:"preferSortTags,omitempty"` BackupSchedule string `json:"backupSchedule,omitempty"` BackupCount int `json:"backupCount,omitempty"` DevActivityPanel bool `json:"devActivityPanel,omitempty"` DefaultBackgroundURLSet bool `json:"defaultBackgroundURL,omitempty"` + HasSmartPlaylists bool `json:"hasSmartPlaylists,omitempty"` + ReverseProxyConfigured bool `json:"reverseProxyConfigured,omitempty"` + HasCustomPID bool `json:"hasCustomPID,omitempty"` + HasCustomTags bool `json:"hasCustomTags,omitempty"` } `json:"config"` + Plugins map[string]PluginInfo `json:"plugins,omitempty"` +} + +type PluginInfo struct { + Name string `json:"name"` + Version string `json:"version"` } type FSInfo struct { diff --git a/core/metrics/insights_linux.go b/core/metrics/insights_linux.go index dbf3c277c..f37c945c1 100644 --- a/core/metrics/insights_linux.go +++ b/core/metrics/insights_linux.go @@ -42,6 +42,7 @@ type MountInfo struct { var fsTypeMap = map[int64]string{ 0x5346414f: "afs", + 0x187: "autofs", 0x61756673: "aufs", 0x9123683E: "btrfs", 0xc36400: "ceph", @@ -55,9 +56,11 @@ var fsTypeMap = map[int64]string{ 0x6a656a63: "fakeowner", // FS inside a container 0x65735546: "fuse", 0x4244: "hfs", + 0x482b: "hfs+", 0x9660: "iso9660", 0x3153464a: "jfs", 0x00006969: "nfs", + 0x5346544e: "ntfs", // NTFS_SB_MAGIC 0x7366746e: "ntfs", 0x794c7630: "overlayfs", 0x9fa0: "proc", @@ -69,8 +72,16 @@ var fsTypeMap = map[int64]string{ 0x01021997: "v9fs", 0x786f4256: "vboxsf", 0x4d44: "vfat", + 0xca451a4e: "virtiofs", 0x58465342: "xfs", 0x2FC12FC1: "zfs", + 0x7c7c6673: "prlfs", // Parallels Shared Folders + + // Signed/unsigned conversion issues (negative hex values converted to uint32) + -0x6edc97c2: "btrfs", // 0x9123683e + -0x1acb2be: "smb2", // 0xfe534d42 + -0xacb2be: "cifs", // 0xff534d42 + -0xd0adff0: "f2fs", // 0xf2f52010 } func getFilesystemType(path string) (string, error) { diff --git a/core/metrics/prometheus.go b/core/metrics/prometheus.go index 5dabf29ce..412483156 100644 --- a/core/metrics/prometheus.go +++ b/core/metrics/prometheus.go @@ -2,7 +2,6 @@ package metrics import ( "context" - "fmt" "net/http" "strconv" "sync" @@ -13,6 +12,7 @@ import ( "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/singleton" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/promhttp" ) @@ -20,6 +20,8 @@ import ( type Metrics interface { WriteInitialMetrics(ctx context.Context) WriteAfterScanMetrics(ctx context.Context, success bool) + RecordRequest(ctx context.Context, endpoint, method, client string, status int32, elapsed int64) + RecordPluginRequest(ctx context.Context, plugin, method string, ok bool, elapsed int64) GetHandler() http.Handler } @@ -27,11 +29,14 @@ type metrics struct { ds model.DataStore } -func NewPrometheusInstance(ds model.DataStore) Metrics { - if conf.Server.Prometheus.Enabled { - return &metrics{ds: ds} +func GetPrometheusInstance(ds model.DataStore) Metrics { + if !conf.Server.Prometheus.Enabled { + return noopMetrics{} } - return noopMetrics{} + + return singleton.GetInstance(func() *metrics { + return &metrics{ds: ds} + }) } func NewNoopInstance() Metrics { @@ -51,6 +56,38 @@ func (m *metrics) WriteAfterScanMetrics(ctx context.Context, success bool) { getPrometheusMetrics().mediaScansCounter.With(scanLabels).Inc() } +func (m *metrics) RecordRequest(_ context.Context, endpoint, method, client string, status int32, elapsed int64) { + httpLabel := prometheus.Labels{ + "endpoint": endpoint, + "method": method, + "client": client, + "status": strconv.FormatInt(int64(status), 10), + } + getPrometheusMetrics().httpRequestCounter.With(httpLabel).Inc() + + httpLatencyLabel := prometheus.Labels{ + "endpoint": endpoint, + "method": method, + "client": client, + } + getPrometheusMetrics().httpRequestDuration.With(httpLatencyLabel).Observe(float64(elapsed)) +} + +func (m *metrics) RecordPluginRequest(_ context.Context, plugin, method string, ok bool, elapsed int64) { + pluginLabel := prometheus.Labels{ + "plugin": plugin, + "method": method, + "ok": strconv.FormatBool(ok), + } + getPrometheusMetrics().pluginRequestCounter.With(pluginLabel).Inc() + + pluginLatencyLabel := prometheus.Labels{ + "plugin": plugin, + "method": method, + } + getPrometheusMetrics().pluginRequestDuration.With(pluginLatencyLabel).Observe(float64(elapsed)) +} + func (m *metrics) GetHandler() http.Handler { r := chi.NewRouter() @@ -59,20 +96,31 @@ func (m *metrics) GetHandler() http.Handler { consts.PrometheusAuthUser: conf.Server.Prometheus.Password, })) } - r.Handle("/", promhttp.Handler()) + // Enable created at timestamp to handle zero counter on create. + // This requires --enable-feature=created-timestamp-zero-ingestion to be passed in Prometheus + r.Handle("/", promhttp.HandlerFor(prometheus.DefaultGatherer, promhttp.HandlerOpts{ + EnableOpenMetrics: true, + EnableOpenMetricsTextCreatedSamples: true, + })) return r } type prometheusMetrics struct { - dbTotal *prometheus.GaugeVec - versionInfo *prometheus.GaugeVec - lastMediaScan *prometheus.GaugeVec - mediaScansCounter *prometheus.CounterVec + dbTotal *prometheus.GaugeVec + versionInfo *prometheus.GaugeVec + lastMediaScan *prometheus.GaugeVec + mediaScansCounter *prometheus.CounterVec + httpRequestCounter *prometheus.CounterVec + httpRequestDuration *prometheus.SummaryVec + pluginRequestCounter *prometheus.CounterVec + pluginRequestDuration *prometheus.SummaryVec } // Prometheus' metrics requires initialization. But not more than once var getPrometheusMetrics = sync.OnceValue(func() *prometheusMetrics { + quartilesToEstimate := map[float64]float64{0.5: 0.05, 0.75: 0.025, 0.9: 0.01, 0.99: 0.001} + instance := &prometheusMetrics{ dbTotal: prometheus.NewGaugeVec( prometheus.GaugeOpts{ @@ -102,23 +150,49 @@ var getPrometheusMetrics = sync.OnceValue(func() *prometheusMetrics { }, []string{"success"}, ), + httpRequestCounter: prometheus.NewCounterVec( + prometheus.CounterOpts{ + Name: "http_request_count", + Help: "Request types by status", + }, + []string{"endpoint", "method", "client", "status"}, + ), + httpRequestDuration: prometheus.NewSummaryVec( + prometheus.SummaryOpts{ + Name: "http_request_latency", + Help: "Latency (in ms) of HTTP requests", + Objectives: quartilesToEstimate, + }, + []string{"endpoint", "method", "client"}, + ), + pluginRequestCounter: prometheus.NewCounterVec( + prometheus.CounterOpts{ + Name: "plugin_request_count", + Help: "Plugin requests by method/status", + }, + []string{"plugin", "method", "ok"}, + ), + pluginRequestDuration: prometheus.NewSummaryVec( + prometheus.SummaryOpts{ + Name: "plugin_request_latency", + Help: "Latency (in ms) of plugin requests", + Objectives: quartilesToEstimate, + }, + []string{"plugin", "method"}, + ), } - err := prometheus.DefaultRegisterer.Register(instance.dbTotal) - if err != nil { - log.Fatal("Unable to create Prometheus metric instance", fmt.Errorf("unable to register db_model_totals metrics: %w", err)) - } - err = prometheus.DefaultRegisterer.Register(instance.versionInfo) - if err != nil { - log.Fatal("Unable to create Prometheus metric instance", fmt.Errorf("unable to register navidrome_info metrics: %w", err)) - } - err = prometheus.DefaultRegisterer.Register(instance.lastMediaScan) - if err != nil { - log.Fatal("Unable to create Prometheus metric instance", fmt.Errorf("unable to register media_scan_last metrics: %w", err)) - } - err = prometheus.DefaultRegisterer.Register(instance.mediaScansCounter) - if err != nil { - log.Fatal("Unable to create Prometheus metric instance", fmt.Errorf("unable to register media_scans metrics: %w", err)) - } + + prometheus.DefaultRegisterer.MustRegister( + instance.dbTotal, + instance.versionInfo, + instance.lastMediaScan, + instance.mediaScansCounter, + instance.httpRequestCounter, + instance.httpRequestDuration, + instance.pluginRequestCounter, + instance.pluginRequestDuration, + ) + return instance }) @@ -159,4 +233,8 @@ func (n noopMetrics) WriteInitialMetrics(context.Context) {} func (n noopMetrics) WriteAfterScanMetrics(context.Context, bool) {} +func (n noopMetrics) RecordRequest(context.Context, string, string, string, int32, int64) {} + +func (n noopMetrics) RecordPluginRequest(context.Context, string, string, bool, int64) {} + func (n noopMetrics) GetHandler() http.Handler { return nil } diff --git a/core/playback/mpv/mpv.go b/core/playback/mpv/mpv.go index 495d27512..6696eca2a 100644 --- a/core/playback/mpv/mpv.go +++ b/core/playback/mpv/mpv.go @@ -12,9 +12,13 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/utils/shellquote" ) func start(ctx context.Context, args []string) (Executor, error) { + if len(args) == 0 { + return Executor{}, fmt.Errorf("no command arguments provided") + } log.Debug("Executing mpv command", "cmd", args) j := Executor{args: args} j.PipeReader, j.out = io.Pipe() @@ -58,8 +62,7 @@ func (j *Executor) start(ctx context.Context) error { func (j *Executor) wait() { if err := j.cmd.Wait(); err != nil { - var exitErr *exec.ExitError - if errors.As(err, &exitErr) { + if exitErr, ok := errors.AsType[*exec.ExitError](err); ok { _ = j.out.CloseWithError(fmt.Errorf("%s exited with non-zero status code: %d", j.args[0], exitErr.ExitCode())) } else { _ = j.out.CloseWithError(fmt.Errorf("waiting %s cmd: %w", j.args[0], err)) @@ -71,28 +74,32 @@ func (j *Executor) wait() { // Path will always be an absolute path func createMPVCommand(deviceName string, filename string, socketName string) []string { - split := strings.Split(fixCmd(conf.Server.MPVCmdTemplate), " ") - for i, s := range split { - s = strings.ReplaceAll(s, "%d", deviceName) - s = strings.ReplaceAll(s, "%f", filename) - s = strings.ReplaceAll(s, "%s", socketName) - split[i] = s + // Parse the template structure using shell parsing to handle quoted arguments + templateArgs, err := shellquote.Split(conf.Server.MPVCmdTemplate) + if err != nil { + log.Error("Failed to parse MPV command template", "template", conf.Server.MPVCmdTemplate, err) + return nil } - return split -} -func fixCmd(cmd string) string { - split := strings.Split(cmd, " ") - var result []string - cmdPath, _ := mpvCommand() - for _, s := range split { - if s == "mpv" || s == "mpv.exe" { - result = append(result, cmdPath) - } else { - result = append(result, s) + // Replace placeholders in each parsed argument to preserve spaces in substituted values + for i, arg := range templateArgs { + arg = strings.ReplaceAll(arg, "%d", deviceName) + arg = strings.ReplaceAll(arg, "%f", filename) + arg = strings.ReplaceAll(arg, "%s", socketName) + templateArgs[i] = arg + } + + // Replace mpv executable references with the configured path + if len(templateArgs) > 0 { + cmdPath, err := mpvCommand() + if err == nil { + if templateArgs[0] == "mpv" || templateArgs[0] == "mpv.exe" { + templateArgs[0] = cmdPath + } } } - return strings.Join(result, " ") + + return templateArgs } // This is a 1:1 copy of the stuff in ffmpeg.go, need to be unified. diff --git a/core/playback/mpv/mpv_suite_test.go b/core/playback/mpv/mpv_suite_test.go new file mode 100644 index 000000000..f8f827620 --- /dev/null +++ b/core/playback/mpv/mpv_suite_test.go @@ -0,0 +1,17 @@ +package mpv + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestMPV(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "MPV Suite") +} diff --git a/core/playback/mpv/mpv_test.go b/core/playback/mpv/mpv_test.go new file mode 100644 index 000000000..6754b39ac --- /dev/null +++ b/core/playback/mpv/mpv_test.go @@ -0,0 +1,394 @@ +package mpv + +import ( + "context" + "fmt" + "io" + "os" + "path/filepath" + "runtime" + "strings" + "sync" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("MPV", func() { + var ( + testScript string + tempDir string + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + + // Reset MPV cache + mpvOnce = sync.Once{} + mpvPath = "" + mpvErr = nil + + // Create temporary directory for test files + var err error + tempDir, err = os.MkdirTemp("", "mpv_test_*") + Expect(err).ToNot(HaveOccurred()) + DeferCleanup(func() { os.RemoveAll(tempDir) }) + + // Create mock MPV script that outputs arguments to stdout + testScript = createMockMPVScript(tempDir) + + // Configure test MPV path + conf.Server.MPVPath = testScript + }) + + Describe("createMPVCommand", func() { + Context("with default template", func() { + BeforeEach(func() { + conf.Server.MPVCmdTemplate = "mpv --audio-device=%d --no-audio-display --pause %f --input-ipc-server=%s" + }) + + It("creates correct command with simple paths", func() { + args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") + Expect(args).To(Equal([]string{ + testScript, + "--audio-device=auto", + "--no-audio-display", + "--pause", + "/music/test.mp3", + "--input-ipc-server=/tmp/socket", + })) + }) + + It("handles paths with spaces", func() { + args := createMPVCommand("auto", "/music/My Album/01 - Song.mp3", "/tmp/socket") + Expect(args).To(Equal([]string{ + testScript, + "--audio-device=auto", + "--no-audio-display", + "--pause", + "/music/My Album/01 - Song.mp3", + "--input-ipc-server=/tmp/socket", + })) + }) + + It("handles complex device names", func() { + deviceName := "coreaudio/AppleUSBAudioEngine:Cambridge Audio :Cambridge Audio USB Audio 1.0:0000:1" + args := createMPVCommand(deviceName, "/music/test.mp3", "/tmp/socket") + Expect(args).To(Equal([]string{ + testScript, + "--audio-device=" + deviceName, + "--no-audio-display", + "--pause", + "/music/test.mp3", + "--input-ipc-server=/tmp/socket", + })) + }) + }) + + Context("with snapcast template (issue #3619)", func() { + BeforeEach(func() { + // This is the template that fails with naive space splitting + conf.Server.MPVCmdTemplate = "mpv --no-audio-display --pause %f --input-ipc-server=%s --audio-channels=stereo --audio-samplerate=48000 --audio-format=s16 --ao=pcm --ao-pcm-file=/audio/snapcast_fifo" + }) + + It("creates correct command for snapcast integration", func() { + args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") + Expect(args).To(Equal([]string{ + testScript, + "--no-audio-display", + "--pause", + "/music/test.mp3", + "--input-ipc-server=/tmp/socket", + "--audio-channels=stereo", + "--audio-samplerate=48000", + "--audio-format=s16", + "--ao=pcm", + "--ao-pcm-file=/audio/snapcast_fifo", + })) + }) + }) + + Context("with wrapper script template", func() { + BeforeEach(func() { + // Test case that would break with naive splitting due to quoted arguments + conf.Server.MPVCmdTemplate = `/tmp/mpv.sh --no-audio-display --pause %f --input-ipc-server=%s --audio-channels=stereo` + }) + + It("handles wrapper script paths", func() { + args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") + Expect(args).To(Equal([]string{ + "/tmp/mpv.sh", + "--no-audio-display", + "--pause", + "/music/test.mp3", + "--input-ipc-server=/tmp/socket", + "--audio-channels=stereo", + })) + }) + }) + + Context("with extra spaces in template", func() { + BeforeEach(func() { + conf.Server.MPVCmdTemplate = "mpv --audio-device=%d --no-audio-display --pause %f --input-ipc-server=%s" + }) + + It("handles extra spaces correctly", func() { + args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") + Expect(args).To(Equal([]string{ + testScript, + "--audio-device=auto", + "--no-audio-display", + "--pause", + "/music/test.mp3", + "--input-ipc-server=/tmp/socket", + })) + }) + }) + Context("with paths containing spaces in template arguments", func() { + BeforeEach(func() { + // Template with spaces in the path arguments themselves + conf.Server.MPVCmdTemplate = `mpv --no-audio-display --pause %f --ao-pcm-file="/audio/my folder/snapcast_fifo" --input-ipc-server=%s` + }) + + It("handles spaces in quoted template argument paths", func() { + args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") + // This test reveals the limitation of strings.Fields() - it will split on all spaces + // Expected behavior would be to keep the path as one argument + Expect(args).To(Equal([]string{ + testScript, + "--no-audio-display", + "--pause", + "/music/test.mp3", + "--ao-pcm-file=/audio/my folder/snapcast_fifo", // This should be one argument + "--input-ipc-server=/tmp/socket", + })) + }) + }) + + Context("with malformed template", func() { + BeforeEach(func() { + // Template with unmatched quotes that will cause shell parsing to fail + conf.Server.MPVCmdTemplate = `mpv --no-audio-display --pause %f --input-ipc-server=%s --ao-pcm-file="/unclosed/quote` + }) + + It("returns nil when shell parsing fails", func() { + args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") + Expect(args).To(BeNil()) + }) + }) + + Context("with empty template", func() { + BeforeEach(func() { + conf.Server.MPVCmdTemplate = "" + }) + + It("returns empty slice for empty template", func() { + args := createMPVCommand("auto", "/music/test.mp3", "/tmp/socket") + Expect(args).To(BeEmpty()) + }) + }) + }) + + Describe("start", func() { + BeforeEach(func() { + conf.Server.MPVCmdTemplate = "mpv --audio-device=%d --no-audio-display --pause %f --input-ipc-server=%s" + }) + + It("executes MPV command and captures arguments correctly", func() { + tests.SkipOnWindows("mpv binary not available in CI (#TBD-mpv-windows)") + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + + deviceName := "auto" + filename := "/music/test.mp3" + socketName := "/tmp/test_socket" + + args := createMPVCommand(deviceName, filename, socketName) + executor, err := start(ctx, args) + Expect(err).ToNot(HaveOccurred()) + + // Read all the output from stdout (this will block until the process finishes or is canceled) + output, err := io.ReadAll(executor) + Expect(err).ToNot(HaveOccurred()) + + // Parse the captured arguments + lines := strings.Split(strings.TrimSpace(string(output)), "\n") + Expect(lines).To(HaveLen(6)) + Expect(lines[0]).To(Equal(testScript)) + Expect(lines[1]).To(Equal("--audio-device=auto")) + Expect(lines[2]).To(Equal("--no-audio-display")) + Expect(lines[3]).To(Equal("--pause")) + Expect(lines[4]).To(Equal("/music/test.mp3")) + Expect(lines[5]).To(Equal("--input-ipc-server=/tmp/test_socket")) + }) + + It("handles file paths with spaces", func() { + tests.SkipOnWindows("mpv binary not available in CI (#TBD-mpv-windows)") + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + + deviceName := "auto" + filename := "/music/My Album/01 - My Song.mp3" + socketName := "/tmp/test socket" + + args := createMPVCommand(deviceName, filename, socketName) + executor, err := start(ctx, args) + Expect(err).ToNot(HaveOccurred()) + + // Read all the output from stdout (this will block until the process finishes or is canceled) + output, err := io.ReadAll(executor) + Expect(err).ToNot(HaveOccurred()) + + // Parse the captured arguments + lines := strings.Split(strings.TrimSpace(string(output)), "\n") + Expect(lines).To(ContainElement("/music/My Album/01 - My Song.mp3")) + Expect(lines).To(ContainElement("--input-ipc-server=/tmp/test socket")) + }) + + Context("with complex snapcast configuration", func() { + BeforeEach(func() { + conf.Server.MPVCmdTemplate = "mpv --no-audio-display --pause %f --input-ipc-server=%s --audio-channels=stereo --audio-samplerate=48000 --audio-format=s16 --ao=pcm --ao-pcm-file=/audio/snapcast_fifo" + }) + + It("passes all snapcast arguments correctly", func() { + tests.SkipOnWindows("mpv binary not available in CI (#TBD-mpv-windows)") + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + + deviceName := "auto" + filename := "/music/album/track.flac" + socketName := "/tmp/mpv-ctrl-test.socket" + + args := createMPVCommand(deviceName, filename, socketName) + executor, err := start(ctx, args) + Expect(err).ToNot(HaveOccurred()) + + // Read all the output from stdout (this will block until the process finishes or is canceled) + output, err := io.ReadAll(executor) + Expect(err).ToNot(HaveOccurred()) + + // Parse the captured arguments + lines := strings.Split(strings.TrimSpace(string(output)), "\n") + + // Verify all expected arguments are present + Expect(lines).To(ContainElement("--no-audio-display")) + Expect(lines).To(ContainElement("--pause")) + Expect(lines).To(ContainElement("/music/album/track.flac")) + Expect(lines).To(ContainElement("--input-ipc-server=/tmp/mpv-ctrl-test.socket")) + Expect(lines).To(ContainElement("--audio-channels=stereo")) + Expect(lines).To(ContainElement("--audio-samplerate=48000")) + Expect(lines).To(ContainElement("--audio-format=s16")) + Expect(lines).To(ContainElement("--ao=pcm")) + Expect(lines).To(ContainElement("--ao-pcm-file=/audio/snapcast_fifo")) + }) + }) + + Context("with nil args", func() { + It("returns error when args is nil", func() { + ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) + defer cancel() + + _, err := start(ctx, nil) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(Equal("no command arguments provided")) + }) + + It("returns error when args is empty", func() { + ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) + defer cancel() + + _, err := start(ctx, []string{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(Equal("no command arguments provided")) + }) + }) + }) + + Describe("mpvCommand", func() { + BeforeEach(func() { + // Reset the mpv command cache + mpvOnce = sync.Once{} + mpvPath = "" + mpvErr = nil + }) + + It("finds the configured MPV path", func() { + conf.Server.MPVPath = testScript + path, err := mpvCommand() + Expect(err).ToNot(HaveOccurred()) + Expect(path).To(Equal(testScript)) + }) + }) + + Describe("NewTrack integration", func() { + var testMediaFile model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.MPVPath = testScript + + // Create a test media file + testMediaFile = model.MediaFile{ + ID: "test-id", + Path: "/music/test.mp3", + } + }) + + Context("with malformed template", func() { + BeforeEach(func() { + // Template with unmatched quotes that will cause shell parsing to fail + conf.Server.MPVCmdTemplate = `mpv --no-audio-display --pause %f --input-ipc-server=%s --ao-pcm-file="/unclosed/quote` + }) + + It("returns error when createMPVCommand fails", func() { + ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second) + defer cancel() + + playbackDone := make(chan bool, 1) + _, err := NewTrack(ctx, playbackDone, "auto", testMediaFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(Equal("no mpv command arguments provided")) + }) + }) + }) +}) + +// createMockMPVScript creates a mock script that outputs arguments to stdout +func createMockMPVScript(tempDir string) string { + var scriptContent string + var scriptExt string + + if runtime.GOOS == "windows" { + scriptExt = ".bat" + scriptContent = `@echo off +echo %0 +:loop +if "%~1"=="" goto end +echo %~1 +shift +goto loop +:end +` + } else { + scriptExt = ".sh" + scriptContent = `#!/bin/sh +echo "$0" +for arg in "$@"; do + echo "$arg" +done +` + } + + scriptPath := filepath.Join(tempDir, "mock_mpv"+scriptExt) + err := os.WriteFile(scriptPath, []byte(scriptContent), 0755) // nolint:gosec + if err != nil { + panic(fmt.Sprintf("Failed to create mock script: %v", err)) + } + + return scriptPath +} diff --git a/core/playback/mpv/track.go b/core/playback/mpv/track.go index b894ff3ad..1038b9190 100644 --- a/core/playback/mpv/track.go +++ b/core/playback/mpv/track.go @@ -34,7 +34,10 @@ func NewTrack(ctx context.Context, playbackDoneChannel chan bool, deviceName str tmpSocketName := socketName("mpv-ctrl-", ".socket") - args := createMPVCommand(deviceName, mf.Path, tmpSocketName) + args := createMPVCommand(deviceName, mf.AbsolutePath(), tmpSocketName) + if len(args) == 0 { + return nil, fmt.Errorf("no mpv command arguments provided") + } exe, err := start(ctx, args) if err != nil { log.Error("Error starting mpv process", err) @@ -203,7 +206,7 @@ func (t *MpvTrack) IsPlaying() bool { func waitForSocket(path string, timeout time.Duration, pause time.Duration) error { start := time.Now() end := start.Add(timeout) - var retries int = 0 + var retries = 0 for { fileInfo, err := os.Stat(path) diff --git a/core/playback/queue.go b/core/playback/queue.go index 0c230a61f..d15eaad96 100644 --- a/core/playback/queue.go +++ b/core/playback/queue.go @@ -3,6 +3,7 @@ package playback import ( "fmt" "math/rand" + "strings" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" @@ -21,11 +22,11 @@ func NewQueue() *Queue { } func (pd *Queue) String() string { - filenames := "" + var filenames strings.Builder for idx, item := range pd.Items { - filenames += fmt.Sprint(idx) + ":" + item.Path + " " + filenames.WriteString(fmt.Sprint(idx) + ":" + item.Path + " ") } - return fmt.Sprintf("#Items: %d, idx: %d, files: %s", len(pd.Items), pd.Index, filenames) + return fmt.Sprintf("#Items: %d, idx: %d, files: %s", len(pd.Items), pd.Index, filenames.String()) } // returns the current mediafile or nil diff --git a/core/playlists.go b/core/playlists.go deleted file mode 100644 index 4cdab0d38..000000000 --- a/core/playlists.go +++ /dev/null @@ -1,382 +0,0 @@ -package core - -import ( - "context" - "encoding/json" - "errors" - "fmt" - "io" - "net/url" - "os" - "path/filepath" - "regexp" - "strings" - "time" - - "github.com/RaveNoX/go-jsoncommentstrip" - "github.com/bmatcuk/doublestar/v4" - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/log" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/criteria" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/utils/slice" -) - -type Playlists interface { - ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) - Update(ctx context.Context, playlistID string, name *string, comment *string, public *bool, idsToAdd []string, idxToRemove []int) error - ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) -} - -type playlists struct { - ds model.DataStore -} - -func NewPlaylists(ds model.DataStore) Playlists { - return &playlists{ds: ds} -} - -func InPlaylistsPath(folder model.Folder) bool { - if conf.Server.PlaylistsPath == "" { - return true - } - rel, _ := filepath.Rel(folder.LibraryPath, folder.AbsolutePath()) - for _, path := range strings.Split(conf.Server.PlaylistsPath, string(filepath.ListSeparator)) { - if match, _ := doublestar.Match(path, rel); match { - return true - } - } - return false -} - -func (s *playlists) ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) { - pls, err := s.parsePlaylist(ctx, filename, folder) - if err != nil { - log.Error(ctx, "Error parsing playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) - return nil, err - } - log.Debug("Found playlist", "name", pls.Name, "lastUpdated", pls.UpdatedAt, "path", pls.Path, "numTracks", len(pls.Tracks)) - err = s.updatePlaylist(ctx, pls) - if err != nil { - log.Error(ctx, "Error updating playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) - } - return pls, err -} - -func (s *playlists) ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) { - owner, _ := request.UserFrom(ctx) - pls := &model.Playlist{ - OwnerID: owner.ID, - Public: false, - Sync: false, - } - err := s.parseM3U(ctx, pls, nil, reader) - if err != nil { - log.Error(ctx, "Error parsing playlist", err) - return nil, err - } - err = s.ds.Playlist(ctx).Put(pls) - if err != nil { - log.Error(ctx, "Error saving playlist", err) - return nil, err - } - return pls, nil -} - -func (s *playlists) parsePlaylist(ctx context.Context, playlistFile string, folder *model.Folder) (*model.Playlist, error) { - pls, err := s.newSyncedPlaylist(folder.AbsolutePath(), playlistFile) - if err != nil { - return nil, err - } - - file, err := os.Open(pls.Path) - if err != nil { - return nil, err - } - defer file.Close() - - extension := strings.ToLower(filepath.Ext(playlistFile)) - switch extension { - case ".nsp": - err = s.parseNSP(ctx, pls, file) - default: - err = s.parseM3U(ctx, pls, folder, file) - } - return pls, err -} - -func (s *playlists) newSyncedPlaylist(baseDir string, playlistFile string) (*model.Playlist, error) { - playlistPath := filepath.Join(baseDir, playlistFile) - info, err := os.Stat(playlistPath) - if err != nil { - return nil, err - } - - var extension = filepath.Ext(playlistFile) - var name = playlistFile[0 : len(playlistFile)-len(extension)] - - pls := &model.Playlist{ - Name: name, - Comment: fmt.Sprintf("Auto-imported from '%s'", playlistFile), - Public: false, - Path: playlistPath, - Sync: true, - UpdatedAt: info.ModTime(), - } - return pls, nil -} - -func getPositionFromOffset(data []byte, offset int64) (line, column int) { - line = 1 - for _, b := range data[:offset] { - if b == '\n' { - line++ - column = 1 - } else { - column++ - } - } - return -} - -func (s *playlists) parseNSP(_ context.Context, pls *model.Playlist, reader io.Reader) error { - nsp := &nspFile{} - reader = io.LimitReader(reader, 100*1024) // Limit to 100KB - reader = jsoncommentstrip.NewReader(reader) - input, err := io.ReadAll(reader) - if err != nil { - return fmt.Errorf("reading SmartPlaylist: %w", err) - } - err = json.Unmarshal(input, nsp) - if err != nil { - var syntaxErr *json.SyntaxError - if errors.As(err, &syntaxErr) { - line, col := getPositionFromOffset(input, syntaxErr.Offset) - return fmt.Errorf("JSON syntax error in SmartPlaylist at line %d, column %d: %w", line, col, err) - } - return fmt.Errorf("JSON parsing error in SmartPlaylist: %w", err) - } - pls.Rules = &nsp.Criteria - if nsp.Name != "" { - pls.Name = nsp.Name - } - if nsp.Comment != "" { - pls.Comment = nsp.Comment - } - return nil -} - -func (s *playlists) parseM3U(ctx context.Context, pls *model.Playlist, folder *model.Folder, reader io.Reader) error { - mediaFileRepository := s.ds.MediaFile(ctx) - var mfs model.MediaFiles - for lines := range slice.CollectChunks(slice.LinesFrom(reader), 400) { - filteredLines := make([]string, 0, len(lines)) - for _, line := range lines { - line := strings.TrimSpace(line) - if strings.HasPrefix(line, "#PLAYLIST:") { - pls.Name = line[len("#PLAYLIST:"):] - continue - } - // Skip empty lines and extended info - if line == "" || strings.HasPrefix(line, "#") { - continue - } - if strings.HasPrefix(line, "file://") { - line = strings.TrimPrefix(line, "file://") - line, _ = url.QueryUnescape(line) - } - if !model.IsAudioFile(line) { - continue - } - filteredLines = append(filteredLines, line) - } - paths, err := s.normalizePaths(ctx, pls, folder, filteredLines) - if err != nil { - log.Warn(ctx, "Error normalizing paths in playlist", "playlist", pls.Name, err) - continue - } - found, err := mediaFileRepository.FindByPaths(paths) - if err != nil { - log.Warn(ctx, "Error reading files from DB", "playlist", pls.Name, err) - continue - } - existing := make(map[string]int, len(found)) - for idx := range found { - existing[strings.ToLower(found[idx].Path)] = idx - } - for _, path := range paths { - idx, ok := existing[strings.ToLower(path)] - if ok { - mfs = append(mfs, found[idx]) - } else { - log.Warn(ctx, "Path in playlist not found", "playlist", pls.Name, "path", path) - } - } - } - if pls.Name == "" { - pls.Name = time.Now().Format(time.RFC3339) - } - pls.Tracks = nil - pls.AddMediaFiles(mfs) - - return nil -} - -// TODO This won't work for multiple libraries -func (s *playlists) normalizePaths(ctx context.Context, pls *model.Playlist, folder *model.Folder, lines []string) ([]string, error) { - libRegex, err := s.compileLibraryPaths(ctx) - if err != nil { - return nil, err - } - - res := make([]string, 0, len(lines)) - for idx, line := range lines { - var libPath string - var filePath string - - if folder != nil && !filepath.IsAbs(line) { - libPath = folder.LibraryPath - filePath = filepath.Join(folder.AbsolutePath(), line) - } else { - cleanLine := filepath.Clean(line) - if libPath = libRegex.FindString(cleanLine); libPath != "" { - filePath = cleanLine - } - } - - if libPath != "" { - if rel, err := filepath.Rel(libPath, filePath); err == nil { - res = append(res, rel) - } else { - log.Debug(ctx, "Error getting relative path", "playlist", pls.Name, "path", line, "libPath", libPath, - "filePath", filePath, err) - } - } else { - log.Warn(ctx, "Path in playlist not found in any library", "path", line, "line", idx) - } - } - return slice.Map(res, filepath.ToSlash), nil -} - -func (s *playlists) compileLibraryPaths(ctx context.Context) (*regexp.Regexp, error) { - libs, err := s.ds.Library(ctx).GetAll() - if err != nil { - return nil, err - } - - // Create regex patterns for each library path - patterns := make([]string, len(libs)) - for i, lib := range libs { - cleanPath := filepath.Clean(lib.Path) - escapedPath := regexp.QuoteMeta(cleanPath) - patterns[i] = fmt.Sprintf("^%s(?:/|$)", escapedPath) - } - // Combine all patterns into a single regex - combinedPattern := strings.Join(patterns, "|") - re, err := regexp.Compile(combinedPattern) - if err != nil { - return nil, fmt.Errorf("compiling library paths `%s`: %w", combinedPattern, err) - } - return re, nil -} - -func (s *playlists) updatePlaylist(ctx context.Context, newPls *model.Playlist) error { - owner, _ := request.UserFrom(ctx) - - pls, err := s.ds.Playlist(ctx).FindByPath(newPls.Path) - if err != nil && !errors.Is(err, model.ErrNotFound) { - return err - } - if err == nil && !pls.Sync { - log.Debug(ctx, "Playlist already imported and not synced", "playlist", pls.Name, "path", pls.Path) - return nil - } - - if err == nil { - log.Info(ctx, "Updating synced playlist", "playlist", pls.Name, "path", newPls.Path) - newPls.ID = pls.ID - newPls.Name = pls.Name - newPls.Comment = pls.Comment - newPls.OwnerID = pls.OwnerID - newPls.Public = pls.Public - newPls.EvaluatedAt = &time.Time{} - } else { - log.Info(ctx, "Adding synced playlist", "playlist", newPls.Name, "path", newPls.Path, "owner", owner.UserName) - newPls.OwnerID = owner.ID - newPls.Public = conf.Server.DefaultPlaylistPublicVisibility - } - return s.ds.Playlist(ctx).Put(newPls) -} - -func (s *playlists) Update(ctx context.Context, playlistID string, - name *string, comment *string, public *bool, - idsToAdd []string, idxToRemove []int) error { - needsInfoUpdate := name != nil || comment != nil || public != nil - needsTrackRefresh := len(idxToRemove) > 0 - - return s.ds.WithTxImmediate(func(tx model.DataStore) error { - var pls *model.Playlist - var err error - repo := tx.Playlist(ctx) - tracks := repo.Tracks(playlistID, true) - if tracks == nil { - return fmt.Errorf("%w: playlist '%s'", model.ErrNotFound, playlistID) - } - if needsTrackRefresh { - pls, err = repo.GetWithTracks(playlistID, true, false) - pls.RemoveTracks(idxToRemove) - pls.AddTracks(idsToAdd) - } else { - if len(idsToAdd) > 0 { - _, err = tracks.Add(idsToAdd) - if err != nil { - return err - } - } - if needsInfoUpdate { - pls, err = repo.Get(playlistID) - } - } - if err != nil { - return err - } - if !needsTrackRefresh && !needsInfoUpdate { - return nil - } - - if name != nil { - pls.Name = *name - } - if comment != nil { - pls.Comment = *comment - } - if public != nil { - pls.Public = *public - } - // Special case: The playlist is now empty - if len(idxToRemove) > 0 && len(pls.Tracks) == 0 { - if err = tracks.DeleteAll(); err != nil { - return err - } - } - return repo.Put(pls) - }) -} - -type nspFile struct { - criteria.Criteria - Name string `json:"name"` - Comment string `json:"comment"` -} - -func (i *nspFile) UnmarshalJSON(data []byte) error { - m := map[string]interface{}{} - err := json.Unmarshal(data, &m) - if err != nil { - return err - } - i.Name, _ = m["name"].(string) - i.Comment, _ = m["comment"].(string) - return json.Unmarshal(data, &i.Criteria) -} diff --git a/core/playlists/import.go b/core/playlists/import.go new file mode 100644 index 000000000..9d3ecabc5 --- /dev/null +++ b/core/playlists/import.go @@ -0,0 +1,200 @@ +package playlists + +import ( + "context" + "errors" + "fmt" + "io" + "os" + "path/filepath" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/ioutils" + "golang.org/x/text/unicode/norm" +) + +func (s *playlists) ImportFile(ctx context.Context, absolutePath string, sync bool) (*model.Playlist, error) { + absPath, err := filepath.Abs(absolutePath) + if err != nil { + return nil, fmt.Errorf("resolving absolute path: %w", err) + } + + dir := filepath.Dir(absPath) + filename := filepath.Base(absPath) + + folder, err := s.resolveFolder(ctx, dir) + if err != nil && !errors.Is(err, errNotInLibrary) { + return nil, err + } + if err == nil { + pls, err := s.importFromFolder(ctx, folder, filename, sync) + if err != nil { + return nil, err + } + if pls.ID != "" && pls.Sync != sync { + pls.Sync = sync + if putErr := s.ds.Playlist(ctx).Put(pls); putErr != nil { + return nil, putErr + } + } + return pls, nil + } + + log.Debug(ctx, "Playlist file is outside all libraries, using path-based import", "path", absPath) + pls, err := s.newSyncedPlaylist(dir, filename) + if err != nil { + return nil, fmt.Errorf("reading playlist file: %w", err) + } + pls.Sync = sync + + file, err := os.Open(absPath) + if err != nil { + return nil, fmt.Errorf("opening playlist file: %w", err) + } + defer file.Close() + + reader := ioutils.UTF8Reader(file) + if err := s.parseM3U(ctx, pls, nil, reader); err != nil { + return nil, err + } + if err := s.updatePlaylist(ctx, pls, sync); err != nil { + return nil, err + } + return pls, nil +} + +var errNotInLibrary = fmt.Errorf("path not in any library") + +func (s *playlists) resolveFolder(ctx context.Context, dir string) (*model.Folder, error) { + libs, err := s.ds.Library(ctx).GetAll() + if err != nil { + return nil, err + } + matcher := newLibraryMatcher(libs) + lib, ok := matcher.findLibrary(dir) + if !ok { + return nil, fmt.Errorf("%w: %s", errNotInLibrary, dir) + } + + folder, err := s.ds.Folder(ctx).GetByPath(lib, dir) + if err != nil { + return nil, fmt.Errorf("resolving folder for path %s: %w", dir, err) + } + folder.LibraryPath = lib.Path + return folder, nil +} + +func (s *playlists) ImportFromFolder(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) { + return s.importFromFolder(ctx, folder, filename, false) +} + +func (s *playlists) importFromFolder(ctx context.Context, folder *model.Folder, filename string, forceSync bool) (*model.Playlist, error) { + pls, err := s.parsePlaylist(ctx, filename, folder) + if err != nil { + log.Error(ctx, "Error parsing playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) + return nil, err + } + log.Debug(ctx, "Found playlist", "name", pls.Name, "lastUpdated", pls.UpdatedAt, "path", pls.Path, "numTracks", len(pls.Tracks)) + err = s.updatePlaylist(ctx, pls, forceSync) + if err != nil { + log.Error(ctx, "Error updating playlist", "path", filepath.Join(folder.AbsolutePath(), filename), err) + } + return pls, err +} + +func (s *playlists) ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) { + owner, _ := request.UserFrom(ctx) + pls := &model.Playlist{ + OwnerID: owner.ID, + Public: false, + Sync: false, + } + err := s.parseM3U(ctx, pls, nil, reader) + if err != nil { + log.Error(ctx, "Error parsing playlist", err) + return nil, err + } + err = s.ds.Playlist(ctx).Put(pls) + if err != nil { + log.Error(ctx, "Error saving playlist", err) + return nil, err + } + return pls, nil +} + +func (s *playlists) parsePlaylist(ctx context.Context, playlistFile string, folder *model.Folder) (*model.Playlist, error) { + pls, err := s.newSyncedPlaylist(folder.AbsolutePath(), playlistFile) + if err != nil { + return nil, err + } + + file, err := os.Open(pls.Path) + if err != nil { + return nil, err + } + defer file.Close() + + reader := ioutils.UTF8Reader(file) + extension := strings.ToLower(filepath.Ext(playlistFile)) + switch extension { + case ".nsp": + err = s.parseNSP(ctx, pls, reader) + default: + err = s.parseM3U(ctx, pls, folder, reader) + } + return pls, err +} + +// findByPathNormalized looks up a playlist by path, trying both NFC and NFD Unicode +// normalization forms to handle cross-platform filesystem differences. +func (s *playlists) findByPathNormalized(ctx context.Context, path string) (*model.Playlist, error) { + pls, err := s.ds.Playlist(ctx).FindByPath(path) + if errors.Is(err, model.ErrNotFound) { + altPath := norm.NFD.String(path) + if altPath == path { + altPath = norm.NFC.String(path) + } + if altPath != path { + pls, err = s.ds.Playlist(ctx).FindByPath(altPath) + } + } + return pls, err +} + +func (s *playlists) updatePlaylist(ctx context.Context, newPls *model.Playlist, forceSync bool) error { + owner, _ := request.UserFrom(ctx) + + pls, err := s.findByPathNormalized(ctx, newPls.Path) + if err != nil && !errors.Is(err, model.ErrNotFound) { + return err + } + alreadyImportedAndNotSynced := err == nil && !pls.Sync && !forceSync + if alreadyImportedAndNotSynced { + log.Debug(ctx, "Playlist already imported and not synced", "playlist", pls.Name, "path", pls.Path) + return nil + } + + if err == nil { + log.Info(ctx, "Updating synced playlist", "playlist", pls.Name, "path", newPls.Path) + newPls.ID = pls.ID + newPls.Name = pls.Name + newPls.Comment = pls.Comment + newPls.OwnerID = pls.OwnerID + newPls.Public = pls.Public + newPls.UploadedImage = pls.UploadedImage // Preserve manual upload + newPls.EvaluatedAt = &time.Time{} + } else { + log.Info(ctx, "Adding synced playlist", "playlist", newPls.Name, "path", newPls.Path, "owner", owner.UserName) + newPls.OwnerID = owner.ID + // For NSP files, Public may already be set from the file; for M3U, use server default + if !newPls.IsSmartPlaylist() { + newPls.Public = conf.Server.DefaultPlaylistPublicVisibility + } + } + return s.ds.Playlist(ctx).Put(newPls) +} diff --git a/core/playlists/import_test.go b/core/playlists/import_test.go new file mode 100644 index 000000000..f2866fb60 --- /dev/null +++ b/core/playlists/import_test.go @@ -0,0 +1,1085 @@ +package playlists_test + +import ( + "context" + "fmt" + "os" + "path/filepath" + "strconv" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "golang.org/x/text/unicode/norm" +) + +var _ = Describe("Playlists - Import", func() { + var ds *tests.MockDataStore + var ps playlists.Playlists + var mockPlsRepo *tests.MockPlaylistRepo + var mockLibRepo *tests.MockLibraryRepo + ctx := context.Background() + + BeforeEach(func() { + mockPlsRepo = tests.CreateMockPlaylistRepo() + mockLibRepo = &tests.MockLibraryRepo{} + ds = &tests.MockDataStore{ + MockedPlaylist: mockPlsRepo, + MockedLibrary: mockLibRepo, + } + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + Describe("ImportFromFolder", func() { + var folder *model.Folder + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + ds.MockedMediaFile = &mockedMediaFileRepo{} + libPath, _ := os.Getwd() + // Set up library with the actual library path that matches the folder + mockLibRepo.SetData([]model.Library{{ID: 1, Path: libPath}}) + folder = &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: libPath, + Path: "tests/fixtures", + Name: "playlists", + } + }) + + Describe("M3U", func() { + It("parses well-formed playlists", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "pls1.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("tests/fixtures/playlists/test.ogg")) + Expect(mockPlsRepo.Last).To(Equal(pls)) + }) + + It("parses playlists using LF ending", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "lf-ended.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("parses playlists using CR ending (old Mac format)", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "cr-ended.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("parses playlists with UTF-8 BOM marker", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "bom-test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("Test Playlist")) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) + }) + + It("parses UTF-16 LE encoded playlists with BOM and converts to UTF-8", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "bom-test-utf16.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("UTF-16 Test Playlist")) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) + }) + + It("parses #EXTALBUMARTURL with HTTP URL", func() { + conf.Server.EnableM3UExternalAlbumArt = true + + pls, err := ps.ImportFromFolder(ctx, folder, "pls-with-art-url.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal("https://example.com/cover.jpg")) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("parses #EXTALBUMARTURL with absolute local path", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "cover.jpg") + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + m3u := fmt.Sprintf("#EXTALBUMARTURL:%s\ntest.mp3\ntest.ogg\n", imgPath) + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3", "test.ogg"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(imgPath)) + }) + + It("parses #EXTALBUMARTURL with relative local path", func() { + tmpDir := GinkgoT().TempDir() + Expect(os.WriteFile(filepath.Join(tmpDir, "cover.jpg"), []byte("fake image"), 0600)).To(Succeed()) + + m3u := "#EXTALBUMARTURL:cover.jpg\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(filepath.Join(tmpDir, "cover.jpg"))) + }) + + It("parses #EXTALBUMARTURL with file:// URL", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "my cover.jpg") + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + m3u := fmt.Sprintf("#EXTALBUMARTURL:file://%s\ntest.mp3\n", strings.ReplaceAll(imgPath, " ", "%20")) + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(imgPath)) + }) + + It("preserves + in file:// URLs (PathUnescape, not QueryUnescape)", func() { + tmpDir := GinkgoT().TempDir() + imgPath := filepath.Join(tmpDir, "A+B.jpg") + Expect(os.WriteFile(imgPath, []byte("fake image"), 0600)).To(Succeed()) + + m3u := fmt.Sprintf("#EXTALBUMARTURL:file://%s\ntest.mp3\n", imgPath) + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal(imgPath)) + }) + + It("rejects #EXTALBUMARTURL with absolute path outside library boundaries", func() { + tests.SkipOnWindows("relies on Unix /etc filesystem") + tmpDir := GinkgoT().TempDir() + + m3u := "#EXTALBUMARTURL:/etc/passwd\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("rejects #EXTALBUMARTURL with file:// URL outside library boundaries", func() { + tmpDir := GinkgoT().TempDir() + + m3u := "#EXTALBUMARTURL:file:///etc/passwd\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("rejects #EXTALBUMARTURL with relative path escaping library", func() { + tmpDir := GinkgoT().TempDir() + + m3u := "#EXTALBUMARTURL:../../etc/passwd\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("ignores HTTP #EXTALBUMARTURL when EnableM3UExternalAlbumArt is false", func() { + conf.Server.EnableM3UExternalAlbumArt = false + + tmpDir := GinkgoT().TempDir() + m3u := "#EXTALBUMARTURL:https://example.com/cover.jpg\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + It("updates ExternalImageURL on re-scan even when UploadedImage is set", func() { + conf.Server.EnableM3UExternalAlbumArt = true + + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + m3u := "#EXTALBUMARTURL:https://example.com/new-cover.jpg\ntest.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: plsFile, + Sync: true, + UploadedImage: "existing-id.jpg", + ExternalImageURL: "https://example.com/old-cover.jpg", + } + mockPlsRepo.PathMap = map[string]*model.Playlist{plsFile: existingPls} + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.UploadedImage).To(Equal("existing-id.jpg")) + Expect(pls.ExternalImageURL).To(Equal("https://example.com/new-cover.jpg")) + }) + + It("skips non-synced playlist on re-import (respects user's choice)", func() { + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte("test.mp3\n"), 0600)).To(Succeed()) + + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: plsFile, + Sync: false, + OwnerID: "123", + } + mockPlsRepo.PathMap = map[string]*model.Playlist{plsFile: existingPls} + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + // updatePlaylist skips the non-synced playlist, so the returned + // playlist has no ID (was never persisted/updated). + Expect(pls.ID).To(BeEmpty()) + }) + + It("clears ExternalImageURL on re-scan when directive is removed", func() { + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3"}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + m3u := "test.mp3\n" + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte(m3u), 0600)).To(Succeed()) + + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: plsFile, + Sync: true, + ExternalImageURL: "https://example.com/old-cover.jpg", + } + mockPlsRepo.PathMap = map[string]*model.Playlist{plsFile: existingPls} + + plsFolder := &model.Folder{ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: ""} + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + }) + + Describe("NSP", func() { + It("parses well-formed playlists", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "recently_played.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last).To(Equal(pls)) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("Recently Played")) + Expect(pls.Comment).To(Equal("Recently played tracks")) + Expect(pls.Rules.Sort).To(Equal("lastPlayed")) + Expect(pls.Rules.Order).To(Equal("desc")) + Expect(pls.Rules.Limit).To(Equal(100)) + Expect(pls.Rules.Expression).To(BeAssignableToTypeOf(criteria.All{})) + }) + It("returns an error if the playlist is not well-formed", func() { + tests.SkipOnWindows("line-ending differences affect JSON error offset") + _, err := ps.ImportFromFolder(ctx, folder, "invalid_json.nsp") + Expect(err.Error()).To(ContainSubstring("line 19, column 1: invalid character '\\n'")) + }) + It("parses NSP with public: true and creates public playlist", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "public_playlist.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Public Playlist")) + Expect(pls.Public).To(BeTrue()) + }) + It("parses NSP with public: false and creates private playlist", func() { + pls, err := ps.ImportFromFolder(ctx, folder, "private_playlist.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Private Playlist")) + Expect(pls.Public).To(BeFalse()) + }) + It("uses server default when public field is absent", func() { + conf.Server.DefaultPlaylistPublicVisibility = true + + pls, err := ps.ImportFromFolder(ctx, folder, "recently_played.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Recently Played")) + Expect(pls.Public).To(BeTrue()) // Should be true since server default is true + }) + }) + + DescribeTable("Playlist filename Unicode normalization (regression fix-playlist-filename-normalization)", + func(storedForm, filesystemForm string) { + tests.SkipOnWindows("/tmp hardcoded in test") + // Use Polish characters that decompose: ó (U+00F3) -> o + combining acute (U+006F + U+0301) + plsNameNFC := "Piosenki_Polskie_zółć" // NFC form (composed) + plsNameNFD := norm.NFD.String(plsNameNFC) + Expect(plsNameNFD).ToNot(Equal(plsNameNFC)) // Verify they differ + + nameByForm := map[string]string{"NFC": plsNameNFC, "NFD": plsNameNFD} + storedName := nameByForm[storedForm] + filesystemName := nameByForm[filesystemForm] + + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{}} + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + // Create the playlist file on disk with the filesystem's normalization form + plsFile := tmpDir + "/" + filesystemName + ".m3u" + Expect(os.WriteFile(plsFile, []byte("#PLAYLIST:Test\n"), 0600)).To(Succeed()) + + // Pre-populate mock repo with the stored normalization form + storedPath := tmpDir + "/" + storedName + ".m3u" + existingPls := &model.Playlist{ + ID: "existing-id", + Name: "Existing Playlist", + Path: storedPath, + Sync: true, + } + mockPlsRepo.PathMap = map[string]*model.Playlist{storedPath: existingPls} + + // Import using the filesystem's normalization form + plsFolder := &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: tmpDir, + Path: "", + Name: "", + } + pls, err := ps.ImportFromFolder(ctx, plsFolder, filesystemName+".m3u") + Expect(err).ToNot(HaveOccurred()) + + // Should update existing playlist, not create new one + Expect(pls.ID).To(Equal("existing-id")) + Expect(pls.Name).To(Equal("Existing Playlist")) + }, + Entry("finds NFD-stored playlist when filesystem provides NFC path", "NFD", "NFC"), + Entry("finds NFC-stored playlist when filesystem provides NFD path", "NFC", "NFD"), + ) + + Describe("Cross-library relative paths", func() { + var tmpDir, plsDir, songsDir string + + BeforeEach(func() { + // Create temp directory structure + tmpDir = GinkgoT().TempDir() + plsDir = tmpDir + "/playlists" + songsDir = tmpDir + "/songs" + Expect(os.Mkdir(plsDir, 0755)).To(Succeed()) + Expect(os.Mkdir(songsDir, 0755)).To(Succeed()) + + // Setup two different libraries with paths matching our temp structure + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: songsDir}, + {ID: 2, Path: plsDir}, + }) + + // Create a mock media file repository that returns files for both libraries + // Note: The paths are relative to their respective library roots + ds.MockedMediaFile = &mockedMediaFileFromListRepo{ + data: []string{ + "abc.mp3", // This is songs/abc.mp3 relative to songsDir + "def.mp3", // This is playlists/def.mp3 relative to plsDir + }, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("handles relative paths that reference files in other libraries", func() { + // Create a temporary playlist file with relative path + plsContent := "#PLAYLIST:Cross Library Test\n../songs/abc.mp3\ndef.mp3" + plsFile := plsDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + // Playlist is in the Playlists library folder + // Important: Path should be relative to LibraryPath, and Name is the folder name + plsFolder := &model.Folder{ + ID: "2", + LibraryID: 2, + LibraryPath: plsDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("abc.mp3")) // From songsDir library + Expect(pls.Tracks[1].Path).To(Equal("def.mp3")) // From plsDir library + }) + + It("ignores paths that point outside all libraries", func() { + // Create a temporary playlist file with path outside libraries + plsContent := "#PLAYLIST:Outside Test\n../../outside.mp3\nabc.mp3" + plsFile := plsDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + plsFolder := &model.Folder{ + ID: "2", + LibraryID: 2, + LibraryPath: plsDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + // Should only find abc.mp3, not outside.mp3 + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("abc.mp3")) + }) + + It("handles relative paths with multiple '../' components", func() { + // Create a nested structure: tmpDir/playlists/subfolder/test.m3u + subFolder := plsDir + "/subfolder" + Expect(os.Mkdir(subFolder, 0755)).To(Succeed()) + + // Create the media file in the subfolder directory + // The mock will return it as "def.mp3" relative to plsDir + ds.MockedMediaFile = &mockedMediaFileFromListRepo{ + data: []string{ + "abc.mp3", // From songsDir library + "def.mp3", // From plsDir library root + }, + } + + // From subfolder, ../../songs/abc.mp3 should resolve to songs library + // ../def.mp3 should resolve to plsDir/def.mp3 + plsContent := "#PLAYLIST:Nested Test\n../../songs/abc.mp3\n../def.mp3" + plsFile := subFolder + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + // The folder: AbsolutePath = LibraryPath + Path + Name + // So for /playlists/subfolder: LibraryPath=/playlists, Path="", Name="subfolder" + plsFolder := &model.Folder{ + ID: "2", + LibraryID: 2, + LibraryPath: plsDir, + Path: "", // Empty because subfolder is directly under library root + Name: "subfolder", // The folder name + } + + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("abc.mp3")) // From songsDir library + Expect(pls.Tracks[1].Path).To(Equal("def.mp3")) // From plsDir library root + }) + + It("correctly resolves libraries when one path is a prefix of another", func() { + // This tests the bug where /music would match before /music-classical + // Create temp directory structure with prefix conflict + tmpDir := GinkgoT().TempDir() + musicDir := tmpDir + "/music" + musicClassicalDir := tmpDir + "/music-classical" + Expect(os.Mkdir(musicDir, 0755)).To(Succeed()) + Expect(os.Mkdir(musicClassicalDir, 0755)).To(Succeed()) + + // Setup two libraries where one is a prefix of the other + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: musicDir}, // /tmp/xxx/music + {ID: 2, Path: musicClassicalDir}, // /tmp/xxx/music-classical + }) + + // Mock will return tracks from both libraries + ds.MockedMediaFile = &mockedMediaFileFromListRepo{ + data: []string{ + "rock.mp3", // From music library + "bach.mp3", // From music-classical library + }, + } + + // Create playlist in music library that references music-classical + plsContent := "#PLAYLIST:Cross Prefix Test\nrock.mp3\n../music-classical/bach.mp3" + plsFile := musicDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + plsFolder := &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: musicDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Tracks[0].Path).To(Equal("rock.mp3")) // From music library + Expect(pls.Tracks[1].Path).To(Equal("bach.mp3")) // From music-classical library (not music!) + }) + + It("correctly handles identical relative paths from different libraries", func() { + // This tests the bug where two libraries have files at the same relative path + // and only one appears in the playlist + tmpDir := GinkgoT().TempDir() + musicDir := tmpDir + "/music" + classicalDir := tmpDir + "/classical" + Expect(os.Mkdir(musicDir, 0755)).To(Succeed()) + Expect(os.Mkdir(classicalDir, 0755)).To(Succeed()) + Expect(os.MkdirAll(musicDir+"/album", 0755)).To(Succeed()) + Expect(os.MkdirAll(classicalDir+"/album", 0755)).To(Succeed()) + // Create placeholder files so paths resolve correctly + Expect(os.WriteFile(musicDir+"/album/track.mp3", []byte{}, 0600)).To(Succeed()) + Expect(os.WriteFile(classicalDir+"/album/track.mp3", []byte{}, 0600)).To(Succeed()) + + // Both libraries have a file at "album/track.mp3" + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: musicDir}, + {ID: 2, Path: classicalDir}, + }) + + // Mock returns files with same relative path but different IDs and library IDs + // Keys use the library-qualified format: "libraryID:path" + ds.MockedMediaFile = &mockedMediaFileRepo{ + data: map[string]model.MediaFile{ + "1:album/track.mp3": {ID: "music-track", Path: "album/track.mp3", LibraryID: 1, Title: "Rock Song"}, + "2:album/track.mp3": {ID: "classical-track", Path: "album/track.mp3", LibraryID: 2, Title: "Classical Piece"}, + }, + } + // Recreate playlists service to pick up new mock + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + // Create playlist in music library that references both tracks + plsContent := "#PLAYLIST:Same Path Test\nalbum/track.mp3\n../classical/album/track.mp3" + plsFile := musicDir + "/test.m3u" + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + plsFolder := &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: musicDir, + Path: "", + Name: "", + } + + pls, err := ps.ImportFromFolder(ctx, plsFolder, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + + // Should have BOTH tracks, not just one + Expect(pls.Tracks).To(HaveLen(2), "Playlist should contain both tracks with same relative path") + + // Verify we got tracks from DIFFERENT libraries (the key fix!) + // Collect the library IDs + libIDs := make(map[int]bool) + for _, track := range pls.Tracks { + libIDs[track.LibraryID] = true + } + Expect(libIDs).To(HaveLen(2), "Tracks should come from two different libraries") + Expect(libIDs[1]).To(BeTrue(), "Should have track from library 1") + Expect(libIDs[2]).To(BeTrue(), "Should have track from library 2") + + // Both tracks should have the same relative path + Expect(pls.Tracks[0].Path).To(Equal("album/track.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("album/track.mp3")) + }) + }) + }) + + Describe("ImportFile", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ds.MockedMediaFile = &mockedMediaFileFromListRepo{data: []string{"test.mp3", "test.ogg"}} + }) + + It("resolves file inside a library and imports it", func() { + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + + mockFolderRepo := &mockFolderRepoForImport{ + folder: &model.Folder{ + ID: "1", + LibraryID: 1, + LibraryPath: tmpDir, + Path: "", + Name: "", + }, + } + ds.MockedFolder = mockFolderRepo + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsContent := "#PLAYLIST:My Playlist\ntest.mp3\ntest.ogg\n" + plsFile := filepath.Join(tmpDir, "my-playlist.m3u") + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + pls, err := ps.ImportFile(ctx, plsFile, true) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("My Playlist")) + Expect(pls.Tracks).To(HaveLen(2)) + Expect(pls.Path).To(Equal(plsFile)) + Expect(pls.Sync).To(BeTrue()) + }) + + It("records path for files outside all libraries", func() { + tmpDir := GinkgoT().TempDir() + libDir := filepath.Join(tmpDir, "music") + Expect(os.Mkdir(libDir, 0755)).To(Succeed()) + mockLibRepo.SetData([]model.Library{{ID: 1, Path: libDir}}) + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsContent := "#PLAYLIST:External Playlist\n" + libDir + "/test.mp3\n" + plsFile := filepath.Join(tmpDir, "external.m3u") + Expect(os.WriteFile(plsFile, []byte(plsContent), 0600)).To(Succeed()) + + pls, err := ps.ImportFile(ctx, plsFile, false) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("External Playlist")) + Expect(pls.Path).To(Equal(plsFile)) + Expect(pls.Sync).To(BeFalse()) + }) + + It("imports with Sync=false", func() { + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + + mockFolderRepo := &mockFolderRepoForImport{ + folder: &model.Folder{ + ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: "", + }, + } + ds.MockedFolder = mockFolderRepo + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte("test.mp3\n"), 0600)).To(Succeed()) + + pls, err := ps.ImportFile(ctx, plsFile, false) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Sync).To(BeFalse()) + }) + + It("imports with Sync=true", func() { + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + + mockFolderRepo := &mockFolderRepoForImport{ + folder: &model.Folder{ + ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: "", + }, + } + ds.MockedFolder = mockFolderRepo + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte("test.mp3\n"), 0600)).To(Succeed()) + + pls, err := ps.ImportFile(ctx, plsFile, true) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Sync).To(BeTrue()) + }) + + It("upgrades non-synced playlist to synced on re-import with sync=true", func() { + tmpDir := GinkgoT().TempDir() + mockLibRepo.SetData([]model.Library{{ID: 1, Path: tmpDir}}) + + mockFolderRepo := &mockFolderRepoForImport{ + folder: &model.Folder{ + ID: "1", LibraryID: 1, LibraryPath: tmpDir, Path: "", Name: "", + }, + } + ds.MockedFolder = mockFolderRepo + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + + plsFile := filepath.Join(tmpDir, "test.m3u") + Expect(os.WriteFile(plsFile, []byte("test.mp3\n"), 0600)).To(Succeed()) + + existingPls := &model.Playlist{ + ID: "existing-id", Name: "Existing", Path: plsFile, + Sync: false, OwnerID: "123", + } + mockPlsRepo.PathMap = map[string]*model.Playlist{plsFile: existingPls} + + pls, err := ps.ImportFile(ctx, plsFile, true) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ID).To(Equal("existing-id")) + Expect(pls.Sync).To(BeTrue()) + }) + }) + + Describe("ImportM3U", func() { + var repo *mockedMediaFileFromListRepo + BeforeEach(func() { + repo = &mockedMediaFileFromListRepo{} + ds.MockedMediaFile = repo + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + mockLibRepo.SetData([]model.Library{{ID: 1, Path: "/music"}, {ID: 2, Path: "/new"}}) + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + It("parses well-formed playlists", func() { + repo.data = []string{ + "tests/test.mp3", + "tests/test.ogg", + "tests/01 Invisible (RED) Edit Version.mp3", + "downloads/newfile.flac", + } + m3u := strings.Join([]string{ + "#PLAYLIST:playlist 1", + "/music/tests/test.mp3", + "/music/tests/test.ogg", + "/new/downloads/newfile.flac", + "file:///music/tests/01%20Invisible%20(RED)%20Edit%20Version.mp3", + }, "\n") + f := strings.NewReader(m3u) + + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.OwnerID).To(Equal("123")) + Expect(pls.Name).To(Equal("playlist 1")) + Expect(pls.Sync).To(BeFalse()) + Expect(pls.Tracks).To(HaveLen(4)) + Expect(pls.Tracks[0].Path).To(Equal("tests/test.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("tests/test.ogg")) + Expect(pls.Tracks[2].Path).To(Equal("downloads/newfile.flac")) + Expect(pls.Tracks[3].Path).To(Equal("tests/01 Invisible (RED) Edit Version.mp3")) + Expect(mockPlsRepo.Last).To(Equal(pls)) + }) + + It("sets the playlist name as a timestamp if the #PLAYLIST directive is not present", func() { + repo.data = []string{ + "tests/test.mp3", + "tests/test.ogg", + "/tests/01 Invisible (RED) Edit Version.mp3", + } + m3u := strings.Join([]string{ + "/music/tests/test.mp3", + "/music/tests/test.ogg", + }, "\n") + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + _, err = time.Parse(time.RFC3339, pls.Name) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(2)) + }) + + It("returns only tracks that exist in the database and in the same order as the m3u", func() { + repo.data = []string{ + "album1/test1.mp3", + "album2/test2.mp3", + "album3/test3.mp3", + } + m3u := strings.Join([]string{ + "/music/album3/test3.mp3", + "/music/album1/test1.mp3", + "/music/album4/test4.mp3", + "/music/album2/test2.mp3", + }, "\n") + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(3)) + Expect(pls.Tracks[0].Path).To(Equal("album3/test3.mp3")) + Expect(pls.Tracks[1].Path).To(Equal("album1/test1.mp3")) + Expect(pls.Tracks[2].Path).To(Equal("album2/test2.mp3")) + }) + + It("is case-insensitive when comparing paths", func() { + repo.data = []string{ + "abc/tEsT1.Mp3", + } + m3u := strings.Join([]string{ + "/music/ABC/TeSt1.mP3", + }, "\n") + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("abc/tEsT1.Mp3")) + }) + + It("parses #EXTALBUMARTURL with HTTP URL via ImportM3U", func() { + conf.Server.EnableM3UExternalAlbumArt = true + + repo.data = []string{"tests/test.mp3"} + m3u := "#EXTALBUMARTURL:https://example.com/cover.jpg\n/music/tests/test.mp3\n" + pls, err := ps.ImportM3U(ctx, strings.NewReader(m3u)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(Equal("https://example.com/cover.jpg")) + }) + + It("ignores relative #EXTALBUMARTURL when imported via API (no folder context)", func() { + repo.data = []string{"tests/test.mp3"} + m3u := "#EXTALBUMARTURL:cover.jpg\n/music/tests/test.mp3\n" + pls, err := ps.ImportM3U(ctx, strings.NewReader(m3u)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ExternalImageURL).To(BeEmpty()) + }) + + // Fullwidth characters (e.g., ABCD) are not handled by SQLite's NOCASE collation, + // so we need exact matching for non-ASCII characters. + It("matches fullwidth characters exactly (SQLite NOCASE limitation)", func() { + // Fullwidth uppercase ACROSS (U+FF21, U+FF23, U+FF32, U+FF2F, U+FF33, U+FF33) + repo.data = []string{ + "plex/02 - ACROSS.flac", + } + m3u := "/music/plex/02 - ACROSS.flac\n" + f := strings.NewReader(m3u) + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal("plex/02 - ACROSS.flac")) + }) + + // Unicode normalization tests: NFC (composed) vs NFD (decomposed) forms + // macOS stores paths in NFD, Linux/Windows use NFC. Playlists may use either form. + DescribeTable("matches paths across Unicode NFC/NFD normalization", + func(description, pathNFC string, dbForm, playlistForm norm.Form) { + pathNFD := norm.NFD.String(pathNFC) + Expect(pathNFD).ToNot(Equal(pathNFC), "test path should have decomposable characters") + + // Set up DB with specified normalization form + var dbPath string + if dbForm == norm.NFC { + dbPath = pathNFC + } else { + dbPath = pathNFD + } + repo.data = []string{dbPath} + + // Set up playlist with specified normalization form + var playlistPath string + if playlistForm == norm.NFC { + playlistPath = pathNFC + } else { + playlistPath = pathNFD + } + m3u := "/music/" + playlistPath + "\n" + f := strings.NewReader(m3u) + + pls, err := ps.ImportM3U(ctx, f) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].Path).To(Equal(dbPath)) + }, + // French: è (U+00E8) decomposes to e + combining grave (U+0065 + U+0300) + Entry("French diacritics - DB:NFD, playlist:NFC", + "macOS DB with Apple Music playlist", + "artist/Michèle/song.mp3", norm.NFD, norm.NFC), + + // Japanese Katakana: ド (U+30C9) decomposes to ト (U+30C8) + combining dakuten (U+3099) + Entry("Japanese Katakana with dakuten - DB:NFC, playlist:NFC (#4884)", + "Linux/Windows DB with NFC playlist", + "artist/\u30a2\u30a4\u30c9\u30eb/\u30c9\u30ea\u30fc\u30e0\u30bd\u30f3\u30b0.mp3", norm.NFC, norm.NFC), + Entry("Japanese Katakana with dakuten - DB:NFD, playlist:NFC (#4884)", + "macOS DB with NFC playlist", + "artist/\u30a2\u30a4\u30c9\u30eb/\u30c9\u30ea\u30fc\u30e0\u30bd\u30f3\u30b0.mp3", norm.NFD, norm.NFC), + + // Cyrillic: й (U+0439) decomposes to и (U+0438) + combining breve (U+0306) + Entry("Cyrillic characters - DB:NFD, playlist:NFC (#4791)", + "macOS DB with NFC playlist", + "Жуки/Батарейка/01 - Разлюбила.mp3", norm.NFD, norm.NFC), + + // Polish: ó (U+00F3) decomposes to o + combining acute (U+0301) + Entry("Polish diacritics - DB:NFD, playlist:NFC (#4663)", + "macOS DB with NFC playlist", + "Zespół/Człowiek/Piosenka o miłości.mp3", norm.NFD, norm.NFC), + Entry("Polish diacritics - DB:NFC, playlist:NFD", + "Linux/Windows DB with macOS-exported playlist", + "Zespół/Człowiek/Piosenka o miłości.mp3", norm.NFC, norm.NFD), + ) + + }) + + Describe("InPath", func() { + var folder model.Folder + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + folder = model.Folder{ + LibraryPath: "/music", + Path: "playlists/abc", + Name: "folder1", + } + }) + + It("returns true if PlaylistsPath is empty", func() { + conf.Server.PlaylistsPath = "" + Expect(playlists.InPath(folder)).To(BeTrue()) + }) + + It("returns true if PlaylistsPath is any (**/**)", func() { + conf.Server.PlaylistsPath = "**/**" + Expect(playlists.InPath(folder)).To(BeTrue()) + }) + + It("returns true if folder is in PlaylistsPath", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-playlists)") + conf.Server.PlaylistsPath = "other/**:playlists/**" + Expect(playlists.InPath(folder)).To(BeTrue()) + }) + + It("returns false if folder is not in PlaylistsPath", func() { + conf.Server.PlaylistsPath = "other" + Expect(playlists.InPath(folder)).To(BeFalse()) + }) + + It("returns true if for a playlist in root of MusicFolder if PlaylistsPath is '.'", func() { + conf.Server.PlaylistsPath = "." + Expect(playlists.InPath(folder)).To(BeFalse()) + + folder2 := model.Folder{ + LibraryPath: "/music", + Path: "", + Name: ".", + } + + Expect(playlists.InPath(folder2)).To(BeTrue()) + }) + }) +}) + +// mockedMediaFileRepo's FindByPaths method returns MediaFiles for the given paths. +// If data map is provided, looks up files by key; otherwise creates them from paths. +type mockedMediaFileRepo struct { + model.MediaFileRepository + data map[string]model.MediaFile +} + +func (r *mockedMediaFileRepo) FindByPaths(paths []string) (model.MediaFiles, error) { + var mfs model.MediaFiles + + // If data map provided, look up files + if r.data != nil { + for _, path := range paths { + if mf, ok := r.data[path]; ok { + mfs = append(mfs, mf) + } + } + return mfs, nil + } + + // Otherwise, create MediaFiles from paths + for idx, path := range paths { + // Strip library qualifier if present (format: "libraryID:path") + actualPath := path + libraryID := 1 + if parts := strings.SplitN(path, ":", 2); len(parts) == 2 { + if id, err := strconv.Atoi(parts[0]); err == nil { + libraryID = id + actualPath = parts[1] + } + } + + mfs = append(mfs, model.MediaFile{ + ID: strconv.Itoa(idx), + Path: actualPath, + LibraryID: libraryID, + }) + } + return mfs, nil +} + +// mockedMediaFileFromListRepo's FindByPaths method returns a list of MediaFiles based on the data field +type mockedMediaFileFromListRepo struct { + model.MediaFileRepository + data []string +} + +func (r *mockedMediaFileFromListRepo) FindByPaths(paths []string) (model.MediaFiles, error) { + var mfs model.MediaFiles + + for idx, dataPath := range r.data { + for _, requestPath := range paths { + // Strip library qualifier if present (format: "libraryID:path") + actualPath := requestPath + libraryID := 1 + if parts := strings.SplitN(requestPath, ":", 2); len(parts) == 2 { + if id, err := strconv.Atoi(parts[0]); err == nil { + libraryID = id + actualPath = parts[1] + } + } + + // Case-insensitive comparison (like SQL's "collate nocase"), but with no + // implicit Unicode normalization (SQLite does not normalize NFC/NFD). + if strings.EqualFold(actualPath, dataPath) { + mfs = append(mfs, model.MediaFile{ + ID: strconv.Itoa(idx), + Path: dataPath, // Return original path from DB + LibraryID: libraryID, + }) + break + } + } + } + return mfs, nil +} + +type mockFolderRepoForImport struct { + model.FolderRepository + folder *model.Folder +} + +func (m *mockFolderRepoForImport) GetByPath(_ model.Library, _ string) (*model.Folder, error) { + if m.folder != nil { + return m.folder, nil + } + return nil, model.ErrNotFound +} diff --git a/core/playlists/parse_m3u.go b/core/playlists/parse_m3u.go new file mode 100644 index 000000000..a64c337c9 --- /dev/null +++ b/core/playlists/parse_m3u.go @@ -0,0 +1,333 @@ +package playlists + +import ( + "cmp" + "context" + "fmt" + "io" + "net/url" + "path/filepath" + "slices" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/slice" + "golang.org/x/text/unicode/norm" +) + +func (s *playlists) parseM3U(ctx context.Context, pls *model.Playlist, folder *model.Folder, reader io.Reader) error { + mediaFileRepository := s.ds.MediaFile(ctx) + resolver, err := newPathResolver(ctx, s.ds) + if err != nil { + return err + } + var mfs model.MediaFiles + // Chunk size of 100 lines, as each line can generate up to 4 lookup candidates + // (NFC/NFD × raw/lowercase), and SQLite has a max expression tree depth of 1000. + for lines := range slice.CollectChunks(slice.LinesFrom(reader), 100) { + filteredLines := make([]string, 0, len(lines)) + for _, line := range lines { + line := strings.TrimSpace(line) + if after, ok := strings.CutPrefix(line, "#PLAYLIST:"); ok { + pls.Name = after + continue + } + if after, ok := strings.CutPrefix(line, "#EXTALBUMARTURL:"); ok { + pls.ExternalImageURL = resolveImageURL(after, folder, resolver.matcher) + continue + } + // Skip empty lines and extended info + if line == "" || strings.HasPrefix(line, "#") { + continue + } + if after, ok := strings.CutPrefix(line, "file://"); ok { + line = after + line, _ = url.PathUnescape(line) + } + if !model.IsAudioFile(line) { + continue + } + filteredLines = append(filteredLines, line) + } + resolvedPaths, err := resolver.resolvePaths(ctx, folder, filteredLines) + if err != nil { + log.Warn(ctx, "Error resolving paths in playlist", "playlist", pls.Name, err) + continue + } + + // SQLite comparisons do not perform Unicode normalization, and filesystem normalization + // differs across platforms (macOS often yields NFD, while Linux/Windows typically use NFC). + // Generate lookup candidates for both forms so playlist entries match DB paths regardless + // of the original normalization. See https://github.com/navidrome/navidrome/issues/4884 + // + // We also include the original (non-lowercased) paths because SQLite's COLLATE NOCASE + // only handles ASCII case-insensitivity. Non-ASCII characters like fullwidth letters + // (e.g., ABCD vs abcd) are not matched case-insensitively by NOCASE. + lookupCandidates := make([]string, 0, len(resolvedPaths)*4) + seen := make(map[string]struct{}, len(resolvedPaths)*4) + for _, path := range resolvedPaths { + // Add original paths first (for exact matching of non-ASCII characters) + nfcRaw := norm.NFC.String(path) + if _, ok := seen[nfcRaw]; !ok { + seen[nfcRaw] = struct{}{} + lookupCandidates = append(lookupCandidates, nfcRaw) + } + nfdRaw := norm.NFD.String(path) + if _, ok := seen[nfdRaw]; !ok { + seen[nfdRaw] = struct{}{} + lookupCandidates = append(lookupCandidates, nfdRaw) + } + + // Add lowercased paths (for ASCII case-insensitive matching via NOCASE) + nfc := strings.ToLower(nfcRaw) + if _, ok := seen[nfc]; !ok { + seen[nfc] = struct{}{} + lookupCandidates = append(lookupCandidates, nfc) + } + nfd := strings.ToLower(nfdRaw) + if _, ok := seen[nfd]; !ok { + seen[nfd] = struct{}{} + lookupCandidates = append(lookupCandidates, nfd) + } + } + + found, err := mediaFileRepository.FindByPaths(lookupCandidates) + if err != nil { + log.Warn(ctx, "Error reading files from DB", "playlist", pls.Name, err) + continue + } + + // Build lookup map with library-qualified keys, normalized for comparison. + // Canonicalize to NFC so NFD/NFC become comparable. + existing := make(map[string]int, len(found)) + for idx := range found { + key := fmt.Sprintf("%d:%s", found[idx].LibraryID, strings.ToLower(norm.NFC.String(found[idx].Path))) + existing[key] = idx + } + + // Find media files in the order of the resolved paths, to keep playlist order. + // Both `existing` keys and `resolvedPaths` use the library-qualified format "libraryID:relativePath", + // so normalizing the full string produces matching keys (digits and ':' are ASCII-invariant). + for _, path := range resolvedPaths { + key := strings.ToLower(norm.NFC.String(path)) + idx, ok := existing[key] + if ok { + mfs = append(mfs, found[idx]) + } else { + // Prefer logging a composed representation when possible to avoid confusing output + // with decomposed combining marks. + log.Warn(ctx, "Path in playlist not found", "playlist", pls.Name, "path", norm.NFC.String(path)) + } + } + } + if pls.Name == "" { + pls.Name = time.Now().Format(time.RFC3339) + } + pls.Tracks = nil + pls.AddMediaFiles(mfs) + + return nil +} + +// pathResolution holds the result of resolving a playlist path to a library-relative path. +type pathResolution struct { + absolutePath string + libraryPath string + libraryID int + valid bool +} + +// ToQualifiedString converts the path resolution to a library-qualified string with forward slashes. +// Format: "libraryID:relativePath" with forward slashes for path separators. +func (r pathResolution) ToQualifiedString() (string, error) { + if !r.valid { + return "", fmt.Errorf("invalid path resolution") + } + relativePath, err := filepath.Rel(r.libraryPath, r.absolutePath) + if err != nil { + return "", err + } + // Convert path separators to forward slashes + return fmt.Sprintf("%d:%s", r.libraryID, filepath.ToSlash(relativePath)), nil +} + +// libraryMatcher holds sorted libraries with cleaned paths for efficient path matching. +type libraryMatcher struct { + libraries model.Libraries + cleanedPaths []string +} + +// findLibraryForPath finds which library contains the given absolute path. +// Returns library ID and path, or 0 and empty string if not found. +func (lm *libraryMatcher) findLibraryForPath(absolutePath string) (int, string) { + lib, ok := lm.findLibrary(absolutePath) + if !ok { + return 0, "" + } + return lib.ID, filepath.Clean(lib.Path) +} + +// findLibrary checks if the absolute path is under any of the library paths. +func (lm *libraryMatcher) findLibrary(absolutePath string) (model.Library, bool) { + // Check sorted libraries (longest path first) to find the best match + for i, cleanLibPath := range lm.cleanedPaths { + // Check if absolutePath is under this library path + if strings.HasPrefix(absolutePath, cleanLibPath) { + // Ensure it's a proper path boundary (not just a prefix) + if len(absolutePath) == len(cleanLibPath) || absolutePath[len(cleanLibPath)] == filepath.Separator { + return lm.libraries[i], true + } + } + } + return model.Library{}, false +} + +// newLibraryMatcher creates a libraryMatcher with libraries sorted by path length (longest first). +// This ensures correct matching when library paths are prefixes of each other. +// Example: /music-classical must be checked before /music +// Otherwise, /music-classical/track.mp3 would match /music instead of /music-classical +func newLibraryMatcher(libs model.Libraries) *libraryMatcher { + // Sort libraries by path length (descending) to ensure longest paths match first. + slices.SortFunc(libs, func(i, j model.Library) int { + return cmp.Compare(len(j.Path), len(i.Path)) // Reverse order for descending + }) + + // Pre-clean all library paths once for efficient matching + cleanedPaths := make([]string, len(libs)) + for i, lib := range libs { + cleanedPaths[i] = filepath.Clean(lib.Path) + } + return &libraryMatcher{ + libraries: libs, + cleanedPaths: cleanedPaths, + } +} + +// pathResolver handles path resolution logic for playlist imports. +type pathResolver struct { + matcher *libraryMatcher +} + +// newPathResolver creates a pathResolver with libraries loaded from the datastore. +func newPathResolver(ctx context.Context, ds model.DataStore) (*pathResolver, error) { + libs, err := ds.Library(ctx).GetAll() + if err != nil { + return nil, err + } + matcher := newLibraryMatcher(libs) + return &pathResolver{matcher: matcher}, nil +} + +// resolvePath determines the absolute path and library path for a playlist entry. +// For absolute paths, it uses them directly. +// For relative paths, it resolves them relative to the playlist's folder location. +// Example: playlist at /music/playlists/test.m3u with line "../songs/abc.mp3" +// +// resolves to /music/songs/abc.mp3 +func (r *pathResolver) resolvePath(line string, folder *model.Folder) pathResolution { + var absolutePath string + if folder != nil && !filepath.IsAbs(line) { + // Resolve relative path to absolute path based on playlist location + absolutePath = filepath.Clean(filepath.Join(folder.AbsolutePath(), line)) + } else { + // Use absolute path directly after cleaning + absolutePath = filepath.Clean(line) + } + + return r.findInLibraries(absolutePath) +} + +// findInLibraries matches an absolute path against all known libraries and returns +// a pathResolution with the library information. Returns an invalid resolution if +// the path is not found in any library. +func (r *pathResolver) findInLibraries(absolutePath string) pathResolution { + libID, libPath := r.matcher.findLibraryForPath(absolutePath) + if libID == 0 { + return pathResolution{valid: false} + } + return pathResolution{ + absolutePath: absolutePath, + libraryPath: libPath, + libraryID: libID, + valid: true, + } +} + +// resolvePaths converts playlist file paths to library-qualified paths (format: "libraryID:relativePath"). +// For relative paths, it resolves them to absolute paths first, then determines which +// library they belong to. This allows playlists to reference files across library boundaries. +func (r *pathResolver) resolvePaths(ctx context.Context, folder *model.Folder, lines []string) ([]string, error) { + results := make([]string, 0, len(lines)) + for idx, line := range lines { + resolution := r.resolvePath(line, folder) + + if !resolution.valid { + log.Warn(ctx, "Path in playlist not found in any library", "path", line, "line", idx) + continue + } + + qualifiedPath, err := resolution.ToQualifiedString() + if err != nil { + log.Debug(ctx, "Error getting library-qualified path", "path", line, + "libPath", resolution.libraryPath, "filePath", resolution.absolutePath, err) + continue + } + + results = append(results, qualifiedPath) + } + + return results, nil +} + +// resolveImageURL resolves an #EXTALBUMARTURL value to a storable string. +// HTTP(S) URLs are stored as-is (gated by EnableM3UExternalAlbumArt). +// Local paths (file://, absolute, or relative) are resolved to an absolute path +// and validated against known library boundaries via matcher. +func resolveImageURL(value string, folder *model.Folder, matcher *libraryMatcher) string { + value = strings.TrimSpace(value) + if value == "" { + return "" + } + + // HTTP(S) URLs — store as-is, but only if external album art is enabled + if strings.HasPrefix(value, "http://") || strings.HasPrefix(value, "https://") { + if !conf.Server.EnableM3UExternalAlbumArt { + return "" + } + return value + } + + // Resolve to local absolute path + localPath, ok := resolveLocalPath(value, folder) + if !ok { + return "" + } + + // Validate path is within a known library + if libID, _ := matcher.findLibraryForPath(localPath); libID == 0 { + return "" + } + return localPath +} + +// resolveLocalPath converts a file://, absolute, or relative path to a clean absolute path. +// Returns ("", false) if the path cannot be resolved. +func resolveLocalPath(value string, folder *model.Folder) (string, bool) { + if after, ok := strings.CutPrefix(value, "file://"); ok { + decoded, err := url.PathUnescape(after) + if err != nil { + return "", false + } + return filepath.Clean(decoded), true + } + if filepath.IsAbs(value) { + return filepath.Clean(value), true + } + if folder == nil { + return "", false + } + return filepath.Clean(filepath.Join(folder.AbsolutePath(), value)), true +} diff --git a/core/playlists/parse_m3u_test.go b/core/playlists/parse_m3u_test.go new file mode 100644 index 000000000..d7fd5e001 --- /dev/null +++ b/core/playlists/parse_m3u_test.go @@ -0,0 +1,408 @@ +package playlists + +import ( + "context" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("libraryMatcher", func() { + var ds *tests.MockDataStore + var mockLibRepo *tests.MockLibraryRepo + ctx := context.Background() + + BeforeEach(func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-playlists)") + mockLibRepo = &tests.MockLibraryRepo{} + ds = &tests.MockDataStore{ + MockedLibrary: mockLibRepo, + } + }) + + // Helper function to create a libraryMatcher from the mock datastore + createMatcher := func(ds model.DataStore) *libraryMatcher { + libs, err := ds.Library(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + return newLibraryMatcher(libs) + } + + Describe("Longest library path matching", func() { + It("matches the longest library path when multiple libraries share a prefix", func() { + // Setup libraries with prefix conflicts + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + {ID: 2, Path: "/music-classical"}, + {ID: 3, Path: "/music-classical/opera"}, + }) + + matcher := createMatcher(ds) + + // Test that longest path matches first and returns correct library ID + testCases := []struct { + path string + expectedLibID int + expectedLibPath string + }{ + {"/music-classical/opera/track.mp3", 3, "/music-classical/opera"}, + {"/music-classical/track.mp3", 2, "/music-classical"}, + {"/music/track.mp3", 1, "/music"}, + {"/music-classical/opera/subdir/file.mp3", 3, "/music-classical/opera"}, + } + + for _, tc := range testCases { + libID, libPath := matcher.findLibraryForPath(tc.path) + Expect(libID).To(Equal(tc.expectedLibID), "Path %s should match library ID %d, but got %d", tc.path, tc.expectedLibID, libID) + Expect(libPath).To(Equal(tc.expectedLibPath), "Path %s should match library path %s, but got %s", tc.path, tc.expectedLibPath, libPath) + } + }) + + It("handles libraries with similar prefixes but different structures", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/home/user/music"}, + {ID: 2, Path: "/home/user/music-backup"}, + }) + + matcher := createMatcher(ds) + + // Test that music-backup library is matched correctly + libID, libPath := matcher.findLibraryForPath("/home/user/music-backup/track.mp3") + Expect(libID).To(Equal(2)) + Expect(libPath).To(Equal("/home/user/music-backup")) + + // Test that music library is still matched correctly + libID, libPath = matcher.findLibraryForPath("/home/user/music/track.mp3") + Expect(libID).To(Equal(1)) + Expect(libPath).To(Equal("/home/user/music")) + }) + + It("matches path that is exactly the library root", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + {ID: 2, Path: "/music-classical"}, + }) + + matcher := createMatcher(ds) + + // Exact library path should match + libID, libPath := matcher.findLibraryForPath("/music-classical") + Expect(libID).To(Equal(2)) + Expect(libPath).To(Equal("/music-classical")) + }) + + It("handles complex nested library structures", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/media"}, + {ID: 2, Path: "/media/audio"}, + {ID: 3, Path: "/media/audio/classical"}, + {ID: 4, Path: "/media/audio/classical/baroque"}, + }) + + matcher := createMatcher(ds) + + testCases := []struct { + path string + expectedLibID int + expectedLibPath string + }{ + {"/media/audio/classical/baroque/bach/track.mp3", 4, "/media/audio/classical/baroque"}, + {"/media/audio/classical/mozart/track.mp3", 3, "/media/audio/classical"}, + {"/media/audio/rock/track.mp3", 2, "/media/audio"}, + {"/media/video/movie.mp4", 1, "/media"}, + } + + for _, tc := range testCases { + libID, libPath := matcher.findLibraryForPath(tc.path) + Expect(libID).To(Equal(tc.expectedLibID), "Path %s should match library ID %d", tc.path, tc.expectedLibID) + Expect(libPath).To(Equal(tc.expectedLibPath), "Path %s should match library path %s", tc.path, tc.expectedLibPath) + } + }) + }) + + Describe("Edge cases", func() { + It("handles empty library list", func() { + mockLibRepo.SetData([]model.Library{}) + + matcher := createMatcher(ds) + Expect(matcher).ToNot(BeNil()) + + // Should not match anything + libID, libPath := matcher.findLibraryForPath("/music/track.mp3") + Expect(libID).To(Equal(0)) + Expect(libPath).To(BeEmpty()) + }) + + It("handles single library", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + }) + + matcher := createMatcher(ds) + + libID, libPath := matcher.findLibraryForPath("/music/track.mp3") + Expect(libID).To(Equal(1)) + Expect(libPath).To(Equal("/music")) + }) + + It("handles libraries with special characters in paths", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music[test]"}, + {ID: 2, Path: "/music(backup)"}, + }) + + matcher := createMatcher(ds) + Expect(matcher).ToNot(BeNil()) + + // Special characters should match literally + libID, libPath := matcher.findLibraryForPath("/music[test]/track.mp3") + Expect(libID).To(Equal(1)) + Expect(libPath).To(Equal("/music[test]")) + }) + }) + + Describe("Path matching order", func() { + It("ensures longest paths match first", func() { + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/a"}, + {ID: 2, Path: "/ab"}, + {ID: 3, Path: "/abc"}, + }) + + matcher := createMatcher(ds) + + // Verify that longer paths match correctly (not cut off by shorter prefix) + testCases := []struct { + path string + expectedLibID int + }{ + {"/abc/file.mp3", 3}, + {"/ab/file.mp3", 2}, + {"/a/file.mp3", 1}, + } + + for _, tc := range testCases { + libID, _ := matcher.findLibraryForPath(tc.path) + Expect(libID).To(Equal(tc.expectedLibID), "Path %s should match library ID %d", tc.path, tc.expectedLibID) + } + }) + }) +}) + +var _ = Describe("pathResolver", func() { + var ds *tests.MockDataStore + var mockLibRepo *tests.MockLibraryRepo + var resolver *pathResolver + ctx := context.Background() + + BeforeEach(func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-playlists)") + mockLibRepo = &tests.MockLibraryRepo{} + ds = &tests.MockDataStore{ + MockedLibrary: mockLibRepo, + } + + // Setup test libraries + mockLibRepo.SetData([]model.Library{ + {ID: 1, Path: "/music"}, + {ID: 2, Path: "/music-classical"}, + {ID: 3, Path: "/podcasts"}, + }) + + var err error + resolver, err = newPathResolver(ctx, ds) + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("resolvePath", func() { + Context("basic", func() { + It("resolves absolute paths", func() { + resolution := resolver.resolvePath("/music/artist/album/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.libraryPath).To(Equal("/music")) + Expect(resolution.absolutePath).To(Equal("/music/artist/album/track.mp3")) + }) + + It("resolves relative paths when folder is provided", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + resolution := resolver.resolvePath("../artist/album/track.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.absolutePath).To(Equal("/music/artist/album/track.mp3")) + }) + + It("returns invalid resolution for paths outside any library", func() { + resolution := resolver.resolvePath("/outside/library/track.mp3", nil) + + Expect(resolution.valid).To(BeFalse()) + }) + }) + + Context("cross-library", func() { + It("resolves path within a library", func() { + resolution := resolver.resolvePath("/music/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.libraryPath).To(Equal("/music")) + Expect(resolution.absolutePath).To(Equal("/music/track.mp3")) + }) + + It("resolves path to the longest matching library", func() { + resolution := resolver.resolvePath("/music-classical/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(2)) + Expect(resolution.libraryPath).To(Equal("/music-classical")) + }) + + It("returns invalid resolution for path outside libraries", func() { + resolution := resolver.resolvePath("/videos/movie.mp4", nil) + + Expect(resolution.valid).To(BeFalse()) + }) + + It("cleans the path before matching", func() { + resolution := resolver.resolvePath("/music//artist/../artist/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.absolutePath).To(Equal("/music/artist/track.mp3")) + }) + }) + + Context("With relative paths", func() { + It("resolves relative path within same library", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + resolution := resolver.resolvePath("../songs/track.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(1)) + Expect(resolution.absolutePath).To(Equal("/music/songs/track.mp3")) + }) + + It("resolves relative path to different library", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + // Path goes up and into a different library + resolution := resolver.resolvePath("../../podcasts/episode.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(3)) + Expect(resolution.libraryPath).To(Equal("/podcasts")) + }) + + It("uses matcher to find correct library for resolved path", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + // This relative path resolves to music-classical library + resolution := resolver.resolvePath("../../music-classical/track.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(2)) + Expect(resolution.libraryPath).To(Equal("/music-classical")) + }) + + It("returns invalid for relative paths escaping all libraries", func() { + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + resolution := resolver.resolvePath("../../../../etc/passwd", folder) + + Expect(resolution.valid).To(BeFalse()) + }) + }) + }) + + Describe("Cross-library resolution scenarios", func() { + It("handles playlist in library A referencing file in library B", func() { + // Playlist is in /music/playlists + folder := &model.Folder{ + Path: "playlists", + LibraryPath: "/music", + LibraryID: 1, + } + + // Relative path that goes to /podcasts library + resolution := resolver.resolvePath("../../podcasts/show/episode.mp3", folder) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(3), "Should resolve to podcasts library") + Expect(resolution.libraryPath).To(Equal("/podcasts")) + }) + + It("prefers longer library paths when resolving", func() { + // Ensure /music-classical is matched instead of /music + resolution := resolver.resolvePath("/music-classical/baroque/track.mp3", nil) + + Expect(resolution.valid).To(BeTrue()) + Expect(resolution.libraryID).To(Equal(2), "Should match /music-classical, not /music") + }) + }) +}) + +var _ = Describe("pathResolution", func() { + Describe("ToQualifiedString", func() { + It("converts valid resolution to qualified string with forward slashes", func() { + resolution := pathResolution{ + absolutePath: "/music/artist/album/track.mp3", + libraryPath: "/music", + libraryID: 1, + valid: true, + } + + qualifiedStr, err := resolution.ToQualifiedString() + + Expect(err).ToNot(HaveOccurred()) + Expect(qualifiedStr).To(Equal("1:artist/album/track.mp3")) + }) + + It("handles Windows-style paths by converting to forward slashes", func() { + resolution := pathResolution{ + absolutePath: "/music/artist/album/track.mp3", + libraryPath: "/music", + libraryID: 2, + valid: true, + } + + qualifiedStr, err := resolution.ToQualifiedString() + + Expect(err).ToNot(HaveOccurred()) + // Should always use forward slashes regardless of OS + Expect(qualifiedStr).To(ContainSubstring("2:")) + Expect(qualifiedStr).ToNot(ContainSubstring("\\")) + }) + + It("returns error for invalid resolution", func() { + resolution := pathResolution{valid: false} + + _, err := resolution.ToQualifiedString() + + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/core/playlists/parse_nsp.go b/core/playlists/parse_nsp.go new file mode 100644 index 000000000..a5b8b7c02 --- /dev/null +++ b/core/playlists/parse_nsp.go @@ -0,0 +1,102 @@ +package playlists + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "io" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/utils/jsoncommentstrip" +) + +func (s *playlists) newSyncedPlaylist(baseDir string, playlistFile string) (*model.Playlist, error) { + playlistPath := filepath.Join(baseDir, playlistFile) + info, err := os.Stat(playlistPath) + if err != nil { + return nil, err + } + + var extension = filepath.Ext(playlistFile) + var name = playlistFile[0 : len(playlistFile)-len(extension)] + + pls := &model.Playlist{ + Name: name, + Comment: fmt.Sprintf("Auto-imported from '%s'", playlistFile), + Public: false, + Path: playlistPath, + Sync: true, + UpdatedAt: info.ModTime(), + } + return pls, nil +} + +func getPositionFromOffset(data []byte, offset int64) (line, column int) { + line = 1 + for _, b := range data[:offset] { + if b == '\n' { + line++ + column = 1 + } else { + column++ + } + } + return +} + +func (s *playlists) parseNSP(_ context.Context, pls *model.Playlist, reader io.Reader) error { + nsp := &nspFile{} + reader = io.LimitReader(reader, 100*1024) // Limit to 100KB + reader = jsoncommentstrip.NewReader(reader) + input, err := io.ReadAll(reader) + if err != nil { + return fmt.Errorf("reading SmartPlaylist: %w", err) + } + err = json.Unmarshal(input, nsp) + if err != nil { + if syntaxErr, ok := errors.AsType[*json.SyntaxError](err); ok { + line, col := getPositionFromOffset(input, syntaxErr.Offset) + return fmt.Errorf("JSON syntax error in SmartPlaylist at line %d, column %d: %w", line, col, err) + } + return fmt.Errorf("JSON parsing error in SmartPlaylist: %w", err) + } + pls.Rules = &nsp.Criteria + if nsp.Name != "" { + pls.Name = nsp.Name + } + if nsp.Comment != "" { + pls.Comment = nsp.Comment + } + if nsp.Public != nil { + pls.Public = *nsp.Public + } else { + pls.Public = conf.Server.DefaultPlaylistPublicVisibility + } + return nil +} + +type nspFile struct { + criteria.Criteria + Name string `json:"name"` + Comment string `json:"comment"` + Public *bool `json:"public"` +} + +func (i *nspFile) UnmarshalJSON(data []byte) error { + m := map[string]any{} + err := json.Unmarshal(data, &m) + if err != nil { + return err + } + i.Name, _ = m["name"].(string) + i.Comment, _ = m["comment"].(string) + if public, ok := m["public"].(bool); ok { + i.Public = &public + } + return json.Unmarshal(data, &i.Criteria) +} diff --git a/core/playlists/parse_nsp_test.go b/core/playlists/parse_nsp_test.go new file mode 100644 index 000000000..516a5355d --- /dev/null +++ b/core/playlists/parse_nsp_test.go @@ -0,0 +1,228 @@ +package playlists + +import ( + "context" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("parseNSP", func() { + var s *playlists + ctx := context.Background() + + BeforeEach(func() { + s = &playlists{} + }) + + It("parses a well-formed NSP with all fields", func() { + nsp := `{ + "name": "My Smart Playlist", + "comment": "A test playlist", + "public": true, + "all": [{"is": {"loved": true}}], + "sort": "title", + "order": "asc", + "limit": 50 + }` + pls := &model.Playlist{Name: "default-name"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("My Smart Playlist")) + Expect(pls.Comment).To(Equal("A test playlist")) + Expect(pls.Public).To(BeTrue()) + Expect(pls.Rules).ToNot(BeNil()) + Expect(pls.Rules.Sort).To(Equal("title")) + Expect(pls.Rules.Order).To(Equal("asc")) + Expect(pls.Rules.Limit).To(Equal(50)) + Expect(pls.Rules.Expression).To(BeAssignableToTypeOf(criteria.All{})) + }) + + It("keeps existing name when NSP has no name field", func() { + nsp := `{"all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{Name: "Original Name"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Original Name")) + }) + + It("keeps existing comment when NSP has no comment field", func() { + nsp := `{"all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{Comment: "Original Comment"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Comment).To(Equal("Original Comment")) + }) + + It("strips JSON comments before parsing", func() { + nsp := `{ + // Line comment + "name": "Commented Playlist", + /* Block comment */ + "all": [{"is": {"loved": true}}] + }` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("Commented Playlist")) + }) + + It("uses server default when public field is absent", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultPlaylistPublicVisibility = true + + nsp := `{"all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Public).To(BeTrue()) + }) + + It("honors explicit public: false over server default", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultPlaylistPublicVisibility = true + + nsp := `{"public": false, "all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Public).To(BeFalse()) + }) + + It("returns a syntax error with line and column info", func() { + nsp := "{\n \"name\": \"Bad\",\n \"all\": [INVALID]\n}" + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("JSON syntax error in SmartPlaylist")) + Expect(err.Error()).To(MatchRegexp(`line \d+, column \d+`)) + }) + + It("returns a parsing error for completely invalid JSON", func() { + nsp := `not json at all` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("SmartPlaylist")) + }) + + It("gracefully handles non-string name field", func() { + nsp := `{"name": 123, "all": [{"is": {"loved": true}}]}` + pls := &model.Playlist{Name: "Original"} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + // Type assertion in UnmarshalJSON fails silently; name stays as original + Expect(pls.Name).To(Equal("Original")) + }) + + It("parses limitPercent from NSP", func() { + nsp := `{ + "all": [{"is": {"loved": true}}], + "sort": "playCount", + "order": "desc", + "limitPercent": 25 + }` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Rules).ToNot(BeNil()) + Expect(pls.Rules.LimitPercent).To(Equal(25)) + Expect(pls.Rules.Limit).To(Equal(0)) + }) + + It("parses criteria with multiple rules", func() { + nsp := `{ + "all": [ + {"is": {"loved": true}}, + {"contains": {"title": "rock"}} + ], + "sort": "lastPlayed", + "order": "desc", + "limit": 100 + }` + pls := &model.Playlist{} + err := s.parseNSP(ctx, pls, strings.NewReader(nsp)) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Rules).ToNot(BeNil()) + Expect(pls.Rules.Sort).To(Equal("lastPlayed")) + Expect(pls.Rules.Order).To(Equal("desc")) + Expect(pls.Rules.Limit).To(Equal(100)) + }) +}) + +var _ = Describe("getPositionFromOffset", func() { + It("returns correct position on first line", func() { + data := []byte("hello world") + line, col := getPositionFromOffset(data, 5) + Expect(line).To(Equal(1)) + Expect(col).To(Equal(5)) + }) + + It("returns correct position after newlines", func() { + data := []byte("line1\nline2\nline3") + // Offsets: l(0) i(1) n(2) e(3) 1(4) \n(5) l(6) i(7) n(8) + line, col := getPositionFromOffset(data, 8) + Expect(line).To(Equal(2)) + Expect(col).To(Equal(3)) + }) + + It("returns correct position at start of new line", func() { + data := []byte("line1\nline2") + // After \n at offset 5, col resets to 1; offset 6 is 'l' -> col=1 + line, col := getPositionFromOffset(data, 6) + Expect(line).To(Equal(2)) + Expect(col).To(Equal(1)) + }) + + It("handles multiple newlines", func() { + data := []byte("a\nb\nc\nd") + // a(0) \n(1) b(2) \n(3) c(4) \n(5) d(6) + line, col := getPositionFromOffset(data, 6) + Expect(line).To(Equal(4)) + Expect(col).To(Equal(1)) + }) +}) + +var _ = Describe("newSyncedPlaylist", func() { + var s *playlists + + BeforeEach(func() { + s = &playlists{} + }) + + It("creates a synced playlist with correct attributes", func() { + tmpDir := GinkgoT().TempDir() + Expect(os.WriteFile(filepath.Join(tmpDir, "test.m3u"), []byte("content"), 0600)).To(Succeed()) + + pls, err := s.newSyncedPlaylist(tmpDir, "test.m3u") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("test")) + Expect(pls.Comment).To(Equal("Auto-imported from 'test.m3u'")) + Expect(pls.Public).To(BeFalse()) + Expect(pls.Path).To(Equal(filepath.Join(tmpDir, "test.m3u"))) + Expect(pls.Sync).To(BeTrue()) + Expect(pls.UpdatedAt).ToNot(BeZero()) + }) + + It("strips extension from filename to derive name", func() { + tmpDir := GinkgoT().TempDir() + Expect(os.WriteFile(filepath.Join(tmpDir, "My Favorites.nsp"), []byte("{}"), 0600)).To(Succeed()) + + pls, err := s.newSyncedPlaylist(tmpDir, "My Favorites.nsp") + Expect(err).ToNot(HaveOccurred()) + Expect(pls.Name).To(Equal("My Favorites")) + }) + + It("returns error for non-existent file", func() { + tmpDir := GinkgoT().TempDir() + _, err := s.newSyncedPlaylist(tmpDir, "nonexistent.m3u") + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/core/playlists/playlists.go b/core/playlists/playlists.go new file mode 100644 index 000000000..3da24706c --- /dev/null +++ b/core/playlists/playlists.go @@ -0,0 +1,322 @@ +package playlists + +import ( + "context" + "io" + "os" + "path/filepath" + "strconv" + "strings" + + "github.com/bmatcuk/doublestar/v4" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +type Playlists interface { + // Reads + GetAll(ctx context.Context, options ...model.QueryOptions) (model.Playlists, error) + Get(ctx context.Context, id string) (*model.Playlist, error) + GetWithTracks(ctx context.Context, id string) (*model.Playlist, error) + GetPlaylists(ctx context.Context, mediaFileId string) (model.Playlists, error) + + // Mutations + Create(ctx context.Context, playlistId string, name string, ids []string) (string, error) + Delete(ctx context.Context, id string) error + Update(ctx context.Context, playlistID string, name *string, comment *string, public *bool, idsToAdd []string, idxToRemove []int) error + + // Track management + AddTracks(ctx context.Context, playlistID string, ids []string) (int, error) + AddAlbums(ctx context.Context, playlistID string, albumIds []string) (int, error) + AddArtists(ctx context.Context, playlistID string, artistIds []string) (int, error) + AddDiscs(ctx context.Context, playlistID string, discs []model.DiscID) (int, error) + RemoveTracks(ctx context.Context, playlistID string, trackIds []string) error + ReorderTrack(ctx context.Context, playlistID string, pos int, newPos int) error + + // Cover art + SetImage(ctx context.Context, playlistID string, reader io.Reader, ext string) error + RemoveImage(ctx context.Context, playlistID string) error + + // Import + ImportFile(ctx context.Context, absolutePath string, sync bool) (*model.Playlist, error) + ImportFromFolder(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) + ImportM3U(ctx context.Context, reader io.Reader) (*model.Playlist, error) + + // REST adapters + NewRepository(ctx context.Context) rest.Repository + TracksRepository(ctx context.Context, playlistId string, refreshSmartPlaylist bool) rest.Repository +} + +// ImageUploadService is a local interface satisfied by core.ImageUploadService. +// Defined here to avoid an import cycle between core and core/playlists. +type ImageUploadService interface { + SetImage(ctx context.Context, entityType string, entityID string, name string, oldPath string, reader io.Reader, ext string) (filename string, err error) + RemoveImage(ctx context.Context, path string) error +} + +type playlists struct { + ds model.DataStore + imgUpload ImageUploadService +} + +func NewPlaylists(ds model.DataStore, imgUpload ImageUploadService) Playlists { + return &playlists{ds: ds, imgUpload: imgUpload} +} + +func InPath(folder model.Folder) bool { + if conf.Server.PlaylistsPath == "" { + return true + } + rel, _ := filepath.Rel(folder.LibraryPath, folder.AbsolutePath()) + for path := range strings.SplitSeq(conf.Server.PlaylistsPath, string(filepath.ListSeparator)) { + if match, _ := doublestar.Match(path, rel); match { + return true + } + } + return false +} + +// --- Read operations --- + +func (s *playlists) GetAll(ctx context.Context, options ...model.QueryOptions) (model.Playlists, error) { + return s.ds.Playlist(ctx).GetAll(options...) +} + +func (s *playlists) Get(ctx context.Context, id string) (*model.Playlist, error) { + return s.ds.Playlist(ctx).Get(id) +} + +func (s *playlists) GetWithTracks(ctx context.Context, id string) (*model.Playlist, error) { + return s.ds.Playlist(ctx).GetWithTracks(id, true, false) +} + +func (s *playlists) GetPlaylists(ctx context.Context, mediaFileId string) (model.Playlists, error) { + return s.ds.Playlist(ctx).GetPlaylists(mediaFileId) +} + +// --- Mutation operations --- + +// Create creates a new playlist (when name is provided) or replaces tracks on an existing +// playlist (when playlistId is provided). This matches the Subsonic createPlaylist semantics. +func (s *playlists) Create(ctx context.Context, playlistId string, name string, ids []string) (string, error) { + usr, _ := request.UserFrom(ctx) + err := s.ds.WithTxImmediate(func(tx model.DataStore) error { + var pls *model.Playlist + var err error + + if playlistId != "" { + pls, err = tx.Playlist(ctx).Get(playlistId) + if err != nil { + return err + } + if pls.IsSmartPlaylist() { + return model.ErrNotAuthorized + } + if !usr.IsAdmin && pls.OwnerID != usr.ID { + return model.ErrNotAuthorized + } + } else { + pls = &model.Playlist{Name: name} + pls.OwnerID = usr.ID + } + pls.Tracks = nil + pls.AddMediaFilesByID(ids) + + err = tx.Playlist(ctx).Put(pls) + playlistId = pls.ID + return err + }) + return playlistId, err +} + +func (s *playlists) Delete(ctx context.Context, id string) error { + pls, err := s.checkWritable(ctx, id) + if err != nil { + return err + } + + // Clean up custom cover image file if one exists + if path := pls.UploadedImagePath(); path != "" { + if err := os.Remove(path); err != nil && !os.IsNotExist(err) { + log.Warn(ctx, "Failed to remove playlist image on delete", "path", path, err) + } + } + + return s.ds.Playlist(ctx).Delete(id) +} + +func (s *playlists) Update(ctx context.Context, playlistID string, + name *string, comment *string, public *bool, + idsToAdd []string, idxToRemove []int) error { + var pls *model.Playlist + var err error + hasTrackChanges := len(idsToAdd) > 0 || len(idxToRemove) > 0 + if hasTrackChanges { + pls, err = s.checkTracksEditable(ctx, playlistID) + } else { + pls, err = s.checkWritable(ctx, playlistID) + } + if err != nil { + return err + } + return s.ds.WithTxImmediate(func(tx model.DataStore) error { + repo := tx.Playlist(ctx) + + if len(idxToRemove) > 0 { + tracksRepo := repo.Tracks(playlistID, false) + // Convert 0-based indices to 1-based position IDs and delete them directly, + // avoiding the need to load all tracks into memory. + positions := make([]string, len(idxToRemove)) + for i, idx := range idxToRemove { + positions[i] = strconv.Itoa(idx + 1) + } + if err := tracksRepo.Delete(positions...); err != nil { + return err + } + if len(idsToAdd) > 0 { + if _, err := tracksRepo.Add(idsToAdd); err != nil { + return err + } + } + return s.updateMetadata(ctx, tx, pls, name, comment, public) + } + + if len(idsToAdd) > 0 { + if _, err := repo.Tracks(playlistID, false).Add(idsToAdd); err != nil { + return err + } + } + if name == nil && comment == nil && public == nil { + return nil + } + // Reuse the playlist from checkWritable (no tracks loaded, so Put only refreshes counters) + return s.updateMetadata(ctx, tx, pls, name, comment, public) + }) +} + +// --- Permission helpers --- + +// checkWritable fetches the playlist and verifies the current user can modify it. +func (s *playlists) checkWritable(ctx context.Context, id string) (*model.Playlist, error) { + pls, err := s.ds.Playlist(ctx).Get(id) + if err != nil { + return nil, err + } + usr, _ := request.UserFrom(ctx) + if !usr.IsAdmin && pls.OwnerID != usr.ID { + return nil, model.ErrNotAuthorized + } + return pls, nil +} + +// checkTracksEditable verifies the user can modify tracks (ownership + not smart playlist). +func (s *playlists) checkTracksEditable(ctx context.Context, playlistID string) (*model.Playlist, error) { + pls, err := s.checkWritable(ctx, playlistID) + if err != nil { + return nil, err + } + if pls.IsSmartPlaylist() { + return nil, model.ErrNotAuthorized + } + return pls, nil +} + +// updateMetadata applies optional metadata changes to a playlist and persists it. +// Accepts a DataStore parameter so it can be used inside transactions. +// The caller is responsible for permission checks. +func (s *playlists) updateMetadata(ctx context.Context, ds model.DataStore, pls *model.Playlist, name *string, comment *string, public *bool) error { + if name != nil { + pls.Name = *name + } + if comment != nil { + pls.Comment = *comment + } + if public != nil { + pls.Public = *public + } + return ds.Playlist(ctx).Put(pls) +} + +// --- Track management operations --- + +func (s *playlists) AddTracks(ctx context.Context, playlistID string, ids []string) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).Add(ids) +} + +func (s *playlists) AddAlbums(ctx context.Context, playlistID string, albumIds []string) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).AddAlbums(albumIds) +} + +func (s *playlists) AddArtists(ctx context.Context, playlistID string, artistIds []string) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).AddArtists(artistIds) +} + +func (s *playlists) AddDiscs(ctx context.Context, playlistID string, discs []model.DiscID) (int, error) { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return 0, err + } + return s.ds.Playlist(ctx).Tracks(playlistID, false).AddDiscs(discs) +} + +func (s *playlists) RemoveTracks(ctx context.Context, playlistID string, trackIds []string) error { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return err + } + return s.ds.WithTx(func(tx model.DataStore) error { + return tx.Playlist(ctx).Tracks(playlistID, false).Delete(trackIds...) + }) +} + +func (s *playlists) ReorderTrack(ctx context.Context, playlistID string, pos int, newPos int) error { + if _, err := s.checkTracksEditable(ctx, playlistID); err != nil { + return err + } + return s.ds.WithTx(func(tx model.DataStore) error { + return tx.Playlist(ctx).Tracks(playlistID, false).Reorder(pos, newPos) + }) +} + +// --- Cover art operations --- + +func (s *playlists) SetImage(ctx context.Context, playlistID string, reader io.Reader, ext string) error { + pls, err := s.checkWritable(ctx, playlistID) + if err != nil { + return err + } + + oldPath := pls.UploadedImagePath() + filename, err := s.imgUpload.SetImage(ctx, consts.EntityPlaylist, pls.ID, pls.Name, oldPath, reader, ext) + if err != nil { + return err + } + + pls.UploadedImage = filename + return s.ds.Playlist(ctx).Put(pls) +} + +func (s *playlists) RemoveImage(ctx context.Context, playlistID string) error { + pls, err := s.checkWritable(ctx, playlistID) + if err != nil { + return err + } + + if err := s.imgUpload.RemoveImage(ctx, pls.UploadedImagePath()); err != nil { + return err + } + + pls.UploadedImage = "" + return s.ds.Playlist(ctx).Put(pls) +} diff --git a/core/playlists/playlists_suite_test.go b/core/playlists/playlists_suite_test.go new file mode 100644 index 000000000..b57248490 --- /dev/null +++ b/core/playlists/playlists_suite_test.go @@ -0,0 +1,17 @@ +package playlists_test + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestPlaylists(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Playlists Suite") +} diff --git a/core/playlists/playlists_test.go b/core/playlists/playlists_test.go new file mode 100644 index 000000000..f849a0a21 --- /dev/null +++ b/core/playlists/playlists_test.go @@ -0,0 +1,413 @@ +package playlists_test + +import ( + "context" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Playlists", func() { + var ds *tests.MockDataStore + var ps playlists.Playlists + var mockPlsRepo *tests.MockPlaylistRepo + ctx := context.Background() + + BeforeEach(func() { + mockPlsRepo = tests.CreateMockPlaylistRepo() + ds = &tests.MockDataStore{ + MockedPlaylist: mockPlsRepo, + MockedLibrary: &tests.MockLibraryRepo{}, + } + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + Describe("Delete", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{AddCount: 3} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to delete their playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Delete(ctx, "pls-1") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Deleted).To(ContainElement("pls-1")) + }) + + It("allows admin to delete any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + err := ps.Delete(ctx, "pls-1") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Deleted).To(ContainElement("pls-1")) + }) + + It("denies non-owner, non-admin from deleting", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.Delete(ctx, "pls-1") + Expect(err).To(MatchError(model.ErrNotAuthorized)) + Expect(mockPlsRepo.Deleted).To(BeEmpty()) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Delete(ctx, "nonexistent") + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + + Describe("Create", func() { + BeforeEach(func() { + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "Existing", OwnerID: "user-1"}, + "pls-2": {ID: "pls-2", Name: "Other's", OwnerID: "other-user"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("creates a new playlist with owner set from context", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + id, err := ps.Create(ctx, "", "New Playlist", []string{"song-1", "song-2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(id).ToNot(BeEmpty()) + Expect(mockPlsRepo.Last.Name).To(Equal("New Playlist")) + Expect(mockPlsRepo.Last.OwnerID).To(Equal("user-1")) + }) + + It("replaces tracks on existing playlist when owner matches", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + id, err := ps.Create(ctx, "pls-1", "", []string{"song-3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(Equal("pls-1")) + Expect(mockPlsRepo.Last.Tracks).To(HaveLen(1)) + }) + + It("allows admin to replace tracks on any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + id, err := ps.Create(ctx, "pls-2", "", []string{"song-3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(Equal("pls-2")) + }) + + It("denies non-owner, non-admin from replacing tracks on existing playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.Create(ctx, "pls-2", "", []string{"song-3"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when existing playlistId not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.Create(ctx, "nonexistent", "", []string{"song-1"}) + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("denies replacing tracks on a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.Create(ctx, "pls-smart", "", []string{"song-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + }) + + Describe("Update", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{AddCount: 2} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to update their playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Update(ctx, "pls-1", new("Updated Name"), nil, nil, nil, nil) + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows admin to update any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + err := ps.Update(ctx, "pls-other", new("Updated Name"), nil, nil, nil, nil) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies non-owner, non-admin from updating", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.Update(ctx, "pls-1", new("Updated Name"), nil, nil, nil, nil) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Update(ctx, "nonexistent", new("Updated Name"), nil, nil, nil, nil) + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("denies adding tracks to a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Update(ctx, "pls-smart", nil, nil, nil, []string{"song-1"}, nil) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("denies removing tracks from a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Update(ctx, "pls-smart", nil, nil, nil, nil, []int{0}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("allows metadata updates on a smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.Update(ctx, "pls-smart", new("Updated Smart"), nil, nil, nil, nil) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("AddTracks", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{AddCount: 2} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to add tracks", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + count, err := ps.AddTracks(ctx, "pls-1", []string{"song-1", "song-2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(2)) + Expect(mockTracks.AddedIds).To(ConsistOf("song-1", "song-2")) + }) + + It("allows admin to add tracks to any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + count, err := ps.AddTracks(ctx, "pls-other", []string{"song-1"}) + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(2)) + }) + + It("denies non-owner, non-admin", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + _, err := ps.AddTracks(ctx, "pls-1", []string{"song-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("denies editing smart playlists", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.AddTracks(ctx, "pls-smart", []string{"song-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + _, err := ps.AddTracks(ctx, "nonexistent", []string{"song-1"}) + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + + Describe("RemoveTracks", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to remove tracks", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveTracks(ctx, "pls-1", []string{"track-1", "track-2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(mockTracks.DeletedIds).To(ConsistOf("track-1", "track-2")) + }) + + It("denies on smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveTracks(ctx, "pls-smart", []string{"track-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.RemoveTracks(ctx, "pls-1", []string{"track-1"}) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + }) + + Describe("ReorderTrack", func() { + var mockTracks *tests.MockPlaylistTrackRepo + + BeforeEach(func() { + mockTracks = &tests.MockPlaylistTrackRepo{} + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-smart": {ID: "pls-smart", Name: "Smart", OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}}, + } + mockPlsRepo.TracksRepo = mockTracks + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("allows owner to reorder", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.ReorderTrack(ctx, "pls-1", 1, 3) + Expect(err).ToNot(HaveOccurred()) + Expect(mockTracks.Reordered).To(BeTrue()) + }) + + It("denies on smart playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.ReorderTrack(ctx, "pls-smart", 1, 3) + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + }) + + Describe("SetImage", func() { + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = conf.NewDir(tmpDir) + + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("saves image file and updates UploadedImage", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + reader := strings.NewReader("fake image data") + err := ps.SetImage(ctx, "pls-1", reader, ".jpg") + Expect(err).ToNot(HaveOccurred()) + + Expect(mockPlsRepo.Last.UploadedImage).To(Equal("pls-1_my_playlist.jpg")) + absPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1_my_playlist.jpg") + data, err := os.ReadFile(absPath) + Expect(err).ToNot(HaveOccurred()) + Expect(string(data)).To(Equal("fake image data")) + }) + + It("removes old image when replacing", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + + // Upload first image + err := ps.SetImage(ctx, "pls-1", strings.NewReader("first"), ".png") + Expect(err).ToNot(HaveOccurred()) + oldPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1_my_playlist.png") + Expect(oldPath).To(BeAnExistingFile()) + + // Upload replacement image + err = ps.SetImage(ctx, "pls-1", strings.NewReader("second"), ".jpg") + Expect(err).ToNot(HaveOccurred()) + Expect(oldPath).ToNot(BeAnExistingFile()) + newPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1_my_playlist.jpg") + Expect(newPath).To(BeAnExistingFile()) + }) + + It("allows admin to set image on any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + err := ps.SetImage(ctx, "pls-other", strings.NewReader("data"), ".jpg") + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.SetImage(ctx, "pls-1", strings.NewReader("data"), ".jpg") + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.SetImage(ctx, "nonexistent", strings.NewReader("data"), ".jpg") + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) + + Describe("RemoveImage", func() { + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = conf.NewDir(tmpDir) + + // Create a real image file on disk + imgDir := filepath.Join(tmpDir, "artwork", "playlist") + Expect(os.MkdirAll(imgDir, 0755)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(imgDir, "pls-1.jpg"), []byte("img data"), 0600)).To(Succeed()) + + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1", UploadedImage: "pls-1.jpg"}, + "pls-empty": {ID: "pls-empty", Name: "No Cover", OwnerID: "user-1"}, + "pls-other": {ID: "pls-other", Name: "Other's", OwnerID: "other-user"}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + It("removes file and clears UploadedImage", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveImage(ctx, "pls-1") + Expect(err).ToNot(HaveOccurred()) + + Expect(mockPlsRepo.Last.UploadedImage).To(BeEmpty()) + absPath := filepath.Join(tmpDir, "artwork", "playlist", "pls-1.jpg") + Expect(absPath).ToNot(BeAnExistingFile()) + }) + + It("succeeds even if playlist has no image", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveImage(ctx, "pls-empty") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.UploadedImage).To(BeEmpty()) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + err := ps.RemoveImage(ctx, "pls-1") + Expect(err).To(MatchError(model.ErrNotAuthorized)) + }) + + It("returns error when playlist not found", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + err := ps.RemoveImage(ctx, "nonexistent") + Expect(err).To(Equal(model.ErrNotFound)) + }) + }) +}) diff --git a/core/playlists/rest_adapter.go b/core/playlists/rest_adapter.go new file mode 100644 index 000000000..3f886aadd --- /dev/null +++ b/core/playlists/rest_adapter.go @@ -0,0 +1,200 @@ +package playlists + +import ( + "context" + "errors" + "reflect" + "strings" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/slice" +) + +// --- REST adapter (follows Share/Library pattern) --- + +func (s *playlists) NewRepository(ctx context.Context) rest.Repository { + return &playlistRepositoryWrapper{ + ctx: ctx, + PlaylistRepository: s.ds.Playlist(ctx), + service: s, + } +} + +// playlistRepositoryWrapper wraps the playlist repository as a thin REST-to-service adapter. +// It satisfies rest.Repository through the embedded PlaylistRepository (via ResourceRepository), +// and rest.Persistable by delegating to service methods for all mutations. +type playlistRepositoryWrapper struct { + model.PlaylistRepository + ctx context.Context + service *playlists +} + +func (r *playlistRepositoryWrapper) Save(entity any) (string, error) { + return r.service.savePlaylist(r.ctx, entity.(*model.Playlist)) +} + +func (r *playlistRepositoryWrapper) Update(id string, entity any, cols ...string) error { + return r.service.updatePlaylistEntity(r.ctx, id, entity.(*model.Playlist), cols...) +} + +func (r *playlistRepositoryWrapper) Delete(id string) error { + err := r.service.Delete(r.ctx, id) + switch { + case errors.Is(err, model.ErrNotFound): + return rest.ErrNotFound + case errors.Is(err, model.ErrNotAuthorized): + return rest.ErrPermissionDenied + default: + return err + } +} + +func (s *playlists) TracksRepository(ctx context.Context, playlistId string, refreshSmartPlaylist bool) rest.Repository { + repo := s.ds.Playlist(ctx) + tracks := repo.Tracks(playlistId, refreshSmartPlaylist) + if tracks == nil { + return nil + } + return tracks.(rest.Repository) +} + +// savePlaylist creates a new playlist, assigning the owner from context. +// Only Name, Comment, Public, and Rules are user-settable via the REST API. +func (s *playlists) savePlaylist(ctx context.Context, pls *model.Playlist) (string, error) { + usr, _ := request.UserFrom(ctx) + pls.OwnerID = usr.ID + pls.ID = "" // Force new creation + pls.Path = "" // Server-managed (M3U file path) + pls.Sync = false // Server-managed (M3U sync flag) + pls.UploadedImage = "" // Managed by image upload endpoint + pls.ExternalImageURL = "" // Managed by M3U import / plugins only + pls.EvaluatedAt = nil // Server-managed + err := s.ds.Playlist(ctx).Put(pls) + if err != nil { + return "", err + } + return pls.ID, nil +} + +// updatePlaylistEntity updates playlist metadata with permission checks. +// Used by the REST API wrapper. +// +// cols names the fields the client actually sent in the JSON body (extracted by +// rest.Put). When non-empty, fields outside cols are not considered changed and +// are left untouched — this prevents partial requests like bulk "Make Public" +// (body: {"public": true}) from wiping fields that just happen to be zero in +// the deserialized entity (see issue #5541). An empty cols means "treat the +// entity as a complete record" — preserved for callers that don't use the REST +// wrapper. +func (s *playlists) updatePlaylistEntity(ctx context.Context, id string, entity *model.Playlist, cols ...string) error { + current, err := s.checkWritable(ctx, id) + if err != nil { + switch { + case errors.Is(err, model.ErrNotFound): + return rest.ErrNotFound + case errors.Is(err, model.ErrNotAuthorized): + return rest.ErrPermissionDenied + default: + return err + } + } + + sent := sentFields(cols) + + usr, _ := request.UserFrom(ctx) + ownerChanged := sent("ownerId") && entity.OwnerID != "" && entity.OwnerID != current.OwnerID + if !usr.IsAdmin && ownerChanged { + return rest.ErrPermissionDenied + } + + nameChanged := sent("name") && entity.Name != current.Name + commentChanged := sent("comment") && entity.Comment != current.Comment + rulesChanged := sent("rules") && !rulesEqual(current.Rules, entity.Rules) + + if nameChanged || commentChanged || ownerChanged || rulesChanged { + return s.applyContentUpdate(ctx, current, entity, sent, + nameChanged, commentChanged, ownerChanged, rulesChanged) + } + return s.applyFlagsOnly(ctx, current, entity, sent) +} + +// applyContentUpdate handles updates that change at least one of name/comment/ +// owner/rules. It goes through updateMetadata, which always bumps updatedAt +// (invalidating cached cover-art URLs). namePtr/commentPtr are nil when the +// field is absent from the request OR present-but-unchanged (so updateMetadata +// skips them); publicPtr is nil only when public is absent from the request +// (an idempotent public value is still forwarded). +func (s *playlists) applyContentUpdate(ctx context.Context, current, entity *model.Playlist, + sent func(string) bool, nameChanged, commentChanged, ownerChanged, rulesChanged bool, +) error { + if ownerChanged { + current.OwnerID = entity.OwnerID + } + if rulesChanged { + current.Rules = entity.Rules + } + if sent("sync") && current.Path != "" && current.Sync != entity.Sync { + current.Sync = entity.Sync + } + var namePtr, commentPtr *string + var publicPtr *bool + if nameChanged { + namePtr = &entity.Name + } + if commentChanged { + commentPtr = &entity.Comment + } + if sent("public") { + publicPtr = &entity.Public + } + return s.updateMetadata(ctx, s.ds, current, namePtr, commentPtr, publicPtr) +} + +// applyFlagsOnly handles updates that only toggle sync/public — skips +// updatedAt so cover art URLs stay stable. +func (s *playlists) applyFlagsOnly(ctx context.Context, current, entity *model.Playlist, + sent func(string) bool, +) error { + var updateCols []string + if sent("sync") && current.Path != "" && current.Sync != entity.Sync { + current.Sync = entity.Sync + updateCols = append(updateCols, "sync") + } + if sent("public") && current.Public != entity.Public { + current.Public = entity.Public + updateCols = append(updateCols, "public") + } + if len(updateCols) == 0 { + return nil + } + return s.ds.Playlist(ctx).Put(current, updateCols...) +} + +// sentFields returns a predicate that reports whether a JSON field was present +// in the request body. Matching is case-insensitive to mirror Go's json +// decoder, which populates struct fields from case-variant keys like +// {"Name":"x"} or {"OWNERID":"y"}. An empty cols list means "treat the entity +// as a full record" — every field is considered sent. +func sentFields(cols []string) func(string) bool { + if len(cols) == 0 { + return func(string) bool { return true } + } + set := slice.ToMap(cols, func(c string) (string, struct{}) { return strings.ToLower(c), struct{}{} }) + return func(field string) bool { + _, ok := set[strings.ToLower(field)] + return ok + } +} + +func rulesEqual(a, b *criteria.Criteria) bool { + if a == b { + return true + } + if a == nil || b == nil { + return false + } + return reflect.DeepEqual(a, b) +} diff --git a/core/playlists/rest_adapter_test.go b/core/playlists/rest_adapter_test.go new file mode 100644 index 000000000..79d72d147 --- /dev/null +++ b/core/playlists/rest_adapter_test.go @@ -0,0 +1,409 @@ +package playlists_test + +import ( + "context" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("REST Adapter", func() { + var ds *tests.MockDataStore + var ps playlists.Playlists + var mockPlsRepo *tests.MockPlaylistRepo + ctx := context.Background() + + BeforeEach(func() { + mockPlsRepo = tests.CreateMockPlaylistRepo() + ds = &tests.MockDataStore{ + MockedPlaylist: mockPlsRepo, + MockedLibrary: &tests.MockLibraryRepo{}, + } + ctx = request.WithUser(ctx, model.User{ID: "123"}) + }) + + Describe("NewRepository", func() { + var repo rest.Persistable + + BeforeEach(func() { + mockPlsRepo.Data = map[string]*model.Playlist{ + "pls-1": {ID: "pls-1", Name: "My Playlist", OwnerID: "user-1"}, + } + ps = playlists.NewPlaylists(ds, core.NewImageUploadService()) + }) + + Describe("Save", func() { + It("sets the owner from the context user", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "New Playlist"} + id, err := repo.Save(pls) + Expect(err).ToNot(HaveOccurred()) + Expect(id).ToNot(BeEmpty()) + Expect(pls.OwnerID).To(Equal("user-1")) + }) + + It("forces a new creation by clearing ID", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{ID: "should-be-cleared", Name: "New"} + _, err := repo.Save(pls) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.ID).ToNot(Equal("should-be-cleared")) + }) + + It("clears server-managed fields to prevent injection via REST API", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{ + Name: "Legit Playlist", + Comment: "A comment", + Public: true, + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "test"}}, + Path: "/some/path/playlist.m3u", + Sync: true, + UploadedImage: "injected-image-path", + ExternalImageURL: "http://evil.example.com/ssrf", + EvaluatedAt: new(time.Now()), + } + _, err := repo.Save(pls) + Expect(err).ToNot(HaveOccurred()) + + saved := mockPlsRepo.Last + // User-settable fields are preserved + Expect(saved.Name).To(Equal("Legit Playlist")) + Expect(saved.Comment).To(Equal("A comment")) + Expect(saved.Public).To(BeTrue()) + Expect(saved.Rules).ToNot(BeNil()) + // Server-managed fields are cleared + Expect(saved.Path).To(BeEmpty()) + Expect(saved.Sync).To(BeFalse()) + Expect(saved.UploadedImage).To(BeEmpty()) + Expect(saved.ExternalImageURL).To(BeEmpty()) + Expect(saved.EvaluatedAt).To(BeNil()) + }) + }) + + Describe("Update", func() { + It("allows owner to update their playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("pls-1", pls) + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows admin to update any playlist", func() { + ctx = request.WithUser(ctx, model.User{ID: "admin-1", IsAdmin: true}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("pls-1", pls) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies non-owner, non-admin", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("pls-1", pls) + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + + It("denies regular user from changing ownership", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated", OwnerID: "other-user"} + err := repo.Update("pls-1", pls) + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + + DescribeTable("denies regular user from changing ownership under any case-variant JSON key", + func(colName string) { + // rest.Put's field-name extraction is case-sensitive, but Go's + // json decoder is case-insensitive on struct fields, so any + // {"OwnerId":"x"} / {"OWNERID":"x"} / {"ownerid":"x"} populates + // entity.OwnerID. sentFields normalizes both sides so the + // permission gate fires regardless of casing. + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{OwnerID: "other-user"} + err := repo.Update("pls-1", pls, colName) + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }, + Entry("canonical camelCase", "ownerId"), + Entry("PascalCase", "OwnerId"), + Entry("all upper", "OWNERID"), + Entry("all lower", "ownerid"), + ) + + It("updates smart playlist rules", func() { + mockPlsRepo.Data["smart-1"] = &model.Playlist{ + ID: "smart-1", + Name: "Smart Playlist", + OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": "old"}}, + } + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + newRules := &criteria.Criteria{Expression: criteria.Contains{"title": "new"}} + pls := &model.Playlist{Name: "Smart Playlist", Rules: newRules} + err := repo.Update("smart-1", pls) + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Rules).To(Equal(newRules)) + }) + + It("allows toggling sync for file-backed playlists", func() { + originalTime := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC) + mockPlsRepo.Data["file-pls"] = &model.Playlist{ + ID: "file-pls", + Name: "File Playlist", + OwnerID: "user-1", + Path: "/music/playlist.m3u", + Sync: true, + UpdatedAt: originalTime, + } + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "File Playlist", Sync: false} + err := repo.Update("file-pls", pls) + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Sync).To(BeFalse()) + Expect(mockPlsRepo.Last.UpdatedAt).To(Equal(originalTime)) + }) + + It("does not allow setting sync on non-file-backed playlists", func() { + mockPlsRepo.Data["manual-pls"] = &model.Playlist{ + ID: "manual-pls", + Name: "Manual Playlist", + OwnerID: "user-1", + Path: "", + Sync: false, + } + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Manual Playlist", Sync: true} + err := repo.Update("manual-pls", pls) + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last).To(BeNil()) + }) + + It("does not bump updatedAt when only public changes", func() { + originalTime := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC) + mockPlsRepo.Data["pls-pub"] = &model.Playlist{ + ID: "pls-pub", + Name: "My Playlist", + OwnerID: "user-1", + Public: false, + UpdatedAt: originalTime, + } + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "My Playlist", Public: true} + err := repo.Update("pls-pub", pls) + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Public).To(BeTrue()) + Expect(mockPlsRepo.Last.UpdatedAt).To(Equal(originalTime)) + }) + + It("bumps updatedAt when name changes along with sync", func() { + mockPlsRepo.Data["file-pls2"] = &model.Playlist{ + ID: "file-pls2", + Name: "Old Name", + OwnerID: "user-1", + Path: "/music/playlist.m3u", + Sync: true, + } + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "New Name", Sync: false} + err := repo.Update("file-pls2", pls) + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Name).To(Equal("New Name")) + Expect(mockPlsRepo.Last.Sync).To(BeFalse()) + }) + + It("returns rest.ErrNotFound when playlist doesn't exist", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + pls := &model.Playlist{Name: "Updated"} + err := repo.Update("nonexistent", pls) + Expect(err).To(Equal(rest.ErrNotFound)) + }) + + // Regression tests for #5541: partial REST updates (e.g. bulk "Make Public") + // must only touch the fields the client actually sent. The cols list from + // rest.Put names those fields; fields outside it must be left alone, even + // when the deserialized entity has zero values for them. + Context("with partial updates (cols)", func() { + BeforeEach(func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + mockPlsRepo.Data["partial"] = &model.Playlist{ + ID: "partial", + Name: "Original Name", + Comment: "Original comment", + OwnerID: "user-1", + Public: false, + } + }) + + It("preserves name and comment when only public is sent (bulk Make Public)", func() { + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Update("partial", &model.Playlist{Public: true}, "public") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Name).To(Equal("Original Name")) + Expect(mockPlsRepo.Last.Comment).To(Equal("Original comment")) + Expect(mockPlsRepo.Last.Public).To(BeTrue()) + }) + + It("preserves name when only sync is sent for a file-backed playlist", func() { + mockPlsRepo.Data["file-partial"] = &model.Playlist{ + ID: "file-partial", + Name: "Keep Me", + OwnerID: "user-1", + Path: "/music/p.m3u", + Sync: true, + } + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Update("file-partial", &model.Playlist{Sync: false}, "sync") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Name).To(Equal("Keep Me")) + Expect(mockPlsRepo.Last.Sync).To(BeFalse()) + }) + + It("renames the playlist when only name is sent", func() { + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Update("partial", &model.Playlist{Name: "Renamed"}, "name") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Name).To(Equal("Renamed")) + Expect(mockPlsRepo.Last.Comment).To(Equal("Original comment")) + Expect(mockPlsRepo.Last.Public).To(BeFalse()) + }) + + It("clears the comment when an empty comment is sent explicitly", func() { + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Update("partial", &model.Playlist{Comment: ""}, "comment") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Comment).To(BeEmpty()) + Expect(mockPlsRepo.Last.Name).To(Equal("Original Name")) + }) + + It("updates rules-only on a smart playlist (Feishin-style edit)", func() { + mockPlsRepo.Data["smart-partial"] = &model.Playlist{ + ID: "smart-partial", + Name: "Smart Original", + Comment: "smart comment", + OwnerID: "user-1", + Public: true, + Rules: &criteria.Criteria{Expression: criteria.Is{"genre": "Rock"}}, + } + repo = ps.NewRepository(ctx).(rest.Persistable) + newRules := &criteria.Criteria{Expression: criteria.Is{"genre": "Jazz"}, Sort: "year DESC"} + err := repo.Update("smart-partial", &model.Playlist{Rules: newRules}, "rules") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Rules).To(Equal(newRules)) + Expect(mockPlsRepo.Last.Name).To(Equal("Smart Original")) + Expect(mockPlsRepo.Last.Comment).To(Equal("smart comment")) + Expect(mockPlsRepo.Last.Public).To(BeTrue()) + }) + + It("updates name and rules together (smart-playlist Edit form)", func() { + mockPlsRepo.Data["smart-edit"] = &model.Playlist{ + ID: "smart-edit", + Name: "Smart Original", + Comment: "smart comment", + OwnerID: "user-1", + Rules: &criteria.Criteria{Expression: criteria.Is{"genre": "Rock"}}, + } + repo = ps.NewRepository(ctx).(rest.Persistable) + newRules := &criteria.Criteria{Expression: criteria.Is{"artist": "Miles Davis"}, Sort: "album"} + err := repo.Update("smart-edit", + &model.Playlist{Name: "Smart Renamed", Rules: newRules}, + "name", "rules") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Name).To(Equal("Smart Renamed")) + Expect(mockPlsRepo.Last.Rules).To(Equal(newRules)) + Expect(mockPlsRepo.Last.Comment).To(Equal("smart comment")) + }) + + It("does not bump the saved rules on an idempotent rules-only PUT", func() { + rules := &criteria.Criteria{Expression: criteria.Is{"genre": "Rock"}} + mockPlsRepo.Data["smart-idempotent"] = &model.Playlist{ + ID: "smart-idempotent", + Name: "Smart Idempotent", + OwnerID: "user-1", + Rules: rules, + } + repo = ps.NewRepository(ctx).(rest.Persistable) + // Same rules sent back — rulesEqual should report no change and + // the request should no-op (no Put call). + sameRules := &criteria.Criteria{Expression: criteria.Is{"genre": "Rock"}} + err := repo.Update("smart-idempotent", &model.Playlist{Rules: sameRules}, "rules") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last).To(BeNil()) // no Put happened + }) + + It("preserves rules when only public is sent (smart playlist + bulk Make Public)", func() { + rules := &criteria.Criteria{Expression: criteria.Is{"genre": "Rock"}} + mockPlsRepo.Data["smart-public"] = &model.Playlist{ + ID: "smart-public", + Name: "Smart Public", + OwnerID: "user-1", + Public: false, + Rules: rules, + } + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Update("smart-public", &model.Playlist{Public: true}, "public") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Public).To(BeTrue()) + Expect(mockPlsRepo.Last.Rules).To(Equal(rules)) + Expect(mockPlsRepo.Last.Name).To(Equal("Smart Public")) + }) + + It("does not treat a missing ownerId as an ownership transfer attempt", func() { + // A non-admin user sending only {public:true} should not be blocked + // just because OwnerID is the zero value in the deserialized entity. + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Update("partial", &model.Playlist{Public: true}, "public") + Expect(err).ToNot(HaveOccurred()) + }) + + It("matches cols case-insensitively (mirrors json decoder behavior)", func() { + // Go's json decoder populates struct fields from case-variant keys + // like {"Name":"x"}, but rest.Put's field-name extraction is + // case-sensitive. sentFields normalizes both sides so a request + // with {"Name":"Renamed"} is honored, not silently ignored. + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Update("partial", &model.Playlist{Name: "Renamed"}, "Name") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Last.Name).To(Equal("Renamed")) + Expect(mockPlsRepo.Last.Comment).To(Equal("Original comment")) + }) + }) + }) + + Describe("Delete", func() { + It("delegates to service Delete with permission checks", func() { + ctx = request.WithUser(ctx, model.User{ID: "user-1", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Delete("pls-1") + Expect(err).ToNot(HaveOccurred()) + Expect(mockPlsRepo.Deleted).To(ContainElement("pls-1")) + }) + + It("denies non-owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "other-user", IsAdmin: false}) + repo = ps.NewRepository(ctx).(rest.Persistable) + err := repo.Delete("pls-1") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + }) +}) diff --git a/core/playlists_test.go b/core/playlists_test.go deleted file mode 100644 index 3a3c9aafc..000000000 --- a/core/playlists_test.go +++ /dev/null @@ -1,283 +0,0 @@ -package core - -import ( - "context" - "os" - "strconv" - "strings" - "time" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/criteria" - "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/tests" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("Playlists", func() { - var ds *tests.MockDataStore - var ps Playlists - var mockPlsRepo mockedPlaylistRepo - var mockLibRepo *tests.MockLibraryRepo - ctx := context.Background() - - BeforeEach(func() { - mockPlsRepo = mockedPlaylistRepo{} - mockLibRepo = &tests.MockLibraryRepo{} - ds = &tests.MockDataStore{ - MockedPlaylist: &mockPlsRepo, - MockedLibrary: mockLibRepo, - } - ctx = request.WithUser(ctx, model.User{ID: "123"}) - // Path should be libPath, but we want to match the root folder referenced in the m3u, which is `/` - mockLibRepo.SetData([]model.Library{{ID: 1, Path: "/"}}) - }) - - Describe("ImportFile", func() { - var folder *model.Folder - BeforeEach(func() { - ps = NewPlaylists(ds) - ds.MockedMediaFile = &mockedMediaFileRepo{} - libPath, _ := os.Getwd() - folder = &model.Folder{ - ID: "1", - LibraryID: 1, - LibraryPath: libPath, - Path: "tests/fixtures", - Name: "playlists", - } - }) - - Describe("M3U", func() { - It("parses well-formed playlists", func() { - pls, err := ps.ImportFile(ctx, folder, "pls1.m3u") - Expect(err).ToNot(HaveOccurred()) - Expect(pls.OwnerID).To(Equal("123")) - Expect(pls.Tracks).To(HaveLen(2)) - Expect(pls.Tracks[0].Path).To(Equal("tests/fixtures/playlists/test.mp3")) - Expect(pls.Tracks[1].Path).To(Equal("tests/fixtures/playlists/test.ogg")) - Expect(mockPlsRepo.last).To(Equal(pls)) - }) - - It("parses playlists using LF ending", func() { - pls, err := ps.ImportFile(ctx, folder, "lf-ended.m3u") - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(2)) - }) - - It("parses playlists using CR ending (old Mac format)", func() { - pls, err := ps.ImportFile(ctx, folder, "cr-ended.m3u") - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(2)) - }) - }) - - Describe("NSP", func() { - It("parses well-formed playlists", func() { - pls, err := ps.ImportFile(ctx, folder, "recently_played.nsp") - Expect(err).ToNot(HaveOccurred()) - Expect(mockPlsRepo.last).To(Equal(pls)) - Expect(pls.OwnerID).To(Equal("123")) - Expect(pls.Name).To(Equal("Recently Played")) - Expect(pls.Comment).To(Equal("Recently played tracks")) - Expect(pls.Rules.Sort).To(Equal("lastPlayed")) - Expect(pls.Rules.Order).To(Equal("desc")) - Expect(pls.Rules.Limit).To(Equal(100)) - Expect(pls.Rules.Expression).To(BeAssignableToTypeOf(criteria.All{})) - }) - It("returns an error if the playlist is not well-formed", func() { - _, err := ps.ImportFile(ctx, folder, "invalid_json.nsp") - Expect(err.Error()).To(ContainSubstring("line 19, column 1: invalid character '\\n'")) - }) - }) - }) - - Describe("ImportM3U", func() { - var repo *mockedMediaFileFromListRepo - BeforeEach(func() { - repo = &mockedMediaFileFromListRepo{} - ds.MockedMediaFile = repo - ps = NewPlaylists(ds) - mockLibRepo.SetData([]model.Library{{ID: 1, Path: "/music"}, {ID: 2, Path: "/new"}}) - ctx = request.WithUser(ctx, model.User{ID: "123"}) - }) - - It("parses well-formed playlists", func() { - repo.data = []string{ - "tests/test.mp3", - "tests/test.ogg", - "tests/01 Invisible (RED) Edit Version.mp3", - "downloads/newfile.flac", - } - m3u := strings.Join([]string{ - "#PLAYLIST:playlist 1", - "/music/tests/test.mp3", - "/music/tests/test.ogg", - "/new/downloads/newfile.flac", - "file:///music/tests/01%20Invisible%20(RED)%20Edit%20Version.mp3", - }, "\n") - f := strings.NewReader(m3u) - - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.OwnerID).To(Equal("123")) - Expect(pls.Name).To(Equal("playlist 1")) - Expect(pls.Sync).To(BeFalse()) - Expect(pls.Tracks).To(HaveLen(4)) - Expect(pls.Tracks[0].Path).To(Equal("tests/test.mp3")) - Expect(pls.Tracks[1].Path).To(Equal("tests/test.ogg")) - Expect(pls.Tracks[2].Path).To(Equal("downloads/newfile.flac")) - Expect(pls.Tracks[3].Path).To(Equal("tests/01 Invisible (RED) Edit Version.mp3")) - Expect(mockPlsRepo.last).To(Equal(pls)) - }) - - It("sets the playlist name as a timestamp if the #PLAYLIST directive is not present", func() { - repo.data = []string{ - "tests/test.mp3", - "tests/test.ogg", - "/tests/01 Invisible (RED) Edit Version.mp3", - } - m3u := strings.Join([]string{ - "/music/tests/test.mp3", - "/music/tests/test.ogg", - }, "\n") - f := strings.NewReader(m3u) - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - _, err = time.Parse(time.RFC3339, pls.Name) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(2)) - }) - - It("returns only tracks that exist in the database and in the same other as the m3u", func() { - repo.data = []string{ - "album1/test1.mp3", - "album2/test2.mp3", - "album3/test3.mp3", - } - m3u := strings.Join([]string{ - "/music/album3/test3.mp3", - "/music/album1/test1.mp3", - "/music/album4/test4.mp3", - "/music/album2/test2.mp3", - }, "\n") - f := strings.NewReader(m3u) - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(3)) - Expect(pls.Tracks[0].Path).To(Equal("album3/test3.mp3")) - Expect(pls.Tracks[1].Path).To(Equal("album1/test1.mp3")) - Expect(pls.Tracks[2].Path).To(Equal("album2/test2.mp3")) - }) - - It("is case-insensitive when comparing paths", func() { - repo.data = []string{ - "abc/tEsT1.Mp3", - } - m3u := strings.Join([]string{ - "/music/ABC/TeSt1.mP3", - }, "\n") - f := strings.NewReader(m3u) - pls, err := ps.ImportM3U(ctx, f) - Expect(err).ToNot(HaveOccurred()) - Expect(pls.Tracks).To(HaveLen(1)) - Expect(pls.Tracks[0].Path).To(Equal("abc/tEsT1.Mp3")) - }) - }) - - Describe("InPlaylistsPath", func() { - var folder model.Folder - - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - folder = model.Folder{ - LibraryPath: "/music", - Path: "playlists/abc", - Name: "folder1", - } - }) - - It("returns true if PlaylistsPath is empty", func() { - conf.Server.PlaylistsPath = "" - Expect(InPlaylistsPath(folder)).To(BeTrue()) - }) - - It("returns true if PlaylistsPath is any (**/**)", func() { - conf.Server.PlaylistsPath = "**/**" - Expect(InPlaylistsPath(folder)).To(BeTrue()) - }) - - It("returns true if folder is in PlaylistsPath", func() { - conf.Server.PlaylistsPath = "other/**:playlists/**" - Expect(InPlaylistsPath(folder)).To(BeTrue()) - }) - - It("returns false if folder is not in PlaylistsPath", func() { - conf.Server.PlaylistsPath = "other" - Expect(InPlaylistsPath(folder)).To(BeFalse()) - }) - - It("returns true if for a playlist in root of MusicFolder if PlaylistsPath is '.'", func() { - conf.Server.PlaylistsPath = "." - Expect(InPlaylistsPath(folder)).To(BeFalse()) - - folder2 := model.Folder{ - LibraryPath: "/music", - Path: "", - Name: ".", - } - - Expect(InPlaylistsPath(folder2)).To(BeTrue()) - }) - }) -}) - -// mockedMediaFileRepo's FindByPaths method returns a list of MediaFiles with the same paths as the input -type mockedMediaFileRepo struct { - model.MediaFileRepository -} - -func (r *mockedMediaFileRepo) FindByPaths(paths []string) (model.MediaFiles, error) { - var mfs model.MediaFiles - for idx, path := range paths { - mfs = append(mfs, model.MediaFile{ - ID: strconv.Itoa(idx), - Path: path, - }) - } - return mfs, nil -} - -// mockedMediaFileFromListRepo's FindByPaths method returns a list of MediaFiles based on the data field -type mockedMediaFileFromListRepo struct { - model.MediaFileRepository - data []string -} - -func (r *mockedMediaFileFromListRepo) FindByPaths([]string) (model.MediaFiles, error) { - var mfs model.MediaFiles - for idx, path := range r.data { - mfs = append(mfs, model.MediaFile{ - ID: strconv.Itoa(idx), - Path: path, - }) - } - return mfs, nil -} - -type mockedPlaylistRepo struct { - last *model.Playlist - model.PlaylistRepository -} - -func (r *mockedPlaylistRepo) FindByPath(string) (*model.Playlist, error) { - return nil, model.ErrNotFound -} - -func (r *mockedPlaylistRepo) Put(pls *model.Playlist) error { - r.last = pls - return nil -} diff --git a/core/publicurl/publicurl.go b/core/publicurl/publicurl.go new file mode 100644 index 000000000..b0865e78b --- /dev/null +++ b/core/publicurl/publicurl.go @@ -0,0 +1,84 @@ +package publicurl + +import ( + "cmp" + "net/http" + "net/url" + "path" + "strconv" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +// ImageURL generates a public URL for artwork images. +// It creates a signed token for the artwork ID and builds a complete public URL. +func ImageURL(req *http.Request, artID model.ArtworkID, size int) string { + token, _ := auth.CreatePublicToken(auth.Claims{ID: artID.String()}) + uri := path.Join(consts.URLPathPublicImages, token) + params := url.Values{} + if size > 0 { + params.Add("size", strconv.Itoa(size)) + } + return PublicURL(req, uri, params) +} + +// PublicURL builds a full URL for public-facing resources. +// It uses ShareURL from config if available, otherwise falls back to extracting +// the scheme and host from the provided http.Request. +// If req is nil and ShareURL is not set, it defaults to http://localhost. +func PublicURL(req *http.Request, u string, params url.Values) string { + if conf.Server.ShareURL == "" { + return AbsoluteURL(req, u, params) + } + shareUrl, err := url.Parse(conf.Server.ShareURL) + if err != nil { + return AbsoluteURL(req, u, params) + } + buildUrl, err := url.Parse(u) + if err != nil { + return AbsoluteURL(req, u, params) + } + buildUrl.Scheme = shareUrl.Scheme + buildUrl.Host = shareUrl.Host + if basePath := strings.TrimRight(shareUrl.Path, "/"); basePath != "" { + buildUrl.Path = path.Join(basePath, buildUrl.Path) + } + if len(params) > 0 { + buildUrl.RawQuery = params.Encode() + } + return buildUrl.String() +} + +// AbsoluteURL builds an absolute URL from a relative path. +// It uses BaseHost/BaseScheme from config if available, otherwise extracts +// the scheme and host from the http.Request. +// If req is nil and BaseHost is not set, it defaults to http://localhost. +func AbsoluteURL(req *http.Request, u string, params url.Values) string { + buildUrl, err := url.Parse(u) + if err != nil { + log.Error(req.Context(), "Failed to parse URL path", "url", u, err) + return "" + } + if strings.HasPrefix(u, "/") { + buildUrl.Path = path.Join(conf.Server.BasePath, buildUrl.Path) + if conf.Server.BaseHost != "" { + buildUrl.Scheme = cmp.Or(conf.Server.BaseScheme, "http") + buildUrl.Host = conf.Server.BaseHost + } else if req != nil { + buildUrl.Scheme = req.URL.Scheme + buildUrl.Host = req.Host + } else { + buildUrl.Scheme = "http" + buildUrl.Host = "localhost" + } + } + if len(params) > 0 { + buildUrl.RawQuery = params.Encode() + } + return buildUrl.String() +} diff --git a/core/publicurl/publicurl_test.go b/core/publicurl/publicurl_test.go new file mode 100644 index 000000000..a195fb9cd --- /dev/null +++ b/core/publicurl/publicurl_test.go @@ -0,0 +1,199 @@ +package publicurl_test + +import ( + "net/http" + "net/url" + "testing" + + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/publicurl" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestPublicURL(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Public URL Suite") +} + +var _ = Describe("Public URL Utilities", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + + Describe("PublicURL", func() { + When("ShareURL is set", func() { + BeforeEach(func() { + conf.Server.ShareURL = "https://share.example.com" + }) + + It("uses ShareURL as the base", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.PublicURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://share.example.com/path/to/resource")) + }) + + It("includes query parameters", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + params := url.Values{"size": []string{"300"}, "format": []string{"png"}} + result := publicurl.PublicURL(r, "/image/123", params) + Expect(result).To(ContainSubstring("https://share.example.com/image/123")) + Expect(result).To(ContainSubstring("size=300")) + Expect(result).To(ContainSubstring("format=png")) + }) + + It("works without a request", func() { + result := publicurl.PublicURL(nil, "/path/to/resource", nil) + Expect(result).To(Equal("https://share.example.com/path/to/resource")) + }) + }) + + When("ShareURL includes a path", func() { + BeforeEach(func() { + conf.Server.ShareURL = "https://example.com/navi" + }) + + It("prepends the ShareURL path to the resource", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.PublicURL(r, "/share/img/hash", nil) + Expect(result).To(Equal("https://example.com/navi/share/img/hash")) + }) + + It("prepends the ShareURL path and includes query parameters", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + params := url.Values{"size": []string{"600"}} + result := publicurl.PublicURL(r, "/share/img/hash", params) + Expect(result).To(Equal("https://example.com/navi/share/img/hash?size=600")) + }) + + It("handles trailing slash in ShareURL path", func() { + conf.Server.ShareURL = "https://example.com/navi/" + result := publicurl.PublicURL(nil, "/share/img/hash", nil) + Expect(result).To(Equal("https://example.com/navi/share/img/hash")) + }) + }) + + When("ShareURL is not set", func() { + BeforeEach(func() { + conf.Server.ShareURL = "" + }) + + It("falls back to AbsoluteURL with request", func() { + r, _ := http.NewRequest("GET", "https://myserver.com/test", nil) + r.Host = "myserver.com" + result := publicurl.PublicURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://myserver.com/path/to/resource")) + }) + + It("falls back to localhost without request", func() { + result := publicurl.PublicURL(nil, "/path/to/resource", nil) + Expect(result).To(Equal("http://localhost/path/to/resource")) + }) + }) + }) + + Describe("AbsoluteURL", func() { + When("BaseHost is set", func() { + BeforeEach(func() { + conf.Server.BaseHost = "configured.example.com" + conf.Server.BaseScheme = "https" + conf.Server.BasePath = "" + }) + + It("uses BaseHost and BaseScheme", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://configured.example.com/path/to/resource")) + }) + + It("defaults to http scheme if BaseScheme is empty", func() { + conf.Server.BaseScheme = "" + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("http://configured.example.com/path/to/resource")) + }) + }) + + When("BaseHost is not set", func() { + BeforeEach(func() { + conf.Server.BaseHost = "" + conf.Server.BasePath = "" + }) + + It("extracts host from request", func() { + r, _ := http.NewRequest("GET", "https://request.example.com/test", nil) + r.Host = "request.example.com" + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://request.example.com/path/to/resource")) + }) + + It("falls back to localhost without request", func() { + result := publicurl.AbsoluteURL(nil, "/path/to/resource", nil) + Expect(result).To(Equal("http://localhost/path/to/resource")) + }) + }) + + When("BasePath is set", func() { + BeforeEach(func() { + conf.Server.BasePath = "/navidrome" + conf.Server.BaseHost = "example.com" + conf.Server.BaseScheme = "https" + }) + + It("prepends BasePath to the URL", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "/path/to/resource", nil) + Expect(result).To(Equal("https://example.com/navidrome/path/to/resource")) + }) + }) + + It("passes through absolute URLs unchanged", func() { + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + result := publicurl.AbsoluteURL(r, "https://other.example.com/path", nil) + Expect(result).To(Equal("https://other.example.com/path")) + }) + + It("includes query parameters", func() { + conf.Server.BaseHost = "example.com" + conf.Server.BaseScheme = "https" + r, _ := http.NewRequest("GET", "http://localhost/test", nil) + params := url.Values{"key": []string{"value"}} + result := publicurl.AbsoluteURL(r, "/path", params) + Expect(result).To(Equal("https://example.com/path?key=value")) + }) + }) + + Describe("ImageURL", func() { + BeforeEach(func() { + conf.Server.ShareURL = "https://share.example.com" + // Initialize JWT auth for token generation + auth.TokenAuth = jwtauth.New("HS256", []byte("test secret"), nil) + }) + + It("generates a URL with the artwork token", func() { + artID := model.NewArtworkID(model.KindAlbumArtwork, "album-123", nil) + result := publicurl.ImageURL(nil, artID, 0) + Expect(result).To(HavePrefix("https://share.example.com/share/img/")) + }) + + It("includes size parameter when provided", func() { + artID := model.NewArtworkID(model.KindArtistArtwork, "artist-1", nil) + result := publicurl.ImageURL(nil, artID, 300) + Expect(result).To(ContainSubstring("size=300")) + }) + + It("omits size parameter when zero", func() { + artID := model.NewArtworkID(model.KindMediaFileArtwork, "track-1", nil) + result := publicurl.ImageURL(nil, artID, 0) + Expect(result).ToNot(ContainSubstring("size=")) + }) + }) +}) diff --git a/core/scrobbler/buffered_scrobbler.go b/core/scrobbler/buffered_scrobbler.go index 047e43eef..67593e9eb 100644 --- a/core/scrobbler/buffered_scrobbler.go +++ b/core/scrobbler/buffered_scrobbler.go @@ -9,26 +9,65 @@ import ( "github.com/navidrome/navidrome/model" ) +// Loader is a function that loads a scrobbler by name. +// It returns the scrobbler and true if found, or nil and false if not available. +// This allows the buffered scrobbler to always get the current plugin instance. +type Loader func() (Scrobbler, bool) + +// newBufferedScrobbler creates a buffered scrobbler that wraps a static scrobbler instance. +// Use this for builtin scrobblers that don't change. func newBufferedScrobbler(ds model.DataStore, s Scrobbler, service string) *bufferedScrobbler { - b := &bufferedScrobbler{ds: ds, wrapped: s, service: service} - b.wakeSignal = make(chan struct{}, 1) - go b.run(context.TODO()) + return newBufferedScrobblerWithLoader(ds, service, func() (Scrobbler, bool) { + return s, true + }) +} + +// newBufferedScrobblerWithLoader creates a buffered scrobbler that dynamically loads +// the underlying scrobbler on each call. Use this for plugin scrobblers that may be +// reloaded (e.g., after configuration changes). +func newBufferedScrobblerWithLoader(ds model.DataStore, service string, loader Loader) *bufferedScrobbler { + ctx, cancel := context.WithCancel(context.Background()) + b := &bufferedScrobbler{ + ds: ds, + loader: loader, + service: service, + wakeSignal: make(chan struct{}, 1), + ctx: ctx, + cancel: cancel, + } + go b.run(ctx) return b } type bufferedScrobbler struct { ds model.DataStore - wrapped Scrobbler + loader Loader service string wakeSignal chan struct{} + ctx context.Context + cancel context.CancelFunc +} + +func (b *bufferedScrobbler) Stop() { + if b.cancel != nil { + b.cancel() + } } func (b *bufferedScrobbler) IsAuthorized(ctx context.Context, userId string) bool { - return b.wrapped.IsAuthorized(ctx, userId) + s, ok := b.loader() + if !ok { + return false + } + return s.IsAuthorized(ctx, userId) } -func (b *bufferedScrobbler) NowPlaying(ctx context.Context, userId string, track *model.MediaFile) error { - return b.wrapped.NowPlaying(ctx, userId, track) +func (b *bufferedScrobbler) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { + s, ok := b.loader() + if !ok { + return errors.New("scrobbler not available") + } + return s.NowPlaying(ctx, userId, track, position) } func (b *bufferedScrobbler) Scrobble(ctx context.Context, userId string, s Scrobble) error { @@ -41,6 +80,14 @@ func (b *bufferedScrobbler) Scrobble(ctx context.Context, userId string, s Scrob return nil } +func (b *bufferedScrobbler) PlaybackReport(ctx context.Context, info PlaybackSession) error { + s, ok := b.loader() + if !ok { + return errors.New("scrobbler not available") + } + return s.PlaybackReport(ctx, info) +} + func (b *bufferedScrobbler) sendWakeSignal() { // Don't block if the previous signal was not read yet select { @@ -92,8 +139,13 @@ func (b *bufferedScrobbler) processUserQueue(ctx context.Context, userId string) if entry == nil { return true } + s, ok := b.loader() + if !ok { + log.Warn(ctx, "Scrobbler not available, will retry later", "scrobbler", b.service) + return false + } log.Debug(ctx, "Sending scrobble", "scrobbler", b.service, "track", entry.Title, "artist", entry.Artist) - err = b.wrapped.Scrobble(ctx, entry.UserID, Scrobble{ + err = s.Scrobble(ctx, entry.UserID, Scrobble{ MediaFile: entry.MediaFile, TimeStamp: entry.PlayTime, }) diff --git a/core/scrobbler/buffered_scrobbler_test.go b/core/scrobbler/buffered_scrobbler_test.go new file mode 100644 index 000000000..9fbca6f71 --- /dev/null +++ b/core/scrobbler/buffered_scrobbler_test.go @@ -0,0 +1,89 @@ +package scrobbler + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("BufferedScrobbler", func() { + var ds model.DataStore + var scr *fakeScrobbler + var bs *bufferedScrobbler + var ctx context.Context + var buffer *tests.MockedScrobbleBufferRepo + + BeforeEach(func() { + ctx = context.Background() + buffer = tests.CreateMockedScrobbleBufferRepo() + ds = &tests.MockDataStore{ + MockedScrobbleBuffer: buffer, + } + scr = &fakeScrobbler{Authorized: true} + bs = newBufferedScrobbler(ds, scr, "test") + }) + + It("forwards IsAuthorized calls", func() { + scr.Authorized = true + Expect(bs.IsAuthorized(ctx, "user1")).To(BeTrue()) + + scr.Authorized = false + Expect(bs.IsAuthorized(ctx, "user1")).To(BeFalse()) + }) + + It("forwards NowPlaying calls", func() { + track := &model.MediaFile{ID: "123", Title: "Test Track"} + Expect(bs.NowPlaying(ctx, "user1", track, 0)).To(Succeed()) + Expect(scr.GetNowPlayingCalled()).To(BeTrue()) + Expect(scr.GetUserID()).To(Equal("user1")) + Expect(scr.GetTrack()).To(Equal(track)) + }) + + It("enqueues scrobbles to buffer", func() { + track := model.MediaFile{ID: "123", Title: "Test Track"} + now := time.Now() + scrobble := Scrobble{MediaFile: track, TimeStamp: now} + Expect(buffer.Length()).To(Equal(int64(0))) + Expect(scr.ScrobbleCalled.Load()).To(BeFalse()) + + Expect(bs.Scrobble(ctx, "user1", scrobble)).To(Succeed()) + + // Wait for the background goroutine to process the scrobble. + // We don't check buffer.Length() here because the background goroutine + // may dequeue the entry before we can observe it. + Eventually(scr.ScrobbleCalled.Load).Should(BeTrue()) + + lastScrobble := scr.LastScrobble.Load() + Expect(lastScrobble.MediaFile.ID).To(Equal("123")) + Expect(lastScrobble.TimeStamp).To(BeTemporally("==", now)) + }) + + It("stops the background goroutine when Stop is called", func() { + // Replace the real run method with one that signals when it exits + done := make(chan struct{}) + + // Start our instrumented run function that will signal when it exits + go func() { + defer close(done) + bs.run(bs.ctx) + }() + + // Wait a bit to ensure the goroutine is running + time.Sleep(10 * time.Millisecond) + + // Call the real Stop method + bs.Stop() + + // Wait for the goroutine to exit or timeout + select { + case <-done: + // Success, goroutine exited + case <-time.After(100 * time.Millisecond): + Fail("Goroutine did not exit in time after Stop was called") + } + }) +}) diff --git a/core/scrobbler/interfaces.go b/core/scrobbler/interfaces.go index 90141f112..8a18bb37e 100644 --- a/core/scrobbler/interfaces.go +++ b/core/scrobbler/interfaces.go @@ -21,8 +21,9 @@ var ( type Scrobbler interface { IsAuthorized(ctx context.Context, userId string) bool - NowPlaying(ctx context.Context, userId string, track *model.MediaFile) error + NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error Scrobble(ctx context.Context, userId string, s Scrobble) error + PlaybackReport(ctx context.Context, info PlaybackSession) error } type Constructor func(ds model.DataStore) Scrobbler diff --git a/core/scrobbler/nowplaying_worker.go b/core/scrobbler/nowplaying_worker.go new file mode 100644 index 000000000..1bacec689 --- /dev/null +++ b/core/scrobbler/nowplaying_worker.go @@ -0,0 +1,78 @@ +package scrobbler + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +func (p *playTracker) enqueueNowPlaying(ctx context.Context, playerId string, userId string, track *model.MediaFile, position int) { + p.npMu.Lock() + defer p.npMu.Unlock() + ctx = context.WithoutCancel(ctx) // Prevent cancellation from affecting background processing + p.npQueue[playerId] = nowPlayingEntry{ + ctx: ctx, + userId: userId, + track: track, + position: position, + } + p.sendNowPlayingSignal() +} + +func (p *playTracker) sendNowPlayingSignal() { + // Don't block if the previous signal was not read yet + select { + case p.npSignal <- struct{}{}: + default: + } +} + +func (p *playTracker) nowPlayingWorker() { + defer close(p.workerDone) + for { + select { + case <-p.shutdown: + return + case <-time.After(time.Second): + case <-p.npSignal: + } + + p.npMu.Lock() + if len(p.npQueue) == 0 { + p.npMu.Unlock() + continue + } + + // Keep a copy of the entries to process and clear the queue + entries := p.npQueue + p.npQueue = make(map[string]nowPlayingEntry) + p.npMu.Unlock() + + // Process entries without holding lock + for _, entry := range entries { + p.dispatchNowPlaying(entry.ctx, entry.userId, entry.track, entry.position) + } + } +} + +func (p *playTracker) dispatchNowPlaying(ctx context.Context, userId string, t *model.MediaFile, position int) { + if t.Artist == consts.UnknownArtist { + log.Debug(ctx, "Ignoring external NowPlaying update for track with unknown artist", "track", t.Title, "artist", t.Artist) + return + } + allScrobblers := p.getActiveScrobblers() + for name, s := range allScrobblers { + if !s.IsAuthorized(ctx, userId) { + continue + } + log.Debug(ctx, "Sending NowPlaying update", "scrobbler", name, "track", t.Title, "artist", t.Artist, "position", position) + err := s.NowPlaying(ctx, userId, t, position) + if err != nil { + log.Error(ctx, "Error sending PlaybackSession", "scrobbler", name, "track", t.Title, "artist", t.Artist, err) + continue + } + } +} diff --git a/core/scrobbler/play_tracker.go b/core/scrobbler/play_tracker.go index 53f397647..860a80bce 100644 --- a/core/scrobbler/play_tracker.go +++ b/core/scrobbler/play_tracker.go @@ -2,9 +2,12 @@ package scrobbler import ( "context" - "sort" + "maps" + "slices" + "sync" "time" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" @@ -14,12 +17,32 @@ import ( "github.com/navidrome/navidrome/utils/singleton" ) -type NowPlayingInfo struct { - MediaFile model.MediaFile - Start time.Time - Username string - PlayerId string - PlayerName string +const ( + StateStarting = "starting" + StatePlaying = "playing" + StatePaused = "paused" + StateStopped = "stopped" + StateExpired = "expired" +) + +var ValidStates = map[string]bool{ + StateStarting: true, + StatePlaying: true, + StatePaused: true, + StateStopped: true, +} + +type PlaybackSession struct { + MediaFile model.MediaFile + Start time.Time + UserId string + Username string + PlayerId string + PlayerName string + State string + PositionMs int64 + PlaybackRate float64 + LastReport time.Time } type Submission struct { @@ -27,31 +50,104 @@ type Submission struct { Timestamp time.Time } +type ReportPlaybackParams struct { + MediaId string + PositionMs int64 + State string + PlaybackRate float64 + IgnoreScrobble bool + ClientId string + ClientName string +} + +type nowPlayingEntry struct { + ctx context.Context + userId string + track *model.MediaFile + position int +} + +type playbackReportEntry struct { + ctx context.Context + info PlaybackSession +} + type PlayTracker interface { - NowPlaying(ctx context.Context, playerId string, playerName string, trackId string) error - GetNowPlaying(ctx context.Context) ([]NowPlayingInfo, error) + GetNowPlaying(ctx context.Context) ([]PlaybackSession, error) Submit(ctx context.Context, submissions []Submission) error + ReportPlayback(ctx context.Context, params ReportPlaybackParams) error +} + +// PluginLoader is a minimal interface for plugin manager usage in PlayTracker +// (avoids import cycles) +type PluginLoader interface { + PluginNames(capability string) []string + LoadScrobbler(name string) (Scrobbler, bool) } type playTracker struct { - ds model.DataStore - broker events.Broker - playMap cache.SimpleCache[string, NowPlayingInfo] - scrobblers map[string]Scrobbler + ds model.DataStore + broker events.Broker + playMap cache.SimpleCache[string, PlaybackSession] + builtinScrobblers map[string]Scrobbler + pluginScrobblers map[string]Scrobbler + pluginLoader PluginLoader + mu sync.RWMutex + npQueue map[string]nowPlayingEntry + npMu sync.Mutex + npSignal chan struct{} + shutdown chan struct{} + workerDone chan struct{} + prQueue []playbackReportEntry + prMu sync.Mutex + prSignal chan struct{} + prWorkerDone chan struct{} } -func GetPlayTracker(ds model.DataStore, broker events.Broker) PlayTracker { +func GetPlayTracker(ds model.DataStore, broker events.Broker, pluginManager PluginLoader) PlayTracker { return singleton.GetInstance(func() *playTracker { - return newPlayTracker(ds, broker) + return newPlayTracker(ds, broker, pluginManager) }) } -// This constructor only exists for testing. For normal usage, the PlayTracker has to be a singleton, returned by -// the GetPlayTracker function above -func newPlayTracker(ds model.DataStore, broker events.Broker) *playTracker { - m := cache.NewSimpleCache[string, NowPlayingInfo]() - p := &playTracker{ds: ds, playMap: m, broker: broker} - p.scrobblers = make(map[string]Scrobbler) +// NewPlayTracker creates a new PlayTracker instance. For normal usage, the PlayTracker has to be a singleton, +// returned by the GetPlayTracker function above. This constructor is exported for testing. +func NewPlayTracker(ds model.DataStore, broker events.Broker, pluginManager PluginLoader) PlayTracker { + return newPlayTracker(ds, broker, pluginManager) +} + +func newPlayTracker(ds model.DataStore, broker events.Broker, pluginManager PluginLoader) *playTracker { + m := cache.NewSimpleCache[string, PlaybackSession]() + p := &playTracker{ + ds: ds, + playMap: m, + broker: broker, + builtinScrobblers: make(map[string]Scrobbler), + pluginScrobblers: make(map[string]Scrobbler), + pluginLoader: pluginManager, + npQueue: make(map[string]nowPlayingEntry), + npSignal: make(chan struct{}, 1), + shutdown: make(chan struct{}), + workerDone: make(chan struct{}), + prSignal: make(chan struct{}, 1), + prWorkerDone: make(chan struct{}), + } + enableNowPlaying := conf.Server.EnableNowPlaying + m.OnExpiration(func(_ string, info PlaybackSession) { + log.Debug("PlaybackSession expired", "clientId", info.PlayerId, "mediaId", info.MediaFile.ID, "state", + info.State, "username", info.Username, "userId", info.UserId) + if enableNowPlaying { + broker.SendBroadcastMessage(context.Background(), &events.NowPlayingCount{Count: m.Len()}) + } + ctx := request.WithUser(context.Background(), model.User{ID: info.UserId, UserName: info.Username}) + if info.State != StateStopped { + log.Trace("Enqueueing PlaybackReport for expired session", "session", info) + info.State = StateExpired + info.LastReport = time.Now() + p.enqueuePlaybackReport(ctx, info) + } + }) + var enabled []string for name, constructor := range constructors { s := constructor(ds) @@ -61,60 +157,250 @@ func newPlayTracker(ds model.DataStore, broker events.Broker) *playTracker { } enabled = append(enabled, name) s = newBufferedScrobbler(ds, s, name) - p.scrobblers[name] = s + p.builtinScrobblers[name] = s } - log.Debug("List of scrobblers enabled", "names", enabled) + log.Debug("List of builtin scrobblers enabled", "names", enabled) + go p.nowPlayingWorker() + go p.playbackReportWorker() return p } -func (p *playTracker) NowPlaying(ctx context.Context, playerId string, playerName string, trackId string) error { - mf, err := p.ds.MediaFile(ctx).GetWithParticipants(trackId) - if err != nil { - log.Error(ctx, "Error retrieving mediaFile", "id", trackId, err) - return err +// stopBackgroundWorkers stops the background workers. This is primarily for testing. +func (p *playTracker) stopBackgroundWorkers() { + close(p.shutdown) + <-p.workerDone // Wait for nowPlaying worker to finish + <-p.prWorkerDone // Wait for playbackReport worker to finish +} + +// pluginNamesMatchScrobblers returns true if the set of pluginNames matches the keys in pluginScrobblers. +func pluginNamesMatchScrobblers(pluginNames []string, scrobblers map[string]Scrobbler) bool { + if len(pluginNames) != len(scrobblers) { + return false + } + for _, name := range pluginNames { + if _, ok := scrobblers[name]; !ok { + return false + } + } + return true +} + +// refreshPluginScrobblers updates the pluginScrobblers map to match the current set of plugin scrobblers. +// The buffered scrobblers use a loader function to dynamically get the current plugin instance, +// so we only need to add/remove scrobblers when plugins are added/removed (not when reloaded). +func (p *playTracker) refreshPluginScrobblers() { + p.mu.Lock() + defer p.mu.Unlock() + if p.pluginLoader == nil { + return } - user, _ := request.UserFrom(ctx) - info := NowPlayingInfo{ - MediaFile: *mf, - Start: time.Now(), - Username: user.UserName, - PlayerId: playerId, - PlayerName: playerName, + // Get the list of available plugin names + pluginNames := p.pluginLoader.PluginNames("Scrobbler") + + // Early return if plugin names match existing scrobblers (no change) + if pluginNamesMatchScrobblers(pluginNames, p.pluginScrobblers) { + return } - ttl := time.Duration(int(mf.Duration)+5) * time.Second - _ = p.playMap.AddWithTTL(playerId, info, ttl) + // Build a set of current plugins for faster lookups + current := make(map[string]struct{}, len(pluginNames)) + + // Process additions - add new plugins with a loader that dynamically fetches the current instance + for _, name := range pluginNames { + current[name] = struct{}{} + if _, exists := p.pluginScrobblers[name]; !exists { + // Capture the name for the closure + pluginName := name + loader := p.pluginLoader + p.pluginScrobblers[name] = newBufferedScrobblerWithLoader(p.ds, name, func() (Scrobbler, bool) { + return loader.LoadScrobbler(pluginName) + }) + } + } + + type stoppableScrobbler interface { + Scrobbler + Stop() + } + + // Process removals - remove plugins that no longer exist + for name, scrobbler := range p.pluginScrobblers { + if _, exists := current[name]; !exists { + // If the scrobbler implements stoppableScrobbler, call Stop() before removing it + if stoppable, ok := scrobbler.(stoppableScrobbler); ok { + log.Debug("Stopping scrobbler", "name", name) + stoppable.Stop() + } + delete(p.pluginScrobblers, name) + } + } +} + +// getActiveScrobblers refreshes plugin scrobblers, acquires a read lock, +// combines builtin and plugin scrobblers into a new map, releases the lock, +// and returns the combined map. +func (p *playTracker) getActiveScrobblers() map[string]Scrobbler { + p.refreshPluginScrobblers() + p.mu.RLock() + defer p.mu.RUnlock() + combined := maps.Clone(p.builtinScrobblers) + maps.Copy(combined, p.pluginScrobblers) + return combined +} + +func remainingTTL(durationSec float32, positionMs int64, rate float64) time.Duration { + if rate <= 0 { + rate = 1.0 + } + remainingMs := float64(int64(durationSec*1000)-positionMs) / rate + remainingSec := max(int(remainingMs/1000), 0) + return time.Duration(remainingSec+5) * time.Second +} + +func (p *playTracker) ReportPlayback(ctx context.Context, params ReportPlaybackParams) error { player, _ := request.PlayerFrom(ctx) - if player.ScrobbleEnabled { - p.dispatchNowPlaying(ctx, user.ID, mf) + user, _ := request.UserFrom(ctx) + clientId := params.ClientId + client := params.ClientName + + now := time.Now() + + switch params.State { + case StateStarting: + mf, err := p.ds.MediaFile(ctx).GetWithParticipants(params.MediaId) + if err != nil { + return err + } + info := PlaybackSession{ + MediaFile: *mf, + Start: now, + UserId: user.ID, + Username: user.UserName, + PlayerId: clientId, + PlayerName: client, + State: params.State, + PositionMs: params.PositionMs, + PlaybackRate: params.PlaybackRate, + LastReport: now, + } + err = p.playMap.AddWithTTL(clientId, info, remainingTTL(mf.Duration, params.PositionMs, params.PlaybackRate)) + if err != nil { + log.Warn(ctx, "Error adding PlaybackSession to cache", "clientId", clientId, "mediaId", params.MediaId, "state", params.State, err) + } + p.enqueuePlaybackReport(ctx, info) + + case StatePlaying, StatePaused: + info, getErr := p.playMap.Get(clientId) + if getErr != nil || info.MediaFile.ID != params.MediaId { + mf, err := p.ds.MediaFile(ctx).GetWithParticipants(params.MediaId) + if err != nil { + return err + } + info = PlaybackSession{ + MediaFile: *mf, + Start: now.Add(-time.Duration(params.PositionMs) * time.Millisecond), + UserId: user.ID, + Username: user.UserName, + PlayerId: clientId, + PlayerName: client, + } + } + info.State = params.State + info.PositionMs = params.PositionMs + info.PlaybackRate = params.PlaybackRate + info.LastReport = now + ttl := 30 * time.Minute + if params.State == StatePlaying { + ttl = remainingTTL(info.MediaFile.Duration, params.PositionMs, params.PlaybackRate) + } + log.Trace(ctx, "Updating PlaybackSession in cache", "clientId", clientId, "mediaId", params.MediaId, "state", params.State, "positionMs", params.PositionMs, "playbackRate", params.PlaybackRate, "ttl", ttl) + err := p.playMap.AddWithTTL(clientId, info, ttl) + if err != nil { + log.Warn(ctx, "Error updating PlaybackSession in cache", "clientId", clientId, "mediaId", params.MediaId, "state", params.State, err) + } + p.enqueuePlaybackReport(ctx, info) + + case StateStopped: + var loadedMF *model.MediaFile + if !params.IgnoreScrobble && player.ScrobbleEnabled { + mf, err := p.ds.MediaFile(ctx).GetWithParticipants(params.MediaId) + if err != nil { + return err + } + loadedMF = mf + trackDurationMs := int64(mf.Duration * 1000) + threshold := min(trackDurationMs*50/100, 240_000) + if params.PositionMs >= threshold { + err = p.incPlay(ctx, mf, now) + if err != nil { + log.Warn(ctx, "Error updating play counts", "id", mf.ID, "track", mf.Title, "user", user.UserName, err) + } + p.dispatchScrobble(ctx, mf, now) + } + } + stoppedInfo := PlaybackSession{ + UserId: user.ID, + Username: user.UserName, + PlayerId: clientId, + PlayerName: client, + State: params.State, + PositionMs: params.PositionMs, + PlaybackRate: params.PlaybackRate, + LastReport: now, + } + if info, getErr := p.playMap.Get(clientId); getErr == nil { + stoppedInfo.MediaFile = info.MediaFile + stoppedInfo.Start = info.Start + } else { + mf := loadedMF + if mf == nil { + var mfErr error + mf, mfErr = p.ds.MediaFile(ctx).GetWithParticipants(params.MediaId) + if mfErr != nil { + return mfErr + } + } + stoppedInfo.MediaFile = *mf + } + p.enqueuePlaybackReport(ctx, stoppedInfo) + p.playMap.Remove(clientId) } + + if conf.Server.EnableNowPlaying { + p.broker.SendBroadcastMessage(ctx, &events.NowPlayingCount{Count: p.playMap.Len()}) + } + + // NowPlaying gating, by design distinct from scrobble submission: + // - IgnoreScrobble=true -> still send NowPlaying (suppresses only the + // scrobble submission/play-count above), mirroring the legacy scrobble + // endpoint's submission=false behavior. + // - player.ScrobbleEnabled=false -> never send NowPlaying. + // External agents here are the active scrobblers (Last.fm, ListenBrainz, and + // scrobbler plugins) returned by getActiveScrobblers; see dispatchNowPlaying. + if player.ScrobbleEnabled && + (params.State == StateStarting || params.State == StatePlaying) { + if info, err := p.playMap.Get(clientId); err == nil { + p.enqueueNowPlaying(ctx, clientId, user.ID, &info.MediaFile, int(params.PositionMs/1000)) + } + } + return nil } -func (p *playTracker) dispatchNowPlaying(ctx context.Context, userId string, t *model.MediaFile) { - if t.Artist == consts.UnknownArtist { - log.Debug(ctx, "Ignoring external NowPlaying update for track with unknown artist", "track", t.Title, "artist", t.Artist) - return - } - for name, s := range p.scrobblers { - if !s.IsAuthorized(ctx, userId) { - continue - } - log.Debug(ctx, "Sending NowPlaying update", "scrobbler", name, "track", t.Title, "artist", t.Artist) - err := s.NowPlaying(ctx, userId, t) - if err != nil { - log.Error(ctx, "Error sending NowPlayingInfo", "scrobbler", name, "track", t.Title, "artist", t.Artist, err) - continue - } - } -} - -func (p *playTracker) GetNowPlaying(_ context.Context) ([]NowPlayingInfo, error) { +func (p *playTracker) GetNowPlaying(_ context.Context) ([]PlaybackSession, error) { res := p.playMap.Values() - sort.Slice(res, func(i, j int) bool { - return res[i].Start.After(res[j].Start) + slices.SortFunc(res, func(a, b PlaybackSession) int { + return b.Start.Compare(a.Start) }) + for i := range res { + if res[i].State == StatePlaying { + elapsed := time.Since(res[i].LastReport).Milliseconds() + estimated := res[i].PositionMs + int64(float64(elapsed)*res[i].PlaybackRate) + trackDurationMs := int64(res[i].MediaFile.Duration * 1000) + res[i].PositionMs = min(estimated, trackDurationMs) + } + } return res, nil } @@ -164,8 +450,14 @@ func (p *playTracker) incPlay(ctx context.Context, track *model.MediaFile, times } for _, artist := range track.Participants[model.RoleArtist] { err = tx.Artist(ctx).IncPlayCount(artist.ID, timestamp) + if err != nil { + return err + } } - return err + if conf.Server.EnableScrobbleHistory { + return tx.Scrobble(ctx).RecordScrobble(track.ID, timestamp) + } + return nil }) } @@ -174,9 +466,11 @@ func (p *playTracker) dispatchScrobble(ctx context.Context, t *model.MediaFile, log.Debug(ctx, "Ignoring external Scrobble for track with unknown artist", "track", t.Title, "artist", t.Artist) return } + + allScrobblers := p.getActiveScrobblers() u, _ := request.UserFrom(ctx) scrobble := Scrobble{MediaFile: *t, TimeStamp: playTime} - for name, s := range p.scrobblers { + for name, s := range allScrobblers { if !s.IsAuthorized(ctx, u.ID) { continue } diff --git a/core/scrobbler/play_tracker_test.go b/core/scrobbler/play_tracker_test.go index 0ff025f15..b5a478c2a 100644 --- a/core/scrobbler/play_tracker_test.go +++ b/core/scrobbler/play_tracker_test.go @@ -3,8 +3,13 @@ package scrobbler import ( "context" "errors" + "net/http" + "sync" + "sync/atomic" "time" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model" @@ -15,30 +20,58 @@ import ( . "github.com/onsi/gomega" ) +type mockPluginLoader struct { + mu sync.RWMutex + names []string + scrobblers map[string]Scrobbler +} + +func (m *mockPluginLoader) PluginNames(service string) []string { + m.mu.RLock() + defer m.mu.RUnlock() + return m.names +} + +func (m *mockPluginLoader) SetNames(names []string) { + m.mu.Lock() + defer m.mu.Unlock() + m.names = names +} + +func (m *mockPluginLoader) LoadScrobbler(name string) (Scrobbler, bool) { + m.mu.RLock() + defer m.mu.RUnlock() + s, ok := m.scrobblers[name] + return s, ok +} + var _ = Describe("PlayTracker", func() { var ctx context.Context var ds model.DataStore - var tracker PlayTracker + var tracker *playTracker + var eventBroker *fakeEventBroker var track model.MediaFile var album model.Album var artist1 model.Artist var artist2 model.Artist - var fake fakeScrobbler + var fake *fakeScrobbler BeforeEach(func() { - ctx = context.Background() + DeferCleanup(configtest.SetupConfig()) + ctx = GinkgoT().Context() ctx = request.WithUser(ctx, model.User{ID: "u-1"}) ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: true}) ds = &tests.MockDataStore{} - fake = fakeScrobbler{Authorized: true} + fake = &fakeScrobbler{Authorized: true} Register("fake", func(model.DataStore) Scrobbler { - return &fake + return fake }) Register("disabled", func(model.DataStore) Scrobbler { return nil }) - tracker = newPlayTracker(ds, events.GetBroker()) - tracker.(*playTracker).scrobblers["fake"] = &fake // Bypass buffering for tests + eventBroker = &fakeEventBroker{} + tracker = newPlayTracker(ds, eventBroker, nil) + tracker.builtinScrobblers["fake"] = fake // Bypass buffering for tests track = model.MediaFile{ ID: "123", @@ -61,44 +94,14 @@ var _ = Describe("PlayTracker", func() { _ = ds.Album(ctx).(*tests.MockAlbumRepo).Put(&album) }) - It("does not register disabled scrobblers", func() { - Expect(tracker.(*playTracker).scrobblers).To(HaveKey("fake")) - Expect(tracker.(*playTracker).scrobblers).ToNot(HaveKey("disabled")) + AfterEach(func() { + // Stop the worker goroutine to prevent data races between tests + tracker.stopBackgroundWorkers() }) - Describe("NowPlaying", func() { - It("sends track to agent", func() { - err := tracker.NowPlaying(ctx, "player-1", "player-one", "123") - Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeTrue()) - Expect(fake.UserID).To(Equal("u-1")) - Expect(fake.Track.ID).To(Equal("123")) - Expect(fake.Track.Participants).To(Equal(track.Participants)) - }) - It("does not send track to agent if user has not authorized", func() { - fake.Authorized = false - - err := tracker.NowPlaying(ctx, "player-1", "player-one", "123") - - Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeFalse()) - }) - It("does not send track to agent if player is not enabled to send scrobbles", func() { - ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: false}) - - err := tracker.NowPlaying(ctx, "player-1", "player-one", "123") - - Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeFalse()) - }) - It("does not send track to agent if artist is unknown", func() { - track.Artist = consts.UnknownArtist - - err := tracker.NowPlaying(ctx, "player-1", "player-one", "123") - - Expect(err).ToNot(HaveOccurred()) - Expect(fake.NowPlayingCalled).To(BeFalse()) - }) + It("does not register disabled scrobblers", func() { + Expect(tracker.builtinScrobblers).To(HaveKey("fake")) + Expect(tracker.builtinScrobblers).ToNot(HaveKey("disabled")) }) Describe("GetNowPlaying", func() { @@ -106,10 +109,16 @@ var _ = Describe("PlayTracker", func() { track2 := track track2.ID = "456" _ = ds.MediaFile(ctx).Put(&track2) - ctx = request.WithUser(context.Background(), model.User{UserName: "user-1"}) - _ = tracker.NowPlaying(ctx, "player-1", "player-one", "123") - ctx = request.WithUser(context.Background(), model.User{UserName: "user-2"}) - _ = tracker.NowPlaying(ctx, "player-2", "player-two", "456") + ctx1 := request.WithUser(GinkgoT().Context(), model.User{UserName: "user-1"}) + ctx1 = request.WithPlayer(ctx1, model.Player{ScrobbleEnabled: true}) + _ = tracker.ReportPlayback(ctx1, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StatePlaying, PlaybackRate: 1.0, ClientId: "player-1", ClientName: "player-one", + }) + ctx2 := request.WithUser(GinkgoT().Context(), model.User{UserName: "user-2"}) + ctx2 = request.WithPlayer(ctx2, model.Player{ScrobbleEnabled: true}) + _ = tracker.ReportPlayback(ctx2, ReportPlaybackParams{ + MediaId: "456", PositionMs: 0, State: StatePlaying, PlaybackRate: 1.0, ClientId: "player-2", ClientName: "player-two", + }) playing, err := tracker.GetNowPlaying(ctx) @@ -127,6 +136,64 @@ var _ = Describe("PlayTracker", func() { }) }) + Describe("Expiration events", func() { + It("sends event when entry expires", func() { + info := PlaybackSession{MediaFile: track, Start: time.Now(), Username: "user"} + _ = tracker.playMap.AddWithTTL("player-1", info, 10*time.Millisecond) + Eventually(func() int { return len(eventBroker.getEvents()) }).Should(BeNumerically(">", 0)) + eventList := eventBroker.getEvents() + evt, ok := eventList[len(eventList)-1].(*events.NowPlayingCount) + Expect(ok).To(BeTrue()) + Expect(evt.Count).To(Equal(0)) + }) + + It("does not send event when disabled", func() { + conf.Server.EnableNowPlaying = false + tracker = newPlayTracker(ds, eventBroker, nil) + info := PlaybackSession{MediaFile: track, Start: time.Now(), Username: "user"} + _ = tracker.playMap.AddWithTTL("player-2", info, 10*time.Millisecond) + Consistently(func() int { return len(eventBroker.getEvents()) }).Should(Equal(0)) + }) + + It("sends expired playback report when session expires", func() { + info := PlaybackSession{ + MediaFile: track, + Start: time.Now(), + UserId: "u-1", + Username: "user", + PlayerId: "player-3", + PlayerName: "test-player", + State: StatePlaying, + PositionMs: 5000, + } + _ = tracker.playMap.AddWithTTL("player-3", info, 10*time.Millisecond) + Eventually(func() *PlaybackSession { + return fake.LastPlaybackReport.Load() + }).ShouldNot(BeNil()) + report := fake.LastPlaybackReport.Load() + Expect(report.State).To(Equal(StateExpired)) + Expect(report.MediaFile.ID).To(Equal("123")) + Expect(report.PlayerId).To(Equal("player-3")) + }) + + It("does not send expired report when session was already stopped", func() { + info := PlaybackSession{ + MediaFile: track, + Start: time.Now(), + UserId: "u-1", + Username: "user", + PlayerId: "player-4", + PlayerName: "test-player", + State: StateStopped, + PositionMs: 180000, + } + _ = tracker.playMap.AddWithTTL("player-4", info, 10*time.Millisecond) + Consistently(func() *PlaybackSession { + return fake.LastPlaybackReport.Load() + }).Should(BeNil()) + }) + }) + Describe("Submit", func() { It("sends track to agent", func() { ctx = request.WithUser(ctx, model.User{ID: "u-1", UserName: "user-1"}) @@ -135,10 +202,12 @@ var _ = Describe("PlayTracker", func() { err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: ts}}) Expect(err).ToNot(HaveOccurred()) - Expect(fake.ScrobbleCalled).To(BeTrue()) - Expect(fake.UserID).To(Equal("u-1")) - Expect(fake.LastScrobble.ID).To(Equal("123")) - Expect(fake.LastScrobble.Participants).To(Equal(track.Participants)) + Expect(fake.ScrobbleCalled.Load()).To(BeTrue()) + Expect(fake.GetUserID()).To(Equal("u-1")) + lastScrobble := fake.LastScrobble.Load() + Expect(lastScrobble.TimeStamp).To(BeTemporally("~", ts, 1*time.Second)) + Expect(lastScrobble.ID).To(Equal("123")) + Expect(lastScrobble.Participants).To(Equal(track.Participants)) }) It("increments play counts in the DB", func() { @@ -162,7 +231,7 @@ var _ = Describe("PlayTracker", func() { err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: time.Now()}}) Expect(err).ToNot(HaveOccurred()) - Expect(fake.ScrobbleCalled).To(BeFalse()) + Expect(fake.ScrobbleCalled.Load()).To(BeFalse()) }) It("does not send track to agent if player is not enabled to send scrobbles", func() { @@ -171,7 +240,7 @@ var _ = Describe("PlayTracker", func() { err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: time.Now()}}) Expect(err).ToNot(HaveOccurred()) - Expect(fake.ScrobbleCalled).To(BeFalse()) + Expect(fake.ScrobbleCalled.Load()).To(BeFalse()) }) It("does not send track to agent if artist is unknown", func() { @@ -180,7 +249,7 @@ var _ = Describe("PlayTracker", func() { err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: time.Now()}}) Expect(err).ToNot(HaveOccurred()) - Expect(fake.ScrobbleCalled).To(BeFalse()) + Expect(fake.ScrobbleCalled.Load()).To(BeFalse()) }) It("increments play counts even if it cannot scrobble", func() { @@ -189,7 +258,7 @@ var _ = Describe("PlayTracker", func() { err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: time.Now()}}) Expect(err).ToNot(HaveOccurred()) - Expect(fake.ScrobbleCalled).To(BeFalse()) + Expect(fake.ScrobbleCalled.Load()).To(BeFalse()) Expect(track.PlayCount).To(Equal(int64(1))) Expect(album.PlayCount).To(Equal(int64(1))) @@ -198,41 +267,876 @@ var _ = Describe("PlayTracker", func() { Expect(artist1.PlayCount).To(Equal(int64(1))) Expect(artist2.PlayCount).To(Equal(int64(1))) }) + + Context("Scrobble History", func() { + It("records scrobble in repository", func() { + conf.Server.EnableScrobbleHistory = true + ctx = request.WithUser(ctx, model.User{ID: "u-1", UserName: "user-1"}) + ts := time.Now() + + err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: ts}}) + + Expect(err).ToNot(HaveOccurred()) + + mockDS := ds.(*tests.MockDataStore) + mockScrobble := mockDS.Scrobble(ctx).(*tests.MockScrobbleRepo) + Expect(mockScrobble.RecordedScrobbles).To(HaveLen(1)) + Expect(mockScrobble.RecordedScrobbles[0].MediaFileID).To(Equal("123")) + Expect(mockScrobble.RecordedScrobbles[0].UserID).To(Equal("u-1")) + Expect(mockScrobble.RecordedScrobbles[0].SubmissionTime).To(Equal(ts)) + }) + + It("does not record scrobble when history is disabled", func() { + conf.Server.EnableScrobbleHistory = false + ctx = request.WithUser(ctx, model.User{ID: "u-1", UserName: "user-1"}) + ts := time.Now() + + err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: ts}}) + + Expect(err).ToNot(HaveOccurred()) + mockDS := ds.(*tests.MockDataStore) + mockScrobble := mockDS.Scrobble(ctx).(*tests.MockScrobbleRepo) + Expect(mockScrobble.RecordedScrobbles).To(HaveLen(0)) + }) + }) }) + Describe("ReportPlayback", func() { + const defaultClientId = "client-1" + + BeforeEach(func() { + ctx = request.WithPlayer(ctx, model.Player{ID: "p1", ScrobbleEnabled: true}) + }) + + It("creates entry on starting and removes on stopped", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].State).To(Equal("starting")) + Expect(playing[0].MediaFile.ID).To(Equal("123")) + + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + IgnoreScrobble: true, + }) + Expect(err).ToNot(HaveOccurred()) + + playing, err = tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(BeEmpty()) + }) + + It("full lifecycle: starting -> playing -> paused -> playing -> stopped", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].State).To(Equal("playing")) + Expect(playing[0].PositionMs).To(BeNumerically(">=", int64(10000))) + + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 30000, State: "paused", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + playing, err = tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing[0].State).To(Equal("paused")) + Expect(playing[0].PositionMs).To(Equal(int64(30000))) + + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 30000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 100000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + playing, err = tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(BeEmpty()) + }) + + It("starting replaces existing entry for same player", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 50000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].State).To(Equal("starting")) + Expect(playing[0].PositionMs).To(Equal(int64(0))) + }) + + It("multiple players have independent sessions", func() { + ctx1 := request.WithUser(ctx, model.User{ID: "u-1", UserName: "user1"}) + ctx1 = request.WithPlayer(ctx1, model.Player{ID: "p1", ScrobbleEnabled: true}) + + ctx2 := request.WithUser(ctx, model.User{ID: "u-1", UserName: "user1"}) + ctx2 = request.WithPlayer(ctx2, model.Player{ID: "p2", ScrobbleEnabled: true}) + + track2 := track + track2.ID = "456" + _ = ds.MediaFile(ctx).Put(&track2) + + err := tracker.ReportPlayback(ctx1, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "playing", PlaybackRate: 1.0, ClientId: "client-1", + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx2, ReportPlaybackParams{ + MediaId: "456", PositionMs: 0, State: "playing", PlaybackRate: 1.0, ClientId: "client-2", + }) + Expect(err).ToNot(HaveOccurred()) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(2)) + }) + + Describe("SSE broadcast on state change", func() { + BeforeEach(func() { + eventBroker = &fakeEventBroker{} + tracker = newPlayTracker(ds, eventBroker, nil) + tracker.builtinScrobblers["fake"] = fake + }) + + It("broadcasts NowPlayingCount on every state change", func() { + // starting -> count should be 1 + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + evts := eventBroker.getEvents() + Expect(evts).To(HaveLen(1)) + Expect(evts[0].(*events.NowPlayingCount).Count).To(Equal(1)) + + // playing -> count should be 1 + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + evts = eventBroker.getEvents() + Expect(evts).To(HaveLen(2)) + Expect(evts[1].(*events.NowPlayingCount).Count).To(Equal(1)) + + // paused -> count should be 1 + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 30000, State: "paused", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + evts = eventBroker.getEvents() + Expect(evts).To(HaveLen(3)) + Expect(evts[2].(*events.NowPlayingCount).Count).To(Equal(1)) + + // stopped -> count should be 0 + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 30000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + IgnoreScrobble: true, + }) + Expect(err).ToNot(HaveOccurred()) + evts = eventBroker.getEvents() + Expect(evts).To(HaveLen(4)) + Expect(evts[3].(*events.NowPlayingCount).Count).To(Equal(0)) + }) + + It("does NOT broadcast when EnableNowPlaying is false", func() { + conf.Server.EnableNowPlaying = false + tracker = newPlayTracker(ds, eventBroker, nil) + tracker.builtinScrobblers["fake"] = fake + + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(eventBroker.getEvents()).To(BeEmpty()) + }) + }) + + Describe("auto-scrobble", func() { + It("scrobbles on stopped when positionMs >= 50% of track", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 90000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(track.PlayCount).To(Equal(int64(1))) + Expect(album.PlayCount).To(Equal(int64(1))) + Expect(artist1.PlayCount).To(Equal(int64(1))) + }) + + It("scrobbles on stopped when positionMs >= 4 min for long tracks", func() { + longTrack := model.MediaFile{ + ID: "long", Title: "Long Song", Album: "Album", AlbumID: "al-1", + Duration: 600, + Participants: map[model.Role]model.ParticipantList{ + model.RoleArtist: []model.Participant{_p("ar-1", "Artist 1")}, + }, + } + _ = ds.MediaFile(ctx).Put(&longTrack) + + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "long", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "long", PositionMs: 240000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(longTrack.PlayCount).To(Equal(int64(1))) + }) + + It("does NOT scrobble when positionMs below threshold", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(track.PlayCount).To(Equal(int64(0))) + }) + + It("does NOT scrobble when ignoreScrobble=true even if threshold met", func() { + fake.ScrobbleCalled.Store(false) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 90000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + IgnoreScrobble: true, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(track.PlayCount).To(Equal(int64(0))) + Consistently(func() bool { return fake.ScrobbleCalled.Load() }).Should(BeFalse()) + }) + + It("does NOT scrobble when player ScrobbleEnabled=false even if threshold met", func() { + ctx = request.WithPlayer(ctx, model.Player{ID: "p1", ScrobbleEnabled: false}) + + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 90000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(track.PlayCount).To(Equal(int64(0))) + }) + + It("scrobbles twice for two separate sessions of same song", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 90000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 90000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(track.PlayCount).To(Equal(int64(2))) + }) + + It("dispatches to external scrobblers on auto-scrobble", func() { + fake.ScrobbleCalled.Store(false) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 90000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(fake.ScrobbleCalled.Load()).To(BeTrue()) + }) + }) + + Describe("position estimation", func() { + It("estimates position for playing state based on elapsed time", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + time.Sleep(50 * time.Millisecond) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].PositionMs).To(BeNumerically(">", int64(10000))) + }) + + It("does NOT estimate for paused", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "paused", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + time.Sleep(50 * time.Millisecond) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].PositionMs).To(Equal(int64(10000))) + }) + + It("does NOT estimate for starting", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + time.Sleep(50 * time.Millisecond) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].PositionMs).To(Equal(int64(0))) + }) + + It("respects playbackRate", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "playing", PlaybackRate: 2.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + time.Sleep(100 * time.Millisecond) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + // At 2x speed, 100ms real time = ~200ms playback time + Expect(playing[0].PositionMs).To(BeNumerically(">", int64(10100))) + }) + + It("caps estimated position at track duration", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 179990, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + time.Sleep(50 * time.Millisecond) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].PositionMs).To(Equal(int64(180000))) // track.Duration * 1000 + }) + + }) + + Describe("resilience (no prior starting)", func() { + It("playing without prior starting creates entry with Start approx now - positionMs", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 30000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].State).To(Equal("playing")) + expectedStart := time.Now().Add(-30 * time.Second) + Expect(playing[0].Start).To(BeTemporally("~", expectedStart, 2*time.Second)) + }) + + It("paused without prior starting creates entry", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 30000, State: "paused", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + playing, err := tracker.GetNowPlaying(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(playing).To(HaveLen(1)) + Expect(playing[0].State).To(Equal("paused")) + }) + + It("stopped without prior starting auto-scrobbles if threshold met", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 90000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(track.PlayCount).To(Equal(int64(1))) + }) + + It("stopped without prior starting does NOT scrobble if below threshold", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "stopped", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(track.PlayCount).To(Equal(int64(0))) + }) + }) + + Describe("external scrobbler dispatch", func() { + It("dispatches NowPlaying on starting", func() { + fake.nowPlayingCalled.Store(false) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.GetNowPlayingCalled() }).Should(BeTrue()) + }) + + It("dispatches NowPlaying on playing", func() { + fake.nowPlayingCalled.Store(false) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "playing", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.GetNowPlayingCalled() }).Should(BeTrue()) + }) + + It("does NOT dispatch on paused", func() { + fake.nowPlayingCalled.Store(false) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 10000, State: "paused", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Consistently(func() bool { return fake.GetNowPlayingCalled() }).Should(BeFalse()) + }) + + It("still dispatches NowPlaying when ignoreScrobble=true", func() { + fake.nowPlayingCalled.Store(false) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + IgnoreScrobble: true, + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.GetNowPlayingCalled() }).Should(BeTrue()) + }) + + It("does NOT dispatch when ScrobbleEnabled=false", func() { + fake.nowPlayingCalled.Store(false) + ctx = request.WithPlayer(ctx, model.Player{ID: "p1", ScrobbleEnabled: false}) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: "starting", PlaybackRate: 1.0, ClientId: defaultClientId, + }) + Expect(err).ToNot(HaveOccurred()) + Consistently(func() bool { return fake.GetNowPlayingCalled() }).Should(BeFalse()) + }) + }) + + Describe("PlaybackReport dispatch", func() { + It("dispatches PlaybackReport for starting state", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StateStarting, PlaybackRate: 1.0, + ClientId: "client-1", ClientName: "Test Player", + }) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() bool { + return fake.PlaybackReportCalled.Load() + }).Should(BeTrue()) + + info := fake.LastPlaybackReport.Load() + Expect(info).ToNot(BeNil()) + Expect(info.MediaFile.ID).To(Equal("123")) + Expect(info.State).To(Equal(StateStarting)) + Expect(info.PositionMs).To(Equal(int64(0))) + Expect(info.PlaybackRate).To(Equal(1.0)) + Expect(info.PlayerId).To(Equal("client-1")) + Expect(info.PlayerName).To(Equal("Test Player")) + }) + + It("dispatches PlaybackReport for playing state", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StateStarting, PlaybackRate: 1.0, + ClientId: "client-1", ClientName: "Test Player", + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.PlaybackReportCalled.Load() }).Should(BeTrue()) + fake.PlaybackReportCalled.Store(false) + fake.LastPlaybackReport.Store(nil) + + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 30000, State: StatePlaying, PlaybackRate: 1.5, + ClientId: "client-1", ClientName: "Test Player", + }) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() bool { return fake.PlaybackReportCalled.Load() }).Should(BeTrue()) + info := fake.LastPlaybackReport.Load() + Expect(info.State).To(Equal(StatePlaying)) + Expect(info.PositionMs).To(Equal(int64(30000))) + Expect(info.PlaybackRate).To(Equal(1.5)) + }) + + It("dispatches PlaybackReport for paused state", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StateStarting, PlaybackRate: 1.0, + ClientId: "client-1", ClientName: "Test Player", + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.PlaybackReportCalled.Load() }).Should(BeTrue()) + fake.PlaybackReportCalled.Store(false) + fake.LastPlaybackReport.Store(nil) + + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 45000, State: StatePaused, PlaybackRate: 1.0, + ClientId: "client-1", ClientName: "Test Player", + }) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() bool { return fake.PlaybackReportCalled.Load() }).Should(BeTrue()) + info := fake.LastPlaybackReport.Load() + Expect(info.State).To(Equal(StatePaused)) + Expect(info.PositionMs).To(Equal(int64(45000))) + }) + + It("dispatches PlaybackReport for stopped state", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StateStarting, PlaybackRate: 1.0, + ClientId: "client-1", ClientName: "Test Player", + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.PlaybackReportCalled.Load() }).Should(BeTrue()) + fake.PlaybackReportCalled.Store(false) + fake.LastPlaybackReport.Store(nil) + + err = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 100000, State: StateStopped, PlaybackRate: 1.0, + ClientId: "client-1", ClientName: "Test Player", + }) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() bool { return fake.PlaybackReportCalled.Load() }).Should(BeTrue()) + info := fake.LastPlaybackReport.Load() + Expect(info.State).To(Equal(StateStopped)) + Expect(info.PositionMs).To(Equal(int64(100000))) + }) + }) + }) + + Describe("Plugin scrobbler logic", func() { + var pluginLoader *mockPluginLoader + var pluginFake *fakeScrobbler + + BeforeEach(func() { + pluginFake = &fakeScrobbler{Authorized: true} + pluginLoader = &mockPluginLoader{ + names: []string{"plugin1"}, + scrobblers: map[string]Scrobbler{"plugin1": pluginFake}, + } + tracker = newPlayTracker(ds, events.GetBroker(), pluginLoader) + + // Bypass buffering for both built-in and plugin scrobblers + tracker.builtinScrobblers["fake"] = fake + tracker.pluginScrobblers["plugin1"] = pluginFake + }) + + It("registers and uses plugin scrobbler for NowPlaying", func() { + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StatePlaying, PlaybackRate: 1.0, ClientId: "player-1", + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeTrue()) + }) + + It("removes plugin scrobbler if not present anymore", func() { + _ = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StatePlaying, PlaybackRate: 1.0, ClientId: "player-1", + }) + Eventually(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeTrue()) + pluginFake.nowPlayingCalled.Store(false) + pluginLoader.SetNames([]string{}) + _ = tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StatePlaying, PlaybackRate: 1.0, ClientId: "player-1", + }) + Consistently(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeFalse()) + }) + + It("calls both builtin and plugin scrobblers for NowPlaying", func() { + fake.nowPlayingCalled.Store(false) + pluginFake.nowPlayingCalled.Store(false) + err := tracker.ReportPlayback(ctx, ReportPlaybackParams{ + MediaId: "123", PositionMs: 0, State: StatePlaying, PlaybackRate: 1.0, ClientId: "player-1", + }) + Expect(err).ToNot(HaveOccurred()) + Eventually(func() bool { return fake.GetNowPlayingCalled() }).Should(BeTrue()) + Eventually(func() bool { return pluginFake.GetNowPlayingCalled() }).Should(BeTrue()) + }) + + It("calls plugin scrobbler for Submit", func() { + ts := time.Now() + err := tracker.Submit(ctx, []Submission{{TrackID: "123", Timestamp: ts}}) + Expect(err).ToNot(HaveOccurred()) + Expect(pluginFake.ScrobbleCalled.Load()).To(BeTrue()) + }) + }) + + Describe("Plugin Scrobbler Management", func() { + var pluginScr *fakeScrobbler + var mockPlugin *mockPluginLoader + var pTracker *playTracker + var mockedBS *mockBufferedScrobbler + + BeforeEach(func() { + ctx = GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "u-1"}) + ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: true}) + ds = &tests.MockDataStore{} + + // Setup plugin scrobbler + pluginScr = &fakeScrobbler{Authorized: true} + mockPlugin = &mockPluginLoader{ + names: []string{"plugin1"}, + scrobblers: map[string]Scrobbler{"plugin1": pluginScr}, + } + + // Create a tracker with the mock plugin loader + pTracker = newPlayTracker(ds, events.GetBroker(), mockPlugin) + + // Create a mock buffered scrobbler and explicitly cast it to Scrobbler + mockedBS = &mockBufferedScrobbler{ + wrapped: pluginScr, + } + // Make sure the instance is added with its concrete type preserved + pTracker.pluginScrobblers["plugin1"] = mockedBS + }) + + It("calls Stop on scrobblers when removing them", func() { + // Change the plugin names to simulate a plugin being removed + mockPlugin.SetNames([]string{}) + + // Call refreshPluginScrobblers which should detect the removed plugin + pTracker.refreshPluginScrobblers() + + // Verify the Stop method was called + Expect(mockedBS.stopCalled).To(BeTrue()) + + // Verify the scrobbler was removed from the map + Expect(pTracker.pluginScrobblers).NotTo(HaveKey("plugin1")) + }) + }) + + Describe("Plugin reload (config update) behavior", func() { + var mockPlugin *mockPluginLoader + var pTracker *playTracker + var originalScrobbler *fakeScrobbler + var reloadedScrobbler *fakeScrobbler + + BeforeEach(func() { + ctx = GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "u-1"}) + ctx = request.WithPlayer(ctx, model.Player{ScrobbleEnabled: true}) + ds = &tests.MockDataStore{} + + // Setup initial plugin scrobbler + originalScrobbler = &fakeScrobbler{Authorized: true} + reloadedScrobbler = &fakeScrobbler{Authorized: true} + + mockPlugin = &mockPluginLoader{ + names: []string{"plugin1"}, + scrobblers: map[string]Scrobbler{"plugin1": originalScrobbler}, + } + + // Create tracker - this will create buffered scrobblers with loaders + pTracker = newPlayTracker(ds, events.GetBroker(), mockPlugin) + + // Trigger initial plugin registration + pTracker.refreshPluginScrobblers() + }) + + AfterEach(func() { + pTracker.stopBackgroundWorkers() + }) + + It("uses the new plugin instance after reload (simulating config update)", func() { + // First call should use the original scrobbler + scrobblers := pTracker.getActiveScrobblers() + pluginScr := scrobblers["plugin1"] + Expect(pluginScr).ToNot(BeNil()) + + err := pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeTrue()) + Expect(reloadedScrobbler.GetNowPlayingCalled()).To(BeFalse()) + + // Simulate plugin reload (config update): replace the scrobbler in the loader + // This is what happens when UpdatePluginConfig is called - the plugin manager + // unloads the old plugin and loads a new instance + mockPlugin.mu.Lock() + mockPlugin.scrobblers["plugin1"] = reloadedScrobbler + mockPlugin.mu.Unlock() + + // Reset call tracking + originalScrobbler.nowPlayingCalled.Store(false) + + // Get scrobblers again - should still return the same buffered scrobbler + // but subsequent calls should use the new plugin instance via the loader + scrobblers = pTracker.getActiveScrobblers() + pluginScr = scrobblers["plugin1"] + + err = pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + + // The new scrobbler should be called, not the old one + Expect(reloadedScrobbler.GetNowPlayingCalled()).To(BeTrue()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeFalse()) + }) + + It("handles plugin becoming unavailable temporarily", func() { + // First verify plugin works + scrobblers := pTracker.getActiveScrobblers() + pluginScr := scrobblers["plugin1"] + + err := pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeTrue()) + + // Simulate plugin becoming unavailable (e.g., during reload) + mockPlugin.mu.Lock() + delete(mockPlugin.scrobblers, "plugin1") + mockPlugin.mu.Unlock() + + originalScrobbler.nowPlayingCalled.Store(false) + + // NowPlaying should return error when plugin unavailable + err = pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).To(HaveOccurred()) + Expect(originalScrobbler.GetNowPlayingCalled()).To(BeFalse()) + + // Simulate plugin becoming available again + mockPlugin.mu.Lock() + mockPlugin.scrobblers["plugin1"] = reloadedScrobbler + mockPlugin.mu.Unlock() + + // Should work again with new instance + err = pluginScr.NowPlaying(ctx, "u-1", &track, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(reloadedScrobbler.GetNowPlayingCalled()).To(BeTrue()) + }) + + It("IsAuthorized uses the current plugin instance", func() { + scrobblers := pTracker.getActiveScrobblers() + pluginScr := scrobblers["plugin1"] + + // Original is authorized + Expect(pluginScr.IsAuthorized(ctx, "u-1")).To(BeTrue()) + + // Replace with unauthorized scrobbler + unauthorizedScrobbler := &fakeScrobbler{Authorized: false} + mockPlugin.mu.Lock() + mockPlugin.scrobblers["plugin1"] = unauthorizedScrobbler + mockPlugin.mu.Unlock() + + // Should reflect the new scrobbler's authorization status + Expect(pluginScr.IsAuthorized(ctx, "u-1")).To(BeFalse()) + }) + }) }) +var _ = DescribeTable("remainingTTL", + func(durationSec float32, positionMs int64, rate float64, expected time.Duration) { + Expect(remainingTTL(durationSec, positionMs, rate)).To(Equal(expected)) + }, + Entry("full track at 1x", float32(300), int64(0), 1.0, 305*time.Second), + Entry("halfway through at 1x", float32(300), int64(150000), 1.0, 155*time.Second), + Entry("near end at 1x", float32(300), int64(298000), 1.0, 7*time.Second), + Entry("at end of track", float32(300), int64(300000), 1.0, 5*time.Second), + Entry("past end of track", float32(300), int64(310000), 1.0, 5*time.Second), + Entry("2x speed halves remaining time", float32(300), int64(0), 2.0, 155*time.Second), + Entry("2x speed halfway", float32(300), int64(150000), 2.0, 80*time.Second), + Entry("0.5x speed doubles remaining time", float32(300), int64(0), 0.5, 605*time.Second), + Entry("zero rate defaults to 1x", float32(300), int64(0), 0.0, 305*time.Second), + Entry("negative rate defaults to 1x", float32(300), int64(0), -1.0, 305*time.Second), + Entry("short track", float32(3.5), int64(0), 1.0, 8*time.Second), + Entry("zero duration", float32(0), int64(0), 1.0, 5*time.Second), +) + type fakeScrobbler struct { - Authorized bool - NowPlayingCalled bool - ScrobbleCalled bool - UserID string - Track *model.MediaFile - LastScrobble Scrobble - Error error + Authorized bool + nowPlayingCalled atomic.Bool + ScrobbleCalled atomic.Bool + PlaybackReportCalled atomic.Bool + userID atomic.Pointer[string] + username atomic.Pointer[string] + track atomic.Pointer[model.MediaFile] + position atomic.Int32 + LastScrobble atomic.Pointer[Scrobble] + LastPlaybackReport atomic.Pointer[PlaybackSession] + Error error +} + +func (f *fakeScrobbler) GetNowPlayingCalled() bool { + return f.nowPlayingCalled.Load() +} + +func (f *fakeScrobbler) GetUserID() string { + if p := f.userID.Load(); p != nil { + return *p + } + return "" +} + +func (f *fakeScrobbler) GetTrack() *model.MediaFile { + return f.track.Load() } func (f *fakeScrobbler) IsAuthorized(ctx context.Context, userId string) bool { return f.Error == nil && f.Authorized } -func (f *fakeScrobbler) NowPlaying(ctx context.Context, userId string, track *model.MediaFile) error { - f.NowPlayingCalled = true +func (f *fakeScrobbler) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { + f.nowPlayingCalled.Store(true) if f.Error != nil { return f.Error } - f.UserID = userId - f.Track = track + f.userID.Store(&userId) + // Capture username from context (this is what plugin scrobblers do) + username, _ := request.UsernameFrom(ctx) + if username == "" { + if u, ok := request.UserFrom(ctx); ok { + username = u.UserName + } + } + if username != "" { + f.username.Store(&username) + } + f.track.Store(track) + f.position.Store(int32(position)) return nil } func (f *fakeScrobbler) Scrobble(ctx context.Context, userId string, s Scrobble) error { - f.ScrobbleCalled = true + f.userID.Store(&userId) + f.LastScrobble.Store(&s) + f.ScrobbleCalled.Store(true) if f.Error != nil { return f.Error } - f.UserID = userId - f.LastScrobble = s + return nil +} + +func (f *fakeScrobbler) PlaybackReport(ctx context.Context, info PlaybackSession) error { + f.PlaybackReportCalled.Store(true) + if f.Error != nil { + return f.Error + } + f.userID.Store(new(info.UserId)) + f.LastPlaybackReport.Store(&info) return nil } @@ -243,3 +1147,55 @@ func _p(id, name string, sortName ...string) model.Participant { } return p } + +type fakeEventBroker struct { + http.Handler + events []events.Event + mu sync.Mutex +} + +func (f *fakeEventBroker) SendMessage(_ context.Context, event events.Event) { + f.mu.Lock() + defer f.mu.Unlock() + f.events = append(f.events, event) +} + +func (f *fakeEventBroker) SendBroadcastMessage(_ context.Context, event events.Event) { + f.mu.Lock() + defer f.mu.Unlock() + f.events = append(f.events, event) +} + +func (f *fakeEventBroker) getEvents() []events.Event { + f.mu.Lock() + defer f.mu.Unlock() + return f.events +} + +var _ events.Broker = (*fakeEventBroker)(nil) + +// mockBufferedScrobbler used to test that Stop is called +type mockBufferedScrobbler struct { + wrapped Scrobbler + stopCalled bool +} + +func (m *mockBufferedScrobbler) Stop() { + m.stopCalled = true +} + +func (m *mockBufferedScrobbler) IsAuthorized(ctx context.Context, userId string) bool { + return m.wrapped.IsAuthorized(ctx, userId) +} + +func (m *mockBufferedScrobbler) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { + return m.wrapped.NowPlaying(ctx, userId, track, position) +} + +func (m *mockBufferedScrobbler) Scrobble(ctx context.Context, userId string, s Scrobble) error { + return m.wrapped.Scrobble(ctx, userId, s) +} + +func (m *mockBufferedScrobbler) PlaybackReport(ctx context.Context, info PlaybackSession) error { + return m.wrapped.PlaybackReport(ctx, info) +} diff --git a/core/scrobbler/playbackreport_worker.go b/core/scrobbler/playbackreport_worker.go new file mode 100644 index 000000000..78ca6e0f7 --- /dev/null +++ b/core/scrobbler/playbackreport_worker.go @@ -0,0 +1,64 @@ +package scrobbler + +import ( + "context" + + "github.com/navidrome/navidrome/log" +) + +func (p *playTracker) enqueuePlaybackReport(ctx context.Context, info PlaybackSession) { + p.prMu.Lock() + defer p.prMu.Unlock() + ctx = context.WithoutCancel(ctx) + p.prQueue = append(p.prQueue, playbackReportEntry{ + ctx: ctx, + info: info, + }) + p.sendPlaybackReportSignal() +} + +func (p *playTracker) sendPlaybackReportSignal() { + select { + case p.prSignal <- struct{}{}: + default: + } +} + +func (p *playTracker) playbackReportWorker() { + defer close(p.prWorkerDone) + for { + select { + case <-p.shutdown: + return + case <-p.prSignal: + } + + p.prMu.Lock() + if len(p.prQueue) == 0 { + p.prMu.Unlock() + continue + } + entries := p.prQueue + p.prQueue = nil + p.prMu.Unlock() + + allScrobblers := p.getActiveScrobblers() + for _, entry := range entries { + p.dispatchPlaybackReport(entry.ctx, entry.info, allScrobblers) + } + } +} + +func (p *playTracker) dispatchPlaybackReport(ctx context.Context, info PlaybackSession, allScrobblers map[string]Scrobbler) { + for name, s := range allScrobblers { + if !s.IsAuthorized(ctx, info.UserId) { + continue + } + log.Debug(ctx, "Sending PlaybackReport", "scrobbler", name, "track", info.MediaFile.Title, "state", info.State, "positionMs", info.PositionMs) + err := s.PlaybackReport(ctx, info) + if err != nil { + log.Error(ctx, "Error sending PlaybackReport", "scrobbler", name, "track", info.MediaFile.Title, "state", info.State, err) + continue + } + } +} diff --git a/core/share.go b/core/share.go index add88322d..5a611c7f0 100644 --- a/core/share.go +++ b/core/share.go @@ -7,12 +7,13 @@ import ( "github.com/Masterminds/squirrel" "github.com/deluan/rest" - gonanoid "github.com/matoous/go-nanoid/v2" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" . "github.com/navidrome/navidrome/utils/gg" + "github.com/navidrome/navidrome/utils/nanoid" "github.com/navidrome/navidrome/utils/slice" + "github.com/navidrome/navidrome/utils/str" ) type Share interface { @@ -40,7 +41,7 @@ func (s *shareService) Load(ctx context.Context, id string) (*model.Share, error if !expiresAt.IsZero() && expiresAt.Before(time.Now()) { return nil, model.ErrExpired } - share.LastVisitedAt = P(time.Now()) + share.LastVisitedAt = new(time.Now()) share.VisitCount++ err = repo.(rest.Persistable).Update(id, share, "last_visited_at", "visit_count") @@ -72,7 +73,7 @@ type shareRepositoryWrapper struct { func (r *shareRepositoryWrapper) newId() (string, error) { for { - id, err := gonanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 10) + id, err := nanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 10) if err != nil { return "", err } @@ -86,7 +87,7 @@ func (r *shareRepositoryWrapper) newId() (string, error) { } } -func (r *shareRepositoryWrapper) Save(entity interface{}) (string, error) { +func (r *shareRepositoryWrapper) Save(entity any) (string, error) { s := entity.(*model.Share) id, err := r.newId() if err != nil { @@ -94,10 +95,10 @@ func (r *shareRepositoryWrapper) Save(entity interface{}) (string, error) { } s.ID = id if V(s.ExpiresAt).IsZero() { - s.ExpiresAt = P(time.Now().Add(conf.Server.DefaultShareExpiration)) + s.ExpiresAt = new(time.Now().Add(conf.Server.DefaultShareExpiration)) } - firstId := strings.SplitN(s.ResourceIDs, ",", 2)[0] + firstId, _, _ := strings.Cut(s.ResourceIDs, ",") v, err := model.GetEntityByID(r.ctx, r.ds, firstId) if err != nil { return "", err @@ -119,15 +120,14 @@ func (r *shareRepositoryWrapper) Save(entity interface{}) (string, error) { log.Error(r.ctx, "Invalid Resource ID", "id", firstId) return "", model.ErrNotFound } - if len(s.Contents) > 30 { - s.Contents = s.Contents[:26] + "..." - } + + s.Contents = str.TruncateRunes(s.Contents, 30, "...") id, err = r.Persistable.Save(s) return id, err } -func (r *shareRepositoryWrapper) Update(id string, entity interface{}, _ ...string) error { +func (r *shareRepositoryWrapper) Update(id string, entity any, _ ...string) error { cols := []string{"description", "downloadable"} // TODO Better handling of Share expiration @@ -149,7 +149,7 @@ func (r *shareRepositoryWrapper) contentsLabelFromArtist(shareID string, ids str func (r *shareRepositoryWrapper) contentsLabelFromAlbums(shareID string, ids string) string { idList := strings.Split(ids, ",") - all, err := r.ds.Album(r.ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"id": idList}}) + all, err := r.ds.Album(r.ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"album.id": idList}}) if err != nil { log.Error(r.ctx, "Error retrieving album names for share", "share", shareID, err) return "" diff --git a/core/share_test.go b/core/share_test.go index 21069bb59..475d40ec9 100644 --- a/core/share_test.go +++ b/core/share_test.go @@ -38,6 +38,38 @@ var _ = Describe("Share", func() { Expect(id).ToNot(BeEmpty()) Expect(entity.ID).To(Equal(id)) }) + + It("does not truncate ASCII labels shorter than 30 characters", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "456", Title: "Example Media File"}) + entity := &model.Share{Description: "test", ResourceIDs: "456"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("Example Media File")) + }) + + It("truncates ASCII labels longer than 30 characters", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "789", Title: "Example Media File But The Title Is Really Long For Testing Purposes"}) + entity := &model.Share{Description: "test", ResourceIDs: "789"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("Example Media File But The ...")) + }) + + It("does not truncate CJK labels shorter than 30 runes", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "456", Title: "青春コンプレックス"}) + entity := &model.Share{Description: "test", ResourceIDs: "456"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("青春コンプレックス")) + }) + + It("truncates CJK labels longer than 30 runes", func() { + _ = ds.MediaFile(ctx).Put(&model.MediaFile{ID: "789", Title: "私の中の幻想的世界観及びその顕現を想起させたある現実での出来事に関する一考察"}) + entity := &model.Share{Description: "test", ResourceIDs: "789"} + _, err := repo.Save(entity) + Expect(err).ToNot(HaveOccurred()) + Expect(entity.Contents).To(Equal("私の中の幻想的世界観及びその顕現を想起させたある現実で...")) + }) }) Describe("Update", func() { diff --git a/core/sonic/sonic.go b/core/sonic/sonic.go new file mode 100644 index 000000000..19eb69c65 --- /dev/null +++ b/core/sonic/sonic.go @@ -0,0 +1,130 @@ +package sonic + +import ( + "context" + "fmt" + + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/matcher" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +const capabilitySonicSimilarity = "SonicSimilarity" + +type SimilarResult struct { + Song agents.Song + Similarity float64 +} + +type SimilarMatch struct { + MediaFile model.MediaFile + Similarity float64 +} + +type Provider interface { + GetSonicSimilarTracks(ctx context.Context, mf *model.MediaFile, count int) ([]SimilarResult, error) + FindSonicPath(ctx context.Context, startMF, endMF *model.MediaFile, count int) ([]SimilarResult, error) +} + +type PluginLoader interface { + PluginNames(capability string) []string + LoadSonicSimilarity(name string) (Provider, bool) +} + +type Sonic struct { + ds model.DataStore + pluginLoader PluginLoader + matcher *matcher.Matcher +} + +func New(ds model.DataStore, pluginLoader PluginLoader, matcher *matcher.Matcher) *Sonic { + return &Sonic{ + ds: ds, + pluginLoader: pluginLoader, + matcher: matcher, + } +} + +func (s *Sonic) HasProvider() bool { + return len(s.pluginLoader.PluginNames(capabilitySonicSimilarity)) > 0 +} + +func (s *Sonic) loadProvider() (Provider, error) { + names := s.pluginLoader.PluginNames(capabilitySonicSimilarity) + if len(names) == 0 { + return nil, model.ErrNotFound + } + provider, ok := s.pluginLoader.LoadSonicSimilarity(names[0]) + if !ok { + return nil, model.ErrNotFound + } + return provider, nil +} + +func (s *Sonic) resolveMatches(ctx context.Context, results []SimilarResult) ([]SimilarMatch, error) { + songs := make([]agents.Song, len(results)) + for i, r := range results { + songs[i] = r.Song + } + + matchMap, err := s.matcher.MatchSongsIndexed(ctx, songs) + if err != nil { + return nil, fmt.Errorf("matching songs to library: %w", err) + } + + var matches []SimilarMatch + for i, r := range results { + if mf, ok := matchMap[i]; ok { + matches = append(matches, SimilarMatch{ + MediaFile: mf, + Similarity: r.Similarity, + }) + } + } + return matches, nil +} + +func (s *Sonic) GetSonicSimilarTracks(ctx context.Context, id string, count int) ([]SimilarMatch, error) { + provider, err := s.loadProvider() + if err != nil { + return nil, err + } + + mf, err := s.ds.MediaFile(ctx).Get(id) + if err != nil { + return nil, fmt.Errorf("getting media file %s: %w", id, err) + } + + results, err := provider.GetSonicSimilarTracks(ctx, mf, count) + if err != nil { + log.Error(ctx, "Plugin GetSonicSimilarTracks failed", "id", id, err) + return nil, err + } + + return s.resolveMatches(ctx, results) +} + +func (s *Sonic) FindSonicPath(ctx context.Context, startID, endID string, count int) ([]SimilarMatch, error) { + provider, err := s.loadProvider() + if err != nil { + return nil, err + } + + startMF, err := s.ds.MediaFile(ctx).Get(startID) + if err != nil { + return nil, fmt.Errorf("getting start media file %s: %w", startID, err) + } + endMF, err := s.ds.MediaFile(ctx).Get(endID) + if err != nil { + return nil, fmt.Errorf("getting end media file %s: %w", endID, err) + } + + results, err := provider.FindSonicPath(ctx, startMF, endMF, count) + if err != nil { + log.Error(ctx, "Plugin FindSonicPath failed", "startId", startID, "endId", endID, err) + return nil, err + } + + return s.resolveMatches(ctx, results) +} diff --git a/core/sonic/sonic_suite_test.go b/core/sonic/sonic_suite_test.go new file mode 100644 index 000000000..7058e5de9 --- /dev/null +++ b/core/sonic/sonic_suite_test.go @@ -0,0 +1,17 @@ +package sonic_test + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestSonic(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Sonic Suite") +} diff --git a/core/sonic/sonic_test.go b/core/sonic/sonic_test.go new file mode 100644 index 000000000..81739b726 --- /dev/null +++ b/core/sonic/sonic_test.go @@ -0,0 +1,146 @@ +package sonic_test + +import ( + "context" + "errors" + + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/matcher" + "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +type mockPluginLoader struct { + names []string + provider sonic.Provider + loadOk bool +} + +func (m *mockPluginLoader) PluginNames(capability string) []string { + if capability == "SonicSimilarity" { + return m.names + } + return nil +} + +func (m *mockPluginLoader) LoadSonicSimilarity(name string) (sonic.Provider, bool) { + return m.provider, m.loadOk +} + +type mockProvider struct { + similarResults []sonic.SimilarResult + similarErr error + pathResults []sonic.SimilarResult + pathErr error +} + +func (m *mockProvider) GetSonicSimilarTracks(_ context.Context, _ *model.MediaFile, _ int) ([]sonic.SimilarResult, error) { + return m.similarResults, m.similarErr +} + +func (m *mockProvider) FindSonicPath(_ context.Context, _, _ *model.MediaFile, _ int) ([]sonic.SimilarResult, error) { + return m.pathResults, m.pathErr +} + +var _ = Describe("Sonic", func() { + var ( + ctx context.Context + ds *tests.MockDataStore + loader *mockPluginLoader + service *sonic.Sonic + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{} + loader = &mockPluginLoader{} + }) + + Describe("HasProvider", func() { + It("returns false when no plugins available", func() { + loader.names = nil + service = sonic.New(ds, loader, nil) + Expect(service.HasProvider()).To(BeFalse()) + }) + + It("returns true when a plugin is available", func() { + loader.names = []string{"test-plugin"} + service = sonic.New(ds, loader, nil) + Expect(service.HasProvider()).To(BeTrue()) + }) + }) + + Describe("GetSonicSimilarTracks", func() { + It("returns error when no plugin available", func() { + loader.names = nil + service = sonic.New(ds, loader, nil) + _, err := service.GetSonicSimilarTracks(ctx, "song-1", 10) + Expect(err).To(MatchError(model.ErrNotFound)) + }) + + It("returns error when media file not found", func() { + loader.names = []string{"test-plugin"} + loader.provider = &mockProvider{} + loader.loadOk = true + ds.MockedMediaFile = &tests.MockMediaFileRepo{} + service = sonic.New(ds, loader, matcher.New(ds)) + _, err := service.GetSonicSimilarTracks(ctx, "nonexistent", 10) + Expect(err).To(HaveOccurred()) + }) + + It("returns matched results from plugin", func() { + mf1 := model.MediaFile{ID: "song-1", Title: "Test Song", Artist: "Test Artist"} + mf2 := model.MediaFile{ID: "song-2", Title: "Similar Song", Artist: "Test Artist"} + + mockRepo := tests.CreateMockMediaFileRepo() + mockRepo.SetData(model.MediaFiles{mf1, mf2}) + ds.MockedMediaFile = mockRepo + + provider := &mockProvider{ + similarResults: []sonic.SimilarResult{ + {Song: agents.Song{ID: "song-2", Name: "Similar Song", Artist: "Test Artist"}, Similarity: 0.85}, + }, + } + loader.names = []string{"test-plugin"} + loader.provider = provider + loader.loadOk = true + + service = sonic.New(ds, loader, matcher.New(ds)) + matches, err := service.GetSonicSimilarTracks(ctx, "song-1", 10) + Expect(err).ToNot(HaveOccurred()) + Expect(matches).To(HaveLen(1)) + Expect(matches[0].MediaFile.ID).To(Equal("song-2")) + Expect(matches[0].Similarity).To(Equal(0.85)) + }) + }) + + Describe("FindSonicPath", func() { + It("returns error when no plugin available", func() { + loader.names = nil + service = sonic.New(ds, loader, nil) + _, err := service.FindSonicPath(ctx, "song-1", "song-2", 25) + Expect(err).To(MatchError(model.ErrNotFound)) + }) + + It("returns error when plugin call fails", func() { + mf1 := model.MediaFile{ID: "song-1", Title: "Start", Artist: "Artist"} + mf2 := model.MediaFile{ID: "song-2", Title: "End", Artist: "Artist"} + + mockRepo := tests.CreateMockMediaFileRepo() + mockRepo.SetData(model.MediaFiles{mf1, mf2}) + ds.MockedMediaFile = mockRepo + + provider := &mockProvider{pathErr: errors.New("plugin error")} + loader.names = []string{"test-plugin"} + loader.provider = provider + loader.loadOk = true + + service = sonic.New(ds, loader, matcher.New(ds)) + _, err := service.FindSonicPath(ctx, "song-1", "song-2", 25) + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/core/storage/local/local.go b/core/storage/local/local.go index 5c335ddb9..5384581e0 100644 --- a/core/storage/local/local.go +++ b/core/storage/local/local.go @@ -11,6 +11,7 @@ import ( "github.com/djherbis/times" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/core/storage" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model/metadata" @@ -28,7 +29,13 @@ type localStorage struct { func newLocalStorage(u url.URL) storage.Storage { newExtractor, ok := extractors[conf.Server.Scanner.Extractor] if !ok || newExtractor == nil { - log.Fatal("Extractor not found", "path", conf.Server.Scanner.Extractor) + if conf.Server.Scanner.Extractor != consts.DefaultScannerExtractor { + log.Warn("Extractor not found, using default", "extractor", conf.Server.Scanner.Extractor, "default", consts.DefaultScannerExtractor) + } + newExtractor = extractors[consts.DefaultScannerExtractor] + if newExtractor == nil { + log.Fatal("Default extractor not registered", "extractor", consts.DefaultScannerExtractor) + } } isWindowsPath := filepath.VolumeName(u.Host) != "" if u.Scheme == storage.LocalSchemaID && isWindowsPath { @@ -44,7 +51,7 @@ func newLocalStorage(u url.URL) storage.Storage { func (s *localStorage) FS() (storage.MusicFS, error) { path := s.u.Path - if _, err := os.Stat(path); err != nil { + if _, err := os.Stat(path); err != nil { //nolint:gosec return nil, fmt.Errorf("%w: %s", err, path) } return &localFS{FS: os.DirFS(path), extractor: s.extractor}, nil diff --git a/core/storage/local/local_suite_test.go b/core/storage/local/local_suite_test.go index 98dfcbd4b..5934cde5d 100644 --- a/core/storage/local/local_suite_test.go +++ b/core/storage/local/local_suite_test.go @@ -3,11 +3,15 @@ package local import ( "testing" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) func TestLocal(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) RegisterFailHandler(Fail) - RunSpecs(t, "Local Storage Test Suite") + RunSpecs(t, "Local Storage Suite") } diff --git a/core/storage/local/local_test.go b/core/storage/local/local_test.go new file mode 100644 index 000000000..aef89cdd5 --- /dev/null +++ b/core/storage/local/local_test.go @@ -0,0 +1,455 @@ +package local + +import ( + "io/fs" + "net/url" + "os" + "path/filepath" + "runtime" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/storage" + "github.com/navidrome/navidrome/model/metadata" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("LocalStorage", func() { + var tempDir string + var testExtractor *mockTestExtractor + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + + // Create a temporary directory for testing + var err error + tempDir, err = os.MkdirTemp("", "navidrome-local-storage-test-") + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + os.RemoveAll(tempDir) + }) + + // Create and register a test extractor + testExtractor = &mockTestExtractor{ + results: make(map[string]metadata.Info), + } + RegisterExtractor("test", func(fs.FS, string) Extractor { + return testExtractor + }) + conf.Server.Scanner.Extractor = "test" + }) + + Describe("newLocalStorage", func() { + BeforeEach(func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-storage-local)") + }) + + Context("with valid path", func() { + It("should create a localStorage instance with correct path", func() { + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + + storage := newLocalStorage(*u) + localStorage := storage.(*localStorage) + + Expect(localStorage.u.Scheme).To(Equal("file")) + // Check that the path is set correctly (could be resolved to real path on macOS) + Expect(localStorage.u.Path).To(ContainSubstring("navidrome-local-storage-test")) + Expect(localStorage.resolvedPath).To(ContainSubstring("navidrome-local-storage-test")) + Expect(localStorage.extractor).ToNot(BeNil()) + }) + + It("should handle URL-decoded paths correctly", func() { + // Create a directory with spaces to test URL decoding + spacedDir := filepath.Join(tempDir, "test folder") + err := os.MkdirAll(spacedDir, 0755) + Expect(err).ToNot(HaveOccurred()) + + // Use proper URL construction instead of manual escaping + u := &url.URL{ + Scheme: "file", + Path: spacedDir, + } + + storage := newLocalStorage(*u) + localStorage, ok := storage.(*localStorage) + Expect(ok).To(BeTrue()) + + Expect(localStorage.u.Path).To(Equal(spacedDir)) + }) + + It("should resolve symlinks when possible", func() { + // Create a real directory and a symlink to it + realDir := filepath.Join(tempDir, "real") + linkDir := filepath.Join(tempDir, "link") + + err := os.MkdirAll(realDir, 0755) + Expect(err).ToNot(HaveOccurred()) + + err = os.Symlink(realDir, linkDir) + Expect(err).ToNot(HaveOccurred()) + + u, err := url.Parse("file://" + linkDir) + Expect(err).ToNot(HaveOccurred()) + + storage := newLocalStorage(*u) + localStorage, ok := storage.(*localStorage) + Expect(ok).To(BeTrue()) + + Expect(localStorage.u.Path).To(Equal(linkDir)) + // Check that the resolved path contains the real directory name + Expect(localStorage.resolvedPath).To(ContainSubstring("real")) + }) + + It("should use u.Path as resolvedPath when symlink resolution fails", func() { + // Use a non-existent path to trigger symlink resolution failure + nonExistentPath := filepath.Join(tempDir, "non-existent") + + u, err := url.Parse("file://" + nonExistentPath) + Expect(err).ToNot(HaveOccurred()) + + storage := newLocalStorage(*u) + localStorage, ok := storage.(*localStorage) + Expect(ok).To(BeTrue()) + + Expect(localStorage.u.Path).To(Equal(nonExistentPath)) + Expect(localStorage.resolvedPath).To(Equal(nonExistentPath)) + }) + }) + + Context("with Windows path", func() { + BeforeEach(func() { + if runtime.GOOS != "windows" { + Skip("Windows-specific test") + } + }) + + It("should handle Windows drive letters correctly", func() { + u, err := url.Parse("file://C:/music") + Expect(err).ToNot(HaveOccurred()) + + storage := newLocalStorage(*u) + localStorage, ok := storage.(*localStorage) + Expect(ok).To(BeTrue()) + + Expect(localStorage.u.Path).To(Equal("C:/music")) + }) + }) + + Context("when the configured extractor is not registered", func() { + var defaultExtractor *mockTestExtractor + + BeforeEach(func() { + defaultExtractor = &mockTestExtractor{results: make(map[string]metadata.Info)} + RegisterExtractor(consts.DefaultScannerExtractor, func(fs.FS, string) Extractor { + return defaultExtractor + }) + DeferCleanup(func() { + lock.Lock() + delete(extractors, consts.DefaultScannerExtractor) + lock.Unlock() + }) + }) + + It("falls back to the default extractor instead of crashing", func() { + conf.Server.Scanner.Extractor = "nonexistent-extractor" + + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + + storage := newLocalStorage(*u) + ls, ok := storage.(*localStorage) + Expect(ok).To(BeTrue()) + Expect(ls.extractor).To(BeIdenticalTo(defaultExtractor)) + }) + }) + }) + + Describe("localStorage.FS", func() { + BeforeEach(func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-storage-local)") + }) + + Context("with existing directory", func() { + It("should return a localFS instance", func() { + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + + storage := newLocalStorage(*u) + musicFS, err := storage.FS() + Expect(err).ToNot(HaveOccurred()) + Expect(musicFS).ToNot(BeNil()) + + _, ok := musicFS.(*localFS) + Expect(ok).To(BeTrue()) + }) + }) + + Context("with non-existent directory", func() { + It("should return an error", func() { + nonExistentPath := filepath.Join(tempDir, "non-existent") + u, err := url.Parse("file://" + nonExistentPath) + Expect(err).ToNot(HaveOccurred()) + + storage := newLocalStorage(*u) + _, err = storage.FS() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring(nonExistentPath)) + }) + }) + }) + + Describe("localFS.ReadTags", func() { + var testFile string + + BeforeEach(func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-storage-local)") + // Create a test file + testFile = filepath.Join(tempDir, "test.mp3") + err := os.WriteFile(testFile, []byte("test data"), 0600) + Expect(err).ToNot(HaveOccurred()) + + // Reset extractor state + testExtractor.results = make(map[string]metadata.Info) + testExtractor.err = nil + }) + + Context("when extractor returns complete metadata", func() { + It("should return the metadata as-is", func() { + expectedInfo := metadata.Info{ + Tags: map[string][]string{ + "title": {"Test Song"}, + "artist": {"Test Artist"}, + }, + AudioProperties: metadata.AudioProperties{ + Duration: 180, + BitRate: 320, + }, + FileInfo: &testFileInfo{name: "test.mp3"}, + } + + testExtractor.results["test.mp3"] = expectedInfo + + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + storage := newLocalStorage(*u) + musicFS, err := storage.FS() + Expect(err).ToNot(HaveOccurred()) + + results, err := musicFS.ReadTags("test.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveKey("test.mp3")) + Expect(results["test.mp3"]).To(Equal(expectedInfo)) + }) + }) + + Context("when extractor returns metadata without FileInfo", func() { + It("should populate FileInfo from filesystem", func() { + incompleteInfo := metadata.Info{ + Tags: map[string][]string{ + "title": {"Test Song"}, + }, + FileInfo: nil, // Missing FileInfo + } + + testExtractor.results["test.mp3"] = incompleteInfo + + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + storage := newLocalStorage(*u) + musicFS, err := storage.FS() + Expect(err).ToNot(HaveOccurred()) + + results, err := musicFS.ReadTags("test.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveKey("test.mp3")) + + result := results["test.mp3"] + Expect(result.FileInfo).ToNot(BeNil()) + Expect(result.FileInfo.Name()).To(Equal("test.mp3")) + + // Should be wrapped in localFileInfo + _, ok := result.FileInfo.(localFileInfo) + Expect(ok).To(BeTrue()) + }) + }) + + Context("when filesystem stat fails", func() { + It("should return an error", func() { + incompleteInfo := metadata.Info{ + Tags: map[string][]string{"title": {"Test Song"}}, + FileInfo: nil, + } + + testExtractor.results["non-existent.mp3"] = incompleteInfo + + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + storage := newLocalStorage(*u) + musicFS, err := storage.FS() + Expect(err).ToNot(HaveOccurred()) + + _, err = musicFS.ReadTags("non-existent.mp3") + Expect(err).To(HaveOccurred()) + }) + }) + + Context("when extractor fails", func() { + It("should return the extractor error", func() { + testExtractor.err = &extractorError{message: "extractor failed"} + + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + storage := newLocalStorage(*u) + musicFS, err := storage.FS() + Expect(err).ToNot(HaveOccurred()) + + _, err = musicFS.ReadTags("test.mp3") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("extractor failed")) + }) + }) + + Context("with multiple files", func() { + It("should process all files correctly", func() { + // Create another test file + testFile2 := filepath.Join(tempDir, "test2.mp3") + err := os.WriteFile(testFile2, []byte("test data 2"), 0600) + Expect(err).ToNot(HaveOccurred()) + + info1 := metadata.Info{ + Tags: map[string][]string{"title": {"Song 1"}}, + FileInfo: &testFileInfo{name: "test.mp3"}, + } + info2 := metadata.Info{ + Tags: map[string][]string{"title": {"Song 2"}}, + FileInfo: nil, // This one needs FileInfo populated + } + + testExtractor.results["test.mp3"] = info1 + testExtractor.results["test2.mp3"] = info2 + + u, err := url.Parse("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + storage := newLocalStorage(*u) + musicFS, err := storage.FS() + Expect(err).ToNot(HaveOccurred()) + + results, err := musicFS.ReadTags("test.mp3", "test2.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + + Expect(results["test.mp3"].FileInfo).To(Equal(&testFileInfo{name: "test.mp3"})) + Expect(results["test2.mp3"].FileInfo).ToNot(BeNil()) + Expect(results["test2.mp3"].FileInfo.Name()).To(Equal("test2.mp3")) + }) + }) + }) + + Describe("localFileInfo", func() { + var testFile string + var fileInfo fs.FileInfo + + BeforeEach(func() { + testFile = filepath.Join(tempDir, "test.mp3") + err := os.WriteFile(testFile, []byte("test data"), 0600) + Expect(err).ToNot(HaveOccurred()) + + fileInfo, err = os.Stat(testFile) + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("BirthTime", func() { + It("should return birth time when available", func() { + lfi := localFileInfo{FileInfo: fileInfo} + birthTime := lfi.BirthTime() + + // Birth time should be a valid time (not zero value) + Expect(birthTime).ToNot(BeZero()) + // Should be around the current time (within last few minutes) + Expect(birthTime).To(BeTemporally("~", time.Now(), 5*time.Minute)) + }) + }) + + It("should delegate all other FileInfo methods", func() { + lfi := localFileInfo{FileInfo: fileInfo} + + Expect(lfi.Name()).To(Equal(fileInfo.Name())) + Expect(lfi.Size()).To(Equal(fileInfo.Size())) + Expect(lfi.Mode()).To(Equal(fileInfo.Mode())) + Expect(lfi.ModTime()).To(Equal(fileInfo.ModTime())) + Expect(lfi.IsDir()).To(Equal(fileInfo.IsDir())) + Expect(lfi.Sys()).To(Equal(fileInfo.Sys())) + }) + }) + + Describe("Storage registration", func() { + It("should register localStorage for file scheme", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-storage-local)") + // This tests the init() function indirectly + storage, err := storage.For("file://" + tempDir) + Expect(err).ToNot(HaveOccurred()) + Expect(storage).To(BeAssignableToTypeOf(&localStorage{})) + }) + }) +}) + +// Test extractor for testing +type mockTestExtractor struct { + results map[string]metadata.Info + err error +} + +func (m *mockTestExtractor) Parse(files ...string) (map[string]metadata.Info, error) { + if m.err != nil { + return nil, m.err + } + + result := make(map[string]metadata.Info) + for _, file := range files { + if info, exists := m.results[file]; exists { + result[file] = info + } + } + return result, nil +} + +func (m *mockTestExtractor) Version() string { + return "test-1.0" +} + +type extractorError struct { + message string +} + +func (e *extractorError) Error() string { + return e.message +} + +// Test FileInfo that implements metadata.FileInfo +type testFileInfo struct { + name string + size int64 + mode fs.FileMode + modTime time.Time + isDir bool + birthTime time.Time +} + +func (t *testFileInfo) Name() string { return t.name } +func (t *testFileInfo) Size() int64 { return t.size } +func (t *testFileInfo) Mode() fs.FileMode { return t.mode } +func (t *testFileInfo) ModTime() time.Time { return t.modTime } +func (t *testFileInfo) IsDir() bool { return t.isDir } +func (t *testFileInfo) Sys() any { return nil } +func (t *testFileInfo) BirthTime() time.Time { + if t.birthTime.IsZero() { + return time.Now() + } + return t.birthTime +} diff --git a/core/storage/local/watcher.go b/core/storage/local/watcher.go index e2418f4cb..1b8a4e0c8 100644 --- a/core/storage/local/watcher.go +++ b/core/storage/local/watcher.go @@ -17,8 +17,8 @@ func (s *localStorage) Start(ctx context.Context) (<-chan string, error) { if !s.watching.CompareAndSwap(false, true) { return nil, errors.New("watcher already started") } - input := make(chan notify.EventInfo, 1) - output := make(chan string, 1) + input := make(chan notify.EventInfo, 500) + output := make(chan string, 500) started := make(chan struct{}) go func() { diff --git a/core/storage/storage.go b/core/storage/storage.go index 84bcae0d6..b9fceb1fd 100644 --- a/core/storage/storage.go +++ b/core/storage/storage.go @@ -6,6 +6,8 @@ import ( "path/filepath" "strings" "sync" + + "github.com/navidrome/navidrome/utils/slice" ) const LocalSchemaID = "file" @@ -36,7 +38,14 @@ func For(uri string) (Storage, error) { if len(parts) < 2 { uri, _ = filepath.Abs(uri) uri = filepath.ToSlash(uri) - uri = LocalSchemaID + "://" + uri + + // Properly escape each path component using URL standards + pathParts := strings.Split(uri, "/") + escapedParts := slice.Map(pathParts, func(s string) string { + return url.PathEscape(s) + }) + + uri = LocalSchemaID + "://" + strings.Join(escapedParts, "/") } u, err := url.Parse(uri) diff --git a/core/storage/storage_test.go b/core/storage/storage_test.go index c74c7c6ed..32fbac413 100644 --- a/core/storage/storage_test.go +++ b/core/storage/storage_test.go @@ -6,6 +6,7 @@ import ( "path/filepath" "testing" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -54,6 +55,7 @@ var _ = Describe("Storage", func() { Expect(s.(*fakeLocalStorage).u.Path).To(Equal("/tmp")) }) It("should return a file implementation for a relative folder", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-storage)") s, err := For("tmp") Expect(err).ToNot(HaveOccurred()) cwd, _ := os.Getwd() @@ -65,6 +67,21 @@ var _ = Describe("Storage", func() { _, err := For("webdav:///tmp") Expect(err).To(HaveOccurred()) }) + DescribeTable("should handle paths with special characters correctly", + func(inputPath string) { + s, err := For(inputPath) + Expect(err).ToNot(HaveOccurred()) + Expect(s).To(BeAssignableToTypeOf(&fakeLocalStorage{})) + Expect(s.(*fakeLocalStorage).u.Scheme).To(Equal("file")) + // The path should be exactly the same as the input - after URL parsing it gets decoded back + Expect(s.(*fakeLocalStorage).u.Path).To(Equal(inputPath)) + }, + Entry("hash symbols", "/tmp/test#folder/file.mp3"), + Entry("spaces", "/tmp/test folder/file with spaces.mp3"), + Entry("question marks", "/tmp/test?query/file.mp3"), + Entry("ampersands", "/tmp/test&/file.mp3"), + Entry("multiple special chars", "/tmp/Song #1 & More?.mp3"), + ) }) }) diff --git a/core/storage/storagetest/fake_storage.go b/core/storage/storagetest/fake_storage.go index 009b37d2d..1b0d1a6c1 100644 --- a/core/storage/storagetest/fake_storage.go +++ b/core/storage/storagetest/fake_storage.go @@ -6,6 +6,7 @@ import ( "errors" "fmt" "io/fs" + "maps" "net/url" "path" "testing/fstest" @@ -135,9 +136,7 @@ func (ffs *FakeFS) UpdateTags(filePath string, newTags map[string]any, when ...t if err != nil { panic(err) } - for k, v := range newTags { - tags[k] = v - } + maps.Copy(tags, newTags) data, _ := json.Marshal(tags) f.Data = data ffs.Touch(filePath, when...) @@ -180,9 +179,7 @@ func Track(num int, title string, tags ...map[string]any) map[string]any { ts["title"] = title ts["track"] = num for _, t := range tags { - for k, v := range t { - ts[k] = v - } + maps.Copy(ts, t) } return ts } @@ -200,9 +197,7 @@ func MP3(tags ...map[string]any) *fstest.MapFile { func File(tags ...map[string]any) *fstest.MapFile { ts := map[string]any{} for _, t := range tags { - for k, v := range t { - ts[k] = v - } + maps.Copy(ts, t) } modTime := time.Now() if mt, ok := ts[fakeFileInfoModTime]; !ok { @@ -289,6 +284,9 @@ func (ffs *FakeFS) parseFile(filePath string) (*metadata.Info, error) { p.AudioProperties.BitDepth = getInt("bitdepth") p.AudioProperties.SampleRate = getInt("samplerate") p.AudioProperties.Channels = getInt("channels") + if codec, ok := data["codec"].(string); ok { + p.AudioProperties.Codec = codec + } for k, v := range data { p.Tags[k] = []string{fmt.Sprintf("%v", v)} } diff --git a/core/stream/aliases.go b/core/stream/aliases.go new file mode 100644 index 000000000..af42ac076 --- /dev/null +++ b/core/stream/aliases.go @@ -0,0 +1,92 @@ +package stream + +import ( + "slices" + "strings" +) + +// containerAliasGroups maps each container alias to a canonical group name. +var containerAliasGroups = func() map[string]string { + groups := [][]string{ + {"aac", "adts", "m4a", "mp4", "m4b", "m4p"}, + {"mpeg", "mp3", "mp2"}, + {"ogg", "oga", "opus"}, + {"aif", "aiff"}, + {"asf", "wma"}, + {"mpc", "mpp"}, + {"wv"}, + } + m := make(map[string]string) + for _, g := range groups { + canonical := g[0] + for _, name := range g { + m[name] = canonical + } + } + return m +}() + +// codecAliasGroups maps each codec alias to a canonical group name. +// Codecs within the same group are considered equivalent. +var codecAliasGroups = func() map[string]string { + groups := [][]string{ + {"aac", "adts"}, + {"ac3", "ac-3"}, + {"eac3", "e-ac3", "e-ac-3", "eac-3"}, + {"mpc7", "musepack7"}, + {"mpc8", "musepack8"}, + {"wma1", "wmav1"}, + {"wma2", "wmav2"}, + {"wmalossless", "wma9lossless"}, + {"wmapro", "wma9pro"}, + {"shn", "shorten"}, + {"mp4als", "als"}, + } + m := make(map[string]string) + for _, g := range groups { + for _, name := range g { + m[name] = g[0] // canonical = first entry + } + } + return m +}() + +// matchesWithAliases checks if a value matches any entry in candidates, +// consulting the alias map for equivalent names. +func matchesWithAliases(value string, candidates []string, aliases map[string]string) bool { + value = strings.ToLower(value) + canonical := aliases[value] + for _, c := range candidates { + c = strings.ToLower(c) + if c == value { + return true + } + if canonical != "" && aliases[c] == canonical { + return true + } + } + return false +} + +// matchesContainer checks if a file suffix matches any of the container names, +// including common aliases. +func matchesContainer(suffix string, containers []string) bool { + return matchesWithAliases(suffix, containers, containerAliasGroups) +} + +// matchesCodec checks if a codec matches any of the codec names, +// including common aliases. +func matchesCodec(codec string, codecs []string) bool { + return matchesWithAliases(codec, codecs, codecAliasGroups) +} + +// IsAACCodec returns true if the given codec or container name resolves to AAC. +func IsAACCodec(name string) bool { + return matchesCodec(name, []string{"aac"}) || matchesContainer(name, []string{"aac"}) +} + +func containsIgnoreCase(slice []string, s string) bool { + return slices.ContainsFunc(slice, func(item string) bool { + return strings.EqualFold(item, s) + }) +} diff --git a/core/stream/aliases_test.go b/core/stream/aliases_test.go new file mode 100644 index 000000000..72f061810 --- /dev/null +++ b/core/stream/aliases_test.go @@ -0,0 +1,30 @@ +package stream + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Aliases", func() { + Describe("IsAACCodec", func() { + It("returns true for AAC and its aliases", func() { + Expect(IsAACCodec("aac")).To(BeTrue()) + Expect(IsAACCodec("AAC")).To(BeTrue()) + Expect(IsAACCodec("adts")).To(BeTrue()) + Expect(IsAACCodec("m4a")).To(BeTrue()) + Expect(IsAACCodec("mp4")).To(BeTrue()) + Expect(IsAACCodec("m4b")).To(BeTrue()) + }) + + It("returns false for non-AAC formats", func() { + Expect(IsAACCodec("mp3")).To(BeFalse()) + Expect(IsAACCodec("opus")).To(BeFalse()) + Expect(IsAACCodec("flac")).To(BeFalse()) + Expect(IsAACCodec("ogg")).To(BeFalse()) + }) + + It("returns false for empty string", func() { + Expect(IsAACCodec("")).To(BeFalse()) + }) + }) +}) diff --git a/core/stream/codec.go b/core/stream/codec.go new file mode 100644 index 000000000..28bff75c4 --- /dev/null +++ b/core/stream/codec.go @@ -0,0 +1,90 @@ +package stream + +import "strings" + +// normalizeProbeCodec maps ffprobe codec_name values to the simplified internal +// codec names used throughout Navidrome (matching inferCodecFromSuffix output). +// Most ffprobe names match directly; this handles the exceptions. +func normalizeProbeCodec(codec string) string { + c := strings.ToLower(codec) + // DSD variants: dsd_lsbf_planar, dsd_msbf_planar, dsd_lsbf, dsd_msbf + if strings.HasPrefix(c, "dsd") { + return "dsd" + } + // PCM variants: pcm_s16le, pcm_s24le, pcm_s32be, pcm_f32le, etc. + if strings.HasPrefix(c, "pcm_") { + return "pcm" + } + return c +} + +// isLosslessFormat returns true if the format is a known lossless audio codec/format. +// Detection is based on codec name only, not bit depth — some lossy codecs (e.g. ADPCM) +// report non-zero bits_per_sample in ffprobe, so bit depth alone is not a reliable signal. +// +// Note: core/ffmpeg has a separate isLosslessOutputFormat that covers only formats +// ffmpeg can produce as output (a smaller set). +func isLosslessFormat(format string) bool { + switch strings.ToLower(format) { + case "flac", "alac", "wav", "aiff", "ape", "wv", "wavpack", "tta", "tak", "shn", "dsd", "pcm": + return true + } + return false +} + +// normalizeSourceSampleRate adjusts the source sample rate for codecs that store +// it differently than PCM. Currently handles DSD (÷8): +// DSD64=2822400→352800, DSD128=5644800→705600, etc. +// For other codecs, returns the rate unchanged. +func normalizeSourceSampleRate(sampleRate int, codec string) int { + if strings.EqualFold(codec, "dsd") && sampleRate > 0 { + return sampleRate / 8 + } + return sampleRate +} + +// normalizeSourceBitDepth adjusts the source bit depth for codecs that use +// non-standard bit depths. Currently handles DSD (1-bit → 24-bit PCM, which is +// what ffmpeg produces). For other codecs, returns the depth unchanged. +func normalizeSourceBitDepth(bitDepth int, codec string) int { + if strings.EqualFold(codec, "dsd") && bitDepth == 1 { + return 24 + } + return bitDepth +} + +// codecFixedOutputSampleRate returns the mandatory output sample rate for codecs +// that always resample regardless of input (e.g., Opus always outputs 48000Hz). +// Returns 0 if the codec has no fixed output rate. +func codecFixedOutputSampleRate(codec string) int { + switch strings.ToLower(codec) { + case "opus": + return 48000 + } + return 0 +} + +// codecMaxSampleRate returns the hard maximum output sample rate for a codec. +// Returns 0 if the codec has no hard limit. +func codecMaxSampleRate(codec string) int { + switch strings.ToLower(codec) { + case "mp3": + return 48000 + case "aac": + return 96000 + } + return 0 +} + +// codecMaxChannels returns the hard maximum number of audio channels a codec +// supports. Returns 0 if the codec has no hard limit (or is unknown), in which +// case the source/profile constraints applied upstream are authoritative. +func codecMaxChannels(codec string) int { + switch strings.ToLower(codec) { + case "mp3": + return 2 + case "opus": + return 8 + } + return 0 +} diff --git a/core/stream/codec_test.go b/core/stream/codec_test.go new file mode 100644 index 000000000..97e15bdb5 --- /dev/null +++ b/core/stream/codec_test.go @@ -0,0 +1,91 @@ +package stream + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Codec", func() { + Describe("isLosslessFormat", func() { + It("returns true for known lossless codecs", func() { + Expect(isLosslessFormat("flac")).To(BeTrue()) + Expect(isLosslessFormat("alac")).To(BeTrue()) + Expect(isLosslessFormat("pcm")).To(BeTrue()) + Expect(isLosslessFormat("wav")).To(BeTrue()) + Expect(isLosslessFormat("dsd")).To(BeTrue()) + Expect(isLosslessFormat("ape")).To(BeTrue()) + Expect(isLosslessFormat("wv")).To(BeTrue()) + Expect(isLosslessFormat("wavpack")).To(BeTrue()) // ffprobe codec_name for WavPack + }) + + It("returns false for lossy codecs", func() { + Expect(isLosslessFormat("mp3")).To(BeFalse()) + Expect(isLosslessFormat("aac")).To(BeFalse()) + Expect(isLosslessFormat("opus")).To(BeFalse()) + Expect(isLosslessFormat("vorbis")).To(BeFalse()) + }) + + It("returns false for unknown codecs", func() { + Expect(isLosslessFormat("unknown_codec")).To(BeFalse()) + }) + + It("is case-insensitive", func() { + Expect(isLosslessFormat("FLAC")).To(BeTrue()) + Expect(isLosslessFormat("Alac")).To(BeTrue()) + }) + }) + + Describe("normalizeProbeCodec", func() { + It("passes through common codec names unchanged", func() { + Expect(normalizeProbeCodec("mp3")).To(Equal("mp3")) + Expect(normalizeProbeCodec("aac")).To(Equal("aac")) + Expect(normalizeProbeCodec("flac")).To(Equal("flac")) + Expect(normalizeProbeCodec("opus")).To(Equal("opus")) + Expect(normalizeProbeCodec("vorbis")).To(Equal("vorbis")) + Expect(normalizeProbeCodec("alac")).To(Equal("alac")) + Expect(normalizeProbeCodec("wmav2")).To(Equal("wmav2")) + }) + + It("normalizes DSD variants to dsd", func() { + Expect(normalizeProbeCodec("dsd_lsbf_planar")).To(Equal("dsd")) + Expect(normalizeProbeCodec("dsd_msbf_planar")).To(Equal("dsd")) + Expect(normalizeProbeCodec("dsd_lsbf")).To(Equal("dsd")) + Expect(normalizeProbeCodec("dsd_msbf")).To(Equal("dsd")) + }) + + It("normalizes PCM variants to pcm", func() { + Expect(normalizeProbeCodec("pcm_s16le")).To(Equal("pcm")) + Expect(normalizeProbeCodec("pcm_s24le")).To(Equal("pcm")) + Expect(normalizeProbeCodec("pcm_s32be")).To(Equal("pcm")) + Expect(normalizeProbeCodec("pcm_f32le")).To(Equal("pcm")) + }) + + It("lowercases input", func() { + Expect(normalizeProbeCodec("MP3")).To(Equal("mp3")) + Expect(normalizeProbeCodec("AAC")).To(Equal("aac")) + Expect(normalizeProbeCodec("DSD_LSBF_PLANAR")).To(Equal("dsd")) + }) + }) + + Describe("codecMaxChannels", func() { + It("returns 2 for mp3", func() { + Expect(codecMaxChannels("mp3")).To(Equal(2)) + }) + + It("returns 8 for opus", func() { + Expect(codecMaxChannels("opus")).To(Equal(8)) + }) + + It("is case-insensitive", func() { + Expect(codecMaxChannels("MP3")).To(Equal(2)) + Expect(codecMaxChannels("Opus")).To(Equal(8)) + }) + + It("returns 0 for codecs with no hard limit", func() { + Expect(codecMaxChannels("aac")).To(Equal(0)) + Expect(codecMaxChannels("flac")).To(Equal(0)) + Expect(codecMaxChannels("vorbis")).To(Equal(0)) + Expect(codecMaxChannels("")).To(Equal(0)) + }) + }) +}) diff --git a/core/stream/decider.go b/core/stream/decider.go new file mode 100644 index 000000000..d6e48497c --- /dev/null +++ b/core/stream/decider.go @@ -0,0 +1,457 @@ +package stream + +import ( + "context" + "encoding/json" + "fmt" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +const fallbackBitrate = 256 // kbps + +// TranscodeDecider is the core service interface for making transcoding decisions +type TranscodeDecider interface { + MakeDecision(ctx context.Context, mf *model.MediaFile, clientInfo *ClientInfo, opts TranscodeOptions) (*TranscodeDecision, error) + CreateTranscodeParams(decision *TranscodeDecision) (string, error) + ResolveRequestFromToken(ctx context.Context, token string, mf *model.MediaFile, offset int) (Request, error) + ResolveRequest(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, offset int) Request +} + +func NewTranscodeDecider(ds model.DataStore, ff ffmpeg.FFmpeg) TranscodeDecider { + return &deciderService{ + ds: ds, + ff: ff, + } +} + +type deciderService struct { + ds model.DataStore + ff ffmpeg.FFmpeg +} + +func (s *deciderService) MakeDecision(ctx context.Context, mf *model.MediaFile, clientInfo *ClientInfo, opts TranscodeOptions) (*TranscodeDecision, error) { + decision := &TranscodeDecision{ + MediaID: mf.ID, + SourceUpdatedAt: mf.UpdatedAt, + } + + var probe *ffmpeg.AudioProbeResult + if !opts.SkipProbe { + if !s.ff.IsProbeAvailable() { + log.Debug(ctx, "ffprobe not available, using tag metadata for transcode decision", "mediaID", mf.ID) + } else { + var err error + probe, err = s.ensureProbed(ctx, mf) + if err != nil { + return nil, err + } + } + } + + // Build source stream details (uses probe data if available) + decision.SourceStream = buildSourceStream(mf, probe) + src := &decision.SourceStream + + log.Trace(ctx, "Making transcode decision", "mediaID", mf.ID, "container", src.Container, + "codec", src.Codec, "bitrate", src.Bitrate, "channels", src.Channels, + "sampleRate", src.SampleRate, "lossless", src.IsLossless, "client", clientInfo.Name) + + // Check global bitrate constraint first. + if clientInfo.MaxAudioBitrate > 0 && src.Bitrate > clientInfo.MaxAudioBitrate { + log.Trace(ctx, "Global bitrate constraint exceeded, skipping direct play", + "sourceBitrate", src.Bitrate, "maxAudioBitrate", clientInfo.MaxAudioBitrate) + decision.TranscodeReasons = append(decision.TranscodeReasons, "audio bitrate not supported") + // Skip direct play profiles entirely — global constraint fails + } else { + // Try direct play profiles, collecting reasons for each failure + for _, profile := range clientInfo.DirectPlayProfiles { + if reason := s.checkDirectPlayProfile(src, &profile, clientInfo); reason == "" { + decision.CanDirectPlay = true + decision.TranscodeReasons = nil // Clear any previously collected reasons + break + } else { + decision.TranscodeReasons = append(decision.TranscodeReasons, reason) + } + } + } + + // If direct play is possible, we're done + if decision.CanDirectPlay { + log.Debug(ctx, "Transcode decision: direct play", "mediaID", mf.ID, "container", src.Container, "codec", src.Codec) + return decision, nil + } + + // Try transcoding profiles (in order of preference) + for _, profile := range clientInfo.TranscodingProfiles { + if ts, transcodeFormat := s.computeTranscodedStream(ctx, src, &profile, clientInfo); ts != nil { + decision.CanTranscode = true + decision.TargetFormat = transcodeFormat + decision.TargetBitrate = ts.Bitrate + decision.TargetChannels = ts.Channels + decision.TargetSampleRate = ts.SampleRate + decision.TargetBitDepth = ts.BitDepth + decision.TranscodeStream = ts + break + } + } + + if decision.CanTranscode { + log.Debug(ctx, "Transcode decision: transcode", "mediaID", mf.ID, + "targetFormat", decision.TargetFormat, "targetBitrate", decision.TargetBitrate, + "targetChannels", decision.TargetChannels, "reasons", decision.TranscodeReasons) + } + + // If neither direct play nor transcode is possible + if !decision.CanDirectPlay && !decision.CanTranscode { + decision.ErrorReason = "no compatible playback profile found" + log.Warn(ctx, "Transcode decision: no compatible profile", "mediaID", mf.ID, + "container", src.Container, "codec", src.Codec, "reasons", decision.TranscodeReasons) + } + + return decision, nil +} + +func buildSourceStream(mf *model.MediaFile, probe *ffmpeg.AudioProbeResult) Details { + sd := Details{ + Container: mf.Suffix, + Duration: mf.Duration, + Size: mf.Size, + } + + // Use pre-parsed probe result, or fall back to parsing stored probe data + if probe == nil { + probe, _ = parseProbeData(mf.ProbeData) + } + + // Use probe data if available for authoritative values + if probe != nil { + sd.Codec = normalizeProbeCodec(probe.Codec) + sd.Profile = probe.Profile + sd.Bitrate = probe.BitRate + sd.SampleRate = probe.SampleRate + sd.BitDepth = probe.BitDepth + sd.Channels = probe.Channels + } else { + sd.Codec = mf.AudioCodec() + sd.Bitrate = mf.BitRate + sd.SampleRate = mf.SampleRate + sd.BitDepth = mf.BitDepth + sd.Channels = mf.Channels + } + sd.IsLossless = isLosslessFormat(sd.Codec) + + return sd +} + +// applyServerOverride replaces the client-provided profiles with synthetic ones +// matching the server-forced transcoding format and bitrate. +func applyServerOverride(ctx context.Context, original *ClientInfo, trc *model.Transcoding) *ClientInfo { + maxBitRate := trc.DefaultBitRate + if player, ok := request.PlayerFrom(ctx); ok && player.MaxBitRate > 0 { + maxBitRate = player.MaxBitRate + } + + log.Debug(ctx, "Applying server-side transcoding override", + "targetFormat", trc.TargetFormat, "maxBitRate", maxBitRate, + "client", original.Name) + + return &ClientInfo{ + Name: original.Name, + Platform: original.Platform, + MaxAudioBitrate: maxBitRate, + MaxTranscodingAudioBitrate: maxBitRate, + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{trc.TargetFormat}, AudioCodecs: []string{trc.TargetFormat}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: trc.TargetFormat, AudioCodec: trc.TargetFormat, Protocol: ProtocolHTTP}, + }, + } +} + +func parseProbeData(data string) (*ffmpeg.AudioProbeResult, error) { + if data == "" { + return nil, nil + } + var result ffmpeg.AudioProbeResult + if err := json.Unmarshal([]byte(data), &result); err != nil { + return nil, err + } + return &result, nil +} + +// matchesPCMWAVBridge bridges Navidrome's internal "pcm" codec name with the +// "wav" codec name that browsers use to advertise audio/wav support. The match +// is scoped to WAV-container sources so AIFF files (which also normalize to +// codec "pcm" but use a different container) cannot false-match a codec-only +// ["wav"] profile. +func matchesPCMWAVBridge(src *Details, profile *DirectPlayProfile) bool { + return strings.EqualFold(src.Codec, "pcm") && + strings.EqualFold(src.Container, "wav") && + containsIgnoreCase(profile.AudioCodecs, "wav") +} + +// checkDirectPlayProfile returns "" if the profile matches (direct play OK), +// or a typed reason string if it doesn't match. +func (s *deciderService) checkDirectPlayProfile(src *Details, profile *DirectPlayProfile, clientInfo *ClientInfo) string { + // Check protocol (only http for now) + if len(profile.Protocols) > 0 && !containsIgnoreCase(profile.Protocols, ProtocolHTTP) { + return "protocol not supported" + } + + // Check container + if len(profile.Containers) > 0 && !matchesContainer(src.Container, profile.Containers) { + return fmt.Sprintf("container '%s' not supported by profile %s", src.Container, profile) + } + + // Check codec + if len(profile.AudioCodecs) > 0 && !matchesCodec(src.Codec, profile.AudioCodecs) && !matchesPCMWAVBridge(src, profile) { + return fmt.Sprintf("audio codec '%s' not supported by profile %s", src.Codec, profile) + } + + // Check channels + if profile.MaxAudioChannels > 0 && src.Channels > profile.MaxAudioChannels { + return fmt.Sprintf("audio channels %d not supported by profile %s (max %d)", src.Channels, profile, profile.MaxAudioChannels) + } + + // Check codec-specific limitations + for _, codecProfile := range clientInfo.CodecProfiles { + if strings.EqualFold(codecProfile.Type, CodecProfileTypeAudio) && matchesCodec(src.Codec, []string{codecProfile.Name}) { + if reason := checkLimitations(src, codecProfile.Limitations); reason != "" { + return reason + } + } + } + + return "" +} + +// computeTranscodedStream attempts to build a valid transcoded stream for the given profile. +// Returns the stream details and the internal transcoding format (which may differ from the +// response container when a codec fallback occurs, e.g., "mp4"→"aac"). +// Returns nil, "" if the profile cannot produce a valid output. +func (s *deciderService) computeTranscodedStream(ctx context.Context, src *Details, profile *Profile, clientInfo *ClientInfo) (*Details, string) { + // Check protocol (only http for now) + if profile.Protocol != "" && !strings.EqualFold(profile.Protocol, ProtocolHTTP) { + log.Trace(ctx, "Skipping transcoding profile: unsupported protocol", "protocol", profile.Protocol) + return nil, "" + } + + responseContainer, targetFormat := resolveTargetFormat(profile) + if targetFormat == "" { + return nil, "" + } + + // Verify we have a transcoding command available (DB custom or built-in default) + if LookupTranscodeCommand(ctx, s.ds, targetFormat) == "" { + log.Trace(ctx, "Skipping transcoding profile: no transcoding command available", "targetFormat", targetFormat) + return nil, "" + } + + targetIsLossless := isLosslessFormat(targetFormat) + + // Reject lossy to lossless conversion + if !src.IsLossless && targetIsLossless { + log.Trace(ctx, "Skipping transcoding profile: lossy to lossless not allowed", "targetFormat", targetFormat) + return nil, "" + } + + ts := &Details{ + Container: responseContainer, + Codec: strings.ToLower(profile.AudioCodec), + SampleRate: normalizeSourceSampleRate(src.SampleRate, src.Codec), + Channels: src.Channels, + BitDepth: normalizeSourceBitDepth(src.BitDepth, src.Codec), + IsLossless: targetIsLossless, + } + if ts.Codec == "" { + ts.Codec = targetFormat + } + + // Apply codec-intrinsic sample rate adjustments before codec profile limitations + if fixedRate := codecFixedOutputSampleRate(ts.Codec); fixedRate > 0 { + ts.SampleRate = fixedRate + } + if maxRate := codecMaxSampleRate(ts.Codec); maxRate > 0 && ts.SampleRate > maxRate { + ts.SampleRate = maxRate + } + if maxCh := codecMaxChannels(ts.Codec); maxCh > 0 && ts.Channels > maxCh { + ts.Channels = maxCh + } + + // Determine target bitrate (all in kbps) + if ok := s.computeBitrate(ctx, src, targetFormat, targetIsLossless, clientInfo, ts); !ok { + return nil, "" + } + + // Apply MaxAudioChannels from the transcoding profile. Compare against the + // already-clamped ts.Channels (not src.Channels) so the codec hard limit + // applied above is never raised by a looser profile setting. + if profile.MaxAudioChannels > 0 && ts.Channels > profile.MaxAudioChannels { + ts.Channels = profile.MaxAudioChannels + } + + // Apply codec profile limitations to the TARGET codec + if ok := s.applyCodecLimitations(ctx, src.Bitrate, targetFormat, targetIsLossless, clientInfo, ts); !ok { + return nil, "" + } + + return ts, targetFormat +} + +// lookupDefaultBitrate returns the default bitrate for the given format. +// It checks the DB first (for user-customized values), then falls back to +// the built-in defaults, and finally to fallbackBitrate. +func lookupDefaultBitrate(ctx context.Context, ds model.DataStore, format string) int { + if t, err := ds.Transcoding(ctx).FindByFormat(format); err == nil && t.DefaultBitRate > 0 { + return t.DefaultBitRate + } + for _, dt := range consts.DefaultTranscodings { + if dt.TargetFormat == format && dt.DefaultBitRate > 0 { + return dt.DefaultBitRate + } + } + return fallbackBitrate +} + +// LookupTranscodeCommand returns the ffmpeg command for the given format. +// It checks the DB first (for user-customized commands), then falls back to +// the built-in default command. Returns "" if the format is unknown. +func LookupTranscodeCommand(ctx context.Context, ds model.DataStore, format string) string { + t, err := ds.Transcoding(ctx).FindByFormat(format) + if err == nil && t.Command != "" { + return t.Command + } + // Fall back to built-in defaults + for _, dt := range consts.DefaultTranscodings { + if dt.TargetFormat == format { + return dt.Command + } + } + return "" +} + +// resolveTargetFormat determines the response container and internal target format +// from the profile's Container and AudioCodec fields. When an AudioCodec is specified +// it is preferred as targetFormat (e.g. container "mp4" with audioCodec "aac" → targetFormat "aac"). +func resolveTargetFormat(profile *Profile) (responseContainer, targetFormat string) { + responseContainer = strings.ToLower(profile.Container) + targetFormat = responseContainer + + // Prefer the audioCodec as targetFormat when provided (handles container-to-codec + // mapping like "mp4" → "aac", "ogg" → "opus"). + if profile.AudioCodec != "" { + targetFormat = strings.ToLower(profile.AudioCodec) + } + + // If neither container nor audioCodec is set, we can't resolve a format. + if targetFormat == "" { + return "", "" + } + + // When no container was specified, use the targetFormat as container too. + if responseContainer == "" { + responseContainer = targetFormat + } + + return responseContainer, targetFormat +} + +// computeBitrate determines the target bitrate for the transcoded stream. +// Returns false if the profile should be rejected. +func (s *deciderService) computeBitrate(ctx context.Context, src *Details, targetFormat string, targetIsLossless bool, clientInfo *ClientInfo, ts *Details) bool { + if src.IsLossless { + if !targetIsLossless { + if clientInfo.MaxTranscodingAudioBitrate > 0 { + ts.Bitrate = clientInfo.MaxTranscodingAudioBitrate + } else if clientInfo.MaxAudioBitrate > 0 { + ts.Bitrate = clientInfo.MaxAudioBitrate + } else { + ts.Bitrate = lookupDefaultBitrate(ctx, s.ds, targetFormat) + } + } else { + if clientInfo.MaxAudioBitrate > 0 && src.Bitrate > clientInfo.MaxAudioBitrate { + log.Trace(ctx, "Skipping transcoding profile: lossless target exceeds bitrate limit", + "targetFormat", targetFormat, "sourceBitrate", src.Bitrate, "maxAudioBitrate", clientInfo.MaxAudioBitrate) + return false + } + } + } else { + ts.Bitrate = src.Bitrate + } + + // Apply maxAudioBitrate as final cap + if clientInfo.MaxAudioBitrate > 0 && ts.Bitrate > 0 && ts.Bitrate > clientInfo.MaxAudioBitrate { + ts.Bitrate = clientInfo.MaxAudioBitrate + } + return true +} + +// applyCodecLimitations applies codec profile limitations to the transcoded stream. +// Returns false if the profile should be rejected. +func (s *deciderService) applyCodecLimitations(ctx context.Context, sourceBitrate int, targetFormat string, targetIsLossless bool, clientInfo *ClientInfo, ts *Details) bool { + targetCodec := ts.Codec + for _, codecProfile := range clientInfo.CodecProfiles { + if !strings.EqualFold(codecProfile.Type, CodecProfileTypeAudio) { + continue + } + if !matchesCodec(targetCodec, []string{codecProfile.Name}) { + continue + } + for _, lim := range codecProfile.Limitations { + result := applyLimitation(sourceBitrate, &lim, ts) + if strings.EqualFold(lim.Name, LimitationAudioBitrate) && targetIsLossless && result == adjustAdjusted { + log.Trace(ctx, "Skipping transcoding profile: cannot adjust bitrate for lossless target", + "targetFormat", targetFormat, "codec", targetCodec, "limitation", lim.Name) + return false + } + if result == adjustCannotFit { + log.Trace(ctx, "Skipping transcoding profile: codec limitation cannot be satisfied", + "targetFormat", targetFormat, "codec", targetCodec, "limitation", lim.Name, + "comparison", lim.Comparison, "values", lim.Values) + return false + } + } + } + return true +} + +// ensureProbed runs ffprobe if probe data is missing, persists it, and returns +// the parsed result. Returns (nil, nil) when probing is skipped or data already exists +// (in which case the caller should parse mf.ProbeData). +func (s *deciderService) ensureProbed(ctx context.Context, mf *model.MediaFile) (*ffmpeg.AudioProbeResult, error) { + if mf.ProbeData != "" { + return nil, nil + } + if !conf.Server.DevEnableMediaFileProbe { + return nil, nil + } + + result, err := s.ff.ProbeAudioStream(ctx, mf.AbsolutePath()) + if err != nil { + return nil, fmt.Errorf("probing media file %s: %w", mf.ID, err) + } + + data, err := json.Marshal(result) + if err != nil { + return nil, fmt.Errorf("marshaling probe result for %s: %w", mf.ID, err) + } + mf.ProbeData = string(data) + + if err := s.ds.MediaFile(ctx).UpdateProbeData(mf.ID, mf.ProbeData); err != nil { + log.Error(ctx, "Failed to persist probe data", "mediaID", mf.ID, err) + // Don't fail the decision — we have the data in memory + } + + log.Debug(ctx, "Probed media file", "mediaID", mf.ID, "codec", result.Codec, + "profile", result.Profile, "bitRate", result.BitRate, + "sampleRate", result.SampleRate, "bitDepth", result.BitDepth, "channels", result.Channels) + return result, nil +} diff --git a/core/stream/decider_test.go b/core/stream/decider_test.go new file mode 100644 index 000000000..f74953258 --- /dev/null +++ b/core/stream/decider_test.go @@ -0,0 +1,1180 @@ +package stream + +import ( + "context" + "encoding/json" + "fmt" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// withProbe pre-populates ProbeData on a MediaFile from its own fields, +// so ensureProbed short-circuits and tests don't need mock ffprobe results. +func withProbe(mf *model.MediaFile) *model.MediaFile { + probe := ffmpeg.AudioProbeResult{ + Codec: mf.AudioCodec(), + BitRate: mf.BitRate, + SampleRate: mf.SampleRate, + BitDepth: mf.BitDepth, + Channels: mf.Channels, + } + data, _ := json.Marshal(probe) + mf.ProbeData = string(data) + return mf +} + +var _ = Describe("Decider", func() { + var ( + ds *tests.MockDataStore + ff *tests.MockFFmpeg + svc TranscodeDecider + ctx context.Context + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedTranscoding: &tests.MockTranscodingRepo{}, + } + ff = tests.NewMockFFmpeg("") + auth.Init(ds) + svc = NewTranscodeDecider(ds, ff) + }) + + Describe("MakeDecision", func() { + Context("Direct Play", func() { + It("allows direct play when profile matches", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + Expect(decision.CanTranscode).To(BeFalse()) + Expect(decision.TranscodeReasons).To(BeEmpty()) + }) + + It("rejects direct play when container doesn't match", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement(And( + ContainSubstring("container 'flac' not supported"), + ContainSubstring("[mp3]"), + ))) + }) + + It("rejects direct play when codec doesn't match", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "ALAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement(And( + ContainSubstring("audio codec 'alac' not supported"), + ContainSubstring("[m4a/aac]"), + ))) + }) + + It("rejects direct play when channels exceed limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement(And( + ContainSubstring("audio channels 6 not supported"), + ContainSubstring("[flac]"), + ContainSubstring("(max 2)"), + ))) + }) + + It("accepts WAV source against a wav codec profile (pcm->wav bridge)", func() { + // ffprobe normalizes PCM variants (pcm_s16le etc) to codec "pcm", but + // browsers advertise WAV support as audioCodecs:["wav"] via audio/wav MIME. + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "wav", Codec: "pcm", BitRate: 1411, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"wav"}, AudioCodecs: []string{"wav"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("does not accept AIFF (pcm in non-wav container) against a wav codec profile", func() { + // AIFF files also normalize to codec="pcm" but use container="aiff". + // Without the container guard they would falsely match a codec-only + // ["wav"] profile and be direct-played as if they were WAV. + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "aiff", Codec: "pcm", BitRate: 1411, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {AudioCodecs: []string{"wav"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement(ContainSubstring("audio codec 'pcm'"))) + }) + + It("handles container aliases (aac -> m4a)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"aac"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles container aliases (mp4 -> m4a)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp4"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles container aliases (opus -> ogg)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "opus", Codec: "Opus", BitRate: 165, Channels: 2, SampleRate: 48000}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"ogg"}, AudioCodecs: []string{"opus"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles codec aliases (adts -> aac)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"adts"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("allows when protocol list is empty (any protocol)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, AudioCodecs: []string{"flac"}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("allows when both container and codec lists are empty (wildcard)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 128, Channels: 2}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{}, AudioCodecs: []string{}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + }) + + Context("MaxAudioBitrate constraint", func() { + It("revokes direct play when bitrate exceeds maxAudioBitrate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1500, Channels: 2}) + ci := &ClientInfo{ + MaxAudioBitrate: 500, // kbps + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeReasons).To(ContainElement("audio bitrate not supported")) + }) + }) + + Context("Transcoding", func() { + It("selects transcoding when direct play isn't possible", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, // kbps + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TargetBitrate).To(Equal(256)) // kbps + Expect(decision.TranscodeReasons).To(ContainElement(And( + ContainSubstring("container 'flac' not supported"), + ContainSubstring("[mp3]"), + ))) + }) + + It("rejects lossy to lossless transcoding", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeFalse()) + }) + + It("uses default bitrate when client doesn't specify", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, BitDepth: 16}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(160)) // mp3 default from mock transcoding repo + }) + + It("preserves lossy bitrate when under max", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "ogg", BitRate: 192, Channels: 2}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, // kbps + TranscodingProfiles: []Profile{ + {Container: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(192)) // source bitrate in kbps + }) + + It("rejects format with no transcoding command available", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "wav", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeFalse()) + }) + + It("applies maxAudioBitrate as final cap on transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2}) + ci := &ClientInfo{ + MaxAudioBitrate: 96, // kbps + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(96)) // capped by maxAudioBitrate + }) + + It("selects first valid transcoding profile in order", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 48000, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP, MaxAudioChannels: 2}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("opus")) + }) + }) + + Context("Lossless to lossless transcoding", func() { + It("allows lossless to lossless when samplerate needs downsampling", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 176400, BitDepth: 1}) + ci := &ClientInfo{ + MaxAudioBitrate: 1000, + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + }) + + It("sets IsLossless=true on transcoded stream when target is lossless", func() { + // Transcoding to mp3 (lossy) should result in IsLossless=false. + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.IsLossless).To(BeFalse()) // mp3 is lossy + }) + }) + + Context("No compatible profile", func() { + It("returns error when nothing matches", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6}) + ci := &ClientInfo{} + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.CanTranscode).To(BeFalse()) + Expect(decision.ErrorReason).To(Equal("no compatible playback profile found")) + }) + }) + + Context("Codec limitations on direct play", func() { + It("rejects direct play when codec limitation fails (required)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 512, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioBitrate, Comparison: ComparisonLessThanEqual, Values: []string{"320"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio bitrate not supported")) + }) + + It("allows direct play when optional limitation fails", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 512, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioBitrate, Comparison: ComparisonLessThanEqual, Values: []string{"320"}, Required: false}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("handles Equals comparison with multiple values", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioChannels, Comparison: ComparisonEquals, Values: []string{"1", "2"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("rejects when Equals comparison doesn't match any value", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioChannels, Comparison: ComparisonEquals, Values: []string{"1", "2"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + }) + + It("rejects direct play when audioProfile limitation fails (required)", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "aac", + Limitations: []Limitation{ + {Name: LimitationAudioProfile, Comparison: ComparisonEquals, Values: []string{"LC"}, Required: true}, + }, + }, + }, + } + // Source profile is empty (not yet populated from scanner), so Equals("LC") fails + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio profile not supported")) + }) + + It("allows direct play when audioProfile limitation is optional", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "m4a", Codec: "AAC", BitRate: 256, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"m4a"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "aac", + Limitations: []Limitation{ + {Name: LimitationAudioProfile, Comparison: ComparisonEquals, Values: []string{"LC"}, Required: false}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("rejects direct play due to samplerate limitation", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonLessThanEqual, Values: []string{"48000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(ContainElement("audio samplerate not supported")) + }) + }) + + Context("Codec limitations on transcoded output", func() { + It("applies bitrate limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 192, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + MaxAudioBitrate: 96, // force transcode + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioBitrate, Comparison: ComparisonLessThanEqual, Values: []string{"96"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Bitrate).To(Equal(96)) + }) + + It("applies channel limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 48000, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioChannels, Comparison: ComparisonLessThanEqual, Values: []string{"2"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Channels).To(Equal(2)) + }) + + It("applies samplerate limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonLessThanEqual, Values: []string{"48000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + }) + + It("applies bitdepth limitation to transcoded stream", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioBitdepth, Comparison: ComparisonLessThanEqual, Values: []string{"16"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.BitDepth).To(Equal(16)) + Expect(decision.TargetBitDepth).To(Equal(16)) + }) + + It("preserves source bit depth when no limitation applies", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 24}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("rejects transcoding profile when GreaterThanEqual cannot be satisfied", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "mp3", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonGreaterThanEqual, Values: []string{"96000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeFalse()) + }) + }) + + Context("DSD sample rate conversion", func() { + It("converts DSD sample rate to PCM-equivalent in decision", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + // DSD64 2822400 / 8 = 352800, capped by MP3 max of 48000 + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + Expect(decision.TargetSampleRate).To(Equal(48000)) + // DSD 1-bit → 24-bit PCM + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("converts DSD sample rate for FLAC target without codec limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("flac")) + // DSD64 2822400 / 8 = 352800, FLAC has no hard max + Expect(decision.TranscodeStream.SampleRate).To(Equal(352800)) + Expect(decision.TargetSampleRate).To(Equal(352800)) + // DSD 1-bit → 24-bit PCM + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("applies codec profile limit to DSD-converted FLAC sample rate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioSamplerate, Comparison: ComparisonLessThanEqual, Values: []string{"48000"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // DSD64 2822400 / 8 = 352800, capped by codec profile limit of 48000 + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + Expect(decision.TargetSampleRate).To(Equal(48000)) + // DSD 1-bit → 24-bit PCM + Expect(decision.TranscodeStream.BitDepth).To(Equal(24)) + Expect(decision.TargetBitDepth).To(Equal(24)) + }) + + It("applies audioBitdepth limitation to DSD-converted bit depth", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "flac", AudioCodec: "flac", Protocol: ProtocolHTTP}, + }, + CodecProfiles: []CodecProfile{ + { + Type: CodecProfileTypeAudio, + Name: "flac", + Limitations: []Limitation{ + {Name: LimitationAudioBitdepth, Comparison: ComparisonLessThanEqual, Values: []string{"16"}, Required: true}, + }, + }, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // DSD 1-bit → 24-bit PCM, then capped by codec profile limit to 16-bit + Expect(decision.TranscodeStream.BitDepth).To(Equal(16)) + Expect(decision.TargetBitDepth).To(Equal(16)) + }) + }) + + Context("Codec channel limits", func() { + It("clamps 6-channel FLAC to 2 channels when transcoding to MP3", func() { + // Regression test for #5336: ffmpeg's mp3 encoder rejects >2 channels. + // The decider must clamp to the codec's hard limit even when no + // transcoding profile MaxAudioChannels is configured. + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TranscodeStream.Channels).To(Equal(2)) + Expect(decision.TargetChannels).To(Equal(2)) + }) + + It("honors a stricter profile MaxAudioChannels over the codec clamp", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP, MaxAudioChannels: 1}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Channels).To(Equal(1)) + Expect(decision.TargetChannels).To(Equal(1)) + }) + + It("applies the codec clamp when the profile limit is looser", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP, MaxAudioChannels: 4}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Channels).To(Equal(2)) + Expect(decision.TargetChannels).To(Equal(2)) + }) + + It("passes channels through unchanged for codecs with no hard limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 6, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "m4a", AudioCodec: "aac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("aac")) + Expect(decision.TranscodeStream.Channels).To(Equal(6)) + Expect(decision.TargetChannels).To(Equal(6)) + }) + }) + + Context("Probe-based lossless detection", func() { + It("uses probe codec name for lossless detection", func() { + // WavPack files: ffprobe reports codec as "wavpack", suffix is ".wv" + mf := &model.MediaFile{ID: "1", Suffix: "wv", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16} + probe := ffmpeg.AudioProbeResult{ + Codec: "wavpack", BitRate: 1000, SampleRate: 44100, BitDepth: 16, Channels: 2, + } + data, _ := json.Marshal(probe) + mf.ProbeData = string(data) + + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + MaxTranscodingAudioBitrate: 256, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.SourceStream.IsLossless).To(BeTrue()) + Expect(decision.SourceStream.Codec).To(Equal("wavpack")) + // Lossless source transcoding to MP3 should use MaxTranscodingAudioBitrate + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.Bitrate).To(Equal(256)) + }) + + It("detects lossy from probe codec name", func() { + mf := &model.MediaFile{ID: "1", Suffix: "ogg", BitRate: 192, Channels: 2, SampleRate: 48000} + probe := ffmpeg.AudioProbeResult{ + Codec: "vorbis", BitRate: 192, SampleRate: 48000, BitDepth: 0, Channels: 2, + } + data, _ := json.Marshal(probe) + mf.ProbeData = string(data) + + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"ogg"}, AudioCodecs: []string{"vorbis"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.SourceStream.IsLossless).To(BeFalse()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + }) + + Context("Opus fixed sample rate", func() { + It("sets Opus output to 48000Hz regardless of input", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 128, + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("opus")) + // Opus always outputs 48000Hz + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + Expect(decision.TargetSampleRate).To(Equal(48000)) + }) + + It("sets Opus output to 48000Hz even for 96kHz input", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1500, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 128, + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + }) + }) + + Context("Container vs format separation", func() { + It("preserves mp4 container when falling back to aac format", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, + TranscodingProfiles: []Profile{ + {Container: "mp4", AudioCodec: "aac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // TargetFormat is the internal format used for transcoding ("aac") + Expect(decision.TargetFormat).To(Equal("aac")) + // Container in the response preserves what the client asked ("mp4") + Expect(decision.TranscodeStream.Container).To(Equal("mp4")) + Expect(decision.TranscodeStream.Codec).To(Equal("aac")) + }) + + It("uses container as format when container matches transcoding config", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 256, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetFormat).To(Equal("mp3")) + Expect(decision.TranscodeStream.Container).To(Equal("mp3")) + }) + }) + + Context("MP3 max sample rate", func() { + It("caps sample rate at 48000 for MP3", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1500, Channels: 2, SampleRate: 96000, BitDepth: 24}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(48000)) + }) + + It("preserves sample rate at 44100 for MP3", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TranscodeStream.SampleRate).To(Equal(44100)) + }) + }) + + Context("AAC max sample rate", func() { + It("caps sample rate at 96000 for AAC", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "dsf", Codec: "DSD", BitRate: 5644, Channels: 2, SampleRate: 2822400, BitDepth: 1}) + ci := &ClientInfo{ + MaxTranscodingAudioBitrate: 320, + TranscodingProfiles: []Profile{ + {Container: "aac", AudioCodec: "aac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + // DSD64 2822400 / 8 = 352800, capped by AAC max of 96000 + Expect(decision.TranscodeStream.SampleRate).To(Equal(96000)) + }) + }) + + Context("Typed transcode reasons from multiple profiles", func() { + It("collects reasons from each failed direct play profile", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "ogg", Codec: "Vorbis", BitRate: 128, Channels: 2, SampleRate: 48000}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + {Containers: []string{"mp3"}, AudioCodecs: []string{"mp3"}, Protocols: []string{ProtocolHTTP}}, + {Containers: []string{"m4a", "mp4"}, AudioCodecs: []string{"aac"}, Protocols: []string{ProtocolHTTP}}, + }, + TranscodingProfiles: []Profile{ + {Container: "mp3", AudioCodec: "mp3", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeFalse()) + Expect(decision.TranscodeReasons).To(HaveLen(3)) + Expect(decision.TranscodeReasons[0]).To(ContainSubstring("container 'ogg' not supported")) + Expect(decision.TranscodeReasons[0]).To(ContainSubstring("[flac]")) + Expect(decision.TranscodeReasons[1]).To(ContainSubstring("container 'ogg' not supported")) + Expect(decision.TranscodeReasons[1]).To(ContainSubstring("[mp3/mp3]")) + Expect(decision.TranscodeReasons[2]).To(ContainSubstring("container 'ogg' not supported")) + Expect(decision.TranscodeReasons[2]).To(ContainSubstring("[m4a,mp4/aac]")) + }) + }) + + Context("Source stream details", func() { + It("populates source stream correctly with kbps bitrate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24, Duration: 300.5, Size: 50000000}) + ci := &ClientInfo{ + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.SourceStream.Container).To(Equal("flac")) + Expect(decision.SourceStream.Codec).To(Equal("flac")) + Expect(decision.SourceStream.Bitrate).To(Equal(1000)) // kbps + Expect(decision.SourceStream.SampleRate).To(Equal(96000)) + Expect(decision.SourceStream.BitDepth).To(Equal(24)) + Expect(decision.SourceStream.Channels).To(Equal(2)) + }) + }) + + Context("Server-side context is ignored by MakeDecision", func() { + It("ignores transcoding override in context", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + ci := &ClientInfo{ + Name: "TestClient", + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 192}) + decision, err := svc.MakeDecision(overrideCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + + It("ignores player MaxBitRate in context", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + Name: "TestClient", + DirectPlayProfiles: []DirectPlayProfile{ + {Containers: []string{"flac"}, Protocols: []string{ProtocolHTTP}}, + }, + } + playerCtx := request.WithPlayer(ctx, model.Player{MaxBitRate: 320}) + decision, err := svc.MakeDecision(playerCtx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanDirectPlay).To(BeTrue()) + }) + }) + + Context("Format-aware default bitrate", func() { + It("uses opus default bitrate from DB", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 48000, BitDepth: 16}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "opus", AudioCodec: "opus", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(96)) // opus default from mock + }) + + It("uses aac default bitrate from DB", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + ci := &ClientInfo{ + TranscodingProfiles: []Profile{ + {Container: "aac", AudioCodec: "aac", Protocol: ProtocolHTTP}, + }, + } + decision, err := svc.MakeDecision(ctx, mf, ci, TranscodeOptions{}) + Expect(err).ToNot(HaveOccurred()) + Expect(decision.CanTranscode).To(BeTrue()) + Expect(decision.TargetBitrate).To(Equal(256)) // aac default from mock + }) + + It("falls back to 256 for unknown format", func() { + bitrate := lookupDefaultBitrate(ctx, ds, "xyz") + Expect(bitrate).To(Equal(fallbackBitrate)) + }) + }) + + }) + + Describe("ensureProbed", func() { + var mockMFRepo *tests.MockMediaFileRepo + + BeforeEach(func() { + mockMFRepo = tests.CreateMockMediaFileRepo() + ds.MockedMediaFile = mockMFRepo + }) + + It("calls ffprobe and populates ProbeData when empty", func() { + mf := &model.MediaFile{ID: "probe-1", Suffix: "mp3", BitRate: 320, Channels: 2} + mockMFRepo.SetData(model.MediaFiles{*mf}) + + ff.ProbeAudioResult = &ffmpeg.AudioProbeResult{ + Codec: "mp3", BitRate: 320, SampleRate: 44100, Channels: 2, + } + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + probe, err := svc.ensureProbed(ctx, mf) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.ProbeData).ToNot(BeEmpty()) + Expect(probe).ToNot(BeNil()) + Expect(probe.Codec).To(Equal("mp3")) + Expect(probe.BitRate).To(Equal(320)) + Expect(probe.SampleRate).To(Equal(44100)) + Expect(probe.Channels).To(Equal(2)) + + // Verify persisted to DB + stored := mockMFRepo.Data["probe-1"] + Expect(stored.ProbeData).To(Equal(mf.ProbeData)) + }) + + It("skips ffprobe when ProbeData is already set", func() { + mf := withProbe(&model.MediaFile{ID: "probe-2", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2}) + + // Set error on mock — if ffprobe were called, this would fail + ff.Error = fmt.Errorf("should not be called") + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + probe, err := svc.ensureProbed(ctx, mf) + Expect(err).ToNot(HaveOccurred()) + Expect(probe).To(BeNil()) + }) + + It("returns error when ffprobe fails", func() { + mf := &model.MediaFile{ID: "probe-3", Suffix: "mp3"} + ff.Error = fmt.Errorf("ffprobe not found") + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + _, err := svc.ensureProbed(ctx, mf) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("probing media file")) + Expect(mf.ProbeData).To(BeEmpty()) + }) + + It("skips ffprobe when DevEnableMediaFileProbe is false", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DevEnableMediaFileProbe = false + + mf := &model.MediaFile{ID: "probe-4", Suffix: "mp3"} + // Set a result — if ffprobe were called, ProbeData would be populated + ff.ProbeAudioResult = &ffmpeg.AudioProbeResult{Codec: "mp3"} + + svc := NewTranscodeDecider(ds, ff).(*deciderService) + probe, err := svc.ensureProbed(ctx, mf) + Expect(err).ToNot(HaveOccurred()) + Expect(probe).To(BeNil()) + Expect(mf.ProbeData).To(BeEmpty()) + }) + }) + +}) diff --git a/core/stream/legacy_client.go b/core/stream/legacy_client.go new file mode 100644 index 000000000..9dd6179a0 --- /dev/null +++ b/core/stream/legacy_client.go @@ -0,0 +1,113 @@ +package stream + +import ( + "context" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +// buildLegacyClientInfo translates legacy Subsonic stream/download parameters +// into a ClientInfo for use with MakeDecision. +func buildLegacyClientInfo(mf *model.MediaFile, reqFormat string, reqBitRate int) *ClientInfo { + ci := &ClientInfo{Name: "legacy"} + + // Determine target format for transcoding + var targetFormat string + switch { + case reqFormat != "": + targetFormat = reqFormat + case reqBitRate > 0 && reqBitRate < mf.BitRate && conf.Server.DefaultDownsamplingFormat != "": + targetFormat = conf.Server.DefaultDownsamplingFormat + } + + if targetFormat != "" { + // Add a direct play profile for the source format when no explicit + // format was requested (bitrate-only downsampling) or when the + // requested format matches the source. When the client explicitly + // requests a different format, direct play must not match the + // source — otherwise the source is returned untranscoded. + if reqFormat == "" || strings.EqualFold(reqFormat, mf.Suffix) { + ci.DirectPlayProfiles = []DirectPlayProfile{ + {Containers: []string{mf.Suffix}, AudioCodecs: []string{mf.AudioCodec()}, Protocols: []string{ProtocolHTTP}}, + } + } + ci.TranscodingProfiles = []Profile{ + {Container: targetFormat, AudioCodec: targetFormat, Protocol: ProtocolHTTP}, + } + if reqBitRate > 0 { + ci.MaxAudioBitrate = reqBitRate + ci.MaxTranscodingAudioBitrate = reqBitRate + } + } else { + // No transcoding requested — direct play everything + ci.DirectPlayProfiles = []DirectPlayProfile{ + {Protocols: []string{ProtocolHTTP}}, + } + } + + return ci +} + +// ResolveRequest uses MakeDecision to resolve legacy Subsonic stream parameters +// into a fully specified Request. +func (s *deciderService) ResolveRequest(ctx context.Context, mf *model.MediaFile, reqFormat string, reqBitRate int, offset int) Request { + var req Request + req.Offset = offset + + if reqFormat == "raw" { + req.Format = "raw" + return req + } + + clientInfo := buildLegacyClientInfo(mf, reqFormat, reqBitRate) + + // Apply server-side player transcoding override before making the decision + if trc, ok := request.TranscodingFrom(ctx); ok && trc.TargetFormat != "" { + clientInfo = applyServerOverride(ctx, clientInfo, &trc) + } else if player, ok := request.PlayerFrom(ctx); ok && player.MaxBitRate > 0 { + if clientInfo.MaxAudioBitrate == 0 || player.MaxBitRate < clientInfo.MaxAudioBitrate { + modified := *clientInfo + modified.MaxAudioBitrate = player.MaxBitRate + clientInfo = &modified + log.Debug(ctx, "Applied player MaxBitRate cap", "playerMaxBitRate", player.MaxBitRate, "client", clientInfo.Name) + } + } + + decision, err := s.MakeDecision(ctx, mf, clientInfo, TranscodeOptions{SkipProbe: true}) + if err != nil { + log.Error(ctx, "Error making transcode decision, falling back to raw", "id", mf.ID, err) + req.Format = "raw" + return req + } + + if decision.CanDirectPlay { + req.Format = "raw" + return req + } + + if decision.CanTranscode { + req.Format = decision.TargetFormat + req.BitRate = decision.TargetBitrate + req.SampleRate = decision.TargetSampleRate + req.BitDepth = decision.TargetBitDepth + req.Channels = decision.TargetChannels + return req + } + + // No compatible profile for the requested format — retry with DefaultDownsamplingFormat + // TODO: validate DefaultDownsamplingFormat at startup to warn about unsupported values + fallbackFormat := conf.Server.DefaultDownsamplingFormat + if reqFormat != "" && fallbackFormat != "" && !strings.EqualFold(reqFormat, fallbackFormat) { + log.Warn(ctx, "Requested format not available, falling back to default downsampling format", + "requestedFormat", reqFormat, "fallbackFormat", fallbackFormat, "id", mf.ID) + return s.ResolveRequest(ctx, mf, fallbackFormat, reqBitRate, offset) + } + + // Ultimate fallback — raw + req.Format = "raw" + return req +} diff --git a/core/stream/legacy_client_test.go b/core/stream/legacy_client_test.go new file mode 100644 index 000000000..ce7b38650 --- /dev/null +++ b/core/stream/legacy_client_test.go @@ -0,0 +1,344 @@ +package stream + +import ( + "context" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("buildLegacyClientInfo", func() { + var mf *model.MediaFile + + BeforeEach(func() { + mf = &model.MediaFile{Suffix: "flac", BitRate: 960} + }) + + It("sets transcoding profile for explicit format without bitrate", func() { + ci := buildLegacyClientInfo(mf, "mp3", 0) + + Expect(ci.Name).To(Equal("legacy")) + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("mp3")) + Expect(ci.TranscodingProfiles[0].AudioCodec).To(Equal("mp3")) + Expect(ci.TranscodingProfiles[0].Protocol).To(Equal(ProtocolHTTP)) + Expect(ci.MaxAudioBitrate).To(BeZero()) + Expect(ci.MaxTranscodingAudioBitrate).To(BeZero()) + Expect(ci.DirectPlayProfiles).To(BeEmpty()) + }) + + It("does not add direct play profile when explicit format differs from source (no bitrate)", func() { + ci := buildLegacyClientInfo(mf, "opus", 0) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("opus")) + Expect(ci.DirectPlayProfiles).To(BeEmpty()) + }) + + It("adds direct play profile when explicit format matches source format", func() { + ci := buildLegacyClientInfo(mf, "flac", 0) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("flac")) + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(Equal([]string{"flac"})) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(Equal([]string{mf.AudioCodec()})) + }) + + It("sets transcoding profile and bitrate for explicit format with bitrate", func() { + ci := buildLegacyClientInfo(mf, "mp3", 192) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("mp3")) + Expect(ci.TranscodingProfiles[0].AudioCodec).To(Equal("mp3")) + Expect(ci.MaxAudioBitrate).To(Equal(192)) + Expect(ci.MaxTranscodingAudioBitrate).To(Equal(192)) + Expect(ci.DirectPlayProfiles).To(BeEmpty()) + }) + + It("returns direct play profile when no format and no bitrate", func() { + ci := buildLegacyClientInfo(mf, "", 0) + + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].Protocols).To(Equal([]string{ProtocolHTTP})) + Expect(ci.TranscodingProfiles).To(BeEmpty()) + Expect(ci.MaxAudioBitrate).To(BeZero()) + }) + + It("uses default downsampling format for bitrate-only downsampling", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + ci := buildLegacyClientInfo(mf, "", 128) + + Expect(ci.TranscodingProfiles).To(HaveLen(1)) + Expect(ci.TranscodingProfiles[0].Container).To(Equal("opus")) + Expect(ci.TranscodingProfiles[0].AudioCodec).To(Equal("opus")) + Expect(ci.TranscodingProfiles[0].Protocol).To(Equal(ProtocolHTTP)) + Expect(ci.MaxAudioBitrate).To(Equal(128)) + Expect(ci.MaxTranscodingAudioBitrate).To(Equal(128)) + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(Equal([]string{"flac"})) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(Equal([]string{mf.AudioCodec()})) + }) + + It("returns direct play when bitrate >= source bitrate", func() { + ci := buildLegacyClientInfo(mf, "", 960) + + Expect(ci.DirectPlayProfiles).To(HaveLen(1)) + Expect(ci.DirectPlayProfiles[0].Containers).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].AudioCodecs).To(BeEmpty()) + Expect(ci.DirectPlayProfiles[0].Protocols).To(Equal([]string{ProtocolHTTP})) + Expect(ci.TranscodingProfiles).To(BeEmpty()) + Expect(ci.MaxAudioBitrate).To(BeZero()) + }) +}) + +var _ = Describe("ResolveRequest", func() { + var ( + svc TranscodeDecider + ctx context.Context + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds := &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedTranscoding: &tests.MockTranscodingRepo{}, + } + ff := tests.NewMockFFmpeg("") + auth.Init(ds) + svc = NewTranscodeDecider(ds, ff) + }) + + It("returns raw when format is 'raw'", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "raw", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("returns raw (direct play) when no format or bitrate specified", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("transcodes to requested format", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "opus", 0, 0) + + Expect(req.Format).To(Equal("opus")) + }) + + It("transcodes to requested format with bitrate limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "mp3", 128, 0) + + Expect(req.Format).To(Equal("mp3")) + Expect(req.BitRate).To(Equal(128)) + }) + + It("returns raw when requested format matches source and no bitrate reduction", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "mp3", 320, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("downsamples when only bitrate is specified below source", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "", 128, 0) + + Expect(req.Format).To(Equal("opus")) + Expect(req.BitRate).To(Equal(128)) + }) + + It("passes offset through", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "opus", 128, 30) + + Expect(req.Format).To(Equal("opus")) + Expect(req.Offset).To(Equal(30)) + }) + + Context("Server-side player transcoding override", func() { + It("forces transcoding when override targets a different format", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 192}) + overrideCtx = request.WithPlayer(overrideCtx, model.Player{MaxBitRate: 0}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(overrideCtx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("mp3")) + Expect(req.BitRate).To(Equal(192)) + }) + + It("allows direct play when source matches forced format and bitrate is within cap", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 128, Channels: 2, SampleRate: 44100}) + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 256}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(overrideCtx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("transcodes when source bitrate exceeds the forced cap", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 192}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(overrideCtx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("mp3")) + Expect(req.BitRate).To(Equal(192)) + }) + + It("uses player MaxBitRate over transcoding DefaultBitRate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 192}) + overrideCtx = request.WithPlayer(overrideCtx, model.Player{MaxBitRate: 320}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(overrideCtx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("mp3")) + Expect(req.BitRate).To(Equal(320)) + }) + + It("applies no bitrate cap when both MaxBitRate and DefaultBitRate are 0", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + overrideCtx := request.WithTranscoding(ctx, model.Transcoding{TargetFormat: "mp3", DefaultBitRate: 0}) + overrideCtx = request.WithPlayer(overrideCtx, model.Player{MaxBitRate: 0}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(overrideCtx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("mp3")) + // With no cap, lossless→lossy uses format default bitrate (160 for mp3 from mock) + Expect(req.BitRate).To(Equal(160)) + }) + + It("does not apply override when no transcoding is in context", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + }) + + Context("Player MaxBitRate cap", func() { + It("applies player MaxBitRate cap when client has no limit", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + playerCtx := request.WithPlayer(ctx, model.Player{MaxBitRate: 320}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(playerCtx, mf, "mp3", 0, 0) + + Expect(req.Format).To(Equal("mp3")) + Expect(req.BitRate).To(Equal(320)) + }) + + It("uses client limit when it is more restrictive than player MaxBitRate", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + playerCtx := request.WithPlayer(ctx, model.Player{MaxBitRate: 500}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(playerCtx, mf, "mp3", 256, 0) + + Expect(req.Format).To(Equal("mp3")) + Expect(req.BitRate).To(Equal(256)) + }) + + It("does not cap when player MaxBitRate is 0", func() { + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + playerCtx := request.WithPlayer(ctx, model.Player{MaxBitRate: 0}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(playerCtx, mf, "", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + }) + + Context("fallback for unknown format", func() { + It("falls back to DefaultDownsamplingFormat", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 0, 0) + + Expect(req.Format).To(Equal("opus")) + }) + + It("falls back to raw when DefaultDownsamplingFormat is empty", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("falls back to raw when DefaultDownsamplingFormat is also invalid", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "xyz" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 0, 0) + + Expect(req.Format).To(Equal("raw")) + }) + + It("preserves bitrate when falling back to DefaultDownsamplingFormat", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + mf := withProbe(&model.MediaFile{ID: "1", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 44100, BitDepth: 16}) + + decider := svc.(*deciderService) + req := decider.ResolveRequest(ctx, mf, "xyz", 128, 0) + + Expect(req.Format).To(Equal("opus")) + Expect(req.BitRate).To(Equal(128)) + }) + }) +}) diff --git a/core/stream/limitations.go b/core/stream/limitations.go new file mode 100644 index 000000000..ab70d6c07 --- /dev/null +++ b/core/stream/limitations.go @@ -0,0 +1,171 @@ +package stream + +import ( + "strconv" + "strings" +) + +// adjustResult represents the outcome of applying a limitation to a transcoded stream value +type adjustResult int + +const ( + adjustNone adjustResult = iota // Value already satisfies the limitation + adjustAdjusted // Value was changed to fit the limitation + adjustCannotFit // Cannot satisfy the limitation (reject this profile) +) + +// checkLimitations checks codec profile limitations against source stream details. +// Returns "" if all limitations pass, or a typed reason string for the first failure. +func checkLimitations(src *Details, limitations []Limitation) string { + for _, lim := range limitations { + var ok bool + var reason string + + switch lim.Name { + case LimitationAudioChannels: + ok = checkIntLimitation(src.Channels, lim.Comparison, lim.Values) + reason = "audio channels not supported" + case LimitationAudioSamplerate: + ok = checkIntLimitation(src.SampleRate, lim.Comparison, lim.Values) + reason = "audio samplerate not supported" + case LimitationAudioBitrate: + ok = checkIntLimitation(src.Bitrate, lim.Comparison, lim.Values) + reason = "audio bitrate not supported" + case LimitationAudioBitdepth: + ok = checkIntLimitation(src.BitDepth, lim.Comparison, lim.Values) + reason = "audio bitdepth not supported" + case LimitationAudioProfile: + ok = checkStringLimitation(src.Profile, lim.Comparison, lim.Values) + reason = "audio profile not supported" + default: + continue + } + + if !ok && lim.Required { + return reason + } + } + return "" +} + +// applyLimitation adjusts a transcoded stream parameter to satisfy the limitation. +// Returns the adjustment result. +func applyLimitation(sourceBitrate int, lim *Limitation, ts *Details) adjustResult { + switch lim.Name { + case LimitationAudioChannels: + return applyIntLimitation(lim.Comparison, lim.Values, ts.Channels, func(v int) { ts.Channels = v }) + case LimitationAudioBitrate: + current := ts.Bitrate + if current == 0 { + current = sourceBitrate + } + return applyIntLimitation(lim.Comparison, lim.Values, current, func(v int) { ts.Bitrate = v }) + case LimitationAudioSamplerate: + return applyIntLimitation(lim.Comparison, lim.Values, ts.SampleRate, func(v int) { ts.SampleRate = v }) + case LimitationAudioBitdepth: + if ts.BitDepth > 0 { + return applyIntLimitation(lim.Comparison, lim.Values, ts.BitDepth, func(v int) { ts.BitDepth = v }) + } + case LimitationAudioProfile: + // TODO: implement when audio profile data is available + } + return adjustNone +} + +// applyIntLimitation applies a limitation comparison to a value. +// If the value needs adjusting, calls the setter and returns the result. +func applyIntLimitation(comparison string, values []string, current int, setter func(int)) adjustResult { + if len(values) == 0 { + return adjustNone + } + + switch comparison { + case ComparisonLessThanEqual: + limit, ok := parseInt(values[0]) + if !ok { + return adjustNone + } + if current <= limit { + return adjustNone + } + setter(limit) + return adjustAdjusted + case ComparisonGreaterThanEqual: + limit, ok := parseInt(values[0]) + if !ok { + return adjustNone + } + if current >= limit { + return adjustNone + } + // Cannot upscale + return adjustCannotFit + case ComparisonEquals: + // Check if current value matches any allowed value + for _, v := range values { + if limit, ok := parseInt(v); ok && current == limit { + return adjustNone + } + } + // Find the closest allowed value below current (don't upscale) + var closest int + found := false + for _, v := range values { + if limit, ok := parseInt(v); ok && limit < current { + if !found || limit > closest { + closest = limit + found = true + } + } + } + if found { + setter(closest) + return adjustAdjusted + } + return adjustCannotFit + case ComparisonNotEquals: + for _, v := range values { + if limit, ok := parseInt(v); ok && current == limit { + return adjustCannotFit + } + } + return adjustNone + } + + return adjustNone +} + +func checkIntLimitation(value int, comparison string, values []string) bool { + return applyIntLimitation(comparison, values, value, func(int) {}) == adjustNone +} + +// checkStringLimitation checks a string value against a limitation. +// Only Equals and NotEquals comparisons are meaningful for strings. +// LessThanEqual/GreaterThanEqual are not applicable and always pass. +func checkStringLimitation(value string, comparison string, values []string) bool { + switch comparison { + case ComparisonEquals: + for _, v := range values { + if strings.EqualFold(value, v) { + return true + } + } + return false + case ComparisonNotEquals: + for _, v := range values { + if strings.EqualFold(value, v) { + return false + } + } + return true + } + return true +} + +func parseInt(s string) (int, bool) { + v, err := strconv.Atoi(s) + if err != nil || v < 0 { + return 0, false + } + return v, true +} diff --git a/core/stream/limiter.go b/core/stream/limiter.go new file mode 100644 index 000000000..622fe21cc --- /dev/null +++ b/core/stream/limiter.go @@ -0,0 +1,135 @@ +package stream + +import ( + "context" + "errors" + "io" + "sync" + "sync/atomic" +) + +// ErrTooManyTranscodes is returned by TranscodeLimiter.Acquire when the +// configured concurrency cap has been reached. Callers should translate this +// into an HTTP 429 response so well-behaved clients back off and retry. +var ErrTooManyTranscodes = errors.New("too many concurrent transcodes") + +// RetryAfterSeconds is the value returned in the HTTP Retry-After header when +// a request is rejected with ErrTooManyTranscodes. Most transcodes finish well +// within this window, so retrying after this delay typically succeeds. +const RetryAfterSeconds = 5 + +// TranscodeLimiter gates the number of concurrent ffmpeg transcodes. It enforces +// both a global cap (to protect the host from process exhaustion) and an optional +// per-user cap (to keep one client from starving the others). Acquire never +// blocks: it either reserves a slot or returns ErrTooManyTranscodes immediately. +type TranscodeLimiter interface { + // Acquire reserves a slot for the given user. On success it returns a release + // function that must be called exactly once when the transcode is done. + // Calling release more than once is safe and idempotent. + Acquire(ctx context.Context, user string) (release func(), err error) + + // Enabled reports whether the limiter actually enforces any cap. Callers + // can use it to decide whether to bind ffmpeg's lifetime to the request + // context so disconnects free slots quickly, rather than letting the + // process drain to completion in the background. + Enabled() bool +} + +// NewTranscodeLimiter returns a limiter enforcing the given caps. Each cap is +// independent: a value of zero or less disables that cap. When both caps are +// disabled the limiter is a no-op. +func NewTranscodeLimiter(maxConcurrent, maxPerUser int) TranscodeLimiter { + if maxConcurrent <= 0 && maxPerUser <= 0 { + return noopLimiter{} + } + l := &transcodeLimiter{maxPerUser: maxPerUser} + if maxConcurrent > 0 { + l.global = make(chan struct{}, maxConcurrent) + } + if maxPerUser > 0 { + l.perUser = make(map[string]int) + } + return l +} + +// releasingReadCloser wraps an io.ReadCloser so that closing it also releases +// the limiter slot exactly once. release must be the function returned by +// TranscodeLimiter.Acquire; its own idempotency makes double-Close safe too. +type releasingReadCloser struct { + io.ReadCloser + release func() +} + +func (r *releasingReadCloser) Close() error { + err := r.ReadCloser.Close() + r.release() + return err +} + +type noopLimiter struct{} + +func (noopLimiter) Acquire(context.Context, string) (func(), error) { + return func() {}, nil +} + +func (noopLimiter) Enabled() bool { return false } + +type transcodeLimiter struct { + maxPerUser int + global chan struct{} + + mu sync.Mutex + perUser map[string]int +} + +func (*transcodeLimiter) Enabled() bool { return true } + +func (l *transcodeLimiter) Acquire(_ context.Context, user string) (func(), error) { + // Reserve a per-user slot first so a noisy user can't burn through + // global slots only to be rejected later. An empty user key means + // "anonymous" (e.g. public share viewers); we skip the per-user cap + // entirely so unrelated anonymous clients do not share a bucket. + perUserActive := l.maxPerUser > 0 && user != "" + if perUserActive { + l.mu.Lock() + if l.perUser[user] >= l.maxPerUser { + l.mu.Unlock() + return nil, ErrTooManyTranscodes + } + l.perUser[user]++ + l.mu.Unlock() + } + + if l.global != nil { + select { + case l.global <- struct{}{}: + default: + if perUserActive { + l.releasePerUser(user) + } + return nil, ErrTooManyTranscodes + } + } + + var released atomic.Bool + return func() { + if !released.CompareAndSwap(false, true) { + return + } + if l.global != nil { + <-l.global + } + if perUserActive { + l.releasePerUser(user) + } + }, nil +} + +func (l *transcodeLimiter) releasePerUser(user string) { + l.mu.Lock() + defer l.mu.Unlock() + l.perUser[user]-- + if l.perUser[user] <= 0 { + delete(l.perUser, user) + } +} diff --git a/core/stream/limiter_test.go b/core/stream/limiter_test.go new file mode 100644 index 000000000..d278d47c8 --- /dev/null +++ b/core/stream/limiter_test.go @@ -0,0 +1,186 @@ +package stream_test + +import ( + "context" + "errors" + "sync" + + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/log" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("TranscodeLimiter", func() { + ctx := log.NewContext(context.TODO()) + + Describe("Disabled (both caps <= 0)", func() { + It("never blocks and never returns ErrTooManyTranscodes", func() { + lim := stream.NewTranscodeLimiter(0, 0) + for range 100 { + rel, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + Expect(rel).ToNot(BeNil()) + } + }) + }) + + Describe("Per-user cap only (no global cap)", func() { + It("still enforces the per-user limit when MaxConcurrent is disabled", func() { + lim := stream.NewTranscodeLimiter(0, 2) + + rel1, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + rel2, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + + _, err = lim.Acquire(ctx, "alice") + Expect(errors.Is(err, stream.ErrTooManyTranscodes)).To(BeTrue()) + + // Other users have their own buckets. + rel3, err := lim.Acquire(ctx, "bob") + Expect(err).ToNot(HaveOccurred()) + + rel1() + _, err = lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + + rel2() + rel3() + }) + }) + + Describe("Global cap", func() { + It("rejects requests beyond MaxConcurrent with ErrTooManyTranscodes", func() { + lim := stream.NewTranscodeLimiter(2, 0) + + rel1, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + rel2, err := lim.Acquire(ctx, "bob") + Expect(err).ToNot(HaveOccurred()) + + _, err = lim.Acquire(ctx, "carol") + Expect(errors.Is(err, stream.ErrTooManyTranscodes)).To(BeTrue()) + + rel1() + _, err = lim.Acquire(ctx, "carol") + Expect(err).ToNot(HaveOccurred()) + + rel2() + }) + + It("releases a slot only once even if release is called multiple times", func() { + lim := stream.NewTranscodeLimiter(1, 0) + + rel, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + + rel() + rel() + rel() + + // After releases, exactly one slot should be available. + _, err = lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + _, err = lim.Acquire(ctx, "alice") + Expect(errors.Is(err, stream.ErrTooManyTranscodes)).To(BeTrue()) + }) + }) + + Describe("Per-user cap", func() { + It("rejects a user beyond MaxConcurrentPerUser even if global slots remain", func() { + lim := stream.NewTranscodeLimiter(10, 2) + + rel1, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + rel2, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + + _, err = lim.Acquire(ctx, "alice") + Expect(errors.Is(err, stream.ErrTooManyTranscodes)).To(BeTrue()) + + // A different user is unaffected. + rel3, err := lim.Acquire(ctx, "bob") + Expect(err).ToNot(HaveOccurred()) + + rel1() + _, err = lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + + rel2() + rel3() + }) + + It("skips the per-user cap for anonymous users (empty key)", func() { + // Anonymous requests (e.g. public share viewers) deliberately + // bypass the per-user cap so unrelated anonymous clients are not + // collapsed into a single shared bucket. The global cap remains + // the only ceiling on anonymous traffic. + lim := stream.NewTranscodeLimiter(10, 1) + + rels := make([]func(), 0, 5) + for range 5 { + rel, err := lim.Acquire(ctx, "") + Expect(err).ToNot(HaveOccurred()) + rels = append(rels, rel) + } + for _, rel := range rels { + rel() + } + }) + + It("still applies the global cap to anonymous users", func() { + lim := stream.NewTranscodeLimiter(2, 1) + + rel1, err := lim.Acquire(ctx, "") + Expect(err).ToNot(HaveOccurred()) + rel2, err := lim.Acquire(ctx, "") + Expect(err).ToNot(HaveOccurred()) + + _, err = lim.Acquire(ctx, "") + Expect(errors.Is(err, stream.ErrTooManyTranscodes)).To(BeTrue()) + + rel1() + rel2() + }) + }) + + Describe("Concurrent safety", func() { + It("survives parallel Acquire/release with consistent counts", func() { + lim := stream.NewTranscodeLimiter(5, 0) + + var wg sync.WaitGroup + var acquired int64 + var rejected int64 + var mu sync.Mutex + + for i := range 50 { + wg.Add(1) + go func(i int) { + defer wg.Done() + rel, err := lim.Acquire(ctx, "alice") + mu.Lock() + if err == nil { + acquired++ + mu.Unlock() + rel() + } else { + rejected++ + mu.Unlock() + } + _ = i + }(i) + } + wg.Wait() + + Expect(acquired + rejected).To(Equal(int64(50))) + // After all releases, all 5 slots should be free again. + for range 5 { + _, err := lim.Acquire(ctx, "alice") + Expect(err).ToNot(HaveOccurred()) + } + _, err := lim.Acquire(ctx, "alice") + Expect(errors.Is(err, stream.ErrTooManyTranscodes)).To(BeTrue()) + }) + }) +}) diff --git a/core/stream/media_streamer.go b/core/stream/media_streamer.go new file mode 100644 index 000000000..b09d9bab8 --- /dev/null +++ b/core/stream/media_streamer.go @@ -0,0 +1,302 @@ +package stream + +import ( + "context" + "errors" + "fmt" + "io" + "mime" + "net/http" + "os" + "strconv" + "sync" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/utils/cache" + "github.com/navidrome/navidrome/utils/req" +) + +type MediaStreamer interface { + NewStream(ctx context.Context, mf *model.MediaFile, req Request) (*Stream, error) +} + +type TranscodingCache cache.FileCache + +func NewMediaStreamer(ds model.DataStore, t ffmpeg.FFmpeg, cache TranscodingCache) MediaStreamer { + return &mediaStreamer{ + ds: ds, + transcoder: t, + cache: cache, + limiter: NewTranscodeLimiter(conf.Server.Transcoding.MaxConcurrent, conf.Server.Transcoding.MaxConcurrentPerUser), + } +} + +type mediaStreamer struct { + ds model.DataStore + transcoder ffmpeg.FFmpeg + cache cache.FileCache + limiter TranscodeLimiter +} + +type streamJob struct { + ms *mediaStreamer + mf *model.MediaFile + filePath string + format string + bitRate int + sampleRate int + bitDepth int + channels int + offset int +} + +func (j *streamJob) Key() string { + return fmt.Sprintf("%s.%s.%d.%d.%d.%d.%s.%d", j.mf.ID, j.mf.UpdatedAt.Format(time.RFC3339Nano), j.bitRate, j.sampleRate, j.bitDepth, j.channels, j.format, j.offset) +} + +// NewStream creates a Stream for the given MediaFile and Request. It handles both raw streaming (no transcoding) +// and transcoded streaming based on the requested format and bitrate. It also logs detailed information about +// the streaming request and whether the transcoding result was served from cache or not. +func (ms *mediaStreamer) NewStream(ctx context.Context, mf *model.MediaFile, req Request) (*Stream, error) { + var format string + var bitRate int + var cached bool + defer func() { + log.Info(ctx, "Streaming file", "title", mf.Title, "artist", mf.Artist, "format", format, "cached", cached, + "bitRate", bitRate, "sampleRate", req.SampleRate, "bitDepth", req.BitDepth, "channels", req.Channels, + "user", userName(ctx), "transcoding", format != "raw", + "originalFormat", mf.Suffix, "originalBitRate", mf.BitRate) + }() + + format = req.Format + bitRate = req.BitRate + if format == "" || format == "raw" { + format = "raw" + bitRate = 0 + } + s := &Stream{ctx: ctx, mf: mf, format: format, bitRate: bitRate} + filePath := mf.AbsolutePath() + + if format == "raw" { + log.Debug(ctx, "Streaming RAW file", "id", mf.ID, "path", filePath, + "requestBitrate", req.BitRate, "requestFormat", req.Format, "requestOffset", req.Offset, + "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, + "selectedBitrate", bitRate, "selectedFormat", format) + f, err := os.Open(filePath) + if err != nil { + return nil, err + } + s.ReadCloser = f + s.Seeker = f + s.format = mf.Suffix + return s, nil + } + + job := &streamJob{ + ms: ms, + mf: mf, + filePath: filePath, + format: format, + bitRate: bitRate, + sampleRate: req.SampleRate, + bitDepth: req.BitDepth, + channels: req.Channels, + offset: req.Offset, + } + r, err := ms.cache.Get(ctx, job) + if err != nil { + // Rate-limit rejections are already logged at warn level by the + // producer; treating them as cache failures here would both + // double-log and mask actual cache problems. + if !errors.Is(err, ErrTooManyTranscodes) { + log.Error(ctx, "Error accessing transcoding cache", "id", mf.ID, err) + } + return nil, err + } + cached = r.Cached + + s.ReadCloser = r + s.Seeker = r.Seeker + + log.Debug(ctx, "Streaming TRANSCODED file", "id", mf.ID, "path", filePath, + "requestBitrate", req.BitRate, "requestFormat", req.Format, "requestOffset", req.Offset, + "originalBitrate", mf.BitRate, "originalFormat", mf.Suffix, + "selectedBitrate", bitRate, "selectedFormat", format, "cached", cached, "seekable", s.Seekable()) + + return s, nil +} + +type Stream struct { + ctx context.Context + mf *model.MediaFile + bitRate int + format string + io.ReadCloser + io.Seeker +} + +func (s *Stream) Seekable() bool { return s.Seeker != nil } +func (s *Stream) Duration() float32 { return s.mf.Duration } +func (s *Stream) ContentType() string { return mime.TypeByExtension("." + s.format) } +func (s *Stream) Name() string { return s.mf.Title + "." + s.format } +func (s *Stream) ModTime() time.Time { return s.mf.UpdatedAt } +func (s *Stream) EstimatedContentLength() int { + return int(s.mf.Duration * float32(s.bitRate) / 8 * 1024) +} + +// Serve writes the stream to the HTTP response. For seekable streams it uses http.ServeContent +// (supporting range requests). For non-seekable streams it writes directly and logs any errors. +// Returns the number of bytes written and an error only when io.Copy fails with 0 bytes written +// (meaning the HTTP 200 status has not been flushed yet and the caller can still send an error response). +// Empty output (0 bytes, no error) is logged but not treated as an error. +func (s *Stream) Serve(ctx context.Context, w http.ResponseWriter, r *http.Request) (int64, error) { + if s.Seekable() { + http.ServeContent(w, r, s.Name(), s.ModTime(), s) + return -1, nil + } + + w.Header().Set("Accept-Ranges", "none") + w.Header().Set("Content-Type", s.ContentType()) + + if req.Params(r).BoolOr("estimateContentLength", false) { + length := strconv.Itoa(s.EstimatedContentLength()) + log.Trace(ctx, "Estimated content-length", "contentLength", length) + w.Header().Set("Content-Length", length) + } + + if r.Method == http.MethodHead { + go func() { _, _ = io.Copy(io.Discard, s) }() + return 0, nil + } + + id := s.mf.ID + c, err := io.Copy(w, s) + if err != nil { + log.Error(ctx, "Error sending transcoded file", "id", id, err) + if c == 0 { + w.Header().Del("Content-Length") + return 0, fmt.Errorf("sending transcoded file: %w", err) + } + return c, nil + } + if c == 0 { + log.Error(ctx, "Transcoding returned empty output, ffmpeg may have failed. "+ + "Check that ffmpeg supports the requested codec. Enable Trace logging for ffmpeg stderr details", + "id", id, "format", s.ContentType()) + } else { + log.Trace(ctx, "Success sending transcoded file", "id", id, "size", c) + } + return c, nil +} + +// NewStream creates a non-seekable Stream from the given components. +func NewStream(mf *model.MediaFile, format string, bitRate int, r io.ReadCloser) *Stream { + return &Stream{ + ctx: context.Background(), + mf: mf, + format: format, + bitRate: bitRate, + ReadCloser: r, + } +} + +var ( + onceTranscodingCache sync.Once + instanceTranscodingCache TranscodingCache +) + +func GetTranscodingCache() TranscodingCache { + onceTranscodingCache.Do(func() { + instanceTranscodingCache = NewTranscodingCache() + }) + return instanceTranscodingCache +} + +func NewTranscodingCache() TranscodingCache { + return cache.NewFileCache("Transcoding", conf.Server.TranscodingCacheSize, + consts.TranscodingCacheDir, consts.DefaultTranscodingCacheMaxItems, + func(ctx context.Context, arg cache.Item) (io.Reader, error) { + job := arg.(*streamJob) + command := LookupTranscodeCommand(ctx, job.ms.ds, job.format) + if command == "" { + log.Error(ctx, "No transcoding command available", "format", job.format) + return nil, os.ErrInvalid + } + + release, err := job.ms.limiter.Acquire(ctx, limiterKey(ctx)) + if err != nil { + log.Warn(ctx, "Refusing transcode: concurrent transcode limit reached", + "id", job.mf.ID, "user", userName(ctx), + "maxConcurrent", conf.Server.Transcoding.MaxConcurrent, + "maxPerUser", conf.Server.Transcoding.MaxConcurrentPerUser) + return nil, err + } + + // Choose the context that drives the ffmpeg process. + // + // When the limiter is enabled, force the request context so a + // client disconnect cancels ffmpeg and frees the slot promptly. + // Otherwise a client could open many transcodes, disconnect + // immediately, and still leave the configured cap's worth of + // ffmpeg processes draining in the background — which is exactly + // the DoS the limiter is meant to prevent. + // + // When the limiter is disabled, preserve the legacy behavior + // governed by Transcoding.EnableCancellation so unchanged configs + // keep their previous observable behavior. + var transcodingCtx context.Context + if job.ms.limiter.Enabled() || conf.Server.Transcoding.EnableCancellation { + transcodingCtx = ctx + } else { + transcodingCtx = request.AddValues(context.Background(), ctx) + } + + out, err := job.ms.transcoder.Transcode(transcodingCtx, ffmpeg.TranscodeOptions{ + Command: command, + Format: job.format, + FilePath: job.filePath, + BitRate: job.bitRate, + SampleRate: job.sampleRate, + BitDepth: job.bitDepth, + Channels: job.channels, + Offset: job.offset, + }) + if err != nil { + release() + log.Error(ctx, "Error starting transcoder", "id", job.mf.ID, err) + return nil, os.ErrInvalid + } + // Tie the slot to the ffmpeg process: copyAndClose calls Close + // on this reader after io.Copy returns, which is exactly when + // ffmpeg has exited (either EOF or context cancellation). + return &releasingReadCloser{ReadCloser: out, release: release}, nil + }) +} + +// userName extracts the username from the context for logging purposes. +func userName(ctx context.Context) string { + if user, ok := request.UserFrom(ctx); !ok { + return "UNKNOWN" + } else { + return user.UserName + } +} + +// limiterKey returns the per-user bucket key used by the transcode limiter. +// For anonymous requests (e.g. public shares) it returns the empty string, +// which signals the limiter to skip the per-user cap entirely — otherwise +// every anonymous viewer of a public share would collide on the same key +// and starve each other within MaxConcurrentPerUser slots. The global cap +// still applies and remains the protection against runaway anonymous load. +func limiterKey(ctx context.Context) string { + if user, ok := request.UserFrom(ctx); ok { + return user.UserName + } + return "" +} diff --git a/core/stream/media_streamer_test.go b/core/stream/media_streamer_test.go new file mode 100644 index 000000000..f5ca16d3f --- /dev/null +++ b/core/stream/media_streamer_test.go @@ -0,0 +1,142 @@ +package stream_test + +import ( + "context" + "errors" + "io" + "os" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("MediaStreamer", func() { + var streamer stream.MediaStreamer + var ds model.DataStore + ffmpeg := tests.NewMockFFmpeg("fake data") + ctx := log.NewContext(context.TODO()) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + cacheDir, _ := os.MkdirTemp("", "file_caches") + conf.Server.CacheFolder = conf.NewDir(cacheDir) + conf.Server.TranscodingCacheSize = "100MB" + ds = &tests.MockDataStore{MockedTranscoding: &tests.MockTranscodingRepo{}} + ds.MediaFile(ctx).(*tests.MockMediaFileRepo).SetData(model.MediaFiles{ + {ID: "123", Path: "tests/fixtures/test.mp3", Suffix: "mp3", BitRate: 128, Duration: 257.0}, + }) + testCache := stream.NewTranscodingCache() + Eventually(func() bool { return testCache.Available(context.TODO()) }).Should(BeTrue()) + streamer = stream.NewMediaStreamer(ds, ffmpeg, testCache) + }) + AfterEach(func() { + _ = os.RemoveAll(conf.Server.CacheFolder.String()) + }) + + Context("NewStream", func() { + var mf *model.MediaFile + BeforeEach(func() { + var err error + mf, err = ds.MediaFile(ctx).Get("123") + Expect(err).ToNot(HaveOccurred()) + }) + It("returns a seekable stream if format is 'raw'", func() { + s, err := streamer.NewStream(ctx, mf, stream.Request{Format: "raw"}) + Expect(err).ToNot(HaveOccurred()) + Expect(s.Seekable()).To(BeTrue()) + }) + It("returns a seekable stream if no format is specified (direct play)", func() { + s, err := streamer.NewStream(ctx, mf, stream.Request{}) + Expect(err).ToNot(HaveOccurred()) + Expect(s.Seekable()).To(BeTrue()) + }) + It("returns a NON seekable stream if transcode is required", func() { + s, err := streamer.NewStream(ctx, mf, stream.Request{Format: "mp3", BitRate: 64}) + Expect(err).To(BeNil()) + Expect(s.Seekable()).To(BeFalse()) + Expect(s.Duration()).To(Equal(float32(257.0))) + }) + It("rejects transcode requests beyond MaxConcurrent with ErrTooManyTranscodes", func() { + // Use an ffmpeg whose Read blocks indefinitely so the cache's + // background copy can't drain the source and release the slot — + // keeping the single transcode slot pinned for this test. + pr, pw := io.Pipe() + DeferCleanup(func() { _ = pw.Close() }) + blockingFFmpeg := tests.NewMockFFmpeg("") + blockingFFmpeg.Reader = pr + + conf.Server.Transcoding.MaxConcurrent = 1 + conf.Server.Transcoding.MaxConcurrentPerUser = 0 + tightCache := stream.NewTranscodingCache() + Eventually(func() bool { return tightCache.Available(context.TODO()) }).Should(BeTrue()) + tightStreamer := stream.NewMediaStreamer(ds, blockingFFmpeg, tightCache) + + userCtx := request.WithUsername(ctx, "alice") + s1, err := tightStreamer.NewStream(userCtx, mf, stream.Request{Format: "mp3", BitRate: 64}) + Expect(err).ToNot(HaveOccurred()) + defer s1.Close() + + // Different cache key so it doesn't dedupe with the first request. + _, err = tightStreamer.NewStream(userCtx, mf, stream.Request{Format: "mp3", BitRate: 96}) + Expect(errors.Is(err, stream.ErrTooManyTranscodes)).To(BeTrue()) + }) + + It("releases the slot once the stream is closed", func() { + conf.Server.Transcoding.MaxConcurrent = 1 + conf.Server.Transcoding.MaxConcurrentPerUser = 0 + tightCache := stream.NewTranscodingCache() + Eventually(func() bool { return tightCache.Available(context.TODO()) }).Should(BeTrue()) + tightStreamer := stream.NewMediaStreamer(ds, ffmpeg, tightCache) + + userCtx := request.WithUsername(ctx, "alice") + s1, err := tightStreamer.NewStream(userCtx, mf, stream.Request{Format: "mp3", BitRate: 64}) + Expect(err).ToNot(HaveOccurred()) + _, _ = io.ReadAll(s1) + _ = s1.Close() + Eventually(func() bool { return ffmpeg.IsClosed() }, "3s").Should(BeTrue()) + + // Slot should now be free for a different transcode. + s2, err := tightStreamer.NewStream(userCtx, mf, stream.Request{Format: "mp3", BitRate: 96}) + Expect(err).ToNot(HaveOccurred()) + defer s2.Close() + }) + + It("does not consume a slot for raw streams", func() { + conf.Server.Transcoding.MaxConcurrent = 1 + conf.Server.Transcoding.MaxConcurrentPerUser = 0 + tightCache := stream.NewTranscodingCache() + Eventually(func() bool { return tightCache.Available(context.TODO()) }).Should(BeTrue()) + tightStreamer := stream.NewMediaStreamer(ds, ffmpeg, tightCache) + + userCtx := request.WithUsername(ctx, "alice") + // First, saturate the single transcode slot. + s1, err := tightStreamer.NewStream(userCtx, mf, stream.Request{Format: "mp3", BitRate: 64}) + Expect(err).ToNot(HaveOccurred()) + defer s1.Close() + + // Raw stream must still succeed. + s2, err := tightStreamer.NewStream(userCtx, mf, stream.Request{Format: "raw"}) + Expect(err).ToNot(HaveOccurred()) + defer s2.Close() + }) + + It("returns a seekable stream if the file is complete in the cache", func() { + s, err := streamer.NewStream(ctx, mf, stream.Request{Format: "mp3", BitRate: 32}) + Expect(err).To(BeNil()) + _, _ = io.ReadAll(s) + _ = s.Close() + Eventually(func() bool { return ffmpeg.IsClosed() }, "3s").Should(BeTrue()) + + s, err = streamer.NewStream(ctx, mf, stream.Request{Format: "mp3", BitRate: 32}) + Expect(err).To(BeNil()) + Expect(s.Seekable()).To(BeTrue()) + }) + }) +}) diff --git a/core/stream/stream_suite_test.go b/core/stream/stream_suite_test.go new file mode 100644 index 000000000..36e9e7f43 --- /dev/null +++ b/core/stream/stream_suite_test.go @@ -0,0 +1,17 @@ +package stream + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestStream(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Stream Suite") +} diff --git a/core/stream/token.go b/core/stream/token.go new file mode 100644 index 000000000..24a154b54 --- /dev/null +++ b/core/stream/token.go @@ -0,0 +1,148 @@ +package stream + +import ( + "context" + "errors" + "fmt" + "time" + + "github.com/lestrrat-go/jwx/v3/jwt" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +const tokenTTL = 48 * time.Hour + +// params contains the parameters extracted from a transcode token. +// TargetBitrate is in kilobits per second (kbps). +type params struct { + MediaID string + DirectPlay bool + TargetFormat string + TargetBitrate int + TargetChannels int + TargetSampleRate int + TargetBitDepth int + SourceUpdatedAt time.Time +} + +// toClaimsMap converts a Decision into a JWT claims map for token encoding. +// Only non-zero transcode fields are included. +func (d *TranscodeDecision) toClaimsMap() map[string]any { + m := map[string]any{ + "mid": d.MediaID, + "ua": d.SourceUpdatedAt.Truncate(time.Second).Unix(), + jwt.ExpirationKey: time.Now().Add(tokenTTL).UTC().Unix(), + } + if d.CanDirectPlay { + m["dp"] = true + } + if d.CanTranscode && d.TargetFormat != "" { + m["f"] = d.TargetFormat + if d.TargetBitrate != 0 { + m["b"] = d.TargetBitrate + } + if d.TargetChannels != 0 { + m["ch"] = d.TargetChannels + } + if d.TargetSampleRate != 0 { + m["sr"] = d.TargetSampleRate + } + if d.TargetBitDepth != 0 { + m["bd"] = d.TargetBitDepth + } + } + return m +} + +// paramsFromToken extracts and validates Params from a parsed JWT token. +// Returns an error if required claims (media ID, source timestamp) are missing. +func paramsFromToken(token jwt.Token) (*params, error) { + var p params + var mid string + if err := token.Get("mid", &mid); err == nil { + p.MediaID = mid + } + if p.MediaID == "" { + return nil, fmt.Errorf("%w: missing media ID", ErrTokenInvalid) + } + + var dp bool + if err := token.Get("dp", &dp); err == nil { + p.DirectPlay = dp + } + + ua := getIntClaim(token, "ua") + if ua != 0 { + p.SourceUpdatedAt = time.Unix(int64(ua), 0) + } + if p.SourceUpdatedAt.IsZero() { + return nil, fmt.Errorf("%w: missing source timestamp", ErrTokenInvalid) + } + + var f string + if err := token.Get("f", &f); err == nil { + p.TargetFormat = f + } + p.TargetBitrate = getIntClaim(token, "b") + p.TargetChannels = getIntClaim(token, "ch") + p.TargetSampleRate = getIntClaim(token, "sr") + p.TargetBitDepth = getIntClaim(token, "bd") + return &p, nil +} + +// getIntClaim extracts an int claim from a JWT token, handling the case where +// the value may be stored as int64 or float64 (common in JSON-based JWT libraries). +func getIntClaim(token jwt.Token, key string) int { + var v int + if err := token.Get(key, &v); err == nil { + return v + } + var v64 int64 + if err := token.Get(key, &v64); err == nil { + return int(v64) + } + var f float64 + if err := token.Get(key, &f); err == nil { + return int(f) + } + return 0 +} + +func (s *deciderService) CreateTranscodeParams(decision *TranscodeDecision) (string, error) { + return auth.EncodeToken(decision.toClaimsMap()) +} + +func (s *deciderService) parseTranscodeParams(tokenStr string) (*params, error) { + token, err := auth.DecodeAndVerifyToken(tokenStr) + if err != nil { + return nil, err + } + return paramsFromToken(token) +} + +func (s *deciderService) ResolveRequestFromToken(ctx context.Context, token string, mf *model.MediaFile, offset int) (Request, error) { + p, err := s.parseTranscodeParams(token) + if err != nil { + return Request{}, errors.Join(ErrTokenInvalid, err) + } + if p.MediaID != mf.ID { + return Request{}, fmt.Errorf("%w: token mediaID %q does not match %q", ErrTokenInvalid, p.MediaID, mf.ID) + } + if !mf.UpdatedAt.Truncate(time.Second).Equal(p.SourceUpdatedAt) { + log.Info(ctx, "Transcode token is stale", "mediaID", mf.ID, + "tokenUpdatedAt", p.SourceUpdatedAt, "fileUpdatedAt", mf.UpdatedAt) + return Request{}, ErrTokenStale + } + + req := Request{Offset: offset} + if !p.DirectPlay && p.TargetFormat != "" { + req.Format = p.TargetFormat + req.BitRate = p.TargetBitrate + req.SampleRate = p.TargetSampleRate + req.BitDepth = p.TargetBitDepth + req.Channels = p.TargetChannels + } + return req, nil +} diff --git a/core/stream/token_test.go b/core/stream/token_test.go new file mode 100644 index 000000000..7409a7532 --- /dev/null +++ b/core/stream/token_test.go @@ -0,0 +1,256 @@ +package stream + +import ( + "context" + "time" + + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Token", func() { + var ( + ds *tests.MockDataStore + ff *tests.MockFFmpeg + svc TranscodeDecider + ctx context.Context + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedTranscoding: &tests.MockTranscodingRepo{}, + } + ff = tests.NewMockFFmpeg("") + auth.Init(ds) + svc = NewTranscodeDecider(ds, ff) + }) + + Describe("Token round-trip", func() { + var ( + sourceTime time.Time + impl *deciderService + ) + + BeforeEach(func() { + sourceTime = time.Date(2025, 6, 15, 10, 30, 0, 0, time.UTC) + impl = svc.(*deciderService) + }) + + It("creates and parses a direct play token", func() { + decision := &TranscodeDecision{ + MediaID: "media-123", + CanDirectPlay: true, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + Expect(token).ToNot(BeEmpty()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-123")) + Expect(params.DirectPlay).To(BeTrue()) + Expect(params.TargetFormat).To(BeEmpty()) + Expect(params.SourceUpdatedAt.Unix()).To(Equal(sourceTime.Unix())) + }) + + It("creates and parses a transcode token with kbps bitrate", func() { + decision := &TranscodeDecision{ + MediaID: "media-456", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, // kbps + TargetChannels: 2, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-456")) + Expect(params.DirectPlay).To(BeFalse()) + Expect(params.TargetFormat).To(Equal("mp3")) + Expect(params.TargetBitrate).To(Equal(256)) // kbps + Expect(params.TargetChannels).To(Equal(2)) + Expect(params.SourceUpdatedAt.Unix()).To(Equal(sourceTime.Unix())) + }) + + It("creates and parses a transcode token with sample rate", func() { + decision := &TranscodeDecision{ + MediaID: "media-789", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "flac", + TargetBitrate: 0, + TargetChannels: 2, + TargetSampleRate: 48000, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-789")) + Expect(params.DirectPlay).To(BeFalse()) + Expect(params.TargetFormat).To(Equal("flac")) + Expect(params.TargetSampleRate).To(Equal(48000)) + Expect(params.TargetChannels).To(Equal(2)) + }) + + It("creates and parses a transcode token with bit depth", func() { + decision := &TranscodeDecision{ + MediaID: "media-bd", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "flac", + TargetBitrate: 0, + TargetChannels: 2, + TargetBitDepth: 24, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.MediaID).To(Equal("media-bd")) + Expect(params.TargetBitDepth).To(Equal(24)) + }) + + It("omits bit depth from token when 0", func() { + decision := &TranscodeDecision{ + MediaID: "media-nobd", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, + TargetBitDepth: 0, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.TargetBitDepth).To(Equal(0)) + }) + + It("omits sample rate from token when 0", func() { + decision := &TranscodeDecision{ + MediaID: "media-100", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, + TargetSampleRate: 0, + SourceUpdatedAt: sourceTime, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.TargetSampleRate).To(Equal(0)) + }) + + It("truncates SourceUpdatedAt to seconds", func() { + timeWithNanos := time.Date(2025, 6, 15, 10, 30, 0, 123456789, time.UTC) + decision := &TranscodeDecision{ + MediaID: "media-trunc", + CanDirectPlay: true, + SourceUpdatedAt: timeWithNanos, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + + params, err := impl.parseTranscodeParams(token) + Expect(err).ToNot(HaveOccurred()) + Expect(params.SourceUpdatedAt.Unix()).To(Equal(timeWithNanos.Truncate(time.Second).Unix())) + }) + + It("rejects an invalid token", func() { + _, err := impl.parseTranscodeParams("invalid-token") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("ResolveRequestFromToken", func() { + var sourceTime time.Time + + BeforeEach(func() { + sourceTime = time.Date(2025, 6, 15, 10, 30, 0, 0, time.UTC) + }) + + createTokenForMedia := func(mediaID string, updatedAt time.Time) string { + decision := &TranscodeDecision{ + MediaID: mediaID, + CanDirectPlay: true, + SourceUpdatedAt: updatedAt, + } + token, err := svc.CreateTranscodeParams(decision) + Expect(err).ToNot(HaveOccurred()) + return token + } + + It("returns stream request for valid token", func() { + mf := &model.MediaFile{ID: "song-1", UpdatedAt: sourceTime} + token := createTokenForMedia("song-1", sourceTime) + + req, err := svc.ResolveRequestFromToken(ctx, token, mf, 0) + Expect(err).ToNot(HaveOccurred()) + Expect(req.Format).To(BeEmpty()) // direct play has no target format + }) + + It("returns ErrTokenInvalid for invalid token", func() { + mf := &model.MediaFile{ID: "song-1", UpdatedAt: sourceTime} + _, err := svc.ResolveRequestFromToken(ctx, "bad-token", mf, 0) + Expect(err).To(MatchError(ContainSubstring(ErrTokenInvalid.Error()))) + }) + + It("returns ErrTokenInvalid when mediaID does not match token", func() { + mf := &model.MediaFile{ID: "song-2", UpdatedAt: sourceTime} + token := createTokenForMedia("song-1", sourceTime) + + _, err := svc.ResolveRequestFromToken(ctx, token, mf, 0) + Expect(err).To(MatchError(ContainSubstring(ErrTokenInvalid.Error()))) + }) + + It("returns ErrTokenStale when media file has changed", func() { + newTime := sourceTime.Add(1 * time.Hour) + mf := &model.MediaFile{ID: "song-1", UpdatedAt: newTime} + token := createTokenForMedia("song-1", sourceTime) + + _, err := svc.ResolveRequestFromToken(ctx, token, mf, 0) + Expect(err).To(MatchError(ErrTokenStale)) + }) + }) + + Describe("paramsFromToken", func() { + It("returns error when media ID is missing", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + token, _, err := tokenAuth.Encode(map[string]any{"ua": int64(1700000000)}) + Expect(err).NotTo(HaveOccurred()) + + _, err = paramsFromToken(token) + Expect(err).To(MatchError(ContainSubstring("missing media ID"))) + }) + + It("returns error when source timestamp is missing", func() { + tokenAuth := jwtauth.New("HS256", []byte("test-secret"), nil) + token, _, err := tokenAuth.Encode(map[string]any{"mid": "song-5"}) + Expect(err).NotTo(HaveOccurred()) + + _, err = paramsFromToken(token) + Expect(err).To(MatchError(ContainSubstring("missing source timestamp"))) + }) + }) +}) diff --git a/core/stream/types.go b/core/stream/types.go new file mode 100644 index 000000000..bd8ce292c --- /dev/null +++ b/core/stream/types.go @@ -0,0 +1,145 @@ +package stream + +import ( + "errors" + "strings" + "time" +) + +var ( + ErrTokenInvalid = errors.New("invalid or expired transcode token") + ErrTokenStale = errors.New("transcode token is stale: media file has changed") +) + +// TranscodeOptions controls optional behavior of MakeTranscodeDecision. +type TranscodeOptions struct { + // SkipProbe prevents MakeTranscodeDecision from running ffprobe on the media file. + // When true, source stream details are derived from tag metadata only. + SkipProbe bool +} + +// Request contains the resolved parameters for creating a media stream. +type Request struct { + Format string + BitRate int // kbps + SampleRate int + BitDepth int + Channels int + Offset int // seconds +} + +// ClientInfo represents client playback capabilities. +// All bitrate values are in kilobits per second (kbps) +type ClientInfo struct { + Name string + Platform string + MaxAudioBitrate int + MaxTranscodingAudioBitrate int + DirectPlayProfiles []DirectPlayProfile + TranscodingProfiles []Profile + CodecProfiles []CodecProfile +} + +// DirectPlayProfile describes a format the client can play directly +type DirectPlayProfile struct { + Containers []string + AudioCodecs []string + Protocols []string + MaxAudioChannels int +} + +func (p DirectPlayProfile) String() string { + containers := strings.Join(p.Containers, ",") + if containers == "" { + containers = "*" + } + codecs := strings.Join(p.AudioCodecs, ",") + if codecs == "" { + return "[" + containers + "]" + } + return "[" + containers + "/" + codecs + "]" +} + +// Profile describes a transcoding target the client supports +type Profile struct { + Container string + AudioCodec string + Protocol string + MaxAudioChannels int +} + +// CodecProfile describes codec-specific limitations +type CodecProfile struct { + Type string + Name string + Limitations []Limitation +} + +// Limitation describes a specific codec limitation +type Limitation struct { + Name string + Comparison string + Values []string + Required bool +} + +// Protocol values (OpenSubsonic spec enum) +const ( + ProtocolHTTP = "http" + ProtocolHLS = "hls" +) + +// Comparison operators (OpenSubsonic spec enum) +const ( + ComparisonEquals = "Equals" + ComparisonNotEquals = "NotEquals" + ComparisonLessThanEqual = "LessThanEqual" + ComparisonGreaterThanEqual = "GreaterThanEqual" +) + +// Limitation names (OpenSubsonic spec enum) +const ( + LimitationAudioChannels = "audioChannels" + LimitationAudioBitrate = "audioBitrate" + LimitationAudioProfile = "audioProfile" + LimitationAudioSamplerate = "audioSamplerate" + LimitationAudioBitdepth = "audioBitdepth" +) + +// Codec profile types (OpenSubsonic spec enum) +const ( + CodecProfileTypeAudio = "AudioCodec" +) + +// TranscodeDecision represents the internal decision result. +// All bitrate values are in kilobits per second (kbps). +type TranscodeDecision struct { + MediaID string + CanDirectPlay bool + CanTranscode bool + TranscodeReasons []string + ErrorReason string + TargetFormat string + TargetBitrate int + TargetChannels int + TargetSampleRate int + TargetBitDepth int + SourceStream Details + SourceUpdatedAt time.Time + TranscodeStream *Details +} + +// Details describes audio stream properties. +// Bitrate is in kilobits per second (kbps). +type Details struct { + Container string + Codec string + Profile string // Audio profile (e.g., "LC", "HE-AACv2"). Populated from ffprobe data. + Bitrate int + SampleRate int + BitDepth int + Channels int + Duration float32 + Size int64 + IsLossless bool +} diff --git a/core/user.go b/core/user.go new file mode 100644 index 000000000..f13e90167 --- /dev/null +++ b/core/user.go @@ -0,0 +1,76 @@ +package core + +import ( + "context" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" +) + +// PluginUnloader defines the interface for unloading disabled plugins. +// This is satisfied by plugins.Manager but defined here to avoid import cycles. +type PluginUnloader interface { + UnloadDisabledPlugins(ctx context.Context) +} + +// User provides business logic for user management with plugin coordination. +type User interface { + NewRepository(ctx context.Context) rest.Repository +} + +type userService struct { + ds model.DataStore + pluginManager PluginUnloader +} + +// NewUser creates a new User service +func NewUser(ds model.DataStore, pluginManager PluginUnloader) User { + return &userService{ + ds: ds, + pluginManager: pluginManager, + } +} + +// NewRepository returns a REST repository wrapper for user operations. +// The wrapper intercepts Delete operations to coordinate plugin unloading. +func (s *userService) NewRepository(ctx context.Context) rest.Repository { + repo := s.ds.User(ctx) + wrapper := &userRepositoryWrapper{ + ctx: ctx, + UserRepository: repo, + pluginManager: s.pluginManager, + } + return wrapper +} + +type userRepositoryWrapper struct { + model.UserRepository + ctx context.Context + pluginManager PluginUnloader +} + +// Save implements rest.Persistable by delegating to the underlying repository. +func (r *userRepositoryWrapper) Save(entity any) (string, error) { + return r.UserRepository.(rest.Persistable).Save(entity) +} + +// Update implements rest.Persistable by delegating to the underlying repository. +func (r *userRepositoryWrapper) Update(id string, entity any, cols ...string) error { + return r.UserRepository.(rest.Persistable).Update(id, entity, cols...) +} + +// Delete implements rest.Persistable and coordinates plugin unloading. +func (r *userRepositoryWrapper) Delete(id string) error { + // The underlying repository Delete handles the database cleanup + // including calling cleanupPluginUserReferences + err := r.UserRepository.(rest.Persistable).Delete(id) + if err != nil { + return err + } + + // After successful deletion, check if any plugins were auto-disabled + // and need to be unloaded from memory + r.pluginManager.UnloadDisabledPlugins(r.ctx) + + return nil +} diff --git a/core/user_test.go b/core/user_test.go new file mode 100644 index 000000000..b2d3117f8 --- /dev/null +++ b/core/user_test.go @@ -0,0 +1,86 @@ +package core_test + +import ( + "context" + "errors" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("User Service", func() { + var service core.User + var ds *tests.MockDataStore + var userRepo *tests.MockedUserRepo + var pluginManager *mockPluginUnloader + var ctx context.Context + + BeforeEach(func() { + ds = &tests.MockDataStore{} + userRepo = tests.CreateMockUserRepo() + ds.MockedUser = userRepo + pluginManager = &mockPluginUnloader{} + service = core.NewUser(ds, pluginManager) + ctx = GinkgoT().Context() + }) + + Describe("NewRepository", func() { + It("returns a rest.Persistable", func() { + repo := service.NewRepository(ctx) + _, ok := repo.(rest.Persistable) + Expect(ok).To(BeTrue()) + }) + }) + + Describe("Delete", func() { + var repo rest.Persistable + + BeforeEach(func() { + r := service.NewRepository(ctx) + repo = r.(rest.Persistable) + + // Add a test user + user := &model.User{ + ID: "user-123", + UserName: "testuser", + IsAdmin: false, + } + user.NewPassword = "password" + Expect(userRepo.Put(user)).To(Succeed()) + }) + + It("deletes the user successfully", func() { + err := repo.Delete("user-123") + Expect(err).NotTo(HaveOccurred()) + + // Verify user is deleted + _, err = userRepo.Get("user-123") + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("calls UnloadDisabledPlugins after successful deletion", func() { + err := repo.Delete("user-123") + Expect(err).NotTo(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(1)) + }) + + It("does not call UnloadDisabledPlugins when deletion fails", func() { + // Try to delete non-existent user + err := repo.Delete("non-existent") + Expect(err).To(HaveOccurred()) + Expect(pluginManager.unloadCalls).To(Equal(0)) + }) + + It("returns error when repository fails", func() { + userRepo.Error = errors.New("database error") + err := repo.Delete("user-123") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("database error")) + Expect(pluginManager.unloadCalls).To(Equal(0)) + }) + }) +}) diff --git a/core/wire_providers.go b/core/wire_providers.go index 482cfbefe..a2fffa34f 100644 --- a/core/wire_providers.go +++ b/core/wire_providers.go @@ -5,23 +5,35 @@ import ( "github.com/navidrome/navidrome/core/agents" "github.com/navidrome/navidrome/core/external" "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/core/lyrics" + "github.com/navidrome/navidrome/core/matcher" "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/stream" ) var Set = wire.NewSet( - NewMediaStreamer, - GetTranscodingCache, + stream.NewMediaStreamer, + stream.GetTranscodingCache, NewArchiver, NewPlayers, NewShare, - NewPlaylists, + playlists.NewPlaylists, + NewLibrary, + NewUser, + NewMaintenance, + NewImageUploadService, + wire.Bind(new(playlists.ImageUploadService), new(ImageUploadService)), + stream.NewTranscodeDecider, agents.GetAgents, external.NewProvider, + matcher.New, wire.Bind(new(external.Agents), new(*agents.Agents)), ffmpeg.New, scrobbler.GetPlayTracker, playback.GetInstance, metrics.GetInstance, + lyrics.NewLyrics, ) diff --git a/db/backup.go b/db/backup.go index 8b0f18b1b..806bef8e2 100644 --- a/db/backup.go +++ b/db/backup.go @@ -27,7 +27,7 @@ const backupSuffixLayout = "2006.01.02_15.04.05" func backupPath(t time.Time) string { return filepath.Join( - conf.Server.Backup.Path, + conf.Server.Backup.Path.MustPath(), fmt.Sprintf("%s_%s.db", backupPrefix, t.Format(backupSuffixLayout)), ) } @@ -81,12 +81,12 @@ func backupOrRestore(ctx context.Context, isBackup bool, path string) error { // Caution: -1 means that sqlite will hold a read lock until the operation finishes // This will lock out other writes that could happen at the same time done, err := backupOp.Step(-1) - if !done { - return fmt.Errorf("backup not done with step -1") - } if err != nil { return fmt.Errorf("error during backup step: %w", err) } + if !done { + return fmt.Errorf("backup not done with step -1") + } err = backupOp.Finish() if err != nil { @@ -117,7 +117,11 @@ func Restore(ctx context.Context, path string) error { } func Prune(ctx context.Context) (int, error) { - files, err := os.ReadDir(conf.Server.Backup.Path) + backupDir, err := conf.Server.Backup.Path.Path() + if err != nil { + return 0, fmt.Errorf("backup directory not available: %w", err) + } + files, err := os.ReadDir(backupDir) if err != nil { return 0, fmt.Errorf("unable to read database backup entries: %w", err) } diff --git a/db/backup_test.go b/db/backup_test.go index aec43446d..5e8f877e6 100644 --- a/db/backup_test.go +++ b/db/backup_test.go @@ -60,7 +60,7 @@ var _ = Describe("database backups", func() { tempFolder, err := os.MkdirTemp("", "navidrome_backup") Expect(err).ToNot(HaveOccurred()) - conf.Server.Backup.Path = tempFolder + conf.Server.Backup.Path = conf.NewDir(tempFolder) DeferCleanup(func() { _ = os.RemoveAll(tempFolder) @@ -118,7 +118,7 @@ var _ = Describe("database backups", func() { BeforeEach(func() { tempFolder, err := os.MkdirTemp("", "navidrome_backup") Expect(err).ToNot(HaveOccurred()) - conf.Server.Backup.Path = tempFolder + conf.Server.Backup.Path = conf.NewDir(tempFolder) DeferCleanup(func() { _ = os.RemoveAll(tempFolder) diff --git a/db/db.go b/db/db.go index cb1ebd9e3..168c12122 100644 --- a/db/db.go +++ b/db/db.go @@ -38,6 +38,8 @@ func Db() *sql.DB { if Path == ":memory:" { Path = "file::memory:?cache=shared&_foreign_keys=on" conf.Server.DbPath = Path + } else { + conf.Server.DataFolder.MustPath() } log.Debug("Opening DataBase", "dbPath", Path, "driver", Driver) db, err := sql.Open(Driver, Path) @@ -45,10 +47,12 @@ func Db() *sql.DB { if err != nil { log.Fatal("Error opening database", err) } - _, err = db.Exec("PRAGMA optimize=0x10002") - if err != nil { - log.Error("Error applying PRAGMA optimize", err) - return nil + if conf.Server.DevOptimizeDB { + _, err = db.Exec("PRAGMA optimize=0x10002") + if err != nil { + log.Error("Error applying PRAGMA optimize", err) + return nil + } } return db }) @@ -99,7 +103,7 @@ func Init(ctx context.Context) func() { log.Fatal(ctx, "Failed to apply new migrations", err) } - if hasSchemaChanges { + if hasSchemaChanges && conf.Server.DevOptimizeDB { log.Debug(ctx, "Applying PRAGMA optimize after schema changes") _, err = db.ExecContext(ctx, "PRAGMA optimize") if err != nil { @@ -114,6 +118,9 @@ func Init(ctx context.Context) func() { // Optimize runs PRAGMA optimize on each connection in the pool func Optimize(ctx context.Context) { + if !conf.Server.DevOptimizeDB { + return + } numConns := Db().Stats().OpenConnections if numConns == 0 { log.Debug(ctx, "No open connections to optimize") @@ -121,7 +128,7 @@ func Optimize(ctx context.Context) { } log.Debug(ctx, "Optimizing open connections", "numConns", numConns) var conns []*sql.Conn - for i := 0; i < numConns; i++ { + for range numConns { conn, err := Db().Conn(ctx) conns = append(conns, conn) if err != nil { @@ -142,8 +149,8 @@ func Optimize(ctx context.Context) { type statusLogger struct{ numPending int } -func (*statusLogger) Fatalf(format string, v ...interface{}) { log.Fatal(fmt.Sprintf(format, v...)) } -func (l *statusLogger) Printf(format string, v ...interface{}) { +func (*statusLogger) Fatalf(format string, v ...any) { log.Fatal(fmt.Sprintf(format, v...)) } +func (l *statusLogger) Printf(format string, v ...any) { if len(v) < 1 { return } @@ -178,27 +185,27 @@ type logAdapter struct { silent bool } -func (l *logAdapter) Fatal(v ...interface{}) { +func (l *logAdapter) Fatal(v ...any) { log.Fatal(l.ctx, fmt.Sprint(v...)) } -func (l *logAdapter) Fatalf(format string, v ...interface{}) { +func (l *logAdapter) Fatalf(format string, v ...any) { log.Fatal(l.ctx, fmt.Sprintf(format, v...)) } -func (l *logAdapter) Print(v ...interface{}) { +func (l *logAdapter) Print(v ...any) { if !l.silent { log.Info(l.ctx, fmt.Sprint(v...)) } } -func (l *logAdapter) Println(v ...interface{}) { +func (l *logAdapter) Println(v ...any) { if !l.silent { log.Info(l.ctx, fmt.Sprintln(v...)) } } -func (l *logAdapter) Printf(format string, v ...interface{}) { +func (l *logAdapter) Printf(format string, v ...any) { if !l.silent { log.Info(l.ctx, fmt.Sprintf(format, v...)) } diff --git a/db/migrations/20241026183640_support_new_scanner.go b/db/migrations/20241026183640_support_new_scanner.go index 251b27f63..fcbef7e4e 100644 --- a/db/migrations/20241026183640_support_new_scanner.go +++ b/db/migrations/20241026183640_support_new_scanner.go @@ -13,7 +13,7 @@ import ( "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/utils/chain" + "github.com/navidrome/navidrome/utils/run" "github.com/pressly/goose/v3" ) @@ -25,7 +25,7 @@ func upSupportNewScanner(ctx context.Context, tx *sql.Tx) error { execute := createExecuteFunc(ctx, tx) addColumn := createAddColumnFunc(ctx, tx) - return chain.RunSequentially( + return run.Sequentially( upSupportNewScanner_CreateTableFolder(ctx, execute), upSupportNewScanner_PopulateTableFolder(ctx, tx), upSupportNewScanner_UpdateTableMediaFile(ctx, execute, addColumn), @@ -213,7 +213,7 @@ update media_file set path = replace(substr(path, %d), '\', '/');`, libPathLen+2 func upSupportNewScanner_UpdateTableMediaFile(_ context.Context, execute execStmtFunc, addColumn addColumnFunc) execFunc { return func() error { - return chain.RunSequentially( + return run.Sequentially( execute(` alter table media_file add column folder_id varchar default '' not null; @@ -288,7 +288,7 @@ create index if not exists album_mbz_release_group_id func upSupportNewScanner_UpdateTableArtist(_ context.Context, execute execStmtFunc, addColumn addColumnFunc) execFunc { return func() error { - return chain.RunSequentially( + return run.Sequentially( execute(` alter table artist drop column album_count; diff --git a/db/migrations/20250611010101_playqueue_current_to_index.go b/db/migrations/20250611010101_playqueue_current_to_index.go new file mode 100644 index 000000000..d9250eba2 --- /dev/null +++ b/db/migrations/20250611010101_playqueue_current_to_index.go @@ -0,0 +1,80 @@ +package migrations + +import ( + "context" + "database/sql" + "strings" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upPlayQueueCurrentToIndex, downPlayQueueCurrentToIndex) +} + +func upPlayQueueCurrentToIndex(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, ` +create table playqueue_dg_tmp( + id varchar(255) not null, + user_id varchar(255) not null + references user(id) + on update cascade on delete cascade, + current integer not null default 0, + position real, + changed_by varchar(255), + items varchar(255), + created_at datetime, + updated_at datetime +);`) + if err != nil { + return err + } + + rows, err := tx.QueryContext(ctx, `select id, user_id, current, position, changed_by, items, created_at, updated_at from playqueue`) + if err != nil { + return err + } + defer rows.Close() + + stmt, err := tx.PrepareContext(ctx, `insert into playqueue_dg_tmp(id, user_id, current, position, changed_by, items, created_at, updated_at) values(?,?,?,?,?,?,?,?)`) + if err != nil { + return err + } + defer stmt.Close() + + for rows.Next() { + var id, userID, currentID, changedBy, items string + var position sql.NullFloat64 + var createdAt, updatedAt sql.NullString + if err = rows.Scan(&id, &userID, ¤tID, &position, &changedBy, &items, &createdAt, &updatedAt); err != nil { + return err + } + index := 0 + if currentID != "" && items != "" { + parts := strings.Split(items, ",") + for i, p := range parts { + if p == currentID { + index = i + break + } + } + } + _, err = stmt.Exec(id, userID, index, position, changedBy, items, createdAt, updatedAt) + if err != nil { + return err + } + } + if err = rows.Err(); err != nil { + return err + } + + if _, err = tx.ExecContext(ctx, `drop table playqueue;`); err != nil { + return err + } + _, err = tx.ExecContext(ctx, `alter table playqueue_dg_tmp rename to playqueue;`) + return err +} + +func downPlayQueueCurrentToIndex(ctx context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20250701010101_add_folder_hash.go b/db/migrations/20250701010101_add_folder_hash.go new file mode 100644 index 000000000..e82a0749f --- /dev/null +++ b/db/migrations/20250701010101_add_folder_hash.go @@ -0,0 +1,21 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddFolderHash, downAddFolderHash) +} + +func upAddFolderHash(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `alter table folder add column hash varchar default '' not null;`) + return err +} + +func downAddFolderHash(ctx context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20250701010102_add_annotation_user_foreign_key.sql b/db/migrations/20250701010102_add_annotation_user_foreign_key.sql new file mode 100644 index 000000000..114de2a88 --- /dev/null +++ b/db/migrations/20250701010102_add_annotation_user_foreign_key.sql @@ -0,0 +1,46 @@ +-- +goose Up +-- +goose StatementBegin +CREATE TABLE IF NOT EXISTS annotation_tmp +( + user_id varchar(255) not null + REFERENCES user(id) + ON DELETE CASCADE + ON UPDATE CASCADE, + item_id varchar(255) default '' not null, + item_type varchar(255) default '' not null, + play_count integer default 0, + play_date datetime, + rating integer default 0, + starred bool default FALSE not null, + starred_at datetime, + unique (user_id, item_id, item_type) +); + + +INSERT INTO annotation_tmp( + user_id, item_id, item_type, play_count, play_date, rating, starred, starred_at +) +SELECT user_id, item_id, item_type, play_count, play_date, rating, starred, starred_at +FROM annotation +WHERE user_id IN ( + SELECT id FROM user +); + +DROP TABLE annotation; +ALTER TABLE annotation_tmp RENAME TO annotation; + +CREATE INDEX annotation_play_count + on annotation (play_count); +CREATE INDEX annotation_play_date + on annotation (play_date); +CREATE INDEX annotation_rating + on annotation (rating); +CREATE INDEX annotation_starred + on annotation (starred); +CREATE INDEX annotation_starred_at + on annotation (starred_at); + +-- +goose StatementEnd + +-- +goose Down + diff --git a/db/migrations/20250701010103_add_library_stats.go b/db/migrations/20250701010103_add_library_stats.go new file mode 100644 index 000000000..8025229cc --- /dev/null +++ b/db/migrations/20250701010103_add_library_stats.go @@ -0,0 +1,48 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddLibraryStats, downAddLibraryStats) +} + +func upAddLibraryStats(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, ` +alter table library add column total_songs integer default 0 not null; +alter table library add column total_albums integer default 0 not null; +alter table library add column total_artists integer default 0 not null; +alter table library add column total_folders integer default 0 not null; + alter table library add column total_files integer default 0 not null; + alter table library add column total_missing_files integer default 0 not null; + alter table library add column total_size integer default 0 not null; +update library set + total_songs = ( + select count(*) from media_file where library_id = library.id and missing = 0 + ), + total_albums = (select count(*) from album where library_id = library.id and missing = 0), + total_artists = ( + select count(*) from library_artist la + join artist a on la.artist_id = a.id + where la.library_id = library.id and a.missing = 0 + ), + total_folders = (select count(*) from folder where library_id = library.id and missing = 0 and num_audio_files > 0), + total_files = ( + select ifnull(sum(num_audio_files + num_playlists + json_array_length(image_files)),0) + from folder where library_id = library.id and missing = 0 + ), + total_missing_files = ( + select count(*) from media_file where library_id = library.id and missing = 1 + ), + total_size = (select ifnull(sum(size),0) from album where library_id = library.id and missing = 0); +`) + return err +} + +func downAddLibraryStats(ctx context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20250701010104_make_replaygain_fields_nullable.go b/db/migrations/20250701010104_make_replaygain_fields_nullable.go new file mode 100644 index 000000000..163608d32 --- /dev/null +++ b/db/migrations/20250701010104_make_replaygain_fields_nullable.go @@ -0,0 +1,49 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upMakeReplaygainFieldsNullable, downMakeReplaygainFieldsNullable) +} + +func upMakeReplaygainFieldsNullable(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, ` +ALTER TABLE media_file ADD COLUMN rg_album_gain_new real; +ALTER TABLE media_file ADD COLUMN rg_album_peak_new real; +ALTER TABLE media_file ADD COLUMN rg_track_gain_new real; +ALTER TABLE media_file ADD COLUMN rg_track_peak_new real; + +UPDATE media_file SET + rg_album_gain_new = rg_album_gain, + rg_album_peak_new = rg_album_peak, + rg_track_gain_new = rg_track_gain, + rg_track_peak_new = rg_track_peak; + +ALTER TABLE media_file DROP COLUMN rg_album_gain; +ALTER TABLE media_file DROP COLUMN rg_album_peak; +ALTER TABLE media_file DROP COLUMN rg_track_gain; +ALTER TABLE media_file DROP COLUMN rg_track_peak; + +ALTER TABLE media_file RENAME COLUMN rg_album_gain_new TO rg_album_gain; +ALTER TABLE media_file RENAME COLUMN rg_album_peak_new TO rg_album_peak; +ALTER TABLE media_file RENAME COLUMN rg_track_gain_new TO rg_track_gain; +ALTER TABLE media_file RENAME COLUMN rg_track_peak_new TO rg_track_peak; + `) + + if err != nil { + return err + } + + notice(tx, "Fetching replaygain fields properly will require a full scan") + return nil +} + +func downMakeReplaygainFieldsNullable(ctx context.Context, tx *sql.Tx) error { + // This code is executed when the migration is rolled back. + return nil +} diff --git a/db/migrations/20250701010105_remove_dangling_items.sql b/db/migrations/20250701010105_remove_dangling_items.sql new file mode 100644 index 000000000..aede49b6e --- /dev/null +++ b/db/migrations/20250701010105_remove_dangling_items.sql @@ -0,0 +1,7 @@ +-- +goose Up +-- +goose StatementBegin +update media_file set missing = 1 where folder_id = ''; +update album set missing = 1 where folder_ids = '[]'; +-- +goose StatementEnd + +-- +goose Down diff --git a/db/migrations/20250701010106_add_participant_stats_to_all_artists.sql b/db/migrations/20250701010106_add_participant_stats_to_all_artists.sql new file mode 100644 index 000000000..1cd67dc32 --- /dev/null +++ b/db/migrations/20250701010106_add_participant_stats_to_all_artists.sql @@ -0,0 +1,65 @@ +-- +goose Up +-- +goose StatementBegin +WITH artist_role_counters AS ( + SELECT jt.atom AS artist_id, + substr( + replace(jt.path, '$.', ''), + 1, + CASE WHEN instr(replace(jt.path, '$.', ''), '[') > 0 + THEN instr(replace(jt.path, '$.', ''), '[') - 1 + ELSE length(replace(jt.path, '$.', '')) + END + ) AS role, + count(DISTINCT mf.album_id) AS album_count, + count(mf.id) AS count, + sum(mf.size) AS size + FROM media_file mf + JOIN json_tree(mf.participants) jt ON jt.key = 'id' AND jt.atom IS NOT NULL + GROUP BY jt.atom, role +), +artist_total_counters AS ( + SELECT mfa.artist_id, + 'total' AS role, + count(DISTINCT mf.album_id) AS album_count, + count(DISTINCT mf.id) AS count, + sum(mf.size) AS size + FROM media_file_artists mfa + JOIN media_file mf ON mfa.media_file_id = mf.id + GROUP BY mfa.artist_id +), +artist_participant_counter AS ( + SELECT mfa.artist_id, + 'maincredit' AS role, + count(DISTINCT mf.album_id) AS album_count, + count(DISTINCT mf.id) AS count, + sum(mf.size) AS size + FROM media_file_artists mfa + JOIN media_file mf ON mfa.media_file_id = mf.id + AND mfa.role IN ('albumartist', 'artist') + GROUP BY mfa.artist_id +), +combined_counters AS ( + SELECT artist_id, role, album_count, count, size FROM artist_role_counters + UNION + SELECT artist_id, role, album_count, count, size FROM artist_total_counters + UNION + SELECT artist_id, role, album_count, count, size FROM artist_participant_counter +), +artist_counters AS ( + SELECT artist_id AS id, + json_group_object( + replace(role, '"', ''), + json_object('a', album_count, 'm', count, 's', size) + ) AS counters + FROM combined_counters + GROUP BY artist_id +) +UPDATE artist +SET stats = coalesce((SELECT counters FROM artist_counters ac WHERE ac.id = artist.id), '{}'), + updated_at = datetime(current_timestamp, 'localtime') +WHERE artist.id <> ''; +-- +goose StatementEnd + +-- +goose Down +-- +goose StatementBegin +-- +goose StatementEnd diff --git a/db/migrations/20250701010107_add_mbid_indexes.sql b/db/migrations/20250701010107_add_mbid_indexes.sql new file mode 100644 index 000000000..f8a5a444b --- /dev/null +++ b/db/migrations/20250701010107_add_mbid_indexes.sql @@ -0,0 +1,27 @@ +-- +goose Up +-- +goose StatementBegin + +-- Add indexes for MBID fields to improve lookup performance +-- Artists table +create index if not exists artist_mbz_artist_id + on artist (mbz_artist_id); + +-- Albums table +create index if not exists album_mbz_album_id + on album (mbz_album_id); + +-- Media files table +create index if not exists media_file_mbz_release_track_id + on media_file (mbz_release_track_id); + +-- +goose StatementEnd + +-- +goose Down +-- +goose StatementBegin + +-- Remove MBID indexes +drop index if exists artist_mbz_artist_id; +drop index if exists album_mbz_album_id; +drop index if exists media_file_mbz_release_track_id; + +-- +goose StatementEnd diff --git a/db/migrations/20250701010108_add_multi_library_support.go b/db/migrations/20250701010108_add_multi_library_support.go new file mode 100644 index 000000000..654784d09 --- /dev/null +++ b/db/migrations/20250701010108_add_multi_library_support.go @@ -0,0 +1,119 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddMultiLibrarySupport, downAddMultiLibrarySupport) +} + +func upAddMultiLibrarySupport(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, ` + -- Create user_library association table + CREATE TABLE user_library ( + user_id VARCHAR(255) NOT NULL, + library_id INTEGER NOT NULL, + PRIMARY KEY (user_id, library_id), + FOREIGN KEY (user_id) REFERENCES user(id) ON DELETE CASCADE, + FOREIGN KEY (library_id) REFERENCES library(id) ON DELETE CASCADE + ); + -- Create indexes for performance + CREATE INDEX idx_user_library_user_id ON user_library(user_id); + CREATE INDEX idx_user_library_library_id ON user_library(library_id); + + -- Populate with existing users having access to library ID 1 (existing setup) + -- Admin users get access to all libraries, regular users get access to library 1 + INSERT INTO user_library (user_id, library_id) + SELECT u.id, 1 + FROM user u; + + -- Add total_duration column to library table + ALTER TABLE library ADD COLUMN total_duration real DEFAULT 0; + UPDATE library SET total_duration = ( + SELECT IFNULL(SUM(duration),0) from album where album.library_id = library.id and missing = 0 + ); + + -- Add default_new_users column to library table + ALTER TABLE library ADD COLUMN default_new_users boolean DEFAULT false; + -- Set library ID 1 (default library) as default for new users + UPDATE library SET default_new_users = true WHERE id = 1; + + -- Add stats column to library_artist junction table for per-library artist statistics + ALTER TABLE library_artist ADD COLUMN stats text DEFAULT '{}'; + + -- Migrate existing global artist stats to per-library format in library_artist table + -- For each library_artist association, copy the artist's global stats + UPDATE library_artist + SET stats = ( + SELECT COALESCE(artist.stats, '{}') + FROM artist + WHERE artist.id = library_artist.artist_id + ); + + -- Remove stats column from artist table to eliminate duplication + -- Stats are now stored per-library in library_artist table + ALTER TABLE artist DROP COLUMN stats; + + -- Create library_tag table for per-library tag statistics + CREATE TABLE library_tag ( + tag_id VARCHAR NOT NULL, + library_id INTEGER NOT NULL, + album_count INTEGER DEFAULT 0 NOT NULL, + media_file_count INTEGER DEFAULT 0 NOT NULL, + PRIMARY KEY (tag_id, library_id), + FOREIGN KEY (tag_id) REFERENCES tag(id) ON DELETE CASCADE, + FOREIGN KEY (library_id) REFERENCES library(id) ON DELETE CASCADE + ); + + -- Create indexes for optimal query performance + CREATE INDEX idx_library_tag_tag_id ON library_tag(tag_id); + CREATE INDEX idx_library_tag_library_id ON library_tag(library_id); + + -- Migrate existing tag stats to per-library format in library_tag table + -- For existing installations, copy current global stats to library ID 1 (default library) + INSERT INTO library_tag (tag_id, library_id, album_count, media_file_count) + SELECT t.id, 1, t.album_count, t.media_file_count + FROM tag t + WHERE EXISTS (SELECT 1 FROM library WHERE id = 1); + + -- Remove global stats from tag table as they are now per-library + ALTER TABLE tag DROP COLUMN album_count; + ALTER TABLE tag DROP COLUMN media_file_count; + `) + + return err +} + +func downAddMultiLibrarySupport(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, ` + -- Restore stats column to artist table before removing from library_artist + ALTER TABLE artist ADD COLUMN stats text DEFAULT '{}'; + + -- Restore global stats by aggregating from library_artist (simplified approach) + -- In a real rollback scenario, this might need more sophisticated logic + UPDATE artist + SET stats = ( + SELECT COALESCE(la.stats, '{}') + FROM library_artist la + WHERE la.artist_id = artist.id + LIMIT 1 + ); + + ALTER TABLE library_artist DROP COLUMN IF EXISTS stats; + DROP INDEX IF EXISTS idx_user_library_library_id; + DROP INDEX IF EXISTS idx_user_library_user_id; + DROP TABLE IF EXISTS user_library; + ALTER TABLE library DROP COLUMN IF EXISTS total_duration; + ALTER TABLE library DROP COLUMN IF EXISTS default_new_users; + + -- Drop library_tag table and its indexes + DROP INDEX IF EXISTS idx_library_tag_library_id; + DROP INDEX IF EXISTS idx_library_tag_tag_id; + DROP TABLE IF EXISTS library_tag; + `) + return err +} diff --git a/db/migrations/20250823142158_make_playqueue_position_int.sql b/db/migrations/20250823142158_make_playqueue_position_int.sql new file mode 100644 index 000000000..de20f0c79 --- /dev/null +++ b/db/migrations/20250823142158_make_playqueue_position_int.sql @@ -0,0 +1,9 @@ +-- +goose Up +-- +goose StatementBegin +ALTER TABLE playqueue ADD COLUMN position_int integer; +UPDATE playqueue SET position_int = CAST(position as INTEGER) ; +ALTER TABLE playqueue DROP COLUMN position; +ALTER TABLE playqueue RENAME COLUMN position_int TO position; +-- +goose StatementEnd + +-- +goose Down diff --git a/db/migrations/20251109010105_add_annotation_rating_date.sql b/db/migrations/20251109010105_add_annotation_rating_date.sql new file mode 100644 index 000000000..9dac46a5e --- /dev/null +++ b/db/migrations/20251109010105_add_annotation_rating_date.sql @@ -0,0 +1,7 @@ +-- +goose Up +-- +goose StatementBegin +ALTER TABLE annotation ADD COLUMN rated_at datetime; +-- +goose StatementEnd + +-- +goose Down + \ No newline at end of file diff --git a/db/migrations/20251206013022_create_scrobbles_table.sql b/db/migrations/20251206013022_create_scrobbles_table.sql new file mode 100644 index 000000000..9791c48e3 --- /dev/null +++ b/db/migrations/20251206013022_create_scrobbles_table.sql @@ -0,0 +1,20 @@ +-- +goose Up +-- +goose StatementBegin +CREATE TABLE scrobbles( + media_file_id VARCHAR(255) NOT NULL + REFERENCES media_file(id) + ON DELETE CASCADE + ON UPDATE CASCADE, + user_id VARCHAR(255) NOT NULL + REFERENCES user(id) + ON DELETE CASCADE + ON UPDATE CASCADE, + submission_time INTEGER NOT NULL +); +CREATE INDEX scrobbles_date ON scrobbles (submission_time); +-- +goose StatementEnd + +-- +goose Down +-- +goose StatementBegin +DROP TABLE scrobbles; +-- +goose StatementEnd diff --git a/db/migrations/20260104203627_playlist_case_insensitive_name.sql b/db/migrations/20260104203627_playlist_case_insensitive_name.sql new file mode 100644 index 000000000..64b079cca --- /dev/null +++ b/db/migrations/20260104203627_playlist_case_insensitive_name.sql @@ -0,0 +1,99 @@ +-- +goose Up +-- Fix case-insensitive sorting for playlist names +create table playlist_dg_tmp +( + id varchar(255) not null + primary key, + name varchar(255) collate NOCASE default '' not null, + comment varchar(255) default '' not null, + duration real default 0 not null, + song_count integer default 0 not null, + public bool default FALSE not null, + created_at datetime, + updated_at datetime, + path string default '' not null, + sync bool default false not null, + size integer default 0 not null, + rules varchar, + evaluated_at datetime, + owner_id varchar(255) not null + constraint playlist_user_user_id_fk + references user + on update cascade on delete cascade +); + +insert into playlist_dg_tmp(id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, + rules, evaluated_at, owner_id) +select id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, rules, evaluated_at, + owner_id +from playlist; + +drop table playlist; + +alter table playlist_dg_tmp + rename to playlist; + +create index playlist_name + on playlist (name); + +create index playlist_created_at + on playlist (created_at); + +create index playlist_updated_at + on playlist (updated_at); + +create index playlist_evaluated_at + on playlist (evaluated_at); + +create index playlist_size + on playlist (size); + +-- +goose Down +-- Note: Downgrade loses the collation but preserves data +create table playlist_dg_tmp +( + id varchar(255) not null + primary key, + name varchar(255) default '' not null, + comment varchar(255) default '' not null, + duration real default 0 not null, + song_count integer default 0 not null, + public bool default FALSE not null, + created_at datetime, + updated_at datetime, + path string default '' not null, + sync bool default false not null, + size integer default 0 not null, + rules varchar, + evaluated_at datetime, + owner_id varchar(255) not null + constraint playlist_user_user_id_fk + references user + on update cascade on delete cascade +); + +insert into playlist_dg_tmp(id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, + rules, evaluated_at, owner_id) +select id, name, comment, duration, song_count, public, created_at, updated_at, path, sync, size, rules, evaluated_at, + owner_id +from playlist; + +drop table playlist; + +alter table playlist_dg_tmp + rename to playlist; + +create index playlist_name + on playlist (name); + +create index playlist_created_at + on playlist (created_at); + +create index playlist_updated_at + on playlist (updated_at); + +create index playlist_evaluated_at + on playlist (evaluated_at); + +create index playlist_size + on playlist (size); diff --git a/db/migrations/20260106000620_create_plugin_table.sql b/db/migrations/20260106000620_create_plugin_table.sql new file mode 100644 index 000000000..bcc83be0b --- /dev/null +++ b/db/migrations/20260106000620_create_plugin_table.sql @@ -0,0 +1,19 @@ +-- +goose Up +CREATE TABLE IF NOT EXISTS plugin ( + id TEXT PRIMARY KEY, + path TEXT NOT NULL, + manifest JSONB NOT NULL, + config JSONB, + users JSONB, + all_users BOOL NOT NULL DEFAULT false, + libraries JSONB, + all_libraries BOOL NOT NULL DEFAULT false, + enabled BOOL NOT NULL DEFAULT false, + last_error TEXT, + sha256 TEXT NOT NULL, + created_at DATETIME NOT NULL, + updated_at DATETIME NOT NULL +); + +-- +goose Down +DROP TABLE IF EXISTS plugin; diff --git a/db/migrations/20260117201522_add_avg_rating_column.sql b/db/migrations/20260117201522_add_avg_rating_column.sql new file mode 100644 index 000000000..f5c8d4522 --- /dev/null +++ b/db/migrations/20260117201522_add_avg_rating_column.sql @@ -0,0 +1,23 @@ +-- +goose Up +ALTER TABLE album ADD COLUMN average_rating REAL NOT NULL DEFAULT 0; +ALTER TABLE media_file ADD COLUMN average_rating REAL NOT NULL DEFAULT 0; +ALTER TABLE artist ADD COLUMN average_rating REAL NOT NULL DEFAULT 0; + +-- Populate average_rating from existing ratings +UPDATE album SET average_rating = coalesce( + (SELECT round(avg(rating), 2) FROM annotation WHERE item_id = album.id AND item_type = 'album' AND rating > 0), + 0 +); +UPDATE media_file SET average_rating = coalesce( + (SELECT round(avg(rating), 2) FROM annotation WHERE item_id = media_file.id AND item_type = 'media_file' AND rating > 0), + 0 +); +UPDATE artist SET average_rating = coalesce( + (SELECT round(avg(rating), 2) FROM annotation WHERE item_id = artist.id AND item_type = 'artist' AND rating > 0), + 0 +); + +-- +goose Down +ALTER TABLE artist DROP COLUMN average_rating; +ALTER TABLE media_file DROP COLUMN average_rating; +ALTER TABLE album DROP COLUMN average_rating; diff --git a/db/migrations/20260220173400_add_fts5_search.go b/db/migrations/20260220173400_add_fts5_search.go new file mode 100644 index 000000000..dc4cd647b --- /dev/null +++ b/db/migrations/20260220173400_add_fts5_search.go @@ -0,0 +1,391 @@ +package migrations + +import ( + "context" + "database/sql" + "fmt" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddFts5Search, downAddFts5Search) +} + +// stripPunct generates a SQL expression that strips common punctuation from a column or expression. +// Used during migration to approximate the Go normalizeForFTS function for bulk-populating search_normalized. +func stripPunct(col string) string { + return fmt.Sprintf( + `REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(REPLACE(%s, '.', ''), '/', ''), '-', ''), '''', ''), '&', ''), ',', '')`, + col, + ) +} + +func upAddFts5Search(ctx context.Context, tx *sql.Tx) error { + notice(tx, "Adding FTS5 full-text search indexes. This may take a moment on large libraries.") + + // Step 1: Add search_participants and search_normalized columns to media_file, album, and artist + _, err := tx.ExecContext(ctx, `ALTER TABLE media_file ADD COLUMN search_participants TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_participants to media_file: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE media_file ADD COLUMN search_normalized TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_normalized to media_file: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE album ADD COLUMN search_participants TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_participants to album: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE album ADD COLUMN search_normalized TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_normalized to album: %w", err) + } + _, err = tx.ExecContext(ctx, `ALTER TABLE artist ADD COLUMN search_normalized TEXT NOT NULL DEFAULT ''`) + if err != nil { + return fmt.Errorf("adding search_normalized to artist: %w", err) + } + + // Step 2: Populate search_participants from participants JSON. + // Extract all "name" values from the participants JSON structure. + // participants is a JSON object like: {"artist":[{"name":"...","id":"..."}],"albumartist":[...]} + // We use json_each + json_extract to flatten all names into a space-separated string. + _, err = tx.ExecContext(ctx, ` + UPDATE media_file SET search_participants = COALESCE( + (SELECT group_concat(json_extract(je2.value, '$.name'), ' ') + FROM json_each(media_file.participants) AS je1, + json_each(je1.value) AS je2 + WHERE json_extract(je2.value, '$.name') IS NOT NULL), + '' + ) + WHERE participants IS NOT NULL AND participants != '' AND participants != '{}' + `) + if err != nil { + return fmt.Errorf("populating media_file search_participants: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + UPDATE album SET search_participants = COALESCE( + (SELECT group_concat(json_extract(je2.value, '$.name'), ' ') + FROM json_each(album.participants) AS je1, + json_each(je1.value) AS je2 + WHERE json_extract(je2.value, '$.name') IS NOT NULL), + '' + ) + WHERE participants IS NOT NULL AND participants != '' AND participants != '{}' + `) + if err != nil { + return fmt.Errorf("populating album search_participants: %w", err) + } + + // Step 2b: Populate search_normalized using SQL REPLACE chains for common punctuation. + // The Go code will compute the precise value on next scan; this is a best-effort approximation. + _, err = tx.ExecContext(ctx, fmt.Sprintf(` + UPDATE artist SET search_normalized = %s + WHERE name != %s`, + stripPunct("name"), stripPunct("name"))) + if err != nil { + return fmt.Errorf("populating artist search_normalized: %w", err) + } + + _, err = tx.ExecContext(ctx, fmt.Sprintf(` + UPDATE album SET search_normalized = TRIM(%s || ' ' || %s) + WHERE name != %s OR COALESCE(album_artist, '') != %s`, + stripPunct("name"), stripPunct("COALESCE(album_artist, '')"), + stripPunct("name"), stripPunct("COALESCE(album_artist, '')"))) + if err != nil { + return fmt.Errorf("populating album search_normalized: %w", err) + } + + _, err = tx.ExecContext(ctx, fmt.Sprintf(` + UPDATE media_file SET search_normalized = + TRIM(%s || ' ' || %s || ' ' || %s || ' ' || %s) + WHERE title != %s + OR COALESCE(album, '') != %s + OR COALESCE(artist, '') != %s + OR COALESCE(album_artist, '') != %s`, + stripPunct("title"), stripPunct("COALESCE(album, '')"), + stripPunct("COALESCE(artist, '')"), stripPunct("COALESCE(album_artist, '')"), + stripPunct("title"), stripPunct("COALESCE(album, '')"), + stripPunct("COALESCE(artist, '')"), stripPunct("COALESCE(album_artist, '')"))) + if err != nil { + return fmt.Errorf("populating media_file search_normalized: %w", err) + } + + // Step 3: Create FTS5 virtual tables + _, err = tx.ExecContext(ctx, ` + CREATE VIRTUAL TABLE IF NOT EXISTS media_file_fts USING fts5( + title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized, + content='', content_rowid='rowid', + tokenize='unicode61 remove_diacritics 2' + ) + `) + if err != nil { + return fmt.Errorf("creating media_file_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE VIRTUAL TABLE IF NOT EXISTS album_fts USING fts5( + name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized, + content='', content_rowid='rowid', + tokenize='unicode61 remove_diacritics 2' + ) + `) + if err != nil { + return fmt.Errorf("creating album_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE VIRTUAL TABLE IF NOT EXISTS artist_fts USING fts5( + name, sort_artist_name, search_normalized, + content='', content_rowid='rowid', + tokenize='unicode61 remove_diacritics 2' + ) + `) + if err != nil { + return fmt.Errorf("creating artist_fts: %w", err) + } + + // Step 4: Bulk-populate FTS5 indexes from existing data + _, err = tx.ExecContext(ctx, ` + INSERT INTO media_file_fts(rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + SELECT rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + COALESCE(disc_subtitle, ''), COALESCE(search_participants, ''), + COALESCE(search_normalized, '') + FROM media_file + `) + if err != nil { + return fmt.Errorf("populating media_file_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + INSERT INTO album_fts(rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + SELECT rowid, name, COALESCE(sort_album_name, ''), COALESCE(album_artist, ''), + COALESCE(search_participants, ''), COALESCE(discs, ''), + COALESCE(catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(album.tags, '$.albumversion') AS je), ''), + COALESCE(search_normalized, '') + FROM album + `) + if err != nil { + return fmt.Errorf("populating album_fts: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + INSERT INTO artist_fts(rowid, name, sort_artist_name, search_normalized) + SELECT rowid, name, COALESCE(sort_artist_name, ''), COALESCE(search_normalized, '') + FROM artist + `) + if err != nil { + return fmt.Errorf("populating artist_fts: %w", err) + } + + // Step 5: Create triggers for media_file + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER media_file_fts_ai AFTER INSERT ON media_file BEGIN + INSERT INTO media_file_fts(rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES (NEW.rowid, NEW.title, NEW.album, NEW.artist, NEW.album_artist, + NEW.sort_title, NEW.sort_album_name, NEW.sort_artist_name, NEW.sort_album_artist_name, + COALESCE(NEW.disc_subtitle, ''), COALESCE(NEW.search_participants, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating media_file_fts insert trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER media_file_fts_ad AFTER DELETE ON media_file BEGIN + INSERT INTO media_file_fts(media_file_fts, rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES ('delete', OLD.rowid, OLD.title, OLD.album, OLD.artist, OLD.album_artist, + OLD.sort_title, OLD.sort_album_name, OLD.sort_artist_name, OLD.sort_album_artist_name, + COALESCE(OLD.disc_subtitle, ''), COALESCE(OLD.search_participants, ''), + COALESCE(OLD.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating media_file_fts delete trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER media_file_fts_au AFTER UPDATE ON media_file + WHEN + OLD.title IS NOT NEW.title OR + OLD.album IS NOT NEW.album OR + OLD.artist IS NOT NEW.artist OR + OLD.album_artist IS NOT NEW.album_artist OR + OLD.sort_title IS NOT NEW.sort_title OR + OLD.sort_album_name IS NOT NEW.sort_album_name OR + OLD.sort_artist_name IS NOT NEW.sort_artist_name OR + OLD.sort_album_artist_name IS NOT NEW.sort_album_artist_name OR + OLD.disc_subtitle IS NOT NEW.disc_subtitle OR + OLD.search_participants IS NOT NEW.search_participants OR + OLD.search_normalized IS NOT NEW.search_normalized + BEGIN + INSERT INTO media_file_fts(media_file_fts, rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES ('delete', OLD.rowid, OLD.title, OLD.album, OLD.artist, OLD.album_artist, + OLD.sort_title, OLD.sort_album_name, OLD.sort_artist_name, OLD.sort_album_artist_name, + COALESCE(OLD.disc_subtitle, ''), COALESCE(OLD.search_participants, ''), + COALESCE(OLD.search_normalized, '')); + INSERT INTO media_file_fts(rowid, title, album, artist, album_artist, + sort_title, sort_album_name, sort_artist_name, sort_album_artist_name, + disc_subtitle, search_participants, search_normalized) + VALUES (NEW.rowid, NEW.title, NEW.album, NEW.artist, NEW.album_artist, + NEW.sort_title, NEW.sort_album_name, NEW.sort_artist_name, NEW.sort_album_artist_name, + COALESCE(NEW.disc_subtitle, ''), COALESCE(NEW.search_participants, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating media_file_fts update trigger: %w", err) + } + + // Step 6: Create triggers for album + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER album_fts_ai AFTER INSERT ON album BEGIN + INSERT INTO album_fts(rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_album_name, ''), COALESCE(NEW.album_artist, ''), + COALESCE(NEW.search_participants, ''), COALESCE(NEW.discs, ''), + COALESCE(NEW.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(NEW.tags, '$.albumversion') AS je), ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating album_fts insert trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER album_fts_ad AFTER DELETE ON album BEGIN + INSERT INTO album_fts(album_fts, rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_album_name, ''), COALESCE(OLD.album_artist, ''), + COALESCE(OLD.search_participants, ''), COALESCE(OLD.discs, ''), + COALESCE(OLD.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(OLD.tags, '$.albumversion') AS je), ''), + COALESCE(OLD.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating album_fts delete trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER album_fts_au AFTER UPDATE ON album + WHEN + OLD.name IS NOT NEW.name OR + OLD.sort_album_name IS NOT NEW.sort_album_name OR + OLD.album_artist IS NOT NEW.album_artist OR + OLD.search_participants IS NOT NEW.search_participants OR + OLD.discs IS NOT NEW.discs OR + OLD.catalog_num IS NOT NEW.catalog_num OR + OLD.tags IS NOT NEW.tags OR + OLD.search_normalized IS NOT NEW.search_normalized + BEGIN + INSERT INTO album_fts(album_fts, rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_album_name, ''), COALESCE(OLD.album_artist, ''), + COALESCE(OLD.search_participants, ''), COALESCE(OLD.discs, ''), + COALESCE(OLD.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(OLD.tags, '$.albumversion') AS je), ''), + COALESCE(OLD.search_normalized, '')); + INSERT INTO album_fts(rowid, name, sort_album_name, album_artist, + search_participants, discs, catalog_num, album_version, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_album_name, ''), COALESCE(NEW.album_artist, ''), + COALESCE(NEW.search_participants, ''), COALESCE(NEW.discs, ''), + COALESCE(NEW.catalog_num, ''), + COALESCE((SELECT group_concat(json_extract(je.value, '$.value'), ' ') + FROM json_each(NEW.tags, '$.albumversion') AS je), ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating album_fts update trigger: %w", err) + } + + // Step 7: Create triggers for artist + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER artist_fts_ai AFTER INSERT ON artist BEGIN + INSERT INTO artist_fts(rowid, name, sort_artist_name, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_artist_name, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating artist_fts insert trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER artist_fts_ad AFTER DELETE ON artist BEGIN + INSERT INTO artist_fts(artist_fts, rowid, name, sort_artist_name, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_artist_name, ''), + COALESCE(OLD.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating artist_fts delete trigger: %w", err) + } + + _, err = tx.ExecContext(ctx, ` + CREATE TRIGGER artist_fts_au AFTER UPDATE ON artist + WHEN + OLD.name IS NOT NEW.name OR + OLD.sort_artist_name IS NOT NEW.sort_artist_name OR + OLD.search_normalized IS NOT NEW.search_normalized + BEGIN + INSERT INTO artist_fts(artist_fts, rowid, name, sort_artist_name, search_normalized) + VALUES ('delete', OLD.rowid, OLD.name, COALESCE(OLD.sort_artist_name, ''), + COALESCE(OLD.search_normalized, '')); + INSERT INTO artist_fts(rowid, name, sort_artist_name, search_normalized) + VALUES (NEW.rowid, NEW.name, COALESCE(NEW.sort_artist_name, ''), + COALESCE(NEW.search_normalized, '')); + END + `) + if err != nil { + return fmt.Errorf("creating artist_fts update trigger: %w", err) + } + + return nil +} + +func downAddFts5Search(ctx context.Context, tx *sql.Tx) error { + for _, trigger := range []string{ + "media_file_fts_ai", "media_file_fts_ad", "media_file_fts_au", + "album_fts_ai", "album_fts_ad", "album_fts_au", + "artist_fts_ai", "artist_fts_ad", "artist_fts_au", + } { + _, err := tx.ExecContext(ctx, "DROP TRIGGER IF EXISTS "+trigger) + if err != nil { + return fmt.Errorf("dropping trigger %s: %w", trigger, err) + } + } + + for _, table := range []string{"media_file_fts", "album_fts", "artist_fts"} { + _, err := tx.ExecContext(ctx, "DROP TABLE IF EXISTS "+table) + if err != nil { + return fmt.Errorf("dropping table %s: %w", table, err) + } + } + + // Note: We don't drop search_participants columns because SQLite doesn't support DROP COLUMN + // on older versions, and the column is harmless if left in place. + return nil +} diff --git a/db/migrations/20260228020813_add_plugin_allow_write_access.sql b/db/migrations/20260228020813_add_plugin_allow_write_access.sql new file mode 100644 index 000000000..e17d874a5 --- /dev/null +++ b/db/migrations/20260228020813_add_plugin_allow_write_access.sql @@ -0,0 +1,5 @@ +-- +goose Up +ALTER TABLE plugin ADD COLUMN allow_write_access BOOL NOT NULL DEFAULT false; + +-- +goose Down +ALTER TABLE plugin DROP COLUMN allow_write_access; diff --git a/db/migrations/20260228172956_add_playlist_image_file.go b/db/migrations/20260228172956_add_playlist_image_file.go new file mode 100644 index 000000000..da2177aba --- /dev/null +++ b/db/migrations/20260228172956_add_playlist_image_file.go @@ -0,0 +1,22 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddPlaylistImageFile, downAddPlaylistImageFile) +} + +func upAddPlaylistImageFile(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist ADD COLUMN image_file VARCHAR(255) DEFAULT '';`) + return err +} + +func downAddPlaylistImageFile(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist DROP COLUMN image_file;`) + return err +} diff --git a/db/migrations/20260302021413_rename_playlist_image_fields.go b/db/migrations/20260302021413_rename_playlist_image_fields.go new file mode 100644 index 000000000..1e9754637 --- /dev/null +++ b/db/migrations/20260302021413_rename_playlist_image_fields.go @@ -0,0 +1,30 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upRenamePlaylistImageFields, downRenamePlaylistImageFields) +} + +func upRenamePlaylistImageFields(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist RENAME COLUMN image_file TO uploaded_image;`) + if err != nil { + return err + } + _, err = tx.ExecContext(ctx, `ALTER TABLE playlist ADD COLUMN external_image_url VARCHAR(255) DEFAULT '';`) + return err +} + +func downRenamePlaylistImageFields(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE playlist DROP COLUMN external_image_url;`) + if err != nil { + return err + } + _, err = tx.ExecContext(ctx, `ALTER TABLE playlist RENAME COLUMN uploaded_image TO image_file;`) + return err +} diff --git a/db/migrations/20260307175815_add_codec_and_update_transcodings.go b/db/migrations/20260307175815_add_codec_and_update_transcodings.go new file mode 100644 index 000000000..4e8b1b7f5 --- /dev/null +++ b/db/migrations/20260307175815_add_codec_and_update_transcodings.go @@ -0,0 +1,73 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/navidrome/navidrome/model/id" + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddCodecAndUpdateTranscodings, downAddCodecAndUpdateTranscodings) +} + +func upAddCodecAndUpdateTranscodings(_ context.Context, tx *sql.Tx) error { + // Add codec column to media_file. + _, err := tx.Exec(`ALTER TABLE media_file ADD COLUMN codec VARCHAR(255) DEFAULT '' NOT NULL`) + if err != nil { + return err + } + _, err = tx.Exec(`CREATE INDEX IF NOT EXISTS media_file_codec ON media_file(codec)`) + if err != nil { + return err + } + + // Update old AAC default (adts) to new default (ipod with fragmented MP4). + // Only affects users who still have the unmodified old default command. + _, err = tx.Exec( + `UPDATE transcoding SET command = ? WHERE target_format = 'aac' AND command = ?`, + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -", + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -", + ) + if err != nil { + return err + } + + // Add FLAC transcoding for existing installations that were seeded before FLAC was added. + var count int + err = tx.QueryRow("SELECT COUNT(*) FROM transcoding WHERE target_format = 'flac'").Scan(&count) + if err != nil { + return err + } + if count == 0 { + _, err = tx.Exec( + "INSERT INTO transcoding (id, name, target_format, default_bit_rate, command) VALUES (?, ?, ?, ?, ?)", + id.NewRandom(), "flac audio", "flac", 0, + "ffmpeg -i %s -ss %t -map 0:a:0 -v 0 -c:a flac -f flac -", + ) + if err != nil { + return err + } + } + + // Add probe_data column for caching ffprobe results. + _, err = tx.Exec(`ALTER TABLE media_file ADD COLUMN probe_data TEXT DEFAULT NULL`) + if err != nil { + return err + } + return nil +} + +func downAddCodecAndUpdateTranscodings(_ context.Context, tx *sql.Tx) error { + _, err := tx.Exec(`ALTER TABLE media_file DROP COLUMN probe_data`) + if err != nil { + return err + } + _, err = tx.Exec(`DROP INDEX IF EXISTS media_file_codec`) + if err != nil { + return err + } + _, err = tx.Exec(`ALTER TABLE media_file DROP COLUMN codec`) + return err +} diff --git a/db/migrations/20260309120007_fix_probe_data_null.go b/db/migrations/20260309120007_fix_probe_data_null.go new file mode 100644 index 000000000..a7e7366ed --- /dev/null +++ b/db/migrations/20260309120007_fix_probe_data_null.go @@ -0,0 +1,28 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upFixProbeDataNull, downFixProbeDataNull) +} + +func upFixProbeDataNull(_ context.Context, tx *sql.Tx) error { + // Recreate probe_data column as NOT NULL with empty string default. + // The previous migration created it with DEFAULT NULL, which causes + // scan errors when reading into Go string fields. + _, err := tx.Exec(`ALTER TABLE media_file DROP COLUMN probe_data`) + if err != nil { + return err + } + _, err = tx.Exec(`ALTER TABLE media_file ADD COLUMN probe_data TEXT DEFAULT '' NOT NULL`) + return err +} + +func downFixProbeDataNull(_ context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20260309203355_ensure_default_transcodings.go b/db/migrations/20260309203355_ensure_default_transcodings.go new file mode 100644 index 000000000..ab6d24952 --- /dev/null +++ b/db/migrations/20260309203355_ensure_default_transcodings.go @@ -0,0 +1,44 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model/id" + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upEnsureDefaultTranscodings, downEnsureDefaultTranscodings) +} + +func upEnsureDefaultTranscodings(_ context.Context, tx *sql.Tx) error { + // Older installations may be missing default transcodings that were added + // after the initial seeding (e.g., aac was added later than mp3/opus). + // Insert any missing defaults without touching user-customized entries. + // Check both target_format and name since both have UNIQUE constraints, + // and older entries may have a different target_format (e.g., 'oga' vs 'opus') + // but the same name. + for _, t := range consts.DefaultTranscodings { + var count int + err := tx.QueryRow("SELECT COUNT(*) FROM transcoding WHERE target_format = ? OR name = ?", t.TargetFormat, t.Name).Scan(&count) + if err != nil { + return err + } + if count == 0 { + _, err = tx.Exec( + "INSERT INTO transcoding (id, name, target_format, default_bit_rate, command) VALUES (?, ?, ?, ?, ?)", + id.NewRandom(), t.Name, t.TargetFormat, t.DefaultBitRate, t.Command, + ) + if err != nil { + return err + } + } + } + return nil +} + +func downEnsureDefaultTranscodings(_ context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20260310113858_fix_aac_transcode_command.go b/db/migrations/20260310113858_fix_aac_transcode_command.go new file mode 100644 index 000000000..588137383 --- /dev/null +++ b/db/migrations/20260310113858_fix_aac_transcode_command.go @@ -0,0 +1,30 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upFixAacTranscodeCommand, downFixAacTranscodeCommand) +} + +func upFixAacTranscodeCommand(_ context.Context, tx *sql.Tx) error { + // The old AAC command used `-f ipod -movflags frag_keyframe+empty_moov` which produces + // corrupt/silent audio when ffmpeg pipes to stdout (confirmed in ffmpeg 8.0+). + // Switch to `-f adts` (raw AAC framing) which works reliably via pipe. + // Only update rows that still have the old default command. + const oldCommand = "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -" + const newCommand = "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -" + _, err := tx.Exec( + "UPDATE transcoding SET command = ? WHERE target_format = 'aac' AND command = ?", + newCommand, oldCommand, + ) + return err +} + +func downFixAacTranscodeCommand(_ context.Context, tx *sql.Tx) error { + return nil +} diff --git a/db/migrations/20260315233131_add_artist_uploaded_image.go b/db/migrations/20260315233131_add_artist_uploaded_image.go new file mode 100644 index 000000000..964e346f5 --- /dev/null +++ b/db/migrations/20260315233131_add_artist_uploaded_image.go @@ -0,0 +1,22 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddArtistUploadedImage, downAddArtistUploadedImage) +} + +func upAddArtistUploadedImage(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE artist ADD COLUMN uploaded_image VARCHAR(255) DEFAULT ''`) + return err +} + +func downAddArtistUploadedImage(ctx context.Context, tx *sql.Tx) error { + // This code is executed when the migration is rolled back. + return nil +} diff --git a/db/migrations/20260316000000_normalize_timestamps.sql b/db/migrations/20260316000000_normalize_timestamps.sql new file mode 100644 index 000000000..a2e1183e9 --- /dev/null +++ b/db/migrations/20260316000000_normalize_timestamps.sql @@ -0,0 +1,74 @@ +-- +goose Up + +-- Normalize T-format timestamps (RFC3339Nano with 'T' separator) to SQLite-compatible format. +-- SQLite uses string comparison for ORDER BY on TEXT columns, so 'T' (ASCII 84) > ' ' (ASCII 32) +-- causes T-format timestamps to sort after space-format ones, breaking "Recently Added" ordering. + +UPDATE album SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE album SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE album SET imported_at = replace(replace(imported_at, 'T', ' '), 'Z', '+00:00') WHERE imported_at LIKE '%T%'; +UPDATE album SET external_info_updated_at = replace(replace(external_info_updated_at, 'T', ' '), 'Z', '+00:00') WHERE external_info_updated_at LIKE '%T%'; + +UPDATE media_file SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE media_file SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE media_file SET birth_time = replace(replace(birth_time, 'T', ' '), 'Z', '+00:00') WHERE birth_time LIKE '%T%'; + +UPDATE artist SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE artist SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE artist SET external_info_updated_at = replace(replace(external_info_updated_at, 'T', ' '), 'Z', '+00:00') WHERE external_info_updated_at LIKE '%T%'; + +UPDATE annotation SET play_date = replace(replace(play_date, 'T', ' '), 'Z', '+00:00') WHERE play_date LIKE '%T%'; +UPDATE annotation SET starred_at = replace(replace(starred_at, 'T', ' '), 'Z', '+00:00') WHERE starred_at LIKE '%T%'; +UPDATE annotation SET rated_at = replace(replace(rated_at, 'T', ' '), 'Z', '+00:00') WHERE rated_at LIKE '%T%'; + +UPDATE playlist SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE playlist SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE playlist SET evaluated_at = replace(replace(evaluated_at, 'T', ' '), 'Z', '+00:00') WHERE evaluated_at LIKE '%T%'; + +UPDATE user SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE user SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE user SET last_login_at = replace(replace(last_login_at, 'T', ' '), 'Z', '+00:00') WHERE last_login_at LIKE '%T%'; +UPDATE user SET last_access_at = replace(replace(last_access_at, 'T', ' '), 'Z', '+00:00') WHERE last_access_at LIKE '%T%'; + +UPDATE player SET last_seen = replace(replace(last_seen, 'T', ' '), 'Z', '+00:00') WHERE last_seen LIKE '%T%'; + +UPDATE playqueue SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE playqueue SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +UPDATE bookmark SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE bookmark SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +UPDATE share SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE share SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE share SET expires_at = replace(replace(expires_at, 'T', ' '), 'Z', '+00:00') WHERE expires_at LIKE '%T%'; +UPDATE share SET last_visited_at = replace(replace(last_visited_at, 'T', ' '), 'Z', '+00:00') WHERE last_visited_at LIKE '%T%'; + +UPDATE radio SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE radio SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +UPDATE folder SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE folder SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE folder SET images_updated_at = replace(replace(images_updated_at, 'T', ' '), 'Z', '+00:00') WHERE images_updated_at LIKE '%T%'; + +UPDATE library SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE library SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; +UPDATE library SET last_scan_at = replace(replace(last_scan_at, 'T', ' '), 'Z', '+00:00') WHERE last_scan_at LIKE '%T%'; +UPDATE library SET last_scan_started_at = replace(replace(last_scan_started_at, 'T', ' '), 'Z', '+00:00') WHERE last_scan_started_at LIKE '%T%'; + +UPDATE scrobble_buffer SET play_time = replace(replace(play_time, 'T', ' '), 'Z', '+00:00') WHERE play_time LIKE '%T%'; +UPDATE scrobble_buffer SET enqueue_time = replace(replace(enqueue_time, 'T', ' '), 'Z', '+00:00') WHERE enqueue_time LIKE '%T%'; + +UPDATE plugin SET created_at = replace(replace(created_at, 'T', ' '), 'Z', '+00:00') WHERE created_at LIKE '%T%'; +UPDATE plugin SET updated_at = replace(replace(updated_at, 'T', ' '), 'Z', '+00:00') WHERE updated_at LIKE '%T%'; + +-- Replace plain indexes with expression indexes for datetime()-based sorting +DROP INDEX IF EXISTS album_created_at; +CREATE INDEX album_created_at ON album(datetime(created_at)); +DROP INDEX IF EXISTS album_updated_at; +CREATE INDEX album_updated_at ON album(datetime(updated_at)); + +-- +goose Down +DROP INDEX IF EXISTS album_created_at; +CREATE INDEX album_created_at ON album(created_at); +DROP INDEX IF EXISTS album_updated_at; +CREATE INDEX album_updated_at ON album(updated_at); diff --git a/db/migrations/20260318182414_add_radio_uploaded_image.go b/db/migrations/20260318182414_add_radio_uploaded_image.go new file mode 100644 index 000000000..e92a6d2ef --- /dev/null +++ b/db/migrations/20260318182414_add_radio_uploaded_image.go @@ -0,0 +1,22 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upAddRadioUploadedImage, downAddRadioUploadedImage) +} + +func upAddRadioUploadedImage(ctx context.Context, tx *sql.Tx) error { + _, err := tx.ExecContext(ctx, `ALTER TABLE radio ADD COLUMN uploaded_image VARCHAR(255) NOT NULL DEFAULT ''`) + return err +} + +func downAddRadioUploadedImage(ctx context.Context, tx *sql.Tx) error { + // This code is executed when the migration is rolled back. + return nil +} diff --git a/db/migrations/20260405124200_fix_schema_inconsistencies.sql b/db/migrations/20260405124200_fix_schema_inconsistencies.sql new file mode 100644 index 000000000..15fe95308 --- /dev/null +++ b/db/migrations/20260405124200_fix_schema_inconsistencies.sql @@ -0,0 +1,55 @@ +-- +goose Up + +-- NOTE: This migration recreates two tables to fix schema inconsistencies. +-- On large production databases, the data copy may take some time as tables are locked during the transaction. +-- This is necessary because SQLite does not support altering table constraints directly. +-- Consider applying this migration during a maintenance window if the tables are large. + +-- Fix library_artist table: Remove contradictory 'default null' from 'not null' column +-- This is a cosmetic fix (NOT NULL takes precedence), but improves schema consistency +CREATE TABLE library_artist_new +( + library_id integer NOT NULL DEFAULT 1 + REFERENCES library(id) ON DELETE CASCADE, + artist_id varchar NOT NULL + REFERENCES artist(id) ON DELETE CASCADE, + stats text DEFAULT '{}', + CONSTRAINT library_artist_ux UNIQUE (library_id, artist_id) +); + +INSERT INTO library_artist_new (library_id, artist_id, stats) +SELECT library_id, artist_id, stats FROM library_artist; + +DROP TABLE library_artist; + +ALTER TABLE library_artist_new RENAME TO library_artist; + +-- Fix scrobble_buffer table: Remove duplicate user_id from unique constraint +-- Original constraint had: UNIQUE (user_id, service, media_file_id, play_time, user_id) +-- Fixed constraint is: UNIQUE (user_id, service, media_file_id, play_time) +CREATE TABLE scrobble_buffer_new +( + user_id varchar NOT NULL + CONSTRAINT scrobble_buffer_user_id_fk + REFERENCES user ON UPDATE CASCADE ON DELETE CASCADE, + service varchar NOT NULL, + media_file_id varchar NOT NULL + CONSTRAINT scrobble_buffer_media_file_id_fk + REFERENCES media_file ON UPDATE CASCADE ON DELETE CASCADE, + play_time datetime NOT NULL, + enqueue_time datetime NOT NULL DEFAULT CURRENT_TIMESTAMP, + id varchar NOT NULL DEFAULT '', + CONSTRAINT scrobble_buffer_pk UNIQUE (user_id, service, media_file_id, play_time) +); + +INSERT INTO scrobble_buffer_new (user_id, service, media_file_id, play_time, enqueue_time, id) +SELECT user_id, service, media_file_id, play_time, enqueue_time, id FROM scrobble_buffer; + +DROP TABLE scrobble_buffer; + +ALTER TABLE scrobble_buffer_new RENAME TO scrobble_buffer; + +CREATE UNIQUE INDEX scrobble_buffer_id_ix ON scrobble_buffer (id); + +-- +goose Down +-- Down migration is intentionally a no-op: Navidrome does not run down migrations. diff --git a/db/migrations/20260410201914_fix_zero_album_created_at.sql b/db/migrations/20260410201914_fix_zero_album_created_at.sql new file mode 100644 index 000000000..ff47eb95f --- /dev/null +++ b/db/migrations/20260410201914_fix_zero_album_created_at.sql @@ -0,0 +1,22 @@ +-- +goose Up + +-- Backfill album.created_at for rows poisoned by early scanner versions or +-- propagated via CopyAttributes during metadata-driven ID changes. Prefer the +-- oldest valid birth_time from the album's media files, fall back to updated_at. +UPDATE album +SET created_at = COALESCE( + (SELECT MIN(birth_time) + FROM media_file + WHERE media_file.album_id = album.id + AND birth_time IS NOT NULL + AND birth_time != '' + AND birth_time NOT LIKE '0001-%'), + updated_at +) +WHERE created_at IS NULL + OR created_at = '' + OR created_at LIKE '0001-%'; + +-- +goose Down + +SELECT 1; diff --git a/db/migrations/20260513173954_move_ss_before_input.go b/db/migrations/20260513173954_move_ss_before_input.go new file mode 100644 index 000000000..c16583aa0 --- /dev/null +++ b/db/migrations/20260513173954_move_ss_before_input.go @@ -0,0 +1,55 @@ +package migrations + +import ( + "context" + "database/sql" + + "github.com/pressly/goose/v3" +) + +func init() { + goose.AddMigrationContext(upMoveSsBeforeInput, downMoveSsBeforeInput) +} + +// ssSeekPairs maps old commands (output seeking) to new commands (input seeking). +// Index 0 = old (after -i), index 1 = new (before -i). +var ssSeekPairs = [][2]string{ + { + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -f mp3 -", + "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -f mp3 -", + }, + { + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a libopus -f opus -", + "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a libopus -f opus -", + }, + { + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -", + "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a aac -f adts -", + }, + { + "ffmpeg -i %s -ss %t -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -", + "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -", + }, + { + "ffmpeg -i %s -ss %t -map 0:a:0 -v 0 -c:a flac -f flac -", + "ffmpeg -ss %t -i %s -map 0:a:0 -v 0 -c:a flac -f flac -", + }, +} + +func upMoveSsBeforeInput(_ context.Context, tx *sql.Tx) error { + for _, p := range ssSeekPairs { + if _, err := tx.Exec(`UPDATE transcoding SET command = ? WHERE command = ?`, p[1], p[0]); err != nil { + return err + } + } + return nil +} + +func downMoveSsBeforeInput(_ context.Context, tx *sql.Tx) error { + for _, p := range ssSeekPairs { + if _, err := tx.Exec(`UPDATE transcoding SET command = ? WHERE command = ?`, p[0], p[1]); err != nil { + return err + } + } + return nil +} diff --git a/db/migrations/20260520211813_add_media_file_artists_composite_index.sql b/db/migrations/20260520211813_add_media_file_artists_composite_index.sql new file mode 100644 index 000000000..f65050d80 --- /dev/null +++ b/db/migrations/20260520211813_add_media_file_artists_composite_index.sql @@ -0,0 +1,9 @@ +-- +goose Up +CREATE INDEX IF NOT EXISTS media_file_artists_media_file_id_role + ON media_file_artists (media_file_id, role); +DROP INDEX IF EXISTS media_file_artists_media_file_id; + +-- +goose Down +CREATE INDEX IF NOT EXISTS media_file_artists_media_file_id + ON media_file_artists (media_file_id); +DROP INDEX IF EXISTS media_file_artists_media_file_id_role; diff --git a/db/migrations/migration.go b/db/migrations/migration.go index 8d8f8a91e..fde6f5817 100644 --- a/db/migrations/migration.go +++ b/db/migrations/migration.go @@ -7,6 +7,7 @@ import ( "strings" "sync" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" ) @@ -21,11 +22,13 @@ func notice(tx *sql.Tx, msg string) { // Call this in migrations that requires a full rescan func forceFullRescan(tx *sql.Tx) error { // If a full scan is required, most probably the query optimizer is outdated, so we run `analyze`. - _, err := tx.Exec(`ANALYZE;`) - if err != nil { - return err + if conf.Server.DevOptimizeDB { + _, err := tx.Exec(`ANALYZE;`) + if err != nil { + return err + } } - _, err = tx.Exec(fmt.Sprintf(` + _, err := tx.Exec(fmt.Sprintf(` INSERT OR REPLACE into property (id, value) values ('%s', '1'); `, consts.FullScanAfterMigrationFlagKey)) return err diff --git a/git/pre-commit b/git/pre-commit index 04f87994b..39ec8797f 100755 --- a/git/pre-commit +++ b/git/pre-commit @@ -12,7 +12,7 @@ gofmtcmd="go tool goimports" -gofiles=$(git diff --cached --name-only --diff-filter=ACM | grep '.go$' | grep -v '_gen.go$') +gofiles=$(git diff --cached --name-only --diff-filter=ACM | grep '.go$' | grep -v '_gen.go$' | grep -v '.pb.go$') [ -z "$gofiles" ] && exit 0 unformatted=$($gofmtcmd -l $gofiles) diff --git a/go.mod b/go.mod index 5c09c0b17..29a415126 100644 --- a/go.mod +++ b/go.mod @@ -1,129 +1,149 @@ module github.com/navidrome/navidrome -go 1.24.2 +go 1.26 -// Fork to fix https://github.com/navidrome/navidrome/pull/3254 -replace github.com/dhowden/tag v0.0.0-20240417053706-3d75831295e8 => github.com/deluan/tag v0.0.0-20241002021117-dfe5e6ea396d +// Fork to implement raw tags support +replace go.senan.xyz/taglib => github.com/deluan/go-taglib v0.0.0-20260511232939-ccd334abae3a require ( github.com/Masterminds/squirrel v1.5.4 - github.com/RaveNoX/go-jsoncommentstrip v1.0.0 github.com/andybalholm/cascadia v1.3.3 - github.com/bmatcuk/doublestar/v4 v4.8.1 - github.com/bradleyjkemp/cupaloy/v2 v2.8.0 + github.com/bmatcuk/doublestar/v4 v4.10.0 github.com/deluan/rest v0.0.0-20211102003136-6260bc399cbf github.com/deluan/sanitize v0.0.0-20241120162836-fdfd8fdfaa55 github.com/dexterlb/mpvipc v0.0.0-20241005113212-7cdefca0e933 - github.com/dhowden/tag v0.0.0-20240417053706-3d75831295e8 - github.com/disintegration/imaging v1.6.2 github.com/djherbis/atime v1.1.0 github.com/djherbis/fscache v0.10.2-0.20231127215153-442a07e326c4 github.com/djherbis/stream v1.4.0 github.com/djherbis/times v1.6.0 github.com/dustin/go-humanize v1.0.1 + github.com/extism/go-sdk v1.7.1 github.com/fatih/structs v1.1.0 - github.com/go-chi/chi/v5 v5.2.1 - github.com/go-chi/cors v1.2.1 + github.com/gen2brain/webp v0.5.5 + github.com/go-chi/chi/v5 v5.3.0 + github.com/go-chi/cors v1.2.2 github.com/go-chi/httprate v0.15.0 - github.com/go-chi/jwtauth/v5 v5.3.3 + github.com/go-chi/jwtauth/v5 v5.4.0 github.com/go-viper/encoding/ini v0.1.1 - github.com/gohugoio/hashstructure v0.5.0 + github.com/go-viper/mapstructure/v2 v2.5.0 + github.com/gohugoio/hashstructure v0.6.0 github.com/google/go-pipeline v0.0.0-20230411140531-6cbedfc1d3fc github.com/google/uuid v1.6.0 - github.com/google/wire v0.6.0 + github.com/google/wire v0.7.0 + github.com/gorilla/websocket v1.5.3 github.com/hashicorp/go-multierror v1.1.1 - github.com/jellydator/ttlcache/v3 v3.3.0 - github.com/kardianos/service v1.2.2 + github.com/jellydator/ttlcache/v3 v3.4.0 + github.com/kardianos/service v1.2.4 github.com/kr/pretty v0.3.1 - github.com/lestrrat-go/jwx/v2 v2.1.6 - github.com/matoous/go-nanoid/v2 v2.1.0 - github.com/mattn/go-sqlite3 v1.14.28 + github.com/lestrrat-go/jwx/v3 v3.1.1 + github.com/mattn/go-sqlite3 v1.14.44 github.com/microcosm-cc/bluemonday v1.0.27 github.com/mileusna/useragent v1.3.5 - github.com/onsi/ginkgo/v2 v2.23.4 - github.com/onsi/gomega v1.37.0 - github.com/pelletier/go-toml/v2 v2.2.4 - github.com/pocketbase/dbx v1.11.0 - github.com/pressly/goose/v3 v3.24.3 - github.com/prometheus/client_golang v1.22.0 + github.com/onsi/ginkgo/v2 v2.29.0 + github.com/onsi/gomega v1.41.0 + github.com/pelletier/go-toml/v2 v2.3.1 + github.com/pmezard/go-difflib v1.0.0 + github.com/pocketbase/dbx v1.12.0 + github.com/pressly/goose/v3 v3.27.1 + github.com/prometheus/client_golang v1.23.2 github.com/rjeczalik/notify v0.9.3 github.com/robfig/cron/v3 v3.0.1 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 - github.com/sirupsen/logrus v1.9.3 - github.com/spf13/cobra v1.9.1 - github.com/spf13/viper v1.20.1 - github.com/stretchr/testify v1.10.0 + github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 + github.com/sirupsen/logrus v1.9.4 + github.com/spf13/cobra v1.10.2 + github.com/spf13/viper v1.21.0 + github.com/stretchr/testify v1.11.1 + github.com/tetratelabs/wazero v1.11.1-0.20260428013916-2bbd517b7633 github.com/unrolled/secure v1.17.0 - github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 + github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 + go.senan.xyz/taglib v0.11.1 go.uber.org/goleak v1.3.0 - golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 - golang.org/x/image v0.27.0 - golang.org/x/net v0.40.0 - golang.org/x/sync v0.14.0 - golang.org/x/sys v0.33.0 - golang.org/x/text v0.25.0 - golang.org/x/time v0.11.0 + golang.org/x/image v0.41.0 + golang.org/x/net v0.55.0 + golang.org/x/sync v0.20.0 + golang.org/x/sys v0.45.0 + golang.org/x/term v0.43.0 + golang.org/x/text v0.37.0 + golang.org/x/time v0.15.0 gopkg.in/yaml.v3 v3.0.1 ) require ( + dario.cat/mergo v1.0.2 // indirect + github.com/Masterminds/semver/v3 v3.5.0 // indirect + github.com/atombender/go-jsonschema v0.20.0 // indirect github.com/aymerick/douceur v0.2.0 // indirect github.com/beorn7/perks v1.0.1 // indirect github.com/cespare/reflex v0.3.1 // indirect github.com/cespare/xxhash/v2 v2.3.0 // indirect - github.com/creack/pty v1.1.11 // indirect + github.com/creack/pty v1.1.24 // indirect github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect - github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 // indirect - github.com/fsnotify/fsnotify v1.9.0 // indirect - github.com/go-logr/logr v1.4.2 // indirect + github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.1 // indirect + github.com/dylibso/observe-sdk/go v0.0.0-20240828172851-9145d8ad07e1 // indirect + github.com/ebitengine/purego v0.10.1 // indirect + github.com/fsnotify/fsnotify v1.10.1 // indirect + github.com/go-logr/logr v1.4.3 // indirect github.com/go-task/slim-sprig/v3 v3.0.0 // indirect - github.com/go-viper/mapstructure/v2 v2.2.1 // indirect - github.com/goccy/go-json v0.10.5 // indirect + github.com/gobwas/glob v0.2.3 // indirect + github.com/goccy/go-json v0.10.6 // indirect + github.com/goccy/go-yaml v1.19.2 // indirect github.com/google/go-cmp v0.7.0 // indirect - github.com/google/pprof v0.0.0-20250501235452-c0086092b71a // indirect + github.com/google/pprof v0.0.0-20260507013755-92041b743c96 // indirect github.com/google/subcommands v1.2.0 // indirect github.com/gorilla/css v1.0.1 // indirect github.com/hashicorp/errwrap v1.1.0 // indirect + github.com/ianlancetaylor/demangle v0.0.0-20260505044615-1ff4bf46051f // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 // indirect - github.com/klauspost/cpuid/v2 v2.2.10 // indirect + github.com/klauspost/cpuid/v2 v2.3.0 // indirect github.com/kr/text v0.2.0 // indirect github.com/lann/builder v0.0.0-20180802200727-47ae307949d0 // indirect github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0 // indirect - github.com/lestrrat-go/blackmagic v1.0.3 // indirect + github.com/lestrrat-go/blackmagic v1.0.4 // indirect + github.com/lestrrat-go/dsig v1.3.0 // indirect + github.com/lestrrat-go/dsig-secp256k1 v1.0.0 // indirect github.com/lestrrat-go/httpcc v1.0.1 // indirect - github.com/lestrrat-go/httprc v1.0.6 // indirect - github.com/lestrrat-go/iter v1.0.2 // indirect - github.com/lestrrat-go/option v1.0.1 // indirect + github.com/lestrrat-go/httprc/v3 v3.0.5 // indirect + github.com/lestrrat-go/option/v2 v2.0.0 // indirect + github.com/maruel/natural v1.3.0 // indirect github.com/mfridman/interpolate v0.0.2 // indirect + github.com/mitchellh/go-wordwrap v1.0.1 // indirect github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect github.com/ogier/pflag v0.0.1 // indirect - github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect - github.com/prometheus/client_model v0.6.1 // indirect - github.com/prometheus/common v0.62.0 // indirect - github.com/prometheus/procfs v0.16.1 // indirect - github.com/rogpeppe/go-internal v1.14.1 // indirect - github.com/sagikazarmark/locafero v0.9.0 // indirect - github.com/segmentio/asm v1.2.0 // indirect + github.com/pkg/errors v0.9.1 // indirect + github.com/prometheus/client_model v0.6.2 // indirect + github.com/prometheus/common v0.67.5 // indirect + github.com/prometheus/procfs v0.20.1 // indirect + github.com/rogpeppe/go-internal v1.15.0 // indirect + github.com/sagikazarmark/locafero v0.12.0 // indirect + github.com/sanity-io/litter v1.5.8 // indirect + github.com/segmentio/asm v1.2.1 // indirect github.com/sethvargo/go-retry v0.3.0 // indirect - github.com/sourcegraph/conc v0.3.0 // indirect - github.com/spf13/afero v1.14.0 // indirect - github.com/spf13/cast v1.8.0 // indirect - github.com/spf13/pflag v1.0.6 // indirect - github.com/stretchr/objx v0.5.2 // indirect + github.com/sosodev/duration v1.3.1 // indirect + github.com/spf13/afero v1.15.0 // indirect + github.com/spf13/cast v1.10.0 // indirect + github.com/spf13/pflag v1.0.10 // indirect + github.com/stretchr/objx v0.5.3 // indirect github.com/subosito/gotenv v1.6.0 // indirect - github.com/zeebo/xxh3 v1.0.2 // indirect - go.uber.org/automaxprocs v1.6.0 // indirect + github.com/tetratelabs/wabin v0.0.0-20230304001439-f6f874872834 // indirect + github.com/valyala/fastjson v1.6.10 // indirect + github.com/zeebo/xxh3 v1.1.0 // indirect + go.opentelemetry.io/proto/otlp v1.10.0 // indirect go.uber.org/multierr v1.11.0 // indirect - golang.org/x/crypto v0.38.0 // indirect - golang.org/x/mod v0.24.0 // indirect - golang.org/x/tools v0.33.0 // indirect - google.golang.org/protobuf v1.36.6 // indirect - gopkg.in/ini.v1 v1.67.0 // indirect + go.yaml.in/yaml/v2 v2.4.3 // indirect + go.yaml.in/yaml/v3 v3.0.4 // indirect + golang.org/x/crypto v0.52.0 // indirect + golang.org/x/mod v0.36.0 // indirect + golang.org/x/telemetry v0.0.0-20260508192327-42602be52be6 // indirect + golang.org/x/tools v0.45.0 // indirect + google.golang.org/protobuf v1.36.11 // indirect + gopkg.in/ini.v1 v1.67.2 // indirect gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect ) tool ( + github.com/atombender/go-jsonschema github.com/cespare/reflex github.com/google/wire/cmd/wire github.com/onsi/ginkgo/v2/ginkgo diff --git a/go.sum b/go.sum index d8a1a8c45..57289abfd 100644 --- a/go.sum +++ b/go.sum @@ -1,43 +1,45 @@ -filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= -filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= +dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8= +dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA= +filippo.io/edwards25519 v1.2.0 h1:crnVqOiS4jqYleHd9vaKZ+HKtHfllngJIiOpNpoJsjo= +filippo.io/edwards25519 v1.2.0/go.mod h1:xzAOLCNug/yB62zG1bQ8uziwrIqIuxhctzJT18Q77mc= +github.com/Masterminds/semver/v3 v3.5.0 h1:kQceYJfbupGfZOKZQg0kou0DgAKhzDg2NZPAwZ/2OOE= +github.com/Masterminds/semver/v3 v3.5.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM= github.com/Masterminds/squirrel v1.5.4 h1:uUcX/aBc8O7Fg9kaISIUsHXdKuqehiXAMQTYX8afzqM= github.com/Masterminds/squirrel v1.5.4/go.mod h1:NNaOrjSoIDfDA40n7sr2tPNZRfjzjA400rg+riTZj10= -github.com/RaveNoX/go-jsoncommentstrip v1.0.0 h1:t527LHHE3HmiHrq74QMpNPZpGCIJzTx+apLkMKt4HC0= -github.com/RaveNoX/go-jsoncommentstrip v1.0.0/go.mod h1:78ihd09MekBnJnxpICcwzCMzGrKSKYe4AqU6PDYYpjk= github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= +github.com/atombender/go-jsonschema v0.20.0 h1:AHg0LeI0HcjQ686ALwUNqVJjNRcSXpIR6U+wC2J0aFY= +github.com/atombender/go-jsonschema v0.20.0/go.mod h1:ZmbuR11v2+cMM0PdP6ySxtyZEGFBmhgF4xa4J6Hdls8= github.com/aymerick/douceur v0.2.0 h1:Mv+mAeH1Q+n9Fr+oyamOlAkUNPWPlA8PPGR0QAaYuPk= github.com/aymerick/douceur v0.2.0/go.mod h1:wlT5vV2O3h55X9m7iVYN0TBM0NH/MmbLnd30/FjWUq4= github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM= github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw= -github.com/bmatcuk/doublestar/v4 v4.8.1 h1:54Bopc5c2cAvhLRAzqOGCYHYyhcDHsFF4wWIR5wKP38= -github.com/bmatcuk/doublestar/v4 v4.8.1/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc= -github.com/bradleyjkemp/cupaloy/v2 v2.8.0 h1:any4BmKE+jGIaMpnU8YgH/I2LPiLBufr6oMMlVBbn9M= -github.com/bradleyjkemp/cupaloy/v2 v2.8.0/go.mod h1:bm7JXdkRd4BHJk9HpwqAI8BoAY1lps46Enkdqw6aRX0= +github.com/bmatcuk/doublestar/v4 v4.10.0 h1:zU9WiOla1YA122oLM6i4EXvGW62DvKZVxIe6TYWexEs= +github.com/bmatcuk/doublestar/v4 v4.10.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc= github.com/cespare/reflex v0.3.1 h1:N4Y/UmRrjwOkNT0oQQnYsdr6YBxvHqtSfPB4mqOyAKk= github.com/cespare/reflex v0.3.1/go.mod h1:I+0Pnu2W693i7Hv6ZZG76qHTY0mgUa7uCIfCtikXojE= github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= -github.com/creack/pty v1.1.11 h1:07n33Z8lZxZ2qwegKbObQohDhXDQxiMMz1NOUGYlesw= github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= +github.com/creack/pty v1.1.24 h1:bJrF4RRfyJnbTJqzRLHzcGaZK1NeM5kTC9jGgovnR1s= +github.com/creack/pty v1.1.24/go.mod h1:08sCNb52WyoAwi2QDyzUCTgcvVFhUzewun7wtTfvcwE= +github.com/davecgh/go-spew v0.0.0-20161028175848-04cdfd42973b/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM= github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0 h1:NMZiJj8QnKe1LgsbDayM4UoHwbvwDRwnI3hwNaAHRnc= -github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.0/go.mod h1:ZXNYxsqcloTdSy/rNShjYzMhyjf0LaoftYK0p+A3h40= +github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.1 h1:5RVFMOWjMyRy8cARdy79nAmgYw3hK/4HUq48LQ6Wwqo= +github.com/decred/dcrd/dcrec/secp256k1/v4 v4.4.1/go.mod h1:ZXNYxsqcloTdSy/rNShjYzMhyjf0LaoftYK0p+A3h40= +github.com/deluan/go-taglib v0.0.0-20260511232939-ccd334abae3a h1:L5E3uF4hKLEqoEYT0tXXuFH6c3PEEzQSWLfTqF5Lpqw= +github.com/deluan/go-taglib v0.0.0-20260511232939-ccd334abae3a/go.mod h1:+k5CamBu88xgydgNGJjugYVeafoCCswoGjpw5w5CvD4= github.com/deluan/rest v0.0.0-20211102003136-6260bc399cbf h1:tb246l2Zmpt/GpF9EcHCKTtwzrd0HGfEmoODFA/qnk4= github.com/deluan/rest v0.0.0-20211102003136-6260bc399cbf/go.mod h1:tSgDythFsl0QgS/PFWfIZqcJKnkADWneY80jaVRlqK8= github.com/deluan/sanitize v0.0.0-20241120162836-fdfd8fdfaa55 h1:wSCnggTs2f2ji6nFwQmfwgINcmSMj0xF0oHnoyRSPe4= github.com/deluan/sanitize v0.0.0-20241120162836-fdfd8fdfaa55/go.mod h1:ZNCLJfehvEf34B7BbLKjgpsL9lyW7q938w/GY1XgV4E= -github.com/deluan/tag v0.0.0-20241002021117-dfe5e6ea396d h1:x/R3+oPEjnisl1zBx2f2v7Gf6f11l0N0JoD6BkwcJyA= -github.com/deluan/tag v0.0.0-20241002021117-dfe5e6ea396d/go.mod h1:apkPC/CR3s48O2D7Y++n1XWEpgPNNCjXYga3PPbJe2E= github.com/dexterlb/mpvipc v0.0.0-20241005113212-7cdefca0e933 h1:r4hxcT6GBIA/j8Ox4OXI5MNgMKfR+9plcAWYi1OnmOg= github.com/dexterlb/mpvipc v0.0.0-20241005113212-7cdefca0e933/go.mod h1:RkQWLNITKkXHLP7LXxZSgEq+uFWU25M5qW7qfEhL9Wc= -github.com/disintegration/imaging v1.6.2 h1:w1LecBlG2Lnp8B3jk5zSuNqd7b4DXhcjwek1ei82L+c= -github.com/disintegration/imaging v1.6.2/go.mod h1:44/5580QXChDfwIclfc/PCwrr44amcmDAg8hxG0Ewe4= github.com/djherbis/atime v1.1.0 h1:rgwVbP/5by8BvvjBNrbh64Qz33idKT3pSnMSJsxhi0g= github.com/djherbis/atime v1.1.0/go.mod h1:28OF6Y8s3NQWwacXc5eZTsEsiMzp7LF8MbXE+XJPdBE= github.com/djherbis/fscache v0.10.2-0.20231127215153-442a07e326c4 h1:wdZllsLrDJtYfHiAKogB4PNHSDeO+v+5S3eqSWHGDlc= @@ -46,76 +48,101 @@ github.com/djherbis/stream v1.4.0 h1:aVD46WZUiq5kJk55yxJAyw6Kuera6kmC3i2vEQyW/AE github.com/djherbis/stream v1.4.0/go.mod h1:cqjC1ZRq3FFwkGmUtHwcldbnW8f0Q4YuVsGW1eAFtOk= github.com/djherbis/times v1.6.0 h1:w2ctJ92J8fBvWPxugmXIv7Nz7Q3iDMKNx9v5ocVH20c= github.com/djherbis/times v1.6.0/go.mod h1:gOHeRAz2h+VJNZ5Gmc/o7iD9k4wW7NMVqieYCY99oc0= +github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI= +github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8= github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY= github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= +github.com/dylibso/observe-sdk/go v0.0.0-20240828172851-9145d8ad07e1 h1:idfl8M8rPW93NehFw5H1qqH8yG158t5POr+LX9avbJY= +github.com/dylibso/observe-sdk/go v0.0.0-20240828172851-9145d8ad07e1/go.mod h1:C8DzXehI4zAbrdlbtOByKX6pfivJTBiV9Jjqv56Yd9Q= +github.com/ebitengine/purego v0.10.1 h1:dewVBCBT2GaMu1SrNTYxQhgQBethzfhiwvZiLGP/qyY= +github.com/ebitengine/purego v0.10.1/go.mod h1:iIjxzd6CiRiOG0UyXP+V1+jWqUXVjPKLAI0mRfJZTmQ= +github.com/extism/go-sdk v1.7.1 h1:lWJos6uY+tRFdlIHR+SJjwFDApY7OypS/2nMhiVQ9Sw= +github.com/extism/go-sdk v1.7.1/go.mod h1:IT+Xdg5AZM9hVtpFUA+uZCJMge/hbvshl8bwzLtFyKA= github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo= github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M= github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8= github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0= github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo= -github.com/fsnotify/fsnotify v1.9.0 h1:2Ml+OJNzbYCTzsxtv8vKSFD9PbJjmhYF14k/jKC7S9k= -github.com/fsnotify/fsnotify v1.9.0/go.mod h1:8jBTzvmWwFyi3Pb8djgCCO5IBqzKJ/Jwo8TRcHyHii0= -github.com/go-chi/chi/v5 v5.2.1 h1:KOIHODQj58PmL80G2Eak4WdvUzjSJSm0vG72crDCqb8= -github.com/go-chi/chi/v5 v5.2.1/go.mod h1:L2yAIGWB3H+phAw1NxKwWM+7eUH/lU8pOMm5hHcoops= -github.com/go-chi/cors v1.2.1 h1:xEC8UT3Rlp2QuWNEr4Fs/c2EAGVKBwy/1vHx3bppil4= -github.com/go-chi/cors v1.2.1/go.mod h1:sSbTewc+6wYHBBCW7ytsFSn836hqM7JxpglAy2Vzc58= +github.com/fsnotify/fsnotify v1.10.1 h1:b0/UzAf9yR5rhf3RPm9gf3ehBPpf0oZKIjtpKrx59Ho= +github.com/fsnotify/fsnotify v1.10.1/go.mod h1:TLheqan6HD6GBK6PrDWyDPBaEV8LspOxvPSjC+bVfgo= +github.com/gen2brain/webp v0.5.5 h1:MvQR75yIPU/9nSqYT5h13k4URaJK3gf9tgz/ksRbyEg= +github.com/gen2brain/webp v0.5.5/go.mod h1:xOSMzp4aROt2KFW++9qcK/RBTOVC2S9tJG66ip/9Oc0= +github.com/gkampitakis/ciinfo v0.3.2 h1:JcuOPk8ZU7nZQjdUhctuhQofk7BGHuIy0c9Ez8BNhXs= +github.com/gkampitakis/ciinfo v0.3.2/go.mod h1:1NIwaOcFChN4fa/B0hEBdAb6npDlFL8Bwx4dfRLRqAo= +github.com/gkampitakis/go-diff v1.3.2 h1:Qyn0J9XJSDTgnsgHRdz9Zp24RaJeKMUHg2+PDZZdC4M= +github.com/gkampitakis/go-diff v1.3.2/go.mod h1:LLgOrpqleQe26cte8s36HTWcTmMEur6OPYerdAAS9tk= +github.com/gkampitakis/go-snaps v0.5.15 h1:amyJrvM1D33cPHwVrjo9jQxX8g/7E2wYdZ+01KS3zGE= +github.com/gkampitakis/go-snaps v0.5.15/go.mod h1:HNpx/9GoKisdhw9AFOBT1N7DBs9DiHo/hGheFGBZ+mc= +github.com/go-chi/chi/v5 v5.3.0 h1:halUjDxhshgXHMrao5bB8eNBXo/rnzwr8m5m36glehM= +github.com/go-chi/chi/v5 v5.3.0/go.mod h1:R+tYY2hNuVUUjxoPtqUdgBqevM9s9njzkTLutVsOCto= +github.com/go-chi/cors v1.2.2 h1:Jmey33TE+b+rB7fT8MUy1u0I4L+NARQlK6LhzKPSyQE= +github.com/go-chi/cors v1.2.2/go.mod h1:sSbTewc+6wYHBBCW7ytsFSn836hqM7JxpglAy2Vzc58= github.com/go-chi/httprate v0.15.0 h1:j54xcWV9KGmPf/X4H32/aTH+wBlrvxL7P+SdnRqxh5g= github.com/go-chi/httprate v0.15.0/go.mod h1:rzGHhVrsBn3IMLYDOZQsSU4fJNWcjui4fWKJcCId1R4= -github.com/go-chi/jwtauth/v5 v5.3.3 h1:50Uzmacu35/ZP9ER2Ht6SazwPsnLQ9LRJy6zTZJpHEo= -github.com/go-chi/jwtauth/v5 v5.3.3/go.mod h1:O4QvPRuZLZghl9WvfVaON+ARfGzpD2PBX/QY5vUz7aQ= -github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= -github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-chi/jwtauth/v5 v5.4.0 h1:Ieh0xMJsFvqylqJ02/mQHKzbbKO9DYNBh4DPKCwTwYI= +github.com/go-chi/jwtauth/v5 v5.4.0/go.mod h1:w6yjqUUXz1b8+oiJel64Sz1KJwduQM6qUA5QNzO5+bQ= +github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= +github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/go-sql-driver/mysql v1.4.1/go.mod h1:zAC/RDZ24gD3HViQzih4MyKcchzm+sOG5ZlKdlhCg5w= -github.com/go-sql-driver/mysql v1.9.2 h1:4cNKDYQ1I84SXslGddlsrMhc8k4LeDVj6Ad6WRjiHuU= -github.com/go-sql-driver/mysql v1.9.2/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU= +github.com/go-sql-driver/mysql v1.9.3 h1:U/N249h2WzJ3Ukj8SowVFjdtZKfu9vlLZxjPXV1aweo= +github.com/go-sql-driver/mysql v1.9.3/go.mod h1:qn46aNg1333BRMNU69Lq93t8du/dwxI64Gl8i5p1WMU= github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI= github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8= github.com/go-viper/encoding/ini v0.1.1 h1:MVWY7B2XNw7lnOqHutGRc97bF3rP7omOdgjdMPAJgbs= github.com/go-viper/encoding/ini v0.1.1/go.mod h1:Pfi4M2V1eAGJVZ5q6FrkHPhtHED2YgLlXhvgMVrB+YQ= -github.com/go-viper/mapstructure/v2 v2.2.1 h1:ZAaOCxANMuZx5RCeg0mBdEZk7DZasvvZIxtHqx8aGss= -github.com/go-viper/mapstructure/v2 v2.2.1/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM= -github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= -github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= -github.com/gohugoio/hashstructure v0.5.0 h1:G2fjSBU36RdwEJBWJ+919ERvOVqAg9tfcYp47K9swqg= -github.com/gohugoio/hashstructure v0.5.0/go.mod h1:Ser0TniXuu/eauYmrwM4o64EBvySxNzITEOLlm4igec= +github.com/go-viper/mapstructure/v2 v2.5.0 h1:vM5IJoUAy3d7zRSVtIwQgBj7BiWtMPfmPEgAXnvj1Ro= +github.com/go-viper/mapstructure/v2 v2.5.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM= +github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y= +github.com/gobwas/glob v0.2.3/go.mod h1:d3Ez4x06l9bZtSvzIay5+Yzi0fmZzPgnTbPcKjJAkT8= +github.com/goccy/go-json v0.10.6 h1:p8HrPJzOakx/mn/bQtjgNjdTcN+/S6FcG2CTtQOrHVU= +github.com/goccy/go-json v0.10.6/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= +github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM= +github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= +github.com/gohugoio/hashstructure v0.6.0 h1:7wMB/2CfXoThFYhdWRGv3u3rUM761Cq29CxUW+NltUg= +github.com/gohugoio/hashstructure v0.6.0/go.mod h1:lapVLk9XidheHG1IQ4ZSbyYrXcaILU1ZEP/+vno5rBQ= github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= -github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= github.com/google/go-pipeline v0.0.0-20230411140531-6cbedfc1d3fc h1:hd+uUVsB1vdxohPneMrhGH2YfQuH5hRIK9u4/XCeUtw= github.com/google/go-pipeline v0.0.0-20230411140531-6cbedfc1d3fc/go.mod h1:SL66SJVysrh7YbDCP9tH30b8a9o/N2HeiQNUm85EKhc= -github.com/google/pprof v0.0.0-20250501235452-c0086092b71a h1:rDA3FfmxwXR+BVKKdz55WwMJ1pD2hJQNW31d+l3mPk4= -github.com/google/pprof v0.0.0-20250501235452-c0086092b71a/go.mod h1:5hDyRhoBCxViHszMt12TnOpEI4VVi+U8Gm9iphldiMA= +github.com/google/pprof v0.0.0-20260507013755-92041b743c96 h1:YDDnaZ9afWajDboPMt9Vikqca/yWAX7KAxVzb4lJU1M= +github.com/google/pprof v0.0.0-20260507013755-92041b743c96/go.mod h1:MxpfABSjhmINe3F1It9d+8exIHFvUqtLIRCdOGNXqiI= github.com/google/subcommands v1.2.0 h1:vWQspBTo2nEqTUFita5/KeEWlUL8kQObDFbub/EN9oE= github.com/google/subcommands v1.2.0/go.mod h1:ZjhPrFU+Olkh9WazFPsl27BQ4UPiG37m3yTrtFlrHVk= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/google/wire v0.6.0 h1:HBkoIh4BdSxoyo9PveV8giw7ZsaBOvzWKfcg/6MrVwI= -github.com/google/wire v0.6.0/go.mod h1:F4QhpQ9EDIdJ1Mbop/NZBRB+5yrR6qg3BnctaoUk6NA= +github.com/google/wire v0.7.0 h1:JxUKI6+CVBgCO2WToKy/nQk0sS+amI9z9EjVmdaocj4= +github.com/google/wire v0.7.0/go.mod h1:n6YbUQD9cPKTnHXEBN2DXlOp/mVADhVErcMFb0v3J18= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1 h1:EGx4pi6eqNxGaHF6qqu48+N2wcFQ5qg5FXgOdqsJ5d8= github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY= github.com/gorilla/css v1.0.1 h1:ntNaBIghp6JmvWnxbZKANoLyuXTPZ4cAMlo6RyhlbO8= github.com/gorilla/css v1.0.1/go.mod h1:BvnYkspnSzMmwRK+b8/xgNPLiIuNZr6vbZBTPQ2A3b0= +github.com/gorilla/websocket v1.5.3 h1:saDtZ6Pbx/0u+bgYQ3q96pZgCzfhKXGPqt7kZ72aNNg= +github.com/gorilla/websocket v1.5.3/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I= github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= +github.com/ianlancetaylor/demangle v0.0.0-20260505044615-1ff4bf46051f h1:NW3E2QSchEk63/fjeEvWOa2cE02FSv9ox//VE/N4c8g= +github.com/ianlancetaylor/demangle v0.0.0-20260505044615-1ff4bf46051f/go.mod h1:gx7rwoVhcfuVKG5uya9Hs3Sxj7EIvldVofAWIUtGouw= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= -github.com/jellydator/ttlcache/v3 v3.3.0 h1:BdoC9cE81qXfrxeb9eoJi9dWrdhSuwXMAnHTbnBm4Wc= -github.com/jellydator/ttlcache/v3 v3.3.0/go.mod h1:bj2/e0l4jRnQdrnSTaGTsh4GSXvMjQcy41i7th0GVGw= +github.com/jellydator/ttlcache/v3 v3.4.0 h1:YS4P125qQS0tNhtL6aeYkheEaB/m8HCqdMMP4mnWdTY= +github.com/jellydator/ttlcache/v3 v3.4.0/go.mod h1:Hw9EgjymziQD3yGsQdf1FqFdpp7YjFMd4Srg5EJlgD4= +github.com/joshdk/go-junit v1.0.0 h1:S86cUKIdwBHWwA6xCmFlf3RTLfVXYQfvanM5Uh+K6GE= +github.com/joshdk/go-junit v1.0.0/go.mod h1:TiiV0PqkaNfFXjEiyjWM3XXrhVyCa1K4Zfga6W52ung= github.com/jtolds/gls v4.20.0+incompatible h1:xdiiI2gbIgH/gLH7ADydsJ1uDOEzR8yvV7C0MuV77Wo= github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU= -github.com/kardianos/service v1.2.2 h1:ZvePhAHfvo0A7Mftk/tEzqEZ7Q4lgnR8sGz4xu1YX60= -github.com/kardianos/service v1.2.2/go.mod h1:CIMRFEJVL+0DS1a3Nx06NaMn4Dz63Ng6O7dl0qH0zVM= +github.com/kardianos/service v1.2.4 h1:XNlGtZOYNx2u91urOdg/Kfmc+gfmuIo1Dd3rEi2OgBk= +github.com/kardianos/service v1.2.4/go.mod h1:E4V9ufUuY82F7Ztlu1eN9VXWIQxg8NoLQlmFe0MtrXc= github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 h1:Z9n2FFNUXsshfwJMBgNA0RU6/i7WVaAegv3PtuIHPMs= github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51/go.mod h1:CzGEWj7cYgsdH8dAjBGEr58BoE7ScuLd+fwFZ44+/x8= -github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zttxdo= -github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ= -github.com/klauspost/cpuid/v2 v2.2.10 h1:tBs3QSyvjDyFTq3uoc/9xFpCuOsJQFNPiAhYdw2skhE= -github.com/klauspost/cpuid/v2 v2.2.10/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= +github.com/klauspost/compress v1.18.5 h1:/h1gH5Ce+VWNLSWqPzOVn6XBO+vJbCNGvjoaGBFW2IE= +github.com/klauspost/compress v1.18.5/go.mod h1:cwPg85FWrGar70rWktvGQj8/hthj3wpl0PGDogxkrSQ= +github.com/klauspost/cpuid/v2 v2.3.0 h1:S4CRMLnYUhGeDFDqkGriYKdfoFlDnMtqTiI/sFzhA9Y= +github.com/klauspost/cpuid/v2 v2.3.0/go.mod h1:hqwkgyIinND0mEev00jJYCxPNVRVXFQeu1XKlok6oO0= github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= @@ -130,60 +157,66 @@ github.com/lann/builder v0.0.0-20180802200727-47ae307949d0 h1:SOEGU9fKiNWd/HOJuq github.com/lann/builder v0.0.0-20180802200727-47ae307949d0/go.mod h1:dXGbAdH5GtBTC4WfIxhKZfyBF/HBFgRZSWwZ9g/He9o= github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0 h1:P6pPBnrTSX3DEVR4fDembhRWSsG5rVo6hYhAB/ADZrk= github.com/lann/ps v0.0.0-20150810152359-62de8c46ede0/go.mod h1:vmVJ0l/dxyfGW6FmdpVm2joNMFikkuWg0EoCKLGUMNw= -github.com/lestrrat-go/blackmagic v1.0.3 h1:94HXkVLxkZO9vJI/w2u1T0DAoprShFd13xtnSINtDWs= -github.com/lestrrat-go/blackmagic v1.0.3/go.mod h1:6AWFyKNNj0zEXQYfTMPfZrAXUWUfTIZ5ECEUEJaijtw= +github.com/lestrrat-go/blackmagic v1.0.4 h1:IwQibdnf8l2KoO+qC3uT4OaTWsW7tuRQXy9TRN9QanA= +github.com/lestrrat-go/blackmagic v1.0.4/go.mod h1:6AWFyKNNj0zEXQYfTMPfZrAXUWUfTIZ5ECEUEJaijtw= +github.com/lestrrat-go/dsig v1.3.0 h1:phjMOCXvYzhuIgn7Voe2rex8z166vGfxRxmqM25P9/Q= +github.com/lestrrat-go/dsig v1.3.0/go.mod h1:RD2eOaidyPvpc7IJQoO3Qq52RWdy8ZcJs8lrOnoa1Kc= +github.com/lestrrat-go/dsig-secp256k1 v1.0.0 h1:JpDe4Aybfl0soBvoVwjqDbp+9S1Y2OM7gcrVVMFPOzY= +github.com/lestrrat-go/dsig-secp256k1 v1.0.0/go.mod h1:CxUgAhssb8FToqbL8NjSPoGQlnO4w3LG1P0qPWQm/NU= github.com/lestrrat-go/httpcc v1.0.1 h1:ydWCStUeJLkpYyjLDHihupbn2tYmZ7m22BGkcvZZrIE= github.com/lestrrat-go/httpcc v1.0.1/go.mod h1:qiltp3Mt56+55GPVCbTdM9MlqhvzyuL6W/NMDA8vA5E= -github.com/lestrrat-go/httprc v1.0.6 h1:qgmgIRhpvBqexMJjA/PmwSvhNk679oqD1RbovdCGW8k= -github.com/lestrrat-go/httprc v1.0.6/go.mod h1:mwwz3JMTPBjHUkkDv/IGJ39aALInZLrhBp0X7KGUZlo= -github.com/lestrrat-go/iter v1.0.2 h1:gMXo1q4c2pHmC3dn8LzRhJfP1ceCbgSiT9lUydIzltI= -github.com/lestrrat-go/iter v1.0.2/go.mod h1:Momfcq3AnRlRjI5b5O8/G5/BvpzrhoFTZcn06fEOPt4= -github.com/lestrrat-go/jwx/v2 v2.1.6 h1:hxM1gfDILk/l5ylers6BX/Eq1m/pnxe9NBwW6lVfecA= -github.com/lestrrat-go/jwx/v2 v2.1.6/go.mod h1:Y722kU5r/8mV7fYDifjug0r8FK8mZdw0K0GpJw/l8pU= -github.com/lestrrat-go/option v1.0.1 h1:oAzP2fvZGQKWkvHa1/SAcFolBEca1oN+mQ7eooNBEYU= -github.com/lestrrat-go/option v1.0.1/go.mod h1:5ZHFbivi4xwXxhxY9XHDe2FHo6/Z7WWmtT7T5nBBp3I= -github.com/matoous/go-nanoid/v2 v2.1.0 h1:P64+dmq21hhWdtvZfEAofnvJULaRR1Yib0+PnU669bE= -github.com/matoous/go-nanoid/v2 v2.1.0/go.mod h1:KlbGNQ+FhrUNIHUxZdL63t7tl4LaPkZNpUULS8H4uVM= -github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= -github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= -github.com/mattn/go-sqlite3 v1.14.28 h1:ThEiQrnbtumT+QMknw63Befp/ce/nUPgBPMlRFEum7A= -github.com/mattn/go-sqlite3 v1.14.28/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y= +github.com/lestrrat-go/httprc/v3 v3.0.5 h1:S+Mb4L2I+bM6JGTibLmxExhyTOqnXjqx+zi9MoXw/TM= +github.com/lestrrat-go/httprc/v3 v3.0.5/go.mod h1:mSMtkZW92Z98M5YoNNztbRGxbXHql7tSitCvaxvo9l0= +github.com/lestrrat-go/jwx/v3 v3.1.1 h1:yd9AdPmZ4INnQ7k42IrzXYpnEG803+SrQ6hdMvzHJzw= +github.com/lestrrat-go/jwx/v3 v3.1.1/go.mod h1:uw/MN2M/Xiu4FhwcIwH11Zsh9JWx9SWzgALl7/uIEkU= +github.com/lestrrat-go/option/v2 v2.0.0 h1:XxrcaJESE1fokHy3FpaQ/cXW8ZsIdWcdFzzLOcID3Ss= +github.com/lestrrat-go/option/v2 v2.0.0/go.mod h1:oSySsmzMoR0iRzCDCaUfsCzxQHUEuhOViQObyy7S6Vg= +github.com/maruel/natural v1.3.0 h1:VsmCsBmEyrR46RomtgHs5hbKADGRVtliHTyCOLFBpsg= +github.com/maruel/natural v1.3.0/go.mod h1:v+Rfd79xlw1AgVBjbO0BEQmptqb5HvL/k9GRHB7ZKEg= +github.com/mattn/go-isatty v0.0.21 h1:xYae+lCNBP7QuW4PUnNG61ffM4hVIfm+zUzDuSzYLGs= +github.com/mattn/go-isatty v0.0.21/go.mod h1:ZXfXG4SQHsB/w3ZeOYbR0PrPwLy+n6xiMrJlRFqopa4= +github.com/mattn/go-sqlite3 v1.14.44 h1:3VSe+xafpbzsLbdr2AWlAZk9yRHiBhTBakioXaCKTF8= +github.com/mattn/go-sqlite3 v1.14.44/go.mod h1:pjEuOr8IwzLJP2MfGeTb0A35jauH+C2kbHKBr7yXKVQ= github.com/mfridman/interpolate v0.0.2 h1:pnuTK7MQIxxFz1Gr+rjSIx9u7qVjf5VOoM/u6BbAxPY= github.com/mfridman/interpolate v0.0.2/go.mod h1:p+7uk6oE07mpE/Ik1b8EckO0O4ZXiGAfshKBWLUM9Xg= +github.com/mfridman/tparse v0.18.0 h1:wh6dzOKaIwkUGyKgOntDW4liXSo37qg5AXbIhkMV3vE= +github.com/mfridman/tparse v0.18.0/go.mod h1:gEvqZTuCgEhPbYk/2lS3Kcxg1GmTxxU7kTC8DvP0i/A= github.com/microcosm-cc/bluemonday v1.0.27 h1:MpEUotklkwCSLeH+Qdx1VJgNqLlpY2KXwXFM08ygZfk= github.com/microcosm-cc/bluemonday v1.0.27/go.mod h1:jFi9vgW+H7c3V0lb6nR74Ib/DIB5OBs92Dimizgw2cA= github.com/mileusna/useragent v1.3.5 h1:SJM5NzBmh/hO+4LGeATKpaEX9+b4vcGg2qXGLiNGDws= github.com/mileusna/useragent v1.3.5/go.mod h1:3d8TOmwL/5I8pJjyVDteHtgDGcefrFUX4ccGOMKNYYc= +github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0= +github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA= github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ= -github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4= -github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls= +github.com/ncruces/go-strftime v1.0.0 h1:HMFp8mLCTPp341M/ZnA4qaf7ZlsbTc+miZjCLOFAw7w= +github.com/ncruces/go-strftime v1.0.0/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls= github.com/ogier/pflag v0.0.1 h1:RW6JSWSu/RkSatfcLtogGfFgpim5p7ARQ10ECk5O750= github.com/ogier/pflag v0.0.1/go.mod h1:zkFki7tvTa0tafRvTBIZTvzYyAu6kQhPZFnshFFPE+g= -github.com/onsi/ginkgo/v2 v2.23.4 h1:ktYTpKJAVZnDT4VjxSbiBenUjmlL/5QkBEocaWXiQus= -github.com/onsi/ginkgo/v2 v2.23.4/go.mod h1:Bt66ApGPBFzHyR+JO10Zbt0Gsp4uWxu5mIOTusL46e8= -github.com/onsi/gomega v1.37.0 h1:CdEG8g0S133B4OswTDC/5XPSzE1OeP29QOioj2PID2Y= -github.com/onsi/gomega v1.37.0/go.mod h1:8D9+Txp43QWKhM24yyOBEdpkzN8FvJyAwecBgsU4KU0= -github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= -github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= +github.com/onsi/ginkgo/v2 v2.29.0 h1:rfh+ZFjgJhYWRoIqVf3Uwx/W20yLrcrE2h2GmYVRaag= +github.com/onsi/ginkgo/v2 v2.29.0/go.mod h1:+aXOY+vzZ5mu2iI2HpTZUPmM//oQfsNFX6gU9kNcA44= +github.com/onsi/gomega v1.41.0 h1:OwKp4pXNgVxf6sCplzYo794OFNuoL2q2SBMU5NSWOjA= +github.com/onsi/gomega v1.41.0/go.mod h1:M/Uqpu/8qTjtzCLUA2zJHX9Iilrau25x1PdoSRbWh5A= +github.com/pelletier/go-toml/v2 v2.3.1 h1:MYEvvGnQjeNkRF1qUuGolNtNExTDwct51yp7olPtrEc= +github.com/pelletier/go-toml/v2 v2.3.1/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= +github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v0.0.0-20151028094244-d8ed2627bdf0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U= -github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/pocketbase/dbx v1.11.0 h1:LpZezioMfT3K4tLrqA55wWFw1EtH1pM4tzSVa7kgszU= -github.com/pocketbase/dbx v1.11.0/go.mod h1:xXRCIAKTHMgUCyCKZm55pUOdvFziJjQfXaWKhu2vhMs= -github.com/prashantv/gostub v1.1.0 h1:BTyx3RfQjRHnUWaGF9oQos79AlQ5k8WNktv7VGvVH4g= -github.com/prashantv/gostub v1.1.0/go.mod h1:A5zLQHz7ieHGG7is6LLXLz7I8+3LZzsrV0P1IAHhP5U= -github.com/pressly/goose/v3 v3.24.3 h1:DSWWNwwggVUsYZ0X2VitiAa9sKuqtBfe+Jr9zFGwWlM= -github.com/pressly/goose/v3 v3.24.3/go.mod h1:v9zYL4xdViLHCUUJh/mhjnm6JrK7Eul8AS93IxiZM4E= -github.com/prometheus/client_golang v1.22.0 h1:rb93p9lokFEsctTys46VnV1kLCDpVZ0a/Y92Vm0Zc6Q= -github.com/prometheus/client_golang v1.22.0/go.mod h1:R7ljNsLXhuQXYZYtw6GAE9AZg8Y7vEW5scdCXrWRXC0= -github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E= -github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY= -github.com/prometheus/common v0.62.0 h1:xasJaQlnWAeyHdUBeGjXmutelfJHWMRr+Fg4QszZ2Io= -github.com/prometheus/common v0.62.0/go.mod h1:vyBcEuLSvWos9B1+CyL7JZ2up+uFzXhkqml0W5zIY1I= -github.com/prometheus/procfs v0.16.1 h1:hZ15bTNuirocR6u0JZ6BAHHmwS1p8B4P6MRqxtzMyRg= -github.com/prometheus/procfs v0.16.1/go.mod h1:teAbpZRB1iIAJYREa1LsoWUXykVXA1KlTmWl8x/U+Is= +github.com/pocketbase/dbx v1.12.0 h1:/oLErM+A0b4xI0PWTGPqSDVjzix48PqI/bng2l0PzoA= +github.com/pocketbase/dbx v1.12.0/go.mod h1:xXRCIAKTHMgUCyCKZm55pUOdvFziJjQfXaWKhu2vhMs= +github.com/pressly/goose/v3 v3.27.1 h1:6uEvcprBybDmW4hcz3gYujhARhye+GoWKhEWyzD5sh4= +github.com/pressly/goose/v3 v3.27.1/go.mod h1:maruOxsPnIG2yHHyo8UqKWXYKFcH7Q76csUV7+7KYoM= +github.com/prometheus/client_golang v1.23.2 h1:Je96obch5RDVy3FDMndoUsjAhG5Edi49h0RJWRi/o0o= +github.com/prometheus/client_golang v1.23.2/go.mod h1:Tb1a6LWHB3/SPIzCoaDXI4I8UHKeFTEQ1YCr+0Gyqmg= +github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk= +github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE= +github.com/prometheus/common v0.67.5 h1:pIgK94WWlQt1WLwAC5j2ynLaBRDiinoAb86HZHTUGI4= +github.com/prometheus/common v0.67.5/go.mod h1:SjE/0MzDEEAyrdr5Gqc6G+sXI67maCxzaT3A2+HqjUw= +github.com/prometheus/procfs v0.20.1 h1:XwbrGOIplXW/AU3YhIhLODXMJYyC1isLFfYCsTEycfc= +github.com/prometheus/procfs v0.20.1/go.mod h1:o9EMBZGRyvDrSPH1RqdxhojkuXstoe4UlK79eF5TGGo= github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE= github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo= github.com/rjeczalik/notify v0.9.3 h1:6rJAzHTGKXGj76sbRgDiDcYj/HniypXmSJo1SWakZeY= @@ -191,86 +224,109 @@ github.com/rjeczalik/notify v0.9.3/go.mod h1:gF3zSOrafR9DQEWSE8TjfI9NkooDxbyT4Ug github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs= github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro= github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs= -github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= -github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= +github.com/rogpeppe/go-internal v1.15.0 h1:D0RCU5rMAp+SpgkiNdrjfJ+LX4J1M32V2NeCY7EJ6hc= +github.com/rogpeppe/go-internal v1.15.0/go.mod h1:DrUVZyrJU+txYW5/1kwtXQSMFio52ZOxX7yM1VHvnxs= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI= github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs= -github.com/sagikazarmark/locafero v0.9.0 h1:GbgQGNtTrEmddYDSAH9QLRyfAHY12md+8YFTqyMTC9k= -github.com/sagikazarmark/locafero v0.9.0/go.mod h1:UBUyz37V+EdMS3hDF3QWIiVr/2dPrx49OMO0Bn0hJqk= -github.com/segmentio/asm v1.2.0 h1:9BQrFxC+YOHJlTlHGkTrFWf59nbL3XnCoFLTwDCI7ys= -github.com/segmentio/asm v1.2.0/go.mod h1:BqMnlJP91P8d+4ibuonYZw9mfnzI9HfxselHZr5aAcs= +github.com/sagikazarmark/locafero v0.12.0 h1:/NQhBAkUb4+fH1jivKHWusDYFjMOOKU88eegjfxfHb4= +github.com/sagikazarmark/locafero v0.12.0/go.mod h1:sZh36u/YSZ918v0Io+U9ogLYQJ9tLLBmM4eneO6WwsI= +github.com/sanity-io/litter v1.5.8 h1:uM/2lKrWdGbRXDrIq08Lh9XtVYoeGtcQxk9rtQ7+rYg= +github.com/sanity-io/litter v1.5.8/go.mod h1:9gzJgR2i4ZpjZHsKvUXIRQVk7P+yM3e+jAF7bU2UI5U= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU= +github.com/segmentio/asm v1.2.1 h1:DTNbBqs57ioxAD4PrArqftgypG4/qNpXoJx8TVXxPR0= +github.com/segmentio/asm v1.2.1/go.mod h1:BqMnlJP91P8d+4ibuonYZw9mfnzI9HfxselHZr5aAcs= github.com/sethvargo/go-retry v0.3.0 h1:EEt31A35QhrcRZtrYFDTBg91cqZVnFL2navjDrah2SE= github.com/sethvargo/go-retry v0.3.0/go.mod h1:mNX17F0C/HguQMyMyJxcnU471gOZGxCLyYaFyAZraas= github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= -github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ= -github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ= +github.com/sirupsen/logrus v1.9.4 h1:TsZE7l11zFCLZnZ+teH4Umoq5BhEIfIzfRDZ1Uzql2w= +github.com/sirupsen/logrus v1.9.4/go.mod h1:ftWc9WdOfJ0a92nsE2jF5u5ZwH8Bv2zdeOC42RjbV2g= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d h1:zE9ykElWQ6/NYmHa3jpm/yHnI4xSofP+UP6SpjHcSeM= github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc= github.com/smartystreets/goconvey v1.6.4 h1:fv0U8FUIMPNf1L9lnHLvLhgicrIVChEkdzIKYqbNC9s= github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA= -github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo= -github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0= -github.com/spf13/afero v1.14.0 h1:9tH6MapGnn/j0eb0yIXiLjERO8RB6xIVZRDCX7PtqWA= -github.com/spf13/afero v1.14.0/go.mod h1:acJQ8t0ohCGuMN3O+Pv0V0hgMxNYDlvdk+VTfyZmbYo= -github.com/spf13/cast v1.8.0 h1:gEN9K4b8Xws4EX0+a0reLmhq8moKn7ntRlQYgjPeCDk= -github.com/spf13/cast v1.8.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo= -github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo= -github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0= -github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o= -github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= -github.com/spf13/viper v1.20.1 h1:ZMi+z/lvLyPSCoNtFCpqjy0S4kPbirhpTMwl8BkW9X4= -github.com/spf13/viper v1.20.1/go.mod h1:P9Mdzt1zoHIG8m2eZQinpiBjo6kCmZSKBClNNqjJvu4= +github.com/sosodev/duration v1.3.1 h1:qtHBDMQ6lvMQsL15g4aopM4HEfOaYuhWBw3NPTtlqq4= +github.com/sosodev/duration v1.3.1/go.mod h1:RQIBBX0+fMLc/D9+Jb/fwvVmo0eZvDDEERAikUR6SDg= +github.com/spf13/afero v1.15.0 h1:b/YBCLWAJdFWJTN9cLhiXXcD7mzKn9Dm86dNnfyQw1I= +github.com/spf13/afero v1.15.0/go.mod h1:NC2ByUVxtQs4b3sIUphxK0NioZnmxgyCrfzeuq8lxMg= +github.com/spf13/cast v1.10.0 h1:h2x0u2shc1QuLHfxi+cTJvs30+ZAHOGRic8uyGTDWxY= +github.com/spf13/cast v1.10.0/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo= +github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU= +github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4= +github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/pflag v1.0.10 h1:4EBh2KAYBwaONj6b2Ye1GiHfwjqyROoF4RwYO+vPwFk= +github.com/spf13/pflag v1.0.10/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/viper v1.21.0 h1:x5S+0EU27Lbphp4UKm1C+1oQO+rKx36vfCoaVebLFSU= +github.com/spf13/viper v1.21.0/go.mod h1:P0lhsswPGWD/1lZJ9ny3fYnVqxiegrlNrEmgLjbTCAY= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/objx v0.5.3 h1:jmXUvGomnU1o3W/V5h2VEradbpJDwGrzugQQvL0POH4= +github.com/stretchr/objx v0.5.3/go.mod h1:rDQraq+vQZU7Fde9LOZLr8Tax6zZvy4kuNKF+QYS+U0= +github.com/stretchr/testify v0.0.0-20161117074351-18a02ba4a312/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= -github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/subosito/gotenv v1.6.0 h1:9NlTDc1FTs4qu0DDq7AEtTPNw6SVm7uBMsUCUjABIf8= github.com/subosito/gotenv v1.6.0/go.mod h1:Dk4QP5c2W3ibzajGcXpNraDfq2IrhjMIvMSWPKKo0FU= +github.com/tetratelabs/wabin v0.0.0-20230304001439-f6f874872834 h1:ZF+QBjOI+tILZjBaFj3HgFonKXUcwgJ4djLb6i42S3Q= +github.com/tetratelabs/wabin v0.0.0-20230304001439-f6f874872834/go.mod h1:m9ymHTgNSEjuxvw8E7WWe4Pl4hZQHXONY8wE6dMLaRk= +github.com/tetratelabs/wazero v1.11.1-0.20260428013916-2bbd517b7633 h1:6GN/lazdqr69FIzz1U6c4TF/ppE2dInMR4GzU9QKxjg= +github.com/tetratelabs/wazero v1.11.1-0.20260428013916-2bbd517b7633/go.mod h1:3ghOSSWYnzX0zd/3Ns4ni2tKxcXDE9/QgkwuH1PW3Rs= +github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY= +github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4= +github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY= +github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28= github.com/unrolled/secure v1.17.0 h1:Io7ifFgo99Bnh0J7+Q+qcMzWM6kaDPCA5FroFZEdbWU= github.com/unrolled/secure v1.17.0/go.mod h1:BmF5hyM6tXczk3MpQkFf1hpKSRqCyhqcbiQtiAF7+40= -github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4= -github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM= +github.com/valyala/fastjson v1.6.10 h1:/yjJg8jaVQdYR3arGxPE2X5z89xrlhS0eGXdv+ADTh4= +github.com/valyala/fastjson v1.6.10/go.mod h1:e6FubmQouUNP73jtMLmcbxS6ydWIpOfhz34TSfO3JaE= +github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 h1:FnBeRrxr7OU4VvAzt5X7s6266i6cSVkkFPS0TuXWbIg= +github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/zeebo/assert v1.3.0 h1:g7C04CbJuIDKNPFHmsk4hwZDO5O+kntRxzaUoNXj+IQ= github.com/zeebo/assert v1.3.0/go.mod h1:Pq9JiuJQpG8JLJdtkwrJESF0Foym2/D9XMU5ciN/wJ0= -github.com/zeebo/xxh3 v1.0.2 h1:xZmwmqxHZA8AI603jOQ0tMqmBr9lPeFwGg6d+xy9DC0= -github.com/zeebo/xxh3 v1.0.2/go.mod h1:5NWz9Sef7zIDm2JHfFlcQvNekmcEl9ekUZQQKCYaDcA= -go.uber.org/automaxprocs v1.6.0 h1:O3y2/QNTOdbF+e/dpXNNW7Rx2hZ4sTIPyybbxyNqTUs= -go.uber.org/automaxprocs v1.6.0/go.mod h1:ifeIMSnPZuznNm6jmdzmU3/bfk01Fe2fotchwEFJ8r8= +github.com/zeebo/xxh3 v1.1.0 h1:s7DLGDK45Dyfg7++yxI0khrfwq9661w9EN78eP/UZVs= +github.com/zeebo/xxh3 v1.1.0/go.mod h1:IisAie1LELR4xhVinxWS5+zf1lA4p0MW4T+w+W07F5s= +go.opentelemetry.io/proto/otlp v1.10.0 h1:IQRWgT5srOCYfiWnpqUYz9CVmbO8bFmKcwYxpuCSL2g= +go.opentelemetry.io/proto/otlp v1.10.0/go.mod h1:/CV4QoCR/S9yaPj8utp3lvQPoqMtxXdzn7ozvvozVqk= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.yaml.in/yaml/v2 v2.4.3 h1:6gvOSjQoTB3vt1l+CU+tSyi/HOjfOjRLJ4YwYZGwRO0= +go.yaml.in/yaml/v2 v2.4.3/go.mod h1:zSxWcmIDjOzPXpjlTTbAsKokqkDNAVtZO0WOMiT90s8= +go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc= +go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= -golang.org/x/crypto v0.18.0/go.mod h1:R0j02AL6hcrfOiy9T4ZYp/rcWeMxM3L6QYxlOuEG1mg= golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= -golang.org/x/crypto v0.38.0 h1:jt+WWG8IZlBnVbomuhg2Mdq0+BBQaHbtqHEFEigjUV8= -golang.org/x/crypto v0.38.0/go.mod h1:MvrbAqul58NNYPKnOra203SB9vpuZW0e+RRZV+Ggqjw= -golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 h1:y5zboxd6LQAqYIhHnB48p0ByQ/GnQx2BE33L8BOHQkI= -golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6/go.mod h1:U6Lno4MTRCDY+Ba7aCcauB9T60gsv5s4ralQzP72ZoQ= -golang.org/x/image v0.0.0-20191009234506-e7c1f5e7dbb8/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= -golang.org/x/image v0.27.0 h1:C8gA4oWU/tKkdCfYT6T2u4faJu3MeNS5O8UPWlPF61w= -golang.org/x/image v0.27.0/go.mod h1:xbdrClrAUway1MUTEZDq9mz/UpRwYAkFFNUslZtcB+g= +golang.org/x/crypto v0.52.0 h1:RMs7fP2rXdep0CftQlK8Uf+kibLm7qkCcradZWYz988= +golang.org/x/crypto v0.52.0/go.mod h1:1QgfPxDqh0T2M/elOJtp9RvuR95kVjir0e6/BvEmGbc= +golang.org/x/image v0.41.0 h1:8wS72eGJMJaBxK6okTzd4WaXumUlTVlb753MlsSvTCo= +golang.org/x/image v0.41.0/go.mod h1:uIc348UZMSvS5Z65CVZ7iDPaNobNFEPeJ4kbqTOszmA= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= -golang.org/x/mod v0.14.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= -golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU= -golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= +golang.org/x/mod v0.36.0 h1:JJjpVx6myfUsUdAzZuOSTTmRE0PfZeNWzzvKrP7amb4= +golang.org/x/mod v0.36.0/go.mod h1:moc6ELqsWcOw5Ef3xVprK5ul/MvtVvkIXLziUOICjUQ= golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -279,12 +335,11 @@ golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= -golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY= golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= -golang.org/x/net v0.40.0 h1:79Xs7wF06Gbdcg4kdCCIQArK11Z1hr5POQ6+fIYHNuY= -golang.org/x/net v0.40.0/go.mod h1:y0hY0exeL2Pku80/zKK7tpntoX23cqL3Oa6njdgRtds= +golang.org/x/net v0.55.0 h1:bcvxaJn3e1U6InsFWt1JUq1aSjnRxLzT2rtD2KfkDF8= +golang.org/x/net v0.55.0/go.mod h1:L5U2KuzuOe1lY7Z+aWVIKK6qEeJXnXV9yzGA+WCHJww= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -292,38 +347,38 @@ golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= -golang.org/x/sync v0.14.0 h1:woo0S4Yywslg6hp4eUFjTVOyKt0RookbpAHG4c1HmhQ= -golang.org/x/sync v0.14.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= +golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4= +golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0= golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180926160741-c2ed4eda69e7/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20201015000850-e3ed0017c211/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220615213510-4f61da869c0c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw= -golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/sys v0.45.0 h1:dO4czNzziLiiXplLQgBCEpCvXQ3dnkn0SdaZSYdQ+FY= +golang.org/x/sys v0.45.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw= golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= +golang.org/x/telemetry v0.0.0-20260508192327-42602be52be6 h1:HjU6IWBiAgRIdAJ9/y1rwCn+UELEmwV+VsTLzj/W4sE= +golang.org/x/telemetry v0.0.0-20260508192327-42602be52be6/go.mod h1:Eqhaxk/wZsWEH8CRxLwj6xzEJbz7k1EFGqx7nyCoabE= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= -golang.org/x/term v0.16.0/go.mod h1:yn7UURbUtPyrVJPGPq404EukNFxcm/foM+bV/bfcDsY= golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= +golang.org/x/term v0.43.0 h1:S4RLU2sB31O/NCl+zFN9Aru9A/Cq2aqKpTZJ6B+DwT4= +golang.org/x/term v0.43.0/go.mod h1:lrhlHNdQJHO+1qVYiHfFKVuVioJIheAc3fBSMFYEIsk= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= @@ -334,40 +389,39 @@ golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= -golang.org/x/text v0.25.0 h1:qVyWApTSYLk/drJRO5mDlNYskwQznZmkpV2c8q9zls4= -golang.org/x/text v0.25.0/go.mod h1:WEdwpYrmk1qmdHvhkSTNPm3app7v4rsT8F2UD6+VHIA= -golang.org/x/time v0.11.0 h1:/bpjEDfN9tkoN/ryeYHnv5hcMlc8ncjMcM4XBk5NWV0= -golang.org/x/time v0.11.0/go.mod h1:CDIdPxbZBQxdj6cxyCIdrNogrJKMJ7pr37NYpMcMDSg= +golang.org/x/text v0.37.0 h1:Cqjiwd9eSg8e0QAkyCaQTNHFIIzWtidPahFWR83rTrc= +golang.org/x/text v0.37.0/go.mod h1:a5sjxXGs9hsn/AJVwuElvCAo9v8QYLzvavO5z2PiM38= +golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U= +golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= -golang.org/x/tools v0.17.0/go.mod h1:xsh6VxdV005rRVaS6SSAf9oiAqljS7UZUacMZ8Bnsps= golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= -golang.org/x/tools v0.33.0 h1:4qz2S3zmRxbGIhDIAgjxvFutSvH5EfnsYrRBj0UI0bc= -golang.org/x/tools v0.33.0/go.mod h1:CIJMaWEY88juyUfo7UbgPqbC8rU2OqfAV1h2Qp0oMYI= +golang.org/x/tools v0.45.0 h1:18qN3FAooORvApf5XjCXgsuayZOEtXf6JK18I3+ONa8= +golang.org/x/tools v0.45.0/go.mod h1:LuUGqqaXcXMEFEruIVJVm5mgDD8vww/z/SR1gQ4uE/0= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/appengine v1.6.5/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= -google.golang.org/protobuf v1.36.6 h1:z1NpPI8ku2WgiWnf+t9wTPsn6eP1L7ksHUlkfLvd9xY= -google.golang.org/protobuf v1.36.6/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY= +google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE= +google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= -gopkg.in/ini.v1 v1.67.0 h1:Dgnx+6+nfE+IfzjUEISNeydPJh9AXNNsWbGP9KzCsOA= -gopkg.in/ini.v1 v1.67.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k= +gopkg.in/ini.v1 v1.67.2 h1:JtOSMb9OuaCZKr7h5D/h6iii14sK0hLbplTc6frx4Ss= +gopkg.in/ini.v1 v1.67.2/go.mod h1:x/cyOwCgZqOkJoDIJ3c1KNHMo10+nLGAhh+kn3Zizss= gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce h1:+JknDZhAj8YMt7GC73Ei8pv4MzjDUNPHgQWJdtMAaDU= gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce/go.mod h1:5AcXVHNjg+BDxry382+8OKon8SEWiKktQR07RKPsv1c= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= -modernc.org/libc v1.65.0 h1:e183gLDnAp9VJh6gWKdTy0CThL9Pt7MfcR/0bgb7Y1Y= -modernc.org/libc v1.65.0/go.mod h1:7m9VzGq7APssBTydds2zBcxGREwvIGpuUBaKTXdm2Qs= +modernc.org/libc v1.72.1 h1:db1xwJ6u1kE3KHTFTTbe2GCrczHPKzlURP0aDC4NGD0= +modernc.org/libc v1.72.1/go.mod h1:HRMiC/PhPGLIPM7GzAFCbI+oSgE3dhZ8FWftmRrHVlY= modernc.org/mathutil v1.7.1 h1:GCZVGXdaN8gTqB1Mf/usp1Y/hSqgI2vAGGP4jZMCxOU= modernc.org/mathutil v1.7.1/go.mod h1:4p5IwJITfppl0G4sUEDtCr4DthTaT47/N3aT6MhfgJg= -modernc.org/memory v1.10.0 h1:fzumd51yQ1DxcOxSO+S6X7+QTuVU+n8/Aj7swYjFfC4= -modernc.org/memory v1.10.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw= -modernc.org/sqlite v1.37.0 h1:s1TMe7T3Q3ovQiK2Ouz4Jwh7dw4ZDqbebSDTlSJdfjI= -modernc.org/sqlite v1.37.0/go.mod h1:5YiWv+YviqGMuGw4V+PNplcyaJ5v+vQd7TQOgkACoJM= +modernc.org/memory v1.11.0 h1:o4QC8aMQzmcwCK3t3Ux/ZHmwFPzE6hf2Y5LbkRs+hbI= +modernc.org/memory v1.11.0/go.mod h1:/JP4VbVC+K5sU2wZi9bHoq2MAkCnrt2r98UGeSK7Mjw= +modernc.org/sqlite v1.49.1 h1:dYGHTKcX1sJ+EQDnUzvz4TJ5GbuvhNJa8Fg6ElGx73U= +modernc.org/sqlite v1.49.1/go.mod h1:m0w8xhwYUVY3H6pSDwc3gkJ/irZT/0YEXwBlhaxQEew= diff --git a/log/journal.go b/log/journal.go new file mode 100644 index 000000000..dd7cf5400 --- /dev/null +++ b/log/journal.go @@ -0,0 +1,41 @@ +package log + +import ( + "fmt" + + "github.com/sirupsen/logrus" +) + +// journalFormatter wraps a logrus.Formatter and prepends a syslog priority +// prefix () to each log line. When stderr is captured by systemd-journald, +// this prefix tells journald the correct severity for each message. +// +// See https://www.freedesktop.org/software/systemd/man/sd-daemon.html +type journalFormatter struct { + inner logrus.Formatter +} + +// levelToPriority maps logrus levels to syslog priority values. +// The mapping follows RFC 5424 severity levels. +var levelToPriority = map[logrus.Level]int{ + logrus.PanicLevel: 0, // emerg + logrus.FatalLevel: 2, // crit + logrus.ErrorLevel: 3, // err + logrus.WarnLevel: 4, // warning + logrus.InfoLevel: 6, // info + logrus.DebugLevel: 7, // debug + logrus.TraceLevel: 7, // debug +} + +func (f *journalFormatter) Format(entry *logrus.Entry) ([]byte, error) { + formatted, err := f.inner.Format(entry) + if err != nil { + return formatted, err + } + priority, ok := levelToPriority[entry.Level] + if !ok { + priority = 6 // default to info for unknown levels + } + prefix := fmt.Appendf(nil, "<%d>", priority) + return append(prefix, formatted...), nil +} diff --git a/log/journal_test.go b/log/journal_test.go new file mode 100644 index 000000000..770f12b6d --- /dev/null +++ b/log/journal_test.go @@ -0,0 +1,41 @@ +package log + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/sirupsen/logrus" +) + +var _ = Describe("journalFormatter", func() { + var formatter *journalFormatter + + BeforeEach(func() { + inner := &logrus.TextFormatter{ + DisableTimestamp: true, + DisableColors: true, + } + formatter = &journalFormatter{inner: inner} + }) + + DescribeTable("prefixes log lines with syslog priority", + func(level logrus.Level, expectedPrefix string) { + entry := &logrus.Entry{ + Logger: logrus.New(), + Level: level, + Message: "test message", + Data: logrus.Fields{}, + } + out, err := formatter.Format(entry) + Expect(err).ToNot(HaveOccurred()) + Expect(string(out)).To(HavePrefix(expectedPrefix)) + }, + Entry("error", logrus.ErrorLevel, "<3>"), + Entry("warning", logrus.WarnLevel, "<4>"), + Entry("info", logrus.InfoLevel, "<6>"), + Entry("debug", logrus.DebugLevel, "<7>"), + Entry("trace", logrus.TraceLevel, "<7>"), + Entry("fatal", logrus.FatalLevel, "<2>"), + Entry("panic", logrus.PanicLevel, "<0>"), + Entry("unknown level defaults to info", logrus.Level(99), "<6>"), + ) +}) diff --git a/log/log.go b/log/log.go index 08a487fcd..2764d80e5 100644 --- a/log/log.go +++ b/log/log.go @@ -11,6 +11,7 @@ import ( "runtime" "sort" "strings" + "sync" "time" "github.com/sirupsen/logrus" @@ -18,7 +19,7 @@ import ( type Level uint32 -type LevelFunc = func(ctx interface{}, msg interface{}, keyValuePairs ...interface{}) +type LevelFunc = func(ctx any, msg any, keyValuePairs ...any) var redacted = &Hook{ AcceptedLevels: logrus.AllLevels, @@ -26,10 +27,9 @@ var redacted = &Hook{ // Keys from the config "(ApiKey:\")[\\w]*", "(Secret:\")[\\w]*", - "(Spotify.*ID:\")[\\w]*", "(PasswordEncryptionKey:[\\s]*\")[^\"]*", - "(ReverseProxyUserHeader:[\\s]*\")[^\"]*", - "(ReverseProxyWhitelist:[\\s]*\")[^\"]*", + "(UserHeader:[\\s]*\")[^\"]*", + "(TrustedSources:[\\s]*\")[^\"]*", "(MetricsPath:[\\s]*\")[^\"]*", "(DevAutoCreateAdminPassword:[\\s]*\")[^\"]*", "(DevAutoLoginUsername:[\\s]*\")[^\"]*", @@ -70,6 +70,7 @@ type levelPath struct { var ( currentLevel Level + loggerMu sync.RWMutex defaultLogger = logrus.New() logSourceLine = false rootPath string @@ -78,17 +79,19 @@ var ( // SetLevel sets the global log level used by the simple logger. func SetLevel(l Level) { + loggerMu.Lock() currentLevel = l defaultLogger.Level = logrus.TraceLevel + loggerMu.Unlock() logrus.SetLevel(logrus.Level(l)) } func SetLevelString(l string) { - level := levelFromString(l) + level := ParseLogLevel(l) SetLevel(level) } -func levelFromString(l string) Level { +func ParseLogLevel(l string) Level { envLevel := strings.ToLower(l) var level Level switch envLevel { @@ -110,9 +113,11 @@ func levelFromString(l string) Level { // SetLogLevels sets the log levels for specific paths in the codebase. func SetLogLevels(levels map[string]string) { + loggerMu.Lock() + defer loggerMu.Unlock() logLevels = nil for k, v := range levels { - logLevels = append(logLevels, levelPath{path: k, level: levelFromString(v)}) + logLevels = append(logLevels, levelPath{path: k, level: ParseLogLevel(v)}) } sort.Slice(logLevels, func(i, j int) bool { return logLevels[i].path > logLevels[j].path @@ -125,6 +130,8 @@ func SetLogSourceLine(enabled bool) { func SetRedacting(enabled bool) { if enabled { + loggerMu.Lock() + defer loggerMu.Unlock() defaultLogger.AddHook(redacted) } } @@ -133,16 +140,27 @@ func SetOutput(w io.Writer) { if runtime.GOOS == "windows" { w = CRLFWriter(w) } + loggerMu.Lock() + defer loggerMu.Unlock() defaultLogger.SetOutput(w) } +// EnableJournalFormat wraps the current logger formatter with syslog +// priority prefixes for systemd-journald. Only call this when output +// goes to stderr and JOURNAL_STREAM is set. +func EnableJournalFormat() { + loggerMu.Lock() + defer loggerMu.Unlock() + defaultLogger.Formatter = &journalFormatter{inner: defaultLogger.Formatter} +} + // Redact applies redaction to a single string func Redact(msg string) string { r, _ := redacted.redact(msg) return r } -func NewContext(ctx context.Context, keyValuePairs ...interface{}) context.Context { +func NewContext(ctx context.Context, keyValuePairs ...any) context.Context { if ctx == nil { ctx = context.Background() } @@ -158,10 +176,14 @@ func NewContext(ctx context.Context, keyValuePairs ...interface{}) context.Conte } func SetDefaultLogger(l *logrus.Logger) { + loggerMu.Lock() + defer loggerMu.Unlock() defaultLogger = l } func CurrentLevel() Level { + loggerMu.RLock() + defer loggerMu.RUnlock() return currentLevel } @@ -170,32 +192,32 @@ func IsGreaterOrEqualTo(level Level) bool { return shouldLog(level, 2) } -func Fatal(args ...interface{}) { - log(LevelFatal, args...) +func Fatal(args ...any) { + Log(LevelFatal, args...) os.Exit(1) } -func Error(args ...interface{}) { - log(LevelError, args...) +func Error(args ...any) { + Log(LevelError, args...) } -func Warn(args ...interface{}) { - log(LevelWarn, args...) +func Warn(args ...any) { + Log(LevelWarn, args...) } -func Info(args ...interface{}) { - log(LevelInfo, args...) +func Info(args ...any) { + Log(LevelInfo, args...) } -func Debug(args ...interface{}) { - log(LevelDebug, args...) +func Debug(args ...any) { + Log(LevelDebug, args...) } -func Trace(args ...interface{}) { - log(LevelTrace, args...) +func Trace(args ...any) { + Log(LevelTrace, args...) } -func log(level Level, args ...interface{}) { +func Log(level Level, args ...any) { if !shouldLog(level, 3) { return } @@ -203,11 +225,22 @@ func log(level Level, args ...interface{}) { logger.Log(logrus.Level(level), msg) } +func Writer() io.Writer { + loggerMu.RLock() + defer loggerMu.RUnlock() + return defaultLogger.Writer() +} + func shouldLog(requiredLevel Level, skip int) bool { - if currentLevel >= requiredLevel { + loggerMu.RLock() + level := currentLevel + levels := logLevels + loggerMu.RUnlock() + + if level >= requiredLevel { return true } - if len(logLevels) == 0 { + if len(levels) == 0 { return false } @@ -217,7 +250,7 @@ func shouldLog(requiredLevel Level, skip int) bool { } file = strings.TrimPrefix(file, rootPath) - for _, lp := range logLevels { + for _, lp := range levels { if strings.HasPrefix(file, lp.path) { return lp.level >= requiredLevel } @@ -225,7 +258,7 @@ func shouldLog(requiredLevel Level, skip int) bool { return false } -func parseArgs(args []interface{}) (*logrus.Entry, string) { +func parseArgs(args []any) (*logrus.Entry, string) { var l *logrus.Entry var err error if args[0] == nil { @@ -264,7 +297,7 @@ func parseArgs(args []interface{}) (*logrus.Entry, string) { return l, "" } -func addFields(logger *logrus.Entry, keyValuePairs []interface{}) *logrus.Entry { +func addFields(logger *logrus.Entry, keyValuePairs []any) *logrus.Entry { for i := 0; i < len(keyValuePairs); i += 2 { switch name := keyValuePairs[i].(type) { case error: @@ -291,7 +324,7 @@ func addFields(logger *logrus.Entry, keyValuePairs []interface{}) *logrus.Entry return logger } -func extractLogger(ctx interface{}) (*logrus.Entry, error) { +func extractLogger(ctx any) (*logrus.Entry, error) { switch ctx := ctx.(type) { case *logrus.Entry: return ctx, nil @@ -310,6 +343,8 @@ func extractLogger(ctx interface{}) (*logrus.Entry, error) { func createNewLogger() *logrus.Entry { //logrus.SetFormatter(&logrus.TextFormatter{ForceColors: true, DisableTimestamp: false, FullTimestamp: true}) //l.Formatter = &logrus.TextFormatter{ForceColors: true, DisableTimestamp: false, FullTimestamp: true} + loggerMu.RLock() + defer loggerMu.RUnlock() logger := logrus.NewEntry(defaultLogger) return logger } diff --git a/log/redactrus.go b/log/redactrus.go index d743e3f2d..6e17243e7 100755 --- a/log/redactrus.go +++ b/log/redactrus.go @@ -42,8 +42,9 @@ func (h *Hook) Fire(e *logrus.Entry) error { e.Data[k] = "[REDACTED]" continue } - - // Redact based on value matching in Data fields + if v == nil { + continue + } switch reflect.TypeOf(v).Kind() { case reflect.String: e.Data[k] = re.ReplaceAllString(v.(string), "$1[REDACTED]$2") diff --git a/main.go b/main.go index 65db162ac..b5fb508b4 100644 --- a/main.go +++ b/main.go @@ -9,11 +9,12 @@ import ( //goland:noinspection GoBoolExpressions func main() { - // This import is used to force the inclusion of the `netgo` tag when compiling the project. + // These references force the inclusion of build tags when compiling the project. // If you get compilation errors like "undefined: buildtags.NETGO", this means you forgot to specify - // the `netgo` build tag when compiling the project. + // the required build tags when compiling the project. // To avoid these kind of errors, you should use `make build` to compile the project. _ = buildtags.NETGO + _ = buildtags.SQLITE_FTS5 cmd.Execute() } diff --git a/model/album.go b/model/album.go index c9dc022cb..667f4695b 100644 --- a/model/album.go +++ b/model/album.go @@ -1,11 +1,14 @@ package model import ( + "fmt" "iter" "math" "sync" "time" + "github.com/navidrome/navidrome/conf" + "github.com/gohugoio/hashstructure" ) @@ -14,6 +17,8 @@ type Album struct { ID string `structs:"id" json:"id"` LibraryID int `structs:"library_id" json:"libraryId"` + LibraryPath string `structs:"-" json:"libraryPath" hash:"ignore"` + LibraryName string `structs:"-" json:"libraryName" hash:"ignore"` Name string `structs:"name" json:"name"` EmbedArtPath string `structs:"embed_art_path" json:"-"` AlbumArtistID string `structs:"album_artist_id" json:"albumArtistId"` // Deprecated, use Participants @@ -68,6 +73,13 @@ func (a Album) CoverArtID() ArtworkID { return artworkIDFromAlbum(a) } +func (a Album) FullName() string { + if conf.Server.Subsonic.AppendAlbumVersion && len(a.Tags[TagAlbumVersion]) > 0 { + return fmt.Sprintf("%s (%s)", a.Name, a.Tags[TagAlbumVersion][0]) + } + return a.Name +} + // Equals compares two Album structs, ignoring calculated fields func (a Album) Equals(other Album) bool { // Normalize float32 values to avoid false negatives diff --git a/model/album_test.go b/model/album_test.go index a45d16dd5..0f4c912cd 100644 --- a/model/album_test.go +++ b/model/album_test.go @@ -3,11 +3,30 @@ package model_test import ( "encoding/json" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" . "github.com/navidrome/navidrome/model" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) +var _ = Describe("Album", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + DescribeTable("FullName", + func(enabled bool, tags Tags, expected string) { + conf.Server.Subsonic.AppendAlbumVersion = enabled + a := Album{Name: "Album", Tags: tags} + Expect(a.FullName()).To(Equal(expected)) + }, + Entry("appends version when enabled and tag is present", true, Tags{TagAlbumVersion: []string{"Remastered"}}, "Album (Remastered)"), + Entry("returns just name when disabled", false, Tags{TagAlbumVersion: []string{"Remastered"}}, "Album"), + Entry("returns just name when tag is absent", true, Tags{}, "Album"), + Entry("returns just name when tag is an empty slice", true, Tags{TagAlbumVersion: []string{}}, "Album"), + ) +}) + var _ = Describe("Albums", func() { var albums Albums diff --git a/model/annotation.go b/model/annotation.go index 2ec72c1b7..5228028a6 100644 --- a/model/annotation.go +++ b/model/annotation.go @@ -3,11 +3,13 @@ package model import "time" type Annotations struct { - PlayCount int64 `structs:"play_count" json:"playCount,omitempty"` - PlayDate *time.Time `structs:"play_date" json:"playDate,omitempty" ` - Rating int `structs:"rating" json:"rating,omitempty" ` - Starred bool `structs:"starred" json:"starred,omitempty" ` - StarredAt *time.Time `structs:"starred_at" json:"starredAt,omitempty"` + PlayCount int64 `structs:"play_count" json:"playCount,omitempty"` + PlayDate *time.Time `structs:"play_date" json:"playDate,omitempty" ` + Rating int `structs:"rating" json:"rating,omitempty" ` + RatedAt *time.Time `structs:"rated_at" json:"ratedAt,omitempty" ` + Starred bool `structs:"starred" json:"starred,omitempty" ` + StarredAt *time.Time `structs:"starred_at" json:"starredAt,omitempty"` + AverageRating float64 `structs:"average_rating" json:"averageRating,omitempty"` } type AnnotatedRepository interface { diff --git a/model/artist.go b/model/artist.go index 68836ff28..2085f0051 100644 --- a/model/artist.go +++ b/model/artist.go @@ -4,6 +4,8 @@ import ( "maps" "slices" "time" + + "github.com/navidrome/navidrome/consts" ) type Artist struct { @@ -34,6 +36,8 @@ type Artist struct { Missing bool `structs:"missing" json:"missing"` + UploadedImage string `structs:"uploaded_image" json:"uploadedImage,omitempty"` + CreatedAt *time.Time `structs:"created_at" json:"createdAt,omitempty"` UpdatedAt *time.Time `structs:"updated_at" json:"updatedAt,omitempty"` } @@ -58,6 +62,10 @@ func (a Artist) CoverArtID() ArtworkID { return artworkIDFromArtist(a) } +func (a Artist) UploadedImagePath() string { + return UploadedImagePath(consts.EntityArtist, a.UploadedImage) +} + // Roles returns the roles this artist has participated in., based on the Stats field func (a Artist) Roles() []Role { return slices.Collect(maps.Keys(a.Stats)) @@ -78,11 +86,11 @@ type ArtistRepository interface { UpdateExternalInfo(a *Artist) error Get(id string) (*Artist, error) GetAll(options ...QueryOptions) (Artists, error) - GetIndex(includeMissing bool, roles ...Role) (ArtistIndexes, error) + GetIndex(includeMissing bool, libraryIds []int, roles ...Role) (ArtistIndexes, error) // The following methods are used exclusively by the scanner: RefreshPlayCounts() (int64, error) - RefreshStats() (int64, error) + RefreshStats(allArtists bool) (int64, error) AnnotatedRepository SearchableRepository[Artists] diff --git a/model/artist_test.go b/model/artist_test.go new file mode 100644 index 000000000..db897d3d5 --- /dev/null +++ b/model/artist_test.go @@ -0,0 +1,30 @@ +package model_test + +import ( + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Artist", func() { + Describe("UploadedImagePath", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = conf.NewDir("/data") + }) + + It("returns empty string when no image uploaded", func() { + a := model.Artist{ID: "ar-1"} + Expect(a.UploadedImagePath()).To(BeEmpty()) + }) + + It("returns full path when image is set", func() { + a := model.Artist{ID: "ar-1", UploadedImage: "ar-1_test.jpg"} + Expect(a.UploadedImagePath()).To(Equal(filepath.Join("/data", "artwork", "artist", "ar-1_test.jpg"))) + }) + }) +}) diff --git a/model/artwork_id.go b/model/artwork_id.go index 36026dd03..1bd146c1f 100644 --- a/model/artwork_id.go +++ b/model/artwork_id.go @@ -22,6 +22,8 @@ var ( KindArtistArtwork = Kind{"ar", "artist"} KindAlbumArtwork = Kind{"al", "album"} KindPlaylistArtwork = Kind{"pl", "playlist"} + KindDiscArtwork = Kind{"dc", "disc"} + KindRadioArtwork = Kind{"ra", "radio"} ) var artworkKindMap = map[string]Kind{ @@ -29,6 +31,8 @@ var artworkKindMap = map[string]Kind{ KindArtistArtwork.prefix: KindArtistArtwork, KindAlbumArtwork.prefix: KindAlbumArtwork, KindPlaylistArtwork.prefix: KindPlaylistArtwork, + KindDiscArtwork.prefix: KindDiscArtwork, + KindRadioArtwork.prefix: KindRadioArtwork, } type ArtworkID struct { @@ -91,6 +95,22 @@ func MustParseArtworkID(id string) ArtworkID { return artID } +func DiscArtworkID(albumID string, discNumber int) string { + return fmt.Sprintf("%s:%d", albumID, discNumber) +} + +func ParseDiscArtworkID(id string) (albumID string, discNumber int, err error) { + parts := strings.SplitN(id, ":", 2) + if len(parts) != 2 || parts[1] == "" { + return "", 0, errors.New("invalid disc artwork id") + } + num, err := strconv.Atoi(parts[1]) + if err != nil { + return "", 0, fmt.Errorf("invalid disc number in artwork id: %w", err) + } + return parts[0], num, nil +} + func artworkIDFromAlbum(al Album) ArtworkID { return ArtworkID{ Kind: KindAlbumArtwork, @@ -121,3 +141,11 @@ func artworkIDFromArtist(ar Artist) ArtworkID { ID: ar.ID, } } + +func artworkIDFromRadio(r Radio) ArtworkID { + return ArtworkID{ + Kind: KindRadioArtwork, + ID: r.ID, + LastUpdate: r.UpdatedAt, + } +} diff --git a/model/artwork_id_test.go b/model/artwork_id_test.go index 2f42217f9..ad66f7bb5 100644 --- a/model/artwork_id_test.go +++ b/model/artwork_id_test.go @@ -11,8 +11,7 @@ import ( var _ = Describe("ArtworkID", func() { Describe("NewArtworkID()", func() { It("creates a valid parseable ArtworkID", func() { - now := time.Now() - id := model.NewArtworkID(model.KindAlbumArtwork, "1234", &now) + id := model.NewArtworkID(model.KindAlbumArtwork, "1234", new(time.Now())) parsedId, err := model.ParseArtworkID(id.String()) Expect(err).ToNot(HaveOccurred()) Expect(parsedId.Kind).To(Equal(id.Kind)) @@ -28,6 +27,40 @@ var _ = Describe("ArtworkID", func() { Expect(parsedId.LastUpdate.Unix()).To(Equal(id.LastUpdate.Unix())) }) }) + Describe("ParseArtworkID - disc kind", func() { + It("parses a disc artwork ID with dc prefix", func() { + now := time.Now() + id := model.NewArtworkID(model.KindDiscArtwork, "albumid123:2", &now) + parsedId, err := model.ParseArtworkID(id.String()) + Expect(err).ToNot(HaveOccurred()) + Expect(parsedId.Kind).To(Equal(model.KindDiscArtwork)) + Expect(parsedId.ID).To(Equal("albumid123:2")) + Expect(parsedId.LastUpdate.Unix()).To(Equal(now.Unix())) + }) + }) + + Describe("ParseDiscArtworkID", func() { + DescribeTable("parses composite disc artwork IDs", + func(id string, expectedAlbum string, expectedDisc int, expectErr bool) { + albumID, discNumber, err := model.ParseDiscArtworkID(id) + if expectErr { + Expect(err).To(HaveOccurred()) + } else { + Expect(err).ToNot(HaveOccurred()) + Expect(albumID).To(Equal(expectedAlbum)) + Expect(discNumber).To(Equal(expectedDisc)) + } + }, + Entry("valid id", "albumid123:2", "albumid123", 2, false), + Entry("disc number 1", "abc:1", "abc", 1, false), + Entry("large disc number", "abc:10", "abc", 10, false), + Entry("missing colon", "albumid123", "", 0, true), + Entry("missing disc number", "albumid123:", "", 0, true), + Entry("non-numeric disc", "albumid123:abc", "", 0, true), + Entry("empty string", "", "", 0, true), + ) + }) + Describe("ParseArtworkID()", func() { It("parses album artwork ids", func() { id, err := model.ParseArtworkID("al-1234") diff --git a/model/criteria/criteria.go b/model/criteria/criteria.go index 493e53173..31d208d08 100644 --- a/model/criteria/criteria.go +++ b/model/criteria/criteria.go @@ -1,62 +1,62 @@ -// Package criteria implements a Criteria API based on Masterminds/squirrel +// Package criteria implements the smart playlist criteria DSL. package criteria import ( "encoding/json" "errors" - "fmt" - "strings" + "slices" - "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/log" ) -type Expression = squirrel.Sqlizer +type Expression interface { + fields() map[string]any +} type Criteria struct { Expression - Sort string - Order string - Limit int - Offset int + Sort string + Order string + Limit int + LimitPercent int + Offset int } -func (c Criteria) OrderBy() string { - if c.Sort == "" { - c.Sort = "title" +// EffectiveLimit resolves the effective limit for a query. If a fixed Limit is +// set it takes precedence. Otherwise, if LimitPercent is set, the limit is +// computed as a percentage of totalCount (minimum 1 when totalCount > 0). +// Returns 0 when no limit applies. +func (c Criteria) EffectiveLimit(totalCount int64) int { + if c.Limit > 0 { + return c.Limit } - sortField := strings.ToLower(c.Sort) - f := fieldMap[sortField] - var mapped string - if f == nil { - log.Error("Invalid field in 'sort' field. Using 'title'", "sort", c.Sort) - mapped = fieldMap["title"].field - } else { - if f.order != "" { - mapped = f.order - } else if f.isTag { - mapped = "COALESCE(json_extract(media_file.tags, '$." + sortField + "[0].value'), '')" - } else if f.isRole { - mapped = "COALESCE(json_extract(media_file.participants, '$." + sortField + "[0].name'), '')" - } else { - mapped = f.field + if c.LimitPercent > 0 && c.LimitPercent <= 100 { + if totalCount <= 0 { + return 0 } - if f.numeric { - mapped = fmt.Sprintf("CAST(%s AS REAL)", mapped) + result := int(totalCount) * c.LimitPercent / 100 + if result < 1 { + return 1 } + return result } - if c.Order != "" { - if strings.EqualFold(c.Order, "asc") || strings.EqualFold(c.Order, "desc") { - mapped = mapped + " " + c.Order - } else { - log.Error("Invalid value in 'order' field. Valid values: 'asc', 'desc'", "order", c.Order) - } - } - return mapped + return 0 } -func (c Criteria) ToSql() (sql string, args []any, err error) { - return c.Expression.ToSql() +// ResolveLimit converts a percentage-based limit into an absolute Limit using +// the given totalCount. It is a no-op when a fixed Limit is already set or when +// no percentage limit is configured. +func (c *Criteria) ResolveLimit(totalCount int64) { + if !c.IsPercentageLimit() { + return + } + c.Limit = c.EffectiveLimit(totalCount) +} + +// IsPercentageLimit returns true when the criteria uses a valid percentage-based +// limit (i.e. LimitPercent is in [1, 100] and no fixed Limit overrides it). +func (c Criteria) IsPercentageLimit() bool { + return c.Limit == 0 && c.LimitPercent > 0 && c.LimitPercent <= 100 } func (c Criteria) ChildPlaylistIds() []string { @@ -64,26 +64,31 @@ func (c Criteria) ChildPlaylistIds() []string { return nil } - if parent := c.Expression.(interface{ ChildPlaylistIds() (ids []string) }); parent != nil { - return parent.ChildPlaylistIds() + parent, ok := c.Expression.(conjunction) + if !ok { + return nil } - return nil + ids := parent.ChildPlaylistIds() + slices.Sort(ids) + return slices.Compact(ids) } func (c Criteria) MarshalJSON() ([]byte, error) { aux := struct { - All []Expression `json:"all,omitempty"` - Any []Expression `json:"any,omitempty"` - Sort string `json:"sort,omitempty"` - Order string `json:"order,omitempty"` - Limit int `json:"limit,omitempty"` - Offset int `json:"offset,omitempty"` + All []Expression `json:"all,omitempty"` + Any []Expression `json:"any,omitempty"` + Sort string `json:"sort,omitempty"` + Order string `json:"order,omitempty"` + Limit int `json:"limit,omitempty"` + LimitPercent int `json:"limitPercent,omitempty"` + Offset int `json:"offset,omitempty"` }{ - Sort: c.Sort, - Order: c.Order, - Limit: c.Limit, - Offset: c.Offset, + Sort: c.Sort, + Order: c.Order, + Limit: c.Limit, + LimitPercent: c.LimitPercent, + Offset: c.Offset, } switch rules := c.Expression.(type) { case Any: @@ -98,12 +103,13 @@ func (c Criteria) MarshalJSON() ([]byte, error) { func (c *Criteria) UnmarshalJSON(data []byte) error { var aux struct { - All unmarshalConjunctionType `json:"all"` - Any unmarshalConjunctionType `json:"any"` - Sort string `json:"sort"` - Order string `json:"order"` - Limit int `json:"limit"` - Offset int `json:"offset"` + All unmarshalConjunctionType `json:"all"` + Any unmarshalConjunctionType `json:"any"` + Sort string `json:"sort"` + Order string `json:"order"` + Limit int `json:"limit"` + LimitPercent int `json:"limitPercent"` + Offset int `json:"offset"` } if err := json.Unmarshal(data, &aux); err != nil { return err @@ -119,5 +125,15 @@ func (c *Criteria) UnmarshalJSON(data []byte) error { c.Order = aux.Order c.Limit = aux.Limit c.Offset = aux.Offset + + // Clamp LimitPercent to [0, 100] + if aux.LimitPercent < 0 { + log.Warn("limitPercent value out of range, clamping to 0", "value", aux.LimitPercent) + aux.LimitPercent = 0 + } else if aux.LimitPercent > 100 { + log.Warn("limitPercent value out of range, clamping to 100", "value", aux.LimitPercent) + aux.LimitPercent = 100 + } + c.LimitPercent = aux.LimitPercent return nil } diff --git a/model/criteria/criteria_test.go b/model/criteria/criteria_test.go index 7afb6ec0d..092cfd36a 100644 --- a/model/criteria/criteria_test.go +++ b/model/criteria/criteria_test.go @@ -27,6 +27,7 @@ var _ = Describe("Criteria", func() { StartsWith{"comment": "this"}, InTheRange{"year": []int{1980, 1990}}, IsNot{"genre": "Rock"}, + Gt{"albumrating": 3}, }, }, Sort: "title", @@ -48,7 +49,8 @@ var _ = Describe("Criteria", func() { { "all": [ { "startsWith": {"comment": "this"} }, { "inTheRange": {"year":[1980,1990]} }, - { "isNot": { "genre": "Rock" }} + { "isNot": { "genre": "Rock" }}, + { "gt": { "albumrating": 3 } } ] } ], @@ -63,16 +65,6 @@ var _ = Describe("Criteria", func() { } jsonObj = b.String() }) - It("generates valid SQL", func() { - sql, args, err := goObj.ToSql() - gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal( - `(media_file.title LIKE ? AND media_file.title NOT LIKE ? ` + - `AND (not exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?) ` + - `OR media_file.album = ?) AND (media_file.comment LIKE ? AND (media_file.year >= ? AND media_file.year <= ?) ` + - `AND not exists (select 1 from json_tree(tags, '$.genre') where key='value' and value = ?)))`)) - gomega.Expect(args).To(gomega.HaveExactElements("%love%", "%hate%", "u2", "best of", "this%", 1980, 1990, "Rock")) - }) It("marshals to JSON", func() { j, err := json.Marshal(goObj) gomega.Expect(err).ToNot(gomega.HaveOccurred()) @@ -86,64 +78,158 @@ var _ = Describe("Criteria", func() { gomega.Expect(err).ToNot(gomega.HaveOccurred()) gomega.Expect(string(j)).To(gomega.Equal(jsonObj)) }) - Describe("OrderBy", func() { - It("sorts by regular fields", func() { - gomega.Expect(goObj.OrderBy()).To(gomega.Equal("media_file.title asc")) - }) - - It("sorts by tag fields", func() { - goObj.Sort = "genre" - gomega.Expect(goObj.OrderBy()).To( - gomega.Equal( - "COALESCE(json_extract(media_file.tags, '$.genre[0].value'), '') asc", - ), - ) - }) - - It("sorts by role fields", func() { - goObj.Sort = "artist" - gomega.Expect(goObj.OrderBy()).To( - gomega.Equal( - "COALESCE(json_extract(media_file.participants, '$.artist[0].name'), '') asc", - ), - ) - }) - - It("casts numeric tags when sorting", func() { - AddTagNames([]string{"rate"}) - AddNumericTags([]string{"rate"}) - goObj.Sort = "rate" - gomega.Expect(goObj.OrderBy()).To( - gomega.Equal("CAST(COALESCE(json_extract(media_file.tags, '$.rate[0].value'), '') AS REAL) asc"), - ) - }) - - It("sorts by random", func() { - newObj := goObj - newObj.Sort = "random" - gomega.Expect(newObj.OrderBy()).To(gomega.Equal("random() asc")) - }) - }) }) - Context("with artist roles", func() { - BeforeEach(func() { - goObj = Criteria{ - Expression: All{ - Is{"artist": "The Beatles"}, - Contains{"composer": "Lennon"}, - }, - } + Describe("LimitPercent", func() { + Describe("JSON round-trip", func() { + It("marshals and unmarshals limitPercent", func() { + goObj := Criteria{ + Expression: All{Contains{"title": "love"}}, + Sort: "title", + Order: "asc", + LimitPercent: 10, + } + j, err := json.Marshal(goObj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(string(j)).To(gomega.ContainSubstring(`"limitPercent":10`)) + gomega.Expect(string(j)).ToNot(gomega.ContainSubstring(`"limit"`)) + + var newObj Criteria + err = json.Unmarshal(j, &newObj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(newObj.LimitPercent).To(gomega.Equal(10)) + gomega.Expect(newObj.Limit).To(gomega.Equal(0)) + }) + + It("does not include limitPercent when zero", func() { + goObj := Criteria{ + Expression: All{Contains{"title": "love"}}, + Limit: 50, + } + j, err := json.Marshal(goObj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(string(j)).To(gomega.ContainSubstring(`"limit":50`)) + gomega.Expect(string(j)).ToNot(gomega.ContainSubstring(`limitPercent`)) + }) + + It("backward compatible: JSON with only limit still works", func() { + jsonStr := `{"all":[{"contains":{"title":"love"}}],"limit":20}` + var c Criteria + err := json.Unmarshal([]byte(jsonStr), &c) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(c.Limit).To(gomega.Equal(20)) + gomega.Expect(c.LimitPercent).To(gomega.Equal(0)) + }) }) - It("generates valid SQL", func() { - sql, args, err := goObj.ToSql() - gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal( - `(exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?) AND ` + - `exists (select 1 from json_tree(participants, '$.composer') where key='name' and value LIKE ?))`, - )) - gomega.Expect(args).To(gomega.HaveExactElements("The Beatles", "%Lennon%")) + Describe("UnmarshalJSON clamping", func() { + It("clamps values above 100 to 100", func() { + jsonStr := `{"all":[{"contains":{"title":"love"}}],"limitPercent":150}` + var c Criteria + err := json.Unmarshal([]byte(jsonStr), &c) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(c.LimitPercent).To(gomega.Equal(100)) + }) + + It("clamps negative values to 0", func() { + jsonStr := `{"all":[{"contains":{"title":"love"}}],"limitPercent":-5}` + var c Criteria + err := json.Unmarshal([]byte(jsonStr), &c) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(c.LimitPercent).To(gomega.Equal(0)) + }) + }) + + Describe("EffectiveLimit", func() { + It("returns fixed limit when Limit is set", func() { + c := Criteria{Limit: 50, LimitPercent: 10} + gomega.Expect(c.EffectiveLimit(1000)).To(gomega.Equal(50)) + }) + + It("returns percentage-based limit", func() { + c := Criteria{LimitPercent: 10} + gomega.Expect(c.EffectiveLimit(450)).To(gomega.Equal(45)) + }) + + It("returns minimum 1 when totalCount > 0 and percentage rounds to 0", func() { + c := Criteria{LimitPercent: 1} + gomega.Expect(c.EffectiveLimit(5)).To(gomega.Equal(1)) + }) + + It("returns 0 when totalCount is 0", func() { + c := Criteria{LimitPercent: 10} + gomega.Expect(c.EffectiveLimit(0)).To(gomega.Equal(0)) + }) + + It("returns 0 when no limit is set", func() { + c := Criteria{} + gomega.Expect(c.EffectiveLimit(1000)).To(gomega.Equal(0)) + }) + + It("returns full count for 100%", func() { + c := Criteria{LimitPercent: 100} + gomega.Expect(c.EffectiveLimit(450)).To(gomega.Equal(450)) + }) + + It("returns 1 for 1% of 50 items", func() { + c := Criteria{LimitPercent: 1} + gomega.Expect(c.EffectiveLimit(50)).To(gomega.Equal(1)) + }) + }) + + Describe("ResolveLimit", func() { + It("resolves percentage to absolute limit preserving LimitPercent", func() { + c := Criteria{LimitPercent: 10} + c.ResolveLimit(450) + gomega.Expect(c.Limit).To(gomega.Equal(45)) + }) + + It("does nothing when Limit is already set", func() { + c := Criteria{Limit: 50, LimitPercent: 10} + c.ResolveLimit(1000) + gomega.Expect(c.Limit).To(gomega.Equal(50)) + }) + + It("does nothing when no limit is configured", func() { + c := Criteria{} + c.ResolveLimit(1000) + gomega.Expect(c.Limit).To(gomega.Equal(0)) + }) + + It("sets minimum 1 when percentage rounds to 0 and totalCount > 0", func() { + c := Criteria{LimitPercent: 1} + c.ResolveLimit(5) + gomega.Expect(c.Limit).To(gomega.Equal(1)) + }) + + It("is idempotent when called twice", func() { + c := Criteria{LimitPercent: 10} + c.ResolveLimit(450) + c.ResolveLimit(450) + gomega.Expect(c.Limit).To(gomega.Equal(45)) + }) + }) + + Describe("IsPercentageLimit", func() { + It("returns true when LimitPercent is set and Limit is 0", func() { + c := Criteria{LimitPercent: 10} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeTrue()) + }) + + It("returns false when Limit is set", func() { + c := Criteria{Limit: 50, LimitPercent: 10} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeFalse()) + }) + + It("returns false when neither is set", func() { + c := Criteria{} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeFalse()) + }) + + It("returns false when LimitPercent is out of range", func() { + c := Criteria{LimitPercent: 150} + gomega.Expect(c.IsPercentageLimit()).To(gomega.BeFalse()) + }) }) }) @@ -212,5 +298,23 @@ var _ = Describe("Criteria", func() { ids := Criteria{}.ChildPlaylistIds() gomega.Expect(ids).To(gomega.BeEmpty()) }) + It("returns empty list for leaf expressions", func() { + ids := Criteria{Expression: Is{"title": "Low Rider"}}.ChildPlaylistIds() + gomega.Expect(ids).To(gomega.BeEmpty()) + }) + It("deduplicates repeated playlist IDs", func() { + sharedID := uuid.NewString() + goObj = Criteria{ + Expression: All{ + InPlaylist{"id": sharedID}, + Any{ + InPlaylist{"id": sharedID}, + NotInPlaylist{"id": sharedID}, + }, + }, + } + ids := goObj.ChildPlaylistIds() + gomega.Expect(ids).To(gomega.Equal([]string{sharedID})) + }) }) }) diff --git a/model/criteria/export_test.go b/model/criteria/export_test.go index 9f3f3922b..e2109aa1a 100644 --- a/model/criteria/export_test.go +++ b/model/criteria/export_test.go @@ -1,5 +1,3 @@ package criteria -var StartOfPeriod = startOfPeriod - type UnmarshalConjunctionType = unmarshalConjunctionType diff --git a/model/criteria/fields.go b/model/criteria/fields.go index b7178e540..9eafff7ab 100644 --- a/model/criteria/fields.go +++ b/model/criteria/fields.go @@ -1,227 +1,164 @@ package criteria -import ( - "fmt" - "reflect" - "strings" +import "strings" - "github.com/Masterminds/squirrel" - "github.com/navidrome/navidrome/log" -) +// FieldInfo contains semantic metadata about a criteria field. +type FieldInfo struct { + Alias string // If set, this field is a backward-compat alias for another canonical name + IsTag bool + IsRole bool + Numeric bool + Boolean bool -var fieldMap = map[string]*mappedField{ - "title": {field: "media_file.title"}, - "album": {field: "media_file.album"}, - "hascoverart": {field: "media_file.has_cover_art"}, - "tracknumber": {field: "media_file.track_number"}, - "discnumber": {field: "media_file.disc_number"}, - "year": {field: "media_file.year"}, - "date": {field: "media_file.date", alias: "recordingdate"}, - "originalyear": {field: "media_file.original_year"}, - "originaldate": {field: "media_file.original_date"}, - "releaseyear": {field: "media_file.release_year"}, - "releasedate": {field: "media_file.release_date"}, - "size": {field: "media_file.size"}, - "compilation": {field: "media_file.compilation"}, - "dateadded": {field: "media_file.created_at"}, - "datemodified": {field: "media_file.updated_at"}, - "discsubtitle": {field: "media_file.disc_subtitle"}, - "comment": {field: "media_file.comment"}, - "lyrics": {field: "media_file.lyrics"}, - "sorttitle": {field: "media_file.sort_title"}, - "sortalbum": {field: "media_file.sort_album_name"}, - "sortartist": {field: "media_file.sort_artist_name"}, - "sortalbumartist": {field: "media_file.sort_album_artist_name"}, - "albumtype": {field: "media_file.mbz_album_type", alias: "releasetype"}, - "albumcomment": {field: "media_file.mbz_album_comment"}, - "catalognumber": {field: "media_file.catalog_num"}, - "filepath": {field: "media_file.path"}, - "filetype": {field: "media_file.suffix"}, - "duration": {field: "media_file.duration"}, - "bitrate": {field: "media_file.bit_rate"}, - "bitdepth": {field: "media_file.bit_depth"}, - "bpm": {field: "media_file.bpm"}, - "channels": {field: "media_file.channels"}, - "loved": {field: "COALESCE(annotation.starred, false)"}, - "dateloved": {field: "annotation.starred_at"}, - "lastplayed": {field: "annotation.play_date"}, - "playcount": {field: "COALESCE(annotation.play_count, 0)"}, - "rating": {field: "COALESCE(annotation.rating, 0)"}, - - // special fields - "random": {field: "", order: "random()"}, // pseudo-field for random sorting - "value": {field: "value"}, // pseudo-field for tag and roles values + tagAlias string // If set, a tag name from mappings.yml that resolves to this field + name string // Canonical name, populated by LookupField from the map key } -type mappedField struct { - field string - order string - isRole bool // true if the field is a role (e.g. "artist", "composer", "conductor", etc.) - isTag bool // true if the field is a tag imported from the file metadata - alias string // name from `mappings.yml` that may differ from the name used in the smart playlist - numeric bool // true if the field/tag should be treated as numeric +// Name returns the canonical field name (the map key used to register this field). +func (f FieldInfo) Name() string { + return f.name } -func mapFields(expr map[string]any) map[string]any { - m := make(map[string]any) - for f, v := range expr { - if dbf := fieldMap[strings.ToLower(f)]; dbf != nil && dbf.field != "" { - m[dbf.field] = v +var fieldMap = map[string]FieldInfo{ + "title": {}, + "album": {}, + "hascoverart": {Boolean: true}, + "tracknumber": {}, + "discnumber": {}, + "year": {}, + "date": {tagAlias: "recordingdate"}, + "originalyear": {}, + "originaldate": {}, + "releaseyear": {}, + "releasedate": {}, + "size": {}, + "compilation": {Boolean: true}, + "missing": {Boolean: true}, + "explicitstatus": {}, + "dateadded": {}, + "datemodified": {}, + "discsubtitle": {}, + "comment": {}, + "lyrics": {}, + "sorttitle": {}, + "sortalbum": {}, + "sortartist": {}, + "sortalbumartist": {}, + "albumcomment": {}, + "catalognumber": {}, + "filepath": {}, + "filetype": {}, + "codec": {}, + "duration": {}, + "bitrate": {}, + "bitdepth": {}, + "samplerate": {}, + "bpm": {}, + "channels": {}, + "loved": {Boolean: true}, + "dateloved": {}, + "lastplayed": {}, + "daterated": {}, + "playcount": {}, + "rating": {}, + "averagerating": {Numeric: true}, + "albumrating": {}, + "albumloved": {Boolean: true}, + "albumplaycount": {}, + "albumlastplayed": {}, + "albumdateloved": {}, + "albumdaterated": {}, + "artistrating": {}, + "artistloved": {Boolean: true}, + "artistplaycount": {}, + "artistlastplayed": {}, + "artistdateloved": {}, + "artistdaterated": {}, + "mbz_album_id": {}, + "mbz_album_artist_id": {}, + "mbz_artist_id": {}, + "mbz_recording_id": {}, + "mbz_release_track_id": {}, + "mbz_release_group_id": {}, + "rgalbumgain": {Numeric: true}, + "rgalbumpeak": {Numeric: true}, + "rgtrackgain": {Numeric: true}, + "rgtrackpeak": {Numeric: true}, + "library_id": {Numeric: true}, + + // Backward compatibility: albumtype is an alias for the releasetype tag. + "albumtype": {Alias: "releasetype", IsTag: true}, + + // Pseudo-field for random sorting + "random": {}, +} + +// AllFieldNames returns the names of all registered criteria fields. +func AllFieldNames() []string { + names := make([]string, 0, len(fieldMap)) + for name := range fieldMap { + names = append(names, name) + } + return names +} + +// LookupField returns semantic metadata for a criteria field name. +func LookupField(name string) (FieldInfo, bool) { + key := strings.ToLower(name) + f, ok := fieldMap[key] + if ok { + if f.Alias != "" { + f.name = f.Alias } else { - log.Error("Invalid field in criteria", "field", f) + f.name = key } } - return m -} - -// mapExpr maps a normal field expression to a specific type of expression (tag or role). -// This is required because tags are handled differently than other fields, -// as they are stored as a JSON column in the database. -func mapExpr(expr squirrel.Sqlizer, negate bool, exprFunc func(string, squirrel.Sqlizer, bool) squirrel.Sqlizer) squirrel.Sqlizer { - rv := reflect.ValueOf(expr) - if rv.Kind() != reflect.Map || rv.Type().Key().Kind() != reflect.String { - log.Fatal(fmt.Sprintf("expr is not a map-based operator: %T", expr)) - } - - // Extract into a generic map - var k string - m := make(map[string]any, rv.Len()) - for _, key := range rv.MapKeys() { - // Save the key to build the expression, and use the provided keyName as the key - k = key.String() - m["value"] = rv.MapIndex(key).Interface() - break // only one key is expected (and supported) - } - - // Clear the original map - for _, key := range rv.MapKeys() { - rv.SetMapIndex(key, reflect.Value{}) - } - - // Write the updated map back into the original variable - for key, val := range m { - rv.SetMapIndex(reflect.ValueOf(key), reflect.ValueOf(val)) - } - - return exprFunc(k, expr, negate) -} - -// mapTagExpr maps a normal field expression to a tag expression. -func mapTagExpr(expr squirrel.Sqlizer, negate bool) squirrel.Sqlizer { - return mapExpr(expr, negate, tagExpr) -} - -// mapRoleExpr maps a normal field expression to an artist role expression. -func mapRoleExpr(expr squirrel.Sqlizer, negate bool) squirrel.Sqlizer { - return mapExpr(expr, negate, roleExpr) -} - -func isTagExpr(expr map[string]any) bool { - for f := range expr { - if f2, ok := fieldMap[strings.ToLower(f)]; ok && f2.isTag { - return true - } - } - return false -} - -func isRoleExpr(expr map[string]any) bool { - for f := range expr { - if f2, ok := fieldMap[strings.ToLower(f)]; ok && f2.isRole { - return true - } - } - return false -} - -func tagExpr(tag string, cond squirrel.Sqlizer, negate bool) squirrel.Sqlizer { - return tagCond{tag: tag, cond: cond, not: negate} -} - -type tagCond struct { - tag string - cond squirrel.Sqlizer - not bool -} - -func (e tagCond) ToSql() (string, []any, error) { - cond, args, err := e.cond.ToSql() - - // Check if this tag is marked as numeric in the fieldMap - if fm, ok := fieldMap[e.tag]; ok && fm.numeric { - cond = strings.ReplaceAll(cond, "value", "CAST(value AS REAL)") - } - - cond = fmt.Sprintf("exists (select 1 from json_tree(tags, '$.%s') where key='value' and %s)", - e.tag, cond) - if e.not { - cond = "not " + cond - } - return cond, args, err -} - -func roleExpr(role string, cond squirrel.Sqlizer, negate bool) squirrel.Sqlizer { - return roleCond{role: role, cond: cond, not: negate} -} - -type roleCond struct { - role string - cond squirrel.Sqlizer - not bool -} - -func (e roleCond) ToSql() (string, []any, error) { - cond, args, err := e.cond.ToSql() - cond = fmt.Sprintf(`exists (select 1 from json_tree(participants, '$.%s') where key='name' and %s)`, - e.role, cond) - if e.not { - cond = "not " + cond - } - return cond, args, err + return f, ok } // AddRoles adds roles to the field map. This is used to add all artist roles to the field map, so they can be used in -// smart playlists. If a role already exists in the field map, it is ignored, so calls to this function are idempotent. +// smart playlists. func AddRoles(roles []string) { for _, role := range roles { name := strings.ToLower(role) if _, ok := fieldMap[name]; ok { continue } - fieldMap[name] = &mappedField{field: name, isRole: true} + fieldMap[name] = FieldInfo{IsRole: true} } } // AddTagNames adds tag names to the field map. This is used to add all tags mapped in the `mappings.yml` -// file to the field map, so they can be used in smart playlists. -// If a tag name already exists in the field map, it is ignored, so calls to this function are idempotent. +// configuration file. func AddTagNames(tagNames []string) { - for _, name := range tagNames { - name := strings.ToLower(name) + for _, tagName := range tagNames { + name := strings.ToLower(tagName) if _, ok := fieldMap[name]; ok { continue } - for _, fm := range fieldMap { - if fm.alias == name { + for key, fm := range fieldMap { + if fm.tagAlias == name { + fm.Alias = key + fm.tagAlias = "" fieldMap[name] = fm break } } if _, ok := fieldMap[name]; !ok { - fieldMap[name] = &mappedField{field: name, isTag: true} + fieldMap[name] = FieldInfo{IsTag: true} } } } -// AddNumericTags marks the given tag names as numeric so they can be cast -// when used in comparisons or sorting. +// AddNumericTags adds tags that should be treated as numbers. func AddNumericTags(tagNames []string) { - for _, name := range tagNames { - name := strings.ToLower(name) + for _, tagName := range tagNames { + name := strings.ToLower(tagName) if fm, ok := fieldMap[name]; ok { - fm.numeric = true + fm.Numeric = true + fieldMap[name] = fm } else { - fieldMap[name] = &mappedField{field: name, isTag: true, numeric: true} + fieldMap[name] = FieldInfo{IsTag: true, Numeric: true} } } } diff --git a/model/criteria/fields_test.go b/model/criteria/fields_test.go index accdebd3d..5b6f53341 100644 --- a/model/criteria/fields_test.go +++ b/model/criteria/fields_test.go @@ -6,11 +6,52 @@ import ( ) var _ = Describe("fields", func() { - Describe("mapFields", func() { - It("ignores random fields", func() { - m := map[string]any{"random": "123"} - m = mapFields(m) - gomega.Expect(m).To(gomega.BeEmpty()) + Describe("LookupField", func() { + It("finds built-in fields case-insensitively", func() { + field, ok := LookupField("Title") + + gomega.Expect(ok).To(gomega.BeTrue()) + gomega.Expect(field.Name()).To(gomega.Equal("title")) }) + + It("resolves aliases to their canonical field name", func() { + field, ok := LookupField("albumtype") + + gomega.Expect(ok).To(gomega.BeTrue()) + gomega.Expect(field.Name()).To(gomega.Equal("releasetype")) + gomega.Expect(field.IsTag).To(gomega.BeTrue()) + }) + + It("finds registered tag names", func() { + AddTagNames([]string{"task3_mood"}) + + field, ok := LookupField("task3_mood") + + gomega.Expect(ok).To(gomega.BeTrue()) + gomega.Expect(field.Name()).To(gomega.Equal("task3_mood")) + gomega.Expect(field.IsTag).To(gomega.BeTrue()) + }) + + It("marks registered numeric tags", func() { + AddTagNames([]string{"task3_score"}) + AddNumericTags([]string{"task3_score"}) + + field, ok := LookupField("task3_score") + + gomega.Expect(ok).To(gomega.BeTrue()) + gomega.Expect(field.IsTag).To(gomega.BeTrue()) + gomega.Expect(field.Numeric).To(gomega.BeTrue()) + }) + + It("finds registered roles", func() { + AddRoles([]string{"task3_producer"}) + + field, ok := LookupField("task3_producer") + + gomega.Expect(ok).To(gomega.BeTrue()) + gomega.Expect(field.Name()).To(gomega.Equal("task3_producer")) + gomega.Expect(field.IsRole).To(gomega.BeTrue()) + }) + }) }) diff --git a/model/criteria/json.go b/model/criteria/json.go index f6ab56eda..ca47ceb95 100644 --- a/model/criteria/json.go +++ b/model/criteria/json.go @@ -3,6 +3,7 @@ package criteria import ( "encoding/json" "fmt" + "strconv" "strings" ) @@ -38,6 +39,7 @@ func unmarshalExpression(opName string, rawValue json.RawMessage) Expression { if err != nil { return nil } + normalizeBoolFields(m) switch opName { case "is": return Is(m) @@ -69,10 +71,48 @@ func unmarshalExpression(opName string, rawValue json.RawMessage) Expression { return InPlaylist(m) case "notinplaylist": return NotInPlaylist(m) + case "ismissing": + normalizeAllBoolFields(m) + return IsMissing(m) + case "ispresent": + normalizeAllBoolFields(m) + return IsPresent(m) } return nil } +func normalizeAllBoolFields(m map[string]any) { + for k, v := range m { + m[k] = normalizeBoolValue(v) + } +} + +func normalizeBoolFields(m map[string]any) { + for field, value := range m { + info, ok := LookupField(field) + if ok && info.Boolean { + m[field] = normalizeBoolValue(value) + } + } +} + +func normalizeBoolValue(v any) any { + switch val := v.(type) { + case string: + if b, err := strconv.ParseBool(val); err == nil { + return b + } + case float64: + if val == 1 { + return true + } + if val == 0 { + return false + } + } + return v +} + func unmarshalConjunction(conjName string, rawValue json.RawMessage) Expression { var items unmarshalConjunctionType err := json.Unmarshal(rawValue, &items) diff --git a/model/criteria/operators.go b/model/criteria/operators.go index 336f914de..14a02ff4b 100644 --- a/model/criteria/operators.go +++ b/model/criteria/operators.go @@ -1,23 +1,16 @@ package criteria -import ( - "errors" - "fmt" - "reflect" - "strconv" - "time" - - "github.com/Masterminds/squirrel" -) +// Conjunctions need to implement this interface, to allow Criteria to extract child playlist IDs recursively +type conjunction interface { + ChildPlaylistIds() []string +} type ( - All squirrel.And + All []Expression And = All ) -func (all All) ToSql() (sql string, args []any, err error) { - return squirrel.And(all).ToSql() -} +func (All) fields() map[string]any { return nil } func (all All) MarshalJSON() ([]byte, error) { return marshalConjunction("all", all) @@ -28,13 +21,11 @@ func (all All) ChildPlaylistIds() (ids []string) { } type ( - Any squirrel.Or + Any []Expression Or = Any ) -func (any Any) ToSql() (sql string, args []any, err error) { - return squirrel.Or(any).ToSql() -} +func (Any) fields() map[string]any { return nil } func (any Any) MarshalJSON() ([]byte, error) { return marshalConjunction("any", any) @@ -44,288 +35,143 @@ func (any Any) ChildPlaylistIds() (ids []string) { return extractPlaylistIds(any) } -type Is squirrel.Eq +type Is map[string]any type Eq = Is -func (is Is) ToSql() (sql string, args []any, err error) { - if isRoleExpr(is) { - return mapRoleExpr(is, false).ToSql() - } - if isTagExpr(is) { - return mapTagExpr(is, false).ToSql() - } - return squirrel.Eq(mapFields(is)).ToSql() -} - func (is Is) MarshalJSON() ([]byte, error) { return marshalExpression("is", is) } -type IsNot squirrel.NotEq +func (is Is) fields() map[string]any { return is } -func (in IsNot) ToSql() (sql string, args []any, err error) { - if isRoleExpr(in) { - return mapRoleExpr(squirrel.Eq(in), true).ToSql() - } - if isTagExpr(in) { - return mapTagExpr(squirrel.Eq(in), true).ToSql() - } - return squirrel.NotEq(mapFields(in)).ToSql() +type IsNot map[string]any + +func (isn IsNot) MarshalJSON() ([]byte, error) { + return marshalExpression("isNot", isn) } -func (in IsNot) MarshalJSON() ([]byte, error) { - return marshalExpression("isNot", in) -} +func (isn IsNot) fields() map[string]any { return isn } -type Gt squirrel.Gt - -func (gt Gt) ToSql() (sql string, args []any, err error) { - if isTagExpr(gt) { - return mapTagExpr(gt, false).ToSql() - } - return squirrel.Gt(mapFields(gt)).ToSql() -} +type Gt map[string]any func (gt Gt) MarshalJSON() ([]byte, error) { return marshalExpression("gt", gt) } -type Lt squirrel.Lt +func (gt Gt) fields() map[string]any { return gt } -func (lt Lt) ToSql() (sql string, args []any, err error) { - if isTagExpr(lt) { - return mapTagExpr(squirrel.Lt(lt), false).ToSql() - } - return squirrel.Lt(mapFields(lt)).ToSql() -} +type Lt map[string]any func (lt Lt) MarshalJSON() ([]byte, error) { return marshalExpression("lt", lt) } -type Before squirrel.Lt +func (lt Lt) fields() map[string]any { return lt } -func (bf Before) ToSql() (sql string, args []any, err error) { - return Lt(bf).ToSql() -} +type Before map[string]any func (bf Before) MarshalJSON() ([]byte, error) { return marshalExpression("before", bf) } -type After Gt +func (bf Before) fields() map[string]any { return bf } -func (af After) ToSql() (sql string, args []any, err error) { - return Gt(af).ToSql() -} +type After Gt func (af After) MarshalJSON() ([]byte, error) { return marshalExpression("after", af) } -type Contains map[string]any +func (af After) fields() map[string]any { return af } -func (ct Contains) ToSql() (sql string, args []any, err error) { - lk := squirrel.Like{} - for f, v := range mapFields(ct) { - lk[f] = fmt.Sprintf("%%%s%%", v) - } - if isRoleExpr(ct) { - return mapRoleExpr(lk, false).ToSql() - } - if isTagExpr(ct) { - return mapTagExpr(lk, false).ToSql() - } - return lk.ToSql() -} +type Contains map[string]any func (ct Contains) MarshalJSON() ([]byte, error) { return marshalExpression("contains", ct) } -type NotContains map[string]any +func (ct Contains) fields() map[string]any { return ct } -func (nct NotContains) ToSql() (sql string, args []any, err error) { - lk := squirrel.NotLike{} - for f, v := range mapFields(nct) { - lk[f] = fmt.Sprintf("%%%s%%", v) - } - if isRoleExpr(nct) { - return mapRoleExpr(squirrel.Like(lk), true).ToSql() - } - if isTagExpr(nct) { - return mapTagExpr(squirrel.Like(lk), true).ToSql() - } - return lk.ToSql() -} +type NotContains map[string]any func (nct NotContains) MarshalJSON() ([]byte, error) { return marshalExpression("notContains", nct) } -type StartsWith map[string]any +func (nct NotContains) fields() map[string]any { return nct } -func (sw StartsWith) ToSql() (sql string, args []any, err error) { - lk := squirrel.Like{} - for f, v := range mapFields(sw) { - lk[f] = fmt.Sprintf("%s%%", v) - } - if isRoleExpr(sw) { - return mapRoleExpr(lk, false).ToSql() - } - if isTagExpr(sw) { - return mapTagExpr(lk, false).ToSql() - } - return lk.ToSql() -} +type StartsWith map[string]any func (sw StartsWith) MarshalJSON() ([]byte, error) { return marshalExpression("startsWith", sw) } +func (sw StartsWith) fields() map[string]any { return sw } + type EndsWith map[string]any -func (sw EndsWith) ToSql() (sql string, args []any, err error) { - lk := squirrel.Like{} - for f, v := range mapFields(sw) { - lk[f] = fmt.Sprintf("%%%s", v) - } - if isRoleExpr(sw) { - return mapRoleExpr(lk, false).ToSql() - } - if isTagExpr(sw) { - return mapTagExpr(lk, false).ToSql() - } - return lk.ToSql() +func (ew EndsWith) MarshalJSON() ([]byte, error) { + return marshalExpression("endsWith", ew) } -func (sw EndsWith) MarshalJSON() ([]byte, error) { - return marshalExpression("endsWith", sw) -} +func (ew EndsWith) fields() map[string]any { return ew } type InTheRange map[string]any -func (itr InTheRange) ToSql() (sql string, args []any, err error) { - and := squirrel.And{} - for f, v := range mapFields(itr) { - s := reflect.ValueOf(v) - if s.Kind() != reflect.Slice || s.Len() != 2 { - return "", nil, fmt.Errorf("invalid range for 'in' operator: %s", v) - } - and = append(and, - squirrel.GtOrEq{f: s.Index(0).Interface()}, - squirrel.LtOrEq{f: s.Index(1).Interface()}, - ) - } - return and.ToSql() -} - func (itr InTheRange) MarshalJSON() ([]byte, error) { return marshalExpression("inTheRange", itr) } -type InTheLast map[string]any +func (itr InTheRange) fields() map[string]any { return itr } -func (itl InTheLast) ToSql() (sql string, args []any, err error) { - exp, err := inPeriod(itl, false) - if err != nil { - return "", nil, err - } - return exp.ToSql() -} +type InTheLast map[string]any func (itl InTheLast) MarshalJSON() ([]byte, error) { return marshalExpression("inTheLast", itl) } -type NotInTheLast map[string]any +func (itl InTheLast) fields() map[string]any { return itl } -func (nitl NotInTheLast) ToSql() (sql string, args []any, err error) { - exp, err := inPeriod(nitl, true) - if err != nil { - return "", nil, err - } - return exp.ToSql() -} +type NotInTheLast map[string]any func (nitl NotInTheLast) MarshalJSON() ([]byte, error) { return marshalExpression("notInTheLast", nitl) } -func inPeriod(m map[string]any, negate bool) (Expression, error) { - var field string - var value any - for f, v := range mapFields(m) { - field, value = f, v - break - } - str := fmt.Sprintf("%v", value) - v, err := strconv.ParseInt(str, 10, 64) - if err != nil { - return nil, err - } - firstDate := startOfPeriod(v, time.Now()) - - if negate { - return Or{ - squirrel.Lt{field: firstDate}, - squirrel.Eq{field: nil}, - }, nil - } - return squirrel.Gt{field: firstDate}, nil -} - -func startOfPeriod(numDays int64, from time.Time) string { - return from.Add(time.Duration(-24*numDays) * time.Hour).Format("2006-01-02") -} +func (nitl NotInTheLast) fields() map[string]any { return nitl } type InPlaylist map[string]any -func (ipl InPlaylist) ToSql() (sql string, args []any, err error) { - return inList(ipl, false) -} - func (ipl InPlaylist) MarshalJSON() ([]byte, error) { return marshalExpression("inPlaylist", ipl) } +func (ipl InPlaylist) fields() map[string]any { return ipl } + type NotInPlaylist map[string]any -func (ipl NotInPlaylist) ToSql() (sql string, args []any, err error) { - return inList(ipl, true) +func (nipl NotInPlaylist) MarshalJSON() ([]byte, error) { + return marshalExpression("notInPlaylist", nipl) } -func (ipl NotInPlaylist) MarshalJSON() ([]byte, error) { - return marshalExpression("notInPlaylist", ipl) +func (nipl NotInPlaylist) fields() map[string]any { return nipl } + +type IsMissing map[string]any + +func (im IsMissing) MarshalJSON() ([]byte, error) { + return marshalExpression("isMissing", im) } -func inList(m map[string]any, negate bool) (sql string, args []any, err error) { - var playlistid string - var ok bool - if playlistid, ok = m["id"].(string); !ok { - return "", nil, errors.New("playlist id not given") - } +func (im IsMissing) fields() map[string]any { return im } - // Subquery to fetch all media files that are contained in given playlist - // Only evaluate playlist if it is public - subQuery := squirrel.Select("media_file_id"). - From("playlist_tracks pl"). - LeftJoin("playlist on pl.playlist_id = playlist.id"). - Where(squirrel.And{ - squirrel.Eq{"pl.playlist_id": playlistid}, - squirrel.Eq{"playlist.public": 1}}) - subQText, subQArgs, err := subQuery.PlaceholderFormat(squirrel.Question).ToSql() +type IsPresent map[string]any - if err != nil { - return "", nil, err - } - if negate { - return "media_file.id NOT IN (" + subQText + ")", subQArgs, nil - } else { - return "media_file.id IN (" + subQText + ")", subQArgs, nil - } +func (ip IsPresent) MarshalJSON() ([]byte, error) { + return marshalExpression("isPresent", ip) } +func (ip IsPresent) fields() map[string]any { return ip } + func extractPlaylistIds(inputRule any) (ids []string) { var id string var ok bool diff --git a/model/criteria/operators_test.go b/model/criteria/operators_test.go index 95f9fc5f4..17c4272ba 100644 --- a/model/criteria/operators_test.go +++ b/model/criteria/operators_test.go @@ -3,7 +3,6 @@ package criteria_test import ( "encoding/json" "fmt" - "time" . "github.com/navidrome/navidrome/model/criteria" . "github.com/onsi/ginkgo/v2" @@ -17,109 +16,6 @@ var _ = BeforeSuite(func() { }) var _ = Describe("Operators", func() { - rangeStart := time.Date(2021, 10, 01, 0, 0, 0, 0, time.Local) - rangeEnd := time.Date(2021, 11, 01, 0, 0, 0, 0, time.Local) - - DescribeTable("ToSQL", - func(op Expression, expectedSql string, expectedArgs ...any) { - sql, args, err := op.ToSql() - gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal(expectedSql)) - gomega.Expect(args).To(gomega.HaveExactElements(expectedArgs...)) - }, - Entry("is [string]", Is{"title": "Low Rider"}, "media_file.title = ?", "Low Rider"), - Entry("is [bool]", Is{"loved": true}, "COALESCE(annotation.starred, false) = ?", true), - Entry("isNot", IsNot{"title": "Low Rider"}, "media_file.title <> ?", "Low Rider"), - Entry("gt", Gt{"playCount": 10}, "COALESCE(annotation.play_count, 0) > ?", 10), - Entry("lt", Lt{"playCount": 10}, "COALESCE(annotation.play_count, 0) < ?", 10), - Entry("contains", Contains{"title": "Low Rider"}, "media_file.title LIKE ?", "%Low Rider%"), - Entry("notContains", NotContains{"title": "Low Rider"}, "media_file.title NOT LIKE ?", "%Low Rider%"), - Entry("startsWith", StartsWith{"title": "Low Rider"}, "media_file.title LIKE ?", "Low Rider%"), - Entry("endsWith", EndsWith{"title": "Low Rider"}, "media_file.title LIKE ?", "%Low Rider"), - Entry("inTheRange [number]", InTheRange{"year": []int{1980, 1990}}, "(media_file.year >= ? AND media_file.year <= ?)", 1980, 1990), - Entry("inTheRange [date]", InTheRange{"lastPlayed": []time.Time{rangeStart, rangeEnd}}, "(annotation.play_date >= ? AND annotation.play_date <= ?)", rangeStart, rangeEnd), - Entry("before", Before{"lastPlayed": rangeStart}, "annotation.play_date < ?", rangeStart), - Entry("after", After{"lastPlayed": rangeStart}, "annotation.play_date > ?", rangeStart), - - // InPlaylist and NotInPlaylist are special cases - Entry("inPlaylist", InPlaylist{"id": "deadbeef-dead-beef"}, "media_file.id IN "+ - "(SELECT media_file_id FROM playlist_tracks pl LEFT JOIN playlist on pl.playlist_id = playlist.id WHERE (pl.playlist_id = ? AND playlist.public = ?))", "deadbeef-dead-beef", 1), - Entry("notInPlaylist", NotInPlaylist{"id": "deadbeef-dead-beef"}, "media_file.id NOT IN "+ - "(SELECT media_file_id FROM playlist_tracks pl LEFT JOIN playlist on pl.playlist_id = playlist.id WHERE (pl.playlist_id = ? AND playlist.public = ?))", "deadbeef-dead-beef", 1), - - Entry("inTheLast", InTheLast{"lastPlayed": 30}, "annotation.play_date > ?", StartOfPeriod(30, time.Now())), - Entry("notInTheLast", NotInTheLast{"lastPlayed": 30}, "(annotation.play_date < ? OR annotation.play_date IS NULL)", StartOfPeriod(30, time.Now())), - - // Tag tests - Entry("tag is [string]", Is{"genre": "Rock"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value = ?)", "Rock"), - Entry("tag isNot [string]", IsNot{"genre": "Rock"}, "not exists (select 1 from json_tree(tags, '$.genre') where key='value' and value = ?)", "Rock"), - Entry("tag gt", Gt{"genre": "A"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value > ?)", "A"), - Entry("tag lt", Lt{"genre": "Z"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value < ?)", "Z"), - Entry("tag contains", Contains{"genre": "Rock"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), - Entry("tag not contains", NotContains{"genre": "Rock"}, "not exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), - Entry("tag startsWith", StartsWith{"genre": "Soft"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "Soft%"), - Entry("tag endsWith", EndsWith{"genre": "Rock"}, "exists (select 1 from json_tree(tags, '$.genre') where key='value' and value LIKE ?)", "%Rock"), - - // Artist roles tests - Entry("role is [string]", Is{"artist": "u2"}, "exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?)", "u2"), - Entry("role isNot [string]", IsNot{"artist": "u2"}, "not exists (select 1 from json_tree(participants, '$.artist') where key='name' and value = ?)", "u2"), - Entry("role contains [string]", Contains{"artist": "u2"}, "exists (select 1 from json_tree(participants, '$.artist') where key='name' and value LIKE ?)", "%u2%"), - Entry("role not contains [string]", NotContains{"artist": "u2"}, "not exists (select 1 from json_tree(participants, '$.artist') where key='name' and value LIKE ?)", "%u2%"), - Entry("role startsWith [string]", StartsWith{"composer": "John"}, "exists (select 1 from json_tree(participants, '$.composer') where key='name' and value LIKE ?)", "John%"), - Entry("role endsWith [string]", EndsWith{"composer": "Lennon"}, "exists (select 1 from json_tree(participants, '$.composer') where key='name' and value LIKE ?)", "%Lennon"), - ) - - // TODO Validate operators that are not valid for each field type. - XDescribeTable("ToSQL - Invalid Operators", - func(op Expression, expectedError string) { - _, _, err := op.ToSql() - gomega.Expect(err).To(gomega.MatchError(expectedError)) - }, - Entry("numeric tag contains", Contains{"rate": 5}, "numeric tag 'rate' cannot be used with Contains operator"), - ) - - Describe("Custom Tags", func() { - It("generates valid SQL", func() { - AddTagNames([]string{"mood"}) - op := EndsWith{"mood": "Soft"} - sql, args, err := op.ToSql() - gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(tags, '$.mood') where key='value' and value LIKE ?)")) - gomega.Expect(args).To(gomega.HaveExactElements("%Soft")) - }) - It("casts numeric comparisons", func() { - AddNumericTags([]string{"rate"}) - op := Lt{"rate": 6} - sql, args, err := op.ToSql() - gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(tags, '$.rate') where key='value' and CAST(value AS REAL) < ?)")) - gomega.Expect(args).To(gomega.HaveExactElements(6)) - }) - It("skips unknown tag names", func() { - op := EndsWith{"unknown": "value"} - sql, args, _ := op.ToSql() - gomega.Expect(sql).To(gomega.BeEmpty()) - gomega.Expect(args).To(gomega.BeEmpty()) - }) - }) - - Describe("Custom Roles", func() { - It("generates valid SQL", func() { - AddRoles([]string{"producer"}) - op := EndsWith{"producer": "Eno"} - sql, args, err := op.ToSql() - gomega.Expect(err).ToNot(gomega.HaveOccurred()) - gomega.Expect(sql).To(gomega.Equal("exists (select 1 from json_tree(participants, '$.producer') where key='name' and value LIKE ?)")) - gomega.Expect(args).To(gomega.HaveExactElements("%Eno")) - }) - It("skips unknown roles", func() { - op := Contains{"groupie": "Penny Lane"} - sql, args, _ := op.ToSql() - gomega.Expect(sql).To(gomega.BeEmpty()) - gomega.Expect(args).To(gomega.BeEmpty()) - }) - }) - DescribeTable("JSON Marshaling", func(op Expression, jsonString string) { obj := And{op} @@ -135,6 +31,7 @@ var _ = Describe("Operators", func() { }, Entry("is [string]", Is{"title": "Low Rider"}, `{"is":{"title":"Low Rider"}}`), Entry("is [bool]", Is{"loved": false}, `{"is":{"loved":false}}`), + Entry("is [string does not coerce non-boolean field]", Is{"title": "true"}, `{"is":{"title":"true"}}`), Entry("isNot", IsNot{"title": "Low Rider"}, `{"isNot":{"title":"Low Rider"}}`), Entry("gt", Gt{"playCount": 10.0}, `{"gt":{"playCount":10}}`), Entry("lt", Lt{"playCount": 10.0}, `{"lt":{"playCount":10}}`), @@ -150,5 +47,83 @@ var _ = Describe("Operators", func() { Entry("notInTheLast", NotInTheLast{"lastPlayed": 30.0}, `{"notInTheLast":{"lastPlayed":30}}`), Entry("inPlaylist", InPlaylist{"id": "deadbeef-dead-beef"}, `{"inPlaylist":{"id":"deadbeef-dead-beef"}}`), Entry("notInPlaylist", NotInPlaylist{"id": "deadbeef-dead-beef"}, `{"notInPlaylist":{"id":"deadbeef-dead-beef"}}`), + Entry("isMissing [true]", IsMissing{"genre": true}, `{"isMissing":{"genre":true}}`), + Entry("isMissing [false]", IsMissing{"genre": false}, `{"isMissing":{"genre":false}}`), + Entry("isPresent [true]", IsPresent{"genre": true}, `{"isPresent":{"genre":true}}`), + Entry("isPresent [false]", IsPresent{"genre": false}, `{"isPresent":{"genre":false}}`), ) + + Describe("Boolean string coercion at unmarshal time (issue #4826)", func() { + It("coerces string 'true' to bool for boolean fields", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"is":{"loved":"true"}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(Is{"loved": true})) + }) + + It("coerces string 'false' to bool for boolean fields", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"is":{"loved":"false"}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(Is{"loved": false})) + }) + + It("does not coerce string values for non-boolean fields", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"is":{"title":"true"}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(Is{"title": "true"})) + }) + + It("coerces numeric 1 to bool true for boolean fields", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"is":{"loved":1}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(Is{"loved": true})) + }) + + It("coerces numeric 0 to bool false for boolean fields", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"is":{"loved":0}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(Is{"loved": false})) + }) + + It("coerces in nested any/all groups", func() { + var c Criteria + err := json.Unmarshal([]byte(`{"all":[{"contains":{"title":"love"}},{"any":[{"is":{"loved":"true"}}]}]}`), &c) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + all := c.Expression.(All) + nested := all[1].(Any) + gomega.Expect(nested[0]).To(gomega.Equal(Is{"loved": true})) + }) + + It("coerces isMissing string 'true' to bool", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"isMissing":{"genre":"true"}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(IsMissing{"genre": true})) + }) + + It("coerces isMissing numeric 0 to bool false", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"isMissing":{"genre":0}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(IsMissing{"genre": false})) + }) + + It("coerces isPresent string 'false' to bool", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"isPresent":{"genre":"false"}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(IsPresent{"genre": false})) + }) + + It("coerces isPresent numeric 1 to bool true", func() { + var obj UnmarshalConjunctionType + err := json.Unmarshal([]byte(`[{"isPresent":{"genre":1}}]`), &obj) + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(obj[0]).To(gomega.Equal(IsPresent{"genre": true})) + }) + }) }) diff --git a/model/criteria/sort.go b/model/criteria/sort.go new file mode 100644 index 000000000..e38fe0551 --- /dev/null +++ b/model/criteria/sort.go @@ -0,0 +1,62 @@ +package criteria + +import ( + "strings" + + "github.com/navidrome/navidrome/log" +) + +type SortField struct { + Field string + Desc bool +} + +func (c Criteria) OrderByFields() []SortField { + sortValue := c.Sort + if sortValue == "" { + sortValue = "title" + } + + order := strings.ToLower(strings.TrimSpace(c.Order)) + if order != "" && order != "asc" && order != "desc" { + log.Error("Invalid value in 'order' field. Valid values: 'asc', 'desc'", "order", c.Order) + order = "" + } + + parts := strings.Split(sortValue, ",") + fields := make([]SortField, 0, len(parts)) + for _, part := range parts { + part = strings.TrimSpace(part) + if part == "" { + continue + } + desc := false + if strings.HasPrefix(part, "+") || strings.HasPrefix(part, "-") { + desc = strings.HasPrefix(part, "-") + part = strings.TrimSpace(part[1:]) + } + info, ok := LookupField(part) + if !ok { + log.Error("Invalid field in 'sort' field", "sort", part) + continue + } + if order == "desc" { + desc = !desc + } + fields = append(fields, SortField{Field: info.Name(), Desc: desc}) + } + if len(fields) == 0 { + log.Warn("No valid sort fields found in 'sort', falling back to 'title'", "sort", sortValue) + return []SortField{{Field: "title", Desc: false}} + } + return fields +} + +func (c Criteria) SortFieldNames() []string { + sortFields := c.OrderByFields() + names := make([]string, len(sortFields)) + for i, sf := range sortFields { + names[i] = sf.Field + } + return names +} diff --git a/model/criteria/sort_test.go b/model/criteria/sort_test.go new file mode 100644 index 000000000..35db88549 --- /dev/null +++ b/model/criteria/sort_test.go @@ -0,0 +1,103 @@ +package criteria + +import ( + . "github.com/onsi/ginkgo/v2" + "github.com/onsi/gomega" +) + +var _ = Describe("OrderByFields", func() { + It("defaults to title ascending when Sort is empty", func() { + c := Criteria{} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "title", Desc: false}})) + }) + + It("parses a single field", func() { + c := Criteria{Sort: "title"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "title", Desc: false}})) + }) + + It("parses descending prefix", func() { + c := Criteria{Sort: "-rating"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "rating", Desc: true}})) + }) + + It("parses ascending prefix", func() { + c := Criteria{Sort: "+title"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "title", Desc: false}})) + }) + + It("parses multiple comma-separated fields", func() { + c := Criteria{Sort: "title,-rating"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{ + {Field: "title", Desc: false}, + {Field: "rating", Desc: true}, + })) + }) + + It("inverts directions when Order is desc", func() { + c := Criteria{Sort: "-date,title", Order: "desc"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{ + {Field: "date", Desc: false}, + {Field: "title", Desc: true}, + })) + }) + + It("skips invalid fields", func() { + c := Criteria{Sort: "bogus,title"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "title", Desc: false}})) + }) + + It("falls back to title when all fields are invalid", func() { + c := Criteria{Sort: "bogus,invalid"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "title", Desc: false}})) + }) + + It("resolves tag aliases (albumtype -> releasetype)", func() { + c := Criteria{Sort: "albumtype"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "releasetype", Desc: false}})) + }) + + It("resolves field aliases (recordingdate -> date)", func() { + AddTagNames([]string{"recordingdate"}) + c := Criteria{Sort: "recordingdate"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "date", Desc: false}})) + }) + + It("handles the random field", func() { + c := Criteria{Sort: "random"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "random", Desc: false}})) + }) + + It("ignores invalid Order value", func() { + c := Criteria{Sort: "-title", Order: "invalid"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{{Field: "title", Desc: true}})) + }) + + It("handles whitespace in fields", func() { + c := Criteria{Sort: " title , -rating "} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{ + {Field: "title", Desc: false}, + {Field: "rating", Desc: true}, + })) + }) + + It("skips empty parts from trailing commas", func() { + c := Criteria{Sort: "title,,rating,"} + gomega.Expect(c.OrderByFields()).To(gomega.Equal([]SortField{ + {Field: "title", Desc: false}, + {Field: "rating", Desc: false}, + })) + }) +}) + +var _ = Describe("SortFieldNames", func() { + It("returns canonical field names", func() { + c := Criteria{Sort: "title,-rating,albumtype"} + gomega.Expect(c.SortFieldNames()).To(gomega.Equal([]string{"title", "rating", "releasetype"})) + }) + + It("defaults to title when Sort is empty", func() { + c := Criteria{} + gomega.Expect(c.SortFieldNames()).To(gomega.Equal([]string{"title"})) + }) +}) diff --git a/model/criteria/walk.go b/model/criteria/walk.go new file mode 100644 index 000000000..7445c2aef --- /dev/null +++ b/model/criteria/walk.go @@ -0,0 +1,37 @@ +package criteria + +import "fmt" + +type Visitor func(Expression) error + +func Walk(expr Expression, visit Visitor) error { + if expr == nil { + return nil + } + if err := visit(expr); err != nil { + return err + } + switch e := expr.(type) { + case All: + for _, child := range e { + if err := Walk(child, visit); err != nil { + return err + } + } + case Any: + for _, child := range e { + if err := Walk(child, visit); err != nil { + return err + } + } + case Is, IsNot, Gt, Lt, Before, After, Contains, NotContains, StartsWith, EndsWith, InTheRange, InTheLast, NotInTheLast, InPlaylist, NotInPlaylist, IsMissing, IsPresent: + return nil + default: + return fmt.Errorf("unknown criteria expression type %T", expr) + } + return nil +} + +func Fields(expr Expression) map[string]any { + return expr.fields() +} diff --git a/model/criteria/walk_test.go b/model/criteria/walk_test.go new file mode 100644 index 000000000..2e0f12f8d --- /dev/null +++ b/model/criteria/walk_test.go @@ -0,0 +1,64 @@ +package criteria + +import ( + "fmt" + + . "github.com/onsi/ginkgo/v2" + "github.com/onsi/gomega" +) + +type unknownExpression struct{} + +func (unknownExpression) fields() map[string]any { return nil } + +var _ = Describe("Walk", func() { + It("visits the expression tree depth-first", func() { + expr := All{ + Contains{"title": "love"}, + Any{ + Is{"album": "best of"}, + Gt{"rating": 3}, + }, + } + + var visited []string + err := Walk(expr, func(expr Expression) error { + visited = append(visited, fmt.Sprintf("%T", expr)) + return nil + }) + + gomega.Expect(err).ToNot(gomega.HaveOccurred()) + gomega.Expect(visited).To(gomega.Equal([]string{ + "criteria.All", + "criteria.Contains", + "criteria.Any", + "criteria.Is", + "criteria.Gt", + })) + }) + + It("stops when the visitor returns an error", func() { + expectedErr := fmt.Errorf("stop") + + err := Walk(All{Contains{"title": "love"}}, func(Expression) error { + return expectedErr + }) + + gomega.Expect(err).To(gomega.MatchError(expectedErr)) + }) + + It("returns fields for leaf expressions", func() { + gomega.Expect(Fields(Contains{"title": "love"})).To(gomega.Equal(map[string]any{"title": "love"})) + gomega.Expect(Fields(After{"date": "2020-01-01"})).To(gomega.Equal(map[string]any{"date": "2020-01-01"})) + }) + + It("returns nil fields for group expressions", func() { + gomega.Expect(Fields(All{Contains{"title": "love"}})).To(gomega.BeNil()) + }) + + It("returns an error for unknown expression types", func() { + err := Walk(unknownExpression{}, func(Expression) error { return nil }) + + gomega.Expect(err).To(gomega.MatchError("unknown criteria expression type criteria.unknownExpression")) + }) +}) diff --git a/model/datastore.go b/model/datastore.go index 4290e2134..94c3c3622 100644 --- a/model/datastore.go +++ b/model/datastore.go @@ -38,10 +38,12 @@ type DataStore interface { User(ctx context.Context) UserRepository UserProps(ctx context.Context) UserPropsRepository ScrobbleBuffer(ctx context.Context) ScrobbleBufferRepository + Scrobble(ctx context.Context) ScrobbleRepository + Plugin(ctx context.Context) PluginRepository - Resource(ctx context.Context, model interface{}) ResourceRepository + Resource(ctx context.Context, model any) ResourceRepository WithTx(block func(tx DataStore) error, scope ...string) error WithTxImmediate(block func(tx DataStore) error, scope ...string) error - GC(ctx context.Context) error + GC(ctx context.Context, libraryIDs ...int) error } diff --git a/model/errors.go b/model/errors.go index ff4be5723..41029d316 100644 --- a/model/errors.go +++ b/model/errors.go @@ -8,4 +8,5 @@ var ( ErrNotAuthorized = errors.New("not authorized") ErrExpired = errors.New("access expired") ErrNotAvailable = errors.New("functionality not available") + ErrValidation = errors.New("validation error") ) diff --git a/model/folder.go b/model/folder.go index 3d14e7c53..7a769735e 100644 --- a/model/folder.go +++ b/model/folder.go @@ -17,7 +17,7 @@ import ( type Folder struct { ID string `structs:"id"` LibraryID int `structs:"library_id"` - LibraryPath string `structs:"-" json:"-" hash:"-"` + LibraryPath string `structs:"-" json:"-" hash:"ignore"` Path string `structs:"path"` Name string `structs:"name"` ParentID string `structs:"parent_id"` @@ -25,6 +25,7 @@ type Folder struct { NumPlaylists int `structs:"num_playlists"` ImageFiles []string `structs:"image_files"` ImagesUpdatedAt time.Time `structs:"images_updated_at"` + Hash string `structs:"hash"` Missing bool `structs:"missing"` UpdateAt time.Time `structs:"updated_at"` CreatedAt time.Time `structs:"created_at"` @@ -74,12 +75,17 @@ func NewFolder(lib Library, folderPath string) *Folder { type FolderCursor iter.Seq2[Folder, error] +type FolderUpdateInfo struct { + UpdatedAt time.Time + Hash string +} + type FolderRepository interface { Get(id string) (*Folder, error) GetByPath(lib Library, path string) (*Folder, error) GetAll(...QueryOptions) ([]Folder, error) CountAll(...QueryOptions) (int64, error) - GetLastUpdates(lib Library) (map[string]time.Time, error) + GetFolderUpdateInfo(lib Library, targetPaths ...string) (map[string]FolderUpdateInfo, error) Put(*Folder) error MarkMissing(missing bool, ids ...string) error GetTouchedWithPlaylists() (FolderCursor, error) diff --git a/model/folder_test.go b/model/folder_test.go index 0535f6987..4c1b4c2b7 100644 --- a/model/folder_test.go +++ b/model/folder_test.go @@ -7,6 +7,7 @@ import ( "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -66,6 +67,7 @@ var _ = Describe("Folder", func() { When("the folder has multiple subdirs", func() { It("should return the correct folder ID", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-model)") folderPath := filepath.FromSlash("/music/rock/metal") expectedID := id.NewHash("1:rock/metal") Expect(model.FolderID(lib, folderPath)).To(Equal(expectedID)) @@ -75,6 +77,7 @@ var _ = Describe("Folder", func() { Describe("NewFolder", func() { It("should create a new SubFolder with the correct attributes", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-model)") folderPath := filepath.FromSlash("rock/metal") folder := model.NewFolder(lib, folderPath) diff --git a/model/get_entity.go b/model/get_entity.go index f51d8c36a..60972b2e9 100644 --- a/model/get_entity.go +++ b/model/get_entity.go @@ -5,7 +5,7 @@ import ( ) // TODO: Should the type be encoded in the ID? -func GetEntityByID(ctx context.Context, ds DataStore, id string) (interface{}, error) { +func GetEntityByID(ctx context.Context, ds DataStore, id string) (any, error) { ar, err := ds.Artist(ctx).Get(id) if err == nil { return ar, nil @@ -22,5 +22,9 @@ func GetEntityByID(ctx context.Context, ds DataStore, id string) (interface{}, e if err == nil { return mf, nil } + r, err := ds.Radio(ctx).Get(id) + if err == nil { + return r, nil + } return nil, err } diff --git a/model/id/id.go b/model/id/id.go index 930875260..b54542898 100644 --- a/model/id/id.go +++ b/model/id/id.go @@ -6,12 +6,12 @@ import ( "math/big" "strings" - gonanoid "github.com/matoous/go-nanoid/v2" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/utils/nanoid" ) func NewRandom() string { - id, err := gonanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 22) + id, err := nanoid.Generate("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 22) if err != nil { log.Error("Could not generate new ID", err) } diff --git a/model/image.go b/model/image.go new file mode 100644 index 000000000..30307fcea --- /dev/null +++ b/model/image.go @@ -0,0 +1,17 @@ +package model + +import ( + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" +) + +// UploadedImagePath returns the absolute filesystem path for a manually uploaded +// entity cover image. Returns empty string if filename is empty. +func UploadedImagePath(entityType, filename string) string { + if filename == "" { + return "" + } + return filepath.Join(conf.Server.DataFolder.String(), consts.ArtworkFolder, entityType, filename) +} diff --git a/model/library.go b/model/library.go index a29f1c1d6..bcb2864c8 100644 --- a/model/library.go +++ b/model/library.go @@ -2,34 +2,60 @@ package model import ( "time" + + "github.com/navidrome/navidrome/utils/slice" ) type Library struct { - ID int - Name string - Path string - RemotePath string - LastScanAt time.Time - LastScanStartedAt time.Time - FullScanInProgress bool - UpdatedAt time.Time - CreatedAt time.Time + ID int `json:"id" db:"id"` + Name string `json:"name" db:"name"` + Path string `json:"path" db:"path"` + RemotePath string `json:"remotePath" db:"remote_path"` + LastScanAt time.Time `json:"lastScanAt" db:"last_scan_at"` + LastScanStartedAt time.Time `json:"lastScanStartedAt" db:"last_scan_started_at"` + FullScanInProgress bool `json:"fullScanInProgress" db:"full_scan_in_progress"` + UpdatedAt time.Time `json:"updatedAt" db:"updated_at"` + CreatedAt time.Time `json:"createdAt" db:"created_at"` + TotalSongs int `json:"totalSongs" db:"total_songs"` + TotalAlbums int `json:"totalAlbums" db:"total_albums"` + TotalArtists int `json:"totalArtists" db:"total_artists"` + TotalFolders int `json:"totalFolders" db:"total_folders"` + TotalFiles int `json:"totalFiles" db:"total_files"` + TotalMissingFiles int `json:"totalMissingFiles" db:"total_missing_files"` + TotalSize int64 `json:"totalSize" db:"total_size"` + TotalDuration float64 `json:"totalDuration" db:"total_duration"` + DefaultNewUsers bool `json:"defaultNewUsers" db:"default_new_users"` } +const ( + DefaultLibraryID = 1 + DefaultLibraryName = "Music Library" +) + type Libraries []Library +func (l Libraries) IDs() []int { + return slice.Map(l, func(lib Library) int { return lib.ID }) +} + type LibraryRepository interface { Get(id int) (*Library, error) // GetPath returns the path of the library with the given ID. // Its implementation must be optimized to avoid unnecessary queries. GetPath(id int) (string, error) GetAll(...QueryOptions) (Libraries, error) + CountAll(...QueryOptions) (int64, error) Put(*Library) error + Delete(id int) error StoreMusicFolder() error AddArtist(id int, artistID string) error + // User-library association methods + GetUsersWithLibraryAccess(libraryID int) (Users, error) + // TODO These methods should be moved to a core service ScanBegin(id int, fullScan bool) error ScanEnd(id int) error ScanInProgress() (bool, error) + RefreshStats(id int) error } diff --git a/model/lyrics_test.go b/model/lyrics_test.go index 382976872..644b85ad2 100644 --- a/model/lyrics_test.go +++ b/model/lyrics_test.go @@ -8,14 +8,13 @@ import ( var _ = Describe("ToLyrics", func() { It("should parse tags with spaces", func() { - num := int64(1551) lyrics, err := ToLyrics("xxx", "[lang: eng ]\n[offset: 1551 ]\n[ti: A title ]\n[ar: An artist ]\n[00:00.00]Hi there") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Lang).To(Equal("eng")) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.DisplayArtist).To(Equal("An artist")) Expect(lyrics.DisplayTitle).To(Equal("A title")) - Expect(lyrics.Offset).To(Equal(&num)) + Expect(lyrics.Offset).To(Equal(new(int64(1551)))) }) It("Should ignore bad offset", func() { @@ -25,39 +24,36 @@ var _ = Describe("ToLyrics", func() { }) It("should accept lines with no text and weird times", func() { - a, b, c, d := int64(0), int64(10040), int64(40000), int64(1000*60*60) lyrics, err := ToLyrics("xxx", "[00:00.00]Hi there\n\n\n[00:10.040]\n[00:40]Test\n[01:00:00]late") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.Line).To(Equal([]Line{ - {Start: &a, Value: "Hi there"}, - {Start: &b, Value: ""}, - {Start: &c, Value: "Test"}, - {Start: &d, Value: "late"}, + {Start: new(int64(0)), Value: "Hi there"}, + {Start: new(int64(10040)), Value: ""}, + {Start: new(int64(40000)), Value: "Test"}, + {Start: new(int64(1000 * 60 * 60)), Value: "late"}, })) }) It("Should support multiple timestamps per line", func() { - a, b, c, d := int64(0), int64(10000), int64(13*60*1000), int64(1000*60*60*51) lyrics, err := ToLyrics("xxx", "[00:00.00] [00:10.00]Repeated\n[13:00][51:00:00.00]") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.Line).To(Equal([]Line{ - {Start: &a, Value: "Repeated"}, - {Start: &b, Value: "Repeated"}, - {Start: &c, Value: ""}, - {Start: &d, Value: ""}, + {Start: new(int64(0)), Value: "Repeated"}, + {Start: new(int64(10000)), Value: "Repeated"}, + {Start: new(int64(13 * 60 * 1000)), Value: ""}, + {Start: new(int64(1000 * 60 * 60 * 51)), Value: ""}, })) }) It("Should support parsing multiline string", func() { - a, b := int64(0), int64(10*60*1000+1) lyrics, err := ToLyrics("xxx", "[00:00.00]This is\na multiline \n\n [:0] string\n[10:00.001]This is\nalso one") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.Line).To(Equal([]Line{ - {Start: &a, Value: "This is\na multiline\n\n[:0] string"}, - {Start: &b, Value: "This is\nalso one"}, + {Start: new(int64(0)), Value: "This is\na multiline\n\n[:0] string"}, + {Start: new(int64(10*60*1000 + 1)), Value: "This is\nalso one"}, })) }) @@ -71,49 +67,45 @@ var _ = Describe("ToLyrics", func() { }) It("Allows timestamp in middle of line if also at beginning", func() { - a, b := int64(0), int64(1000) lyrics, err := ToLyrics("xxx", " [00:00] This is [00:00:00] be a synced file\n [00:01]Line 2") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.Line).To(Equal([]Line{ - {Start: &a, Value: "This is [00:00:00] be a synced file"}, - {Start: &b, Value: "Line 2"}, + {Start: new(int64(0)), Value: "This is [00:00:00] be a synced file"}, + {Start: new(int64(1000)), Value: "Line 2"}, })) }) It("Ignores lines in synchronized lyric prior to first timestamp", func() { - a := int64(0) lyrics, err := ToLyrics("xxx", "This is some prelude\nThat doesn't\nmatter\n[00:00]Text") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.Line).To(Equal([]Line{ - {Start: &a, Value: "Text"}, + {Start: new(int64(0)), Value: "Text"}, })) }) It("Handles all possible ms cases", func() { - a, b, c := int64(1), int64(10), int64(100) lyrics, err := ToLyrics("xxx", "[00:00.001]a\n[00:00.01]b\n[00:00.1]c") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.Line).To(Equal([]Line{ - {Start: &a, Value: "a"}, - {Start: &b, Value: "b"}, - {Start: &c, Value: "c"}, + {Start: new(int64(1)), Value: "a"}, + {Start: new(int64(10)), Value: "b"}, + {Start: new(int64(100)), Value: "c"}, })) }) It("Properly sorts repeated lyrics out of order", func() { - a, b, c, d, e := int64(0), int64(10000), int64(40000), int64(13*60*1000), int64(1000*60*60*51) lyrics, err := ToLyrics("xxx", "[00:00.00] [13:00]Repeated\n[00:10.00][51:00:00.00]Test\n[00:40.00]Not repeated") Expect(err).ToNot(HaveOccurred()) Expect(lyrics.Synced).To(BeTrue()) Expect(lyrics.Line).To(Equal([]Line{ - {Start: &a, Value: "Repeated"}, - {Start: &b, Value: "Test"}, - {Start: &c, Value: "Not repeated"}, - {Start: &d, Value: "Repeated"}, - {Start: &e, Value: "Test"}, + {Start: new(int64(0)), Value: "Repeated"}, + {Start: new(int64(10000)), Value: "Test"}, + {Start: new(int64(40000)), Value: "Not repeated"}, + {Start: new(int64(13 * 60 * 1000)), Value: "Repeated"}, + {Start: new(int64(1000 * 60 * 60 * 51)), Value: "Test"}, })) }) }) diff --git a/model/mediafile.go b/model/mediafile.go index cdb001c85..6be8402ae 100644 --- a/model/mediafile.go +++ b/model/mediafile.go @@ -9,6 +9,7 @@ import ( "mime" "path/filepath" "slices" + "strings" "time" "github.com/gohugoio/hashstructure" @@ -25,7 +26,8 @@ type MediaFile struct { ID string `structs:"id" json:"id" hash:"ignore"` PID string `structs:"pid" json:"-" hash:"ignore"` LibraryID int `structs:"library_id" json:"libraryId" hash:"ignore"` - LibraryPath string `structs:"-" json:"libraryPath" hash:"-"` + LibraryPath string `structs:"-" json:"libraryPath" hash:"ignore"` + LibraryName string `structs:"-" json:"libraryName" hash:"ignore"` FolderID string `structs:"folder_id" json:"folderId" hash:"ignore"` Path string `structs:"path" json:"path" hash:"ignore"` Title string `structs:"title" json:"title"` @@ -35,53 +37,55 @@ type MediaFile struct { Artist string `structs:"artist" json:"artist"` AlbumArtistID string `structs:"album_artist_id" json:"albumArtistId"` // Deprecated: Use Participants instead // AlbumArtist is the display name used for the album artist. - AlbumArtist string `structs:"album_artist" json:"albumArtist"` - AlbumID string `structs:"album_id" json:"albumId"` - HasCoverArt bool `structs:"has_cover_art" json:"hasCoverArt"` - TrackNumber int `structs:"track_number" json:"trackNumber"` - DiscNumber int `structs:"disc_number" json:"discNumber"` - DiscSubtitle string `structs:"disc_subtitle" json:"discSubtitle,omitempty"` - Year int `structs:"year" json:"year"` - Date string `structs:"date" json:"date,omitempty"` - OriginalYear int `structs:"original_year" json:"originalYear"` - OriginalDate string `structs:"original_date" json:"originalDate,omitempty"` - ReleaseYear int `structs:"release_year" json:"releaseYear"` - ReleaseDate string `structs:"release_date" json:"releaseDate,omitempty"` - Size int64 `structs:"size" json:"size"` - Suffix string `structs:"suffix" json:"suffix"` - Duration float32 `structs:"duration" json:"duration"` - BitRate int `structs:"bit_rate" json:"bitRate"` - SampleRate int `structs:"sample_rate" json:"sampleRate"` - BitDepth int `structs:"bit_depth" json:"bitDepth"` - Channels int `structs:"channels" json:"channels"` - Genre string `structs:"genre" json:"genre"` - Genres Genres `structs:"-" json:"genres,omitempty"` - SortTitle string `structs:"sort_title" json:"sortTitle,omitempty"` - SortAlbumName string `structs:"sort_album_name" json:"sortAlbumName,omitempty"` - SortArtistName string `structs:"sort_artist_name" json:"sortArtistName,omitempty"` // Deprecated: Use Participants instead - SortAlbumArtistName string `structs:"sort_album_artist_name" json:"sortAlbumArtistName,omitempty"` // Deprecated: Use Participants instead - OrderTitle string `structs:"order_title" json:"orderTitle,omitempty"` - OrderAlbumName string `structs:"order_album_name" json:"orderAlbumName"` - OrderArtistName string `structs:"order_artist_name" json:"orderArtistName"` // Deprecated: Use Participants instead - OrderAlbumArtistName string `structs:"order_album_artist_name" json:"orderAlbumArtistName"` // Deprecated: Use Participants instead - Compilation bool `structs:"compilation" json:"compilation"` - Comment string `structs:"comment" json:"comment,omitempty"` - Lyrics string `structs:"lyrics" json:"lyrics"` - BPM int `structs:"bpm" json:"bpm,omitempty"` - ExplicitStatus string `structs:"explicit_status" json:"explicitStatus"` - CatalogNum string `structs:"catalog_num" json:"catalogNum,omitempty"` - MbzRecordingID string `structs:"mbz_recording_id" json:"mbzRecordingID,omitempty"` - MbzReleaseTrackID string `structs:"mbz_release_track_id" json:"mbzReleaseTrackId,omitempty"` - MbzAlbumID string `structs:"mbz_album_id" json:"mbzAlbumId,omitempty"` - MbzReleaseGroupID string `structs:"mbz_release_group_id" json:"mbzReleaseGroupId,omitempty"` - MbzArtistID string `structs:"mbz_artist_id" json:"mbzArtistId,omitempty"` // Deprecated: Use Participants instead - MbzAlbumArtistID string `structs:"mbz_album_artist_id" json:"mbzAlbumArtistId,omitempty"` // Deprecated: Use Participants instead - MbzAlbumType string `structs:"mbz_album_type" json:"mbzAlbumType,omitempty"` - MbzAlbumComment string `structs:"mbz_album_comment" json:"mbzAlbumComment,omitempty"` - RGAlbumGain float64 `structs:"rg_album_gain" json:"rgAlbumGain"` - RGAlbumPeak float64 `structs:"rg_album_peak" json:"rgAlbumPeak"` - RGTrackGain float64 `structs:"rg_track_gain" json:"rgTrackGain"` - RGTrackPeak float64 `structs:"rg_track_peak" json:"rgTrackPeak"` + AlbumArtist string `structs:"album_artist" json:"albumArtist"` + AlbumID string `structs:"album_id" json:"albumId" hash:"ignore"` + HasCoverArt bool `structs:"has_cover_art" json:"hasCoverArt"` + TrackNumber int `structs:"track_number" json:"trackNumber"` + DiscNumber int `structs:"disc_number" json:"discNumber"` + DiscSubtitle string `structs:"disc_subtitle" json:"discSubtitle,omitempty"` + Year int `structs:"year" json:"year"` + Date string `structs:"date" json:"date,omitempty"` + OriginalYear int `structs:"original_year" json:"originalYear"` + OriginalDate string `structs:"original_date" json:"originalDate,omitempty"` + ReleaseYear int `structs:"release_year" json:"releaseYear"` + ReleaseDate string `structs:"release_date" json:"releaseDate,omitempty"` + Size int64 `structs:"size" json:"size"` + Suffix string `structs:"suffix" json:"suffix"` + Duration float32 `structs:"duration" json:"duration"` + BitRate int `structs:"bit_rate" json:"bitRate"` + SampleRate int `structs:"sample_rate" json:"sampleRate"` + BitDepth int `structs:"bit_depth" json:"bitDepth"` + Channels int `structs:"channels" json:"channels"` + Codec string `structs:"codec" json:"codec"` + ProbeData string `structs:"probe_data" json:"-" hash:"ignore"` + Genre string `structs:"genre" json:"genre"` + Genres Genres `structs:"-" json:"genres,omitempty"` + SortTitle string `structs:"sort_title" json:"sortTitle,omitempty"` + SortAlbumName string `structs:"sort_album_name" json:"sortAlbumName,omitempty"` + SortArtistName string `structs:"sort_artist_name" json:"sortArtistName,omitempty"` // Deprecated: Use Participants instead + SortAlbumArtistName string `structs:"sort_album_artist_name" json:"sortAlbumArtistName,omitempty"` // Deprecated: Use Participants instead + OrderTitle string `structs:"order_title" json:"orderTitle,omitempty"` + OrderAlbumName string `structs:"order_album_name" json:"orderAlbumName"` + OrderArtistName string `structs:"order_artist_name" json:"orderArtistName"` // Deprecated: Use Participants instead + OrderAlbumArtistName string `structs:"order_album_artist_name" json:"orderAlbumArtistName"` // Deprecated: Use Participants instead + Compilation bool `structs:"compilation" json:"compilation"` + Comment string `structs:"comment" json:"comment,omitempty"` + Lyrics string `structs:"lyrics" json:"lyrics"` + BPM int `structs:"bpm" json:"bpm,omitempty"` + ExplicitStatus string `structs:"explicit_status" json:"explicitStatus"` + CatalogNum string `structs:"catalog_num" json:"catalogNum,omitempty"` + MbzRecordingID string `structs:"mbz_recording_id" json:"mbzRecordingID,omitempty"` + MbzReleaseTrackID string `structs:"mbz_release_track_id" json:"mbzReleaseTrackId,omitempty"` + MbzAlbumID string `structs:"mbz_album_id" json:"mbzAlbumId,omitempty"` + MbzReleaseGroupID string `structs:"mbz_release_group_id" json:"mbzReleaseGroupId,omitempty"` + MbzArtistID string `structs:"mbz_artist_id" json:"mbzArtistId,omitempty"` // Deprecated: Use Participants instead + MbzAlbumArtistID string `structs:"mbz_album_artist_id" json:"mbzAlbumArtistId,omitempty"` // Deprecated: Use Participants instead + MbzAlbumType string `structs:"mbz_album_type" json:"mbzAlbumType,omitempty"` + MbzAlbumComment string `structs:"mbz_album_comment" json:"mbzAlbumComment,omitempty"` + RGAlbumGain *float64 `structs:"rg_album_gain" json:"rgAlbumGain"` + RGAlbumPeak *float64 `structs:"rg_album_peak" json:"rgAlbumPeak"` + RGTrackGain *float64 `structs:"rg_track_gain" json:"rgTrackGain"` + RGTrackPeak *float64 `structs:"rg_track_peak" json:"rgTrackPeak"` Tags Tags `structs:"tags" json:"tags,omitempty" hash:"ignore"` // All imported tags from the original file Participants Participants `structs:"participants" json:"participants" hash:"ignore"` // All artists that participated in this track @@ -93,12 +97,19 @@ type MediaFile struct { } func (mf MediaFile) FullTitle() string { - if conf.Server.Subsonic.AppendSubtitle && mf.Tags[TagSubtitle] != nil { + if conf.Server.Subsonic.AppendSubtitle && len(mf.Tags[TagSubtitle]) > 0 { return fmt.Sprintf("%s (%s)", mf.Title, mf.Tags[TagSubtitle][0]) } return mf.Title } +func (mf MediaFile) FullAlbumName() string { + if conf.Server.Subsonic.AppendAlbumVersion && len(mf.Tags[TagAlbumVersion]) > 0 { + return fmt.Sprintf("%s (%s)", mf.Album, mf.Tags[TagAlbumVersion][0]) + } + return mf.Album +} + func (mf MediaFile) ContentType() string { return mime.TypeByExtension("." + mf.Suffix) } @@ -108,7 +119,16 @@ func (mf MediaFile) CoverArtID() ArtworkID { if mf.HasCoverArt && conf.Server.EnableMediaFileCoverArt { return artworkIDFromMediaFile(mf) } - // if it does not have a coverArt, fallback to the album cover + // Otherwise fallback to disc (if available) or album cover + return mf.DiscCoverArtID() +} + +// DiscCoverArtID returns the disc artwork ID when the media file has a disc number, +// otherwise it returns the album artwork ID. +func (mf MediaFile) DiscCoverArtID() ArtworkID { + if mf.DiscNumber > 0 { + return NewArtworkID(KindDiscArtwork, DiscArtworkID(mf.AlbumID, mf.DiscNumber), nil) + } return mf.AlbumCoverArtID() } @@ -138,7 +158,7 @@ func (mf MediaFile) Hash() string { } hash, _ := hashstructure.Hash(mf, opts) sum := md5.New() - sum.Write([]byte(fmt.Sprintf("%d", hash))) + sum.Write(fmt.Appendf(nil, "%d", hash)) sum.Write(mf.Tags.Hash()) sum.Write(mf.Participants.Hash()) return fmt.Sprintf("%x", sum.Sum(nil)) @@ -159,6 +179,63 @@ func (mf MediaFile) AbsolutePath() string { return filepath.Join(mf.LibraryPath, mf.Path) } +// AudioCodec returns the audio codec for this file. +// Uses the stored Codec field if available, otherwise infers from Suffix and audio properties. +func (mf MediaFile) AudioCodec() string { + // If we have a stored codec from scanning, normalize and return it + if mf.Codec != "" { + return strings.ToLower(mf.Codec) + } + // Fallback: infer from Suffix + BitDepth + return mf.inferCodecFromSuffix() +} + +// inferCodecFromSuffix infers the codec from the file extension when Codec field is empty. +func (mf MediaFile) inferCodecFromSuffix() string { + switch strings.ToLower(mf.Suffix) { + case "mp3", "mpga": + return "mp3" + case "mp2": + return "mp2" + case "ogg", "oga": + return "vorbis" + case "opus": + return "opus" + case "mpc": + return "mpc" + case "wma": + return "wma" + case "flac": + return "flac" + case "wav": + return "pcm" + case "aif", "aiff", "aifc": + return "pcm" + case "ape": + return "ape" + case "wv", "wvp": + return "wv" + case "tta": + return "tta" + case "tak": + return "tak" + case "shn": + return "shn" + case "dsf", "dff": + return "dsd" + case "m4a": + // AAC if BitDepth==0, ALAC if BitDepth>0 + if mf.BitDepth > 0 { + return "alac" + } + return "aac" + case "m4b", "m4p", "m4r": + return "aac" + default: + return "" + } +} + type MediaFiles []MediaFile // ToAlbum creates an Album object based on the attributes of this MediaFiles collection. @@ -284,6 +361,9 @@ func older(t1, t2 time.Time) time.Time { if t1.IsZero() { return t2 } + if t2.IsZero() { + return t1 + } if t1.After(t2) { return t2 } @@ -330,15 +410,35 @@ func firstArtPath(currentPath string, currentDisc int, m MediaFile) (string, int return currentPath, currentDisc } +// ToM3U8 exports the playlist to the Extended M3U8 format, as specified in +// https://docs.fileformat.com/audio/m3u/#extended-m3u +func (mfs MediaFiles) ToM3U8(title string, absolutePaths bool) string { + buf := strings.Builder{} + buf.WriteString("#EXTM3U\n") + buf.WriteString(fmt.Sprintf("#PLAYLIST:%s\n", title)) + for _, t := range mfs { + buf.WriteString(fmt.Sprintf("#EXTINF:%.f,%s - %s\n", t.Duration, t.Artist, t.Title)) + if absolutePaths { + buf.WriteString(t.AbsolutePath() + "\n") + } else { + buf.WriteString(t.Path + "\n") + } + } + return buf.String() +} + type MediaFileCursor iter.Seq2[MediaFile, error] type MediaFileRepository interface { CountAll(options ...QueryOptions) (int64, error) + CountBySuffix(options ...QueryOptions) (map[string]int64, error) Exists(id string) (bool, error) Put(m *MediaFile) error + UpdateProbeData(id string, data string) error Get(id string) (*MediaFile, error) GetWithParticipants(id string) (*MediaFile, error) GetAll(options ...QueryOptions) (MediaFiles, error) + GetAllByTags(tag TagName, values []string, options ...QueryOptions) (MediaFiles, error) GetCursor(options ...QueryOptions) (MediaFileCursor, error) Delete(id string) error DeleteMissing(ids []string) error @@ -349,6 +449,8 @@ type MediaFileRepository interface { MarkMissing(bool, ...*MediaFile) error MarkMissingByFolder(missing bool, folderIDs ...string) error GetMissingAndMatching(libId int) (MediaFileCursor, error) + FindRecentFilesByMBZTrackID(missing MediaFile, since time.Time) (MediaFiles, error) + FindRecentFilesByProperties(missing MediaFile, since time.Time) (MediaFiles, error) AnnotatedRepository BookmarkableRepository diff --git a/model/mediafile_test.go b/model/mediafile_test.go index 7f583cf75..3547ec4ef 100644 --- a/model/mediafile_test.go +++ b/model/mediafile_test.go @@ -6,6 +6,7 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" . "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -22,7 +23,7 @@ var _ = Describe("MediaFiles", func() { SortAlbumName: "SortAlbumName", SortArtistName: "SortArtistName", SortAlbumArtistName: "SortAlbumArtistName", OrderAlbumName: "OrderAlbumName", OrderAlbumArtistName: "OrderAlbumArtistName", MbzAlbumArtistID: "MbzAlbumArtistID", MbzAlbumType: "MbzAlbumType", MbzAlbumComment: "MbzAlbumComment", - MbzReleaseGroupID: "MbzReleaseGroupID", Compilation: false, CatalogNum: "", Path: "/music1/file1.mp3", FolderID: "Folder1", + MbzReleaseGroupID: "MbzReleaseGroupID", Compilation: false, CatalogNum: "", Path: "music1/file1.mp3", FolderID: "Folder1", }, { ID: "2", Album: "Album", ArtistID: "ArtistID", Artist: "Artist", AlbumArtistID: "AlbumArtistID", AlbumArtist: "AlbumArtist", AlbumID: "AlbumID", @@ -30,7 +31,7 @@ var _ = Describe("MediaFiles", func() { OrderAlbumName: "OrderAlbumName", OrderArtistName: "OrderArtistName", OrderAlbumArtistName: "OrderAlbumArtistName", MbzAlbumArtistID: "MbzAlbumArtistID", MbzAlbumType: "MbzAlbumType", MbzAlbumComment: "MbzAlbumComment", MbzReleaseGroupID: "MbzReleaseGroupID", - Compilation: true, CatalogNum: "CatalogNum", HasCoverArt: true, Path: "/music2/file2.mp3", FolderID: "Folder2", + Compilation: true, CatalogNum: "CatalogNum", HasCoverArt: true, Path: "music2/file2.mp3", FolderID: "Folder2", }, } }) @@ -51,7 +52,7 @@ var _ = Describe("MediaFiles", func() { Expect(album.MbzReleaseGroupID).To(Equal("MbzReleaseGroupID")) Expect(album.CatalogNum).To(Equal("CatalogNum")) Expect(album.Compilation).To(BeTrue()) - Expect(album.EmbedArtPath).To(Equal("/music2/file2.mp3")) + Expect(album.EmbedArtPath).To(Equal("music2/file2.mp3")) Expect(album.FolderIDs).To(ConsistOf("Folder1", "Folder2")) }) }) @@ -119,6 +120,20 @@ var _ = Describe("MediaFiles", func() { Expect(a.MinYear).To(Equal(1999)) }) }) + Context("CreatedAt aggregation", func() { + It("ignores zero BirthTime values when computing the oldest", func() { + mfs = MediaFiles{ + {BirthTime: t("2022-12-19 08:30")}, + {BirthTime: time.Time{}}, + {BirthTime: t("2022-12-18 10:00")}, + } + Expect(mfs.ToAlbum().CreatedAt).To(Equal(t("2022-12-18 10:00"))) + }) + It("returns zero when all BirthTime values are zero", func() { + mfs = MediaFiles{{BirthTime: time.Time{}}, {BirthTime: time.Time{}}} + Expect(mfs.ToAlbum().CreatedAt).To(BeZero()) + }) + }) }) When("we have multiple songs with same dates", func() { BeforeEach(func() { @@ -402,6 +417,76 @@ var _ = Describe("MediaFiles", func() { }) }) }) + + Describe("ToM3U8", func() { + It("returns header only for empty MediaFiles", func() { + mfs = MediaFiles{} + result := mfs.ToM3U8("My Playlist", false) + Expect(result).To(Equal("#EXTM3U\n#PLAYLIST:My Playlist\n")) + }) + + DescribeTable("duration formatting", + func(duration float32, expected string) { + mfs = MediaFiles{{Title: "Song", Artist: "Artist", Duration: duration, Path: "song.mp3"}} + result := mfs.ToM3U8("Test", false) + Expect(result).To(ContainSubstring(expected)) + }, + Entry("zero duration", float32(0.0), "#EXTINF:0,"), + Entry("whole number", float32(120.0), "#EXTINF:120,"), + Entry("rounds 0.5 down", float32(180.5), "#EXTINF:180,"), + Entry("rounds 0.6 up", float32(240.6), "#EXTINF:241,"), + ) + + Context("multiple tracks", func() { + BeforeEach(func() { + mfs = MediaFiles{ + {Title: "Song One", Artist: "Artist A", Duration: 120, Path: "a/song1.mp3", LibraryPath: "/music"}, + {Title: "Song Two", Artist: "Artist B", Duration: 241, Path: "b/song2.mp3", LibraryPath: "/music"}, + {Title: "Song with \"quotes\" & ampersands", Artist: "Artist with Ümläuts", Duration: 90, Path: "special/file.mp3", LibraryPath: "/música"}, + } + }) + + DescribeTable("generates correct output", + func(absolutePaths bool, expectedContent string) { + if absolutePaths { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-model)") + } + result := mfs.ToM3U8("Multi Track", absolutePaths) + Expect(result).To(Equal(expectedContent)) + }, + Entry("relative paths", + false, + "#EXTM3U\n#PLAYLIST:Multi Track\n#EXTINF:120,Artist A - Song One\na/song1.mp3\n#EXTINF:241,Artist B - Song Two\nb/song2.mp3\n#EXTINF:90,Artist with Ümläuts - Song with \"quotes\" & ampersands\nspecial/file.mp3\n", + ), + Entry("absolute paths", + true, + "#EXTM3U\n#PLAYLIST:Multi Track\n#EXTINF:120,Artist A - Song One\n/music/a/song1.mp3\n#EXTINF:241,Artist B - Song Two\n/music/b/song2.mp3\n#EXTINF:90,Artist with Ümläuts - Song with \"quotes\" & ampersands\n/música/special/file.mp3\n", + ), + Entry("special characters", + false, + "#EXTM3U\n#PLAYLIST:Multi Track\n#EXTINF:120,Artist A - Song One\na/song1.mp3\n#EXTINF:241,Artist B - Song Two\nb/song2.mp3\n#EXTINF:90,Artist with Ümläuts - Song with \"quotes\" & ampersands\nspecial/file.mp3\n", + ), + ) + }) + + Context("path variations", func() { + It("handles different path structures", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-model)") + mfs = MediaFiles{ + {Title: "Root", Artist: "Artist", Duration: 60, Path: "song.mp3", LibraryPath: "/lib"}, + {Title: "Nested", Artist: "Artist", Duration: 60, Path: "deep/nested/song.mp3", LibraryPath: "/lib"}, + } + + relativeResult := mfs.ToM3U8("Test", false) + Expect(relativeResult).To(ContainSubstring("song.mp3\n")) + Expect(relativeResult).To(ContainSubstring("deep/nested/song.mp3\n")) + + absoluteResult := mfs.ToM3U8("Test", true) + Expect(absoluteResult).To(ContainSubstring("/lib/song.mp3\n")) + Expect(absoluteResult).To(ContainSubstring("/lib/deep/nested/song.mp3\n")) + }) + }) + }) }) var _ = Describe("MediaFile", func() { @@ -409,20 +494,55 @@ var _ = Describe("MediaFile", func() { DeferCleanup(configtest.SetupConfig()) conf.Server.EnableMediaFileCoverArt = true }) - Describe(".CoverArtId()", func() { + DescribeTable("FullTitle", + func(enabled bool, tags Tags, expected string) { + conf.Server.Subsonic.AppendSubtitle = enabled + mf := MediaFile{Title: "Song", Tags: tags} + Expect(mf.FullTitle()).To(Equal(expected)) + }, + Entry("appends subtitle when enabled and tag is present", true, Tags{TagSubtitle: []string{"Live"}}, "Song (Live)"), + Entry("returns just title when disabled", false, Tags{TagSubtitle: []string{"Live"}}, "Song"), + Entry("returns just title when tag is absent", true, Tags{}, "Song"), + Entry("returns just title when tag is an empty slice", true, Tags{TagSubtitle: []string{}}, "Song"), + ) + DescribeTable("FullAlbumName", + func(enabled bool, tags Tags, expected string) { + conf.Server.Subsonic.AppendAlbumVersion = enabled + mf := MediaFile{Album: "Album", Tags: tags} + Expect(mf.FullAlbumName()).To(Equal(expected)) + }, + Entry("appends version when enabled and tag is present", true, Tags{TagAlbumVersion: []string{"Deluxe Edition"}}, "Album (Deluxe Edition)"), + Entry("returns just album name when disabled", false, Tags{TagAlbumVersion: []string{"Deluxe Edition"}}, "Album"), + Entry("returns just album name when tag is absent", true, Tags{}, "Album"), + Entry("returns just album name when tag is an empty slice", true, Tags{TagAlbumVersion: []string{}}, "Album"), + ) + Describe("CoverArtId", func() { It("returns its own id if it HasCoverArt", func() { mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: true} id := mf.CoverArtID() Expect(id.Kind).To(Equal(KindMediaFileArtwork)) Expect(id.ID).To(Equal(mf.ID)) }) - It("returns its album id if HasCoverArt is false", func() { + It("returns disc art id if HasCoverArt is false and DiscNumber > 0", func() { + mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: false, DiscNumber: 2} + id := mf.CoverArtID() + Expect(id.Kind).To(Equal(KindDiscArtwork)) + Expect(id.ID).To(Equal("1:2")) + }) + It("returns its album id if HasCoverArt is false and DiscNumber is 0", func() { mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: false} id := mf.CoverArtID() Expect(id.Kind).To(Equal(KindAlbumArtwork)) Expect(id.ID).To(Equal(mf.AlbumID)) }) - It("returns its album id if EnableMediaFileCoverArt is disabled", func() { + It("returns disc art id if EnableMediaFileCoverArt is disabled and DiscNumber > 0", func() { + conf.Server.EnableMediaFileCoverArt = false + mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: true, DiscNumber: 3} + id := mf.CoverArtID() + Expect(id.Kind).To(Equal(KindDiscArtwork)) + Expect(id.ID).To(Equal("1:3")) + }) + It("returns its album id if EnableMediaFileCoverArt is disabled and DiscNumber is 0", func() { conf.Server.EnableMediaFileCoverArt = false mf := MediaFile{ID: "111", AlbumID: "1", HasCoverArt: true} id := mf.CoverArtID() @@ -430,6 +550,58 @@ var _ = Describe("MediaFile", func() { Expect(id.ID).To(Equal(mf.AlbumID)) }) }) + + Describe("AudioCodec", func() { + It("returns normalized stored codec when available", func() { + mf := MediaFile{Codec: "AAC", Suffix: "m4a"} + Expect(mf.AudioCodec()).To(Equal("aac")) + }) + + It("returns stored codec lowercased", func() { + mf := MediaFile{Codec: "ALAC", Suffix: "m4a"} + Expect(mf.AudioCodec()).To(Equal("alac")) + }) + + DescribeTable("infers codec from suffix when Codec field is empty", + func(suffix string, bitDepth int, expected string) { + mf := MediaFile{Suffix: suffix, BitDepth: bitDepth} + Expect(mf.AudioCodec()).To(Equal(expected)) + }, + Entry("mp3", "mp3", 0, "mp3"), + Entry("mpga", "mpga", 0, "mp3"), + Entry("mp2", "mp2", 0, "mp2"), + Entry("ogg", "ogg", 0, "vorbis"), + Entry("oga", "oga", 0, "vorbis"), + Entry("opus", "opus", 0, "opus"), + Entry("mpc", "mpc", 0, "mpc"), + Entry("wma", "wma", 0, "wma"), + Entry("flac", "flac", 0, "flac"), + Entry("wav", "wav", 0, "pcm"), + Entry("aif", "aif", 0, "pcm"), + Entry("aiff", "aiff", 0, "pcm"), + Entry("aifc", "aifc", 0, "pcm"), + Entry("ape", "ape", 0, "ape"), + Entry("wv", "wv", 0, "wv"), + Entry("wvp", "wvp", 0, "wv"), + Entry("tta", "tta", 0, "tta"), + Entry("tak", "tak", 0, "tak"), + Entry("shn", "shn", 0, "shn"), + Entry("dsf", "dsf", 0, "dsd"), + Entry("dff", "dff", 0, "dsd"), + Entry("m4a with BitDepth=0 (AAC)", "m4a", 0, "aac"), + Entry("m4a with BitDepth>0 (ALAC)", "m4a", 16, "alac"), + Entry("m4b", "m4b", 0, "aac"), + Entry("m4p", "m4p", 0, "aac"), + Entry("m4r", "m4r", 0, "aac"), + Entry("unknown suffix", "xyz", 0, ""), + ) + + It("prefers stored codec over suffix inference", func() { + mf := MediaFile{Codec: "ALAC", Suffix: "m4a", BitDepth: 0} + Expect(mf.AudioCodec()).To(Equal("alac")) + }) + }) + }) func t(v string) time.Time { diff --git a/model/metadata/legacy_ids.go b/model/metadata/legacy_ids.go index 25025ea19..18a273550 100644 --- a/model/metadata/legacy_ids.go +++ b/model/metadata/legacy_ids.go @@ -14,18 +14,25 @@ import ( // These are the legacy ID functions that were used in the original Navidrome ID generation. // They are kept here for backwards compatibility with existing databases. -func legacyTrackID(mf model.MediaFile) string { - return fmt.Sprintf("%x", md5.Sum([]byte(mf.Path))) +func legacyTrackID(mf model.MediaFile, prependLibId bool) string { + id := mf.Path + if prependLibId && mf.LibraryID != model.DefaultLibraryID { + id = fmt.Sprintf("%d\\%s", mf.LibraryID, id) + } + return fmt.Sprintf("%x", md5.Sum([]byte(id))) } -func legacyAlbumID(md Metadata) string { - releaseDate := legacyReleaseDate(md) +func legacyAlbumID(mf model.MediaFile, md Metadata, prependLibId bool) string { + _, _, releaseDate := md.mapDates() albumPath := strings.ToLower(fmt.Sprintf("%s\\%s", legacyMapAlbumArtistName(md), legacyMapAlbumName(md))) if !conf.Server.Scanner.GroupAlbumReleases { if len(releaseDate) != 0 { albumPath = fmt.Sprintf("%s\\%s", albumPath, releaseDate) } } + if prependLibId && mf.LibraryID != model.DefaultLibraryID { + albumPath = fmt.Sprintf("%d\\%s", mf.LibraryID, albumPath) + } return fmt.Sprintf("%x", md5.Sum([]byte(albumPath))) } @@ -48,9 +55,3 @@ func legacyMapAlbumName(md Metadata) string { consts.UnknownAlbum, ) } - -// Keep the TaggedLikePicard logic for backwards compatibility -func legacyReleaseDate(md Metadata) string { - _, _, releaseDate := md.mapDates() - return string(releaseDate) -} diff --git a/model/metadata/legacy_ids_test.go b/model/metadata/legacy_ids_test.go deleted file mode 100644 index b6d096763..000000000 --- a/model/metadata/legacy_ids_test.go +++ /dev/null @@ -1,30 +0,0 @@ -package metadata - -import ( - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("legacyReleaseDate", func() { - - DescribeTable("legacyReleaseDate", - func(recordingDate, originalDate, releaseDate, expected string) { - md := New("", Info{ - Tags: map[string][]string{ - "DATE": {recordingDate}, - "ORIGINALDATE": {originalDate}, - "RELEASEDATE": {releaseDate}, - }, - }) - - result := legacyReleaseDate(md) - Expect(result).To(Equal(expected)) - }, - Entry("regular mapping", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), - Entry("legacy mapping", "2020-05-15", "2019-02-10", "", "2020-05-15"), - Entry("legacy mapping, originalYear < year", "2018-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), - Entry("legacy mapping, originalYear empty", "2020-05-15", "", "2021-01-01", "2021-01-01"), - Entry("legacy mapping, releaseYear", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), - Entry("legacy mapping, same dates", "2020-05-15", "2020-05-15", "", "2020-05-15"), - ) -}) diff --git a/model/metadata/map_mediafile.go b/model/metadata/map_mediafile.go index b4857df85..824cad7c2 100644 --- a/model/metadata/map_mediafile.go +++ b/model/metadata/map_mediafile.go @@ -7,9 +7,9 @@ import ( "math" "strconv" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/utils/str" ) @@ -53,9 +53,9 @@ func (md Metadata) ToMediaFile(libID int, folderID string) model.MediaFile { mf.MbzAlbumType = md.String(model.TagReleaseType) // ReplayGain - mf.RGAlbumPeak = md.Float(model.TagReplayGainAlbumPeak, 1) + mf.RGAlbumPeak = md.NullableFloat(model.TagReplayGainAlbumPeak) mf.RGAlbumGain = md.mapGain(model.TagReplayGainAlbumGain, model.TagR128AlbumGain) - mf.RGTrackPeak = md.Float(model.TagReplayGainTrackPeak, 1) + mf.RGTrackPeak = md.NullableFloat(model.TagReplayGainTrackPeak) mf.RGTrackGain = md.mapGain(model.TagReplayGainTrackGain, model.TagR128TrackGain) // General properties @@ -65,6 +65,7 @@ func (md Metadata) ToMediaFile(libID int, folderID string) model.MediaFile { mf.SampleRate = md.AudioProperties().SampleRate mf.BitDepth = md.AudioProperties().BitDepth mf.Channels = md.AudioProperties().Channels + mf.Codec = md.AudioProperties().Codec mf.Path = md.FilePath() mf.Suffix = md.Suffix() mf.Size = md.Size() @@ -77,7 +78,7 @@ func (md Metadata) ToMediaFile(libID int, folderID string) model.MediaFile { // Persistent IDs mf.PID = md.trackPID(mf) - mf.AlbumID = md.albumID(mf) + mf.AlbumID = md.albumID(mf, conf.Server.PID.Album) // BFR These IDs will go away once the UI handle multiple participants. // BFR For Legacy Subsonic compatibility, we will set them in the API handlers @@ -104,27 +105,27 @@ func (md Metadata) ToMediaFile(libID int, folderID string) model.MediaFile { } func (md Metadata) AlbumID(mf model.MediaFile, pidConf string) string { - getPID := createGetPID(id.NewHash) - return getPID(mf, md, pidConf) + return md.albumID(mf, pidConf) } -func (md Metadata) mapGain(rg, r128 model.TagName) float64 { +func (md Metadata) mapGain(rg, r128 model.TagName) *float64 { v := md.Gain(rg) - if v != 0 { + if v != nil { return v } r128value := md.String(r128) if r128value != "" { var v, err = strconv.Atoi(r128value) if err != nil { - return 0 + return nil } // Convert Q7.8 to float - var value = float64(v) / 256.0 + value := float64(v) / 256.0 // Adding 5 dB to normalize with ReplayGain level - return value + 5 + value += 5 + return &value } - return 0 + return nil } func (md Metadata) mapLyrics() string { diff --git a/model/metadata/map_mediafile_test.go b/model/metadata/map_mediafile_test.go index ddda39bc2..16142f526 100644 --- a/model/metadata/map_mediafile_test.go +++ b/model/metadata/map_mediafile_test.go @@ -8,7 +8,6 @@ import ( "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/metadata" "github.com/navidrome/navidrome/tests" - . "github.com/navidrome/navidrome/utils/gg" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -75,6 +74,23 @@ var _ = Describe("ToMediaFile", func() { Expect(mf.OriginalYear).To(Equal(1966)) Expect(mf.ReleaseYear).To(Equal(2014)) }) + DescribeTable("legacyReleaseDate (TaggedLikePicard old behavior)", + func(recordingDate, originalDate, releaseDate, expected string) { + mf := toMediaFile(model.RawTags{ + "DATE": {recordingDate}, + "ORIGINALDATE": {originalDate}, + "RELEASEDATE": {releaseDate}, + }) + + Expect(mf.ReleaseDate).To(Equal(expected)) + }, + Entry("regular mapping", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), + Entry("legacy mapping", "2020-05-15", "2019-02-10", "", "2020-05-15"), + Entry("legacy mapping, originalYear < year", "2018-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), + Entry("legacy mapping, originalYear empty", "2020-05-15", "", "2021-01-01", "2021-01-01"), + Entry("legacy mapping, releaseYear", "2020-05-15", "2019-02-10", "2021-01-01", "2021-01-01"), + Entry("legacy mapping, same dates", "2020-05-15", "2020-05-15", "", "2020-05-15"), + ) }) Describe("Lyrics", func() { @@ -91,8 +107,8 @@ var _ = Describe("ToMediaFile", func() { expected := model.LyricList{ {Lang: "eng", Line: []model.Line{ - {Value: "This is", Start: P(int64(0))}, - {Value: "English SYLT", Start: P(int64(2500))}, + {Value: "This is", Start: new(int64(0))}, + {Value: "English SYLT", Start: new(int64(2500))}, }, Synced: true}, {Lang: "xxx", Line: []model.Line{{Value: "Lyrics"}}, Synced: false}, } diff --git a/model/metadata/map_participants_test.go b/model/metadata/map_participants_test.go index 71cb9c1f2..5ee802ced 100644 --- a/model/metadata/map_participants_test.go +++ b/model/metadata/map_participants_test.go @@ -684,6 +684,26 @@ var _ = Describe("Participants", func() { Expect(composers[2].Name).To(Equal("The Album Artist")) }) }) + + // Sibling fix to https://github.com/navidrome/navidrome/issues/5065: when + // multiple frames map to the same role tag (e.g. TIPL producer entries), + // the configured split separator must still apply to each value. + When("the tag has multiple values", func() { + It("should split each value individually", func() { + mf = toMediaFile(model.RawTags{ + "COMPOSER": {"John Doe/Jane Doe", "Someone Else"}, + }) + + participants := mf.Participants + Expect(participants).To(HaveKeyWithValue(model.RoleComposer, HaveLen(3))) + composers := participants[model.RoleComposer] + Expect(composers).To(ConsistOf( + HaveField("Name", "John Doe"), + HaveField("Name", "Jane Doe"), + HaveField("Name", "Someone Else"), + )) + }) + }) }) Describe("MBID tags", func() { diff --git a/model/metadata/metadata.go b/model/metadata/metadata.go index 471c2434c..48928f989 100644 --- a/model/metadata/metadata.go +++ b/model/metadata/metadata.go @@ -35,6 +35,7 @@ type AudioProperties struct { BitDepth int SampleRate int Channels int + Codec string } type Date string @@ -103,9 +104,11 @@ func (md Metadata) NumAndTotal(key model.TagName) (int, int) { return md.tuple(k func (md Metadata) Float(key model.TagName, def ...float64) float64 { return float(md.first(key), def...) } -func (md Metadata) Gain(key model.TagName) float64 { +func (md Metadata) NullableFloat(key model.TagName) *float64 { return nullableFloat(md.first(key)) } + +func (md Metadata) Gain(key model.TagName) *float64 { v := strings.TrimSpace(strings.Replace(md.first(key), "dB", "", 1)) - return float(v) + return nullableFloat(v) } func (md Metadata) Pairs(key model.TagName) []Pair { values := md.tags[key] @@ -119,14 +122,22 @@ func (md Metadata) first(key model.TagName) string { } func float(value string, def ...float64) float64 { + v := nullableFloat(value) + if v != nil { + return *v + } + if len(def) > 0 { + return def[0] + } + return 0 +} + +func nullableFloat(value string) *float64 { v, err := strconv.ParseFloat(value, 64) if err != nil || v == math.Inf(-1) || math.IsInf(v, 1) || math.IsNaN(v) { - if len(def) > 0 { - return def[0] - } - return 0 + return nil } - return v + return &v } // Used for tracks and discs @@ -235,10 +246,22 @@ func processPairMapping(name model.TagName, mapping model.TagConf, lowered model } } + // always parse id3 pairs. For lyrics, Taglib appears to always provide lyrics:xxx + // Prefer that over format-specific tags + id3Base := parseID3Pairs(name, lowered) + if len(aliasValues) > 0 { - return parseVorbisPairs(aliasValues) + // For lyrics, don't use parseVorbisPairs as parentheses in lyrics content + // should not be interpreted as language keys (e.g. "(intro)" is not a language) + if name == model.TagLyrics { + for _, v := range aliasValues { + id3Base = append(id3Base, NewPair("xxx", v)) + } + } else { + id3Base = append(id3Base, parseVorbisPairs(aliasValues)...) + } } - return parseID3Pairs(name, lowered) + return id3Base } func parseID3Pairs(name model.TagName, lowered model.Tags) []string { @@ -246,8 +269,8 @@ func parseID3Pairs(name model.TagName, lowered model.Tags) []string { prefix := string(name) + ":" for tagKey, tagValues := range lowered { keyStr := string(tagKey) - if strings.HasPrefix(keyStr, prefix) { - keyPart := strings.TrimPrefix(keyStr, prefix) + if after, ok := strings.CutPrefix(keyStr, prefix); ok { + keyPart := after if keyPart == string(name) { keyPart = "" } diff --git a/model/metadata/metadata_test.go b/model/metadata/metadata_test.go index d7473afa7..350731b89 100644 --- a/model/metadata/metadata_test.go +++ b/model/metadata/metadata_test.go @@ -129,6 +129,21 @@ var _ = Describe("Metadata", func() { Expect(md.Strings(model.TagGenre)).To(Equal([]string{"Rock", "Pop", "Punk"})) }) + + // Regression test for https://github.com/navidrome/navidrome/issues/5065 + // + // MP3s with both an ID3v2 TMOO frame and a TXXX:MOOD frame are surfaced by + // TagLib's PropertyMap as a single "mood" key with multiple values. The split + // configuration must still apply to each value individually. + It("should split values from multiple frames mapping to the same tag", func() { + props.Tags = model.RawTags{ + // Same shape as the bug report: two frames, comma-separated content. + "mood": {"Love, Emotional, Ballad", "Love; Emotional; Ballad"}, + } + md = metadata.New(filePath, props) + + Expect(md.Strings(model.TagMood)).To(ConsistOf("Love", "Emotional", "Ballad")) + }) }) DescribeTable("Date", @@ -245,6 +260,18 @@ var _ = Describe("Metadata", func() { metadata.NewPair("eng", "Lyrics"), )) }) + + It("should preserve lyrics starting with parentheses from alias tags", func() { + props.Tags = model.RawTags{ + "LYRICS": {"(line one)\nline two\nline three"}, + } + md = metadata.New(filePath, props) + + Expect(md.All()).To(HaveKey(model.TagLyrics)) + Expect(md.Strings(model.TagLyrics)).To(ContainElements( + metadata.NewPair("xxx", "(line one)\nline two\nline three"), + )) + }) }) Describe("ReplayGain", func() { @@ -257,38 +284,39 @@ var _ = Describe("Metadata", func() { } DescribeTable("Gain", - func(tagValue string, expected float64) { + func(tagValue string, expected *float64) { mf := createMF("replaygain_track_gain", tagValue) Expect(mf.RGTrackGain).To(Equal(expected)) }, - Entry("0", "0", 0.0), - Entry("1.2dB", "1.2dB", 1.2), - Entry("Infinity", "Infinity", 0.0), - Entry("Invalid value", "INVALID VALUE", 0.0), - Entry("NaN", "NaN", 0.0), + Entry("0", "0", new(0.0)), + Entry("1.2dB", "1.2dB", new(1.2)), + Entry("Infinity", "Infinity", nil), + Entry("Invalid value", "INVALID VALUE", nil), + Entry("NaN", "NaN", nil), ) DescribeTable("Peak", - func(tagValue string, expected float64) { + func(tagValue string, expected *float64) { mf := createMF("replaygain_track_peak", tagValue) Expect(mf.RGTrackPeak).To(Equal(expected)) }, - Entry("0", "0", 0.0), - Entry("0.5", "0.5", 0.5), - Entry("Invalid dB suffix", "0.7dB", 1.0), - Entry("Infinity", "Infinity", 1.0), - Entry("Invalid value", "INVALID VALUE", 1.0), - Entry("NaN", "NaN", 1.0), + Entry("0", "0", new(0.0)), + Entry("1.0", "1.0", new(1.0)), + Entry("0.5", "0.5", new(0.5)), + Entry("Invalid dB suffix", "0.7dB", nil), + Entry("Infinity", "Infinity", nil), + Entry("Invalid value", "INVALID VALUE", nil), + Entry("NaN", "NaN", nil), ) DescribeTable("getR128GainValue", - func(tagValue string, expected float64) { + func(tagValue string, expected *float64) { mf := createMF("r128_track_gain", tagValue) Expect(mf.RGTrackGain).To(Equal(expected)) }, - Entry("0", "0", 5.0), - Entry("-3776", "-3776", -9.75), - Entry("Infinity", "Infinity", 0.0), - Entry("Invalid value", "INVALID VALUE", 0.0), + Entry("0", "0", new(5.0)), + Entry("-3776", "-3776", new(-9.75)), + Entry("Infinity", "Infinity", nil), + Entry("Invalid value", "INVALID VALUE", nil), ) }) diff --git a/model/metadata/persistent_ids.go b/model/metadata/persistent_ids.go index a71749e81..db315dc6b 100644 --- a/model/metadata/persistent_ids.go +++ b/model/metadata/persistent_ids.go @@ -2,86 +2,95 @@ package metadata import ( "cmp" + "fmt" "path/filepath" "strings" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/utils" - "github.com/navidrome/navidrome/utils/slice" "github.com/navidrome/navidrome/utils/str" ) type hashFunc = func(...string) string -// getPID returns the persistent ID for a given spec, getting the referenced values from the metadata -// The spec is a pipe-separated list of fields, where each field is a comma-separated list of attributes -// Attributes can be either tags or some processed values like folder, albumid, albumartistid, etc. -// For each field, it gets all its attributes values and concatenates them, then hashes the result. -// If a field is empty, it is skipped and the function looks for the next field. -func createGetPID(hash hashFunc) func(mf model.MediaFile, md Metadata, spec string) string { - var getPID func(mf model.MediaFile, md Metadata, spec string) string - getAttr := func(mf model.MediaFile, md Metadata, attr string) string { - switch attr { - case "albumid": - return getPID(mf, md, conf.Server.PID.Album) - case "folder": - return filepath.Dir(mf.Path) - case "albumartistid": - return hash(str.Clear(strings.ToLower(mf.AlbumArtist))) - case "title": - return mf.Title - case "album": - return str.Clear(strings.ToLower(md.String(model.TagAlbum))) - } - return md.String(model.TagName(attr)) +// computePID calculates the persistent ID for a given spec. The spec is a +// pipe-separated list of fields, where each field is a comma-separated list of +// attributes. Attributes can be either tags or processed values like folder, +// albumid, albumartistid, etc. For each field, it gets all its attribute values +// and concatenates them, then hashes the result. If a field is empty, it is +// skipped and the function looks for the next field. +// +// Taking hash as a parameter (instead of closing over it in a factory) keeps +// mf on the stack: closing over mf would force the whole ~1KB MediaFile to the +// heap on every call. +func computePID(mf model.MediaFile, md Metadata, spec string, prependLibId bool, hash hashFunc) string { + switch spec { + case "track_legacy": + return legacyTrackID(mf, prependLibId) + case "album_legacy": + return legacyAlbumID(mf, md, prependLibId) } - getPID = func(mf model.MediaFile, md Metadata, spec string) string { - pid := "" - fields := strings.Split(spec, "|") - for _, field := range fields { - attributes := strings.Split(field, ",") - hasValue := false - values := slice.Map(attributes, func(attr string) string { - v := getAttr(mf, md, attr) - if v != "" { - hasValue = true - } - return v - }) - if hasValue { - pid += strings.Join(values, "\\") - break + pid := "" + fields := strings.SplitSeq(spec, "|") + for field := range fields { + attributes := strings.Split(field, ",") + values := make([]string, len(attributes)) + hasValue := false + for i, attr := range attributes { + v := getPIDAttr(mf, md, attr, prependLibId, spec, hash) + if v != "" { + hasValue = true } + values[i] = v + } + if hasValue { + pid += strings.Join(values, "\\") + break } - return hash(pid) } + if prependLibId { + pid = fmt.Sprintf("%d\\%s", mf.LibraryID, pid) + } + return hash(pid) +} - return func(mf model.MediaFile, md Metadata, spec string) string { - switch spec { - case "track_legacy": - return legacyTrackID(mf) - case "album_legacy": - return legacyAlbumID(md) +func getPIDAttr(mf model.MediaFile, md Metadata, attr string, prependLibId bool, spec string, hash hashFunc) string { + attr = strings.TrimSpace(strings.ToLower(attr)) + switch attr { + case "albumid": + if spec == conf.Server.PID.Album { + log.Error("Recursive PID definition detected, ignoring `albumid`", "spec", spec) + return "" } - return getPID(mf, md, spec) + return computePID(mf, md, conf.Server.PID.Album, prependLibId, hash) + case "folder": + return filepath.Dir(mf.Path) + case "albumartistid": + return hash(str.Clear(strings.ToLower(mf.AlbumArtist))) + case "title": + return mf.Title + case "album": + return str.Clear(strings.ToLower(md.String(model.TagAlbum))) } + return md.String(model.TagName(attr)) } func (md Metadata) trackPID(mf model.MediaFile) string { - return createGetPID(id.NewHash)(mf, md, conf.Server.PID.Track) + return computePID(mf, md, conf.Server.PID.Track, true, id.NewHash) } -func (md Metadata) albumID(mf model.MediaFile) string { - return createGetPID(id.NewHash)(mf, md, conf.Server.PID.Album) +func (md Metadata) albumID(mf model.MediaFile, pidConf string) string { + return computePID(mf, md, pidConf, true, id.NewHash) } // BFR Must be configurable? func (md Metadata) artistID(name string) string { mf := model.MediaFile{AlbumArtist: name} - return createGetPID(id.NewHash)(mf, md, "albumartistid") + return computePID(mf, md, "albumartistid", false, id.NewHash) } func (md Metadata) mapTrackTitle() string { diff --git a/model/metadata/persistent_ids_test.go b/model/metadata/persistent_ids_test.go index 6903abc05..eb66d11d1 100644 --- a/model/metadata/persistent_ids_test.go +++ b/model/metadata/persistent_ids_test.go @@ -6,21 +6,23 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) var _ = Describe("getPID", func() { var ( - md Metadata - mf model.MediaFile - sum hashFunc - getPID func(mf model.MediaFile, md Metadata, spec string) string + md Metadata + mf model.MediaFile + sum hashFunc ) + getPID := func(mf model.MediaFile, md Metadata, spec string, prependLibId bool) string { + return computePID(mf, md, spec, prependLibId, sum) + } BeforeEach(func() { sum = func(s ...string) string { return "(" + strings.Join(s, ",") + ")" } - getPID = createGetPID(sum) }) Context("attributes are tags", func() { @@ -28,7 +30,7 @@ var _ = Describe("getPID", func() { When("no attributes were present", func() { It("should return empty pid", func() { md.tags = map[model.TagName][]string{} - pid := getPID(mf, md, spec) + pid := getPID(mf, md, spec, false) Expect(pid).To(Equal("()")) }) }) @@ -40,7 +42,7 @@ var _ = Describe("getPID", func() { "discnumber": {"1"}, "tracknumber": {"1"}, } - Expect(getPID(mf, md, spec)).To(Equal("(mbtrackid)")) + Expect(getPID(mf, md, spec, false)).To(Equal("(mbtrackid)")) }) }) When("only first field is present", func() { @@ -48,7 +50,7 @@ var _ = Describe("getPID", func() { md.tags = map[model.TagName][]string{ "musicbrainz_trackid": {"mbtrackid"}, } - Expect(getPID(mf, md, spec)).To(Equal("(mbtrackid)")) + Expect(getPID(mf, md, spec, false)).To(Equal("(mbtrackid)")) }) }) When("first is empty, but second field is present", func() { @@ -57,14 +59,15 @@ var _ = Describe("getPID", func() { "album": {"album name"}, "discnumber": {"1"}, } - Expect(getPID(mf, md, spec)).To(Equal("(album name\\1\\)")) + Expect(getPID(mf, md, spec, false)).To(Equal("(album name\\1\\)")) }) }) }) + Context("calculated attributes", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) - conf.Server.PID.Album = "musicbrainz_albumid|albumartistid,album,version,releasedate" + conf.Server.PID.Album = "musicbrainz_albumid|albumartistid,album,albumversion,releasedate" }) When("field is title", func() { It("should return the pid", func() { @@ -72,28 +75,29 @@ var _ = Describe("getPID", func() { md.tags = map[model.TagName][]string{"title": {"title"}} md.filePath = "/path/to/file.mp3" mf.Title = "Title" - Expect(getPID(mf, md, spec)).To(Equal("(Title)")) + Expect(getPID(mf, md, spec, false)).To(Equal("(Title)")) }) }) When("field is folder", func() { It("should return the pid", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-metadata)") spec := "folder|title" md.tags = map[model.TagName][]string{"title": {"title"}} mf.Path = "/path/to/file.mp3" - Expect(getPID(mf, md, spec)).To(Equal("(/path/to)")) + Expect(getPID(mf, md, spec, false)).To(Equal("(/path/to)")) }) }) When("field is albumid", func() { It("should return the pid", func() { spec := "albumid|title" md.tags = map[model.TagName][]string{ - "title": {"title"}, - "album": {"album name"}, - "version": {"version"}, - "releasedate": {"2021-01-01"}, + "title": {"title"}, + "album": {"album name"}, + "albumversion": {"deluxe edition"}, + "releasedate": {"2021-01-01"}, } mf.AlbumArtist = "Album Artist" - Expect(getPID(mf, md, spec)).To(Equal("(((album artist)\\album name\\version\\2021-01-01))")) + Expect(getPID(mf, md, spec, false)).To(Equal("(((album artist)\\album name\\deluxe edition\\2021-01-01))")) }) }) When("field is albumartistid", func() { @@ -103,14 +107,186 @@ var _ = Describe("getPID", func() { "albumartist": {"Album Artist"}, } mf.AlbumArtist = "Album Artist" - Expect(getPID(mf, md, spec)).To(Equal("((album artist))")) + Expect(getPID(mf, md, spec, false)).To(Equal("((album artist))")) }) }) When("field is album", func() { It("should return the pid", func() { spec := "album|title" md.tags = map[model.TagName][]string{"album": {"Album Name"}} - Expect(getPID(mf, md, spec)).To(Equal("(album name)")) + Expect(getPID(mf, md, spec, false)).To(Equal("(album name)")) + }) + }) + + When("albumid configuration refers to albumid recursively", func() { + It("should avoid infinite recursion", func() { + // Reproduce the issue from #4920 + conf.Server.PID.Album = "albumid,album,albumversion,releasedate" + spec := conf.Server.PID.Album + md.tags = map[model.TagName][]string{ + "album": {"Album Name"}, + "albumversion": {"Version"}, + "releasedate": {"2022"}, + } + // Should not panic and return a valid PID ignoring the recursive "albumid" + Expect(func() { + pid := getPID(mf, md, spec, false) + Expect(pid).To(Equal("(\\album name\\Version\\2022)")) + }).To(Not(Panic())) + }) + }) + }) + + Context("edge cases", func() { + When("the spec has spaces between groups", func() { + It("should return the pid", func() { + spec := "albumartist| Album" + md.tags = map[model.TagName][]string{ + "album": {"album name"}, + } + Expect(getPID(mf, md, spec, false)).To(Equal("(album name)")) + }) + }) + When("the spec has spaces", func() { + It("should return the pid", func() { + spec := "albumartist, album" + md.tags = map[model.TagName][]string{ + "albumartist": {"Album Artist"}, + "album": {"album name"}, + } + Expect(getPID(mf, md, spec, false)).To(Equal("(Album Artist\\album name)")) + }) + }) + When("the spec has mixed case fields", func() { + It("should return the pid", func() { + spec := "albumartist,Album" + md.tags = map[model.TagName][]string{ + "albumartist": {"Album Artist"}, + "album": {"album name"}, + } + Expect(getPID(mf, md, spec, false)).To(Equal("(Album Artist\\album name)")) + }) + }) + }) + + Context("prependLibId functionality", func() { + BeforeEach(func() { + mf.LibraryID = 42 + }) + When("prependLibId is true", func() { + It("should prepend library ID to the hash input", func() { + spec := "album" + md.tags = map[model.TagName][]string{"album": {"Test Album"}} + pid := getPID(mf, md, spec, true) + // The hash function should receive "42\test album" as input + Expect(pid).To(Equal("(42\\test album)")) + }) + }) + When("prependLibId is false", func() { + It("should not prepend library ID to the hash input", func() { + spec := "album" + md.tags = map[model.TagName][]string{"album": {"Test Album"}} + pid := getPID(mf, md, spec, false) + // The hash function should receive "test album" as input + Expect(pid).To(Equal("(test album)")) + }) + }) + When("prependLibId is true with complex spec", func() { + It("should prepend library ID to the final hash input", func() { + spec := "musicbrainz_trackid|album,tracknumber" + md.tags = map[model.TagName][]string{ + "album": {"Test Album"}, + "tracknumber": {"1"}, + } + pid := getPID(mf, md, spec, true) + // Should use the fallback field and prepend library ID + Expect(pid).To(Equal("(42\\test album\\1)")) + }) + }) + When("prependLibId is true with nested albumid", func() { + It("should handle nested albumid calls correctly", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.PID.Album = "album" + spec := "albumid" + md.tags = map[model.TagName][]string{"album": {"Test Album"}} + mf.AlbumArtist = "Test Artist" + pid := getPID(mf, md, spec, true) + // The albumid call should also use prependLibId=true + Expect(pid).To(Equal("(42\\(42\\test album))")) + }) + }) + }) + + Context("legacy specs", func() { + Context("track_legacy", func() { + When("library ID is default (1)", func() { + It("should not prepend library ID even when prependLibId is true", func() { + mf.Path = "/path/to/track.mp3" + mf.LibraryID = 1 // Default library ID + // With default library, both should be the same + pidTrue := getPID(mf, md, "track_legacy", true) + pidFalse := getPID(mf, md, "track_legacy", false) + Expect(pidTrue).To(Equal(pidFalse)) + Expect(pidTrue).NotTo(BeEmpty()) + }) + }) + When("library ID is non-default", func() { + It("should prepend library ID when prependLibId is true", func() { + mf.Path = "/path/to/track.mp3" + mf.LibraryID = 2 // Non-default library ID + pidTrue := getPID(mf, md, "track_legacy", true) + pidFalse := getPID(mf, md, "track_legacy", false) + Expect(pidTrue).NotTo(Equal(pidFalse)) + Expect(pidTrue).NotTo(BeEmpty()) + Expect(pidFalse).NotTo(BeEmpty()) + }) + }) + When("library ID is non-default but prependLibId is false", func() { + It("should not prepend library ID", func() { + mf.Path = "/path/to/track.mp3" + mf.LibraryID = 3 + mf2 := mf + mf2.LibraryID = 1 // Default library + pidNonDefault := getPID(mf, md, "track_legacy", false) + pidDefault := getPID(mf2, md, "track_legacy", false) + // Should be the same since prependLibId=false + Expect(pidNonDefault).To(Equal(pidDefault)) + }) + }) + }) + Context("album_legacy", func() { + When("library ID is default (1)", func() { + It("should not prepend library ID even when prependLibId is true", func() { + md.tags = map[model.TagName][]string{"album": {"Test Album"}} + mf.LibraryID = 1 // Default library ID + pidTrue := getPID(mf, md, "album_legacy", true) + pidFalse := getPID(mf, md, "album_legacy", false) + Expect(pidTrue).To(Equal(pidFalse)) + Expect(pidTrue).NotTo(BeEmpty()) + }) + }) + When("library ID is non-default", func() { + It("should prepend library ID when prependLibId is true", func() { + md.tags = map[model.TagName][]string{"album": {"Test Album"}} + mf.LibraryID = 2 // Non-default library ID + pidTrue := getPID(mf, md, "album_legacy", true) + pidFalse := getPID(mf, md, "album_legacy", false) + Expect(pidTrue).NotTo(Equal(pidFalse)) + Expect(pidTrue).NotTo(BeEmpty()) + Expect(pidFalse).NotTo(BeEmpty()) + }) + }) + When("library ID is non-default but prependLibId is false", func() { + It("should not prepend library ID", func() { + md.tags = map[model.TagName][]string{"album": {"Test Album"}} + mf.LibraryID = 3 + mf2 := mf + mf2.LibraryID = 1 // Default library + pidNonDefault := getPID(mf, md, "album_legacy", false) + pidDefault := getPID(mf2, md, "album_legacy", false) + // Should be the same since prependLibId=false + Expect(pidNonDefault).To(Equal(pidDefault)) + }) }) }) }) diff --git a/model/participants.go b/model/participants.go index 5f07bf42c..afbda10de 100644 --- a/model/participants.go +++ b/model/participants.go @@ -25,6 +25,8 @@ var ( RoleRemixer = Role{"remixer"} RoleDJMixer = Role{"djmixer"} RolePerformer = Role{"performer"} + // RoleMainCredit is a credit where the artist is an album artist or artist + RoleMainCredit = Role{"maincredit"} ) var AllRoles = map[string]Role{ @@ -41,6 +43,7 @@ var AllRoles = map[string]Role{ RoleRemixer.role: RoleRemixer, RoleDJMixer.role: RoleDJMixer, RolePerformer.role: RolePerformer, + RoleMainCredit.role: RoleMainCredit, } // Role represents the role of an artist in a track or album. diff --git a/model/playlist.go b/model/playlist.go index 521adfcd0..dc549f039 100644 --- a/model/playlist.go +++ b/model/playlist.go @@ -1,30 +1,31 @@ package model import ( - "fmt" "slices" "strconv" - "strings" "time" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model/criteria" ) type Playlist struct { - ID string `structs:"id" json:"id"` - Name string `structs:"name" json:"name"` - Comment string `structs:"comment" json:"comment"` - Duration float32 `structs:"duration" json:"duration"` - Size int64 `structs:"size" json:"size"` - SongCount int `structs:"song_count" json:"songCount"` - OwnerName string `structs:"-" json:"ownerName"` - OwnerID string `structs:"owner_id" json:"ownerId"` - Public bool `structs:"public" json:"public"` - Tracks PlaylistTracks `structs:"-" json:"tracks,omitempty"` - Path string `structs:"path" json:"path"` - Sync bool `structs:"sync" json:"sync"` - CreatedAt time.Time `structs:"created_at" json:"createdAt"` - UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` + ID string `structs:"id" json:"id"` + Name string `structs:"name" json:"name"` + Comment string `structs:"comment" json:"comment"` + Duration float32 `structs:"duration" json:"duration"` + Size int64 `structs:"size" json:"size"` + SongCount int `structs:"song_count" json:"songCount"` + OwnerName string `structs:"-" json:"ownerName"` + OwnerID string `structs:"owner_id" json:"ownerId"` + Public bool `structs:"public" json:"public"` + Tracks PlaylistTracks `structs:"-" json:"tracks,omitempty"` + Path string `structs:"path" json:"path"` + Sync bool `structs:"sync" json:"sync"` + UploadedImage string `structs:"uploaded_image" json:"uploadedImage"` + ExternalImageURL string `structs:"external_image_url" json:"externalImageUrl,omitempty"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` // SmartPlaylist attributes Rules *criteria.Criteria `structs:"rules" json:"rules"` @@ -42,6 +43,21 @@ func (pls Playlist) MediaFiles() MediaFiles { return pls.Tracks.MediaFiles() } +func (pls *Playlist) refreshStats() { + pls.SongCount = len(pls.Tracks) + pls.Duration = 0 + pls.Size = 0 + for _, t := range pls.Tracks { + pls.Duration += t.MediaFile.Duration + pls.Size += t.MediaFile.Size + } +} + +func (pls *Playlist) SetTracks(tracks PlaylistTracks) { + pls.Tracks = tracks + pls.refreshStats() +} + func (pls *Playlist) RemoveTracks(idxToRemove []int) { var newTracks PlaylistTracks for i, t := range pls.Tracks { @@ -51,22 +67,15 @@ func (pls *Playlist) RemoveTracks(idxToRemove []int) { newTracks = append(newTracks, t) } pls.Tracks = newTracks + pls.refreshStats() } -// ToM3U8 exports the playlist to the Extended M3U8 format, as specified in -// https://docs.fileformat.com/audio/m3u/#extended-m3u +// ToM3U8 exports the playlist to the Extended M3U8 format func (pls *Playlist) ToM3U8() string { - buf := strings.Builder{} - buf.WriteString("#EXTM3U\n") - buf.WriteString(fmt.Sprintf("#PLAYLIST:%s\n", pls.Name)) - for _, t := range pls.Tracks { - buf.WriteString(fmt.Sprintf("#EXTINF:%.f,%s - %s\n", t.Duration, t.Artist, t.Title)) - buf.WriteString(t.AbsolutePath() + "\n") - } - return buf.String() + return pls.MediaFiles().ToM3U8(pls.Name, true) } -func (pls *Playlist) AddTracks(mediaFileIds []string) { +func (pls *Playlist) AddMediaFilesByID(mediaFileIds []string) { pos := len(pls.Tracks) for _, mfId := range mediaFileIds { pos++ @@ -78,6 +87,7 @@ func (pls *Playlist) AddTracks(mediaFileIds []string) { } pls.Tracks = append(pls.Tracks, t) } + pls.refreshStats() } func (pls *Playlist) AddMediaFiles(mfs MediaFiles) { @@ -92,25 +102,35 @@ func (pls *Playlist) AddMediaFiles(mfs MediaFiles) { } pls.Tracks = append(pls.Tracks, t) } + pls.refreshStats() } func (pls Playlist) CoverArtID() ArtworkID { return artworkIDFromPlaylist(pls) } +// UploadedImagePath returns the absolute filesystem path for a manually uploaded +// playlist cover image. Returns empty string if no image has been uploaded. +// This does NOT cover sidecar images or external URLs — those are resolved +// by the artwork reader's fallback chain. +func (pls Playlist) UploadedImagePath() string { + return UploadedImagePath(consts.EntityPlaylist, pls.UploadedImage) +} + type Playlists []Playlist type PlaylistRepository interface { ResourceRepository CountAll(options ...QueryOptions) (int64, error) Exists(id string) (bool, error) - Put(pls *Playlist) error + Put(pls *Playlist, cols ...string) error Get(id string) (*Playlist, error) GetWithTracks(id string, refreshSmartPlaylist, includeMissing bool) (*Playlist, error) GetAll(options ...QueryOptions) (Playlists, error) FindByPath(path string) (*Playlist, error) Delete(id string) error Tracks(playlistId string, refreshSmartPlaylist bool) PlaylistTrackRepository + GetPlaylists(mediaFileId string) (Playlists, error) } type PlaylistTrack struct { diff --git a/model/playlists_test.go b/model/playlist_test.go similarity index 68% rename from model/playlists_test.go rename to model/playlist_test.go index 600e116cc..9ed24f00f 100644 --- a/model/playlists_test.go +++ b/model/playlist_test.go @@ -2,6 +2,7 @@ package model_test import ( "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -13,16 +14,21 @@ var _ = Describe("Playlist", func() { pls = model.Playlist{Name: "Mellow sunset"} pls.Tracks = model.PlaylistTracks{ {MediaFile: model.MediaFile{Artist: "Morcheeba feat. Kurt Wagner", Title: "What New York Couples Fight About", - Duration: 377.84, Path: "/music/library/Morcheeba/Charango/01-06 What New York Couples Fight About.mp3"}}, + Duration: 377.84, + LibraryPath: "/music/library", Path: "Morcheeba/Charango/01-06 What New York Couples Fight About.mp3"}}, {MediaFile: model.MediaFile{Artist: "A Tribe Called Quest", Title: "Description of a Fool (Groove Armada's Acoustic mix)", - Duration: 374.49, Path: "/music/library/Groove Armada/Back to Mine_ Groove Armada/01-01 Description of a Fool (Groove Armada's Acoustic mix).mp3"}}, + Duration: 374.49, + LibraryPath: "/music/library", Path: "Groove Armada/Back to Mine_ Groove Armada/01-01 Description of a Fool (Groove Armada's Acoustic mix).mp3"}}, {MediaFile: model.MediaFile{Artist: "Lou Reed", Title: "Walk on the Wild Side", - Duration: 253.1, Path: "/music/library/Lou Reed/Walk on the Wild Side_ The Best of Lou Reed/01-06 Walk on the Wild Side.m4a"}}, + Duration: 253.1, + LibraryPath: "/music/library", Path: "Lou Reed/Walk on the Wild Side_ The Best of Lou Reed/01-06 Walk on the Wild Side.m4a"}}, {MediaFile: model.MediaFile{Artist: "Legião Urbana", Title: "On the Way Home", - Duration: 163.89, Path: "/music/library/Legião Urbana/Música p_ acampamentos/02-05 On the Way Home.mp3"}}, + Duration: 163.89, + LibraryPath: "/music/library", Path: "Legião Urbana/Música p_ acampamentos/02-05 On the Way Home.mp3"}}, } }) It("generates the correct M3U format", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-model)") expected := `#EXTM3U #PLAYLIST:Mellow sunset #EXTINF:378,Morcheeba feat. Kurt Wagner - What New York Couples Fight About diff --git a/model/playqueue.go b/model/playqueue.go index 52ba173d3..03b562253 100644 --- a/model/playqueue.go +++ b/model/playqueue.go @@ -7,7 +7,7 @@ import ( type PlayQueue struct { ID string `structs:"id" json:"id"` UserID string `structs:"user_id" json:"userId"` - Current string `structs:"current" json:"current"` + Current int `structs:"current" json:"current"` Position int64 `structs:"position" json:"position"` ChangedBy string `structs:"changed_by" json:"changedBy"` Items MediaFiles `structs:"-" json:"items,omitempty"` @@ -18,6 +18,11 @@ type PlayQueue struct { type PlayQueues []PlayQueue type PlayQueueRepository interface { - Store(queue *PlayQueue) error + Store(queue *PlayQueue, colNames ...string) error + // Retrieve returns the playqueue without loading the full MediaFiles + // (Items only contain IDs) Retrieve(userId string) (*PlayQueue, error) + // RetrieveWithMediaFiles returns the playqueue with full MediaFiles loaded + RetrieveWithMediaFiles(userId string) (*PlayQueue, error) + Clear(userId string) error } diff --git a/model/plugin.go b/model/plugin.go new file mode 100644 index 000000000..18d66e305 --- /dev/null +++ b/model/plugin.go @@ -0,0 +1,32 @@ +package model + +import "time" + +type Plugin struct { + ID string `structs:"id" json:"id"` + Path string `structs:"path" json:"path"` + Manifest string `structs:"manifest" json:"manifest"` + Config string `structs:"config" json:"config,omitempty"` + Users string `structs:"users" json:"users,omitempty"` + AllUsers bool `structs:"all_users" json:"allUsers,omitempty"` + Libraries string `structs:"libraries" json:"libraries,omitempty"` + AllLibraries bool `structs:"all_libraries" json:"allLibraries,omitempty"` + AllowWriteAccess bool `structs:"allow_write_access" json:"allowWriteAccess,omitempty"` + Enabled bool `structs:"enabled" json:"enabled"` + LastError string `structs:"last_error" json:"lastError,omitempty"` + SHA256 string `structs:"sha256" json:"sha256"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` +} + +type Plugins []Plugin + +type PluginRepository interface { + ResourceRepository + ClearErrors() error + CountAll(options ...QueryOptions) (int64, error) + Delete(id string) error + Get(id string) (*Plugin, error) + GetAll(options ...QueryOptions) (Plugins, error) + Put(p *Plugin) error +} diff --git a/model/radio.go b/model/radio.go index 567d32e44..86f27c24c 100644 --- a/model/radio.go +++ b/model/radio.go @@ -1,14 +1,27 @@ package model -import "time" +import ( + "time" + + "github.com/navidrome/navidrome/consts" +) type Radio struct { - ID string `structs:"id" json:"id"` - StreamUrl string `structs:"stream_url" json:"streamUrl"` - Name string `structs:"name" json:"name"` - HomePageUrl string `structs:"home_page_url" json:"homePageUrl"` - CreatedAt time.Time `structs:"created_at" json:"createdAt"` - UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` + ID string `structs:"id" json:"id"` + StreamUrl string `structs:"stream_url" json:"streamUrl"` + Name string `structs:"name" json:"name"` + HomePageUrl string `structs:"home_page_url" json:"homePageUrl"` + UploadedImage string `structs:"uploaded_image" json:"uploadedImage,omitempty"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` +} + +func (r Radio) CoverArtID() ArtworkID { + return artworkIDFromRadio(r) +} + +func (r Radio) UploadedImagePath() string { + return UploadedImagePath(consts.EntityRadio, r.UploadedImage) } type Radios []Radio @@ -19,5 +32,5 @@ type RadioRepository interface { Delete(id string) error Get(id string) (*Radio, error) GetAll(options ...QueryOptions) (Radios, error) - Put(u *Radio) error + Put(u *Radio, colsToUpdate ...string) error } diff --git a/model/radio_test.go b/model/radio_test.go new file mode 100644 index 000000000..860331f17 --- /dev/null +++ b/model/radio_test.go @@ -0,0 +1,42 @@ +package model_test + +import ( + "path/filepath" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Radio", func() { + Describe("CoverArtID", func() { + It("returns a radio artwork ID", func() { + now := time.Now() + r := model.Radio{ID: "rd-1", UpdatedAt: now} + artID := r.CoverArtID() + Expect(artID.Kind).To(Equal(model.KindRadioArtwork)) + Expect(artID.ID).To(Equal("rd-1")) + Expect(artID.LastUpdate).To(Equal(now)) + }) + }) + + Describe("UploadedImagePath", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = conf.NewDir("/data") + }) + + It("returns empty string when no image uploaded", func() { + r := model.Radio{ID: "rd-1"} + Expect(r.UploadedImagePath()).To(BeEmpty()) + }) + + It("returns full path when image is set", func() { + r := model.Radio{ID: "rd-1", UploadedImage: "rd-1_test.jpg"} + Expect(r.UploadedImagePath()).To(Equal(filepath.Join("/data", "artwork", "radio", "rd-1_test.jpg"))) + }) + }) +}) diff --git a/model/request/request.go b/model/request/request.go index 5f2980340..8d7919298 100644 --- a/model/request/request.go +++ b/model/request/request.go @@ -17,6 +17,7 @@ const ( Transcoding = contextKey("transcoding") ClientUniqueId = contextKey("clientUniqueId") ReverseProxyIp = contextKey("reverseProxyIp") + InternalAuth = contextKey("internalAuth") // Used for internal API calls, e.g., from the plugins ) var allKeys = []contextKey{ @@ -28,6 +29,7 @@ var allKeys = []contextKey{ Transcoding, ClientUniqueId, ReverseProxyIp, + InternalAuth, } func WithUser(ctx context.Context, u model.User) context.Context { @@ -62,6 +64,10 @@ func WithReverseProxyIp(ctx context.Context, reverseProxyIp string) context.Cont return context.WithValue(ctx, ReverseProxyIp, reverseProxyIp) } +func WithInternalAuth(ctx context.Context, username string) context.Context { + return context.WithValue(ctx, InternalAuth, username) +} + func UserFrom(ctx context.Context) (model.User, bool) { v, ok := ctx.Value(User).(model.User) return v, ok @@ -102,6 +108,15 @@ func ReverseProxyIpFrom(ctx context.Context) (string, bool) { return v, ok } +func InternalAuthFrom(ctx context.Context) (string, bool) { + if v := ctx.Value(InternalAuth); v != nil { + if username, ok := v.(string); ok { + return username, true + } + } + return "", false +} + func AddValues(ctx, requestCtx context.Context) context.Context { for _, key := range allKeys { if v := requestCtx.Value(key); v != nil { diff --git a/model/scanner.go b/model/scanner.go new file mode 100644 index 000000000..54f81037c --- /dev/null +++ b/model/scanner.go @@ -0,0 +1,81 @@ +package model + +import ( + "context" + "fmt" + "strconv" + "strings" + "time" +) + +// ScanTarget represents a specific folder within a library to be scanned. +// NOTE: This struct is used as a map key, so it should only contain comparable types. +type ScanTarget struct { + LibraryID int + FolderPath string // Relative path within the library, or "" for entire library +} + +func (st ScanTarget) String() string { + return fmt.Sprintf("%d:%s", st.LibraryID, st.FolderPath) +} + +// ScannerStatus holds information about the current scan status +type ScannerStatus struct { + Scanning bool + LastScan time.Time + Count uint32 + FolderCount uint32 + LastError string + ScanType string + ElapsedTime time.Duration +} + +type Scanner interface { + // ScanAll starts a scan of all libraries. This is a blocking operation. + ScanAll(ctx context.Context, fullScan bool) (warnings []string, err error) + // ScanFolders scans specific library/folder pairs, recursing into subdirectories. + // If targets is nil, it scans all libraries. This is a blocking operation. + ScanFolders(ctx context.Context, fullScan bool, targets []ScanTarget) (warnings []string, err error) + Status(context.Context) (*ScannerStatus, error) +} + +// ParseTargets parses scan targets strings into ScanTarget structs. +// Example: []string{"1:Music/Rock", "2:Classical"} +func ParseTargets(libFolders []string) ([]ScanTarget, error) { + targets := make([]ScanTarget, 0, len(libFolders)) + + for _, part := range libFolders { + part = strings.TrimSpace(part) + if part == "" { + continue + } + + // Split by the first colon + before, after, ok := strings.Cut(part, ":") + if !ok { + return nil, fmt.Errorf("invalid target format: %q (expected libraryID:folderPath)", part) + } + + libIDStr := before + folderPath := after + + libID, err := strconv.Atoi(libIDStr) + if err != nil { + return nil, fmt.Errorf("invalid library ID %q: %w", libIDStr, err) + } + if libID <= 0 { + return nil, fmt.Errorf("invalid library ID %q", libIDStr) + } + + targets = append(targets, ScanTarget{ + LibraryID: libID, + FolderPath: folderPath, + }) + } + + if len(targets) == 0 { + return nil, fmt.Errorf("no valid targets found") + } + + return targets, nil +} diff --git a/model/scanner_test.go b/model/scanner_test.go new file mode 100644 index 000000000..8ca0c53fa --- /dev/null +++ b/model/scanner_test.go @@ -0,0 +1,89 @@ +package model_test + +import ( + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ParseTargets", func() { + It("parses multiple entries in slice", func() { + targets, err := model.ParseTargets([]string{"1:Music/Rock", "1:Music/Jazz", "2:Classical"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(3)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + Expect(targets[1].LibraryID).To(Equal(1)) + Expect(targets[1].FolderPath).To(Equal("Music/Jazz")) + Expect(targets[2].LibraryID).To(Equal(2)) + Expect(targets[2].FolderPath).To(Equal("Classical")) + }) + + It("handles empty folder paths", func() { + targets, err := model.ParseTargets([]string{"1:", "2:"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].FolderPath).To(Equal("")) + Expect(targets[1].FolderPath).To(Equal("")) + }) + + It("trims whitespace from entries", func() { + targets, err := model.ParseTargets([]string{" 1:Music/Rock", " 2:Classical "}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + Expect(targets[1].LibraryID).To(Equal(2)) + Expect(targets[1].FolderPath).To(Equal("Classical")) + }) + + It("skips empty strings", func() { + targets, err := model.ParseTargets([]string{"1:Music/Rock", "", "2:Classical"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + }) + + It("handles paths with colons", func() { + targets, err := model.ParseTargets([]string{"1:C:/Music/Rock", "2:/path:with:colons"}) + Expect(err).ToNot(HaveOccurred()) + Expect(targets).To(HaveLen(2)) + Expect(targets[0].FolderPath).To(Equal("C:/Music/Rock")) + Expect(targets[1].FolderPath).To(Equal("/path:with:colons")) + }) + + It("returns error for invalid format without colon", func() { + _, err := model.ParseTargets([]string{"1Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid target format")) + }) + + It("returns error for non-numeric library ID", func() { + _, err := model.ParseTargets([]string{"abc:Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid library ID")) + }) + + It("returns error for negative library ID", func() { + _, err := model.ParseTargets([]string{"-1:Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid library ID")) + }) + + It("returns error for zero library ID", func() { + _, err := model.ParseTargets([]string{"0:Music/Rock"}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid library ID")) + }) + + It("returns error for empty input", func() { + _, err := model.ParseTargets([]string{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no valid targets found")) + }) + + It("returns error for all empty strings", func() { + _, err := model.ParseTargets([]string{"", " ", ""}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no valid targets found")) + }) +}) diff --git a/model/scrobble.go b/model/scrobble.go new file mode 100644 index 000000000..e1567abc3 --- /dev/null +++ b/model/scrobble.go @@ -0,0 +1,13 @@ +package model + +import "time" + +type Scrobble struct { + MediaFileID string + UserID string + SubmissionTime time.Time +} + +type ScrobbleRepository interface { + RecordScrobble(mediaFileID string, submissionTime time.Time) error +} diff --git a/model/searchable.go b/model/searchable.go index d37299997..a64a0171c 100644 --- a/model/searchable.go +++ b/model/searchable.go @@ -1,5 +1,5 @@ package model type SearchableRepository[T any] interface { - Search(q string, offset, size int, includeMissing bool) (T, error) + Search(q string, options ...QueryOptions) (T, error) } diff --git a/model/share.go b/model/share.go index 0f52f5323..ce0846d60 100644 --- a/model/share.go +++ b/model/share.go @@ -2,7 +2,6 @@ package model import ( "cmp" - "fmt" "strings" "time" @@ -23,8 +22,8 @@ type Share struct { Format string `structs:"format" json:"format,omitempty"` MaxBitRate int `structs:"max_bit_rate" json:"maxBitRate,omitempty"` VisitCount int `structs:"visit_count" json:"visitCount,omitempty"` - CreatedAt time.Time `structs:"created_at" json:"createdAt,omitempty"` - UpdatedAt time.Time `structs:"updated_at" json:"updatedAt,omitempty"` + CreatedAt time.Time `structs:"created_at" json:"createdAt"` + UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` Tracks MediaFiles `structs:"-" json:"tracks,omitempty"` Albums Albums `structs:"-" json:"albums,omitempty"` URL string `structs:"-" json:"-"` @@ -50,17 +49,9 @@ func (s Share) CoverArtID() ArtworkID { type Shares []Share -// ToM3U8 exports the playlist to the Extended M3U8 format, as specified in -// https://docs.fileformat.com/audio/m3u/#extended-m3u +// ToM3U8 exports the share to the Extended M3U8 format. func (s Share) ToM3U8() string { - buf := strings.Builder{} - buf.WriteString("#EXTM3U\n") - buf.WriteString(fmt.Sprintf("#PLAYLIST:%s\n", cmp.Or(s.Description, s.ID))) - for _, t := range s.Tracks { - buf.WriteString(fmt.Sprintf("#EXTINF:%.f,%s - %s\n", t.Duration, t.Artist, t.Title)) - buf.WriteString(t.Path + "\n") - } - return buf.String() + return s.Tracks.ToM3U8(cmp.Or(s.Description, s.ID), false) } type ShareRepository interface { diff --git a/model/tag.go b/model/tag.go index a1f4e28da..1f6b24d21 100644 --- a/model/tag.go +++ b/model/tag.go @@ -12,11 +12,11 @@ import ( ) type Tag struct { - ID string `json:"id,omitempty"` - TagName TagName `json:"tagName,omitempty"` - TagValue string `json:"tagValue,omitempty"` - AlbumCount int `json:"albumCount,omitempty"` - MediaFileCount int `json:"songCount,omitempty"` + ID string `json:"id,omitempty"` + TagName TagName `json:"tagName,omitempty"` + TagValue string `json:"tagValue,omitempty"` + AlbumCount int `json:"albumCount,omitempty"` + SongCount int `json:"songCount,omitempty"` } type TagList []Tag @@ -144,16 +144,14 @@ func (t Tags) Merge(tags Tags) { } func (t Tags) Add(name TagName, v string) { - for _, existing := range t[name] { - if existing == v { - return - } + if slices.Contains(t[name], v) { + return } t[name] = append(t[name], v) } type TagRepository interface { - Add(...Tag) error + Add(libraryID int, tags ...Tag) error UpdateCounts() error } diff --git a/model/tag_mappings.go b/model/tag_mappings.go index d54f51f43..dd19a157b 100644 --- a/model/tag_mappings.go +++ b/model/tag_mappings.go @@ -34,23 +34,25 @@ type TagConf struct { SplitRx *regexp.Regexp `yaml:"-"` } -// SplitTagValue splits a tag value by the split separators, but only if it has a single value. +// SplitTagValue splits tag values by the configured split separators. +// Each value in the input slice is individually split and trimmed. func (c TagConf) SplitTagValue(values []string) []string { - // If there's not exactly one value or no separators, return early. - if len(values) != 1 || c.SplitRx == nil { + if c.SplitRx == nil || len(values) == 0 { return values } - tag := values[0] - // Replace all occurrences of any separator with the zero-width space. - tag = c.SplitRx.ReplaceAllString(tag, consts.Zwsp) + var result []string + for _, tag := range values { + // Replace all occurrences of any separator with the zero-width space. + tag = c.SplitRx.ReplaceAllString(tag, consts.Zwsp) - // Split by the zero-width space and trim each substring. - parts := strings.Split(tag, consts.Zwsp) - for i, part := range parts { - parts[i] = strings.TrimSpace(part) + // Split by the zero-width space and trim each substring. + parts := strings.SplitSeq(tag, consts.Zwsp) + for part := range parts { + result = append(result, strings.TrimSpace(part)) + } } - return parts + return result } type TagType string @@ -139,7 +141,9 @@ func compileSplitRegex(tagName TagName, split []string) *regexp.Regexp { } // If no valid separators remain, return the original value. if len(escaped) == 0 { - log.Warn("No valid separators found in split list", "split", split, "tag", tagName) + if len(split) > 0 { + log.Warn("No valid separators found in split list", "split", split, "tag", tagName) + } return nil } @@ -147,7 +151,7 @@ func compileSplitRegex(tagName TagName, split []string) *regexp.Regexp { pattern := "(?i)(" + strings.Join(escaped, "|") + ")" re, err := regexp.Compile(pattern) if err != nil { - log.Error("Error compiling regexp", "pattern", pattern, "tag", tagName, "err", err) + log.Warn("Error compiling regexp for split list", "pattern", pattern, "tag", tagName, "split", split, err) return nil } return re diff --git a/model/tag_mappings_test.go b/model/tag_mappings_test.go new file mode 100644 index 000000000..1665d557b --- /dev/null +++ b/model/tag_mappings_test.go @@ -0,0 +1,64 @@ +package model + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("TagConf", func() { + Describe("SplitTagValue", func() { + var conf TagConf + + BeforeEach(func() { + conf = TagConf{Split: []string{";", "/", ","}} + conf.SplitRx = compileSplitRegex("test", conf.Split) + }) + + It("splits a single value on configured separators", func() { + Expect(conf.SplitTagValue([]string{"Rock/Pop;Punk"})).To(Equal([]string{"Rock", "Pop", "Punk"})) + }) + + It("trims whitespace around split values", func() { + Expect(conf.SplitTagValue([]string{"Love, Emotional, Ballad"})).To(Equal([]string{"Love", "Emotional", "Ballad"})) + }) + + // Regression test for https://github.com/navidrome/navidrome/issues/5065 + // + // When multiple ID3v2 frames map to the same logical tag (e.g. TMOO + TXXX:MOOD), + // TagLib's PropertyMap merges them into a slice with several entries. Previously + // SplitTagValue had a `len(values) != 1` guard that skipped splitting in this case. + It("splits each value individually when given multiple inputs", func() { + input := []string{"Love, Emotional, Ballad", "Love; Emotional; Ballad"} + Expect(conf.SplitTagValue(input)).To(Equal([]string{ + "Love", "Emotional", "Ballad", + "Love", "Emotional", "Ballad", + })) + }) + + It("matches separators case-insensitively when the split pattern allows", func() { + c := TagConf{Split: []string{" AND "}} + c.SplitRx = compileSplitRegex("test", c.Split) + Expect(c.SplitTagValue([]string{"foo and bar AND baz"})).To(Equal([]string{"foo", "bar", "baz"})) + }) + + It("returns values unchanged when no separators are configured", func() { + c := TagConf{} + Expect(c.SplitTagValue([]string{"Foo, Bar"})).To(Equal([]string{"Foo, Bar"})) + Expect(c.SplitTagValue([]string{"a", "b"})).To(Equal([]string{"a", "b"})) + }) + + It("returns an empty slice for empty input", func() { + Expect(conf.SplitTagValue([]string{})).To(BeEmpty()) + }) + + It("handles a value with no separator as a single-element result", func() { + Expect(conf.SplitTagValue([]string{"JustOneMood"})).To(Equal([]string{"JustOneMood"})) + }) + + It("produces empty strings when separators are adjacent (dedup happens downstream)", func() { + // SplitTagValue itself does not filter empties; that is the job of + // filterDuplicatedOrEmptyValues in the metadata pipeline. + Expect(conf.SplitTagValue([]string{"Rock//Pop"})).To(Equal([]string{"Rock", "", "Pop"})) + }) + }) +}) diff --git a/model/user.go b/model/user.go index 7c41ac041..1c8541ccf 100644 --- a/model/user.go +++ b/model/user.go @@ -1,6 +1,8 @@ package model -import "time" +import ( + "time" +) type User struct { ID string `structs:"id" json:"id"` @@ -13,20 +15,38 @@ type User struct { CreatedAt time.Time `structs:"created_at" json:"createdAt"` UpdatedAt time.Time `structs:"updated_at" json:"updatedAt"` + // Library associations (many-to-many relationship) + Libraries Libraries `structs:"-" json:"libraries,omitempty"` + // This is only available on the backend, and it is never sent over the wire Password string `structs:"-" json:"-"` // This is used to set or change a password when calling Put. If it is empty, the password is not changed. // It is received from the UI with the name "password" - NewPassword string `structs:"password,omitempty" json:"password,omitempty"` + NewPassword string `structs:"password,omitempty" json:"password,omitempty"` //nolint:gosec // If changing the password, this is also required CurrentPassword string `structs:"current_password,omitempty" json:"currentPassword,omitempty"` } +func (u User) HasLibraryAccess(libraryID int) bool { + if u.IsAdmin { + return true // Admin users have access to all libraries + } + for _, lib := range u.Libraries { + if lib.ID == libraryID { + return true + } + } + return false +} + type Users []User type UserRepository interface { + ResourceRepository CountAll(...QueryOptions) (int64, error) + Delete(id string) error Get(id string) (*User, error) + GetAll(options ...QueryOptions) (Users, error) Put(*User) error UpdateLastLoginAt(id string) error UpdateLastAccessAt(id string) error @@ -35,4 +55,8 @@ type UserRepository interface { FindByUsername(username string) (*User, error) // FindByUsernameWithPassword is the same as above, but also returns the decrypted password FindByUsernameWithPassword(username string) (*User, error) + + // Library association methods + GetUserLibraries(userID string) (Libraries, error) + SetUserLibraries(userID string, libraryIDs []int) error } diff --git a/model/user_test.go b/model/user_test.go new file mode 100644 index 000000000..ab66a29a9 --- /dev/null +++ b/model/user_test.go @@ -0,0 +1,83 @@ +package model_test + +import ( + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("User", func() { + var user model.User + var libraries model.Libraries + + BeforeEach(func() { + libraries = model.Libraries{ + {ID: 1, Name: "Rock Library", Path: "/music/rock"}, + {ID: 2, Name: "Jazz Library", Path: "/music/jazz"}, + {ID: 3, Name: "Classical Library", Path: "/music/classical"}, + } + + user = model.User{ + ID: "user1", + UserName: "testuser", + Name: "Test User", + Email: "test@example.com", + IsAdmin: false, + Libraries: libraries, + } + }) + + Describe("HasLibraryAccess", func() { + Context("when user is admin", func() { + BeforeEach(func() { + user.IsAdmin = true + }) + + It("returns true for any library ID", func() { + Expect(user.HasLibraryAccess(1)).To(BeTrue()) + Expect(user.HasLibraryAccess(99)).To(BeTrue()) + Expect(user.HasLibraryAccess(-1)).To(BeTrue()) + }) + + It("returns true even when user has no libraries assigned", func() { + user.Libraries = nil + Expect(user.HasLibraryAccess(1)).To(BeTrue()) + }) + }) + + Context("when user is not admin", func() { + BeforeEach(func() { + user.IsAdmin = false + }) + + It("returns true for libraries the user has access to", func() { + Expect(user.HasLibraryAccess(1)).To(BeTrue()) + Expect(user.HasLibraryAccess(2)).To(BeTrue()) + Expect(user.HasLibraryAccess(3)).To(BeTrue()) + }) + + It("returns false for libraries the user does not have access to", func() { + Expect(user.HasLibraryAccess(4)).To(BeFalse()) + Expect(user.HasLibraryAccess(99)).To(BeFalse()) + Expect(user.HasLibraryAccess(-1)).To(BeFalse()) + Expect(user.HasLibraryAccess(0)).To(BeFalse()) + }) + + It("returns false when user has no libraries assigned", func() { + user.Libraries = nil + Expect(user.HasLibraryAccess(1)).To(BeFalse()) + }) + + It("handles duplicate library IDs correctly", func() { + user.Libraries = model.Libraries{ + {ID: 1, Name: "Library 1", Path: "/music1"}, + {ID: 1, Name: "Library 1 Duplicate", Path: "/music1-dup"}, + {ID: 2, Name: "Library 2", Path: "/music2"}, + } + Expect(user.HasLibraryAccess(1)).To(BeTrue()) + Expect(user.HasLibraryAccess(2)).To(BeTrue()) + Expect(user.HasLibraryAccess(3)).To(BeFalse()) + }) + }) + }) +}) diff --git a/persistence/album_repository.go b/persistence/album_repository.go index 3f238ee23..99ed10877 100644 --- a/persistence/album_repository.go +++ b/persistence/album_repository.go @@ -4,6 +4,7 @@ import ( "context" "encoding/json" "fmt" + "iter" "maps" "slices" "strings" @@ -61,11 +62,14 @@ func (a *dbAlbum) PostScan() error { func (a *dbAlbum) PostMapArgs(args map[string]any) error { fullText := []string{a.Name, a.SortAlbumName, a.AlbumArtist} - fullText = append(fullText, a.Album.Participants.AllNames()...) + participantNames := a.Album.Participants.AllNames() + fullText = append(fullText, participantNames...) fullText = append(fullText, slices.Collect(maps.Values(a.Album.Discs))...) fullText = append(fullText, a.Album.Tags[model.TagAlbumVersion]...) fullText = append(fullText, a.Album.Tags[model.TagCatalogNumber]...) args["full_text"] = formatFullText(fullText...) + args["search_participants"] = strings.Join(participantNames, " ") + args["search_normalized"] = normalizeForFTS(a.Name, a.AlbumArtist) args["tags"] = marshalTags(a.Album.Tags) args["participants"] = marshalParticipants(a.Album.Participants) @@ -105,6 +109,7 @@ func NewAlbumRepository(ctx context.Context, db dbx.Builder) model.AlbumReposito "random": "random", "recently_added": recentlyAddedSort(), "starred_at": "starred, starred_at", + "rated_at": "rating, rated_at", }) return r } @@ -112,16 +117,17 @@ func NewAlbumRepository(ctx context.Context, db dbx.Builder) model.AlbumReposito var albumFilters = sync.OnceValue(func() map[string]filterFunc { filters := map[string]filterFunc{ "id": idFilter("album"), - "name": fullTextFilter("album"), + "name": fullTextFilter("album", "mbz_album_id", "mbz_release_group_id"), "compilation": booleanFilter, "artist_id": artistFilter, "year": yearFilter, "recently_played": recentlyPlayedFilter, - "starred": booleanFilter, - "has_rating": hasRatingFilter, + "starred": annotationBoolFilter("starred"), + "has_rating": annotationBoolFilter("rating"), "missing": booleanFilter, "genre_id": tagIDFilter, "role_total_id": allRolesFilter, + "library_id": libraryIdFilter, } // Add all album tags as filters for tag := range model.AlbumLevelTags() { @@ -137,20 +143,16 @@ var albumFilters = sync.OnceValue(func() map[string]filterFunc { func recentlyAddedSort() string { if conf.Server.RecentlyAddedByModTime { - return "updated_at" + return "datetime(album.updated_at)" } - return "created_at" + return "datetime(album.created_at)" } -func recentlyPlayedFilter(string, interface{}) Sqlizer { +func recentlyPlayedFilter(string, any) Sqlizer { return Gt{"play_count": 0} } -func hasRatingFilter(string, interface{}) Sqlizer { - return Gt{"rating": 0} -} - -func yearFilter(_ string, value interface{}) Sqlizer { +func yearFilter(_ string, value any) Sqlizer { return Or{ And{ Gt{"min_year": 0}, @@ -161,14 +163,14 @@ func yearFilter(_ string, value interface{}) Sqlizer { } } -func artistFilter(_ string, value interface{}) Sqlizer { +func artistFilter(_ string, value any) Sqlizer { return Or{ Exists("json_tree(participants, '$.albumartist')", Eq{"value": value}), Exists("json_tree(participants, '$.artist')", Eq{"value": value}), } } -func artistRoleFilter(name string, value interface{}) Sqlizer { +func artistRoleFilter(name string, value any) Sqlizer { roleName := strings.TrimSuffix(strings.TrimPrefix(name, "role_"), "_id") // Check if the role name is valid. If not, return an invalid filter @@ -178,14 +180,15 @@ func artistRoleFilter(name string, value interface{}) Sqlizer { return Exists(fmt.Sprintf("json_tree(participants, '$.%s')", roleName), Eq{"value": value}) } -func allRolesFilter(_ string, value interface{}) Sqlizer { +func allRolesFilter(_ string, value any) Sqlizer { return Like{"participants": fmt.Sprintf(`%%"%s"%%`, value)} } func (r *albumRepository) CountAll(options ...model.QueryOptions) (int64, error) { - sql := r.newSelect() - sql = r.withAnnotation(sql, "album.id") - return r.count(sql, options...) + query := r.newSelect() + query = r.withAnnotation(query, "album.id") + query = r.applyLibraryFilter(query) + return r.count(query, options...) } func (r *albumRepository) Exists(id string) (bool, error) { @@ -200,12 +203,11 @@ func (r *albumRepository) Put(al *model.Album) error { } al.ID = id if len(al.Participants) > 0 { - err = r.updateParticipants(al.ID, al.Participants) - if err != nil { + if err = r.updateParticipants(al.ID, al.Participants); err != nil { return err } } - return err + return nil } // TODO Move external metadata to a separated table @@ -215,8 +217,10 @@ func (r *albumRepository) UpdateExternalInfo(al *model.Album) error { } func (r *albumRepository) selectAlbum(options ...model.QueryOptions) SelectBuilder { - sql := r.newSelect(options...).Columns("album.*") - return r.withAnnotation(sql, "album.id") + sql := r.newSelect(options...).Columns("album.*", "library.path as library_path", "library.name as library_name"). + LeftJoin("library on album.library_id = library.id") + sql = r.withAnnotation(sql, "album.id") + return r.applyLibraryFilter(sql) } func (r *albumRepository) Get(id string) (*model.Album, error) { @@ -237,7 +241,7 @@ func (r *albumRepository) GetAll(options ...model.QueryOptions) (model.Albums, e if err != nil { return nil, err } - return res.toModels(), err + return res.toModels(), nil } func (r *albumRepository) CopyAttributes(fromID, toID string, columns ...string) error { @@ -246,9 +250,19 @@ func (r *albumRepository) CopyAttributes(fromID, toID string, columns ...string) if err != nil { return fmt.Errorf("getting album to copy fields from: %w", err) } - to := make(map[string]interface{}) + to := make(map[string]any) for _, col := range columns { - to[col] = from[col] + v := from[col] + // created_at is aggregated from song birth_times and must never be + // overwritten with a zero/poisoned value, or it propagates forward on + // every metadata-driven album ID change. + if col == "created_at" && (!v.Valid || v.String == "" || strings.HasPrefix(v.String, "0001-")) { + continue + } + to[col] = v + } + if len(to) == 0 { + return nil } _, err = r.executeSQL(Update(r.tableName).SetMap(to).Where(Eq{"id": toID})) return err @@ -290,7 +304,6 @@ func (r *albumRepository) TouchByMissingFolder() (int64, error) { // It does not need to load participants, as they are not used by the scanner. func (r *albumRepository) GetTouchedAlbums(libID int) (model.AlbumCursor, error) { query := r.selectAlbum(). - Join("library on library.id = album.library_id"). Where(And{ Eq{"library.id": libID}, ConcatExpr("album.imported_at > library.last_scan_at"), @@ -299,17 +312,21 @@ func (r *albumRepository) GetTouchedAlbums(libID int) (model.AlbumCursor, error) if err != nil { return nil, err } + return wrapAlbumCursor(cursor), nil +} + +func wrapAlbumCursor(cursor iter.Seq2[dbAlbum, error]) model.AlbumCursor { return func(yield func(model.Album, error) bool) { for a, err := range cursor { if a.Album == nil { - yield(model.Album{}, fmt.Errorf("unexpected nil album: %v", a)) + yield(model.Album{}, fmt.Errorf("unexpected nil album (%v): %w", a, err)) return } if !yield(*a.Album, err) || err != nil { return } } - }, nil + } } // RefreshPlayCounts updates the play count and last play date annotations for all albums, based @@ -333,8 +350,12 @@ on conflict (user_id, item_id, item_type) do update return r.executeSQL(query) } -func (r *albumRepository) purgeEmpty() error { +func (r *albumRepository) purgeEmpty(libraryIDs ...int) error { del := Delete(r.tableName).Where("id not in (select distinct(album_id) from media_file)") + // If libraryIDs are specified, only purge albums from those libraries + if len(libraryIDs) > 0 { + del = del.Where(Eq{"library_id": libraryIDs}) + } c, err := r.executeSQL(del) if err != nil { return fmt.Errorf("purging empty albums: %w", err) @@ -345,24 +366,34 @@ func (r *albumRepository) purgeEmpty() error { return nil } -func (r *albumRepository) Search(q string, offset int, size int, includeMissing bool) (model.Albums, error) { - var res dbAlbums - err := r.doSearch(r.selectAlbum(), q, offset, size, includeMissing, &res, "name") - if err != nil { - return nil, err +var albumSearchConfig = searchConfig{ + NaturalOrder: "album.rowid", + OrderBy: []string{"name"}, + MBIDFields: []string{"mbz_album_id", "mbz_release_group_id"}, +} + +func (r *albumRepository) Search(q string, options ...model.QueryOptions) (model.Albums, error) { + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] } - return res.toModels(), err + var res dbAlbums + err := r.doSearch(r.selectAlbum(options...), q, &res, albumSearchConfig, opts) + if err != nil { + return nil, fmt.Errorf("searching album %q: %w", q, err) + } + return res.toModels(), nil } func (r *albumRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *albumRepository) Read(id string) (interface{}, error) { +func (r *albumRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *albumRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *albumRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -370,7 +401,7 @@ func (r *albumRepository) EntityName() string { return "album" } -func (r *albumRepository) NewInstance() interface{} { +func (r *albumRepository) NewInstance() any { return &model.Album{} } diff --git a/persistence/album_repository_test.go b/persistence/album_repository_test.go index 529458c26..a6270933f 100644 --- a/persistence/album_repository_test.go +++ b/persistence/album_repository_test.go @@ -1,13 +1,14 @@ package persistence import ( - "context" + "errors" "fmt" "time" + "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/model/request" @@ -16,16 +17,16 @@ import ( ) var _ = Describe("AlbumRepository", func() { - var repo model.AlbumRepository + var albumRepo *albumRepository BeforeEach(func() { - ctx := request.WithUser(log.NewContext(context.TODO()), model.User{ID: "userid", UserName: "johndoe"}) - repo = NewAlbumRepository(ctx, GetDBXBuilder()) + ctx := request.WithUser(GinkgoT().Context(), model.User{ID: "userid", UserName: "johndoe"}) + albumRepo = NewAlbumRepository(ctx, GetDBXBuilder()).(*albumRepository) }) Describe("Get", func() { var Get = func(id string) (*model.Album, error) { - album, err := repo.Get(id) + album, err := albumRepo.Get(id) if album != nil { album.ImportedAt = time.Time{} } @@ -40,9 +41,35 @@ var _ = Describe("AlbumRepository", func() { }) }) + Describe("CopyAttributes", func() { + var srcTime, dstTime time.Time + BeforeEach(func() { + srcTime = time.Date(2020, 1, 2, 3, 4, 5, 0, time.UTC) + dstTime = time.Date(2024, 6, 7, 8, 9, 10, 0, time.UTC) + Expect(albumRepo.Put(&model.Album{ID: "copy-src", Name: "src", LibraryID: 1, CreatedAt: srcTime})).To(Succeed()) + Expect(albumRepo.Put(&model.Album{ID: "copy-dst", Name: "dst", LibraryID: 1, CreatedAt: dstTime})).To(Succeed()) + Expect(albumRepo.Put(&model.Album{ID: "copy-zero", Name: "zero", LibraryID: 1})).To(Succeed()) + DeferCleanup(func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": []string{"copy-src", "copy-dst", "copy-zero"}})) + }) + }) + It("copies a valid created_at from source to destination", func() { + Expect(albumRepo.CopyAttributes("copy-src", "copy-dst", "created_at")).To(Succeed()) + got, err := albumRepo.Get("copy-dst") + Expect(err).ToNot(HaveOccurred()) + Expect(got.CreatedAt).To(BeTemporally("~", srcTime, time.Second)) + }) + It("leaves destination untouched when source created_at is zero", func() { + Expect(albumRepo.CopyAttributes("copy-zero", "copy-dst", "created_at")).To(Succeed()) + got, err := albumRepo.Get("copy-dst") + Expect(err).ToNot(HaveOccurred()) + Expect(got.CreatedAt).To(BeTemporally("~", dstTime, time.Second)) + }) + }) + Describe("GetAll", func() { var GetAll = func(opts ...model.QueryOptions) (model.Albums, error) { - albums, err := repo.GetAll(opts...) + albums, err := albumRepo.GetAll(opts...) for i := range albums { albums[i].ImportedAt = time.Time{} } @@ -56,15 +83,23 @@ var _ = Describe("AlbumRepository", func() { It("returns all records sorted", func() { Expect(GetAll(model.QueryOptions{Sort: "name"})).To(Equal(model.Albums{ albumAbbeyRoad, + albumWithVersion, + albumCJK, + albumMultiDisc, albumRadioactivity, albumSgtPeppers, + albumPunctuation, })) }) It("returns all records sorted desc", func() { Expect(GetAll(model.QueryOptions{Sort: "name", Order: "desc"})).To(Equal(model.Albums{ + albumPunctuation, albumSgtPeppers, albumRadioactivity, + albumMultiDisc, + albumCJK, + albumWithVersion, albumAbbeyRoad, })) }) @@ -76,6 +111,129 @@ var _ = Describe("AlbumRepository", func() { }) }) + Describe("recently_added sort", func() { + It("sorts correctly regardless of timestamp format (T-format vs space-format)", func() { + // Both timestamps share the same date prefix "2024-01-15" so the T vs space + // character at position 10 determines sort order in raw string comparison. + // Without normalization, 'T' (ASCII 84) > ' ' (ASCII 32) makes the older + // T-format timestamp sort AFTER the newer space-format one. + + // Older album: morning of Jan 15, stored in T-format + olderAlbum := &model.Album{LibraryID: 1, ID: "ts-older", Name: "Older Album"} + Expect(albumRepo.Put(olderAlbum)).To(Succeed()) + _, err := albumRepo.executeSQL(squirrel.Update("album"). + Set("created_at", "2024-01-15T08:00:00Z"). + Where(squirrel.Eq{"id": "ts-older"})) + Expect(err).ToNot(HaveOccurred()) + + // Newer album: evening of Jan 15, stored in space-format + newerAlbum := &model.Album{LibraryID: 1, ID: "ts-newer", Name: "Newer Album"} + Expect(albumRepo.Put(newerAlbum)).To(Succeed()) + _, err = albumRepo.executeSQL(squirrel.Update("album"). + Set("created_at", "2024-01-15 20:00:00+00:00"). + Where(squirrel.Eq{"id": "ts-newer"})) + Expect(err).ToNot(HaveOccurred()) + + albums, err := albumRepo.GetAll(model.QueryOptions{Sort: "recently_added", Order: "desc"}) + Expect(err).ToNot(HaveOccurred()) + + // Find positions of our test albums + olderIdx, newerIdx := -1, -1 + for i, a := range albums { + switch a.ID { + case "ts-older": + olderIdx = i + case "ts-newer": + newerIdx = i + } + } + Expect(olderIdx).To(BeNumerically(">=", 0), "older album not found in results") + Expect(newerIdx).To(BeNumerically(">=", 0), "newer album not found in results") + // Newer album (evening, space-format) should come before older album (morning, T-format) in desc order + Expect(newerIdx).To(BeNumerically("<", olderIdx), + "Newer album (20:00 space-format) should sort before older album (08:00 T-format) in desc order") + + // Clean up + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": []string{"ts-older", "ts-newer"}})) + }) + }) + + Context("Filters", func() { + var albumWithoutAnnotation model.Album + + BeforeEach(func() { + // Create album without any annotation (no star, no rating) + albumWithoutAnnotation = model.Album{ID: "no-annotation-album", Name: "No Annotation", LibraryID: 1} + Expect(albumRepo.Put(&albumWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": albumWithoutAnnotation.ID})) + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + + Describe("has_rating", func() { + It("false includes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"has_rating": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album without annotation should be included in has_rating=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"has_rating": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + }) + Describe("Album.PlayCount", func() { // Implementation is in withAnnotation() method DescribeTable("normalizes play count when AlbumPlayCountMode is absolute", @@ -83,12 +241,12 @@ var _ = Describe("AlbumRepository", func() { conf.Server.AlbumPlayCountMode = consts.AlbumPlayCountModeAbsolute newID := id.NewRandom() - Expect(repo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "name", SongCount: songCount})).To(Succeed()) - for i := 0; i < playCount; i++ { - Expect(repo.IncPlayCount(newID, time.Now())).To(Succeed()) + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "name", SongCount: songCount})).To(Succeed()) + for range playCount { + Expect(albumRepo.IncPlayCount(newID, time.Now())).To(Succeed()) } - album, err := repo.Get(newID) + album, err := albumRepo.Get(newID) Expect(err).ToNot(HaveOccurred()) Expect(album.PlayCount).To(Equal(int64(expected))) }, @@ -106,12 +264,12 @@ var _ = Describe("AlbumRepository", func() { conf.Server.AlbumPlayCountMode = consts.AlbumPlayCountModeNormalized newID := id.NewRandom() - Expect(repo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "name", SongCount: songCount})).To(Succeed()) - for i := 0; i < playCount; i++ { - Expect(repo.IncPlayCount(newID, time.Now())).To(Succeed()) + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "name", SongCount: songCount})).To(Succeed()) + for range playCount { + Expect(albumRepo.IncPlayCount(newID, time.Now())).To(Succeed()) } - album, err := repo.Get(newID) + album, err := albumRepo.Get(newID) Expect(err).ToNot(HaveOccurred()) Expect(album.PlayCount).To(Equal(int64(expected))) }, @@ -125,6 +283,89 @@ var _ = Describe("AlbumRepository", func() { ) }) + Describe("Album.AverageRating", func() { + It("returns 0 when no ratings exist", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "no ratings album"})).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(0.0)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("returns the user's rating as average when only one user rated", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "single rating album"})).To(Succeed()) + Expect(albumRepo.SetRating(4, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(4.0)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("calculates average across multiple users", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "multi rating album"})).To(Succeed()) + + Expect(albumRepo.SetRating(4, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewAlbumRepository(user2Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user2Repo.SetRating(5, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(4.5)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("excludes zero ratings from average calculation", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "zero rating excluded album"})).To(Succeed()) + Expect(albumRepo.SetRating(3, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewAlbumRepository(user2Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user2Repo.SetRating(0, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(3.0)) + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + + It("rounds to 2 decimal places", func() { + newID := id.NewRandom() + Expect(albumRepo.Put(&model.Album{LibraryID: 1, ID: newID, Name: "rounding test album"})).To(Succeed()) + + Expect(albumRepo.SetRating(5, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewAlbumRepository(user2Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user2Repo.SetRating(4, newID)).To(Succeed()) + + user3Ctx := request.WithUser(GinkgoT().Context(), thirdUser) + user3Repo := NewAlbumRepository(user3Ctx, GetDBXBuilder()).(*albumRepository) + Expect(user3Repo.SetRating(4, newID)).To(Succeed()) + + album, err := albumRepo.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(album.AverageRating).To(Equal(4.33)) // (5 + 4 + 4) / 3 = 4.333... + + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": newID})) + }) + }) + Describe("dbAlbum mapping", func() { var ( a model.Album @@ -245,7 +486,7 @@ var _ = Describe("AlbumRepository", func() { sql, args, err := sqlizer.ToSql() Expect(err).ToNot(HaveOccurred()) Expect(sql).To(Equal(expectedSQL)) - Expect(args).To(Equal([]interface{}{artistID})) + Expect(args).To(Equal([]any{artistID})) }, Entry("artist role", "role_artist_id", "123", "exists (select 1 from json_tree(participants, '$.artist') where value = ?)"), @@ -267,7 +508,7 @@ var _ = Describe("AlbumRepository", func() { sql, args, err := sqlizer.ToSql() Expect(err).ToNot(HaveOccurred()) Expect(sql).To(Equal(fmt.Sprintf("exists (select 1 from json_tree(participants, '$.%s') where value = ?)", roleName))) - Expect(args).To(Equal([]interface{}{"test-id"})) + Expect(args).To(Equal([]any{"test-id"})) } }) @@ -283,6 +524,339 @@ var _ = Describe("AlbumRepository", func() { Expect(err).To(HaveOccurred()) }) }) + + Describe("Participant Foreign Key Handling", func() { + // albumArtistRecord represents a record in the album_artists table + type albumArtistRecord struct { + ArtistID string `db:"artist_id"` + Role string `db:"role"` + SubRole string `db:"sub_role"` + } + + var artistRepo *artistRepository + + BeforeEach(func() { + ctx := request.WithUser(GinkgoT().Context(), adminUser) + artistRepo = NewArtistRepository(ctx, GetDBXBuilder()).(*artistRepository) + }) + + // Helper to verify album_artists records + verifyAlbumArtists := func(albumID string, expected []albumArtistRecord) { + GinkgoHelper() + var actual []albumArtistRecord + sq := squirrel.Select("artist_id", "role", "sub_role"). + From("album_artists"). + Where(squirrel.Eq{"album_id": albumID}). + OrderBy("role", "artist_id", "sub_role") + + err := albumRepo.queryAll(sq, &actual) + Expect(err).ToNot(HaveOccurred()) + Expect(actual).To(Equal(expected)) + } + + It("verifies that participant records are actually inserted into database", func() { + // Create a real artist in the database first + artist := &model.Artist{ + ID: "real-artist-1", + Name: "Real Artist", + OrderArtistName: "real artist", + SortArtistName: "Artist, Real", + } + err := createArtistWithLibrary(artistRepo, artist, 1) + Expect(err).ToNot(HaveOccurred()) + + // Create an album with participants that reference the real artist + album := &model.Album{ + LibraryID: 1, + ID: "test-album-db-insert", + Name: "Test Album DB Insert", + AlbumArtistID: "real-artist-1", + AlbumArtist: "Real Artist", + Participants: model.Participants{ + model.RoleArtist: { + {Artist: model.Artist{ID: "real-artist-1", Name: "Real Artist"}}, + }, + model.RoleComposer: { + {Artist: model.Artist{ID: "real-artist-1", Name: "Real Artist"}, SubRole: "primary"}, + }, + }, + } + + // Insert the album + err = albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify that participant records were actually inserted into album_artists table + expected := []albumArtistRecord{ + {ArtistID: "real-artist-1", Role: "artist", SubRole: ""}, + {ArtistID: "real-artist-1", Role: "composer", SubRole: "primary"}, + } + verifyAlbumArtists(album.ID, expected) + + // Clean up the test artist and album created for this test + _, _ = artistRepo.executeSQL(squirrel.Delete("artist").Where(squirrel.Eq{"id": artist.ID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": album.ID})) + }) + + It("filters out invalid artist IDs leaving only valid participants in database", func() { + // Create two real artists in the database + artist1 := &model.Artist{ + ID: "real-artist-mix-1", + Name: "Real Artist 1", + OrderArtistName: "real artist 1", + } + artist2 := &model.Artist{ + ID: "real-artist-mix-2", + Name: "Real Artist 2", + OrderArtistName: "real artist 2", + } + err := createArtistWithLibrary(artistRepo, artist1, 1) + Expect(err).ToNot(HaveOccurred()) + err = createArtistWithLibrary(artistRepo, artist2, 1) + Expect(err).ToNot(HaveOccurred()) + + // Create an album with mix of valid and invalid artist IDs + album := &model.Album{ + LibraryID: 1, + ID: "test-album-mixed-validity", + Name: "Test Album Mixed Validity", + AlbumArtistID: "real-artist-mix-1", + AlbumArtist: "Real Artist 1", + Participants: model.Participants{ + model.RoleArtist: { + {Artist: model.Artist{ID: "real-artist-mix-1", Name: "Real Artist 1"}}, + {Artist: model.Artist{ID: "non-existent-mix-1", Name: "Non Existent 1"}}, + {Artist: model.Artist{ID: "real-artist-mix-2", Name: "Real Artist 2"}}, + }, + model.RoleComposer: { + {Artist: model.Artist{ID: "non-existent-mix-2", Name: "Non Existent 2"}}, + {Artist: model.Artist{ID: "real-artist-mix-1", Name: "Real Artist 1"}}, + }, + }, + } + + // This should not fail - only valid artists should be inserted + err = albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify that only valid artist IDs were inserted into album_artists table + // Non-existent artists should be filtered out by the INNER JOIN + expected := []albumArtistRecord{ + {ArtistID: "real-artist-mix-1", Role: "artist", SubRole: ""}, + {ArtistID: "real-artist-mix-2", Role: "artist", SubRole: ""}, + {ArtistID: "real-artist-mix-1", Role: "composer", SubRole: ""}, + } + verifyAlbumArtists(album.ID, expected) + + // Clean up the test artists and album created for this test + artistIDs := []string{artist1.ID, artist2.ID} + _, _ = artistRepo.executeSQL(squirrel.Delete("artist").Where(squirrel.Eq{"id": artistIDs})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": album.ID})) + }) + + It("handles complex nested JSON with multiple roles and sub-roles", func() { + // Create 4 artists for this test + artists := []*model.Artist{ + {ID: "complex-artist-1", Name: "Lead Vocalist", OrderArtistName: "lead vocalist"}, + {ID: "complex-artist-2", Name: "Guitarist", OrderArtistName: "guitarist"}, + {ID: "complex-artist-3", Name: "Producer", OrderArtistName: "producer"}, + {ID: "complex-artist-4", Name: "Engineer", OrderArtistName: "engineer"}, + } + + for _, artist := range artists { + err := createArtistWithLibrary(artistRepo, artist, 1) + Expect(err).ToNot(HaveOccurred()) + } + + // Create album with complex participant structure + album := &model.Album{ + LibraryID: 1, + ID: "test-album-complex-json", + Name: "Test Album Complex JSON", + AlbumArtistID: "complex-artist-1", + AlbumArtist: "Lead Vocalist", + Participants: model.Participants{ + model.RoleArtist: { + {Artist: model.Artist{ID: "complex-artist-1", Name: "Lead Vocalist"}}, + {Artist: model.Artist{ID: "complex-artist-2", Name: "Guitarist"}, SubRole: "lead guitar"}, + {Artist: model.Artist{ID: "complex-artist-2", Name: "Guitarist"}, SubRole: "rhythm guitar"}, + }, + model.RoleProducer: { + {Artist: model.Artist{ID: "complex-artist-3", Name: "Producer"}, SubRole: "executive"}, + }, + model.RoleEngineer: { + {Artist: model.Artist{ID: "complex-artist-4", Name: "Engineer"}, SubRole: "mixing"}, + {Artist: model.Artist{ID: "complex-artist-4", Name: "Engineer"}, SubRole: "mastering"}, + }, + }, + } + + err := albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify complex JSON structure was correctly parsed and inserted + expected := []albumArtistRecord{ + {ArtistID: "complex-artist-1", Role: "artist", SubRole: ""}, + {ArtistID: "complex-artist-2", Role: "artist", SubRole: "lead guitar"}, + {ArtistID: "complex-artist-2", Role: "artist", SubRole: "rhythm guitar"}, + {ArtistID: "complex-artist-4", Role: "engineer", SubRole: "mastering"}, + {ArtistID: "complex-artist-4", Role: "engineer", SubRole: "mixing"}, + {ArtistID: "complex-artist-3", Role: "producer", SubRole: "executive"}, + } + verifyAlbumArtists(album.ID, expected) + + // Clean up the test artists and album created for this test + artistIDs := make([]string, len(artists)) + for i, artist := range artists { + artistIDs[i] = artist.ID + } + _, _ = artistRepo.executeSQL(squirrel.Delete("artist").Where(squirrel.Eq{"id": artistIDs})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": album.ID})) + }) + + It("handles albums with non-existent artist IDs without constraint errors", func() { + // Regression test for foreign key constraint error when album participants + // contain artist IDs that don't exist in the artist table + + // Create an album with participants that reference non-existent artist IDs + album := &model.Album{ + LibraryID: 1, + ID: "test-album-fk-constraints", + Name: "Test Album with Invalid Artist References", + AlbumArtistID: "non-existent-artist-1", + AlbumArtist: "Non Existent Album Artist", + Participants: model.Participants{ + model.RoleArtist: { + {Artist: model.Artist{ID: "non-existent-artist-1", Name: "Non Existent Artist 1"}}, + {Artist: model.Artist{ID: "non-existent-artist-2", Name: "Non Existent Artist 2"}}, + }, + model.RoleComposer: { + {Artist: model.Artist{ID: "non-existent-composer-1", Name: "Non Existent Composer 1"}}, + {Artist: model.Artist{ID: "non-existent-composer-2", Name: "Non Existent Composer 2"}}, + }, + model.RoleAlbumArtist: { + {Artist: model.Artist{ID: "non-existent-album-artist-1", Name: "Non Existent Album Artist 1"}}, + }, + }, + } + + // This should not fail with foreign key constraint error + // The updateParticipants method should handle non-existent artist IDs gracefully + err := albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify that no participant records were inserted since all artist IDs were invalid + // The INNER JOIN with the artist table should filter out all non-existent artists + verifyAlbumArtists(album.ID, []albumArtistRecord{}) + + // Clean up the test album created for this test + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": album.ID})) + }) + + It("removes stale role associations when artist role changes", func() { + // Regression test for issue #4242: Composers displayed in albumartist list + // This happens when an artist's role changes (e.g., was both albumartist and composer, + // now only composer) and the old role association isn't properly removed. + + // Create an artist that will have changing roles + artist := &model.Artist{ + ID: "role-change-artist-1", + Name: "Role Change Artist", + OrderArtistName: "role change artist", + } + err := createArtistWithLibrary(artistRepo, artist, 1) + Expect(err).ToNot(HaveOccurred()) + + // Create album with artist as both albumartist and composer + album := &model.Album{ + LibraryID: 1, + ID: "test-album-role-change", + Name: "Test Album Role Change", + AlbumArtistID: "role-change-artist-1", + AlbumArtist: "Role Change Artist", + Participants: model.Participants{ + model.RoleAlbumArtist: { + {Artist: model.Artist{ID: "role-change-artist-1", Name: "Role Change Artist"}}, + }, + model.RoleComposer: { + {Artist: model.Artist{ID: "role-change-artist-1", Name: "Role Change Artist"}}, + }, + }, + } + + err = albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify initial state: artist has both albumartist and composer roles + expected := []albumArtistRecord{ + {ArtistID: "role-change-artist-1", Role: "albumartist", SubRole: ""}, + {ArtistID: "role-change-artist-1", Role: "composer", SubRole: ""}, + } + verifyAlbumArtists(album.ID, expected) + + // Now update album so artist is ONLY a composer (remove albumartist role) + album.Participants = model.Participants{ + model.RoleComposer: { + {Artist: model.Artist{ID: "role-change-artist-1", Name: "Role Change Artist"}}, + }, + } + + err = albumRepo.Put(album) + Expect(err).ToNot(HaveOccurred()) + + // Verify that the albumartist role was removed - only composer should remain + // This is the key test: before the fix, the albumartist role would remain + // causing composers to appear in the albumartist filter + expectedAfter := []albumArtistRecord{ + {ArtistID: "role-change-artist-1", Role: "composer", SubRole: ""}, + } + verifyAlbumArtists(album.ID, expectedAfter) + + // Clean up + _, _ = artistRepo.executeSQL(squirrel.Delete("artist").Where(squirrel.Eq{"id": artist.ID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": album.ID})) + }) + }) + + Describe("wrapAlbumCursor", func() { + It("does not panic when the cursor yields a dbAlbum with nil Album", func() { + // Simulate what queryWithStableResults does on the rows.Err() path: + // it yields a zero-value dbAlbum (where Album is nil) with an error. + dbErr := fmt.Errorf("database is locked") + cursor := func(yield func(dbAlbum, error) bool) { + var empty dbAlbum // Album pointer is nil + yield(empty, dbErr) + } + + // wrapAlbumCursor should handle the nil Album without panicking + wrappedCursor := wrapAlbumCursor(cursor) + var gotErr error + Expect(func() { + for _, err := range wrappedCursor { + gotErr = err + } + }).ToNot(Panic()) + Expect(gotErr).To(HaveOccurred()) + Expect(gotErr.Error()).To(ContainSubstring("unexpected nil album")) + Expect(errors.Is(gotErr, dbErr)).To(BeTrue(), "should wrap the original cursor error") + }) + + It("yields albums from a valid cursor", func() { + album := &model.Album{ID: "a1", Name: "Test"} + cursor := func(yield func(dbAlbum, error) bool) { + yield(dbAlbum{Album: album}, nil) + } + + wrappedCursor := wrapAlbumCursor(cursor) + var albums []model.Album + for a, err := range wrappedCursor { + Expect(err).ToNot(HaveOccurred()) + albums = append(albums, a) + } + Expect(albums).To(HaveLen(1)) + Expect(albums[0].ID).To(Equal("a1")) + }) + }) }) func _p(id, name string, sortName ...string) model.Participant { diff --git a/persistence/artist_repository.go b/persistence/artist_repository.go index eb87ed006..cfdc499e0 100644 --- a/persistence/artist_repository.go +++ b/persistence/artist_repository.go @@ -4,7 +4,9 @@ import ( "cmp" "context" "encoding/json" + "errors" "fmt" + "os" "slices" "strings" "time" @@ -12,10 +14,10 @@ import ( . "github.com/Masterminds/squirrel" "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils" - . "github.com/navidrome/navidrome/utils/gg" "github.com/navidrome/navidrome/utils/slice" "github.com/pocketbase/dbx" ) @@ -26,9 +28,9 @@ type artistRepository struct { } type dbArtist struct { - *model.Artist `structs:",flatten"` - SimilarArtists string `structs:"-" json:"-"` - Stats string `structs:"-" json:"-"` + *model.Artist `structs:",flatten"` + SimilarArtists string `structs:"-" json:"-"` + LibraryStatsJSON string `structs:"-" json:"-"` } type dbSimilarArtist struct { @@ -37,27 +39,45 @@ type dbSimilarArtist struct { } func (a *dbArtist) PostScan() error { - var stats map[string]map[string]int64 - if err := json.Unmarshal([]byte(a.Stats), &stats); err != nil { - return fmt.Errorf("parsing artist stats from db: %w", err) - } a.Artist.Stats = make(map[model.Role]model.ArtistStats) - for key, c := range stats { - if key == "total" { - a.Artist.Size = c["s"] - a.Artist.SongCount = int(c["m"]) - a.Artist.AlbumCount = int(c["a"]) + + if a.LibraryStatsJSON != "" { + var rawLibStats map[string]map[string]map[string]int64 + if err := json.Unmarshal([]byte(a.LibraryStatsJSON), &rawLibStats); err != nil { + return fmt.Errorf("parsing artist stats from db: %w", err) } - role := model.RoleFromString(key) - if role == model.RoleInvalid { - continue - } - a.Artist.Stats[role] = model.ArtistStats{ - SongCount: int(c["m"]), - AlbumCount: int(c["a"]), - Size: c["s"], + + for _, stats := range rawLibStats { + // Sum all libraries roles stats + for key, stat := range stats { + // Aggregate stats into the main Artist.Stats map + artistStats := model.ArtistStats{ + SongCount: int(stat["m"]), + AlbumCount: int(stat["a"]), + Size: stat["s"], + } + + // Store total stats into the main attributes + if key == "total" { + a.Artist.Size += artistStats.Size + a.Artist.SongCount += artistStats.SongCount + a.Artist.AlbumCount += artistStats.AlbumCount + } + + role := model.RoleFromString(key) + if role == model.RoleInvalid { + continue + } + + current := a.Artist.Stats[role] + current.Size += artistStats.Size + current.SongCount += artistStats.SongCount + current.AlbumCount += artistStats.AlbumCount + a.Artist.Stats[role] = current + } } } + a.Artist.SimilarArtists = nil if a.SimilarArtists == "" { return nil @@ -83,6 +103,7 @@ func (a *dbArtist) PostMapArgs(m map[string]any) error { similarArtists, _ := json.Marshal(sa) m["similar_artists"] = string(similarArtists) m["full_text"] = formatFullText(a.Name, a.SortArtistName) + m["search_normalized"] = normalizeForFTS(a.Name) // Do not override the sort_artist_name and mbz_artist_id fields if they are empty // TODO: Better way to handle this? @@ -112,45 +133,92 @@ func NewArtistRepository(ctx context.Context, db dbx.Builder) model.ArtistReposi r.indexGroups = utils.ParseIndexGroups(conf.Server.IndexGroups) r.tableName = "artist" // To be used by the idFilter below r.registerModel(&model.Artist{}, map[string]filterFunc{ - "id": idFilter(r.tableName), - "name": fullTextFilter(r.tableName), - "starred": booleanFilter, - "role": roleFilter, - "missing": booleanFilter, + "id": idFilter(r.tableName), + "name": fullTextFilter(r.tableName, "mbz_artist_id"), + "starred": annotationBoolFilter("starred"), + "has_rating": annotationBoolFilter("rating"), + "role": roleFilter, + "missing": booleanFilter, + "library_id": artistLibraryIdFilter, }) - r.setSortMappings(map[string]string{ + r.setSortMappings(map[string]string{ //nolint:gosec "name": "order_artist_name", "starred_at": "starred, starred_at", + "rated_at": "rating, rated_at", "song_count": "stats->>'total'->>'m'", "album_count": "stats->>'total'->>'a'", "size": "stats->>'total'->>'s'", + + // Stats by credits that are currently available + "maincredit_song_count": "sum(stats->>'maincredit'->>'m')", + "maincredit_album_count": "sum(stats->>'maincredit'->>'a')", + "maincredit_size": "sum(stats->>'maincredit'->>'s')", }) return r } func roleFilter(_ string, role any) Sqlizer { - return NotEq{fmt.Sprintf("stats ->> '$.%v'", role): nil} + if role, ok := role.(string); ok { + if _, ok := model.AllRoles[role]; ok { + return Expr("JSON_EXTRACT(library_artist.stats, '$." + role + ".m') IS NOT NULL") + } + } + return Eq{"1": 2} +} + +// artistLibraryIdFilter filters artists based on library access through the library_artist table +func artistLibraryIdFilter(_ string, value any) Sqlizer { + return Eq{"library_artist.library_id": value} +} + +// applyLibraryFilterToArtistQuery applies library filtering to artist queries through the library_artist junction table +func (r *artistRepository) applyLibraryFilterToArtistQuery(query SelectBuilder) SelectBuilder { + user := loggedUser(r.ctx) + // Join with library_artist first to ensure only artists with content in libraries are included + // Exclude artists with empty stats (no actual content in the library) + query = query.Join("library_artist on library_artist.artist_id = artist.id") + //query = query.Join("library_artist on library_artist.artist_id = artist.id AND library_artist.stats != '{}'") + + // Admin users see all artists from all libraries, no additional filtering needed + if user.ID != invalidUserId && !user.IsAdmin { + // Apply library filtering only for non-admin users by joining with their accessible libraries + query = query.Join("user_library on user_library.library_id = library_artist.library_id AND user_library.user_id = ?", user.ID) + } + + return query } func (r *artistRepository) selectArtist(options ...model.QueryOptions) SelectBuilder { - query := r.newSelect(options...).Columns("artist.*") - query = r.withAnnotation(query, "artist.id") - return query + // Stats Format: {"1": {"albumartist": {"m": 10, "a": 5, "s": 1024}, "artist": {...}}, "2": {...}} + query := r.newSelect(options...).Columns("artist.*", + "JSON_GROUP_OBJECT(library_artist.library_id, JSONB(library_artist.stats)) as library_stats_json") + + query = r.applyLibraryFilterToArtistQuery(query) + query = query.GroupBy("artist.id") + return r.withAnnotation(query, "artist.id") } func (r *artistRepository) CountAll(options ...model.QueryOptions) (int64, error) { query := r.newSelect() + query = r.applyLibraryFilterToArtistQuery(query) query = r.withAnnotation(query, "artist.id") return r.count(query, options...) } +// Exists checks if an artist with the given ID exists in the database and is accessible by the current user. func (r *artistRepository) Exists(id string) (bool, error) { - return r.exists(Eq{"artist.id": id}) + // Create a query using the same library filtering logic as selectArtist() + query := r.newSelect().Columns("count(distinct artist.id) as exist").Where(Eq{"artist.id": id}) + query = r.applyLibraryFilterToArtistQuery(query) + + var res struct{ Exist int64 } + err := r.queryOne(query, &res) + return res.Exist > 0, err } func (r *artistRepository) Put(a *model.Artist, colsToUpdate ...string) error { dba := &dbArtist{Artist: a} - dba.CreatedAt = P(time.Now()) + dba.CreatedAt = new(time.Now()) dba.UpdatedAt = dba.CreatedAt _, err := r.put(dba.ID, dba, colsToUpdate...) return err @@ -202,14 +270,21 @@ func (r *artistRepository) getIndexKey(a model.Artist) string { return "#" } -// TODO Cache the index (recalculate when there are changes to the DB) -func (r *artistRepository) GetIndex(includeMissing bool, roles ...model.Role) (model.ArtistIndexes, error) { +// GetIndex returns a list of artists grouped by the first letter of their name, or by the index group if configured. +// It can filter by roles and libraries, and optionally include artists that are missing (i.e., have no albums). +// TODO Cache the index (recalculate at scan time) +func (r *artistRepository) GetIndex(includeMissing bool, libraryIds []int, roles ...model.Role) (model.ArtistIndexes, error) { + // Validate library IDs. If no library IDs are provided, return an empty index. + if len(libraryIds) == 0 { + return nil, nil + } + options := model.QueryOptions{Sort: "name"} if len(roles) > 0 { roleFilters := slice.Map(roles, func(r model.Role) Sqlizer { - return roleFilter("role", r) + return roleFilter("role", r.String()) }) - options.Filters = And(roleFilters) + options.Filters = Or(roleFilters) } if !includeMissing { if options.Filters == nil { @@ -218,10 +293,19 @@ func (r *artistRepository) GetIndex(includeMissing bool, roles ...model.Role) (m options.Filters = And{options.Filters, Eq{"artist.missing": false}} } } + + libFilter := artistLibraryIdFilter("library_id", libraryIds) + if options.Filters == nil { + options.Filters = libFilter + } else { + options.Filters = And{options.Filters, libFilter} + } + artists, err := r.GetAll(options) if err != nil { return nil, err } + var result model.ArtistIndexes for k, v := range slice.Group(artists, r.getIndexKey) { result = append(result, model.ArtistIndex{ID: k, Artists: v}) @@ -233,7 +317,19 @@ func (r *artistRepository) GetIndex(includeMissing bool, roles ...model.Role) (m } func (r *artistRepository) purgeEmpty() error { - del := Delete(r.tableName).Where("id not in (select artist_id from album_artists)") + orphanFilter := "id not in (select artist_id from album_artists)" + + // Collect uploaded image filenames before deleting + sel := Select("uploaded_image").From(r.tableName). + Where(orphanFilter). + Where("uploaded_image != ''") + var imageFiles []string + if err := r.queryAllSlice(sel, &imageFiles); err != nil && !errors.Is(err, model.ErrNotFound) { + return fmt.Errorf("collecting artist images for cleanup: %w", err) + } + + // Delete orphan artists + del := Delete(r.tableName).Where(orphanFilter) c, err := r.executeSQL(del) if err != nil { return fmt.Errorf("purging empty artists: %w", err) @@ -241,6 +337,19 @@ func (r *artistRepository) purgeEmpty() error { if c > 0 { log.Debug(r.ctx, "Purged empty artists", "totalDeleted", c) } + + if len(imageFiles) == 0 { + return nil + } + + // Best-effort cleanup of uploaded image files + log.Debug(r.ctx, "Cleaning up artist images", "totalImages", len(imageFiles)) + for _, filename := range imageFiles { + path := model.UploadedImagePath(consts.EntityArtist, filename) + if err := os.Remove(path); err != nil && !os.IsNotExist(err) { + log.Warn(r.ctx, "Failed to remove artist image during GC", "path", path, err) + } + } return nil } @@ -287,75 +396,97 @@ on conflict (user_id, item_id, item_type) do update } // RefreshStats updates the stats field for artists whose associated media files were updated after the oldest recorded library scan time. -// It processes artists in batches to handle potentially large updates. -func (r *artistRepository) RefreshStats() (int64, error) { - touchedArtistsQuerySQL := ` - SELECT DISTINCT mfa.artist_id - FROM media_file_artists mfa - JOIN media_file mf ON mfa.media_file_id = mf.id - WHERE mf.updated_at > (SELECT last_scan_at FROM library ORDER BY last_scan_at ASC LIMIT 1) - ` - +// When allArtists is true, it refreshes stats for all artists. It processes artists in batches to handle potentially large updates. +// This method now calculates per-library statistics and stores them in the library_artist junction table. +func (r *artistRepository) RefreshStats(allArtists bool) (int64, error) { var allTouchedArtistIDs []string - if err := r.db.NewQuery(touchedArtistsQuerySQL).Column(&allTouchedArtistIDs); err != nil { - return 0, fmt.Errorf("fetching touched artist IDs: %w", err) + if allArtists { + // Refresh stats for all artists + allArtistsQuerySQL := `SELECT DISTINCT id FROM artist WHERE id <> ''` + if err := r.db.NewQuery(allArtistsQuerySQL).Column(&allTouchedArtistIDs); err != nil { + return 0, fmt.Errorf("fetching all artist IDs: %w", err) + } + log.Debug(r.ctx, "RefreshStats: Refreshing all artists.", "count", len(allTouchedArtistIDs)) + } else { + // Only refresh artists with updated timestamps + touchedArtistsQuerySQL := ` + SELECT DISTINCT id + FROM artist + WHERE updated_at > (SELECT last_scan_at FROM library ORDER BY last_scan_at ASC LIMIT 1) + ` + if err := r.db.NewQuery(touchedArtistsQuerySQL).Column(&allTouchedArtistIDs); err != nil { + return 0, fmt.Errorf("fetching touched artist IDs: %w", err) + } + log.Debug(r.ctx, "RefreshStats: Refreshing touched artists.", "count", len(allTouchedArtistIDs)) } if len(allTouchedArtistIDs) == 0 { log.Debug(r.ctx, "RefreshStats: No artists to update.") return 0, nil } - log.Debug(r.ctx, "RefreshStats: Found artists to update.", "count", len(allTouchedArtistIDs)) // Template for the batch update with placeholder markers that we'll replace + // This now calculates per-library statistics and stores them in library_artist.stats batchUpdateStatsSQL := ` WITH artist_role_counters AS ( - SELECT jt.atom AS artist_id, - substr( - replace(jt.path, '$.', ''), - 1, - CASE WHEN instr(replace(jt.path, '$.', ''), '[') > 0 - THEN instr(replace(jt.path, '$.', ''), '[') - 1 - ELSE length(replace(jt.path, '$.', '')) - END - ) AS role, + SELECT mfa.artist_id, + mf.library_id, + mfa.role, count(DISTINCT mf.album_id) AS album_count, - count(mf.id) AS count, + count(DISTINCT mf.id) AS count, sum(mf.size) AS size - FROM media_file mf - JOIN json_tree(mf.participants) jt ON jt.key = 'id' AND jt.atom IS NOT NULL - WHERE jt.atom IN (ROLE_IDS_PLACEHOLDER) -- Will replace with actual placeholders - GROUP BY jt.atom, role + FROM media_file_artists mfa + JOIN media_file mf ON mfa.media_file_id = mf.id + WHERE mfa.artist_id IN (ROLE_IDS_PLACEHOLDER) -- Will replace with actual placeholders + GROUP BY mfa.artist_id, mf.library_id, mfa.role ), artist_total_counters AS ( SELECT mfa.artist_id, + mf.library_id, 'total' AS role, count(DISTINCT mf.album_id) AS album_count, count(DISTINCT mf.id) AS count, sum(mf.size) AS size FROM media_file_artists mfa JOIN media_file mf ON mfa.media_file_id = mf.id - WHERE mfa.artist_id IN (TOTAL_IDS_PLACEHOLDER) -- Will replace with actual placeholders - GROUP BY mfa.artist_id + WHERE mfa.artist_id IN (ROLE_IDS_PLACEHOLDER) -- Will replace with actual placeholders + GROUP BY mfa.artist_id, mf.library_id + ), + artist_participant_counter AS ( + SELECT mfa.artist_id, + mf.library_id, + 'maincredit' AS role, + count(DISTINCT mf.album_id) AS album_count, + count(DISTINCT mf.id) AS count, + sum(mf.size) AS size + FROM media_file_artists mfa + JOIN media_file mf ON mfa.media_file_id = mf.id + WHERE mfa.artist_id IN (ROLE_IDS_PLACEHOLDER) -- Will replace with actual placeholders + AND mfa.role IN ('albumartist', 'artist') + GROUP BY mfa.artist_id, mf.library_id ), combined_counters AS ( - SELECT artist_id, role, album_count, count, size FROM artist_role_counters - UNION - SELECT artist_id, role, album_count, count, size FROM artist_total_counters + SELECT artist_id, library_id, role, album_count, count, size FROM artist_role_counters + UNION ALL + SELECT artist_id, library_id, role, album_count, count, size FROM artist_total_counters + UNION ALL + SELECT artist_id, library_id, role, album_count, count, size FROM artist_participant_counter ), - artist_counters AS ( - SELECT artist_id AS id, + library_artist_counters AS ( + SELECT artist_id, + library_id, json_group_object( - replace(role, '"', ''), + role, json_object('a', album_count, 'm', count, 's', size) ) AS counters FROM combined_counters - GROUP BY artist_id + GROUP BY artist_id, library_id ) - UPDATE artist - SET stats = coalesce((SELECT counters FROM artist_counters ac WHERE ac.id = artist.id), '{}'), - updated_at = datetime(current_timestamp, 'localtime') - WHERE artist.id IN (UPDATE_IDS_PLACEHOLDER) AND artist.id <> '';` // Will replace with actual placeholders + UPDATE library_artist + SET stats = coalesce((SELECT counters FROM library_artist_counters lac + WHERE lac.artist_id = library_artist.artist_id + AND lac.library_id = library_artist.library_id), '{}') + WHERE library_artist.artist_id IN (ROLE_IDS_PLACEHOLDER);` // Will replace with actual placeholders var totalRowsAffected int64 = 0 const batchSize = 1000 @@ -374,21 +505,16 @@ func (r *artistRepository) RefreshStats() (int64, error) { inClause := strings.Join(placeholders, ",") // Replace the placeholder markers with actual SQL placeholders - batchSQL := strings.Replace(batchUpdateStatsSQL, "ROLE_IDS_PLACEHOLDER", inClause, 1) - batchSQL = strings.Replace(batchSQL, "TOTAL_IDS_PLACEHOLDER", inClause, 1) - batchSQL = strings.Replace(batchSQL, "UPDATE_IDS_PLACEHOLDER", inClause, 1) + batchSQL := strings.Replace(batchUpdateStatsSQL, "ROLE_IDS_PLACEHOLDER", inClause, 4) - // Create a single parameter array with all IDs (repeated 3 times for each IN clause) - // We need to repeat each ID 3 times (once for each IN clause) - var args []interface{} - for _, id := range artistIDBatch { - args = append(args, id) // For ROLE_IDS_PLACEHOLDER - } - for _, id := range artistIDBatch { - args = append(args, id) // For TOTAL_IDS_PLACEHOLDER - } - for _, id := range artistIDBatch { - args = append(args, id) // For UPDATE_IDS_PLACEHOLDER + // Create a single parameter array with all IDs (repeated 4 times for each IN clause) + // We need to repeat each ID 4 times (once for each IN clause) + args := make([]any, 4*len(artistIDBatch)) + for idx, id := range artistIDBatch { + for i := range 4 { + startIdx := i * len(artistIDBatch) + args[startIdx+idx] = id + } } // Now use Expr with the expanded SQL and all parameters @@ -401,37 +527,60 @@ func (r *artistRepository) RefreshStats() (int64, error) { totalRowsAffected += rowsAffected } + // // Remove library_artist entries for artists that no longer have any content in any library + cleanupSQL := Delete("library_artist").Where("stats = '{}'") + cleanupRows, err := r.executeSQL(cleanupSQL) + if err != nil { + log.Warn(r.ctx, "Failed to cleanup empty library_artist entries", "error", err) + } else if cleanupRows > 0 { + log.Debug(r.ctx, "Cleaned up empty library_artist entries", "rowsDeleted", cleanupRows) + } + log.Debug(r.ctx, "RefreshStats: Successfully updated stats.", "totalArtistsProcessed", len(allTouchedArtistIDs), "totalDBRowsAffected", totalRowsAffected) return totalRowsAffected, nil } -func (r *artistRepository) Search(q string, offset int, size int, includeMissing bool) (model.Artists, error) { - var dba dbArtists - err := r.doSearch(r.selectArtist(), q, offset, size, includeMissing, &dba, "json_extract(stats, '$.total.m') desc", "name") - if err != nil { - return nil, err +func (r *artistRepository) searchCfg() searchConfig { + return searchConfig{ + // Natural order for artists is more performant by ID, due to GROUP BY clause in selectArtist + NaturalOrder: "artist.id", + OrderBy: []string{"sum(json_extract(stats, '$.total.m')) desc", "name"}, + MBIDFields: []string{"mbz_artist_id"}, + LibraryFilter: r.applyLibraryFilterToArtistQuery, } - return dba.toModels(), nil +} + +func (r *artistRepository) Search(q string, options ...model.QueryOptions) (model.Artists, error) { + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } + var res dbArtists + err := r.doSearch(r.selectArtist(options...), q, &res, r.searchCfg(), opts) + if err != nil { + return nil, fmt.Errorf("searching artist %q: %w", q, err) + } + return res.toModels(), nil } func (r *artistRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *artistRepository) Read(id string) (interface{}, error) { +func (r *artistRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *artistRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *artistRepository) ReadAll(options ...rest.QueryOptions) (any, error) { role := "total" if len(options) > 0 { if v, ok := options[0].Filters["role"].(string); ok { role = v } } - r.sortMappings["song_count"] = "stats->>'" + role + "'->>'m'" - r.sortMappings["album_count"] = "stats->>'" + role + "'->>'a'" - r.sortMappings["size"] = "stats->>'" + role + "'->>'s'" + r.sortMappings["song_count"] = "sum(stats->>'" + role + "'->>'m')" + r.sortMappings["album_count"] = "sum(stats->>'" + role + "'->>'a')" + r.sortMappings["size"] = "sum(stats->>'" + role + "'->>'s')" return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -439,7 +588,7 @@ func (r *artistRepository) EntityName() string { return "artist" } -func (r *artistRepository) NewInstance() interface{} { +func (r *artistRepository) NewInstance() any { return &model.Artist{} } diff --git a/persistence/artist_repository_test.go b/persistence/artist_repository_test.go index 0c7018dc8..076a9da3b 100644 --- a/persistence/artist_repository_test.go +++ b/persistence/artist_repository_test.go @@ -3,11 +3,14 @@ package persistence import ( "context" "encoding/json" + "os" + "path/filepath" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/utils" @@ -15,310 +18,914 @@ import ( . "github.com/onsi/gomega" ) +// Test helper functions to reduce duplication +func createTestArtistWithMBID(id, name, mbid string) model.Artist { + return model.Artist{ + ID: id, + Name: name, + MbzArtistID: mbid, + } +} + +func createUserWithLibraries(userID string, libraryIDs []int) model.User { + user := model.User{ + ID: userID, + UserName: userID, + Name: userID, + Email: userID + "@test.com", + IsAdmin: false, + } + + if len(libraryIDs) > 0 { + user.Libraries = make(model.Libraries, len(libraryIDs)) + for i, libID := range libraryIDs { + user.Libraries[i] = model.Library{ID: libID, Name: "Test Library", Path: "/test"} + } + } + + return user +} + var _ = Describe("ArtistRepository", func() { - var repo model.ArtistRepository - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - ctx := log.NewContext(context.TODO()) - ctx = request.WithUser(ctx, model.User{ID: "userid"}) - repo = NewArtistRepository(ctx, GetDBXBuilder()) - }) + Context("Core Functionality", func() { + Describe("GetIndexKey", func() { + // Note: OrderArtistName should never be empty, so we don't need to test for that + r := artistRepository{indexGroups: utils.ParseIndexGroups(conf.Server.IndexGroups)} - Describe("Count", func() { - It("returns the number of artists in the DB", func() { - Expect(repo.CountAll()).To(Equal(int64(2))) + DescribeTable("returns correct index key based on PreferSortTags setting", + func(preferSortTags bool, sortArtistName, orderArtistName, expectedKey string) { + DeferCleanup(configtest.SetupConfig()) + conf.Server.PreferSortTags = preferSortTags + a := model.Artist{SortArtistName: sortArtistName, OrderArtistName: orderArtistName, Name: "Test"} + idx := GetIndexKey(&r, a) + Expect(idx).To(Equal(expectedKey)) + }, + Entry("PreferSortTags=false, SortArtistName empty -> uses OrderArtistName", false, "", "Bar", "B"), + Entry("PreferSortTags=false, SortArtistName not empty -> still uses OrderArtistName", false, "Foo", "Bar", "B"), + Entry("PreferSortTags=true, SortArtistName not empty -> uses SortArtistName", true, "Foo", "Bar", "F"), + Entry("PreferSortTags=true, SortArtistName empty -> falls back to OrderArtistName", true, "", "Bar", "B"), + ) }) - }) - Describe("Exists", func() { - It("returns true for an artist that is in the DB", func() { - Expect(repo.Exists("3")).To(BeTrue()) - }) - It("returns false for an artist that is in the DB", func() { - Expect(repo.Exists("666")).To(BeFalse()) - }) - }) + Describe("roleFilter", func() { + DescribeTable("validates roles and returns appropriate SQL expressions", + func(role string, shouldBeValid bool) { + result := roleFilter("", role) + if shouldBeValid { + expectedExpr := squirrel.Expr("JSON_EXTRACT(library_artist.stats, '$." + role + ".m') IS NOT NULL") + Expect(result).To(Equal(expectedExpr)) + } else { + expectedInvalid := squirrel.Eq{"1": 2} + Expect(result).To(Equal(expectedInvalid)) + } + }, + // Valid roles from model.AllRoles + Entry("artist role", "artist", true), + Entry("albumartist role", "albumartist", true), + Entry("composer role", "composer", true), + Entry("conductor role", "conductor", true), + Entry("lyricist role", "lyricist", true), + Entry("arranger role", "arranger", true), + Entry("producer role", "producer", true), + Entry("director role", "director", true), + Entry("engineer role", "engineer", true), + Entry("mixer role", "mixer", true), + Entry("remixer role", "remixer", true), + Entry("djmixer role", "djmixer", true), + Entry("performer role", "performer", true), + Entry("maincredit role", "maincredit", true), + // Invalid roles + Entry("invalid role - wizard", "wizard", false), + Entry("invalid role - songanddanceman", "songanddanceman", false), + Entry("empty string", "", false), + Entry("SQL injection attempt", "artist') SELECT LIKE(CHAR(65,66,67,68,69,70,71),UPPER(HEX(RANDOMBLOB(500000000/2))))--", false), + ) - Describe("Get", func() { - It("saves and retrieves data", func() { - artist, err := repo.Get("2") - Expect(err).ToNot(HaveOccurred()) - Expect(artist.Name).To(Equal(artistKraftwerk.Name)) + It("handles non-string input types", func() { + expectedInvalid := squirrel.Eq{"1": 2} + Expect(roleFilter("", 123)).To(Equal(expectedInvalid)) + Expect(roleFilter("", nil)).To(Equal(expectedInvalid)) + Expect(roleFilter("", []string{"artist"})).To(Equal(expectedInvalid)) + }) }) - }) - Describe("GetIndexKey", func() { - // Note: OrderArtistName should never be empty, so we don't need to test for that - r := artistRepository{indexGroups: utils.ParseIndexGroups(conf.Server.IndexGroups)} - When("PreferSortTags is false", func() { + Describe("dbArtist mapping", func() { + var ( + artist *model.Artist + dba *dbArtist + ) + BeforeEach(func() { - conf.Server.PreferSortTags = false + artist = &model.Artist{ID: "1", Name: "Eddie Van Halen", SortArtistName: "Van Halen, Eddie"} + dba = &dbArtist{Artist: artist} }) - It("returns the OrderArtistName key is SortArtistName is empty", func() { - conf.Server.PreferSortTags = false - a := model.Artist{SortArtistName: "", OrderArtistName: "Bar", Name: "Qux"} - idx := GetIndexKey(&r, a) - Expect(idx).To(Equal("B")) + + Describe("PostScan", func() { + It("parses stats and similar artists correctly", func() { + stats := map[string]map[string]map[string]int64{ + "1": { + "total": {"s": 1000, "m": 10, "a": 2}, + "composer": {"s": 500, "m": 5, "a": 1}, + }, + } + statsJSON, _ := json.Marshal(stats) + dba.LibraryStatsJSON = string(statsJSON) + dba.SimilarArtists = `[{"id":"2","Name":"AC/DC"},{"name":"Test;With:Sep,Chars"}]` + + err := dba.PostScan() + Expect(err).ToNot(HaveOccurred()) + Expect(dba.Artist.Size).To(Equal(int64(1000))) + Expect(dba.Artist.SongCount).To(Equal(10)) + Expect(dba.Artist.AlbumCount).To(Equal(2)) + Expect(dba.Artist.Stats).To(HaveLen(1)) + Expect(dba.Artist.Stats[model.RoleFromString("composer")].Size).To(Equal(int64(500))) + Expect(dba.Artist.Stats[model.RoleFromString("composer")].SongCount).To(Equal(5)) + Expect(dba.Artist.Stats[model.RoleFromString("composer")].AlbumCount).To(Equal(1)) + Expect(dba.Artist.SimilarArtists).To(HaveLen(2)) + Expect(dba.Artist.SimilarArtists[0].ID).To(Equal("2")) + Expect(dba.Artist.SimilarArtists[0].Name).To(Equal("AC/DC")) + Expect(dba.Artist.SimilarArtists[1].ID).To(BeEmpty()) + Expect(dba.Artist.SimilarArtists[1].Name).To(Equal("Test;With:Sep,Chars")) + }) }) - It("returns the OrderArtistName key even if SortArtistName is not empty", func() { - a := model.Artist{SortArtistName: "Foo", OrderArtistName: "Bar", Name: "Qux"} - idx := GetIndexKey(&r, a) - Expect(idx).To(Equal("B")) - }) - }) - When("PreferSortTags is true", func() { - BeforeEach(func() { - conf.Server.PreferSortTags = true - }) - It("returns the SortArtistName key if it is not empty", func() { - a := model.Artist{SortArtistName: "Foo", OrderArtistName: "Bar", Name: "Qux"} - idx := GetIndexKey(&r, a) - Expect(idx).To(Equal("F")) - }) - It("returns the OrderArtistName key if SortArtistName is empty", func() { - a := model.Artist{SortArtistName: "", OrderArtistName: "Bar", Name: "Qux"} - idx := GetIndexKey(&r, a) - Expect(idx).To(Equal("B")) + + Describe("PostMapArgs", func() { + It("maps empty similar artists correctly", func() { + m := make(map[string]any) + err := dba.PostMapArgs(m) + Expect(err).ToNot(HaveOccurred()) + Expect(m).To(HaveKeyWithValue("similar_artists", "[]")) + }) + + It("maps similar artists and full text correctly", func() { + artist.SimilarArtists = []model.Artist{ + {ID: "2", Name: "AC/DC"}, + {Name: "Test;With:Sep,Chars"}, + } + m := make(map[string]any) + err := dba.PostMapArgs(m) + Expect(err).ToNot(HaveOccurred()) + Expect(m).To(HaveKeyWithValue("similar_artists", `[{"id":"2","name":"AC/DC"},{"name":"Test;With:Sep,Chars"}]`)) + Expect(m).To(HaveKeyWithValue("full_text", " eddie halen van")) + }) + + It("does not override empty sort_artist_name and mbz_artist_id", func() { + m := map[string]any{ + "sort_artist_name": "", + "mbz_artist_id": "", + } + err := dba.PostMapArgs(m) + Expect(err).ToNot(HaveOccurred()) + Expect(m).ToNot(HaveKey("sort_artist_name")) + Expect(m).ToNot(HaveKey("mbz_artist_id")) + }) }) }) }) - Describe("GetIndex", func() { - When("PreferSortTags is true", func() { - BeforeEach(func() { - conf.Server.PreferSortTags = true - }) - It("returns the index when PreferSortTags is true and SortArtistName is not empty", func() { - // Set SortArtistName to "Foo" for Beatles - artistBeatles.SortArtistName = "Foo" - er := repo.Put(&artistBeatles) - Expect(er).To(BeNil()) - - idx, err := repo.GetIndex(false) - Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) - Expect(idx[0].ID).To(Equal("F")) - Expect(idx[0].Artists).To(HaveLen(1)) - Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) - Expect(idx[1].ID).To(Equal("K")) - Expect(idx[1].Artists).To(HaveLen(1)) - Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) - - // Restore the original value - artistBeatles.SortArtistName = "" - er = repo.Put(&artistBeatles) - Expect(er).To(BeNil()) - }) - - // BFR Empty SortArtistName is not saved in the DB anymore - XIt("returns the index when PreferSortTags is true and SortArtistName is empty", func() { - idx, err := repo.GetIndex(false) - Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) - Expect(idx[0].ID).To(Equal("B")) - Expect(idx[0].Artists).To(HaveLen(1)) - Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) - Expect(idx[1].ID).To(Equal("K")) - Expect(idx[1].Artists).To(HaveLen(1)) - Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) - }) - }) - - When("PreferSortTags is false", func() { - BeforeEach(func() { - conf.Server.PreferSortTags = false - }) - It("returns the index when SortArtistName is NOT empty", func() { - // Set SortArtistName to "Foo" for Beatles - artistBeatles.SortArtistName = "Foo" - er := repo.Put(&artistBeatles) - Expect(er).To(BeNil()) - - idx, err := repo.GetIndex(false) - Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) - Expect(idx[0].ID).To(Equal("B")) - Expect(idx[0].Artists).To(HaveLen(1)) - Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) - Expect(idx[1].ID).To(Equal("K")) - Expect(idx[1].Artists).To(HaveLen(1)) - Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) - - // Restore the original value - artistBeatles.SortArtistName = "" - er = repo.Put(&artistBeatles) - Expect(er).To(BeNil()) - }) - - It("returns the index when SortArtistName is empty", func() { - idx, err := repo.GetIndex(false) - Expect(err).ToNot(HaveOccurred()) - Expect(idx).To(HaveLen(2)) - Expect(idx[0].ID).To(Equal("B")) - Expect(idx[0].Artists).To(HaveLen(1)) - Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) - Expect(idx[1].ID).To(Equal("K")) - Expect(idx[1].Artists).To(HaveLen(1)) - Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) - }) - }) - }) - - Describe("dbArtist mapping", func() { - var ( - artist *model.Artist - dba *dbArtist - ) + Context("Admin User Operations", func() { + var repo model.ArtistRepository BeforeEach(func() { - artist = &model.Artist{ID: "1", Name: "Eddie Van Halen", SortArtistName: "Van Halen, Eddie"} - dba = &dbArtist{Artist: artist} + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, adminUser) + repo = NewArtistRepository(ctx, GetDBXBuilder()) }) - Describe("PostScan", func() { - It("parses stats and similar artists correctly", func() { - stats := map[string]map[string]int64{ - "total": {"s": 1000, "m": 10, "a": 2}, - "composer": {"s": 500, "m": 5, "a": 1}, - } - statsJSON, _ := json.Marshal(stats) - dba.Stats = string(statsJSON) - dba.SimilarArtists = `[{"id":"2","Name":"AC/DC"},{"name":"Test;With:Sep,Chars"}]` + Describe("Basic Operations", func() { + Describe("Count", func() { + It("returns the number of artists in the DB", func() { + Expect(repo.CountAll()).To(Equal(int64(4))) + }) + }) - err := dba.PostScan() - Expect(err).ToNot(HaveOccurred()) - Expect(dba.Artist.Size).To(Equal(int64(1000))) - Expect(dba.Artist.SongCount).To(Equal(10)) - Expect(dba.Artist.AlbumCount).To(Equal(2)) - Expect(dba.Artist.Stats).To(HaveLen(1)) - Expect(dba.Artist.Stats[model.RoleFromString("composer")].Size).To(Equal(int64(500))) - Expect(dba.Artist.Stats[model.RoleFromString("composer")].SongCount).To(Equal(5)) - Expect(dba.Artist.Stats[model.RoleFromString("composer")].AlbumCount).To(Equal(1)) - Expect(dba.Artist.SimilarArtists).To(HaveLen(2)) - Expect(dba.Artist.SimilarArtists[0].ID).To(Equal("2")) - Expect(dba.Artist.SimilarArtists[0].Name).To(Equal("AC/DC")) - Expect(dba.Artist.SimilarArtists[1].ID).To(BeEmpty()) - Expect(dba.Artist.SimilarArtists[1].Name).To(Equal("Test;With:Sep,Chars")) + Describe("Exists", func() { + It("returns true for an artist that is in the DB", func() { + Expect(repo.Exists("3")).To(BeTrue()) + }) + It("returns false for an artist that is NOT in the DB", func() { + Expect(repo.Exists("666")).To(BeFalse()) + }) + }) + + Describe("Get", func() { + It("retrieves existing artist data", func() { + artist, err := repo.Get("2") + Expect(err).ToNot(HaveOccurred()) + Expect(artist.Name).To(Equal(artistKraftwerk.Name)) + }) }) }) - Describe("PostMapArgs", func() { - It("maps empty similar artists correctly", func() { - m := make(map[string]any) - err := dba.PostMapArgs(m) - Expect(err).ToNot(HaveOccurred()) - Expect(m).To(HaveKeyWithValue("similar_artists", "[]")) + Describe("GetIndex", func() { + When("PreferSortTags is true", func() { + BeforeEach(func() { + conf.Server.PreferSortTags = true + }) + It("returns the index when PreferSortTags is true and SortArtistName is not empty", func() { + // Set SortArtistName to "Foo" for Beatles + artistBeatles.SortArtistName = "Foo" + er := repo.Put(&artistBeatles) + Expect(er).To(BeNil()) + + idx, err := repo.GetIndex(false, []int{1}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(4)) + Expect(idx[0].ID).To(Equal("F")) + Expect(idx[0].Artists).To(HaveLen(1)) + Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) + Expect(idx[1].ID).To(Equal("K")) + Expect(idx[1].Artists).To(HaveLen(1)) + Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) + + // Restore the original value + artistBeatles.SortArtistName = "" + er = repo.Put(&artistBeatles) + Expect(er).To(BeNil()) + }) + + // BFR Empty SortArtistName is not saved in the DB anymore + XIt("returns the index when PreferSortTags is true and SortArtistName is empty", func() { + idx, err := repo.GetIndex(false, []int{1}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(4)) + Expect(idx[0].ID).To(Equal("B")) + Expect(idx[0].Artists).To(HaveLen(1)) + Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) + Expect(idx[1].ID).To(Equal("K")) + Expect(idx[1].Artists).To(HaveLen(1)) + Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) + }) }) - It("maps similar artists and full text correctly", func() { - artist.SimilarArtists = []model.Artist{ - {ID: "2", Name: "AC/DC"}, - {Name: "Test;With:Sep,Chars"}, - } - m := make(map[string]any) - err := dba.PostMapArgs(m) - Expect(err).ToNot(HaveOccurred()) - Expect(m).To(HaveKeyWithValue("similar_artists", `[{"id":"2","name":"AC/DC"},{"name":"Test;With:Sep,Chars"}]`)) - Expect(m).To(HaveKeyWithValue("full_text", " eddie halen van")) + When("PreferSortTags is false", func() { + BeforeEach(func() { + conf.Server.PreferSortTags = false + }) + It("returns the index when SortArtistName is NOT empty", func() { + // Set SortArtistName to "Foo" for Beatles + artistBeatles.SortArtistName = "Foo" + er := repo.Put(&artistBeatles) + Expect(er).To(BeNil()) + + idx, err := repo.GetIndex(false, []int{1}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(4)) + Expect(idx[0].ID).To(Equal("B")) + Expect(idx[0].Artists).To(HaveLen(1)) + Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) + Expect(idx[1].ID).To(Equal("K")) + Expect(idx[1].Artists).To(HaveLen(1)) + Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) + + // Restore the original value + artistBeatles.SortArtistName = "" + er = repo.Put(&artistBeatles) + Expect(er).To(BeNil()) + }) + + It("returns the index when SortArtistName is empty", func() { + idx, err := repo.GetIndex(false, []int{1}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(4)) + Expect(idx[0].ID).To(Equal("B")) + Expect(idx[0].Artists).To(HaveLen(1)) + Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) + Expect(idx[1].ID).To(Equal("K")) + Expect(idx[1].Artists).To(HaveLen(1)) + Expect(idx[1].Artists[0].Name).To(Equal(artistKraftwerk.Name)) + Expect(idx[2].ID).To(Equal("R")) + Expect(idx[2].Artists).To(HaveLen(1)) + Expect(idx[2].Artists[0].Name).To(Equal(artistPunctuation.Name)) + Expect(idx[3].ID).To(Equal("S")) + Expect(idx[3].Artists).To(HaveLen(1)) + Expect(idx[3].Artists[0].Name).To(Equal(artistCJK.Name)) + }) }) - It("does not override empty sort_artist_name and mbz_artist_id", func() { - m := map[string]any{ - "sort_artist_name": "", - "mbz_artist_id": "", - } - err := dba.PostMapArgs(m) - Expect(err).ToNot(HaveOccurred()) - Expect(m).ToNot(HaveKey("sort_artist_name")) - Expect(m).ToNot(HaveKey("mbz_artist_id")) + When("filtering by role", func() { + var raw *artistRepository + + BeforeEach(func() { + raw = repo.(*artistRepository) + // Add stats to library_artist table since stats are now stored per-library + composerStats := `{"composer": {"s": 1000, "m": 5, "a": 2}}` + producerStats := `{"producer": {"s": 500, "m": 3, "a": 1}}` + + // Set Beatles as composer in library 1 + _, err := raw.executeSQL(squirrel.Insert("library_artist"). + Columns("library_id", "artist_id", "stats"). + Values(1, artistBeatles.ID, composerStats). + Suffix("ON CONFLICT(library_id, artist_id) DO UPDATE SET stats = excluded.stats")) + Expect(err).ToNot(HaveOccurred()) + + // Set Kraftwerk as producer in library 1 + _, err = raw.executeSQL(squirrel.Insert("library_artist"). + Columns("library_id", "artist_id", "stats"). + Values(1, artistKraftwerk.ID, producerStats). + Suffix("ON CONFLICT(library_id, artist_id) DO UPDATE SET stats = excluded.stats")) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + // Clean up stats from library_artist table + _, _ = raw.executeSQL(squirrel.Update("library_artist"). + Set("stats", "{}"). + Where(squirrel.Eq{"artist_id": artistBeatles.ID, "library_id": 1})) + _, _ = raw.executeSQL(squirrel.Update("library_artist"). + Set("stats", "{}"). + Where(squirrel.Eq{"artist_id": artistKraftwerk.ID, "library_id": 1})) + }) + + It("returns only artists with the specified role", func() { + idx, err := repo.GetIndex(false, []int{1}, model.RoleComposer) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(1)) + Expect(idx[0].ID).To(Equal("B")) + Expect(idx[0].Artists).To(HaveLen(1)) + Expect(idx[0].Artists[0].Name).To(Equal(artistBeatles.Name)) + }) + + It("returns artists with any of the specified roles", func() { + idx, err := repo.GetIndex(false, []int{1}, model.RoleComposer, model.RoleProducer) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(2)) + + // Find Beatles and Kraftwerk in the results + var beatlesFound, kraftwerkFound bool + for _, index := range idx { + for _, artist := range index.Artists { + if artist.Name == artistBeatles.Name { + beatlesFound = true + } + if artist.Name == artistKraftwerk.Name { + kraftwerkFound = true + } + } + } + Expect(beatlesFound).To(BeTrue()) + Expect(kraftwerkFound).To(BeTrue()) + }) + + It("returns empty index when no artists have the specified role", func() { + idx, err := repo.GetIndex(false, []int{1}, model.RoleDirector) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(0)) + }) + }) + + When("validating library IDs", func() { + It("returns nil when no library IDs are provided", func() { + idx, err := repo.GetIndex(false, []int{}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(BeNil()) + }) + + It("returns artists when library IDs are provided (admin user sees all content)", func() { + // Admin users can see all content when valid library IDs are provided + idx, err := repo.GetIndex(false, []int{1}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(4)) + + // With non-existent library ID, admin users see no content because no artists are associated with that library + idx, err = repo.GetIndex(false, []int{999}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(0)) // Even admin users need valid library associations + }) }) }) - Describe("Missing artist visibility", func() { + Describe("Filters", func() { + var artistWithoutAnnotation model.Artist + + BeforeEach(func() { + // Create artist without any annotation + artistWithoutAnnotation = model.Artist{ID: "no-annotation-artist", Name: "No Annotation Artist"} + err := createArtistWithLibrary(repo, &artistWithoutAnnotation, 1) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if raw, ok := repo.(*artistRepository); ok { + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": artistWithoutAnnotation.ID})) + } + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := repo.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + artists := res.(model.Artists) + + var found bool + for _, a := range artists { + if a.ID == artistWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Artist without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := repo.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + artists := res.(model.Artists) + + for _, a := range artists { + Expect(a.ID).ToNot(Equal(artistWithoutAnnotation.ID)) + } + }) + }) + }) + + Describe("MBID and Text Search", func() { + var lib2 model.Library + var lr model.LibraryRepository + var restrictedUser model.User + var restrictedRepo model.ArtistRepository + var headlessRepo model.ArtistRepository + + BeforeEach(func() { + // Set up headless repo (no user context) + headlessRepo = NewArtistRepository(context.Background(), GetDBXBuilder()) + + // Create library for testing access restrictions + lib2 = model.Library{ID: 0, Name: "Artist Test Library", Path: "/artist/test/lib"} + lr = NewLibraryRepository(request.WithUser(GinkgoT().Context(), adminUser), GetDBXBuilder()) + err := lr.Put(&lib2) + Expect(err).ToNot(HaveOccurred()) + + // Create a user with access to only library 1 + restrictedUser = createUserWithLibraries("search_user", []int{1}) + + // Create repository context for the restricted user + ctx := request.WithUser(GinkgoT().Context(), restrictedUser) + restrictedRepo = NewArtistRepository(ctx, GetDBXBuilder()) + + // Ensure both test artists are associated with library 1 + err = lr.AddArtist(1, artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + err = lr.AddArtist(1, artistKraftwerk.ID) + Expect(err).ToNot(HaveOccurred()) + + // Create the restricted user in the database + ur := NewUserRepository(request.WithUser(GinkgoT().Context(), adminUser), GetDBXBuilder()) + err = ur.Put(&restrictedUser) + Expect(err).ToNot(HaveOccurred()) + err = ur.SetUserLibraries(restrictedUser.ID, []int{1}) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + // Clean up library 2 + lr := NewLibraryRepository(request.WithUser(GinkgoT().Context(), adminUser), GetDBXBuilder()) + _ = lr.(*libraryRepository).delete(squirrel.Eq{"id": lib2.ID}) + }) + + DescribeTable("MBID search behavior across different user types", + func(testRepo *model.ArtistRepository, shouldFind bool, testDesc string) { + // Create test artist with MBID + artistWithMBID := createTestArtistWithMBID("test-mbid-artist", "Test MBID Artist", "550e8400-e29b-41d4-a716-446655440010") + + err := createArtistWithLibrary(*testRepo, &artistWithMBID, 1) + Expect(err).ToNot(HaveOccurred()) + + // Test the search + results, err := (*testRepo).Search("550e8400-e29b-41d4-a716-446655440010", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + + if shouldFind { + Expect(results).To(HaveLen(1), testDesc) + Expect(results[0].ID).To(Equal("test-mbid-artist")) + } else { + Expect(results).To(BeEmpty(), testDesc) + } + + // Clean up + if raw, ok := (*testRepo).(*artistRepository); ok { + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": artistWithMBID.ID})) + } + }, + Entry("Admin user can find artist by MBID", &repo, true, "Admin should find MBID artist"), + Entry("Restricted user can find artist by MBID in accessible library", &restrictedRepo, true, "Restricted user should find MBID artist in accessible library"), + Entry("Headless process can find artist by MBID", &headlessRepo, true, "Headless process should find MBID artist"), + ) + + It("prevents restricted user from finding artist by MBID when not in accessible library", func() { + // Create an artist in library 2 (not accessible to restricted user) + inaccessibleArtist := createTestArtistWithMBID("inaccessible-mbid-artist", "Inaccessible MBID Artist", "a74b1b7f-71a5-4011-9441-d0b5e4122711") + err := repo.Put(&inaccessibleArtist) + Expect(err).ToNot(HaveOccurred()) + + // Add to library 2 (not accessible to restricted user) + err = lr.AddArtist(lib2.ID, inaccessibleArtist.ID) + Expect(err).ToNot(HaveOccurred()) + + // Restricted user should not find this artist + results, err := restrictedRepo.Search("a74b1b7f-71a5-4011-9441-d0b5e4122711", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + + // But admin should find it + results, err = repo.Search("a74b1b7f-71a5-4011-9441-d0b5e4122711", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + + // Clean up + if raw, ok := repo.(*artistRepository); ok { + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": inaccessibleArtist.ID})) + } + }) + + Context("Text Search", func() { + It("allows admin to find artists by name regardless of library", func() { + results, err := repo.Search("Beatles", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("The Beatles")) + }) + + It("correctly prevents restricted user from finding artists by name when not in accessible library", func() { + // Create an artist in library 2 (not accessible to restricted user) + inaccessibleArtist := model.Artist{ + ID: "inaccessible-text-artist", + Name: "Unique Search Name Artist", + } + err := repo.Put(&inaccessibleArtist) + Expect(err).ToNot(HaveOccurred()) + + // Add to library 2 (not accessible to restricted user) + err = lr.AddArtist(lib2.ID, inaccessibleArtist.ID) + Expect(err).ToNot(HaveOccurred()) + + // Restricted user should not find this artist + results, err := restrictedRepo.Search("Unique Search Name", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty(), "Text search should respect library filtering") + + // Clean up + if raw, ok := repo.(*artistRepository); ok { + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": inaccessibleArtist.ID})) + } + }) + }) + + Context("Headless Processes (No User Context)", func() { + It("should see all artists from all libraries when no user is in context", func() { + // Add artists to different libraries + err := lr.AddArtist(lib2.ID, artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + + // Headless processes should see all artists regardless of library + artists, err := headlessRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + + // Should see all artists from all libraries + found := false + for _, artist := range artists { + if artist.ID == artistBeatles.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Headless process should see artists from all libraries") + }) + + It("should allow headless processes to apply explicit library_id filters", func() { + // Add artists to different libraries + err := lr.AddArtist(lib2.ID, artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + + // Filter by specific library + artists, err := headlessRepo.GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + + // Should see only artists from the specified library + for _, artist := range artists { + if artist.ID == artistBeatles.ID { + return // Found the expected artist + } + } + Expect(false).To(BeTrue(), "Should find artist from specified library") + }) + + It("should get individual artists when no user is in context", func() { + // Add artist to a library + err := lr.AddArtist(lib2.ID, artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + + // Headless process should be able to get the artist + artist, err := headlessRepo.Get(artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(artist.ID).To(Equal(artistBeatles.ID)) + }) + }) + }) + + Describe("Admin User Library Access", func() { + It("sees all artists regardless of library permissions", func() { + count, err := repo.CountAll() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(4))) + + artists, err := repo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(HaveLen(4)) + + exists, err := repo.Exists(artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + }) + + Describe("Missing Artist Handling", func() { + var missingArtist model.Artist var raw *artistRepository - var missing model.Artist - insertMissing := func() { - missing = model.Artist{ID: "m1", Name: "Missing", OrderArtistName: "missing"} - Expect(repo.Put(&missing)).To(Succeed()) + BeforeEach(func() { raw = repo.(*artistRepository) - _, err := raw.executeSQL(squirrel.Update(raw.tableName).Set("missing", true).Where(squirrel.Eq{"id": missing.ID})) + missingArtist = model.Artist{ID: "missing_test", Name: "Missing Artist", OrderArtistName: "missing artist"} + + // Create and mark as missing + err := createArtistWithLibrary(repo, &missingArtist, 1) Expect(err).ToNot(HaveOccurred()) - } - removeMissing := func() { - if raw != nil { - _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": missing.ID})) + _, err = raw.executeSQL(squirrel.Update(raw.tableName).Set("missing", true).Where(squirrel.Eq{"id": missingArtist.ID})) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": missingArtist.ID})) + }) + + It("missing artists are never returned by search", func() { + // Should see missing artist in GetAll by default for admin users + artists, err := repo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(HaveLen(5)) // Including the missing artist + + // Search never returns missing artists (hardcoded behavior) + results, err := repo.Search("Missing Artist", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + }) + }) + + Context("Regular User Operations", func() { + var restrictedRepo model.ArtistRepository + var unauthorizedUser model.User + + BeforeEach(func() { + // Create a user without access to any libraries + unauthorizedUser = model.User{ID: "restricted_user", UserName: "restricted", Name: "Restricted User", Email: "restricted@test.com", IsAdmin: false} + + // Create repository context for the unauthorized user + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, unauthorizedUser) + restrictedRepo = NewArtistRepository(ctx, GetDBXBuilder()) + }) + + Describe("Library Access Restrictions", func() { + It("CountAll returns 0 for users without library access", func() { + count, err := restrictedRepo.CountAll() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(0))) + }) + + It("GetAll returns empty list for users without library access", func() { + artists, err := restrictedRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(BeEmpty()) + }) + + It("Exists returns false for existing artists when user has no library access", func() { + // These artists exist in the DB but the user has no access to them + exists, err := restrictedRepo.Exists(artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + + exists, err = restrictedRepo.Exists(artistKraftwerk.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("Get returns ErrNotFound for existing artists when user has no library access", func() { + _, err := restrictedRepo.Get(artistBeatles.ID) + Expect(err).To(Equal(model.ErrNotFound)) + + _, err = restrictedRepo.Get(artistKraftwerk.ID) + Expect(err).To(Equal(model.ErrNotFound)) + }) + + It("Search returns empty results for users without library access", func() { + results, err := restrictedRepo.Search("Beatles", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + + results, err = restrictedRepo.Search("Kraftwerk", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("GetIndex returns empty index for users without library access", func() { + idx, err := restrictedRepo.GetIndex(false, []int{1}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(0)) + }) + }) + + Context("when user gains library access", func() { + BeforeEach(func() { + ctx := GinkgoT().Context() + // Give the user access to library 1 + ur := NewUserRepository(request.WithUser(ctx, adminUser), GetDBXBuilder()) + + // First create the user if not exists + err := ur.Put(&unauthorizedUser) + Expect(err).ToNot(HaveOccurred()) + + // Then add library access + err = ur.SetUserLibraries(unauthorizedUser.ID, []int{1}) + Expect(err).ToNot(HaveOccurred()) + + // Update the user object with the libraries to simulate middleware behavior + libraries, err := ur.GetUserLibraries(unauthorizedUser.ID) + Expect(err).ToNot(HaveOccurred()) + unauthorizedUser.Libraries = libraries + + // Recreate repository context with updated user + ctx = request.WithUser(ctx, unauthorizedUser) + restrictedRepo = NewArtistRepository(ctx, GetDBXBuilder()) + }) + + AfterEach(func() { + // Clean up: remove the user's library access + ur := NewUserRepository(request.WithUser(GinkgoT().Context(), adminUser), GetDBXBuilder()) + _ = ur.SetUserLibraries(unauthorizedUser.ID, []int{}) + }) + + It("CountAll returns correct count after gaining access", func() { + count, err := restrictedRepo.CountAll() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(4))) // Beatles, Kraftwerk, Seatbelts, and The Roots + }) + + It("GetAll returns artists after gaining access", func() { + artists, err := restrictedRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(HaveLen(4)) + + var names []string + for _, artist := range artists { + names = append(names, artist.Name) } - } - - Context("regular user", func() { - BeforeEach(func() { - ctx := log.NewContext(context.TODO()) - ctx = request.WithUser(ctx, model.User{ID: "u1"}) - repo = NewArtistRepository(ctx, GetDBXBuilder()) - insertMissing() - }) - - AfterEach(func() { removeMissing() }) - - It("does not return missing artist in GetAll", func() { - artists, err := repo.GetAll(model.QueryOptions{Filters: squirrel.Eq{"artist.missing": false}}) - Expect(err).ToNot(HaveOccurred()) - Expect(artists).To(HaveLen(2)) - }) - - It("does not return missing artist in Search", func() { - res, err := repo.Search("missing", 0, 10, false) - Expect(err).ToNot(HaveOccurred()) - Expect(res).To(BeEmpty()) - }) - - It("does not return missing artist in GetIndex", func() { - idx, err := repo.GetIndex(false) - Expect(err).ToNot(HaveOccurred()) - // Only 2 artists should be present - total := 0 - for _, ix := range idx { - total += len(ix.Artists) - } - Expect(total).To(Equal(2)) - }) + Expect(names).To(ContainElements("The Beatles", "Kraftwerk", "シートベルツ", "The Roots")) }) - Context("admin user", func() { - BeforeEach(func() { - ctx := log.NewContext(context.TODO()) - ctx = request.WithUser(ctx, model.User{ID: "admin", IsAdmin: true}) - repo = NewArtistRepository(ctx, GetDBXBuilder()) - insertMissing() - }) + It("Exists returns true for accessible artists", func() { + exists, err := restrictedRepo.Exists(artistBeatles.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) - AfterEach(func() { removeMissing() }) - - It("returns missing artist in GetAll", func() { - artists, err := repo.GetAll() - Expect(err).ToNot(HaveOccurred()) - Expect(artists).To(HaveLen(3)) - }) - - It("returns missing artist in Search", func() { - res, err := repo.Search("missing", 0, 10, true) - Expect(err).ToNot(HaveOccurred()) - Expect(res).To(HaveLen(1)) - }) - - It("returns missing artist in GetIndex when included", func() { - idx, err := repo.GetIndex(true) - Expect(err).ToNot(HaveOccurred()) - total := 0 - for _, ix := range idx { - total += len(ix.Artists) - } - Expect(total).To(Equal(3)) - }) + exists, err = restrictedRepo.Exists(artistKraftwerk.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) }) + + It("GetIndex returns artists with proper library filtering", func() { + // With valid library access, should see artists + idx, err := restrictedRepo.GetIndex(false, []int{1}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(4)) + + // With non-existent library ID, should see nothing (non-admin user) + idx, err = restrictedRepo.GetIndex(false, []int{999}) + Expect(err).ToNot(HaveOccurred()) + Expect(idx).To(HaveLen(0)) + }) + }) + }) + + Describe("purgeEmpty", func() { + var repo *artistRepository + var tmpDir string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + tmpDir = GinkgoT().TempDir() + conf.Server.DataFolder = conf.NewDir(tmpDir) + + ctx := request.WithUser(GinkgoT().Context(), adminUser) + repo = NewArtistRepository(ctx, GetDBXBuilder()).(*artistRepository) + }) + + // Helper to create an artist image file on disk and return its path + createImageFile := func(filename string) string { + dir := filepath.Join(tmpDir, consts.ArtworkFolder, consts.EntityArtist) + Expect(os.MkdirAll(dir, 0755)).To(Succeed()) + path := filepath.Join(dir, filename) + Expect(os.WriteFile(path, []byte("fake image data"), 0600)).To(Succeed()) + return path + } + + It("removes uploaded image files for purged artists", func() { + // Create an orphan artist (not in album_artists) with an uploaded image + orphanArtist := model.Artist{ID: "orphan-with-image", Name: "Orphan Artist", UploadedImage: "orphan-with-image_Orphan_Artist.jpg"} + Expect(repo.Put(&orphanArtist)).To(Succeed()) + imgPath := createImageFile("orphan-with-image_Orphan_Artist.jpg") + + Expect(repo.purgeEmpty()).To(Succeed()) + + // Artist should be gone from DB + exists, err := repo.Exists("orphan-with-image") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + + // Image file should be removed from disk + _, err = os.Stat(imgPath) + Expect(os.IsNotExist(err)).To(BeTrue()) + }) + + It("handles missing image files gracefully", func() { + // Artist has UploadedImage set but no actual file on disk + orphanArtist := model.Artist{ID: "orphan-no-file", Name: "Ghost Image", UploadedImage: "orphan-no-file_Ghost_Image.jpg"} + Expect(repo.Put(&orphanArtist)).To(Succeed()) + + Expect(repo.purgeEmpty()).To(Succeed()) + + // Artist should be gone from DB + exists, err := repo.Exists("orphan-no-file") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("does not delete images for artists that are kept", func() { + // Create an artist with an uploaded image AND an album_artists entry so it won't be purged + keptArtist := model.Artist{ID: "kept-artist", Name: "Kept Artist", UploadedImage: "kept-artist_Kept_Artist.jpg"} + Expect(repo.Put(&keptArtist)).To(Succeed()) + imgPath := createImageFile("kept-artist_Kept_Artist.jpg") + + // Insert an album_artists record to keep this artist from being purged + _, err := repo.executeSQL(squirrel.Insert("album_artists"). + SetMap(map[string]any{"album_id": "101", "artist_id": "kept-artist", "role": "artist", "sub_role": ""})) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _, _ = repo.executeSQL(squirrel.Delete("album_artists").Where(squirrel.Eq{"artist_id": "kept-artist"})) + _ = repo.delete(squirrel.Eq{"id": "kept-artist"}) + }) + + Expect(repo.purgeEmpty()).To(Succeed()) + + // Artist should still exist (check directly, bypassing library filter) + var ids []string + err = repo.queryAllSlice(squirrel.Select("id").From("artist").Where(squirrel.Eq{"id": "kept-artist"}), &ids) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(HaveLen(1)) + + // Image file should still be on disk + _, err = os.Stat(imgPath) + Expect(err).ToNot(HaveOccurred()) }) }) }) + +// Helper function to create an artist with proper library association. +// This ensures test artists always have library_artist associations to avoid orphaned artists in tests. +func createArtistWithLibrary(repo model.ArtistRepository, artist *model.Artist, libraryID int) error { + err := repo.Put(artist) + if err != nil { + return err + } + + // Add the artist to the specified library + lr := NewLibraryRepository(request.WithUser(GinkgoT().Context(), adminUser), GetDBXBuilder()) + return lr.AddArtist(libraryID, artist.ID) +} diff --git a/persistence/collation_test.go b/persistence/collation_test.go index 7e1144753..bb1276577 100644 --- a/persistence/collation_test.go +++ b/persistence/collation_test.go @@ -32,6 +32,7 @@ var _ = Describe("Collation", func() { Entry("media_file.sort_title", "media_file", "sort_title"), Entry("media_file.sort_album_name", "media_file", "sort_album_name"), Entry("media_file.sort_artist_name", "media_file", "sort_artist_name"), + Entry("playlist.name", "playlist", "name"), Entry("radio.name", "radio", "name"), Entry("user.name", "user", "name"), ) @@ -53,6 +54,7 @@ var _ = Describe("Collation", func() { Entry("media_file.sort_album_name", "media_file", "coalesce(nullif(sort_album_name,''),order_album_name) collate nocase"), Entry("media_file.sort_artist_name", "media_file", "coalesce(nullif(sort_artist_name,''),order_artist_name) collate nocase"), Entry("media_file.path", "media_file", "path collate nocase"), + Entry("playlist.name", "playlist", "name collate nocase"), Entry("radio.name", "radio", "name collate nocase"), Entry("user.user_name", "user", "user_name collate nocase"), ) diff --git a/persistence/criteria_sql.go b/persistence/criteria_sql.go new file mode 100644 index 000000000..37e4ae340 --- /dev/null +++ b/persistence/criteria_sql.go @@ -0,0 +1,663 @@ +package persistence + +import ( + "errors" + "fmt" + "maps" + "reflect" + "slices" + "strconv" + "strings" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" +) + +type smartPlaylistJoinType int + +const ( + smartPlaylistJoinNone smartPlaylistJoinType = 0 + smartPlaylistJoinAlbumAnnotation smartPlaylistJoinType = 1 << iota + smartPlaylistJoinArtistAnnotation +) + +func (j smartPlaylistJoinType) has(other smartPlaylistJoinType) bool { + return j&other != 0 +} + +type smartPlaylistField struct { + expr string + order string + joinType smartPlaylistJoinType +} + +type smartPlaylistCriteria struct { + criteria.Criteria + owner model.User +} + +func newSmartPlaylistCriteria(c criteria.Criteria, opts ...func(*smartPlaylistCriteria)) smartPlaylistCriteria { + cSQL := smartPlaylistCriteria{Criteria: c} + for _, opt := range opts { + opt(&cSQL) + } + return cSQL +} + +func withSmartPlaylistOwner(owner model.User) func(*smartPlaylistCriteria) { + return func(c *smartPlaylistCriteria) { + c.owner = owner + } +} + +var smartPlaylistFields = map[string]smartPlaylistField{ + "title": {expr: "media_file.title"}, + "album": {expr: "media_file.album"}, + "hascoverart": {expr: "media_file.has_cover_art"}, + "tracknumber": {expr: "media_file.track_number"}, + "discnumber": {expr: "media_file.disc_number"}, + "year": {expr: "media_file.year"}, + "date": {expr: "media_file.date"}, + "originalyear": {expr: "media_file.original_year"}, + "originaldate": {expr: "media_file.original_date"}, + "releaseyear": {expr: "media_file.release_year"}, + "releasedate": {expr: "media_file.release_date"}, + "size": {expr: "media_file.size"}, + "compilation": {expr: "media_file.compilation"}, + "missing": {expr: "media_file.missing"}, + "explicitstatus": {expr: "media_file.explicit_status"}, + "dateadded": {expr: "media_file.created_at"}, + "datemodified": {expr: "media_file.updated_at"}, + "discsubtitle": {expr: "media_file.disc_subtitle"}, + "comment": {expr: "media_file.comment"}, + "lyrics": {expr: "media_file.lyrics"}, + "sorttitle": {expr: "media_file.sort_title"}, + "sortalbum": {expr: "media_file.sort_album_name"}, + "sortartist": {expr: "media_file.sort_artist_name"}, + "sortalbumartist": {expr: "media_file.sort_album_artist_name"}, + "albumcomment": {expr: "media_file.mbz_album_comment"}, + "catalognumber": {expr: "media_file.catalog_num"}, + "filepath": {expr: "media_file.path"}, + "filetype": {expr: "media_file.suffix"}, + "codec": {expr: "media_file.codec"}, + "duration": {expr: "media_file.duration"}, + "bitrate": {expr: "media_file.bit_rate"}, + "bitdepth": {expr: "media_file.bit_depth"}, + "samplerate": {expr: "media_file.sample_rate"}, + "bpm": {expr: "media_file.bpm"}, + "channels": {expr: "media_file.channels"}, + "loved": {expr: "COALESCE(annotation.starred, false)"}, + "dateloved": {expr: "annotation.starred_at"}, + "lastplayed": {expr: "annotation.play_date"}, + "daterated": {expr: "annotation.rated_at"}, + "playcount": {expr: "COALESCE(annotation.play_count, 0)"}, + "rating": {expr: "COALESCE(annotation.rating, 0)"}, + "averagerating": {expr: "media_file.average_rating"}, + "albumrating": {expr: "COALESCE(album_annotation.rating, 0)", joinType: smartPlaylistJoinAlbumAnnotation}, + "albumloved": {expr: "COALESCE(album_annotation.starred, false)", joinType: smartPlaylistJoinAlbumAnnotation}, + "albumplaycount": {expr: "COALESCE(album_annotation.play_count, 0)", joinType: smartPlaylistJoinAlbumAnnotation}, + "albumlastplayed": {expr: "album_annotation.play_date", joinType: smartPlaylistJoinAlbumAnnotation}, + "albumdateloved": {expr: "album_annotation.starred_at", joinType: smartPlaylistJoinAlbumAnnotation}, + "albumdaterated": {expr: "album_annotation.rated_at", joinType: smartPlaylistJoinAlbumAnnotation}, + "artistrating": {expr: "COALESCE(artist_annotation.rating, 0)", joinType: smartPlaylistJoinArtistAnnotation}, + "artistloved": {expr: "COALESCE(artist_annotation.starred, false)", joinType: smartPlaylistJoinArtistAnnotation}, + "artistplaycount": {expr: "COALESCE(artist_annotation.play_count, 0)", joinType: smartPlaylistJoinArtistAnnotation}, + "artistlastplayed": {expr: "artist_annotation.play_date", joinType: smartPlaylistJoinArtistAnnotation}, + "artistdateloved": {expr: "artist_annotation.starred_at", joinType: smartPlaylistJoinArtistAnnotation}, + "artistdaterated": {expr: "artist_annotation.rated_at", joinType: smartPlaylistJoinArtistAnnotation}, + "mbz_album_id": {expr: "media_file.mbz_album_id"}, + "mbz_album_artist_id": {expr: "media_file.mbz_album_artist_id"}, + "mbz_artist_id": {expr: "media_file.mbz_artist_id"}, + "mbz_recording_id": {expr: "media_file.mbz_recording_id"}, + "mbz_release_track_id": {expr: "media_file.mbz_release_track_id"}, + "mbz_release_group_id": {expr: "media_file.mbz_release_group_id"}, + "rgalbumgain": {expr: "media_file.rg_album_gain"}, + "rgalbumpeak": {expr: "media_file.rg_album_peak"}, + "rgtrackgain": {expr: "media_file.rg_track_gain"}, + "rgtrackpeak": {expr: "media_file.rg_track_peak"}, + "library_id": {expr: "media_file.library_id"}, + "random": {order: "random()"}, +} + +func (c smartPlaylistCriteria) Where() (squirrel.Sqlizer, error) { + if c.Criteria.Expression == nil { + return squirrel.Expr("1 = 1"), nil + } + return c.exprSQL(c.Criteria.Expression) +} + +func (c smartPlaylistCriteria) exprSQL(expr criteria.Expression) (squirrel.Sqlizer, error) { + switch e := expr.(type) { + case criteria.All: + and := squirrel.And{} + for _, child := range e { + cond, err := c.exprSQL(child) + if err != nil { + return nil, err + } + and = append(and, cond) + } + return and, nil + case criteria.Any: + or := squirrel.Or{} + for _, child := range e { + cond, err := c.exprSQL(child) + if err != nil { + return nil, err + } + or = append(or, cond) + } + return mergeJsonConds(or), nil + case criteria.Is: + return mapExpr(e, func(fields map[string]any) squirrel.Sqlizer { + return squirrel.Eq(fields) + }, false) + case criteria.IsNot: + return isNotExpr(e) + case criteria.Gt: + return mapExpr(e, func(fields map[string]any) squirrel.Sqlizer { + return squirrel.Gt(fields) + }, false) + case criteria.Lt: + return mapExpr(e, func(fields map[string]any) squirrel.Sqlizer { + return squirrel.Lt(fields) + }, false) + case criteria.Before: + return mapExpr(e, func(fields map[string]any) squirrel.Sqlizer { + return squirrel.Lt(fields) + }, false) + case criteria.After: + return mapExpr(e, func(fields map[string]any) squirrel.Sqlizer { + return squirrel.Gt(fields) + }, false) + case criteria.Contains: + return likeExpr(e, "%%%v%%", false) + case criteria.NotContains: + return likeExpr(e, "%%%v%%", true) + case criteria.StartsWith: + return likeExpr(e, "%v%%", false) + case criteria.EndsWith: + return likeExpr(e, "%%%v", false) + case criteria.InTheRange: + return rangeExpr(e) + case criteria.InTheLast: + return periodExpr(e, false) + case criteria.NotInTheLast: + return periodExpr(e, true) + case criteria.InPlaylist: + return c.inList(e, false) + case criteria.NotInPlaylist: + return c.inList(e, true) + case criteria.IsMissing: + return missingExpr(e, true) + case criteria.IsPresent: + return missingExpr(e, false) + default: + return nil, fmt.Errorf("unknown criteria expression type %T", expr) + } +} + +func isNotExpr(values map[string]any) (squirrel.Sqlizer, error) { + if _, value, info, ok := singleField(values); ok && (info.IsTag || info.IsRole) { + return jsonExpr(info, squirrel.Eq{"value": value}, true), nil + } + fields, err := sqlFields(values) + if err != nil { + return nil, err + } + return squirrel.NotEq(fields), nil +} + +func missingExpr(values map[string]any, checkAbsence bool) (squirrel.Sqlizer, error) { + field, value, info, ok := singleField(values) + if !ok { + if len(values) != 1 { + return nil, fmt.Errorf("invalid field in criteria: isMissing/isPresent requires exactly one field") + } + return nil, fmt.Errorf("invalid field in criteria: %s", field) + } + if !info.IsTag && !info.IsRole { + return nil, fmt.Errorf("isMissing/isPresent operator is only supported for tag and role fields, got: %s", field) + } + + b, ok := value.(bool) + if !ok { + return nil, fmt.Errorf("invalid boolean value for 'missing' expression: %s: %v", field, value) + } + negate := checkAbsence == b + return jsonExpr(info, nil, negate), nil +} + +func mapExpr(values map[string]any, makeCond func(map[string]any) squirrel.Sqlizer, negateJSON bool) (squirrel.Sqlizer, error) { + if _, value, info, ok := singleField(values); ok && (info.IsTag || info.IsRole) { + return jsonExpr(info, makeCond(map[string]any{"value": value}), negateJSON), nil + } + fields, err := sqlFields(values) + if err != nil { + return nil, err + } + return makeCond(fields), nil +} + +func likeExpr(values map[string]any, pattern string, negate bool) (squirrel.Sqlizer, error) { + if _, value, info, ok := singleField(values); ok && (info.IsTag || info.IsRole) { + return jsonExpr(info, squirrel.Like{"value": fmt.Sprintf(pattern, value)}, negate), nil + } + fields, err := sqlFields(values) + if err != nil { + return nil, err + } + if negate { + lk := squirrel.NotLike{} + for field, value := range fields { + lk[field] = fmt.Sprintf(pattern, value) + } + return lk, nil + } + lk := squirrel.Like{} + for field, value := range fields { + lk[field] = fmt.Sprintf(pattern, value) + } + return lk, nil +} + +func rangeExpr(values map[string]any) (squirrel.Sqlizer, error) { + fields, err := sqlFields(values) + if err != nil { + return nil, err + } + and := squirrel.And{} + for field, value := range fields { + s := reflect.ValueOf(value) + if s.Kind() != reflect.Slice || s.Len() != 2 { + return nil, fmt.Errorf("invalid range for 'in' operator: %s", value) + } + and = append(and, + squirrel.GtOrEq{field: s.Index(0).Interface()}, + squirrel.LtOrEq{field: s.Index(1).Interface()}, + ) + } + return and, nil +} + +func periodExpr(values map[string]any, negate bool) (squirrel.Sqlizer, error) { + fields, err := sqlFields(values) + if err != nil { + return nil, err + } + var field string + var value any + for f, v := range fields { + field, value = f, v + break + } + days, err := strconv.ParseInt(fmt.Sprintf("%v", value), 10, 64) + if err != nil { + return nil, err + } + firstDate := startOfPeriod(days, time.Now()) + if negate { + return squirrel.Or{ + squirrel.Lt{field: firstDate}, + squirrel.Eq{field: nil}, + }, nil + } + return squirrel.Gt{field: firstDate}, nil +} + +func startOfPeriod(numDays int64, from time.Time) string { + return from.Add(time.Duration(-24*numDays) * time.Hour).Format("2006-01-02") +} + +func (c smartPlaylistCriteria) inList(values map[string]any, negate bool) (squirrel.Sqlizer, error) { + playlistID, ok := values["id"].(string) + if !ok { + return nil, errors.New("playlist id not given") + } + filters := squirrel.And{squirrel.Eq{"pl.playlist_id": playlistID}} + if !c.owner.IsAdmin { + if c.owner.ID == "" { + filters = append(filters, squirrel.Eq{"playlist.public": 1}) + } else { + filters = append(filters, squirrel.Or{ + squirrel.Eq{"playlist.public": 1}, + squirrel.Eq{"playlist.owner_id": c.owner.ID}, + }) + } + } + subQuery := squirrel.Select("media_file_id"). + From("playlist_tracks pl"). + LeftJoin("playlist on pl.playlist_id = playlist.id"). + Where(filters) + subSQL, subArgs, err := subQuery.PlaceholderFormat(squirrel.Question).ToSql() + if err != nil { + return nil, err + } + if negate { + return squirrel.Expr("media_file.id NOT IN ("+subSQL+")", subArgs...), nil + } + return squirrel.Expr("media_file.id IN ("+subSQL+")", subArgs...), nil +} + +func jsonExpr(info criteria.FieldInfo, cond squirrel.Sqlizer, negate bool) squirrel.Sqlizer { + if info.IsRole { + return roleCond{role: info.Name(), cond: cond, not: negate} + } + return tagCond{tag: info.Name(), numeric: info.Numeric, cond: cond, not: negate} +} + +type tagCond struct { + tag string + numeric bool + cond squirrel.Sqlizer + not bool +} + +func (e tagCond) ToSql() (string, []any, error) { + var cond string + var args []any + var err error + if e.cond != nil { + cond, args, err = e.cond.ToSql() + if e.numeric { + cond = strings.ReplaceAll(cond, "value", "CAST(value AS REAL)") + } + cond = fmt.Sprintf("exists (select 1 from json_tree(media_file.tags, '$.%s') where key='value' and %s)", e.tag, cond) + } else { + cond = fmt.Sprintf("exists (select 1 from json_tree(media_file.tags, '$.%s') where key='value')", e.tag) + } + if e.not { + cond = "not " + cond + } + return cond, args, err +} + +type roleCond struct { + role string + cond squirrel.Sqlizer + not bool +} + +func (e roleCond) ToSql() (string, []any, error) { + var cond string + var args []any + if e.cond != nil { + innerSQL, innerArgs, err := roleCondSQL(e.cond) + if err != nil { + return "", nil, err + } + cond = roleExistsSQL(innerSQL) + args = append([]any{e.role}, innerArgs...) + } else { + cond = "exists (select 1 from media_file_artists mfa where mfa.media_file_id = media_file.id and mfa.role = ?)" + args = []any{e.role} + } + if e.not { + cond = "not " + cond + } + return cond, args, nil +} + +// roleCondSQL extracts SQL from a squirrel condition and rewrites the placeholder column name. +func roleCondSQL(cond squirrel.Sqlizer) (string, []any, error) { + sql, args, err := cond.ToSql() + if err != nil { + return "", nil, err + } + return strings.ReplaceAll(sql, "value", "artist.name"), args, nil +} + +// roleExistsSQL wraps a condition fragment in the standard role EXISTS subquery. +func roleExistsSQL(innerCond string) string { + return fmt.Sprintf("exists (select 1 from media_file_artists mfa join artist on artist.id = mfa.artist_id "+ + "where mfa.media_file_id = media_file.id and mfa.role = ? and %s)", innerCond) +} + +// jsonCondBatchSize limits how many conditions are ORed inside a single EXISTS subquery +// to stay within SQLite's expression tree depth limit (max 1000). The EXISTS wrapper +// consumes ~4 levels; each ORed condition adds 1 level. Empirically, 496 is the maximum. +const jsonCondBatchSize = 350 + +// mergeJsonConds collapses multiple non-negated roleCond or tagCond entries for the same +// field within an OR group into batched EXISTS subqueries with the conditions ORed inside. +// This turns N separate correlated subqueries into ceil(N/batchSize), dramatically +// improving performance for smart playlists with many patterns. +func mergeJsonConds(or squirrel.Or) squirrel.Sqlizer { + type condEntry struct { + index int + cond squirrel.Sqlizer + } + type group struct { + entries []condEntry + isRole bool + numeric bool + tag string + } + groups := make(map[string]*group) + for i, s := range or { + switch c := s.(type) { + case roleCond: + if c.not || c.cond == nil { + continue + } + g, exists := groups["role:"+c.role] + if !exists { + g = &group{isRole: true} + groups["role:"+c.role] = g + } + g.entries = append(g.entries, condEntry{index: i, cond: c.cond}) + case tagCond: + if c.not || c.cond == nil { + continue + } + g, exists := groups["tag:"+c.tag] + if !exists { + g = &group{tag: c.tag, numeric: c.numeric} + groups["tag:"+c.tag] = g + } + g.entries = append(g.entries, condEntry{index: i, cond: c.cond}) + } + } + + merged := false + remove := make(map[int]bool) + var additions []squirrel.Sqlizer + for _, key := range slices.Sorted(maps.Keys(groups)) { + g := groups[key] + if len(g.entries) < 2 { + continue + } + merged = true + for _, e := range g.entries { + remove[e.index] = true + } + conds := make([]squirrel.Sqlizer, len(g.entries)) + for i, e := range g.entries { + conds[i] = e.cond + } + if g.isRole { + role := key[len("role:"):] + for batch := range slices.Chunk(conds, jsonCondBatchSize) { + additions = append(additions, roleCondGroup{role: role, conds: batch}) + } + } else { + for batch := range slices.Chunk(conds, jsonCondBatchSize) { + additions = append(additions, tagCondGroup{tag: g.tag, numeric: g.numeric, conds: batch}) + } + } + } + + if !merged { + return or + } + + result := make(squirrel.Or, 0, len(or)-len(remove)+len(additions)) + for i, s := range or { + if !remove[i] { + result = append(result, s) + } + } + result = append(result, additions...) + return result +} + +// roleCondGroup represents multiple role conditions for the same role, merged into +// a single EXISTS subquery for performance. +type roleCondGroup struct { + role string + conds []squirrel.Sqlizer +} + +func (g roleCondGroup) ToSql() (string, []any, error) { + innerParts := make([]string, 0, len(g.conds)) + allArgs := []any{g.role} + for _, c := range g.conds { + part, args, err := roleCondSQL(c) + if err != nil { + return "", nil, err + } + innerParts = append(innerParts, part) + allArgs = append(allArgs, args...) + } + cond := roleExistsSQL("(" + strings.Join(innerParts, " OR ") + ")") + return cond, allArgs, nil +} + +// tagCondGroup represents multiple tag conditions for the same tag, merged into +// a single EXISTS subquery for performance. +type tagCondGroup struct { + tag string + numeric bool + conds []squirrel.Sqlizer +} + +func (g tagCondGroup) ToSql() (string, []any, error) { + innerParts := make([]string, 0, len(g.conds)) + var allArgs []any + for _, c := range g.conds { + part, args, err := c.ToSql() + if err != nil { + return "", nil, err + } + if g.numeric { + part = strings.ReplaceAll(part, "value", "CAST(value AS REAL)") + } + innerParts = append(innerParts, part) + allArgs = append(allArgs, args...) + } + cond := fmt.Sprintf("exists (select 1 from json_tree(media_file.tags, '$.%s') where key='value' and (%s))", + g.tag, strings.Join(innerParts, " OR ")) + return cond, allArgs, nil +} + +func singleField(values map[string]any) (string, any, criteria.FieldInfo, bool) { + if len(values) != 1 { + return "", nil, criteria.FieldInfo{}, false + } + for field, value := range values { + info, ok := criteria.LookupField(field) + return field, value, info, ok + } + return "", nil, criteria.FieldInfo{}, false +} + +func sqlFields(values map[string]any) (map[string]any, error) { + fields := make(map[string]any, len(values)) + for field, value := range values { + info, ok := criteria.LookupField(field) + if !ok { + return nil, fmt.Errorf("invalid field in criteria: %s", field) + } + if info.IsTag || info.IsRole { + return nil, fmt.Errorf("tag and role criteria must contain exactly one field: %s", field) + } + sqlField, ok := fieldExpr(info.Name()) + if !ok || sqlField == "" { + return nil, fmt.Errorf("invalid field in criteria: %s", field) + } + fields[sqlField] = value + } + return fields, nil +} + +func fieldExpr(name string) (string, bool) { + field, ok := smartPlaylistFields[strings.ToLower(name)] + return field.expr, ok +} + +func fieldJoinType(name string) smartPlaylistJoinType { + info, ok := criteria.LookupField(name) + if !ok { + return smartPlaylistJoinNone + } + field, ok := smartPlaylistFields[info.Name()] + if !ok { + return smartPlaylistJoinNone + } + return field.joinType +} + +func (c smartPlaylistCriteria) ExpressionJoins() smartPlaylistJoinType { + var joins smartPlaylistJoinType + _ = criteria.Walk(c.Criteria.Expression, func(expr criteria.Expression) error { + for field := range criteria.Fields(expr) { + joins |= fieldJoinType(field) + } + return nil + }) + return joins +} + +func (c smartPlaylistCriteria) RequiredJoins() smartPlaylistJoinType { + joins := c.ExpressionJoins() + for _, name := range c.Criteria.SortFieldNames() { + joins |= fieldJoinType(name) + } + return joins +} + +func (c smartPlaylistCriteria) OrderBy() string { + sortFields := c.Criteria.OrderByFields() + parts := make([]string, 0, len(sortFields)) + for _, sf := range sortFields { + mapped, ok := sortExpr(sf.Field) + if !ok { + continue + } + dir := "asc" + if sf.Desc { + dir = "desc" + } + parts = append(parts, mapped+" "+dir) + } + return strings.Join(parts, ", ") +} + +func sortExpr(sortField string) (string, bool) { + info, ok := criteria.LookupField(sortField) + if !ok { + return "", false + } + if field, ok := smartPlaylistFields[info.Name()]; ok && field.order != "" { + return field.order, true + } + var mapped string + switch { + case info.IsTag: + mapped = "COALESCE(json_extract(media_file.tags, '$." + info.Name() + "[0].value'), '')" + case info.IsRole: + mapped = "COALESCE(json_extract(media_file.participants, '$." + info.Name() + "[0].name'), '')" + default: + field, ok := smartPlaylistFields[info.Name()] + if !ok || field.expr == "" { + return "", false + } + mapped = field.expr + } + if info.Numeric { + mapped = fmt.Sprintf("CAST(%s AS REAL)", mapped) + } + return mapped, true +} diff --git a/persistence/criteria_sql_benchmark_test.go b/persistence/criteria_sql_benchmark_test.go new file mode 100644 index 000000000..d901e9eda --- /dev/null +++ b/persistence/criteria_sql_benchmark_test.go @@ -0,0 +1,236 @@ +package persistence + +import ( + "context" + "encoding/json" + "fmt" + "path/filepath" + "strings" + "testing" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/pocketbase/dbx" +) + +const ( + benchNumArtists = 1_000 + benchNumTracks = 40_000 + benchNumPatterns = 500 + benchArtistsPerTrack = 3 +) + +// BenchmarkSmartPlaylistRole compares role-based smart playlist query performance +// between the current implementation (merged join-table via criteria pipeline) and +// the old baseline (unmerged json_tree subqueries). +func BenchmarkSmartPlaylistRole(b *testing.B) { + configtest.SetupConfig() + tmpDir := b.TempDir() + conf.Server.DbPath = filepath.Join(tmpDir, "bench-smartpl.db") + cleanup := db.Init(context.Background()) + defer cleanup() + log.SetLevel(log.LevelFatal) + + conn := dbx.NewFromDB(db.Db(), db.Dialect) + ctx := log.NewContext(context.Background()) + user := model.User{ID: "bench-user", UserName: "bench", Name: "Bench User", IsAdmin: true} + ctx = request.WithUser(ctx, user) + + setupBenchData(b, ctx, conn, user) + criteria.AddRoles([]string{"artist"}) + + // Build the criteria expression: 500 "contains artist" patterns in an OR group + anyExprs := make(criteria.Any, benchNumPatterns) + for i := range benchNumPatterns { + anyExprs[i] = criteria.Contains{"artist": fmt.Sprintf("Artist %04d", i)} + } + expr := criteria.Criteria{Expression: anyExprs, Sort: "title", Limit: 500} + + b.Run("Current", func(b *testing.B) { + benchmarkCriteriaPipeline(b, ctx, expr) + }) + b.Run("Baseline_UnmergedJSONTree", func(b *testing.B) { + benchmarkUnmergedJSONTree(b, ctx) + }) +} + +// benchmarkCriteriaPipeline runs the criteria through the actual production code path: +// newSmartPlaylistCriteria → Where() → ToSql(), then executes the resulting query. +func benchmarkCriteriaPipeline(b *testing.B, ctx context.Context, expr criteria.Criteria) { + b.Helper() + + cSQL := newSmartPlaylistCriteria(expr) + + // Build the full query matching buildSmartPlaylistQuery + addCriteria + sq := squirrel.Select("media_file.id").From("media_file") + cond, err := cSQL.Where() + if err != nil { + b.Fatal(err) + } + sq = sq.Where(cond) + if expr.Limit > 0 { + sq = sq.Limit(uint64(expr.Limit)) + } + if order := cSQL.OrderBy(); order != "" { + sq = sq.OrderBy(order) + } + + query, args, err := sq.PlaceholderFormat(squirrel.Question).ToSql() + if err != nil { + b.Fatal(err) + } + + runBenchQuery(b, ctx, query, args) +} + +// benchmarkUnmergedJSONTree builds the old-style query with N separate json_tree EXISTS +// subqueries (the pre-optimization baseline). +func benchmarkUnmergedJSONTree(b *testing.B, ctx context.Context) { + b.Helper() + + var sb strings.Builder + sb.WriteString("SELECT media_file.id FROM media_file WHERE (") + args := make([]any, 0, benchNumPatterns) + for i := range benchNumPatterns { + if i > 0 { + sb.WriteString(" OR ") + } + sb.WriteString("exists (select 1 from json_tree(media_file.participants, '$.artist') where key='name' and value LIKE ?)") + args = append(args, fmt.Sprintf("%%Artist %04d%%", i)) + } + sb.WriteString(") ORDER BY media_file.title LIMIT 500") + + runBenchQuery(b, ctx, sb.String(), args) +} + +func runBenchQuery(b *testing.B, ctx context.Context, query string, args []any) { + b.Helper() + sqlDB := db.Db() + b.ResetTimer() + for range b.N { + rows, err := sqlDB.QueryContext(ctx, query, args...) + if err != nil { + b.Fatal(err) + } + for rows.Next() { + var id string + _ = rows.Scan(&id) + } + rows.Close() + if err := rows.Err(); err != nil { + b.Fatal(err) + } + } +} + +func setupBenchData(b *testing.B, ctx context.Context, conn *dbx.DB, user model.User) { + b.Helper() + + sqlDB := db.Db() + + ur := NewUserRepository(ctx, conn) + if err := ur.Put(&user); err != nil { + b.Fatal(err) + } + if err := ur.SetUserLibraries(user.ID, []int{1}); err != nil { + b.Fatal(err) + } + + tx, err := sqlDB.Begin() + if err != nil { + b.Fatal(err) + } + + // Create artists + artistStmt, err := tx.Prepare("INSERT INTO artist (id, name) VALUES (?, ?)") + if err != nil { + b.Fatal(err) + } + for i := range benchNumArtists { + if _, err := artistStmt.Exec(fmt.Sprintf("artist-%04d", i), fmt.Sprintf("Artist %04d", i)); err != nil { + b.Fatal(err) + } + } + artistStmt.Close() + + // Ensure folder exists + folderID := "bench-folder" + if _, err := tx.Exec("INSERT OR IGNORE INTO folder (id, library_id, path, name, parent_id) VALUES (?, 1, '.', '.', '')", folderID); err != nil { + b.Fatal(err) + } + + // Create media files with participants JSON, cycling through artists + mfStmt, err := tx.Prepare(`INSERT INTO media_file (id, path, title, album, artist, artist_id, album_id, + duration, year, size, suffix, tags, participants, lyrics, library_id, folder_id, pid, codec) + VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`) + if err != nil { + b.Fatal(err) + } + + // Populate media_file_artists join table + mfaStmt, err := tx.Prepare("INSERT INTO media_file_artists (media_file_id, artist_id, role, sub_role) VALUES (?, ?, ?, ?)") + if err != nil { + b.Fatal(err) + } + + for i := range benchNumTracks { + trackID := fmt.Sprintf("track-%05d", i) + + // Assign benchArtistsPerTrack artists to each track, cycling through the pool + artistEntries := make([]map[string]string, benchArtistsPerTrack) + for a := range benchArtistsPerTrack { + artistIdx := (i + a) % benchNumArtists + artistEntries[a] = map[string]string{ + "id": fmt.Sprintf("artist-%04d", artistIdx), + "name": fmt.Sprintf("Artist %04d", artistIdx), + } + } + primaryArtistIdx := i % benchNumArtists + primaryArtistID := fmt.Sprintf("artist-%04d", primaryArtistIdx) + primaryArtistName := fmt.Sprintf("Artist %04d", primaryArtistIdx) + + participants := map[string][]map[string]string{"artist": artistEntries} + participantsJSON, _ := json.Marshal(participants) + + if _, err := mfStmt.Exec( + trackID, + fmt.Sprintf("music/%s.mp3", trackID), + fmt.Sprintf("Track %05d", i), + "Bench Album", + primaryArtistName, + primaryArtistID, + "bench-album", + 180, 2024, 5000000, "mp3", + "{}", + string(participantsJSON), + "[]", + 1, folderID, trackID, "mp3", + ); err != nil { + b.Fatal(err) + } + + // Insert all artist associations into the join table + for a := range benchArtistsPerTrack { + artistIdx := (i + a) % benchNumArtists + artistID := fmt.Sprintf("artist-%04d", artistIdx) + if _, err := mfaStmt.Exec(trackID, artistID, "artist", ""); err != nil { + b.Fatal(err) + } + } + } + mfStmt.Close() + mfaStmt.Close() + + if err := tx.Commit(); err != nil { + b.Fatal(err) + } + + b.Logf("Setup complete: %d artists, %d tracks (%d artists/track), %d patterns", + benchNumArtists, benchNumTracks, benchArtistsPerTrack, benchNumPatterns) +} diff --git a/persistence/criteria_sql_test.go b/persistence/criteria_sql_test.go new file mode 100644 index 000000000..5c8909e1c --- /dev/null +++ b/persistence/criteria_sql_test.go @@ -0,0 +1,381 @@ +package persistence + +import ( + "fmt" + "strings" + "time" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Smart playlist criteria SQL", func() { + BeforeEach(func() { + criteria.AddRoles([]string{"artist", "composer", "producer"}) + criteria.AddTagNames([]string{"genre", "mood", "releasetype", "recordingdate"}) + criteria.AddNumericTags([]string{"rate"}) + }) + + DescribeTable("expressions", + func(expr criteria.Expression, expectedSQL string, expectedArgs ...any) { + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal(expectedSQL)) + Expect(args).To(HaveExactElements(expectedArgs...)) + }, + Entry("all group", + criteria.All{criteria.Contains{"title": "love"}, criteria.Gt{"rating": 3}}, + "(media_file.title LIKE ? AND COALESCE(annotation.rating, 0) > ?)", "%love%", 3), + Entry("any group", + criteria.Any{criteria.Is{"title": "Low Rider"}, criteria.Is{"album": "Best Of"}}, + "(media_file.title = ? OR media_file.album = ?)", "Low Rider", "Best Of"), + Entry("is string", criteria.Is{"title": "Low Rider"}, "media_file.title = ?", "Low Rider"), + Entry("is bool", criteria.Is{"loved": true}, "COALESCE(annotation.starred, false) = ?", true), + Entry("is numeric list", criteria.Is{"library_id": []int{1, 2}}, "media_file.library_id IN (?,?)", 1, 2), + Entry("is not", criteria.IsNot{"title": "Low Rider"}, "media_file.title <> ?", "Low Rider"), + Entry("gt", criteria.Gt{"playCount": 10}, "COALESCE(annotation.play_count, 0) > ?", 10), + Entry("lt", criteria.Lt{"playCount": 10}, "COALESCE(annotation.play_count, 0) < ?", 10), + Entry("contains", criteria.Contains{"title": "Low Rider"}, "media_file.title LIKE ?", "%Low Rider%"), + Entry("not contains", criteria.NotContains{"title": "Low Rider"}, "media_file.title NOT LIKE ?", "%Low Rider%"), + Entry("starts with", criteria.StartsWith{"title": "Low Rider"}, "media_file.title LIKE ?", "Low Rider%"), + Entry("ends with", criteria.EndsWith{"title": "Low Rider"}, "media_file.title LIKE ?", "%Low Rider"), + Entry("in range", criteria.InTheRange{"year": []int{1980, 1990}}, "(media_file.year >= ? AND media_file.year <= ?)", 1980, 1990), + Entry("before", criteria.Before{"lastPlayed": time.Date(2021, 10, 1, 0, 0, 0, 0, time.Local)}, "annotation.play_date < ?", time.Date(2021, 10, 1, 0, 0, 0, 0, time.Local)), + Entry("after", criteria.After{"lastPlayed": time.Date(2021, 10, 1, 0, 0, 0, 0, time.Local)}, "annotation.play_date > ?", time.Date(2021, 10, 1, 0, 0, 0, 0, time.Local)), + Entry("in playlist", criteria.InPlaylist{"id": "deadbeef-dead-beef"}, "media_file.id IN (SELECT media_file_id FROM playlist_tracks pl LEFT JOIN playlist on pl.playlist_id = playlist.id WHERE (pl.playlist_id = ? AND playlist.public = ?))", "deadbeef-dead-beef", 1), + Entry("not in playlist", criteria.NotInPlaylist{"id": "deadbeef-dead-beef"}, "media_file.id NOT IN (SELECT media_file_id FROM playlist_tracks pl LEFT JOIN playlist on pl.playlist_id = playlist.id WHERE (pl.playlist_id = ? AND playlist.public = ?))", "deadbeef-dead-beef", 1), + Entry("album annotation", criteria.Gt{"albumRating": 3}, "COALESCE(album_annotation.rating, 0) > ?", 3), + Entry("artist annotation", criteria.Is{"artistLoved": true}, "COALESCE(artist_annotation.starred, false) = ?", true), + Entry("tag is", criteria.Is{"genre": "Rock"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value = ?)", "Rock"), + Entry("tag is not", criteria.IsNot{"genre": "Rock"}, "not exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value = ?)", "Rock"), + Entry("tag contains", criteria.Contains{"genre": "Rock"}, "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), + Entry("tag not contains", criteria.NotContains{"genre": "Rock"}, "not exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and value LIKE ?)", "%Rock%"), + Entry("numeric tag", criteria.Lt{"rate": 6}, "exists (select 1 from json_tree(media_file.tags, '$.rate') where key='value' and CAST(value AS REAL) < ?)", 6), + Entry("tag alias", criteria.Is{"albumtype": "album"}, "exists (select 1 from json_tree(media_file.tags, '$.releasetype') where key='value' and value = ?)", "album"), + Entry("field alias via tag registration", criteria.Is{"recordingdate": "2024-01-01"}, "media_file.date = ?", "2024-01-01"), + Entry("role is", criteria.Is{"artist": "u2"}, "exists (select 1 from media_file_artists mfa join artist on artist.id = mfa.artist_id where mfa.media_file_id = media_file.id and mfa.role = ? and artist.name = ?)", "artist", "u2"), + Entry("role contains", criteria.Contains{"composer": "Lennon"}, "exists (select 1 from media_file_artists mfa join artist on artist.id = mfa.artist_id where mfa.media_file_id = media_file.id and mfa.role = ? and artist.name LIKE ?)", "composer", "%Lennon%"), + Entry("role not contains", criteria.NotContains{"artist": "u2"}, "not exists (select 1 from media_file_artists mfa join artist on artist.id = mfa.artist_id where mfa.media_file_id = media_file.id and mfa.role = ? and artist.name LIKE ?)", "artist", "%u2%"), + // ReplayGain fields + Entry("rgAlbumGain is", criteria.Is{"rgAlbumGain": 0}, "media_file.rg_album_gain = ?", 0), + Entry("rgAlbumGain gt", criteria.Gt{"rgAlbumGain": -6.0}, "media_file.rg_album_gain > ?", -6.0), + Entry("rgTrackPeak lt", criteria.Lt{"rgTrackPeak": 1.0}, "media_file.rg_track_peak < ?", 1.0), + // isMissing — tags + Entry("isMissing tag [true]", criteria.IsMissing{"genre": true}, + "not exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value')"), + Entry("isMissing tag [false]", criteria.IsMissing{"genre": false}, + "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value')"), + // isMissing — roles + Entry("isMissing role [true]", criteria.IsMissing{"artist": true}, + "not exists (select 1 from media_file_artists mfa where mfa.media_file_id = media_file.id and mfa.role = ?)", "artist"), + Entry("isMissing role [false]", criteria.IsMissing{"artist": false}, + "exists (select 1 from media_file_artists mfa where mfa.media_file_id = media_file.id and mfa.role = ?)", "artist"), + // isPresent — tags + Entry("isPresent tag [true]", criteria.IsPresent{"genre": true}, + "exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value')"), + Entry("isPresent tag [false]", criteria.IsPresent{"genre": false}, + "not exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value')"), + // isPresent — roles + Entry("isPresent role [true]", criteria.IsPresent{"composer": true}, + "exists (select 1 from media_file_artists mfa where mfa.media_file_id = media_file.id and mfa.role = ?)", "composer"), + Entry("isPresent role [false]", criteria.IsPresent{"composer": false}, + "not exists (select 1 from media_file_artists mfa where mfa.media_file_id = media_file.id and mfa.role = ?)", "composer"), + ) + + Describe("playlist permissions", func() { + It("allows public or same-owner playlist references for regular users", func() { + sqlizer, err := newSmartPlaylistCriteria( + criteria.Criteria{Expression: criteria.InPlaylist{"id": "deadbeef-dead-beef"}}, + withSmartPlaylistOwner(model.User{ID: "owner-id", IsAdmin: false}), + ).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal("media_file.id IN (SELECT media_file_id FROM playlist_tracks pl LEFT JOIN playlist on pl.playlist_id = playlist.id WHERE (pl.playlist_id = ? AND (playlist.public = ? OR playlist.owner_id = ?)))")) + Expect(args).To(HaveExactElements("deadbeef-dead-beef", 1, "owner-id")) + }) + + It("allows all playlist references for admins", func() { + sqlizer, err := newSmartPlaylistCriteria( + criteria.Criteria{Expression: criteria.InPlaylist{"id": "deadbeef-dead-beef"}}, + withSmartPlaylistOwner(model.User{ID: "admin-id", IsAdmin: true}), + ).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal("media_file.id IN (SELECT media_file_id FROM playlist_tracks pl LEFT JOIN playlist on pl.playlist_id = playlist.id WHERE (pl.playlist_id = ?))")) + Expect(args).To(HaveExactElements("deadbeef-dead-beef")) + }) + }) + + It("builds relative date expressions", func() { + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.InTheLast{"lastPlayed": 30}}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal("annotation.play_date > ?")) + Expect(args).To(HaveExactElements(startOfPeriod(30, time.Now()))) + }) + + It("builds negated relative date expressions", func() { + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.NotInTheLast{"lastPlayed": 30}}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal("(annotation.play_date < ? OR annotation.play_date IS NULL)")) + Expect(args).To(HaveExactElements(startOfPeriod(30, time.Now()))) + }) + + It("returns an error for unknown fields", func() { + _, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.EndsWith{"unknown": "value"}}).Where() + + Expect(err).To(MatchError("invalid field in criteria: unknown")) + }) + + It("returns an error when isMissing is used with a regular field", func() { + _, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.IsMissing{"year": true}}).Where() + Expect(err).To(MatchError(ContainSubstring("isMissing/isPresent operator is only supported for tag and role fields"))) + }) + + It("returns an error when isPresent is used with a regular field", func() { + _, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.IsPresent{"title": true}}).Where() + Expect(err).To(MatchError(ContainSubstring("isMissing/isPresent operator is only supported for tag and role fields"))) + }) + + It("returns an error when isMissing has a non-boolean value", func() { + _, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: criteria.IsMissing{"genre": "hello"}}).Where() + Expect(err).To(MatchError(ContainSubstring("invalid boolean value for 'missing' expression"))) + }) + + Describe("sort", func() { + It("sorts by regular fields", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "title"}).OrderBy()).To(Equal("media_file.title asc")) + }) + + It("sorts by tag fields", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "genre"}).OrderBy()).To(Equal("COALESCE(json_extract(media_file.tags, '$.genre[0].value'), '') asc")) + }) + + It("sorts by role fields", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "artist"}).OrderBy()).To(Equal("COALESCE(json_extract(media_file.participants, '$.artist[0].name'), '') asc")) + }) + + It("casts numeric tags when sorting", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "rate"}).OrderBy()).To(Equal("CAST(COALESCE(json_extract(media_file.tags, '$.rate[0].value'), '') AS REAL) asc")) + }) + + It("sorts by albumtype alias", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "albumtype"}).OrderBy()).To(Equal("COALESCE(json_extract(media_file.tags, '$.releasetype[0].value'), '') asc")) + }) + + It("sorts by random", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "random"}).OrderBy()).To(Equal("random() asc")) + }) + + It("sorts by multiple fields", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "title,-rating"}).OrderBy()).To(Equal("media_file.title asc, COALESCE(annotation.rating, 0) desc")) + }) + + It("reverts order when order is desc", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "-date,artist", Order: "desc"}).OrderBy()).To(Equal("media_file.date asc, COALESCE(json_extract(media_file.participants, '$.artist[0].name'), '') desc")) + }) + + It("ignores invalid sort fields", func() { + Expect(newSmartPlaylistCriteria(criteria.Criteria{Sort: "bogus,title"}).OrderBy()).To(Equal("media_file.title asc")) + }) + }) + + It("has SQL mappings for all non-tag/non-role criteria fields", func() { + for _, name := range criteria.AllFieldNames() { + info, ok := criteria.LookupField(name) + Expect(ok).To(BeTrue(), "field %q registered but LookupField fails", name) + if info.IsTag || info.IsRole { + continue + } + _, hasSQLField := smartPlaylistFields[info.Name()] + Expect(hasSQLField).To(BeTrue(), "criteria field %q (name=%q) has no entry in smartPlaylistFields", name, info.Name()) + } + }) + + Describe("JSON condition merging", func() { + It("merges multiple role conditions in an OR group into a single EXISTS", func() { + expr := criteria.Any{ + criteria.Contains{"artist": "Beatles"}, + criteria.Contains{"artist": "Kraftwerk"}, + criteria.Contains{"artist": "Pink Floyd"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal("(exists (select 1 from media_file_artists mfa join artist on artist.id = mfa.artist_id where mfa.media_file_id = media_file.id and mfa.role = ? and (artist.name LIKE ? OR artist.name LIKE ? OR artist.name LIKE ?)))")) + Expect(args).To(HaveExactElements("artist", "%Beatles%", "%Kraftwerk%", "%Pink Floyd%")) + }) + + It("does not merge role conditions from different roles", func() { + expr := criteria.Any{ + criteria.Contains{"artist": "Beatles"}, + criteria.Contains{"composer": "Lennon"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, _, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("mfa.role = ?")) + // Two separate EXISTS since roles differ + Expect(strings.Count(sql, "exists")).To(Equal(2)) + }) + + It("does not merge negated role conditions", func() { + expr := criteria.Any{ + criteria.NotContains{"artist": "Beatles"}, + criteria.NotContains{"artist": "Kraftwerk"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, _, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Two separate "not exists" since they are negated + Expect(strings.Count(sql, "not exists")).To(Equal(2)) + }) + + It("batches large groups to avoid SQLite expression tree depth limit", func() { + // Create jsonCondBatchSize + 1 conditions to trigger batching into 2 groups + anyExprs := make(criteria.Any, jsonCondBatchSize+1) + for i := range anyExprs { + anyExprs[i] = criteria.Contains{"artist": fmt.Sprintf("Artist%d", i)} + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: anyExprs}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Should produce 2 EXISTS subqueries (one batch of jsonCondBatchSize, one of 1) + Expect(strings.Count(sql, "exists")).To(Equal(2)) + // First batch has jsonCondBatchSize patterns, second has 1 => total args: + // 2 roles + (jsonCondBatchSize + 1) patterns + Expect(args).To(HaveLen(2 + jsonCondBatchSize + 1)) + }) + + It("merges role conditions while preserving non-role conditions", func() { + expr := criteria.Any{ + criteria.Contains{"title": "Love"}, + criteria.Contains{"artist": "Beatles"}, + criteria.Contains{"artist": "Kraftwerk"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("media_file.title LIKE ?")) + Expect(sql).To(ContainSubstring("artist.name LIKE ? OR artist.name LIKE ?")) + Expect(args).To(HaveExactElements("%Love%", "artist", "%Beatles%", "%Kraftwerk%")) + }) + + It("merges multiple tag conditions in an OR group into a single EXISTS", func() { + expr := criteria.Any{ + criteria.Contains{"genre": "Rock"}, + criteria.Contains{"genre": "Metal"}, + criteria.Contains{"genre": "Punk"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal("(exists (select 1 from json_tree(media_file.tags, '$.genre') where key='value' and (value LIKE ? OR value LIKE ? OR value LIKE ?)))")) + Expect(args).To(HaveExactElements("%Rock%", "%Metal%", "%Punk%")) + }) + + It("does not merge tag conditions from different tags", func() { + expr := criteria.Any{ + criteria.Contains{"genre": "Rock"}, + criteria.Contains{"mood": "Happy"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, _, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(strings.Count(sql, "exists")).To(Equal(2)) + }) + + It("does not merge negated tag conditions", func() { + expr := criteria.Any{ + criteria.NotContains{"genre": "Rock"}, + criteria.NotContains{"genre": "Metal"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, _, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(strings.Count(sql, "not exists")).To(Equal(2)) + }) + + It("merges role and tag conditions independently", func() { + expr := criteria.Any{ + criteria.Contains{"artist": "Beatles"}, + criteria.Contains{"artist": "Kraftwerk"}, + criteria.Contains{"genre": "Rock"}, + criteria.Contains{"genre": "Metal"}, + } + sqlizer, err := newSmartPlaylistCriteria(criteria.Criteria{Expression: expr}).Where() + Expect(err).ToNot(HaveOccurred()) + + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Two merged EXISTS: one for roles, one for tags + Expect(strings.Count(sql, "exists")).To(Equal(2)) + Expect(sql).To(ContainSubstring("artist.name LIKE ? OR artist.name LIKE ?")) + Expect(sql).To(ContainSubstring("value LIKE ? OR value LIKE ?")) + Expect(args).To(HaveLen(2 + 2 + 1)) // 2 tag patterns + 2 role patterns + 1 role name + }) + }) + + Describe("joins", func() { + It("excludes sort-only joins from expression joins", func() { + c := criteria.Criteria{Expression: criteria.All{criteria.Contains{"title": "love"}}, Sort: "albumRating"} + cSQL := newSmartPlaylistCriteria(c) + + Expect(cSQL.ExpressionJoins()).To(Equal(smartPlaylistJoinNone)) + Expect(cSQL.RequiredJoins().has(smartPlaylistJoinAlbumAnnotation)).To(BeTrue()) + }) + + It("includes expression-based joins", func() { + c := criteria.Criteria{Expression: criteria.All{criteria.Gt{"albumRating": 3}}} + + Expect(newSmartPlaylistCriteria(c).ExpressionJoins().has(smartPlaylistJoinAlbumAnnotation)).To(BeTrue()) + }) + + It("detects nested album and artist joins", func() { + c := criteria.Criteria{Expression: criteria.All{ + criteria.Any{criteria.All{criteria.Is{"albumLoved": true}}}, + criteria.Any{criteria.Gt{"artistPlayCount": 10}}, + }} + + joins := newSmartPlaylistCriteria(c).RequiredJoins() + Expect(joins.has(smartPlaylistJoinAlbumAnnotation)).To(BeTrue()) + Expect(joins.has(smartPlaylistJoinArtistAnnotation)).To(BeTrue()) + }) + + It("detects join types from sort fields with direction prefixes", func() { + c := criteria.Criteria{Expression: criteria.All{criteria.Contains{"title": "love"}}, Sort: "-artistRating"} + + Expect(newSmartPlaylistCriteria(c).RequiredJoins().has(smartPlaylistJoinArtistAnnotation)).To(BeTrue()) + }) + }) +}) diff --git a/persistence/e2e/e2e_suite_test.go b/persistence/e2e/e2e_suite_test.go new file mode 100644 index 000000000..f42292f02 --- /dev/null +++ b/persistence/e2e/e2e_suite_test.go @@ -0,0 +1,345 @@ +package e2e + +import ( + "context" + "encoding/json" + "os" + "path/filepath" + "sort" + "testing" + "testing/fstest" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestSmartPlaylistE2E(t *testing.T) { + tests.Init(t, false) + defer db.Close(t.Context()) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Smart Playlist E2E Suite") +} + +type _t = map[string]any + +var template = storagetest.Template +var track = storagetest.Track + +var ( + ctx context.Context + ds *tests.MockDataStore + lib model.Library + + dbFilePath string + snapshotPath string + snapshotTables []string + + adminUser = model.User{ + ID: "sp-test-user-1", + UserName: "sptestuser", + Name: "SP Test User", + IsAdmin: true, + } + + regularUser = model.User{ + ID: "sp-test-user-2", + UserName: "spotheruser", + Name: "SP Other User", + IsAdmin: false, + } +) + +func buildTestFS() { + abbeyRoad := template(_t{ + "albumartist": "The Beatles", + "artist": "The Beatles", + "album": "Abbey Road", + "year": 1969, + "genre": "Rock;Blues", + }) + ledZepIV := template(_t{ + "albumartist": "Led Zeppelin", + "artist": "Led Zeppelin", + "album": "IV", + "year": 1971, + }) + kindOfBlue := template(_t{ + "albumartist": "Miles Davis", + "artist": "Miles Davis", + "album": "Kind of Blue", + "year": 1959, + "genre": "Jazz", + "composer": "Miles Davis", + }) + nightAtOpera := template(_t{ + "albumartist": "Queen", + "artist": "Queen", + "album": "A Night at the Opera", + "year": 1975, + "genre": "Rock", + }) + electricLadyland := template(_t{ + "albumartist": "Jimi Hendrix", + "artist": "Jimi Hendrix", + "album": "Electric Ladyland", + "year": 1968, + "genre": "Rock;Blues", + }) + newsOfWorld := template(_t{ + "albumartist": "Queen", + "artist": "Queen", + "album": "News of the World", + "year": 1977, + "genre": "Rock;Pop", + "compilation": "1", + }) + + fs := storagetest.FakeFS{} + fs.SetFiles(fstest.MapFS{ + "Rock/The Beatles/Abbey Road/01 - Come Together.mp3": abbeyRoad(track(1, "Come Together", + _t{"genre": "Rock;Blues", "composer": "Lennon/McCartney", "bpm": 120, "grouping": "Beatles Tracks"})), + "Rock/The Beatles/Abbey Road/02 - Something.mp3": abbeyRoad(track(2, "Something", + _t{"genre": "Rock", "composer": "Harrison", "bpm": 100, "grouping": "Beatles Tracks"})), + "Rock/Led Zeppelin/IV/01 - Stairway To Heaven.flac": ledZepIV(track(1, "Stairway To Heaven", + _t{"genre": "Rock;Folk", "composer": "Page/Plant", "bpm": 82, "suffix": "flac", + "bitrate": 900, "samplerate": 44100, "bitdepth": 16})), + "Rock/Led Zeppelin/IV/02 - Black Dog.flac": ledZepIV(track(2, "Black Dog", + _t{"genre": "Rock;Blues", "composer": "Page/Plant/Jones", "bpm": 150, "suffix": "flac", + "bitrate": 900, "samplerate": 44100, "bitdepth": 16})), + "Jazz/Miles Davis/Kind of Blue/01 - So What.mp3": kindOfBlue(track(1, "So What", + _t{"bpm": 136})), + "Rock/Queen/A Night at the Opera/01 - Bohemian Rhapsody.mp3": nightAtOpera(track(1, "Bohemian Rhapsody", + _t{"composer": "Freddie Mercury", "bpm": 72})), + "Rock/Jimi Hendrix/Electric Ladyland/01 - All Along the Watchtower.mp3": electricLadyland(track(1, "All Along the Watchtower", + _t{"composer": "Bob Dylan", "bpm": 112})), + "Rock/Queen/News of the World/01 - We Are the Champions.mp3": newsOfWorld(track(1, "We Are the Champions", + _t{"composer": "Freddie Mercury", "bpm": 64})), + }) + storagetest.Register("fake", &fs) +} + +func findMediaFileByTitle(title string) string { + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"media_file.title": title}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1), "expected exactly one media file with title %q", title) + return mfs[0].ID +} + +func evaluateRule(jsonRule string) []string { + titles := evaluateRuleOrderedAs(adminUser, jsonRule) + sort.Strings(titles) + return titles +} + +func evaluateRuleOrdered(jsonRule string) []string { + return evaluateRuleOrderedAs(adminUser, jsonRule) +} + +func evaluateRuleAs(owner model.User, jsonRule string) []string { + titles := evaluateRuleOrderedAs(owner, jsonRule) + sort.Strings(titles) + return titles +} + +func evaluateRuleOrderedAs(owner model.User, jsonRule string) []string { + userCtx := request.WithUser(GinkgoT().Context(), owner) + var rules criteria.Criteria + err := json.Unmarshal([]byte(jsonRule), &rules) + Expect(err).ToNot(HaveOccurred(), "invalid criteria JSON: %s", jsonRule) + + pls := &model.Playlist{ + Name: "test-smart-playlist", + OwnerID: owner.ID, + Rules: &rules, + } + err = ds.Playlist(userCtx).Put(pls) + Expect(err).ToNot(HaveOccurred()) + + loaded, err := ds.Playlist(userCtx).GetWithTracks(pls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + titles := make([]string, len(loaded.Tracks)) + for i, t := range loaded.Tracks { + titles[i] = t.Title + } + return titles +} + +func createPlaylist(owner model.User, public bool, titles ...string) string { + pls := &model.Playlist{ + Name: "ref-playlist", + OwnerID: owner.ID, + Public: public, + } + for _, title := range titles { + mfID := findMediaFileByTitle(title) + pls.AddMediaFilesByID([]string{mfID}) + } + Expect(ds.Playlist(ctx).Put(pls)).To(Succeed()) + return pls.ID +} + +func createPublicPlaylist(owner model.User, titles ...string) string { + return createPlaylist(owner, true, titles...) +} + +func createPrivatePlaylist(owner model.User, titles ...string) string { + return createPlaylist(owner, false, titles...) +} + +func createPublicSmartPlaylist(owner model.User, jsonRule string) string { + return createSmartPlaylist(owner, true, jsonRule) +} + +func createPrivateSmartPlaylist(owner model.User, jsonRule string) string { + return createSmartPlaylist(owner, false, jsonRule) +} + +func createSmartPlaylist(owner model.User, public bool, jsonRule string) string { + var rules criteria.Criteria + Expect(json.Unmarshal([]byte(jsonRule), &rules)).To(Succeed()) + pls := &model.Playlist{ + Name: "ref-smart-playlist", + OwnerID: owner.ID, + Public: public, + Rules: &rules, + } + Expect(ds.Playlist(ctx).Put(pls)).To(Succeed()) + return pls.ID +} + +var _ = BeforeSuite(func() { + ctx = request.WithUser(GinkgoT().Context(), adminUser) + tmpDir := GinkgoT().TempDir() + dbFilePath = filepath.Join(tmpDir, "smartplaylist-e2e.db") + snapshotPath = filepath.Join(tmpDir, "smartplaylist-e2e.db.snapshot") + conf.Server.DbPath = dbFilePath + "?_journal_mode=WAL" + db.Db().SetMaxOpenConns(1) + + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + conf.Server.SmartPlaylistRefreshDelay = 0 + + db.Init(ctx) + + initDS := &tests.MockDataStore{RealDS: persistence.New(db.Db())} + + userWithPass := adminUser + userWithPass.NewPassword = "password" + Expect(initDS.User(ctx).Put(&userWithPass)).To(Succeed()) + + regularUserWithPass := regularUser + regularUserWithPass.NewPassword = "password" + Expect(initDS.User(ctx).Put(®ularUserWithPass)).To(Succeed()) + + lib = model.Library{ID: 1, Name: "Music Library", Path: "fake:///music"} + Expect(initDS.Library(ctx).Put(&lib)).To(Succeed()) + Expect(initDS.User(ctx).SetUserLibraries(adminUser.ID, []int{lib.ID})).To(Succeed()) + Expect(initDS.User(ctx).SetUserLibraries(regularUser.ID, []int{lib.ID})).To(Succeed()) + + loadedUser, err := initDS.User(ctx).FindByUsername(adminUser.UserName) + Expect(err).ToNot(HaveOccurred()) + adminUser.Libraries = loadedUser.Libraries + + loadedOther, err := initDS.User(ctx).FindByUsername(regularUser.UserName) + Expect(err).ToNot(HaveOccurred()) + regularUser.Libraries = loadedOther.Libraries + + ctx = request.WithUser(GinkgoT().Context(), adminUser) + + buildTestFS() + s := scanner.New(ctx, initDS, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(initDS, core.NewImageUploadService()), metrics.NewNoopInstance()) + _, err = s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + + ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} + + comeTogetherID := findMediaFileByTitle("Come Together") + Expect(ds.MediaFile(ctx).SetStar(true, comeTogetherID)).To(Succeed()) + Expect(ds.MediaFile(ctx).SetStar(true, findMediaFileByTitle("So What"))).To(Succeed()) + Expect(ds.MediaFile(ctx).SetRating(3, findMediaFileByTitle("Stairway To Heaven"))).To(Succeed()) + Expect(ds.MediaFile(ctx).SetRating(5, findMediaFileByTitle("Bohemian Rhapsody"))).To(Succeed()) + for range 10 { + Expect(ds.MediaFile(ctx).IncPlayCount(comeTogetherID, time.Now())).To(Succeed()) + } + Expect(ds.MediaFile(ctx).IncPlayCount(findMediaFileByTitle("Black Dog"), time.Now())).To(Succeed()) + + rows, err := db.Db().Query("SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%' AND name NOT LIKE '%_fts' AND name NOT LIKE '%_fts_%'") + Expect(err).ToNot(HaveOccurred()) + defer rows.Close() + for rows.Next() { + var name string + Expect(rows.Scan(&name)).To(Succeed()) + snapshotTables = append(snapshotTables, name) + } + Expect(rows.Err()).ToNot(HaveOccurred()) + + _, err = db.Db().Exec("PRAGMA wal_checkpoint(TRUNCATE)") + Expect(err).ToNot(HaveOccurred()) + data, err := os.ReadFile(dbFilePath) + Expect(err).ToNot(HaveOccurred()) + Expect(os.WriteFile(snapshotPath, data, 0600)).To(Succeed()) +}) + +var _ = AfterSuite(func() { + db.Close(ctx) +}) + +func restoreDB() { + sqlDB := db.Db() + + _, err := sqlDB.Exec("PRAGMA foreign_keys = OFF") + Expect(err).ToNot(HaveOccurred()) + defer func() { _, _ = sqlDB.Exec("PRAGMA foreign_keys = ON") }() + + _, err = sqlDB.Exec("ATTACH DATABASE ? AS snapshot", snapshotPath) + Expect(err).ToNot(HaveOccurred()) + defer func() { _, _ = sqlDB.Exec("DETACH DATABASE snapshot") }() + + _, err = sqlDB.Exec("BEGIN TRANSACTION") + Expect(err).ToNot(HaveOccurred()) + defer func() { _, _ = sqlDB.Exec("ROLLBACK") }() + + for _, table := range snapshotTables { + _, err = sqlDB.Exec(`DELETE FROM main."` + table + `"`) //nolint:gosec + Expect(err).ToNot(HaveOccurred()) + _, err = sqlDB.Exec(`INSERT INTO main."` + table + `" SELECT * FROM snapshot."` + table + `"`) //nolint:gosec + Expect(err).ToNot(HaveOccurred()) + } + + _, err = sqlDB.Exec("COMMIT") + Expect(err).ToNot(HaveOccurred()) +} + +func setupTestDB() { + ctx = request.WithUser(GinkgoT().Context(), adminUser) + DeferCleanup(configtest.SetupConfig()) + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + conf.Server.SmartPlaylistRefreshDelay = 0 + + restoreDB() + ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} +} diff --git a/persistence/e2e/smartplaylist_test.go b/persistence/e2e/smartplaylist_test.go new file mode 100644 index 000000000..a844dc982 --- /dev/null +++ b/persistence/e2e/smartplaylist_test.go @@ -0,0 +1,374 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/sirupsen/logrus" +) + +var _ = Describe("Smart Playlists", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("String fields", func() { + It("matches by exact title", func() { + results := evaluateRule(`{"all":[{"is":{"title":"Something"}}]}`) + Expect(results).To(ConsistOf("Something")) + }) + + It("matches by title contains", func() { + results := evaluateRule(`{"all":[{"contains":{"title":"the"}}]}`) + Expect(results).To(ConsistOf("Come Together", "All Along the Watchtower", "We Are the Champions")) + }) + + It("matches by artist startsWith", func() { + results := evaluateRule(`{"all":[{"startsWith":{"artist":"Led"}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog")) + }) + + It("matches by title isNot", func() { + results := evaluateRule(`{"all":[{"isNot":{"title":"Something"}},{"is":{"artist":"The Beatles"}}]}`) + Expect(results).To(ConsistOf("Come Together")) + }) + + It("matches by artist endsWith", func() { + results := evaluateRule(`{"all":[{"endsWith":{"artist":"Davis"}}]}`) + Expect(results).To(ConsistOf("So What")) + }) + }) + + Describe("Numeric fields", func() { + It("matches by year greater than", func() { + results := evaluateRule(`{"all":[{"gt":{"year":1970}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog", "Bohemian Rhapsody", "We Are the Champions")) + }) + + It("matches by year less than", func() { + results := evaluateRule(`{"all":[{"lt":{"year":1969}}]}`) + Expect(results).To(ConsistOf("So What", "All Along the Watchtower")) + }) + + It("matches by BPM in range", func() { + results := evaluateRule(`{"all":[{"inTheRange":{"bpm":[100,130]}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "All Along the Watchtower")) + }) + }) + + Describe("Boolean fields", func() { + It("matches compilations", func() { + results := evaluateRule(`{"all":[{"is":{"compilation":true}}]}`) + Expect(results).To(ConsistOf("We Are the Champions")) + }) + + It("matches non-compilations", func() { + results := evaluateRule(`{"all":[{"is":{"compilation":false}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", "So What", "Bohemian Rhapsody", "All Along the Watchtower")) + }) + }) + + Describe("File type fields", func() { + It("matches by filetype", func() { + results := evaluateRule(`{"all":[{"is":{"filetype":"flac"}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog")) + }) + }) + + Describe("Multi-valued tags", func() { + It("matches tracks with Blues genre", func() { + results := evaluateRule(`{"all":[{"is":{"genre":"Blues"}}]}`) + Expect(results).To(ConsistOf("Come Together", "Black Dog", "All Along the Watchtower")) + }) + + It("excludes tracks with Rock genre", func() { + results := evaluateRule(`{"all":[{"isNot":{"genre":"Rock"}}]}`) + Expect(results).To(ConsistOf("So What")) + }) + + It("matches genre contains", func() { + results := evaluateRule(`{"all":[{"contains":{"genre":"ol"}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven")) + }) + + It("matches tracks with Pop genre", func() { + results := evaluateRule(`{"all":[{"is":{"genre":"Pop"}}]}`) + Expect(results).To(ConsistOf("We Are the Champions")) + }) + + It("matches genre startsWith", func() { + results := evaluateRule(`{"all":[{"startsWith":{"genre":"Ro"}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", + "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + }) + + Describe("Participants", func() { + It("matches by exact composer", func() { + results := evaluateRule(`{"all":[{"is":{"composer":"Harrison"}}]}`) + Expect(results).To(ConsistOf("Something")) + }) + + It("matches by composer contains", func() { + results := evaluateRule(`{"all":[{"contains":{"composer":"Plant"}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog")) + }) + + It("matches by composer isNot", func() { + results := evaluateRule(`{"all":[{"isNot":{"composer":"Freddie Mercury"}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", "So What", "All Along the Watchtower")) + }) + + It("matches by composer endsWith", func() { + results := evaluateRule(`{"all":[{"endsWith":{"composer":"Mercury"}}]}`) + Expect(results).To(ConsistOf("Bohemian Rhapsody", "We Are the Champions")) + }) + }) + + Describe("Annotations", func() { + It("matches starred tracks", func() { + results := evaluateRule(`{"all":[{"is":{"loved":true}}]}`) + Expect(results).To(ConsistOf("Come Together", "So What")) + }) + + It("matches unstarred tracks", func() { + results := evaluateRule(`{"all":[{"is":{"loved":false}}]}`) + Expect(results).To(ConsistOf("Something", "Stairway To Heaven", "Black Dog", "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("matches by rating greater than", func() { + results := evaluateRule(`{"all":[{"gt":{"rating":3}}]}`) + Expect(results).To(ConsistOf("Bohemian Rhapsody")) + }) + + It("matches by rating greater than or equal via inTheRange", func() { + results := evaluateRule(`{"all":[{"inTheRange":{"rating":[3,5]}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Bohemian Rhapsody")) + }) + + It("matches by play count greater than", func() { + results := evaluateRule(`{"all":[{"gt":{"playcount":5}}]}`) + Expect(results).To(ConsistOf("Come Together")) + }) + + It("matches by play count greater than zero", func() { + results := evaluateRule(`{"all":[{"gt":{"playcount":0}}]}`) + Expect(results).To(ConsistOf("Come Together", "Black Dog")) + }) + }) + + Describe("Negated string operators", func() { + It("matches by title notContains", func() { + results := evaluateRule(`{"all":[{"notContains":{"title":"the"}}]}`) + Expect(results).To(ConsistOf("Something", "Stairway To Heaven", "Black Dog", "So What", "Bohemian Rhapsody")) + }) + }) + + Describe("Date/time fields", func() { + It("matches dateAdded before a far-future date", func() { + results := evaluateRule(`{"all":[{"before":{"dateadded":"2099-01-01"}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", + "So What", "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("matches lastPlayed inTheLast 1 day", func() { + results := evaluateRule(`{"all":[{"inTheLast":{"lastplayed":1}}]}`) + Expect(results).To(ConsistOf("Come Together", "Black Dog")) + }) + + It("matches lastPlayed notInTheLast (far future)", func() { + results := evaluateRule(`{"all":[{"notInTheLast":{"lastplayed":99999}}]}`) + Expect(results).To(ConsistOf("Something", "Stairway To Heaven", "So What", + "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("matches dateLoved after a past date", func() { + results := evaluateRule(`{"all":[{"after":{"dateloved":"2020-01-01"}}]}`) + Expect(results).To(ConsistOf("Come Together", "So What")) + }) + + It("matches dateRated after a past date", func() { + results := evaluateRule(`{"all":[{"after":{"daterated":"2020-01-01"}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Bohemian Rhapsody")) + }) + + It("matches dateAdded inTheLast 1 day", func() { + results := evaluateRule(`{"all":[{"inTheLast":{"dateadded":1}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", + "So What", "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("resolves recordingdate alias to the date column", func() { + results := evaluateRule(`{"all":[{"is":{"recordingdate":"1959"}}]}`) + Expect(results).To(ConsistOf("So What")) + }) + }) + + Describe("Logic operators", func() { + It("matches with ALL (AND)", func() { + results := evaluateRule(`{"all":[{"is":{"genre":"Blues"}},{"gt":{"bpm":130}}]}`) + Expect(results).To(ConsistOf("Black Dog")) + }) + + It("matches with ANY (OR)", func() { + results := evaluateRule(`{"any":[{"is":{"genre":"Jazz"}},{"is":{"compilation":true}}]}`) + Expect(results).To(ConsistOf("So What", "We Are the Champions")) + }) + + It("matches nested all/any", func() { + results := evaluateRule(`{"all":[{"any":[{"is":{"genre":"Blues"}},{"is":{"genre":"Jazz"}}]},{"gt":{"year":1960}}]}`) + Expect(results).To(ConsistOf("Come Together", "Black Dog", "All Along the Watchtower")) + }) + }) + + Describe("Sorting and limits", func() { + It("returns tracks sorted by year descending with limit", func() { + results := evaluateRuleOrdered(`{"all":[{"gt":{"year":0}}],"sort":"year","order":"desc","limit":2}`) + Expect(results).To(Equal([]string{"We Are the Champions", "Bohemian Rhapsody"})) + }) + + It("returns tracks sorted by title ascending", func() { + results := evaluateRuleOrdered(`{"all":[{"is":{"genre":"Blues"}}],"sort":"title","order":"asc"}`) + Expect(results).To(Equal([]string{"All Along the Watchtower", "Black Dog", "Come Together"})) + }) + }) + + Describe("Combined real-world patterns", func() { + It("matches genre filter with exclusion and year range", func() { + results := evaluateRuleOrdered(`{ + "all":[ + {"any":[ + {"is":{"genre":"Blues"}}, + {"is":{"genre":"Folk"}} + ]}, + {"isNot":{"genre":"Jazz"}}, + {"gt":{"year":1965}} + ], + "sort":"-year,title" + }`) + Expect(results).To(Equal([]string{"Black Dog", "Stairway To Heaven", "Come Together", "All Along the Watchtower"})) + }) + }) + + Describe("Playlist operators", func() { + It("matches tracks in a public regular playlist", func() { + refID := createPublicPlaylist(adminUser, "Come Together", "So What") + results := evaluateRuleAs(regularUser, `{"all":[{"inPlaylist":{"id":"`+refID+`"}}]}`) + Expect(results).To(ConsistOf("Come Together", "So What")) + }) + + It("matches tracks not in a public regular playlist", func() { + refID := createPublicPlaylist(adminUser, "Come Together", "So What") + results := evaluateRuleAs(regularUser, `{"all":[{"notInPlaylist":{"id":"`+refID+`"}}]}`) + Expect(results).To(ConsistOf("Something", "Stairway To Heaven", "Black Dog", + "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("recursively refreshes a referenced smart playlist owned by the same user", func() { + smartBID := createPublicSmartPlaylist(adminUser, `{"all":[{"is":{"genre":"Jazz"}}]}`) + results := evaluateRuleAs(adminUser, `{"all":[{"inPlaylist":{"id":"`+smartBID+`"}}]}`) + Expect(results).To(ConsistOf("So What")) + }) + + It("does not refresh a referenced smart playlist owned by another user", func() { + smartBID := createPublicSmartPlaylist(regularUser, `{"all":[{"is":{"genre":"Jazz"}}]}`) + results := evaluateRuleAs(adminUser, `{"all":[{"inPlaylist":{"id":"`+smartBID+`"}}]}`) + Expect(results).To(BeEmpty()) + }) + + It("does not refresh a playlist or its children when an admin views another user's smart playlist", func() { + smartBID := createPrivateSmartPlaylist(adminUser, `{"all":[{"is":{"genre":"Jazz"}}]}`) + smartAID := createPublicSmartPlaylist(regularUser, `{"all":[{"inPlaylist":{"id":"`+smartBID+`"}}]}`) + + loadedA, err := ds.Playlist(ctx).GetWithTracks(smartAID, true, false) + Expect(err).ToNot(HaveOccurred()) + Expect(loadedA.Tracks).To(BeEmpty()) + Expect(loadedA.EvaluatedAt).To(BeNil()) + + loadedB, err := ds.Playlist(ctx).Get(smartBID) + Expect(err).ToNot(HaveOccurred()) + Expect(loadedB.EvaluatedAt).To(BeNil()) + }) + + It("matches tracks from a private playlist owned by the same user", func() { + refID := createPrivatePlaylist(regularUser, "Come Together", "So What") + results := evaluateRuleAs(regularUser, `{"all":[{"inPlaylist":{"id":"`+refID+`"}}]}`) + Expect(results).To(ConsistOf("Come Together", "So What")) + }) + + It("allows admin-owned smart playlists to reference private playlists owned by other users", func() { + refID := createPrivatePlaylist(regularUser, "Bohemian Rhapsody") + results := evaluateRuleAs(adminUser, `{"all":[{"inPlaylist":{"id":"`+refID+`"}}]}`) + Expect(results).To(ConsistOf("Bohemian Rhapsody")) + }) + + It("does not match tracks from a private playlist owned by another regular user", func() { + refID := createPrivatePlaylist(adminUser, "Come Together", "So What") + results := evaluateRuleAs(regularUser, `{"all":[{"inPlaylist":{"id":"`+refID+`"}}]}`) + Expect(results).To(BeEmpty()) + }) + + It("warns when a referenced playlist is inaccessible to the smart playlist owner", func() { + hook, cleanup := tests.LogHook() + defer cleanup() + + refID := createPrivatePlaylist(adminUser, "Come Together") + results := evaluateRuleAs(regularUser, `{"all":[{"notInPlaylist":{"id":"`+refID+`"}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", + "So What", "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + + Expect(hook.LastEntry()).ToNot(BeNil()) + Expect(hook.LastEntry().Level).To(Equal(logrus.WarnLevel)) + Expect(hook.LastEntry().Message).To(Equal("Referenced playlist is not accessible to smart playlist owner")) + Expect(hook.LastEntry().Data).To(HaveKeyWithValue("childId", refID)) + }) + + It("matches tracks in a public playlist owned by another user", func() { + refID := createPublicPlaylist(adminUser, "Bohemian Rhapsody") + results := evaluateRuleAs(regularUser, `{"all":[{"inPlaylist":{"id":"`+refID+`"}}]}`) + Expect(results).To(ConsistOf("Bohemian Rhapsody")) + }) + + }) + + Describe("isMissing/isPresent operators", func() { + It("isMissing finds tracks without grouping tag", func() { + results := evaluateRule(`{"all":[{"isMissing":{"grouping":true}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog", "So What", + "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("isMissing false finds tracks with grouping tag", func() { + results := evaluateRule(`{"all":[{"isMissing":{"grouping":false}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something")) + }) + + It("isPresent finds tracks with grouping tag", func() { + results := evaluateRule(`{"all":[{"isPresent":{"grouping":true}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something")) + }) + + It("isPresent false finds tracks without grouping tag", func() { + results := evaluateRule(`{"all":[{"isPresent":{"grouping":false}}]}`) + Expect(results).To(ConsistOf("Stairway To Heaven", "Black Dog", "So What", + "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("isMissing returns all tracks for a tag nobody has", func() { + results := evaluateRule(`{"all":[{"isMissing":{"lyricist":true}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", + "So What", "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("isPresent returns all tracks for a role everyone has", func() { + results := evaluateRule(`{"all":[{"isPresent":{"composer":true}}]}`) + Expect(results).To(ConsistOf("Come Together", "Something", "Stairway To Heaven", "Black Dog", + "So What", "Bohemian Rhapsody", "All Along the Watchtower", "We Are the Champions")) + }) + + It("combines isMissing with other operators", func() { + results := evaluateRule(`{"all":[{"isMissing":{"grouping":true}},{"is":{"genre":"Blues"}}]}`) + Expect(results).To(ConsistOf("Black Dog", "All Along the Watchtower")) + }) + }) +}) diff --git a/persistence/folder_repository.go b/persistence/folder_repository.go index a8b7884b7..f7bb6a4fe 100644 --- a/persistence/folder_repository.go +++ b/persistence/folder_repository.go @@ -4,7 +4,12 @@ import ( "context" "encoding/json" "fmt" + "iter" + "maps" + "os" + "path/filepath" "slices" + "strings" "time" . "github.com/Masterminds/squirrel" @@ -61,8 +66,9 @@ func newFolderRepository(ctx context.Context, db dbx.Builder) model.FolderReposi } func (r folderRepository) selectFolder(options ...model.QueryOptions) SelectBuilder { - return r.newSelect(options...).Columns("folder.*", "library.path as library_path"). + sql := r.newSelect(options...).Columns("folder.*", "library.path as library_path"). Join("library on library.id = folder.library_id") + return r.applyLibraryFilter(sql) } func (r folderRepository) Get(id string) (*model.Folder, error) { @@ -85,23 +91,99 @@ func (r folderRepository) GetAll(opt ...model.QueryOptions) ([]model.Folder, err } func (r folderRepository) CountAll(opt ...model.QueryOptions) (int64, error) { - sq := r.newSelect(opt...).Columns("count(*)") - return r.count(sq) + query := r.newSelect(opt...).Columns("count(*)") + query = r.applyLibraryFilter(query) + return r.count(query) } -func (r folderRepository) GetLastUpdates(lib model.Library) (map[string]time.Time, error) { - sq := r.newSelect().Columns("id", "updated_at").Where(Eq{"library_id": lib.ID, "missing": false}) +func (r folderRepository) GetFolderUpdateInfo(lib model.Library, targetPaths ...string) (map[string]model.FolderUpdateInfo, error) { + // If no specific paths, return all folders in the library + if len(targetPaths) == 0 { + return r.getFolderUpdateInfoAll(lib) + } + + // Check if any path is root (return all folders) + for _, targetPath := range targetPaths { + if targetPath == "" || targetPath == "." { + return r.getFolderUpdateInfoAll(lib) + } + } + + // Process paths in batches to avoid SQLite's expression tree depth limit (max 1000). + // Each path generates ~3 conditions, so batch size of 100 keeps us well under the limit. + const batchSize = 100 + result := make(map[string]model.FolderUpdateInfo) + + for batch := range slices.Chunk(targetPaths, batchSize) { + batchResult, err := r.getFolderUpdateInfoBatch(lib, batch) + if err != nil { + return nil, err + } + maps.Copy(result, batchResult) + } + + return result, nil +} + +// getFolderUpdateInfoAll returns update info for all non-missing folders in the library +func (r folderRepository) getFolderUpdateInfoAll(lib model.Library) (map[string]model.FolderUpdateInfo, error) { + where := And{ + Eq{"library_id": lib.ID}, + Eq{"missing": false}, + } + return r.queryFolderUpdateInfo(where) +} + +// getFolderUpdateInfoBatch returns update info for a batch of target paths and their descendants +func (r folderRepository) getFolderUpdateInfoBatch(lib model.Library, targetPaths []string) (map[string]model.FolderUpdateInfo, error) { + where := And{ + Eq{"library_id": lib.ID}, + Eq{"missing": false}, + } + + // Collect folder IDs for exact target folders and path conditions for descendants + folderIDs := make([]string, 0, len(targetPaths)) + pathConditions := make(Or, 0, len(targetPaths)*2) + + for _, targetPath := range targetPaths { + // Clean the path to normalize it. Paths stored in the folder table do not have leading/trailing slashes. + cleanPath := strings.TrimPrefix(targetPath, string(os.PathSeparator)) + cleanPath = filepath.Clean(cleanPath) + + // Include the target folder itself by ID + folderIDs = append(folderIDs, model.FolderID(lib, cleanPath)) + + // Include all descendants: folders whose path field equals or starts with the target path + // Note: Folder.Path is the directory path, so children have path = targetPath + pathConditions = append(pathConditions, Eq{"path": cleanPath}) + pathConditions = append(pathConditions, Like{"path": cleanPath + "/%"}) + } + + // Combine conditions: exact folder IDs OR descendant path patterns + if len(folderIDs) > 0 { + where = append(where, Or{Eq{"id": folderIDs}, pathConditions}) + } else if len(pathConditions) > 0 { + where = append(where, pathConditions) + } + + return r.queryFolderUpdateInfo(where) +} + +// queryFolderUpdateInfo executes the query and returns the result map +func (r folderRepository) queryFolderUpdateInfo(where And) (map[string]model.FolderUpdateInfo, error) { + sq := r.newSelect().Columns("id", "updated_at", "hash").Where(where) var res []struct { ID string UpdatedAt time.Time + Hash string } err := r.queryAll(sq, &res) if err != nil { return nil, err } - m := make(map[string]time.Time, len(res)) + m := make(map[string]model.FolderUpdateInfo, len(res)) for _, f := range res { - m[f.ID] = f.UpdatedAt + m[f.ID] = model.FolderUpdateInfo{UpdatedAt: f.UpdatedAt, Hash: f.Hash} } return m, nil } @@ -137,16 +219,24 @@ func (r folderRepository) GetTouchedWithPlaylists() (model.FolderCursor, error) if err != nil { return nil, err } + return wrapFolderCursor(cursor), nil +} + +func wrapFolderCursor(cursor iter.Seq2[dbFolder, error]) model.FolderCursor { return func(yield func(model.Folder, error) bool) { for f, err := range cursor { + if f.Folder == nil { + yield(model.Folder{}, fmt.Errorf("unexpected nil folder (%v): %w", f, err)) + return + } if !yield(*f.Folder, err) || err != nil { return } } - }, nil + } } -func (r folderRepository) purgeEmpty() error { +func (r folderRepository) purgeEmpty(libraryIDs ...int) error { sq := Delete(r.tableName).Where(And{ Eq{"num_audio_files": 0}, Eq{"num_playlists": 0}, @@ -154,6 +244,10 @@ func (r folderRepository) purgeEmpty() error { ConcatExpr("id not in (select parent_id from folder)"), ConcatExpr("id not in (select folder_id from media_file)"), }) + // If libraryIDs are specified, only purge folders from those libraries + if len(libraryIDs) > 0 { + sq = sq.Where(Eq{"library_id": libraryIDs}) + } c, err := r.executeSQL(sq) if err != nil { return fmt.Errorf("purging empty folders: %w", err) diff --git a/persistence/folder_repository_test.go b/persistence/folder_repository_test.go new file mode 100644 index 000000000..ebc08fd04 --- /dev/null +++ b/persistence/folder_repository_test.go @@ -0,0 +1,259 @@ +package persistence + +import ( + "context" + "errors" + "fmt" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +var _ = Describe("FolderRepository", func() { + var repo model.FolderRepository + var ctx context.Context + var conn *dbx.DB + var testLib, otherLib model.Library + + BeforeEach(func() { + ctx = request.WithUser(log.NewContext(context.TODO()), model.User{ID: "userid"}) + conn = GetDBXBuilder() + repo = newFolderRepository(ctx, conn) + + // Use existing library ID 1 from test fixtures + libRepo := NewLibraryRepository(ctx, conn) + lib, err := libRepo.Get(1) + Expect(err).ToNot(HaveOccurred()) + testLib = *lib + + // Create a second library with its own folder to verify isolation + otherLib = model.Library{Name: "Other Library", Path: "/other/path"} + Expect(libRepo.Put(&otherLib)).To(Succeed()) + }) + + AfterEach(func() { + // Clean up only test folders created by our tests (paths starting with "Test") + // This prevents interference with fixture data needed by other tests + _, _ = conn.NewQuery("DELETE FROM folder WHERE library_id = 1 AND path LIKE 'Test%'").Execute() + _, _ = conn.NewQuery(fmt.Sprintf("DELETE FROM library WHERE id = %d", otherLib.ID)).Execute() + }) + + Describe("GetFolderUpdateInfo", func() { + Context("with no target paths", func() { + It("returns all folders in the library", func() { + // Create test folders with unique names to avoid conflicts + folder1 := model.NewFolder(testLib, "TestGetLastUpdates/Folder1") + folder2 := model.NewFolder(testLib, "TestGetLastUpdates/Folder2") + + err := repo.Put(folder1) + Expect(err).ToNot(HaveOccurred()) + err = repo.Put(folder2) + Expect(err).ToNot(HaveOccurred()) + + otherFolder := model.NewFolder(otherLib, "TestOtherLib/Folder") + err = repo.Put(otherFolder) + Expect(err).ToNot(HaveOccurred()) + + // Query all folders (no target paths) - should only return folders from testLib + results, err := repo.GetFolderUpdateInfo(testLib) + Expect(err).ToNot(HaveOccurred()) + // Should include folders from testLib + Expect(results).To(HaveKey(folder1.ID)) + Expect(results).To(HaveKey(folder2.ID)) + // Should NOT include folders from other library + Expect(results).ToNot(HaveKey(otherFolder.ID)) + }) + }) + + Context("with specific target paths", func() { + It("returns folder info for existing folders", func() { + // Create test folders with unique names + folder1 := model.NewFolder(testLib, "TestSpecific/Rock") + folder2 := model.NewFolder(testLib, "TestSpecific/Jazz") + folder3 := model.NewFolder(testLib, "TestSpecific/Classical") + + err := repo.Put(folder1) + Expect(err).ToNot(HaveOccurred()) + err = repo.Put(folder2) + Expect(err).ToNot(HaveOccurred()) + err = repo.Put(folder3) + Expect(err).ToNot(HaveOccurred()) + + // Query specific paths + results, err := repo.GetFolderUpdateInfo(testLib, "TestSpecific/Rock", "TestSpecific/Classical") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + + // Verify folder IDs are in results + Expect(results).To(HaveKey(folder1.ID)) + Expect(results).To(HaveKey(folder3.ID)) + Expect(results).ToNot(HaveKey(folder2.ID)) + + // Verify update info is populated + Expect(results[folder1.ID].UpdatedAt).ToNot(BeZero()) + Expect(results[folder1.ID].Hash).To(Equal(folder1.Hash)) + }) + + It("includes all child folders when querying parent", func() { + tests.SkipOnWindows("path storage (#TBD-path-sep-persistence)") + // Create a parent folder with multiple children + parent := model.NewFolder(testLib, "TestParent/Music") + child1 := model.NewFolder(testLib, "TestParent/Music/Rock/Queen") + child2 := model.NewFolder(testLib, "TestParent/Music/Jazz") + otherParent := model.NewFolder(testLib, "TestParent2/Music/Jazz") + + Expect(repo.Put(parent)).To(Succeed()) + Expect(repo.Put(child1)).To(Succeed()) + Expect(repo.Put(child2)).To(Succeed()) + + // Query the parent folder - should return parent and all children + results, err := repo.GetFolderUpdateInfo(testLib, "TestParent/Music") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + Expect(results).To(HaveKey(parent.ID)) + Expect(results).To(HaveKey(child1.ID)) + Expect(results).To(HaveKey(child2.ID)) + Expect(results).ToNot(HaveKey(otherParent.ID)) + }) + + It("excludes children from other libraries", func() { + tests.SkipOnWindows("path storage (#TBD-path-sep-persistence)") + // Create parent in testLib + parent := model.NewFolder(testLib, "TestIsolation/Parent") + child := model.NewFolder(testLib, "TestIsolation/Parent/Child") + + Expect(repo.Put(parent)).To(Succeed()) + Expect(repo.Put(child)).To(Succeed()) + + // Create similar path in other library + otherParent := model.NewFolder(otherLib, "TestIsolation/Parent") + otherChild := model.NewFolder(otherLib, "TestIsolation/Parent/Child") + + Expect(repo.Put(otherParent)).To(Succeed()) + Expect(repo.Put(otherChild)).To(Succeed()) + + // Query should only return folders from testLib + results, err := repo.GetFolderUpdateInfo(testLib, "TestIsolation/Parent") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results).To(HaveKey(parent.ID)) + Expect(results).To(HaveKey(child.ID)) + Expect(results).ToNot(HaveKey(otherParent.ID)) + Expect(results).ToNot(HaveKey(otherChild.ID)) + }) + + It("excludes missing children when querying parent", func() { + tests.SkipOnWindows("path storage (#TBD-path-sep-persistence)") + // Create parent and children, mark one as missing + parent := model.NewFolder(testLib, "TestMissingChild/Parent") + child1 := model.NewFolder(testLib, "TestMissingChild/Parent/Child1") + child2 := model.NewFolder(testLib, "TestMissingChild/Parent/Child2") + child2.Missing = true + + Expect(repo.Put(parent)).To(Succeed()) + Expect(repo.Put(child1)).To(Succeed()) + Expect(repo.Put(child2)).To(Succeed()) + + // Query parent - should only return parent and non-missing child + results, err := repo.GetFolderUpdateInfo(testLib, "TestMissingChild/Parent") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results).To(HaveKey(parent.ID)) + Expect(results).To(HaveKey(child1.ID)) + Expect(results).ToNot(HaveKey(child2.ID)) + }) + + It("handles mix of existing and non-existing target paths", func() { + tests.SkipOnWindows("path storage (#TBD-path-sep-persistence)") + // Create folders for one path but not the other + existingParent := model.NewFolder(testLib, "TestMixed/Exists") + existingChild := model.NewFolder(testLib, "TestMixed/Exists/Child") + + Expect(repo.Put(existingParent)).To(Succeed()) + Expect(repo.Put(existingChild)).To(Succeed()) + + // Query both existing and non-existing paths + results, err := repo.GetFolderUpdateInfo(testLib, "TestMixed/Exists", "TestMixed/DoesNotExist") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results).To(HaveKey(existingParent.ID)) + Expect(results).To(HaveKey(existingChild.ID)) + }) + + It("handles empty folder path as root", func() { + // Test querying for root folder without creating it (fixtures should have one) + rootFolderID := model.FolderID(testLib, ".") + + results, err := repo.GetFolderUpdateInfo(testLib, "") + Expect(err).ToNot(HaveOccurred()) + // Should return the root folder if it exists + if len(results) > 0 { + Expect(results).To(HaveKey(rootFolderID)) + } + }) + + It("returns empty map for non-existent folders", func() { + results, err := repo.GetFolderUpdateInfo(testLib, "NonExistent/Path") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("skips missing folders", func() { + // Create a folder and mark it as missing + folder := model.NewFolder(testLib, "TestMissing/Folder") + folder.Missing = true + err := repo.Put(folder) + Expect(err).ToNot(HaveOccurred()) + + results, err := repo.GetFolderUpdateInfo(testLib, "TestMissing/Folder") + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + }) + }) + + Describe("wrapFolderCursor", func() { + It("does not panic when the cursor yields a dbFolder with nil Folder", func() { + // Simulate what queryWithStableResults does on the rows.Err() path: + // it yields a zero-value dbFolder (where Folder is nil) with an error. + dbErr := fmt.Errorf("database is locked") + cursor := func(yield func(dbFolder, error) bool) { + var empty dbFolder // Folder pointer is nil + yield(empty, dbErr) + } + + // wrapFolderCursor should handle the nil Folder without panicking + wrappedCursor := wrapFolderCursor(cursor) + var gotErr error + Expect(func() { + for _, err := range wrappedCursor { + gotErr = err + } + }).ToNot(Panic()) + Expect(gotErr).To(HaveOccurred()) + Expect(gotErr.Error()).To(ContainSubstring("unexpected nil folder")) + Expect(errors.Is(gotErr, dbErr)).To(BeTrue(), "should wrap the original cursor error") + }) + + It("yields folders from a valid cursor", func() { + folder := &model.Folder{ID: "f1", Name: "Test"} + cursor := func(yield func(dbFolder, error) bool) { + yield(dbFolder{Folder: folder}, nil) + } + + wrappedCursor := wrapFolderCursor(cursor) + var folders []model.Folder + for f, err := range wrappedCursor { + Expect(err).ToNot(HaveOccurred()) + folders = append(folders, f) + } + Expect(folders).To(HaveLen(1)) + Expect(folders[0].ID).To(Equal("f1")) + }) + }) +}) diff --git a/persistence/genre_repository.go b/persistence/genre_repository.go index e92e1491a..22443284f 100644 --- a/persistence/genre_repository.go +++ b/persistence/genre_repository.go @@ -10,31 +10,17 @@ import ( ) type genreRepository struct { - sqlRepository + *baseTagRepository } func NewGenreRepository(ctx context.Context, db dbx.Builder) model.GenreRepository { - r := &genreRepository{} - r.ctx = ctx - r.db = db - r.registerModel(&model.Tag{}, map[string]filterFunc{ - "name": containsFilter("tag_value"), - }) - r.setSortMappings(map[string]string{ - "name": "tag_name", - }) - return r + return &genreRepository{ + baseTagRepository: newBaseTagRepository(ctx, db, new(model.TagGenre)), + } } func (r *genreRepository) selectGenre(opt ...model.QueryOptions) SelectBuilder { - return r.newSelect(opt...). - Columns( - "id", - "tag_value as name", - "album_count", - "media_file_count as song_count", - ). - Where(Eq{"tag.tag_name": model.TagGenre}) + return r.newSelect(opt...).Columns("tag.tag_value as name") } func (r *genreRepository) GetAll(opt ...model.QueryOptions) (model.Genres, error) { @@ -44,26 +30,20 @@ func (r *genreRepository) GetAll(opt ...model.QueryOptions) (model.Genres, error return res, err } -func (r *genreRepository) Count(options ...rest.QueryOptions) (int64, error) { - return r.count(r.selectGenre(), r.parseRestOptions(r.ctx, options...)) -} +// Override ResourceRepository methods to return Genre objects instead of Tag objects -func (r *genreRepository) Read(id string) (interface{}, error) { - sel := r.selectGenre().Columns("*").Where(Eq{"id": id}) +func (r *genreRepository) Read(id string) (any, error) { + sel := r.selectGenre().Where(Eq{"tag.id": id}) var res model.Genre err := r.queryOne(sel, &res) return &res, err } -func (r *genreRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *genreRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } -func (r *genreRepository) EntityName() string { - return r.tableName -} - -func (r *genreRepository) NewInstance() interface{} { +func (r *genreRepository) NewInstance() any { return &model.Genre{} } diff --git a/persistence/genre_repository_test.go b/persistence/genre_repository_test.go new file mode 100644 index 000000000..e3779725c --- /dev/null +++ b/persistence/genre_repository_test.go @@ -0,0 +1,329 @@ +package persistence + +import ( + "context" + "slices" + "strings" + + "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("GenreRepository", func() { + var repo model.GenreRepository + var restRepo model.ResourceRepository + var tagRepo model.TagRepository + var ctx context.Context + + BeforeEach(func() { + ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "userid", UserName: "johndoe", IsAdmin: true}) + genreRepo := NewGenreRepository(ctx, GetDBXBuilder()) + repo = genreRepo + restRepo = genreRepo.(model.ResourceRepository) + tagRepo = NewTagRepository(ctx, GetDBXBuilder()) + + // Clear any existing tags to ensure test isolation + db := GetDBXBuilder() + _, err := db.NewQuery("DELETE FROM tag").Execute() + Expect(err).ToNot(HaveOccurred()) + + // Ensure library 1 exists and user has access to it + _, err = db.NewQuery("INSERT OR IGNORE INTO library (id, name, path, default_new_users) VALUES (1, 'Test Library', '/test', true)").Execute() + Expect(err).ToNot(HaveOccurred()) + _, err = db.NewQuery("INSERT OR IGNORE INTO user_library (user_id, library_id) VALUES ('userid', 1)").Execute() + Expect(err).ToNot(HaveOccurred()) + + // Add comprehensive test data that covers all test scenarios + newTag := func(name, value string) model.Tag { + return model.Tag{ID: id.NewTagID(name, value), TagName: model.TagName(name), TagValue: value} + } + + err = tagRepo.Add(1, + newTag("genre", "rock"), + newTag("genre", "pop"), + newTag("genre", "jazz"), + newTag("genre", "electronic"), + newTag("genre", "classical"), + newTag("genre", "ambient"), + newTag("genre", "techno"), + newTag("genre", "house"), + newTag("genre", "trance"), + newTag("genre", "Alternative Rock"), + newTag("genre", "Blues"), + newTag("genre", "Country"), + // These should not be counted as genres + newTag("mood", "happy"), + newTag("mood", "ambient"), + ) + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("GetAll", func() { + It("should return all genres", func() { + genres, err := repo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(genres).To(HaveLen(12)) + + // Verify that all returned items are genres (TagName = "genre") + genreNames := make([]string, len(genres)) + for i, genre := range genres { + genreNames[i] = genre.Name + } + Expect(genreNames).To(ContainElement("rock")) + Expect(genreNames).To(ContainElement("pop")) + Expect(genreNames).To(ContainElement("jazz")) + // Should not contain mood tags + Expect(genreNames).ToNot(ContainElement("happy")) + }) + + It("should support query options", func() { + // Test with limiting results + genres, err := repo.GetAll(model.QueryOptions{Max: 1}) + Expect(err).ToNot(HaveOccurred()) + Expect(genres).To(HaveLen(1)) + }) + + It("should handle empty results gracefully", func() { + // Clear all genre tags + _, err := GetDBXBuilder().NewQuery("DELETE FROM tag WHERE tag_name = 'genre'").Execute() + Expect(err).ToNot(HaveOccurred()) + + genres, err := repo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(genres).To(BeEmpty()) + }) + Describe("filtering and sorting", func() { + It("should filter by name using like match", func() { + // Test filtering by partial name match using the "name" filter which maps to containsFilter("tag_value") + options := model.QueryOptions{ + Filters: squirrel.Like{"tag_value": "%rock%"}, // Direct field access + } + genres, err := repo.GetAll(options) + Expect(err).ToNot(HaveOccurred()) + Expect(genres).To(HaveLen(2)) // Should match "rock" and "Alternative Rock" + + // Verify all returned genres contain "rock" in their name + for _, genre := range genres { + Expect(strings.ToLower(genre.Name)).To(ContainSubstring("rock")) + } + }) + + It("should sort by name in ascending order", func() { + // Test sorting by name with the fixed mapping + options := model.QueryOptions{ + Filters: squirrel.Like{"tag_value": "%e%"}, // Should match genres containing "e" + Sort: "name", + } + genres, err := repo.GetAll(options) + Expect(err).ToNot(HaveOccurred()) + Expect(genres).To(HaveLen(7)) + + Expect(slices.IsSortedFunc(genres, func(a, b model.Genre) int { + return strings.Compare(b.Name, a.Name) // Inverted to check descending order + })) + }) + + It("should sort by name in descending order", func() { + // Test sorting by name in descending order + options := model.QueryOptions{ + Filters: squirrel.Like{"tag_value": "%e%"}, // Should match genres containing "e" + Sort: "name", + Order: "desc", + } + genres, err := repo.GetAll(options) + Expect(err).ToNot(HaveOccurred()) + Expect(genres).To(HaveLen(7)) + + Expect(slices.IsSortedFunc(genres, func(a, b model.Genre) int { + return strings.Compare(a.Name, b.Name) + })) + }) + }) + }) + + Describe("Count", func() { + It("should return correct count of genres", func() { + count, err := restRepo.Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(12))) // We have 12 genre tags + }) + + It("should handle zero count", func() { + // Clear all genre tags + _, err := GetDBXBuilder().NewQuery("DELETE FROM tag WHERE tag_name = 'genre'").Execute() + Expect(err).ToNot(HaveOccurred()) + + count, err := restRepo.Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(BeZero()) + }) + + It("should only count genre tags", func() { + // Add a non-genre tag + nonGenreTag := model.Tag{ + ID: id.NewTagID("mood", "energetic"), + TagName: "mood", + TagValue: "energetic", + } + err := tagRepo.Add(1, nonGenreTag) + Expect(err).ToNot(HaveOccurred()) + + count, err := restRepo.Count() + Expect(err).ToNot(HaveOccurred()) + // Count should not include the mood tag + Expect(count).To(Equal(int64(12))) // Should still be 12 genre tags + }) + + It("should filter by name using like match", func() { + // Test filtering by partial name match using the "name" filter which maps to containsFilter("tag_value") + options := rest.QueryOptions{ + Filters: map[string]any{"name": "%rock%"}, + } + count, err := restRepo.Count(options) + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(BeNumerically("==", 2)) + }) + }) + + Describe("Read", func() { + It("should return existing genre", func() { + // Use one of the existing genres from our consolidated dataset + genreID := id.NewTagID("genre", "rock") + result, err := restRepo.Read(genreID) + Expect(err).ToNot(HaveOccurred()) + genre := result.(*model.Genre) + Expect(genre.ID).To(Equal(genreID)) + Expect(genre.Name).To(Equal("rock")) + }) + + It("should return error for non-existent genre", func() { + _, err := restRepo.Read("non-existent-id") + Expect(err).To(HaveOccurred()) + }) + + It("should not return non-genre tags", func() { + moodID := id.NewTagID("mood", "happy") // This exists as a mood tag, not genre + _, err := restRepo.Read(moodID) + Expect(err).To(HaveOccurred()) // Should not find it as a genre + }) + }) + + Describe("ReadAll", func() { + It("should return all genres through ReadAll", func() { + result, err := restRepo.ReadAll() + Expect(err).ToNot(HaveOccurred()) + genres := result.(model.Genres) + Expect(genres).To(HaveLen(12)) // We have 12 genre tags + + genreNames := make([]string, len(genres)) + for i, genre := range genres { + genreNames[i] = genre.Name + } + // Check for some of our consolidated dataset genres + Expect(genreNames).To(ContainElement("rock")) + Expect(genreNames).To(ContainElement("pop")) + Expect(genreNames).To(ContainElement("jazz")) + }) + + It("should support rest query options", func() { + result, err := restRepo.ReadAll() + Expect(err).ToNot(HaveOccurred()) + Expect(result).ToNot(BeNil()) + }) + }) + + Describe("Library Filtering", func() { + Context("Headless Processes (No User Context)", func() { + var headlessRepo model.GenreRepository + var headlessRestRepo model.ResourceRepository + + BeforeEach(func() { + // Create a repository with no user context (headless) + headlessGenreRepo := NewGenreRepository(context.Background(), GetDBXBuilder()) + headlessRepo = headlessGenreRepo + headlessRestRepo = headlessGenreRepo.(model.ResourceRepository) + + // Add genres to different libraries + db := GetDBXBuilder() + _, err := db.NewQuery("INSERT OR IGNORE INTO library (id, name, path) VALUES (2, 'Test Library 2', '/test2')").Execute() + Expect(err).ToNot(HaveOccurred()) + + // Add tags to different libraries + newTag := func(name, value string) model.Tag { + return model.Tag{ID: id.NewTagID(name, value), TagName: model.TagName(name), TagValue: value} + } + + err = tagRepo.Add(2, newTag("genre", "jazz")) + Expect(err).ToNot(HaveOccurred()) + }) + + It("should see all genres from all libraries when no user is in context", func() { + // Headless processes should see all genres regardless of library + genres, err := headlessRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + + // Should see genres from all libraries + var genreNames []string + for _, genre := range genres { + genreNames = append(genreNames, genre.Name) + } + + // Should include both rock (library 1) and jazz (library 2) + Expect(genreNames).To(ContainElement("rock")) + Expect(genreNames).To(ContainElement("jazz")) + }) + + It("should count all genres from all libraries when no user is in context", func() { + count, err := headlessRestRepo.Count() + Expect(err).ToNot(HaveOccurred()) + + // Should count all genres from all libraries + Expect(count).To(BeNumerically(">=", 2)) + }) + + It("should allow headless processes to apply explicit library_id filters", func() { + // Filter by specific library + genres, err := headlessRestRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"library_id": 2}, + }) + Expect(err).ToNot(HaveOccurred()) + + genreList := genres.(model.Genres) + // Should see only genres from library 2 + Expect(genreList).To(HaveLen(1)) + Expect(genreList[0].Name).To(Equal("jazz")) + }) + + It("should get individual genres when no user is in context", func() { + // Get all genres first to find an ID + genres, err := headlessRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(genres).ToNot(BeEmpty()) + + // Headless process should be able to get the genre + genre, err := headlessRestRepo.Read(genres[0].ID) + Expect(err).ToNot(HaveOccurred()) + Expect(genre).ToNot(BeNil()) + }) + }) + }) + + Describe("EntityName", func() { + It("should return correct entity name", func() { + name := restRepo.EntityName() + Expect(name).To(Equal("tag")) // Genre repository uses tag table + }) + }) + + Describe("NewInstance", func() { + It("should return new genre instance", func() { + instance := restRepo.NewInstance() + Expect(instance).To(BeAssignableToTypeOf(&model.Genre{})) + }) + }) +}) diff --git a/persistence/helpers.go b/persistence/helpers.go index 73815ae45..fd6a9a4cd 100644 --- a/persistence/helpers.go +++ b/persistence/helpers.go @@ -15,7 +15,7 @@ type PostMapper interface { PostMapArgs(map[string]any) error } -func toSQLArgs(rec interface{}) (map[string]interface{}, error) { +func toSQLArgs(rec any) (map[string]any, error) { m := structs.Map(rec) for k, v := range m { switch t := v.(type) { @@ -71,7 +71,7 @@ type existsCond struct { not bool } -func (e existsCond) ToSql() (string, []interface{}, error) { +func (e existsCond) ToSql() (string, []any, error) { sql, args, err := e.cond.ToSql() sql = fmt.Sprintf("exists (select 1 from %s where %s)", e.subTable, sql) if e.not { diff --git a/persistence/library_repository.go b/persistence/library_repository.go index 5ec54b964..1d8e6f35e 100644 --- a/persistence/library_repository.go +++ b/persistence/library_repository.go @@ -2,13 +2,17 @@ package persistence import ( "context" + "fmt" + "strconv" "sync" "time" . "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/run" "github.com/pocketbase/dbx" ) @@ -67,41 +71,78 @@ func (r *libraryRepository) GetPath(id int) (string, error) { } func (r *libraryRepository) Put(l *model.Library) error { - cols := map[string]any{ - "name": l.Name, - "path": l.Path, - "remote_path": l.RemotePath, - "updated_at": time.Now(), - } - if l.ID != 0 { - cols["id"] = l.ID + if l.ID == model.DefaultLibraryID { + currentLib, err := r.Get(1) + // if we are creating it, it's ok. + if err == nil { // it exists, so we are updating it + if currentLib.Path != l.Path { + return fmt.Errorf("%w: path for library with ID 1 cannot be changed", model.ErrValidation) + } + } } - sq := Insert(r.tableName).SetMap(cols). - Suffix(`on conflict(id) do update set name = excluded.name, path = excluded.path, - remote_path = excluded.remote_path, updated_at = excluded.updated_at`) - _, err := r.executeSQL(sq) + var err error + l.UpdatedAt = time.Now() + if l.ID == 0 { + // Insert with autoassigned ID + l.CreatedAt = time.Now() + err = r.db.Model(l).Insert() + } else { + // Try to update first + cols := map[string]any{ + "name": l.Name, + "path": l.Path, + "remote_path": l.RemotePath, + "default_new_users": l.DefaultNewUsers, + "updated_at": l.UpdatedAt, + } + sq := Update(r.tableName).SetMap(cols).Where(Eq{"id": l.ID}) + rowsAffected, updateErr := r.executeSQL(sq) + if updateErr != nil { + return updateErr + } + + // If no rows were affected, the record doesn't exist, so insert it + if rowsAffected == 0 { + l.CreatedAt = time.Now() + l.UpdatedAt = time.Now() + err = r.db.Model(l).Insert() + } + } if err != nil { - libLock.Lock() - defer libLock.Unlock() - libCache[l.ID] = l.Path + return err } - return err -} -const hardCodedMusicFolderID = 1 + // Auto-assign all libraries to all admin users + sql := Expr(` +INSERT INTO user_library (user_id, library_id) +SELECT u.id, l.id +FROM user u +CROSS JOIN library l +WHERE u.is_admin = true +ON CONFLICT (user_id, library_id) DO NOTHING;`, + ) + if _, err = r.executeSQL(sql); err != nil { + return fmt.Errorf("failed to assign library to admin users: %w", err) + } + + libLock.Lock() + defer libLock.Unlock() + libCache[l.ID] = l.Path + return nil +} // TODO Remove this method when we have a proper UI to add libraries // This is a temporary method to store the music folder path from the config in the DB func (r *libraryRepository) StoreMusicFolder() error { sq := Update(r.tableName).Set("path", conf.Server.MusicFolder). Set("updated_at", time.Now()). - Where(Eq{"id": hardCodedMusicFolderID}) + Where(Eq{"id": model.DefaultLibraryID}) _, err := r.executeSQL(sq) if err != nil { libLock.Lock() defer libLock.Unlock() - libCache[hardCodedMusicFolderID] = conf.Server.MusicFolder + libCache[model.DefaultLibraryID] = conf.Server.MusicFolder } return err } @@ -136,7 +177,11 @@ func (r *libraryRepository) ScanEnd(id int) error { return err } // https://www.sqlite.org/pragma.html#pragma_optimize - _, err = r.executeSQL(Expr("PRAGMA optimize=0x10012;")) + // Use mask 0x10000 to check table sizes without running ANALYZE + // Running ANALYZE can cause query planner issues with expression-based collation indexes + if conf.Server.DevOptimizeDB { + _, err = r.executeSQL(Expr("PRAGMA optimize=0x10000;")) + } return err } @@ -146,6 +191,88 @@ func (r *libraryRepository) ScanInProgress() (bool, error) { return count > 0, err } +func (r *libraryRepository) RefreshStats(id int) error { + var songsRes, albumsRes, artistsRes, foldersRes, filesRes, missingRes struct{ Count int64 } + var sizeRes struct{ Sum int64 } + var durationRes struct{ Sum float64 } + + err := run.Parallel( + func() error { + return r.queryOne(Select("count(*) as count").From("media_file").Where(Eq{"library_id": id, "missing": false}), &songsRes) + }, + func() error { + return r.queryOne(Select("count(*) as count").From("album").Where(Eq{"library_id": id, "missing": false}), &albumsRes) + }, + func() error { + return r.queryOne(Select("count(*) as count").From("library_artist la"). + Join("artist a on la.artist_id = a.id"). + Where(Eq{"la.library_id": id, "a.missing": false}), &artistsRes) + }, + func() error { + return r.queryOne(Select("count(*) as count").From("folder"). + Where(And{ + Eq{"library_id": id, "missing": false}, + Gt{"num_audio_files": 0}, + }), &foldersRes) + }, + func() error { + return r.queryOne(Select("ifnull(sum(num_audio_files + num_playlists + json_array_length(image_files)),0) as count"). + From("folder").Where(Eq{"library_id": id, "missing": false}), &filesRes) + }, + func() error { + return r.queryOne(Select("count(*) as count").From("media_file").Where(Eq{"library_id": id, "missing": true}), &missingRes) + }, + func() error { + return r.queryOne(Select("ifnull(sum(size),0) as sum").From("album").Where(Eq{"library_id": id, "missing": false}), &sizeRes) + }, + func() error { + return r.queryOne(Select("ifnull(sum(duration),0) as sum").From("album").Where(Eq{"library_id": id, "missing": false}), &durationRes) + }, + )() + if err != nil { + return err + } + + sq := Update(r.tableName). + Set("total_songs", songsRes.Count). + Set("total_albums", albumsRes.Count). + Set("total_artists", artistsRes.Count). + Set("total_folders", foldersRes.Count). + Set("total_files", filesRes.Count). + Set("total_missing_files", missingRes.Count). + Set("total_size", sizeRes.Sum). + Set("total_duration", durationRes.Sum). + Set("updated_at", time.Now()). + Where(Eq{"id": id}) + _, err = r.executeSQL(sq) + return err +} + +func (r *libraryRepository) Delete(id int) error { + if !loggedUser(r.ctx).IsAdmin { + return model.ErrNotAuthorized + } + if id == 1 { + return fmt.Errorf("%w: library with ID 1 cannot be deleted", model.ErrValidation) + } + + err := r.delete(Eq{"id": id}) + if err != nil { + return err + } + + // Clear cache entry for this library only if DB operation was successful + libLock.Lock() + defer libLock.Unlock() + delete(libCache, id) + + // Clean up orphaned plugin references for the deleted library + if err := cleanupPluginLibraryReferences(r.db, id); err != nil { + log.Error(r.ctx, "Failed to cleanup plugin library references", "libraryID", id, err) + } + return nil +} + func (r *libraryRepository) GetAll(ops ...model.QueryOptions) (model.Libraries, error) { sq := r.newSelect(ops...).Columns("*") res := model.Libraries{} @@ -153,4 +280,72 @@ func (r *libraryRepository) GetAll(ops ...model.QueryOptions) (model.Libraries, return res, err } +func (r *libraryRepository) CountAll(ops ...model.QueryOptions) (int64, error) { + sq := r.newSelect(ops...) + return r.count(sq) +} + +// User-library association methods + +func (r *libraryRepository) GetUsersWithLibraryAccess(libraryID int) (model.Users, error) { + sel := Select("u.*"). + From("user u"). + Join("user_library ul ON u.id = ul.user_id"). + Where(Eq{"ul.library_id": libraryID}). + OrderBy("u.name") + + var res model.Users + err := r.queryAll(sel, &res) + return res, err +} + +// REST interface methods + +func (r *libraryRepository) Count(options ...rest.QueryOptions) (int64, error) { + return r.CountAll(r.parseRestOptions(r.ctx, options...)) +} + +func (r *libraryRepository) Read(id string) (any, error) { + idInt, err := strconv.Atoi(id) + if err != nil { + log.Trace(r.ctx, "invalid library id: %s", id, err) + return nil, rest.ErrNotFound + } + return r.Get(idInt) +} + +func (r *libraryRepository) ReadAll(options ...rest.QueryOptions) (any, error) { + return r.GetAll(r.parseRestOptions(r.ctx, options...)) +} + +func (r *libraryRepository) EntityName() string { + return "library" +} + +func (r *libraryRepository) NewInstance() any { + return &model.Library{} +} + +func (r *libraryRepository) Save(entity any) (string, error) { + lib := entity.(*model.Library) + lib.ID = 0 // Reset ID to ensure we create a new library + err := r.Put(lib) + if err != nil { + return "", err + } + return strconv.Itoa(lib.ID), nil +} + +func (r *libraryRepository) Update(id string, entity any, cols ...string) error { + lib := entity.(*model.Library) + idInt, err := strconv.Atoi(id) + if err != nil { + return fmt.Errorf("invalid library ID: %s", id) + } + + lib.ID = idInt + return r.Put(lib) +} + var _ model.LibraryRepository = (*libraryRepository)(nil) +var _ rest.Repository = (*libraryRepository)(nil) diff --git a/persistence/library_repository_test.go b/persistence/library_repository_test.go new file mode 100644 index 000000000..de7161643 --- /dev/null +++ b/persistence/library_repository_test.go @@ -0,0 +1,209 @@ +package persistence + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +var _ = Describe("LibraryRepository", func() { + var repo model.LibraryRepository + var ctx context.Context + var conn *dbx.DB + + BeforeEach(func() { + ctx = request.WithUser(log.NewContext(context.TODO()), model.User{ID: "userid"}) + conn = GetDBXBuilder() + repo = NewLibraryRepository(ctx, conn) + }) + + AfterEach(func() { + // Clean up test libraries (keep ID 1 which is the default library) + _, _ = conn.NewQuery("DELETE FROM library WHERE id > 1").Execute() + }) + + Describe("Put", func() { + Context("when ID is 0", func() { + It("inserts a new library with autoassigned ID", func() { + lib := &model.Library{ + ID: 0, + Name: "Test Library", + Path: "/music/test", + } + + err := repo.Put(lib) + Expect(err).ToNot(HaveOccurred()) + Expect(lib.ID).To(BeNumerically(">", 0)) + Expect(lib.CreatedAt).ToNot(BeZero()) + Expect(lib.UpdatedAt).ToNot(BeZero()) + + // Verify it was inserted + savedLib, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(savedLib.Name).To(Equal("Test Library")) + Expect(savedLib.Path).To(Equal("/music/test")) + }) + }) + + Context("when ID is non-zero and record exists", func() { + It("updates the existing record", func() { + // First create a library + lib := &model.Library{ + ID: 0, + Name: "Original Library", + Path: "/music/original", + } + err := repo.Put(lib) + Expect(err).ToNot(HaveOccurred()) + + originalID := lib.ID + originalCreatedAt := lib.CreatedAt + + // Ensure the update's timestamp is strictly greater than the + // create's timestamp on platforms with coarse clock resolution + // (Windows' time.Now() is millisecond-granular). + time.Sleep(2 * time.Millisecond) + + // Now update it + lib.Name = "Updated Library" + lib.Path = "/music/updated" + err = repo.Put(lib) + Expect(err).ToNot(HaveOccurred()) + + // Verify it was updated, not inserted + Expect(lib.ID).To(Equal(originalID)) + Expect(lib.CreatedAt).To(Equal(originalCreatedAt)) + Expect(lib.UpdatedAt).To(BeTemporally(">", originalCreatedAt)) + + // Verify the changes were saved + savedLib, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(savedLib.Name).To(Equal("Updated Library")) + Expect(savedLib.Path).To(Equal("/music/updated")) + }) + }) + + Context("when ID is non-zero but record doesn't exist", func() { + It("inserts a new record with the specified ID", func() { + lib := &model.Library{ + ID: 999, + Name: "New Library with ID", + Path: "/music/new", + } + + // Ensure the record doesn't exist + _, err := repo.Get(999) + Expect(err).To(HaveOccurred()) + + // Put should insert it + err = repo.Put(lib) + Expect(err).ToNot(HaveOccurred()) + Expect(lib.ID).To(Equal(999)) + Expect(lib.CreatedAt).ToNot(BeZero()) + Expect(lib.UpdatedAt).ToNot(BeZero()) + + // Verify it was inserted with the correct ID + savedLib, err := repo.Get(999) + Expect(err).ToNot(HaveOccurred()) + Expect(savedLib.ID).To(Equal(999)) + Expect(savedLib.Name).To(Equal("New Library with ID")) + Expect(savedLib.Path).To(Equal("/music/new")) + }) + }) + }) + + It("refreshes stats", func() { + libBefore, err := repo.Get(1) + Expect(err).ToNot(HaveOccurred()) + Expect(repo.RefreshStats(1)).To(Succeed()) + libAfter, err := repo.Get(1) + Expect(err).ToNot(HaveOccurred()) + Expect(libAfter.UpdatedAt).To(BeTemporally(">", libBefore.UpdatedAt)) + + var songsRes, albumsRes, artistsRes, foldersRes, filesRes, missingRes struct{ Count int64 } + var sizeRes struct{ Sum int64 } + var durationRes struct{ Sum float64 } + + Expect(conn.NewQuery("select count(*) as count from media_file where library_id = {:id} and missing = 0").Bind(dbx.Params{"id": 1}).One(&songsRes)).To(Succeed()) + Expect(conn.NewQuery("select count(*) as count from album where library_id = {:id} and missing = 0").Bind(dbx.Params{"id": 1}).One(&albumsRes)).To(Succeed()) + Expect(conn.NewQuery("select count(*) as count from library_artist la join artist a on la.artist_id = a.id where la.library_id = {:id} and a.missing = 0").Bind(dbx.Params{"id": 1}).One(&artistsRes)).To(Succeed()) + Expect(conn.NewQuery("select count(*) as count from folder where library_id = {:id} and missing = 0").Bind(dbx.Params{"id": 1}).One(&foldersRes)).To(Succeed()) + Expect(conn.NewQuery("select ifnull(sum(num_audio_files + num_playlists + json_array_length(image_files)),0) as count from folder where library_id = {:id} and missing = 0").Bind(dbx.Params{"id": 1}).One(&filesRes)).To(Succeed()) + Expect(conn.NewQuery("select count(*) as count from media_file where library_id = {:id} and missing = 1").Bind(dbx.Params{"id": 1}).One(&missingRes)).To(Succeed()) + Expect(conn.NewQuery("select ifnull(sum(size),0) as sum from album where library_id = {:id} and missing = 0").Bind(dbx.Params{"id": 1}).One(&sizeRes)).To(Succeed()) + Expect(conn.NewQuery("select ifnull(sum(duration),0) as sum from album where library_id = {:id} and missing = 0").Bind(dbx.Params{"id": 1}).One(&durationRes)).To(Succeed()) + + Expect(libAfter.TotalSongs).To(Equal(int(songsRes.Count))) + Expect(libAfter.TotalAlbums).To(Equal(int(albumsRes.Count))) + Expect(libAfter.TotalArtists).To(Equal(int(artistsRes.Count))) + Expect(libAfter.TotalFolders).To(Equal(int(foldersRes.Count))) + Expect(libAfter.TotalFiles).To(Equal(int(filesRes.Count))) + Expect(libAfter.TotalMissingFiles).To(Equal(int(missingRes.Count))) + Expect(libAfter.TotalSize).To(Equal(sizeRes.Sum)) + Expect(libAfter.TotalDuration).To(Equal(durationRes.Sum)) + }) + + Describe("ScanBegin and ScanEnd", func() { + var lib *model.Library + + BeforeEach(func() { + lib = &model.Library{ + ID: 0, + Name: "Test Scan Library", + Path: "/music/test-scan", + } + err := repo.Put(lib) + Expect(err).ToNot(HaveOccurred()) + }) + + DescribeTable("ScanBegin", + func(fullScan bool, expectedFullScanInProgress bool) { + err := repo.ScanBegin(lib.ID, fullScan) + Expect(err).ToNot(HaveOccurred()) + + updatedLib, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(updatedLib.LastScanStartedAt).ToNot(BeZero()) + Expect(updatedLib.FullScanInProgress).To(Equal(expectedFullScanInProgress)) + }, + Entry("sets FullScanInProgress to true for full scan", true, true), + Entry("sets FullScanInProgress to false for quick scan", false, false), + ) + + Context("ScanEnd", func() { + BeforeEach(func() { + err := repo.ScanBegin(lib.ID, true) + Expect(err).ToNot(HaveOccurred()) + }) + + It("sets LastScanAt and clears FullScanInProgress and LastScanStartedAt", func() { + err := repo.ScanEnd(lib.ID) + Expect(err).ToNot(HaveOccurred()) + + updatedLib, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(updatedLib.LastScanAt).ToNot(BeZero()) + Expect(updatedLib.FullScanInProgress).To(BeFalse()) + Expect(updatedLib.LastScanStartedAt).To(BeZero()) + }) + + It("sets LastScanAt to be after LastScanStartedAt", func() { + libBefore, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + + err = repo.ScanEnd(lib.ID) + Expect(err).ToNot(HaveOccurred()) + + libAfter, err := repo.Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(libAfter.LastScanAt).To(BeTemporally(">=", libBefore.LastScanStartedAt)) + }) + }) + }) +}) diff --git a/persistence/mediafile_repository.go b/persistence/mediafile_repository.go index b0ed637c1..559378262 100644 --- a/persistence/mediafile_repository.go +++ b/persistence/mediafile_repository.go @@ -3,12 +3,16 @@ package persistence import ( "context" "fmt" + "iter" "slices" + "strconv" + "strings" "sync" "time" . "github.com/Masterminds/squirrel" "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/slice" @@ -25,10 +29,10 @@ type dbMediaFile struct { Tags string `structs:"-" json:"-"` // These are necessary to map the correct names (rg_*) to the correct fields (RG*) // without using `db` struct tags in the model.MediaFile struct - RgAlbumGain float64 `structs:"-" json:"-"` - RgAlbumPeak float64 `structs:"-" json:"-"` - RgTrackGain float64 `structs:"-" json:"-"` - RgTrackPeak float64 `structs:"-" json:"-"` + RgAlbumGain *float64 `structs:"-" json:"-"` + RgAlbumPeak *float64 `structs:"-" json:"-"` + RgTrackGain *float64 `structs:"-" json:"-"` + RgTrackPeak *float64 `structs:"-" json:"-"` } func (m *dbMediaFile) PostScan() error { @@ -54,8 +58,11 @@ func (m *dbMediaFile) PostScan() error { func (m *dbMediaFile) PostMapArgs(args map[string]any) error { fullText := []string{m.FullTitle(), m.Album, m.Artist, m.AlbumArtist, m.SortTitle, m.SortAlbumName, m.SortArtistName, m.SortAlbumArtistName, m.DiscSubtitle} - fullText = append(fullText, m.MediaFile.Participants.AllNames()...) + participantNames := m.MediaFile.Participants.AllNames() + fullText = append(fullText, participantNames...) args["full_text"] = formatFullText(fullText...) + args["search_participants"] = strings.Join(participantNames, " ") + args["search_normalized"] = normalizeForFTS(m.FullTitle(), m.Album, m.Artist, m.AlbumArtist) args["tags"] = marshalTags(m.MediaFile.Tags) args["participants"] = marshalParticipants(m.MediaFile.Participants) return nil @@ -74,13 +81,15 @@ func NewMediaFileRepository(ctx context.Context, db dbx.Builder) model.MediaFile r.tableName = "media_file" r.registerModel(&model.MediaFile{}, mediaFileFilter()) r.setSortMappings(map[string]string{ - "title": "order_title", - "artist": "order_artist_name, order_album_name, release_date, disc_number, track_number", - "album_artist": "order_album_artist_name, order_album_name, release_date, disc_number, track_number", - "album": "order_album_name, album_id, disc_number, track_number, order_artist_name, title", - "random": "random", - "created_at": "media_file.created_at", - "starred_at": "starred, starred_at", + "title": "order_title", + "artist": "order_artist_name, order_album_name, release_date, disc_number, track_number", + "album_artist": "order_album_artist_name, order_album_name, release_date, disc_number, track_number", + "album": "order_album_name, album_id, disc_number, track_number, order_artist_name, title", + "random": "random", + "created_at": "media_file.created_at", + "recently_added": mediaFileRecentlyAddedSort(), + "starred_at": "starred, starred_at", + "rated_at": "rating, rated_at", }) return r } @@ -88,11 +97,14 @@ func NewMediaFileRepository(ctx context.Context, db dbx.Builder) model.MediaFile var mediaFileFilter = sync.OnceValue(func() map[string]filterFunc { filters := map[string]filterFunc{ "id": idFilter("media_file"), - "title": fullTextFilter("media_file"), - "starred": booleanFilter, + "title": fullTextFilter("media_file", "mbz_recording_id", "mbz_release_track_id"), + "starred": annotationBoolFilter("starred"), + "has_rating": annotationBoolFilter("rating"), "genre_id": tagIDFilter, "missing": booleanFilter, "artists_id": artistFilter, + "library_id": libraryIdFilter, + "path": startsWithFilter("media_file.path"), } // Add all album tags as filters for tag := range model.TagMappings() { @@ -103,18 +115,47 @@ var mediaFileFilter = sync.OnceValue(func() map[string]filterFunc { return filters }) +func mediaFileRecentlyAddedSort() string { + if conf.Server.RecentlyAddedByModTime { + return "media_file.updated_at" + } + return "media_file.created_at" +} + func (r *mediaFileRepository) CountAll(options ...model.QueryOptions) (int64, error) { query := r.newSelect() query = r.withAnnotation(query, "media_file.id") + query = r.applyLibraryFilter(query) return r.count(query, options...) } +func (r *mediaFileRepository) CountBySuffix(options ...model.QueryOptions) (map[string]int64, error) { + sel := r.newSelect(options...). + Columns("lower(suffix) as suffix", "count(*) as count"). + GroupBy("lower(suffix)") + var res []struct { + Suffix string + Count int64 + } + err := r.queryAll(sel, &res) + if err != nil { + return nil, err + } + counts := make(map[string]int64, len(res)) + for _, c := range res { + counts[c.Suffix] = c.Count + } + return counts, nil +} + func (r *mediaFileRepository) Exists(id string) (bool, error) { return r.exists(Eq{"media_file.id": id}) } func (r *mediaFileRepository) Put(m *model.MediaFile) error { - m.CreatedAt = time.Now() + if m.CreatedAt.IsZero() { + m.CreatedAt = time.Now() + } id, err := r.putByMatch(Eq{"path": m.Path, "library_id": m.LibraryID}, m.ID, &dbMediaFile{MediaFile: m}) if err != nil { return err @@ -123,11 +164,17 @@ func (r *mediaFileRepository) Put(m *model.MediaFile) error { return r.updateParticipants(m.ID, m.Participants) } +func (r *mediaFileRepository) UpdateProbeData(id string, data string) error { + _, err := r.executeSQL(Update(r.tableName).Set("probe_data", data).Where(Eq{"id": id})) + return err +} + func (r *mediaFileRepository) selectMediaFile(options ...model.QueryOptions) SelectBuilder { - sql := r.newSelect(options...).Columns("media_file.*", "library.path as library_path"). + sql := r.newSelect(options...).Columns("media_file.*", "library.path as library_path", "library.name as library_name"). LeftJoin("library on media_file.library_id = library.id") sql = r.withAnnotation(sql, "media_file.id") - return r.withBookmark(sql, "media_file.id") + sql = r.withBookmark(sql, "media_file.id") + return r.applyLibraryFilter(sql) } func (r *mediaFileRepository) Get(id string) (*model.MediaFile, error) { @@ -160,31 +207,77 @@ func (r *mediaFileRepository) GetAll(options ...model.QueryOptions) (model.Media return res.toModels(), nil } +func (r *mediaFileRepository) GetAllByTags(tag model.TagName, values []string, options ...model.QueryOptions) (model.MediaFiles, error) { + placeholders := make([]string, len(values)) + args := make([]any, len(values)) + for i, v := range values { + placeholders[i] = "?" + args[i] = v + } + tagFilter := Expr( + fmt.Sprintf("exists (select 1 from json_tree(media_file.tags, '$.%s') where key='value' and value in (%s))", + tag, strings.Join(placeholders, ",")), + args..., + ) + + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } + if opts.Filters != nil { + opts.Filters = And{tagFilter, opts.Filters} + } else { + opts.Filters = tagFilter + } + return r.GetAll(opts) +} + func (r *mediaFileRepository) GetCursor(options ...model.QueryOptions) (model.MediaFileCursor, error) { sq := r.selectMediaFile(options...) cursor, err := queryWithStableResults[dbMediaFile](r.sqlRepository, sq) if err != nil { return nil, err } - return func(yield func(model.MediaFile, error) bool) { - for m, err := range cursor { - if m.MediaFile == nil { - yield(model.MediaFile{}, fmt.Errorf("unexpected nil mediafile: %v", m)) - return - } - if !yield(*m.MediaFile, err) || err != nil { - return - } - } - }, nil + return wrapMediaFileCursor(cursor), nil } +// FindByPaths finds media files by their paths. +// The paths can be library-qualified (format: "libraryID:path") or unqualified ("path"). +// Library-qualified paths search within the specified library, while unqualified paths +// search across all libraries for backward compatibility. func (r *mediaFileRepository) FindByPaths(paths []string) (model.MediaFiles, error) { - sel := r.newSelect().Columns("*").Where(Eq{"path collate nocase": paths}) + query := Or{} + + for _, path := range paths { + parts := strings.SplitN(path, ":", 2) + if len(parts) == 2 { + // Library-qualified path: "libraryID:path" + libraryID, err := strconv.Atoi(parts[0]) + if err != nil { + // Invalid format, skip + continue + } + relativePath := parts[1] + query = append(query, And{ + Eq{"path collate nocase": relativePath}, + Eq{"library_id": libraryID}, + }) + } else { + // Unqualified path: search across all libraries + query = append(query, Eq{"path collate nocase": path}) + } + } + + if len(query) == 0 { + return model.MediaFiles{}, nil + } + + sel := r.newSelect().Columns("*").Where(query) var res dbMediaFiles if err := r.queryAll(sel, &res); err != nil { return nil, err } + return res.toModels(), nil } @@ -263,7 +356,7 @@ func (r *mediaFileRepository) GetMissingAndMatching(libId int) (model.MediaFileC if err != nil { return nil, err } - sel := r.newSelect().Columns("media_file.*", "library.path as library_path"). + sel := r.newSelect().Columns("media_file.*", "library.path as library_path", "library.name as library_name"). LeftJoin("library on media_file.library_id = library.id"). Where("pid in ("+subQText+")", subQArgs...). Where(Or{ @@ -275,33 +368,99 @@ func (r *mediaFileRepository) GetMissingAndMatching(libId int) (model.MediaFileC if err != nil { return nil, err } + return wrapMediaFileCursor(cursor), nil +} + +func wrapMediaFileCursor(cursor iter.Seq2[dbMediaFile, error]) model.MediaFileCursor { return func(yield func(model.MediaFile, error) bool) { for m, err := range cursor { + if m.MediaFile == nil { + yield(model.MediaFile{}, fmt.Errorf("unexpected nil mediafile (%v): %w", m, err)) + return + } if !yield(*m.MediaFile, err) || err != nil { return } } - }, nil + } } -func (r *mediaFileRepository) Search(q string, offset int, size int, includeMissing bool) (model.MediaFiles, error) { - results := dbMediaFiles{} - err := r.doSearch(r.selectMediaFile(), q, offset, size, includeMissing, &results, "title") +// FindRecentFilesByMBZTrackID finds recently added files by MusicBrainz Track ID in other libraries +// It uses a lightweight query without annotation/bookmark joins since those are not needed for matching +func (r *mediaFileRepository) FindRecentFilesByMBZTrackID(missing model.MediaFile, since time.Time) (model.MediaFiles, error) { + sel := r.newSelect().Columns("media_file.*", "library.path as library_path", "library.name as library_name"). + LeftJoin("library on media_file.library_id = library.id"). + Where(And{ + NotEq{"media_file.library_id": missing.LibraryID}, + Eq{"media_file.mbz_release_track_id": missing.MbzReleaseTrackID}, + NotEq{"media_file.mbz_release_track_id": ""}, // Exclude empty MBZ Track IDs + Eq{"media_file.suffix": missing.Suffix}, + Gt{"media_file.created_at": since}, + Eq{"media_file.missing": false}, + }).OrderBy("media_file.created_at DESC") + + var res dbMediaFiles + err := r.queryAll(sel, &res) if err != nil { return nil, err } - return results.toModels(), err + return res.toModels(), nil +} + +// FindRecentFilesByProperties finds recently added files by intrinsic properties in other libraries +// It uses a lightweight query without annotation/bookmark joins since those are not needed for matching +func (r *mediaFileRepository) FindRecentFilesByProperties(missing model.MediaFile, since time.Time) (model.MediaFiles, error) { + sel := r.newSelect().Columns("media_file.*", "library.path as library_path", "library.name as library_name"). + LeftJoin("library on media_file.library_id = library.id"). + Where(And{ + NotEq{"media_file.library_id": missing.LibraryID}, + Eq{"media_file.title": missing.Title}, + Eq{"media_file.size": missing.Size}, + Eq{"media_file.suffix": missing.Suffix}, + Eq{"media_file.disc_number": missing.DiscNumber}, + Eq{"media_file.track_number": missing.TrackNumber}, + Eq{"media_file.album": missing.Album}, + Eq{"media_file.mbz_release_track_id": ""}, // Exclude files with MBZ Track ID + Gt{"media_file.created_at": since}, + Eq{"media_file.missing": false}, + }).OrderBy("media_file.created_at DESC") + + var res dbMediaFiles + err := r.queryAll(sel, &res) + if err != nil { + return nil, err + } + return res.toModels(), nil +} + +var mediaFileSearchConfig = searchConfig{ + NaturalOrder: "media_file.rowid", + OrderBy: []string{"title"}, + MBIDFields: []string{"mbz_recording_id", "mbz_release_track_id"}, +} + +func (r *mediaFileRepository) Search(q string, options ...model.QueryOptions) (model.MediaFiles, error) { + var opts model.QueryOptions + if len(options) > 0 { + opts = options[0] + } + var res dbMediaFiles + err := r.doSearch(r.selectMediaFile(options...), q, &res, mediaFileSearchConfig, opts) + if err != nil { + return nil, fmt.Errorf("searching media_file %q: %w", q, err) + } + return res.toModels(), nil } func (r *mediaFileRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *mediaFileRepository) Read(id string) (interface{}, error) { +func (r *mediaFileRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *mediaFileRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *mediaFileRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -309,7 +468,7 @@ func (r *mediaFileRepository) EntityName() string { return "mediafile" } -func (r *mediaFileRepository) NewInstance() interface{} { +func (r *mediaFileRepository) NewInstance() any { return &model.MediaFile{} } diff --git a/persistence/mediafile_repository_test.go b/persistence/mediafile_repository_test.go index c17bc595b..2bc9d0267 100644 --- a/persistence/mediafile_repository_test.go +++ b/persistence/mediafile_repository_test.go @@ -2,15 +2,21 @@ package persistence import ( "context" + "errors" + "fmt" "time" "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/model/request" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" ) var _ = Describe("MediaRepository", func() { @@ -35,7 +41,131 @@ var _ = Describe("MediaRepository", func() { }) It("counts the number of mediafiles in the DB", func() { - Expect(mr.CountAll()).To(Equal(int64(4))) + Expect(mr.CountAll()).To(Equal(int64(13))) + }) + + Describe("CountBySuffix", func() { + var mp3File, flacFile1, flacFile2, flacUpperFile model.MediaFile + + BeforeEach(func() { + mp3File = model.MediaFile{ID: "suffix-mp3", LibraryID: 1, Suffix: "mp3", Path: "test/file.mp3"} + flacFile1 = model.MediaFile{ID: "suffix-flac1", LibraryID: 1, Suffix: "flac", Path: "test/file1.flac"} + flacFile2 = model.MediaFile{ID: "suffix-flac2", LibraryID: 1, Suffix: "flac", Path: "test/file2.flac"} + flacUpperFile = model.MediaFile{ID: "suffix-FLAC", LibraryID: 1, Suffix: "FLAC", Path: "test/file.FLAC"} + + Expect(mr.Put(&mp3File)).To(Succeed()) + Expect(mr.Put(&flacFile1)).To(Succeed()) + Expect(mr.Put(&flacFile2)).To(Succeed()) + Expect(mr.Put(&flacUpperFile)).To(Succeed()) + }) + + AfterEach(func() { + _ = mr.Delete(mp3File.ID) + _ = mr.Delete(flacFile1.ID) + _ = mr.Delete(flacFile2.ID) + _ = mr.Delete(flacUpperFile.ID) + }) + + It("counts media files grouped by suffix with lowercase normalization", func() { + counts, err := mr.CountBySuffix() + Expect(err).ToNot(HaveOccurred()) + + // Should have lowercase keys only + Expect(counts).To(HaveKey("mp3")) + Expect(counts).To(HaveKey("flac")) + Expect(counts).ToNot(HaveKey("FLAC")) + + // mp3: 1 file + Expect(counts["mp3"]).To(Equal(int64(1))) + // flac: 3 files (2 lowercase + 1 uppercase normalized) + Expect(counts["flac"]).To(Equal(int64(3))) + }) + }) + + It("returns songs ordered by lyrics with a specific title/artist", func() { + // attempt to mimic filters.SongsByArtistTitleWithLyricsFirst, except we want all items + results, err := mr.GetAll(model.QueryOptions{ + Sort: "lyrics, updated_at", + Order: "desc", + Filters: squirrel.And{ + squirrel.Eq{"title": "Antenna"}, + squirrel.Or{ + Exists("json_tree(participants, '$.albumartist')", squirrel.Eq{"value": "Kraftwerk"}), + Exists("json_tree(participants, '$.artist')", squirrel.Eq{"value": "Kraftwerk"}), + }, + }, + }) + + Expect(err).To(BeNil()) + Expect(results).To(HaveLen(3)) + Expect(results[0].Lyrics).To(Equal(`[{"lang":"xxx","line":[{"value":"This is a set of lyrics"}],"synced":false}]`)) + for _, item := range results[1:] { + Expect(item.Lyrics).To(Equal("[]")) + Expect(item.Title).To(Equal("Antenna")) + Expect(item.Participants[model.RoleArtist][0].Name).To(Equal("Kraftwerk")) + } + }) + + Describe("Put CreatedAt behavior (#5050)", func() { + It("sets CreatedAt to now when inserting a new file with zero CreatedAt", func() { + before := time.Now().Add(-time.Second) + newFile := model.MediaFile{ID: id.NewRandom(), LibraryID: 1, Path: "test/created-at-zero.mp3"} + Expect(mr.Put(&newFile)).To(Succeed()) + + retrieved, err := mr.Get(newFile.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(retrieved.CreatedAt).To(BeTemporally(">", before)) + + _ = mr.Delete(newFile.ID) + }) + + It("preserves CreatedAt when inserting a new file with non-zero CreatedAt", func() { + originalTime := time.Date(2020, 3, 15, 10, 30, 0, 0, time.UTC) + newFile := model.MediaFile{ + ID: id.NewRandom(), + LibraryID: 1, + Path: "test/created-at-preserved.mp3", + CreatedAt: originalTime, + } + Expect(mr.Put(&newFile)).To(Succeed()) + + retrieved, err := mr.Get(newFile.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(retrieved.CreatedAt).To(BeTemporally("~", originalTime, time.Second)) + + _ = mr.Delete(newFile.ID) + }) + + It("does not reset CreatedAt when updating an existing file", func() { + originalTime := time.Date(2019, 6, 1, 12, 0, 0, 0, time.UTC) + fileID := id.NewRandom() + newFile := model.MediaFile{ + ID: fileID, + LibraryID: 1, + Path: "test/created-at-update.mp3", + Title: "Original Title", + CreatedAt: originalTime, + } + Expect(mr.Put(&newFile)).To(Succeed()) + + // Update the file with a new title but zero CreatedAt + updatedFile := model.MediaFile{ + ID: fileID, + LibraryID: 1, + Path: "test/created-at-update.mp3", + Title: "Updated Title", + // CreatedAt is zero - should NOT overwrite the stored value + } + Expect(mr.Put(&updatedFile)).To(Succeed()) + + retrieved, err := mr.Get(fileID) + Expect(err).ToNot(HaveOccurred()) + Expect(retrieved.Title).To(Equal("Updated Title")) + // CreatedAt should still be the original time (not reset) + Expect(retrieved.CreatedAt).To(BeTemporally("~", originalTime, time.Second)) + + _ = mr.Delete(fileID) + }) }) It("checks existence of mediafiles in the DB", func() { @@ -92,6 +222,74 @@ var _ = Describe("MediaRepository", func() { Expect(mf.PlayCount).To(Equal(int64(1))) }) + Describe("AverageRating", func() { + var raw *mediaFileRepository + + BeforeEach(func() { + raw = mr.(*mediaFileRepository) + }) + + It("returns 0 when no ratings exist", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "test/no-rating.mp3"})).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(0.0)) + + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + + It("returns the user's rating as average when only one user rated", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "test/single-rating.mp3"})).To(Succeed()) + Expect(mr.SetRating(5, newID)).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(5.0)) + + _, _ = raw.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + + It("calculates average across multiple users", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "test/multi-rating.mp3"})).To(Succeed()) + + Expect(mr.SetRating(3, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewMediaFileRepository(user2Ctx, GetDBXBuilder()) + Expect(user2Repo.SetRating(5, newID)).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(4.0)) + + _, _ = raw.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + + It("excludes zero ratings from average calculation", func() { + newID := id.NewRandom() + Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: newID, Path: "test/zero-excluded.mp3"})).To(Succeed()) + + Expect(mr.SetRating(4, newID)).To(Succeed()) + + user2Ctx := request.WithUser(GinkgoT().Context(), regularUser) + user2Repo := NewMediaFileRepository(user2Ctx, GetDBXBuilder()) + Expect(user2Repo.SetRating(0, newID)).To(Succeed()) + + mf, err := mr.Get(newID) + Expect(err).ToNot(HaveOccurred()) + Expect(mf.AverageRating).To(Equal(4.0)) + + _, _ = raw.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": newID})) + _, _ = raw.executeSQL(squirrel.Delete("media_file").Where(squirrel.Eq{"id": newID})) + }) + }) + It("preserves play date if and only if provided date is older", func() { id := "incplay.playdate" Expect(mr.Put(&model.MediaFile{LibraryID: 1, ID: id})).To(BeNil()) @@ -131,4 +329,456 @@ var _ = Describe("MediaRepository", func() { Expect(mf.PlayCount).To(Equal(int64(1))) }) }) + + Context("Sort options", func() { + Context("recently_added sort", func() { + var testMediaFiles []model.MediaFile + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + + // Create test media files with specific timestamps + testMediaFiles = []model.MediaFile{ + { + ID: id.NewRandom(), + LibraryID: 1, + Title: "Old Song", + Path: "test/old.mp3", + }, + { + ID: id.NewRandom(), + LibraryID: 1, + Title: "Middle Song", + Path: "test/middle.mp3", + }, + { + ID: id.NewRandom(), + LibraryID: 1, + Title: "New Song", + Path: "test/new.mp3", + }, + } + + // Insert test data first + for i := range testMediaFiles { + Expect(mr.Put(&testMediaFiles[i])).To(Succeed()) + } + + // Then manually update timestamps using direct SQL to bypass the repository logic + db := GetDBXBuilder() + + // Set specific timestamps for testing + oldTime := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC) + middleTime := time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC) + newTime := time.Date(2022, 1, 1, 0, 0, 0, 0, time.UTC) + + // Update "Old Song": created long ago, updated recently + _, err := db.Update("media_file", + map[string]any{ + "created_at": oldTime, + "updated_at": newTime, + }, + dbx.HashExp{"id": testMediaFiles[0].ID}).Execute() + Expect(err).ToNot(HaveOccurred()) + + // Update "Middle Song": created and updated at the same middle time + _, err = db.Update("media_file", + map[string]any{ + "created_at": middleTime, + "updated_at": middleTime, + }, + dbx.HashExp{"id": testMediaFiles[1].ID}).Execute() + Expect(err).ToNot(HaveOccurred()) + + // Update "New Song": created recently, updated long ago + _, err = db.Update("media_file", + map[string]any{ + "created_at": newTime, + "updated_at": oldTime, + }, + dbx.HashExp{"id": testMediaFiles[2].ID}).Execute() + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + // Clean up test data + for _, mf := range testMediaFiles { + _ = mr.Delete(mf.ID) + } + }) + + When("RecentlyAddedByModTime is false", func() { + var testRepo model.MediaFileRepository + + BeforeEach(func() { + conf.Server.RecentlyAddedByModTime = false + // Create repository AFTER setting config + ctx := log.NewContext(GinkgoT().Context()) + ctx = request.WithUser(ctx, model.User{ID: "userid"}) + testRepo = NewMediaFileRepository(ctx, GetDBXBuilder()) + }) + + It("sorts by created_at", func() { + // Get results sorted by recently_added (should use created_at) + results, err := testRepo.GetAll(model.QueryOptions{ + Sort: "recently_added", + Order: "desc", + Filters: squirrel.Eq{"media_file.id": []string{testMediaFiles[0].ID, testMediaFiles[1].ID, testMediaFiles[2].ID}}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + + // Verify sorting by created_at (newest first in descending order) + Expect(results[0].Title).To(Equal("New Song")) // created 2022 + Expect(results[1].Title).To(Equal("Middle Song")) // created 2021 + Expect(results[2].Title).To(Equal("Old Song")) // created 2020 + }) + + It("sorts in ascending order when specified", func() { + // Get results sorted by recently_added in ascending order + results, err := testRepo.GetAll(model.QueryOptions{ + Sort: "recently_added", + Order: "asc", + Filters: squirrel.Eq{"media_file.id": []string{testMediaFiles[0].ID, testMediaFiles[1].ID, testMediaFiles[2].ID}}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + + // Verify sorting by created_at (oldest first) + Expect(results[0].Title).To(Equal("Old Song")) // created 2020 + Expect(results[1].Title).To(Equal("Middle Song")) // created 2021 + Expect(results[2].Title).To(Equal("New Song")) // created 2022 + }) + }) + + When("RecentlyAddedByModTime is true", func() { + var testRepo model.MediaFileRepository + + BeforeEach(func() { + conf.Server.RecentlyAddedByModTime = true + // Create repository AFTER setting config + ctx := log.NewContext(GinkgoT().Context()) + ctx = request.WithUser(ctx, model.User{ID: "userid"}) + testRepo = NewMediaFileRepository(ctx, GetDBXBuilder()) + }) + + It("sorts by updated_at", func() { + // Get results sorted by recently_added (should use updated_at) + results, err := testRepo.GetAll(model.QueryOptions{ + Sort: "recently_added", + Order: "desc", + Filters: squirrel.Eq{"media_file.id": []string{testMediaFiles[0].ID, testMediaFiles[1].ID, testMediaFiles[2].ID}}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + + // Verify sorting by updated_at (newest first in descending order) + Expect(results[0].Title).To(Equal("Old Song")) // updated 2022 + Expect(results[1].Title).To(Equal("Middle Song")) // updated 2021 + Expect(results[2].Title).To(Equal("New Song")) // updated 2020 + }) + }) + + }) + }) + + Context("Filters", func() { + var mfWithoutAnnotation model.MediaFile + + BeforeEach(func() { + mfWithoutAnnotation = model.MediaFile{ID: "no-annotation-file", LibraryID: 1, Path: "test/no-annotation.mp3", Title: "No Annotation"} + Expect(mr.Put(&mfWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _ = mr.Delete(mfWithoutAnnotation.ID) + }) + + Describe("starred", func() { + It("false includes items without annotations", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "false"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + + var found bool + for _, f := range files { + if f.ID == mfWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "MediaFile without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": "true"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + + for _, f := range files { + Expect(f.ID).ToNot(Equal(mfWithoutAnnotation.ID)) + } + }) + }) + + Describe("path", func() { + It("matches files whose path starts with the given prefix", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"path": "test/"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + + var found bool + for _, f := range files { + Expect(f.Path).To(HavePrefix("test/")) + if f.ID == mfWithoutAnnotation.ID { + found = true + } + } + Expect(found).To(BeTrue(), "MediaFile with matching path prefix should be included") + }) + + It("excludes files whose path does not start with the given prefix", func() { + res, err := mr.(model.ResourceRepository).ReadAll(rest.QueryOptions{ + Filters: map[string]any{"path": "no-such-prefix/"}, + }) + Expect(err).ToNot(HaveOccurred()) + files := res.(model.MediaFiles) + Expect(files).To(BeEmpty()) + }) + }) + }) + + Describe("Search", func() { + Context("text search", func() { + It("finds media files by title", func() { + results, err := mr.Search("Antenna", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) // songAntenna, songAntennaWithLyrics, songAntenna2 + for _, result := range results { + Expect(result.Title).To(Equal("Antenna")) + } + }) + + It("finds media files case insensitively", func() { + results, err := mr.Search("antenna", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + for _, result := range results { + Expect(result.Title).To(Equal("Antenna")) + } + }) + + It("returns empty result when no matches found", func() { + results, err := mr.Search("nonexistent", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + }) + + Context("MBID search", func() { + var mediaFileWithMBID model.MediaFile + var raw *mediaFileRepository + + BeforeEach(func() { + raw = mr.(*mediaFileRepository) + // Create a test media file with MBID + mediaFileWithMBID = model.MediaFile{ + ID: "test-mbid-mediafile", + Title: "Test MBID MediaFile", + MbzRecordingID: "550e8400-e29b-41d4-a716-446655440020", // Valid UUID v4 + MbzReleaseTrackID: "550e8400-e29b-41d4-a716-446655440021", // Valid UUID v4 + LibraryID: 1, + Path: "test/path/test.mp3", + } + + // Insert the test media file into the database + err := mr.Put(&mediaFileWithMBID) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + // Clean up test data using direct SQL + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": mediaFileWithMBID.ID})) + }) + + It("finds media file by mbz_recording_id", func() { + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440020", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("test-mbid-mediafile")) + Expect(results[0].Title).To(Equal("Test MBID MediaFile")) + }) + + It("finds media file by mbz_release_track_id", func() { + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440021", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("test-mbid-mediafile")) + Expect(results[0].Title).To(Equal("Test MBID MediaFile")) + }) + + It("returns empty result when MBID is not found", func() { + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440099", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("missing media files are never returned by search", func() { + // Create a missing media file with MBID + missingMediaFile := model.MediaFile{ + ID: "test-missing-mbid-mediafile", + Title: "Test Missing MBID MediaFile", + MbzRecordingID: "550e8400-e29b-41d4-a716-446655440022", + LibraryID: 1, + Path: "test/path/missing.mp3", + Missing: true, + } + + err := mr.Put(&missingMediaFile) + Expect(err).ToNot(HaveOccurred()) + + // Search never returns missing media files (hardcoded behavior) + results, err := mr.Search("550e8400-e29b-41d4-a716-446655440022", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + + // Clean up + _, _ = raw.executeSQL(squirrel.Delete(raw.tableName).Where(squirrel.Eq{"id": missingMediaFile.ID})) + }) + }) + }) + + Describe("FindByPaths", func() { + // Test fixtures for Unicode and case-sensitivity tests + var testFiles []model.MediaFile + + BeforeEach(func() { + testFiles = []model.MediaFile{ + {ID: "findpath-1", LibraryID: 1, Path: "artist/Album/track.mp3", Title: "Track"}, + {ID: "findpath-2", LibraryID: 1, Path: "artist/Album/UPPER.mp3", Title: "Upper"}, + // Fullwidth uppercase: ACROSS (U+FF21 U+FF23 U+FF32 U+FF2F U+FF33 U+FF33) + {ID: "findpath-3", LibraryID: 1, Path: "plex/02 - ACROSS.flac", Title: "Fullwidth"}, + // French diacritic: è (U+00E8, can decompose to e + combining grave) + {ID: "findpath-4", LibraryID: 1, Path: "artist/Michèle/song.mp3", Title: "French"}, + } + for _, mf := range testFiles { + Expect(mr.Put(&mf)).To(Succeed()) + } + }) + + AfterEach(func() { + for _, mf := range testFiles { + _ = mr.Delete(mf.ID) + } + }) + + It("finds files by exact path", func() { + results, err := mr.FindByPaths([]string{"1:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-1")) + }) + + It("finds files case-insensitively for ASCII characters (NOCASE)", func() { + // SQLite's COLLATE NOCASE handles ASCII case-insensitivity + results, err := mr.FindByPaths([]string{"1:ARTIST/ALBUM/TRACK.MP3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-1")) + }) + + It("finds fullwidth characters only with exact case match (SQLite NOCASE limitation)", func() { + // SQLite's NOCASE does NOT handle fullwidth uppercase/lowercase equivalence + // The DB has fullwidth uppercase ACROSS, searching with exact match should work + results, err := mr.FindByPaths([]string{"1:plex/02 - ACROSS.flac"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal("findpath-3")) + + // Searching with fullwidth lowercase across should NOT match + // (this is the SQLite limitation that requires exact matching for non-ASCII) + results, err = mr.FindByPaths([]string{"1:plex/02 - across.flac"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("returns multiple files when querying multiple paths", func() { + results, err := mr.FindByPaths([]string{ + "1:artist/Album/track.mp3", + "1:artist/Album/UPPER.mp3", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + }) + + It("returns empty slice for non-existent paths", func() { + results, err := mr.FindByPaths([]string{"1:nonexistent/path.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("returns empty slice for empty input", func() { + results, err := mr.FindByPaths([]string{}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + + It("handles library-qualified paths correctly", func() { + // Library 1 should find the file + results, err := mr.FindByPaths([]string{"1:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + + // Library 2 should NOT find it (file is in library 1) + results, err = mr.FindByPaths([]string{"2:artist/Album/track.mp3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty()) + }) + }) + + Describe("wrapMediaFileCursor", func() { + It("does not panic when the cursor yields a dbMediaFile with nil MediaFile", func() { + // Simulate what queryWithStableResults does on the rows.Err() path: + // it yields a zero-value dbMediaFile (where MediaFile is nil) with an error. + dbErr := fmt.Errorf("database is locked") + cursor := func(yield func(dbMediaFile, error) bool) { + var empty dbMediaFile // MediaFile pointer is nil + yield(empty, dbErr) + } + + // wrapMediaFileCursor should handle the nil MediaFile without panicking + wrappedCursor := wrapMediaFileCursor(cursor) + var gotErr error + Expect(func() { + for _, err := range wrappedCursor { + gotErr = err + } + }).ToNot(Panic()) + Expect(gotErr).To(HaveOccurred()) + Expect(gotErr.Error()).To(ContainSubstring("unexpected nil mediafile")) + Expect(errors.Is(gotErr, dbErr)).To(BeTrue(), "should wrap the original cursor error") + }) + + It("yields mediafiles from a valid cursor", func() { + mf := &model.MediaFile{ID: "mf1", Title: "Test"} + cursor := func(yield func(dbMediaFile, error) bool) { + yield(dbMediaFile{MediaFile: mf}, nil) + } + + wrappedCursor := wrapMediaFileCursor(cursor) + var mediafiles []model.MediaFile + for m, err := range wrappedCursor { + Expect(err).ToNot(HaveOccurred()) + mediafiles = append(mediafiles, m) + } + Expect(mediafiles).To(HaveLen(1)) + Expect(mediafiles[0].ID).To(Equal("mf1")) + }) + }) }) diff --git a/persistence/persistence.go b/persistence/persistence.go index 2536b9c35..83211bdd5 100644 --- a/persistence/persistence.go +++ b/persistence/persistence.go @@ -9,7 +9,7 @@ import ( "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/utils/chain" + "github.com/navidrome/navidrome/utils/run" "github.com/pocketbase/dbx" ) @@ -89,7 +89,15 @@ func (s *SQLStore) ScrobbleBuffer(ctx context.Context) model.ScrobbleBufferRepos return NewScrobbleBufferRepository(ctx, s.getDBXBuilder()) } -func (s *SQLStore) Resource(ctx context.Context, m interface{}) model.ResourceRepository { +func (s *SQLStore) Scrobble(ctx context.Context) model.ScrobbleRepository { + return NewScrobbleRepository(ctx, s.getDBXBuilder()) +} + +func (s *SQLStore) Plugin(ctx context.Context) model.PluginRepository { + return NewPluginRepository(ctx, s.getDBXBuilder()) +} + +func (s *SQLStore) Resource(ctx context.Context, m any) model.ResourceRepository { switch m.(type) { case model.User: return s.User(ctx).(model.ResourceRepository) @@ -113,6 +121,8 @@ func (s *SQLStore) Resource(ctx context.Context, m interface{}) model.ResourceRe return s.Share(ctx).(model.ResourceRepository) case model.Tag: return s.Tag(ctx).(model.ResourceRepository) + case model.Plugin: + return s.Plugin(ctx).(model.ResourceRepository) } log.Error("Resource not implemented", "model", reflect.TypeOf(m).Name()) return nil @@ -157,7 +167,7 @@ func (s *SQLStore) WithTxImmediate(block func(tx model.DataStore) error, scope . }, scope...) } -func (s *SQLStore) GC(ctx context.Context) error { +func (s *SQLStore) GC(ctx context.Context, libraryIDs ...int) error { trace := func(ctx context.Context, msg string, f func() error) func() error { return func() error { start := time.Now() @@ -167,11 +177,17 @@ func (s *SQLStore) GC(ctx context.Context) error { } } - err := chain.RunSequentially( - trace(ctx, "purge empty albums", func() error { return s.Album(ctx).(*albumRepository).purgeEmpty() }), + // If libraryIDs are provided, scope operations to those libraries where possible + scoped := len(libraryIDs) > 0 + if scoped { + log.Debug(ctx, "GC: Running selective garbage collection", "libraryIDs", libraryIDs) + } + + err := run.Sequentially( + trace(ctx, "purge empty albums", func() error { return s.Album(ctx).(*albumRepository).purgeEmpty(libraryIDs...) }), trace(ctx, "purge empty artists", func() error { return s.Artist(ctx).(*artistRepository).purgeEmpty() }), trace(ctx, "mark missing artists", func() error { return s.Artist(ctx).(*artistRepository).markMissing() }), - trace(ctx, "purge empty folders", func() error { return s.Folder(ctx).(*folderRepository).purgeEmpty() }), + trace(ctx, "purge empty folders", func() error { return s.Folder(ctx).(*folderRepository).purgeEmpty(libraryIDs...) }), trace(ctx, "clean album annotations", func() error { return s.Album(ctx).(*albumRepository).cleanAnnotations() }), trace(ctx, "clean artist annotations", func() error { return s.Artist(ctx).(*artistRepository).cleanAnnotations() }), trace(ctx, "clean media file annotations", func() error { return s.MediaFile(ctx).(*mediaFileRepository).cleanAnnotations() }), diff --git a/persistence/persistence_suite_test.go b/persistence/persistence_suite_test.go index 43e4c292b..abc5c4b6a 100644 --- a/persistence/persistence_suite_test.go +++ b/persistence/persistence_suite_test.go @@ -5,6 +5,7 @@ import ( "path/filepath" "testing" + "github.com/Masterminds/squirrel" _ "github.com/mattn/go-sqlite3" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/db" @@ -33,56 +34,107 @@ func mf(mf model.MediaFile) model.MediaFile { mf.Tags = model.Tags{} mf.LibraryID = 1 mf.LibraryPath = "music" // Default folder + mf.LibraryName = "Music Library" mf.Participants = model.Participants{ model.RoleArtist: model.ParticipantList{ model.Participant{Artist: model.Artist{ID: mf.ArtistID, Name: mf.Artist}}, }, } + if mf.Lyrics == "" { + mf.Lyrics = "[]" + } return mf } func al(al model.Album) model.Album { al.LibraryID = 1 + al.LibraryPath = "music" + al.LibraryName = "Music Library" al.Discs = model.Discs{} al.Tags = model.Tags{} al.Participants = model.Participants{} return al } +func alWithTags(a model.Album, tags model.Tags) model.Album { + a = al(a) + a.Tags = tags + return a +} + var ( - artistKraftwerk = model.Artist{ID: "2", Name: "Kraftwerk", OrderArtistName: "kraftwerk"} - artistBeatles = model.Artist{ID: "3", Name: "The Beatles", OrderArtistName: "beatles"} - testArtists = model.Artists{ + artistKraftwerk = model.Artist{ID: "2", Name: "Kraftwerk", OrderArtistName: "kraftwerk"} + artistBeatles = model.Artist{ID: "3", Name: "The Beatles", OrderArtistName: "beatles"} + artistCJK = model.Artist{ID: "4", Name: "シートベルツ", SortArtistName: "Seatbelts", OrderArtistName: "seatbelts"} + artistPunctuation = model.Artist{ID: "5", Name: "The Roots", OrderArtistName: "roots"} + testArtists = model.Artists{ artistKraftwerk, artistBeatles, + artistCJK, + artistPunctuation, } ) var ( - albumSgtPeppers = al(model.Album{ID: "101", Name: "Sgt Peppers", AlbumArtist: "The Beatles", OrderAlbumName: "sgt peppers", AlbumArtistID: "3", EmbedArtPath: p("/beatles/1/sgt/a day.mp3"), SongCount: 1, MaxYear: 1967}) - albumAbbeyRoad = al(model.Album{ID: "102", Name: "Abbey Road", AlbumArtist: "The Beatles", OrderAlbumName: "abbey road", AlbumArtistID: "3", EmbedArtPath: p("/beatles/1/come together.mp3"), SongCount: 1, MaxYear: 1969}) - albumRadioactivity = al(model.Album{ID: "103", Name: "Radioactivity", AlbumArtist: "Kraftwerk", OrderAlbumName: "radioactivity", AlbumArtistID: "2", EmbedArtPath: p("/kraft/radio/radio.mp3"), SongCount: 2}) - testAlbums = model.Albums{ + albumSgtPeppers = al(model.Album{ID: "101", Name: "Sgt Peppers", AlbumArtist: "The Beatles", OrderAlbumName: "sgt peppers", AlbumArtistID: "3", EmbedArtPath: p("beatles/1/sgt/a day.mp3"), SongCount: 1, MaxYear: 1967}) + albumAbbeyRoad = al(model.Album{ID: "102", Name: "Abbey Road", AlbumArtist: "The Beatles", OrderAlbumName: "abbey road", AlbumArtistID: "3", EmbedArtPath: p("beatles/1/come together.mp3"), SongCount: 1, MaxYear: 1969}) + albumRadioactivity = al(model.Album{ID: "103", Name: "Radioactivity", AlbumArtist: "Kraftwerk", OrderAlbumName: "radioactivity", AlbumArtistID: "2", EmbedArtPath: p("kraft/radio/radio.mp3"), SongCount: 2}) + albumMultiDisc = al(model.Album{ID: "104", Name: "Multi Disc Album", AlbumArtist: "Test Artist", OrderAlbumName: "multi disc album", AlbumArtistID: "1", EmbedArtPath: p("test/multi/disc1/track1.mp3"), SongCount: 4}) + albumCJK = al(model.Album{ID: "105", Name: "COWBOY BEBOP", AlbumArtist: "シートベルツ", OrderAlbumName: "cowboy bebop", AlbumArtistID: "4", EmbedArtPath: p("seatbelts/cowboy-bebop/track1.mp3"), SongCount: 1}) + albumWithVersion = alWithTags(model.Album{ID: "106", Name: "Abbey Road", AlbumArtist: "The Beatles", OrderAlbumName: "abbey road", AlbumArtistID: "3", EmbedArtPath: p("beatles/2/come together.mp3"), SongCount: 1, MaxYear: 2019}, + model.Tags{model.TagAlbumVersion: {"Deluxe Edition"}}) + albumPunctuation = al(model.Album{ID: "107", Name: "Things Fall Apart", AlbumArtist: "The Roots", OrderAlbumName: "things fall apart", AlbumArtistID: "5", EmbedArtPath: p("roots/things/track1.mp3"), SongCount: 1}) + testAlbums = model.Albums{ albumSgtPeppers, albumAbbeyRoad, albumRadioactivity, + albumMultiDisc, + albumCJK, + albumWithVersion, + albumPunctuation, } ) var ( - songDayInALife = mf(model.MediaFile{ID: "1001", Title: "A Day In A Life", ArtistID: "3", Artist: "The Beatles", AlbumID: "101", Album: "Sgt Peppers", Path: p("/beatles/1/sgt/a day.mp3")}) - songComeTogether = mf(model.MediaFile{ID: "1002", Title: "Come Together", ArtistID: "3", Artist: "The Beatles", AlbumID: "102", Album: "Abbey Road", Path: p("/beatles/1/come together.mp3")}) - songRadioactivity = mf(model.MediaFile{ID: "1003", Title: "Radioactivity", ArtistID: "2", Artist: "Kraftwerk", AlbumID: "103", Album: "Radioactivity", Path: p("/kraft/radio/radio.mp3")}) + songDayInALife = mf(model.MediaFile{ID: "1001", Title: "A Day In A Life", ArtistID: "3", Artist: "The Beatles", AlbumID: "101", Album: "Sgt Peppers", Path: p("beatles/1/sgt/a day.mp3")}) + songComeTogether = mf(model.MediaFile{ID: "1002", Title: "Come Together", ArtistID: "3", Artist: "The Beatles", AlbumID: "102", Album: "Abbey Road", Path: p("beatles/1/come together.mp3")}) + songRadioactivity = mf(model.MediaFile{ID: "1003", Title: "Radioactivity", ArtistID: "2", Artist: "Kraftwerk", AlbumID: "103", Album: "Radioactivity", Path: p("kraft/radio/radio.mp3")}) songAntenna = mf(model.MediaFile{ID: "1004", Title: "Antenna", ArtistID: "2", Artist: "Kraftwerk", AlbumID: "103", - Path: p("/kraft/radio/antenna.mp3"), - RGAlbumGain: 1.0, RGAlbumPeak: 2.0, RGTrackGain: 3.0, RGTrackPeak: 4.0, + Path: p("kraft/radio/antenna.mp3"), + RGAlbumGain: new(1.0), RGAlbumPeak: new(2.0), RGTrackGain: new(3.0), RGTrackPeak: new(4.0), }) - testSongs = model.MediaFiles{ + songAntennaWithLyrics = mf(model.MediaFile{ + ID: "1005", + Title: "Antenna", + ArtistID: "2", + Artist: "Kraftwerk", + AlbumID: "103", + Lyrics: `[{"lang":"xxx","line":[{"value":"This is a set of lyrics"}],"synced":false}]`, + }) + songAntenna2 = mf(model.MediaFile{ID: "1006", Title: "Antenna", ArtistID: "2", Artist: "Kraftwerk", AlbumID: "103"}) + // Multi-disc album tracks (intentionally out of order to test sorting) + songDisc2Track11 = mf(model.MediaFile{ID: "2001", Title: "Disc 2 Track 11", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 2, TrackNumber: 11, Path: p("test/multi/disc2/track11.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songDisc1Track01 = mf(model.MediaFile{ID: "2002", Title: "Disc 1 Track 1", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 1, TrackNumber: 1, Path: p("test/multi/disc1/track1.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songDisc2Track01 = mf(model.MediaFile{ID: "2003", Title: "Disc 2 Track 1", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 2, TrackNumber: 1, Path: p("test/multi/disc2/track1.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songDisc1Track02 = mf(model.MediaFile{ID: "2004", Title: "Disc 1 Track 2", ArtistID: "1", Artist: "Test Artist", AlbumID: "104", Album: "Multi Disc Album", DiscNumber: 1, TrackNumber: 2, Path: p("test/multi/disc1/track2.mp3"), OrderAlbumName: "multi disc album", OrderArtistName: "test artist"}) + songCJK = mf(model.MediaFile{ID: "3001", Title: "プラチナ・ジェット", ArtistID: "4", Artist: "シートベルツ", AlbumID: "105", Album: "COWBOY BEBOP", Path: p("seatbelts/cowboy-bebop/track1.mp3")}) + songVersioned = mf(model.MediaFile{ID: "3002", Title: "Come Together", ArtistID: "3", Artist: "The Beatles", AlbumID: "106", Album: "Abbey Road", Path: p("beatles/2/come together.mp3")}) + songPunctuation = mf(model.MediaFile{ID: "3003", Title: "!!!!!!!", ArtistID: "5", Artist: "The Roots", AlbumID: "107", Album: "Things Fall Apart", Path: p("roots/things/track1.mp3")}) + testSongs = model.MediaFiles{ songDayInALife, songComeTogether, songRadioactivity, songAntenna, + songAntennaWithLyrics, + songAntenna2, + songDisc2Track11, + songDisc1Track01, + songDisc2Track01, + songDisc1Track02, + songCJK, + songVersioned, + songPunctuation, } ) @@ -101,15 +153,14 @@ var ( var ( adminUser = model.User{ID: "userid", UserName: "userid", Name: "admin", Email: "admin@email.com", IsAdmin: true} regularUser = model.User{ID: "2222", UserName: "regular-user", Name: "Regular User", Email: "regular@example.com"} - testUsers = model.Users{adminUser, regularUser} + thirdUser = model.User{ID: "3333", UserName: "third-user", Name: "Third User", Email: "third@example.com"} + testUsers = model.Users{adminUser, regularUser, thirdUser} ) func p(path string) string { return filepath.FromSlash(path) } -// Initialize test DB -// TODO Load this data setup from file(s) var _ = BeforeSuite(func() { conn := GetDBXBuilder() ctx := log.NewContext(context.TODO()) @@ -123,19 +174,17 @@ var _ = BeforeSuite(func() { } } - //gr := NewGenreRepository(ctx, conn) - //for i := range testGenres { - // g := testGenres[i] - // err := gr.Put(&g) - // if err != nil { - // panic(err) - // } - //} + // Associate users with library 1 (default test library) + for i := range testUsers { + err := ur.SetUserLibraries(testUsers[i].ID, []int{1}) + if err != nil { + panic(err) + } + } alr := NewAlbumRepository(ctx, conn).(*albumRepository) for i := range testAlbums { - a := testAlbums[i] - err := alr.Put(&a) + err := alr.Put(new(testAlbums[i])) if err != nil { panic(err) } @@ -143,8 +192,37 @@ var _ = BeforeSuite(func() { arr := NewArtistRepository(ctx, conn) for i := range testArtists { - a := testArtists[i] - err := arr.Put(&a) + err := arr.Put(new(testArtists[i])) + if err != nil { + panic(err) + } + } + + // Associate artists with library 1 (default test library) + lr := NewLibraryRepository(ctx, conn) + for i := range testArtists { + err := lr.AddArtist(1, testArtists[i].ID) + if err != nil { + panic(err) + } + } + + // Populate album_artists based on the AlbumArtistID relationships in testAlbums + artistIDs := map[string]bool{} + for _, a := range testArtists { + artistIDs[a.ID] = true + } + for i := range testAlbums { + a := testAlbums[i] + if a.AlbumArtistID == "" || !artistIDs[a.AlbumArtistID] { + continue + } + _, err := alr.executeSQL(squirrel.Insert("album_artists").SetMap(map[string]any{ + "album_id": a.ID, + "artist_id": a.AlbumArtistID, + "role": "artist", + "sub_role": "", + })) if err != nil { panic(err) } @@ -160,8 +238,7 @@ var _ = BeforeSuite(func() { rar := NewRadioRepository(ctx, conn) for i := range testRadios { - r := testRadios[i] - err := rar.Put(&r) + err := rar.Put(new(testRadios[i])) if err != nil { panic(err) } @@ -175,9 +252,9 @@ var _ = BeforeSuite(func() { Public: true, SongCount: 2, } - plsBest.AddTracks([]string{"1001", "1003"}) + plsBest.AddMediaFilesByID([]string{"1001", "1003"}) plsCool = model.Playlist{Name: "Cool", OwnerID: "userid", OwnerName: "userid"} - plsCool.AddTracks([]string{"1004"}) + plsCool.AddMediaFilesByID([]string{"1004"}) testPlaylists = []*model.Playlist{&plsBest, &plsCool} pr := NewPlaylistRepository(ctx, conn) @@ -192,7 +269,13 @@ var _ = BeforeSuite(func() { if err := arr.SetStar(true, artistBeatles.ID); err != nil { panic(err) } - ar, _ := arr.Get(artistBeatles.ID) + ar, err := arr.Get(artistBeatles.ID) + if err != nil { + panic(err) + } + if ar == nil { + panic("artist not found after SetStar") + } artistBeatles.Starred = true artistBeatles.StarredAt = ar.StarredAt testArtists[1] = artistBeatles @@ -204,6 +287,9 @@ var _ = BeforeSuite(func() { if err != nil { panic(err) } + if al == nil { + panic("album not found after SetStar") + } albumRadioactivity.Starred = true albumRadioactivity.StarredAt = al.StarredAt testAlbums[2] = albumRadioactivity diff --git a/persistence/player_repository.go b/persistence/player_repository.go index 73c820753..353b0444f 100644 --- a/persistence/player_repository.go +++ b/persistence/player_repository.go @@ -62,18 +62,6 @@ func (r *playerRepository) newRestSelect(options ...model.QueryOptions) SelectBu return s.Where(r.addRestriction()) } -func (r *playerRepository) addRestriction(sql ...Sqlizer) Sqlizer { - s := And{} - if len(sql) > 0 { - s = append(s, sql[0]) - } - u := loggedUser(r.ctx) - if u.IsAdmin { - return s - } - return append(s, Eq{"user_id": u.ID}) -} - func (r *playerRepository) CountByClient(options ...model.QueryOptions) (map[string]int64, error) { sel := r.newSelect(options...). Columns( @@ -103,14 +91,14 @@ func (r *playerRepository) Count(options ...rest.QueryOptions) (int64, error) { return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *playerRepository) Read(id string) (interface{}, error) { +func (r *playerRepository) Read(id string) (any, error) { sel := r.newRestSelect().Where(Eq{"player.id": id}) var res model.Player err := r.queryOne(sel, &res) return &res, err } -func (r *playerRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *playerRepository) ReadAll(options ...rest.QueryOptions) (any, error) { sel := r.newRestSelect(r.parseRestOptions(r.ctx, options...)) res := model.Players{} err := r.queryAll(sel, &res) @@ -121,16 +109,20 @@ func (r *playerRepository) EntityName() string { return "player" } -func (r *playerRepository) NewInstance() interface{} { +func (r *playerRepository) NewInstance() any { return &model.Player{} } +// isPermitted authorizes creating a new record, based on the owner declared in the request body. +// This is only safe for inserts: there is no stored row yet, and a non-admin may only create a +// player they own. Updates must not use this (the body owner is attacker-controlled); they go +// through updateOwned, which authorizes against the persisted user_id in the WHERE clause. func (r *playerRepository) isPermitted(p *model.Player) bool { u := loggedUser(r.ctx) return u.IsAdmin || p.UserId == u.ID } -func (r *playerRepository) Save(entity interface{}) (string, error) { +func (r *playerRepository) Save(entity any) (string, error) { t := entity.(*model.Player) if !r.isPermitted(t) { return "", rest.ErrPermissionDenied @@ -142,26 +134,14 @@ func (r *playerRepository) Save(entity interface{}) (string, error) { return id, err } -func (r *playerRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *playerRepository) Update(id string, entity any, cols ...string) error { t := entity.(*model.Player) t.ID = id - if !r.isPermitted(t) { - return rest.ErrPermissionDenied - } - _, err := r.put(id, t, cols...) - if errors.Is(err, model.ErrNotFound) { - return rest.ErrNotFound - } - return err + return r.updateOwned(id, t, cols...) } func (r *playerRepository) Delete(id string) error { - filter := r.addRestriction(And{Eq{"player.id": id}}) - err := r.delete(filter) - if errors.Is(err, model.ErrNotFound) { - return rest.ErrNotFound - } - return err + return r.deleteOwned(id) } var _ model.PlayerRepository = (*playerRepository)(nil) diff --git a/persistence/player_repository_test.go b/persistence/player_repository_test.go index f6c669493..b7085a1fb 100644 --- a/persistence/player_repository_test.go +++ b/persistence/player_repository_test.go @@ -110,33 +110,43 @@ var _ = Describe("PlayerRepository", func() { }) Describe("Delete", func() { - DescribeTable("item type", func(player model.Player) { - err := repo.Delete(player.ID) + It("deletes a player owned by the current user", func() { + err := repo.Delete(userPlayer.ID) Expect(err).To(BeNil()) - isReal := player.UserId != "" - canDelete := admin || player.UserId == userPlayer.UserId - count, err := repo.Count() Expect(err).To(BeNil()) + Expect(count).To(Equal(baseCount - 1)) - if isReal && canDelete { - Expect(count).To(Equal(baseCount - 1)) - } else { - Expect(count).To(Equal(baseCount)) - } + _, err = repo.Get(userPlayer.ID) + Expect(err).To(Equal(model.ErrNotFound)) + }) - item, err := repo.Get(player.ID) - if !isReal || canDelete { + It("does not delete another user's player when not admin", func() { + err := repo.Delete(otherPlayer.ID) + + if admin { + // Admins may delete any player. + Expect(err).To(BeNil()) + Expect(repo.Count()).To(Equal(baseCount - 1)) + _, err = repo.Get(otherPlayer.ID) Expect(err).To(Equal(model.ErrNotFound)) } else { - Expect(*item).To(Equal(player)) + // The ownership-restricted delete matches no owned row, so it reports + // permission-denied and leaves the other user's player untouched. + Expect(err).To(Equal(rest.ErrPermissionDenied)) + Expect(repo.Count()).To(Equal(baseCount)) + item, err := repo.Get(otherPlayer.ID) + Expect(err).To(BeNil()) + Expect(*item).To(Equal(otherPlayer)) } - }, - Entry("same user", userPlayer), - Entry("other item", otherPlayer), - Entry("fake item", model.Player{}), - ) + }) + + It("returns not-found for a nonexistent player", func() { + err := repo.Delete("i don't exist") + Expect(err).To(Equal(rest.ErrNotFound)) + Expect(repo.Count()).To(Equal(baseCount)) + }) }) Describe("Read", func() { @@ -215,9 +225,12 @@ var _ = Describe("PlayerRepository", func() { clone.MaxBitRate = 10000 err := repo.Update(clone.ID, &clone, "ip") - if clone.UserId == "" { + if player.UserId == "" { Expect(err).To(HaveOccurred()) } else if !admin && player.Username == adminPlayer1.Username { + // A non-admin cannot target another user's player: the ownership-restricted + // update matches no owned row, so it reports permission-denied rather than + // touching it. Expect(err).To(Equal(rest.ErrPermissionDenied)) clone.IP = player.IP } else { @@ -244,4 +257,86 @@ var _ = Describe("PlayerRepository", func() { Entry("admin context", true, players, adminPlayer1, regularPlayer), Entry("regular context", false, model.Players{regularPlayer}, regularPlayer, adminPlayer1), ) + + Describe("Ownership enforcement (cross-tenant write protection)", func() { + var regularRepo *playerRepository + + BeforeEach(func() { + ctx := log.NewContext(context.TODO()) + ctx = request.WithUser(ctx, regularUser) + regularRepo = NewPlayerRepository(ctx, database).(*playerRepository) + }) + + It("does not let a regular user hijack another user's player by spoofing userId in the body", func() { + // Attacker (regularUser) targets the victim's (adminUser) player by URL id, + // but sets userId in the body to their own id to try to pass the permission check. + spoofed := model.Player{ + ID: adminPlayer1.ID, + Name: "HIJACKED", + UserId: regularUser.ID, // attacker's own id, spoofed in the body + MaxBitRate: 1, + } + + // The ownership-restricted update matches no row owned by the attacker, so the write + // targets nothing and reports permission-denied rather than overwriting the victim's row. + err := regularRepo.Update(adminPlayer1.ID, &spoofed, "name", "user_id", "max_bit_rate") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + + // The victim's player must remain untouched. + stored, err := adminRepo.Get(adminPlayer1.ID) + Expect(err).To(BeNil()) + Expect(*stored).To(Equal(adminPlayer1)) + }) + + It("does not let a regular user reassign their own player to another user", func() { + // Owner updates their own player but tries to give it away to the admin. The update + // succeeds for the other fields, but user_id is never written, so ownership stays put. + reassign := regularPlayer + reassign.UserId = adminUser.ID + reassign.Name = "given-away" + + err := regularRepo.Update(regularPlayer.ID, &reassign, "name", "user_id") + Expect(err).To(BeNil()) + + // Ownership must not have changed. + stored, err := adminRepo.Get(regularPlayer.ID) + Expect(err).To(BeNil()) + Expect(stored.UserId).To(Equal(regularUser.ID)) + }) + + It("does not let an admin reassign a player to another user", func() { + // Even an admin cannot change a player's owner via update. + reassign := regularPlayer + reassign.UserId = adminUser.ID + reassign.Name = "admin-renamed" + + err := adminRepo.Update(regularPlayer.ID, &reassign, "name", "user_id") + Expect(err).To(BeNil()) + + // The name change applies, but ownership must not have moved. + stored, err := adminRepo.Get(regularPlayer.ID) + Expect(err).To(BeNil()) + Expect(stored.Name).To(Equal("admin-renamed")) + Expect(stored.UserId).To(Equal(regularUser.ID)) + }) + + It("lets the owner update their own player", func() { + update := regularPlayer + update.Name = "renamed-by-owner" + + err := regularRepo.Update(regularPlayer.ID, &update, "name") + Expect(err).To(BeNil()) + + stored, err := adminRepo.Get(regularPlayer.ID) + Expect(err).To(BeNil()) + Expect(stored.Name).To(Equal("renamed-by-owner")) + Expect(stored.UserId).To(Equal(regularUser.ID)) + }) + + It("returns not found when updating a nonexistent player", func() { + ghost := model.Player{ID: "does-not-exist", Name: "ghost", UserId: regularUser.ID} + err := regularRepo.Update("does-not-exist", &ghost, "name") + Expect(err).To(Equal(rest.ErrNotFound)) + }) + }) }) diff --git a/persistence/playlist_repository.go b/persistence/playlist_repository.go index 743eca470..4152505d2 100644 --- a/persistence/playlist_repository.go +++ b/persistence/playlist_repository.go @@ -11,10 +11,8 @@ import ( . "github.com/Masterminds/squirrel" "github.com/deluan/rest" - "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/criteria" "github.com/pocketbase/dbx" ) @@ -61,14 +59,14 @@ func NewPlaylistRepository(ctx context.Context, db dbx.Builder) model.PlaylistRe return r } -func playlistFilter(_ string, value interface{}) Sqlizer { +func playlistFilter(_ string, value any) Sqlizer { return Or{ substringFilter("playlist.name", value), substringFilter("playlist.comment", value), } } -func smartPlaylistFilter(string, interface{}) Sqlizer { +func smartPlaylistFilter(string, any) Sqlizer { return Or{ Eq{"rules": ""}, Eq{"rules": nil}, @@ -96,31 +94,20 @@ func (r *playlistRepository) Exists(id string) (bool, error) { } func (r *playlistRepository) Delete(id string) error { - usr := loggedUser(r.ctx) - if !usr.IsAdmin { - pls, err := r.Get(id) - if err != nil { - return err - } - if pls.OwnerID != usr.ID { - return rest.ErrPermissionDenied - } - } return r.delete(And{Eq{"id": id}, r.userFilter()}) } -func (r *playlistRepository) Put(p *model.Playlist) error { +func (r *playlistRepository) Put(p *model.Playlist, cols ...string) error { pls := dbPlaylist{Playlist: *p} + if len(cols) > 0 { + if pls.ID == "" { + return errors.New("playlist id is required for partial update") + } + _, err := r.put(pls.ID, pls, cols...) + return err + } if pls.ID == "" { pls.CreatedAt = time.Now() - } else { - ok, err := r.Exists(pls.ID) - if err != nil { - return err - } - if !ok { - return model.ErrNotAuthorized - } } pls.UpdatedAt = time.Now() @@ -132,7 +119,6 @@ func (r *playlistRepository) Put(p *model.Playlist) error { if p.IsSmartPlaylist() { // Do not update tracks at this point, as it may take a long time and lock the DB, breaking the scan process - //r.refreshSmartPlaylist(p) return nil } // Only update tracks if they were specified @@ -161,7 +147,7 @@ func (r *playlistRepository) GetWithTracks(id string, refreshSmartPlaylist, incl log.Error(r.ctx, "Error loading playlist tracks ", "playlist", pls.Name, "id", pls.ID, err) return nil, err } - pls.Tracks = tracks + pls.SetTracks(tracks) return pls, nil } @@ -197,93 +183,30 @@ func (r *playlistRepository) GetAll(options ...model.QueryOptions) (model.Playli return playlists, err } +func (r *playlistRepository) GetPlaylists(mediaFileId string) (model.Playlists, error) { + sel := r.selectPlaylist(model.QueryOptions{Sort: "name"}). + Join("playlist_tracks on playlist.id = playlist_tracks.playlist_id"). + Where(And{Eq{"playlist_tracks.media_file_id": mediaFileId}, r.userFilter()}) + var res []dbPlaylist + err := r.queryAll(sel, &res) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.Playlists{}, nil + } + return nil, err + } + playlists := make(model.Playlists, len(res)) + for i, p := range res { + playlists[i] = p.Playlist + } + return playlists, nil +} + func (r *playlistRepository) selectPlaylist(options ...model.QueryOptions) SelectBuilder { return r.newSelect(options...).Join("user on user.id = owner_id"). Columns(r.tableName+".*", "user.user_name as owner_name") } -func (r *playlistRepository) refreshSmartPlaylist(pls *model.Playlist) bool { - // Only refresh if it is a smart playlist and was not refreshed within the interval provided by the refresh delay config - if !pls.IsSmartPlaylist() || (pls.EvaluatedAt != nil && time.Since(*pls.EvaluatedAt) < conf.Server.SmartPlaylistRefreshDelay) { - return false - } - - // Never refresh other users' playlists - usr := loggedUser(r.ctx) - if pls.OwnerID != usr.ID { - log.Trace(r.ctx, "Not refreshing smart playlist from other user", "playlist", pls.Name, "id", pls.ID) - return false - } - - log.Debug(r.ctx, "Refreshing smart playlist", "playlist", pls.Name, "id", pls.ID) - start := time.Now() - - // Remove old tracks - del := Delete("playlist_tracks").Where(Eq{"playlist_id": pls.ID}) - _, err := r.executeSQL(del) - if err != nil { - log.Error(r.ctx, "Error deleting old smart playlist tracks", "playlist", pls.Name, "id", pls.ID, err) - return false - } - - // Re-populate playlist based on Smart Playlist criteria - rules := *pls.Rules - - // If the playlist depends on other playlists, recursively refresh them first - childPlaylistIds := rules.ChildPlaylistIds() - for _, id := range childPlaylistIds { - childPls, err := r.Get(id) - if err != nil { - log.Error(r.ctx, "Error loading child playlist", "id", pls.ID, "childId", id, err) - return false - } - r.refreshSmartPlaylist(childPls) - } - - sq := Select("row_number() over (order by "+rules.OrderBy()+") as id", "'"+pls.ID+"' as playlist_id", "media_file.id as media_file_id"). - From("media_file").LeftJoin("annotation on (" + - "annotation.item_id = media_file.id" + - " AND annotation.item_type = 'media_file'" + - " AND annotation.user_id = '" + userId(r.ctx) + "')") - sq = r.addCriteria(sq, rules) - insSql := Insert("playlist_tracks").Columns("id", "playlist_id", "media_file_id").Select(sq) - _, err = r.executeSQL(insSql) - if err != nil { - log.Error(r.ctx, "Error refreshing smart playlist tracks", "playlist", pls.Name, "id", pls.ID, err) - return false - } - - // Update playlist stats - err = r.refreshCounters(pls) - if err != nil { - log.Error(r.ctx, "Error updating smart playlist stats", "playlist", pls.Name, "id", pls.ID, err) - return false - } - - // Update when the playlist was last refreshed (for cache purposes) - updSql := Update(r.tableName).Set("evaluated_at", time.Now()).Where(Eq{"id": pls.ID}) - _, err = r.executeSQL(updSql) - if err != nil { - log.Error(r.ctx, "Error updating smart playlist", "playlist", pls.Name, "id", pls.ID, err) - return false - } - - log.Debug(r.ctx, "Refreshed playlist", "playlist", pls.Name, "id", pls.ID, "numTracks", pls.SongCount, "elapsed", time.Since(start)) - - return true -} - -func (r *playlistRepository) addCriteria(sql SelectBuilder, c criteria.Criteria) SelectBuilder { - sql = sql.Where(c) - if c.Limit > 0 { - sql = sql.Limit(uint64(c.Limit)).Offset(uint64(c.Offset)) - } - if order := c.OrderBy(); order != "" { - sql = sql.OrderBy(order) - } - return sql -} - func (r *playlistRepository) updateTracks(id string, tracks model.MediaFiles) error { ids := make([]string, len(tracks)) for i := range tracks { @@ -293,10 +216,6 @@ func (r *playlistRepository) updateTracks(id string, tracks model.MediaFiles) er } func (r *playlistRepository) updatePlaylist(playlistId string, mediaFileIds []string) error { - if !r.isWritable(playlistId) { - return rest.ErrPermissionDenied - } - // Remove old tracks del := Delete("playlist_tracks").Where(Eq{"playlist_id": playlistId}) _, err := r.executeSQL(del) @@ -360,6 +279,8 @@ func (r *playlistRepository) refreshCounters(pls *model.Playlist) error { } func (r *playlistRepository) loadTracks(sel SelectBuilder, id string) (model.PlaylistTracks, error) { + sel = r.applyLibraryFilter(sel, "f") + userID := loggedUser(r.ctx).ID tracksQuery := sel. Columns( "coalesce(starred, 0) as starred", @@ -367,14 +288,16 @@ func (r *playlistRepository) loadTracks(sel SelectBuilder, id string) (model.Pla "coalesce(play_count, 0) as play_count", "play_date", "coalesce(rating, 0) as rating", + "rated_at", "f.*", "playlist_tracks.*", "library.path as library_path", + "library.name as library_name", ). LeftJoin("annotation on (" + "annotation.item_id = media_file_id" + " AND annotation.item_type = 'media_file'" + - " AND annotation.user_id = '" + userId(r.ctx) + "')"). + " AND annotation.user_id = '" + userID + "')"). Join("media_file f on f.id = media_file_id"). Join("library on f.library_id = library.id"). Where(Eq{"playlist_id": id}) @@ -390,11 +313,11 @@ func (r *playlistRepository) Count(options ...rest.QueryOptions) (int64, error) return r.CountAll(r.parseRestOptions(r.ctx, options...)) } -func (r *playlistRepository) Read(id string) (interface{}, error) { +func (r *playlistRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *playlistRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *playlistRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -402,14 +325,13 @@ func (r *playlistRepository) EntityName() string { return "playlist" } -func (r *playlistRepository) NewInstance() interface{} { +func (r *playlistRepository) NewInstance() any { return &model.Playlist{} } -func (r *playlistRepository) Save(entity interface{}) (string, error) { +func (r *playlistRepository) Save(entity any) (string, error) { pls := entity.(*model.Playlist) - pls.OwnerID = loggedUser(r.ctx).ID - pls.ID = "" // Make sure we don't override an existing playlist + pls.ID = "" // Force new creation err := r.Put(pls) if err != nil { return "", err @@ -417,26 +339,11 @@ func (r *playlistRepository) Save(entity interface{}) (string, error) { return pls.ID, err } -func (r *playlistRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *playlistRepository) Update(id string, entity any, cols ...string) error { pls := dbPlaylist{Playlist: *entity.(*model.Playlist)} - current, err := r.Get(id) - if err != nil { - return err - } - usr := loggedUser(r.ctx) - if !usr.IsAdmin { - // Only the owner can update the playlist - if current.OwnerID != usr.ID { - return rest.ErrPermissionDenied - } - // Regular users can't change the ownership of a playlist - if pls.OwnerID != "" && pls.OwnerID != usr.ID { - return rest.ErrPermissionDenied - } - } pls.ID = id pls.UpdatedAt = time.Now() - _, err = r.put(id, pls, append(cols, "updatedAt")...) + _, err := r.put(id, pls, append(cols, "updatedAt")...) if errors.Is(err, model.ErrNotFound) { return rest.ErrNotFound } @@ -476,23 +383,31 @@ func (r *playlistRepository) removeOrphans() error { return nil } +// renumber updates the position of all tracks in the playlist to be sequential starting from 1, ordered by their +// current position. This is needed after removing orphan tracks, to ensure there are no gaps in the track numbering. +// The two-step approach (negate then reassign via CTE) avoids UNIQUE constraint violations on (playlist_id, id). func (r *playlistRepository) renumber(id string) error { - var ids []string - sq := Select("media_file_id").From("playlist_tracks").Where(Eq{"playlist_id": id}).OrderBy("id") - err := r.queryAllSlice(sq, &ids) + // Step 1: Negate all IDs to clear the positive ID space + _, err := r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -id WHERE playlist_id = ? AND id > 0`, id)) if err != nil { return err } - return r.updatePlaylist(id, ids) -} - -func (r *playlistRepository) isWritable(playlistId string) bool { - usr := loggedUser(r.ctx) - if usr.IsAdmin { - return true + // Step 2: Assign new sequential positive IDs using UPDATE...FROM with a CTE. + // The CTE is fully materialized before the UPDATE begins, avoiding self-referencing issues. + // ORDER BY id DESC restores original order since IDs are now negative. + _, err = r.executeSQL(Expr( + `WITH new_ids AS ( + SELECT rowid as rid, ROW_NUMBER() OVER (ORDER BY id DESC) as new_id + FROM playlist_tracks WHERE playlist_id = ? + ) + UPDATE playlist_tracks SET id = new_ids.new_id + FROM new_ids + WHERE playlist_tracks.rowid = new_ids.rid AND playlist_tracks.playlist_id = ?`, id, id)) + if err != nil { + return err } - pls, err := r.Get(playlistId) - return err == nil && pls.OwnerID == usr.ID + return r.refreshCounters(&model.Playlist{ID: id}) } var _ model.PlaylistRepository = (*playlistRepository)(nil) diff --git a/persistence/playlist_repository_test.go b/persistence/playlist_repository_test.go index 5a82964c9..cfabd0983 100644 --- a/persistence/playlist_repository_test.go +++ b/persistence/playlist_repository_test.go @@ -1,13 +1,8 @@ package persistence import ( - "context" - "time" - - "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/criteria" "github.com/navidrome/navidrome/model/request" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -17,7 +12,7 @@ var _ = Describe("PlaylistRepository", func() { var repo model.PlaylistRepository BeforeEach(func() { - ctx := log.NewContext(context.TODO()) + ctx := log.NewContext(GinkgoT().Context()) ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) repo = NewPlaylistRepository(ctx, GetDBXBuilder()) }) @@ -79,13 +74,13 @@ var _ = Describe("PlaylistRepository", func() { It("Put/Exists/Delete", func() { By("saves the playlist to the DB") newPls := model.Playlist{Name: "Great!", OwnerID: "userid"} - newPls.AddTracks([]string{"1004", "1003"}) + newPls.AddMediaFilesByID([]string{"1004", "1003"}) By("saves the playlist to the DB") Expect(repo.Put(&newPls)).To(BeNil()) By("adds repeated songs to a playlist and keeps the order") - newPls.AddTracks([]string{"1004"}) + newPls.AddMediaFilesByID([]string{"1004"}) Expect(repo.Put(&newPls)).To(BeNil()) saved, _ := repo.GetWithTracks(newPls.ID, true, false) Expect(saved.Tracks).To(HaveLen(3)) @@ -112,96 +107,91 @@ var _ = Describe("PlaylistRepository", func() { }) }) - Context("Smart Playlists", func() { - var rules *criteria.Criteria - BeforeEach(func() { - rules = &criteria.Criteria{ - Expression: criteria.All{ - criteria.Contains{"title": "love"}, - }, + Describe("GetPlaylists", func() { + It("returns playlists for a track", func() { + pls, err := repo.GetPlaylists(songRadioactivity.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(pls).To(HaveLen(1)) + Expect(pls[0].ID).To(Equal(plsBest.ID)) + }) + + It("returns empty when none", func() { + pls, err := repo.GetPlaylists("9999") + Expect(err).ToNot(HaveOccurred()) + Expect(pls).To(HaveLen(0)) + }) + }) + + Describe("Track Deletion and Renumbering", func() { + var testPlaylistID string + + AfterEach(func() { + if testPlaylistID != "" { + Expect(repo.Delete(testPlaylistID)).To(BeNil()) + testPlaylistID = "" } }) - Context("valid rules", func() { - Specify("Put/Get", func() { - newPls := model.Playlist{Name: "Great!", OwnerID: "userid", Rules: rules} - Expect(repo.Put(&newPls)).To(Succeed()) - savedPls, err := repo.Get(newPls.ID) - Expect(err).ToNot(HaveOccurred()) - Expect(savedPls.Rules).To(Equal(rules)) - }) + // helper to get track positions and media file IDs + getTrackInfo := func(playlistID string) (ids []string, mediaFileIDs []string) { + pls, err := repo.GetWithTracks(playlistID, false, false) + Expect(err).ToNot(HaveOccurred()) + for _, t := range pls.Tracks { + ids = append(ids, t.ID) + mediaFileIDs = append(mediaFileIDs, t.MediaFileID) + } + return + } + + It("renumbers correctly after deleting a track from the middle", func() { + By("creating a playlist with 4 tracks") + newPls := model.Playlist{Name: "Renumber Test Middle", OwnerID: "userid"} + newPls.AddMediaFilesByID([]string{"1001", "1002", "1003", "1004"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("deleting the second track (position 2)") + tracksRepo := repo.Tracks(newPls.ID, false) + Expect(tracksRepo.Delete("2")).To(Succeed()) + + By("verifying remaining tracks are renumbered sequentially") + ids, mediaFileIDs := getTrackInfo(newPls.ID) + Expect(ids).To(Equal([]string{"1", "2", "3"})) + Expect(mediaFileIDs).To(Equal([]string{"1001", "1003", "1004"})) }) - Context("invalid rules", func() { - It("fails to Put it in the DB", func() { - rules = &criteria.Criteria{ - // This is invalid because "contains" cannot have multiple fields - Expression: criteria.All{ - criteria.Contains{"genre": "Hardcore", "filetype": "mp3"}, - }, - } - newPls := model.Playlist{Name: "Great!", OwnerID: "userid", Rules: rules} - Expect(repo.Put(&newPls)).To(MatchError(ContainSubstring("invalid criteria expression"))) - }) + It("renumbers correctly after deleting the first track", func() { + By("creating a playlist with 3 tracks") + newPls := model.Playlist{Name: "Renumber Test First", OwnerID: "userid"} + newPls.AddMediaFilesByID([]string{"1001", "1002", "1003"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("deleting the first track (position 1)") + tracksRepo := repo.Tracks(newPls.ID, false) + Expect(tracksRepo.Delete("1")).To(Succeed()) + + By("verifying remaining tracks are renumbered sequentially") + ids, mediaFileIDs := getTrackInfo(newPls.ID) + Expect(ids).To(Equal([]string{"1", "2"})) + Expect(mediaFileIDs).To(Equal([]string{"1002", "1003"})) }) - // TODO Validate these tests - XContext("child smart playlists", func() { - When("refresh day has expired", func() { - It("should refresh tracks for smart playlist referenced in parent smart playlist criteria", func() { - conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + It("renumbers correctly after deleting the last track", func() { + By("creating a playlist with 3 tracks") + newPls := model.Playlist{Name: "Renumber Test Last", OwnerID: "userid"} + newPls.AddMediaFilesByID([]string{"1001", "1002", "1003"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID - nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Rules: rules} - Expect(repo.Put(&nestedPls)).To(Succeed()) + By("deleting the last track (position 3)") + tracksRepo := repo.Tracks(newPls.ID, false) + Expect(tracksRepo.Delete("3")).To(Succeed()) - parentPls := model.Playlist{Name: "Parent", OwnerID: "userid", Rules: &criteria.Criteria{ - Expression: criteria.All{ - criteria.InPlaylist{"id": nestedPls.ID}, - }, - }} - Expect(repo.Put(&parentPls)).To(Succeed()) - - nestedPlsRead, err := repo.Get(nestedPls.ID) - Expect(err).ToNot(HaveOccurred()) - - _, err = repo.GetWithTracks(parentPls.ID, true, false) - Expect(err).ToNot(HaveOccurred()) - - // Check that the nested playlist was refreshed by parent get by verifying evaluatedAt is updated since first nestedPls get - nestedPlsAfterParentGet, err := repo.Get(nestedPls.ID) - Expect(err).ToNot(HaveOccurred()) - - Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(BeTemporally(">", *nestedPlsRead.EvaluatedAt)) - }) - }) - - When("refresh day has not expired", func() { - It("should NOT refresh tracks for smart playlist referenced in parent smart playlist criteria", func() { - conf.Server.SmartPlaylistRefreshDelay = 1 * time.Hour - - nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Rules: rules} - Expect(repo.Put(&nestedPls)).To(Succeed()) - - parentPls := model.Playlist{Name: "Parent", OwnerID: "userid", Rules: &criteria.Criteria{ - Expression: criteria.All{ - criteria.InPlaylist{"id": nestedPls.ID}, - }, - }} - Expect(repo.Put(&parentPls)).To(Succeed()) - - nestedPlsRead, err := repo.Get(nestedPls.ID) - Expect(err).ToNot(HaveOccurred()) - - _, err = repo.GetWithTracks(parentPls.ID, true, false) - Expect(err).ToNot(HaveOccurred()) - - // Check that the nested playlist was not refreshed by parent get by verifying evaluatedAt is not updated since first nestedPls get - nestedPlsAfterParentGet, err := repo.Get(nestedPls.ID) - Expect(err).ToNot(HaveOccurred()) - - Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(Equal(*nestedPlsRead.EvaluatedAt)) - }) - }) + By("verifying remaining tracks are renumbered sequentially") + ids, mediaFileIDs := getTrackInfo(newPls.ID) + Expect(ids).To(Equal([]string{"1", "2"})) + Expect(mediaFileIDs).To(Equal([]string{"1001", "1002"})) }) }) }) diff --git a/persistence/playlist_track_repository.go b/persistence/playlist_track_repository.go index d33bd5113..1a7062cc2 100644 --- a/persistence/playlist_track_repository.go +++ b/persistence/playlist_track_repository.go @@ -47,14 +47,15 @@ func (r *playlistRepository) Tracks(playlistId string, refreshSmartPlaylist bool p.db = r.db p.tableName = "playlist_tracks" p.registerModel(&model.PlaylistTrack{}, map[string]filterFunc{ - "missing": booleanFilter, + "missing": booleanFilter, + "library_id": libraryIdFilter, }) p.setSortMappings( map[string]string{ "id": "playlist_tracks.id", "artist": "order_artist_name", "album_artist": "order_album_artist_name", - "album": "order_album_name, order_album_artist_name", + "album": "order_album_name, album_id, disc_number, track_number, order_artist_name, title", "title": "order_title", // To make sure these fields will be whitelisted "duration": "duration", @@ -83,26 +84,28 @@ func (r *playlistTrackRepository) Count(options ...rest.QueryOptions) (int64, er return r.count(query, r.parseRestOptions(r.ctx, options...)) } -func (r *playlistTrackRepository) Read(id string) (interface{}, error) { +func (r *playlistTrackRepository) Read(id string) (any, error) { + userID := loggedUser(r.ctx).ID sel := r.newSelect(). LeftJoin("annotation on ("+ "annotation.item_id = media_file_id"+ " AND annotation.item_type = 'media_file'"+ - " AND annotation.user_id = '"+userId(r.ctx)+"')"). + " AND annotation.user_id = '"+userID+"')"). Columns( "coalesce(starred, 0) as starred", "coalesce(play_count, 0) as play_count", "coalesce(rating, 0) as rating", "starred_at", "play_date", + "rated_at", "f.*", "playlist_tracks.*", ). Join("media_file f on f.id = media_file_id"). - Where(And{Eq{"playlist_id": r.playlistId}, Eq{"id": id}}) + Where(And{Eq{"playlist_id": r.playlistId}, Eq{"playlist_tracks.id": id}}) var trk dbPlaylistTrack err := r.queryOne(sel, &trk) - return trk.PlaylistTrack.MediaFile, err + return trk.PlaylistTrack, err } func (r *playlistTrackRepository) GetAll(options ...model.QueryOptions) (model.PlaylistTracks, error) { @@ -125,7 +128,7 @@ func (r *playlistTrackRepository) GetAlbumIDs(options ...model.QueryOptions) ([] return ids, nil } -func (r *playlistTrackRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *playlistTrackRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } @@ -133,19 +136,11 @@ func (r *playlistTrackRepository) EntityName() string { return "playlist_tracks" } -func (r *playlistTrackRepository) NewInstance() interface{} { +func (r *playlistTrackRepository) NewInstance() any { return &model.PlaylistTrack{} } -func (r *playlistTrackRepository) isTracksEditable() bool { - return r.playlistRepo.isWritable(r.playlistId) && !r.playlist.IsSmartPlaylist() -} - func (r *playlistTrackRepository) Add(mediaFileIds []string) (int, error) { - if !r.isTracksEditable() { - return 0, rest.ErrPermissionDenied - } - if len(mediaFileIds) > 0 { log.Debug(r.ctx, "Adding songs to playlist", "playlistId", r.playlistId, "mediaFileIds", mediaFileIds) } else { @@ -193,22 +188,7 @@ func (r *playlistTrackRepository) AddDiscs(discs []model.DiscID) (int, error) { return r.addMediaFileIds(clauses) } -// Get ids from all current tracks -func (r *playlistTrackRepository) getTracks() ([]string, error) { - all := r.newSelect().Columns("media_file_id").Where(Eq{"playlist_id": r.playlistId}).OrderBy("id") - var ids []string - err := r.queryAllSlice(all, &ids) - if err != nil { - log.Error(r.ctx, "Error querying current tracks from playlist", "playlistId", r.playlistId, err) - return nil, err - } - return ids, nil -} - func (r *playlistTrackRepository) Delete(ids ...string) error { - if !r.isTracksEditable() { - return rest.ErrPermissionDenied - } err := r.delete(And{Eq{"playlist_id": r.playlistId}, Eq{"id": ids}}) if err != nil { return err @@ -218,9 +198,6 @@ func (r *playlistTrackRepository) Delete(ids ...string) error { } func (r *playlistTrackRepository) DeleteAll() error { - if !r.isTracksEditable() { - return rest.ErrPermissionDenied - } err := r.delete(Eq{"playlist_id": r.playlistId}) if err != nil { return err @@ -229,16 +206,45 @@ func (r *playlistTrackRepository) DeleteAll() error { return r.playlistRepo.renumber(r.playlistId) } +// Reorder moves a track from pos to newPos, shifting other tracks accordingly. func (r *playlistTrackRepository) Reorder(pos int, newPos int) error { - if !r.isTracksEditable() { - return rest.ErrPermissionDenied + if pos == newPos { + return nil } - ids, err := r.getTracks() + pid := r.playlistId + + // Step 1: Move the source track out of the way (temporary sentinel value) + _, err := r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -999999 WHERE playlist_id = ? AND id = ?`, pid, pos)) if err != nil { return err } - newOrder := slice.Move(ids, pos-1, newPos-1) - return r.playlistRepo.updatePlaylist(r.playlistId, newOrder) + + // Step 2: Shift the affected range using negative values to avoid unique constraint violations + if pos < newPos { + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -(id - 1) WHERE playlist_id = ? AND id > ? AND id <= ?`, + pid, pos, newPos)) + } else { + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -(id + 1) WHERE playlist_id = ? AND id >= ? AND id < ?`, + pid, newPos, pos)) + } + if err != nil { + return err + } + + // Step 3: Flip the shifted range back to positive + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = -id WHERE playlist_id = ? AND id < 0 AND id != -999999`, pid)) + if err != nil { + return err + } + + // Step 4: Place the source track at its new position + _, err = r.executeSQL(Expr( + `UPDATE playlist_tracks SET id = ? WHERE playlist_id = ? AND id = -999999`, newPos, pid)) + return err } var _ model.PlaylistTrackRepository = (*playlistTrackRepository)(nil) diff --git a/persistence/playqueue_repository.go b/persistence/playqueue_repository.go index fe42dd7fc..ba69ec746 100644 --- a/persistence/playqueue_repository.go +++ b/persistence/playqueue_repository.go @@ -2,6 +2,7 @@ package persistence import ( "context" + "errors" "strings" "time" @@ -27,7 +28,7 @@ func NewPlayQueueRepository(ctx context.Context, db dbx.Builder) model.PlayQueue type playQueue struct { ID string `structs:"id"` UserID string `structs:"user_id"` - Current string `structs:"current"` + Current int `structs:"current"` Position int64 `structs:"position"` ChangedBy string `structs:"changed_by"` Items string `structs:"items"` @@ -35,22 +36,39 @@ type playQueue struct { UpdatedAt time.Time `structs:"updated_at"` } -func (r *playQueueRepository) Store(q *model.PlayQueue) error { +func (r *playQueueRepository) Store(q *model.PlayQueue, colNames ...string) error { u := loggedUser(r.ctx) - err := r.clearPlayQueue(q.UserID) - if err != nil { - log.Error(r.ctx, "Error deleting previous playqueue", "user", u.UserName, err) + + // Always find existing playqueue for this user + existingQueue, err := r.Retrieve(q.UserID) + if err != nil && !errors.Is(err, model.ErrNotFound) { + log.Error(r.ctx, "Error retrieving existing playqueue", "user", u.UserName, err) return err } - if len(q.Items) == 0 { - return nil + + // Use existing ID if found, otherwise keep the provided ID (which may be empty for new records) + if !errors.Is(err, model.ErrNotFound) && existingQueue.ID != "" { + q.ID = existingQueue.ID } + + // When no specific columns are provided, we replace the whole queue + if len(colNames) == 0 { + err := r.clearPlayQueue(q.UserID) + if err != nil { + log.Error(r.ctx, "Error deleting previous playqueue", "user", u.UserName, err) + return err + } + if len(q.Items) == 0 { + return nil + } + } + pq := r.fromModel(q) if pq.ID == "" { pq.CreatedAt = time.Now() } pq.UpdatedAt = time.Now() - _, err = r.put(pq.ID, pq) + _, err = r.put(pq.ID, pq, colNames...) if err != nil { log.Error(r.ctx, "Error saving playqueue", "user", u.UserName, err) return err @@ -58,12 +76,20 @@ func (r *playQueueRepository) Store(q *model.PlayQueue) error { return nil } +func (r *playQueueRepository) RetrieveWithMediaFiles(userId string) (*model.PlayQueue, error) { + sel := r.newSelect().Columns("*").Where(Eq{"user_id": userId}) + var res playQueue + err := r.queryOne(sel, &res) + q := r.toModel(&res) + q.Items = r.loadTracks(q.Items) + return &q, err +} + func (r *playQueueRepository) Retrieve(userId string) (*model.PlayQueue, error) { sel := r.newSelect().Columns("*").Where(Eq{"user_id": userId}) var res playQueue err := r.queryOne(sel, &res) - pls := r.toModel(&res) - return &pls, err + return new(r.toModel(&res)), err } func (r *playQueueRepository) fromModel(q *model.PlayQueue) playQueue { @@ -95,12 +121,11 @@ func (r *playQueueRepository) toModel(pq *playQueue) model.PlayQueue { UpdatedAt: pq.UpdatedAt, } if strings.TrimSpace(pq.Items) != "" { - tracks := strings.Split(pq.Items, ",") - for _, t := range tracks { + tracks := strings.SplitSeq(pq.Items, ",") + for t := range tracks { q.Items = append(q.Items, model.MediaFile{ID: t}) } } - q.Items = r.loadTracks(q.Items) return q } @@ -145,4 +170,8 @@ func (r *playQueueRepository) clearPlayQueue(userId string) error { return r.delete(Eq{"user_id": userId}) } +func (r *playQueueRepository) Clear(userId string) error { + return r.clearPlayQueue(userId) +} + var _ model.PlayQueueRepository = (*playQueueRepository)(nil) diff --git a/persistence/playqueue_repository_test.go b/persistence/playqueue_repository_test.go index a370e1162..2bcc88fd0 100644 --- a/persistence/playqueue_repository_test.go +++ b/persistence/playqueue_repository_test.go @@ -5,6 +5,7 @@ import ( "time" "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" @@ -18,38 +19,296 @@ var _ = Describe("PlayQueueRepository", func() { var ctx context.Context BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) ctx = log.NewContext(context.TODO()) ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) repo = NewPlayQueueRepository(ctx, GetDBXBuilder()) }) - Describe("PlayQueues", func() { + Describe("Store", func() { + It("stores a complete playqueue", func() { + expected := aPlayQueue("userid", 1, 123, songComeTogether, songDayInALife) + Expect(repo.Store(expected)).To(Succeed()) + + actual, err := repo.RetrieveWithMediaFiles("userid") + Expect(err).ToNot(HaveOccurred()) + AssertPlayQueue(expected, actual) + Expect(countPlayQueues(repo, "userid")).To(Equal(1)) + }) + + It("replaces existing playqueue when storing without column names", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 0, 100, songComeTogether) + Expect(repo.Store(initial)).To(Succeed()) + + By("Storing replacement playqueue") + replacement := aPlayQueue("userid", 1, 200, songDayInALife, songAntenna) + Expect(repo.Store(replacement)).To(Succeed()) + + actual, err := repo.RetrieveWithMediaFiles("userid") + Expect(err).ToNot(HaveOccurred()) + AssertPlayQueue(replacement, actual) + Expect(countPlayQueues(repo, "userid")).To(Equal(1)) + }) + + It("clears playqueue when storing empty items", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 0, 100, songComeTogether) + Expect(repo.Store(initial)).To(Succeed()) + + By("Storing empty playqueue") + empty := aPlayQueue("userid", 0, 0) + Expect(repo.Store(empty)).To(Succeed()) + + By("Verifying playqueue is cleared") + _, err := repo.Retrieve("userid") + Expect(err).To(MatchError(model.ErrNotFound)) + }) + + It("updates only current field when specified", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 0, 100, songComeTogether, songDayInALife) + Expect(repo.Store(initial)).To(Succeed()) + + By("Getting the existing playqueue to obtain its ID") + existing, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + + By("Updating only current field") + update := &model.PlayQueue{ + ID: existing.ID, // Use existing ID for partial update + UserID: "userid", + Current: 1, + ChangedBy: "test-update", + } + Expect(repo.Store(update, "current")).To(Succeed()) + + By("Verifying only current was updated") + actual, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + Expect(actual.Current).To(Equal(1)) + Expect(actual.Position).To(Equal(int64(100))) // Should remain unchanged + Expect(actual.Items).To(HaveLen(2)) // Should remain unchanged + }) + + It("updates only position field when specified", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 1, 100, songComeTogether, songDayInALife) + Expect(repo.Store(initial)).To(Succeed()) + + By("Getting the existing playqueue to obtain its ID") + existing, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + + By("Updating only position field") + update := &model.PlayQueue{ + ID: existing.ID, // Use existing ID for partial update + UserID: "userid", + Position: 500, + ChangedBy: "test-update", + } + Expect(repo.Store(update, "position")).To(Succeed()) + + By("Verifying only position was updated") + actual, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + Expect(actual.Position).To(Equal(int64(500))) + Expect(actual.Current).To(Equal(1)) // Should remain unchanged + Expect(actual.Items).To(HaveLen(2)) // Should remain unchanged + }) + + It("updates multiple specified fields", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 0, 100, songComeTogether) + Expect(repo.Store(initial)).To(Succeed()) + + By("Getting the existing playqueue to obtain its ID") + existing, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + + By("Updating current and position fields") + update := &model.PlayQueue{ + ID: existing.ID, // Use existing ID for partial update + UserID: "userid", + Current: 1, + Position: 300, + ChangedBy: "test-update", + } + Expect(repo.Store(update, "current", "position")).To(Succeed()) + + By("Verifying both fields were updated") + actual, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + Expect(actual.Current).To(Equal(1)) + Expect(actual.Position).To(Equal(int64(300))) + Expect(actual.Items).To(HaveLen(1)) // Should remain unchanged + }) + + It("preserves existing data when updating with empty items list and column names", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 0, 100, songComeTogether, songDayInALife) + Expect(repo.Store(initial)).To(Succeed()) + + By("Getting the existing playqueue to obtain its ID") + existing, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + + By("Updating only position with empty items") + update := &model.PlayQueue{ + ID: existing.ID, // Use existing ID for partial update + UserID: "userid", + Position: 200, + ChangedBy: "test-update", + Items: []model.MediaFile{}, // Empty items + } + Expect(repo.Store(update, "position")).To(Succeed()) + + By("Verifying items are preserved") + actual, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + Expect(actual.Position).To(Equal(int64(200))) + Expect(actual.Items).To(HaveLen(2)) // Should remain unchanged + }) + + It("ensures only one record per user by reusing existing record ID", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 0, 100, songComeTogether) + Expect(repo.Store(initial)).To(Succeed()) + initialCount := countPlayQueues(repo, "userid") + Expect(initialCount).To(Equal(1)) + + By("Storing another playqueue with different ID but same user") + different := aPlayQueue("userid", 1, 200, songDayInALife) + different.ID = "different-id" // Force a different ID + Expect(repo.Store(different)).To(Succeed()) + + By("Verifying only one record exists for the user") + finalCount := countPlayQueues(repo, "userid") + Expect(finalCount).To(Equal(1)) + + By("Verifying the record was updated, not duplicated") + actual, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + Expect(actual.Current).To(Equal(1)) // Should be updated value + Expect(actual.Position).To(Equal(int64(200))) // Should be updated value + Expect(actual.Items).To(HaveLen(1)) // Should be new items + Expect(actual.Items[0].ID).To(Equal(songDayInALife.ID)) + }) + + It("ensures only one record per user even with partial updates", func() { + By("Storing initial playqueue") + initial := aPlayQueue("userid", 0, 100, songComeTogether, songDayInALife) + Expect(repo.Store(initial)).To(Succeed()) + initialCount := countPlayQueues(repo, "userid") + Expect(initialCount).To(Equal(1)) + + By("Storing partial update with different ID but same user") + partialUpdate := &model.PlayQueue{ + ID: "completely-different-id", // Use a completely different ID + UserID: "userid", + Current: 1, + ChangedBy: "test-partial", + } + Expect(repo.Store(partialUpdate, "current")).To(Succeed()) + + By("Verifying only one record still exists for the user") + finalCount := countPlayQueues(repo, "userid") + Expect(finalCount).To(Equal(1)) + + By("Verifying the existing record was updated with new current value") + actual, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + Expect(actual.Current).To(Equal(1)) // Should be updated value + Expect(actual.Position).To(Equal(int64(100))) // Should remain unchanged + Expect(actual.Items).To(HaveLen(2)) // Should remain unchanged + }) + }) + + Describe("Retrieve", func() { It("returns notfound error if there's no playqueue for the user", func() { _, err := repo.Retrieve("user999") Expect(err).To(MatchError(model.ErrNotFound)) }) - It("stores and retrieves the playqueue for the user", func() { + It("retrieves the playqueue with only track IDs (no full MediaFile data)", func() { By("Storing a playqueue for the user") - expected := aPlayQueue("userid", songDayInALife.ID, 123, songComeTogether, songDayInALife) + expected := aPlayQueue("userid", 1, 123, songComeTogether, songDayInALife) Expect(repo.Store(expected)).To(Succeed()) actual, err := repo.Retrieve("userid") Expect(err).ToNot(HaveOccurred()) - AssertPlayQueue(expected, actual) + // Basic playqueue properties should match + Expect(actual.ID).To(Equal(expected.ID)) + Expect(actual.UserID).To(Equal(expected.UserID)) + Expect(actual.Current).To(Equal(expected.Current)) + Expect(actual.Position).To(Equal(expected.Position)) + Expect(actual.ChangedBy).To(Equal(expected.ChangedBy)) + Expect(actual.Items).To(HaveLen(len(expected.Items))) - By("Storing a new playqueue for the same user") + // Items should only contain IDs, not full MediaFile data + for i, item := range actual.Items { + Expect(item.ID).To(Equal(expected.Items[i].ID)) + // These fields should be empty since we're not loading full MediaFiles + Expect(item.Title).To(BeEmpty()) + Expect(item.Path).To(BeEmpty()) + Expect(item.Album).To(BeEmpty()) + Expect(item.Artist).To(BeEmpty()) + } + }) - another := aPlayQueue("userid", songRadioactivity.ID, 321, songAntenna, songRadioactivity) - Expect(repo.Store(another)).To(Succeed()) + It("returns items with IDs even when some tracks don't exist in the DB", func() { + // Add a new song to the DB + newSong := songRadioactivity + newSong.ID = "temp-track" + newSong.Path = "/new-path" + mfRepo := NewMediaFileRepository(ctx, GetDBXBuilder()) - actual, err = repo.Retrieve("userid") + Expect(mfRepo.Put(&newSong)).To(Succeed()) + + // Create a playqueue with the new song + pq := aPlayQueue("userid", 0, 0, newSong, songAntenna) + Expect(repo.Store(pq)).To(Succeed()) + + // Delete the new song from the database + Expect(mfRepo.Delete("temp-track")).To(Succeed()) + + // Retrieve the playqueue with Retrieve method + actual, err := repo.Retrieve("userid") Expect(err).ToNot(HaveOccurred()) - AssertPlayQueue(another, actual) - Expect(countPlayQueues(repo, "userid")).To(Equal(1)) + // The playqueue should still contain both track IDs (including the deleted one) + Expect(actual.Items).To(HaveLen(2)) + Expect(actual.Items[0].ID).To(Equal("temp-track")) + Expect(actual.Items[1].ID).To(Equal(songAntenna.ID)) + + // Items should only contain IDs, no other data + for _, item := range actual.Items { + Expect(item.Title).To(BeEmpty()) + Expect(item.Path).To(BeEmpty()) + Expect(item.Album).To(BeEmpty()) + Expect(item.Artist).To(BeEmpty()) + } + }) + }) + + Describe("RetrieveWithMediaFiles", func() { + It("returns notfound error if there's no playqueue for the user", func() { + _, err := repo.RetrieveWithMediaFiles("user999") + Expect(err).To(MatchError(model.ErrNotFound)) + }) + + It("retrieves the playqueue with full MediaFile data", func() { + By("Storing a playqueue for the user") + + expected := aPlayQueue("userid", 1, 123, songComeTogether, songDayInALife) + Expect(repo.Store(expected)).To(Succeed()) + + actual, err := repo.RetrieveWithMediaFiles("userid") + Expect(err).ToNot(HaveOccurred()) + + AssertPlayQueue(expected, actual) }) It("does not return tracks if they don't exist in the DB", func() { @@ -62,11 +321,11 @@ var _ = Describe("PlayQueueRepository", func() { Expect(mfRepo.Put(&newSong)).To(Succeed()) // Create a playqueue with the new song - pq := aPlayQueue("userid", newSong.ID, 0, newSong, songAntenna) + pq := aPlayQueue("userid", 0, 0, newSong, songAntenna) Expect(repo.Store(pq)).To(Succeed()) // Retrieve the playqueue - actual, err := repo.Retrieve("userid") + actual, err := repo.RetrieveWithMediaFiles("userid") Expect(err).ToNot(HaveOccurred()) // The playqueue should contain both tracks @@ -76,7 +335,7 @@ var _ = Describe("PlayQueueRepository", func() { Expect(mfRepo.Delete("temp-track")).To(Succeed()) // Retrieve the playqueue - actual, err = repo.Retrieve("userid") + actual, err = repo.RetrieveWithMediaFiles("userid") Expect(err).ToNot(HaveOccurred()) // The playqueue should not contain the deleted track @@ -84,6 +343,59 @@ var _ = Describe("PlayQueueRepository", func() { Expect(actual.Items[0].ID).To(Equal(songAntenna.ID)) }) }) + + Describe("Clear", func() { + It("clears an existing playqueue", func() { + By("Storing a playqueue") + expected := aPlayQueue("userid", 1, 123, songComeTogether, songDayInALife) + Expect(repo.Store(expected)).To(Succeed()) + + By("Verifying playqueue exists") + _, err := repo.Retrieve("userid") + Expect(err).ToNot(HaveOccurred()) + + By("Clearing the playqueue") + Expect(repo.Clear("userid")).To(Succeed()) + + By("Verifying playqueue is cleared") + _, err = repo.Retrieve("userid") + Expect(err).To(MatchError(model.ErrNotFound)) + }) + + It("does not error when clearing non-existent playqueue", func() { + // Clear should not error even if no playqueue exists + Expect(repo.Clear("nonexistent-user")).To(Succeed()) + }) + + It("only clears the specified user's playqueue", func() { + By("Creating users in the database to avoid foreign key constraints") + userRepo := NewUserRepository(ctx, GetDBXBuilder()) + user1 := &model.User{ID: "user1", UserName: "user1", Name: "User 1", Email: "user1@test.com"} + user2 := &model.User{ID: "user2", UserName: "user2", Name: "User 2", Email: "user2@test.com"} + Expect(userRepo.Put(user1)).To(Succeed()) + Expect(userRepo.Put(user2)).To(Succeed()) + + By("Storing playqueues for two users") + user1Queue := aPlayQueue("user1", 0, 100, songComeTogether) + user2Queue := aPlayQueue("user2", 1, 200, songDayInALife) + Expect(repo.Store(user1Queue)).To(Succeed()) + Expect(repo.Store(user2Queue)).To(Succeed()) + + By("Clearing only user1's playqueue") + Expect(repo.Clear("user1")).To(Succeed()) + + By("Verifying user1's playqueue is cleared") + _, err := repo.Retrieve("user1") + Expect(err).To(MatchError(model.ErrNotFound)) + + By("Verifying user2's playqueue still exists") + actual, err := repo.Retrieve("user2") + Expect(err).ToNot(HaveOccurred()) + Expect(actual.UserID).To(Equal("user2")) + Expect(actual.Current).To(Equal(1)) + Expect(actual.Position).To(Equal(int64(200))) + }) + }) }) func countPlayQueues(repo model.PlayQueueRepository, userId string) int { @@ -107,7 +419,7 @@ func AssertPlayQueue(expected, actual *model.PlayQueue) { } } -func aPlayQueue(userId, current string, position int64, items ...model.MediaFile) *model.PlayQueue { +func aPlayQueue(userId string, current int, position int64, items ...model.MediaFile) *model.PlayQueue { createdAt := time.Now() updatedAt := createdAt.Add(time.Minute) return &model.PlayQueue{ diff --git a/persistence/plugin_cleanup.go b/persistence/plugin_cleanup.go new file mode 100644 index 000000000..0202726e4 --- /dev/null +++ b/persistence/plugin_cleanup.go @@ -0,0 +1,86 @@ +package persistence + +import ( + "github.com/pocketbase/dbx" +) + +// cleanupPluginUserReferences removes a user ID from all plugins' users JSON arrays +// and auto-disables plugins that lose their only permitted user (when users permission is required). +// This is called from userRepository.Delete() to maintain referential integrity. +func cleanupPluginUserReferences(db dbx.Builder, userID string) error { + // SQLite JSON function: json_remove removes the element at the path where user matches. + // We use a subquery with json_each to find and remove the user ID from the array. + // This updates all plugins where the users array contains the given user ID. + _, err := db.NewQuery(` + UPDATE plugin + SET users = ( + SELECT json_group_array(value) + FROM json_each(plugin.users) + WHERE value != {:userID} + ), + updated_at = CURRENT_TIMESTAMP + WHERE users IS NOT NULL + AND users != '' + AND EXISTS (SELECT 1 FROM json_each(plugin.users) WHERE value = {:userID}) + `).Bind(dbx.Params{"userID": userID}).Execute() + if err != nil { + return err + } + + // Auto-disable plugins that: + // 1. Are currently enabled + // 2. Require users permission (manifest has permissions.users) + // 3. Don't have allUsers enabled + // 4. Now have an empty users array after cleanup + // + // The manifest check uses JSON path to see if permissions.users exists. + _, err = db.NewQuery(` + UPDATE plugin + SET enabled = false, + updated_at = CURRENT_TIMESTAMP + WHERE enabled = true + AND all_users = false + AND json_extract(manifest, '$.permissions.users') IS NOT NULL + AND (users IS NULL OR users = '' OR users = '[]' OR json_array_length(users) = 0) + `).Execute() + return err +} + +// cleanupPluginLibraryReferences removes a library ID from all plugins' libraries JSON arrays +// and auto-disables plugins that lose their only permitted library (when library permission is required). +// This is called from libraryRepository.Delete() to maintain referential integrity. +func cleanupPluginLibraryReferences(db dbx.Builder, libraryID int) error { + // SQLite JSON function: we filter out the library ID from the array. + // Libraries are stored as integers in the JSON array. + _, err := db.NewQuery(` + UPDATE plugin + SET libraries = ( + SELECT json_group_array(value) + FROM json_each(plugin.libraries) + WHERE CAST(value AS INTEGER) != {:libraryID} + ), + updated_at = CURRENT_TIMESTAMP + WHERE libraries IS NOT NULL + AND libraries != '' + AND EXISTS (SELECT 1 FROM json_each(plugin.libraries) WHERE CAST(value AS INTEGER) = {:libraryID}) + `).Bind(dbx.Params{"libraryID": libraryID}).Execute() + if err != nil { + return err + } + + // Auto-disable plugins that: + // 1. Are currently enabled + // 2. Require library permission (manifest has permissions.library) + // 3. Don't have allLibraries enabled + // 4. Now have an empty libraries array after cleanup + _, err = db.NewQuery(` + UPDATE plugin + SET enabled = false, + updated_at = CURRENT_TIMESTAMP + WHERE enabled = true + AND all_libraries = false + AND json_extract(manifest, '$.permissions.library') IS NOT NULL + AND (libraries IS NULL OR libraries = '' OR libraries = '[]' OR json_array_length(libraries) = 0) + `).Execute() + return err +} diff --git a/persistence/plugin_cleanup_test.go b/persistence/plugin_cleanup_test.go new file mode 100644 index 000000000..bfe6d60ca --- /dev/null +++ b/persistence/plugin_cleanup_test.go @@ -0,0 +1,263 @@ +package persistence + +import ( + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Plugin Cleanup", func() { + var pluginRepo model.PluginRepository + var userRepo model.UserRepository + var libraryRepo model.LibraryRepository + + BeforeEach(func() { + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "admin", UserName: "admin", IsAdmin: true}) + db := GetDBXBuilder() + pluginRepo = NewPluginRepository(ctx, db) + userRepo = NewUserRepository(ctx, db) + libraryRepo = NewLibraryRepository(ctx, db) + + // Clean up any existing plugins + all, _ := pluginRepo.GetAll() + for _, p := range all { + _ = pluginRepo.Delete(p.ID) + } + }) + + AfterEach(func() { + // Clean up after tests + all, _ := pluginRepo.GetAll() + for _, p := range all { + _ = pluginRepo.Delete(p.ID) + } + }) + + Describe("cleanupPluginUserReferences", func() { + It("removes user ID from plugin users array", func() { + // Create a plugin with multiple users + plugin := &model.Plugin{ + ID: "test-plugin", + Path: "/plugins/test.wasm", + Manifest: `{"name":"test"}`, + SHA256: "abc123", + Users: `["user1","user2","user3"]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Clean up user2 reference + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "user2")).To(Succeed()) + + // Verify user2 was removed + updated, err := pluginRepo.Get("test-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`["user1","user3"]`)) + Expect(updated.Enabled).To(BeTrue()) // Still has users, should remain enabled + }) + + It("auto-disables plugin when last permitted user is removed", func() { + // Create a plugin that requires users permission with only one user + plugin := &model.Plugin{ + ID: "user-plugin", + Path: "/plugins/user.wasm", + Manifest: `{"name":"user-plugin","permissions":{"users":{}}}`, + SHA256: "def456", + Users: `["only-user"]`, + AllUsers: false, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the only user + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "only-user")).To(Succeed()) + + // Verify plugin was auto-disabled + updated, err := pluginRepo.Get("user-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`[]`)) + Expect(updated.Enabled).To(BeFalse()) + }) + + It("does not disable plugin when allUsers is true", func() { + plugin := &model.Plugin{ + ID: "all-users-plugin", + Path: "/plugins/all.wasm", + Manifest: `{"name":"all-users","permissions":{"users":{}}}`, + SHA256: "ghi789", + Users: `["user1"]`, + AllUsers: true, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the user (but allUsers is true) + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "user1")).To(Succeed()) + + // Plugin should still be enabled because allUsers is true + updated, err := pluginRepo.Get("all-users-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Enabled).To(BeTrue()) + }) + + It("does not affect plugins without users permission requirement", func() { + plugin := &model.Plugin{ + ID: "no-users-perm", + Path: "/plugins/noperm.wasm", + Manifest: `{"name":"no-perm"}`, // No permissions.users in manifest + SHA256: "jkl012", + Users: `["user1"]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the user + db := GetDBXBuilder() + Expect(cleanupPluginUserReferences(db, "user1")).To(Succeed()) + + // Plugin should still be enabled (no users permission requirement) + updated, err := pluginRepo.Get("no-users-perm") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`[]`)) + Expect(updated.Enabled).To(BeTrue()) + }) + }) + + Describe("cleanupPluginLibraryReferences", func() { + It("removes library ID from plugin libraries array", func() { + // Create a plugin with multiple libraries + plugin := &model.Plugin{ + ID: "lib-plugin", + Path: "/plugins/lib.wasm", + Manifest: `{"name":"lib-plugin"}`, + SHA256: "mno345", + Libraries: `[1,2,3]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Clean up library 2 reference + db := GetDBXBuilder() + Expect(cleanupPluginLibraryReferences(db, 2)).To(Succeed()) + + // Verify library 2 was removed + updated, err := pluginRepo.Get("lib-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Libraries).To(Equal(`[1,3]`)) + }) + + It("auto-disables plugin when last permitted library is removed", func() { + // Create a plugin that requires library permission with only one library + plugin := &model.Plugin{ + ID: "lib-only-plugin", + Path: "/plugins/libonly.wasm", + Manifest: `{"name":"lib-only","permissions":{"library":{}}}`, + SHA256: "pqr678", + Libraries: `[99]`, + AllLibraries: false, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the only library + db := GetDBXBuilder() + Expect(cleanupPluginLibraryReferences(db, 99)).To(Succeed()) + + // Verify plugin was auto-disabled + updated, err := pluginRepo.Get("lib-only-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Libraries).To(Equal(`[]`)) + Expect(updated.Enabled).To(BeFalse()) + }) + + It("does not disable plugin when allLibraries is true", func() { + plugin := &model.Plugin{ + ID: "all-libs-plugin", + Path: "/plugins/alllibs.wasm", + Manifest: `{"name":"all-libs","permissions":{"library":{}}}`, + SHA256: "stu901", + Libraries: `[1]`, + AllLibraries: true, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Remove the library (but allLibraries is true) + db := GetDBXBuilder() + Expect(cleanupPluginLibraryReferences(db, 1)).To(Succeed()) + + // Plugin should still be enabled + updated, err := pluginRepo.Get("all-libs-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Enabled).To(BeTrue()) + }) + }) + + Describe("User Delete integration", func() { + It("cleans up plugin references when user is deleted", func() { + // Create a test user + user := &model.User{ + ID: "test-delete-user", + UserName: "plugin-cleanup-test-user", + IsAdmin: false, + } + user.NewPassword = "password123" + Expect(userRepo.Put(user)).To(Succeed()) + + // Create a plugin referencing this user + plugin := &model.Plugin{ + ID: "user-ref-plugin", + Path: "/plugins/userref.wasm", + Manifest: `{"name":"user-ref"}`, + SHA256: "xyz123", + Users: `["test-delete-user","other-user"]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Delete the user + Expect(userRepo.Delete("test-delete-user")).To(Succeed()) + + // Verify user was removed from plugin + updated, err := pluginRepo.Get("user-ref-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Users).To(Equal(`["other-user"]`)) + }) + }) + + Describe("Library Delete integration", func() { + It("cleans up plugin references when library is deleted", func() { + // Create a test library (ID > 1 since ID 1 cannot be deleted) + library := &model.Library{ + ID: 99, + Name: "Test Library", + Path: "/tmp/test-lib", + } + Expect(libraryRepo.Put(library)).To(Succeed()) + + // Create a plugin referencing this library + plugin := &model.Plugin{ + ID: "lib-ref-plugin", + Path: "/plugins/libref.wasm", + Manifest: `{"name":"lib-ref"}`, + SHA256: "abc789", + Libraries: `[99,1]`, + Enabled: true, + } + Expect(pluginRepo.Put(plugin)).To(Succeed()) + + // Delete the library + Expect(libraryRepo.Delete(99)).To(Succeed()) + + // Verify library was removed from plugin + updated, err := pluginRepo.Get("lib-ref-plugin") + Expect(err).ToNot(HaveOccurred()) + Expect(updated.Libraries).To(Equal(`[1]`)) + }) + }) +}) diff --git a/persistence/plugin_repository.go b/persistence/plugin_repository.go new file mode 100644 index 000000000..35c32de91 --- /dev/null +++ b/persistence/plugin_repository.go @@ -0,0 +1,171 @@ +package persistence + +import ( + "context" + "errors" + "time" + + . "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/pocketbase/dbx" +) + +type pluginRepository struct { + sqlRepository +} + +func NewPluginRepository(ctx context.Context, db dbx.Builder) model.PluginRepository { + r := &pluginRepository{} + r.ctx = ctx + r.db = db + r.registerModel(&model.Plugin{}, map[string]filterFunc{ + "id": idFilter("plugin"), + "enabled": booleanFilter, + }) + return r +} + +func (r *pluginRepository) isPermitted() bool { + user := loggedUser(r.ctx) + return user.IsAdmin +} + +func (r *pluginRepository) ClearErrors() error { + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + _, err := r.db.NewQuery("UPDATE plugin SET last_error = '' WHERE last_error != ''").Execute() + return err +} + +func (r *pluginRepository) CountAll(options ...model.QueryOptions) (int64, error) { + if !r.isPermitted() { + return 0, rest.ErrPermissionDenied + } + sql := r.newSelect() + return r.count(sql, options...) +} + +func (r *pluginRepository) Delete(id string) error { + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + return r.delete(Eq{"id": id}) +} + +func (r *pluginRepository) Get(id string) (*model.Plugin, error) { + if !r.isPermitted() { + return nil, rest.ErrPermissionDenied + } + sel := r.newSelect().Where(Eq{"id": id}).Columns("*") + res := model.Plugin{} + err := r.queryOne(sel, &res) + return &res, err +} + +func (r *pluginRepository) GetAll(options ...model.QueryOptions) (model.Plugins, error) { + if !r.isPermitted() { + return nil, rest.ErrPermissionDenied + } + sel := r.newSelect(options...).Columns("*") + res := model.Plugins{} + err := r.queryAll(sel, &res) + return res, err +} + +func (r *pluginRepository) Put(plugin *model.Plugin) error { + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + + plugin.UpdatedAt = time.Now() + + if plugin.ID == "" { + return errors.New("plugin ID cannot be empty") + } + + // Upsert using INSERT ... ON CONFLICT for atomic operation + _, err := r.db.NewQuery(` + INSERT INTO plugin (id, path, manifest, config, users, all_users, libraries, all_libraries, allow_write_access, enabled, last_error, sha256, created_at, updated_at) + VALUES ({:id}, {:path}, {:manifest}, {:config}, {:users}, {:all_users}, {:libraries}, {:all_libraries}, {:allow_write_access}, {:enabled}, {:last_error}, {:sha256}, {:created_at}, {:updated_at}) + ON CONFLICT(id) DO UPDATE SET + path = excluded.path, + manifest = excluded.manifest, + config = excluded.config, + users = excluded.users, + all_users = excluded.all_users, + libraries = excluded.libraries, + all_libraries = excluded.all_libraries, + allow_write_access = excluded.allow_write_access, + enabled = excluded.enabled, + last_error = excluded.last_error, + sha256 = excluded.sha256, + updated_at = excluded.updated_at + `).Bind(dbx.Params{ + "id": plugin.ID, + "path": plugin.Path, + "manifest": plugin.Manifest, + "config": plugin.Config, + "users": plugin.Users, + "all_users": plugin.AllUsers, + "libraries": plugin.Libraries, + "all_libraries": plugin.AllLibraries, + "allow_write_access": plugin.AllowWriteAccess, + "enabled": plugin.Enabled, + "last_error": plugin.LastError, + "sha256": plugin.SHA256, + "created_at": time.Now(), + "updated_at": plugin.UpdatedAt, + }).Execute() + return err +} + +func (r *pluginRepository) Count(options ...rest.QueryOptions) (int64, error) { + return r.CountAll(r.parseRestOptions(r.ctx, options...)) +} + +func (r *pluginRepository) EntityName() string { + return "plugin" +} + +func (r *pluginRepository) NewInstance() any { + return &model.Plugin{} +} + +func (r *pluginRepository) Read(id string) (any, error) { + return r.Get(id) +} + +func (r *pluginRepository) ReadAll(options ...rest.QueryOptions) (any, error) { + return r.GetAll(r.parseRestOptions(r.ctx, options...)) +} + +func (r *pluginRepository) Save(entity any) (string, error) { + p := entity.(*model.Plugin) + if !r.isPermitted() { + return "", rest.ErrPermissionDenied + } + err := r.Put(p) + if errors.Is(err, model.ErrNotFound) { + return "", rest.ErrNotFound + } + return p.ID, err +} + +func (r *pluginRepository) Update(id string, entity any, cols ...string) error { + p := entity.(*model.Plugin) + p.ID = id + if !r.isPermitted() { + return rest.ErrPermissionDenied + } + err := r.Put(p) + if errors.Is(err, model.ErrNotFound) { + return rest.ErrNotFound + } + return err +} + +var _ model.PluginRepository = (*pluginRepository)(nil) +var _ rest.Repository = (*pluginRepository)(nil) +var _ rest.Persistable = (*pluginRepository)(nil) diff --git a/persistence/plugin_repository_test.go b/persistence/plugin_repository_test.go new file mode 100644 index 000000000..dc68b0892 --- /dev/null +++ b/persistence/plugin_repository_test.go @@ -0,0 +1,251 @@ +package persistence + +import ( + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("PluginRepository", func() { + var repo model.PluginRepository + + Describe("Admin User", func() { + BeforeEach(func() { + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) + repo = NewPluginRepository(ctx, GetDBXBuilder()) + + // Clean up any existing plugins + all, _ := repo.GetAll() + for _, p := range all { + _ = repo.Delete(p.ID) + } + }) + + AfterEach(func() { + // Clean up after tests + all, _ := repo.GetAll() + for _, p := range all { + _ = repo.Delete(p.ID) + } + }) + + Describe("CountAll", func() { + It("returns 0 when no plugins exist", func() { + Expect(repo.CountAll()).To(Equal(int64(0))) + }) + + It("returns the number of plugins in the DB", func() { + _ = repo.Put(&model.Plugin{ID: "test-plugin-1", Path: "/plugins/test1.wasm", Manifest: "{}", SHA256: "abc123"}) + _ = repo.Put(&model.Plugin{ID: "test-plugin-2", Path: "/plugins/test2.wasm", Manifest: "{}", SHA256: "def456"}) + + Expect(repo.CountAll()).To(Equal(int64(2))) + }) + }) + + Describe("Delete", func() { + It("deletes existing item", func() { + plugin := &model.Plugin{ID: "to-delete", Path: "/plugins/delete.wasm", Manifest: "{}", SHA256: "hash"} + _ = repo.Put(plugin) + + err := repo.Delete(plugin.ID) + Expect(err).To(BeNil()) + + _, err = repo.Get(plugin.ID) + Expect(err).To(MatchError(model.ErrNotFound)) + }) + }) + + Describe("Get", func() { + It("returns an existing item", func() { + plugin := &model.Plugin{ID: "test-get", Path: "/plugins/test.wasm", Manifest: `{"name":"test"}`, SHA256: "hash123"} + _ = repo.Put(plugin) + + res, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(res.ID).To(Equal(plugin.ID)) + Expect(res.Path).To(Equal(plugin.Path)) + Expect(res.Manifest).To(Equal(plugin.Manifest)) + }) + + It("errors when missing", func() { + _, err := repo.Get("notanid") + Expect(err).To(MatchError(model.ErrNotFound)) + }) + }) + + Describe("GetAll", func() { + It("returns all items from the DB", func() { + _ = repo.Put(&model.Plugin{ID: "plugin-a", Path: "/plugins/a.wasm", Manifest: "{}", SHA256: "hash1"}) + _ = repo.Put(&model.Plugin{ID: "plugin-b", Path: "/plugins/b.wasm", Manifest: "{}", SHA256: "hash2"}) + + all, err := repo.GetAll() + Expect(err).To(BeNil()) + Expect(all).To(HaveLen(2)) + }) + + It("supports pagination", func() { + _ = repo.Put(&model.Plugin{ID: "plugin-1", Path: "/plugins/1.wasm", Manifest: "{}", SHA256: "h1"}) + _ = repo.Put(&model.Plugin{ID: "plugin-2", Path: "/plugins/2.wasm", Manifest: "{}", SHA256: "h2"}) + _ = repo.Put(&model.Plugin{ID: "plugin-3", Path: "/plugins/3.wasm", Manifest: "{}", SHA256: "h3"}) + + page1, err := repo.GetAll(model.QueryOptions{Max: 2, Offset: 0, Sort: "id"}) + Expect(err).To(BeNil()) + Expect(page1).To(HaveLen(2)) + + page2, err := repo.GetAll(model.QueryOptions{Max: 2, Offset: 2, Sort: "id"}) + Expect(err).To(BeNil()) + Expect(page2).To(HaveLen(1)) + }) + }) + + Describe("Put", func() { + It("successfully creates a new plugin", func() { + plugin := &model.Plugin{ + ID: "new-plugin", + Path: "/plugins/new.wasm", + Manifest: `{"name":"new","version":"1.0"}`, + Config: `{"setting":"value"}`, + SHA256: "sha256hash", + Enabled: false, + } + + err := repo.Put(plugin) + Expect(err).To(BeNil()) + + saved, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(saved.Path).To(Equal(plugin.Path)) + Expect(saved.Manifest).To(Equal(plugin.Manifest)) + Expect(saved.Config).To(Equal(plugin.Config)) + Expect(saved.Enabled).To(BeFalse()) + Expect(saved.CreatedAt).NotTo(BeZero()) + Expect(saved.UpdatedAt).NotTo(BeZero()) + }) + + It("successfully updates an existing plugin", func() { + plugin := &model.Plugin{ + ID: "update-plugin", + Path: "/plugins/update.wasm", + Manifest: `{"name":"test"}`, + SHA256: "original", + Enabled: false, + } + _ = repo.Put(plugin) + + plugin.Enabled = true + plugin.Config = `{"new":"config"}` + plugin.SHA256 = "updated" + err := repo.Put(plugin) + Expect(err).To(BeNil()) + + saved, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(saved.Enabled).To(BeTrue()) + Expect(saved.Config).To(Equal(`{"new":"config"}`)) + Expect(saved.SHA256).To(Equal("updated")) + }) + + It("stores and retrieves last_error", func() { + plugin := &model.Plugin{ + ID: "error-plugin", + Path: "/plugins/error.wasm", + Manifest: "{}", + SHA256: "hash", + LastError: "failed to load: missing export", + } + err := repo.Put(plugin) + Expect(err).To(BeNil()) + + saved, err := repo.Get(plugin.ID) + Expect(err).To(BeNil()) + Expect(saved.LastError).To(Equal("failed to load: missing export")) + }) + + It("fails when ID is empty", func() { + plugin := &model.Plugin{ + Path: "/plugins/noid.wasm", + Manifest: "{}", + SHA256: "hash", + } + err := repo.Put(plugin) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ID cannot be empty")) + }) + }) + + Describe("ClearErrors", func() { + It("clears last_error on all plugins with errors", func() { + _ = repo.Put(&model.Plugin{ID: "ok-plugin", Path: "/plugins/ok.wasm", Manifest: "{}", SHA256: "h1"}) + _ = repo.Put(&model.Plugin{ID: "err-plugin-1", Path: "/plugins/e1.wasm", Manifest: "{}", SHA256: "h2", LastError: "incompatible version"}) + _ = repo.Put(&model.Plugin{ID: "err-plugin-2", Path: "/plugins/e2.wasm", Manifest: "{}", SHA256: "h3", LastError: "missing export"}) + + err := repo.ClearErrors() + Expect(err).To(BeNil()) + + all, err := repo.GetAll() + Expect(err).To(BeNil()) + for _, p := range all { + Expect(p.LastError).To(BeEmpty(), "plugin %s should have no error", p.ID) + } + }) + + It("succeeds when no plugins have errors", func() { + _ = repo.Put(&model.Plugin{ID: "clean-plugin", Path: "/plugins/c.wasm", Manifest: "{}", SHA256: "h1"}) + + err := repo.ClearErrors() + Expect(err).To(BeNil()) + }) + }) + }) + + Describe("Regular User", func() { + BeforeEach(func() { + ctx := GinkgoT().Context() + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: false}) + repo = NewPluginRepository(ctx, GetDBXBuilder()) + }) + + Describe("CountAll", func() { + It("fails to count items", func() { + _, err := repo.CountAll() + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("Delete", func() { + It("fails to delete items", func() { + err := repo.Delete("any-id") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("Get", func() { + It("fails to get items", func() { + _, err := repo.Get("any-id") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("GetAll", func() { + It("fails to get all items", func() { + _, err := repo.GetAll() + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + + Describe("Put", func() { + It("fails to create/update item", func() { + err := repo.Put(&model.Plugin{ + ID: "user-create", + Path: "/plugins/create.wasm", + Manifest: "{}", + SHA256: "hash", + }) + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + }) + }) +}) diff --git a/persistence/radio_repository.go b/persistence/radio_repository.go index cf253d06b..a073643db 100644 --- a/persistence/radio_repository.go +++ b/persistence/radio_repository.go @@ -58,34 +58,20 @@ func (r *radioRepository) GetAll(options ...model.QueryOptions) (model.Radios, e return res, err } -func (r *radioRepository) Put(radio *model.Radio) error { +func (r *radioRepository) Put(radio *model.Radio, colsToUpdate ...string) error { if !r.isPermitted() { return rest.ErrPermissionDenied } - var values map[string]interface{} - radio.UpdatedAt = time.Now() - if radio.ID == "" { radio.CreatedAt = time.Now() radio.ID = id.NewRandom() - values, _ = toSQLArgs(*radio) - } else { - values, _ = toSQLArgs(*radio) - update := Update(r.tableName).Where(Eq{"id": radio.ID}).SetMap(values) - count, err := r.executeSQL(update) - - if err != nil { - return err - } else if count > 0 { - return nil - } } - - values["created_at"] = time.Now() - insert := Insert(r.tableName).SetMap(values) - _, err := r.executeSQL(insert) + if len(colsToUpdate) > 0 { + colsToUpdate = append(colsToUpdate, "UpdatedAt") + } + _, err := r.put(radio.ID, radio, colsToUpdate...) return err } @@ -97,19 +83,19 @@ func (r *radioRepository) EntityName() string { return "radio" } -func (r *radioRepository) NewInstance() interface{} { +func (r *radioRepository) NewInstance() any { return &model.Radio{} } -func (r *radioRepository) Read(id string) (interface{}, error) { +func (r *radioRepository) Read(id string) (any, error) { return r.Get(id) } -func (r *radioRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *radioRepository) ReadAll(options ...rest.QueryOptions) (any, error) { return r.GetAll(r.parseRestOptions(r.ctx, options...)) } -func (r *radioRepository) Save(entity interface{}) (string, error) { +func (r *radioRepository) Save(entity any) (string, error) { t := entity.(*model.Radio) if !r.isPermitted() { return "", rest.ErrPermissionDenied @@ -121,7 +107,7 @@ func (r *radioRepository) Save(entity interface{}) (string, error) { return t.ID, err } -func (r *radioRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *radioRepository) Update(id string, entity any, cols ...string) error { t := entity.(*model.Radio) t.ID = id if !r.isPermitted() { diff --git a/persistence/radio_repository_test.go b/persistence/radio_repository_test.go index 88a31ac49..05628ca41 100644 --- a/persistence/radio_repository_test.go +++ b/persistence/radio_repository_test.go @@ -11,10 +11,6 @@ import ( . "github.com/onsi/gomega" ) -var ( - NewId string = "123-456-789" -) - var _ = Describe("RadioRepository", func() { var repo model.RadioRepository @@ -34,8 +30,7 @@ var _ = Describe("RadioRepository", func() { } for i := range testRadios { - r := testRadios[i] - err := repo.Put(&r) + err := repo.Put(new(testRadios[i])) if err != nil { panic(err) } @@ -140,7 +135,7 @@ var _ = Describe("RadioRepository", func() { It("returns an existing item", func() { res, err := repo.Get(radioWithHomePage.ID) - Expect(err).To((BeNil())) + Expect(err).To(BeNil()) Expect(res.ID).To(Equal(radioWithHomePage.ID)) }) diff --git a/persistence/scrobble_buffer_repository.go b/persistence/scrobble_buffer_repository.go index d0f88903e..3cfb836bf 100644 --- a/persistence/scrobble_buffer_repository.go +++ b/persistence/scrobble_buffer_repository.go @@ -51,7 +51,7 @@ func (r *scrobbleBufferRepository) UserIDs(service string) ([]string, error) { } func (r *scrobbleBufferRepository) Enqueue(service, userId, mediaFileId string, playTime time.Time) error { - ins := Insert(r.tableName).SetMap(map[string]interface{}{ + ins := Insert(r.tableName).SetMap(map[string]any{ "id": id.NewRandom(), "user_id": userId, "service": service, diff --git a/persistence/scrobble_buffer_repository_test.go b/persistence/scrobble_buffer_repository_test.go index 6962ea7c6..edf59ce49 100644 --- a/persistence/scrobble_buffer_repository_test.go +++ b/persistence/scrobble_buffer_repository_test.go @@ -24,7 +24,7 @@ var _ = Describe("ScrobbleBufferRepository", func() { id := id.NewRandom() ids = append(ids, id) - ins := squirrel.Insert("scrobble_buffer").SetMap(map[string]interface{}{ + ins := squirrel.Insert("scrobble_buffer").SetMap(map[string]any{ "id": id, "user_id": userId, "service": service, @@ -152,7 +152,7 @@ var _ = Describe("ScrobbleBufferRepository", func() { Expect(err).ToNot(HaveOccurred()) Expect(entry).ToNot(BeNil()) - Expect(entry.EnqueueTime).To(BeTemporally("~", now)) + Expect(entry.EnqueueTime).To(BeTemporally("~", now, 100*time.Millisecond)) Expect(entry.MediaFileID).To(Equal(fileId)) Expect(entry.PlayTime).To(BeTemporally("==", playTime)) }, diff --git a/persistence/scrobble_repository.go b/persistence/scrobble_repository.go new file mode 100644 index 000000000..219a48198 --- /dev/null +++ b/persistence/scrobble_repository.go @@ -0,0 +1,34 @@ +package persistence + +import ( + "context" + "time" + + . "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/model" + "github.com/pocketbase/dbx" +) + +type scrobbleRepository struct { + sqlRepository +} + +func NewScrobbleRepository(ctx context.Context, db dbx.Builder) model.ScrobbleRepository { + r := &scrobbleRepository{} + r.ctx = ctx + r.db = db + r.tableName = "scrobbles" + return r +} + +func (r *scrobbleRepository) RecordScrobble(mediaFileID string, submissionTime time.Time) error { + userID := loggedUser(r.ctx).ID + values := map[string]any{ + "media_file_id": mediaFileID, + "user_id": userID, + "submission_time": submissionTime.Unix(), + } + insert := Insert(r.tableName).SetMap(values) + _, err := r.executeSQL(insert) + return err +} diff --git a/persistence/scrobble_repository_test.go b/persistence/scrobble_repository_test.go new file mode 100644 index 000000000..d43848d03 --- /dev/null +++ b/persistence/scrobble_repository_test.go @@ -0,0 +1,84 @@ +package persistence + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +var _ = Describe("ScrobbleRepository", func() { + var repo model.ScrobbleRepository + var rawRepo sqlRepository + var ctx context.Context + var fileID string + var userID string + + BeforeEach(func() { + fileID = id.NewRandom() + userID = id.NewRandom() + ctx = request.WithUser(log.NewContext(GinkgoT().Context()), model.User{ID: userID, UserName: "johndoe", IsAdmin: true}) + db := GetDBXBuilder() + repo = NewScrobbleRepository(ctx, db) + + rawRepo = sqlRepository{ + ctx: ctx, + tableName: "scrobbles", + db: db, + } + }) + + AfterEach(func() { + _, _ = rawRepo.db.Delete("scrobbles", dbx.HashExp{"media_file_id": fileID}).Execute() + _, _ = rawRepo.db.Delete("media_file", dbx.HashExp{"id": fileID}).Execute() + _, _ = rawRepo.db.Delete("user", dbx.HashExp{"id": userID}).Execute() + }) + + Describe("RecordScrobble", func() { + It("records a scrobble event", func() { + submissionTime := time.Now().UTC() + + // Insert User + _, err := rawRepo.db.Insert("user", dbx.Params{ + "id": userID, + "user_name": "user", + "password": "pw", + "created_at": time.Now(), + "updated_at": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + // Insert MediaFile + _, err = rawRepo.db.Insert("media_file", dbx.Params{ + "id": fileID, + "path": "path", + "created_at": time.Now(), + "updated_at": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + err = repo.RecordScrobble(fileID, submissionTime) + Expect(err).ToNot(HaveOccurred()) + + // Verify insertion + var scrobble struct { + MediaFileID string `db:"media_file_id"` + UserID string `db:"user_id"` + SubmissionTime int64 `db:"submission_time"` + } + err = rawRepo.db.Select("*").From("scrobbles"). + Where(dbx.HashExp{"media_file_id": fileID, "user_id": userID}). + One(&scrobble) + Expect(err).ToNot(HaveOccurred()) + Expect(scrobble.MediaFileID).To(Equal(fileID)) + Expect(scrobble.UserID).To(Equal(userID)) + Expect(scrobble.SubmissionTime).To(Equal(submissionTime.Unix())) + }) + }) +}) diff --git a/persistence/share_repository.go b/persistence/share_repository.go index abe1ea6e6..89dc19e19 100644 --- a/persistence/share_repository.go +++ b/persistence/share_repository.go @@ -31,20 +31,17 @@ func NewShareRepository(ctx context.Context, db dbx.Builder) model.ShareReposito } func (r *shareRepository) Delete(id string) error { - err := r.delete(Eq{"id": id}) - if errors.Is(err, model.ErrNotFound) { - return rest.ErrNotFound - } - return err + return r.deleteOwned(id) } func (r *shareRepository) selectShare(options ...model.QueryOptions) SelectBuilder { return r.newSelect(options...).Join("user u on u.id = share.user_id"). - Columns("share.*", "user_name as username") + Columns("share.*", "user_name as username"). + Where(r.addRestriction()) } func (r *shareRepository) Exists(id string) (bool, error) { - return r.exists(Eq{"id": id}) + return r.exists(r.addRestriction(And{Eq{"id": id}})) } func (r *shareRepository) Get(id string) (*model.Share, error) { @@ -95,7 +92,7 @@ func (r *shareRepository) loadMedia(share *model.Share) error { return err case "album": albumRepo := NewAlbumRepository(r.ctx, r.db) - share.Albums, err = albumRepo.GetAll(model.QueryOptions{Filters: noMissing(Eq{"id": ids})}) + share.Albums, err = albumRepo.GetAll(model.QueryOptions{Filters: noMissing(Eq{"album.id": ids})}) if err != nil { return err } @@ -138,20 +135,17 @@ func sortByIdPosition(mfs model.MediaFiles, ids []string) model.MediaFiles { return sorted } -func (r *shareRepository) Update(id string, entity interface{}, cols ...string) error { +func (r *shareRepository) Update(id string, entity any, cols ...string) error { s := entity.(*model.Share) - // TODO Validate record s.ID = id s.UpdatedAt = time.Now() - cols = append(cols, "updated_at") - _, err := r.put(id, s, cols...) - if errors.Is(err, model.ErrNotFound) { - return rest.ErrNotFound + if len(cols) > 0 { + cols = append(cols, "updated_at") } - return err + return r.updateOwned(id, s, cols...) } -func (r *shareRepository) Save(entity interface{}) (string, error) { +func (r *shareRepository) Save(entity any) (string, error) { s := entity.(*model.Share) // TODO Validate record u := loggedUser(r.ctx) @@ -179,18 +173,18 @@ func (r *shareRepository) EntityName() string { return "share" } -func (r *shareRepository) NewInstance() interface{} { +func (r *shareRepository) NewInstance() any { return &model.Share{} } -func (r *shareRepository) Read(id string) (interface{}, error) { +func (r *shareRepository) Read(id string) (any, error) { sel := r.selectShare().Where(Eq{"share.id": id}) var res model.Share err := r.queryOne(sel, &res) return &res, err } -func (r *shareRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *shareRepository) ReadAll(options ...rest.QueryOptions) (any, error) { sq := r.selectShare(r.parseRestOptions(r.ctx, options...)) res := model.Shares{} err := r.queryAll(sq, &res) diff --git a/persistence/share_repository_test.go b/persistence/share_repository_test.go new file mode 100644 index 000000000..0b3ece598 --- /dev/null +++ b/persistence/share_repository_test.go @@ -0,0 +1,395 @@ +package persistence + +import ( + "context" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ShareRepository", func() { + var repo model.ShareRepository + var ctx context.Context + var adminUser = model.User{ID: "admin", UserName: "admin", IsAdmin: true} + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = request.WithUser(log.NewContext(GinkgoT().Context()), adminUser) + repo = NewShareRepository(ctx, GetDBXBuilder()) + + // Insert the admin user into the database (required for foreign key constraint) + ur := NewUserRepository(ctx, GetDBXBuilder()) + err := ur.Put(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + // Clean up shares + db := GetDBXBuilder() + _, err = db.NewQuery("DELETE FROM share").Execute() + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("Headless Access", func() { + Context("Repository creation and basic operations", func() { + It("should create repository successfully with no user context", func() { + // Create repository with no user context (headless) + headlessRepo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + Expect(headlessRepo).ToNot(BeNil()) + }) + + It("should handle GetAll for headless processes", func() { + // Create a simple share directly in database + shareID := "headless-test-share" + _, err := GetDBXBuilder().NewQuery(` + INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) + VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) + `).Bind(map[string]any{ + "id": shareID, + "user": adminUser.ID, + "desc": "Headless Test Share", + "type": "song", + "ids": "song-1", + "created": time.Now(), + "updated": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + // Headless process should see all shares + headlessRepo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + shares, err := headlessRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + + found := false + for _, s := range shares { + if s.ID == shareID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Headless process should see all shares") + }) + + It("should handle individual share retrieval for headless processes", func() { + // Create a simple share + shareID := "headless-get-share" + _, err := GetDBXBuilder().NewQuery(` + INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) + VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) + `).Bind(map[string]any{ + "id": shareID, + "user": adminUser.ID, + "desc": "Headless Get Share", + "type": "song", + "ids": "song-2", + "created": time.Now(), + "updated": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + // Headless process should be able to get the share + headlessRepo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + share, err := headlessRepo.Get(shareID) + Expect(err).ToNot(HaveOccurred()) + Expect(share.ID).To(Equal(shareID)) + Expect(share.Description).To(Equal("Headless Get Share")) + }) + }) + }) + + Describe("SQL ambiguity fix verification", func() { + It("should handle share operations without SQL ambiguity errors", func() { + // This test verifies that the loadMedia function doesn't cause SQL ambiguity + // The key fix was using "album.id" instead of "id" in the album query filters + + // Create a share that would trigger the loadMedia function + shareID := "sql-test-share" + _, err := GetDBXBuilder().NewQuery(` + INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) + VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) + `).Bind(map[string]any{ + "id": shareID, + "user": adminUser.ID, + "desc": "SQL Test Share", + "type": "album", + "ids": "non-existent-album", // Won't find albums, but shouldn't cause SQL errors + "created": time.Now(), + "updated": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + // The Get operation should work without SQL ambiguity errors + // even if no albums are found + share, err := repo.Get(shareID) + Expect(err).ToNot(HaveOccurred()) + Expect(share.ID).To(Equal(shareID)) + // Albums array should be empty since we used non-existent album ID + Expect(share.Albums).To(BeEmpty()) + }) + }) + + Describe("Ownership Checks", func() { + var ownerUser = model.User{ID: "2222", UserName: "regular-user"} + var otherUser = model.User{ID: "3333", UserName: "third-user"} + + insertShare := func(shareID, userID string) { + _, err := GetDBXBuilder().NewQuery(` + INSERT INTO share (id, user_id, description, resource_type, resource_ids, created_at, updated_at) + VALUES ({:id}, {:user}, {:desc}, {:type}, {:ids}, {:created}, {:updated}) + `).Bind(map[string]any{ + "id": shareID, + "user": userID, + "desc": "Test Share", + "type": "media_file", + "ids": "1001", + "created": time.Now(), + "updated": time.Now(), + }).Execute() + Expect(err).ToNot(HaveOccurred()) + } + + Describe("Delete", func() { + It("allows a non-admin user to delete their own share", func() { + insertShare("own-share-del", ownerUser.ID) + ctx := request.WithUser(log.NewContext(GinkgoT().Context()), ownerUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("own-share-del") + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies a non-admin user from deleting another user's share", func() { + insertShare("other-share-del", ownerUser.ID) + ctx := request.WithUser(log.NewContext(GinkgoT().Context()), otherUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("other-share-del") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + + // The share was not deleted: the owner can still read it. + ownerCtx := request.WithUser(log.NewContext(GinkgoT().Context()), ownerUser) + ownerRepo := NewShareRepository(ownerCtx, GetDBXBuilder()) + _, err = ownerRepo.(rest.Repository).Read("other-share-del") + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows an admin to delete any user's share", func() { + insertShare("admin-del-share", ownerUser.ID) + ctx := request.WithUser(log.NewContext(GinkgoT().Context()), adminUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("admin-del-share") + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows headless context (no user) to delete a share", func() { + insertShare("headless-del-share", ownerUser.ID) + repo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + err := repo.(rest.Persistable).Delete("headless-del-share") + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Update", func() { + It("allows a non-admin user to update their own share", func() { + insertShare("own-share-upd", ownerUser.ID) + ctx := request.WithUser(log.NewContext(GinkgoT().Context()), ownerUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("own-share-upd", &model.Share{Description: "Updated"}, "description") + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies a non-admin user from updating another user's share", func() { + insertShare("other-share-upd", ownerUser.ID) + ctx := request.WithUser(log.NewContext(GinkgoT().Context()), otherUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("other-share-upd", &model.Share{Description: "Hacked"}, "description") + Expect(err).To(Equal(rest.ErrPermissionDenied)) + }) + + It("allows an admin to update any user's share", func() { + insertShare("admin-upd-share", ownerUser.ID) + ctx := request.WithUser(log.NewContext(GinkgoT().Context()), adminUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("admin-upd-share", &model.Share{Description: "Admin Updated"}, "description") + Expect(err).ToNot(HaveOccurred()) + }) + + It("allows headless context (no user) to update a share", func() { + insertShare("headless-upd-share", ownerUser.ID) + repo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + err := repo.(rest.Persistable).Update("headless-upd-share", &model.Share{Description: "Headless"}, "description") + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns not found when updating a nonexistent share", func() { + ctx := request.WithUser(log.NewContext(context.TODO()), ownerUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("does-not-exist", &model.Share{Description: "Ghost"}, "description") + Expect(err).To(Equal(rest.ErrNotFound)) + }) + + It("updates all columns when no specific columns are given", func() { + insertShare("all-cols-share", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), ownerUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + // No cols: the update must write every column, not just updated_at. + err := repo.(rest.Persistable).Update("all-cols-share", + &model.Share{Description: "All Updated", MaxBitRate: 192, ResourceType: "album", ResourceIDs: "2002"}) + Expect(err).ToNot(HaveOccurred()) + + got, err := repo.(rest.Repository).Read("all-cols-share") + Expect(err).ToNot(HaveOccurred()) + share := got.(*model.Share) + Expect(share.Description).To(Equal("All Updated")) + Expect(share.MaxBitRate).To(Equal(192)) + Expect(share.ResourceType).To(Equal("album")) + }) + + It("does not let an owner reassign their share to another user", func() { + insertShare("reassign-share", ownerUser.ID) + ctx := request.WithUser(log.NewContext(context.TODO()), ownerUser) + repo := NewShareRepository(ctx, GetDBXBuilder()) + err := repo.(rest.Persistable).Update("reassign-share", + &model.Share{UserID: otherUser.ID, Description: "Given away"}, "user_id", "description") + Expect(err).ToNot(HaveOccurred()) + + // Ownership must not have moved, even though user_id was passed in the body and cols. + got, err := repo.(rest.Repository).Read("reassign-share") + Expect(err).ToNot(HaveOccurred()) + Expect(got.(*model.Share).UserID).To(Equal(ownerUser.ID)) + }) + }) + + Describe("Read scoping", func() { + BeforeEach(func() { + // Persist owner/other users so the JOIN in selectShare resolves. + ur := NewUserRepository(ctx, GetDBXBuilder()) + Expect(ur.Put(&ownerUser)).To(Succeed()) + Expect(ur.Put(&otherUser)).To(Succeed()) + + insertShare("share-owner-1", ownerUser.ID) + insertShare("share-owner-2", ownerUser.ID) + insertShare("share-other-1", otherUser.ID) + }) + + Context("non-admin user", func() { + var nonAdminRepo model.ShareRepository + var nonAdminRest rest.Repository + + BeforeEach(func() { + nonAdminCtx := request.WithUser(log.NewContext(GinkgoT().Context()), ownerUser) + nonAdminRepo = NewShareRepository(nonAdminCtx, GetDBXBuilder()) + nonAdminRest = nonAdminRepo.(rest.Repository) + }) + + It("GetAll returns only own shares", func() { + shares, err := nonAdminRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + ids := make([]string, len(shares)) + for i, s := range shares { + ids[i] = s.ID + } + Expect(ids).To(ConsistOf("share-owner-1", "share-owner-2")) + }) + + It("ReadAll returns only own shares", func() { + res, err := nonAdminRest.ReadAll() + Expect(err).ToNot(HaveOccurred()) + shares := res.(model.Shares) + ids := make([]string, len(shares)) + for i, s := range shares { + ids[i] = s.ID + } + Expect(ids).To(ConsistOf("share-owner-1", "share-owner-2")) + }) + + It("Get returns own share", func() { + s, err := nonAdminRepo.Get("share-owner-1") + Expect(err).ToNot(HaveOccurred()) + Expect(s.ID).To(Equal("share-owner-1")) + }) + + It("Get returns ErrNotFound for another user's share", func() { + _, err := nonAdminRepo.Get("share-other-1") + Expect(err).To(MatchError(model.ErrNotFound)) + }) + + It("Read returns ErrNotFound for another user's share", func() { + _, err := nonAdminRest.Read("share-other-1") + Expect(err).To(MatchError(model.ErrNotFound)) + }) + + It("Exists returns true for own share", func() { + exists, err := nonAdminRepo.Exists("share-owner-1") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + + It("Exists returns false for another user's share", func() { + exists, err := nonAdminRepo.Exists("share-other-1") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("CountAll counts only own shares", func() { + count, err := nonAdminRepo.CountAll() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(BeNumerically("==", 2)) + }) + + It("Count (rest) counts only own shares", func() { + count, err := nonAdminRest.Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(BeNumerically("==", 2)) + }) + }) + + Context("admin user", func() { + It("GetAll returns all shares", func() { + adminCtx := request.WithUser(log.NewContext(GinkgoT().Context()), adminUser) + adminRepo := NewShareRepository(adminCtx, GetDBXBuilder()) + shares, err := adminRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + ids := make([]string, len(shares)) + for i, s := range shares { + ids[i] = s.ID + } + Expect(ids).To(ConsistOf("share-owner-1", "share-owner-2", "share-other-1")) + }) + + It("CountAll counts all shares", func() { + adminCtx := request.WithUser(log.NewContext(GinkgoT().Context()), adminUser) + adminRepo := NewShareRepository(adminCtx, GetDBXBuilder()) + count, err := adminRepo.CountAll() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(BeNumerically("==", 3)) + }) + }) + + Context("headless context (public share route)", func() { + It("GetAll returns all shares", func() { + headlessRepo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + shares, err := headlessRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(shares).To(HaveLen(3)) + }) + + It("Get returns another user's share", func() { + headlessRepo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + s, err := headlessRepo.Get("share-other-1") + Expect(err).ToNot(HaveOccurred()) + Expect(s.ID).To(Equal("share-other-1")) + }) + + It("Exists returns true for any share", func() { + headlessRepo := NewShareRepository(GinkgoT().Context(), GetDBXBuilder()) + exists, err := headlessRepo.Exists("share-other-1") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + }) + }) + }) +}) diff --git a/persistence/smart_playlist_repository.go b/persistence/smart_playlist_repository.go new file mode 100644 index 000000000..54f316152 --- /dev/null +++ b/persistence/smart_playlist_repository.go @@ -0,0 +1,203 @@ +package persistence + +import ( + "time" + + . "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +// PlaylistRepository methods to handle smart playlists, which are defined by criteria and automatically populated +// based on their rules. The main method is refreshSmartPlaylist, which evaluates the criteria and updates the playlist +// tracks accordingly. It also handles refreshing dependent playlists when a smart playlist references other playlists +// in its criteria. To optimize performance, it only refreshes when necessary based on the last evaluated time and +// configured refresh delay. + +// refreshSmartPlaylist evaluates the criteria of a smart playlist and updates its tracks accordingly. +func (r *playlistRepository) refreshSmartPlaylist(pls *model.Playlist) bool { + usr := loggedUser(r.ctx) + if !r.shouldRefreshSmartPlaylist(pls, usr) { + return false + } + + log.Debug(r.ctx, "Refreshing smart playlist", "playlist", pls.Name, "id", pls.ID) + start := time.Now() + + del := Delete("playlist_tracks").Where(Eq{"playlist_id": pls.ID}) + if _, err := r.executeSQL(del); err != nil { + log.Error(r.ctx, "Error deleting old smart playlist tracks", "playlist", pls.Name, "id", pls.ID, err) + return false + } + + rulesSQL := newSmartPlaylistCriteria(*pls.Rules, withSmartPlaylistOwner(*usr)) + + if !r.refreshChildPlaylists(pls, rulesSQL) { + return false + } + + if err := r.resolvePercentageLimit(pls, &rulesSQL, usr.ID); err != nil { + return false + } + + sq := r.buildSmartPlaylistQuery(pls, rulesSQL, usr.ID) + sq, err := r.addCriteria(sq, rulesSQL) + if err != nil { + log.Error(r.ctx, "Error building smart playlist criteria", "playlist", pls.Name, "id", pls.ID, err) + return false + } + + insSql := Insert("playlist_tracks").Columns("id", "playlist_id", "media_file_id").Select(sq) + if _, err = r.executeSQL(insSql); err != nil { + log.Error(r.ctx, "Error refreshing smart playlist tracks", "playlist", pls.Name, "id", pls.ID, err) + return false + } + + if err = r.refreshCounters(pls); err != nil { + log.Error(r.ctx, "Error updating smart playlist stats", "playlist", pls.Name, "id", pls.ID, err) + return false + } + + now := time.Now() + updSql := Update(r.tableName).Set("evaluated_at", now).Where(Eq{"id": pls.ID}) + if _, err = r.executeSQL(updSql); err != nil { + log.Error(r.ctx, "Error updating smart playlist", "playlist", pls.Name, "id", pls.ID, err) + return false + } + pls.EvaluatedAt = &now + + log.Debug(r.ctx, "Refreshed playlist", "playlist", pls.Name, "id", pls.ID, "numTracks", pls.SongCount, "elapsed", time.Since(start)) + return true +} + +// shouldRefreshSmartPlaylist determines if a smart playlist needs to be refreshed based on its type, last evaluated +// time, and ownership. +func (r *playlistRepository) shouldRefreshSmartPlaylist(pls *model.Playlist, usr *model.User) bool { + if !pls.IsSmartPlaylist() { + return false + } + if pls.EvaluatedAt != nil && time.Since(*pls.EvaluatedAt) < conf.Server.SmartPlaylistRefreshDelay { + return false + } + if pls.OwnerID != usr.ID { + log.Trace(r.ctx, "Not refreshing smart playlist from other user", "playlist", pls.Name, "id", pls.ID) + return false + } + return true +} + +// refreshChildPlaylists handles refreshing any child playlists that are referenced in the smart playlist criteria. +// Returns false if child playlists could not be loaded (DB error), signaling the parent refresh should abort. +func (r *playlistRepository) refreshChildPlaylists(pls *model.Playlist, rulesSQL smartPlaylistCriteria) bool { + childPlaylistIds := rulesSQL.ChildPlaylistIds() + if len(childPlaylistIds) == 0 { + return true + } + + childPlaylists, err := r.GetAll(model.QueryOptions{Filters: Eq{"playlist.id": childPlaylistIds}}) + if err != nil { + log.Error(r.ctx, "Error loading child playlists for smart playlist refresh", "playlist", pls.Name, "id", pls.ID, "childIds", childPlaylistIds, err) + return false + } + + found := make(map[string]struct{}, len(childPlaylists)) + for i := range childPlaylists { + found[childPlaylists[i].ID] = struct{}{} + r.refreshSmartPlaylist(&childPlaylists[i]) + } + for _, id := range childPlaylistIds { + if _, ok := found[id]; !ok { + log.Warn(r.ctx, "Referenced playlist is not accessible to smart playlist owner", "playlist", pls.Name, "id", pls.ID, "childId", id, "ownerId", pls.OwnerID) + } + } + return true +} + +// resolvePercentageLimit calculates the actual limit for a smart playlist criteria that uses a percentage-based limit. +func (r *playlistRepository) resolvePercentageLimit(pls *model.Playlist, rulesSQL *smartPlaylistCriteria, userID string) error { + if !rulesSQL.IsPercentageLimit() { + return nil + } + + exprJoins := rulesSQL.ExpressionJoins() + countSq := Select("count(*) as count").From("media_file") + countSq = r.addMediaFileAnnotationJoin(countSq, userID) + countSq = r.addSmartPlaylistAnnotationJoins(countSq, exprJoins, userID) + countSq = r.applyLibraryFilter(countSq, "media_file") + + cond, err := rulesSQL.Where() + if err != nil { + log.Error(r.ctx, "Error building smart playlist criteria", "playlist", pls.Name, "id", pls.ID, err) + return err + } + countSq = countSq.Where(cond) + + var res struct{ Count int64 } + if err = r.queryOne(countSq, &res); err != nil { + log.Error(r.ctx, "Error counting matching tracks for percentage limit", "playlist", pls.Name, "id", pls.ID, err) + return err + } + + rulesSQL.ResolveLimit(res.Count) + log.Debug(r.ctx, "Resolved percentage limit", "playlist", pls.Name, "percent", rulesSQL.LimitPercent, "totalMatching", res.Count, "resolvedLimit", rulesSQL.Limit) + return nil +} + +// buildSmartPlaylistQuery constructs the SQL query to select media files matching the smart playlist criteria, +// including necessary joins for annotations and library filtering. +func (r *playlistRepository) buildSmartPlaylistQuery(pls *model.Playlist, rulesSQL smartPlaylistCriteria, userID string) SelectBuilder { + orderBy := rulesSQL.OrderBy() + sq := Select("row_number() over (order by "+orderBy+") as id", "'"+pls.ID+"' as playlist_id", "media_file.id as media_file_id"). + From("media_file") + sq = r.addMediaFileAnnotationJoin(sq, userID) + + requiredJoins := rulesSQL.RequiredJoins() + sq = r.addSmartPlaylistAnnotationJoins(sq, requiredJoins, userID) + sq = r.applyLibraryFilter(sq, "media_file") + return sq +} + +// addMediaFileAnnotationJoin adds a left join to the annotation table for media files, filtering by user ID to include +// user-specific annotations in the smart playlist criteria evaluation. +func (r *playlistRepository) addMediaFileAnnotationJoin(sq SelectBuilder, userID string) SelectBuilder { + return sq.LeftJoin("annotation on ("+ + "annotation.item_id = media_file.id"+ + " AND annotation.item_type = 'media_file'"+ + " AND annotation.user_id = ?)", userID) +} + +// addSmartPlaylistAnnotationJoins adds left joins to the annotation table for albums and artists as needed based on +// the smart playlist criteria, filtering by user ID to include user-specific annotations in the evaluation. +func (r *playlistRepository) addSmartPlaylistAnnotationJoins(sq SelectBuilder, joins smartPlaylistJoinType, userID string) SelectBuilder { + if joins.has(smartPlaylistJoinAlbumAnnotation) { + sq = sq.LeftJoin("annotation AS album_annotation ON ("+ + "album_annotation.item_id = media_file.album_id"+ + " AND album_annotation.item_type = 'album'"+ + " AND album_annotation.user_id = ?)", userID) + } + if joins.has(smartPlaylistJoinArtistAnnotation) { + sq = sq.LeftJoin("annotation AS artist_annotation ON ("+ + "artist_annotation.item_id = media_file.artist_id"+ + " AND artist_annotation.item_type = 'artist'"+ + " AND artist_annotation.user_id = ?)", userID) + } + return sq +} + +// addCriteria applies the where conditions, limit, offset, and order by clauses to the SQL query based on the +// smart playlist criteria. +func (r *playlistRepository) addCriteria(sql SelectBuilder, cSQL smartPlaylistCriteria) (SelectBuilder, error) { + cond, err := cSQL.Where() + if err != nil { + return sql, err + } + sql = sql.Where(cond) + if cSQL.Criteria.Limit > 0 { + sql = sql.Limit(uint64(cSQL.Criteria.Limit)).Offset(uint64(cSQL.Criteria.Offset)) + } + if order := cSQL.OrderBy(); order != "" { + sql = sql.OrderBy(order) + } + return sql, nil +} diff --git a/persistence/smart_playlist_repository_test.go b/persistence/smart_playlist_repository_test.go new file mode 100644 index 000000000..7bc705385 --- /dev/null +++ b/persistence/smart_playlist_repository_test.go @@ -0,0 +1,596 @@ +package persistence + +import ( + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +var _ = Describe("PlaylistRepository - Smart Playlists", func() { + var repo model.PlaylistRepository + + BeforeEach(func() { + ctx := log.NewContext(GinkgoT().Context()) + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) + repo = NewPlaylistRepository(ctx, GetDBXBuilder()) + }) + + Context("Smart Playlists", func() { + var rules *criteria.Criteria + BeforeEach(func() { + rules = &criteria.Criteria{ + Expression: criteria.All{ + criteria.Contains{"title": "love"}, + }, + } + }) + Context("valid rules", func() { + Specify("Put/Get", func() { + newPls := model.Playlist{Name: "Great!", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(newPls.ID) }) + + savedPls, err := repo.Get(newPls.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(savedPls.Rules).To(Equal(rules)) + }) + }) + + Context("invalid rules", func() { + It("fails to Put it in the DB", func() { + rules = &criteria.Criteria{ + // This is invalid because "contains" cannot have multiple fields + Expression: criteria.All{ + criteria.Contains{"genre": "Hardcore", "filetype": "mp3"}, + }, + } + newPls := model.Playlist{Name: "Great!", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(MatchError(ContainSubstring("invalid criteria expression"))) + }) + }) + + Context("child smart playlists", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + + When("refresh delay has expired", func() { + It("should refresh tracks for smart playlist referenced in parent smart playlist criteria", func() { + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + + childRules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Contains{"title": "Day"}, + }, + } + nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Public: true, Rules: childRules} + Expect(repo.Put(&nestedPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(nestedPls.ID) }) + + parentPls := model.Playlist{Name: "Parent", OwnerID: "userid", Rules: &criteria.Criteria{ + Expression: criteria.All{ + criteria.InPlaylist{"id": nestedPls.ID}, + }, + }} + Expect(repo.Put(&parentPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(parentPls.ID) }) + + // Nested playlist has not been evaluated yet + nestedPlsRead, err := repo.Get(nestedPls.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(nestedPlsRead.EvaluatedAt).To(BeNil()) + + // Getting parent with refresh should recursively refresh the nested playlist + pls, err := repo.GetWithTracks(parentPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + Expect(pls.EvaluatedAt).ToNot(BeNil()) + Expect(*pls.EvaluatedAt).To(BeTemporally("~", time.Now(), 2*time.Second)) + + // Parent should have tracks from the nested playlist + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].MediaFileID).To(Equal(songDayInALife.ID)) + + // Nested playlist should now have been refreshed (EvaluatedAt set) + nestedPlsAfterParentGet, err := repo.Get(nestedPls.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(nestedPlsAfterParentGet.EvaluatedAt).ToNot(BeNil()) + Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(BeTemporally("~", time.Now(), 2*time.Second)) + }) + }) + + When("refresh delay has not expired", func() { + It("should NOT refresh tracks for smart playlist referenced in parent smart playlist criteria", func() { + conf.Server.SmartPlaylistRefreshDelay = 1 * time.Hour + childEvaluatedAt := time.Now().Add(-30 * time.Minute) + + childRules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Contains{"title": "Day"}, + }, + } + nestedPls := model.Playlist{Name: "Nested", OwnerID: "userid", Public: true, Rules: childRules, EvaluatedAt: &childEvaluatedAt} + Expect(repo.Put(&nestedPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(nestedPls.ID) }) + + // Parent has no EvaluatedAt, so it WILL refresh, but the child should not + parentPls := model.Playlist{Name: "Parent", OwnerID: "userid", Rules: &criteria.Criteria{ + Expression: criteria.All{ + criteria.InPlaylist{"id": nestedPls.ID}, + }, + }} + Expect(repo.Put(&parentPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(parentPls.ID) }) + + nestedPlsRead, err := repo.Get(nestedPls.ID) + Expect(err).ToNot(HaveOccurred()) + + // Getting parent with refresh should NOT recursively refresh the nested playlist + parent, err := repo.GetWithTracks(parentPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + // Parent should have been refreshed (its EvaluatedAt was nil) + Expect(parent.EvaluatedAt).ToNot(BeNil()) + Expect(*parent.EvaluatedAt).To(BeTemporally("~", time.Now(), 2*time.Second)) + + // Nested playlist should NOT have been refreshed (still within delay window) + nestedPlsAfterParentGet, err := repo.Get(nestedPls.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(BeTemporally("~", childEvaluatedAt, time.Second)) + Expect(*nestedPlsAfterParentGet.EvaluatedAt).To(Equal(*nestedPlsRead.EvaluatedAt)) + }) + }) + }) + }) + + Describe("Playlist Track Sorting", func() { + var testPlaylistID string + + AfterEach(func() { + if testPlaylistID != "" { + Expect(repo.Delete(testPlaylistID)).To(BeNil()) + testPlaylistID = "" + } + }) + + It("sorts tracks correctly by album (disc and track number)", func() { + By("creating a playlist with multi-disc album tracks in arbitrary order") + newPls := model.Playlist{Name: "Multi-Disc Test", OwnerID: "userid"} + // Add tracks in intentionally scrambled order + newPls.AddMediaFilesByID([]string{"2001", "2002", "2003", "2004"}) + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("retrieving tracks sorted by album") + tracksRepo := repo.Tracks(newPls.ID, false) + tracks, err := tracksRepo.GetAll(model.QueryOptions{Sort: "album", Order: "asc"}) + Expect(err).ToNot(HaveOccurred()) + + By("verifying tracks are sorted by disc number then track number") + Expect(tracks).To(HaveLen(4)) + // Expected order: Disc 1 Track 1, Disc 1 Track 2, Disc 2 Track 1, Disc 2 Track 11 + Expect(tracks[0].MediaFileID).To(Equal("2002")) // Disc 1, Track 1 + Expect(tracks[1].MediaFileID).To(Equal("2004")) // Disc 1, Track 2 + Expect(tracks[2].MediaFileID).To(Equal("2003")) // Disc 2, Track 1 + Expect(tracks[3].MediaFileID).To(Equal("2001")) // Disc 2, Track 11 + }) + }) + + Describe("Smart Playlists with Album/Artist Annotation Criteria", func() { + var testPlaylistID string + + AfterEach(func() { + if testPlaylistID != "" { + _ = repo.Delete(testPlaylistID) + testPlaylistID = "" + } + }) + + It("matches tracks from starred albums using albumLoved", func() { + // albumRadioactivity (ID "103") is starred in test fixtures + // Songs in album 103: 1003, 1004, 1005, 1006 + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Is{"albumLoved": true}, + }, + } + newPls := model.Playlist{Name: "Starred Album Songs", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + trackIDs := make([]string, len(pls.Tracks)) + for i, t := range pls.Tracks { + trackIDs[i] = t.MediaFileID + } + Expect(trackIDs).To(ConsistOf("1003", "1004", "1005", "1006")) + }) + + It("matches tracks from starred artists using artistLoved", func() { + // artistBeatles (ID "3") is starred in test fixtures + // Songs with ArtistID "3": 1001, 1002, 3002 + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Is{"artistLoved": true}, + }, + } + newPls := model.Playlist{Name: "Starred Artist Songs", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + trackIDs := make([]string, len(pls.Tracks)) + for i, t := range pls.Tracks { + trackIDs[i] = t.MediaFileID + } + Expect(trackIDs).To(ConsistOf("1001", "1002", "3002")) + }) + + It("matches tracks with combined album and artist criteria", func() { + // albumLoved=true → songs from album 103 (1003, 1004, 1005, 1006) + // artistLoved=true → songs with artist 3 (1001, 1002) + // Using Any: union of both sets + rules := &criteria.Criteria{ + Expression: criteria.Any{ + criteria.Is{"albumLoved": true}, + criteria.Is{"artistLoved": true}, + }, + } + newPls := model.Playlist{Name: "Combined Album+Artist", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + trackIDs := make([]string, len(pls.Tracks)) + for i, t := range pls.Tracks { + trackIDs[i] = t.MediaFileID + } + Expect(trackIDs).To(ConsistOf("1001", "1002", "1003", "1004", "1005", "1006", "3002")) + }) + + It("returns no tracks when no albums/artists match", func() { + // No album has rating 5 in fixtures + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Is{"albumRating": 5}, + }, + } + newPls := model.Playlist{Name: "No Match", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + Expect(pls.Tracks).To(BeEmpty()) + }) + + It("matches loved tracks when loved value is a string in nested group (issue #4826)", func() { + // songComeTogether (ID "1002") is starred in test fixtures + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Any{ + criteria.Is{"loved": "true"}, + }, + }, + } + newPls := model.Playlist{Name: "String Loved Nested", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + trackIDs := make([]string, len(pls.Tracks)) + for i, t := range pls.Tracks { + trackIDs[i] = t.MediaFileID + } + Expect(trackIDs).To(ContainElement("1002")) + Expect(len(pls.Tracks)).To(BeNumerically(">=", 1)) + }) + + It("returns same results for string and bool loved values (issue #4826)", func() { + boolRules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Any{ + criteria.Is{"loved": true}, + }, + }, + } + boolPls := model.Playlist{Name: "Bool Loved", OwnerID: "userid", Rules: boolRules} + Expect(repo.Put(&boolPls)).To(Succeed()) + DeferCleanup(func() { _ = repo.Delete(boolPls.ID) }) + + stringRules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Any{ + criteria.Is{"loved": "true"}, + }, + }, + } + stringPls := model.Playlist{Name: "String Loved", OwnerID: "userid", Rules: stringRules} + Expect(repo.Put(&stringPls)).To(Succeed()) + testPlaylistID = stringPls.ID + + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + boolResult, err := repo.GetWithTracks(boolPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + stringResult, err := repo.GetWithTracks(stringPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + boolIDs := make([]string, len(boolResult.Tracks)) + for i, t := range boolResult.Tracks { + boolIDs[i] = t.MediaFileID + } + stringIDs := make([]string, len(stringResult.Tracks)) + for i, t := range stringResult.Tracks { + stringIDs[i] = t.MediaFileID + } + Expect(stringIDs).To(ConsistOf(boolIDs)) + }) + }) + + Describe("Smart Playlists with Tag Criteria", func() { + var mfRepo model.MediaFileRepository + var testPlaylistID string + var songWithGrouping, songWithoutGrouping model.MediaFile + + BeforeEach(func() { + ctx := log.NewContext(GinkgoT().Context()) + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) + mfRepo = NewMediaFileRepository(ctx, GetDBXBuilder()) + + // Register 'grouping' as a valid tag for smart playlists + criteria.AddTagNames([]string{"grouping"}) + + // Create a song with the grouping tag + songWithGrouping = model.MediaFile{ + ID: "test-grouping-1", + Title: "Song With Grouping", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: "test/grouping/song1.mp3", + Tags: model.Tags{ + "grouping": []string{"My Crate"}, + }, + Participants: model.Participants{}, + LibraryID: 1, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songWithGrouping)).To(Succeed()) + + // Create a song without the grouping tag + songWithoutGrouping = model.MediaFile{ + ID: "test-grouping-2", + Title: "Song Without Grouping", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: "test/grouping/song2.mp3", + Tags: model.Tags{}, + Participants: model.Participants{}, + LibraryID: 1, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songWithoutGrouping)).To(Succeed()) + }) + + AfterEach(func() { + if testPlaylistID != "" { + _ = repo.Delete(testPlaylistID) + testPlaylistID = "" + } + // Clean up test media files + _, _ = GetDBXBuilder().Delete("media_file", dbx.HashExp{"id": "test-grouping-1"}).Execute() + _, _ = GetDBXBuilder().Delete("media_file", dbx.HashExp{"id": "test-grouping-2"}).Execute() + }) + + It("matches tracks with a tag value using 'contains' with empty string (issue #4728 workaround)", func() { + By("creating a smart playlist that checks if grouping tag has any value") + // This is the workaround for issue #4728: using 'contains' with empty string + // generates SQL: value LIKE '%%' which matches any non-empty string + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Contains{"grouping": ""}, + }, + } + newPls := model.Playlist{Name: "Tracks with Grouping", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("refreshing the smart playlist") + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second // Force refresh + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + By("verifying only the track with grouping tag is matched") + Expect(pls.Tracks).To(HaveLen(1)) + Expect(pls.Tracks[0].MediaFileID).To(Equal(songWithGrouping.ID)) + }) + + It("excludes tracks with a tag value using 'notContains' with empty string", func() { + By("creating a smart playlist that checks if grouping tag is NOT set") + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.NotContains{"grouping": ""}, + }, + } + newPls := model.Playlist{Name: "Tracks without Grouping", OwnerID: "userid", Rules: rules} + Expect(repo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("refreshing the smart playlist") + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second // Force refresh + pls, err := repo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + By("verifying the track with grouping is NOT in the playlist") + for _, track := range pls.Tracks { + Expect(track.MediaFileID).ToNot(Equal(songWithGrouping.ID)) + } + + By("verifying the track without grouping IS in the playlist") + var foundWithoutGrouping bool + for _, track := range pls.Tracks { + if track.MediaFileID == songWithoutGrouping.ID { + foundWithoutGrouping = true + break + } + } + Expect(foundWithoutGrouping).To(BeTrue()) + }) + }) + + Describe("Smart Playlists Library Filtering", func() { + var mfRepo model.MediaFileRepository + var testPlaylistID string + var lib2ID int + var restrictedUserID string + var uniqueLibPath string + + BeforeEach(func() { + db := GetDBXBuilder() + + // Generate unique IDs for this test run + uniqueSuffix := time.Now().Format("20060102150405.000") + restrictedUserID = "restricted-user-" + uniqueSuffix + uniqueLibPath = "/music/lib2-" + uniqueSuffix + + // Create a second library with unique name and path to avoid conflicts with other tests + _, err := db.DB().Exec("INSERT INTO library (name, path, created_at, updated_at) VALUES (?, ?, datetime('now'), datetime('now'))", "Library 2-"+uniqueSuffix, uniqueLibPath) + Expect(err).ToNot(HaveOccurred()) + err = db.DB().QueryRow("SELECT last_insert_rowid()").Scan(&lib2ID) + Expect(err).ToNot(HaveOccurred()) + + // Create a restricted user with access only to library 1 + _, err = db.DB().Exec("INSERT INTO user (id, user_name, name, is_admin, password, created_at, updated_at) VALUES (?, ?, 'Restricted User', false, 'pass', datetime('now'), datetime('now'))", restrictedUserID, restrictedUserID) + Expect(err).ToNot(HaveOccurred()) + _, err = db.DB().Exec("INSERT INTO user_library (user_id, library_id) VALUES (?, 1)", restrictedUserID) + Expect(err).ToNot(HaveOccurred()) + + // Create test media files in each library + ctx := log.NewContext(GinkgoT().Context()) + ctx = request.WithUser(ctx, model.User{ID: "userid", UserName: "userid", IsAdmin: true}) + mfRepo = NewMediaFileRepository(ctx, db) + + // Song in library 1 (accessible by restricted user) + songLib1 := model.MediaFile{ + ID: "lib1-song", + Title: "Song in Lib1", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: "lib1/song.mp3", + LibraryID: 1, + Participants: model.Participants{}, + Tags: model.Tags{}, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songLib1)).To(Succeed()) + + // Song in library 2 (NOT accessible by restricted user) + songLib2 := model.MediaFile{ + ID: "lib2-song", + Title: "Song in Lib2", + Artist: "Test Artist", + ArtistID: "1", + Album: "Test Album", + AlbumID: "101", + Path: "lib2/song.mp3", + LibraryID: lib2ID, + Participants: model.Participants{}, + Tags: model.Tags{}, + Lyrics: "[]", + } + Expect(mfRepo.Put(&songLib2)).To(Succeed()) + }) + + AfterEach(func() { + db := GetDBXBuilder() + if testPlaylistID != "" { + _ = repo.Delete(testPlaylistID) + testPlaylistID = "" + } + // Clean up test data + _, _ = db.Delete("media_file", dbx.HashExp{"id": "lib1-song"}).Execute() + _, _ = db.Delete("media_file", dbx.HashExp{"id": "lib2-song"}).Execute() + _, _ = db.Delete("user_library", dbx.HashExp{"user_id": restrictedUserID}).Execute() + _, _ = db.Delete("user", dbx.HashExp{"id": restrictedUserID}).Execute() + _, _ = db.DB().Exec("DELETE FROM library WHERE id = ?", lib2ID) + }) + + It("should only include tracks from libraries the user has access to (issue #4738)", func() { + db := GetDBXBuilder() + ctx := log.NewContext(GinkgoT().Context()) + + // Create the smart playlist as the restricted user + restrictedUser := model.User{ID: restrictedUserID, UserName: restrictedUserID, IsAdmin: false} + ctx = request.WithUser(ctx, restrictedUser) + restrictedRepo := NewPlaylistRepository(ctx, db) + + // Create a smart playlist that matches all songs + rules := &criteria.Criteria{ + Expression: criteria.All{ + criteria.Gt{"playCount": -1}, // Matches everything + }, + } + newPls := model.Playlist{Name: "All Songs", OwnerID: restrictedUserID, Rules: rules} + Expect(restrictedRepo.Put(&newPls)).To(Succeed()) + testPlaylistID = newPls.ID + + By("refreshing the smart playlist") + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second // Force refresh + pls, err := restrictedRepo.GetWithTracks(newPls.ID, true, false) + Expect(err).ToNot(HaveOccurred()) + + By("verifying only the track from library 1 is in the playlist") + var foundLib1Song, foundLib2Song bool + for _, track := range pls.Tracks { + if track.MediaFileID == "lib1-song" { + foundLib1Song = true + } + if track.MediaFileID == "lib2-song" { + foundLib2Song = true + } + } + Expect(foundLib1Song).To(BeTrue(), "Song from library 1 should be in the playlist") + Expect(foundLib2Song).To(BeFalse(), "Song from library 2 should NOT be in the playlist") + + By("verifying playlist_tracks table only contains the accessible track") + var playlistTracksCount int + err = db.DB().QueryRow("SELECT count(*) FROM playlist_tracks WHERE playlist_id = ?", newPls.ID).Scan(&playlistTracksCount) + Expect(err).ToNot(HaveOccurred()) + // Count should only include tracks visible to the user (lib1-song) + // The count may include other test songs from library 1, but NOT lib2-song + var lib2TrackCount int + err = db.DB().QueryRow("SELECT count(*) FROM playlist_tracks WHERE playlist_id = ? AND media_file_id = 'lib2-song'", newPls.ID).Scan(&lib2TrackCount) + Expect(err).ToNot(HaveOccurred()) + Expect(lib2TrackCount).To(Equal(0), "lib2-song should not be in playlist_tracks") + + By("verifying SongCount matches visible tracks") + Expect(pls.SongCount).To(Equal(len(pls.Tracks)), "SongCount should match the number of visible tracks") + }) + }) +}) diff --git a/persistence/sql_annotations.go b/persistence/sql_annotations.go index daf621ffe..07bd96975 100644 --- a/persistence/sql_annotations.go +++ b/persistence/sql_annotations.go @@ -4,6 +4,7 @@ import ( "database/sql" "errors" "fmt" + "strings" "time" . "github.com/Masterminds/squirrel" @@ -15,20 +16,20 @@ import ( const annotationTable = "annotation" func (r sqlRepository) withAnnotation(query SelectBuilder, idField string) SelectBuilder { - if userId(r.ctx) == invalidUserId { - return query + userID := loggedUser(r.ctx).ID + if userID == invalidUserId { + return query.Columns(fmt.Sprintf("%s.average_rating", r.tableName)) } query = query. LeftJoin("annotation on ("+ "annotation.item_id = "+idField+ - // item_ids are unique across different item_types, so the clause below is not needed - //" AND annotation.item_type = '"+r.tableName+"'"+ - " AND annotation.user_id = '"+userId(r.ctx)+"')"). + " AND annotation.user_id = '"+userID+"')"). Columns( "coalesce(starred, 0) as starred", "coalesce(rating, 0) as rating", "starred_at", "play_date", + "rated_at", ) if conf.Server.AlbumPlayCountMode == consts.AlbumPlayCountModeNormalized && r.tableName == "album" { query = query.Columns( @@ -38,26 +39,43 @@ func (r sqlRepository) withAnnotation(query SelectBuilder, idField string) Selec query = query.Columns("coalesce(play_count, 0) as play_count") } + query = query.Columns(fmt.Sprintf("%s.average_rating", r.tableName)) + return query } +func annotationBoolFilter(field string) func(string, any) Sqlizer { + return func(_ string, value any) Sqlizer { + v, ok := value.(string) + if !ok { + return nil + } + if strings.ToLower(v) == "true" { + return Expr(fmt.Sprintf("COALESCE(%s, 0) > 0", field)) + } + return Expr(fmt.Sprintf("COALESCE(%s, 0) = 0", field)) + } +} + func (r sqlRepository) annId(itemID ...string) And { + userID := loggedUser(r.ctx).ID return And{ - Eq{annotationTable + ".user_id": userId(r.ctx)}, + Eq{annotationTable + ".user_id": userID}, Eq{annotationTable + ".item_type": r.tableName}, Eq{annotationTable + ".item_id": itemID}, } } -func (r sqlRepository) annUpsert(values map[string]interface{}, itemIDs ...string) error { +func (r sqlRepository) annUpsert(values map[string]any, itemIDs ...string) error { upd := Update(annotationTable).Where(r.annId(itemIDs...)) for f, v := range values { upd = upd.Set(f, v) } c, err := r.executeSQL(upd) if c == 0 || errors.Is(err, sql.ErrNoRows) { + userID := loggedUser(r.ctx).ID for _, itemID := range itemIDs { - values["user_id"] = userId(r.ctx) + values["user_id"] = userID values["item_type"] = r.tableName values["item_id"] = itemID ins := Insert(annotationTable).SetMap(values) @@ -72,11 +90,27 @@ func (r sqlRepository) annUpsert(values map[string]interface{}, itemIDs ...strin func (r sqlRepository) SetStar(starred bool, ids ...string) error { starredAt := time.Now() - return r.annUpsert(map[string]interface{}{"starred": starred, "starred_at": starredAt}, ids...) + return r.annUpsert(map[string]any{"starred": starred, "starred_at": starredAt}, ids...) } func (r sqlRepository) SetRating(rating int, itemID string) error { - return r.annUpsert(map[string]interface{}{"rating": rating}, itemID) + ratedAt := time.Now() + err := r.annUpsert(map[string]any{"rating": rating, "rated_at": ratedAt}, itemID) + if err != nil { + return err + } + return r.updateAvgRating(itemID) +} + +func (r sqlRepository) updateAvgRating(itemID string) error { + upd := Update(r.tableName). + Where(Eq{"id": itemID}). + Set("average_rating", Expr( + "coalesce((select round(avg(rating), 2) from annotation where item_id = ? and item_type = ? and rating > 0), 0)", + itemID, r.tableName, + )) + _, err := r.executeSQL(upd) + return err } func (r sqlRepository) IncPlayCount(itemID string, ts time.Time) error { @@ -86,8 +120,9 @@ func (r sqlRepository) IncPlayCount(itemID string, ts time.Time) error { c, err := r.executeSQL(upd) if c == 0 || errors.Is(err, sql.ErrNoRows) { - values := map[string]interface{}{} - values["user_id"] = userId(r.ctx) + userID := loggedUser(r.ctx).ID + values := map[string]any{} + values["user_id"] = userID values["item_type"] = r.tableName values["item_id"] = itemID values["play_count"] = 1 @@ -117,7 +152,7 @@ func (r sqlRepository) cleanAnnotations() error { del := Delete(annotationTable).Where(Eq{"item_type": r.tableName}).Where("item_id not in (select id from " + r.tableName + ")") c, err := r.executeSQL(del) if err != nil { - return fmt.Errorf("error cleaning up annotations: %w", err) + return fmt.Errorf("error cleaning up %s annotations: %w", r.tableName, err) } if c > 0 { log.Debug(r.ctx, "Clean-up annotations", "table", r.tableName, "totalDeleted", c) diff --git a/persistence/sql_annotations_test.go b/persistence/sql_annotations_test.go new file mode 100644 index 000000000..15efc5dc7 --- /dev/null +++ b/persistence/sql_annotations_test.go @@ -0,0 +1,153 @@ +package persistence + +import ( + "context" + + "github.com/Masterminds/squirrel" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Annotation Filters", func() { + var ( + albumRepo *albumRepository + albumWithoutAnnotation model.Album + ) + + BeforeEach(func() { + ctx := request.WithUser(context.Background(), model.User{ID: "userid", UserName: "johndoe"}) + albumRepo = NewAlbumRepository(ctx, GetDBXBuilder()).(*albumRepository) + + // Create album without any annotation (no star, no rating) + albumWithoutAnnotation = model.Album{ID: "no-annotation-album", Name: "No Annotation", LibraryID: 1} + Expect(albumRepo.Put(&albumWithoutAnnotation)).To(Succeed()) + }) + + AfterEach(func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": albumWithoutAnnotation.ID})) + }) + + Describe("annotationBoolFilter", func() { + DescribeTable("creates correct SQL expressions", + func(field, value string, expectedSQL string, expectedArgs []any) { + sqlizer := annotationBoolFilter(field)(field, value) + sql, args, err := sqlizer.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(Equal(expectedSQL)) + Expect(args).To(Equal(expectedArgs)) + }, + Entry("starred=true", "starred", "true", "COALESCE(starred, 0) > 0", []any(nil)), + Entry("starred=false", "starred", "false", "COALESCE(starred, 0) = 0", []any(nil)), + Entry("starred=True (case insensitive)", "starred", "True", "COALESCE(starred, 0) > 0", []any(nil)), + Entry("rating=true", "rating", "true", "COALESCE(rating, 0) > 0", []any(nil)), + ) + + It("returns nil if value is not a string", func() { + sqlizer := annotationBoolFilter("starred")("starred", 123) + Expect(sqlizer).To(BeNil()) + }) + }) + + Describe("starredFilter", func() { + It("false includes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("starred")("starred", "false"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included in starred=false filter") + }) + + It("true excludes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("starred")("starred", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + }) + + Describe("hasRatingFilter", func() { + It("false includes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "false"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included in has_rating=false filter") + }) + + It("true excludes items without annotations", func() { + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + for _, a := range albums { + Expect(a.ID).ToNot(Equal(albumWithoutAnnotation.ID)) + } + }) + + It("true includes items with rating > 0", func() { + // Create album with rating 1 + ratedAlbum := model.Album{ID: "rated-album", Name: "Rated Album", LibraryID: 1} + Expect(albumRepo.Put(&ratedAlbum)).To(Succeed()) + Expect(albumRepo.SetRating(1, ratedAlbum.ID)).To(Succeed()) + defer func() { + _, _ = albumRepo.executeSQL(squirrel.Delete("annotation").Where(squirrel.Eq{"item_id": ratedAlbum.ID})) + _, _ = albumRepo.executeSQL(squirrel.Delete("album").Where(squirrel.Eq{"id": ratedAlbum.ID})) + }() + + albums, err := albumRepo.GetAll(model.QueryOptions{ + Filters: annotationBoolFilter("rating")("rating", "true"), + }) + Expect(err).ToNot(HaveOccurred()) + + var found bool + for _, a := range albums { + if a.ID == ratedAlbum.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Album with rating 5 should be included in has_rating=true filter") + }) + }) + + It("ignores invalid filter values (not strings)", func() { + res, err := albumRepo.ReadAll(rest.QueryOptions{ + Filters: map[string]any{"starred": 123}, + }) + Expect(err).ToNot(HaveOccurred()) + albums := res.(model.Albums) + + var found bool + for _, a := range albums { + if a.ID == albumWithoutAnnotation.ID { + found = true + break + } + } + Expect(found).To(BeTrue(), "Item without annotation should be included when filter is ignored") + }) +}) diff --git a/persistence/sql_base_repository.go b/persistence/sql_base_repository.go index 7cc24b6c4..321e790db 100644 --- a/persistence/sql_base_repository.go +++ b/persistence/sql_base_repository.go @@ -13,6 +13,7 @@ import ( "time" . "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" @@ -49,25 +50,39 @@ type sqlRepository struct { const invalidUserId = "-1" -func userId(ctx context.Context) string { - if user, ok := request.UserFrom(ctx); !ok { - return invalidUserId - } else { - return user.ID - } -} - func loggedUser(ctx context.Context) *model.User { if user, ok := request.UserFrom(ctx); !ok { - return &model.User{} + return &model.User{ID: invalidUserId} } else { return &user } } -func isAdmin(ctx context.Context) bool { - user := loggedUser(ctx) - return user.IsAdmin +// ownerFilter returns the predicate restricting access to rows owned by the logged-in user, for +// tables with a user_id column. It returns nil for admins and for headless/system contexts (invalid +// user), meaning "no ownership restriction". Callers should skip the WHERE clause when it is nil. +// +// The predicate uses an unqualified user_id, so it only works on queries where that column is +// unambiguous (no join introducing a second user_id). +func (r sqlRepository) ownerFilter() Sqlizer { + if usr := loggedUser(r.ctx); !usr.IsAdmin && usr.ID != invalidUserId { + return Eq{"user_id": usr.ID} + } + return nil +} + +// addRestriction combines an optional caller predicate with the ownership filter, producing the +// WHERE clause for owner-scoped reads. For admins and headless contexts ownerFilter() is nil and +// only the caller's predicate (if any) remains. +func (r sqlRepository) addRestriction(sql ...Sqlizer) Sqlizer { + s := And{} + if len(sql) > 0 { + s = append(s, sql[0]) + } + if owner := r.ownerFilter(); owner != nil { + s = append(s, owner) + } + return s } func (r *sqlRepository) registerModel(instance any, filters map[string]filterFunc) { @@ -86,6 +101,10 @@ func (r *sqlRepository) registerModel(instance any, filters map[string]filterFun // which gives precedence to sort tags. // Ex: order_title => (coalesce(nullif(sort_title,”),order_title) collate nocase) // To avoid performance issues, indexes should be created for these sort expressions +// +// NOTE: if an individual item has spaces, it should be wrapped in parentheses. For example, +// you should write "(lyrics != '[]')". This prevents the item being split unexpectedly. +// Without parentheses, "lyrics != '[]'" would be mapped as simply "lyrics" func (r *sqlRepository) setSortMappings(mappings map[string]string, tableName ...string) { tn := r.tableName if len(tableName) > 0 { @@ -195,10 +214,36 @@ func (r sqlRepository) applyFilters(sq SelectBuilder, options ...model.QueryOpti return sq } +// libraryIdFilter is a filter function to be added to resources that have a library_id column. +func libraryIdFilter(_ string, value any) Sqlizer { + return Eq{"library_id": value} +} + +// applyLibraryFilter adds library filtering to queries for tables that have a library_id column +// This ensures users only see content from libraries they have access to +func (r sqlRepository) applyLibraryFilter(sq SelectBuilder, tableName ...string) SelectBuilder { + user := loggedUser(r.ctx) + + // If the user is an admin, or the user ID is invalid (e.g., when no user is logged in), skip the library filter + if user.IsAdmin || user.ID == invalidUserId { + return sq + } + + table := r.tableName + if len(tableName) > 0 { + table = tableName[0] + } + + // Get user's accessible library IDs + // Use subquery to filter by user's library access + return sq.Where(Expr(table+".library_id IN ("+ + "SELECT ul.library_id FROM user_library ul WHERE ul.user_id = ?)", user.ID)) +} + func (r sqlRepository) seedKey() string { // Seed keys must be all lowercase, or else SQLite3 will encode it, making it not match the seed // used in the query. Hashing the user ID and converting it to a hex string will do the trick - userIDHash := md5.Sum([]byte(userId(r.ctx))) + userIDHash := md5.Sum([]byte(loggedUser(r.ctx).ID)) return fmt.Sprintf("%s|%x", r.tableName, userIDHash) } @@ -255,7 +300,7 @@ func (r sqlRepository) toSQL(sq Sqlizer) (string, dbx.Params, error) { return result, params, nil } -func (r sqlRepository) queryOne(sq Sqlizer, response interface{}) error { +func (r sqlRepository) queryOne(sq Sqlizer, response any) error { query, args, err := r.toSQL(sq) if err != nil { return err @@ -302,7 +347,7 @@ func queryWithStableResults[T any](r sqlRepository, sq SelectBuilder, options .. }, nil } -func (r sqlRepository) queryAll(sq SelectBuilder, response interface{}, options ...model.QueryOptions) error { +func (r sqlRepository) queryAll(sq SelectBuilder, response any, options ...model.QueryOptions) error { if len(options) > 0 && options[0].Offset > 0 { sq = r.optimizePagination(sq, options[0]) } @@ -321,7 +366,7 @@ func (r sqlRepository) queryAll(sq SelectBuilder, response interface{}, options } // queryAllSlice is a helper function to query a single column and return the result in a slice -func (r sqlRepository) queryAllSlice(sq SelectBuilder, response interface{}) error { +func (r sqlRepository) queryAllSlice(sq SelectBuilder, response any) error { query, args, err := r.toSQL(sq) if err != nil { return err @@ -356,6 +401,65 @@ func (r sqlRepository) exists(cond Sqlizer) (bool, error) { return res.Exist > 0, err } +// updateOwned performs an atomic, ownership-restricted update of the row identified by id, for +// repositories whose table has a user_id column. Non-admins can only update rows they own: the +// ownership predicate is part of the UPDATE's WHERE clause, so a row owned by another user simply +// does not match and no write happens. Ownership itself is immutable here: user_id is never written, +// so no caller (admin included) can reassign a row to a different owner via an update. Unlike put, +// it never falls through to an INSERT, so a non-matching id never creates a row. +// +// When the update matches no row it classifies the failure: if the row exists but is owned by +// another user it returns rest.ErrPermissionDenied, otherwise rest.ErrNotFound. The write itself is +// still atomic; the extra lookup happens only on the failure path (count == 0), where no write +// occurred, so there is no TOCTOU on the update. +func (r sqlRepository) updateOwned(id string, m any, colsToUpdate ...string) error { + values, err := toSQLArgs(m) + if err != nil { + return fmt.Errorf("error preparing values to write to DB: %w", err) + } + updateValues := filterUpdateValues(values, id, colsToUpdate...) + delete(updateValues, "user_id") // ownership is immutable on update + update := Update(r.tableName).Where(r.addRestriction(Eq{"id": id})).SetMap(updateValues) + count, err := r.executeSQL(update) + if err != nil { + return err + } + if count == 0 { + return r.classifyOwnedWriteMiss(id) + } + return nil +} + +// deleteOwned performs an atomic, ownership-restricted delete of the row identified by id, for +// repositories whose table has a user_id column. Non-admins can only delete rows they own: the +// ownership predicate is part of the DELETE's WHERE clause, so a row owned by another user simply +// does not match and is left untouched. The failure path mirrors updateOwned (see +// classifyOwnedWriteMiss), so there is no TOCTOU on the delete. +func (r sqlRepository) deleteOwned(id string) error { + count, err := r.executeSQL(Delete(r.tableName).Where(r.addRestriction(Eq{"id": id}))) + if err != nil { + return err + } + if count == 0 { + return r.classifyOwnedWriteMiss(id) + } + return nil +} + +// classifyOwnedWriteMiss explains why an ownership-filtered write (updateOwned/deleteOwned) matched +// no row: rest.ErrPermissionDenied if the row exists but is owned by another user, otherwise +// rest.ErrNotFound. It runs only on the failure path (count == 0), where no write occurred. +func (r sqlRepository) classifyOwnedWriteMiss(id string) error { + exists, err := r.exists(Eq{"id": id}) + if err != nil { + return err + } + if exists { + return rest.ErrPermissionDenied + } + return rest.ErrNotFound +} + func (r sqlRepository) count(countQuery SelectBuilder, options ...model.QueryOptions) (int64, error) { countQuery = countQuery. RemoveColumns().Columns("count(distinct " + r.tableName + ".id) as count"). @@ -368,7 +472,7 @@ func (r sqlRepository) count(countQuery SelectBuilder, options ...model.QueryOpt return res.Count, err } -func (r sqlRepository) putByMatch(filter Sqlizer, id string, m interface{}, colsToUpdate ...string) (string, error) { +func (r sqlRepository) putByMatch(filter Sqlizer, id string, m any, colsToUpdate ...string) (string, error) { if id != "" { return r.put(id, m, colsToUpdate...) } @@ -382,31 +486,38 @@ func (r sqlRepository) putByMatch(filter Sqlizer, id string, m interface{}, cols return r.put(res.ID, m, colsToUpdate...) } -func (r sqlRepository) put(id string, m interface{}, colsToUpdate ...string) (newId string, err error) { +// filterUpdateValues selects, from a marshaled column map, the values to write in an UPDATE on the +// row identified by id: only the requested colsToUpdate (or all columns when none are specified), +// dropping columns that must never be overwritten on update (created_at, birth_time). +func filterUpdateValues(values map[string]any, id string, colsToUpdate ...string) map[string]any { + updateValues := map[string]any{} + + // This is a map of the columns that need to be updated, if specified + c2upd := slice.ToMap(colsToUpdate, func(s string) (string, struct{}) { + return toSnakeCase(s), struct{}{} + }) + for k, v := range values { + if _, found := c2upd[k]; len(c2upd) == 0 || found { + updateValues[k] = v + } + } + + updateValues["id"] = id + delete(updateValues, "created_at") + // To avoid updating the media_file birth_time on each scan. Not the best solution, but it works for now + // TODO move to mediafile_repository when each repo has its own upsert method + delete(updateValues, "birth_time") + return updateValues +} + +func (r sqlRepository) put(id string, m any, colsToUpdate ...string) (newId string, err error) { values, err := toSQLArgs(m) if err != nil { return "", fmt.Errorf("error preparing values to write to DB: %w", err) } // If there's an ID, try to update first if id != "" { - updateValues := map[string]interface{}{} - - // This is a map of the columns that need to be updated, if specified - c2upd := slice.ToMap(colsToUpdate, func(s string) (string, struct{}) { - return toSnakeCase(s), struct{}{} - }) - for k, v := range values { - if _, found := c2upd[k]; len(c2upd) == 0 || found { - updateValues[k] = v - } - } - - updateValues["id"] = id - delete(updateValues, "created_at") - // To avoid updating the media_file birth_time on each scan. Not the best solution, but it works for now - // TODO move to mediafile_repository when each repo has its own upsert method - delete(updateValues, "birth_time") - update := Update(r.tableName).Where(Eq{"id": id}).SetMap(updateValues) + update := Update(r.tableName).Where(Eq{"id": id}).SetMap(filterUpdateValues(values, id, colsToUpdate...)) count, err := r.executeSQL(update) if err != nil { return "", err diff --git a/persistence/sql_base_repository_test.go b/persistence/sql_base_repository_test.go index 4b380e298..b46e2066b 100644 --- a/persistence/sql_base_repository_test.go +++ b/persistence/sql_base_repository_test.go @@ -136,6 +136,10 @@ var _ = Describe("sqlRepository", func() { }) Describe("buildSortOrder", func() { + BeforeEach(func() { + r.sortMappings = map[string]string{} + }) + Context("single field", func() { It("sorts by specified field", func() { sql := r.buildSortOrder("name", "desc") @@ -163,6 +167,14 @@ var _ = Describe("sqlRepository", func() { sql := r.buildSortOrder("name desc, age, status asc", "desc") Expect(sql).To(Equal("name asc, age desc, status desc")) }) + It("handles spaces in mapped field", func() { + r.sortMappings = map[string]string{ + "has_lyrics": "(lyrics != '[]'), updated_at", + } + sql := r.buildSortOrder("has_lyrics", "desc") + Expect(sql).To(Equal("(lyrics != '[]') desc, updated_at desc")) + }) + }) Context("function fields", func() { It("handles functions with multiple params", func() { @@ -211,4 +223,62 @@ var _ = Describe("sqlRepository", func() { Expect(hasher.CurrentSeed(id)).To(Equal("seed")) }) }) + + Describe("applyLibraryFilter", func() { + var sq squirrel.SelectBuilder + + BeforeEach(func() { + sq = squirrel.Select("*").From("test_table") + }) + + Context("Admin User", func() { + BeforeEach(func() { + r.ctx = request.WithUser(context.Background(), model.User{ID: "admin", IsAdmin: true}) + }) + + It("should not apply library filter for admin users", func() { + result := r.applyLibraryFilter(sq) + sql, _, _ := result.ToSql() + Expect(sql).To(Equal("SELECT * FROM test_table")) + }) + }) + + Context("Regular User", func() { + BeforeEach(func() { + r.ctx = request.WithUser(context.Background(), model.User{ID: "user123", IsAdmin: false}) + }) + + It("should apply library filter for regular users", func() { + result := r.applyLibraryFilter(sq) + sql, args, _ := result.ToSql() + Expect(sql).To(ContainSubstring("IN (SELECT ul.library_id FROM user_library ul WHERE ul.user_id = ?)")) + Expect(args).To(ContainElement("user123")) + }) + + It("should use custom table name when provided", func() { + result := r.applyLibraryFilter(sq, "custom_table") + sql, args, _ := result.ToSql() + Expect(sql).To(ContainSubstring("custom_table.library_id IN")) + Expect(args).To(ContainElement("user123")) + }) + }) + + Context("Headless Process (No User Context)", func() { + BeforeEach(func() { + r.ctx = context.Background() // No user context + }) + + It("should not apply library filter for headless processes", func() { + result := r.applyLibraryFilter(sq) + sql, _, _ := result.ToSql() + Expect(sql).To(Equal("SELECT * FROM test_table")) + }) + + It("should not apply library filter even with custom table name", func() { + result := r.applyLibraryFilter(sq, "custom_table") + sql, _, _ := result.ToSql() + Expect(sql).To(Equal("SELECT * FROM test_table")) + }) + }) + }) }) diff --git a/persistence/sql_bookmarks.go b/persistence/sql_bookmarks.go index 56645ea21..19f16b231 100644 --- a/persistence/sql_bookmarks.go +++ b/persistence/sql_bookmarks.go @@ -15,21 +15,20 @@ import ( const bookmarkTable = "bookmark" func (r sqlRepository) withBookmark(query SelectBuilder, idField string) SelectBuilder { - if userId(r.ctx) == invalidUserId { + userID := loggedUser(r.ctx).ID + if userID == invalidUserId { return query } return query. LeftJoin("bookmark on (" + "bookmark.item_id = " + idField + - // item_ids are unique across different item_types, so the clause below is not needed - //" AND bookmark.item_type = '" + r.tableName + "'" + - " AND bookmark.user_id = '" + userId(r.ctx) + "')"). + " AND bookmark.user_id = '" + userID + "')"). Columns("coalesce(position, 0) as bookmark_position") } func (r sqlRepository) bmkID(itemID ...string) And { return And{ - Eq{bookmarkTable + ".user_id": userId(r.ctx)}, + Eq{bookmarkTable + ".user_id": loggedUser(r.ctx).ID}, Eq{bookmarkTable + ".item_type": r.tableName}, Eq{bookmarkTable + ".item_id": itemID}, } @@ -38,7 +37,7 @@ func (r sqlRepository) bmkID(itemID ...string) And { func (r sqlRepository) bmkUpsert(itemID, comment string, position int64) error { client, _ := request.ClientFrom(r.ctx) user, _ := request.UserFrom(r.ctx) - values := map[string]interface{}{ + values := map[string]any{ "comment": comment, "position": position, "updated_at": time.Now(), @@ -149,10 +148,10 @@ func (r sqlRepository) cleanBookmarks() error { del := Delete(bookmarkTable).Where(Eq{"item_type": r.tableName}).Where("item_id not in (select id from " + r.tableName + ")") c, err := r.executeSQL(del) if err != nil { - return fmt.Errorf("error cleaning up bookmarks: %w", err) + return fmt.Errorf("error cleaning up %s bookmarks: %w", r.tableName, err) } if c > 0 { - log.Debug(r.ctx, "Clean-up bookmarks", "totalDeleted", c) + log.Debug(r.ctx, "Clean-up bookmarks", "totalDeleted", c, "itemType", r.tableName) } return nil } diff --git a/persistence/sql_participations.go b/persistence/sql_participations.go index 006b7063b..38b0203fa 100644 --- a/persistence/sql_participations.go +++ b/persistence/sql_participations.go @@ -15,6 +15,13 @@ type participant struct { SubRole string `json:"subRole,omitempty"` } +// flatParticipant represents a flattened participant structure for SQL processing +type flatParticipant struct { + ArtistID string `json:"artist_id"` + Role string `json:"role"` + SubRole string `json:"sub_role,omitempty"` +} + func marshalParticipants(participants model.Participants) string { dbParticipants := make(map[model.Role][]participant) for role, artists := range participants { @@ -44,8 +51,10 @@ func unmarshalParticipants(data string) (model.Participants, error) { } func (r sqlRepository) updateParticipants(itemID string, participants model.Participants) error { - ids := participants.AllIDs() - sqd := Delete(r.tableName + "_artists").Where(And{Eq{r.tableName + "_id": itemID}, NotEq{"artist_id": ids}}) + // Delete all existing participant entries for this item. + // This ensures stale role associations are removed when an artist's role changes + // (e.g., an artist was both albumartist and composer, but is now only composer). + sqd := Delete(r.tableName + "_artists").Where(Eq{r.tableName + "_id": itemID}) _, err := r.executeSQL(sqd) if err != nil { return err @@ -53,22 +62,47 @@ func (r sqlRepository) updateParticipants(itemID string, participants model.Part if len(participants) == 0 { return nil } - sqi := Insert(r.tableName+"_artists"). - Columns(r.tableName+"_id", "artist_id", "role", "sub_role"). - Suffix(fmt.Sprintf("on conflict (artist_id, %s_id, role, sub_role) do nothing", r.tableName)) + + var flatParticipants []flatParticipant for role, artists := range participants { for _, artist := range artists { - sqi = sqi.Values(itemID, artist.ID, role.String(), artist.SubRole) + flatParticipants = append(flatParticipants, flatParticipant{ + ArtistID: artist.ID, + Role: role.String(), + SubRole: artist.SubRole, + }) } } - _, err = r.executeSQL(sqi) + + participantsJSON, err := json.Marshal(flatParticipants) + if err != nil { + return fmt.Errorf("marshaling participants: %w", err) + } + + // Build the INSERT query using json_each and INNER JOIN to artist table + // to automatically filter out non-existent artist IDs + query := fmt.Sprintf(` + INSERT INTO %[1]s_artists (%[1]s_id, artist_id, role, sub_role) + SELECT ?, + json_extract(value, '$.artist_id') as artist_id, + json_extract(value, '$.role') as role, + COALESCE(json_extract(value, '$.sub_role'), '') as sub_role + -- Parse the flat JSON array: [{"artist_id": "id", "role": "role", "sub_role": "subRole"}] + FROM json_each(?) -- Iterate through each array element + -- CRITICAL: Only insert records for artists that actually exist in the database + JOIN artist ON artist.id = json_extract(value, '$.artist_id') -- Filter out non-existent artist IDs via INNER JOIN + -- Handle duplicate insertions gracefully (e.g., if called multiple times) + ON CONFLICT (artist_id, %[1]s_id, role, sub_role) DO NOTHING -- Ignore duplicates + `, r.tableName) + + _, err = r.executeSQL(Expr(query, itemID, string(participantsJSON))) return err } func (r *sqlRepository) getParticipants(m *model.MediaFile) (model.Participants, error) { ar := NewArtistRepository(r.ctx, r.db) ids := m.Participants.AllIDs() - artists, err := ar.GetAll(model.QueryOptions{Filters: Eq{"id": ids}}) + artists, err := ar.GetAll(model.QueryOptions{Filters: Eq{"artist.id": ids}}) if err != nil { return nil, fmt.Errorf("getting participants: %w", err) } diff --git a/persistence/sql_restful.go b/persistence/sql_restful.go index 6be368b00..1dcabcec6 100644 --- a/persistence/sql_restful.go +++ b/persistence/sql_restful.go @@ -1,6 +1,7 @@ package persistence import ( + "cmp" "context" "fmt" "reflect" @@ -45,7 +46,7 @@ func (r *sqlRepository) parseRestFilters(ctx context.Context, options rest.Query continue } // Default to a "starts with" filter - filters = append(filters, startsWithFilter(f, v)) + filters = append(filters, Like{f: fmt.Sprintf("%s%%", v)}) } return filters } @@ -90,8 +91,10 @@ func eqFilter(field string, value any) Sqlizer { return Eq{field: value} } -func startsWithFilter(field string, value any) Sqlizer { - return Like{field: fmt.Sprintf("%s%%", value)} +func startsWithFilter(field string) func(string, any) Sqlizer { + return func(_ string, value any) Sqlizer { + return Like{field: fmt.Sprintf("%s%%", value)} + } } func containsFilter(field string) func(string, any) Sqlizer { @@ -105,8 +108,14 @@ func booleanFilter(field string, value any) Sqlizer { return Eq{field: v == "true"} } -func fullTextFilter(tableName string) func(string, any) Sqlizer { - return func(field string, value any) Sqlizer { return fullTextExpr(tableName, value.(string)) } +func fullTextFilter(tableName string, mbidFields ...string) func(string, any) Sqlizer { + return func(field string, value any) Sqlizer { + v := strings.ToLower(value.(string)) + return cmp.Or[Sqlizer]( + mbidExpr(tableName, v, mbidFields...), + getSearchStrategy(tableName, v), + ) + } } func substringFilter(field string, value any) Sqlizer { diff --git a/persistence/sql_restful_test.go b/persistence/sql_restful_test.go index 20cc31a36..32f418b8e 100644 --- a/persistence/sql_restful_test.go +++ b/persistence/sql_restful_test.go @@ -2,9 +2,12 @@ package persistence import ( "context" + "strings" "github.com/Masterminds/squirrel" "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -23,11 +26,13 @@ var _ = Describe("sqlRestful", func() { Expect(r.parseRestFilters(context.Background(), options)).To(BeNil()) }) - It(`returns nil if tries a filter with fullTextExpr("'")`, func() { + It(`returns nil if tries a filter with legacySearchExpr("'")`, func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" r.filterMappings = map[string]filterFunc{ "name": fullTextFilter("table"), } - options.Filters = map[string]interface{}{"name": "'"} + options.Filters = map[string]any{"name": "'"} Expect(r.parseRestFilters(context.Background(), options)).To(BeEmpty()) }) @@ -37,33 +42,217 @@ var _ = Describe("sqlRestful", func() { return nil }, } - options.Filters = map[string]interface{}{"name": "joe"} + options.Filters = map[string]any{"name": "joe"} Expect(r.parseRestFilters(context.Background(), options)).To(BeEmpty()) }) It("returns a '=' condition for 'id' filter", func() { - options.Filters = map[string]interface{}{"id": "123"} + options.Filters = map[string]any{"id": "123"} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Eq{"id": "123"}})) }) It("returns a 'in' condition for multiples 'id' filters", func() { - options.Filters = map[string]interface{}{"id": []string{"123", "456"}} + options.Filters = map[string]any{"id": []string{"123", "456"}} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Eq{"id": []string{"123", "456"}}})) }) It("returns a 'like' condition for other filters", func() { - options.Filters = map[string]interface{}{"name": "joe"} + options.Filters = map[string]any{"name": "joe"} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Like{"name": "joe%"}})) }) It("uses the custom filter", func() { r.filterMappings = map[string]filterFunc{ - "test": func(field string, value interface{}) squirrel.Sqlizer { + "test": func(field string, value any) squirrel.Sqlizer { return squirrel.Gt{field: value} }, } - options.Filters = map[string]interface{}{"test": 100} + options.Filters = map[string]any{"test": 100} Expect(r.parseRestFilters(context.Background(), options)).To(Equal(squirrel.And{squirrel.Gt{"test": 100}})) }) }) + + Describe("fullTextFilter function", func() { + var filter filterFunc + var tableName string + var mbidFields []string + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + tableName = "test_table" + mbidFields = []string{"mbid", "artist_mbid"} + filter = fullTextFilter(tableName, mbidFields...) + }) + + Context("when value is a valid UUID", func() { + It("returns only the mbid filter (precedence over full text)", func() { + uuid := "550e8400-e29b-41d4-a716-446655440000" + result := filter("search", uuid) + + expected := squirrel.Or{ + squirrel.Eq{"test_table.mbid": uuid}, + squirrel.Eq{"test_table.artist_mbid": uuid}, + } + Expect(result).To(Equal(expected)) + }) + + It("falls back to full text when no mbid fields are provided", func() { + noMbidFilter := fullTextFilter(tableName) + uuid := "550e8400-e29b-41d4-a716-446655440000" + result := noMbidFilter("search", uuid) + + // mbidExpr with no fields returns nil, so cmp.Or falls back to search strategy + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% 550e8400-e29b-41d4-a716-446655440000%")) + }) + }) + + Context("when value is not a valid UUID", func() { + It("returns full text search condition only", func() { + result := filter("search", "beatles") + + // mbidExpr returns nil for non-UUIDs, so search strategy result is returned directly + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% beatles%")) + }) + + It("handles multi-word search terms", func() { + result := filter("search", "the beatles abbey road") + + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + // All words should be present as LIKE conditions + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(HaveLen(4)) + Expect(args).To(ContainElement("% the%")) + Expect(args).To(ContainElement("% beatles%")) + Expect(args).To(ContainElement("% abbey%")) + Expect(args).To(ContainElement("% road%")) + }) + }) + + Context("when SearchFullString config changes behavior", func() { + It("uses different separator with SearchFullString=false", func() { + conf.Server.Search.FullString = false + result := filter("search", "test query") + + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(HaveLen(2)) + Expect(args).To(ContainElement("% test%")) + Expect(args).To(ContainElement("% query%")) + }) + + It("uses no separator with SearchFullString=true", func() { + conf.Server.Search.FullString = true + result := filter("search", "test query") + + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(HaveLen(2)) + Expect(args).To(ContainElement("%test%")) + Expect(args).To(ContainElement("%query%")) + }) + }) + + Context("single-character queries (regression: must not be rejected)", func() { + It("returns valid filter for single-char query with legacy backend", func() { + conf.Server.Search.Backend = "legacy" + result := filter("search", "a") + Expect(result).ToNot(BeNil(), "single-char REST filter must not be dropped") + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + Expect(args).ToNot(BeEmpty()) + }) + + It("returns valid filter for single-char query with FTS backend", func() { + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + ftsFilter := fullTextFilter(tableName, mbidFields...) + result := ftsFilter("search", "a") + Expect(result).ToNot(BeNil(), "single-char REST filter must not be dropped") + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + Expect(args).ToNot(BeEmpty()) + }) + }) + + Context("edge cases", func() { + It("returns nil for empty string", func() { + result := filter("search", "") + Expect(result).To(BeNil()) + }) + + It("returns nil for string with only whitespace", func() { + result := filter("search", " ") + Expect(result).To(BeNil()) + }) + + It("handles special characters that are sanitized", func() { + result := filter("search", "don't") + + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% dont%")) + }) + + It("returns nil for single quote (SQL injection protection)", func() { + result := filter("search", "'") + Expect(result).To(BeNil()) + }) + + It("handles mixed case UUIDs", func() { + uuid := "550E8400-E29B-41D4-A716-446655440000" + result := filter("search", uuid) + + // Should return only mbid filter (uppercase UUID should work) + expected := squirrel.Or{ + squirrel.Eq{"test_table.mbid": strings.ToLower(uuid)}, + squirrel.Eq{"test_table.artist_mbid": strings.ToLower(uuid)}, + } + Expect(result).To(Equal(expected)) + }) + + It("handles invalid UUID format gracefully", func() { + result := filter("search", "550e8400-invalid-uuid") + + // Should return full text filter since UUID is invalid + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% 550e8400-invalid-uuid%")) + }) + + It("handles empty mbid fields array", func() { + emptyMbidFilter := fullTextFilter(tableName, []string{}...) + result := emptyMbidFilter("search", "test") + + // mbidExpr with empty fields returns nil, so search strategy result is returned directly + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% test%")) + }) + + It("converts value to lowercase before processing", func() { + result := filter("search", "TEST") + + sql, args, err := result.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("test_table.full_text LIKE")) + Expect(args).To(ContainElement("% test%")) + }) + }) + }) + }) diff --git a/persistence/sql_search.go b/persistence/sql_search.go index 9ac171263..43965ebb7 100644 --- a/persistence/sql_search.go +++ b/persistence/sql_search.go @@ -4,6 +4,7 @@ import ( "strings" . "github.com/Masterminds/squirrel" + "github.com/google/uuid" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/str" @@ -14,45 +15,81 @@ func formatFullText(text ...string) string { return " " + fullText } -func (r sqlRepository) doSearch(sq SelectBuilder, q string, offset, size int, includeMissing bool, results any, orderBys ...string) error { +// searchConfig holds per-repository constants for doSearch. +type searchConfig struct { + NaturalOrder string // ORDER BY for empty-query results (e.g. "album.rowid") + OrderBy []string // ORDER BY for text search results (e.g. ["name"]) + MBIDFields []string // columns to match when query is a UUID + // LibraryFilter overrides the default applyLibraryFilter for FTS Phase 1. + // Needed when library access requires a junction table (e.g. artist → library_artist). + LibraryFilter func(sq SelectBuilder) SelectBuilder +} + +// searchStrategy defines how to execute a text search against a repository table. +// options carries filters and pagination that must reach all query phases, +// including FTS Phase 1 which builds its own query outside sq. +type searchStrategy interface { + Sqlizer + execute(r sqlRepository, sq SelectBuilder, dest any, cfg searchConfig, options model.QueryOptions) error +} + +// getSearchStrategy returns the appropriate search strategy based on config and query content. +// Returns nil when the query produces no searchable tokens. +func getSearchStrategy(tableName, query string) searchStrategy { + if conf.Server.Search.Backend == "legacy" || conf.Server.Search.FullString { + return newLegacySearch(tableName, query) + } + if containsCJK(query) { + return newLikeSearch(tableName, query) + } + return newFTSSearch(tableName, query) +} + +// doSearch dispatches a search query: empty → natural order, UUID → MBID match, +// otherwise delegates to getSearchStrategy. sq must already have LIMIT/OFFSET set +// via newSelect(options...). options is forwarded so FTS Phase 1 can apply the same +// filters and pagination independently. +func (r sqlRepository) doSearch(sq SelectBuilder, q string, results any, cfg searchConfig, options model.QueryOptions) error { q = strings.TrimSpace(q) q = strings.TrimSuffix(q, "*") + + sq = sq.Where(Eq{r.tableName + ".missing": false}) + + // Empty query (OpenSubsonic `search3?query=""`) — return all in natural order. + if q == "" || q == `""` { + sq = sq.OrderBy(cfg.NaturalOrder) + return r.queryAll(sq, results, options) + } + + // MBID search: if query is a valid UUID, search by MBID fields instead + if uuid.Validate(q) == nil && len(cfg.MBIDFields) > 0 { + sq = sq.Where(mbidExpr(r.tableName, q, cfg.MBIDFields...)) + return r.queryAll(sq, results) + } + + // Min-length guard: single-character queries are too broad for search3. + // This check lives here (not in the strategies) so that fullTextFilter + // (REST filter path) can still use single-character queries. if len(q) < 2 { return nil } - //sq := r.newSelect().Columns(r.tableName + ".*") - //sq = r.withAnnotation(sq, r.tableName+".id") - //sq = r.withBookmark(sq, r.tableName+".id") - filter := fullTextExpr(r.tableName, q) - if filter != nil { - sq = sq.Where(filter) - sq = sq.OrderBy(orderBys...) - } else { - // If the filter is empty, we sort by rowid. - // This is to speed up the results of `search3?query=""`, for OpenSubsonic - sq = sq.OrderBy(r.tableName + ".rowid") - } - if !includeMissing { - sq = sq.Where(Eq{r.tableName + ".missing": false}) - } - sq = sq.Limit(uint64(size)).Offset(uint64(offset)) - return r.queryAll(sq, results, model.QueryOptions{Offset: offset}) -} - -func fullTextExpr(tableName string, s string) Sqlizer { - q := str.SanitizeStrings(s) - if q == "" { + strategy := getSearchStrategy(r.tableName, q) + if strategy == nil { return nil } - var sep string - if !conf.Server.SearchFullString { - sep = " " - } - parts := strings.Split(q, " ") - filters := And{} - for _, part := range parts { - filters = append(filters, Like{tableName + ".full_text": "%" + sep + part + "%"}) - } - return filters + + return strategy.execute(r, sq, results, cfg, options) +} + +func mbidExpr(tableName, mbid string, mbidFields ...string) Sqlizer { + if uuid.Validate(mbid) != nil || len(mbidFields) == 0 { + return nil + } + mbid = strings.ToLower(mbid) + var cond []Sqlizer + for _, mbidField := range mbidFields { + cond = append(cond, Eq{tableName + "." + mbidField: mbid}) + } + return Or(cond) } diff --git a/persistence/sql_search_fts.go b/persistence/sql_search_fts.go new file mode 100644 index 000000000..b90dc937b --- /dev/null +++ b/persistence/sql_search_fts.go @@ -0,0 +1,441 @@ +package persistence + +import ( + "fmt" + "regexp" + "strings" + "unicode" + "unicode/utf8" + + . "github.com/Masterminds/squirrel" + "github.com/deluan/sanitize" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +// containsCJK returns true if the string contains any CJK (Chinese/Japanese/Korean) characters. +// CJK text doesn't use spaces between words, so FTS5's unicode61 tokenizer treats entire +// CJK phrases as single tokens, making token-based search ineffective for CJK content. +func containsCJK(s string) bool { + for _, r := range s { + if unicode.Is(unicode.Han, r) || + unicode.Is(unicode.Hiragana, r) || + unicode.Is(unicode.Katakana, r) || + unicode.Is(unicode.Hangul, r) { + return true + } + } + return false +} + +// fts5SpecialChars matches characters that should be stripped from user input. +// We keep only Unicode letters, numbers, whitespace, * (prefix wildcard), " (phrase quotes), +// and \x00 (internal placeholder marker). All punctuation is removed because the unicode61 +// tokenizer treats it as token separators, and characters like ' can cause FTS5 parse errors +// as unbalanced string delimiters. +var fts5SpecialChars = regexp.MustCompile(`[^\p{L}\p{N}\s*"\x00]`) + +// fts5PunctStrip strips everything except letters and numbers (no whitespace, wildcards, or quotes). +// Used for normalizing words at index time to create concatenated forms (e.g., "R.E.M." → "REM"). +var fts5PunctStrip = regexp.MustCompile(`[^\p{L}\p{N}]`) + +// fts5Operators matches FTS5 boolean operators as whole words (case-insensitive). +var fts5Operators = regexp.MustCompile(`(?i)\b(AND|OR|NOT|NEAR)\b`) + +// fts5LeadingStar matches a * at the start of a token. FTS5 only supports * at the end (prefix queries). +var fts5LeadingStar = regexp.MustCompile(`(^|[\s])\*+`) + +// normalizeForFTS takes multiple strings and returns a space-separated, deduplicated list of +// alternative searchable forms for each word: punctuation-stripped (R.E.M. → REM, AC/DC → ACDC) +// and ASCII-transliterated (Bjørk → Bjork, œuvre → oeuvre). The transliterated form is needed +// because FTS5's `unicode61 remove_diacritics 2` only handles NFKD-decomposable diacritics — +// atomic letters like ø/æ/œ/ß survive tokenization, so the query side and index side disagree +// without an explicit transliterated entry here. +func normalizeForFTS(values ...string) string { + seen := make(map[string]struct{}) + var result []string + add := func(orig, variant string) { + if variant == "" || variant == orig { + return + } + lower := strings.ToLower(variant) + if _, ok := seen[lower]; ok { + return + } + seen[lower] = struct{}{} + result = append(result, variant) + } + for _, v := range values { + for word := range strings.FieldsSeq(v) { + transliterated := sanitize.Accents(word) + // Concatenated ASCII form: R.E.M. → REM, AC/DC → ACDC, St-Étienne → StEtienne. + add(word, fts5PunctStrip.ReplaceAllString(transliterated, "")) + // Accent-only transliteration for words without name-punctuation (Bjørk → Bjork). + add(word, transliterated) + } + } + return strings.Join(result, " ") +} + +// isSingleUnicodeLetter returns true if token is exactly one Unicode letter. +func isSingleUnicodeLetter(token string) bool { + r, size := utf8.DecodeRuneInString(token) + return size == len(token) && size > 0 && unicode.IsLetter(r) +} + +// namePunctuation is the set of characters commonly used as separators in artist/album +// names (hyphens, slashes, dots, apostrophes). Only words containing these are candidates +// for punctuated-word processing; other special characters (^, :, &) are just stripped. +const namePunctuation = `-/.''` + +// processPunctuatedWords handles words with embedded name punctuation before the general +// special-character stripping. For each punctuated word it produces either: +// - A quoted phrase for dotted abbreviations: R.E.M. → "R E M" +// - A phrase+concat OR for other patterns: a-ha → ("a ha" OR aha*) +func processPunctuatedWords(input string, phrases []string) (string, []string) { + words := strings.Fields(input) + var result []string + for _, w := range words { + if strings.HasPrefix(w, "\x00") || strings.ContainsAny(w, `*"`) || !strings.ContainsAny(w, namePunctuation) { + result = append(result, w) + continue + } + concat := fts5PunctStrip.ReplaceAllString(w, "") + if concat == "" || concat == w { + result = append(result, w) + continue + } + subTokens := strings.Fields(fts5SpecialChars.ReplaceAllString(w, " ")) + if len(subTokens) < 2 { + // Single sub-token after splitting (e.g., N' → N): just use the stripped form + result = append(result, concat) + continue + } + // Dotted abbreviations (R.E.M., U.K.) — all single letters separated by dots only + if isDottedAbbreviation(w, subTokens) { + phrases = append(phrases, fmt.Sprintf(`"%s"`, strings.Join(subTokens, " "))) + } else { + // Punctuated names (a-ha, AC/DC, Jay-Z) — phrase for adjacency + concat for search_normalized + phrases = append(phrases, fmt.Sprintf(`("%s" OR %s*)`, strings.Join(subTokens, " "), concat)) + } + result = append(result, fmt.Sprintf("\x00PHRASE%d\x00", len(phrases)-1)) + } + return strings.Join(result, " "), phrases +} + +// isDottedAbbreviation returns true if w uses only dots as punctuation and all sub-tokens +// are single letters (e.g., "R.E.M.", "U.K." but not "a-ha" or "AC/DC"). +func isDottedAbbreviation(w string, subTokens []string) bool { + for _, r := range w { + if !unicode.IsLetter(r) && !unicode.IsNumber(r) && r != '.' { + return false + } + } + for _, st := range subTokens { + if !isSingleUnicodeLetter(st) { + return false + } + } + return true +} + +// buildFTS5Query preprocesses user input into a safe FTS5 MATCH expression. +// It preserves quoted phrases and * prefix wildcards, neutralizes FTS5 operators +// (by lowercasing them, since FTS5 operators are case-sensitive) and strips +// special characters to prevent query injection. +func buildFTS5Query(userInput string) string { + q := strings.TrimSpace(userInput) + if q == "" || q == `""` { + return "" + } + + var phrases []string + result := q + for { + start := strings.Index(result, `"`) + if start == -1 { + break + } + end := strings.Index(result[start+1:], `"`) + if end == -1 { + // Unmatched quote — remove it + result = result[:start] + result[start+1:] + break + } + end += start + 1 + phrase := result[start : end+1] // includes quotes + phrases = append(phrases, phrase) + result = result[:start] + fmt.Sprintf("\x00PHRASE%d\x00", len(phrases)-1) + result[end+1:] + } + + // Transliterate non-ASCII letters in the unquoted portion (ø→o, æ→ae, œ→oe, ß→ss, …) + // so the query matches the ASCII variants emitted by normalizeForFTS at index time. + // FTS5's own `remove_diacritics 2` only strips NFKD-decomposable marks, so without + // this step queries for words containing these letters can miss. Quoted phrases are + // left untouched so they continue to match the original text in title/artist columns. + result = sanitize.Accents(result) + + // Neutralize FTS5 operators by lowercasing them (FTS5 operators are case-sensitive: + // AND, OR, NOT, NEAR are operators, but and, or, not, near are plain tokens) + result = fts5Operators.ReplaceAllStringFunc(result, strings.ToLower) + + // Handle words with embedded punctuation (a-ha, AC/DC, R.E.M.) before stripping + result, phrases = processPunctuatedWords(result, phrases) + + result = fts5SpecialChars.ReplaceAllString(result, " ") + result = fts5LeadingStar.ReplaceAllString(result, "$1") + tokens := strings.Fields(result) + + // Append * to plain tokens for prefix matching (e.g., "love" → "love*"). + // Skip tokens that are already wildcarded or are quoted phrase placeholders. + for i, t := range tokens { + if strings.HasPrefix(t, "\x00") || strings.HasSuffix(t, "*") { + continue + } + tokens[i] = t + "*" + } + + // Use explicit AND between tokens — FTS5's implicit AND (space-separated) + // doesn't work correctly with parenthesized OR groups from processPunctuatedWords. + result = strings.Join(tokens, " AND ") + + for i, phrase := range phrases { + placeholder := fmt.Sprintf("\x00PHRASE%d\x00", i) + result = strings.ReplaceAll(result, placeholder, phrase) + } + + return result +} + +// ftsColumn pairs an FTS5 column name with its BM25 relevance weight. +type ftsColumn struct { + Name string + Weight float64 +} + +// ftsColumnDefs defines FTS5 columns and their BM25 relevance weights. +// The order MUST match the column order in the FTS5 table definition (see migrations). +// All columns are both searched and ranked. When adding indexed-but-not-searched +// columns in the future, use Weight: 0 to exclude from the search column filter. +var ftsColumnDefs = map[string][]ftsColumn{ + "media_file": { + {"title", 10.0}, + {"album", 5.0}, + {"artist", 3.0}, + {"album_artist", 3.0}, + {"sort_title", 1.0}, + {"sort_album_name", 1.0}, + {"sort_artist_name", 1.0}, + {"sort_album_artist_name", 1.0}, + {"disc_subtitle", 1.0}, + {"search_participants", 2.0}, + {"search_normalized", 1.0}, + }, + "album": { + {"name", 10.0}, + {"sort_album_name", 1.0}, + {"album_artist", 3.0}, + {"search_participants", 2.0}, + {"discs", 1.0}, + {"catalog_num", 1.0}, + {"album_version", 1.0}, + {"search_normalized", 1.0}, + }, + "artist": { + {"name", 10.0}, + {"sort_artist_name", 1.0}, + {"search_normalized", 1.0}, + }, +} + +// ftsColumnFilters and ftsBM25Weights are precomputed from ftsColumnDefs at init time +// to avoid per-query allocations. +var ( + ftsColumnFilters = map[string]string{} + ftsBM25Weights = map[string]string{} +) + +func init() { + for table, cols := range ftsColumnDefs { + var names []string + weights := make([]string, len(cols)) + for i, c := range cols { + if c.Weight > 0 { + names = append(names, c.Name) + } + weights[i] = fmt.Sprintf("%.1f", c.Weight) + } + ftsColumnFilters[table] = "{" + strings.Join(names, " ") + "}" + ftsBM25Weights[table] = strings.Join(weights, ", ") + } +} + +// ftsSearch implements searchStrategy using FTS5 full-text search with BM25 ranking. +type ftsSearch struct { + tableName string + ftsTable string + matchExpr string + rankExpr string +} + +// ToSql returns a single-query fallback for the REST filter path (no two-phase split). +func (s *ftsSearch) ToSql() (string, []any, error) { + sql := s.tableName + ".rowid IN (SELECT rowid FROM " + s.ftsTable + " WHERE " + s.ftsTable + " MATCH ?)" + return sql, []any{s.matchExpr}, nil +} + +// execute runs a two-phase FTS5 search: +// - Phase 1: lightweight rowid query (main table + FTS + library filter) for ranking and pagination. +// - Phase 2: full SELECT with all JOINs, scoped to Phase 1's rowid set. +// +// Complex ORDER BY (function calls, aggregations) are dropped from Phase 1. +func (s *ftsSearch) execute(r sqlRepository, sq SelectBuilder, dest any, cfg searchConfig, options model.QueryOptions) error { + qualifiedOrderBys := []string{s.rankExpr} + for _, ob := range cfg.OrderBy { + if qualified := qualifyOrderBy(s.tableName, ob); qualified != "" { + qualifiedOrderBys = append(qualifiedOrderBys, qualified) + } + } + + // Phase 1: fresh query — must set LIMIT/OFFSET from options explicitly. + // Mirror applyOptions behavior: Max=0 means no limit, not LIMIT 0. + rowidQuery := Select(s.tableName+".rowid"). + From(s.tableName). + Join(s.ftsTable+" ON "+s.ftsTable+".rowid = "+s.tableName+".rowid AND "+s.ftsTable+" MATCH ?", s.matchExpr). + Where(Eq{s.tableName + ".missing": false}). + OrderBy(qualifiedOrderBys...) + if options.Max > 0 { + rowidQuery = rowidQuery.Limit(uint64(options.Max)) + } + if options.Offset > 0 { + rowidQuery = rowidQuery.Offset(uint64(options.Offset)) + } + + // Library filter + musicFolderId must be applied here, before pagination. + if cfg.LibraryFilter != nil { + rowidQuery = cfg.LibraryFilter(rowidQuery) + } else { + rowidQuery = r.applyLibraryFilter(rowidQuery) + } + if options.Filters != nil { + rowidQuery = rowidQuery.Where(options.Filters) + } + + rowidSQL, rowidArgs, err := rowidQuery.ToSql() + if err != nil { + return fmt.Errorf("building FTS rowid query: %w", err) + } + + // Phase 2: strip LIMIT/OFFSET from sq (Phase 1 handled pagination), + // join on the ranked rowid set to hydrate with full columns. + sq = sq.RemoveLimit().RemoveOffset() + rankedSubquery := fmt.Sprintf( + "(SELECT rowid as _rid, row_number() OVER () AS _rn FROM (%s)) AS _ranked", + rowidSQL, + ) + sq = sq.Join(rankedSubquery+" ON "+s.tableName+".rowid = _ranked._rid", rowidArgs...) + sq = sq.OrderBy("_ranked._rn") + return r.queryAll(sq, dest) +} + +// qualifyOrderBy prepends tableName to a simple column name. Returns empty string for +// complex expressions (function calls, aggregations) that can't be used in Phase 1. +func qualifyOrderBy(tableName, orderBy string) string { + orderBy = strings.TrimSpace(orderBy) + if orderBy == "" || strings.ContainsAny(orderBy, "(,") { + return "" + } + parts := strings.Fields(orderBy) + if !strings.Contains(parts[0], ".") { + parts[0] = tableName + "." + parts[0] + } + return strings.Join(parts, " ") +} + +// ftsQueryDegraded returns true when the FTS query lost significant discriminating +// content compared to the original input. This happens when special characters that +// are part of the entity name (e.g., "1+", "C++", "!!!", "C#") get stripped by FTS +// tokenization, leaving only very short/broad tokens. Also detects quoted phrases +// that would be degraded by FTS5's unicode61 tokenizer (e.g., "1+" → token "1"). +func ftsQueryDegraded(original, ftsQuery string) bool { + original = strings.TrimSpace(original) + if original == "" || ftsQuery == "" { + return false + } + // Strip quotes from original for comparison — we want the raw content + stripped := strings.ReplaceAll(original, `"`, "") + // Extract the alphanumeric content from the original query + alphaNum := fts5PunctStrip.ReplaceAllString(stripped, "") + // If the original is entirely alphanumeric, nothing was stripped — not degraded + if len(alphaNum) == len(stripped) { + return false + } + // Check if all effective FTS tokens are very short (≤2 chars). + // Short tokens with prefix matching are too broad when special chars were stripped. + // For quoted phrases, extract the content and check the tokens inside. + tokens := strings.FieldsSeq(ftsQuery) + for t := range tokens { + t = strings.TrimSuffix(t, "*") + // Skip internal phrase placeholders + if strings.HasPrefix(t, "\x00") { + return false + } + // For OR groups from processPunctuatedWords (e.g., ("a ha" OR aha*)), + // the punctuated word was already handled meaningfully — not degraded. + if strings.HasPrefix(t, "(") { + return false + } + // For quoted phrases, check the tokens inside as FTS5 will tokenize them + if strings.HasPrefix(t, `"`) { + // Extract content between quotes + inner := strings.Trim(t, `"`) + innerAlpha := fts5PunctStrip.ReplaceAllString(inner, " ") + for it := range strings.FieldsSeq(innerAlpha) { + if len(it) > 2 { + return false + } + } + continue + } + if len(t) > 2 { + return false + } + } + return true +} + +// newFTSSearch creates an FTS5 search strategy. Falls back to LIKE search if the +// query produces no FTS tokens (e.g., punctuation-only like "!!!!!!!") or if FTS +// tokenization stripped significant content from the query (e.g., "1+" → "1*"). +// Returns nil when the query produces no searchable tokens at all. +func newFTSSearch(tableName, query string) searchStrategy { + q := buildFTS5Query(query) + if q == "" || ftsQueryDegraded(query, q) { + // Fallback: try LIKE search with the raw query + cleaned := strings.TrimSpace(strings.ReplaceAll(query, `"`, "")) + if cleaned != "" { + log.Trace("Search using LIKE fallback for non-tokenizable query", "table", tableName, "query", cleaned) + return newLikeSearch(tableName, cleaned) + } + return nil + } + ftsTable := tableName + "_fts" + matchExpr := q + if cols, ok := ftsColumnFilters[tableName]; ok { + matchExpr = cols + " : (" + q + ")" + } + + rankExpr := ftsTable + ".rank" + if weights, ok := ftsBM25Weights[tableName]; ok { + rankExpr = "bm25(" + ftsTable + ", " + weights + ")" + } + + s := &ftsSearch{ + tableName: tableName, + ftsTable: ftsTable, + matchExpr: matchExpr, + rankExpr: rankExpr, + } + log.Trace("Search using FTS5 backend", "table", tableName, "query", q, "filter", s) + return s +} diff --git a/persistence/sql_search_fts_test.go b/persistence/sql_search_fts_test.go new file mode 100644 index 000000000..b54e5856a --- /dev/null +++ b/persistence/sql_search_fts_test.go @@ -0,0 +1,450 @@ +package persistence + +import ( + "context" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = DescribeTable("buildFTS5Query", + func(input, expected string) { + Expect(buildFTS5Query(input)).To(Equal(expected)) + }, + Entry("returns empty string for empty input", "", ""), + Entry("returns empty string for whitespace-only input", " ", ""), + Entry("appends * to a single word for prefix matching", "beatles", "beatles*"), + Entry("appends * to each word for prefix matching", "abbey road", "abbey* AND road*"), + Entry("preserves quoted phrases without appending *", `"the beatles"`, `"the beatles"`), + Entry("does not double-append * to existing prefix wildcard", "beat*", "beat*"), + Entry("strips FTS5 operators and appends * to lowercased words", "AND OR NOT NEAR", "and* AND or* AND not* AND near*"), + Entry("strips special FTS5 syntax characters and appends *", "test^col:val", "test* AND col* AND val*"), + Entry("handles mixed phrases and words", `"the beatles" abbey`, `"the beatles" AND abbey*`), + Entry("handles prefix with multiple words", "beat* abbey", "beat* AND abbey*"), + Entry("collapses multiple spaces", "abbey road", "abbey* AND road*"), + Entry("strips leading * from tokens and appends trailing *", "*livia", "livia*"), + Entry("strips leading * and preserves existing trailing *", "*livia oliv*", "livia* AND oliv*"), + Entry("strips standalone *", "*", ""), + Entry("strips apostrophe from input", "Guns N' Roses", "Guns* AND N* AND Roses*"), + Entry("converts slashed word to phrase+concat OR", "AC/DC", `("AC DC" OR ACDC*)`), + Entry("converts hyphenated word to phrase+concat OR", "a-ha", `("a ha" OR aha*)`), + Entry("converts partial hyphenated word to phrase+concat OR", "a-h", `("a h" OR ah*)`), + Entry("converts hyphenated name to phrase+concat OR", "Jay-Z", `("Jay Z" OR JayZ*)`), + Entry("converts contraction to phrase+concat OR", "it's", `("it s" OR its*)`), + Entry("handles punctuated word mixed with plain words", "best of a-ha", `best* AND of* AND ("a ha" OR aha*)`), + Entry("handles contraction followed by plain words", "you've got", `("you ve" OR youve*) AND got*`), + Entry("strips miscellaneous punctuation", "rock & roll, vol. 2", "rock* AND roll* AND vol* AND 2*"), + Entry("transliterates NFKD-decomposable diacritics", "Björk début", "Bjork* AND debut*"), + Entry("transliterates ø to o", "Øystein", "Oystein*"), + Entry("transliterates œ ligature to oe", "œuvre", "oeuvre*"), + Entry("transliterates æ ligature to ae", "Brennæ", "Brennae*"), + Entry("transliterates mixed unicode words", "Mø Sigur Rós", "Mo* AND Sigur* AND Ros*"), + Entry("transliterates ß to ss", "Straße", "Strasse*"), + Entry("preserves quoted unicode phrase verbatim", `"Björk"`, `"Björk"`), + Entry("collapses dotted abbreviation into phrase", "R.E.M.", `"R E M"`), + Entry("collapses abbreviation without trailing dot", "R.E.M", `"R E M"`), + Entry("collapses abbreviation mixed with words", "best of R.E.M.", `best* AND of* AND "R E M"`), + Entry("collapses two-letter abbreviation", "U.K.", `"U K"`), + Entry("does not collapse single letter surrounded by words", "I am fine", "I* AND am* AND fine*"), + Entry("does not collapse single standalone letter", "A test", "A* AND test*"), + Entry("preserves quoted phrase with punctuation verbatim", `"ac/dc"`, `"ac/dc"`), + Entry("preserves quoted abbreviation verbatim", `"R.E.M."`, `"R.E.M."`), + Entry("returns empty string for punctuation-only input", "!!!!!!!", ""), + Entry("returns empty string for mixed punctuation", "!@#$%^&", ""), + Entry("returns empty string for empty quoted phrase", `""`, ""), +) + +var _ = DescribeTable("ftsQueryDegraded", + func(original, ftsQuery string, expected bool) { + Expect(ftsQueryDegraded(original, ftsQuery)).To(Equal(expected)) + }, + Entry("not degraded for empty original", "", "1*", false), + Entry("not degraded for empty ftsQuery", "1+", "", false), + Entry("not degraded for purely alphanumeric query", "beatles", "beatles*", false), + Entry("not degraded when long tokens remain", "test^val", "test* val*", false), + Entry("not degraded for quoted phrase with long tokens", `"the beatles"`, `"the beatles"`, false), + Entry("degraded for quoted phrase with only short tokens after tokenizer strips special chars", `"1+"`, `"1+"`, true), + Entry("not degraded for quoted phrase with meaningful content", `"C++ programming"`, `"C++ programming"`, false), + Entry("degraded when special chars stripped leaving short token", "1+", "1*", true), + Entry("degraded when special chars stripped leaving two short tokens", "C# 1", "C* 1*", true), + Entry("not degraded when at least one long token remains", "1+ beatles", "1* beatles*", false), + Entry("not degraded for OR groups from processPunctuatedWords", "AC/DC", `("AC DC" OR ACDC*)`, false), +) + +var _ = DescribeTable("normalizeForFTS", + func(expected string, values ...string) { + Expect(normalizeForFTS(values...)).To(Equal(expected)) + }, + Entry("strips dots and concatenates", "REM", "R.E.M."), + Entry("strips slash", "ACDC", "AC/DC"), + Entry("strips hyphen", "Aha", "A-ha"), + Entry("skips unchanged ASCII words", "", "The Beatles"), + Entry("handles mixed input", "REM", "R.E.M.", "Automatic for the People"), + Entry("deduplicates", "REM", "R.E.M.", "R.E.M."), + Entry("strips apostrophe from word", "N", "Guns N' Roses"), + Entry("handles multiple values with punctuation", "REM ACDC", "R.E.M.", "AC/DC"), + Entry("transliterates ø to o", "Bjork", "Bjørk"), + Entry("transliterates Ø to O", "Oystein", "Øystein"), + Entry("transliterates œ ligature to oe", "oeuvre", "œuvre"), + Entry("transliterates Latin diacritics", "cafe", "café"), + Entry("transliterates only the non-ASCII words", "Mo Ros", "Mø Rós"), + Entry("combines punctuation strip and transliteration", "StEtienne St-Etienne", "St-Étienne"), + Entry("deduplicates against punctuation form", "Cafe", "Café", "Cafe"), + Entry("transliterates ß to ss", "Strasse", "Straße"), +) + +var _ = DescribeTable("containsCJK", + func(input string, expected bool) { + Expect(containsCJK(input)).To(Equal(expected)) + }, + Entry("returns false for empty string", "", false), + Entry("returns false for ASCII text", "hello world", false), + Entry("returns false for Latin with diacritics", "Björk début", false), + Entry("detects Chinese characters (Han)", "周杰伦", true), + Entry("detects Japanese Hiragana", "こんにちは", true), + Entry("detects Japanese Katakana", "カタカナ", true), + Entry("detects Korean Hangul", "한국어", true), + Entry("detects CJK mixed with Latin", "best of 周杰伦", true), + Entry("detects single CJK character", "a曲b", true), +) + +var _ = DescribeTable("qualifyOrderBy", + func(tableName, orderBy, expected string) { + Expect(qualifyOrderBy(tableName, orderBy)).To(Equal(expected)) + }, + Entry("returns empty string for empty input", "artist", "", ""), + Entry("qualifies simple column with table name", "artist", "name", "artist.name"), + Entry("qualifies column with direction", "artist", "name desc", "artist.name desc"), + Entry("preserves already-qualified column", "artist", "artist.name", "artist.name"), + Entry("preserves already-qualified column with direction", "artist", "artist.name desc", "artist.name desc"), + Entry("returns empty for function call expression", "artist", "sum(json_extract(stats, '$.total.m')) desc", ""), + Entry("returns empty for expression with comma", "artist", "a, b", ""), + Entry("qualifies media_file column", "media_file", "title", "media_file.title"), +) + +var _ = Describe("ftsColumnDefs helpers", func() { + Describe("ftsColumnFilters", func() { + It("returns column filter for media_file", func() { + Expect(ftsColumnFilters).To(HaveKeyWithValue("media_file", + "{title album artist album_artist sort_title sort_album_name sort_artist_name sort_album_artist_name disc_subtitle search_participants search_normalized}", + )) + }) + + It("returns column filter for album", func() { + Expect(ftsColumnFilters).To(HaveKeyWithValue("album", + "{name sort_album_name album_artist search_participants discs catalog_num album_version search_normalized}", + )) + }) + + It("returns column filter for artist", func() { + Expect(ftsColumnFilters).To(HaveKeyWithValue("artist", + "{name sort_artist_name search_normalized}", + )) + }) + + It("has no entry for unknown table", func() { + Expect(ftsColumnFilters).ToNot(HaveKey("unknown")) + }) + }) + + Describe("ftsBM25Weights", func() { + It("returns weight CSV for media_file", func() { + Expect(ftsBM25Weights).To(HaveKeyWithValue("media_file", + "10.0, 5.0, 3.0, 3.0, 1.0, 1.0, 1.0, 1.0, 1.0, 2.0, 1.0", + )) + }) + + It("returns weight CSV for album", func() { + Expect(ftsBM25Weights).To(HaveKeyWithValue("album", + "10.0, 1.0, 3.0, 2.0, 1.0, 1.0, 1.0, 1.0", + )) + }) + + It("returns weight CSV for artist", func() { + Expect(ftsBM25Weights).To(HaveKeyWithValue("artist", + "10.0, 1.0, 1.0", + )) + }) + + It("has no entry for unknown table", func() { + Expect(ftsBM25Weights).ToNot(HaveKey("unknown")) + }) + }) + + It("has definitions for all known tables", func() { + for _, table := range []string{"media_file", "album", "artist"} { + Expect(ftsColumnDefs).To(HaveKey(table)) + Expect(ftsColumnDefs[table]).ToNot(BeEmpty()) + } + }) + + It("has matching column count between filter and weights", func() { + for table, cols := range ftsColumnDefs { + // Column filter only includes Weight > 0 columns + filterCount := 0 + for _, c := range cols { + if c.Weight > 0 { + filterCount++ + } + } + // For now, all columns have Weight > 0, so filter count == total count + Expect(filterCount).To(Equal(len(cols)), "table %s: all columns should have positive weights", table) + } + }) +}) + +var _ = Describe("newFTSSearch", func() { + It("returns nil for empty query", func() { + Expect(newFTSSearch("media_file", "")).To(BeNil()) + }) + + It("returns non-nil for single-character query", func() { + strategy := newFTSSearch("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must not be rejected; min-length is enforced in doSearch, not here") + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + }) + + It("returns ftsSearch with correct table names and MATCH expression", func() { + strategy := newFTSSearch("media_file", "beatles") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.tableName).To(Equal("media_file")) + Expect(fts.ftsTable).To(Equal("media_file_fts")) + Expect(fts.matchExpr).To(HavePrefix("{title album artist album_artist")) + Expect(fts.matchExpr).To(ContainSubstring("beatles*")) + }) + + It("ToSql generates rowid IN subquery with MATCH (fallback path)", func() { + strategy := newFTSSearch("media_file", "beatles") + sql, args, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("media_file.rowid IN")) + Expect(sql).To(ContainSubstring("media_file_fts")) + Expect(sql).To(ContainSubstring("MATCH")) + Expect(args).To(HaveLen(1)) + }) + + It("generates correct FTS table name per entity", func() { + for _, table := range []string{"media_file", "album", "artist"} { + strategy := newFTSSearch(table, "test") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.tableName).To(Equal(table)) + Expect(fts.ftsTable).To(Equal(table + "_fts")) + } + }) + + It("builds bm25() rank expression with column weights", func() { + strategy := newFTSSearch("media_file", "beatles") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.rankExpr).To(HavePrefix("bm25(media_file_fts,")) + Expect(fts.rankExpr).To(ContainSubstring("10.0")) + + strategy = newFTSSearch("artist", "beatles") + fts, ok = strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.rankExpr).To(HavePrefix("bm25(artist_fts,")) + }) + + It("falls back to ftsTable.rank for unknown tables", func() { + strategy := newFTSSearch("unknown_table", "test") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.rankExpr).To(Equal("unknown_table_fts.rank")) + }) + + It("wraps query with column filter for known tables", func() { + strategy := newFTSSearch("artist", "Beatles") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(Equal("{name sort_artist_name search_normalized} : (Beatles*)")) + }) + + It("passes query without column filter for unknown tables", func() { + strategy := newFTSSearch("unknown_table", "test") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(Equal("test*")) + }) + + It("preserves phrase queries inside column filter", func() { + strategy := newFTSSearch("media_file", `"the beatles"`) + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(ContainSubstring(`"the beatles"`)) + }) + + It("preserves prefix queries inside column filter", func() { + strategy := newFTSSearch("media_file", "beat*") + fts, ok := strategy.(*ftsSearch) + Expect(ok).To(BeTrue()) + Expect(fts.matchExpr).To(ContainSubstring("beat*")) + }) + + It("falls back to LIKE search for punctuation-only query", func() { + strategy := newFTSSearch("media_file", "!!!!!!!") + Expect(strategy).ToNot(BeNil()) + _, ok := strategy.(*ftsSearch) + Expect(ok).To(BeFalse(), "punctuation-only should fall back to LIKE, not FTS") + sql, args, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + Expect(args).To(ContainElement("%!!!!!!!%")) + }) + + It("falls back to LIKE search for degraded query (special chars stripped leaving short tokens)", func() { + strategy := newFTSSearch("album", "1+") + Expect(strategy).ToNot(BeNil()) + _, ok := strategy.(*ftsSearch) + Expect(ok).To(BeFalse(), "degraded query should fall back to LIKE, not FTS") + sql, args, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + Expect(args).To(ContainElement("%1+%")) + }) + + It("returns nil for empty string even with LIKE fallback", func() { + Expect(newFTSSearch("media_file", "")).To(BeNil()) + Expect(newFTSSearch("media_file", " ")).To(BeNil()) + }) + + It("returns nil for empty quoted phrase", func() { + Expect(newFTSSearch("media_file", `""`)).To(BeNil()) + }) +}) + +var _ = Describe("FTS5 Integration Search", func() { + var ( + mr model.MediaFileRepository + alr model.AlbumRepository + arr model.ArtistRepository + ) + + BeforeEach(func() { + ctx := log.NewContext(context.TODO()) + ctx = request.WithUser(ctx, adminUser) + conn := GetDBXBuilder() + mr = NewMediaFileRepository(ctx, conn) + alr = NewAlbumRepository(ctx, conn) + arr = NewArtistRepository(ctx, conn) + }) + + Describe("MediaFile search", func() { + It("finds media files by title", func() { + results, err := mr.Search("Radioactivity", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("Radioactivity")) + Expect(results[0].ID).To(Equal(songRadioactivity.ID)) + }) + + It("finds media files by artist name", func() { + results, err := mr.Search("Beatles", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + for _, r := range results { + Expect(r.Artist).To(Equal("The Beatles")) + } + }) + }) + + Describe("Album search", func() { + It("finds albums by name", func() { + results, err := alr.Search("Sgt Peppers", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("Sgt Peppers")) + Expect(results[0].ID).To(Equal(albumSgtPeppers.ID)) + }) + + It("finds albums with multi-word search", func() { + results, err := alr.Search("Abbey Road", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + }) + }) + + Describe("Artist search", func() { + It("finds artists by name", func() { + results, err := arr.Search("Kraftwerk", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("Kraftwerk")) + Expect(results[0].ID).To(Equal(artistKraftwerk.ID)) + }) + }) + + Describe("CJK search", func() { + It("finds media files by CJK title", func() { + results, err := mr.Search("プラチナ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("プラチナ・ジェット")) + Expect(results[0].ID).To(Equal(songCJK.ID)) + }) + + It("finds media files by CJK artist name", func() { + results, err := mr.Search("シートベルツ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Artist).To(Equal("シートベルツ")) + }) + + It("finds albums by CJK artist name", func() { + results, err := alr.Search("シートベルツ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("COWBOY BEBOP")) + Expect(results[0].ID).To(Equal(albumCJK.ID)) + }) + + It("finds artists by CJK name", func() { + results, err := arr.Search("シートベルツ", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Name).To(Equal("シートベルツ")) + Expect(results[0].ID).To(Equal(artistCJK.ID)) + }) + }) + + Describe("Album version search", func() { + It("finds albums by version tag via FTS", func() { + results, err := alr.Search("Deluxe", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal(albumWithVersion.ID)) + }) + }) + + Describe("Punctuation-only search", func() { + It("finds media files with punctuation-only title", func() { + results, err := mr.Search("!!!!!!!", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("!!!!!!!")) + Expect(results[0].ID).To(Equal(songPunctuation.ID)) + }) + }) + + Describe("Single-character search (doSearch min-length guard)", func() { + It("returns empty results for single-char query via Search", func() { + results, err := mr.Search("a", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty(), "doSearch should reject single-char queries") + }) + }) + + Describe("Max=0 means no limit (regression: must not produce LIMIT 0)", func() { + It("returns results with Max=0", func() { + results, err := mr.Search("Beatles", model.QueryOptions{Max: 0}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).ToNot(BeEmpty(), "Max=0 should mean no limit, not LIMIT 0") + }) + }) +}) diff --git a/persistence/sql_search_like.go b/persistence/sql_search_like.go new file mode 100644 index 000000000..972545ac5 --- /dev/null +++ b/persistence/sql_search_like.go @@ -0,0 +1,106 @@ +package persistence + +import ( + "strings" + + . "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/str" +) + +// likeSearch implements searchStrategy using LIKE-based SQL filters. +// Used for legacy full_text searches, CJK fallback, and punctuation-only fallback. +type likeSearch struct { + filter Sqlizer +} + +func (s *likeSearch) ToSql() (string, []any, error) { + return s.filter.ToSql() +} + +func (s *likeSearch) execute(r sqlRepository, sq SelectBuilder, dest any, cfg searchConfig, options model.QueryOptions) error { + sq = sq.Where(s.filter) + sq = sq.OrderBy(cfg.OrderBy...) + return r.queryAll(sq, dest, options) +} + +// newLegacySearch creates a LIKE search against the full_text column. +// Returns nil when the query produces no searchable tokens. +func newLegacySearch(tableName, query string) searchStrategy { + filter := legacySearchExpr(tableName, query) + if filter == nil { + return nil + } + return &likeSearch{filter: filter} +} + +// newLikeSearch creates a LIKE search against core entity columns (CJK, punctuation fallback). +// No minimum length is enforced, since single CJK characters are meaningful words. +// Returns nil when the query produces no searchable tokens. +func newLikeSearch(tableName, query string) searchStrategy { + filter := likeSearchExpr(tableName, query) + if filter == nil { + return nil + } + return &likeSearch{filter: filter} +} + +// legacySearchExpr generates LIKE-based search filters against the full_text column. +// This is the original search implementation, used when Search.Backend="legacy". +func legacySearchExpr(tableName string, s string) Sqlizer { + q := str.SanitizeStrings(s) + if q == "" { + log.Trace("Search using legacy backend, query is empty", "table", tableName) + return nil + } + var sep string + if !conf.Server.Search.FullString { + sep = " " + } + parts := strings.Split(q, " ") + filters := And{} + for _, part := range parts { + filters = append(filters, Like{tableName + ".full_text": "%" + sep + part + "%"}) + } + log.Trace("Search using legacy backend", "query", filters, "table", tableName) + return filters +} + +// likeSearchColumns defines the core columns to search with LIKE queries. +// These are the primary user-visible fields for each entity type. +// Used as a fallback when FTS5 cannot handle the query (e.g., CJK text, punctuation-only input). +var likeSearchColumns = map[string][]string{ + "media_file": {"title", "album", "artist", "album_artist"}, + "album": {"name", "album_artist"}, + "artist": {"name"}, +} + +// likeSearchExpr generates LIKE-based search filters against core columns. +// Each word in the query must match at least one column (AND between words), +// and each word can match any column (OR within a word). +// Used as a fallback when FTS5 cannot handle the query (e.g., CJK text, punctuation-only input). +func likeSearchExpr(tableName string, s string) Sqlizer { + s = strings.TrimSpace(s) + if s == "" { + log.Trace("Search using LIKE backend, query is empty", "table", tableName) + return nil + } + columns, ok := likeSearchColumns[tableName] + if !ok { + log.Trace("Search using LIKE backend, couldn't find columns for this table", "table", tableName) + return nil + } + words := strings.Fields(s) + wordFilters := And{} + for _, word := range words { + colFilters := Or{} + for _, col := range columns { + colFilters = append(colFilters, Like{tableName + "." + col: "%" + word + "%"}) + } + wordFilters = append(wordFilters, colFilters) + } + log.Trace("Search using LIKE backend", "query", wordFilters, "table", tableName) + return wordFilters +} diff --git a/persistence/sql_search_like_test.go b/persistence/sql_search_like_test.go new file mode 100644 index 000000000..8ee4ef93c --- /dev/null +++ b/persistence/sql_search_like_test.go @@ -0,0 +1,134 @@ +package persistence + +import ( + "context" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("newLegacySearch", func() { + It("returns non-nil for single-character query", func() { + strategy := newLegacySearch("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must not be rejected; min-length is enforced in doSearch, not here") + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + }) +}) + +var _ = Describe("legacySearchExpr", func() { + It("returns nil for empty query", func() { + Expect(legacySearchExpr("media_file", "")).To(BeNil()) + }) + + It("generates LIKE filter for single word", func() { + expr := legacySearchExpr("media_file", "beatles") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("media_file.full_text LIKE")) + Expect(args).To(ContainElement("% beatles%")) + }) + + It("generates AND of LIKE filters for multiple words", func() { + expr := legacySearchExpr("media_file", "abbey road") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("AND")) + Expect(args).To(HaveLen(2)) + }) +}) + +var _ = Describe("likeSearchExpr", func() { + It("returns nil for empty query", func() { + Expect(likeSearchExpr("media_file", "")).To(BeNil()) + }) + + It("returns nil for whitespace-only query", func() { + Expect(likeSearchExpr("media_file", " ")).To(BeNil()) + }) + + It("generates LIKE filters against core columns for single CJK word", func() { + expr := likeSearchExpr("media_file", "周杰伦") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Should have OR between columns for the single word + Expect(sql).To(ContainSubstring("OR")) + Expect(sql).To(ContainSubstring("media_file.title LIKE")) + Expect(sql).To(ContainSubstring("media_file.album LIKE")) + Expect(sql).To(ContainSubstring("media_file.artist LIKE")) + Expect(sql).To(ContainSubstring("media_file.album_artist LIKE")) + Expect(args).To(HaveLen(4)) + for _, arg := range args { + Expect(arg).To(Equal("%周杰伦%")) + } + }) + + It("generates AND of OR groups for multi-word query", func() { + expr := likeSearchExpr("media_file", "周杰伦 greatest") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Two groups AND'd together, each with 4 columns OR'd + Expect(sql).To(ContainSubstring("AND")) + Expect(args).To(HaveLen(8)) + }) + + It("uses correct columns for album table", func() { + expr := likeSearchExpr("album", "周杰伦") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("album.name LIKE")) + Expect(sql).To(ContainSubstring("album.album_artist LIKE")) + Expect(args).To(HaveLen(2)) + }) + + It("uses correct columns for artist table", func() { + expr := likeSearchExpr("artist", "周杰伦") + sql, args, err := expr.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("artist.name LIKE")) + Expect(args).To(HaveLen(1)) + }) + + It("returns nil for unknown table", func() { + Expect(likeSearchExpr("unknown_table", "周杰伦")).To(BeNil()) + }) +}) + +var _ = Describe("Legacy Integration Search", func() { + var mr model.MediaFileRepository + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + + ctx := log.NewContext(context.TODO()) + ctx = request.WithUser(ctx, adminUser) + conn := GetDBXBuilder() + mr = NewMediaFileRepository(ctx, conn) + }) + + It("returns results using legacy LIKE-based search", func() { + results, err := mr.Search("Radioactivity", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].Title).To(Equal("Radioactivity")) + }) + + It("returns empty results for single-char query (doSearch min-length guard)", func() { + results, err := mr.Search("a", model.QueryOptions{Max: 10}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(BeEmpty(), "doSearch should reject single-char queries") + }) + + It("returns results with Max=0 (regression: must not produce LIMIT 0)", func() { + results, err := mr.Search("Beatles", model.QueryOptions{Max: 0}) + Expect(err).ToNot(HaveOccurred()) + Expect(results).ToNot(BeEmpty(), "Max=0 should mean no limit, not LIMIT 0") + }) +}) diff --git a/persistence/sql_search_test.go b/persistence/sql_search_test.go index 6bfd88d9f..68ee205b4 100644 --- a/persistence/sql_search_test.go +++ b/persistence/sql_search_test.go @@ -1,6 +1,8 @@ package persistence import ( + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -11,4 +13,100 @@ var _ = Describe("sqlRepository", func() { Expect(formatFullText("legiao urbana")).To(Equal(" legiao urbana")) }) }) + + Describe("getSearchStrategy", func() { + It("returns FTS strategy by default", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "test") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + }) + + It("returns legacy LIKE strategy when SearchBackend is legacy", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "test") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + }) + + It("falls back to legacy LIKE strategy when SearchFullString is enabled", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = true + + strategy := getSearchStrategy("media_file", "test") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("LIKE")) + }) + + It("routes CJK queries to LIKE strategy instead of FTS", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "周杰伦") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + // CJK should use LIKE, not MATCH + Expect(sql).To(ContainSubstring("LIKE")) + Expect(sql).NotTo(ContainSubstring("MATCH")) + }) + + It("routes non-CJK queries to FTS strategy", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "beatles") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(sql).To(ContainSubstring("MATCH")) + }) + + It("returns non-nil for single-character query (no min-length in strategy)", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "fts" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must be accepted by strategies (min-length is enforced in doSearch)") + }) + + It("returns non-nil for single-character query with legacy backend", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "a") + Expect(strategy).ToNot(BeNil(), "single-char queries must be accepted by legacy strategy (min-length is enforced in doSearch)") + }) + + It("uses legacy for CJK when SearchBackend is legacy", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + conf.Server.Search.FullString = false + + strategy := getSearchStrategy("media_file", "周杰伦") + Expect(strategy).ToNot(BeNil()) + sql, _, err := strategy.ToSql() + Expect(err).ToNot(HaveOccurred()) + // Legacy should still use full_text column LIKE + Expect(sql).To(ContainSubstring("LIKE")) + Expect(sql).To(ContainSubstring("full_text")) + }) + }) }) diff --git a/persistence/sql_tags.go b/persistence/sql_tags.go index d7b48f23e..88acebb7f 100644 --- a/persistence/sql_tags.go +++ b/persistence/sql_tags.go @@ -1,12 +1,15 @@ package persistence import ( + "context" "encoding/json" "fmt" "strings" . "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/model" + "github.com/pocketbase/dbx" ) // Format of a tag in the DB @@ -55,3 +58,111 @@ func tagIDFilter(name string, idValue any) Sqlizer { }, ) } + +// tagLibraryIdFilter filters tags based on library access through the library_tag table +func tagLibraryIdFilter(_ string, value any) Sqlizer { + return Eq{"library_tag.library_id": value} +} + +// baseTagRepository provides common functionality for all tag-based repositories. +// It handles CRUD operations with optional filtering by tag name. +type baseTagRepository struct { + sqlRepository + tagFilter *model.TagName // nil = no filter (all tags), non-nil = filter by specific tag name +} + +// newBaseTagRepository creates a new base tag repository with optional tag filtering. +// If tagFilter is nil, the repository will work with all tags. +// If tagFilter is provided, the repository will only work with tags of that specific name. +func newBaseTagRepository(ctx context.Context, db dbx.Builder, tagFilter *model.TagName) *baseTagRepository { + r := &baseTagRepository{ + tagFilter: tagFilter, + } + r.ctx = ctx + r.db = db + r.tableName = "tag" + r.registerModel(&model.Tag{}, map[string]filterFunc{ + "name": containsFilter("tag_value"), + "library_id": tagLibraryIdFilter, + }) + r.setSortMappings(map[string]string{ + "name": "tag_value", + }) + return r +} + +// applyLibraryFiltering adds the appropriate library joins based on user context +func (r *baseTagRepository) applyLibraryFiltering(sq SelectBuilder) SelectBuilder { + // Add library_tag join + sq = sq.LeftJoin("library_tag on library_tag.tag_id = tag.id") + + // For authenticated users, also join with user_library to filter by accessible libraries + user := loggedUser(r.ctx) + if user.ID != invalidUserId { + sq = sq.Join("user_library on user_library.library_id = library_tag.library_id AND user_library.user_id = ?", user.ID) + } + + return sq +} + +// newSelect overrides the base implementation to apply tag name filtering and library filtering. +func (r *baseTagRepository) newSelect(options ...model.QueryOptions) SelectBuilder { + sq := r.sqlRepository.newSelect(options...) + + // Apply tag name filtering if specified + if r.tagFilter != nil { + sq = sq.Where(Eq{"tag.tag_name": *r.tagFilter}) + } + + // Apply library filtering and set up aggregation columns + sq = r.applyLibraryFiltering(sq).Columns( + "tag.id", + "tag.tag_name", + "tag.tag_value", + "COALESCE(SUM(library_tag.album_count), 0) as album_count", + "COALESCE(SUM(library_tag.media_file_count), 0) as song_count", + ).GroupBy("tag.id", "tag.tag_name", "tag.tag_value") + + return sq +} + +// ResourceRepository interface implementation + +func (r *baseTagRepository) Count(options ...rest.QueryOptions) (int64, error) { + sq := Select("COUNT(DISTINCT tag.id)").From("tag") + + // Apply tag name filtering if specified + if r.tagFilter != nil { + sq = sq.Where(Eq{"tag.tag_name": *r.tagFilter}) + } + + // Apply library filtering + sq = r.applyLibraryFiltering(sq) + + return r.count(sq, r.parseRestOptions(r.ctx, options...)) +} + +func (r *baseTagRepository) Read(id string) (any, error) { + query := r.newSelect().Where(Eq{"id": id}) + var res model.Tag + err := r.queryOne(query, &res) + return &res, err +} + +func (r *baseTagRepository) ReadAll(options ...rest.QueryOptions) (any, error) { + query := r.newSelect(r.parseRestOptions(r.ctx, options...)) + var res model.TagList + err := r.queryAll(query, &res) + return res, err +} + +func (r *baseTagRepository) EntityName() string { + return "tag" +} + +func (r *baseTagRepository) NewInstance() any { + return model.Tag{} +} + +// Interface compliance check +var _ model.ResourceRepository = (*baseTagRepository)(nil) diff --git a/persistence/tag_library_filtering_test.go b/persistence/tag_library_filtering_test.go new file mode 100644 index 000000000..ddd897165 --- /dev/null +++ b/persistence/tag_library_filtering_test.go @@ -0,0 +1,263 @@ +package persistence + +import ( + "context" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +const ( + adminUserID = "userid" + regularUserID = "2222" + libraryID1 = 1 + libraryID2 = 2 + libraryID3 = 3 + + tagNameGenre = "genre" + tagValueRock = "rock" + tagValuePop = "pop" + tagValueJazz = "jazz" +) + +var _ = Describe("Tag Library Filtering", func() { + var ( + tagRockID = id.NewTagID(tagNameGenre, tagValueRock) + tagPopID = id.NewTagID(tagNameGenre, tagValuePop) + tagJazzID = id.NewTagID(tagNameGenre, tagValueJazz) + ) + + expectTagValues := func(tagList model.TagList, expected []string) { + tagValues := make([]string, len(tagList)) + for i, tag := range tagList { + tagValues[i] = tag.TagValue + } + Expect(tagValues).To(ContainElements(expected)) + } + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + + // Generate unique path suffix to avoid conflicts with other tests + uniqueSuffix := time.Now().Format("20060102150405.000") + + // Clean up database + db := GetDBXBuilder() + _, err := db.NewQuery("DELETE FROM library_tag").Execute() + Expect(err).ToNot(HaveOccurred()) + _, err = db.NewQuery("DELETE FROM tag").Execute() + Expect(err).ToNot(HaveOccurred()) + _, err = db.NewQuery("DELETE FROM user_library WHERE user_id != {:admin} AND user_id != {:regular}"). + Bind(dbx.Params{"admin": adminUserID, "regular": regularUserID}).Execute() + Expect(err).ToNot(HaveOccurred()) + _, err = db.NewQuery("DELETE FROM library WHERE id > 1").Execute() + Expect(err).ToNot(HaveOccurred()) + + // Create test libraries with unique names and paths to avoid conflicts with other tests + _, err = db.NewQuery("INSERT INTO library (id, name, path) VALUES ({:id}, {:name}, {:path})"). + Bind(dbx.Params{"id": libraryID2, "name": "Library 2-" + uniqueSuffix, "path": "/music/lib2-" + uniqueSuffix}).Execute() + Expect(err).ToNot(HaveOccurred()) + _, err = db.NewQuery("INSERT INTO library (id, name, path) VALUES ({:id}, {:name}, {:path})"). + Bind(dbx.Params{"id": libraryID3, "name": "Library 3-" + uniqueSuffix, "path": "/music/lib3-" + uniqueSuffix}).Execute() + Expect(err).ToNot(HaveOccurred()) + + // Give admin access to all libraries + for _, libID := range []int{libraryID1, libraryID2, libraryID3} { + _, err = db.NewQuery("INSERT OR IGNORE INTO user_library (user_id, library_id) VALUES ({:user}, {:lib})"). + Bind(dbx.Params{"user": adminUserID, "lib": libID}).Execute() + Expect(err).ToNot(HaveOccurred()) + } + + // Create test tags + adminCtx := request.WithUser(log.NewContext(context.TODO()), adminUser) + tagRepo := NewTagRepository(adminCtx, GetDBXBuilder()) + + createTag := func(libraryID int, name, value string) { + tag := model.Tag{ID: id.NewTagID(name, value), TagName: model.TagName(name), TagValue: value} + err := tagRepo.Add(libraryID, tag) + Expect(err).ToNot(HaveOccurred()) + } + + createTag(libraryID1, tagNameGenre, tagValueRock) + createTag(libraryID2, tagNameGenre, tagValuePop) + createTag(libraryID3, tagNameGenre, tagValueJazz) + createTag(libraryID2, tagNameGenre, tagValueRock) // Rock appears in both lib1 and lib2 + + // Set tag counts (manually for testing) + setCounts := func(tagID string, libID, albums, songs int) { + _, err := db.NewQuery("UPDATE library_tag SET album_count = {:albums}, media_file_count = {:songs} WHERE tag_id = {:tag} AND library_id = {:lib}"). + Bind(dbx.Params{"albums": albums, "songs": songs, "tag": tagID, "lib": libID}).Execute() + Expect(err).ToNot(HaveOccurred()) + } + + setCounts(tagRockID, libraryID1, 5, 20) + setCounts(tagPopID, libraryID2, 3, 10) + setCounts(tagJazzID, libraryID3, 2, 8) + setCounts(tagRockID, libraryID2, 1, 4) + + // Give regular user access to library 2 only + _, err = db.NewQuery("INSERT INTO user_library (user_id, library_id) VALUES ({:user}, {:lib})"). + Bind(dbx.Params{"user": regularUserID, "lib": libraryID2}).Execute() + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("TagRepository Library Filtering", func() { + // Helper to create repository and read all tags + readAllTags := func(user *model.User, filters ...rest.QueryOptions) model.TagList { + var ctx context.Context + if user != nil { + ctx = request.WithUser(log.NewContext(context.TODO()), *user) + } else { + ctx = context.Background() // Headless context + } + + tagRepo := NewTagRepository(ctx, GetDBXBuilder()) + repo := tagRepo.(model.ResourceRepository) + + var opts rest.QueryOptions + if len(filters) > 0 { + opts = filters[0] + } + + tags, err := repo.ReadAll(opts) + Expect(err).ToNot(HaveOccurred()) + return tags.(model.TagList) + } + + // Helper to count tags + countTags := func(user *model.User) int64 { + var ctx context.Context + if user != nil { + ctx = request.WithUser(log.NewContext(context.TODO()), *user) + } else { + ctx = context.Background() + } + + tagRepo := NewTagRepository(ctx, GetDBXBuilder()) + repo := tagRepo.(model.ResourceRepository) + + count, err := repo.Count() + Expect(err).ToNot(HaveOccurred()) + return count + } + + Context("Admin User", func() { + It("should see all tags regardless of library", func() { + tags := readAllTags(&adminUser) + Expect(tags).To(HaveLen(3)) + }) + }) + + Context("Regular User with Limited Library Access", func() { + It("should only see tags from accessible libraries", func() { + tags := readAllTags(®ularUser) + // Should see rock (libraries 1,2) and pop (library 2), but not jazz (library 3) + Expect(tags).To(HaveLen(2)) + }) + + It("should respect explicit library_id filters within accessible libraries", func() { + tags := readAllTags(®ularUser, rest.QueryOptions{ + Filters: map[string]any{"library_id": libraryID2}, + }) + // Should see only tags from library 2: pop and rock(lib2) + Expect(tags).To(HaveLen(2)) + expectTagValues(tags, []string{tagValuePop, tagValueRock}) + }) + + It("should not return tags when filtering by inaccessible library", func() { + tags := readAllTags(®ularUser, rest.QueryOptions{ + Filters: map[string]any{"library_id": libraryID3}, + }) + // Should return no tags since user can't access library 3 + Expect(tags).To(HaveLen(0)) + }) + + It("should filter by library 1 correctly", func() { + tags := readAllTags(®ularUser, rest.QueryOptions{ + Filters: map[string]any{"library_id": libraryID1}, + }) + // Should see only rock from library 1 + Expect(tags).To(HaveLen(1)) + Expect(tags[0].TagValue).To(Equal(tagValueRock)) + }) + }) + + Context("Headless Processes (No User Context)", func() { + It("should see all tags from all libraries when no user is in context", func() { + tags := readAllTags(nil) // nil = headless context + // Should see all tags from all libraries (no filtering applied) + Expect(tags).To(HaveLen(3)) + expectTagValues(tags, []string{tagValueRock, tagValuePop, tagValueJazz}) + }) + + It("should count all tags from all libraries when no user is in context", func() { + count := countTags(nil) + // Should count all tags from all libraries + Expect(count).To(Equal(int64(3))) + }) + + It("should calculate proper statistics from all libraries for headless processes", func() { + tags := readAllTags(nil) + + // Find the rock tag (appears in libraries 1 and 2) + var rockTag *model.Tag + for _, tag := range tags { + if tag.TagValue == tagValueRock { + rockTag = &tag + break + } + } + Expect(rockTag).ToNot(BeNil()) + + // Should have stats from all libraries where rock appears + // Library 1: 5 albums, 20 songs + // Library 2: 1 album, 4 songs + // Total: 6 albums, 24 songs + Expect(rockTag.AlbumCount).To(Equal(6)) + Expect(rockTag.SongCount).To(Equal(24)) + }) + + It("should allow headless processes to apply explicit library_id filters", func() { + tags := readAllTags(nil, rest.QueryOptions{ + Filters: map[string]any{"library_id": libraryID3}, + }) + // Should see only jazz from library 3 + Expect(tags).To(HaveLen(1)) + Expect(tags[0].TagValue).To(Equal(tagValueJazz)) + }) + }) + + Context("Admin User with Explicit Library Filtering", func() { + It("should see all tags when no filter is applied", func() { + tags := readAllTags(&adminUser) + Expect(tags).To(HaveLen(3)) + }) + + It("should respect explicit library_id filters", func() { + tags := readAllTags(&adminUser, rest.QueryOptions{ + Filters: map[string]any{"library_id": libraryID3}, + }) + // Should see only jazz from library 3 + Expect(tags).To(HaveLen(1)) + Expect(tags[0].TagValue).To(Equal(tagValueJazz)) + }) + + It("should filter by library 2 correctly", func() { + tags := readAllTags(&adminUser, rest.QueryOptions{ + Filters: map[string]any{"library_id": libraryID2}, + }) + // Should see pop and rock from library 2 + Expect(tags).To(HaveLen(2)) + expectTagValues(tags, []string{tagValuePop, tagValueRock}) + }) + }) + }) +}) diff --git a/persistence/tag_repository.go b/persistence/tag_repository.go index d63584af0..5bb8b3832 100644 --- a/persistence/tag_repository.go +++ b/persistence/tag_repository.go @@ -7,26 +7,22 @@ import ( "time" . "github.com/Masterminds/squirrel" - "github.com/deluan/rest" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/pocketbase/dbx" ) type tagRepository struct { - sqlRepository + *baseTagRepository } func NewTagRepository(ctx context.Context, db dbx.Builder) model.TagRepository { - r := &tagRepository{} - r.ctx = ctx - r.db = db - r.tableName = "tag" - r.registerModel(&model.Tag{}, nil) - return r + return &tagRepository{ + baseTagRepository: newBaseTagRepository(ctx, db, nil), // nil = no filter, works with all tags + } } -func (r *tagRepository) Add(tags ...model.Tag) error { +func (r *tagRepository) Add(libraryID int, tags ...model.Tag) error { for chunk := range slices.Chunk(tags, 200) { sq := Insert(r.tableName).Columns("id", "tag_name", "tag_value"). Suffix("on conflict (id) do nothing") @@ -37,34 +33,42 @@ func (r *tagRepository) Add(tags ...model.Tag) error { if err != nil { return err } + + // Create library_tag entries for library filtering + libSq := Insert("library_tag").Columns("tag_id", "library_id", "album_count", "media_file_count"). + Suffix("on conflict (tag_id, library_id) do nothing") + for _, t := range chunk { + libSq = libSq.Values(t.ID, libraryID, 0, 0) + } + _, err = r.executeSQL(libSq) + if err != nil { + return fmt.Errorf("adding library_tag entries: %w", err) + } } return nil } -// UpdateCounts updates the album_count and media_file_count columns in the tag_counts table. +// UpdateCounts updates the library_tag table with per-library statistics. // Only genres are being updated for now. func (r *tagRepository) UpdateCounts() error { template := ` -with updated_values as ( - select jt.value as id, count(distinct %[1]s.id) as %[1]s_count - from %[1]s - join json_tree(tags, '$.genre') as jt - where atom is not null - and key = 'id' - group by jt.value -) -update tag -set %[1]s_count = updated_values.%[1]s_count -from updated_values -where tag.id = updated_values.id; +INSERT INTO library_tag (tag_id, library_id, %[1]s_count) +SELECT jt.value as tag_id, %[1]s.library_id, count(distinct %[1]s.id) as %[1]s_count +FROM %[1]s +JOIN json_tree(%[1]s.tags, '$.genre') as jt ON jt.atom IS NOT NULL AND jt.key = 'id' +JOIN tag ON tag.id = jt.value +GROUP BY jt.value, %[1]s.library_id +ON CONFLICT (tag_id, library_id) +DO UPDATE SET %[1]s_count = excluded.%[1]s_count; ` + for _, table := range []string{"album", "media_file"} { start := time.Now() query := Expr(fmt.Sprintf(template, table)) c, err := r.executeSQL(query) - log.Debug(r.ctx, "Updated tag counts", "table", table, "elapsed", time.Since(start), "updated", c) + log.Debug(r.ctx, "Updated library tag counts", "table", table, "elapsed", time.Since(start), "updated", c) if err != nil { - return fmt.Errorf("updating %s tag counts: %w", table, err) + return fmt.Errorf("updating %s library tag counts: %w", table, err) } } return nil @@ -74,43 +78,22 @@ func (r *tagRepository) purgeUnused() error { del := Delete(r.tableName).Where(` id not in (select jt.value from album left join json_tree(album.tags, '$') as jt + where atom is not null + and key = 'id' + UNION + select jt.value + from media_file left join json_tree(media_file.tags, '$') as jt where atom is not null and key = 'id') `) c, err := r.executeSQL(del) if err != nil { - return fmt.Errorf("error purging unused tags: %w", err) + return fmt.Errorf("error purging %s unused tags: %w", r.tableName, err) } if c > 0 { - log.Debug(r.ctx, "Purged unused tags", "totalDeleted", c) + log.Debug(r.ctx, "Purged unused tags", "totalDeleted", c, "table", r.tableName) } return err } -func (r *tagRepository) Count(options ...rest.QueryOptions) (int64, error) { - return r.count(r.newSelect(), r.parseRestOptions(r.ctx, options...)) -} - -func (r *tagRepository) Read(id string) (interface{}, error) { - query := r.newSelect().Columns("*").Where(Eq{"id": id}) - var res model.Tag - err := r.queryOne(query, &res) - return &res, err -} - -func (r *tagRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { - query := r.newSelect(r.parseRestOptions(r.ctx, options...)).Columns("*") - var res model.TagList - err := r.queryAll(query, &res) - return res, err -} - -func (r *tagRepository) EntityName() string { - return "tag" -} - -func (r *tagRepository) NewInstance() interface{} { - return model.Tag{} -} - var _ model.ResourceRepository = &tagRepository{} diff --git a/persistence/tag_repository_test.go b/persistence/tag_repository_test.go new file mode 100644 index 000000000..9a019c30e --- /dev/null +++ b/persistence/tag_repository_test.go @@ -0,0 +1,311 @@ +package persistence + +import ( + "context" + "slices" + "strings" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/pocketbase/dbx" +) + +var _ = Describe("TagRepository", func() { + var repo model.TagRepository + var restRepo model.ResourceRepository + var ctx context.Context + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = request.WithUser(log.NewContext(context.TODO()), model.User{ID: "userid", UserName: "johndoe", IsAdmin: true}) + tagRepo := NewTagRepository(ctx, GetDBXBuilder()) + repo = tagRepo + restRepo = tagRepo.(model.ResourceRepository) + + // Clean the database before each test to ensure isolation + db := GetDBXBuilder() + _, err := db.NewQuery("DELETE FROM tag").Execute() + Expect(err).ToNot(HaveOccurred()) + _, err = db.NewQuery("DELETE FROM library_tag").Execute() + Expect(err).ToNot(HaveOccurred()) + + // Ensure library 1 exists (if it doesn't already) + _, err = db.NewQuery("INSERT OR IGNORE INTO library (id, name, path, default_new_users) VALUES (1, 'Test Library', '/test', true)").Execute() + Expect(err).ToNot(HaveOccurred()) + + // Ensure the admin user has access to library 1 + _, err = db.NewQuery("INSERT OR IGNORE INTO user_library (user_id, library_id) VALUES ('userid', 1)").Execute() + Expect(err).ToNot(HaveOccurred()) + + // Add comprehensive test data that covers all test scenarios + newTag := func(name, value string) model.Tag { + return model.Tag{ID: id.NewTagID(name, value), TagName: model.TagName(name), TagValue: value} + } + + err = repo.Add(1, + // Genre tags + newTag("genre", "rock"), + newTag("genre", "pop"), + newTag("genre", "jazz"), + newTag("genre", "electronic"), + newTag("genre", "classical"), + newTag("genre", "ambient"), + newTag("genre", "techno"), + newTag("genre", "house"), + newTag("genre", "trance"), + newTag("genre", "Alternative Rock"), + newTag("genre", "Blues"), + newTag("genre", "Country"), + // Mood tags + newTag("mood", "happy"), + newTag("mood", "sad"), + newTag("mood", "energetic"), + newTag("mood", "calm"), + // Other tag types + newTag("instrument", "guitar"), + newTag("instrument", "piano"), + newTag("decade", "1980s"), + newTag("decade", "1990s"), + ) + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("Add", func() { + It("should handle adding new tags", func() { + newTag := model.Tag{ + ID: id.NewTagID("genre", "experimental"), + TagName: "genre", + TagValue: "experimental", + } + + err := repo.Add(1, newTag) + Expect(err).ToNot(HaveOccurred()) + + // Verify tag was added + result, err := restRepo.Read(newTag.ID) + Expect(err).ToNot(HaveOccurred()) + resultTag := result.(*model.Tag) + Expect(resultTag.TagValue).To(Equal("experimental")) + + // Check count increased + count, err := restRepo.Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(21))) // 20 from dataset + 1 new + }) + + It("should handle duplicate tags gracefully", func() { + // Try to add a duplicate tag + duplicateTag := model.Tag{ + ID: id.NewTagID("genre", "rock"), // This already exists + TagName: "genre", + TagValue: "rock", + } + + count, err := restRepo.Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(20))) // Still 20 tags + + err = repo.Add(1, duplicateTag) + Expect(err).ToNot(HaveOccurred()) // Should not error + + // Count should remain the same + count, err = restRepo.Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(20))) // Still 20 tags + }) + }) + + Describe("UpdateCounts", func() { + It("should update tag counts successfully", func() { + err := repo.UpdateCounts() + Expect(err).ToNot(HaveOccurred()) + }) + + It("should handle empty database gracefully", func() { + // Clear the database first + db := GetDBXBuilder() + _, err := db.NewQuery("DELETE FROM tag").Execute() + Expect(err).ToNot(HaveOccurred()) + + err = repo.UpdateCounts() + Expect(err).ToNot(HaveOccurred()) + }) + + It("should handle albums with non-existent tag IDs in JSON gracefully", func() { + // Regression test for foreign key constraint error + // Create an album with tag IDs in JSON that don't exist in tag table + db := GetDBXBuilder() + + // First, create a non-existent tag ID (this simulates tags in JSON that aren't in tag table) + nonExistentTagID := id.NewTagID("genre", "nonexistent-genre") + + // Create album with JSON containing the non-existent tag ID + albumWithBadTags := `{"genre":[{"id":"` + nonExistentTagID + `","value":"nonexistent-genre"}]}` + + // Insert album directly into database with the problematic JSON + _, err := db.NewQuery("INSERT INTO album (id, name, library_id, tags) VALUES ({:id}, {:name}, {:lib}, {:tags})"). + Bind(dbx.Params{ + "id": "test-album-bad-tags", + "name": "Album With Bad Tags", + "lib": 1, + "tags": albumWithBadTags, + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + // This should not fail with foreign key constraint error + err = repo.UpdateCounts() + Expect(err).ToNot(HaveOccurred()) + + // Cleanup + _, err = db.NewQuery("DELETE FROM album WHERE id = {:id}"). + Bind(dbx.Params{"id": "test-album-bad-tags"}).Execute() + Expect(err).ToNot(HaveOccurred()) + }) + + It("should handle media files with non-existent tag IDs in JSON gracefully", func() { + // Regression test for foreign key constraint error with media files + db := GetDBXBuilder() + + // Create a non-existent tag ID + nonExistentTagID := id.NewTagID("genre", "another-nonexistent-genre") + + // Create media file with JSON containing the non-existent tag ID + mediaFileWithBadTags := `{"genre":[{"id":"` + nonExistentTagID + `","value":"another-nonexistent-genre"}]}` + + // Insert media file directly into database with the problematic JSON + _, err := db.NewQuery("INSERT INTO media_file (id, title, library_id, tags) VALUES ({:id}, {:title}, {:lib}, {:tags})"). + Bind(dbx.Params{ + "id": "test-media-bad-tags", + "title": "Media File With Bad Tags", + "lib": 1, + "tags": mediaFileWithBadTags, + }).Execute() + Expect(err).ToNot(HaveOccurred()) + + // This should not fail with foreign key constraint error + err = repo.UpdateCounts() + Expect(err).ToNot(HaveOccurred()) + + // Cleanup + _, err = db.NewQuery("DELETE FROM media_file WHERE id = {:id}"). + Bind(dbx.Params{"id": "test-media-bad-tags"}).Execute() + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Count", func() { + It("should return correct count of tags", func() { + count, err := restRepo.Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(Equal(int64(20))) // From the test dataset + }) + }) + + Describe("Read", func() { + It("should return existing tag", func() { + rockID := id.NewTagID("genre", "rock") + result, err := restRepo.Read(rockID) + Expect(err).ToNot(HaveOccurred()) + resultTag := result.(*model.Tag) + Expect(resultTag.ID).To(Equal(rockID)) + Expect(resultTag.TagName).To(Equal(model.TagName("genre"))) + Expect(resultTag.TagValue).To(Equal("rock")) + }) + + It("should return error for non-existent tag", func() { + _, err := restRepo.Read("non-existent-id") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("ReadAll", func() { + It("should return all tags from dataset", func() { + result, err := restRepo.ReadAll() + Expect(err).ToNot(HaveOccurred()) + tags := result.(model.TagList) + Expect(tags).To(HaveLen(20)) + }) + + It("should filter tags by partial value correctly", func() { + options := rest.QueryOptions{ + Filters: map[string]any{"name": "%rock%"}, // Tags containing 'rock' + } + result, err := restRepo.ReadAll(options) + Expect(err).ToNot(HaveOccurred()) + tags := result.(model.TagList) + Expect(tags).To(HaveLen(2)) // "rock" and "Alternative Rock" + + // Verify all returned tags contain 'rock' in their value + for _, tag := range tags { + Expect(strings.ToLower(tag.TagValue)).To(ContainSubstring("rock")) + } + }) + + It("should filter tags by partial value using LIKE", func() { + options := rest.QueryOptions{ + Filters: map[string]any{"name": "%e%"}, // Tags containing 'e' + } + result, err := restRepo.ReadAll(options) + Expect(err).ToNot(HaveOccurred()) + tags := result.(model.TagList) + Expect(tags).To(HaveLen(8)) // electronic, house, trance, energetic, Blues, decade x2, Alternative Rock + + // Verify all returned tags contain 'e' in their value + for _, tag := range tags { + Expect(strings.ToLower(tag.TagValue)).To(ContainSubstring("e")) + } + }) + + It("should sort tags by value ascending", func() { + options := rest.QueryOptions{ + Filters: map[string]any{"name": "%r%"}, // Tags containing 'r' + Sort: "name", + Order: "asc", + } + result, err := restRepo.ReadAll(options) + Expect(err).ToNot(HaveOccurred()) + tags := result.(model.TagList) + Expect(tags).To(HaveLen(7)) + + Expect(slices.IsSortedFunc(tags, func(a, b model.Tag) int { + return strings.Compare(strings.ToLower(a.TagValue), strings.ToLower(b.TagValue)) + })) + }) + + It("should sort tags by value descending", func() { + options := rest.QueryOptions{ + Filters: map[string]any{"name": "%r%"}, // Tags containing 'r' + Sort: "name", + Order: "desc", + } + result, err := restRepo.ReadAll(options) + Expect(err).ToNot(HaveOccurred()) + tags := result.(model.TagList) + Expect(tags).To(HaveLen(7)) + + Expect(slices.IsSortedFunc(tags, func(a, b model.Tag) int { + return strings.Compare(strings.ToLower(b.TagValue), strings.ToLower(a.TagValue)) // Descending order + })) + }) + }) + + Describe("EntityName", func() { + It("should return correct entity name", func() { + name := restRepo.EntityName() + Expect(name).To(Equal("tag")) + }) + }) + + Describe("NewInstance", func() { + It("should return new tag instance", func() { + instance := restRepo.NewInstance() + Expect(instance).To(BeAssignableToTypeOf(model.Tag{})) + }) + }) +}) diff --git a/persistence/transcoding_repository.go b/persistence/transcoding_repository.go index bdcbe7262..96fd3efdb 100644 --- a/persistence/transcoding_repository.go +++ b/persistence/transcoding_repository.go @@ -41,7 +41,7 @@ func (r *transcodingRepository) FindByFormat(format string) (*model.Transcoding, } func (r *transcodingRepository) Put(t *model.Transcoding) error { - if !isAdmin(r.ctx) { + if !loggedUser(r.ctx).IsAdmin { return rest.ErrPermissionDenied } _, err := r.put(t.ID, t) @@ -52,27 +52,42 @@ func (r *transcodingRepository) Count(options ...rest.QueryOptions) (int64, erro return r.count(Select(), r.parseRestOptions(r.ctx, options...)) } -func (r *transcodingRepository) Read(id string) (interface{}, error) { - return r.Get(id) +func (r *transcodingRepository) Read(id string) (any, error) { + res, err := r.Get(id) + if err != nil { + return nil, err + } + if !loggedUser(r.ctx).IsAdmin { + res.Command = "" + } + return res, nil } -func (r *transcodingRepository) ReadAll(options ...rest.QueryOptions) (interface{}, error) { +func (r *transcodingRepository) ReadAll(options ...rest.QueryOptions) (any, error) { sel := r.newSelect(r.parseRestOptions(r.ctx, options...)).Columns("*") res := model.Transcodings{} err := r.queryAll(sel, &res) - return res, err + if err != nil { + return nil, err + } + if !loggedUser(r.ctx).IsAdmin { + for i := range res { + res[i].Command = "" + } + } + return res, nil } func (r *transcodingRepository) EntityName() string { return "transcoding" } -func (r *transcodingRepository) NewInstance() interface{} { +func (r *transcodingRepository) NewInstance() any { return &model.Transcoding{} } -func (r *transcodingRepository) Save(entity interface{}) (string, error) { - if !isAdmin(r.ctx) { +func (r *transcodingRepository) Save(entity any) (string, error) { + if !loggedUser(r.ctx).IsAdmin { return "", rest.ErrPermissionDenied } t := entity.(*model.Transcoding) @@ -83,8 +98,8 @@ func (r *transcodingRepository) Save(entity interface{}) (string, error) { return id, err } -func (r *transcodingRepository) Update(id string, entity interface{}, cols ...string) error { - if !isAdmin(r.ctx) { +func (r *transcodingRepository) Update(id string, entity any, cols ...string) error { + if !loggedUser(r.ctx).IsAdmin { return rest.ErrPermissionDenied } t := entity.(*model.Transcoding) @@ -97,7 +112,7 @@ func (r *transcodingRepository) Update(id string, entity interface{}, cols ...st } func (r *transcodingRepository) Delete(id string) error { - if !isAdmin(r.ctx) { + if !loggedUser(r.ctx).IsAdmin { return rest.ErrPermissionDenied } err := r.delete(Eq{"id": id}) diff --git a/persistence/transcoding_repository_test.go b/persistence/transcoding_repository_test.go index eddc5047a..73250163c 100644 --- a/persistence/transcoding_repository_test.go +++ b/persistence/transcoding_repository_test.go @@ -64,9 +64,69 @@ var _ = Describe("TranscodingRepository", func() { _, err = adminRepo.Get("to-delete") Expect(err).To(MatchError(model.ErrNotFound)) }) + + It("reads the Command field via the REST Read method", func() { + tr := &model.Transcoding{ID: "adminread", Name: "temp", TargetFormat: "test_format", DefaultBitRate: 64, Command: "ffmpeg -secret"} + Expect(adminRepo.Put(tr)).To(Succeed()) + + res, err := adminRepo.(*transcodingRepository).Read("adminread") + Expect(err).ToNot(HaveOccurred()) + Expect(res.(*model.Transcoding).Command).To(Equal("ffmpeg -secret")) + }) }) Describe("Regular User", func() { + It("reads a transcoding but with the Command field redacted", func() { + tr := &model.Transcoding{ID: "readreg", Name: "temp", TargetFormat: "test_format", DefaultBitRate: 64, Command: "ffmpeg -secret"} + Expect(adminRepo.Put(tr)).To(Succeed()) + + res, err := repo.(*transcodingRepository).Read("readreg") + Expect(err).ToNot(HaveOccurred()) + t := res.(*model.Transcoding) + Expect(t.Name).To(Equal("temp")) + Expect(t.TargetFormat).To(Equal("test_format")) + Expect(t.Command).To(BeEmpty()) + }) + + It("lists transcodings but with the Command field redacted", func() { + tr := &model.Transcoding{ID: "listreg", Name: "temp", TargetFormat: "test_format", DefaultBitRate: 64, Command: "ffmpeg -secret"} + Expect(adminRepo.Put(tr)).To(Succeed()) + + res, err := repo.(*transcodingRepository).ReadAll() + Expect(err).ToNot(HaveOccurred()) + list := res.(model.Transcodings) + Expect(list).ToNot(BeEmpty()) + for _, t := range list { + Expect(t.Command).To(BeEmpty()) + } + }) + + It("counts transcodings", func() { + count, err := repo.(*transcodingRepository).Count() + Expect(err).ToNot(HaveOccurred()) + Expect(count).To(BeNumerically(">=", 0)) + }) + + It("can still resolve a transcoding for streaming via Get (Command not redacted)", func() { + tr := &model.Transcoding{ID: "streamreg", Name: "temp", TargetFormat: "test_format", DefaultBitRate: 64, Command: "ffmpeg -secret"} + Expect(adminRepo.Put(tr)).To(Succeed()) + + res, err := repo.Get("streamreg") + Expect(err).ToNot(HaveOccurred()) + Expect(res.ID).To(Equal("streamreg")) + Expect(res.Command).To(Equal("ffmpeg -secret")) + }) + + It("can still resolve a transcoding for streaming via FindByFormat (Command not redacted)", func() { + tr := &model.Transcoding{ID: "fmtreg", Name: "temp", TargetFormat: "test_format", DefaultBitRate: 64, Command: "ffmpeg -secret"} + Expect(adminRepo.Put(tr)).To(Succeed()) + + res, err := repo.FindByFormat("test_format") + Expect(err).ToNot(HaveOccurred()) + Expect(res.ID).To(Equal("fmtreg")) + Expect(res.Command).To(Equal("ffmpeg -secret")) + }) + It("fails to create", func() { err := repo.Put(&model.Transcoding{ID: "bad", Name: "bad", TargetFormat: "test_format", DefaultBitRate: 64, Command: "ffmpeg"}) Expect(err).To(Equal(rest.ErrPermissionDenied)) diff --git a/persistence/user_repository.go b/persistence/user_repository.go index 073e32963..9decff4e5 100644 --- a/persistence/user_repository.go +++ b/persistence/user_repository.go @@ -3,6 +3,7 @@ package persistence import ( "context" "crypto/sha256" + "encoding/json" "errors" "fmt" "strings" @@ -17,6 +18,7 @@ import ( "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/utils" + "github.com/navidrome/navidrome/utils/slice" "github.com/pocketbase/dbx" ) @@ -24,6 +26,26 @@ type userRepository struct { sqlRepository } +type dbUser struct { + *model.User `structs:",flatten"` + LibrariesJSON string `structs:"-" json:"-"` +} + +func (u *dbUser) PostScan() error { + if u.LibrariesJSON != "" { + if err := json.Unmarshal([]byte(u.LibrariesJSON), &u.User.Libraries); err != nil { + return fmt.Errorf("parsing user libraries from db: %w", err) + } + } + return nil +} + +type dbUsers []dbUser + +func (us dbUsers) toModels() model.Users { + return slice.Map(us, func(u dbUser) model.User { return *u.User }) +} + var ( once sync.Once encKey []byte @@ -33,8 +55,11 @@ func NewUserRepository(ctx context.Context, db dbx.Builder) model.UserRepository r := &userRepository{} r.ctx = ctx r.db = db + r.tableName = "user" r.registerModel(&model.User{}, map[string]filterFunc{ + "id": idFilter(r.tableName), "password": invalidFilter(ctx), + "name": startsWithFilter(r.tableName + ".name"), }) once.Do(func() { _ = r.initPasswordEncryptionKey() @@ -42,28 +67,48 @@ func NewUserRepository(ctx context.Context, db dbx.Builder) model.UserRepository return r } +// selectUserWithLibraries returns a SelectBuilder that includes library information +func (r *userRepository) selectUserWithLibraries(options ...model.QueryOptions) SelectBuilder { + return r.newSelect(options...). + Columns(`user.*`, + `COALESCE(json_group_array(json_object( + 'id', library.id, + 'name', library.name, + 'path', library.path, + 'remote_path', library.remote_path, + 'last_scan_at', library.last_scan_at, + 'last_scan_started_at', library.last_scan_started_at, + 'full_scan_in_progress', library.full_scan_in_progress, + 'updated_at', library.updated_at, + 'created_at', library.created_at + )) FILTER (WHERE library.id IS NOT NULL), '[]') AS libraries_json`). + LeftJoin("user_library ul ON user.id = ul.user_id"). + LeftJoin("library ON ul.library_id = library.id"). + GroupBy("user.id") +} + func (r *userRepository) CountAll(qo ...model.QueryOptions) (int64, error) { return r.count(Select(), qo...) } func (r *userRepository) Get(id string) (*model.User, error) { - sel := r.newSelect().Columns("*").Where(Eq{"id": id}) - var res model.User + sel := r.selectUserWithLibraries().Where(Eq{"user.id": id}) + var res dbUser err := r.queryOne(sel, &res) if err != nil { return nil, err } - return &res, nil + return res.User, nil } func (r *userRepository) GetAll(options ...model.QueryOptions) (model.Users, error) { - sel := r.newSelect(options...).Columns("*") - res := model.Users{} + sel := r.selectUserWithLibraries(options...) + var res dbUsers err := r.queryAll(sel, &res) if err != nil { return nil, err } - return res, nil + return res.toModels(), nil } func (r *userRepository) Put(u *model.User) error { @@ -79,38 +124,65 @@ func (r *userRepository) Put(u *model.User) error { return fmt.Errorf("error converting user to SQL args: %w", err) } delete(values, "current_password") + + // Save/update the user update := Update(r.tableName).Where(Eq{"id": u.ID}).SetMap(values) count, err := r.executeSQL(update) if err != nil { return err } - if count > 0 { - return nil + + isNewUser := count == 0 + if isNewUser { + values["created_at"] = time.Now() + insert := Insert(r.tableName).SetMap(values) + _, err = r.executeSQL(insert) + if err != nil { + return err + } } - values["created_at"] = time.Now() - insert := Insert(r.tableName).SetMap(values) - _, err = r.executeSQL(insert) - return err + + // Auto-assign all libraries to admin users in a single SQL operation + if u.IsAdmin { + sql := Expr( + "INSERT OR IGNORE INTO user_library (user_id, library_id) SELECT ?, id FROM library", + u.ID, + ) + if _, err := r.executeSQL(sql); err != nil { + return fmt.Errorf("failed to assign all libraries to admin user: %w", err) + } + } else if isNewUser { // Only for new regular users + // Auto-assign default libraries to new regular users + sql := Expr( + "INSERT OR IGNORE INTO user_library (user_id, library_id) SELECT ?, id FROM library WHERE default_new_users = true", + u.ID, + ) + if _, err := r.executeSQL(sql); err != nil { + return fmt.Errorf("failed to assign default libraries to new user: %w", err) + } + } + + return nil } func (r *userRepository) FindFirstAdmin() (*model.User, error) { - sel := r.newSelect(model.QueryOptions{Sort: "updated_at", Max: 1}).Columns("*").Where(Eq{"is_admin": true}) - var usr model.User + sel := r.selectUserWithLibraries(model.QueryOptions{Sort: "updated_at", Max: 1}).Where(Eq{"user.is_admin": true}) + var usr dbUser err := r.queryOne(sel, &usr) if err != nil { return nil, err } - return &usr, nil + return usr.User, nil } func (r *userRepository) FindByUsername(username string) (*model.User, error) { - sel := r.newSelect().Columns("*").Where(Expr("user_name = ? COLLATE NOCASE", username)) - var usr model.User + sel := r.selectUserWithLibraries().Where(Expr("user.user_name = ? COLLATE NOCASE", username)) + var usr dbUser err := r.queryOne(sel, &usr) if err != nil { return nil, err } - return &usr, nil + return usr.User, nil } func (r *userRepository) FindByUsernameWithPassword(username string) (*model.User, error) { @@ -268,7 +340,15 @@ func (r *userRepository) Delete(id string) error { if errors.Is(err, model.ErrNotFound) { return rest.ErrNotFound } - return err + if err != nil { + return err + } + + // Clean up orphaned plugin references for the deleted user + if err := cleanupPluginUserReferences(r.db, id); err != nil { + log.Error(r.ctx, "Failed to cleanup plugin user references", "userID", id, err) + } + return nil } func keyTo32Bytes(input string) []byte { @@ -365,6 +445,39 @@ func (r *userRepository) decryptAllPasswords(users model.Users) error { return nil } +// Library association methods + +func (r *userRepository) GetUserLibraries(userID string) (model.Libraries, error) { + sel := Select("l.*"). + From("library l"). + Join("user_library ul ON l.id = ul.library_id"). + Where(Eq{"ul.user_id": userID}). + OrderBy("l.name") + + var res model.Libraries + err := r.queryAll(sel, &res) + return res, err +} + +func (r *userRepository) SetUserLibraries(userID string, libraryIDs []int) error { + // Remove existing associations + delSql := Delete("user_library").Where(Eq{"user_id": userID}) + if _, err := r.executeSQL(delSql); err != nil { + return err + } + + // Add new associations + if len(libraryIDs) > 0 { + insert := Insert("user_library").Columns("user_id", "library_id") + for _, libID := range libraryIDs { + insert = insert.Values(userID, libID) + } + _, err := r.executeSQL(insert) + return err + } + return nil +} + var _ model.UserRepository = (*userRepository)(nil) var _ rest.Repository = (*userRepository)(nil) var _ rest.Persistable = (*userRepository)(nil) diff --git a/persistence/user_repository_test.go b/persistence/user_repository_test.go index 7b1ad79d7..6f8ab9161 100644 --- a/persistence/user_repository_test.go +++ b/persistence/user_repository_test.go @@ -3,12 +3,15 @@ package persistence import ( "context" "errors" + "slices" + "github.com/Masterminds/squirrel" "github.com/deluan/rest" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -18,7 +21,7 @@ var _ = Describe("UserRepository", func() { var repo model.UserRepository BeforeEach(func() { - repo = NewUserRepository(log.NewContext(context.TODO()), GetDBXBuilder()) + repo = NewUserRepository(log.NewContext(GinkgoT().Context()), GetDBXBuilder()) }) Describe("Put/Get/FindByUsername", func() { @@ -79,7 +82,7 @@ var _ = Describe("UserRepository", func() { It("does nothing if passwords are not specified", func() { user := &model.User{ID: "2", UserName: "johndoe"} err := validatePasswordChange(user, loggedUser) - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) }) Context("Autogenerated password (used with Reverse Proxy Authentication)", func() { @@ -91,7 +94,7 @@ var _ = Describe("UserRepository", func() { It("does nothing if passwords are not specified", func() { user = *loggedUser err := validatePasswordChange(&user, loggedUser) - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) }) It("does not requires currentPassword for regular user", func() { user = *loggedUser @@ -118,7 +121,7 @@ var _ = Describe("UserRepository", func() { user := &model.User{ID: "2", UserName: "johndoe"} user.NewPassword = "new" err := validatePasswordChange(user, loggedUser) - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) }) It("requires currentPassword to change its own", func() { user := *loggedUser @@ -156,7 +159,7 @@ var _ = Describe("UserRepository", func() { user.CurrentPassword = "abc123" user.NewPassword = "new" err := validatePasswordChange(&user, loggedUser) - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) }) }) @@ -200,10 +203,57 @@ var _ = Describe("UserRepository", func() { user.CurrentPassword = "abc123" user.NewPassword = "new" err := validatePasswordChange(&user, loggedUser) - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) }) }) }) + + Describe("ReadAll name filter", func() { + var adminRepo model.ResourceRepository + + BeforeEach(func() { + adminCtx := request.WithUser(GinkgoT().Context(), model.User{ID: "admin-id", UserName: "admin", IsAdmin: true}) + adminRepo = NewUserRepository(adminCtx, GetDBXBuilder()).(model.ResourceRepository) + + for _, u := range []model.User{ + {ID: "filter-alice", UserName: "alice_filter", Name: "Alice Filter", NewPassword: "x"}, + {ID: "filter-bob", UserName: "bob_filter", Name: "Bob Filter", NewPassword: "x"}, + } { + Expect(adminRepo.(model.UserRepository).Put(&u)).To(Succeed()) + } + }) + + AfterEach(func() { + ur := adminRepo.(model.UserRepository) + _ = ur.Delete("filter-alice") + _ = ur.Delete("filter-bob") + }) + + It("matches users whose name starts with the given prefix", func() { + res, err := adminRepo.ReadAll(rest.QueryOptions{Filters: map[string]any{"name": "Alice"}}) + Expect(err).ToNot(HaveOccurred()) + users := res.(model.Users) + + var names []string + for _, u := range users { + names = append(names, u.Name) + } + Expect(names).To(ContainElement("Alice Filter")) + Expect(names).ToNot(ContainElement("Bob Filter")) + }) + + It("does not match names by mid-string substring (startsWith, not contains)", func() { + res, err := adminRepo.ReadAll(rest.QueryOptions{Filters: map[string]any{"name": "Filter"}}) + Expect(err).ToNot(HaveOccurred()) + users := res.(model.Users) + + for _, u := range users { + Expect(u.ID).ToNot(Or(Equal("filter-alice"), Equal("filter-bob")), + "a mid-string substring should not match a startsWith filter") + } + }) + }) + Describe("validateUsernameUnique", func() { var repo *tests.MockedUserRepo var existingUser *model.User @@ -235,4 +285,336 @@ var _ = Describe("UserRepository", func() { Expect(err).To(MatchError("fake error")) }) }) + + Describe("Library Association Methods", func() { + var userID string + var library1, library2 model.Library + + BeforeEach(func() { + // Create a test user first to satisfy foreign key constraints + testUser := model.User{ + ID: "test-user-id", + UserName: "testuser", + Name: "Test User", + Email: "test@example.com", + NewPassword: "password", + IsAdmin: false, + } + Expect(repo.Put(&testUser)).To(BeNil()) + userID = testUser.ID + + library1 = model.Library{ID: 0, Name: "Library 500", Path: "/path/500"} + library2 = model.Library{ID: 0, Name: "Library 501", Path: "/path/501"} + + // Create test libraries + libRepo := NewLibraryRepository(log.NewContext(context.TODO()), GetDBXBuilder()) + Expect(libRepo.Put(&library1)).To(BeNil()) + Expect(libRepo.Put(&library2)).To(BeNil()) + }) + + AfterEach(func() { + // Clean up user-library associations to ensure test isolation + _ = repo.SetUserLibraries(userID, []int{}) + + // Clean up test libraries to ensure isolation between test groups + libRepo := NewLibraryRepository(log.NewContext(context.TODO()), GetDBXBuilder()) + _ = libRepo.(*libraryRepository).delete(squirrel.Eq{"id": []int{library1.ID, library2.ID}}) + }) + + Describe("GetUserLibraries", func() { + It("returns empty list when user has no library associations", func() { + libraries, err := repo.GetUserLibraries("non-existent-user") + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(0)) + }) + + It("returns user's associated libraries", func() { + err := repo.SetUserLibraries(userID, []int{library1.ID, library2.ID}) + Expect(err).ToNot(HaveOccurred()) + + libraries, err := repo.GetUserLibraries(userID) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(2)) + + libIDs := []int{libraries[0].ID, libraries[1].ID} + Expect(libIDs).To(ContainElements(library1.ID, library2.ID)) + }) + }) + + Describe("SetUserLibraries", func() { + It("sets user's library associations", func() { + libraryIDs := []int{library1.ID, library2.ID} + err := repo.SetUserLibraries(userID, libraryIDs) + Expect(err).ToNot(HaveOccurred()) + + libraries, err := repo.GetUserLibraries(userID) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(2)) + }) + + It("replaces existing associations", func() { + // Set initial associations + err := repo.SetUserLibraries(userID, []int{library1.ID, library2.ID}) + Expect(err).ToNot(HaveOccurred()) + + // Replace with just one library + err = repo.SetUserLibraries(userID, []int{library1.ID}) + Expect(err).ToNot(HaveOccurred()) + + libraries, err := repo.GetUserLibraries(userID) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(1)) + Expect(libraries[0].ID).To(Equal(library1.ID)) + }) + + It("removes all associations when passed empty slice", func() { + // Set initial associations + err := repo.SetUserLibraries(userID, []int{library1.ID, library2.ID}) + Expect(err).ToNot(HaveOccurred()) + + // Remove all + err = repo.SetUserLibraries(userID, []int{}) + Expect(err).ToNot(HaveOccurred()) + + libraries, err := repo.GetUserLibraries(userID) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(0)) + }) + }) + }) + + Describe("Admin User Auto-Assignment", func() { + var ( + libRepo model.LibraryRepository + library1 model.Library + library2 model.Library + initialLibCount int + ) + + BeforeEach(func() { + libRepo = NewLibraryRepository(log.NewContext(context.TODO()), GetDBXBuilder()) + + // Count initial libraries + existingLibs, err := libRepo.GetAll() + Expect(err).ToNot(HaveOccurred()) + initialLibCount = len(existingLibs) + + library1 = model.Library{ID: 0, Name: "Admin Test Library 1", Path: "/admin/test/path1"} + library2 = model.Library{ID: 0, Name: "Admin Test Library 2", Path: "/admin/test/path2"} + + // Create test libraries + Expect(libRepo.Put(&library1)).To(BeNil()) + Expect(libRepo.Put(&library2)).To(BeNil()) + }) + + AfterEach(func() { + // Clean up test libraries and their associations + _ = libRepo.(*libraryRepository).delete(squirrel.Eq{"id": []int{library1.ID, library2.ID}}) + + // Clean up user-library associations for these test libraries + _, _ = repo.(*userRepository).executeSQL(squirrel.Delete("user_library").Where(squirrel.Eq{"library_id": []int{library1.ID, library2.ID}})) + }) + + It("automatically assigns all libraries to admin users when created", func() { + adminUser := model.User{ + ID: "admin-user-id-1", + UserName: "adminuser1", + Name: "Admin User", + Email: "admin1@example.com", + NewPassword: "password", + IsAdmin: true, + } + + err := repo.Put(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + // Admin should automatically have access to all libraries (including existing ones) + libraries, err := repo.GetUserLibraries(adminUser.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(initialLibCount + 2)) // Initial libraries + our 2 test libraries + + libIDs := make([]int, len(libraries)) + for i, lib := range libraries { + libIDs[i] = lib.ID + } + Expect(libIDs).To(ContainElements(library1.ID, library2.ID)) + }) + + It("automatically assigns all libraries to admin users when updated", func() { + // Create regular user first + regularUser := model.User{ + ID: "regular-user-id-1", + UserName: "regularuser1", + Name: "Regular User", + Email: "regular1@example.com", + NewPassword: "password", + IsAdmin: false, + } + + err := repo.Put(®ularUser) + Expect(err).ToNot(HaveOccurred()) + + // Give them access to just one library + err = repo.SetUserLibraries(regularUser.ID, []int{library1.ID}) + Expect(err).ToNot(HaveOccurred()) + + // Promote to admin + regularUser.IsAdmin = true + err = repo.Put(®ularUser) + Expect(err).ToNot(HaveOccurred()) + + // Should now have access to all libraries (including existing ones) + libraries, err := repo.GetUserLibraries(regularUser.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(initialLibCount + 2)) // Initial libraries + our 2 test libraries + + libIDs := make([]int, len(libraries)) + for i, lib := range libraries { + libIDs[i] = lib.ID + } + // Should include our test libraries plus all existing ones + Expect(libIDs).To(ContainElements(library1.ID, library2.ID)) + }) + + It("assigns default libraries to regular users", func() { + regularUser := model.User{ + ID: "regular-user-id-2", + UserName: "regularuser2", + Name: "Regular User", + Email: "regular2@example.com", + NewPassword: "password", + IsAdmin: false, + } + + err := repo.Put(®ularUser) + Expect(err).ToNot(HaveOccurred()) + + // Regular user should be assigned to default libraries (library ID 1 from migration) + libraries, err := repo.GetUserLibraries(regularUser.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(1)) + Expect(libraries[0].ID).To(Equal(1)) + Expect(libraries[0].DefaultNewUsers).To(BeTrue()) + }) + }) + + Describe("Libraries Field Population", func() { + var ( + libRepo model.LibraryRepository + library1 model.Library + library2 model.Library + testUser model.User + ) + + BeforeEach(func() { + libRepo = NewLibraryRepository(log.NewContext(context.TODO()), GetDBXBuilder()) + library1 = model.Library{ID: 0, Name: "Field Test Library 1", Path: "/field/test/path1"} + library2 = model.Library{ID: 0, Name: "Field Test Library 2", Path: "/field/test/path2"} + + // Create test libraries + Expect(libRepo.Put(&library1)).To(BeNil()) + Expect(libRepo.Put(&library2)).To(BeNil()) + + // Create test user + testUser = model.User{ + ID: "field-test-user", + UserName: "fieldtestuser", + Name: "Field Test User", + Email: "fieldtest@example.com", + NewPassword: "password", + IsAdmin: false, + } + Expect(repo.Put(&testUser)).To(BeNil()) + + // Assign libraries to user + Expect(repo.SetUserLibraries(testUser.ID, []int{library1.ID, library2.ID})).To(BeNil()) + }) + + AfterEach(func() { + // Clean up test libraries and their associations + _ = libRepo.(*libraryRepository).delete(squirrel.Eq{"id": []int{library1.ID, library2.ID}}) + _ = repo.(*userRepository).delete(squirrel.Eq{"id": testUser.ID}) + + // Clean up user-library associations for these test libraries + _, _ = repo.(*userRepository).executeSQL(squirrel.Delete("user_library").Where(squirrel.Eq{"library_id": []int{library1.ID, library2.ID}})) + }) + + It("populates Libraries field when getting a single user", func() { + user, err := repo.Get(testUser.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(user.Libraries).To(HaveLen(2)) + + libIDs := []int{user.Libraries[0].ID, user.Libraries[1].ID} + Expect(libIDs).To(ContainElements(library1.ID, library2.ID)) + + // Check that library details are properly populated + for _, lib := range user.Libraries { + switch lib.ID { + case library1.ID: + Expect(lib.Name).To(Equal("Field Test Library 1")) + Expect(lib.Path).To(Equal("/field/test/path1")) + case library2.ID: + Expect(lib.Name).To(Equal("Field Test Library 2")) + Expect(lib.Path).To(Equal("/field/test/path2")) + } + } + }) + + It("populates Libraries field when getting all users", func() { + users, err := repo.(*userRepository).GetAll() + Expect(err).ToNot(HaveOccurred()) + + // Find our test user in the results + found := slices.IndexFunc(users, func(u model.User) bool { return u.ID == testUser.ID }) + Expect(found).ToNot(Equal(-1)) + + foundUser := users[found] + Expect(foundUser).ToNot(BeNil()) + Expect(foundUser.Libraries).To(HaveLen(2)) + + libIDs := []int{foundUser.Libraries[0].ID, foundUser.Libraries[1].ID} + Expect(libIDs).To(ContainElements(library1.ID, library2.ID)) + }) + + It("populates Libraries field when finding user by username", func() { + user, err := repo.FindByUsername(testUser.UserName) + Expect(err).ToNot(HaveOccurred()) + Expect(user.Libraries).To(HaveLen(2)) + + libIDs := []int{user.Libraries[0].ID, user.Libraries[1].ID} + Expect(libIDs).To(ContainElements(library1.ID, library2.ID)) + }) + + It("returns default Libraries array for new regular users", func() { + // Create a user with no explicit library associations - should get default libraries + userWithoutLibs := model.User{ + ID: "no-libs-user", + UserName: "nolibsuser", + Name: "No Libs User", + Email: "nolibs@example.com", + NewPassword: "password", + IsAdmin: false, + } + Expect(repo.Put(&userWithoutLibs)).To(BeNil()) + defer func() { _ = repo.(*userRepository).delete(squirrel.Eq{"id": userWithoutLibs.ID}) }() + + user, err := repo.Get(userWithoutLibs.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(user.Libraries).ToNot(BeNil()) + // Regular users should be assigned to default libraries (library ID 1 from migration) + Expect(user.Libraries).To(HaveLen(1)) + Expect(user.Libraries[0].ID).To(Equal(1)) + }) + }) + + Describe("filters", func() { + It("qualifies id filter with table name", func() { + r := repo.(*userRepository) + qo := r.parseRestOptions(r.ctx, rest.QueryOptions{Filters: map[string]any{"id": "123"}}) + sel := r.selectUserWithLibraries(qo) + query, _, err := r.toSQL(sel) + Expect(err).NotTo(HaveOccurred()) + Expect(query).To(ContainSubstring("user.id = {:p0}")) + }) + }) }) diff --git a/plugins/.gitignore b/plugins/.gitignore new file mode 100644 index 000000000..5026985e6 --- /dev/null +++ b/plugins/.gitignore @@ -0,0 +1,4 @@ +# Rust build artifacts +# Cargo.lock is not needed for library crates (this is a cdylib) +Cargo.lock +target \ No newline at end of file diff --git a/plugins/README.md b/plugins/README.md new file mode 100644 index 000000000..048cf549d --- /dev/null +++ b/plugins/README.md @@ -0,0 +1,1106 @@ +# Navidrome Plugin System + +Navidrome supports WebAssembly (Wasm) plugins for extending functionality. Plugins run in a secure sandbox and can provide metadata agents, scrobblers, lyrics providers, audio similarity, and other integrations through host services like scheduling, caching, task queues, WebSockets, and Subsonic API access. + +The plugin system is built on **[Extism](https://extism.org/)**, a cross-language framework for building WebAssembly plugins. You can write plugins in any language that Extism supports (Go, Rust, Python, TypeScript, and more) using their Plugin Development Kits (PDKs). + +**Essential Extism Resources:** +- [Extism Documentation](https://extism.org/docs/overview) – Core concepts and architecture +- [Plugin Development Kits (PDKs)](https://extism.org/docs/concepts/pdk) – Language-specific libraries for writing plugins +- [Go PDK](https://github.com/extism/go-pdk) – Recommended for Go plugins with TinyGo +- [Rust PDK](https://github.com/extism/rust-pdk) – For Rust plugins +- [Python PDK](https://github.com/extism/python-pdk) – Experimental Python support +- [JavaScript PDK](https://github.com/extism/js-pdk) – For TypeScript/JavaScript plugins + +## Table of Contents + +- [Quick Start](#quick-start) +- [Plugin Basics](#plugin-basics) +- [Capabilities](#capabilities) + - [MetadataAgent](#metadataagent) + - [Scrobbler](#scrobbler) + - [Lyrics](#lyrics) + - [SonicSimilarity](#sonicsimilarity) + - [TaskWorker](#taskworker) + - [Lifecycle](#lifecycle) + - [SchedulerCallback](#schedulercallback) + - [WebSocketCallback](#websocketcallback) +- [Host Services](#host-services) + - [HTTP](#http) + - [Scheduler](#scheduler) + - [Cache](#cache) + - [KVStore](#kvstore) + - [Task](#task) + - [WebSocket](#websocket) + - [Library](#library) + - [Artwork](#artwork) + - [SubsonicAPI](#subsonicapi) + - [Config](#config) + - [Users](#users) +- [Configuration](#configuration) +- [Building Plugins](#building-plugins) +- [Examples](#examples) +- [Security](#security) + +--- + +## Quick Start + +### 1. Create a minimal plugin + +Create `main.go`: + +```go +package main + +import "github.com/extism/go-pdk" + +func main() {} + +// Implement your capability functions here +``` + +Create `manifest.json`: + +```json +{ + "name": "My Plugin", + "author": "Your Name", + "version": "1.0.0" +} +``` + +### 2. Build with TinyGo and package as .ndp + +```bash +# Compile to WebAssembly +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . + +# Package as .ndp (zip archive) +zip -j my-plugin.ndp manifest.json plugin.wasm +``` + +### 3. Install + +Copy `my-plugin.ndp` to your Navidrome plugins folder and enable plugins in your config: + +```toml +[Plugins] +Enabled = true +Folder = "/path/to/plugins" +``` + +--- + +## Plugin Basics + +### What is a Plugin? + +A Navidrome plugin is an `.ndp` package file (zip archive) containing: + +1. **`manifest.json`** – Plugin metadata (name, author, version, permissions) +2. **`plugin.wasm`** – Compiled WebAssembly module with capability functions + +### Plugin Naming + +Plugins are identified by their **filename** (without `.ndp` extension), not the manifest `name` field: + +- `my-plugin.ndp` → plugin ID is `my-plugin` +- The manifest `name` is the display name shown in the UI + +This allows users to have multiple instances of the same plugin with different configs by renaming the files. + +### The Manifest + +Every plugin must include a `manifest.json` file. Example: + +```json +{ + "name": "My Plugin", + "author": "Author Name", + "version": "1.0.0", + "description": "What this plugin does", + "website": "https://example.com", + "config": { + "schema": { ... }, + "uiSchema": { ... } + }, + "permissions": { + "http": { + "reason": "Fetch metadata from external API", + "requiredHosts": ["api.example.com", "*.musicbrainz.org"] + } + } +} +``` + +**Required fields:** `name`, `author`, `version` + +**Optional fields:** `description`, `website`, `config`, `permissions`, `experimental` + +#### Config Definition + +The `config` field defines the plugin's configuration schema using [JSON Schema (draft-07)](https://json-schema.org/) and an optional [JSONForms](https://jsonforms.io/) UI schema for rendering in the Navidrome web UI: + +```json +{ + "config": { + "schema": { + "type": "object", + "properties": { + "api_key": { "type": "string", "title": "API Key" }, + "max_retries": { "type": "integer", "default": 3 } + }, + "required": ["api_key"] + }, + "uiSchema": { + "api_key": { "ui:widget": "password" } + } + } +} +``` + +#### Experimental Features + +Plugins can opt-in to experimental WebAssembly features that may change or be removed in future versions. Currently supported: + +- **`threads`** – Enables WebAssembly threads support (for plugins compiled with multi-threading) + +```json +{ + "experimental": { + "threads": { + "reason": "Required for concurrent audio processing" + } + } +} +``` + +> **Note:** Experimental features may have compatibility or performance implications. Use only when necessary. + +--- + +## Capabilities + +Capabilities define what your plugin can do. They're automatically detected based on which functions you export. A plugin can implement multiple capabilities. + +### MetadataAgent + +Provides artist and album metadata. All methods are **optional** — implement only the ones your data source supports. + +| Function | Input | Output | Description | +|-----------------------------------|----------------------------|----------------------------------|--------------------------| +| `nd_get_artist_mbid` | `{id, name}` | `{mbid}` | Get MusicBrainz ID | +| `nd_get_artist_url` | `{id, name, mbid?}` | `{url}` | Get artist URL | +| `nd_get_artist_biography` | `{id, name, mbid?}` | `{biography}` | Get artist biography | +| `nd_get_similar_artists` | `{id, name, mbid?, limit}` | `{artists: [{name, mbid?}]}` | Get similar artists | +| `nd_get_artist_images` | `{id, name, mbid?}` | `{images: [{url, size}]}` | Get artist images | +| `nd_get_artist_top_songs` | `{id, name, mbid?, count}` | `{songs: [{name, mbid?}]}` | Get top songs | +| `nd_get_album_info` | `{name, artist, mbid?}` | `{name, mbid, description, url}` | Get album info | +| `nd_get_album_images` | `{name, artist, mbid?}` | `{images: [{url, size}]}` | Get album images | +| `nd_get_similar_songs_by_track` | `{id, name, artist, ...}` | `{songs: [{name, artist}]}` | Similar songs by track | +| `nd_get_similar_songs_by_album` | `{id, name, artist, ...}` | `{songs: [{name, artist}]}` | Similar songs by album | +| `nd_get_similar_songs_by_artist` | `{id, name, mbid?, count}` | `{songs: [{name, artist}]}` | Similar songs by artist | + +To use the plugin as a metadata agent, add it to your config: + +```toml +Agents = "lastfm,spotify,my-plugin" +``` + +**Example (using Go PDK package):** + +```go +package main + +import "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + +type myPlugin struct{} + +func (p *myPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{Biography: "Biography text..."}, nil +} + +func init() { metadata.Register(&myPlugin{}) } +func main() {} +``` + +**Example (raw wasmexport):** + +```go +//go:wasmexport nd_get_artist_biography +func ndGetArtistBiography() int32 { + var input ArtistInput + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return 1 + } + pdk.OutputJSON(BiographyOutput{Biography: "Artist biography..."}) + return 0 +} +``` + +### Scrobbler + +Integrates with external scrobbling services. All three methods are **required**. + +| Function | Input | Output | Description | +|------------------------------|-----------------------|--------|-----------------------------| +| `nd_scrobbler_is_authorized` | `{username}` | `bool` | Check if user is authorized | +| `nd_scrobbler_now_playing` | See below | (none) | Send now playing | +| `nd_scrobbler_scrobble` | See below | (none) | Submit a scrobble | + +> **Important:** Scrobbler plugins require the `users` permission in their manifest. Scrobble events are only sent for users assigned to the plugin through Navidrome's configuration. + +**Manifest permission:** + +```json +{ + "permissions": { + "users": { + "reason": "Receive scrobble events for users assigned to this plugin" + } + } +} +``` + +**NowPlaying/Scrobble Input:** + +```json +{ + "username": "john", + "track": { + "id": "track-id", + "title": "Song Title", + "album": "Album Name", + "artist": "Artist Name", + "albumArtist": "Album Artist", + "duration": 180.5, + "trackNumber": 1, + "discNumber": 1, + "mbzRecordingId": "...", + "mbzAlbumId": "...", + "mbzArtistId": "..." + }, + "timestamp": 1703270400 +} +``` + +**Error Handling:** + +On success, return `0`. On failure, use `pdk.SetError()` with one of these error types: + +- `scrobbler(not_authorized)` – User needs to re-authorize +- `scrobbler(retry_later)` – Temporary failure, Navidrome will retry +- `scrobbler(unrecoverable)` – Permanent failure, scrobble discarded + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/scrobbler" + +return scrobbler.ScrobblerErrorNotAuthorized +return scrobbler.ScrobblerErrorRetryLater +return scrobbler.ScrobblerErrorUnrecoverable +``` + +### Lyrics + +Provides lyrics for tracks. The single method is **required**. + +| Function | Input | Output | Description | +|-------------------------|-------------------------------|------------------------------------|-----------------| +| `nd_lyrics_get_lyrics` | `{artistName, title, ...}` | `{lyrics: [{lang, text}]}` | Get lyrics | + +Each returned lyric entry has a `lang` (language code) and `text` field. Multiple entries can be returned for different languages. + +### SonicSimilarity + +Audio-similarity discovery based on acoustic features (e.g., embeddings). Both methods are **required**. + +| Function | Input | Output | Description | +|---------------------------------|----------------------------------|--------------------------------------------|---------------------------------------| +| `nd_get_sonic_similar_tracks` | `{song, count}` | `{matches: [{song, similarity}]}` | Find acoustically similar tracks | +| `nd_find_sonic_path` | `{startSong, endSong, count}` | `{matches: [{song, similarity}]}` | Find a path between two songs | + +Each match contains a `song` reference and a `similarity` score (float64, 0.0–1.0). + +### TaskWorker + +Processes tasks from a queue. The method is **optional** — export it if your plugin uses the [Task](#task) host service for background work. + +| Function | Input | Output | Description | +|---------------------|---------------------------------------------|---------|----------------------| +| `nd_task_execute` | `{queueName, taskID, payload, attempt}` | `string`| Execute a queued task| + +The `payload` is raw bytes (the same bytes passed to `TaskEnqueue`). The `attempt` counter starts at 1 and increments on retries. Return a string result on success. + +### Lifecycle + +Optional initialization callback. Called once after the plugin fully loads. + +| Function | Input | Output | Description | +|--------------|-------|------------|--------------------------------| +| `nd_on_init` | `{}` | `{error?}` | Called once after plugin loads | + +Useful for initializing connections, scheduling recurring tasks, etc. Errors are logged but don't prevent the plugin from loading. + +### SchedulerCallback + +Receives scheduled task events. **Required** if your plugin uses the [Scheduler](#scheduler) host service. + +| Function | Input | Output | Description | +|---------------------------|----------------------------------------------|--------|-----------------------------| +| `nd_scheduler_callback` | `{scheduleId, payload, isRecurring}` | (none) | Handle scheduled task event | + +### WebSocketCallback + +Receives WebSocket events. Export any subset of these to handle events from the [WebSocket](#websocket) host service. + +| Function | Input | Description | +|----------------------------------|---------------------------------|----------------------------------| +| `nd_websocket_on_text_message` | `{connectionId, message}` | Text message received | +| `nd_websocket_on_binary_message` | `{connectionId, data}` | Binary message received (base64) | +| `nd_websocket_on_error` | `{connectionId, error}` | Connection error | +| `nd_websocket_on_close` | `{connectionId, code, reason}` | Connection closed | + +--- + +## Host Services + +Host services let your plugin call back into Navidrome for advanced functionality. Each service (except [Config](#config)) requires declaring the corresponding permission in your manifest. + +### Go PDK Setup + +All host service examples below use the generated Go SDK. Add this to your `go.mod`: + +``` +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go +``` + +Then import: + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/host" +``` + +### HTTP + +Make HTTP requests to external services. This is a dedicated host service (separate from Extism's built-in HTTP support) with additional features like timeouts and redirect control. + +**Manifest permission:** + +```json +{ + "permissions": { + "http": { + "reason": "Fetch metadata from external API", + "requiredHosts": ["api.example.com", "*.musicbrainz.org"] + } + } +} +``` + +**Host functions:** + +| Function | Parameters | Returns | +|-------------|----------------------------------------------------------|----------------------------------| +| `http_send` | `method, url, headers, body, timeoutMs, noFollowRedirects` | `statusCode, headers, body` | + +**Usage:** + +```go +resp, err := host.HTTPSend(host.HTTPRequest{ + Method: "GET", + URL: "https://api.example.com/data", + Headers: map[string]string{"Authorization": "Bearer " + apiKey}, +}) +if resp.StatusCode == 200 { + // Process resp.Body +} +``` + +### Scheduler + +Schedule one-time or recurring tasks. Your plugin must export the [`nd_scheduler_callback`](#schedulercallback) function to receive events. + +**Manifest permission:** + +```json +{ + "permissions": { + "scheduler": { + "reason": "Schedule periodic metadata refresh" + } + } +} +``` + +**Host functions:** + +| Function | Parameters | Description | +|-------------------------------|------------------------------------------|-----------------------------| +| `scheduler_scheduleonetime` | `delaySeconds, payload, scheduleId?` | Schedule one-time callback | +| `scheduler_schedulerecurring` | `cronExpression, payload, scheduleId?` | Schedule recurring callback | +| `scheduler_cancelschedule` | `scheduleId` | Cancel a scheduled task | + +**Usage:** + +```go +// Schedule one-time task in 60 seconds +scheduleID, err := host.SchedulerScheduleOneTime(60, "my-payload", "") + +// Schedule recurring task with cron expression (every hour) +scheduleID, err := host.SchedulerScheduleRecurring("0 * * * *", "hourly-task", "") + +// Cancel a task +err := host.SchedulerCancelSchedule(scheduleID) +``` + +### Cache + +In-memory TTL-based cache. Each plugin has its own isolated namespace. Cleared on server restart. + +**Manifest permission:** + +```json +{ + "permissions": { + "cache": { + "reason": "Cache API responses to reduce external requests" + } + } +} +``` + +**Host functions:** + +| Function | Parameters | Description | +|-------------------|---------------------------|-----------------------| +| `cache_setstring` | `key, value, ttl_seconds` | Store a string | +| `cache_getstring` | `key` | Get a string | +| `cache_setint` | `key, value, ttl_seconds` | Store an integer | +| `cache_getint` | `key` | Get an integer | +| `cache_setfloat` | `key, value, ttl_seconds` | Store a float | +| `cache_getfloat` | `key` | Get a float | +| `cache_setbytes` | `key, value, ttl_seconds` | Store bytes | +| `cache_getbytes` | `key` | Get bytes | +| `cache_has` | `key` | Check if key exists | +| `cache_remove` | `key` | Delete a cached value | + +**TTL:** Pass `0` for the default (24 hours), or specify seconds. + +**Usage:** + +```go +// Cache a value for 1 hour +host.CacheSetString("api-response", responseData, 3600) + +// Retrieve (returns value, exists, error) +value, exists, err := host.CacheGetString("api-response") +if exists { + // Use value +} +``` + +### KVStore + +Persistent key-value storage backed by SQLite. Survives server restarts. Each plugin has its own isolated database at `${DataFolder}/plugins/${pluginID}/kvstore.db`. + +**Manifest permission:** + +```json +{ + "permissions": { + "kvstore": { + "reason": "Store OAuth tokens and plugin state", + "maxSize": "1MB" + } + } +} +``` + +- `maxSize`: Maximum storage size (e.g., `"1MB"`, `"500KB"`). Default: 1MB + +**Key constraints:** Maximum 256 bytes, must be valid UTF-8. + +**Host functions:** + +| Function | Parameters | Description | +|-----------------------------|--------------------------|-----------------------------------| +| `kvstore_set` | `key, value` | Store a byte value | +| `kvstore_setwithttl` | `key, value, ttlSeconds` | Store with auto-expiration | +| `kvstore_get` | `key` | Retrieve a byte value | +| `kvstore_getmany` | `keys` | Retrieve multiple values at once | +| `kvstore_has` | `key` | Check if key exists | +| `kvstore_list` | `prefix` | List keys matching prefix | +| `kvstore_delete` | `key` | Delete a value | +| `kvstore_deletebyprefix` | `prefix` | Delete all keys matching prefix | +| `kvstore_getstorageused` | – | Get current storage usage (bytes) | + +**Usage:** + +```go +// Store a value (as raw bytes) +token := []byte(`{"access_token": "xyz", "refresh_token": "abc"}`) +host.KVStoreSet("oauth:spotify", token) + +// Store with TTL (auto-expires after 1 hour) +host.KVStoreSetWithTTL("session:abc", sessionData, 3600) + +// Retrieve a value +value, exists, err := host.KVStoreGet("oauth:spotify") +if exists { + var tokenData map[string]string + json.Unmarshal(value, &tokenData) +} + +// Batch retrieve +results, err := host.KVStoreGetMany([]string{"key1", "key2", "key3"}) + +// List and delete by prefix +keys, err := host.KVStoreList("user:") +host.KVStoreDeleteByPrefix("user:") + +// Check storage usage +usage, err := host.KVStoreGetStorageUsed() +fmt.Printf("Using %d bytes\n", usage) +``` + +### Task + +Background task queue with retry support. Plugins enqueue tasks and process them by exporting the [`nd_task_execute`](#taskworker) capability function. + +**Manifest permission:** + +```json +{ + "permissions": { + "taskqueue": { + "reason": "Process audio analysis in the background", + "maxConcurrency": 2 + } + } +} +``` + +**Host functions:** + +| Function | Parameters | Description | +|---------------------|---------------------------------------------------|----------------------------| +| `task_createqueue` | `name, concurrency, maxRetries, backoffMs, ...` | Create a named task queue | +| `task_enqueue` | `queueName, payload` | Add a task to the queue | +| `task_get` | `taskID` | Get task status and result | +| `task_cancel` | `taskID` | Cancel a pending task | +| `task_clearqueue` | `queueName` | Remove all tasks from queue| + +**Usage:** + +```go +// Create a queue with retry configuration +host.TaskCreateQueue("analysis", host.QueueConfig{ + Concurrency: 2, + MaxRetries: 3, + BackoffMs: 1000, +}) + +// Enqueue a task +taskID, err := host.TaskEnqueue("analysis", []byte(`{"trackId": "abc"}`)) + +// Check task status +info, err := host.TaskGet(taskID) +fmt.Printf("Status: %s, Attempt: %d\n", info.Status, info.Attempt) +``` + +### WebSocket + +Establish persistent WebSocket connections to external services. Your plugin must export [WebSocketCallback](#websocketcallback) functions to receive events. + +**Manifest permission:** + +```json +{ + "permissions": { + "websocket": { + "reason": "Real-time connection to service", + "requiredHosts": ["gateway.example.com", "*.discord.gg"] + } + } +} +``` + +**Host functions:** + +| Function | Parameters | Description | +|----------------------------|---------------------------------|-------------------| +| `websocket_connect` | `url, headers?, connectionId?` | Open a connection | +| `websocket_sendtext` | `connectionId, message` | Send text message | +| `websocket_sendbinary` | `connectionId, data` | Send binary data | +| `websocket_closeconnection`| `connectionId, code?, reason?` | Close connection | + +**Usage:** + +```go +connID, err := host.WebSocketConnect("wss://gateway.example.com", nil, "") +host.WebSocketSendText(connID, `{"op": 1, "d": null}`) +host.WebSocketCloseConnection(connID, 1000, "done") +``` + +### Library + +Access music library metadata and optionally read files from library directories. + +**Manifest permission:** + +```json +{ + "permissions": { + "library": { + "reason": "Access library metadata for analysis", + "filesystem": false + } + } +} +``` + +- `filesystem` – Set to `true` to enable read-only access to library directories (default: `false`) + +**Host functions:** + +| Function | Parameters | Returns | +|----------------------------|------------|---------------------------| +| `library_getlibrary` | `id` | Library metadata | +| `library_getalllibraries` | (none) | Array of library metadata | + +**Library metadata:** + +```json +{ + "id": 1, + "name": "My Music", + "path": "/music/collection", + "mountPoint": "/libraries/1", + "lastScanAt": 1703270400, + "totalSongs": 5000, + "totalAlbums": 500, + "totalArtists": 200, + "totalSize": 50000000000, + "totalDuration": 1500000.5 +} +``` + +> **Note:** The `path` and `mountPoint` fields are only included when `filesystem: true` is set in the permission. + +**Filesystem access:** + +When `filesystem: true`, your plugin can read files from library directories via WASI filesystem APIs. Each library is mounted at `/libraries/`: + +```go +import "os" + +content, err := os.ReadFile("/libraries/1/Artist/Album/track.mp3") +entries, err := os.ReadDir("/libraries/1/Artist") +``` + +> **Security:** Filesystem access is read-only and restricted to configured library paths only. + +**Usage:** + +```go +// Get a specific library +library, err := host.LibraryGetLibrary(1) +fmt.Printf("Library: %s (%d songs)\n", library.Name, library.TotalSongs) + +// Get all libraries +libraries, err := host.LibraryGetAllLibraries() +for _, lib := range libraries { + fmt.Printf("Library: %s (%d songs)\n", lib.Name, lib.TotalSongs) +} +``` + +### Artwork + +Generate public URLs for Navidrome artwork (albums, artists, tracks, playlists). + +**Manifest permission:** + +```json +{ + "permissions": { + "artwork": { + "reason": "Get artwork URLs for display" + } + } +} +``` + +**Host functions:** + +| Function | Parameters | Returns | +|--------------------------|------------|-------------| +| `artwork_getartisturl` | `id, size` | Artwork URL | +| `artwork_getalbumurl` | `id, size` | Artwork URL | +| `artwork_gettrackurl` | `id, size` | Artwork URL | +| `artwork_getplaylisturl` | `id, size` | Artwork URL | + +**Usage:** + +```go +url, err := host.ArtworkGetAlbumUrl("album-id", 300) +``` + +### SubsonicAPI + +Call Navidrome's Subsonic API internally (no network round-trip). + +**Manifest permission:** + +```json +{ + "permissions": { + "subsonicapi": { + "reason": "Access library data" + }, + "users": { + "reason": "Access user information for SubsonicAPI authorization" + } + } +} +``` + +> **Important:** The `subsonicapi` permission requires the `users` permission. Which users the plugin can act as is controlled through the Navidrome UI. + +**Host functions:** + +| Function | Parameters | Returns | +|-----------------------|------------|--------------------------------| +| `subsonicapi_call` | `uri` | JSON response string | +| `subsonicapi_callraw` | `uri` | Content type + binary response | + +**Usage:** + +```go +// JSON response +response, err := host.SubsonicAPICall("getAlbumList2?type=random&size=10&u=username") + +// Binary response (e.g., cover art, streams) +contentType, data, err := host.SubsonicAPICallRaw("getCoverArt?id=al-123&u=username") +``` + +### Config + +Access plugin configuration values. Unlike `pdk.GetConfig()` which only retrieves individual values, this service can list all available configuration keys — useful for discovering dynamic configuration. + +> **Note:** This service is always available and does not require a manifest permission. + +**Host functions:** + +| Function | Parameters | Returns | +|-----------------|------------|-----------------------------| +| `config_get` | `key` | `value, exists` | +| `config_getint` | `key` | `value, exists` | +| `config_keys` | `prefix` | Array of matching key names | + +**Usage:** + +```go +// Get a configuration value +value, exists := host.ConfigGet("api_key") + +// Get an integer configuration value +count, exists := host.ConfigGetInt("max_retries") + +// List all keys with a prefix (useful for user-specific config) +keys := host.ConfigKeys("user:") + +// List all configuration keys +allKeys := host.ConfigKeys("") +``` + +### Users + +Access user information for the users that the plugin has been granted access to. + +**Manifest permission:** + +```json +{ + "permissions": { + "users": { + "reason": "Display user information in status updates" + } + } +} +``` + +**Important:** Before enabling a plugin that requires the `users` permission, an administrator must configure which users the plugin can access: + +1. **Allow all users** – Enable the "Allow all users" toggle in the plugin settings +2. **Select specific users** – Choose individual users from the user list + +If neither option is configured, the plugin cannot be enabled. + +**Host functions:** + +| Function | Parameters | Returns | +|------------------|------------|-----------------------| +| `users_getusers` | – | Array of User objects | +| `users_getadmins`| – | Array of admin Users | + +**User object fields:** + +| Field | Type | Description | +|------------|---------|--------------------------------| +| `userName` | string | The user's unique username | +| `name` | string | The user's display name | +| `isAdmin` | boolean | Whether the user is an admin | + +> **Security:** Sensitive fields like passwords, email addresses, and internal IDs are never exposed to plugins. + +**Usage:** + +```go +users, err := host.UsersGetUsers() +for _, user := range users { + pdk.Log(pdk.LogInfo, "User: " + user.UserName + " (" + user.Name + ")") +} + +admins, err := host.UsersGetAdmins() +``` + +--- + +## Configuration + +### Server Configuration + +Enable plugins in `navidrome.toml`: + +```toml +[Plugins] +Enabled = true +Folder = "/path/to/plugins" # Default: DataFolder/plugins +AutoReload = true # Auto-reload on file changes (dev mode) +LogLevel = "debug" # Plugin-specific log level +CacheSize = "200MB" # Compilation cache size limit +``` + +### Plugin Configuration + +Plugin configuration is managed through the Navidrome web UI. Navigate to the Plugins page, select a plugin, and edit its configuration as key-value pairs. + +Access configuration values in your plugin: + +```go +apiKey, ok := pdk.GetConfig("api_key") +if !ok { + pdk.SetErrorString("api_key configuration is required") + return 1 +} +``` + +For more advanced access (listing keys, integer values), use the [Config](#config) host service. + +--- + +## Building Plugins + +### Supported Languages + +Plugins can be written in any language that Extism supports. We recommend: + +- **Go** – Best overall experience with [TinyGo](https://tinygo.org/) and the [Go PDK](https://github.com/extism/go-pdk). Familiar syntax, excellent stdlib support. +- **Rust** – Best for performance-critical plugins. Smallest binaries, excellent type safety. Uses the [Rust PDK](https://github.com/extism/rust-pdk). +- **Python** – Best for rapid prototyping. Experimental support via [extism-py](https://github.com/extism/python-pdk). Note some limitations compared to compiled languages. +- **TypeScript** – Experimental support via [extism-js](https://github.com/extism/js-pdk). + +### Go with TinyGo (Recommended) + +```bash +# Install TinyGo: https://tinygo.org/getting-started/install/ + +# Build WebAssembly module +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . + +# Package as .ndp +zip -j my-plugin.ndp manifest.json plugin.wasm +``` + +#### Using Go PDK Packages + +Navidrome provides type-safe Go packages for each capability and host service in `plugins/pdk/go/`. Instead of manually exporting functions with `//go:wasmexport`, use the `Register()` pattern: + +```go +package main + +import "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + +type myPlugin struct{} + +func (p *myPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{Biography: "Biography text..."}, nil +} + +func init() { metadata.Register(&myPlugin{}) } +func main() {} +``` + +Add to your `go.mod`: + +``` +require github.com/navidrome/navidrome v0.0.0 +replace github.com/navidrome/navidrome => ../../.. +``` + +**Available capability packages:** + +| Package | Import Path | Description | +|-------------------|--------------------------------------|--------------------------------------| +| `metadata` | `plugins/pdk/go/metadata` | Artist/album metadata providers | +| `scrobbler` | `plugins/pdk/go/scrobbler` | Scrobbling services | +| `lyrics` | `plugins/pdk/go/lyrics` | Lyrics providers | +| `sonicsimilarity` | `plugins/pdk/go/sonicsimilarity` | Audio similarity discovery | +| `taskworker` | `plugins/pdk/go/taskworker` | Background task processing | +| `lifecycle` | `plugins/pdk/go/lifecycle` | Plugin initialization | +| `scheduler` | `plugins/pdk/go/scheduler` | Scheduled task callbacks | +| `websocket` | `plugins/pdk/go/websocket` | WebSocket event handlers | +| `host` | `plugins/pdk/go/host` | Host service SDK (all services) | + +See the example plugins in [examples/](examples/) for complete usage patterns. + +### Rust + +```bash +# Build WebAssembly module +cargo build --release --target wasm32-wasip1 + +# Package as .ndp +zip -j my-plugin.ndp manifest.json target/wasm32-wasip1/release/plugin.wasm +``` + +#### Using Rust PDK + +```toml +# Cargo.toml +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" +``` + +**Implementing capabilities with traits and macros:** + +```rust +use nd_pdk::scrobbler::{Scrobbler, IsAuthorizedRequest, Error}; +use nd_pdk::register_scrobbler; + +#[derive(Default)] +struct MyPlugin; + +impl Scrobbler for MyPlugin { + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result { + Ok(true) + } + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error> { Ok(()) } + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error> { Ok(()) } +} + +register_scrobbler!(MyPlugin); // Generates all WASM exports +``` + +**Using host services:** + +```rust +use nd_pdk::host::{cache, scheduler, library}; + +cache::set_string("my_key", "my_value", 3600)?; +scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; +let libs = library::get_all_libraries()?; +``` + +See [pdk/rust/README.md](pdk/rust/README.md) for detailed documentation. + +### Python (with extism-py) + +```bash +# Build WebAssembly module (requires extism-py installed) +extism-py plugin.wasm -o plugin.wasm *.py + +# Package as .ndp +zip -j my-plugin.ndp manifest.json plugin.wasm +``` + +**For Python host services:** Copy functions from the `nd_host_*.py` files in `plugins/pdk/python/host/` into your `__init__.py` (see comments in those files for extism-py limitations). + +### Using XTP CLI (Scaffolding) + +Bootstrap a new plugin from a schema: + +```bash +# Install XTP CLI: https://docs.xtp.dylibso.com/docs/cli + +# Create a metadata agent plugin +xtp plugin init \ + --schema-file plugins/capabilities/metadata_agent.yaml \ + --template go \ + --path ./my-agent \ + --name my-agent + +# Build and package +cd my-agent && xtp plugin build +zip -j my-agent.ndp manifest.json dist/plugin.wasm +``` + +See [capabilities/README.md](capabilities/README.md) for available schemas and scaffolding examples. + +--- + +## Examples + +See [examples/](examples/) for complete working plugins: + +| Plugin | Language | Capabilities | Host Services | Description | +|----------------------------------------------------------------|----------------|---------------|--------------------------------------------|--------------------------------| +| [minimal](examples/minimal/) | Go | MetadataAgent | – | Basic structure example | +| [wikimedia](examples/wikimedia/) | Go | MetadataAgent | HTTP | Wikidata/Wikipedia integration | +| [coverartarchive-py](examples/coverartarchive-py/) | Python | MetadataAgent | HTTP | Cover Art Archive | +| [coverartarchive-as](examples/coverartarchive-as/) | AssemblyScript | MetadataAgent | HTTP | Cover Art Archive | +| [webhook-rs](examples/webhook-rs/) | Rust | Scrobbler | HTTP | HTTP webhooks | +| [nowplaying-py](examples/nowplaying-py/) | Python | Lifecycle | Scheduler, SubsonicAPI | Periodic now-playing logger | +| [library-inspector-rs](examples/library-inspector-rs/) | Rust | Lifecycle | Library, Scheduler | Periodic library stats logging | +| [crypto-ticker](examples/crypto-ticker/) | Go | Lifecycle | WebSocket, Scheduler | Real-time crypto prices demo | +| [discord-rich-presence-rs](examples/discord-rich-presence-rs/) | Rust | Scrobbler | HTTP, WebSocket, Cache, Scheduler, Artwork | Discord integration | + +--- + +## Security + +Plugins run in a secure WebAssembly sandbox provided by [Extism](https://extism.org/) and the [Wazero](https://wazero.io/) runtime: + +1. **Host Allowlisting** – Only explicitly allowed hosts are accessible via HTTP/WebSocket +2. **Limited File System** – Read-only access to library directories, only when explicitly granted the `library.filesystem` permission +3. **No Network Listeners** – Plugins cannot bind ports +4. **Config Isolation** – Plugins only receive their own config section +5. **Memory Limits** – Controlled by the WebAssembly runtime +6. **User-Scoped Authorization** – Plugins with `subsonicapi` or `scrobbler` capabilities can only access/receive events for users assigned to them through Navidrome's configuration +7. **Users Permission** – Plugins requesting user access must be explicitly configured with allowed users; sensitive data (passwords, emails) is never exposed + +--- + +## Runtime Management + +### Auto-Reload + +With `AutoReload = true`, Navidrome watches the plugins folder and automatically detects when `.ndp` files are added, modified, or removed. When a plugin file changes, the plugin is disabled and its metadata is re-read from the archive. + +If `AutoReload` is disabled, Navidrome needs to be restarted to pick up plugin changes. + +### Enabling/Disabling Plugins + +Plugins can be enabled/disabled via the Navidrome UI. The plugin state is persisted in the database. + +### Important Notes + +- **In-flight requests** – When reloading, existing requests complete before the new version takes over +- **Config changes** – Changes to the plugin configuration in the UI are applied immediately +- **Cache persistence** – The in-memory cache is cleared when a plugin is unloaded \ No newline at end of file diff --git a/plugins/capabilities.go b/plugins/capabilities.go new file mode 100644 index 000000000..81e683b6b --- /dev/null +++ b/plugins/capabilities.go @@ -0,0 +1,41 @@ +package plugins + +import "slices" + +// Capability represents a plugin capability type. +// Capabilities are detected by checking which functions a plugin exports. +type Capability string + +// capabilityFunctions maps each capability to its required/optional functions. +// A plugin has a capability if it exports at least one of these functions. +var capabilityFunctions = map[Capability][]string{} + +// registerCapability registers a capability with its associated functions. +func registerCapability(cap Capability, functions ...string) { + capabilityFunctions[cap] = functions +} + +// functionExistsChecker is an interface for checking if a function exists in a plugin. +// This allows for testing without a real plugin instance. +type functionExistsChecker interface { + FunctionExists(name string) bool +} + +// detectCapabilities detects which capabilities a plugin has by checking +// which functions it exports. +func detectCapabilities(plugin functionExistsChecker) []Capability { + var capabilities []Capability + + for cap, functions := range capabilityFunctions { + if slices.ContainsFunc(functions, plugin.FunctionExists) { + capabilities = append(capabilities, cap) // Found at least one function, plugin has this capability + } + } + + return capabilities +} + +// hasCapability checks if the given capabilities slice contains a specific capability. +func hasCapability(capabilities []Capability, cap Capability) bool { + return slices.Contains(capabilities, cap) +} diff --git a/plugins/capabilities/README.md b/plugins/capabilities/README.md new file mode 100644 index 000000000..fca3cbd31 --- /dev/null +++ b/plugins/capabilities/README.md @@ -0,0 +1,87 @@ +# Navidrome Plugin Capabilities + +This directory contains the Go interface definitions for Navidrome plugin capabilities. These interfaces are the **source of truth** for plugin development and are used to generate: + +1. **Go PDK packages** (`pdk/go/*/`) - Type-safe wrappers for Go plugin developers +2. **Rust PDK crates** (`pdk/rust/*/`) - Type-safe wrappers for Rust plugin developers +3. **XTP YAML schemas** (`*.yaml`) - Schema files for other [Extism plugin languages](https://extism.org/docs/concepts/pdk/) (TypeScript, Python, C#, Zig, C++, ...) + +## For Go Plugin Developers + +Go developers should use the generated PDK packages in `plugins/pdk/go/`. See the example Go plugins in `plugins/examples/` for usage patterns. + +## For Rust Plugin Developers + +Rust developers should use the generated PDK crate in `plugins/pdk/rust/nd-pdk`. See the example Rust plugins in `plugins/examples` for usage patterns. + +## For Non-Go Plugin Developers + +If you're developing plugins in other languages (TypeScript, Rust, Python, C#, Zig, C++), you can use the XTP CLI to generate type-safe bindings from the YAML schema files in this directory. + +### Prerequisites + +Install the XTP CLI: + +```bash +# macOS +brew install dylibso/tap/xtp + +# Other platforms - see https://docs.xtp.dylibso.com/docs/cli +curl https://static.dylibso.com/cli/install.sh | bash +``` + +### Generating Plugin Scaffolding + +Use the XTP CLI to generate plugin boilerplate from any capability schema: + +```bash +# TypeScript +xtp plugin init --schema-file plugins/capabilities/metadata_agent.yaml \ + --template typescript --path my-plugin + +# Rust +xtp plugin init --schema-file plugins/capabilities/scrobbler.yaml \ + --template rust --path my-plugin + +# Python +xtp plugin init --schema-file plugins/capabilities/lifecycle.yaml \ + --template python --path my-plugin + +# C# +xtp plugin init --schema-file plugins/capabilities/scheduler_callback.yaml \ + --template csharp --path my-plugin + +# Go (alternative to using the PDK packages) +xtp plugin init --schema-file plugins/capabilities/websocket_callback.yaml \ + --template go --path my-plugin +``` + +### Available Capabilities + +| Capability | Schema File | Description | +|--------------------|---------------------------|-------------------------------------------------------------| +| Metadata Agent | `metadata_agent.yaml` | Fetch artist biographies, album images, and similar artists | +| Scrobbler | `scrobbler.yaml` | Report listening activity to external services | +| Lifecycle | `lifecycle.yaml` | Plugin initialization callbacks | +| Scheduler Callback | `scheduler_callback.yaml` | Scheduled task execution | +| WebSocket Callback | `websocket_callback.yaml` | Real-time WebSocket message handling | + +### Building Your Plugin + +After generating the scaffolding, implement the required functions and build your plugin as a WebAssembly module. The exact build process depends on your chosen language - see the [Extism PDK documentation](https://extism.org/docs/concepts/pdk) for language-specific guides. + +## XTP Schema Generation + +The YAML schemas in this package are automatically generated from the capability Go interfaces using `ndpgen`. +To regenerate the schemas after modifying the interfaces, run: + +```bash +cd plugins/cmd/ndpgen && go run . -schemas -input=./plugins/capabilities +``` + +## Resources + +- [XTP Documentation](https://docs.xtp.dylibso.com/) +- [XTP Bindgen Repository](https://github.com/dylibso/xtp-bindgen) +- [Extism Plugin Development Kit](https://extism.org/docs/concepts/pdk) +- [XTP Schema Definition](https://raw.githubusercontent.com/dylibso/xtp-bindgen/5090518dd86ba5e734dc225a33066ecc0ed2e12d/plugin/schema.json) diff --git a/plugins/capabilities/doc.go b/plugins/capabilities/doc.go new file mode 100644 index 000000000..fa9b7eb5d --- /dev/null +++ b/plugins/capabilities/doc.go @@ -0,0 +1,56 @@ +// Package capabilities defines Go interfaces for Navidrome plugin capabilities. +// +// These interfaces serve as the source of truth for capability definitions. +// The ndpgen tool generates: +// - Go export wrappers in plugins/pdk/go// for Go plugins +// - XTP YAML schemas for non-Go plugins (Rust, TypeScript, etc.) +// +// Each capability is defined as an annotated interface: +// +// //nd:capability name=metadata +// type MetadataAgent interface { +// //nd:export name=nd_get_artist_biography +// GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +// } +// +// Annotation Reference: +// +// //nd:capability name= [required=true] +// - Marks an interface as a capability +// - name: Generated package name (e.g., name=metadata → pdk/go/metadata/) +// - required: If true, all methods must be implemented (default: false) +// +// //nd:export name= +// - Marks a method as an exported WASM function +// - name: The export name (e.g., nd_get_artist_biography) +// +// Generated Code Structure: +// +// For a capability like MetadataAgent with required=false: +// +// package metadata +// +// // Agent is the marker interface +// type Agent interface{} +// +// // Optional provider interfaces +// type ArtistBiographyProvider interface { +// GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +// } +// +// // Registration function +// func Register(impl Agent) { ... } +// +// For a capability with required=true: +// +// package scrobbler +// +// // Scrobbler requires all methods +// type Scrobbler interface { +// IsAuthorized(IsAuthorizedRequest) (bool, error) +// NowPlaying(NowPlayingRequest) error +// Scrobble(ScrobbleRequest) error +// } +// +// func Register(impl Scrobbler) { ... } +package capabilities diff --git a/plugins/capabilities/lifecycle.go b/plugins/capabilities/lifecycle.go new file mode 100644 index 000000000..b5f19ec5b --- /dev/null +++ b/plugins/capabilities/lifecycle.go @@ -0,0 +1,19 @@ +package capabilities + +// Lifecycle provides plugin lifecycle hooks. +// This capability allows plugins to perform initialization when loaded, +// such as establishing connections, starting background processes, or +// validating configuration. +// +// The OnInit function is called once when the plugin is loaded, and is NOT +// called when the plugin is hot-reloaded. Plugins should not assume this +// function will be called on every startup. +// +//nd:capability name=lifecycle +type Lifecycle interface { + // OnInit is called after a plugin is fully loaded with all services registered. + // Plugins can use this function to perform one-time initialization tasks. + // Errors are logged but will not prevent the plugin from being loaded. + //nd:export name=nd_on_init + OnInit() error +} diff --git a/plugins/capabilities/lifecycle.yaml b/plugins/capabilities/lifecycle.yaml new file mode 100644 index 000000000..7c6af62b8 --- /dev/null +++ b/plugins/capabilities/lifecycle.yaml @@ -0,0 +1,7 @@ +version: v1-draft +exports: + nd_on_init: + description: |- + OnInit is called after a plugin is fully loaded with all services registered. + Plugins can use this function to perform one-time initialization tasks. + Errors are logged but will not prevent the plugin from being loaded. diff --git a/plugins/capabilities/lyrics.go b/plugins/capabilities/lyrics.go new file mode 100644 index 000000000..6f6d19177 --- /dev/null +++ b/plugins/capabilities/lyrics.go @@ -0,0 +1,26 @@ +package capabilities + +// Lyrics provides lyrics for a given track from external sources. +// +//nd:capability name=lyrics required=true +type Lyrics interface { + //nd:export name=nd_lyrics_get_lyrics + GetLyrics(GetLyricsRequest) (GetLyricsResponse, error) +} + +// GetLyricsRequest contains the track information for lyrics lookup. +type GetLyricsRequest struct { + Track TrackInfo `json:"track"` +} + +// GetLyricsResponse contains the lyrics returned by the plugin. +type GetLyricsResponse struct { + Lyrics []LyricsText `json:"lyrics"` +} + +// LyricsText represents a single set of lyrics in raw text format. +// Text can be plain text or LRC format — Navidrome will parse it. +type LyricsText struct { + Lang string `json:"lang,omitempty"` + Text string `json:"text"` +} diff --git a/plugins/capabilities/lyrics.yaml b/plugins/capabilities/lyrics.yaml new file mode 100644 index 000000000..04dd283dd --- /dev/null +++ b/plugins/capabilities/lyrics.yaml @@ -0,0 +1,126 @@ +version: v1-draft +exports: + nd_lyrics_get_lyrics: + input: + $ref: '#/components/schemas/GetLyricsRequest' + contentType: application/json + output: + $ref: '#/components/schemas/GetLyricsResponse' + contentType: application/json +components: + schemas: + ArtistRef: + description: ArtistRef is a reference to an artist with name and optional MBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID (if known). + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - name + GetLyricsRequest: + description: GetLyricsRequest contains the track information for lyrics lookup. + properties: + track: + $ref: '#/components/schemas/TrackInfo' + required: + - track + GetLyricsResponse: + description: GetLyricsResponse contains the lyrics returned by the plugin. + properties: + lyrics: + type: array + items: + $ref: '#/components/schemas/LyricsText' + required: + - lyrics + LyricsText: + description: |- + LyricsText represents a single set of lyrics in raw text format. + Text can be plain text or LRC format — Navidrome will parse it. + properties: + lang: + type: string + text: + type: string + required: + - text + TrackInfo: + description: TrackInfo contains track metadata. + properties: + id: + type: string + description: ID is the internal Navidrome track ID. + title: + type: string + description: Title is the track title. + album: + type: string + description: Album is the album name. + artist: + type: string + description: Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + albumArtist: + type: string + description: AlbumArtist is the formatted album artist name for display. + artists: + type: array + description: Artists is the list of track artists. + items: + $ref: '#/components/schemas/ArtistRef' + albumArtists: + type: array + description: AlbumArtists is the list of album artists. + items: + $ref: '#/components/schemas/ArtistRef' + duration: + type: number + format: float + description: Duration is the track duration in seconds. + trackNumber: + type: integer + format: int32 + description: TrackNumber is the track number on the album. + discNumber: + type: integer + format: int32 + description: DiscNumber is the disc number. + mbzRecordingId: + type: string + description: MBZRecordingID is the MusicBrainz recording ID. + mbzAlbumId: + type: string + description: MBZAlbumID is the MusicBrainz album/release ID. + mbzReleaseGroupId: + type: string + description: MBZReleaseGroupID is the MusicBrainz release group ID. + mbzReleaseTrackId: + type: string + description: MBZReleaseTrackID is the MusicBrainz release track ID. + libraryId: + type: integer + format: int32 + description: |- + LibraryID is the ID of the library the track belongs to. + Only included if the plugin has library permission with filesystem access for the track's library. + path: + type: string + description: |- + Path is the full path to the track file, relative to the library root. + Only included if the plugin has library permission with filesystem access for the track's library. + required: + - id + - title + - album + - artist + - albumArtist + - artists + - albumArtists + - duration + - trackNumber + - discNumber diff --git a/plugins/capabilities/metadata_agent.go b/plugins/capabilities/metadata_agent.go new file mode 100644 index 000000000..407f21ec5 --- /dev/null +++ b/plugins/capabilities/metadata_agent.go @@ -0,0 +1,237 @@ +package capabilities + +// MetadataAgent provides artist and album metadata retrieval. +// This capability allows plugins to provide external metadata for artists and albums, +// such as biographies, images, similar artists, and top songs. +// +// Plugins implementing this capability can choose which methods to implement. +// Each method is optional - plugins only need to provide the functionality they support. +// +//nd:capability name=metadata +type MetadataAgent interface { + // GetArtistMBID retrieves the MusicBrainz ID for an artist. + //nd:export name=nd_get_artist_mbid + GetArtistMBID(ArtistMBIDRequest) (*ArtistMBIDResponse, error) + + // GetArtistURL retrieves the external URL for an artist. + //nd:export name=nd_get_artist_url + GetArtistURL(ArtistRequest) (*ArtistURLResponse, error) + + // GetArtistBiography retrieves the biography for an artist. + //nd:export name=nd_get_artist_biography + GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) + + // GetSimilarArtists retrieves similar artists for a given artist. + //nd:export name=nd_get_similar_artists + GetSimilarArtists(SimilarArtistsRequest) (*SimilarArtistsResponse, error) + + // GetArtistImages retrieves images for an artist. + //nd:export name=nd_get_artist_images + GetArtistImages(ArtistRequest) (*ArtistImagesResponse, error) + + // GetArtistTopSongs retrieves top songs for an artist. + //nd:export name=nd_get_artist_top_songs + GetArtistTopSongs(TopSongsRequest) (*TopSongsResponse, error) + + // GetAlbumInfo retrieves album information. + //nd:export name=nd_get_album_info + GetAlbumInfo(AlbumRequest) (*AlbumInfoResponse, error) + + // GetAlbumImages retrieves images for an album. + //nd:export name=nd_get_album_images + GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) + + // GetSimilarSongsByTrack retrieves songs similar to a specific track. + //nd:export name=nd_get_similar_songs_by_track + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) + + // GetSimilarSongsByAlbum retrieves songs similar to tracks on an album. + //nd:export name=nd_get_similar_songs_by_album + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) + + // GetSimilarSongsByArtist retrieves songs similar to an artist's catalog. + //nd:export name=nd_get_similar_songs_by_artist + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +} + +// ArtistMBIDRequest is the request for GetArtistMBID. +type ArtistMBIDRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` +} + +// ArtistMBIDResponse is the response for GetArtistMBID. +type ArtistMBIDResponse struct { + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid"` +} + +// ArtistRequest is the common request for artist-related functions. +type ArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistURLResponse is the response for GetArtistURL. +type ArtistURLResponse struct { + // URL is the external URL for the artist. + URL string `json:"url"` +} + +// ArtistBiographyResponse is the response for GetArtistBiography. +type ArtistBiographyResponse struct { + // Biography is the artist biography text. + Biography string `json:"biography"` +} + +// SimilarArtistsRequest is the request for GetSimilarArtists. +type SimilarArtistsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Limit is the maximum number of similar artists to return. + Limit int32 `json:"limit"` +} + +// SimilarArtistsResponse is the response for GetSimilarArtists. +type SimilarArtistsResponse struct { + // Artists is the list of similar artists. + Artists []ArtistRef `json:"artists"` +} + +// ImageInfo represents an image with URL and size. +type ImageInfo struct { + // URL is the URL of the image. + URL string `json:"url"` + // Size is the size of the image in pixels (width or height). + Size int32 `json:"size"` +} + +// ArtistImagesResponse is the response for GetArtistImages. +type ArtistImagesResponse struct { + // Images is the list of artist images. + Images []ImageInfo `json:"images"` +} + +// TopSongsRequest is the request for GetArtistTopSongs. +type TopSongsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of top songs to return. + Count int32 `json:"count"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// TopSongsResponse is the response for GetArtistTopSongs. +type TopSongsResponse struct { + // Songs is the list of top songs. + Songs []SongRef `json:"songs"` +} + +// AlbumRequest is the common request for album-related functions. +type AlbumRequest struct { + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz ID for the album (if known). + MBID string `json:"mbid,omitempty"` +} + +// AlbumInfoResponse is the response for GetAlbumInfo. +type AlbumInfoResponse struct { + // Name is the album name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the album. + MBID string `json:"mbid"` + // Description is the album description/notes. + Description string `json:"description"` + // URL is the external URL for the album. + URL string `json:"url"` +} + +// AlbumImagesResponse is the response for GetAlbumImages. +type AlbumImagesResponse struct { + // Images is the list of album images. + Images []ImageInfo `json:"images"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} diff --git a/plugins/capabilities/metadata_agent.yaml b/plugins/capabilities/metadata_agent.yaml new file mode 100644 index 000000000..4940a5056 --- /dev/null +++ b/plugins/capabilities/metadata_agent.yaml @@ -0,0 +1,396 @@ +version: v1-draft +exports: + nd_get_artist_mbid: + description: GetArtistMBID retrieves the MusicBrainz ID for an artist. + input: + $ref: '#/components/schemas/ArtistMBIDRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistMBIDResponse' + contentType: application/json + nd_get_artist_url: + description: GetArtistURL retrieves the external URL for an artist. + input: + $ref: '#/components/schemas/ArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistURLResponse' + contentType: application/json + nd_get_artist_biography: + description: GetArtistBiography retrieves the biography for an artist. + input: + $ref: '#/components/schemas/ArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistBiographyResponse' + contentType: application/json + nd_get_similar_artists: + description: GetSimilarArtists retrieves similar artists for a given artist. + input: + $ref: '#/components/schemas/SimilarArtistsRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarArtistsResponse' + contentType: application/json + nd_get_artist_images: + description: GetArtistImages retrieves images for an artist. + input: + $ref: '#/components/schemas/ArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/ArtistImagesResponse' + contentType: application/json + nd_get_artist_top_songs: + description: GetArtistTopSongs retrieves top songs for an artist. + input: + $ref: '#/components/schemas/TopSongsRequest' + contentType: application/json + output: + $ref: '#/components/schemas/TopSongsResponse' + contentType: application/json + nd_get_album_info: + description: GetAlbumInfo retrieves album information. + input: + $ref: '#/components/schemas/AlbumRequest' + contentType: application/json + output: + $ref: '#/components/schemas/AlbumInfoResponse' + contentType: application/json + nd_get_album_images: + description: GetAlbumImages retrieves images for an album. + input: + $ref: '#/components/schemas/AlbumRequest' + contentType: application/json + output: + $ref: '#/components/schemas/AlbumImagesResponse' + contentType: application/json + nd_get_similar_songs_by_track: + description: GetSimilarSongsByTrack retrieves songs similar to a specific track. + input: + $ref: '#/components/schemas/SimilarSongsByTrackRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json + nd_get_similar_songs_by_album: + description: GetSimilarSongsByAlbum retrieves songs similar to tracks on an album. + input: + $ref: '#/components/schemas/SimilarSongsByAlbumRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json + nd_get_similar_songs_by_artist: + description: GetSimilarSongsByArtist retrieves songs similar to an artist's catalog. + input: + $ref: '#/components/schemas/SimilarSongsByArtistRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SimilarSongsResponse' + contentType: application/json +components: + schemas: + AlbumImagesResponse: + description: AlbumImagesResponse is the response for GetAlbumImages. + properties: + images: + type: array + description: Images is the list of album images. + items: + $ref: '#/components/schemas/ImageInfo' + required: + - images + AlbumInfoResponse: + description: AlbumInfoResponse is the response for GetAlbumInfo. + properties: + name: + type: string + description: Name is the album name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the album. + description: + type: string + description: Description is the album description/notes. + url: + type: string + description: URL is the external URL for the album. + required: + - name + - mbid + - description + - url + AlbumRequest: + description: AlbumRequest is the common request for album-related functions. + properties: + name: + type: string + description: Name is the album name. + artist: + type: string + description: Artist is the album artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the album (if known). + required: + - name + - artist + ArtistBiographyResponse: + description: ArtistBiographyResponse is the response for GetArtistBiography. + properties: + biography: + type: string + description: Biography is the artist biography text. + required: + - biography + ArtistImagesResponse: + description: ArtistImagesResponse is the response for GetArtistImages. + properties: + images: + type: array + description: Images is the list of artist images. + items: + $ref: '#/components/schemas/ImageInfo' + required: + - images + ArtistMBIDRequest: + description: ArtistMBIDRequest is the request for GetArtistMBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + required: + - id + - name + ArtistMBIDResponse: + description: ArtistMBIDResponse is the response for GetArtistMBID. + properties: + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - mbid + ArtistRef: + description: ArtistRef is a reference to an artist with name and optional MBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID (if known). + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - name + ArtistRequest: + description: ArtistRequest is the common request for artist-related functions. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist (if known). + required: + - id + - name + ArtistURLResponse: + description: ArtistURLResponse is the response for GetArtistURL. + properties: + url: + type: string + description: URL is the external URL for the artist. + required: + - url + ImageInfo: + description: ImageInfo represents an image with URL and size. + properties: + url: + type: string + description: URL is the URL of the image. + size: + type: integer + format: int32 + description: Size is the size of the image in pixels (width or height). + required: + - url + - size + SimilarArtistsRequest: + description: SimilarArtistsRequest is the request for GetSimilarArtists. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist (if known). + limit: + type: integer + format: int32 + description: Limit is the maximum number of similar artists to return. + required: + - id + - name + - limit + SimilarArtistsResponse: + description: SimilarArtistsResponse is the response for GetSimilarArtists. + properties: + artists: + type: array + description: Artists is the list of similar artists. + items: + $ref: '#/components/schemas/ArtistRef' + required: + - artists + SimilarSongsByAlbumRequest: + description: SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. + properties: + id: + type: string + description: ID is the internal Navidrome album ID. + name: + type: string + description: Name is the album name. + artist: + type: string + description: Artist is the album artist name. + mbid: + type: string + description: MBID is the MusicBrainz release ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - artist + - count + SimilarSongsByArtistRequest: + description: SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz artist ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - count + SimilarSongsByTrackRequest: + description: SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. + properties: + id: + type: string + description: ID is the internal Navidrome mediafile ID. + name: + type: string + description: Name is the track title. + artist: + type: string + description: Artist is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz recording ID (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of similar songs to return. + required: + - id + - name + - artist + - count + SimilarSongsResponse: + description: SimilarSongsResponse is the response for GetSimilarSongsBy* functions. + properties: + songs: + type: array + description: Songs is the list of similar songs. + items: + $ref: '#/components/schemas/SongRef' + required: + - songs + SongRef: + description: SongRef is a reference to a song with metadata for matching. + properties: + id: + type: string + description: ID is the internal Navidrome mediafile ID (if known). + name: + type: string + description: Name is the song name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the song. + isrc: + type: string + description: ISRC is the International Standard Recording Code for the song. + artist: + type: string + description: Artist is the artist name. + artistMbid: + type: string + description: ArtistMBID is the MusicBrainz artist ID. + album: + type: string + description: Album is the album name. + albumMbid: + type: string + description: AlbumMBID is the MusicBrainz release ID. + duration: + type: number + format: float + description: Duration is the song duration in seconds. + required: + - name + TopSongsRequest: + description: TopSongsRequest is the request for GetArtistTopSongs. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID. + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist (if known). + count: + type: integer + format: int32 + description: Count is the maximum number of top songs to return. + required: + - id + - name + - count + TopSongsResponse: + description: TopSongsResponse is the response for GetArtistTopSongs. + properties: + songs: + type: array + description: Songs is the list of top songs. + items: + $ref: '#/components/schemas/SongRef' + required: + - songs diff --git a/plugins/capabilities/scheduler_callback.go b/plugins/capabilities/scheduler_callback.go new file mode 100644 index 000000000..93f66f10d --- /dev/null +++ b/plugins/capabilities/scheduler_callback.go @@ -0,0 +1,27 @@ +package capabilities + +// SchedulerCallback provides scheduled task handling. +// This capability allows plugins to receive callbacks when their scheduled tasks execute. +// Plugins that use the scheduler host service must implement this capability +// to handle task execution. +// +//nd:capability name=scheduler +type SchedulerCallback interface { + // OnCallback is called when a scheduled task fires. + // Errors are logged but do not affect the scheduling system. + //nd:export name=nd_scheduler_callback + OnCallback(SchedulerCallbackRequest) error +} + +// SchedulerCallbackRequest is the request provided when a scheduled task fires. +type SchedulerCallbackRequest struct { + // ScheduleID is the unique identifier for this scheduled task. + // This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + ScheduleID string `json:"scheduleId"` + // Payload is the payload data that was provided when the task was scheduled. + // Can be used to pass context or parameters to the callback handler. + Payload string `json:"payload"` + // IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + // false if it's a one-time schedule (created via ScheduleOneTime). + IsRecurring bool `json:"isRecurring"` +} diff --git a/plugins/capabilities/scheduler_callback.yaml b/plugins/capabilities/scheduler_callback.yaml new file mode 100644 index 000000000..9a081cd08 --- /dev/null +++ b/plugins/capabilities/scheduler_callback.yaml @@ -0,0 +1,33 @@ +version: v1-draft +exports: + nd_scheduler_callback: + description: |- + OnCallback is called when a scheduled task fires. + Errors are logged but do not affect the scheduling system. + input: + $ref: '#/components/schemas/SchedulerCallbackRequest' + contentType: application/json +components: + schemas: + SchedulerCallbackRequest: + description: SchedulerCallbackRequest is the request provided when a scheduled task fires. + properties: + scheduleId: + type: string + description: |- + ScheduleID is the unique identifier for this scheduled task. + This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + payload: + type: string + description: |- + Payload is the payload data that was provided when the task was scheduled. + Can be used to pass context or parameters to the callback handler. + isRecurring: + type: boolean + description: |- + IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + false if it's a one-time schedule (created via ScheduleOneTime). + required: + - scheduleId + - payload + - isRecurring diff --git a/plugins/capabilities/scrobbler.go b/plugins/capabilities/scrobbler.go new file mode 100644 index 000000000..4918d5e8f --- /dev/null +++ b/plugins/capabilities/scrobbler.go @@ -0,0 +1,136 @@ +package capabilities + +// Scrobbler provides scrobbling functionality to external services. +// This capability allows plugins to submit listening history to services like Last.fm, +// ListenBrainz, or custom scrobbling backends. +// +// All methods are required - plugins implementing this capability must provide +// all four functions: IsAuthorized, NowPlaying, Scrobble, and PlaybackReport. +// +//nd:capability name=scrobbler required=true +type Scrobbler interface { + // IsAuthorized checks if a user is authorized to scrobble to this service. + //nd:export name=nd_scrobbler_is_authorized + IsAuthorized(IsAuthorizedRequest) (bool, error) + + // NowPlaying sends a now playing notification to the scrobbling service. + //nd:export name=nd_scrobbler_now_playing + NowPlaying(NowPlayingRequest) error + + // Scrobble submits a completed scrobble to the scrobbling service. + //nd:export name=nd_scrobbler_scrobble + Scrobble(ScrobbleRequest) error + + // PlaybackReport sends a playback state report to the scrobbling service. + //nd:export name=nd_scrobbler_playback_report + PlaybackReport(PlaybackReportRequest) error +} + +// IsAuthorizedRequest is the request for authorization check. +type IsAuthorizedRequest struct { + // Username is the username of the user. + Username string `json:"username"` +} + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` + // LibraryID is the ID of the library the track belongs to. + // Only included if the plugin has library permission with filesystem access for the track's library. + LibraryID int32 `json:"libraryId,omitempty"` + // Path is the full path to the track file, relative to the library root. + // Only included if the plugin has library permission with filesystem access for the track's library. + Path string `json:"path,omitempty"` +} + +// NowPlayingRequest is the request for now playing notification. +type NowPlayingRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track currently playing. + Track TrackInfo `json:"track"` + // Position is the current playback position in seconds. + Position int32 `json:"position"` +} + +// ScrobbleRequest is the request for submitting a scrobble. +type ScrobbleRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track that was played. + Track TrackInfo `json:"track"` + // Timestamp is the Unix timestamp when the track started playing. + Timestamp int64 `json:"timestamp"` +} + +// PlaybackReportRequest is the request for playback report notifications. +type PlaybackReportRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track being played. + Track TrackInfo `json:"track"` + // State is the current playback state (starting/playing/paused/stopped/expired). + State string `json:"state"` + // PositionMs is the current playback position in milliseconds. + PositionMs int64 `json:"positionMs"` + // PlaybackRate is the playback speed (1.0 = normal). + PlaybackRate float64 `json:"playbackRate"` + // PlayerId is the unique client identifier. + PlayerId string `json:"playerId"` + // PlayerName is the human-readable player name. + PlayerName string `json:"playerName"` + // Timestamp is the Unix timestamp when this report was generated. + Timestamp int64 `json:"timestamp"` +} + +// ScrobblerError represents an error type for scrobbling operations. +type ScrobblerError string + +const ( + // ScrobblerErrorNotAuthorized indicates the user is not authorized. + ScrobblerErrorNotAuthorized ScrobblerError = "scrobbler(not_authorized)" + // ScrobblerErrorRetryLater indicates the operation should be retried later. + ScrobblerErrorRetryLater ScrobblerError = "scrobbler(retry_later)" + // ScrobblerErrorUnrecoverable indicates an unrecoverable error. + ScrobblerErrorUnrecoverable ScrobblerError = "scrobbler(unrecoverable)" +) + +// Error implements the error interface for ScrobblerError. +func (e ScrobblerError) Error() string { return string(e) } diff --git a/plugins/capabilities/scrobbler.yaml b/plugins/capabilities/scrobbler.yaml new file mode 100644 index 000000000..9d5cfed30 --- /dev/null +++ b/plugins/capabilities/scrobbler.yaml @@ -0,0 +1,196 @@ +version: v1-draft +exports: + nd_scrobbler_is_authorized: + description: IsAuthorized checks if a user is authorized to scrobble to this service. + input: + $ref: '#/components/schemas/IsAuthorizedRequest' + contentType: application/json + output: + type: boolean + contentType: application/json + nd_scrobbler_now_playing: + description: NowPlaying sends a now playing notification to the scrobbling service. + input: + $ref: '#/components/schemas/NowPlayingRequest' + contentType: application/json + nd_scrobbler_scrobble: + description: Scrobble submits a completed scrobble to the scrobbling service. + input: + $ref: '#/components/schemas/ScrobbleRequest' + contentType: application/json + nd_scrobbler_playback_report: + description: PlaybackReport sends a playback state report to the scrobbling service. + input: + $ref: '#/components/schemas/PlaybackReportRequest' + contentType: application/json +components: + schemas: + ArtistRef: + description: ArtistRef is a reference to an artist with name and optional MBID. + properties: + id: + type: string + description: ID is the internal Navidrome artist ID (if known). + name: + type: string + description: Name is the artist name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the artist. + required: + - name + IsAuthorizedRequest: + description: IsAuthorizedRequest is the request for authorization check. + properties: + username: + type: string + description: Username is the username of the user. + required: + - username + NowPlayingRequest: + description: NowPlayingRequest is the request for now playing notification. + properties: + username: + type: string + description: Username is the username of the user. + track: + $ref: '#/components/schemas/TrackInfo' + description: Track is the track currently playing. + position: + type: integer + format: int32 + description: Position is the current playback position in seconds. + required: + - username + - track + - position + PlaybackReportRequest: + description: PlaybackReportRequest is the request for playback report notifications. + properties: + username: + type: string + description: Username is the username of the user. + track: + $ref: '#/components/schemas/TrackInfo' + description: Track is the track being played. + state: + type: string + description: State is the current playback state (starting/playing/paused/stopped/expired). + positionMs: + type: integer + format: int64 + description: PositionMs is the current playback position in milliseconds. + playbackRate: + type: number + format: float + description: PlaybackRate is the playback speed (1.0 = normal). + playerId: + type: string + description: PlayerId is the unique client identifier. + playerName: + type: string + description: PlayerName is the human-readable player name. + timestamp: + type: integer + format: int64 + description: Timestamp is the Unix timestamp when this report was generated. + required: + - username + - track + - state + - positionMs + - playbackRate + - playerId + - playerName + - timestamp + ScrobbleRequest: + description: ScrobbleRequest is the request for submitting a scrobble. + properties: + username: + type: string + description: Username is the username of the user. + track: + $ref: '#/components/schemas/TrackInfo' + description: Track is the track that was played. + timestamp: + type: integer + format: int64 + description: Timestamp is the Unix timestamp when the track started playing. + required: + - username + - track + - timestamp + TrackInfo: + description: TrackInfo contains track metadata. + properties: + id: + type: string + description: ID is the internal Navidrome track ID. + title: + type: string + description: Title is the track title. + album: + type: string + description: Album is the album name. + artist: + type: string + description: Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + albumArtist: + type: string + description: AlbumArtist is the formatted album artist name for display. + artists: + type: array + description: Artists is the list of track artists. + items: + $ref: '#/components/schemas/ArtistRef' + albumArtists: + type: array + description: AlbumArtists is the list of album artists. + items: + $ref: '#/components/schemas/ArtistRef' + duration: + type: number + format: float + description: Duration is the track duration in seconds. + trackNumber: + type: integer + format: int32 + description: TrackNumber is the track number on the album. + discNumber: + type: integer + format: int32 + description: DiscNumber is the disc number. + mbzRecordingId: + type: string + description: MBZRecordingID is the MusicBrainz recording ID. + mbzAlbumId: + type: string + description: MBZAlbumID is the MusicBrainz album/release ID. + mbzReleaseGroupId: + type: string + description: MBZReleaseGroupID is the MusicBrainz release group ID. + mbzReleaseTrackId: + type: string + description: MBZReleaseTrackID is the MusicBrainz release track ID. + libraryId: + type: integer + format: int32 + description: |- + LibraryID is the ID of the library the track belongs to. + Only included if the plugin has library permission with filesystem access for the track's library. + path: + type: string + description: |- + Path is the full path to the track file, relative to the library root. + Only included if the plugin has library permission with filesystem access for the track's library. + required: + - id + - title + - album + - artist + - albumArtist + - artists + - albumArtists + - duration + - trackNumber + - discNumber diff --git a/plugins/capabilities/sonic_similarity.go b/plugins/capabilities/sonic_similarity.go new file mode 100644 index 000000000..aadb9396e --- /dev/null +++ b/plugins/capabilities/sonic_similarity.go @@ -0,0 +1,32 @@ +package capabilities + +// SonicSimilarity provides audio-similarity based track discovery. +// +//nd:capability name=sonicsimilarity required=true +type SonicSimilarity interface { + //nd:export name=nd_get_sonic_similar_tracks + GetSonicSimilarTracks(GetSonicSimilarTracksRequest) (SonicSimilarityResponse, error) + + //nd:export name=nd_find_sonic_path + FindSonicPath(FindSonicPathRequest) (SonicSimilarityResponse, error) +} + +type GetSonicSimilarTracksRequest struct { + Song SongRef `json:"song"` + Count int32 `json:"count"` +} + +type FindSonicPathRequest struct { + StartSong SongRef `json:"startSong"` + EndSong SongRef `json:"endSong"` + Count int32 `json:"count"` +} + +type SonicSimilarityResponse struct { + Matches []SonicMatch `json:"matches"` +} + +type SonicMatch struct { + Song SongRef `json:"song"` + Similarity float64 `json:"similarity"` +} diff --git a/plugins/capabilities/sonic_similarity.yaml b/plugins/capabilities/sonic_similarity.yaml new file mode 100644 index 000000000..cba97d9b0 --- /dev/null +++ b/plugins/capabilities/sonic_similarity.yaml @@ -0,0 +1,92 @@ +version: v1-draft +exports: + nd_get_sonic_similar_tracks: + input: + $ref: '#/components/schemas/GetSonicSimilarTracksRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SonicSimilarityResponse' + contentType: application/json + nd_find_sonic_path: + input: + $ref: '#/components/schemas/FindSonicPathRequest' + contentType: application/json + output: + $ref: '#/components/schemas/SonicSimilarityResponse' + contentType: application/json +components: + schemas: + FindSonicPathRequest: + properties: + startSong: + $ref: '#/components/schemas/SongRef' + endSong: + $ref: '#/components/schemas/SongRef' + count: + type: integer + format: int32 + required: + - startSong + - endSong + - count + GetSonicSimilarTracksRequest: + properties: + song: + $ref: '#/components/schemas/SongRef' + count: + type: integer + format: int32 + required: + - song + - count + SongRef: + description: SongRef is a reference to a song with metadata for matching. + properties: + id: + type: string + description: ID is the internal Navidrome mediafile ID (if known). + name: + type: string + description: Name is the song name. + mbid: + type: string + description: MBID is the MusicBrainz ID for the song. + isrc: + type: string + description: ISRC is the International Standard Recording Code for the song. + artist: + type: string + description: Artist is the artist name. + artistMbid: + type: string + description: ArtistMBID is the MusicBrainz artist ID. + album: + type: string + description: Album is the album name. + albumMbid: + type: string + description: AlbumMBID is the MusicBrainz release ID. + duration: + type: number + format: float + description: Duration is the song duration in seconds. + required: + - name + SonicMatch: + properties: + song: + $ref: '#/components/schemas/SongRef' + similarity: + type: number + format: float + required: + - song + - similarity + SonicSimilarityResponse: + properties: + matches: + type: array + items: + $ref: '#/components/schemas/SonicMatch' + required: + - matches diff --git a/plugins/capabilities/taskworker.go b/plugins/capabilities/taskworker.go new file mode 100644 index 000000000..c53d50174 --- /dev/null +++ b/plugins/capabilities/taskworker.go @@ -0,0 +1,27 @@ +package capabilities + +// TaskWorker provides task execution handling. +// This capability allows plugins to receive callbacks when their queued tasks +// are ready to execute. Plugins that use the taskqueue host service must +// implement this capability. +// +//nd:capability name=taskworker +type TaskWorker interface { + // OnTaskExecute is called when a queued task is ready to run. + // The returned string is a status/result message stored in the tasks table. + // Return an error to trigger retry (if retries are configured). + //nd:export name=nd_task_execute + OnTaskExecute(TaskExecuteRequest) (string, error) +} + +// TaskExecuteRequest is the request provided when a task is ready to execute. +type TaskExecuteRequest struct { + // QueueName is the name of the queue this task belongs to. + QueueName string `json:"queueName"` + // TaskID is the unique identifier for this task. + TaskID string `json:"taskId"` + // Payload is the opaque data provided when the task was enqueued. + Payload []byte `json:"payload"` + // Attempt is the current attempt number (1-based: first attempt = 1). + Attempt int32 `json:"attempt"` +} diff --git a/plugins/capabilities/taskworker.yaml b/plugins/capabilities/taskworker.yaml new file mode 100644 index 000000000..7aa7126e0 --- /dev/null +++ b/plugins/capabilities/taskworker.yaml @@ -0,0 +1,37 @@ +version: v1-draft +exports: + nd_task_execute: + description: |- + OnTaskExecute is called when a queued task is ready to run. + The returned string is a status/result message stored in the tasks table. + Return an error to trigger retry (if retries are configured). + input: + $ref: '#/components/schemas/TaskExecuteRequest' + contentType: application/json + output: + type: string + contentType: application/json +components: + schemas: + TaskExecuteRequest: + description: TaskExecuteRequest is the request provided when a task is ready to execute. + properties: + queueName: + type: string + description: QueueName is the name of the queue this task belongs to. + taskId: + type: string + description: TaskID is the unique identifier for this task. + payload: + type: string + format: byte + description: Payload is the opaque data provided when the task was enqueued. + attempt: + type: integer + format: int32 + description: 'Attempt is the current attempt number (1-based: first attempt = 1).' + required: + - queueName + - taskId + - payload + - attempt diff --git a/plugins/capabilities/websocket_callback.go b/plugins/capabilities/websocket_callback.go new file mode 100644 index 000000000..ddfc0fc95 --- /dev/null +++ b/plugins/capabilities/websocket_callback.go @@ -0,0 +1,61 @@ +package capabilities + +// WebSocketCallback provides WebSocket message handling. +// This capability allows plugins to receive callbacks for WebSocket events +// such as text messages, binary messages, errors, and connection closures. +// Plugins that use the WebSocket host service must implement this capability +// to handle incoming events. +// +//nd:capability name=websocket +type WebSocketCallback interface { + // OnTextMessage is called when a text message is received on a WebSocket connection. + //nd:export name=nd_websocket_on_text_message + OnTextMessage(OnTextMessageRequest) error + + // OnBinaryMessage is called when a binary message is received on a WebSocket connection. + //nd:export name=nd_websocket_on_binary_message + OnBinaryMessage(OnBinaryMessageRequest) error + + // OnError is called when an error occurs on a WebSocket connection. + //nd:export name=nd_websocket_on_error + OnError(OnErrorRequest) error + + // OnClose is called when a WebSocket connection is closed. + //nd:export name=nd_websocket_on_close + OnClose(OnCloseRequest) error +} + +// OnTextMessageRequest is the request provided when a text message is received. +type OnTextMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Message is the text message content received from the WebSocket. + Message string `json:"message"` +} + +// OnBinaryMessageRequest is the request provided when a binary message is received. +type OnBinaryMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Data is the binary data received from the WebSocket, encoded as base64. + Data []byte `json:"data"` +} + +// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +type OnErrorRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + ConnectionID string `json:"connectionId"` + // Error is the error message describing what went wrong. + Error string `json:"error"` +} + +// OnCloseRequest is the request provided when a WebSocket connection is closed. +type OnCloseRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that was closed. + ConnectionID string `json:"connectionId"` + // Code is the WebSocket close status code (e.g., 1000 for normal closure, + // 1001 for going away, 1006 for abnormal closure). + Code int32 `json:"code"` + // Reason is the human-readable reason for the connection closure, if provided. + Reason string `json:"reason"` +} diff --git a/plugins/capabilities/websocket_callback.yaml b/plugins/capabilities/websocket_callback.yaml new file mode 100644 index 000000000..6cd0cff9f --- /dev/null +++ b/plugins/capabilities/websocket_callback.yaml @@ -0,0 +1,80 @@ +version: v1-draft +exports: + nd_websocket_on_text_message: + description: OnTextMessage is called when a text message is received on a WebSocket connection. + input: + $ref: '#/components/schemas/OnTextMessageRequest' + contentType: application/json + nd_websocket_on_binary_message: + description: OnBinaryMessage is called when a binary message is received on a WebSocket connection. + input: + $ref: '#/components/schemas/OnBinaryMessageRequest' + contentType: application/json + nd_websocket_on_error: + description: OnError is called when an error occurs on a WebSocket connection. + input: + $ref: '#/components/schemas/OnErrorRequest' + contentType: application/json + nd_websocket_on_close: + description: OnClose is called when a WebSocket connection is closed. + input: + $ref: '#/components/schemas/OnCloseRequest' + contentType: application/json +components: + schemas: + OnBinaryMessageRequest: + description: OnBinaryMessageRequest is the request provided when a binary message is received. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection that received the message. + data: + type: string + format: byte + description: Data is the binary data received from the WebSocket, encoded as base64. + required: + - connectionId + - data + OnCloseRequest: + description: OnCloseRequest is the request provided when a WebSocket connection is closed. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection that was closed. + code: + type: integer + format: int32 + description: |- + Code is the WebSocket close status code (e.g., 1000 for normal closure, + 1001 for going away, 1006 for abnormal closure). + reason: + type: string + description: Reason is the human-readable reason for the connection closure, if provided. + required: + - connectionId + - code + - reason + OnErrorRequest: + description: OnErrorRequest is the request provided when an error occurs on a WebSocket connection. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + error: + type: string + description: Error is the error message describing what went wrong. + required: + - connectionId + - error + OnTextMessageRequest: + description: OnTextMessageRequest is the request provided when a text message is received. + properties: + connectionId: + type: string + description: ConnectionID is the unique identifier for the WebSocket connection that received the message. + message: + type: string + description: Message is the text message content received from the WebSocket. + required: + - connectionId + - message diff --git a/plugins/capabilities_test.go b/plugins/capabilities_test.go new file mode 100644 index 000000000..35fc3910a --- /dev/null +++ b/plugins/capabilities_test.go @@ -0,0 +1,81 @@ +package plugins + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// mockFunctionChecker implements functionExistsChecker for testing +type mockFunctionChecker struct { + functions map[string]bool +} + +func (m *mockFunctionChecker) FunctionExists(name string) bool { + return m.functions[name] +} + +var _ = Describe("Capabilities", func() { + Describe("detectCapabilities", func() { + It("detects MetadataAgent capability when plugin exports artist biography function", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{ + FuncGetArtistBiography: true, + }, + } + + caps := detectCapabilities(checker) + Expect(caps).To(ContainElement(CapabilityMetadataAgent)) + }) + + It("detects MetadataAgent capability when plugin exports multiple functions", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{ + FuncGetArtistMBID: true, + FuncGetArtistURL: true, + FuncGetAlbumInfo: true, + FuncGetAlbumImages: true, + }, + } + + caps := detectCapabilities(checker) + Expect(caps).To(ContainElement(CapabilityMetadataAgent)) + Expect(caps).To(HaveLen(1)) // Should only have one MetadataAgent capability + }) + + It("returns empty slice when no capability functions are exported", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{ + "some_other_function": true, + }, + } + + caps := detectCapabilities(checker) + Expect(caps).To(BeEmpty()) + }) + + It("returns empty slice when plugin exports no functions", func() { + checker := &mockFunctionChecker{ + functions: map[string]bool{}, + } + + caps := detectCapabilities(checker) + Expect(caps).To(BeEmpty()) + }) + }) + + Describe("hasCapability", func() { + It("returns true when capability exists", func() { + caps := []Capability{CapabilityMetadataAgent} + Expect(hasCapability(caps, CapabilityMetadataAgent)).To(BeTrue()) + }) + + It("returns false when capability does not exist", func() { + var caps []Capability + Expect(hasCapability(caps, CapabilityMetadataAgent)).To(BeFalse()) + }) + + It("returns false when capabilities slice is nil", func() { + Expect(hasCapability(nil, CapabilityMetadataAgent)).To(BeFalse()) + }) + }) +}) diff --git a/plugins/capability_lifecycle.go b/plugins/capability_lifecycle.go new file mode 100644 index 000000000..499e3916d --- /dev/null +++ b/plugins/capability_lifecycle.go @@ -0,0 +1,38 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/log" +) + +// CapabilityLifecycle indicates the plugin has lifecycle callback functions. +// Detected when the plugin exports the nd_on_init function. +const CapabilityLifecycle Capability = "Lifecycle" + +const FuncOnInit = "nd_on_init" + +func init() { + registerCapability( + CapabilityLifecycle, + FuncOnInit, + ) +} + +// callPluginInit calls the plugin's nd_on_init function if it has the Lifecycle capability. +// This is called after the plugin is fully loaded with all services registered. +func callPluginInit(ctx context.Context, instance *plugin) { + if !hasCapability(instance.capabilities, CapabilityLifecycle) { + return + } + + log.Debug(ctx, "Calling plugin init function", "plugin", instance.name) + + err := callPluginFunctionNoInput(ctx, instance, FuncOnInit) + if err != nil { + log.Error(ctx, "Plugin init function failed", "plugin", instance.name, err) + return + } + + log.Debug(ctx, "Plugin init function completed", "plugin", instance.name) +} diff --git a/plugins/cmd/ndpgen/.gitignore b/plugins/cmd/ndpgen/.gitignore new file mode 100644 index 000000000..315ccc05f --- /dev/null +++ b/plugins/cmd/ndpgen/.gitignore @@ -0,0 +1 @@ +ndpgen \ No newline at end of file diff --git a/plugins/cmd/ndpgen/README.md b/plugins/cmd/ndpgen/README.md new file mode 100644 index 000000000..d2f67a60c --- /dev/null +++ b/plugins/cmd/ndpgen/README.md @@ -0,0 +1,198 @@ +# ndpgen + +Navidrome Plugin Development Kit (PDK) code generator. It reads Go interface definitions with special annotations and generates client wrappers for WASM plugins. + +This tool is the unified code generator that handle both host function wrappers and capability wrappers. + +## Usage + +```bash +ndpgen -input -output [-package ] [-v] [-dry-run] [-host-only] [-go] [-python] [-rust] +``` + +### Flags + +| Flag | Description | Default | +|--------------|----------------------------------------------------------------|----------------------| +| `-input` | Directory containing Go source files with annotated interfaces | Required | +| `-output` | Directory where generated files will be written | Same as input | +| `-package` | Package name for generated files | Inferred from output | +| `-v` | Verbose output | `false` | +| `-dry-run` | Parse and validate without writing files | `false` | +| `-host-only` | Generate only host function wrappers (capability support TBD) | `true` | +| `-go` | Generate Go client wrappers | `true`* | +| `-python` | Generate Python client wrappers | `false` | +| `-rust` | Generate Rust client wrappers | `false` | + +\* `-go` is enabled by default when neither `-python` nor `-rust` is specified. Use combinations like `-go -python -rust` to generate multiple languages. + +### Example + +```bash +go run ./plugins/cmd/ndpgen \ + -input ./plugins/host \ + -output ./plugins/pdk +``` + +## Annotations + +### `//nd:hostservice` + +Marks an interface as a host service that will have wrappers generated. + +```go +//nd:hostservice name= permission= +type MyService interface { ... } +``` + +| Parameter | Description | Required | +|--------------|-----------------------------------------------------------------|----------| +| `name` | Service name used in generated type names and function prefixes | Yes | +| `permission` | Permission required by plugins to use this service | Yes | + +### `//nd:hostfunc` + +Marks a method within a host service interface for export to plugins. + +```go +//nd:hostfunc [name=] +MethodName(ctx context.Context, ...) (result Type, err error) +``` + +| Parameter | Description | Required | +|-----------|-------------------------------------------------------------------------|----------| +| `name` | Custom export name (default: `_` in lowercase) | No | + +## Input Format + +Host service interfaces must follow these conventions: + +1. **First parameter must be `context.Context`** - Required for all methods +2. **Last return value should be `error`** - For proper error handling +3. **Annotations must be on consecutive lines** - No blank comment lines between doc and annotation + +### Example Interface + +```go +package host + +import "context" + +// SubsonicAPIService provides access to Navidrome's Subsonic API. +// This documentation becomes part of the generated code. +//nd:hostservice name=SubsonicAPI permission=subsonicapi +type SubsonicAPIService interface { + // Call executes a Subsonic API request and returns the response. + //nd:hostfunc + Call(ctx context.Context, uri string) (response string, err error) +} +``` + +## Generated Output + +### Go Client Library (Go/TinyGo WASM) + +Generated files are named `nd_host_.go` (lowercase) and placed in `$output/go/host/`. The `$output/go/` directory becomes a complete Go module (`github.com/navidrome/navidrome/plugins/pdk/go`) with package name `host`, intended for import by Navidrome plugins built with TinyGo. + +The generator creates: +- `nd_host_.go` - Client wrapper code (WASM build) +- `nd_host__stub.go` - Mock implementations for non-WASM platforms (testing) +- `doc.go` - Package documentation listing all available services +- `go.mod` - Go module file with required dependencies + +Each service file includes: + +- `// Code generated by ndpgen. DO NOT EDIT.` header +- Required imports (`encoding/json`, `errors`, `github.com/extism/go-pdk`) +- `//go:wasmimport` declarations for each host function +- Response struct types and any struct definitions from the service +- Wrapper functions that handle memory allocation and JSON parsing + +### Testing Plugins with Mocks + +The stub files (`*_stub.go`) contain [testify/mock](https://github.com/stretchr/testify) implementations that allow plugin authors to unit test their code on non-WASM platforms. + +Each host service has: +- A private mock struct embedding `mock.Mock` +- An exported auto-instantiated mock instance (e.g., `host.CacheMock`, `host.ArtworkMock`) +- Wrapper functions that delegate to the mock + +**Example: Testing a plugin that uses the Cache service** + +```go +package myplugin + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" +) + +func TestMyPluginFunction(t *testing.T) { + // Set expectations on the mock + host.CacheMock.On("GetString", "my-key").Return("cached-value", true, nil) + host.CacheMock.On("SetString", "new-key", "new-value", int64(3600)).Return(nil) + + // Call your plugin code that uses host.CacheGetString and host.CacheSetString + result := myPluginFunction() + + // Assert the result + if result != "expected" { + t.Errorf("unexpected result: %s", result) + } + + // Verify all expected calls were made + host.CacheMock.AssertExpectations(t) +} +``` + +**Resetting mocks between tests:** + +If you need to reset mock state between tests, testify's mock doesn't have a built-in reset. Either use separate test functions (testify automatically resets between test runs), or create a helper to set up fresh expectations. + +### Python Client Library + +When using `-python`, Python client files are generated in a `python/` subdirectory. + +### Rust Client Library + +When using `-rust`, Rust client files are generated in a `rust/` subdirectory. + +## Supported Types + +ndpgen supports these Go types in method signatures: + +| Type | JSON Representation | +|-------------------------------|------------------------------------------| +| `string`, `int`, `bool`, etc. | Native JSON types | +| `[]T` (slices) | JSON arrays | +| `map[K]V` (maps) | JSON objects | +| `*T` (pointers) | Nullable fields | +| `interface{}` / `any` | Converts to `any` | +| Custom structs | JSON objects (must be JSON-serializable) | + +### Multiple Return Values + +Methods can return multiple values (plus error): + +```go +//nd:hostfunc +Search(ctx context.Context, query string) (results []string, total int, hasMore bool, err error) +``` + +Generates: + +```go +type ServiceSearchResponse struct { + Results []string `json:"results,omitempty"` + Total int `json:"total,omitempty"` + HasMore bool `json:"hasMore,omitempty"` + Error string `json:"error,omitempty"` +} +``` + +## Running Tests + +```bash +go test ./plugins/cmd/ndpgen/... +``` diff --git a/plugins/cmd/ndpgen/go.mod b/plugins/cmd/ndpgen/go.mod new file mode 100644 index 000000000..af9fce441 --- /dev/null +++ b/plugins/cmd/ndpgen/go.mod @@ -0,0 +1,26 @@ +module github.com/navidrome/navidrome/plugins/cmd/ndpgen + +go 1.25 + +require ( + github.com/extism/go-pdk v1.1.3 + github.com/onsi/ginkgo/v2 v2.27.5 + github.com/onsi/gomega v1.39.0 + github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 + golang.org/x/tools v0.41.0 + gopkg.in/yaml.v3 v3.0.1 +) + +require ( + github.com/Masterminds/semver/v3 v3.4.0 // indirect + github.com/go-logr/logr v1.4.3 // indirect + github.com/go-task/slim-sprig/v3 v3.0.0 // indirect + github.com/google/go-cmp v0.7.0 // indirect + github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 // indirect + go.yaml.in/yaml/v3 v3.0.4 // indirect + golang.org/x/mod v0.32.0 // indirect + golang.org/x/net v0.49.0 // indirect + golang.org/x/sync v0.19.0 // indirect + golang.org/x/sys v0.40.0 // indirect + golang.org/x/text v0.33.0 // indirect +) diff --git a/plugins/cmd/ndpgen/go.sum b/plugins/cmd/ndpgen/go.sum new file mode 100644 index 000000000..952672d0e --- /dev/null +++ b/plugins/cmd/ndpgen/go.sum @@ -0,0 +1,75 @@ +github.com/Masterminds/semver/v3 v3.4.0 h1:Zog+i5UMtVoCU8oKka5P7i9q9HgrJeGzI9SA1Xbatp0= +github.com/Masterminds/semver/v3 v3.4.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI= +github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/gkampitakis/ciinfo v0.3.2 h1:JcuOPk8ZU7nZQjdUhctuhQofk7BGHuIy0c9Ez8BNhXs= +github.com/gkampitakis/ciinfo v0.3.2/go.mod h1:1NIwaOcFChN4fa/B0hEBdAb6npDlFL8Bwx4dfRLRqAo= +github.com/gkampitakis/go-diff v1.3.2 h1:Qyn0J9XJSDTgnsgHRdz9Zp24RaJeKMUHg2+PDZZdC4M= +github.com/gkampitakis/go-diff v1.3.2/go.mod h1:LLgOrpqleQe26cte8s36HTWcTmMEur6OPYerdAAS9tk= +github.com/gkampitakis/go-snaps v0.5.15 h1:amyJrvM1D33cPHwVrjo9jQxX8g/7E2wYdZ+01KS3zGE= +github.com/gkampitakis/go-snaps v0.5.15/go.mod h1:HNpx/9GoKisdhw9AFOBT1N7DBs9DiHo/hGheFGBZ+mc= +github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= +github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI= +github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8= +github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw= +github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83 h1:z2ogiKUYzX5Is6zr/vP9vJGqPwcdqsWjOt+V8J7+bTc= +github.com/google/pprof v0.0.0-20260115054156-294ebfa9ad83/go.mod h1:MxpfABSjhmINe3F1It9d+8exIHFvUqtLIRCdOGNXqiI= +github.com/joshdk/go-junit v1.0.0 h1:S86cUKIdwBHWwA6xCmFlf3RTLfVXYQfvanM5Uh+K6GE= +github.com/joshdk/go-junit v1.0.0/go.mod h1:TiiV0PqkaNfFXjEiyjWM3XXrhVyCa1K4Zfga6W52ung= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/maruel/natural v1.1.1 h1:Hja7XhhmvEFhcByqDoHz9QZbkWey+COd9xWfCfn1ioo= +github.com/maruel/natural v1.1.1/go.mod h1:v+Rfd79xlw1AgVBjbO0BEQmptqb5HvL/k9GRHB7ZKEg= +github.com/mfridman/tparse v0.18.0 h1:wh6dzOKaIwkUGyKgOntDW4liXSo37qg5AXbIhkMV3vE= +github.com/mfridman/tparse v0.18.0/go.mod h1:gEvqZTuCgEhPbYk/2lS3Kcxg1GmTxxU7kTC8DvP0i/A= +github.com/onsi/ginkgo/v2 v2.27.5 h1:ZeVgZMx2PDMdJm/+w5fE/OyG6ILo1Y3e+QX4zSR0zTE= +github.com/onsi/ginkgo/v2 v2.27.5/go.mod h1:ArE1D/XhNXBXCBkKOLkbsb2c81dQHCRcF5zwn/ykDRo= +github.com/onsi/gomega v1.39.0 h1:y2ROC3hKFmQZJNFeGAMeHZKkjBL65mIZcvrLQBF9k6Q= +github.com/onsi/gomega v1.39.0/go.mod h1:ZCU1pkQcXDO5Sl9/VVEGlDyp+zm0m1cmeG5TOzLgdh4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII= +github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ= +github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY= +github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4= +github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= +github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY= +github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28= +go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc= +go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg= +golang.org/x/mod v0.32.0 h1:9F4d3PHLljb6x//jOyokMv3eX+YDeepZSEo3mFJy93c= +golang.org/x/mod v0.32.0/go.mod h1:SgipZ/3h2Ci89DlEtEXWUk/HteuRin+HHhN+WbNhguU= +golang.org/x/net v0.49.0 h1:eeHFmOGUTtaaPSGNmjBKpbng9MulQsJURQUAfUwY++o= +golang.org/x/net v0.49.0/go.mod h1:/ysNB2EvaqvesRkuLAyjI1ycPZlQHM3q01F02UY/MV8= +golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4= +golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI= +golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ= +golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks= +golang.org/x/text v0.33.0 h1:B3njUFyqtHDUI5jMn1YIr5B0IE2U0qck04r6d4KPAxE= +golang.org/x/text v0.33.0/go.mod h1:LuMebE6+rBincTi9+xWTY8TztLzKHc/9C1uBCG27+q8= +golang.org/x/tools v0.41.0 h1:a9b8iMweWG+S0OBnlU36rzLp20z1Rp10w+IY2czHTQc= +golang.org/x/tools v0.41.0/go.mod h1:XSY6eDqxVNiYgezAVqqCeihT4j1U2CCsqvH3WhQpnlg= +google.golang.org/protobuf v1.36.7 h1:IgrO7UwFQGJdRNXH/sQux4R1Dj1WAKcLElzeeRaXV2A= +google.golang.org/protobuf v1.36.7/go.mod h1:jduwjTPXsFjZGTmRluh+L6NjiWu7pchiJ2/5YcXBHnY= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 h1:qIbj1fsPNlZgppZ+VLlY7N33q108Sa+fhmuc+sWQYwY= +gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/cmd/ndpgen/integration_test.go b/plugins/cmd/ndpgen/integration_test.go new file mode 100644 index 000000000..db500c1fc --- /dev/null +++ b/plugins/cmd/ndpgen/integration_test.go @@ -0,0 +1,534 @@ +package main + +import ( + "fmt" + "go/format" + "os" + "os/exec" + "path/filepath" + "strings" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// normalizeGeneratedCode normalizes generated code for comparison with expected output. +func normalizeGeneratedCode(code string) string { + // Replace package names (generated uses ndpdk, testdata may use ndhost) + code = strings.ReplaceAll(code, "package ndhost", "package ndpdk") + return code +} + +var _ = Describe("ndpgen CLI", Ordered, func() { + var ( + testDir string + outputDir string + ndpgenBin string + ) + + BeforeAll(func() { + // Set testdata directory (relative to ndpgen root) + testdataDir = filepath.Join(mustGetWd(GinkgoT()), "testdata") + + // Build the ndpgen binary + ndpgenBin = filepath.Join(os.TempDir(), "ndpgen-test") + cmd := exec.Command("go", "build", "-o", ndpgenBin, ".") + cmd.Dir = mustGetWd(GinkgoT()) + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Failed to build ndpgen: %s", output) + DeferCleanup(func() { + os.Remove(ndpgenBin) + }) + }) + + BeforeEach(func() { + var err error + testDir, err = os.MkdirTemp("", "ndpgen-test-input-*") + Expect(err).ToNot(HaveOccurred()) + outputDir, err = os.MkdirTemp("", "ndpgen-test-output-*") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(testDir) + os.RemoveAll(outputDir) + }) + + Describe("CLI flags and behavior", func() { + BeforeEach(func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + DoAction(ctx context.Context, input string) (output string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + }) + + It("supports verbose mode", func() { + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-v") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + outputStr := string(output) + Expect(outputStr).To(ContainSubstring("Input directory:")) + Expect(outputStr).To(ContainSubstring("Base output directory:")) + Expect(outputStr).To(ContainSubstring("Go output directory:")) + Expect(outputStr).To(ContainSubstring("Found 1 host service(s)")) + Expect(outputStr).To(ContainSubstring("Generated")) + }) + + It("supports dry-run mode", func() { + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-dry-run") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + Expect(string(output)).To(ContainSubstring("func TestDoAction(")) + Expect(filepath.Join(outputDir, "nd_host_test.go")).ToNot(BeAnExistingFile()) + }) + + It("uses default package name 'host'", func() { + customOutput, err := os.MkdirTemp("", "mypkg") + Expect(err).ToNot(HaveOccurred()) + defer os.RemoveAll(customOutput) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", customOutput) + _, err = cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred()) + + // Go code goes to $output/go/host/ + content, err := os.ReadFile(filepath.Join(customOutput, "go", "host", "nd_host_test.go")) + Expect(err).ToNot(HaveOccurred()) + Expect(string(content)).To(ContainSubstring("package host")) + }) + + It("returns error for invalid input directory", func() { + cmd := exec.Command(ndpgenBin, "-input", "/nonexistent/path") + output, err := cmd.CombinedOutput() + Expect(err).To(HaveOccurred()) + Expect(string(output)).To(ContainSubstring("parsing source files")) + }) + + It("handles no annotated services gracefully", func() { + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte("package testpkg\n"), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-v") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + Expect(string(output)).To(ContainSubstring("No host services found")) + }) + + It("generates separate files for multiple services", func() { + // Remove service.go created by BeforeEach + Expect(os.Remove(filepath.Join(testDir, "service.go"))).To(Succeed()) + + service1 := `package testpkg +import "context" +//nd:hostservice name=ServiceA permission=a +type ServiceA interface { + //nd:hostfunc + MethodA(ctx context.Context) error +} +` + service2 := `package testpkg +import "context" +//nd:hostservice name=ServiceB permission=b +type ServiceB interface { + //nd:hostfunc + MethodB(ctx context.Context) error +} +` + Expect(os.WriteFile(filepath.Join(testDir, "a.go"), []byte(service1), 0600)).To(Succeed()) + Expect(os.WriteFile(filepath.Join(testDir, "b.go"), []byte(service2), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-v") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + Expect(string(output)).To(ContainSubstring("Found 2 host service(s)")) + + // Go code goes to $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + Expect(filepath.Join(goHostDir, "nd_host_servicea.go")).To(BeAnExistingFile()) + Expect(filepath.Join(goHostDir, "nd_host_serviceb.go")).To(BeAnExistingFile()) + }) + + It("generates Go client code by default", func() { + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Go client code goes to $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + Expect(filepath.Join(goHostDir, "nd_host_test.go")).To(BeAnExistingFile()) + // Stub file also generated + Expect(filepath.Join(goHostDir, "nd_host_test_stub.go")).To(BeAnExistingFile()) + // doc.go in host dir + Expect(filepath.Join(goHostDir, "doc.go")).To(BeAnExistingFile()) + // go.mod at parent $output/go/ for consolidated module + goDir := filepath.Join(outputDir, "go") + Expect(filepath.Join(goDir, "go.mod")).To(BeAnExistingFile()) + }) + }) + + Describe("code generation", func() { + DescribeTable("generates correct client output", + func(serviceFile, goClientExpectedFile, pyClientExpectedFile, rsClientExpectedFile string) { + serviceCode := readTestdata(serviceFile) + goClientExpected := readTestdata(goClientExpectedFile) + pyClientExpected := readTestdata(pyClientExpectedFile) + rsClientExpected := readTestdata(rsClientExpectedFile) + + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + // Generate all client code (Go, Python, Rust) + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-go", "-python", "-rust") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Verify Go client code (now in $output/go/host/) + goHostDir := filepath.Join(outputDir, "go", "host") + entries, err := os.ReadDir(goHostDir) + Expect(err).ToNot(HaveOccurred()) + + var goClientFiles []string + for _, e := range entries { + if !e.IsDir() && + !strings.HasSuffix(e.Name(), "_stub.go") && + e.Name() != "doc.go" && e.Name() != "go.mod" { + goClientFiles = append(goClientFiles, e.Name()) + } + } + Expect(goClientFiles).To(HaveLen(1), "Expected exactly one Go client file, got: %v", goClientFiles) + + goClientActual, err := os.ReadFile(filepath.Join(goHostDir, goClientFiles[0])) + Expect(err).ToNot(HaveOccurred()) + + formattedGoClientActual, err := format.Source(goClientActual) + Expect(err).ToNot(HaveOccurred(), "Generated Go client code is not valid Go:\n%s", goClientActual) + + // Normalize expected code to match ndpgen output format + normalizedExpected := normalizeGeneratedCode(goClientExpected) + formattedGoClientExpected, err := format.Source([]byte(normalizedExpected)) + Expect(err).ToNot(HaveOccurred(), "Expected Go client code is not valid Go") + + Expect(string(formattedGoClientActual)).To(Equal(string(formattedGoClientExpected)), "Go client code mismatch") + + // Verify Python client code (now in $output/python/host/) + pythonHostDir := filepath.Join(outputDir, "python", "host") + pyClientEntries, err := os.ReadDir(pythonHostDir) + Expect(err).ToNot(HaveOccurred()) + Expect(pyClientEntries).To(HaveLen(1), "Expected exactly one Python client file") + + pyClientActual, err := os.ReadFile(filepath.Join(pythonHostDir, pyClientEntries[0].Name())) + Expect(err).ToNot(HaveOccurred()) + + Expect(string(pyClientActual)).To(Equal(pyClientExpected), "Python client code mismatch") + + // Verify Rust client code (now in $output/rust/nd-pdk-host/src/) + rustSrcDir := filepath.Join(outputDir, "rust", "nd-pdk-host", "src") + rsClientEntries, err := os.ReadDir(rustSrcDir) + Expect(err).ToNot(HaveOccurred()) + Expect(rsClientEntries).To(HaveLen(2), "Expected Rust client file and lib.rs in src/") + + // Find the client file (not lib.rs) + var rsClientName string + for _, entry := range rsClientEntries { + if entry.Name() != "lib.rs" { + rsClientName = entry.Name() + break + } + } + Expect(rsClientName).ToNot(BeEmpty(), "Expected to find Rust client file") + + rsClientActual, err := os.ReadFile(filepath.Join(rustSrcDir, rsClientName)) + Expect(err).ToNot(HaveOccurred()) + + Expect(string(rsClientActual)).To(Equal(rsClientExpected), "Rust client code mismatch") + }, + + Entry("simple string params", + "echo_service.go.txt", "echo_client_expected.go.txt", "echo_client_expected.py", "echo_client_expected.rs"), + + Entry("multiple simple params (int32)", + "math_service.go.txt", "math_client_expected.go.txt", "math_client_expected.py", "math_client_expected.rs"), + + Entry("struct param with request type", + "store_service.go.txt", "store_client_expected.go.txt", "store_client_expected.py", "store_client_expected.rs"), + + Entry("mixed simple and complex params", + "list_service.go.txt", "list_client_expected.go.txt", "list_client_expected.py", "list_client_expected.rs"), + + Entry("method without error", + "counter_service.go.txt", "counter_client_expected.go.txt", "counter_client_expected.py", "counter_client_expected.rs"), + + Entry("no params, error only", + "ping_service.go.txt", "ping_client_expected.go.txt", "ping_client_expected.py", "ping_client_expected.rs"), + + Entry("map and interface types", + "meta_service.go.txt", "meta_client_expected.go.txt", "meta_client_expected.py", "meta_client_expected.rs"), + + Entry("pointer types", + "users_service.go.txt", "users_client_expected.go.txt", "users_client_expected.py", "users_client_expected.rs"), + + Entry("multiple returns", + "search_service.go.txt", "search_client_expected.go.txt", "search_client_expected.py", "search_client_expected.rs"), + + Entry("bytes", + "codec_service.go.txt", "codec_client_expected.go.txt", "codec_client_expected.py", "codec_client_expected.rs"), + + Entry("option pattern (value, exists bool)", + "config_service.go.txt", "config_client_expected.go.txt", "config_client_expected.py", "config_client_expected.rs"), + ) + + It("generates compilable client code for comprehensive service", func() { + serviceCode := readTestdata("comprehensive_service.go.txt") + + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + // Generate client code + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Generation failed: %s", output) + + // Go code goes to $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + + // Read generated client code + entries, err := os.ReadDir(goHostDir) + Expect(err).ToNot(HaveOccurred()) + + // Find the client file + var clientFileName string + for _, entry := range entries { + name := entry.Name() + if name != "doc.go" && name != "go.mod" && !strings.HasSuffix(name, "_stub.go") && strings.HasSuffix(name, ".go") { + clientFileName = name + break + } + } + Expect(clientFileName).ToNot(BeEmpty(), "Expected to find Go client file") + + content, err := os.ReadFile(filepath.Join(goHostDir, clientFileName)) + Expect(err).ToNot(HaveOccurred()) + + // Verify key expected content + contentStr := string(content) + // Should have wasmimport declarations for all methods + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_simpleparams")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_structparam")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_noerror")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_noparams")) + Expect(contentStr).To(ContainSubstring("//go:wasmimport extism:host/user comprehensive_noparamsnoreturns")) + + // Should have response types for methods with complex returns (private types in client code) + Expect(contentStr).To(ContainSubstring("type comprehensiveSimpleParamsResponse struct")) + Expect(contentStr).To(ContainSubstring("type comprehensiveMultipleReturnsResponse struct")) + + // Should have wrapper functions + Expect(contentStr).To(ContainSubstring("func ComprehensiveSimpleParams(")) + Expect(contentStr).To(ContainSubstring("func ComprehensiveNoParams()")) + Expect(contentStr).To(ContainSubstring("func ComprehensiveNoParamsNoReturns()")) + + // Create a plugin directory with proper import structure + pluginDir := filepath.Join(outputDir, "plugin") + Expect(os.MkdirAll(pluginDir, 0750)).To(Succeed()) + + // go.mod is at parent $output/go/ for consolidated module + goDir := filepath.Join(outputDir, "go") + + // Create go.mod for the plugin that imports the generated library + goMod := fmt.Sprintf(`module testplugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +replace github.com/navidrome/navidrome/plugins/pdk/go => %s +`, goDir) + Expect(os.WriteFile(filepath.Join(pluginDir, "go.mod"), []byte(goMod), 0600)).To(Succeed()) + + // Add a simple main function that imports and uses the ndpdk package + mainGo := `package main + +import ndpdk "github.com/navidrome/navidrome/plugins/pdk/go/host" + +func main() {} + +// Use some functions to ensure import is not unused +var _ = ndpdk.ComprehensiveNoParams +` + Expect(os.WriteFile(filepath.Join(pluginDir, "main.go"), []byte(mainGo), 0600)).To(Succeed()) + + // Tidy dependencies for the generated go library + goTidyLibCmd := exec.Command("go", "mod", "tidy") + goTidyLibCmd.Dir = goDir + goTidyLibOutput, err := goTidyLibCmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "go mod tidy (library) failed: %s", goTidyLibOutput) + + // Tidy dependencies for the plugin + goTidyCmd := exec.Command("go", "mod", "tidy") + goTidyCmd.Dir = pluginDir + goTidyOutput, err := goTidyCmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "go mod tidy (plugin) failed: %s", goTidyOutput) + + // Build as WASM plugin - this validates the client code compiles correctly + buildCmd := exec.Command("go", "build", "-buildmode=c-shared", "-o", "plugin.wasm", ".") + buildCmd.Dir = pluginDir + buildCmd.Env = append(os.Environ(), "GOOS=wasip1", "GOARCH=wasm") + buildOutput, err := buildCmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "WASM build failed: %s", buildOutput) + + // Verify .wasm file was created + Expect(filepath.Join(pluginDir, "plugin.wasm")).To(BeAnExistingFile()) + }) + + It("generates Python client code with -python flag", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + DoAction(ctx context.Context, input string) (output string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Verify Python client code exists in $output/python/host/ + pythonHostDir := filepath.Join(outputDir, "python", "host") + Expect(pythonHostDir).To(BeADirectory()) + + pythonFile := filepath.Join(pythonHostDir, "nd_host_test.py") + Expect(pythonFile).To(BeAnExistingFile()) + + content, err := os.ReadFile(pythonFile) + Expect(err).ToNot(HaveOccurred()) + + contentStr := string(content) + Expect(contentStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + Expect(contentStr).To(ContainSubstring("class HostFunctionError(Exception):")) + Expect(contentStr).To(ContainSubstring(`@extism.import_fn("extism:host/user", "test_doaction")`)) + Expect(contentStr).To(ContainSubstring("def test_do_action(input: str) -> str:")) + }) + + It("generates both Go and Python client code with -go -python flags", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + DoAction(ctx context.Context, input string) (output string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-go", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + // Verify Go client code exists in $output/go/host/ + goHostDir := filepath.Join(outputDir, "go", "host") + Expect(filepath.Join(goHostDir, "nd_host_test.go")).To(BeAnExistingFile()) + + // Verify Python client code exists in $output/python/host/ + pythonHostDir := filepath.Join(outputDir, "python", "host") + Expect(pythonHostDir).To(BeADirectory()) + Expect(filepath.Join(pythonHostDir, "nd_host_test.py")).To(BeAnExistingFile()) + }) + + It("generates Python code with dataclass for multi-value returns", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Cache permission=cache +type CacheService interface { + //nd:hostfunc + GetString(ctx context.Context, key string) (value string, exists bool, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + content, err := os.ReadFile(filepath.Join(outputDir, "python", "host", "nd_host_cache.py")) + Expect(err).ToNot(HaveOccurred()) + + contentStr := string(content) + Expect(contentStr).To(ContainSubstring("@dataclass")) + Expect(contentStr).To(ContainSubstring("class CacheGetStringResult:")) + Expect(contentStr).To(ContainSubstring("value: str")) + Expect(contentStr).To(ContainSubstring("exists: bool")) + Expect(contentStr).To(ContainSubstring("def cache_get_string(key: str) -> CacheGetStringResult:")) + }) + + It("generates Python code for methods with no parameters", func() { + serviceCode := `package testpkg + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + Ping(ctx context.Context) (status string, err error) +} +` + Expect(os.WriteFile(filepath.Join(testDir, "service.go"), []byte(serviceCode), 0600)).To(Succeed()) + + cmd := exec.Command(ndpgenBin, "-input", testDir, "-output", outputDir, "-package", "ndpdk", "-python") + output, err := cmd.CombinedOutput() + Expect(err).ToNot(HaveOccurred(), "Command failed: %s", output) + + content, err := os.ReadFile(filepath.Join(outputDir, "python", "host", "nd_host_test.py")) + Expect(err).ToNot(HaveOccurred()) + + contentStr := string(content) + Expect(contentStr).To(ContainSubstring("def test_ping() -> str:")) + Expect(contentStr).To(ContainSubstring(`request_bytes = b"{}"`)) + }) + }) +}) + +var testdataDir string + +func readTestdata(filename string) string { + content, err := os.ReadFile(filepath.Join(testdataDir, filename)) + Expect(err).ToNot(HaveOccurred(), "Failed to read testdata file: %s", filename) + return string(content) +} + +func mustGetWd(t FullGinkgoTInterface) string { + dir, err := os.Getwd() + if err != nil { + t.Fatal(err) + } + // Look for ndpgen's own go.mod (the subproject root) + for { + goModPath := filepath.Join(dir, "go.mod") + if _, err := os.Stat(goModPath); err == nil { + // Check if this is the ndpgen go.mod by reading it + content, err := os.ReadFile(goModPath) + if err == nil && strings.Contains(string(content), "plugins/cmd/ndpgen") { + return dir + } + } + parent := filepath.Dir(dir) + if parent == dir { + t.Fatal("could not find ndpgen project root") + } + dir = parent + } +} diff --git a/plugins/cmd/ndpgen/internal/generator.go b/plugins/cmd/ndpgen/internal/generator.go new file mode 100644 index 000000000..705cd4d36 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/generator.go @@ -0,0 +1,889 @@ +package internal + +import ( + "bytes" + "embed" + "fmt" + "strings" + "text/template" +) + +//go:embed templates/*.tmpl +var templatesFS embed.FS + +// hostFuncMap returns the template functions for host code generation. +func hostFuncMap(svc Service) template.FuncMap { + return template.FuncMap{ + "lower": strings.ToLower, + "title": strings.Title, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "requestType": func(m Method) string { return m.RequestTypeName(svc.Name) }, + "responseType": func(m Method) string { return m.ResponseTypeName(svc.Name) }, + } +} + +// clientFuncMap returns the template functions for client code generation. +// Uses private (lowercase) type names for request/response structs. +func clientFuncMap(svc Service) template.FuncMap { + return template.FuncMap{ + "lower": strings.ToLower, + "title": strings.Title, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "requestType": func(m Method) string { return m.ClientRequestTypeName(svc.Name) }, + "responseType": func(m Method) string { return m.ClientResponseTypeName(svc.Name) }, + "formatDoc": formatDoc, + "mockReturnValues": mockReturnValues, + } +} + +// mockReturnValues generates the testify mock return value accessors for a method. +// For example: args.String(0), args.Bool(1), args.Error(2) +func mockReturnValues(m Method) string { + var parts []string + idx := 0 + + for _, r := range m.Returns { + parts = append(parts, mockAccessor(r.Type, idx)) + idx++ + } + + if m.HasError { + parts = append(parts, fmt.Sprintf("args.Error(%d)", idx)) + } + + return strings.Join(parts, ", ") +} + +// mockAccessor returns the testify mock accessor call for a given type and index. +func mockAccessor(typ string, idx int) string { + switch { + case typ == "string": + return fmt.Sprintf("args.String(%d)", idx) + case typ == "bool": + return fmt.Sprintf("args.Bool(%d)", idx) + case typ == "int": + return fmt.Sprintf("args.Int(%d)", idx) + case typ == "int64": + return fmt.Sprintf("args.Get(%d).(int64)", idx) + case typ == "int32": + return fmt.Sprintf("args.Get(%d).(int32)", idx) + case typ == "float64": + return fmt.Sprintf("args.Get(%d).(float64)", idx) + case typ == "float32": + return fmt.Sprintf("args.Get(%d).(float32)", idx) + case typ == "[]byte": + return fmt.Sprintf("args.Get(%d).([]byte)", idx) + default: + // For slices, maps, pointers, and custom types, use Get with type assertion + return fmt.Sprintf("args.Get(%d).(%s)", idx, typ) + } +} + +// pythonFuncMap returns the template functions for Python client code generation. +func pythonFuncMap(svc Service) template.FuncMap { + return template.FuncMap{ + "lower": strings.ToLower, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "pythonFunc": func(m Method) string { return m.PythonFunctionName(svc.ExportPrefix()) }, + "pythonResultType": func(m Method) string { return m.PythonResultTypeName(svc.Name) }, + "pythonDefault": pythonDefaultValue, + } +} + +// GenerateHost generates the host function wrapper code for a service. +func GenerateHost(svc Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/host.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading host template: %w", err) + } + + tmpl, err := template.New("host").Funcs(hostFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Package: pkgName, + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateClientGo generates client wrapper code for plugins to call host functions. +func GenerateClientGo(svc Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading client template: %w", err) + } + + tmpl, err := template.New("client").Funcs(clientFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Package: pkgName, + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateClientGoStub generates stub code for non-WASM platforms. +// These stubs provide type definitions and function signatures for IDE support, +// but panic at runtime since host functions are only available in WASM plugins. +func GenerateClientGoStub(svc Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading client stub template: %w", err) + } + + tmpl, err := template.New("client_stub").Funcs(clientFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Package: pkgName, + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +type templateData struct { + Package string + Service Service +} + +// formatDoc formats a documentation string for Go comments. +// It prefixes each line with "// " and trims trailing whitespace. +func formatDoc(doc string) string { + if doc == "" { + return "" + } + lines := strings.Split(strings.TrimSpace(doc), "\n") + var result []string + for _, line := range lines { + result = append(result, "// "+strings.TrimRight(line, " \t")) + } + return strings.Join(result, "\n") +} + +// GenerateClientPython generates Python client wrapper code for plugins. +func GenerateClientPython(svc Service) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client.py.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Python client template: %w", err) + } + + tmpl, err := template.New("client_py").Funcs(pythonFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := templateData{ + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// pythonDefaultValue returns a Python default value for response.get() calls. +func pythonDefaultValue(p Param) string { + switch p.Type { + case "string": + return `, ""` + case "int", "int32", "int64": + return ", 0" + case "float32", "float64": + return ", 0.0" + case "bool": + return ", False" + case "[]byte": + return ", b\"\"" + default: + return ", None" + } +} + +// rustFuncMap returns the template functions for Rust client code generation. +func rustFuncMap(svc Service) template.FuncMap { + knownStructs := svc.KnownStructs() + return template.FuncMap{ + "lower": strings.ToLower, + "exportName": func(m Method) string { return m.FunctionName(svc.ExportPrefix()) }, + "requestType": func(m Method) string { return m.RequestTypeName(svc.Name) }, + "responseType": func(m Method) string { return m.ResponseTypeName(svc.Name) }, + "rustFunc": func(m Method) string { return m.RustFunctionName(svc.ExportPrefix()) }, + "rustDocComment": RustDocComment, + "rustType": func(p Param) string { return p.RustTypeWithStructs(knownStructs) }, + "rustParamType": func(p Param) string { return p.RustParamTypeWithStructs(knownStructs) }, + "fieldRustType": func(f FieldDef) string { return f.RustType(knownStructs) }, + } +} + +// GenerateClientRust generates Rust client wrapper code for plugins. +func GenerateClientRust(svc Service) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/client.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Rust client template: %w", err) + } + + tmpl, err := template.New("client_rs").Funcs(rustFuncMap(svc)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + partialContent, err := templatesFS.ReadFile("templates/base64_bytes.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading base64_bytes partial: %w", err) + } + tmpl, err = tmpl.Parse(string(partialContent)) + if err != nil { + return nil, fmt.Errorf("parsing base64_bytes partial: %w", err) + } + + data := templateData{ + Service: svc, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// firstLine returns the first line of a multi-line string, with the first word removed. +func firstLine(s string) string { + line := s + if idx := strings.Index(s, "\n"); idx >= 0 { + line = s[:idx] + } + // Remove the first word (service name like "ArtworkService") + if idx := strings.Index(line, " "); idx >= 0 { + line = line[idx+1:] + } + return line +} + +// GenerateRustLib generates the lib.rs file that exposes all service modules. +func GenerateRustLib(services []Service) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/lib.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Rust lib template: %w", err) + } + + tmpl, err := template.New("lib_rs").Funcs(template.FuncMap{ + "lower": strings.ToLower, + "firstLine": firstLine, + }).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := struct { + Services []Service + }{ + Services: services, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateGoDoc generates the doc.go file that provides package documentation. +func GenerateGoDoc(services []Service, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/doc.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Go doc template: %w", err) + } + + tmpl, err := template.New("doc_go").Funcs(template.FuncMap{ + "firstLine": firstLine, + }).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := struct { + Package string + Services []Service + }{ + Package: pkgName, + Services: services, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateGoMod generates the go.mod file for the Go client library. +func GenerateGoMod() ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/go.mod.tmpl") + if err != nil { + return nil, fmt.Errorf("reading go.mod template: %w", err) + } + return tmplContent, nil +} + +// capabilityTemplateData holds data for capability template execution. +type capabilityTemplateData struct { + Package string + Capability Capability +} + +// capabilityFuncMap returns template functions for capability code generation. +func capabilityFuncMap(cap Capability) template.FuncMap { + return template.FuncMap{ + "formatDoc": formatDoc, + "indent": indentText, + "agentName": capabilityAgentName, + "providerInterface": func(e Export) string { return e.ProviderInterfaceName() }, + "implVar": func(e Export) string { return e.ImplVarName() }, + "exportFunc": func(e Export) string { return e.ExportFuncName() }, + } +} + +// indentText adds n tabs to each line of text. +func indentText(n int, s string) string { + indent := strings.Repeat("\t", n) + lines := strings.Split(s, "\n") + for i, line := range lines { + if line != "" { + lines[i] = indent + line + } + } + return strings.Join(lines, "\n") +} + +// capabilityAgentName returns the interface name for a capability. +// Uses the Go interface name stripped of common suffixes. +func capabilityAgentName(cap Capability) string { + name := cap.Interface + // Remove common suffixes to get a clean name + for _, suffix := range []string{"Agent", "Callback", "Service"} { + if strings.HasSuffix(name, suffix) { + name = name[:len(name)-len(suffix)] + break + } + } + // Use the shortened name or the original if no suffix found + if name == "" { + name = cap.Interface + } + return name +} + +// GenerateCapabilityGo generates Go export wrapper code for a capability. +func GenerateCapabilityGo(cap Capability, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/capability.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading capability template: %w", err) + } + + tmpl, err := template.New("capability").Funcs(capabilityFuncMap(cap)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := capabilityTemplateData{ + Package: pkgName, + Capability: cap, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateCapabilityGoStub generates stub code for non-WASM platforms. +func GenerateCapabilityGoStub(cap Capability, pkgName string) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/capability_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading capability stub template: %w", err) + } + + tmpl, err := template.New("capability_stub").Funcs(capabilityFuncMap(cap)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + data := capabilityTemplateData{ + Package: pkgName, + Capability: cap, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// rustCapabilityFuncMap returns template functions for Rust capability code generation. +func rustCapabilityFuncMap(cap Capability) template.FuncMap { + knownStructs := cap.KnownStructs() + return template.FuncMap{ + "rustDocComment": RustDocComment, + "rustTypeAlias": rustTypeAlias, + "rustConstType": rustConstType, + "rustConstName": rustConstName, + "rustFieldName": func(name string) string { return ToSnakeCase(name) }, + "rustMethodName": func(name string) string { return ToSnakeCase(name) }, + "fieldRustType": func(f FieldDef) string { return f.RustType(knownStructs) }, + "rustOutputType": rustOutputType, + "isPrimitiveRust": isPrimitiveRustType, + "skipSerializingFunc": skipSerializingFunc, + "hasHashMap": hasHashMap, + "agentName": capabilityAgentName, + "providerInterface": func(e Export) string { return e.ProviderInterfaceName() }, + "registerMacroName": func(name string) string { return registerMacroName(cap.Name, name) }, + "snakeCase": ToSnakeCase, + "indent": func(spaces int, s string) string { + indent := strings.Repeat(" ", spaces) + lines := strings.Split(s, "\n") + for i, line := range lines { + if line != "" { + lines[i] = indent + line + } + } + return strings.Join(lines, "\n") + }, + } +} + +// rustTypeAlias converts a Go type to its Rust equivalent for type aliases. +// For string types used as error sentinels/constants, we use &'static str +// since Rust consts can't be heap-allocated String values. +func rustTypeAlias(goType string) string { + switch goType { + case "string": + return "&'static str" + case "int", "int32": + return "i32" + case "int64": + return "i64" + default: + return goType + } +} + +// rustConstType converts a Go type to its Rust equivalent for const declarations. +// For String types, it returns &'static str since Rust consts can't be heap-allocated. +func rustConstType(goType string) string { + switch goType { + case "string", "String": + return "&'static str" + case "int", "int32": + return "i32" + case "int64": + return "i64" + default: + return goType + } +} + +// rustOutputType converts a Go type to Rust for capability method signatures. +// It handles pointer types specially - for capability outputs, pointers become the base type +// (not Option) because Rust's Result already provides optional semantics. +// +// TODO: Pointer to primitive types (e.g., *string, *int32) are not handled correctly. +// Currently "*string" returns "string" instead of "String". This would generate invalid +// Rust code. No current capability uses this pattern, but it should be fixed if needed. +func rustOutputType(goType string) string { + // Strip pointer prefix - capability outputs use Result for optionality + if strings.HasPrefix(goType, "*") { + return goType[1:] + } + // Convert Go primitives to Rust primitives + switch goType { + case "bool": + return "bool" + case "string": + return "String" + case "int", "int32": + return "i32" + case "int64": + return "i64" + case "float32": + return "f32" + case "float64": + return "f64" + } + return goType +} + +// isPrimitiveRustType returns true if the Go type maps to a Rust primitive type. +func isPrimitiveRustType(goType string) bool { + // Strip pointer prefix first + if strings.HasPrefix(goType, "*") { + goType = goType[1:] + } + switch goType { + case "bool", "string", "int", "int32", "int64", "float32", "float64": + return true + } + return false +} + +// rustConstName converts a Go const name to Rust convention (SCREAMING_SNAKE_CASE). +func rustConstName(name string) string { + return strings.ToUpper(ToSnakeCase(name)) +} + +// skipSerializingFunc returns the appropriate skip_serializing_if function name. +func skipSerializingFunc(goType string) string { + if strings.HasPrefix(goType, "*") || strings.HasPrefix(goType, "[]") || strings.HasPrefix(goType, "map[") { + return "Option::is_none" + } + switch goType { + case "string": + return "String::is_empty" + case "bool": + return "std::ops::Not::not" + case "int32": + return "is_zero_i32" + case "uint32": + return "is_zero_u32" + case "int64": + return "is_zero_i64" + case "uint64": + return "is_zero_u64" + case "float32": + return "is_zero_f32" + case "float64": + return "is_zero_f64" + default: + return "Option::is_none" + } +} + +// hasHashMap returns true if any struct in the capability uses HashMap. +func hasHashMap(cap Capability) bool { + for _, st := range cap.Structs { + for _, f := range st.Fields { + if strings.HasPrefix(f.Type, "map[") { + return true + } + } + } + return false +} + +// registerMacroName returns the macro name for registering an optional method. +// For package "websocket" and method "OnClose", returns "register_websocket_close". +func registerMacroName(pkg, name string) string { + // Remove common prefixes from method name + for _, prefix := range []string{"Get", "On"} { + if strings.HasPrefix(name, prefix) { + name = name[len(prefix):] + break + } + } + return "register_" + ToSnakeCase(pkg) + "_" + ToSnakeCase(name) +} + +// GenerateCapabilityRust generates Rust export wrapper code for a capability. +func GenerateCapabilityRust(cap Capability) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/capability.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading Rust capability template: %w", err) + } + + tmpl, err := template.New("capability_rust").Funcs(rustCapabilityFuncMap(cap)).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + partialContent, err := templatesFS.ReadFile("templates/base64_bytes.rs.tmpl") + if err != nil { + return nil, fmt.Errorf("reading base64_bytes partial: %w", err) + } + tmpl, err = tmpl.Parse(string(partialContent)) + if err != nil { + return nil, fmt.Errorf("parsing base64_bytes partial: %w", err) + } + + data := capabilityTemplateData{ + Package: cap.Name, + Capability: cap, + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, data); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GenerateCapabilityRustLib generates the lib.rs file for the Rust capabilities crate. +func GenerateCapabilityRustLib(capabilities []Capability) ([]byte, error) { + var buf bytes.Buffer + buf.WriteString("// Code generated by ndpgen. DO NOT EDIT.\n\n") + buf.WriteString("//! Navidrome Plugin Development Kit - Capability Wrappers\n") + buf.WriteString("//!\n") + buf.WriteString("//! This crate provides type definitions, traits, and registration macros\n") + buf.WriteString("//! for implementing Navidrome plugin capabilities in Rust.\n\n") + + // Module declarations + for _, cap := range capabilities { + moduleName := ToSnakeCase(cap.Name) + buf.WriteString(fmt.Sprintf("pub mod %s;\n", moduleName)) + } + + return buf.Bytes(), nil +} + +// pdkFuncMap returns the template functions for PDK code generation. +func pdkFuncMap() template.FuncMap { + return template.FuncMap{ + "firstSentence": firstSentence, + "paramList": pdkParamList, + "returnList": pdkReturnList, + "argList": pdkArgList, + "argListWithReceiver": pdkArgListWithReceiver, + "mockReturns": pdkMockReturns, + "constValue": pdkConstValue, + "stubTypeUnderlying": stubTypeUnderlying, + "methodReceiver": pdkMethodReceiver, + } +} + +// stubTypeUnderlying returns the appropriate stub type for non-WASM builds. +// For types that reference internal packages (like memory.Memory), returns "struct{}". +func stubTypeUnderlying(t PDKType) string { + underlying := t.Underlying + // If the underlying type references a package (contains a dot), use a stub struct + if strings.Contains(underlying, ".") { + return "struct{}" + } + // For simple types like int, int32, return as-is + return underlying +} + +// firstSentence returns the first sentence of a doc string, normalized to a single line. +func firstSentence(doc string) string { + if doc == "" { + return "" + } + // Normalize whitespace (replace newlines with spaces, collapse multiple spaces) + doc = strings.Join(strings.Fields(doc), " ") + + // Find first period followed by space or end + for i, r := range doc { + if r == '.' && (i+1 >= len(doc) || doc[i+1] == ' ') { + return doc[:i+1] + } + } + return doc +} + +// pdkParamList generates a parameter list string for function signature. +func pdkParamList(params []PDKParam) string { + var parts []string + for _, p := range params { + if p.Name != "" { + parts = append(parts, p.Name+" "+p.Type) + } else { + parts = append(parts, p.Type) + } + } + return strings.Join(parts, ", ") +} + +// pdkReturnList generates a return list string for function signature. +func pdkReturnList(returns []PDKReturn) string { + if len(returns) == 0 { + return "" + } + if len(returns) == 1 && returns[0].Name == "" { + return " " + returns[0].Type + } + var parts []string + for _, r := range returns { + if r.Name != "" { + parts = append(parts, r.Name+" "+r.Type) + } else { + parts = append(parts, r.Type) + } + } + return " (" + strings.Join(parts, ", ") + ")" +} + +// pdkArgList generates an argument list string for function call. +func pdkArgList(params []PDKParam) string { + var parts []string + for _, p := range params { + if p.Name != "" { + parts = append(parts, p.Name) + } else { + parts = append(parts, "_") + } + } + return strings.Join(parts, ", ") +} + +// pdkArgListWithReceiver generates an argument list that includes the receiver variable +// as the first argument to PDKMock.Called(). This allows tests to verify which instance +// a method was called on. +func pdkArgListWithReceiver(params []PDKParam, typeName string) string { + // Use lowercase first letter of type name as receiver variable + receiverVar := strings.ToLower(typeName[:1]) + parts := []string{receiverVar} + for _, p := range params { + if p.Name != "" { + parts = append(parts, p.Name) + } else { + parts = append(parts, "_") + } + } + return strings.Join(parts, ", ") +} + +// pdkMethodReceiver generates the receiver declaration for a method. +// Example: "r *HTTPRequest" or "m Memory" +func pdkMethodReceiver(receiver, typeName string) string { + receiverVar := strings.ToLower(typeName[:1]) + if strings.HasPrefix(receiver, "*") { + return receiverVar + " *" + typeName + } + return receiverVar + " " + typeName +} + +// pdkMockReturns generates the mock return accessors for a function. +func pdkMockReturns(returns []PDKReturn) string { + var parts []string + for i, r := range returns { + parts = append(parts, mockAccessorForType(r.Type, i)) + } + return strings.Join(parts, ", ") +} + +// mockAccessorForType returns the testify mock accessor for a type. +func mockAccessorForType(typ string, idx int) string { + switch typ { + case "string": + return fmt.Sprintf("args.String(%d)", idx) + case "bool": + return fmt.Sprintf("args.Bool(%d)", idx) + case "int": + return fmt.Sprintf("args.Int(%d)", idx) + case "error": + return fmt.Sprintf("args.Error(%d)", idx) + case "[]byte": + return fmt.Sprintf("args.Get(%d).([]byte)", idx) + case "uint64": + return fmt.Sprintf("args.Get(%d).(uint64)", idx) + case "uint32": + return fmt.Sprintf("args.Get(%d).(uint32)", idx) + case "uint16": + return fmt.Sprintf("args.Get(%d).(uint16)", idx) + default: + return fmt.Sprintf("args.Get(%d).(%s)", idx, typ) + } +} + +// pdkConstValue returns the value expression for a constant. +func pdkConstValue(c PDKConst) string { + if c.Value == "" || c.Value == "iota" { + return "iota" + } + return c.Value +} + +// GeneratePDKGo generates the WASM implementation of the PDK wrapper package. +func GeneratePDKGo(symbols *PDKSymbols) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/pdk.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading pdk template: %w", err) + } + + tmpl, err := template.New("pdk").Funcs(pdkFuncMap()).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, symbols); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GeneratePDKGoStub generates the native stub implementation of the PDK wrapper package. +func GeneratePDKGoStub(symbols *PDKSymbols) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/pdk_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading pdk stub template: %w", err) + } + + tmpl, err := template.New("pdk_stub").Funcs(pdkFuncMap()).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, symbols); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} + +// GeneratePDKTypesStub generates the native type definitions for the PDK wrapper package. +func GeneratePDKTypesStub(symbols *PDKSymbols) ([]byte, error) { + tmplContent, err := templatesFS.ReadFile("templates/types_stub.go.tmpl") + if err != nil { + return nil, fmt.Errorf("reading types stub template: %w", err) + } + + tmpl, err := template.New("types_stub").Funcs(pdkFuncMap()).Parse(string(tmplContent)) + if err != nil { + return nil, fmt.Errorf("parsing template: %w", err) + } + + var buf bytes.Buffer + if err := tmpl.Execute(&buf, symbols); err != nil { + return nil, fmt.Errorf("executing template: %w", err) + } + + return buf.Bytes(), nil +} diff --git a/plugins/cmd/ndpgen/internal/generator_test.go b/plugins/cmd/ndpgen/internal/generator_test.go new file mode 100644 index 000000000..34c2c2886 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/generator_test.go @@ -0,0 +1,1664 @@ +package internal + +import ( + "go/format" + "os" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Generator", func() { + Describe("GenerateHost", func() { + It("should generate valid Go code for a simple service with strings", func() { + // All methods use JSON request/response types + svc := Service{ + Name: "SubsonicAPI", + Permission: "subsonicapi", + Interface: "SubsonicAPIService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + // Verify the code is valid Go + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package host")) + + // All methods now use request type for JSON protocol + Expect(codeStr).To(ContainSubstring("type SubsonicAPICallRequest struct")) + Expect(codeStr).To(ContainSubstring(`Uri string `)) + + // Response type with error handling + Expect(codeStr).To(ContainSubstring("type SubsonicAPICallResponse struct")) + Expect(codeStr).To(ContainSubstring(`Response string `)) + Expect(codeStr).To(ContainSubstring(`Error string `)) + + // Check for registration function + Expect(codeStr).To(ContainSubstring("func RegisterSubsonicAPIHostFunctions(service SubsonicAPIService)")) + + // Check for host function name + Expect(codeStr).To(ContainSubstring(`"subsonicapi_call"`)) + + // Check for JSON unmarshal (all methods use JSON now) + Expect(codeStr).To(ContainSubstring("json.Unmarshal")) + }) + + It("should generate code for methods without parameters", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoParams", + HasError: true, + Returns: []Param{NewParam("result", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // Methods without params don't need a request type - no params to serialize + Expect(codeStr).NotTo(ContainSubstring("type TestNoParamsRequest struct")) + // But still uses PTR input/output for consistency + Expect(codeStr).To(MatchRegexp(`\[\]extism\.ValueType\{extism\.ValueTypePTR\},\s*\[\]extism\.ValueType\{extism\.ValueTypePTR\}`)) + }) + + It("should generate code for methods without return values", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoReturn", + HasError: true, + Params: []Param{NewParam("input", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should generate code for multiple methods", func() { + svc := Service{ + Name: "Scheduler", + Permission: "scheduler", + Interface: "SchedulerService", + Methods: []Method{ + { + Name: "ScheduleRecurring", + HasError: true, + Params: []Param{NewParam("cronExpression", "string")}, + Returns: []Param{NewParam("scheduleID", "string")}, + }, + { + Name: "ScheduleOneTime", + HasError: true, + Params: []Param{NewParam("delaySeconds", "int32")}, + Returns: []Param{NewParam("scheduleID", "string")}, + }, + { + Name: "CancelSchedule", + HasError: true, + Params: []Param{NewParam("scheduleID", "string")}, + Returns: []Param{NewParam("canceled", "bool")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring("scheduler_schedulerecurring")) + Expect(codeStr).To(ContainSubstring("scheduler_scheduleonetime")) + Expect(codeStr).To(ContainSubstring("scheduler_cancelschedule")) + }) + + It("should handle multiple simple parameters with JSON", func() { + // All params use JSON - single PTR input + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "MultiParam", + HasError: true, + Params: []Param{ + NewParam("name", "string"), + NewParam("count", "int32"), + NewParam("enabled", "bool"), + }, + Returns: []Param{NewParam("result", "string")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // All methods use request type with JSON protocol + Expect(codeStr).To(ContainSubstring("type TestMultiParamRequest struct")) + // Check for JSON unmarshal (all methods use JSON now) + Expect(codeStr).To(ContainSubstring("json.Unmarshal")) + // Check that input/output ValueType both use PTR (JSON) + Expect(codeStr).To(MatchRegexp(`\[\]extism\.ValueType\{extism\.ValueTypePTR\},\s*\[\]extism\.ValueType\{extism\.ValueTypePTR\}`)) + }) + + It("should use single PTR for mixed simple and complex params", func() { + // When any param needs JSON, all are bundled into one request struct + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "MixedParam", + HasError: true, + Params: []Param{ + NewParam("id", "string"), // simple (PTR for string) + NewParam("tags", "[]string"), // complex - needs JSON + }, + Returns: []Param{NewParam("count", "int32")}, // simple + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // Request type IS needed because of complex param + Expect(codeStr).To(ContainSubstring("type TestMixedParamRequest struct")) + // When using request type, only ONE PTR for input (the JSON request) + Expect(codeStr).To(MatchRegexp(`\[\]extism\.ValueType\{extism\.ValueTypePTR\},\s*\[\]extism\.ValueType\{extism\.ValueTypePTR\}`)) + }) + + It("should generate proper JSON tags for complex types", func() { + // Complex types (structs, slices, maps) need JSON serialization + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Method", + HasError: true, + Params: []Param{NewParam("inputValue", "[]string")}, // slice needs JSON + Returns: []Param{NewParam("outputValue", "map[string]string")}, // map needs JSON + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + // Complex params need request type with JSON tags + Expect(codeStr).To(ContainSubstring(`json:"inputValue"`)) + // Complex returns need response type with JSON tags + Expect(codeStr).To(ContainSubstring(`json:"outputValue,omitempty"`)) + }) + + It("should include required imports", func() { + // Service with complex types needs JSON import + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Method", + HasError: true, + Params: []Param{NewParam("data", "MyStruct")}, // struct needs JSON + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring(`"context"`)) + Expect(codeStr).To(ContainSubstring(`"encoding/json"`)) + Expect(codeStr).To(ContainSubstring(`extism "github.com/extism/go-sdk"`)) + }) + + It("should always include json import for JSON protocol", func() { + // All services use JSON protocol, so json import is always needed + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Method", + Params: []Param{NewParam("count", "int32")}, + Returns: []Param{NewParam("result", "int64")}, + }, + }, + } + + code, err := GenerateHost(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring(`"context"`)) + Expect(codeStr).To(ContainSubstring(`"encoding/json"`)) + Expect(codeStr).To(ContainSubstring(`extism "github.com/extism/go-sdk"`)) + }) + }) + + Describe("toJSONName", func() { + It("should convert to camelCase matching Rust serde behavior", func() { + Expect(toJSONName("InputValue")).To(Equal("inputValue")) + Expect(toJSONName("URI")).To(Equal("uri")) + Expect(toJSONName("id")).To(Equal("id")) + Expect(toJSONName("ID")).To(Equal("id")) + Expect(toJSONName("ConnectionID")).To(Equal("connectionId")) + Expect(toJSONName("NewConnectionID")).To(Equal("newConnectionId")) + Expect(toJSONName("XMLHTTPRequest")).To(Equal("xmlhttpRequest")) + Expect(toJSONName("APIKey")).To(Equal("apiKey")) + }) + + It("should handle empty string", func() { + Expect(toJSONName("")).To(Equal("")) + }) + }) + + Describe("NewParam", func() { + It("should create param with auto-generated JSON name", func() { + p := NewParam("MyParam", "string") + Expect(p.Name).To(Equal("MyParam")) + Expect(p.Type).To(Equal("string")) + Expect(p.JSONName).To(Equal("myParam")) + }) + }) + + Describe("Method.IsOptionPattern", func() { + It("should return true for (value, exists bool) pattern", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should return true for (value, ok bool) pattern", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "int64"}, + {Name: "ok", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should return true for (value, found bool) pattern", func() { + m := Method{ + Returns: []Param{ + {Name: "data", Type: "[]byte"}, + {Name: "found", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should be case insensitive for bool name", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "EXISTS", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeTrue()) + }) + + It("should return false for single return", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false for more than two returns", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "count", Type: "int"}, + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false when second return is not bool", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "count", Type: "int"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false when bool is not named exists/ok/found", func() { + m := Method{ + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "success", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false for Has() pattern where first return is bool", func() { + // Has(key) -> (exists bool) should NOT be treated as Option pattern + m := Method{ + Returns: []Param{ + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + + It("should return false when first return is bool (preserves Has-like methods)", func() { + // Even with two returns, if first is bool, don't convert to Option + m := Method{ + Returns: []Param{ + {Name: "result", Type: "bool"}, + {Name: "exists", Type: "bool"}, + }, + } + Expect(m.IsOptionPattern()).To(BeFalse()) + }) + }) + + Describe("Python type and name helpers", func() { + Describe("ToPythonType", func() { + It("should map Go types to Python types", func() { + Expect(ToPythonType("string")).To(Equal("str")) + Expect(ToPythonType("int")).To(Equal("int")) + Expect(ToPythonType("int32")).To(Equal("int")) + Expect(ToPythonType("int64")).To(Equal("int")) + Expect(ToPythonType("float32")).To(Equal("float")) + Expect(ToPythonType("float64")).To(Equal("float")) + Expect(ToPythonType("bool")).To(Equal("bool")) + Expect(ToPythonType("[]byte")).To(Equal("bytes")) + Expect(ToPythonType("unknown")).To(Equal("Any")) + }) + }) + + Describe("ToSnakeCase", func() { + It("should convert PascalCase to snake_case", func() { + Expect(ToSnakeCase("ScheduleRecurring")).To(Equal("schedule_recurring")) + Expect(ToSnakeCase("GetString")).To(Equal("get_string")) + Expect(ToSnakeCase("simple")).To(Equal("simple")) + }) + + It("should handle acronyms correctly", func() { + Expect(ToSnakeCase("ID")).To(Equal("id")) + Expect(ToSnakeCase("ScheduleID")).To(Equal("schedule_id")) + Expect(ToSnakeCase("NewScheduleID")).To(Equal("new_schedule_id")) + Expect(ToSnakeCase("XMLParser")).To(Equal("xml_parser")) + Expect(ToSnakeCase("GetHTTPResponse")).To(Equal("get_http_response")) + }) + }) + + Describe("Method.PythonFunctionName", func() { + It("should generate snake_case function name with service prefix", func() { + m := Method{Name: "GetString"} + Expect(m.PythonFunctionName("cache")).To(Equal("cache_get_string")) + }) + }) + + Describe("Param.PythonType", func() { + It("should return Python type for parameter", func() { + p := NewParam("value", "string") + Expect(p.PythonType()).To(Equal("str")) + }) + }) + + Describe("Param.PythonName", func() { + It("should return snake_case name for parameter", func() { + p := NewParam("ttlSeconds", "int64") + Expect(p.PythonName()).To(Equal("ttl_seconds")) + }) + }) + }) + + Describe("GenerateClientPython", func() { + It("should generate valid Python code for a simple service", func() { + svc := Service{ + Name: "SubsonicAPI", + Permission: "subsonicapi", + Interface: "SubsonicAPIService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("responseJSON", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for imports + Expect(codeStr).To(ContainSubstring("from dataclasses import dataclass")) + Expect(codeStr).To(ContainSubstring("import extism")) + Expect(codeStr).To(ContainSubstring("import json")) + + // Check for exception class + Expect(codeStr).To(ContainSubstring("class HostFunctionError(Exception):")) + + // Check for raw import function + Expect(codeStr).To(ContainSubstring(`@extism.import_fn("extism:host/user", "subsonicapi_call")`)) + Expect(codeStr).To(ContainSubstring("def _subsonicapi_call(offset: int) -> int:")) + + // Check for wrapper function with type hints + Expect(codeStr).To(ContainSubstring("def subsonicapi_call(uri: str) -> str:")) + + // Check for error handling + Expect(codeStr).To(ContainSubstring("raise HostFunctionError(response[")) + }) + + It("should generate dataclass for multi-value returns", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Methods: []Method{ + { + Name: "GetString", + HasError: true, + Params: []Param{NewParam("key", "string")}, + Returns: []Param{ + NewParam("value", "string"), + NewParam("exists", "bool"), + }, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for dataclass + Expect(codeStr).To(ContainSubstring("@dataclass")) + Expect(codeStr).To(ContainSubstring("class CacheGetStringResult:")) + Expect(codeStr).To(ContainSubstring("value: str")) + Expect(codeStr).To(ContainSubstring("exists: bool")) + + // Check that function returns dataclass + Expect(codeStr).To(ContainSubstring("def cache_get_string(key: str) -> CacheGetStringResult:")) + Expect(codeStr).To(ContainSubstring("return CacheGetStringResult(")) + }) + + It("should handle methods with no parameters", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoParams", + HasError: true, + Returns: []Param{NewParam("result", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Function with no params + Expect(codeStr).To(ContainSubstring("def test_no_params() -> str:")) + // Empty request + Expect(codeStr).To(ContainSubstring(`request_bytes = b"{}"`)) + }) + + It("should handle methods with no return values", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "NoReturn", + HasError: true, + Params: []Param{NewParam("input", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Function returns None + Expect(codeStr).To(ContainSubstring("def test_no_return(input: str) -> None:")) + }) + + It("should generate correct Python defaults for different types", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "AllTypes", + HasError: true, + Returns: []Param{ + NewParam("strVal", "string"), + NewParam("intVal", "int64"), + NewParam("floatVal", "float64"), + NewParam("boolVal", "bool"), + }, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check defaults in response.get() calls + Expect(codeStr).To(ContainSubstring(`response.get("strVal", "")`)) + Expect(codeStr).To(ContainSubstring(`response.get("intVal", 0)`)) + Expect(codeStr).To(ContainSubstring(`response.get("floatVal", 0.0)`)) + Expect(codeStr).To(ContainSubstring(`response.get("boolVal", False)`)) + }) + + It("should not import base64 for non-byte services", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + Expect(codeStr).NotTo(ContainSubstring("import base64")) + }) + + It("should generate base64 encoding/decoding for byte fields", func() { + svc := Service{ + Name: "Codec", + Permission: "codec", + Interface: "CodecService", + Methods: []Method{ + { + Name: "Encode", + HasError: true, + Params: []Param{NewParam("data", "[]byte")}, + Returns: []Param{NewParam("result", "[]byte")}, + }, + }, + } + + code, err := GenerateClientPython(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should import base64 + Expect(codeStr).To(ContainSubstring("import base64")) + + // Should base64-encode byte params in request + Expect(codeStr).To(ContainSubstring(`base64.b64encode(data).decode("ascii")`)) + + // Should base64-decode byte returns in response + Expect(codeStr).To(ContainSubstring(`base64.b64decode(response.get("result", ""))`)) + }) + }) + + Describe("GenerateGoDoc", func() { + It("should generate valid doc.go content for multiple services", func() { + services := []Service{ + { + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Doc: "CacheService provides temporary key-value storage with TTL.", + }, + { + Name: "Scheduler", + Permission: "scheduler", + Interface: "SchedulerService", + Doc: "SchedulerService manages scheduled tasks.", + }, + } + + code, err := GenerateGoDoc(services, "ndpdk") + Expect(err).NotTo(HaveOccurred()) + + // Verify it's valid Go code + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package ndpdk")) + + // Check for package documentation + Expect(codeStr).To(ContainSubstring("Package ndpdk provides Navidrome Plugin Development Kit wrappers")) + + // Check that services are listed + Expect(codeStr).To(ContainSubstring("Cache:")) + Expect(codeStr).To(ContainSubstring("Scheduler:")) + }) + }) + + Describe("GenerateGoMod", func() { + It("should generate valid go.mod content", func() { + code, err := GenerateGoMod() + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for module declaration (consolidated PDK path at pdk/go level) + Expect(codeStr).To(ContainSubstring("module github.com/navidrome/navidrome/plugins/pdk/go")) + // Ensure it's not the old host-specific path + Expect(codeStr).NotTo(ContainSubstring("module github.com/navidrome/navidrome/plugins/pdk/go/host")) + + // Check for Go version + Expect(codeStr).To(ContainSubstring("go 1.25")) + + // Check for extism-go-pdk dependency + Expect(codeStr).To(ContainSubstring("github.com/extism/go-pdk")) + }) + }) + + Describe("GenerateClientGo", func() { + It("should include errors import when service has methods with errors", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Methods: []Method{ + { + Name: "Get", + HasError: true, + Params: []Param{NewParam("key", "string")}, + Returns: []Param{NewParam("value", "string")}, + }, + }, + } + + code, err := GenerateClientGo(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + // Verify the code is valid Go (can't actually compile without wasip1) + codeStr := string(code) + + // Check for errors import when methods have errors + Expect(codeStr).To(ContainSubstring(`"errors"`)) + Expect(codeStr).To(ContainSubstring("errors.New")) + }) + + It("should not include errors import when service has no methods with errors", func() { + svc := Service{ + Name: "Config", + Permission: "config", + Interface: "ConfigService", + Methods: []Method{ + { + Name: "Get", + HasError: false, + Params: []Param{NewParam("key", "string")}, + Returns: []Param{NewParam("value", "string"), NewParam("exists", "bool")}, + }, + { + Name: "List", + HasError: false, + Params: []Param{NewParam("prefix", "string")}, + Returns: []Param{NewParam("keys", "[]string")}, + }, + }, + } + + code, err := GenerateClientGo(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check that errors is NOT imported when no methods have errors + Expect(codeStr).NotTo(ContainSubstring(`"errors"`)) + Expect(codeStr).NotTo(ContainSubstring("errors.New")) + }) + + It("should generate valid Go code structure", func() { + svc := Service{ + Name: "SubsonicAPI", + Permission: "subsonicapi", + Interface: "SubsonicAPIService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateClientGo(svc, "host") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for generated header + Expect(codeStr).To(ContainSubstring("Code generated by ndpgen. DO NOT EDIT.")) + + // Check for build tag + Expect(codeStr).To(ContainSubstring("//go:build wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package host")) + + // Check for wasmimport directive + Expect(codeStr).To(ContainSubstring("//go:wasmimport extism:host/user")) + + // Check for PDK import + Expect(codeStr).To(ContainSubstring("github.com/navidrome/navidrome/plugins/pdk/go/pdk")) + }) + + }) + + Describe("GenerateClientGoStub", func() { + It("should generate valid mock code with testify/mock", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Doc: "CacheService provides caching capabilities.", + Methods: []Method{ + { + Name: "Get", + Doc: "Get retrieves a value from the cache.", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "string"}, + {Name: "exists", Type: "bool"}, + }, + }, + }, + } + + code, err := GenerateClientGoStub(svc, "ndpdk") + Expect(err).NotTo(HaveOccurred()) + + // Verify it's valid Go code + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for build tag (non-WASM) + Expect(codeStr).To(ContainSubstring("//go:build !wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package ndpdk")) + + // Check for mock comment + Expect(codeStr).To(ContainSubstring("mock implementations for non-WASM builds")) + + // Check for testify/mock import + Expect(codeStr).To(ContainSubstring(`"github.com/stretchr/testify/mock"`)) + + // Check for private mock struct + Expect(codeStr).To(ContainSubstring("type mockCacheService struct")) + Expect(codeStr).To(ContainSubstring("mock.Mock")) + + // Check for exported mock instance + Expect(codeStr).To(ContainSubstring("var CacheMock = &mockCacheService{}")) + + // Check for mock method + Expect(codeStr).To(ContainSubstring("func (m *mockCacheService) Get(key string)")) + Expect(codeStr).To(ContainSubstring("m.Called(key)")) + + // Check for wrapper function delegating to mock + Expect(codeStr).To(ContainSubstring("func CacheGet(key string)")) + Expect(codeStr).To(ContainSubstring("return CacheMock.Get(key)")) + + // Stub files should NOT have request/response types (they're not needed) + Expect(codeStr).NotTo(ContainSubstring("Request struct")) + Expect(codeStr).NotTo(ContainSubstring("Response struct")) + }) + + It("should generate correct mock return values for different types", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "GetString", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "string"}, + }, + HasError: true, + }, + { + Name: "GetInt64", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "int64"}, + {Name: "exists", Type: "bool"}, + }, + HasError: true, + }, + { + Name: "GetBytes", + Params: []Param{ + {Name: "key", Type: "string"}, + }, + Returns: []Param{ + {Name: "value", Type: "[]byte"}, + }, + HasError: true, + }, + }, + } + + code, err := GenerateClientGoStub(svc, "ndpdk") + Expect(err).NotTo(HaveOccurred()) + + // Verify it's valid Go code + _, err = format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check string return uses args.String(0) + Expect(codeStr).To(ContainSubstring("args.String(0)")) + + // Check int64 return uses args.Get(0).(int64) + Expect(codeStr).To(ContainSubstring("args.Get(0).(int64)")) + + // Check bool return uses args.Bool(1) + Expect(codeStr).To(ContainSubstring("args.Bool(1)")) + + // Check []byte return uses args.Get(0).([]byte) + Expect(codeStr).To(ContainSubstring("args.Get(0).([]byte)")) + + // Check error returns use args.Error(N) + Expect(codeStr).To(ContainSubstring("args.Error(")) + }) + }) + + Describe("Integration", func() { + It("should generate compilable code from parsed source", func() { + // This is an integration test that verifies the full pipeline + src := `package host + +import "context" + +// TestService is a test service. +//nd:hostservice name=Test permission=test +type TestService interface { + // DoSomething does something. + //nd:hostfunc + DoSomething(ctx context.Context, input string) (output string, err error) +} +` + // Create temporary directory + tmpDir := GinkgoT().TempDir() + path := tmpDir + "/test.go" + err := writeFile(path, src) + Expect(err).NotTo(HaveOccurred()) + + // Parse + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + + // Generate + code, err := GenerateHost(services[0], "host") + Expect(err).NotTo(HaveOccurred()) + + // Format (validates syntax) + formatted, err := format.Source(code) + Expect(err).NotTo(HaveOccurred()) + + // Verify key elements + codeStr := string(formatted) + Expect(codeStr).To(ContainSubstring("RegisterTestHostFunctions")) + Expect(codeStr).To(ContainSubstring(`"test_dosomething"`)) + }) + }) + + Describe("GenerateCapabilityGo", func() { + It("should generate valid Go code for a non-required capability", func() { + cap := Capability{ + Name: "metadata", + Interface: "MetadataAgent", + Required: false, + Doc: "MetadataAgent provides metadata retrieval.", + Methods: []Export{ + { + Name: "GetArtistBiography", + ExportName: "nd_get_artist_biography", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistBiographyOutput"}, + Doc: "Returns artist biography", + }, + { + Name: "GetArtistImages", + ExportName: "nd_get_artist_images", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistImagesOutput"}, + Doc: "Returns artist images", + }, + }, + Structs: []StructDef{ + { + Name: "ArtistInput", + Fields: []FieldDef{ + {Name: "ID", Type: "string", JSONTag: "id"}, + {Name: "Name", Type: "string", JSONTag: "name"}, + }, + }, + { + Name: "ArtistBiographyOutput", + Fields: []FieldDef{ + {Name: "Biography", Type: "string", JSONTag: "biography"}, + }, + }, + { + Name: "ArtistImagesOutput", + Fields: []FieldDef{ + {Name: "Images", Type: "[]ImageInfo", JSONTag: "images"}, + }, + }, + { + Name: "ImageInfo", + Fields: []FieldDef{ + {Name: "URL", Type: "string", JSONTag: "url"}, + {Name: "Size", Type: "int32", JSONTag: "size"}, + }, + }, + }, + } + + code, err := GenerateCapabilityGo(cap, "metadata") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for build tag + Expect(codeStr).To(ContainSubstring("//go:build wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package metadata")) + + // Check for marker interface (non-required) + Expect(codeStr).To(ContainSubstring("type Metadata interface{}")) + + // Check for provider interfaces + Expect(codeStr).To(ContainSubstring("type ArtistBiographyProvider interface")) + Expect(codeStr).To(ContainSubstring("type ArtistImagesProvider interface")) + + // Check for Register function with type assertions + Expect(codeStr).To(ContainSubstring("func Register(impl Metadata)")) + Expect(codeStr).To(ContainSubstring("impl.(ArtistBiographyProvider)")) + + // Check for export wrappers + Expect(codeStr).To(ContainSubstring("//go:wasmexport nd_get_artist_biography")) + Expect(codeStr).To(ContainSubstring("func _NdGetArtistBiography()")) + + // Check for NotImplementedCode handling + Expect(codeStr).To(ContainSubstring("NotImplementedCode")) + Expect(codeStr).To(ContainSubstring("return NotImplementedCode")) + + // Check struct definitions + Expect(codeStr).To(ContainSubstring("type ArtistInput struct")) + Expect(codeStr).To(ContainSubstring("type ImageInfo struct")) + }) + + It("should generate valid Go code for a required capability", func() { + cap := Capability{ + Name: "scrobbler", + Interface: "Scrobbler", + Required: true, + Methods: []Export{ + { + Name: "IsAuthorized", + ExportName: "nd_scrobbler_is_authorized", + Input: Param{Type: "AuthInput"}, + Output: Param{Type: "AuthOutput"}, + }, + { + Name: "Scrobble", + ExportName: "nd_scrobbler_scrobble", + Input: Param{Type: "ScrobbleInput"}, + Output: Param{Type: "ScrobblerOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "AuthInput", Fields: []FieldDef{{Name: "UserID", Type: "string", JSONTag: "userId"}}}, + {Name: "AuthOutput", Fields: []FieldDef{{Name: "Authorized", Type: "bool", JSONTag: "authorized"}}}, + {Name: "ScrobbleInput", Fields: []FieldDef{{Name: "UserID", Type: "string", JSONTag: "userId"}}}, + {Name: "ScrobblerOutput", Fields: []FieldDef{{Name: "Error", Type: "*string", JSONTag: "error", OmitEmpty: true}}}, + }, + } + + code, err := GenerateCapabilityGo(cap, "scrobbler") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for full interface (required capability) + Expect(codeStr).To(ContainSubstring("type Scrobbler interface {")) + Expect(codeStr).To(ContainSubstring("IsAuthorized(AuthInput) (AuthOutput, error)")) + Expect(codeStr).To(ContainSubstring("Scrobble(ScrobbleInput) (ScrobblerOutput, error)")) + + // Should NOT have provider interfaces for required capability + Expect(codeStr).NotTo(ContainSubstring("AuthProvider interface")) + + // Register should directly assign methods + Expect(codeStr).To(ContainSubstring("func Register(impl Scrobbler)")) + Expect(codeStr).To(ContainSubstring("impl.IsAuthorized")) + }) + + It("should include type aliases and consts", func() { + cap := Capability{ + Name: "scrobbler", + Interface: "Scrobbler", + Required: true, + Methods: []Export{ + { + Name: "Scrobble", + ExportName: "nd_scrobble", + Input: Param{Type: "ScrobbleInput"}, + Output: Param{Type: "ScrobblerOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "ScrobbleInput", Fields: []FieldDef{{Name: "UserID", Type: "string", JSONTag: "userId"}}}, + {Name: "ScrobblerOutput", Fields: []FieldDef{{Name: "ErrorType", Type: "*ScrobblerErrorType", JSONTag: "errorType", OmitEmpty: true}}}, + }, + TypeAliases: []TypeAlias{ + {Name: "ScrobblerErrorType", Type: "string", Doc: "ScrobblerErrorType indicates error handling."}, + }, + Consts: []ConstGroup{ + { + Type: "ScrobblerErrorType", + Values: []ConstDef{ + {Name: "ScrobblerErrorNone", Value: `"none"`, Doc: "No error"}, + {Name: "ScrobblerErrorRetry", Value: `"retry"`, Doc: "Retry later"}, + }, + }, + }, + } + + code, err := GenerateCapabilityGo(cap, "scrobbler") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check type alias + Expect(codeStr).To(ContainSubstring("type ScrobblerErrorType string")) + + // Check consts - all consts should have type annotation + Expect(codeStr).To(ContainSubstring("ScrobblerErrorNone ScrobblerErrorType =")) + Expect(codeStr).To(ContainSubstring(`"none"`)) + Expect(codeStr).To(ContainSubstring("ScrobblerErrorRetry ScrobblerErrorType =")) + Expect(codeStr).To(ContainSubstring(`"retry"`)) + }) + }) + + Describe("GenerateCapabilityGoStub", func() { + It("should generate valid stub code for non-WASM builds", func() { + cap := Capability{ + Name: "metadata", + Interface: "MetadataAgent", + Required: false, + Methods: []Export{ + { + Name: "GetArtistBiography", + ExportName: "nd_get_artist_biography", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistBiographyOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "ArtistInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "ArtistBiographyOutput", Fields: []FieldDef{{Name: "Biography", Type: "string", JSONTag: "biography"}}}, + }, + } + + code, err := GenerateCapabilityGoStub(cap, "metadata") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check for non-WASM build tag + Expect(codeStr).To(ContainSubstring("//go:build !wasip1")) + + // Check for package declaration + Expect(codeStr).To(ContainSubstring("package metadata")) + + // Check for no-op Register + Expect(codeStr).To(ContainSubstring("func Register(_ Metadata) {}")) + + // Check struct definitions are present + Expect(codeStr).To(ContainSubstring("type ArtistInput struct")) + + // Check there are no export wrappers + Expect(codeStr).NotTo(ContainSubstring("//go:wasmexport")) + Expect(codeStr).NotTo(ContainSubstring("pdk.InputJSON")) + }) + }) + + Describe("End-to-end capability generation", func() { + It("should parse and generate capability code from source", func() { + src := `package capabilities + +// Lifecycle provides plugin lifecycle hooks. +//nd:capability name=lifecycle +type Lifecycle interface { + // OnInit is called when the plugin is loaded. + //nd:export name=nd_on_init + OnInit(OnInitInput) (OnInitOutput, error) +} + +// OnInitInput is the input for OnInit. +type OnInitInput struct { +} + +// OnInitOutput is the output for OnInit. +type OnInitOutput struct { + // Error is the error message if initialization failed. + Error *string ` + "`json:\"error,omitempty\"`" + ` +} +` + // Create temporary directory + tmpDir := GinkgoT().TempDir() + path := tmpDir + "/lifecycle.go" + err := writeFile(path, src) + Expect(err).NotTo(HaveOccurred()) + + // Parse + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + Expect(cap.Name).To(Equal("lifecycle")) + Expect(cap.Methods).To(HaveLen(1)) + + // Generate WASM code + code, err := GenerateCapabilityGo(cap, "lifecycle") + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + Expect(codeStr).To(ContainSubstring("//go:wasmexport nd_on_init")) + Expect(codeStr).To(ContainSubstring("type InitProvider interface")) + + // Generate stub code + stubCode, err := GenerateCapabilityGoStub(cap, "lifecycle") + Expect(err).NotTo(HaveOccurred()) + + stubStr := string(stubCode) + Expect(stubStr).To(ContainSubstring("//go:build !wasip1")) + Expect(stubStr).To(ContainSubstring("func Register(_ Lifecycle) {}")) + }) + }) +}) + +var _ = Describe("Rust Generation", func() { + Describe("skipSerializingFunc", func() { + It("should return Option::is_none for pointer, slice, and map types", func() { + Expect(skipSerializingFunc("*string")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("*MyStruct")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("[]string")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("[]int32")).To(Equal("Option::is_none")) + Expect(skipSerializingFunc("map[string]int")).To(Equal("Option::is_none")) + }) + + It("should return String::is_empty for string type", func() { + Expect(skipSerializingFunc("string")).To(Equal("String::is_empty")) + }) + + It("should return std::ops::Not::not for bool type", func() { + Expect(skipSerializingFunc("bool")).To(Equal("std::ops::Not::not")) + }) + + It("should return is_zero_* functions for numeric types", func() { + Expect(skipSerializingFunc("int32")).To(Equal("is_zero_i32")) + Expect(skipSerializingFunc("uint32")).To(Equal("is_zero_u32")) + Expect(skipSerializingFunc("int64")).To(Equal("is_zero_i64")) + Expect(skipSerializingFunc("uint64")).To(Equal("is_zero_u64")) + Expect(skipSerializingFunc("float32")).To(Equal("is_zero_f32")) + Expect(skipSerializingFunc("float64")).To(Equal("is_zero_f64")) + }) + + It("should return Option::is_none for unknown types", func() { + Expect(skipSerializingFunc("CustomType")).To(Equal("Option::is_none")) + }) + }) + + Describe("rustOutputType", func() { + It("should convert Go primitives to Rust primitives", func() { + Expect(rustOutputType("bool")).To(Equal("bool")) + Expect(rustOutputType("string")).To(Equal("String")) + Expect(rustOutputType("int")).To(Equal("i32")) + Expect(rustOutputType("int32")).To(Equal("i32")) + Expect(rustOutputType("int64")).To(Equal("i64")) + Expect(rustOutputType("float32")).To(Equal("f32")) + Expect(rustOutputType("float64")).To(Equal("f64")) + }) + + It("should strip pointer prefix", func() { + // NOTE: This behavior is incorrect for pointer to primitives. + // "*string" returns "string" instead of "String", which would generate + // invalid Rust code. No current capability uses this pattern. + // See TODO in rustOutputType function. + Expect(rustOutputType("*string")).To(Equal("string")) + Expect(rustOutputType("*MyStruct")).To(Equal("MyStruct")) + }) + + It("should pass through unknown types", func() { + Expect(rustOutputType("CustomType")).To(Equal("CustomType")) + Expect(rustOutputType("MyStruct")).To(Equal("MyStruct")) + }) + }) + + Describe("isPrimitiveRustType", func() { + It("should return true for primitive Go types", func() { + Expect(isPrimitiveRustType("bool")).To(BeTrue()) + Expect(isPrimitiveRustType("string")).To(BeTrue()) + Expect(isPrimitiveRustType("int")).To(BeTrue()) + Expect(isPrimitiveRustType("int32")).To(BeTrue()) + Expect(isPrimitiveRustType("int64")).To(BeTrue()) + Expect(isPrimitiveRustType("float32")).To(BeTrue()) + Expect(isPrimitiveRustType("float64")).To(BeTrue()) + }) + + It("should return false for non-primitive types", func() { + Expect(isPrimitiveRustType("MyStruct")).To(BeFalse()) + Expect(isPrimitiveRustType("CustomType")).To(BeFalse()) + Expect(isPrimitiveRustType("[]string")).To(BeFalse()) + Expect(isPrimitiveRustType("map[string]int")).To(BeFalse()) + }) + + It("should handle pointer types by stripping prefix", func() { + Expect(isPrimitiveRustType("*string")).To(BeTrue()) + Expect(isPrimitiveRustType("*int64")).To(BeTrue()) + Expect(isPrimitiveRustType("*MyStruct")).To(BeFalse()) + }) + }) + + Describe("GenerateCapabilityRust", func() { + It("should generate valid Rust code with primitive output types", func() { + cap := Capability{ + Name: "test", + Interface: "TestAgent", + Required: true, + SourceFile: "test", + Methods: []Export{ + { + Name: "GetBool", + ExportName: "nd_get_bool", + Input: Param{Type: "BoolInput"}, + Output: Param{Type: "bool"}, + }, + { + Name: "GetString", + ExportName: "nd_get_string", + Input: Param{Type: "StrInput"}, + Output: Param{Type: "string"}, + }, + { + Name: "GetInt", + ExportName: "nd_get_int", + Input: Param{Type: "IntInput"}, + Output: Param{Type: "int32"}, + }, + }, + Structs: []StructDef{ + {Name: "BoolInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "StrInput", Fields: []FieldDef{{Name: "Key", Type: "string", JSONTag: "key"}}}, + {Name: "IntInput", Fields: []FieldDef{{Name: "Index", Type: "int32", JSONTag: "index"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Check that primitive output types are not prefixed with $crate:: + // The template should use isPrimitiveRust to determine this + Expect(codeStr).To(ContainSubstring("FnResult>")) + Expect(codeStr).To(ContainSubstring("FnResult>")) + Expect(codeStr).To(ContainSubstring("FnResult>")) + + // Verify that primitive output types don't use $crate:: prefix in FnResult + // The pattern "$crate::test::bool>" would indicate incorrect generation + Expect(codeStr).NotTo(ContainSubstring("$crate::test::bool>")) + Expect(codeStr).NotTo(ContainSubstring("$crate::test::String>")) + Expect(codeStr).NotTo(ContainSubstring("$crate::test::i32>")) + }) + + It("should generate valid Rust code with struct output types", func() { + cap := Capability{ + Name: "metadata", + Interface: "MetadataAgent", + Required: true, + SourceFile: "metadata", + Methods: []Export{ + { + Name: "GetArtist", + ExportName: "nd_get_artist", + Input: Param{Type: "ArtistInput"}, + Output: Param{Type: "ArtistOutput"}, + }, + }, + Structs: []StructDef{ + {Name: "ArtistInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "ArtistOutput", Fields: []FieldDef{{Name: "Name", Type: "string", JSONTag: "name"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Non-primitive struct types should use $crate:: prefix + Expect(codeStr).To(ContainSubstring("$crate::metadata::ArtistOutput")) + }) + + It("should generate valid Rust code with pointer output types", func() { + cap := Capability{ + Name: "test", + Interface: "TestAgent", + Required: true, + SourceFile: "test", + Methods: []Export{ + { + Name: "GetOptionalStruct", + ExportName: "nd_get_optional_struct", + Input: Param{Type: "Input"}, + Output: Param{Type: "*Output"}, + }, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Pointer to struct should strip pointer and use struct type with $crate:: + Expect(codeStr).To(ContainSubstring("$crate::test::Output>")) + // Pointer output types should NOT have Option<> wrapping - Result handles optionality + Expect(codeStr).NotTo(ContainSubstring("Option<")) + }) + + It("should include all float types correctly", func() { + cap := Capability{ + Name: "test", + Interface: "TestAgent", + Required: true, + SourceFile: "test", + Methods: []Export{ + { + Name: "GetFloat32", + ExportName: "nd_get_float32", + Input: Param{Type: "Input"}, + Output: Param{Type: "float32"}, + }, + { + Name: "GetFloat64", + ExportName: "nd_get_float64", + Input: Param{Type: "Input"}, + Output: Param{Type: "float64"}, + }, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + }, + } + + code, err := GenerateCapabilityRust(cap) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + Expect(codeStr).To(ContainSubstring("FnResult>")) + Expect(codeStr).To(ContainSubstring("FnResult>")) + }) + }) + + Describe("GenerateClientRust", func() { + It("should generate Option for (value, exists bool) pattern", func() { + svc := Service{ + Name: "Config", + Permission: "config", + Interface: "ConfigService", + Methods: []Method{ + { + Name: "Get", + Params: []Param{ + {Name: "key", Type: "string", JSONName: "key"}, + }, + Returns: []Param{ + {Name: "value", Type: "string", JSONName: "value"}, + {Name: "exists", Type: "bool", JSONName: "exists"}, + }, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate Option return type, not (String, bool) + Expect(codeStr).To(ContainSubstring("Result, Error>")) + Expect(codeStr).NotTo(ContainSubstring("Result<(String, bool), Error>")) + + // Should generate Some/None logic + Expect(codeStr).To(ContainSubstring("Ok(Some(")) + Expect(codeStr).To(ContainSubstring("Ok(None)")) + }) + + It("should generate tuple for non-option multi-return", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "GetStats", + Returns: []Param{ + {Name: "count", Type: "int64", JSONName: "count"}, + {Name: "size", Type: "int64", JSONName: "size"}, + }, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate tuple return type + Expect(codeStr).To(ContainSubstring("Result<(i64, i64), Error>")) + Expect(codeStr).NotTo(ContainSubstring("Option<")) + }) + + It("should NOT generate Option for Has() pattern where first return is bool", func() { + svc := Service{ + Name: "Cache", + Permission: "cache", + Interface: "CacheService", + Methods: []Method{ + { + Name: "Has", + Params: []Param{ + {Name: "key", Type: "string", JSONName: "key"}, + }, + Returns: []Param{ + {Name: "exists", Type: "bool", JSONName: "exists"}, + }, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate simple bool return, not Option + Expect(codeStr).To(ContainSubstring("Result")) + Expect(codeStr).NotTo(ContainSubstring("Option")) + }) + + It("should generate base64 serde for Vec fields", func() { + svc := Service{ + Name: "Codec", + Permission: "codec", + Interface: "CodecService", + Methods: []Method{ + { + Name: "Encode", + HasError: true, + Params: []Param{NewParam("data", "[]byte")}, + Returns: []Param{NewParam("result", "[]byte")}, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + // Should generate base64_bytes serde module + Expect(codeStr).To(ContainSubstring("mod base64_bytes")) + Expect(codeStr).To(ContainSubstring("use base64::Engine as _")) + + // Should add serde(with = "base64_bytes") on Vec fields + Expect(codeStr).To(ContainSubstring(`#[serde(with = "base64_bytes")]`)) + }) + + It("should not generate base64 module when no byte fields", func() { + svc := Service{ + Name: "Test", + Permission: "test", + Interface: "TestService", + Methods: []Method{ + { + Name: "Call", + HasError: true, + Params: []Param{NewParam("uri", "string")}, + Returns: []Param{NewParam("response", "string")}, + }, + }, + } + + code, err := GenerateClientRust(svc) + Expect(err).NotTo(HaveOccurred()) + + codeStr := string(code) + + Expect(codeStr).NotTo(ContainSubstring("mod base64_bytes")) + Expect(codeStr).NotTo(ContainSubstring("use base64")) + }) + }) +}) + +func writeFile(path, content string) error { + return os.WriteFile(path, []byte(content), 0600) +} diff --git a/plugins/cmd/ndpgen/internal/internal_suite_test.go b/plugins/cmd/ndpgen/internal/internal_suite_test.go new file mode 100644 index 000000000..5c7d27088 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/internal_suite_test.go @@ -0,0 +1,13 @@ +package internal + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestInternal(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "NDPGen Internal Suite") +} diff --git a/plugins/cmd/ndpgen/internal/parser.go b/plugins/cmd/ndpgen/internal/parser.go new file mode 100644 index 000000000..4cb28f8d4 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/parser.go @@ -0,0 +1,846 @@ +package internal + +import ( + "fmt" + "go/ast" + "go/parser" + "go/token" + "maps" + "os" + "path/filepath" + "regexp" + "slices" + "strings" +) + +// Annotation patterns +var ( + // //nd:hostservice name=ServiceName permission=key + hostServicePattern = regexp.MustCompile(`//nd:hostservice\s+(.*)`) + // //nd:hostfunc [name=CustomName] + hostFuncPattern = regexp.MustCompile(`//nd:hostfunc(?:\s+(.*))?`) + // //nd:capability name=PackageName [required=true] + capabilityPattern = regexp.MustCompile(`//nd:capability\s+(.*)`) + // //nd:export name=ExportName + exportPattern = regexp.MustCompile(`//nd:export\s+(.*)`) + // key=value pairs + keyValuePattern = regexp.MustCompile(`(\w+)=(\S+)`) +) + +// ParseDirectory parses all Go source files in a directory and extracts host services. +func ParseDirectory(dir string) ([]Service, error) { + entries, err := os.ReadDir(dir) + if err != nil { + return nil, fmt.Errorf("reading directory: %w", err) + } + + var services []Service + fset := token.NewFileSet() + + for _, entry := range entries { + if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".go") { + continue + } + // Skip generated files and test files + if strings.HasSuffix(entry.Name(), "_gen.go") || strings.HasSuffix(entry.Name(), "_test.go") { + continue + } + + path := filepath.Join(dir, entry.Name()) + parsed, err := parseFile(fset, path) + if err != nil { + return nil, fmt.Errorf("parsing %s: %w", entry.Name(), err) + } + services = append(services, parsed...) + } + + return services, nil +} + +// ParseCapabilities parses all Go source files in a directory and extracts capabilities. +func ParseCapabilities(dir string) ([]Capability, error) { + entries, err := os.ReadDir(dir) + if err != nil { + return nil, fmt.Errorf("reading directory: %w", err) + } + + fset := token.NewFileSet() + + // First pass: collect all structs and type aliases from all files in the package + sharedStructMap := make(map[string]StructDef) + sharedAliasMap := make(map[string]TypeAlias) + var allConstGroups []ConstGroup + + var goFiles []string + for _, entry := range entries { + if entry.IsDir() || !strings.HasSuffix(entry.Name(), ".go") { + continue + } + // Skip generated files, test files, and doc.go + if strings.HasSuffix(entry.Name(), "_gen.go") || + strings.HasSuffix(entry.Name(), "_test.go") || + entry.Name() == "doc.go" { + continue + } + goFiles = append(goFiles, filepath.Join(dir, entry.Name())) + } + + for _, path := range goFiles { + f, err := parser.ParseFile(fset, path, nil, parser.ParseComments) + if err != nil { + return nil, fmt.Errorf("parsing %s for types: %w", filepath.Base(path), err) + } + for _, s := range parseStructs(f) { + sharedStructMap[s.Name] = s + } + for _, a := range parseTypeAliases(f) { + sharedAliasMap[a.Name] = a + } + allConstGroups = append(allConstGroups, parseConstGroups(f)...) + } + + // Second pass: parse capabilities using the shared type maps + var capabilities []Capability + for _, path := range goFiles { + parsed, err := parseCapabilityFile(fset, path, sharedStructMap, sharedAliasMap, allConstGroups) + if err != nil { + return nil, fmt.Errorf("parsing %s: %w", filepath.Base(path), err) + } + capabilities = append(capabilities, parsed...) + } + + return capabilities, nil +} + +// parseCapabilityFile parses a single Go source file and extracts capabilities. +func parseCapabilityFile(fset *token.FileSet, path string, structMap map[string]StructDef, aliasMap map[string]TypeAlias, allConstGroups []ConstGroup) ([]Capability, error) { + f, err := parser.ParseFile(fset, path, nil, parser.ParseComments) + if err != nil { + return nil, err + } + + var capabilities []Capability + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + interfaceType, ok := typeSpec.Type.(*ast.InterfaceType) + if !ok { + continue + } + + // Check for //nd:capability annotation in doc comment + docText, rawDoc := getDocComment(genDecl, typeSpec) + capAnnotation := parseCapabilityAnnotation(rawDoc) + if capAnnotation == nil { + continue + } + + // Extract source file base name (e.g., "websocket_callback" from "websocket_callback.go") + baseName := filepath.Base(path) + sourceFile := strings.TrimSuffix(baseName, ".go") + + capability := Capability{ + Name: capAnnotation["name"], + Interface: typeSpec.Name.Name, + Required: capAnnotation["required"] == "true", + Doc: cleanDoc(docText), + SourceFile: sourceFile, + } + + // Parse methods and collect referenced types + referencedTypes := make(map[string]bool) + for _, method := range interfaceType.Methods.List { + if len(method.Names) == 0 { + continue // Embedded interface + } + + funcType, ok := method.Type.(*ast.FuncType) + if !ok { + continue + } + + // Check for //nd:export annotation + methodDocText, methodRawDoc := getMethodDocComment(method) + exportAnnotation := parseExportAnnotation(methodRawDoc) + if exportAnnotation == nil { + continue + } + + export, err := parseExport(method.Names[0].Name, funcType, exportAnnotation, cleanDoc(methodDocText)) + if err != nil { + return nil, fmt.Errorf("parsing export %s.%s: %w", typeSpec.Name.Name, method.Names[0].Name, err) + } + capability.Methods = append(capability.Methods, export) + + // Collect referenced types from input and output + collectReferencedTypes(export.Input.Type, referencedTypes) + collectReferencedTypes(export.Output.Type, referencedTypes) + } + + // Recursively collect all struct dependencies + collectAllStructDependencies(referencedTypes, structMap) + + // Sort type names for stable output order + sortedTypeNames := slices.Sorted(maps.Keys(referencedTypes)) + + // Attach referenced structs to the capability + for _, typeName := range sortedTypeNames { + if s, exists := structMap[typeName]; exists { + capability.Structs = append(capability.Structs, s) + } + } + + // Attach referenced type aliases + for _, typeName := range sortedTypeNames { + if a, exists := aliasMap[typeName]; exists { + capability.TypeAliases = append(capability.TypeAliases, a) + } + } + + // Also attach type aliases prefixed with interface name (e.g., ScrobblerError for Scrobbler interface) + // This supports error types that are not directly referenced in method signatures + interfaceName := typeSpec.Name.Name + for _, typeName := range slices.Sorted(maps.Keys(aliasMap)) { + a := aliasMap[typeName] + if strings.HasPrefix(typeName, interfaceName) && !referencedTypes[typeName] { + capability.TypeAliases = append(capability.TypeAliases, a) + referencedTypes[typeName] = true // Mark as referenced for const lookup + } + } + + // Attach const groups that match referenced type aliases + for _, group := range allConstGroups { + if group.Type == "" { + continue + } + if referencedTypes[group.Type] { + capability.Consts = append(capability.Consts, group) + } + } + + if len(capability.Methods) > 0 { + capabilities = append(capabilities, capability) + } + } + } + + return capabilities, nil +} + +// collectAllStructDependencies recursively collects all struct types referenced by other structs. +func collectAllStructDependencies(referencedTypes map[string]bool, structMap map[string]StructDef) { + // Keep iterating until no new types are added + for { + newTypes := make(map[string]bool) + for typeName := range referencedTypes { + if s, exists := structMap[typeName]; exists { + for _, field := range s.Fields { + collectReferencedTypes(field.Type, newTypes) + } + } + } + // Check if any new types were found + foundNew := false + for t := range newTypes { + if !referencedTypes[t] { + referencedTypes[t] = true + foundNew = true + } + } + if !foundNew { + break + } + } +} + +// parseExport parses an export method signature into an Export struct. +func parseExport(name string, funcType *ast.FuncType, annotation map[string]string, doc string) (Export, error) { + export := Export{ + Name: name, + ExportName: annotation["name"], + Doc: doc, + } + + // Capability exports have exactly one input parameter (the struct type) + if funcType.Params != nil && len(funcType.Params.List) == 1 { + field := funcType.Params.List[0] + typeName := typeToString(field.Type) + paramName := "input" + if len(field.Names) > 0 { + paramName = field.Names[0].Name + } + export.Input = NewParam(paramName, typeName) + } + + // Capability exports return (OutputType, error) + if funcType.Results != nil { + for _, field := range funcType.Results.List { + typeName := typeToString(field.Type) + if typeName == "error" { + continue // Skip error return + } + paramName := "output" + if len(field.Names) > 0 { + paramName = field.Names[0].Name + } + export.Output = NewParam(paramName, typeName) + break // Only take the first non-error return + } + } + + return export, nil +} + +// parseFile parses a single Go source file and extracts host services. +func parseFile(fset *token.FileSet, path string) ([]Service, error) { + f, err := parser.ParseFile(fset, path, nil, parser.ParseComments) + if err != nil { + return nil, err + } + + // First pass: collect all struct definitions in the file + allStructs := parseStructs(f) + structMap := make(map[string]StructDef) + for _, s := range allStructs { + structMap[s.Name] = s + } + + var services []Service + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + interfaceType, ok := typeSpec.Type.(*ast.InterfaceType) + if !ok { + continue + } + + // Check for //nd:hostservice annotation in doc comment + docText, rawDoc := getDocComment(genDecl, typeSpec) + svcAnnotation := parseHostServiceAnnotation(rawDoc) + if svcAnnotation == nil { + continue + } + + service := Service{ + Name: svcAnnotation["name"], + Permission: svcAnnotation["permission"], + Interface: typeSpec.Name.Name, + Doc: cleanDoc(docText), + } + + // Parse methods and collect referenced types + referencedTypes := make(map[string]bool) + for _, method := range interfaceType.Methods.List { + if len(method.Names) == 0 { + continue // Embedded interface + } + + funcType, ok := method.Type.(*ast.FuncType) + if !ok { + continue + } + + // Check for //nd:hostfunc annotation + methodDocText, methodRawDoc := getMethodDocComment(method) + methodAnnotation := parseHostFuncAnnotation(methodRawDoc) + if methodAnnotation == nil { + continue + } + + m, err := parseMethod(method.Names[0].Name, funcType, methodAnnotation, cleanDoc(methodDocText)) + if err != nil { + return nil, fmt.Errorf("parsing method %s.%s: %w", typeSpec.Name.Name, method.Names[0].Name, err) + } + service.Methods = append(service.Methods, m) + + // Collect referenced types from params and returns + for _, p := range m.Params { + collectReferencedTypes(p.Type, referencedTypes) + } + for _, r := range m.Returns { + collectReferencedTypes(r.Type, referencedTypes) + } + } + + // Attach referenced structs to the service (sorted for stable output) + for _, typeName := range slices.Sorted(maps.Keys(referencedTypes)) { + if s, exists := structMap[typeName]; exists { + service.Structs = append(service.Structs, s) + } + } + + if len(service.Methods) > 0 { + services = append(services, service) + } + } + } + + return services, nil +} + +// parseStructs extracts all struct type definitions from a parsed Go file. +func parseStructs(f *ast.File) []StructDef { + var structs []StructDef + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + structType, ok := typeSpec.Type.(*ast.StructType) + if !ok { + continue + } + + docText, _ := getDocComment(genDecl, typeSpec) + s := StructDef{ + Name: typeSpec.Name.Name, + Doc: cleanDoc(docText), + } + + // Parse struct fields + for _, field := range structType.Fields.List { + if len(field.Names) == 0 { + continue // Embedded field + } + + fieldDef := parseStructField(field) + s.Fields = append(s.Fields, fieldDef...) + } + + structs = append(structs, s) + } + } + + return structs +} + +// parseTypeAliases extracts all type alias definitions from a parsed Go file. +// Type aliases are non-struct type declarations like: type MyType string +func parseTypeAliases(f *ast.File) []TypeAlias { + var aliases []TypeAlias + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.TYPE { + continue + } + + for _, spec := range genDecl.Specs { + typeSpec, ok := spec.(*ast.TypeSpec) + if !ok { + continue + } + + // Skip struct and interface types + if _, isStruct := typeSpec.Type.(*ast.StructType); isStruct { + continue + } + if _, isInterface := typeSpec.Type.(*ast.InterfaceType); isInterface { + continue + } + + docText, _ := getDocComment(genDecl, typeSpec) + aliases = append(aliases, TypeAlias{ + Name: typeSpec.Name.Name, + Type: typeToString(typeSpec.Type), + Doc: cleanDoc(docText), + }) + } + } + + return aliases +} + +// parseConstGroups extracts const groups from a parsed Go file. +func parseConstGroups(f *ast.File) []ConstGroup { + var groups []ConstGroup + + for _, decl := range f.Decls { + genDecl, ok := decl.(*ast.GenDecl) + if !ok || genDecl.Tok != token.CONST { + continue + } + + group := ConstGroup{} + for _, spec := range genDecl.Specs { + valueSpec, ok := spec.(*ast.ValueSpec) + if !ok { + continue + } + + // Get type if specified + if valueSpec.Type != nil && group.Type == "" { + group.Type = typeToString(valueSpec.Type) + } + + // Extract values + for i, name := range valueSpec.Names { + def := ConstDef{ + Name: name.Name, + } + // Get value if present + if i < len(valueSpec.Values) { + def.Value = exprToString(valueSpec.Values[i]) + } + // Get doc comment + if valueSpec.Doc != nil { + def.Doc = cleanDoc(valueSpec.Doc.Text()) + } else if valueSpec.Comment != nil { + def.Doc = cleanDoc(valueSpec.Comment.Text()) + } + group.Values = append(group.Values, def) + } + } + + if len(group.Values) > 0 { + groups = append(groups, group) + } + } + + return groups +} + +// exprToString converts an AST expression to a Go source string. +func exprToString(expr ast.Expr) string { + switch e := expr.(type) { + case *ast.BasicLit: + return e.Value + case *ast.Ident: + return e.Name + default: + return "" + } +} + +// parseStructField parses a struct field and returns FieldDef for each name. +func parseStructField(field *ast.Field) []FieldDef { + var fields []FieldDef + typeName := typeToString(field.Type) + + // Parse struct tag for JSON field name and omitempty + jsonTag := "" + omitEmpty := false + if field.Tag != nil { + tag := field.Tag.Value + // Remove backticks + tag = strings.Trim(tag, "`") + // Parse json tag + jsonTag, omitEmpty = parseJSONTag(tag) + } + + // Get doc comment + var doc string + if field.Doc != nil { + doc = cleanDoc(field.Doc.Text()) + } + + for _, name := range field.Names { + fieldJSONTag := jsonTag + if fieldJSONTag == "" { + // Default to field name with camelCase + fieldJSONTag = toJSONName(name.Name) + } + fields = append(fields, FieldDef{ + Name: name.Name, + Type: typeName, + JSONTag: fieldJSONTag, + OmitEmpty: omitEmpty, + Doc: doc, + }) + } + + return fields +} + +// parseJSONTag extracts the json field name and omitempty flag from a struct tag. +func parseJSONTag(tag string) (name string, omitEmpty bool) { + // Find json:"..." in the tag + for _, part := range strings.Split(tag, " ") { + if strings.HasPrefix(part, `json:"`) { + value := strings.TrimPrefix(part, `json:"`) + value = strings.TrimSuffix(value, `"`) + parts := strings.Split(value, ",") + if len(parts) > 0 && parts[0] != "-" { + name = parts[0] + } + for _, opt := range parts[1:] { + if opt == "omitempty" { + omitEmpty = true + } + } + return + } + } + return "", false +} + +// collectReferencedTypes extracts custom type names from a Go type string. +// It handles pointers, slices, and maps, collecting base type names. +func collectReferencedTypes(goType string, refs map[string]bool) { + // Strip pointer + if strings.HasPrefix(goType, "*") { + collectReferencedTypes(goType[1:], refs) + return + } + // Strip slice + if strings.HasPrefix(goType, "[]") { + if goType != "[]byte" { + collectReferencedTypes(goType[2:], refs) + } + return + } + // Handle map + if strings.HasPrefix(goType, "map[") { + rest := goType[4:] // Remove "map[" + depth := 1 + keyEnd := 0 + for i, r := range rest { + if r == '[' { + depth++ + } else if r == ']' { + depth-- + if depth == 0 { + keyEnd = i + break + } + } + } + keyType := rest[:keyEnd] + valueType := rest[keyEnd+1:] + collectReferencedTypes(keyType, refs) + collectReferencedTypes(valueType, refs) + return + } + + // Check if it's a custom type (starts with uppercase, not a builtin) + if len(goType) > 0 && goType[0] >= 'A' && goType[0] <= 'Z' { + switch goType { + case "String", "Bool", "Int", "Int32", "Int64", "Float32", "Float64": + // Not custom types (just capitalized for some reason) + default: + refs[goType] = true + } + } +} + +// toJSONName is imported from types.go via the same package + +// getDocComment extracts the doc comment for a type spec. +// Returns both the readable doc text and the raw comment text (which includes pragma-style comments). +func getDocComment(genDecl *ast.GenDecl, typeSpec *ast.TypeSpec) (docText, rawText string) { + var docGroup *ast.CommentGroup + // First check the TypeSpec's own doc (when multiple types in one block) + if typeSpec.Doc != nil { + docGroup = typeSpec.Doc + } else if genDecl.Doc != nil { + // Fall back to GenDecl doc (single type declaration) + docGroup = genDecl.Doc + } + if docGroup == nil { + return "", "" + } + return docGroup.Text(), commentGroupRaw(docGroup) +} + +// commentGroupRaw returns all comment text including pragma-style comments (//nd:...). +// Go's ast.CommentGroup.Text() strips comments without a space after //, so we need this. +func commentGroupRaw(cg *ast.CommentGroup) string { + if cg == nil { + return "" + } + var lines []string + for _, c := range cg.List { + lines = append(lines, c.Text) + } + return strings.Join(lines, "\n") +} + +// getMethodDocComment extracts the doc comment for a method. +func getMethodDocComment(field *ast.Field) (docText, rawText string) { + if field.Doc == nil { + return "", "" + } + return field.Doc.Text(), commentGroupRaw(field.Doc) +} + +// parseHostServiceAnnotation extracts //nd:hostservice annotation parameters. +func parseHostServiceAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := hostServicePattern.FindStringSubmatch(line) + if match != nil { + return parseKeyValuePairs(match[1]) + } + } + return nil +} + +// parseHostFuncAnnotation extracts //nd:hostfunc annotation parameters. +func parseHostFuncAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := hostFuncPattern.FindStringSubmatch(line) + if match != nil { + params := parseKeyValuePairs(match[1]) + if params == nil { + params = make(map[string]string) + } + return params + } + } + return nil +} + +// parseCapabilityAnnotation extracts //nd:capability annotation parameters. +func parseCapabilityAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := capabilityPattern.FindStringSubmatch(line) + if match != nil { + return parseKeyValuePairs(match[1]) + } + } + return nil +} + +// parseExportAnnotation extracts //nd:export annotation parameters. +func parseExportAnnotation(doc string) map[string]string { + for _, line := range strings.Split(doc, "\n") { + line = strings.TrimSpace(line) + match := exportPattern.FindStringSubmatch(line) + if match != nil { + return parseKeyValuePairs(match[1]) + } + } + return nil +} + +// parseKeyValuePairs extracts key=value pairs from annotation text. +func parseKeyValuePairs(text string) map[string]string { + matches := keyValuePattern.FindAllStringSubmatch(text, -1) + if len(matches) == 0 { + return nil + } + result := make(map[string]string) + for _, m := range matches { + result[m[1]] = m[2] + } + return result +} + +// parseMethod parses a method signature into a Method struct. +func parseMethod(name string, funcType *ast.FuncType, annotation map[string]string, doc string) (Method, error) { + m := Method{ + Name: name, + ExportName: annotation["name"], + Doc: doc, + } + + // Parse parameters (skip context.Context) + if funcType.Params != nil { + for _, field := range funcType.Params.List { + typeName := typeToString(field.Type) + if typeName == "context.Context" { + continue // Skip context parameter + } + + for _, name := range field.Names { + m.Params = append(m.Params, NewParam(name.Name, typeName)) + } + } + } + + // Parse return values + if funcType.Results != nil { + for _, field := range funcType.Results.List { + typeName := typeToString(field.Type) + if typeName == "error" { + m.HasError = true + continue // Track error but don't include in Returns + } + + // Handle anonymous returns + if len(field.Names) == 0 { + // Generate a name based on position + m.Returns = append(m.Returns, NewParam("result", typeName)) + } else { + for _, name := range field.Names { + m.Returns = append(m.Returns, NewParam(name.Name, typeName)) + } + } + } + } + + return m, nil +} + +// typeToString converts an AST type expression to a string. +func typeToString(expr ast.Expr) string { + switch t := expr.(type) { + case *ast.Ident: + return t.Name + case *ast.SelectorExpr: + return typeToString(t.X) + "." + t.Sel.Name + case *ast.StarExpr: + return "*" + typeToString(t.X) + case *ast.ArrayType: + if t.Len == nil { + return "[]" + typeToString(t.Elt) + } + return fmt.Sprintf("[%s]%s", typeToString(t.Len), typeToString(t.Elt)) + case *ast.MapType: + return fmt.Sprintf("map[%s]%s", typeToString(t.Key), typeToString(t.Value)) + case *ast.BasicLit: + return t.Value + case *ast.InterfaceType: + // Empty interface (interface{} or any) + if t.Methods == nil || len(t.Methods.List) == 0 { + return "any" + } + // Non-empty interfaces can't be easily represented + return "any" + default: + return fmt.Sprintf("%T", expr) + } +} + +// cleanDoc removes annotation lines from documentation. +func cleanDoc(doc string) string { + var lines []string + for _, line := range strings.Split(doc, "\n") { + trimmed := strings.TrimSpace(line) + if strings.HasPrefix(trimmed, "//nd:") { + continue + } + lines = append(lines, line) + } + return strings.TrimSpace(strings.Join(lines, "\n")) +} diff --git a/plugins/cmd/ndpgen/internal/parser_test.go b/plugins/cmd/ndpgen/internal/parser_test.go new file mode 100644 index 000000000..f43578397 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/parser_test.go @@ -0,0 +1,547 @@ +package internal + +import ( + "os" + "path/filepath" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Parser", func() { + var tmpDir string + + BeforeEach(func() { + var err error + tmpDir, err = os.MkdirTemp("", "ndpgen-test-*") + Expect(err).NotTo(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tmpDir) + }) + + Describe("ParseDirectory", func() { + It("should parse a simple host service interface", func() { + src := `package host + +import "context" + +// SubsonicAPIService provides access to Navidrome's Subsonic API. +//nd:hostservice name=SubsonicAPI permission=subsonicapi +type SubsonicAPIService interface { + // Call executes a Subsonic API request. + //nd:hostfunc + Call(ctx context.Context, uri string) (response string, err error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "service.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + + svc := services[0] + Expect(svc.Name).To(Equal("SubsonicAPI")) + Expect(svc.Permission).To(Equal("subsonicapi")) + Expect(svc.Interface).To(Equal("SubsonicAPIService")) + Expect(svc.Methods).To(HaveLen(1)) + + m := svc.Methods[0] + Expect(m.Name).To(Equal("Call")) + Expect(m.HasError).To(BeTrue()) + Expect(m.Params).To(HaveLen(1)) + Expect(m.Params[0].Name).To(Equal("uri")) + Expect(m.Params[0].Type).To(Equal("string")) + Expect(m.Returns).To(HaveLen(1)) + Expect(m.Returns[0].Name).To(Equal("response")) + Expect(m.Returns[0].Type).To(Equal("string")) + }) + + It("should parse multiple methods", func() { + src := `package host + +import "context" + +// SchedulerService provides scheduling capabilities. +//nd:hostservice name=Scheduler permission=scheduler +type SchedulerService interface { + //nd:hostfunc + ScheduleRecurring(ctx context.Context, cronExpression string) (scheduleID string, err error) + + //nd:hostfunc + ScheduleOneTime(ctx context.Context, delaySeconds int32) (scheduleID string, err error) + + //nd:hostfunc + CancelSchedule(ctx context.Context, scheduleID string) (canceled bool, err error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "scheduler.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + + svc := services[0] + Expect(svc.Name).To(Equal("Scheduler")) + Expect(svc.Methods).To(HaveLen(3)) + + Expect(svc.Methods[0].Name).To(Equal("ScheduleRecurring")) + Expect(svc.Methods[0].Params[0].Type).To(Equal("string")) + + Expect(svc.Methods[1].Name).To(Equal("ScheduleOneTime")) + Expect(svc.Methods[1].Params[0].Type).To(Equal("int32")) + + Expect(svc.Methods[2].Name).To(Equal("CancelSchedule")) + Expect(svc.Methods[2].Returns[0].Type).To(Equal("bool")) + }) + + It("should skip methods without hostfunc annotation", func() { + src := `package host + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + Exported(ctx context.Context) error + + // This method is not exported + NotExported(ctx context.Context) error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Methods).To(HaveLen(1)) + Expect(services[0].Methods[0].Name).To(Equal("Exported")) + }) + + It("should handle custom export name", func() { + src := `package host + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc name=custom_export_name + MyMethod(ctx context.Context) error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services[0].Methods[0].ExportName).To(Equal("custom_export_name")) + Expect(services[0].Methods[0].FunctionName("test")).To(Equal("custom_export_name")) + }) + + It("should skip generated files", func() { + regularSrc := `package host + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + Method(ctx context.Context) error +} +` + genSrc := `// Code generated. DO NOT EDIT. +package host + +//nd:hostservice name=Generated permission=gen +type GeneratedService interface { + //nd:hostfunc + Method() error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(regularSrc), 0600) + Expect(err).NotTo(HaveOccurred()) + err = os.WriteFile(filepath.Join(tmpDir, "test_gen.go"), []byte(genSrc), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Name).To(Equal("Test")) + }) + + It("should skip interfaces without hostservice annotation", func() { + src := `package host + +import "context" + +// Regular interface without annotation +type RegularInterface interface { + Method(ctx context.Context) error +} + +//nd:hostservice name=Annotated permission=annotated +type AnnotatedService interface { + //nd:hostfunc + Method(ctx context.Context) error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Name).To(Equal("Annotated")) + }) + + It("should return empty slice for directory with no host services", func() { + src := `package host + +type RegularInterface interface { + Method() error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(BeEmpty()) + }) + }) + + Describe("parseKeyValuePairs", func() { + It("should parse key=value pairs", func() { + result := parseKeyValuePairs("name=Test permission=test") + Expect(result).To(HaveKeyWithValue("name", "Test")) + Expect(result).To(HaveKeyWithValue("permission", "test")) + }) + + It("should return nil for empty input", func() { + result := parseKeyValuePairs("") + Expect(result).To(BeNil()) + }) + }) + + Describe("typeToString", func() { + It("should handle basic types", func() { + src := `package test +type T interface { + Method(s string, i int, b bool) ([]byte, error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "types.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + // Parse and verify type conversion works + // This is implicitly tested through ParseDirectory + }) + + It("should convert interface{} to any", func() { + src := `package test + +import "context" + +//nd:hostservice name=Test permission=test +type TestService interface { + //nd:hostfunc + GetMetadata(ctx context.Context) (data map[string]interface{}, err error) +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + services, err := ParseDirectory(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(services).To(HaveLen(1)) + Expect(services[0].Methods[0].Returns[0].Type).To(Equal("map[string]any")) + }) + }) + + Describe("Method helpers", func() { + It("should generate correct function names", func() { + m := Method{Name: "Call"} + Expect(m.FunctionName("subsonicapi")).To(Equal("subsonicapi_call")) + + m.ExportName = "custom_name" + Expect(m.FunctionName("subsonicapi")).To(Equal("custom_name")) + }) + + It("should generate correct type names", func() { + m := Method{Name: "Call"} + // Host-side types are public + Expect(m.RequestTypeName("SubsonicAPI")).To(Equal("SubsonicAPICallRequest")) + Expect(m.ResponseTypeName("SubsonicAPI")).To(Equal("SubsonicAPICallResponse")) + // Client/PDK types are private + Expect(m.ClientRequestTypeName("SubsonicAPI")).To(Equal("subsonicAPICallRequest")) + Expect(m.ClientResponseTypeName("SubsonicAPI")).To(Equal("subsonicAPICallResponse")) + }) + }) + + Describe("Service helpers", func() { + It("should generate correct output file name", func() { + s := Service{Name: "SubsonicAPI"} + Expect(s.OutputFileName()).To(Equal("subsonicapi_gen.go")) + }) + + It("should generate correct export prefix", func() { + s := Service{Name: "SubsonicAPI"} + Expect(s.ExportPrefix()).To(Equal("subsonicapi")) + }) + }) + + Describe("ParseCapabilities", func() { + It("should parse a simple capability interface", func() { + src := `package capabilities + +// MetadataAgent provides metadata retrieval. +//nd:capability name=metadata +type MetadataAgent interface { + // GetArtistBiography returns artist biography. + //nd:export name=nd_get_artist_biography + GetArtistBiography(ArtistInput) (ArtistBiographyOutput, error) +} + +// ArtistInput is the input for artist-related functions. +type ArtistInput struct { + // ID is the artist ID. + ID string ` + "`json:\"id\"`" + ` + // Name is the artist name. + Name string ` + "`json:\"name\"`" + ` +} + +// ArtistBiographyOutput is the output for GetArtistBiography. +type ArtistBiographyOutput struct { + // Biography is the biography text. + Biography string ` + "`json:\"biography\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "metadata.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + Expect(cap.Name).To(Equal("metadata")) + Expect(cap.Interface).To(Equal("MetadataAgent")) + Expect(cap.Required).To(BeFalse()) + Expect(cap.Doc).To(ContainSubstring("MetadataAgent provides metadata retrieval")) + Expect(cap.Methods).To(HaveLen(1)) + + m := cap.Methods[0] + Expect(m.Name).To(Equal("GetArtistBiography")) + Expect(m.ExportName).To(Equal("nd_get_artist_biography")) + Expect(m.Input.Type).To(Equal("ArtistInput")) + Expect(m.Output.Type).To(Equal("ArtistBiographyOutput")) + + // Check structs were collected + Expect(cap.Structs).To(HaveLen(2)) + }) + + It("should parse a required capability", func() { + src := `package capabilities + +// Scrobbler requires all methods to be implemented. +//nd:capability name=scrobbler required=true +type Scrobbler interface { + //nd:export name=nd_scrobbler_is_authorized + IsAuthorized(AuthInput) (AuthOutput, error) + + //nd:export name=nd_scrobbler_scrobble + Scrobble(ScrobbleInput) (ScrobblerOutput, error) +} + +type AuthInput struct { + UserID string ` + "`json:\"userId\"`" + ` +} + +type AuthOutput struct { + Authorized bool ` + "`json:\"authorized\"`" + ` +} + +type ScrobbleInput struct { + UserID string ` + "`json:\"userId\"`" + ` +} + +type ScrobblerOutput struct { + Error *string ` + "`json:\"error,omitempty\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "scrobbler.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + Expect(cap.Name).To(Equal("scrobbler")) + Expect(cap.Required).To(BeTrue()) + Expect(cap.Methods).To(HaveLen(2)) + }) + + It("should parse type aliases and consts", func() { + src := `package capabilities + +//nd:capability name=scrobbler required=true +type Scrobbler interface { + //nd:export name=nd_scrobble + Scrobble(ScrobbleInput) (ScrobblerOutput, error) +} + +type ScrobbleInput struct { + UserID string ` + "`json:\"userId\"`" + ` +} + +// ScrobblerErrorType indicates error handling behavior. +type ScrobblerErrorType string + +const ( + // ScrobblerErrorNone indicates no error. + ScrobblerErrorNone ScrobblerErrorType = "none" + // ScrobblerErrorRetry indicates retry later. + ScrobblerErrorRetry ScrobblerErrorType = "retry" +) + +type ScrobblerOutput struct { + ErrorType *ScrobblerErrorType ` + "`json:\"errorType,omitempty\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "scrobbler.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + // Type alias should be collected + Expect(cap.TypeAliases).To(HaveLen(1)) + Expect(cap.TypeAliases[0].Name).To(Equal("ScrobblerErrorType")) + Expect(cap.TypeAliases[0].Type).To(Equal("string")) + + // Consts should be collected + Expect(cap.Consts).To(HaveLen(1)) + Expect(cap.Consts[0].Type).To(Equal("ScrobblerErrorType")) + Expect(cap.Consts[0].Values).To(HaveLen(2)) + Expect(cap.Consts[0].Values[0].Name).To(Equal("ScrobblerErrorNone")) + Expect(cap.Consts[0].Values[0].Value).To(Equal(`"none"`)) + }) + + It("should collect nested struct dependencies", func() { + src := `package capabilities + +//nd:capability name=metadata +type MetadataAgent interface { + //nd:export name=nd_get_images + GetImages(ArtistInput) (ImagesOutput, error) +} + +type ArtistInput struct { + ID string ` + "`json:\"id\"`" + ` +} + +type ImagesOutput struct { + Images []ImageInfo ` + "`json:\"images\"`" + ` +} + +type ImageInfo struct { + URL string ` + "`json:\"url\"`" + ` + Size int32 ` + "`json:\"size\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "metadata.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + cap := capabilities[0] + // Should collect all 3 structs: ArtistInput, ImagesOutput, and ImageInfo + Expect(cap.Structs).To(HaveLen(3)) + + structNames := make([]string, len(cap.Structs)) + for i, s := range cap.Structs { + structNames[i] = s.Name + } + Expect(structNames).To(ContainElements("ArtistInput", "ImagesOutput", "ImageInfo")) + }) + + It("should return empty slice for directory with no capabilities", func() { + src := `package capabilities + +type RegularInterface interface { + Method() error +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(BeEmpty()) + }) + + It("should ignore methods without export annotation", func() { + src := `package capabilities + +//nd:capability name=test +type TestCapability interface { + //nd:export name=nd_exported + ExportedMethod(Input) (Output, error) + + // This method has no export annotation + NotExportedMethod(Input) (Output, error) +} + +type Input struct { + Value string ` + "`json:\"value\"`" + ` +} + +type Output struct { + Result string ` + "`json:\"result\"`" + ` +} +` + err := os.WriteFile(filepath.Join(tmpDir, "test.go"), []byte(src), 0600) + Expect(err).NotTo(HaveOccurred()) + + capabilities, err := ParseCapabilities(tmpDir) + Expect(err).NotTo(HaveOccurred()) + Expect(capabilities).To(HaveLen(1)) + + // Only the exported method should be captured + Expect(capabilities[0].Methods).To(HaveLen(1)) + Expect(capabilities[0].Methods[0].Name).To(Equal("ExportedMethod")) + }) + }) + + Describe("Export helpers", func() { + It("should generate correct provider interface name", func() { + e := Export{Name: "GetArtistBiography"} + Expect(e.ProviderInterfaceName()).To(Equal("ArtistBiographyProvider")) + + e = Export{Name: "OnInit"} + Expect(e.ProviderInterfaceName()).To(Equal("InitProvider")) + }) + + It("should generate correct impl variable name", func() { + e := Export{Name: "GetArtistBiography"} + Expect(e.ImplVarName()).To(Equal("artistBiographyImpl")) + + e = Export{Name: "OnInit"} + Expect(e.ImplVarName()).To(Equal("initImpl")) + }) + + It("should generate correct export function name", func() { + e := Export{Name: "GetArtistBiography", ExportName: "nd_get_artist_biography"} + Expect(e.ExportFuncName()).To(Equal("_NdGetArtistBiography")) + }) + }) +}) diff --git a/plugins/cmd/ndpgen/internal/pdk_parser.go b/plugins/cmd/ndpgen/internal/pdk_parser.go new file mode 100644 index 000000000..4756334dd --- /dev/null +++ b/plugins/cmd/ndpgen/internal/pdk_parser.go @@ -0,0 +1,441 @@ +package internal + +import ( + "fmt" + "go/ast" + "go/token" + "sort" + "strings" + + "golang.org/x/tools/go/packages" +) + +// PDKSymbols contains all exported symbols parsed from extism/go-pdk. +type PDKSymbols struct { + Types []PDKType + Consts []PDKConst + Functions []PDKFunc +} + +// PDKType represents an exported type from extism/go-pdk. +type PDKType struct { + Name string + Underlying string // The underlying type (e.g., "int" for LogLevel) + IsAlias bool // True if it's a type alias (type X = Y) + Doc string // Documentation comment + Methods []PDKFunc // Methods on this type + Fields []PDKField // Struct fields (if it's a struct type) +} + +// PDKField represents a struct field. +type PDKField struct { + Name string + Type string + Tag string // Struct tag (e.g., `json:"name"`) +} + +// PDKConst represents an exported constant from extism/go-pdk. +type PDKConst struct { + Name string + Type string // The type name (may be empty for untyped consts) + Value string // The value expression + Doc string +} + +// PDKFunc represents an exported function from extism/go-pdk. +type PDKFunc struct { + Name string + Doc string + Receiver string // Empty for package-level functions + Params []PDKParam + Returns []PDKReturn + IsVariadic bool +} + +// PDKParam represents a function parameter. +type PDKParam struct { + Name string + Type string +} + +// PDKReturn represents a function return value. +type PDKReturn struct { + Name string // May be empty for unnamed returns + Type string +} + +// ParseExtismPDK parses the extism/go-pdk package and extracts all exported symbols. +func ParseExtismPDK() (*PDKSymbols, error) { + // Load both packages with syntax trees in one call + cfg := &packages.Config{ + Mode: packages.NeedName | packages.NeedSyntax | packages.NeedFiles, + } + pkgs, err := packages.Load(cfg, + "github.com/extism/go-pdk", + "github.com/extism/go-pdk/internal/memory", + ) + if err != nil { + return nil, fmt.Errorf("loading extism/go-pdk: %w", err) + } + + // Find both packages + var pdkPkg, memoryPkg *packages.Package + for _, pkg := range pkgs { + if len(pkg.Errors) > 0 { + return nil, fmt.Errorf("loading %s: %v", pkg.PkgPath, pkg.Errors[0]) + } + switch pkg.Name { + case "pdk": + pdkPkg = pkg + case "memory": + memoryPkg = pkg + } + } + if pdkPkg == nil { + return nil, fmt.Errorf("package github.com/extism/go-pdk not found") + } + if memoryPkg == nil { + return nil, fmt.Errorf("package github.com/extism/go-pdk/internal/memory not found") + } + + symbols := &PDKSymbols{} + seenTypes := make(map[string]bool) + + // Extract Memory type from internal/memory package first + extractMemorySymbols(memoryPkg.Syntax, symbols, seenTypes) + + // First pass: collect types from pdk package (skip if already found in internal packages) + for _, file := range pdkPkg.Syntax { + for _, decl := range file.Decls { + if genDecl, ok := decl.(*ast.GenDecl); ok { + for _, spec := range genDecl.Specs { + if typeSpec, ok := spec.(*ast.TypeSpec); ok { + if !typeSpec.Name.IsExported() { + continue + } + // Skip if we already have this type (from internal packages) + if seenTypes[typeSpec.Name.Name] { + continue + } + seenTypes[typeSpec.Name.Name] = true + pdkType := extractType(typeSpec, genDecl.Doc) + symbols.Types = append(symbols.Types, pdkType) + } + } + } + } + } + + // Build typeMap from the final slice (after all types are added) + typeMap := make(map[string]*PDKType) + for i := range symbols.Types { + typeMap[symbols.Types[i].Name] = &symbols.Types[i] + } + + // Second pass: collect functions and methods from pdk package + for _, file := range pdkPkg.Syntax { + for _, decl := range file.Decls { + switch d := decl.(type) { + case *ast.GenDecl: + if d.Tok == token.CONST { + consts := extractConsts(d) + symbols.Consts = append(symbols.Consts, consts...) + } + case *ast.FuncDecl: + if !d.Name.IsExported() { + continue + } + fn := extractFunc(d) + if fn.Receiver != "" { + // It's a method, associate with type + typeName := fn.Receiver + if strings.HasPrefix(typeName, "*") { + typeName = typeName[1:] + } + if t, ok := typeMap[typeName]; ok { + t.Methods = append(t.Methods, fn) + } + } else { + symbols.Functions = append(symbols.Functions, fn) + } + } + } + } + + // Sort for consistent output + sort.Slice(symbols.Types, func(i, j int) bool { + return symbols.Types[i].Name < symbols.Types[j].Name + }) + sort.Slice(symbols.Consts, func(i, j int) bool { + return symbols.Consts[i].Name < symbols.Consts[j].Name + }) + sort.Slice(symbols.Functions, func(i, j int) bool { + return symbols.Functions[i].Name < symbols.Functions[j].Name + }) + + return symbols, nil +} + +func extractType(spec *ast.TypeSpec, doc *ast.CommentGroup) PDKType { + t := PDKType{ + Name: spec.Name.Name, + Doc: extractDoc(doc), + } + + // Check if it's an alias (type X = Y) + t.IsAlias = spec.Assign.IsValid() + + // Extract underlying type + t.Underlying = typeString(spec.Type) + + // Extract struct fields if it's a struct type + if structType, ok := spec.Type.(*ast.StructType); ok { + t.Fields = extractStructFields(structType) + } + + return t +} + +func extractStructFields(st *ast.StructType) []PDKField { + var fields []PDKField + if st.Fields == nil { + return fields + } + + for _, field := range st.Fields.List { + fieldType := typeString(field.Type) + tag := "" + if field.Tag != nil { + tag = field.Tag.Value + } + + if len(field.Names) == 0 { + // Embedded field + fields = append(fields, PDKField{ + Name: fieldType, // Use type name as field name for embedded + Type: fieldType, + Tag: tag, + }) + } else { + for _, name := range field.Names { + // Skip unexported fields + if !name.IsExported() { + continue + } + fields = append(fields, PDKField{ + Name: name.Name, + Type: fieldType, + Tag: tag, + }) + } + } + } + return fields +} + +func extractConsts(decl *ast.GenDecl) []PDKConst { + var consts []PDKConst + var currentType string // For iota-style const blocks + + for i, spec := range decl.Specs { + valSpec, ok := spec.(*ast.ValueSpec) + if !ok { + continue + } + + // Update type if specified + if valSpec.Type != nil { + currentType = typeString(valSpec.Type) + } + + for j, name := range valSpec.Names { + if !name.IsExported() { + continue + } + + c := PDKConst{ + Name: name.Name, + Type: currentType, + } + + // Extract value + if j < len(valSpec.Values) { + c.Value = exprString(valSpec.Values[j]) + } else if i == 0 && j == 0 { + // First const with no value - likely iota + c.Value = "iota" + } + + // Extract doc + if valSpec.Doc != nil { + c.Doc = extractDoc(valSpec.Doc) + } else if i == 0 && decl.Doc != nil { + c.Doc = extractDoc(decl.Doc) + } + + consts = append(consts, c) + } + } + + return consts +} + +func extractFunc(decl *ast.FuncDecl) PDKFunc { + fn := PDKFunc{ + Name: decl.Name.Name, + Doc: extractDoc(decl.Doc), + } + + // Extract receiver + if decl.Recv != nil && len(decl.Recv.List) > 0 { + fn.Receiver = typeString(decl.Recv.List[0].Type) + } + + // Extract parameters + if decl.Type.Params != nil { + for _, field := range decl.Type.Params.List { + paramType := typeString(field.Type) + + // Check for variadic + if _, ok := field.Type.(*ast.Ellipsis); ok { + fn.IsVariadic = true + } + + if len(field.Names) == 0 { + // Unnamed parameter + fn.Params = append(fn.Params, PDKParam{Type: paramType}) + } else { + for _, name := range field.Names { + fn.Params = append(fn.Params, PDKParam{ + Name: name.Name, + Type: paramType, + }) + } + } + } + } + + // Extract returns + if decl.Type.Results != nil { + for _, field := range decl.Type.Results.List { + retType := typeString(field.Type) + + if len(field.Names) == 0 { + // Unnamed return + fn.Returns = append(fn.Returns, PDKReturn{Type: retType}) + } else { + for _, name := range field.Names { + fn.Returns = append(fn.Returns, PDKReturn{ + Name: name.Name, + Type: retType, + }) + } + } + } + } + + return fn +} + +func extractDoc(doc *ast.CommentGroup) string { + if doc == nil { + return "" + } + return strings.TrimSpace(doc.Text()) +} + +func typeString(expr ast.Expr) string { + switch t := expr.(type) { + case *ast.Ident: + return t.Name + case *ast.StarExpr: + return "*" + typeString(t.X) + case *ast.SelectorExpr: + return typeString(t.X) + "." + t.Sel.Name + case *ast.ArrayType: + if t.Len == nil { + return "[]" + typeString(t.Elt) + } + return fmt.Sprintf("[%s]%s", exprString(t.Len), typeString(t.Elt)) + case *ast.MapType: + return fmt.Sprintf("map[%s]%s", typeString(t.Key), typeString(t.Value)) + case *ast.InterfaceType: + return "any" // Simplified + case *ast.Ellipsis: + return "..." + typeString(t.Elt) + case *ast.StructType: + return "struct{}" // Simplified for anonymous structs + case *ast.FuncType: + return "func()" // Simplified + default: + return fmt.Sprintf("%T", expr) + } +} + +func exprString(expr ast.Expr) string { + switch e := expr.(type) { + case *ast.Ident: + return e.Name + case *ast.BasicLit: + return e.Value + case *ast.BinaryExpr: + return exprString(e.X) + " " + e.Op.String() + " " + exprString(e.Y) + case *ast.UnaryExpr: + return e.Op.String() + exprString(e.X) + case *ast.CallExpr: + return typeString(e.Fun) + "(...)" + default: + return fmt.Sprintf("%T", expr) + } +} + +// extractMemorySymbols extracts the Memory type and its methods from already-parsed syntax trees. +// This is needed because Memory is defined in internal/memory but re-exported by the pdk package. +func extractMemorySymbols(files []*ast.File, symbols *PDKSymbols, seenTypes map[string]bool) { + // Collect the Memory type + for _, file := range files { + for _, decl := range file.Decls { + if genDecl, ok := decl.(*ast.GenDecl); ok { + for _, spec := range genDecl.Specs { + if typeSpec, ok := spec.(*ast.TypeSpec); ok { + // Only interested in Memory type + if typeSpec.Name.Name == "Memory" { + pdkType := extractType(typeSpec, genDecl.Doc) + symbols.Types = append(symbols.Types, pdkType) + seenTypes["Memory"] = true + } + } + } + } + } + } + + // Build local type map for method association + localTypeMap := make(map[string]*PDKType) + for i := range symbols.Types { + localTypeMap[symbols.Types[i].Name] = &symbols.Types[i] + } + + // Collect methods for Memory + for _, file := range files { + for _, decl := range file.Decls { + if funcDecl, ok := decl.(*ast.FuncDecl); ok { + if !funcDecl.Name.IsExported() { + continue + } + fn := extractFunc(funcDecl) + if fn.Receiver != "" { + typeName := fn.Receiver + if strings.HasPrefix(typeName, "*") { + typeName = typeName[1:] + } + if typeName == "Memory" { + if t, ok := localTypeMap["Memory"]; ok { + t.Methods = append(t.Methods, fn) + } + } + } + } + } + } +} diff --git a/plugins/cmd/ndpgen/internal/templates/base64_bytes.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/base64_bytes.rs.tmpl new file mode 100644 index 000000000..929aa8e3e --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/base64_bytes.rs.tmpl @@ -0,0 +1,25 @@ +{{define "base64_bytes_module"}} +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize(bytes: &Vec, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} +{{- end}} \ No newline at end of file diff --git a/plugins/cmd/ndpgen/internal/templates/capability.go.tmpl b/plugins/cmd/ndpgen/internal/templates/capability.go.tmpl new file mode 100644 index 000000000..ebcd80739 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/capability.go.tmpl @@ -0,0 +1,223 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the {{.Capability.Interface}} capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package {{.Package}} + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +{{- /* Generate type alias definitions */ -}} +{{- range .Capability.TypeAliases}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} {{.Type}} +{{- end}} + +{{- /* Generate const definitions */ -}} +{{- range .Capability.Consts}} +{{- if .Values}} + +const ( +{{- $type := .Type}} +{{- range $i, $v := .Values}} +{{- if $v.Doc}} +{{formatDoc $v.Doc | indent 1}} +{{- end}} +{{- if $type}} + {{$v.Name}} {{$type}} = {{$v.Value}} +{{- else}} + {{$v.Name}} = {{$v.Value}} +{{- end}} +{{- end}} +) +{{- end}} +{{- end}} + +{{- /* Generate Error() methods for string type aliases with const values (implements error interface) */ -}} +{{- $consts := .Capability.Consts}} +{{- range .Capability.TypeAliases}} +{{- if eq .Type "string"}} +{{- $typeName := .Name}} +{{- range $consts}} +{{- if eq .Type $typeName}} + +// Error implements the error interface for {{$typeName}}. +func (e {{$typeName}}) Error() string { return string(e) } +{{- end}} +{{- end}} +{{- end}} +{{- end}} + +{{- /* Generate struct definitions */ -}} +{{- range .Capability.Structs}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- else}} +// {{.Name}} represents the {{.Name}} data structure. +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} +{{- if .Doc}} +{{formatDoc .Doc | indent 1}} +{{- end}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}{{if .OmitEmpty}},omitempty{{end}}"` +{{- end}} +} +{{- end}} + +{{- /* Generate main interface based on required flag */ -}} +{{if .Capability.Required}} + +// {{agentName .Capability}} requires all methods to be implemented. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface { +{{- range .Capability.Methods}} + // {{.Name}}{{if .Doc}} - {{.Doc}}{{end}} + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +{{- end}} +} +{{- else}} + +// {{agentName .Capability}} is the marker interface for {{.Package}} plugins. +// Implement one or more of the provider interfaces below. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface{} +{{- end}} + +{{- /* Generate optional provider interfaces for non-required capabilities */ -}} +{{- if not .Capability.Required}} +{{- range .Capability.Methods}} + +// {{providerInterface .}} provides the {{.Name}} function. +type {{providerInterface .}} interface { + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +} +{{- end}} +{{- end}} + +{{- /* Generate implementation function holders */ -}} + +// Internal implementation holders +var ( +{{- range .Capability.Methods}} + {{- if and .HasInput .HasOutput}} + {{implVar .}} func({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{implVar .}} func({{.Input.Type}}) error + {{- else if .HasOutput}} + {{implVar .}} func() ({{.Output.Type}}, error) + {{- else}} + {{implVar .}} func() error + {{- end}} +{{- end}} +) + +// Register registers a {{.Package}} implementation. +{{- if .Capability.Required}} +// All methods are required. +func Register(impl {{agentName .Capability}}) { +{{- range .Capability.Methods}} + {{implVar .}} = impl.{{.Name}} +{{- end}} +} +{{- else}} +// The implementation is checked for optional provider interfaces. +func Register(impl {{agentName .Capability}}) { +{{- range .Capability.Methods}} + if p, ok := impl.({{providerInterface .}}); ok { + {{implVar .}} = p.{{.Name}} + } +{{- end}} +} +{{- end}} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +{{- /* Generate export wrappers */ -}} +{{range .Capability.Methods}} + +//go:wasmexport {{.ExportName}} +func {{exportFunc .}}() int32 { + if {{implVar .}} == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } +{{- if .HasInput}} + + var input {{.Input.Type}} + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } +{{- end}} +{{- if and .HasInput .HasOutput}} + + output, err := {{implVar .}}(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } +{{- else if .HasInput}} + + if err := {{implVar .}}(input); err != nil { + pdk.SetError(err) + return -1 + } +{{- else if .HasOutput}} + + output, err := {{implVar .}}() + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } +{{- else}} + + if err := {{implVar .}}(); err != nil { + pdk.SetError(err) + return -1 + } +{{- end}} + + return 0 +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl new file mode 100644 index 000000000..790ed93e4 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/capability.rs.tmpl @@ -0,0 +1,202 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the {{.Capability.Interface}} capability. +// It is intended for use in Navidrome plugins built with extism-pdk. +{{if .Capability.Structs}} +use serde::{Deserialize, Serialize}; +{{- if hasHashMap .Capability}} +use std::collections::HashMap; +{{- end}} +{{- if .Capability.HasByteFields}}{{template "base64_bytes_module" .}}{{- end}} + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +{{- end}} + +{{- /* Generate type alias definitions */ -}} +{{- range .Capability.TypeAliases}} + +{{- if .Doc}} +{{rustDocComment .Doc}} +{{- end}} +pub type {{.Name}} = {{rustTypeAlias .Type}}; +{{- end}} + +{{- /* Generate const definitions */ -}} +{{- range .Capability.Consts}} +{{- if .Values}} +{{- $type := .Type}} +{{- range $i, $v := .Values}} + +{{- if $v.Doc}} +{{rustDocComment $v.Doc}} +{{- end}} +{{- /* Use the type alias name if a named type is provided, otherwise use &'static str */ -}} +{{- if $type}} +pub const {{rustConstName $v.Name}}: {{$type}} = {{$v.Value}}; +{{- else}} +pub const {{rustConstName $v.Name}}: &'static str = {{$v.Value}}; +{{- end}} +{{- end}} +{{- end}} +{{- end}} + +{{- /* Generate struct definitions */ -}} +{{- range .Capability.Structs}} + +{{- if .Doc}} +{{rustDocComment .Doc}} +{{- else}} +/// {{.Name}} represents the {{.Name}} data structure. +{{- end}} +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct {{.Name}} { +{{- range .Fields}} +{{- if .Doc}} +{{rustDocComment .Doc | indent 4}} +{{- end}} +{{- if .OmitEmpty}} + #[serde(default, skip_serializing_if = "{{skipSerializingFunc .Type}}")] +{{- else}} + #[serde(default)] +{{- end}} +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + pub {{rustFieldName .Name}}: {{fieldRustType .}}, +{{- end}} +} +{{- end}} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into) -> Self { + Self { message: message.into() } + } +} + +{{- /* Generate main interface based on required flag */ -}} +{{if .Capability.Required}} + +/// {{agentName .Capability}} requires all methods to be implemented. +{{- if .Capability.Doc}} +{{rustDocComment .Capability.Doc}} +{{- end}} +pub trait {{agentName .Capability}} { +{{- range .Capability.Methods}} + /// {{.Name}}{{if .Doc}} - {{.Doc}}{{end}} + {{- if and .HasInput .HasOutput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else if .HasInput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<(), Error>; + {{- else if .HasOutput}} + fn {{rustMethodName .Name}}(&self) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else}} + fn {{rustMethodName .Name}}(&self) -> Result<(), Error>; + {{- end}} +{{- end}} +} + +/// Register all exports for the {{agentName .Capability}} capability. +/// This macro generates the WASM export functions for all trait methods. +#[macro_export] +macro_rules! register_{{snakeCase .Package}} { + ($plugin_type:ty) => { + {{- range .Capability.Methods}} + #[extism_pdk::plugin_fn] + pub fn {{.ExportName}}( + {{- if .HasInput}} + req: extism_pdk::Json<$crate::{{snakeCase $.Package}}::{{rustOutputType .Input.Type}}> + {{- end}} + ) -> extism_pdk::FnResult<{{if .HasOutput}}extism_pdk::Json<{{if isPrimitiveRust .Output.Type}}{{rustOutputType .Output.Type}}{{else}}$crate::{{snakeCase $.Package}}::{{rustOutputType .Output.Type}}{{end}}>{{else}}(){{end}}> { + let plugin = <$plugin_type>::default(); + {{- if and .HasInput .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + {{- else if .HasInput}} + $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(()) + {{- else if .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin)?; + Ok(extism_pdk::Json(result)) + {{- else}} + $crate::{{snakeCase $.Package}}::{{agentName $.Capability}}::{{rustMethodName .Name}}(&plugin)?; + Ok(()) + {{- end}} + } + {{- end}} + }; +} +{{- else}} + +{{- /* Generate optional provider interfaces for non-required capabilities */ -}} +{{- range .Capability.Methods}} + +/// {{providerInterface .}} provides the {{.Name}} function. +pub trait {{providerInterface .}} { + {{- if and .HasInput .HasOutput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else if .HasInput}} + fn {{rustMethodName .Name}}(&self, req: {{rustOutputType .Input.Type}}) -> Result<(), Error>; + {{- else if .HasOutput}} + fn {{rustMethodName .Name}}(&self) -> Result<{{rustOutputType .Output.Type}}, Error>; + {{- else}} + fn {{rustMethodName .Name}}(&self) -> Result<(), Error>; + {{- end}} +} + +/// Register the {{rustMethodName .Name}} export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! {{registerMacroName .Name}} { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn {{.ExportName}}( + {{- if .HasInput}} + req: extism_pdk::Json<$crate::{{snakeCase $.Package}}::{{rustOutputType .Input.Type}}> + {{- end}} + ) -> extism_pdk::FnResult<{{if .HasOutput}}extism_pdk::Json<{{if isPrimitiveRust .Output.Type}}{{rustOutputType .Output.Type}}{{else}}$crate::{{snakeCase $.Package}}::{{rustOutputType .Output.Type}}{{end}}>{{else}}(){{end}}> { + let plugin = <$plugin_type>::default(); + {{- if and .HasInput .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + {{- else if .HasInput}} + $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin, req.into_inner())?; + Ok(()) + {{- else if .HasOutput}} + let result = $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin)?; + Ok(extism_pdk::Json(result)) + {{- else}} + $crate::{{snakeCase $.Package}}::{{providerInterface .}}::{{rustMethodName .Name}}(&plugin)?; + Ok(()) + {{- end}} + } + }; +} +{{- end}} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/capability_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/capability_stub.go.tmpl new file mode 100644 index 000000000..90f72be93 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/capability_stub.go.tmpl @@ -0,0 +1,132 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package {{.Package}} + +{{- /* Generate type alias definitions */ -}} +{{- range .Capability.TypeAliases}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} {{.Type}} +{{- end}} + +{{- /* Generate const definitions */ -}} +{{- range .Capability.Consts}} +{{- if .Values}} + +const ( +{{- $type := .Type}} +{{- range $i, $v := .Values}} +{{- if $v.Doc}} +{{formatDoc $v.Doc | indent 1}} +{{- end}} +{{- if $type}} + {{$v.Name}} {{$type}} = {{$v.Value}} +{{- else}} + {{$v.Name}} = {{$v.Value}} +{{- end}} +{{- end}} +) +{{- end}} +{{- end}} + +{{- /* Generate Error() methods for string type aliases with const values (implements error interface) */ -}} +{{- $consts := .Capability.Consts}} +{{- range .Capability.TypeAliases}} +{{- if eq .Type "string"}} +{{- $typeName := .Name}} +{{- range $consts}} +{{- if eq .Type $typeName}} + +// Error implements the error interface for {{$typeName}}. +func (e {{$typeName}}) Error() string { return string(e) } +{{- end}} +{{- end}} +{{- end}} +{{- end}} + +{{- /* Generate struct definitions */ -}} +{{- range .Capability.Structs}} + +{{- if .Doc}} +{{formatDoc .Doc}} +{{- else}} +// {{.Name}} represents the {{.Name}} data structure. +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} +{{- if .Doc}} +{{formatDoc .Doc | indent 1}} +{{- end}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}{{if .OmitEmpty}},omitempty{{end}}"` +{{- end}} +} +{{- end}} + +{{- /* Generate main interface based on required flag */ -}} +{{if .Capability.Required}} + +// {{agentName .Capability}} requires all methods to be implemented. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface { +{{- range .Capability.Methods}} + // {{.Name}}{{if .Doc}} - {{.Doc}}{{end}} + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +{{- end}} +} +{{- else}} + +// {{agentName .Capability}} is the marker interface for {{.Package}} plugins. +// Implement one or more of the provider interfaces below. +{{- if .Capability.Doc}} +{{formatDoc .Capability.Doc}} +{{- end}} +type {{agentName .Capability}} interface{} +{{- end}} + +{{- /* Generate optional provider interfaces for non-required capabilities */ -}} +{{- if not .Capability.Required}} +{{- range .Capability.Methods}} + +// {{providerInterface .}} provides the {{.Name}} function. +type {{providerInterface .}} interface { + {{- if and .HasInput .HasOutput}} + {{.Name}}({{.Input.Type}}) ({{.Output.Type}}, error) + {{- else if .HasInput}} + {{.Name}}({{.Input.Type}}) error + {{- else if .HasOutput}} + {{.Name}}() ({{.Output.Type}}, error) + {{- else}} + {{.Name}}() error + {{- end}} +} +{{- end}} +{{- end}} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +{{- if .Capability.Required}} +func Register(_ {{agentName .Capability}}) {} +{{- else}} +func Register(_ {{agentName .Capability}}) {} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client.go.tmpl b/plugins/cmd/ndpgen/internal/templates/client.go.tmpl new file mode 100644 index 000000000..a6ee04446 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client.go.tmpl @@ -0,0 +1,129 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the {{.Service.Name}} host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package {{.Package}} + +import ( + "encoding/json" +{{- if .Service.HasErrors}} + "errors" +{{- end}} + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +{{- /* Generate struct definitions */ -}} +{{- range .Service.Structs}} + +// {{.Name}} represents the {{.Name}} data structure. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}"` +{{- end}} +} +{{- end}} + +{{- /* Generate wasmimport declarations for each method */ -}} +{{range .Service.Methods}} + +// {{exportName .}} is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user {{exportName .}} +func {{exportName .}}(uint64) uint64 +{{- end}} + +{{- /* Generate request/response types for all methods (private) */ -}} +{{range .Service.Methods}} +{{- if .HasParams}} + +type {{requestType .}} struct { +{{- range .Params}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}}"` +{{- end}} +} +{{- end}} +{{- if not .IsErrorOnly}} + +type {{responseType .}} struct { +{{- range .Returns}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}},omitempty"` +{{- end}} +{{- if .HasError}} + Error string `json:"error,omitempty"` +{{- end}} +} +{{- end}} +{{- end}} + +{{- /* Generate wrapper functions */ -}} +{{range .Service.Methods}} + +// {{$.Service.Name}}{{.Name}} calls the {{exportName .}} host function. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +func {{$.Service.Name}}{{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}} {{$p.Type}}{{end}}) {{.ReturnSignature}} { +{{- if .HasParams}} + // Marshal request to JSON + req := {{requestType .}}{ +{{- range .Params}} + {{title .Name}}: {{.Name}}, +{{- end}} + } + reqBytes, err := json.Marshal(req) + if err != nil { + return {{if .HasReturns}}{{.ZeroValues}}{{end}}{{if and .HasReturns .HasError}}, {{end}}{{if .HasError}}err{{end}} + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() +{{- else}} + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() +{{- end}} + + // Call the host function + responsePtr := {{exportName .}}(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() +{{- if .IsErrorOnly}} + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +{{- else}} + + // Parse the response + var response {{responseType .}} + if err := json.Unmarshal(responseBytes, &response); err != nil { + return {{if .HasReturns}}{{.ZeroValues}}{{end}}{{if and .HasReturns .HasError}}, {{end}}{{if .HasError}}err{{end}} + } +{{- if .HasError}} + + // Convert Error field to Go error + if response.Error != "" { + return {{if .HasReturns}}{{.ZeroValues}}, {{end}}errors.New(response.Error) + } +{{- end}} + + return {{range $i, $r := .Returns}}{{if $i}}, {{end}}response.{{title $r.Name}}{{end}}{{if and .HasReturns .HasError}}, {{end}}{{if .HasError}}nil{{end}} +{{- end}} +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client.py.tmpl b/plugins/cmd/ndpgen/internal/templates/client.py.tmpl new file mode 100644 index 000000000..7ccaa6106 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client.py.tmpl @@ -0,0 +1,111 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the {{.Service.Name}} host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +{{- if .Service.HasByteFields}} +import base64 +{{- end}} + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + +{{- /* Generate raw host function imports */ -}} +{{range .Service.Methods}} + + +@extism.import_fn("extism:host/user", "{{exportName .}}") +def _{{exportName .}}(offset: int) -> int: + """Raw host function - do not call directly.""" + ... +{{- end}} +{{- /* Generate dataclasses for multi-value returns */ -}} +{{range .Service.Methods}} +{{- if .NeedsResultClass}} + + +@dataclass +class {{pythonResultType .}}: + """Result type for {{pythonFunc .}}.""" +{{- range .Returns}} + {{.PythonName}}: {{.PythonType}} +{{- end}} +{{- end}} +{{- end}} +{{- /* Generate wrapper functions */ -}} +{{range .Service.Methods}} + + +def {{pythonFunc .}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.PythonName}}: {{$p.PythonType}}{{end}}){{if .NeedsResultClass}} -> {{pythonResultType .}}{{else if .HasReturns}} -> {{(index .Returns 0).PythonType}}{{else}} -> None{{end}}: + """{{if .Doc}}{{.Doc}}{{else}}Call the {{exportName .}} host function.{{end}} +{{- if .HasParams}} + + Args: +{{- range .Params}} + {{.PythonName}}: {{.PythonType}} parameter. +{{- end}} +{{- end}} +{{- if .HasReturns}} + + Returns: +{{- if .NeedsResultClass}} + {{pythonResultType .}} containing{{range .Returns}} {{.PythonName}},{{end}}. +{{- else}} + {{(index .Returns 0).PythonType}}: The result value. +{{- end}} +{{- end}} + + Raises: + HostFunctionError: If the host function returns an error. + """ +{{- if .HasParams}} + request = { +{{- range .Params}} +{{- if .IsByteSlice}} + "{{.JSONName}}": base64.b64encode({{.PythonName}}).decode("ascii"), +{{- else}} + "{{.JSONName}}": {{.PythonName}}, +{{- end}} +{{- end}} + } + request_bytes = json.dumps(request).encode("utf-8") +{{- else}} + request_bytes = b"{}" +{{- end}} + request_mem = extism.memory.alloc(request_bytes) + response_offset = _{{exportName .}}(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) +{{if .HasError}} + if response.get("error"): + raise HostFunctionError(response["error"]) +{{end}} +{{- if .NeedsResultClass}} + return {{pythonResultType .}}( +{{- range .Returns}} +{{- if .IsByteSlice}} + {{.PythonName}}=base64.b64decode(response.get("{{.JSONName}}", "")), +{{- else}} + {{.PythonName}}=response.get("{{.JSONName}}"{{pythonDefault .}}), +{{- end}} +{{- end}} + ) +{{- else if .HasReturns}} +{{- if (index .Returns 0).IsByteSlice}} + return base64.b64decode(response.get("{{(index .Returns 0).JSONName}}", "")) +{{- else}} + return response.get("{{(index .Returns 0).JSONName}}"{{pythonDefault (index .Returns 0)}}) +{{- end}} +{{- end}} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/client.rs.tmpl new file mode 100644 index 000000000..f8b786849 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client.rs.tmpl @@ -0,0 +1,144 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the {{.Service.Name}} host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +{{- if .Service.HasByteFields}}{{template "base64_bytes_module" .}}{{- end}} +{{- /* Generate struct definitions */ -}} +{{- range .Service.Structs}} +{{if .Doc}} +{{rustDocComment .Doc}} +{{else}} +{{end}}#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct {{.Name}} { +{{- range .Fields}} +{{- if .NeedsDefault}} + #[serde(default)] +{{- end}} +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + pub {{.RustName}}: {{fieldRustType .}}, +{{- end}} +} +{{- end}} +{{- /* Generate request/response types */ -}} +{{- range .Service.Methods}} +{{- if .HasParams}} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct {{requestType .}} { +{{- range .Params}} +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + {{.RustName}}: {{rustType .}}, +{{- end}} +} +{{- end}} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct {{responseType .}} { +{{- range .Returns}} + #[serde(default)] +{{- if .IsByteSlice}} + #[serde(with = "base64_bytes")] +{{- end}} + {{.RustName}}: {{rustType .}}, +{{- end}} +{{- if .HasError}} + #[serde(default)] + error: Option, +{{- end}} +} +{{- end}} + +#[host_fn] +extern "ExtismHost" { +{{- range .Service.Methods}} + fn {{exportName .}}(input: Json<{{if .HasParams}}{{requestType .}}{{else}}serde_json::Value{{end}}>) -> Json<{{responseType .}}>; +{{- end}} +} + +{{- /* Generate wrapper functions */ -}} +{{range .Service.Methods}} + +{{if .Doc}}{{rustDocComment .Doc}}{{else}}/// Calls the {{exportName .}} host function.{{end}} +{{- if .HasParams}} +/// +/// # Arguments +{{- range .Params}} +/// * `{{.RustName}}` - {{rustType .}} parameter. +{{- end}} +{{- end}} +{{- if .HasReturns}} +/// +/// # Returns +{{- if .IsOptionPattern}} +/// `Some({{(index .Returns 0).RustName}})` if found, `None` otherwise. +{{- else if eq (len .Returns) 1}} +/// The {{(index .Returns 0).RustName}} value. +{{- else}} +/// A tuple of ({{range $i, $r := .Returns}}{{if $i}}, {{end}}{{$r.RustName}}{{end}}). +{{- end}} +{{- end}} +/// +/// # Errors +/// Returns an error if the host function call fails. +{{- if .IsOptionPattern}} +pub fn {{rustFunc .}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.RustName}}: {{rustParamType $p}}{{end}}) -> Result, Error> { + let response = unsafe { +{{- if .HasParams}} + {{exportName .}}(Json({{requestType .}} { +{{- range .Params}} + {{.RustName}}: {{.RustName}}{{if .NeedsToOwned}}.to_owned(){{end}}, +{{- end}} + }))? +{{- else}} + {{exportName .}}(Json(serde_json::json!({})))? +{{- end}} + }; +{{if .HasError}} + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } +{{end}} + if response.0.{{(index .Returns 1).RustName}} { + Ok(Some(response.0.{{(index .Returns 0).RustName}})) + } else { + Ok(None) + } +} +{{- else}} +pub fn {{rustFunc .}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.RustName}}: {{rustParamType $p}}{{end}}) -> Result<{{if eq (len .Returns) 0}}(){{else if eq (len .Returns) 1}}{{rustType (index .Returns 0)}}{{else}}({{range $i, $r := .Returns}}{{if $i}}, {{end}}{{rustType $r}}{{end}}){{end}}, Error> { + let response = unsafe { +{{- if .HasParams}} + {{exportName .}}(Json({{requestType .}} { +{{- range .Params}} + {{.RustName}}: {{.RustName}}{{if .NeedsToOwned}}.to_owned(){{end}}, +{{- end}} + }))? +{{- else}} + {{exportName .}}(Json(serde_json::json!({})))? +{{- end}} + }; +{{if .HasError}} + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } +{{end}} +{{- if eq (len .Returns) 0}} + Ok(()) +{{- else if eq (len .Returns) 1}} + Ok(response.0.{{(index .Returns 0).RustName}}) +{{- else}} + Ok(({{range $i, $r := .Returns}}{{if $i}}, {{end}}response.0.{{$r.RustName}}{{end}})) +{{- end}} +} +{{- end}} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/client_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/client_stub.go.tmpl new file mode 100644 index 000000000..da19df666 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/client_stub.go.tmpl @@ -0,0 +1,50 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package {{.Package}} + +import "github.com/stretchr/testify/mock" + +{{- /* Generate struct definitions (same as main file, needed for type references in function signatures) */ -}} +{{- range .Service.Structs}} + +// {{.Name}} represents the {{.Name}} data structure. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +type {{.Name}} struct { +{{- range .Fields}} + {{.Name}} {{.Type}} `json:"{{.JSONTag}}"` +{{- end}} +} +{{- end}} + +// mock{{.Service.Name}}Service is the mock implementation for testing. +type mock{{.Service.Name}}Service struct { + mock.Mock +} + +// {{.Service.Name}}Mock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.{{.Service.Name}}Mock.On("MethodName", args...).Return(values...) +var {{.Service.Name}}Mock = &mock{{.Service.Name}}Service{} +{{range .Service.Methods}} + +// {{.Name}} is the mock method for {{$.Service.Name}}{{.Name}}. +func (m *mock{{$.Service.Name}}Service) {{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}} {{$p.Type}}{{end}}) {{.ReturnSignature}} { + args := m.Called({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}}{{end}}) + return {{mockReturnValues .}} +} + +// {{$.Service.Name}}{{.Name}} delegates to the mock instance. +{{- if .Doc}} +{{formatDoc .Doc}} +{{- end}} +func {{$.Service.Name}}{{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}} {{$p.Type}}{{end}}) {{.ReturnSignature}} { + return {{$.Service.Name}}Mock.{{.Name}}({{range $i, $p := .Params}}{{if $i}}, {{end}}{{$p.Name}}{{end}}) +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/doc.go.tmpl b/plugins/cmd/ndpgen/internal/templates/doc.go.tmpl new file mode 100644 index 000000000..e48dc3363 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/doc.go.tmpl @@ -0,0 +1,49 @@ +// Code generated by ndpgen. DO NOT EDIT. + +/* +Package {{.Package}} provides Navidrome Plugin Development Kit wrappers for Go/TinyGo plugins. + +This package is auto-generated by the ndpgen tool and should not be edited manually. + +# Usage + +Add this module as a dependency in your plugin's go.mod: + + require github.com/navidrome/navidrome/plugins/pdk/go/host v0.0.0 + +Then import the package in your plugin code: + + import {{.Package}} "github.com/navidrome/navidrome/plugins/pdk/go/host" + + func myPluginFunction() error { + // Use the cache service + _, err := {{.Package}}.CacheSetString("my_key", "my_value", 3600) + if err != nil { + return err + } + + // Schedule a recurring task + _, err = {{.Package}}.SchedulerScheduleRecurring("@every 5m", "payload", "task_id") + if err != nil { + return err + } + + return nil + } + +# Available Services + +The following host services are available: +{{range .Services}} + - {{.Name}}: {{if .Doc}}{{.Doc | firstLine}}{{else}}{{.Name}} service{{end}} +{{- end}} + +# Building Plugins + +Go plugins must be compiled to WebAssembly using TinyGo: + + tinygo build -o plugin.wasm -target=wasip1 -buildmode=c-shared . + +See the examples directory for complete plugin implementations. +*/ +package {{.Package}} diff --git a/plugins/cmd/ndpgen/internal/templates/go.mod.tmpl b/plugins/cmd/ndpgen/internal/templates/go.mod.tmpl new file mode 100644 index 000000000..3916cd749 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/go.mod.tmpl @@ -0,0 +1,8 @@ +module github.com/navidrome/navidrome/plugins/pdk/go + +go 1.25 + +require ( + github.com/extism/go-pdk v1.1.3 + github.com/stretchr/testify v1.11.1 +) diff --git a/plugins/cmd/ndpgen/internal/templates/host.go.tmpl b/plugins/cmd/ndpgen/internal/templates/host.go.tmpl new file mode 100644 index 000000000..083f7577e --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/host.go.tmpl @@ -0,0 +1,129 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package {{.Package}} + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +{{- /* Generate request/response types for all methods */ -}} +{{range .Service.Methods}} +{{- if .HasParams}} + +// {{requestType .}} is the request type for {{$.Service.Name}}.{{.Name}}. +type {{requestType .}} struct { +{{- range .Params}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}}"` +{{- end}} +} +{{- end}} + +// {{responseType .}} is the response type for {{$.Service.Name}}.{{.Name}}. +type {{responseType .}} struct { +{{- range .Returns}} + {{title .Name}} {{.Type}} `json:"{{.JSONName}},omitempty"` +{{- end}} +{{- if .HasError}} + Error string `json:"error,omitempty"` +{{- end}} +} +{{end}} + +// Register{{.Service.Name}}HostFunctions registers {{.Service.Name}} service host functions. +// The returned host functions should be added to the plugin's configuration. +func Register{{.Service.Name}}HostFunctions(service {{.Service.Interface}}) []extism.HostFunction { + return []extism.HostFunction{ +{{- range .Service.Methods}} + new{{$.Service.Name}}{{.Name}}HostFunction(service), +{{- end}} + } +} +{{range .Service.Methods}} + +func new{{$.Service.Name}}{{.Name}}HostFunction(service {{$.Service.Interface}}) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "{{exportName .}}", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { +{{- if .HasParams}} + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + {{$.Service.Name | lower}}WriteError(p, stack, err) + return + } + var req {{requestType .}} + if err := json.Unmarshal(reqBytes, &req); err != nil { + {{$.Service.Name | lower}}WriteError(p, stack, err) + return + } +{{- end}} + + // Call the service method +{{- if .HasReturns}} +{{- if .HasError}} + {{range $i, $r := .Returns}}{{if $i}}, {{end}}{{lower $r.Name}}{{end}}, svcErr := service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}) + if svcErr != nil { + {{$.Service.Name | lower}}WriteError(p, stack, svcErr) + return + } +{{- else}} + {{range $i, $r := .Returns}}{{if $i}}, {{end}}{{lower $r.Name}}{{end}} := service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}) +{{- end}} + + // Write JSON response to plugin memory + resp := {{responseType .}}{ +{{- range .Returns}} + {{title .Name}}: {{lower .Name}}, +{{- end}} + } + {{$.Service.Name | lower}}WriteResponse(p, stack, resp) +{{- else if .HasError}} + if svcErr := service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}); svcErr != nil { + {{$.Service.Name | lower}}WriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := {{responseType .}}{} + {{$.Service.Name | lower}}WriteResponse(p, stack, resp) +{{- else}} + service.{{.Name}}(ctx{{range .Params}}, req.{{title .Name}}{{end}}) + + // Write JSON response to plugin memory + resp := {{responseType .}}{} + {{$.Service.Name | lower}}WriteResponse(p, stack, resp) +{{- end}} + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} +{{end}} + +// {{.Service.Name | lower}}WriteResponse writes a JSON response to plugin memory. +func {{.Service.Name | lower}}WriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + {{.Service.Name | lower}}WriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// {{.Service.Name | lower}}WriteError writes an error response to plugin memory. +func {{.Service.Name | lower}}WriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/internal/templates/lib.rs.tmpl b/plugins/cmd/ndpgen/internal/templates/lib.rs.tmpl new file mode 100644 index 000000000..3b0434ee2 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/lib.rs.tmpl @@ -0,0 +1,47 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +//! Navidrome Host Function Wrappers for Rust Plugins +//! +//! This crate provides idiomatic Rust wrappers for all Navidrome host services. +//! It is auto-generated by the ndpgen tool and should not be edited manually. +//! +//! # Usage +//! +//! Add this crate as a dependency in your plugin's Cargo.toml: +//! +//! ```toml +//! [dependencies] +//! nd-host = { path = "../../host/rust" } +//! ``` +//! +//! Then import the services you need: +//! +//! ```ignore +//! use nd_host::{cache, scheduler}; +//! +//! fn my_plugin_function() -> Result<(), extism_pdk::Error> { +//! // Use the cache service +//! cache::set_string("my_key", "my_value", 3600)?; +//! +//! // Schedule a recurring task +//! scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; +//! +//! Ok(()) +//! } +//! ``` +//! +//! # Available Services +//! +{{- range .Services}} +//! - [`{{.Name | lower}}`] - {{if .Doc}}{{.Doc | firstLine}}{{else}}{{.Name}} service{{end}} +{{- end}} +{{range .Services}} +#[doc(hidden)] +mod nd_host_{{.Name | lower}}; +/// {{if .Doc}}{{.Doc | firstLine}}{{else}}{{.Name}} host service wrappers.{{end}} +pub mod {{.Name | lower}} { + pub use super::nd_host_{{.Name | lower}}::*; +} +{{end}} +// Re-export commonly used types from extism-pdk for convenience +pub use extism_pdk::Error; diff --git a/plugins/cmd/ndpgen/internal/templates/pdk.go.tmpl b/plugins/cmd/ndpgen/internal/templates/pdk.go.tmpl new file mode 100644 index 000000000..ebaf88df0 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/pdk.go.tmpl @@ -0,0 +1,50 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains wrapper functions for the extism/go-pdk package. +// For WASM builds, it provides type aliases and function wrappers that delegate +// to the real extism/go-pdk package with zero overhead. +// +//go:build wasip1 + +package pdk + +import ( + extism "github.com/extism/go-pdk" +) + +// Type aliases - zero overhead, full compatibility +{{- range .Types}} +type {{.Name}} = extism.{{.Name}} +{{- end}} + +// Constants +{{- $prevType := ""}} +{{- range .Consts}} +{{- if ne .Type $prevType}} +{{- if ne $prevType ""}} +) +{{- end}} + +const ( +{{- end}} + {{.Name}} = extism.{{.Name}} +{{- $prevType = .Type}} +{{- end}} +{{- if ne $prevType ""}} +) +{{- end}} + +// Functions +{{- range .Functions}} + +{{- if .Doc}} +// {{.Name}} {{firstSentence .Doc}} +{{- end}} +func {{.Name}}({{paramList .Params}}){{returnList .Returns}} { +{{- if .Returns}} + return extism.{{.Name}}({{argList .Params}}) +{{- else}} + extism.{{.Name}}({{argList .Params}}) +{{- end}} +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/pdk_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/pdk_stub.go.tmpl new file mode 100644 index 000000000..6a57a6469 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/pdk_stub.go.tmpl @@ -0,0 +1,42 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported PDKMock instance to set expectations in tests. +// +//go:build !wasip1 + +package pdk + +import "github.com/stretchr/testify/mock" + +// mockPDK is the mock implementation for testing PDK functions. +type mockPDK struct { + mock.Mock +} + +// PDKMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: pdk.PDKMock.On("GetConfig", "key").Return("value", true) +var PDKMock = &mockPDK{} + +// ResetMock resets the mock to its initial state. +// Call this in test setup/teardown to ensure clean state between tests. +func ResetMock() { + PDKMock = &mockPDK{} +} + +// Functions +{{- range .Functions}} + +{{- if .Doc}} +// {{.Name}} {{firstSentence .Doc}} +{{- end}} +func {{.Name}}({{paramList .Params}}){{returnList .Returns}} { +{{- if .Returns}} + args := PDKMock.Called({{argList .Params}}) + return {{mockReturns .Returns}} +{{- else}} + PDKMock.Called({{argList .Params}}) +{{- end}} +} +{{- end}} diff --git a/plugins/cmd/ndpgen/internal/templates/types_stub.go.tmpl b/plugins/cmd/ndpgen/internal/templates/types_stub.go.tmpl new file mode 100644 index 000000000..06cbb4f1f --- /dev/null +++ b/plugins/cmd/ndpgen/internal/templates/types_stub.go.tmpl @@ -0,0 +1,192 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains type definitions for non-WASM builds. +// These types match the extism/go-pdk signatures to allow compilation and testing +// on native platforms without importing the WASM-only extism package. +// +//go:build !wasip1 + +package pdk + +// LogLevel represents a logging level. +type LogLevel int + +// Log level constants +const ( + LogTrace LogLevel = iota + LogDebug + LogInfo + LogWarn + LogError +) + +// HTTPMethod represents an HTTP method. +type HTTPMethod int32 + +// HTTP method constants +const ( + MethodGet HTTPMethod = iota + MethodHead + MethodPost + MethodPut + MethodPatch + MethodDelete + MethodConnect + MethodOptions + MethodTrace +) + +// String returns the string representation of the HTTP method. +func (m HTTPMethod) String() string { + switch m { + case MethodGet: + return "GET" + case MethodHead: + return "HEAD" + case MethodPost: + return "POST" + case MethodPut: + return "PUT" + case MethodPatch: + return "PATCH" + case MethodDelete: + return "DELETE" + case MethodConnect: + return "CONNECT" + case MethodOptions: + return "OPTIONS" + case MethodTrace: + return "TRACE" + default: + return "UNKNOWN" + } +} + +// Memory represents memory allocated by (and shared with) the host. +// This is a stub implementation for non-WASM platforms. +type Memory struct { + offset uint64 + length uint64 + data []byte +} + +// Offset returns the offset of the memory block. +func (m Memory) Offset() uint64 { + return m.offset +} + +// Length returns the length of the memory block. +func (m Memory) Length() uint64 { + return m.length +} + +// ReadBytes reads all bytes from the memory block. +func (m Memory) ReadBytes() []byte { + return m.data +} + +// Load reads the memory block into the provided buffer. +func (m *Memory) Load(buffer []byte) { + copy(buffer, m.data) +} + +// Store writes data to the memory block. +func (m *Memory) Store(data []byte) { + m.data = make([]byte, len(data)) + copy(m.data, data) + m.length = uint64(len(data)) +} + +// Free frees the memory block. +func (m *Memory) Free() { + m.data = nil + m.length = 0 +} + +// NewStubMemory creates a new stub Memory for testing. +// This is a helper function not present in the real PDK. +func NewStubMemory(offset, length uint64, data []byte) Memory { + return Memory{ + offset: offset, + length: length, + data: data, + } +} + +// HTTPRequest represents an HTTP request sent by the host. +// This is a stub implementation for non-WASM platforms. +type HTTPRequest struct { + method HTTPMethod + url string + headers map[string]string + body []byte +} + +// SetHeader sets an HTTP header key to value. +func (r *HTTPRequest) SetHeader(key string, value string) *HTTPRequest { + if r.headers == nil { + r.headers = make(map[string]string) + } + r.headers[key] = value + return r +} + +// SetBody sets the HTTP request body. +func (r *HTTPRequest) SetBody(body []byte) *HTTPRequest { + r.body = body + return r +} + +// Send sends the HTTP request and returns the response. +// In the stub implementation, this delegates to the mock. +func (r *HTTPRequest) Send() HTTPResponse { + args := PDKMock.Called(r) + return args.Get(0).(HTTPResponse) +} + +// HTTPRequestMeta represents the metadata associated with an HTTP request. +type HTTPRequestMeta struct { + URL string `json:"url"` + Method string `json:"method"` + Headers map[string]string `json:"headers"` +} + +// HTTPResponse represents an HTTP response returned from the host. +// This is a stub implementation for non-WASM platforms. +type HTTPResponse struct { + status uint16 + headers map[string]string + body []byte + memory Memory +} + +// Status returns the status code from the response. +func (r HTTPResponse) Status() uint16 { + return r.status +} + +// Headers returns the HTTP response headers. +func (r *HTTPResponse) Headers() map[string]string { + return r.headers +} + +// Body returns the body byte slice from the response. +func (r HTTPResponse) Body() []byte { + return r.body +} + +// Memory returns the memory associated with the response. +func (r HTTPResponse) Memory() Memory { + return r.memory +} + +// NewStubHTTPResponse creates a new stub HTTPResponse for testing. +// This is a helper function not present in the real PDK. +func NewStubHTTPResponse(status uint16, headers map[string]string, body []byte) HTTPResponse { + return HTTPResponse{ + status: status, + headers: headers, + body: body, + memory: NewStubMemory(0, uint64(len(body)), body), + } +} diff --git a/plugins/cmd/ndpgen/internal/types.go b/plugins/cmd/ndpgen/internal/types.go new file mode 100644 index 000000000..6132dfbc4 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/types.go @@ -0,0 +1,669 @@ +package internal + +import ( + "strings" + "unicode" +) + +// Service represents a parsed host service interface. +type Service struct { + Name string // Service name from annotation (e.g., "SubsonicAPI") + Permission string // Manifest permission key (e.g., "subsonicapi") + Interface string // Go interface name (e.g., "SubsonicAPIService") + Methods []Method // Methods marked with //nd:hostfunc + Doc string // Documentation comment for the service + Structs []StructDef // Structs used by this service +} + +// Capability represents a parsed capability interface for plugin exports. +type Capability struct { + Name string // Package name from annotation (e.g., "metadata") + Interface string // Go interface name (e.g., "MetadataAgent") + Required bool // If true, all methods must be implemented + Methods []Export // Methods marked with //nd:export + Doc string // Documentation comment for the capability + Structs []StructDef // Structs used by this capability + TypeAliases []TypeAlias // Type aliases used by this capability + Consts []ConstGroup // Const groups used by this capability + SourceFile string // Base name of source file without extension (e.g., "websocket_callback") +} + +// TypeAlias represents a type alias definition (e.g., type ScrobblerErrorType string). +type TypeAlias struct { + Name string // Type name + Type string // Underlying type + Doc string // Documentation comment +} + +// ConstGroup represents a group of const definitions. +type ConstGroup struct { + Type string // Type name for typed consts (empty for untyped) + Values []ConstDef // Const definitions +} + +// ConstDef represents a single const definition. +type ConstDef struct { + Name string // Const name + Value string // Const value + Doc string // Documentation comment +} + +// KnownStructs returns a map of struct names defined in this capability. +func (c Capability) KnownStructs() map[string]bool { + result := make(map[string]bool) + for _, st := range c.Structs { + result[st.Name] = true + } + return result +} + +// Export represents an exported WASM function within a capability. +type Export struct { + Name string // Go method name (e.g., "GetArtistBiography") + ExportName string // WASM export name (e.g., "nd_get_artist_biography") + Input Param // Single input parameter (the struct type) + Output Param // Single output return value (the struct type) + Doc string // Documentation comment for the method +} + +// ProviderInterfaceName returns the optional provider interface name. +// For a method "GetArtistBiography", returns "ArtistBiographyProvider". +func (e Export) ProviderInterfaceName() string { + // Remove "Get", "On", etc. prefixes and add "Provider" suffix + name := e.Name + for _, prefix := range []string{"Get", "On"} { + if strings.HasPrefix(name, prefix) { + name = name[len(prefix):] + break + } + } + return name + "Provider" +} + +// ImplVarName returns the internal implementation variable name. +// For "GetArtistBiography", returns "artistBiographyImpl". +func (e Export) ImplVarName() string { + name := e.Name + for _, prefix := range []string{"Get", "On"} { + if strings.HasPrefix(name, prefix) { + name = name[len(prefix):] + break + } + } + // Convert to camelCase + if len(name) > 0 { + name = strings.ToLower(string(name[0])) + name[1:] + } + return name + "Impl" +} + +// ExportFuncName returns the unexported WASM export function name. +// For "nd_get_artist_biography", returns "_ndGetArtistBiography". +func (e Export) ExportFuncName() string { + // Convert snake_case to PascalCase + parts := strings.Split(e.ExportName, "_") + var result strings.Builder + result.WriteString("_") + for _, part := range parts { + if len(part) > 0 { + result.WriteString(strings.ToUpper(string(part[0]))) + result.WriteString(part[1:]) + } + } + return result.String() +} + +// HasInput returns true if the method has an input parameter. +func (e Export) HasInput() bool { + return e.Input.Type != "" +} + +// HasOutput returns true if the method has a non-error return value. +func (e Export) HasOutput() bool { + return e.Output.Type != "" +} + +// IsPointerOutput returns true if the output type is a pointer. +func (e Export) IsPointerOutput() bool { + return strings.HasPrefix(e.Output.Type, "*") +} + +// StructDef represents a Go struct type definition. +type StructDef struct { + Name string // Go struct name (e.g., "Library") + Fields []FieldDef // Struct fields + Doc string // Documentation comment +} + +// FieldDef represents a field within a struct. +type FieldDef struct { + Name string // Go field name (e.g., "TotalSongs") + Type string // Go type (e.g., "int32", "*string", "[]User") + JSONTag string // JSON tag value (e.g., "totalSongs,omitempty") + OmitEmpty bool // Whether the field has omitempty tag + Doc string // Field documentation +} + +// OutputFileName returns the generated file name for this service. +func (s Service) OutputFileName() string { + return strings.ToLower(s.Name) + "_gen.go" +} + +// ExportPrefix returns the prefix for exported host function names. +func (s Service) ExportPrefix() string { + return strings.ToLower(s.Name) +} + +// KnownStructs returns a map of struct names defined in this service. +func (s Service) KnownStructs() map[string]bool { + result := make(map[string]bool) + for _, st := range s.Structs { + result[st.Name] = true + } + return result +} + +// HasErrors returns true if any method in the service returns an error. +func (s Service) HasErrors() bool { + for _, m := range s.Methods { + if m.HasError { + return true + } + } + return false +} + +// Method represents a host function method within a service. +type Method struct { + Name string // Go method name (e.g., "Call") + ExportName string // Optional override for export name + Params []Param // Method parameters (excluding context.Context) + Returns []Param // Return values (excluding error) + HasError bool // Whether the method returns an error + Doc string // Documentation comment for the method +} + +// FunctionName returns the Extism host function export name. +func (m Method) FunctionName(servicePrefix string) string { + if m.ExportName != "" { + return m.ExportName + } + return servicePrefix + "_" + strings.ToLower(m.Name) +} + +// RequestTypeName returns the generated request type name (public, for host-side code). +func (m Method) RequestTypeName(serviceName string) string { + return serviceName + m.Name + "Request" +} + +// ResponseTypeName returns the generated response type name (public, for host-side code). +func (m Method) ResponseTypeName(serviceName string) string { + return serviceName + m.Name + "Response" +} + +// ClientRequestTypeName returns the generated request type name (private, for client/PDK code). +func (m Method) ClientRequestTypeName(serviceName string) string { + return lowerFirst(serviceName) + m.Name + "Request" +} + +// ClientResponseTypeName returns the generated response type name (private, for client/PDK code). +func (m Method) ClientResponseTypeName(serviceName string) string { + return lowerFirst(serviceName) + m.Name + "Response" +} + +// lowerFirst returns the string with the first letter lowercased. +func lowerFirst(s string) string { + if s == "" { + return s + } + r := []rune(s) + r[0] = unicode.ToLower(r[0]) + return string(r) +} + +// HasParams returns true if the method has input parameters. +func (m Method) HasParams() bool { + return len(m.Params) > 0 +} + +// HasReturns returns true if the method has return values (excluding error). +func (m Method) HasReturns() bool { + return len(m.Returns) > 0 +} + +// IsErrorOnly returns true if the method only returns an error (no data fields). +func (m Method) IsErrorOnly() bool { + return m.HasError && !m.HasReturns() +} + +// IsSingleReturn returns true if the method has exactly one return value (excluding error). +func (m Method) IsSingleReturn() bool { + return len(m.Returns) == 1 +} + +// IsMultiReturn returns true if the method has multiple return values (excluding error). +func (m Method) IsMultiReturn() bool { + return len(m.Returns) > 1 +} + +// IsOptionPattern returns true if the method returns (value, bool) where the bool +// indicates existence (named "exists", "ok", or "found"). This pattern is used to +// generate Option in Rust instead of a tuple. +func (m Method) IsOptionPattern() bool { + if len(m.Returns) != 2 { + return false + } + if m.Returns[1].Type != "bool" { + return false + } + // Only treat as option pattern if the first return has a meaningful value type + // (not just a bool check like Has()) + if m.Returns[0].Type == "bool" { + return false + } + name := strings.ToLower(m.Returns[1].Name) + return name == "exists" || name == "ok" || name == "found" +} + +// ReturnSignature returns the Go return type signature for the wrapper function. +// For error-only: "error" +// For single return with error: "(Type, error)" +// For single return no error: "Type" +// For multi return: "(Type1, Type2, ..., error)" +func (m Method) ReturnSignature() string { + if m.IsErrorOnly() { + return "error" + } + var parts []string + for _, r := range m.Returns { + parts = append(parts, r.Type) + } + if m.HasError { + parts = append(parts, "error") + } + // Single return without error doesn't need parentheses + if len(parts) == 1 { + return parts[0] + } + return "(" + strings.Join(parts, ", ") + ")" +} + +// ZeroValues returns the zero value expressions for all return types (excluding error). +// Used for error return statements like "return "", false, err". +func (m Method) ZeroValues() string { + var zeros []string + for _, r := range m.Returns { + zeros = append(zeros, zeroValue(r.Type)) + } + return strings.Join(zeros, ", ") +} + +// zeroValue returns the zero value for a Go type. +func zeroValue(typ string) string { + switch { + case typ == "string": + return `""` + case typ == "bool": + return "false" + case typ == "int", typ == "int8", typ == "int16", typ == "int32", typ == "int64", + typ == "uint", typ == "uint8", typ == "uint16", typ == "uint32", typ == "uint64", + typ == "float32", typ == "float64": + return "0" + case typ == "[]byte": + return "nil" + case strings.HasPrefix(typ, "[]"): + return "nil" + case strings.HasPrefix(typ, "map["): + return "nil" + case strings.HasPrefix(typ, "*"): + return "nil" + case typ == "any", typ == "interface{}": + return "nil" + default: + // For custom struct types, return empty struct + return typ + "{}" + } +} + +// Param represents a method parameter or return value. +type Param struct { + Name string // Parameter name + Type string // Go type (e.g., "string", "int32", "[]byte") + JSONName string // JSON field name (camelCase) +} + +// IsByteSlice returns true if the parameter type is []byte. +func (p Param) IsByteSlice() bool { + return p.Type == "[]byte" +} + +// IsByteSlice returns true if the field type is []byte. +func (f FieldDef) IsByteSlice() bool { + return f.Type == "[]byte" +} + +// HasByteFields returns true if any method params, returns, or struct fields use []byte. +func (s Service) HasByteFields() bool { + for _, m := range s.Methods { + for _, p := range m.Params { + if p.IsByteSlice() { + return true + } + } + for _, r := range m.Returns { + if r.IsByteSlice() { + return true + } + } + } + for _, st := range s.Structs { + for _, f := range st.Fields { + if f.IsByteSlice() { + return true + } + } + } + return false +} + +// HasByteFields returns true if any capability struct fields use []byte. +func (c Capability) HasByteFields() bool { + for _, st := range c.Structs { + for _, f := range st.Fields { + if f.IsByteSlice() { + return true + } + } + } + return false +} + +// NewParam creates a Param with auto-generated JSON name. +func NewParam(name, typ string) Param { + return Param{ + Name: name, + Type: typ, + JSONName: toJSONName(name), + } +} + +// toJSONName converts a Go identifier to camelCase JSON field name. +// This matches Rust serde's rename_all = "camelCase" behavior. +// Examples: "ConnectionID" -> "connectionId", "NewConnectionID" -> "newConnectionId" +func toJSONName(name string) string { + if name == "" { + return "" + } + + runes := []rune(name) + result := make([]rune, 0, len(runes)) + + for i, r := range runes { + if i == 0 { + // First character is always lowercase + result = append(result, unicode.ToLower(r)) + } else if unicode.IsUpper(r) { + // Check if this is part of an acronym (consecutive uppercase) + // or a word boundary + prevIsUpper := unicode.IsUpper(runes[i-1]) + nextIsLower := i+1 < len(runes) && unicode.IsLower(runes[i+1]) + + if prevIsUpper && !nextIsLower { + // Middle of an acronym - lowercase it + result = append(result, unicode.ToLower(r)) + } else if prevIsUpper && nextIsLower { + // End of acronym followed by lowercase - this starts a new word + // Keep uppercase + result = append(result, r) + } else { + // Regular word boundary - keep uppercase + result = append(result, r) + } + } else { + result = append(result, r) + } + } + + return string(result) +} + +// ToPythonType converts a Go type to its Python equivalent. +func ToPythonType(goType string) string { + switch goType { + case "string": + return "str" + case "int", "int32", "int64": + return "int" + case "float32", "float64": + return "float" + case "bool": + return "bool" + case "[]byte": + return "bytes" + default: + return "Any" + } +} + +// ToSnakeCase converts a PascalCase or camelCase string to snake_case. +// It handles consecutive uppercase letters correctly (e.g., "ScheduleID" -> "schedule_id"). +func ToSnakeCase(s string) string { + var result strings.Builder + runes := []rune(s) + for i, r := range runes { + if i > 0 && r >= 'A' && r <= 'Z' { + // Add underscore before uppercase, but not if: + // - Previous char was uppercase AND next char is uppercase or end of string + // (this handles acronyms like "ID" in "NewScheduleID") + prevUpper := runes[i-1] >= 'A' && runes[i-1] <= 'Z' + nextUpper := i+1 < len(runes) && runes[i+1] >= 'A' && runes[i+1] <= 'Z' + atEnd := i+1 == len(runes) + + // Only skip underscore if we're in the middle of an acronym + if !prevUpper || (!nextUpper && !atEnd) { + result.WriteByte('_') + } + } + result.WriteRune(r) + } + return strings.ToLower(result.String()) +} + +// PythonFunctionName returns the Python function name for a method. +func (m Method) PythonFunctionName(servicePrefix string) string { + return ToSnakeCase(servicePrefix + m.Name) +} + +// PythonResultTypeName returns the Python dataclass name for multi-value returns. +func (m Method) PythonResultTypeName(serviceName string) string { + return serviceName + m.Name + "Result" +} + +// NeedsResultClass returns true if the method needs a dataclass for returns. +func (m Method) NeedsResultClass() bool { + return len(m.Returns) > 1 +} + +// PythonType returns the Python type for this parameter. +func (p Param) PythonType() string { + return ToPythonType(p.Type) +} + +// PythonName returns the snake_case Python name for this parameter. +func (p Param) PythonName() string { + return ToSnakeCase(p.Name) +} + +// ToRustType converts a Go type to its Rust equivalent. +func ToRustType(goType string) string { + return ToRustTypeWithStructs(goType, nil) +} + +// RustParamType returns the Rust type for a function parameter (uses &str for strings). +func RustParamType(goType string) string { + if goType == "string" { + return "&str" + } + return ToRustType(goType) +} + +// RustDefaultValue returns the default value for a Rust type. +func RustDefaultValue(goType string) string { + switch goType { + case "string": + return `String::new()` + case "int", "int32", "int64", "uint", "uint32", "uint64": + return "0" + case "float32", "float64": + return "0.0" + case "bool": + return "false" + default: + if strings.HasPrefix(goType, "[]") { + return "Vec::new()" + } + if strings.HasPrefix(goType, "map[") { + return "std::collections::HashMap::new()" + } + if strings.HasPrefix(goType, "*") { + return "None" + } + return "serde_json::Value::Null" + } +} + +// RustFunctionName returns the Rust function name for a method (snake_case). +// Uses just the method name without service prefix since the module provides namespacing. +func (m Method) RustFunctionName(_ string) string { + return ToSnakeCase(m.Name) +} + +// RustDocComment returns a properly formatted Rust doc comment. +// Each line of the input doc string is prefixed with "/// ". +func RustDocComment(doc string) string { + if doc == "" { + return "" + } + lines := strings.Split(doc, "\n") + var result []string + for _, line := range lines { + result = append(result, "/// "+line) + } + return strings.Join(result, "\n") +} + +// RustType returns the Rust type for this parameter. +func (p Param) RustType() string { + return ToRustType(p.Type) +} + +// RustTypeWithStructs returns the Rust type using known struct names. +func (p Param) RustTypeWithStructs(knownStructs map[string]bool) string { + return ToRustTypeWithStructs(p.Type, knownStructs) +} + +// RustParamType returns the Rust type for this parameter when used as a function argument. +func (p Param) RustParamType() string { + return RustParamType(p.Type) +} + +// RustParamTypeWithStructs returns the Rust param type using known struct names. +func (p Param) RustParamTypeWithStructs(knownStructs map[string]bool) string { + if p.Type == "string" { + return "&str" + } + return ToRustTypeWithStructs(p.Type, knownStructs) +} + +// RustName returns the snake_case Rust name for this parameter. +func (p Param) RustName() string { + return ToSnakeCase(p.Name) +} + +// NeedsToOwned returns true if the parameter needs .to_owned() when used. +func (p Param) NeedsToOwned() bool { + return p.Type == "string" +} + +// RustType returns the Rust type for this field, using known struct names. +func (f FieldDef) RustType(knownStructs map[string]bool) string { + return ToRustTypeWithStructs(f.Type, knownStructs) +} + +// RustName returns the snake_case Rust name for this field. +func (f FieldDef) RustName() string { + return ToSnakeCase(f.Name) +} + +// NeedsDefault returns true if the field needs #[serde(default)] attribute. +// This is true for fields with omitempty tag. +func (f FieldDef) NeedsDefault() bool { + return f.OmitEmpty +} + +// ToRustTypeWithStructs converts a Go type to its Rust equivalent, +// using known struct names instead of serde_json::Value. +func ToRustTypeWithStructs(goType string, knownStructs map[string]bool) string { + // Handle pointer types + if strings.HasPrefix(goType, "*") { + inner := ToRustTypeWithStructs(goType[1:], knownStructs) + return "Option<" + inner + ">" + } + // Handle slice types + if strings.HasPrefix(goType, "[]") { + if goType == "[]byte" { + return "Vec" + } + inner := ToRustTypeWithStructs(goType[2:], knownStructs) + return "Vec<" + inner + ">" + } + // Handle map types + if strings.HasPrefix(goType, "map[") { + // Extract key and value types from map[K]V + rest := goType[4:] // Remove "map[" + depth := 1 + keyEnd := 0 + for i, r := range rest { + if r == '[' { + depth++ + } else if r == ']' { + depth-- + if depth == 0 { + keyEnd = i + break + } + } + } + keyType := rest[:keyEnd] + valueType := rest[keyEnd+1:] + return "std::collections::HashMap<" + ToRustTypeWithStructs(keyType, knownStructs) + ", " + ToRustTypeWithStructs(valueType, knownStructs) + ">" + } + + switch goType { + case "string": + return "String" + case "int", "int32": + return "i32" + case "int64": + return "i64" + case "uint", "uint32": + return "u32" + case "uint64": + return "u64" + case "float32": + return "f32" + case "float64": + return "f64" + case "bool": + return "bool" + case "interface{}", "any": + return "serde_json::Value" + default: + // Check if this is a known struct type + if knownStructs != nil && knownStructs[goType] { + return goType + } + // For unknown custom types, fall back to Value + return "serde_json::Value" + } +} diff --git a/plugins/cmd/ndpgen/internal/xtp_schema.go b/plugins/cmd/ndpgen/internal/xtp_schema.go new file mode 100644 index 000000000..cc2a7d0e0 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema.go @@ -0,0 +1,339 @@ +package internal + +import ( + "sort" + "strings" + + "gopkg.in/yaml.v3" +) + +// XTP Schema types for YAML marshalling +type ( + xtpSchema struct { + Version string `yaml:"version"` + Exports yaml.Node `yaml:"exports,omitempty"` + Components *xtpComponents `yaml:"components,omitempty"` + } + + xtpComponents struct { + Schemas yaml.Node `yaml:"schemas"` + } + + xtpExport struct { + Description string `yaml:"description,omitempty"` + Input *xtpIOParam `yaml:"input,omitempty"` + Output *xtpIOParam `yaml:"output,omitempty"` + } + + xtpIOParam struct { + Ref string `yaml:"$ref,omitempty"` + Type string `yaml:"type,omitempty"` + ContentType string `yaml:"contentType"` + } + + // xtpObjectSchema represents an object schema in XTP. + // Per the XTP JSON Schema, ObjectSchema has properties, required, and description + // but NOT a type field. + xtpObjectSchema struct { + Description string `yaml:"description,omitempty"` + Properties yaml.Node `yaml:"properties"` + Required []string `yaml:"required,omitempty"` + } + + xtpEnumSchema struct { + Description string `yaml:"description,omitempty"` + Type string `yaml:"type"` + Enum []string `yaml:"enum"` + } + + xtpProperty struct { + Ref string `yaml:"$ref,omitempty"` + Type string `yaml:"type,omitempty"` + Format string `yaml:"format,omitempty"` + Description string `yaml:"description,omitempty"` + Nullable bool `yaml:"nullable,omitempty"` + Items *xtpProperty `yaml:"items,omitempty"` + } +) + +// GenerateSchema generates an XTP YAML schema from a capability. +func GenerateSchema(cap Capability) ([]byte, error) { + schema := xtpSchema{Version: "v1-draft"} + + // Build exports as ordered map + if len(cap.Methods) > 0 { + schema.Exports = yaml.Node{Kind: yaml.MappingNode} + for _, export := range cap.Methods { + addToMap(&schema.Exports, export.ExportName, buildExport(export)) + } + } + + // Build components/schemas + schemas := buildSchemas(cap) + if len(schemas.Content) > 0 { + schema.Components = &xtpComponents{Schemas: schemas} + } + + return yaml.Marshal(schema) +} + +func buildExport(export Export) xtpExport { + e := xtpExport{Description: cleanDocForYAML(export.Doc)} + if export.Input.Type != "" { + e.Input = &xtpIOParam{ + Ref: "#/components/schemas/" + strings.TrimPrefix(export.Input.Type, "*"), + ContentType: "application/json", + } + } + if export.Output.Type != "" { + outputType := strings.TrimPrefix(export.Output.Type, "*") + // Check if output is a primitive type + if isPrimitiveGoType(outputType) { + e.Output = &xtpIOParam{ + Type: goTypeToXTPType(outputType), + ContentType: "application/json", + } + } else { + e.Output = &xtpIOParam{ + Ref: "#/components/schemas/" + outputType, + ContentType: "application/json", + } + } + } + return e +} + +// isPrimitiveGoType returns true if the Go type is a primitive type. +func isPrimitiveGoType(goType string) bool { + switch goType { + case "bool", "string", "int", "int32", "int64", "uint", "uint32", "uint64", "float32", "float64", "[]byte": + return true + } + return false +} + +func buildSchemas(cap Capability) yaml.Node { + schemas := yaml.Node{Kind: yaml.MappingNode} + knownTypes := cap.KnownStructs() + for _, alias := range cap.TypeAliases { + knownTypes[alias.Name] = true + } + + // Collect types that are actually used by exports + usedTypes := collectUsedTypes(cap, knownTypes) + + // Sort structs by name for consistent output + structNames := make([]string, 0, len(cap.Structs)) + structMap := make(map[string]StructDef) + for _, st := range cap.Structs { + if usedTypes[st.Name] { + structNames = append(structNames, st.Name) + structMap[st.Name] = st + } + } + sort.Strings(structNames) + + for _, name := range structNames { + st := structMap[name] + addToMap(&schemas, name, buildObjectSchema(st, knownTypes)) + } + + // Build enum types from type aliases (only if used by exports) + for _, alias := range cap.TypeAliases { + if !usedTypes[alias.Name] { + continue + } + if alias.Type == "string" { + for _, cg := range cap.Consts { + if cg.Type == alias.Name { + addToMap(&schemas, alias.Name, buildEnumSchema(alias, cg)) + break + } + } + } + } + + return schemas +} + +// collectUsedTypes returns a set of type names that are reachable from exports. +func collectUsedTypes(cap Capability, knownTypes map[string]bool) map[string]bool { + used := make(map[string]bool) + + // Start with types directly referenced by exports + for _, export := range cap.Methods { + if export.Input.Type != "" { + addTypeAndDeps(strings.TrimPrefix(export.Input.Type, "*"), cap, knownTypes, used) + } + if export.Output.Type != "" { + outputType := strings.TrimPrefix(export.Output.Type, "*") + if !isPrimitiveGoType(outputType) { + addTypeAndDeps(outputType, cap, knownTypes, used) + } + } + } + + return used +} + +// addTypeAndDeps adds a type and all its dependencies to the used set. +func addTypeAndDeps(typeName string, cap Capability, knownTypes map[string]bool, used map[string]bool) { + if used[typeName] || !knownTypes[typeName] { + return + } + used[typeName] = true + + // Find the struct and add its field types + for _, st := range cap.Structs { + if st.Name == typeName { + for _, field := range st.Fields { + fieldType := strings.TrimPrefix(field.Type, "*") + fieldType = strings.TrimPrefix(fieldType, "[]") + if knownTypes[fieldType] { + addTypeAndDeps(fieldType, cap, knownTypes, used) + } + } + return + } + } +} + +func buildObjectSchema(st StructDef, knownTypes map[string]bool) xtpObjectSchema { + schema := xtpObjectSchema{ + Description: cleanDocForYAML(st.Doc), + Properties: yaml.Node{Kind: yaml.MappingNode}, + } + + for _, field := range st.Fields { + propName := getJSONFieldName(field) + addToMap(&schema.Properties, propName, buildProperty(field, knownTypes)) + + if !strings.HasPrefix(field.Type, "*") && !field.OmitEmpty { + schema.Required = append(schema.Required, propName) + } + } + + return schema +} + +func buildEnumSchema(alias TypeAlias, cg ConstGroup) xtpEnumSchema { + values := make([]string, 0, len(cg.Values)) + for _, cv := range cg.Values { + values = append(values, strings.Trim(cv.Value, `"`)) + } + return xtpEnumSchema{ + Description: cleanDocForYAML(alias.Doc), + Type: "string", + Enum: values, + } +} + +func buildProperty(field FieldDef, knownTypes map[string]bool) xtpProperty { + goType := field.Type + isPointer := strings.HasPrefix(goType, "*") + if isPointer { + goType = goType[1:] + } + + prop := xtpProperty{ + Description: cleanDocForYAML(field.Doc), + Nullable: isPointer, + } + + // Handle reference types (use $ref instead of type) + if isKnownType(goType, knownTypes) && !strings.HasPrefix(goType, "[]") { + prop.Ref = "#/components/schemas/" + goType + return prop + } + + // Handle primitive types (including []byte which maps to string/byte, not array) + if isPrimitiveGoType(goType) { + prop.Type, prop.Format = goTypeToXTPTypeAndFormat(goType) + return prop + } + + // Handle slice types + if strings.HasPrefix(goType, "[]") { + elemType := goType[2:] + prop.Type = "array" + prop.Items = &xtpProperty{} + if isKnownType(elemType, knownTypes) { + prop.Items.Ref = "#/components/schemas/" + elemType + } else { + prop.Items.Type = goTypeToXTPType(elemType) + } + return prop + } + + // Handle remaining types + prop.Type, prop.Format = goTypeToXTPTypeAndFormat(goType) + return prop +} + +// addToMap adds a key-value pair to a yaml.Node map, preserving insertion order. +func addToMap[T any](node *yaml.Node, key string, value T) { + var valNode yaml.Node + _ = valNode.Encode(value) + node.Content = append(node.Content, &yaml.Node{Kind: yaml.ScalarNode, Value: key}, &valNode) +} + +func getJSONFieldName(field FieldDef) string { + propName := field.JSONTag + if idx := strings.Index(propName, ","); idx >= 0 { + propName = propName[:idx] + } + if propName == "" { + propName = field.Name + } + return propName +} + +// isKnownType checks if a type is a known struct or type alias. +func isKnownType(typeName string, knownTypes map[string]bool) bool { + return knownTypes[typeName] +} + +// goTypeToXTPType converts a Go type to an XTP schema type. +func goTypeToXTPType(goType string) string { + typ, _ := goTypeToXTPTypeAndFormat(goType) + return typ +} + +// goTypeToXTPTypeAndFormat converts a Go type to XTP type and format. +func goTypeToXTPTypeAndFormat(goType string) (typ, format string) { + switch goType { + case "string": + return "string", "" + case "int", "int32": + return "integer", "int32" + case "int64": + return "integer", "int64" + case "uint", "uint32": + // XTP schema doesn't support unsigned formats; use int64 to hold full uint32 range + return "integer", "int64" + case "uint64": + // XTP schema doesn't support unsigned formats; use int64 (may lose precision for large values) + return "integer", "int64" + case "float32": + return "number", "float" + case "float64": + return "number", "float" + case "bool": + return "boolean", "" + case "[]byte": + return "string", "byte" + default: + return "object", "" + } +} + +// cleanDocForYAML cleans documentation for YAML output. +func cleanDocForYAML(doc string) string { + doc = strings.TrimSpace(doc) + // Remove leading "// " from each line if present + lines := strings.Split(doc, "\n") + for i, line := range lines { + lines[i] = strings.TrimPrefix(strings.TrimSpace(line), "// ") + } + return strings.TrimSpace(strings.Join(lines, "\n")) +} diff --git a/plugins/cmd/ndpgen/internal/xtp_schema.json b/plugins/cmd/ndpgen/internal/xtp_schema.json new file mode 100644 index 000000000..8b3fbe0b9 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema.json @@ -0,0 +1,549 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "version": { + "$ref": "#/$defs/XtpVersion" + } + }, + "required": [ + "version" + ], + "allOf": [ + { + "if": { + "properties": { + "version": { + "const": "v0" + } + } + }, + "then": { + "properties": { + "exports": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[a-zA-Z_$][a-zA-Z0-9_$]*$" + } + }, + "version": { + "const": "v0" + } + }, + "required": [ + "exports" + ], + "additionalProperties": false + } + }, + { + "if": { + "properties": { + "version": { + "const": "v1-draft" + } + } + }, + "then": { + "properties": { + "version": { + "$ref": "#/$defs/XtpVersion" + }, + "exports": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Export" + } + }, + "additionalProperties": false + }, + "imports": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Import" + } + }, + "additionalProperties": false + }, + "components": { + "type": "object", + "properties": { + "schemas": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Schema" + } + }, + "additionalProperties": false + } + }, + "required": [ + "schemas" + ], + "additionalProperties": false + } + }, + "required": [ + "exports" + ], + "additionalProperties": false + } + } + ], + "$defs": { + "XtpVersion": { + "type": "string", + "enum": [ + "v0", + "v1-draft" + ] + }, + "Export": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "codeSamples": { + "type": "array", + "items": { + "$ref": "#/$defs/CodeSample" + } + }, + "input": { + "$ref": "#/$defs/Parameter" + }, + "output": { + "$ref": "#/$defs/Parameter" + } + }, + "additionalProperties": false + }, + "CodeSample": { + "type": "object", + "properties": { + "lang": { + "anyOf": [ + { + "type": "string", + "enum": [ + "typescript", + "csharp", + "zig", + "rust", + "go", + "python", + "c++" + ] + }, + { + "type": "string" + } + ] + }, + "source": { + "type": "string" + }, + "label": { + "type": "string" + } + }, + "required": [ + "lang", + "source" + ], + "additionalProperties": false + }, + "Import": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "input": { + "$ref": "#/$defs/Parameter" + }, + "output": { + "$ref": "#/$defs/Parameter" + } + }, + "additionalProperties": false + }, + "Schema": { + "oneOf": [ + { + "$ref": "#/$defs/ObjectSchema" + }, + { + "$ref": "#/$defs/EnumSchema" + } + ] + }, + "ObjectSchema": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "properties": { + "type": "object", + "patternProperties": { + "^[a-zA-Z_$][a-zA-Z0-9_$]*$": { + "$ref": "#/$defs/Property" + } + }, + "additionalProperties": false + }, + "required": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "properties" + ], + "additionalProperties": false + }, + "EnumSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "string" + ] + }, + "description": { + "type": "string" + }, + "enum": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[a-zA-Z_$][a-zA-Z0-9_$]*$" + } + } + }, + "required": [ + "enum" + ], + "additionalProperties": false + }, + "Parameter": { + "oneOf": [ + { + "$ref": "#/$defs/ValueParameter" + }, + { + "$ref": "#/$defs/RefParameter" + }, + { + "$ref": "#/$defs/MapParameter" + } + ] + }, + "RefParameter": { + "type": "object", + "properties": { + "$ref": { + "$ref": "#/$defs/SchemaReference" + }, + "description": { + "type": "string" + }, + "nullable": { + "type": "boolean", + "default": false + }, + "contentType": { + "$ref": "#/$defs/ContentType" + } + }, + "required": [ + "$ref", + "contentType" + ], + "additionalProperties": false + }, + "ValueParameter": { + "type": "object", + "properties": { + "contentType": { + "$ref": "#/$defs/ContentType" + }, + "type": { + "$ref": "#/$defs/XtpType" + }, + "format": { + "$ref": "#/$defs/XtpFormat" + }, + "nullable": { + "type": "boolean", + "default": false + }, + "description": { + "type": "string" + }, + "items": { + "type": "object", + "$ref": "#/$defs/ArrayItem" + } + }, + "required": [ + "type", + "contentType" + ], + "additionalProperties": false + }, + "MapParameter": { + "type": "object", + "properties": { + "type": { + "const": "object" + }, + "description": { + "type": "string" + }, + "additionalProperties": { + "allOf": [ + { + "$ref": "#/$defs/NonMapProperty" + }, + { + "type": "object", + "properties": { + "description": false + }, + "additionalProperties": false + } + ] + }, + "nullable": { + "type": "boolean", + "default": false + }, + "contentType": { + "$ref": "#/$defs/ContentType" + } + }, + "required": [ + "additionalProperties", + "contentType" + ] + }, + "NonMapProperty": { + "oneOf": [ + { + "$ref": "#/$defs/ValueProperty" + }, + { + "$ref": "#/$defs/RefProperty" + } + ] + }, + "Property": { + "oneOf": [ + { + "$ref": "#/$defs/ValueProperty" + }, + { + "$ref": "#/$defs/RefProperty" + }, + { + "$ref": "#/$defs/MapProperty" + } + ] + }, + "ValueProperty": { + "type": "object", + "properties": { + "type": { + "$ref": "#/$defs/XtpType" + }, + "format": { + "$ref": "#/$defs/XtpFormat" + }, + "nullable": { + "type": "boolean", + "default": false + }, + "description": { + "type": "string" + }, + "items": { + "type": "object", + "$ref": "#/$defs/ArrayItem" + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + "MapProperty": { + "type": "object", + "properties": { + "type": { + "const": "object" + }, + "description": { + "type": "string" + }, + "additionalProperties": { + "allOf": [ + { + "$ref": "#/$defs/NonMapProperty" + }, + { + "not": { + "type": "object", + "required": ["description"] + } + } + ] + }, + "nullable": { + "type": "boolean", + "default": false + } + }, + "required": [ + "additionalProperties" + ], + "additionalProperties": false + }, + "RefProperty": { + "type": "object", + "properties": { + "$ref": { + "$ref": "#/$defs/SchemaReference" + }, + "description": { + "type": "string" + }, + "nullable": { + "type": "boolean", + "default": false + } + }, + "required": [ + "$ref" + ], + "additionalProperties": false + }, + "ContentType": { + "type": "string", + "enum": [ + "application/json", + "application/x-binary", + "text/plain; charset=utf-8" + ] + }, + "SchemaReference": { + "type": "string", + "pattern": "^#/components/schemas/[^/]+$" + }, + "XtpType": { + "type": "string", + "enum": [ + "integer", + "string", + "number", + "boolean", + "object", + "array", + "buffer" + ] + }, + "XtpFormat": { + "type": "string", + "enum": [ + "int32", + "int64", + "float", + "double", + "date-time", + "byte" + ] + }, + "ArrayItem": { + "type": "object", + "oneOf": [ + { + "$ref": "#/$defs/ValueArrayItem" + }, + { + "$ref": "#/$defs/RefArrayItem" + }, + { + "$ref": "#/$defs/MapArrayItem" + } + ] + }, + "ValueArrayItem": { + "type": "object", + "properties": { + "type": { + "$ref": "#/$defs/XtpType" + }, + "format": { + "$ref": "#/$defs/XtpFormat" + }, + "nullable": { + "type": "boolean" + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + "RefArrayItem": { + "type": "object", + "properties": { + "$ref": { + "$ref": "#/$defs/SchemaReference" + }, + "nullable": { + "type": "boolean", + "default": false + } + }, + "required": [ + "$ref" + ], + "additionalProperties": false + }, + "MapArrayItem": { + "type": "object", + "properties": { + "type": { + "const": "object" + }, + "additionalProperties": { + "allOf": [ + { + "$ref": "#/$defs/NonMapProperty" + }, + { + "not": { + "type": "object", + "required": ["description"] + } + } + ] + } + }, + "required": [ + "additionalProperties" + ], + "additionalProperties": false + } + } +} diff --git a/plugins/cmd/ndpgen/internal/xtp_schema_test.go b/plugins/cmd/ndpgen/internal/xtp_schema_test.go new file mode 100644 index 000000000..2e28a75d8 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema_test.go @@ -0,0 +1,761 @@ +package internal + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "gopkg.in/yaml.v3" +) + +var _ = Describe("XTP Schema Generation", func() { + parseSchema := func(schema []byte) map[string]any { + var doc map[string]any + Expect(yaml.Unmarshal(schema, &doc)).To(Succeed()) + return doc + } + + Describe("GenerateSchema", func() { + Context("basic capability with one export", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "test", + Doc: "Test capability", + SourceFile: "test", + Methods: []Export{ + { + ExportName: "test_method", + Doc: "Test method does something", + Input: NewParam("input", "TestInput"), + Output: NewParam("output", "TestOutput"), + }, + }, + Structs: []StructDef{ + { + Name: "TestInput", + Doc: "Input for test", + Fields: []FieldDef{ + {Name: "Name", Type: "string", JSONTag: "name", Doc: "The name"}, + {Name: "Count", Type: "int", JSONTag: "count", Doc: "The count"}, + }, + }, + { + Name: "TestOutput", + Doc: "Output for test", + Fields: []FieldDef{ + {Name: "Result", Type: "string", JSONTag: "result", Doc: "The result"}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(schema).NotTo(BeEmpty()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should have correct version", func() { + doc := parseSchema(schema) + Expect(doc["version"]).To(Equal("v1-draft")) + }) + + It("should include exports with description", func() { + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + Expect(exports).To(HaveKey("test_method")) + method := exports["test_method"].(map[string]any) + Expect(method["description"]).To(Equal("Test method does something")) + }) + + It("should include schemas for input and output types", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + Expect(schemas).To(HaveKey("TestInput")) + Expect(schemas).To(HaveKey("TestOutput")) + }) + + It("should define input schema with correct properties", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["TestInput"].(map[string]any) + // Per XTP spec, ObjectSchema does NOT have a type field - only properties, required, description + Expect(input).NotTo(HaveKey("type")) + props := input["properties"].(map[string]any) + Expect(props).To(HaveKey("name")) + Expect(props).To(HaveKey("count")) + }) + + It("should mark non-pointer, non-omitempty fields as required", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["TestInput"].(map[string]any) + required := input["required"].([]any) + Expect(required).To(ContainElement("name")) + Expect(required).To(ContainElement("count")) + }) + }) + + Context("capability with pointer fields (nullable)", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "nullable_test", + SourceFile: "nullable_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Required", Type: "string", JSONTag: "required"}, + {Name: "Optional", Type: "*string", JSONTag: "optional,omitempty", OmitEmpty: true}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should not mark required field as nullable", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + requiredField := props["required"].(map[string]any) + Expect(requiredField).NotTo(HaveKey("nullable")) + }) + + It("should mark optional pointer field as nullable", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + optionalField := props["optional"].(map[string]any) + Expect(optionalField["nullable"]).To(BeTrue()) + }) + + It("should only include non-pointer fields in required array", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + required := input["required"].([]any) + Expect(required).To(ContainElement("required")) + Expect(required).NotTo(ContainElement("optional")) + }) + }) + + Context("capability with enum", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "enum_test", + SourceFile: "enum_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Status", Type: "Status", JSONTag: "status"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + }, + TypeAliases: []TypeAlias{ + {Name: "Status", Type: "string", Doc: "Status type"}, + }, + Consts: []ConstGroup{ + { + Type: "Status", + Values: []ConstDef{ + {Name: "StatusPending", Value: `"pending"`}, + {Name: "StatusActive", Value: `"active"`}, + {Name: "StatusDone", Value: `"done"`}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should define enum type with correct values", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + Expect(schemas).To(HaveKey("Status")) + status := schemas["Status"].(map[string]any) + Expect(status["type"]).To(Equal("string")) + enum := status["enum"].([]any) + Expect(enum).To(ConsistOf("pending", "active", "done")) + }) + + It("should use $ref for enum field in struct", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + statusRef := props["status"].(map[string]any) + Expect(statusRef["$ref"]).To(Equal("#/components/schemas/Status")) + }) + }) + + Context("capability with array types", func() { + var schema []byte + + BeforeEach(func() { + capability := Capability{ + Name: "array_test", + SourceFile: "array_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Tags", Type: "[]string", JSONTag: "tags"}, + {Name: "Items", Type: "[]Item", JSONTag: "items"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + { + Name: "Item", + Fields: []FieldDef{ + {Name: "ID", Type: "string", JSONTag: "id"}, + }, + }, + }, + } + var err error + schema, err = GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + }) + + It("should validate against XTP JSONSchema", func() { + Expect(ValidateXTPSchema(schema)).To(Succeed()) + }) + + It("should define string array with primitive type", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + tags := props["tags"].(map[string]any) + Expect(tags["type"]).To(Equal("array")) + tagItems := tags["items"].(map[string]any) + Expect(tagItems["type"]).To(Equal("string")) + }) + + It("should define struct array with $ref", func() { + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + items := props["items"].(map[string]any) + Expect(items["type"]).To(Equal("array")) + itemItems := items["items"].(map[string]any) + Expect(itemItems["$ref"]).To(Equal("#/components/schemas/Item")) + }) + }) + + Context("capability with []byte field", func() { + It("should map []byte to string with byte format, not array", func() { + capability := Capability{ + Name: "byte_test", + SourceFile: "byte_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Data", Type: "[]byte", JSONTag: "data"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + input := schemas["Input"].(map[string]any) + props := input["properties"].(map[string]any) + data := props["data"].(map[string]any) + Expect(data["type"]).To(Equal("string")) + Expect(data["format"]).To(Equal("byte")) + Expect(data).NotTo(HaveKey("items")) + }) + }) + + Context("capability with nullable ref", func() { + It("should mark pointer to enum as nullable with $ref", func() { + capability := Capability{ + Name: "nullable_ref_test", + SourceFile: "nullable_ref_test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{ + {Name: "Value", Type: "string", JSONTag: "value"}, + }, + }, + { + Name: "Output", + Fields: []FieldDef{ + {Name: "Status", Type: "*ErrorType", JSONTag: "status,omitempty", OmitEmpty: true}, + }, + }, + }, + TypeAliases: []TypeAlias{ + {Name: "ErrorType", Type: "string"}, + }, + Consts: []ConstGroup{ + { + Type: "ErrorType", + Values: []ConstDef{ + {Name: "ErrorNone", Value: `"none"`}, + {Name: "ErrorFatal", Value: `"fatal"`}, + }, + }, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + + // Validate against XTP JSONSchema + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + output := schemas["Output"].(map[string]any) + props := output["properties"].(map[string]any) + status := props["status"].(map[string]any) + Expect(status["$ref"]).To(Equal("#/components/schemas/ErrorType")) + Expect(status["nullable"]).To(BeTrue()) + }) + }) + }) + + Describe("goTypeToXTPTypeAndFormat", func() { + DescribeTable("should convert Go types to XTP types", + func(goType, wantType, wantFormat string) { + gotType, gotFormat := goTypeToXTPTypeAndFormat(goType) + Expect(gotType).To(Equal(wantType)) + Expect(gotFormat).To(Equal(wantFormat)) + }, + Entry("string", "string", "string", ""), + Entry("int", "int", "integer", "int32"), + Entry("int32", "int32", "integer", "int32"), + Entry("int64", "int64", "integer", "int64"), + Entry("float32", "float32", "number", "float"), + Entry("float64", "float64", "number", "float"), + Entry("bool", "bool", "boolean", ""), + Entry("[]byte", "[]byte", "string", "byte"), + Entry("unknown types default to object", "CustomType", "object", ""), + ) + }) + + Describe("cleanDocForYAML", func() { + DescribeTable("should clean documentation strings", + func(doc, want string) { + Expect(cleanDocForYAML(doc)).To(Equal(want)) + }, + Entry("empty", "", ""), + Entry("single line", "Simple description", "Simple description"), + Entry("multiline", "First line\nSecond line", "First line\nSecond line"), + Entry("trailing newline", "Description\n", "Description"), + Entry("whitespace", " Description ", "Description"), + ) + }) + + Describe("isPrimitiveGoType", func() { + DescribeTable("should identify primitive Go types", + func(goType string, want bool) { + Expect(isPrimitiveGoType(goType)).To(Equal(want)) + }, + Entry("bool", "bool", true), + Entry("string", "string", true), + Entry("int", "int", true), + Entry("int32", "int32", true), + Entry("int64", "int64", true), + Entry("float32", "float32", true), + Entry("float64", "float64", true), + Entry("[]byte", "[]byte", true), + Entry("custom type", "CustomType", false), + Entry("struct type", "MyStruct", false), + Entry("slice of string", "[]string", false), + Entry("map type", "map[string]int", false), + ) + }) + + Describe("GenerateSchema with primitive output types", func() { + inputStruct := StructDef{ + Name: "Input", + Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}, + } + + Context("export with primitive string output", func() { + It("should use type instead of $ref and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_name", Input: NewParam("input", "Input"), Output: NewParam("output", "string")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(schema).NotTo(BeEmpty()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_name"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("string")) + Expect(output).NotTo(HaveKey("$ref")) + Expect(output["contentType"]).To(Equal("application/json")) + }) + }) + + Context("export with primitive bool output", func() { + It("should use boolean type and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "is_valid", Input: NewParam("input", "Input"), Output: NewParam("output", "bool")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["is_valid"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("boolean")) + Expect(output).NotTo(HaveKey("$ref")) + }) + }) + + Context("export with primitive int output", func() { + It("should use integer type and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_count", Input: NewParam("input", "Input"), Output: NewParam("output", "int32")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_count"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("integer")) + Expect(output).NotTo(HaveKey("$ref")) + }) + }) + + Context("export with pointer to primitive output", func() { + It("should strip pointer and use primitive type and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_optional_string", Input: NewParam("input", "Input"), Output: NewParam("output", "*string")}, + }, + Structs: []StructDef{inputStruct}, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_optional_string"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["type"]).To(Equal("string")) + Expect(output).NotTo(HaveKey("$ref")) + }) + }) + + Context("export with struct output", func() { + It("should still use $ref and validate against XTP JSONSchema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "get_result", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + inputStruct, + {Name: "Output", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + exports := doc["exports"].(map[string]any) + method := exports["get_result"].(map[string]any) + output := method["output"].(map[string]any) + Expect(output["$ref"]).To(Equal("#/components/schemas/Output")) + Expect(output).NotTo(HaveKey("type")) + }) + }) + }) + + Describe("collectUsedTypes", func() { + getSchemas := func(schema []byte) map[string]any { + doc := parseSchema(schema) + components, hasComponents := doc["components"].(map[string]any) + if !hasComponents { + return make(map[string]any) + } + schemas, ok := components["schemas"].(map[string]any) + if !ok { + return make(map[string]any) + } + return schemas + } + + It("should only include types referenced by exports", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "UsedInput"), Output: NewParam("output", "UsedOutput")}, + }, + Structs: []StructDef{ + {Name: "UsedInput", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "UsedOutput", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + {Name: "UnusedStruct", Fields: []FieldDef{{Name: "Foo", Type: "string", JSONTag: "foo"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("UsedInput")) + Expect(schemas).To(HaveKey("UsedOutput")) + Expect(schemas).NotTo(HaveKey("UnusedStruct")) + }) + + It("should include transitively referenced types", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Nested", Type: "NestedType", JSONTag: "nested"}}}, + {Name: "NestedType", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + Expect(schemas).To(HaveKey("Output")) + Expect(schemas).To(HaveKey("NestedType")) + }) + + It("should include array element types", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Items", Type: "[]Item", JSONTag: "items"}}}, + {Name: "Item", Fields: []FieldDef{{Name: "Name", Type: "string", JSONTag: "name"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + Expect(schemas).To(HaveKey("Output")) + Expect(schemas).To(HaveKey("Item")) + }) + + It("should include pointer types", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + {Name: "Output", Fields: []FieldDef{{Name: "Optional", Type: "*OptionalType", JSONTag: "optional"}}}, + {Name: "OptionalType", Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + Expect(schemas).To(HaveKey("Output")) + Expect(schemas).To(HaveKey("OptionalType")) + }) + + It("should exclude primitive output types from schema", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "string")}, + }, + Structs: []StructDef{ + {Name: "Input", Fields: []FieldDef{{Name: "ID", Type: "string", JSONTag: "id"}}}, + }, + } + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + schemas := getSchemas(schema) + Expect(schemas).To(HaveKey("Input")) + }) + }) + + Describe("GenerateSchema enum filtering", func() { + It("should only include enums that are actually used by exports", func() { + capability := Capability{ + Name: "test", + SourceFile: "test", + Methods: []Export{ + {ExportName: "test", Input: NewParam("input", "Input"), Output: NewParam("output", "Output")}, + }, + Structs: []StructDef{ + { + Name: "Input", + Fields: []FieldDef{{Name: "Status", Type: "UsedStatus", JSONTag: "status"}}, + }, + { + Name: "Output", + Fields: []FieldDef{{Name: "Value", Type: "string", JSONTag: "value"}}, + }, + }, + TypeAliases: []TypeAlias{ + {Name: "UsedStatus", Type: "string"}, + {Name: "UnusedStatus", Type: "string"}, + }, + Consts: []ConstGroup{ + { + Type: "UsedStatus", + Values: []ConstDef{ + {Name: "StatusActive", Value: `"active"`}, + {Name: "StatusInactive", Value: `"inactive"`}, + }, + }, + { + Type: "UnusedStatus", + Values: []ConstDef{ + {Name: "UnusedPending", Value: `"pending"`}, + }, + }, + }, + } + + schema, err := GenerateSchema(capability) + Expect(err).NotTo(HaveOccurred()) + Expect(ValidateXTPSchema(schema)).To(Succeed()) + + doc := parseSchema(schema) + components := doc["components"].(map[string]any) + schemas := components["schemas"].(map[string]any) + + // UsedStatus should be included because it's referenced by Input + Expect(schemas).To(HaveKey("UsedStatus")) + usedStatus := schemas["UsedStatus"].(map[string]any) + Expect(usedStatus["type"]).To(Equal("string")) + enum := usedStatus["enum"].([]any) + Expect(enum).To(ConsistOf("active", "inactive")) + + // UnusedStatus should NOT be included + Expect(schemas).NotTo(HaveKey("UnusedStatus")) + }) + }) +}) diff --git a/plugins/cmd/ndpgen/internal/xtp_schema_validate.go b/plugins/cmd/ndpgen/internal/xtp_schema_validate.go new file mode 100644 index 000000000..94404fb79 --- /dev/null +++ b/plugins/cmd/ndpgen/internal/xtp_schema_validate.go @@ -0,0 +1,86 @@ +package internal + +import ( + _ "embed" + "encoding/json" + "errors" + "fmt" + "strings" + + "github.com/santhosh-tekuri/jsonschema/v6" + "gopkg.in/yaml.v3" +) + +// XTP JSONSchema specification, from +// https://raw.githubusercontent.com/dylibso/xtp-bindgen/5090518dd86ba5e734dc225a33066ecc0ed2e12d/plugin/schema.json +// +//go:embed xtp_schema.json +var xtpSchemaJSON string + +// ValidateXTPSchema validates that the generated schema conforms to the XTP JSONSchema specification. +// Returns nil if valid, or an error with validation details if invalid. +func ValidateXTPSchema(generatedSchema []byte) error { + // Parse the YAML schema to JSON for validation + var schemaDoc map[string]any + if err := yaml.Unmarshal(generatedSchema, &schemaDoc); err != nil { + return fmt.Errorf("failed to parse generated schema as YAML: %w", err) + } + + // Parse the XTP schema JSON + var xtpSchema any + if err := json.Unmarshal([]byte(xtpSchemaJSON), &xtpSchema); err != nil { + return fmt.Errorf("failed to parse XTP schema: %w", err) + } + + // Compile the XTP schema + compiler := jsonschema.NewCompiler() + if err := compiler.AddResource("xtp-schema.json", xtpSchema); err != nil { + return fmt.Errorf("failed to add XTP schema resource: %w", err) + } + + schema, err := compiler.Compile("xtp-schema.json") + if err != nil { + return fmt.Errorf("failed to compile XTP schema: %w", err) + } + + // Validate the generated schema against XTP schema + if err := schema.Validate(schemaDoc); err != nil { + return fmt.Errorf("schema validation errors:\n%s", formatValidationErrors(err)) + } + + return nil +} + +// formatValidationErrors formats jsonschema validation errors into readable strings. +func formatValidationErrors(err error) string { + var validationErr *jsonschema.ValidationError + if !errors.As(err, &validationErr) { + return fmt.Sprintf("- %s", err.Error()) + } + + var errs []string + collectValidationErrors(validationErr, &errs) + + if len(errs) == 0 { + return fmt.Sprintf("- %s", validationErr.Error()) + } + return strings.Join(errs, "\n") +} + +// collectValidationErrors recursively collects leaf validation errors. +func collectValidationErrors(err *jsonschema.ValidationError, errs *[]string) { + if len(err.Causes) > 0 { + for _, cause := range err.Causes { + collectValidationErrors(cause, errs) + } + return + } + + // Leaf error - format with location if available + msg := err.Error() + if len(err.InstanceLocation) > 0 { + location := strings.Join(err.InstanceLocation, "/") + msg = fmt.Sprintf("%s: %s", location, msg) + } + *errs = append(*errs, fmt.Sprintf("- %s", msg)) +} diff --git a/plugins/cmd/ndpgen/main.go b/plugins/cmd/ndpgen/main.go new file mode 100644 index 000000000..b34ee4296 --- /dev/null +++ b/plugins/cmd/ndpgen/main.go @@ -0,0 +1,957 @@ +// ndpgen generates Navidrome Plugin Development Kit (PDK) code from annotated Go interfaces. +// +// This is the unified code generator that handles both host function wrappers +// and capability export wrappers. +// +// Usage: +// +// # Generate host wrappers for Navidrome server (output to input directory) +// ndpgen -host-wrappers -input=./plugins/host -package=host +// +// # Generate PDK client wrappers (from plugins/host to plugins/pdk) +// ndpgen -host-only -input=./plugins/host -output=./plugins/pdk +// +// # Generate capability wrappers (from plugins/capabilities to plugins/pdk) +// ndpgen -capability-only -input=./plugins/capabilities -output=./plugins/pdk +// +// # Generate XTP schemas from capabilities (output to input directory) +// ndpgen -schemas -input=./plugins/capabilities +// +// Output directories: +// - Host wrappers: $input/_gen.go (server-side, used by Navidrome) +// - Host functions: $output/go/host/, $output/python/host/, $output/rust/host/ +// - Capabilities: $output/go// (e.g., $output/go/metadata/) +// - Schemas: $input/.yaml (co-located with Go sources) +// +// Flags: +// +// -input Input directory containing Go source files with annotated interfaces +// -output Output directory base for generated files (default: same as input) +// -package Output package name for Go (default: host for host-only, auto for capabilities) +// -host-wrappers Generate server-side host wrappers (used by Navidrome, output to input directory) +// -host-only Generate PDK client wrappers for calling host functions +// -capability-only Generate only capability export wrappers +// -schemas Generate XTP YAML schemas from capabilities +// -go Generate Go client wrappers (default: true when not using -python/-rust) +// -python Generate Python client wrappers (default: false) +// -rust Generate Rust client wrappers (default: false) +// -v Verbose output +// -dry-run Preview generated code without writing files +package main + +import ( + "flag" + "fmt" + "go/format" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/plugins/cmd/ndpgen/internal" +) + +// config holds the parsed command-line configuration. +type config struct { + inputDir string + outputDir string // Base output directory (e.g., plugins/pdk) + goOutputDir string // Go output: $outputDir/go/host (for host-only) + pythonOutputDir string // Python output: $outputDir/python/host + rustOutputDir string // Rust output: $outputDir/rust/host + pkgName string + hostOnly bool + hostWrappers bool // Generate host wrappers (used by Navidrome server) + capabilityOnly bool + schemasOnly bool // Generate XTP schemas from capabilities (output goes to inputDir) + pdkOnly bool // Generate PDK abstraction layer wrapper + generateGoClient bool + generatePyClient bool + generateRsClient bool + verbose bool + dryRun bool +} + +func main() { + cfg, err := parseConfig() + if err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + + if cfg.schemasOnly { + if err := runSchemaGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + if cfg.pdkOnly { + if err := runPDKGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + if cfg.capabilityOnly { + if err := runCapabilityGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + if cfg.hostWrappers { + if err := runHostWrapperGeneration(cfg); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + return + } + + // Default: host-only mode + services, err := parseServices(cfg) + if err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } + if len(services) == 0 { + return + } + + if err := generateAllCode(cfg, services); err != nil { + fmt.Fprintf(os.Stderr, "Error: %v\n", err) + os.Exit(1) + } +} + +// runCapabilityGeneration handles capability-only code generation. +func runCapabilityGeneration(cfg *config) error { + capabilities, err := parseCapabilities(cfg) + if err != nil { + return err + } + if len(capabilities) == 0 { + if cfg.verbose { + fmt.Println("No capabilities found") + } + return nil + } + + return generateCapabilityCode(cfg, capabilities) +} + +// runSchemaGeneration handles XTP schema generation from capabilities. +func runSchemaGeneration(cfg *config) error { + capabilities, err := parseCapabilities(cfg) + if err != nil { + return err + } + if len(capabilities) == 0 { + if cfg.verbose { + fmt.Println("No capabilities found") + } + return nil + } + + return generateSchemas(cfg, capabilities) +} + +// runPDKGeneration handles PDK abstraction layer code generation. +// This generates the pdk wrapper package that wraps extism/go-pdk +// with mockable implementations for unit testing on native platforms. +func runPDKGeneration(cfg *config) error { + // Output directory is $output/go/pdk/ + outputDir := filepath.Join(cfg.outputDir, "go", "pdk") + return generatePDKPackageWithParsing(outputDir, cfg.dryRun, cfg.verbose) +} + +// generatePDKPackageWithParsing generates the PDK abstraction layer using AST parsing. +// It extracts all exported symbols from extism/go-pdk and generates wrappers for them. +func generatePDKPackageWithParsing(outputDir string, dryRun, verbose bool) error { + if verbose { + fmt.Println("Parsing extism/go-pdk to extract exported symbols...") + } + + // Parse extism/go-pdk to get all exported symbols + symbols, err := internal.ParseExtismPDK() + if err != nil { + return fmt.Errorf("parsing extism/go-pdk: %w", err) + } + + if verbose { + fmt.Printf("Found %d types, %d constants, %d functions\n", + len(symbols.Types), len(symbols.Consts), len(symbols.Functions)) + for _, t := range symbols.Types { + fmt.Printf(" Type %s: %d methods, %d fields\n", t.Name, len(t.Methods), len(t.Fields)) + for _, m := range t.Methods { + fmt.Printf(" Method: %s (receiver: %s)\n", m.Name, m.Receiver) + } + } + fmt.Printf("Generating PDK abstraction layer to: %s\n", outputDir) + } + + // Generate the WASM implementation (pdk.go) + pdkCode, err := internal.GeneratePDKGo(symbols) + if err != nil { + return fmt.Errorf("generating pdk.go: %w", err) + } + + formatted, err := format.Source(pdkCode) + if err != nil { + return fmt.Errorf("formatting pdk.go: %w\nRaw code:\n%s", err, pdkCode) + } + + pdkFile := filepath.Join(outputDir, "pdk.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", pdkFile, formatted) + } else { + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(pdkFile, formatted, 0600); err != nil { + return fmt.Errorf("writing pdk.go: %w", err) + } + + if verbose { + fmt.Printf("Generated: %s\n", pdkFile) + } + } + + // Generate the types stub (types_stub.go) + typesStubCode, err := internal.GeneratePDKTypesStub(symbols) + if err != nil { + return fmt.Errorf("generating types_stub.go: %w", err) + } + + formattedTypesStub, err := format.Source(typesStubCode) + if err != nil { + return fmt.Errorf("formatting types_stub.go: %w\nRaw code:\n%s", err, typesStubCode) + } + + typesStubFile := filepath.Join(outputDir, "types_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", typesStubFile, formattedTypesStub) + } else { + if err := os.WriteFile(typesStubFile, formattedTypesStub, 0600); err != nil { + return fmt.Errorf("writing types_stub.go: %w", err) + } + + if verbose { + fmt.Printf("Generated: %s\n", typesStubFile) + } + } + + // Generate the stub implementation (pdk_stub.go) + stubCode, err := internal.GeneratePDKGoStub(symbols) + if err != nil { + return fmt.Errorf("generating pdk_stub.go: %w", err) + } + + formattedStub, err := format.Source(stubCode) + if err != nil { + return fmt.Errorf("formatting pdk_stub.go: %w\nRaw code:\n%s", err, stubCode) + } + + stubFile := filepath.Join(outputDir, "pdk_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", stubFile, formattedStub) + } else { + if err := os.WriteFile(stubFile, formattedStub, 0600); err != nil { + return fmt.Errorf("writing pdk_stub.go: %w", err) + } + + if verbose { + fmt.Printf("Generated: %s\n", stubFile) + } + } + + return nil +} + +// generatePDKPackage generates the PDK abstraction layer to a specific directory. +// This is called by generateAllCode to include the PDK package alongside host client code. +func generatePDKPackage(outputDir string, dryRun, verbose bool) error { + return generatePDKPackageWithParsing(outputDir, dryRun, verbose) +} + +// runHostWrapperGeneration handles host wrapper code generation. +// This generates the *_gen.go files in the input directory that are used +// by Navidrome server to expose host functions to plugins. +func runHostWrapperGeneration(cfg *config) error { + services, err := parseServices(cfg) + if err != nil { + return err + } + if len(services) == 0 { + if cfg.verbose { + fmt.Println("No host services found") + } + return nil + } + + // Generate host wrappers for each service + for _, svc := range services { + if err := generateHostWrapperCode(svc, cfg.inputDir, cfg.pkgName, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating host wrapper for %s: %w", svc.Name, err) + } + } + + return nil +} + +// parseConfig parses command-line flags and returns the configuration. +func parseConfig() (*config, error) { + var ( + inputDir = flag.String("input", ".", "Input directory containing Go source files") + outputDir = flag.String("output", "", "Base output directory for generated files (default: same as input)") + pkgName = flag.String("package", "", "Output package name for Go (default: host for host-only, auto for capabilities)") + hostOnly = flag.Bool("host-only", false, "Generate only host function wrappers") + hostWrappers = flag.Bool("host-wrappers", false, "Generate host wrappers (used by Navidrome server, output to input directory)") + capabilityOnly = flag.Bool("capability-only", false, "Generate only capability export wrappers") + schemasOnly = flag.Bool("schemas", false, "Generate XTP YAML schemas from capabilities (output to input directory)") + pdkOnly = flag.Bool("extism-pdk", false, "Generate PDK abstraction layer by parsing extism/go-pdk") + goClient = flag.Bool("go", false, "Generate Go client wrappers") + pyClient = flag.Bool("python", false, "Generate Python client wrappers") + rsClient = flag.Bool("rust", false, "Generate Rust client wrappers") + verbose = flag.Bool("v", false, "Verbose output") + dryRun = flag.Bool("dry-run", false, "Preview generated code without writing files") + ) + flag.Parse() + + // Count how many mode flags are specified + modeCount := 0 + if *hostOnly { + modeCount++ + } + if *hostWrappers { + modeCount++ + } + if *capabilityOnly { + modeCount++ + } + if *schemasOnly { + modeCount++ + } + if *pdkOnly { + modeCount++ + } + + // Default to host-only if no mode is specified + if modeCount == 0 { + *hostOnly = true + } + + // Cannot specify multiple modes + if modeCount > 1 { + return nil, fmt.Errorf("cannot specify multiple modes (-host-only, -host-wrappers, -capability-only, -schemas, -pdk)") + } + + if *outputDir == "" { + *outputDir = *inputDir + } + + // Default package name based on mode + if *pkgName == "" { + if *hostOnly { + *pkgName = "host" + } + // For capability-only, package name is derived from capability annotation + } + + absInput, err := filepath.Abs(*inputDir) + if err != nil { + return nil, fmt.Errorf("resolving input path: %w", err) + } + absOutput, err := filepath.Abs(*outputDir) + if err != nil { + return nil, fmt.Errorf("resolving output path: %w", err) + } + + // Set output directories for each language + // Go host wrappers: $output/go/host/ + // Python host wrappers: $output/python/host/ + // Rust host wrappers: $output/rust/nd-pdk-host/ (renamed crate) + absGoOutput := filepath.Join(absOutput, "go", "host") + absPythonOutput := filepath.Join(absOutput, "python", "host") + absRustOutput := filepath.Join(absOutput, "rust", "nd-pdk-host") + + // Determine what to generate + // Default: generate Go clients if no language flag is specified + anyLangFlag := *goClient || *pyClient || *rsClient + + return &config{ + inputDir: absInput, + outputDir: absOutput, + goOutputDir: absGoOutput, + pythonOutputDir: absPythonOutput, + rustOutputDir: absRustOutput, + pkgName: *pkgName, + hostOnly: *hostOnly, + hostWrappers: *hostWrappers, + capabilityOnly: *capabilityOnly, + schemasOnly: *schemasOnly, + pdkOnly: *pdkOnly, + generateGoClient: *goClient || !anyLangFlag, + generatePyClient: *pyClient, + generateRsClient: *rsClient, + verbose: *verbose, + dryRun: *dryRun, + }, nil +} + +// parseServices parses source files and returns discovered services. +func parseServices(cfg *config) ([]internal.Service, error) { + if cfg.verbose { + fmt.Printf("Input directory: %s\n", cfg.inputDir) + fmt.Printf("Base output directory: %s\n", cfg.outputDir) + if cfg.generateGoClient { + fmt.Printf("Go output directory: %s\n", cfg.goOutputDir) + } + if cfg.generatePyClient { + fmt.Printf("Python output directory: %s\n", cfg.pythonOutputDir) + } + if cfg.generateRsClient { + fmt.Printf("Rust output directory: %s\n", cfg.rustOutputDir) + } + fmt.Printf("Package name: %s\n", cfg.pkgName) + fmt.Printf("Host-only mode: %v\n", cfg.hostOnly) + fmt.Printf("Generate Go client code: %v\n", cfg.generateGoClient) + fmt.Printf("Generate Python client code: %v\n", cfg.generatePyClient) + fmt.Printf("Generate Rust client code: %v\n", cfg.generateRsClient) + } + + services, err := internal.ParseDirectory(cfg.inputDir) + if err != nil { + return nil, fmt.Errorf("parsing source files: %w", err) + } + + if len(services) == 0 { + if cfg.verbose { + fmt.Println("No host services found") + } + return nil, nil + } + + if cfg.verbose { + fmt.Printf("Found %d host service(s)\n", len(services)) + for _, svc := range services { + fmt.Printf(" - %s (%d methods)\n", svc.Name, len(svc.Methods)) + } + } + + return services, nil +} + +// parseCapabilities parses source files and returns discovered capabilities. +func parseCapabilities(cfg *config) ([]internal.Capability, error) { + if cfg.verbose { + fmt.Printf("Input directory: %s\n", cfg.inputDir) + fmt.Printf("Base output directory: %s\n", cfg.outputDir) + fmt.Printf("Capability-only mode: %v\n", cfg.capabilityOnly) + } + + capabilities, err := internal.ParseCapabilities(cfg.inputDir) + if err != nil { + return nil, fmt.Errorf("parsing capability files: %w", err) + } + + if len(capabilities) == 0 { + return nil, nil + } + + if cfg.verbose { + fmt.Printf("Found %d capability(ies)\n", len(capabilities)) + for _, cap := range capabilities { + fmt.Printf(" - %s (%d exports, required=%v)\n", cap.Name, len(cap.Methods), cap.Required) + } + } + + return capabilities, nil +} + +// generateCapabilityCode generates export wrappers for all capabilities. +func generateCapabilityCode(cfg *config, capabilities []internal.Capability) error { + // Generate Go capability wrappers (always, for now) + for _, cap := range capabilities { + // Output directory is $output/go// + outputDir := filepath.Join(cfg.outputDir, "go", cap.Name) + + if err := generateCapabilityGoCode(cap, outputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go capability code for %s: %w", cap.Name, err) + } + } + + // Generate Rust capability wrappers if -rust flag is set + if cfg.generateRsClient { + rustOutputDir := filepath.Join(cfg.outputDir, "rust", "nd-pdk-capabilities", "src") + if err := generateCapabilityRustCode(capabilities, rustOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Rust capability code: %w", err) + } + } + + return nil +} + +// generateCapabilityGoCode generates Go export wrapper code for a capability. +func generateCapabilityGoCode(cap internal.Capability, outputDir string, dryRun, verbose bool) error { + // Use the capability name as the package name + pkgName := cap.Name + + // Generate the main WASM code + code, err := internal.GenerateCapabilityGo(cap, pkgName) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting code: %w\nRaw code:\n%s", err, code) + } + + mainFile := filepath.Join(outputDir, cap.Name+".go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", mainFile, formatted) + } else { + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(mainFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated capability code: %s\n", mainFile) + } + } + + // Generate the stub code for non-WASM platforms + stubCode, err := internal.GenerateCapabilityGoStub(cap, pkgName) + if err != nil { + return fmt.Errorf("generating stub code: %w", err) + } + + formattedStub, err := format.Source(stubCode) + if err != nil { + return fmt.Errorf("formatting stub code: %w\nRaw code:\n%s", err, stubCode) + } + + stubFile := filepath.Join(outputDir, cap.Name+"_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", stubFile, formattedStub) + } else { + if err := os.WriteFile(stubFile, formattedStub, 0600); err != nil { + return fmt.Errorf("writing stub file: %w", err) + } + + if verbose { + fmt.Printf("Generated capability stub: %s\n", stubFile) + } + } + + return nil +} + +// generateCapabilityRustCode generates Rust export wrapper code for all capabilities. +func generateCapabilityRustCode(capabilities []internal.Capability, outputDir string, dryRun, verbose bool) error { + // Generate individual capability modules + for _, cap := range capabilities { + code, err := internal.GenerateCapabilityRust(cap) + if err != nil { + return fmt.Errorf("generating Rust code for %s: %w", cap.Name, err) + } + + fileName := internal.ToSnakeCase(cap.Name) + ".rs" + filePath := filepath.Join(outputDir, fileName) + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", filePath, code) + } else { + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(filePath, code, 0600); err != nil { + return fmt.Errorf("writing file %s: %w", filePath, err) + } + + if verbose { + fmt.Printf("Generated Rust capability code: %s\n", filePath) + } + } + } + + // Generate lib.rs + libCode, err := internal.GenerateCapabilityRustLib(capabilities) + if err != nil { + return fmt.Errorf("generating lib.rs: %w", err) + } + + libPath := filepath.Join(outputDir, "lib.rs") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", libPath, libCode) + } else { + if err := os.WriteFile(libPath, libCode, 0600); err != nil { + return fmt.Errorf("writing lib.rs: %w", err) + } + + if verbose { + fmt.Printf("Generated Rust lib.rs: %s\n", libPath) + } + } + + return nil +} + +// generateAllCode generates all requested code for the services. +func generateAllCode(cfg *config, services []internal.Service) error { + for _, svc := range services { + if cfg.generateGoClient { + if err := generateGoClientCode(svc, cfg.goOutputDir, cfg.pkgName, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go client code for %s: %w", svc.Name, err) + } + } + if cfg.generatePyClient { + if err := generatePythonClientCode(svc, cfg.pythonOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Python client code for %s: %w", svc.Name, err) + } + } + if cfg.generateRsClient { + if err := generateRustClientCode(svc, cfg.rustOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Rust client code for %s: %w", svc.Name, err) + } + } + } + + if cfg.generateRsClient && len(services) > 0 { + if err := generateRustLibFile(services, cfg.rustOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Rust lib.rs: %w", err) + } + } + + if cfg.generateGoClient && len(services) > 0 { + if err := generateGoDocFile(services, cfg.goOutputDir, cfg.pkgName, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go doc.go: %w", err) + } + if err := generateGoModFile(cfg.goOutputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating Go go.mod: %w", err) + } + // Generate PDK abstraction layer alongside host client code + pdkDir := filepath.Join(filepath.Dir(cfg.goOutputDir), "pdk") + if err := generatePDKPackage(pdkDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating PDK package: %w", err) + } + } + + return nil +} + +// generateHostWrapperCode generates host wrapper code for a service. +// This generates the *_gen.go files that are used by Navidrome server +// to expose host functions to plugins via Extism. +func generateHostWrapperCode(svc internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateHost(svc, pkgName) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting code: %w\nRaw code:\n%s", err, code) + } + + // Host wrapper file follows the pattern _gen.go + hostFile := filepath.Join(outputDir, strings.ToLower(svc.Name)+"_gen.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", hostFile, formatted) + } else { + if err := os.WriteFile(hostFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated host wrapper: %s\n", hostFile) + } + } + + return nil +} + +// generateGoClientCode generates Go client-side code for a service. +func generateGoClientCode(svc internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateClientGo(svc, pkgName) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting code: %w\nRaw code:\n%s", err, code) + } + + // Client code goes directly in the output directory + clientFile := filepath.Join(outputDir, "nd_host_"+strings.ToLower(svc.Name)+".go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", clientFile, formatted) + } else { + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(clientFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go client code: %s\n", clientFile) + } + } + + // Also generate stub file for non-WASM platforms + return generateGoClientStubCode(svc, outputDir, pkgName, dryRun, verbose) +} + +// generateGoClientStubCode generates stub code for non-WASM platforms. +func generateGoClientStubCode(svc internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateClientGoStub(svc, pkgName) + if err != nil { + return fmt.Errorf("generating stub code: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting stub code: %w\nRaw code:\n%s", err, code) + } + + // Stub code goes directly in output directory with _stub suffix + stubFile := filepath.Join(outputDir, "nd_host_"+strings.ToLower(svc.Name)+"_stub.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", stubFile, formatted) + return nil + } + + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(stubFile, formatted, 0600); err != nil { + return fmt.Errorf("writing stub file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go client stub: %s\n", stubFile) + } + return nil +} + +// generatePythonClientCode generates Python client-side code for a service. +func generatePythonClientCode(svc internal.Service, outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateClientPython(svc) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + // Python code goes directly in the output directory + clientFile := filepath.Join(outputDir, "nd_host_"+strings.ToLower(svc.Name)+".py") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", clientFile, code) + return nil + } + + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating python client directory: %w", err) + } + + if err := os.WriteFile(clientFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Python client code: %s\n", clientFile) + } + return nil +} + +// generateRustClientCode generates Rust client-side code for a service. +func generateRustClientCode(svc internal.Service, outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateClientRust(svc) + if err != nil { + return fmt.Errorf("generating code: %w", err) + } + + // Rust code goes in src/ subdirectory (standard Rust convention) + srcDir := filepath.Join(outputDir, "src") + clientFile := filepath.Join(srcDir, "nd_host_"+strings.ToLower(svc.Name)+".rs") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", clientFile, code) + return nil + } + + // Create src directory if needed + if err := os.MkdirAll(srcDir, 0755); err != nil { + return fmt.Errorf("creating rust src directory: %w", err) + } + + if err := os.WriteFile(clientFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Rust client code: %s\n", clientFile) + } + return nil +} + +// generateRustLibFile generates the lib.rs file that exposes all Rust modules. +func generateRustLibFile(services []internal.Service, outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateRustLib(services) + if err != nil { + return fmt.Errorf("generating lib.rs: %w", err) + } + + // lib.rs goes in src/ subdirectory (standard Rust convention) + srcDir := filepath.Join(outputDir, "src") + libFile := filepath.Join(srcDir, "lib.rs") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", libFile, code) + return nil + } + + // Create src directory if needed + if err := os.MkdirAll(srcDir, 0755); err != nil { + return fmt.Errorf("creating rust src directory: %w", err) + } + + if err := os.WriteFile(libFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Rust lib.rs: %s\n", libFile) + } + return nil +} + +// generateGoDocFile generates the doc.go file for the Go library. +func generateGoDocFile(services []internal.Service, outputDir, pkgName string, dryRun, verbose bool) error { + code, err := internal.GenerateGoDoc(services, pkgName) + if err != nil { + return fmt.Errorf("generating doc.go: %w", err) + } + + formatted, err := format.Source(code) + if err != nil { + return fmt.Errorf("formatting doc.go: %w\nRaw code:\n%s", err, code) + } + + docFile := filepath.Join(outputDir, "doc.go") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", docFile, formatted) + return nil + } + + // Create output directory if needed + if err := os.MkdirAll(outputDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(docFile, formatted, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go doc.go: %s\n", docFile) + } + return nil +} + +// generateGoModFile generates the go.mod file for the Go library. +// The go.mod is placed at the parent directory ($output/go/) to create a unified +// module that includes both host wrappers and capabilities. +func generateGoModFile(outputDir string, dryRun, verbose bool) error { + code, err := internal.GenerateGoMod() + if err != nil { + return fmt.Errorf("generating go.mod: %w", err) + } + + // Output to parent directory ($output/go/) instead of host directory + parentDir := filepath.Dir(outputDir) + modFile := filepath.Join(parentDir, "go.mod") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", modFile, code) + return nil + } + + // Create parent directory if needed + if err := os.MkdirAll(parentDir, 0755); err != nil { + return fmt.Errorf("creating output directory: %w", err) + } + + if err := os.WriteFile(modFile, code, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated Go go.mod: %s\n", modFile) + } + return nil +} + +// generateSchemas generates XTP YAML schemas from capabilities. +func generateSchemas(cfg *config, capabilities []internal.Capability) error { + for _, cap := range capabilities { + if err := generateSchemaFile(cap, cfg.inputDir, cfg.dryRun, cfg.verbose); err != nil { + return fmt.Errorf("generating schema for %s: %w", cap.Name, err) + } + } + return nil +} + +// generateSchemaFile generates an XTP YAML schema file for a capability. +func generateSchemaFile(cap internal.Capability, outputDir string, dryRun, verbose bool) error { + schema, err := internal.GenerateSchema(cap) + if err != nil { + return fmt.Errorf("generating schema: %w", err) + } + + // Validate the generated schema against XTP JSONSchema spec + if err := internal.ValidateXTPSchema(schema); err != nil { + fmt.Fprintf(os.Stderr, "Warning: Schema validation for %s:\n%s\n", cap.Name, err) + } + + // Use the source file name: websocket_callback.go -> websocket_callback.yaml + schemaFile := filepath.Join(outputDir, cap.SourceFile+".yaml") + + if dryRun { + fmt.Printf("=== %s ===\n%s\n", schemaFile, schema) + return nil + } + + if err := os.WriteFile(schemaFile, schema, 0600); err != nil { + return fmt.Errorf("writing file: %w", err) + } + + if verbose { + fmt.Printf("Generated XTP schema: %s\n", schemaFile) + } + return nil +} diff --git a/plugins/cmd/ndpgen/ndpgen_suite_test.go b/plugins/cmd/ndpgen/ndpgen_suite_test.go new file mode 100644 index 000000000..543fe8876 --- /dev/null +++ b/plugins/cmd/ndpgen/ndpgen_suite_test.go @@ -0,0 +1,13 @@ +package main + +import ( + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestNdpgen(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "NDPGen CLI Suite") +} diff --git a/plugins/cmd/ndpgen/testdata/codec_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/codec_client_expected.go.txt new file mode 100644 index 000000000..93d5cb27c --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_client_expected.go.txt @@ -0,0 +1,63 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Codec host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// codec_encode is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user codec_encode +func codec_encode(uint64) uint64 + +type codecEncodeRequest struct { + Data []byte `json:"data"` +} + +type codecEncodeResponse struct { + Result []byte `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// CodecEncode calls the codec_encode host function. +func CodecEncode(data []byte) ([]byte, error) { + // Marshal request to JSON + req := codecEncodeRequest{ + Data: data, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := codec_encode(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response codecEncodeResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/cmd/ndpgen/testdata/codec_client_expected.py b/plugins/cmd/ndpgen/testdata/codec_client_expected.py new file mode 100644 index 000000000..5142ffd0e --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_client_expected.py @@ -0,0 +1,53 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Codec host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "codec_encode") +def _codec_encode(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def codec_encode(data: bytes) -> bytes: + """Call the codec_encode host function. + + Args: + data: bytes parameter. + + Returns: + bytes: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": base64.b64encode(data).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _codec_encode(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return base64.b64decode(response.get("result", "")) diff --git a/plugins/cmd/ndpgen/testdata/codec_client_expected.rs b/plugins/cmd/ndpgen/testdata/codec_client_expected.rs new file mode 100644 index 000000000..3e229ea8a --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_client_expected.rs @@ -0,0 +1,76 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Codec host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize(bytes: &Vec, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CodecEncodeRequest { + #[serde(with = "base64_bytes")] + data: Vec, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CodecEncodeResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + result: Vec, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn codec_encode(input: Json) -> Json; +} + +/// Calls the codec_encode host function. +/// +/// # Arguments +/// * `data` - Vec parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn encode(data: Vec) -> Result, Error> { + let response = unsafe { + codec_encode(Json(CodecEncodeRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/codec_expected.go.txt b/plugins/cmd/ndpgen/testdata/codec_expected.go.txt new file mode 100644 index 000000000..8655e49c8 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_expected.go.txt @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// CodecEncodeRequest is the request type for Codec.Encode. +type CodecEncodeRequest struct { + Data []byte `json:"data"` +} + +// CodecEncodeResponse is the response type for Codec.Encode. +type CodecEncodeResponse struct { + Result []byte `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterCodecHostFunctions registers Codec service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterCodecHostFunctions(service CodecService) []extism.HostFunction { + return []extism.HostFunction{ + newCodecEncodeHostFunction(service), + } +} + +func newCodecEncodeHostFunction(service CodecService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "codec_encode", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + codecWriteError(p, stack, err) + return + } + var req CodecEncodeRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + codecWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Encode(ctx, req.Data) + if svcErr != nil { + codecWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CodecEncodeResponse{ + Result: result, + } + codecWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// codecWriteResponse writes a JSON response to plugin memory. +func codecWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + codecWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// codecWriteError writes an error response to plugin memory. +func codecWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/codec_service.go.txt b/plugins/cmd/ndpgen/testdata/codec_service.go.txt new file mode 100644 index 000000000..94a1b71db --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/codec_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Codec permission=codec +type CodecService interface { + //nd:hostfunc + Encode(ctx context.Context, data []byte) ([]byte, error) +} diff --git a/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.py b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.py new file mode 100644 index 000000000..93370ddcf --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.py @@ -0,0 +1,342 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Comprehensive host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "comprehensive_simpleparams") +def _comprehensive_simpleparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_structparam") +def _comprehensive_structparam(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_mixedparams") +def _comprehensive_mixedparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_noerror") +def _comprehensive_noerror(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_noparams") +def _comprehensive_noparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_noparamsnoreturns") +def _comprehensive_noparamsnoreturns(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_pointerparams") +def _comprehensive_pointerparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_mapparams") +def _comprehensive_mapparams(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_multiplereturns") +def _comprehensive_multiplereturns(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "comprehensive_byteslice") +def _comprehensive_byteslice(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class ComprehensiveMultipleReturnsResult: + """Result type for comprehensive_multiple_returns.""" + results: Any + total: int + + +def comprehensive_simple_params(name: str, count: int) -> str: + """Call the comprehensive_simpleparams host function. + + Args: + name: str parameter. + count: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + "count": count, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_simpleparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", "") + + +def comprehensive_struct_param(user: Any) -> None: + """Call the comprehensive_structparam host function. + + Args: + user: Any parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "user": user, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_structparam(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def comprehensive_mixed_params(id: str, filter: Any) -> int: + """Call the comprehensive_mixedparams host function. + + Args: + id: str parameter. + filter: Any parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "filter": filter, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_mixedparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", 0) + + +def comprehensive_no_error(name: str) -> str: + """Call the comprehensive_noerror host function. + + Args: + name: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_noerror(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", "") + + +def comprehensive_no_params() -> None: + """Call the comprehensive_noparams host function. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_noparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def comprehensive_no_params_no_returns() -> None: + """Call the comprehensive_noparamsnoreturns host function. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_noparamsnoreturns(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def comprehensive_pointer_params(id: Any, user: Any) -> Any: + """Call the comprehensive_pointerparams host function. + + Args: + id: Any parameter. + user: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "user": user, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_pointerparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def comprehensive_map_params(data: Any) -> Any: + """Call the comprehensive_mapparams host function. + + Args: + data: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": data, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_mapparams(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def comprehensive_multiple_returns(query: str) -> ComprehensiveMultipleReturnsResult: + """Call the comprehensive_multiplereturns host function. + + Args: + query: str parameter. + + Returns: + ComprehensiveMultipleReturnsResult containing results, total,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "query": query, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_multiplereturns(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return ComprehensiveMultipleReturnsResult( + results=response.get("results", None), + total=response.get("total", 0), + ) + + +def comprehensive_byte_slice(data: bytes) -> bytes: + """Call the comprehensive_byteslice host function. + + Args: + data: bytes parameter. + + Returns: + bytes: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": base64.b64encode(data).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _comprehensive_byteslice(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return base64.b64decode(response.get("result", "")) diff --git a/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.rs b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.rs new file mode 100644 index 000000000..08dae2901 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/comprehensive_client_expected.rs @@ -0,0 +1,423 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Comprehensive host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize(bytes: &Vec, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct User2 { + pub id: String, + pub name: String, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Filter2 { + pub active: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveSimpleParamsRequest { + name: String, + count: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveSimpleParamsResponse { + #[serde(default)] + result: String, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveStructParamRequest { + user: User2, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveStructParamResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMixedParamsRequest { + id: String, + filter: Filter2, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMixedParamsResponse { + #[serde(default)] + result: i32, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoErrorRequest { + name: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoErrorResponse { + #[serde(default)] + result: String, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoParamsResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveNoParamsNoReturnsResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensivePointerParamsRequest { + id: Option, + user: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensivePointerParamsResponse { + #[serde(default)] + result: Option, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMapParamsRequest { + data: std::collections::HashMap, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMapParamsResponse { + #[serde(default)] + result: serde_json::Value, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMultipleReturnsRequest { + query: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveMultipleReturnsResponse { + #[serde(default)] + results: Vec, + #[serde(default)] + total: i32, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveByteSliceRequest { + #[serde(with = "base64_bytes")] + data: Vec, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ComprehensiveByteSliceResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + result: Vec, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn comprehensive_simpleparams(input: Json) -> Json; + fn comprehensive_structparam(input: Json) -> Json; + fn comprehensive_mixedparams(input: Json) -> Json; + fn comprehensive_noerror(input: Json) -> Json; + fn comprehensive_noparams(input: Json) -> Json; + fn comprehensive_noparamsnoreturns(input: Json) -> Json; + fn comprehensive_pointerparams(input: Json) -> Json; + fn comprehensive_mapparams(input: Json) -> Json; + fn comprehensive_multiplereturns(input: Json) -> Json; + fn comprehensive_byteslice(input: Json) -> Json; +} + +/// Calls the comprehensive_simpleparams host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// * `count` - i32 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn simple_params(name: &str, count: i32) -> Result { + let response = unsafe { + comprehensive_simpleparams(Json(ComprehensiveSimpleParamsRequest { + name: name.to_owned(), + count: count, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_structparam host function. +/// +/// # Arguments +/// * `user` - User2 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn struct_param(user: User2) -> Result<(), Error> { + let response = unsafe { + comprehensive_structparam(Json(ComprehensiveStructParamRequest { + user: user, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the comprehensive_mixedparams host function. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `filter` - Filter2 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn mixed_params(id: &str, filter: Filter2) -> Result { + let response = unsafe { + comprehensive_mixedparams(Json(ComprehensiveMixedParamsRequest { + id: id.to_owned(), + filter: filter, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_noerror host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn no_error(name: &str) -> Result { + let response = unsafe { + comprehensive_noerror(Json(ComprehensiveNoErrorRequest { + name: name.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_noparams host function. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn no_params() -> Result<(), Error> { + let response = unsafe { + comprehensive_noparams(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the comprehensive_noparamsnoreturns host function. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn no_params_no_returns() -> Result<(), Error> { + let response = unsafe { + comprehensive_noparamsnoreturns(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the comprehensive_pointerparams host function. +/// +/// # Arguments +/// * `id` - Option parameter. +/// * `user` - Option parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn pointer_params(id: Option, user: Option) -> Result, Error> { + let response = unsafe { + comprehensive_pointerparams(Json(ComprehensivePointerParamsRequest { + id: id, + user: user, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_mapparams host function. +/// +/// # Arguments +/// * `data` - std::collections::HashMap parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn map_params(data: std::collections::HashMap) -> Result { + let response = unsafe { + comprehensive_mapparams(Json(ComprehensiveMapParamsRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Calls the comprehensive_multiplereturns host function. +/// +/// # Arguments +/// * `query` - String parameter. +/// +/// # Returns +/// A tuple of (results, total). +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn multiple_returns(query: &str) -> Result<(Vec, i32), Error> { + let response = unsafe { + comprehensive_multiplereturns(Json(ComprehensiveMultipleReturnsRequest { + query: query.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok((response.0.results, response.0.total)) +} + +/// Calls the comprehensive_byteslice host function. +/// +/// # Arguments +/// * `data` - Vec parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn byte_slice(data: Vec) -> Result, Error> { + let response = unsafe { + comprehensive_byteslice(Json(ComprehensiveByteSliceRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/comprehensive_service.go.txt b/plugins/cmd/ndpgen/testdata/comprehensive_service.go.txt new file mode 100644 index 000000000..3a9a1bfc4 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/comprehensive_service.go.txt @@ -0,0 +1,36 @@ +package testpkg + +import "context" + +type User2 struct { + ID string + Name string +} + +type Filter2 struct { + Active bool +} + +//nd:hostservice name=Comprehensive permission=comprehensive +type ComprehensiveService interface { + //nd:hostfunc + SimpleParams(ctx context.Context, name string, count int32) (string, error) + //nd:hostfunc + StructParam(ctx context.Context, user User2) error + //nd:hostfunc + MixedParams(ctx context.Context, id string, filter Filter2) (int32, error) + //nd:hostfunc + NoError(ctx context.Context, name string) string + //nd:hostfunc + NoParams(ctx context.Context) error + //nd:hostfunc + NoParamsNoReturns(ctx context.Context) + //nd:hostfunc + PointerParams(ctx context.Context, id *string, user *User2) (*User2, error) + //nd:hostfunc + MapParams(ctx context.Context, data map[string]any) (interface{}, error) + //nd:hostfunc + MultipleReturns(ctx context.Context, query string) (results []User2, total int32, err error) + //nd:hostfunc + ByteSlice(ctx context.Context, data []byte) ([]byte, error) +} diff --git a/plugins/cmd/ndpgen/testdata/config_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/config_client_expected.go.txt new file mode 100644 index 000000000..c88fb930b --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_client_expected.go.txt @@ -0,0 +1,156 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// config_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_get +func config_get(uint64) uint64 + +// config_set is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_set +func config_set(uint64) uint64 + +// config_has is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_has +func config_has(uint64) uint64 + +type configGetRequest struct { + Key string `json:"key"` +} + +type configGetResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type configSetRequest struct { + Key string `json:"key"` + Value string `json:"value"` +} + +type configHasRequest struct { + Key string `json:"key"` +} + +type configHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// ConfigGet calls the config_get host function. +func ConfigGet(key string) (string, bool, error) { + // Marshal request to JSON + req := configGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// ConfigSet calls the config_set host function. +func ConfigSet(key string, value string) error { + // Marshal request to JSON + req := configSetRequest{ + Key: key, + Value: value, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_set(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// ConfigHas calls the config_has host function. +func ConfigHas(key string) (bool, error) { + // Marshal request to JSON + req := configHasRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_has(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configHasResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return false, errors.New(response.Error) + } + + return response.Exists, nil +} diff --git a/plugins/cmd/ndpgen/testdata/config_client_expected.py b/plugins/cmd/ndpgen/testdata/config_client_expected.py new file mode 100644 index 000000000..370de6d10 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_client_expected.py @@ -0,0 +1,126 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Config host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "config_get") +def _config_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_set") +def _config_set(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_has") +def _config_has(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class ConfigGetResult: + """Result type for config_get.""" + value: str + exists: bool + + +def config_get(key: str) -> ConfigGetResult: + """Call the config_get host function. + + Args: + key: str parameter. + + Returns: + ConfigGetResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return ConfigGetResult( + value=response.get("value", ""), + exists=response.get("exists", False), + ) + + +def config_set(key: str, value: str) -> None: + """Call the config_set host function. + + Args: + key: str parameter. + value: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_set(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def config_has(key: str) -> bool: + """Call the config_has host function. + + Args: + key: str parameter. + + Returns: + bool: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_has(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("exists", False) diff --git a/plugins/cmd/ndpgen/testdata/config_client_expected.rs b/plugins/cmd/ndpgen/testdata/config_client_expected.rs new file mode 100644 index 000000000..154d01b0c --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_client_expected.rs @@ -0,0 +1,135 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetResponse { + #[serde(default)] + value: String, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigSetRequest { + key: String, + value: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigSetResponse { + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigHasRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigHasResponse { + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn config_get(input: Json) -> Json; + fn config_set(input: Json) -> Json; + fn config_has(input: Json) -> Json; +} + +/// Calls the config_get host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result, Error> { + let response = unsafe { + config_get(Json(ConfigGetRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// Calls the config_set host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set(key: &str, value: &str) -> Result<(), Error> { + let response = unsafe { + config_set(Json(ConfigSetRequest { + key: key.to_owned(), + value: value.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Calls the config_has host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The exists value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn has(key: &str) -> Result { + let response = unsafe { + config_has(Json(ConfigHasRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.exists) +} diff --git a/plugins/cmd/ndpgen/testdata/config_service.go.txt b/plugins/cmd/ndpgen/testdata/config_service.go.txt new file mode 100644 index 000000000..5def79302 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/config_service.go.txt @@ -0,0 +1,15 @@ +package testpkg + +import "context" + +//nd:hostservice name=Config permission=config +type ConfigService interface { + //nd:hostfunc + Get(ctx context.Context, key string) (value string, exists bool, err error) + + //nd:hostfunc + Set(ctx context.Context, key string, value string) error + + //nd:hostfunc + Has(ctx context.Context, key string) (exists bool, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/counter_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/counter_client_expected.go.txt new file mode 100644 index 000000000..3fbb53727 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_client_expected.go.txt @@ -0,0 +1,56 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Counter host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// counter_count is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user counter_count +func counter_count(uint64) uint64 + +type counterCountRequest struct { + Name string `json:"name"` +} + +type counterCountResponse struct { + Value int32 `json:"value,omitempty"` +} + +// CounterCount calls the counter_count host function. +func CounterCount(name string) int32 { + // Marshal request to JSON + req := counterCountRequest{ + Name: name, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0 + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := counter_count(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response counterCountResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0 + } + + return response.Value +} diff --git a/plugins/cmd/ndpgen/testdata/counter_client_expected.py b/plugins/cmd/ndpgen/testdata/counter_client_expected.py new file mode 100644 index 000000000..872d407bb --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_client_expected.py @@ -0,0 +1,49 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Counter host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "counter_count") +def _counter_count(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def counter_count(name: str) -> int: + """Call the counter_count host function. + + Args: + name: str parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _counter_count(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return response.get("value", 0) diff --git a/plugins/cmd/ndpgen/testdata/counter_client_expected.rs b/plugins/cmd/ndpgen/testdata/counter_client_expected.rs new file mode 100644 index 000000000..a58dd8e1e --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_client_expected.rs @@ -0,0 +1,45 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Counter host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CounterCountRequest { + name: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CounterCountResponse { + #[serde(default)] + value: i32, +} + +#[host_fn] +extern "ExtismHost" { + fn counter_count(input: Json) -> Json; +} + +/// Calls the counter_count host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// +/// # Returns +/// The value value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn count(name: &str) -> Result { + let response = unsafe { + counter_count(Json(CounterCountRequest { + name: name.to_owned(), + }))? + }; + + Ok(response.0.value) +} diff --git a/plugins/cmd/ndpgen/testdata/counter_expected.go.txt b/plugins/cmd/ndpgen/testdata/counter_expected.go.txt new file mode 100644 index 000000000..7fd1cbb84 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_expected.go.txt @@ -0,0 +1,83 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// CounterCountRequest is the request type for Counter.Count. +type CounterCountRequest struct { + Name string `json:"name"` +} + +// CounterCountResponse is the response type for Counter.Count. +type CounterCountResponse struct { + Value int32 `json:"value,omitempty"` +} + +// RegisterCounterHostFunctions registers Counter service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterCounterHostFunctions(service CounterService) []extism.HostFunction { + return []extism.HostFunction{ + newCounterCountHostFunction(service), + } +} + +func newCounterCountHostFunction(service CounterService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "counter_count", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + counterWriteError(p, stack, err) + return + } + var req CounterCountRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + counterWriteError(p, stack, err) + return + } + + // Call the service method + value := service.Count(ctx, req.Name) + + // Write JSON response to plugin memory + resp := CounterCountResponse{ + Value: value, + } + counterWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// counterWriteResponse writes a JSON response to plugin memory. +func counterWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + counterWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// counterWriteError writes an error response to plugin memory. +func counterWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/counter_service.go.txt b/plugins/cmd/ndpgen/testdata/counter_service.go.txt new file mode 100644 index 000000000..456599031 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/counter_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Counter permission=counter +type CounterService interface { + //nd:hostfunc + Count(ctx context.Context, name string) (value int32) +} diff --git a/plugins/cmd/ndpgen/testdata/echo_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/echo_client_expected.go.txt new file mode 100644 index 000000000..7a495acf4 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_client_expected.go.txt @@ -0,0 +1,63 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Echo host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// echo_echo is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user echo_echo +func echo_echo(uint64) uint64 + +type echoEchoRequest struct { + Message string `json:"message"` +} + +type echoEchoResponse struct { + Reply string `json:"reply,omitempty"` + Error string `json:"error,omitempty"` +} + +// EchoEcho calls the echo_echo host function. +func EchoEcho(message string) (string, error) { + // Marshal request to JSON + req := echoEchoRequest{ + Message: message, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := echo_echo(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response echoEchoResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Reply, nil +} diff --git a/plugins/cmd/ndpgen/testdata/echo_client_expected.py b/plugins/cmd/ndpgen/testdata/echo_client_expected.py new file mode 100644 index 000000000..06565b0d6 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_client_expected.py @@ -0,0 +1,52 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Echo host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "echo_echo") +def _echo_echo(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def echo_echo(message: str) -> str: + """Call the echo_echo host function. + + Args: + message: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "message": message, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _echo_echo(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("reply", "") diff --git a/plugins/cmd/ndpgen/testdata/echo_client_expected.rs b/plugins/cmd/ndpgen/testdata/echo_client_expected.rs new file mode 100644 index 000000000..0b97ca1cd --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_client_expected.rs @@ -0,0 +1,51 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Echo host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct EchoEchoRequest { + message: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct EchoEchoResponse { + #[serde(default)] + reply: String, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn echo_echo(input: Json) -> Json; +} + +/// Calls the echo_echo host function. +/// +/// # Arguments +/// * `message` - String parameter. +/// +/// # Returns +/// The reply value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn echo(message: &str) -> Result { + let response = unsafe { + echo_echo(Json(EchoEchoRequest { + message: message.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.reply) +} diff --git a/plugins/cmd/ndpgen/testdata/echo_expected.go.txt b/plugins/cmd/ndpgen/testdata/echo_expected.go.txt new file mode 100644 index 000000000..d67854abf --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_expected.go.txt @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// EchoEchoRequest is the request type for Echo.Echo. +type EchoEchoRequest struct { + Message string `json:"message"` +} + +// EchoEchoResponse is the response type for Echo.Echo. +type EchoEchoResponse struct { + Reply string `json:"reply,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterEchoHostFunctions registers Echo service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterEchoHostFunctions(service EchoService) []extism.HostFunction { + return []extism.HostFunction{ + newEchoEchoHostFunction(service), + } +} + +func newEchoEchoHostFunction(service EchoService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "echo_echo", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + echoWriteError(p, stack, err) + return + } + var req EchoEchoRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + echoWriteError(p, stack, err) + return + } + + // Call the service method + reply, svcErr := service.Echo(ctx, req.Message) + if svcErr != nil { + echoWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := EchoEchoResponse{ + Reply: reply, + } + echoWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// echoWriteResponse writes a JSON response to plugin memory. +func echoWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + echoWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// echoWriteError writes an error response to plugin memory. +func echoWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/echo_service.go.txt b/plugins/cmd/ndpgen/testdata/echo_service.go.txt new file mode 100644 index 000000000..42a1e9572 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/echo_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Echo permission=echo +type EchoService interface { + //nd:hostfunc + Echo(ctx context.Context, message string) (reply string, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/list_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/list_client_expected.go.txt new file mode 100644 index 000000000..ea825ee43 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_client_expected.go.txt @@ -0,0 +1,70 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the List host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Filter represents the Filter data structure. +type Filter struct { + Active bool `json:"active"` +} + +// list_items is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user list_items +func list_items(uint64) uint64 + +type listItemsRequest struct { + Name string `json:"name"` + Filter Filter `json:"filter"` +} + +type listItemsResponse struct { + Count int32 `json:"count,omitempty"` + Error string `json:"error,omitempty"` +} + +// ListItems calls the list_items host function. +func ListItems(name string, filter Filter) (int32, error) { + // Marshal request to JSON + req := listItemsRequest{ + Name: name, + Filter: filter, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := list_items(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response listItemsResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Count, nil +} diff --git a/plugins/cmd/ndpgen/testdata/list_client_expected.py b/plugins/cmd/ndpgen/testdata/list_client_expected.py new file mode 100644 index 000000000..58ccad146 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_client_expected.py @@ -0,0 +1,54 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the List host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "list_items") +def _list_items(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def list_items(name: str, filter: Any) -> int: + """Call the list_items host function. + + Args: + name: str parameter. + filter: Any parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + "filter": filter, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _list_items(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("count", 0) diff --git a/plugins/cmd/ndpgen/testdata/list_client_expected.rs b/plugins/cmd/ndpgen/testdata/list_client_expected.rs new file mode 100644 index 000000000..9b54f7544 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_client_expected.rs @@ -0,0 +1,60 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the List host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Filter { + pub active: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ListItemsRequest { + name: String, + filter: Filter, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ListItemsResponse { + #[serde(default)] + count: i32, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn list_items(input: Json) -> Json; +} + +/// Calls the list_items host function. +/// +/// # Arguments +/// * `name` - String parameter. +/// * `filter` - Filter parameter. +/// +/// # Returns +/// The count value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn items(name: &str, filter: Filter) -> Result { + let response = unsafe { + list_items(Json(ListItemsRequest { + name: name.to_owned(), + filter: filter, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.count) +} diff --git a/plugins/cmd/ndpgen/testdata/list_expected.go.txt b/plugins/cmd/ndpgen/testdata/list_expected.go.txt new file mode 100644 index 000000000..778f3a409 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_expected.go.txt @@ -0,0 +1,89 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// ListItemsRequest is the request type for List.Items. +type ListItemsRequest struct { + Name string `json:"name"` + Filter Filter `json:"filter"` +} + +// ListItemsResponse is the response type for List.Items. +type ListItemsResponse struct { + Count int32 `json:"count,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterListHostFunctions registers List service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterListHostFunctions(service ListService) []extism.HostFunction { + return []extism.HostFunction{ + newListItemsHostFunction(service), + } +} + +func newListItemsHostFunction(service ListService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "list_items", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + listWriteError(p, stack, err) + return + } + var req ListItemsRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + listWriteError(p, stack, err) + return + } + + // Call the service method + count, svcErr := service.Items(ctx, req.Name, req.Filter) + if svcErr != nil { + listWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ListItemsResponse{ + Count: count, + } + listWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// listWriteResponse writes a JSON response to plugin memory. +func listWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + listWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// listWriteError writes an error response to plugin memory. +func listWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/list_service.go.txt b/plugins/cmd/ndpgen/testdata/list_service.go.txt new file mode 100644 index 000000000..ff3a42e01 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/list_service.go.txt @@ -0,0 +1,13 @@ +package testpkg + +import "context" + +type Filter struct { + Active bool +} + +//nd:hostservice name=List permission=list +type ListService interface { + //nd:hostfunc + Items(ctx context.Context, name string, filter Filter) (count int32, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/math_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/math_client_expected.go.txt new file mode 100644 index 000000000..9b95b50e9 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_client_expected.go.txt @@ -0,0 +1,65 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Math host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// math_add is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user math_add +func math_add(uint64) uint64 + +type mathAddRequest struct { + A int32 `json:"a"` + B int32 `json:"b"` +} + +type mathAddResponse struct { + Result int32 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// MathAdd calls the math_add host function. +func MathAdd(a int32, b int32) (int32, error) { + // Marshal request to JSON + req := mathAddRequest{ + A: a, + B: b, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := math_add(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response mathAddResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/cmd/ndpgen/testdata/math_client_expected.py b/plugins/cmd/ndpgen/testdata/math_client_expected.py new file mode 100644 index 000000000..f3ea53335 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_client_expected.py @@ -0,0 +1,54 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Math host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "math_add") +def _math_add(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def math_add(a: int, b: int) -> int: + """Call the math_add host function. + + Args: + a: int parameter. + b: int parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "a": a, + "b": b, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _math_add(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", 0) diff --git a/plugins/cmd/ndpgen/testdata/math_client_expected.rs b/plugins/cmd/ndpgen/testdata/math_client_expected.rs new file mode 100644 index 000000000..fde6a7cb9 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_client_expected.rs @@ -0,0 +1,54 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Math host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct MathAddRequest { + a: i32, + b: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct MathAddResponse { + #[serde(default)] + result: i32, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn math_add(input: Json) -> Json; +} + +/// Calls the math_add host function. +/// +/// # Arguments +/// * `a` - i32 parameter. +/// * `b` - i32 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn add(a: i32, b: i32) -> Result { + let response = unsafe { + math_add(Json(MathAddRequest { + a: a, + b: b, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/math_expected.go.txt b/plugins/cmd/ndpgen/testdata/math_expected.go.txt new file mode 100644 index 000000000..48a2bf875 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_expected.go.txt @@ -0,0 +1,89 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// MathAddRequest is the request type for Math.Add. +type MathAddRequest struct { + A int32 `json:"a"` + B int32 `json:"b"` +} + +// MathAddResponse is the response type for Math.Add. +type MathAddResponse struct { + Result int32 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterMathHostFunctions registers Math service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterMathHostFunctions(service MathService) []extism.HostFunction { + return []extism.HostFunction{ + newMathAddHostFunction(service), + } +} + +func newMathAddHostFunction(service MathService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "math_add", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + mathWriteError(p, stack, err) + return + } + var req MathAddRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + mathWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Add(ctx, req.A, req.B) + if svcErr != nil { + mathWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := MathAddResponse{ + Result: result, + } + mathWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// mathWriteResponse writes a JSON response to plugin memory. +func mathWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + mathWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// mathWriteError writes an error response to plugin memory. +func mathWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/math_service.go.txt b/plugins/cmd/ndpgen/testdata/math_service.go.txt new file mode 100644 index 000000000..66776b1da --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/math_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Math permission=math +type MathService interface { + //nd:hostfunc + Add(ctx context.Context, a int32, b int32) (result int32, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/meta_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/meta_client_expected.go.txt new file mode 100644 index 000000000..4147f35f1 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_client_expected.go.txt @@ -0,0 +1,105 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Meta host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// meta_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user meta_get +func meta_get(uint64) uint64 + +// meta_set is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user meta_set +func meta_set(uint64) uint64 + +type metaGetRequest struct { + Key string `json:"key"` +} + +type metaGetResponse struct { + Value any `json:"value,omitempty"` + Error string `json:"error,omitempty"` +} + +type metaSetRequest struct { + Data map[string]any `json:"data"` +} + +// MetaGet calls the meta_get host function. +func MetaGet(key string) (any, error) { + // Marshal request to JSON + req := metaGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := meta_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response metaGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Value, nil +} + +// MetaSet calls the meta_set host function. +func MetaSet(data map[string]any) error { + // Marshal request to JSON + req := metaSetRequest{ + Data: data, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := meta_set(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/cmd/ndpgen/testdata/meta_client_expected.py b/plugins/cmd/ndpgen/testdata/meta_client_expected.py new file mode 100644 index 000000000..4d20c73ff --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_client_expected.py @@ -0,0 +1,81 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Meta host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "meta_get") +def _meta_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "meta_set") +def _meta_set(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def meta_get(key: str) -> Any: + """Call the meta_get host function. + + Args: + key: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _meta_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("value", None) + + +def meta_set(data: Any) -> None: + """Call the meta_set host function. + + Args: + data: Any parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "data": data, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _meta_set(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/cmd/ndpgen/testdata/meta_client_expected.rs b/plugins/cmd/ndpgen/testdata/meta_client_expected.rs new file mode 100644 index 000000000..79b95ffb3 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_client_expected.rs @@ -0,0 +1,86 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Meta host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct MetaGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct MetaGetResponse { + #[serde(default)] + value: serde_json::Value, + #[serde(default)] + error: Option, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct MetaSetRequest { + data: std::collections::HashMap, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct MetaSetResponse { + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn meta_get(input: Json) -> Json; + fn meta_set(input: Json) -> Json; +} + +/// Calls the meta_get host function. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The value value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result { + let response = unsafe { + meta_get(Json(MetaGetRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.value) +} + +/// Calls the meta_set host function. +/// +/// # Arguments +/// * `data` - std::collections::HashMap parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set(data: std::collections::HashMap) -> Result<(), Error> { + let response = unsafe { + meta_set(Json(MetaSetRequest { + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/cmd/ndpgen/testdata/meta_expected.go.txt b/plugins/cmd/ndpgen/testdata/meta_expected.go.txt new file mode 100644 index 000000000..6f660fd65 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_expected.go.txt @@ -0,0 +1,130 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// MetaGetRequest is the request type for Meta.Get. +type MetaGetRequest struct { + Key string `json:"key"` +} + +// MetaGetResponse is the response type for Meta.Get. +type MetaGetResponse struct { + Value any `json:"value,omitempty"` + Error string `json:"error,omitempty"` +} + +// MetaSetRequest is the request type for Meta.Set. +type MetaSetRequest struct { + Data map[string]any `json:"data"` +} + +// MetaSetResponse is the response type for Meta.Set. +type MetaSetResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterMetaHostFunctions registers Meta service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterMetaHostFunctions(service MetaService) []extism.HostFunction { + return []extism.HostFunction{ + newMetaGetHostFunction(service), + newMetaSetHostFunction(service), + } +} + +func newMetaGetHostFunction(service MetaService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "meta_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + metaWriteError(p, stack, err) + return + } + var req MetaGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + metaWriteError(p, stack, err) + return + } + + // Call the service method + value, svcErr := service.Get(ctx, req.Key) + if svcErr != nil { + metaWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := MetaGetResponse{ + Value: value, + } + metaWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newMetaSetHostFunction(service MetaService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "meta_set", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + metaWriteError(p, stack, err) + return + } + var req MetaSetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + metaWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Set(ctx, req.Data); svcErr != nil { + metaWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := MetaSetResponse{} + metaWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// metaWriteResponse writes a JSON response to plugin memory. +func metaWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + metaWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// metaWriteError writes an error response to plugin memory. +func metaWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/meta_service.go.txt b/plugins/cmd/ndpgen/testdata/meta_service.go.txt new file mode 100644 index 000000000..a7b23ecea --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/meta_service.go.txt @@ -0,0 +1,11 @@ +package testpkg + +import "context" + +//nd:hostservice name=Meta permission=meta +type MetaService interface { + //nd:hostfunc + Get(ctx context.Context, key string) (value interface{}, err error) + //nd:hostfunc + Set(ctx context.Context, data map[string]any) error +} diff --git a/plugins/cmd/ndpgen/testdata/ping_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/ping_client_expected.go.txt new file mode 100644 index 000000000..be9668314 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_client_expected.go.txt @@ -0,0 +1,46 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Ping host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// ping_ping is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user ping_ping +func ping_ping(uint64) uint64 + +// PingPing calls the ping_ping host function. +func PingPing() error { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := ping_ping(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/cmd/ndpgen/testdata/ping_client_expected.py b/plugins/cmd/ndpgen/testdata/ping_client_expected.py new file mode 100644 index 000000000..4c7d41d8e --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_client_expected.py @@ -0,0 +1,42 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Ping host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "ping_ping") +def _ping_ping(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def ping_ping() -> None: + """Call the ping_ping host function. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _ping_ping(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/cmd/ndpgen/testdata/ping_client_expected.rs b/plugins/cmd/ndpgen/testdata/ping_client_expected.rs new file mode 100644 index 000000000..a40f10843 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_client_expected.rs @@ -0,0 +1,35 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Ping host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct PingPingResponse { + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn ping_ping(input: Json) -> Json; +} + +/// Calls the ping_ping host function. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn ping() -> Result<(), Error> { + let response = unsafe { + ping_ping(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/cmd/ndpgen/testdata/ping_expected.go.txt b/plugins/cmd/ndpgen/testdata/ping_expected.go.txt new file mode 100644 index 000000000..0b0253817 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_expected.go.txt @@ -0,0 +1,68 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// PingPingResponse is the response type for Ping.Ping. +type PingPingResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterPingHostFunctions registers Ping service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterPingHostFunctions(service PingService) []extism.HostFunction { + return []extism.HostFunction{ + newPingPingHostFunction(service), + } +} + +func newPingPingHostFunction(service PingService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "ping_ping", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + if svcErr := service.Ping(ctx); svcErr != nil { + pingWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := PingPingResponse{} + pingWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// pingWriteResponse writes a JSON response to plugin memory. +func pingWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + pingWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// pingWriteError writes an error response to plugin memory. +func pingWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/ping_service.go.txt b/plugins/cmd/ndpgen/testdata/ping_service.go.txt new file mode 100644 index 000000000..c6bd1f489 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/ping_service.go.txt @@ -0,0 +1,9 @@ +package testpkg + +import "context" + +//nd:hostservice name=Ping permission=ping +type PingService interface { + //nd:hostfunc + Ping(ctx context.Context) error +} diff --git a/plugins/cmd/ndpgen/testdata/search_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/search_client_expected.go.txt new file mode 100644 index 000000000..6ea002cf3 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_client_expected.go.txt @@ -0,0 +1,69 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Search host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Result represents the Result data structure. +type Result struct { + ID string `json:"id"` +} + +// search_find is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user search_find +func search_find(uint64) uint64 + +type searchFindRequest struct { + Query string `json:"query"` +} + +type searchFindResponse struct { + Results []Result `json:"results,omitempty"` + Total int32 `json:"total,omitempty"` + Error string `json:"error,omitempty"` +} + +// SearchFind calls the search_find host function. +func SearchFind(query string) ([]Result, int32, error) { + // Marshal request to JSON + req := searchFindRequest{ + Query: query, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := search_find(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response searchFindResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, 0, errors.New(response.Error) + } + + return response.Results, response.Total, nil +} diff --git a/plugins/cmd/ndpgen/testdata/search_client_expected.py b/plugins/cmd/ndpgen/testdata/search_client_expected.py new file mode 100644 index 000000000..aa2e98a36 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_client_expected.py @@ -0,0 +1,62 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Search host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "search_find") +def _search_find(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class SearchFindResult: + """Result type for search_find.""" + results: Any + total: int + + +def search_find(query: str) -> SearchFindResult: + """Call the search_find host function. + + Args: + query: str parameter. + + Returns: + SearchFindResult containing results, total,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "query": query, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _search_find(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return SearchFindResult( + results=response.get("results", None), + total=response.get("total", 0), + ) diff --git a/plugins/cmd/ndpgen/testdata/search_client_expected.rs b/plugins/cmd/ndpgen/testdata/search_client_expected.rs new file mode 100644 index 000000000..b0ab2505a --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_client_expected.rs @@ -0,0 +1,59 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Search host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Result { + pub id: String, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SearchFindRequest { + query: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SearchFindResponse { + #[serde(default)] + results: Vec, + #[serde(default)] + total: i32, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn search_find(input: Json) -> Json; +} + +/// Calls the search_find host function. +/// +/// # Arguments +/// * `query` - String parameter. +/// +/// # Returns +/// A tuple of (results, total). +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn find(query: &str) -> Result<(Vec, i32), Error> { + let response = unsafe { + search_find(Json(SearchFindRequest { + query: query.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok((response.0.results, response.0.total)) +} diff --git a/plugins/cmd/ndpgen/testdata/search_expected.go.txt b/plugins/cmd/ndpgen/testdata/search_expected.go.txt new file mode 100644 index 000000000..6c316266f --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_expected.go.txt @@ -0,0 +1,90 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// SearchFindRequest is the request type for Search.Find. +type SearchFindRequest struct { + Query string `json:"query"` +} + +// SearchFindResponse is the response type for Search.Find. +type SearchFindResponse struct { + Results []Result `json:"results,omitempty"` + Total int32 `json:"total,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterSearchHostFunctions registers Search service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterSearchHostFunctions(service SearchService) []extism.HostFunction { + return []extism.HostFunction{ + newSearchFindHostFunction(service), + } +} + +func newSearchFindHostFunction(service SearchService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "search_find", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + searchWriteError(p, stack, err) + return + } + var req SearchFindRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + searchWriteError(p, stack, err) + return + } + + // Call the service method + results, total, svcErr := service.Find(ctx, req.Query) + if svcErr != nil { + searchWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SearchFindResponse{ + Results: results, + Total: total, + } + searchWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// searchWriteResponse writes a JSON response to plugin memory. +func searchWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + searchWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// searchWriteError writes an error response to plugin memory. +func searchWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/search_service.go.txt b/plugins/cmd/ndpgen/testdata/search_service.go.txt new file mode 100644 index 000000000..03a081966 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/search_service.go.txt @@ -0,0 +1,13 @@ +package testpkg + +import "context" + +type Result struct { + ID string +} + +//nd:hostservice name=Search permission=search +type SearchService interface { + //nd:hostfunc + Find(ctx context.Context, query string) (results []Result, total int32, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/store_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/store_client_expected.go.txt new file mode 100644 index 000000000..89618026c --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_client_expected.go.txt @@ -0,0 +1,69 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Store host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Item represents the Item data structure. +type Item struct { + ID string `json:"id"` + Name string `json:"name"` +} + +// store_save is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user store_save +func store_save(uint64) uint64 + +type storeSaveRequest struct { + Item Item `json:"item"` +} + +type storeSaveResponse struct { + Id string `json:"id,omitempty"` + Error string `json:"error,omitempty"` +} + +// StoreSave calls the store_save host function. +func StoreSave(item Item) (string, error) { + // Marshal request to JSON + req := storeSaveRequest{ + Item: item, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := store_save(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response storeSaveResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Id, nil +} diff --git a/plugins/cmd/ndpgen/testdata/store_client_expected.py b/plugins/cmd/ndpgen/testdata/store_client_expected.py new file mode 100644 index 000000000..4a964a497 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_client_expected.py @@ -0,0 +1,52 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Store host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "store_save") +def _store_save(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def store_save(item: Any) -> str: + """Call the store_save host function. + + Args: + item: Any parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "item": item, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _store_save(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("id", "") diff --git a/plugins/cmd/ndpgen/testdata/store_client_expected.rs b/plugins/cmd/ndpgen/testdata/store_client_expected.rs new file mode 100644 index 000000000..25d2af2e0 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_client_expected.rs @@ -0,0 +1,58 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Store host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Item { + pub id: String, + pub name: String, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct StoreSaveRequest { + item: Item, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct StoreSaveResponse { + #[serde(default)] + id: String, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn store_save(input: Json) -> Json; +} + +/// Calls the store_save host function. +/// +/// # Arguments +/// * `item` - Item parameter. +/// +/// # Returns +/// The id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn save(item: Item) -> Result { + let response = unsafe { + store_save(Json(StoreSaveRequest { + item: item, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.id) +} diff --git a/plugins/cmd/ndpgen/testdata/store_expected.go.txt b/plugins/cmd/ndpgen/testdata/store_expected.go.txt new file mode 100644 index 000000000..07537ca41 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_expected.go.txt @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// StoreSaveRequest is the request type for Store.Save. +type StoreSaveRequest struct { + Item Item `json:"item"` +} + +// StoreSaveResponse is the response type for Store.Save. +type StoreSaveResponse struct { + Id string `json:"id,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterStoreHostFunctions registers Store service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterStoreHostFunctions(service StoreService) []extism.HostFunction { + return []extism.HostFunction{ + newStoreSaveHostFunction(service), + } +} + +func newStoreSaveHostFunction(service StoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "store_save", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + storeWriteError(p, stack, err) + return + } + var req StoreSaveRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + storeWriteError(p, stack, err) + return + } + + // Call the service method + id, svcErr := service.Save(ctx, req.Item) + if svcErr != nil { + storeWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := StoreSaveResponse{ + Id: id, + } + storeWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// storeWriteResponse writes a JSON response to plugin memory. +func storeWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + storeWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// storeWriteError writes an error response to plugin memory. +func storeWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/store_service.go.txt b/plugins/cmd/ndpgen/testdata/store_service.go.txt new file mode 100644 index 000000000..c2ff69740 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/store_service.go.txt @@ -0,0 +1,14 @@ +package testpkg + +import "context" + +type Item struct { + ID string + Name string +} + +//nd:hostservice name=Store permission=store +type StoreService interface { + //nd:hostfunc + Save(ctx context.Context, item Item) (id string, err error) +} diff --git a/plugins/cmd/ndpgen/testdata/users_client_expected.go.txt b/plugins/cmd/ndpgen/testdata/users_client_expected.go.txt new file mode 100644 index 000000000..ddd71f3dc --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_client_expected.go.txt @@ -0,0 +1,71 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package ndhost + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// User represents the User data structure. +type User struct { + ID string `json:"id"` + Name string `json:"name"` +} + +// users_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user users_get +func users_get(uint64) uint64 + +type usersGetRequest struct { + Id *string `json:"id"` + Filter *User `json:"filter"` +} + +type usersGetResponse struct { + Result *User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// UsersGet calls the users_get host function. +func UsersGet(id *string, filter *User) (*User, error) { + // Marshal request to JSON + req := usersGetRequest{ + Id: id, + Filter: filter, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := users_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response usersGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/cmd/ndpgen/testdata/users_client_expected.py b/plugins/cmd/ndpgen/testdata/users_client_expected.py new file mode 100644 index 000000000..468b87b98 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_client_expected.py @@ -0,0 +1,54 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Users host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "users_get") +def _users_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def users_get(id: Any, filter: Any) -> Any: + """Call the users_get host function. + + Args: + id: Any parameter. + filter: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "filter": filter, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _users_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/cmd/ndpgen/testdata/users_client_expected.rs b/plugins/cmd/ndpgen/testdata/users_client_expected.rs new file mode 100644 index 000000000..40daa9cfd --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_client_expected.rs @@ -0,0 +1,61 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct User { + pub id: String, + pub name: String, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetRequest { + id: Option, + filter: Option, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetResponse { + #[serde(default)] + result: Option, + #[serde(default)] + error: Option, +} + +#[host_fn] +extern "ExtismHost" { + fn users_get(input: Json) -> Json; +} + +/// Calls the users_get host function. +/// +/// # Arguments +/// * `id` - Option parameter. +/// * `filter` - Option parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(id: Option, filter: Option) -> Result, Error> { + let response = unsafe { + users_get(Json(UsersGetRequest { + id: id, + filter: filter, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/cmd/ndpgen/testdata/users_expected.go.txt b/plugins/cmd/ndpgen/testdata/users_expected.go.txt new file mode 100644 index 000000000..1b0fbfa93 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_expected.go.txt @@ -0,0 +1,89 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package testpkg + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// UsersGetRequest is the request type for Users.Get. +type UsersGetRequest struct { + Id *string `json:"id"` + Filter *User `json:"filter"` +} + +// UsersGetResponse is the response type for Users.Get. +type UsersGetResponse struct { + Result *User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterUsersHostFunctions registers Users service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterUsersHostFunctions(service UsersService) []extism.HostFunction { + return []extism.HostFunction{ + newUsersGetHostFunction(service), + } +} + +func newUsersGetHostFunction(service UsersService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "users_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + usersWriteError(p, stack, err) + return + } + var req UsersGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + usersWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Get(ctx, req.Id, req.Filter) + if svcErr != nil { + usersWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := UsersGetResponse{ + Result: result, + } + usersWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// usersWriteResponse writes a JSON response to plugin memory. +func usersWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + usersWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// usersWriteError writes an error response to plugin memory. +func usersWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/cmd/ndpgen/testdata/users_service.go.txt b/plugins/cmd/ndpgen/testdata/users_service.go.txt new file mode 100644 index 000000000..cb8db8c12 --- /dev/null +++ b/plugins/cmd/ndpgen/testdata/users_service.go.txt @@ -0,0 +1,14 @@ +package testpkg + +import "context" + +type User struct { + ID string + Name string +} + +//nd:hostservice name=Users permission=users +type UsersService interface { + //nd:hostfunc + Get(ctx context.Context, id *string, filter *User) (*User, error) +} diff --git a/plugins/cmd/ndpgen/tools.go b/plugins/cmd/ndpgen/tools.go new file mode 100644 index 000000000..961d4e805 --- /dev/null +++ b/plugins/cmd/ndpgen/tools.go @@ -0,0 +1,8 @@ +//go:build tools + +// This file ensures the extism/go-pdk dependency stays in go.mod. +// The PDK parser loads this package at runtime using go/packages. +// Without this import, `go mod tidy` would remove it since it's not directly imported elsewhere. +package main + +import _ "github.com/extism/go-pdk" diff --git a/plugins/config_validation.go b/plugins/config_validation.go new file mode 100644 index 000000000..d75f9ee7c --- /dev/null +++ b/plugins/config_validation.go @@ -0,0 +1,129 @@ +package plugins + +import ( + "encoding/json" + "errors" + "fmt" + "strings" + + "github.com/santhosh-tekuri/jsonschema/v6" +) + +// ConfigValidationError represents a validation error with field path and message. +type ConfigValidationError struct { + Field string `json:"field"` + Message string `json:"message"` +} + +// ConfigValidationErrors is a collection of validation errors. +type ConfigValidationErrors struct { + Errors []ConfigValidationError `json:"errors"` +} + +func (e *ConfigValidationErrors) Error() string { + if len(e.Errors) == 0 { + return "validation failed" + } + var msgs []string + for _, err := range e.Errors { + if err.Field != "" { + msgs = append(msgs, fmt.Sprintf("%s: %s", err.Field, err.Message)) + } else { + msgs = append(msgs, err.Message) + } + } + return strings.Join(msgs, "; ") +} + +// ValidateConfig validates a config JSON string against a plugin's config schema. +// If the manifest has no config schema, it returns an error indicating the plugin +// has no configurable options. +// Returns nil if validation passes, ConfigValidationErrors if validation fails. +func ValidateConfig(manifest *Manifest, configJSON string) error { + // If no config schema defined, plugin has no configurable options + if !manifest.HasConfigSchema() { + return fmt.Errorf("plugin has no configurable options") + } + + // Parse the config JSON (empty string treated as empty object) + var configData any + if configJSON == "" { + configData = map[string]any{} + } else { + if err := json.Unmarshal([]byte(configJSON), &configData); err != nil { + return &ConfigValidationErrors{ + Errors: []ConfigValidationError{{ + Message: fmt.Sprintf("invalid JSON: %v", err), + }}, + } + } + } + + // Compile the schema + compiler := jsonschema.NewCompiler() + if err := compiler.AddResource("schema.json", manifest.Config.Schema); err != nil { + return fmt.Errorf("adding schema resource: %w", err) + } + + schema, err := compiler.Compile("schema.json") + if err != nil { + return fmt.Errorf("compiling schema: %w", err) + } + + // Validate config against schema + if err := schema.Validate(configData); err != nil { + return convertValidationError(err) + } + + return nil +} + +// convertValidationError converts jsonschema validation errors to our format. +func convertValidationError(err error) *ConfigValidationErrors { + var validationErr *jsonschema.ValidationError + if !errors.As(err, &validationErr) { + return &ConfigValidationErrors{ + Errors: []ConfigValidationError{{ + Message: err.Error(), + }}, + } + } + + var configErrors []ConfigValidationError + collectErrors(validationErr, &configErrors) + + if len(configErrors) == 0 { + configErrors = append(configErrors, ConfigValidationError{ + Message: validationErr.Error(), + }) + } + + return &ConfigValidationErrors{Errors: configErrors} +} + +// collectErrors recursively collects validation errors from the error tree. +func collectErrors(err *jsonschema.ValidationError, errors *[]ConfigValidationError) { + // If there are child errors, collect from them + if len(err.Causes) > 0 { + for _, cause := range err.Causes { + collectErrors(cause, errors) + } + return + } + + // Leaf error - add it + field := "" + if len(err.InstanceLocation) > 0 { + field = strings.Join(err.InstanceLocation, "/") + } + + *errors = append(*errors, ConfigValidationError{ + Field: field, + Message: err.Error(), + }) +} + +// HasConfigSchema returns true if the manifest defines a config schema. +func (m *Manifest) HasConfigSchema() bool { + return m.Config != nil && m.Config.Schema != nil +} diff --git a/plugins/config_validation_test.go b/plugins/config_validation_test.go new file mode 100644 index 000000000..b430c0b31 --- /dev/null +++ b/plugins/config_validation_test.go @@ -0,0 +1,184 @@ +package plugins + +import ( + "errors" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Config Validation", func() { + Describe("ValidateConfig", func() { + Context("when manifest has no config schema", func() { + It("returns an error", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + } + err := ValidateConfig(manifest, `{"key": "value"}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no configurable options")) + }) + }) + + Context("when manifest has config schema", func() { + var manifest *Manifest + + BeforeEach(func() { + manifest = &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "apiKey": map[string]any{ + "type": "string", + "description": "API key for the service", + "minLength": float64(1), + }, + "timeout": map[string]any{ + "type": "integer", + "minimum": float64(1), + "maximum": float64(300), + }, + "enabled": map[string]any{ + "type": "boolean", + }, + }, + "required": []any{"apiKey"}, + }, + }, + } + }) + + It("accepts valid config", func() { + err := ValidateConfig(manifest, `{"apiKey": "secret123", "timeout": 30}`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("rejects empty config when required fields are missing", func() { + err := ValidateConfig(manifest, "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + + err = ValidateConfig(manifest, "{}") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + }) + + It("rejects config missing required field", func() { + err := ValidateConfig(manifest, `{"timeout": 30}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + }) + + It("rejects config with wrong type", func() { + err := ValidateConfig(manifest, `{"apiKey": "secret", "timeout": "not a number"}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("timeout")) + }) + + It("rejects config with value out of range", func() { + err := ValidateConfig(manifest, `{"apiKey": "secret", "timeout": 500}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("timeout")) + }) + + It("rejects config with empty required string", func() { + err := ValidateConfig(manifest, `{"apiKey": ""}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("apiKey")) + }) + + It("rejects invalid JSON", func() { + err := ValidateConfig(manifest, `{invalid json}`) + Expect(err).To(HaveOccurred()) + var validationErr *ConfigValidationErrors + Expect(errors.As(err, &validationErr)).To(BeTrue()) + Expect(validationErr.Errors[0].Message).To(ContainSubstring("invalid JSON")) + }) + }) + + Context("with enum values", func() { + It("accepts valid enum value", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "logLevel": map[string]any{ + "type": "string", + "enum": []any{"debug", "info", "warn", "error"}, + }, + }, + }, + }, + } + err := ValidateConfig(manifest, `{"logLevel": "info"}`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("rejects invalid enum value", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "logLevel": map[string]any{ + "type": "string", + "enum": []any{"debug", "info", "warn", "error"}, + }, + }, + }, + }, + } + err := ValidateConfig(manifest, `{"logLevel": "verbose"}`) + Expect(err).To(HaveOccurred()) + }) + }) + }) + + Describe("HasConfigSchema", func() { + It("returns false when config is nil", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + } + Expect(manifest.HasConfigSchema()).To(BeFalse()) + }) + + It("returns false when schema is nil", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{}, + } + Expect(manifest.HasConfigSchema()).To(BeFalse()) + }) + + It("returns true when schema is present", func() { + manifest := &Manifest{ + Name: "test", + Author: "test", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + }, + }, + } + Expect(manifest.HasConfigSchema()).To(BeTrue()) + }) + }) +}) diff --git a/plugins/examples/Makefile b/plugins/examples/Makefile new file mode 100644 index 000000000..c8a62ab0c --- /dev/null +++ b/plugins/examples/Makefile @@ -0,0 +1,98 @@ +# Build example plugins for Navidrome +# Auto-discover all plugin folders (folders containing go.mod) +PLUGINS := $(patsubst %/go.mod,%,$(wildcard */go.mod)) + +# Auto-discover Python plugins (folders containing plugin/__init__.py) +PYTHON_PLUGINS := $(patsubst %/plugin/__init__.py,%,$(wildcard */plugin/__init__.py)) + +# Auto-discover Rust plugins (folders containing Cargo.toml) +RUST_PLUGINS := $(patsubst %/Cargo.toml,%,$(wildcard */Cargo.toml)) + +# Prefer tinygo if available, it produces smaller wasm binaries. +TINYGO := $(shell command -v tinygo 2> /dev/null) +EXTISM_PY := $(shell command -v extism-py 2> /dev/null) + +# PDK source files that trigger rebuild when changed (recursive) +PDK_GO_SOURCES := $(shell find ../pdk/go -name '*.go' 2>/dev/null) +PDK_PY_SOURCES := $(shell find ../pdk/python -name '*.py' 2>/dev/null) +PDK_RS_SOURCES := $(shell find ../pdk/rust -name '*.rs' 2>/dev/null) + +# Allow building plugins without .ndp extension (e.g., make minimal instead of make minimal.ndp) +.PHONY: $(PLUGINS) $(PYTHON_PLUGINS) $(RUST_PLUGINS) +$(PLUGINS): %: %.ndp +$(PYTHON_PLUGINS): %: %.ndp +$(RUST_PLUGINS): %: %.ndp + +# Default target: show available plugins +.DEFAULT_GOAL := help + +help: + @echo "Available Go plugins:" + @$(foreach p,$(PLUGINS),echo " $(p)";) + @echo "" + @echo "Available Python plugins:" + @$(foreach p,$(PYTHON_PLUGINS),echo " $(p)";) + @echo "" + @echo "Available Rust plugins:" + @$(foreach p,$(RUST_PLUGINS),echo " $(p)";) + @echo "" + @echo "Usage:" + @echo " make Build a specific plugin (e.g., make $(firstword $(PLUGINS)))" + @echo " make all Build all plugins" + @echo " make all-go Build all Go plugins" + @echo " make all-python Build all Python plugins (requires extism-py)" + @echo " make all-rust Build all Rust plugins (requires cargo)" + @echo " make clean Remove all built plugins (.ndp and .wasm files)" + +all: all-go all-python all-rust + +all-go: $(PLUGINS:%=%.ndp) + +all-python: $(PYTHON_PLUGINS:%=%.ndp) + +all-rust: $(RUST_PLUGINS:%=%.ndp) + +clean: + rm -f $(PLUGINS:%=%.ndp) $(PYTHON_PLUGINS:%=%.ndp) $(RUST_PLUGINS:%=%.ndp) + rm -f $(PLUGINS:%=%.wasm) $(PYTHON_PLUGINS:%=%.wasm) $(RUST_PLUGINS:%=%.wasm) + @$(foreach p,$(RUST_PLUGINS),(cd $(p) && cargo clean 2>/dev/null) || true;) + +# Mark .wasm files as intermediate so Make deletes them after building .ndp +.INTERMEDIATE: $(PLUGINS:%=%.wasm) $(PYTHON_PLUGINS:%=%.wasm) $(RUST_PLUGINS:%=%.wasm) + +# Build .ndp package from .wasm and manifest.json +# Go plugins +%.ndp: %.wasm %/manifest.json + @rm -f $@ + @cp $< plugin.wasm + zip -j $@ $*/manifest.json plugin.wasm + @rm -f plugin.wasm + @mv $< $<.tmp && mv $<.tmp $< # Touch wasm to ensure it's older than ndp + +# Use secondary expansion to properly track all Go source files +.SECONDEXPANSION: +$(PLUGINS:%=%.wasm): %.wasm: $$(shell find % -name '*.go' 2>/dev/null) %/go.mod $(PDK_GO_SOURCES) +ifdef TINYGO + cd $* && tinygo build -target wasip1 -buildmode=c-shared -o ../$@ . +else + cd $* && GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o ../$@ . +endif + +# Python plugin builds (generic rule for any folder with plugin/__init__.py) +# Use secondary expansion to get all .py files in the plugin directory as dependencies +.SECONDEXPANSION: +$(PYTHON_PLUGINS:%=%.wasm): %.wasm: $$(wildcard %/plugin/*.py) $(PDK_PY_SOURCES) +ifndef EXTISM_PY + $(error extism-py is not installed. Install from https://github.com/extism/python-pdk) +endif + cd $* && PYTHONPATH=plugin extism-py plugin/__init__.py -o ../$@ + +# Rust plugin builds (generic rule for any folder with Cargo.toml) +# Note: Rust crate names use underscores, but plugin names use hyphens +# All Rust plugins use wasm32-wasip1 for WASI support (filesystem, etc.) +RUST_TARGET := wasm32-wasip1 +RUSTUP_CARGO := $(shell rustup which cargo 2>/dev/null || echo cargo) +RUSTUP_RUSTC := $(shell rustup which rustc 2>/dev/null) +$(RUST_PLUGINS:%=%.wasm): %.wasm: %/Cargo.toml $$(wildcard %/src/*.rs) $(PDK_RS_SOURCES) + cd $* && CARGO_BUILD_RUSTC=$(RUSTUP_RUSTC) $(RUSTUP_CARGO) build --release --target $(RUST_TARGET) + cp $*/target/$(RUST_TARGET)/release/$(subst -,_,$*).wasm $@ diff --git a/plugins/examples/README.md b/plugins/examples/README.md new file mode 100644 index 000000000..bce2b6762 --- /dev/null +++ b/plugins/examples/README.md @@ -0,0 +1,180 @@ +# Navidrome Plugin Examples + +This folder contains example plugins demonstrating various capabilities and languages supported by Navidrome's plugin system. + +## Available Examples + +| Plugin | Language | Capabilities | Description | +|-------------------------------------------------------|----------|-------------------------------------------------|--------------------------------| +| [minimal](minimal/) | Go | MetadataAgent | Basic plugin structure | +| [wikimedia](wikimedia/) | Go | MetadataAgent | Wikidata/Wikipedia metadata | +| [crypto-ticker](crypto-ticker/) | Go | Scheduler, WebSocket, Cache | Real-time crypto prices (demo) | +| [coverartarchive-py](coverartarchive-py/) | Python | MetadataAgent | Cover Art Archive | +| [nowplaying-py](nowplaying-py/) | Python | Scheduler, SubsonicAPI | Now playing logger | +| [webhook-rs](webhook-rs/) | Rust | Scrobbler | HTTP webhook on scrobble | +| [library-inspector-rs](library-inspector-rs/) | Rust | Library, Scheduler | Periodic library stats logging | +| [discord-rich-presence-rs](discord-rich-presence-rs/) | Rust | Scrobbler, Scheduler, WebSocket, Cache, Artwork | Discord integration (Rust) | + +## Building + +### Prerequisites + +- **Go plugins:** [TinyGo](https://tinygo.org/getting-started/install/) 0.30+ +- **Python plugins:** [extism-py](https://github.com/extism/python-pdk) +- **Rust plugins:** [Rust](https://rustup.rs/) with `wasm32-unknown-unknown` target + +### Build All Plugins + +```bash +make all +``` + +This creates `.ndp` package files for each plugin. + +### Build Individual Plugin + +```bash +make minimal.ndp +make wikimedia.ndp +make discord-rich-presence-rs.ndp +``` + +### Clean + +```bash +make clean +``` + +## Testing Plugins + +### With Extism CLI + +Test any plugin without running Navidrome. First extract the `.wasm` file from the `.ndp` package: + +```bash +# Install: https://extism.org/docs/install + +# Extract the wasm file from the package +unzip -p minimal.ndp plugin.wasm > minimal.wasm + +# Test a capability function +extism call minimal.wasm nd_get_artist_biography --wasi \ + --input '{"id":"1","name":"The Beatles"}' +``` + +For plugins that make HTTP requests, allow the hosts: + +```bash +unzip -p wikimedia.ndp plugin.wasm > wikimedia.wasm +extism call wikimedia.wasm nd_get_artist_biography --wasi \ + --input '{"id":"1","name":"Yussef Dayes"}' \ + --allow-host "query.wikidata.org" \ + --allow-host "en.wikipedia.org" +``` + +### With Navidrome + +1. Copy the `.ndp` file to your plugins folder +2. Enable plugins in `navidrome.toml`: + ```toml + [Plugins] + Enabled = true + Folder = "/path/to/plugins" + ``` +3. For metadata agents, add to your agents list: + ```toml + Agents = "lastfm,spotify,wikimedia" + ``` + +## Creating Your Own Plugin + +### Option 1: Start from Minimal + +Copy the [minimal](minimal/) example and modify: + +```bash +cp -r minimal my-plugin +cd my-plugin +# Edit main.go and manifest.json +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . +zip -j my-plugin.ndp manifest.json plugin.wasm +``` + +### Option 2: Bootstrap with XTP CLI + +Generate boilerplate from a schema: + +```bash +# Install XTP: https://docs.xtp.dylibso.com/docs/cli + +xtp plugin init \ + --schema-file ../schemas/metadata_agent.yaml \ + --template go \ + --path ./my-plugin \ + --name my-plugin + +# Then create manifest.json and package +cd my-plugin +xtp plugin build +zip -j my-plugin.ndp manifest.json dist/plugin.wasm +``` + +Available schemas in [../schemas/](../schemas/): +- `metadata_agent.yaml` – Artist/album metadata +- `scrobbler.yaml` – Scrobbling integration +- `lifecycle.yaml` – Init callbacks +- `scheduler_callback.yaml` – Scheduled tasks +- `websocket_callback.yaml` – WebSocket events + +### Option 3: Different Language + +See language-specific examples: +- **Python:** [coverartarchive-py](coverartarchive-py/) +- **Rust:** [webhook-rs](webhook-rs/) + +## Example Breakdown + +### Minimal (Go) + +The simplest possible plugin. Shows: +- Manifest export +- Single capability function +- Basic input/output handling + +### Wikimedia (Go) + +Real-world metadata agent. Shows: +- HTTP requests to external APIs +- SPARQL queries (Wikidata) +- Error handling +- Host allowlisting + +### Discord Rich Presence (Go) + +Complex multi-capability plugin. Shows: +- **Scrobbler** – Receives play events +- **WebSocket** – Maintains Discord gateway connection +- **Scheduler** – Heartbeat and timeout management +- **Cache** – Connection state storage +- **Artwork** – Getting album art URLs + +### Cover Art Archive (Python) + +Python metadata agent. Shows: +- extism-py plugin structure +- HTTP requests +- JSON handling + +### Webhook (Rust) + +Rust scrobbler. Shows: +- extism-rs plugin structure +- HTTP POST requests +- Minimal dependencies + +## Resources + +- [Plugin System Documentation](../README.md) +- [Extism PDK Docs](https://extism.org/docs/concepts/pdk) +- [TinyGo WebAssembly](https://tinygo.org/docs/guides/webassembly/) +- [XTP CLI](https://docs.xtp.dylibso.com/docs/cli) diff --git a/plugins/examples/coverartarchive-py/Makefile b/plugins/examples/coverartarchive-py/Makefile new file mode 100644 index 000000000..e3cd60d1c --- /dev/null +++ b/plugins/examples/coverartarchive-py/Makefile @@ -0,0 +1,27 @@ +# Build the Cover Art Archive Python plugin +.PHONY: build test clean + +WASM_FILE = coverartarchive-py.wasm + +build: $(WASM_FILE) + +$(WASM_FILE): plugin/__init__.py + extism-py plugin/__init__.py -o $(WASM_FILE) + +test: build + @echo "Testing nd_manifest..." + extism call $(WASM_FILE) nd_manifest --wasi + @echo "" + @echo "Testing nd_get_album_images with Portishead's Dummy MBID..." + extism call $(WASM_FILE) nd_get_album_images --wasi \ + --input '{"name":"Dummy","artist":"Portishead","mbid":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}' \ + --allow-host "coverartarchive.org" --allow-host "archive.org" + +test-error: build + @echo "Testing error case (missing MBID)..." + -extism call $(WASM_FILE) nd_get_album_images --wasi \ + --input '{"name":"Test Album","artist":"Test Artist"}' \ + --allow-host "coverartarchive.org" + +clean: + rm -f $(WASM_FILE) diff --git a/plugins/examples/coverartarchive-py/README.md b/plugins/examples/coverartarchive-py/README.md new file mode 100644 index 000000000..77957ac4f --- /dev/null +++ b/plugins/examples/coverartarchive-py/README.md @@ -0,0 +1,73 @@ +# Cover Art Archive Plugin (Python) + +A Python example plugin that fetches album cover images from the [Cover Art Archive](https://coverartarchive.org/) API using the MusicBrainz Release MBID. + +## Features + +- Implements the `nd_get_album_images` method of the MetadataAgent plugin interface +- Returns front cover images for a given release MBID +- Returns `not found` if no MBID is provided or no images are found +- Demonstrates Python plugin development for Navidrome + +## Prerequisites + +- [extism-py](https://github.com/extism/python-pdk) - Python PDK compiler + ```bash + curl -Ls https://raw.githubusercontent.com/extism/python-pdk/main/install.sh | bash + ``` + +> **Note:** `extism-py` requires [Binaryen](https://github.com/WebAssembly/binaryen/) (`wasm-merge`, `wasm-opt`) to be installed. + +## Building + +From the `plugins/examples` directory: + +```bash +make coverartarchive-py.ndp +``` + +Or directly: + +```bash +extism-py plugin/__init__.py -o plugin.wasm +zip -j coverartarchive-py.ndp manifest.json plugin.wasm +``` + +## Installation + +1. Copy `coverartarchive-py.ndp` to your Navidrome plugins folder + +2. Enable plugins in `navidrome.toml`: + ```toml + [Plugins] + Enabled = true + Folder = "/path/to/plugins" + ``` + +3. Add to your agents list: + ```toml + Agents = "coverartarchive-py,spotify,lastfm" + ``` + +## Testing + +Extract the wasm file and test: + +```bash +unzip -p coverartarchive-py.ndp plugin.wasm > coverartarchive-py.wasm +extism call coverartarchive-py.wasm nd_get_album_images --wasi \ + --input '{"name":"Dummy","artist":"Portishead","mbid":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}' \ + --allow-host "coverartarchive.org" --allow-host "archive.org" +``` + +## How It Works + +1. **Album Image Request (`nd_get_album_images`)**: Receives album metadata including the MusicBrainz Release MBID. + +2. **API Query**: Fetches cover art metadata from `https://coverartarchive.org/release/{mbid}`. + +3. **Response**: Returns the front cover image URL if found. + +## API Reference + +- [Cover Art Archive API](https://musicbrainz.org/doc/Cover_Art_Archive/API) diff --git a/plugins/examples/coverartarchive-py/manifest.json b/plugins/examples/coverartarchive-py/manifest.json new file mode 100644 index 000000000..c9a52ba07 --- /dev/null +++ b/plugins/examples/coverartarchive-py/manifest.json @@ -0,0 +1,16 @@ +{ + "name": "Cover Art Archive (Python)", + "author": "Navidrome", + "version": "1.0.0", + "description": "Album cover art from the Cover Art Archive - Python example", + "website": "https://coverartarchive.org", + "permissions": { + "http": { + "reason": "Fetch album cover art from Cover Art Archive API", + "requiredHosts": [ + "coverartarchive.org", + "*.archive.org" + ] + } + } +} diff --git a/plugins/examples/coverartarchive-py/plugin/__init__.py b/plugins/examples/coverartarchive-py/plugin/__init__.py new file mode 100644 index 000000000..3c1d4149e --- /dev/null +++ b/plugins/examples/coverartarchive-py/plugin/__init__.py @@ -0,0 +1,105 @@ +# Cover Art Archive Plugin for Navidrome +# +# This plugin fetches album cover art from the Cover Art Archive (https://coverartarchive.org/) +# using the MusicBrainz album MBID. +# +# Build with: +# extism-py plugin/__init__.py -o coverartarchive-py.wasm +# +# Test with: +# extism call coverartarchive-py.wasm nd_get_album_images --wasi \ +# --input '{"name":"Dummy","artist":"Portishead","mbid":"76df3287-6cda-33eb-8e9a-044b5e15ffdd"}' \ +# --allow-host "coverartarchive.org" --allow-host "archive.org" + +import extism +import json + + +@extism.plugin_fn +def nd_get_album_images(): + """Retrieve album cover images from Cover Art Archive.""" + input_data = extism.input_json() + mbid = input_data.get("mbid", "") + + if not mbid: + raise Exception("not found: MBID required") + + # Query Cover Art Archive API + url = f"https://coverartarchive.org/release/{mbid}" + response = extism.Http.request(url, meth="GET") + + if response.status_code != 200: + raise Exception(f"not found: CAA returned status {response.status_code}") + + try: + data = json.loads(response.data_str()) + except json.JSONDecodeError: + raise Exception("not found: invalid JSON response") + + caa_images = data.get("images", []) + if not caa_images: + raise Exception("not found: no images in response") + + # Find the front cover image + front_image = find_front_image(caa_images) + if not front_image: + raise Exception("not found: no front cover image") + + # Build the response with available image sizes + images = build_image_list(front_image) + if not images: + raise Exception("not found: no usable image URLs") + + extism.output_str(json.dumps({"images": images})) + + +def find_front_image(images): + """Find the front cover image from CAA response.""" + # First, look for an image explicitly marked as front + for img in images: + if img.get("front", False): + return img + + # Second, look for an image with "Front" in types + for img in images: + types = img.get("types", []) + if "Front" in types: + return img + + # Fallback to first image + if images: + return images[0] + + return None + + +def build_image_list(img): + """Build list of images with URLs and sizes from CAA image data.""" + images = [] + thumbnails = img.get("thumbnails", {}) + + # First, try numeric sizes (250, 500, 1200, etc.) + for size_str, url in thumbnails.items(): + if not url: + continue + try: + size = int(size_str) + images.append({"url": url, "size": size}) + except ValueError: + pass # Not a numeric size + + # If no numeric sizes, fallback to named sizes + if not images: + size_map = {"large": 500, "small": 250} + for size_name, size in size_map.items(): + url = thumbnails.get(size_name) + if url: + images.append({"url": url, "size": size}) + + # If still no images, use the main image URL + if not images: + main_url = img.get("image") + if main_url: + images.append({"url": main_url, "size": 0}) + + return images diff --git a/plugins/examples/crypto-ticker/README.md b/plugins/examples/crypto-ticker/README.md new file mode 100644 index 000000000..7f23433f5 --- /dev/null +++ b/plugins/examples/crypto-ticker/README.md @@ -0,0 +1,91 @@ +# Crypto Ticker Plugin + +This is a WebSocket-based WASM plugin for Navidrome that displays real-time cryptocurrency prices from Coinbase. + +## Features + +- Connects to Coinbase WebSocket API to receive real-time ticker updates +- Configurable to track multiple cryptocurrency pairs +- Implements WebSocket callback handlers for message processing +- Automatically reconnects on connection loss using the scheduler service +- Displays price, best bid, best ask, and 24-hour percentage change + +## Configuration + +Configure in the Navidrome UI (Settings → Plugins → crypto-ticker): + +| Key | Description | Default | +|-----------|----------------------------------------------------------------------|-----------| +| `tickers` | Comma-separated list of cryptocurrency symbols (e.g., `BTC,ETH,SOL`) | `BTC,ETH` | + +The plugin will append `-USD` to any symbol without a trading pair specified. + +## How it Works + +1. On plugin initialization, connects to Coinbase's WebSocket API +2. Subscribes to ticker updates for the configured cryptocurrencies +3. Incoming ticker data is processed via `nd_websocket_on_text_message` callback +4. On connection loss, schedules a reconnection attempt via the scheduler service +5. Reconnection is attempted until successful + +## Building + +To build the plugin and package as `.ndp`: + +```bash +# Using TinyGo (recommended - smaller binary) +tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . +zip -j crypto-ticker.ndp manifest.json plugin.wasm +``` + +Or from the `plugins/examples/` directory: + +```bash +make crypto-ticker.ndp +``` + +## Installation + +Copy the resulting `crypto-ticker.ndp` to your Navidrome plugins folder. + +## Example Output + +``` +[Crypto] Crypto Ticker Plugin initializing... +[Crypto] Configured tickers: [BTC-USD ETH-USD] +[Crypto] Connected to Coinbase WebSocket API (connection: crypto-ticker-conn) +[Crypto] Subscription message sent to Coinbase WebSocket API +[Crypto] Received subscriptions message +[Crypto] 💰 BTC-USD: $98765.43 (24h: +2.35%) Bid: $98764.00 Ask: $98766.00 +[Crypto] 💰 ETH-USD: $3456.78 (24h: -0.54%) Bid: $3455.90 Ask: $3457.80 +``` + +## Permissions Required + +- **config**: Read ticker symbols configuration +- **websocket**: Connect to `ws-feed.exchange.coinbase.com` +- **scheduler**: Schedule reconnection attempts + +## Files + +- `main.go` - Main plugin implementation +- `go.mod` - Go module file + +## PDK + +This plugin imports the Navidrome PDK subpackages directly: + +```go +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" + "github.com/navidrome/navidrome/plugins/pdk/go/websocket" +) +``` + +The `go.mod` file uses `replace` directives to point to the local packages for development. + +--- + +For more details, see the source code in `main.go`. diff --git a/plugins/examples/crypto-ticker/go.mod b/plugins/examples/crypto-ticker/go.mod new file mode 100755 index 000000000..f2884679a --- /dev/null +++ b/plugins/examples/crypto-ticker/go.mod @@ -0,0 +1,16 @@ +module crypto-ticker + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/examples/crypto-ticker/go.sum b/plugins/examples/crypto-ticker/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/examples/crypto-ticker/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/examples/crypto-ticker/main.go b/plugins/examples/crypto-ticker/main.go new file mode 100755 index 000000000..8fc189128 --- /dev/null +++ b/plugins/examples/crypto-ticker/main.go @@ -0,0 +1,302 @@ +// Crypto Ticker Plugin - Demonstrates WebSocket host service capabilities. +// +// This plugin connects to Coinbase's WebSocket API to receive real-time +// cryptocurrency price updates and logs them to the Navidrome console. +package main + +import ( + "encoding/json" + "fmt" + "strings" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" + "github.com/navidrome/navidrome/plugins/pdk/go/websocket" +) + +const ( + // Coinbase WebSocket API endpoint + coinbaseWSEndpoint = "wss://ws-feed.exchange.coinbase.com" + + // Connection ID for our WebSocket connection + connectionID = "crypto-ticker-conn" + + // ID for the reconnection schedule + reconnectScheduleID = "crypto-ticker-reconnect" + + // Config keys (must match manifest.json schema property names) + symbolsKey = "symbols" + reconnectDelayKey = "reconnectDelay" + logPricesKey = "logPrices" + + // Default values + defaultReconnectDelay = 5 +) + +// CoinbaseSubscription message structure +type CoinbaseSubscription struct { + Type string `json:"type"` + ProductIDs []string `json:"product_ids"` + Channels []string `json:"channels"` +} + +// CoinbaseTicker message structure +type CoinbaseTicker struct { + Type string `json:"type"` + Sequence int64 `json:"sequence"` + ProductID string `json:"product_id"` + Price string `json:"price"` + Open24h string `json:"open_24h"` + Volume24h string `json:"volume_24h"` + Low24h string `json:"low_24h"` + High24h string `json:"high_24h"` + BestBid string `json:"best_bid"` + BestAsk string `json:"best_ask"` + Time string `json:"time"` +} + +// cryptoTickerPlugin implements the lifecycle, websocket and scheduler interfaces. +type cryptoTickerPlugin struct{} + +// init registers the plugin capabilities +func init() { + lifecycle.Register(&cryptoTickerPlugin{}) + websocket.Register(&cryptoTickerPlugin{}) + scheduler.Register(&cryptoTickerPlugin{}) +} + +// Ensure cryptoTickerPlugin implements the required provider interfaces +var ( + _ lifecycle.InitProvider = (*cryptoTickerPlugin)(nil) + _ websocket.TextMessageProvider = (*cryptoTickerPlugin)(nil) + _ websocket.BinaryMessageProvider = (*cryptoTickerPlugin)(nil) + _ websocket.ErrorProvider = (*cryptoTickerPlugin)(nil) + _ websocket.CloseProvider = (*cryptoTickerPlugin)(nil) + _ scheduler.CallbackProvider = (*cryptoTickerPlugin)(nil) +) + +// OnInit is called when the plugin is loaded. +// We use this to establish the initial WebSocket connection. +func (p *cryptoTickerPlugin) OnInit() error { + pdk.Log(pdk.LogInfo, "Crypto Ticker Plugin initializing...") + + // Get ticker configuration from JSON schema config + symbols := getSymbols() + pdk.Log(pdk.LogInfo, fmt.Sprintf("Configured symbols: %v", symbols)) + + // Connect to WebSocket + // Errors won't fail init - reconnect logic will handle it + return connectAndSubscribe(symbols) +} + +// getSymbols reads the symbols array from config +func getSymbols() []string { + defaultSymbols := []string{"BTC-USD"} + symbolsJSON, ok := pdk.GetConfig(symbolsKey) + if !ok || symbolsJSON == "" { + return defaultSymbols + } + + var symbols []string + if err := json.Unmarshal([]byte(symbolsJSON), &symbols); err != nil { + pdk.Log(pdk.LogWarn, fmt.Sprintf("failed to parse symbols config: %v, using defaults", err)) + return defaultSymbols + } + + if len(symbols) == 0 { + return defaultSymbols + } + + // Normalize symbols - add -USD suffix if not present + for i, s := range symbols { + s = strings.TrimSpace(s) + if !strings.Contains(s, "-") { + symbols[i] = s + "-USD" + } else { + symbols[i] = s + } + } + + return symbols +} + +// getReconnectDelay reads the reconnect delay from config +func getReconnectDelay() int32 { + delayStr, ok := pdk.GetConfig(reconnectDelayKey) + if !ok || delayStr == "" { + return defaultReconnectDelay + } + + var delay int + if _, err := fmt.Sscanf(delayStr, "%d", &delay); err != nil || delay < 1 { + return defaultReconnectDelay + } + return int32(delay) +} + +// shouldLogPrices reads the logPrices setting from config +func shouldLogPrices() bool { + logStr, ok := pdk.GetConfig(logPricesKey) + if !ok || logStr == "" { + return false + } + return logStr == "true" +} + +// connectAndSubscribe connects to Coinbase WebSocket and subscribes to tickers +func connectAndSubscribe(tickers []string) error { + // Connect to WebSocket using host function + newConnID, err := host.WebSocketConnect(coinbaseWSEndpoint, nil, connectionID) + if err != nil { + return fmt.Errorf("WebSocket connection error: %w", err) + } + pdk.Log(pdk.LogInfo, fmt.Sprintf("Connected to Coinbase WebSocket API (connection: %s)", newConnID)) + + // Subscribe to ticker channel + subscription := CoinbaseSubscription{ + Type: "subscribe", + ProductIDs: tickers, + Channels: []string{"ticker"}, + } + + subscriptionJSON, err := json.Marshal(subscription) + if err != nil { + return fmt.Errorf("JSON marshal error: %v", err) + } + + // Send subscription message + err = host.WebSocketSendText(connectionID, string(subscriptionJSON)) + if err != nil { + return fmt.Errorf("WebSocket send error: %w", err) + } + + pdk.Log(pdk.LogInfo, "Subscription message sent to Coinbase WebSocket API") + return nil +} + +// OnTextMessage is called when a text message is received +func (p *cryptoTickerPlugin) OnTextMessage(input websocket.OnTextMessageRequest) error { + // Only process messages from our connection + if input.ConnectionID != connectionID { + return nil + } + + // Try to parse as a ticker message + var ticker CoinbaseTicker + err := json.Unmarshal([]byte(input.Message), &ticker) + if err != nil { + // Not a valid JSON message, ignore + return nil + } + + // Only process ticker messages + if ticker.Type != "ticker" { + // Could be subscription confirmation or heartbeat + if ticker.Type != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Received %s message", ticker.Type)) + } + return nil + } + + // Calculate 24h change percentage + change := calculatePercentChange(ticker.Open24h, ticker.Price) + + // Log ticker information (only if enabled in config) + if shouldLogPrices() { + pdk.Log(pdk.LogInfo, fmt.Sprintf("💰 %s: $%s (24h: %s%%) Bid: $%s Ask: $%s", + ticker.ProductID, + ticker.Price, + change, + ticker.BestBid, + ticker.BestAsk, + )) + } + + return nil +} + +// OnBinaryMessage is called when a binary message is received +func (p *cryptoTickerPlugin) OnBinaryMessage(input websocket.OnBinaryMessageRequest) error { + // Coinbase doesn't send binary messages, but we implement the handler anyway + pdk.Log(pdk.LogWarn, fmt.Sprintf("Received unexpected binary message on connection %s", input.ConnectionID)) + return nil +} + +// OnError is called when an error occurs on the WebSocket connection +func (p *cryptoTickerPlugin) OnError(input websocket.OnErrorRequest) error { + pdk.Log(pdk.LogError, fmt.Sprintf("WebSocket error on connection %s: %s", input.ConnectionID, input.Error)) + return nil +} + +// OnClose is called when the WebSocket connection is closed +func (p *cryptoTickerPlugin) OnClose(input websocket.OnCloseRequest) error { + pdk.Log(pdk.LogInfo, fmt.Sprintf("WebSocket connection %s closed (code: %d, reason: %s)", + input.ConnectionID, input.Code, input.Reason)) + + // Only attempt reconnect for our connection + if input.ConnectionID == connectionID { + delay := getReconnectDelay() + pdk.Log(pdk.LogInfo, fmt.Sprintf("Scheduling reconnection attempt in %d seconds...", delay)) + + // Schedule a one-time reconnection attempt + _, err := host.SchedulerScheduleOneTime(delay, "reconnect", reconnectScheduleID) + if err != nil { + pdk.Log(pdk.LogError, fmt.Sprintf("Failed to schedule reconnection: %v", err)) + } + } + + return nil +} + +// OnCallback is called when a scheduled task fires +func (p *cryptoTickerPlugin) OnCallback(input scheduler.SchedulerCallbackRequest) error { + // Only handle our reconnection schedule + if input.ScheduleID != reconnectScheduleID { + return nil + } + + pdk.Log(pdk.LogInfo, "Attempting to reconnect to Coinbase WebSocket API...") + + // Get ticker configuration + symbols := getSymbols() + + // Try to connect and subscribe + err := connectAndSubscribe(symbols) + if err != nil { + delay := getReconnectDelay() * 2 // Double delay on failure + pdk.Log(pdk.LogError, fmt.Sprintf("Reconnection failed: %v - will retry in %d seconds", err, delay)) + + // Schedule another attempt + _, err := host.SchedulerScheduleOneTime(delay, "reconnect", reconnectScheduleID) + if err != nil { + pdk.Log(pdk.LogError, fmt.Sprintf("Failed to schedule retry: %v", err)) + } + } else { + pdk.Log(pdk.LogInfo, "Successfully reconnected!") + } + + return nil +} + +// calculatePercentChange calculates the percentage change between open and current price +func calculatePercentChange(open, current string) string { + var openFloat, currentFloat float64 + _, err := fmt.Sscanf(open, "%f", &openFloat) + if err != nil || openFloat == 0 { + return "N/A" + } + _, err = fmt.Sscanf(current, "%f", ¤tFloat) + if err != nil { + return "N/A" + } + + change := ((currentFloat - openFloat) / openFloat) * 100 + if change >= 0 { + return fmt.Sprintf("+%.2f", change) + } + return fmt.Sprintf("%.2f", change) +} + +func main() {} diff --git a/plugins/examples/crypto-ticker/manifest.json b/plugins/examples/crypto-ticker/manifest.json new file mode 100644 index 000000000..362fcd0e9 --- /dev/null +++ b/plugins/examples/crypto-ticker/manifest.json @@ -0,0 +1,71 @@ +{ + "name": "Crypto Ticker", + "author": "Navidrome", + "version": "1.0.0", + "description": "Real-time cryptocurrency price ticker using Coinbase WebSocket API", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/crypto-ticker", + "config": { + "schema": { + "type": "object", + "properties": { + "symbols": { + "type": "array", + "title": "Trading Pairs", + "description": "Cryptocurrency trading pairs to track (default: BTC-USD)", + "items": { + "type": "string", + "title": "Trading Pair", + "pattern": "^[A-Z]{3,5}-[A-Z]{3,5}$", + "description": "Trading pair in the format BASE-QUOTE (e.g., BTC-USD, ETH-USD)" + }, + "default": ["BTC-USD"] + }, + "reconnectDelay": { + "type": "integer", + "title": "Reconnect Delay", + "description": "Delay in seconds before attempting to reconnect after connection loss", + "default": 5, + "minimum": 1, + "maximum": 60 + }, + "logPrices": { + "type": "boolean", + "title": "Log Prices", + "description": "Whether to log price updates to the server log", + "default": false + } + } + }, + "uiSchema": { + "type": "VerticalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/symbols" + }, + { + "type": "HorizontalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/reconnectDelay" + }, + { + "type": "Control", + "scope": "#/properties/logPrices" + } + ] + } + ] + } + }, + "permissions": { + "scheduler": { + "reason": "To schedule reconnection attempts on connection loss" + }, + "websocket": { + "reason": "To connect to Coinbase WebSocket API for real-time prices", + "requiredHosts": ["ws-feed.exchange.coinbase.com"] + } + } +} diff --git a/plugins/examples/discord-rich-presence-rs/.cargo/config.toml b/plugins/examples/discord-rich-presence-rs/.cargo/config.toml new file mode 100644 index 000000000..6b509f5b7 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/.cargo/config.toml @@ -0,0 +1,2 @@ +[build] +target = "wasm32-wasip1" diff --git a/plugins/examples/discord-rich-presence-rs/Cargo.toml b/plugins/examples/discord-rich-presence-rs/Cargo.toml new file mode 100644 index 000000000..bc473147d --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "discord-rich-presence-rs" +version = "1.0.0" +edition = "2021" +description = "Discord Rich Presence plugin for Navidrome - Rust implementation" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/examples/discord-rich-presence-rs/README.md b/plugins/examples/discord-rich-presence-rs/README.md new file mode 100644 index 000000000..5cd973af0 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/README.md @@ -0,0 +1,100 @@ +# Discord Rich Presence Plugin (Rust) + +A Navidrome plugin that displays your currently playing track on Discord using Rich Presence. This is the Rust implementation demonstrating how to use the `nd-pdk` library. + +## ⚠️ Warning + +This plugin is for **demonstration purposes only**. It requires storing your Discord token in the Navidrome configuration file, which: + +1. Is not secure (tokens should never be stored in plain text) +2. May violate Discord's Terms of Service + +**Use at your own risk.** + +## Features + +- Shows currently playing track on Discord Rich Presence +- Displays album artwork +- Shows track progress with start/end timestamps +- Automatically clears presence when track finishes +- Supports multiple users + +## Capabilities + +This plugin implements multiple capabilities to demonstrate the nd-pdk library: + +- **Scrobbler**: Receives now-playing events from Navidrome +- **SchedulerCallback**: Handles heartbeat and activity clearing timers +- **WebSocketCallback**: Communicates with Discord gateway (text, binary, error, and close handlers) + +## Configuration + +Configure in the Navidrome UI (Settings → Plugins → discord-rich-presence-rs): + +| Key | Description | Example | +|---------------|--------------------------------------|---------------------------| +| `clientid` | Your Discord application ID | `123456789012345678` | +| `user.` | Discord token for the specified user | `user.alice` = `token123` | + +Each user is configured as a separate key with the `user.` prefix. + + +### Getting Configuration Values + +1. **Client ID**: Create a Discord Application at https://discord.com/developers/applications and copy the Application ID + +2. **Discord Token**: This requires extracting your user token from Discord (not recommended for security reasons) + +3. **Multiple Users**: Add multiple user keys: + ```properties + user.user1 = "token1" + user.user2 = "token2" + ``` + +## Building + +```bash +# From the plugins/examples directory +make discord-rich-presence-rs.ndp + +# This creates discord-rich-presence-rs.ndp containing: +# - manifest.json +# - plugin.wasm +``` + +## Installation + +1. Build the plugin using the command above +2. Copy the `.ndp` file to your Navidrome plugins directory +3. Enable and configure the plugin in the Navidrome UI (Settings → Plugins) +4. Restart Navidrome if needed + +## Using nd-pdk Library + +This plugin demonstrates how to use the Rust plugin development kit: + +```rust +use nd_pdk::host::{artwork, cache, scheduler, websocket}; +use std::collections::HashMap; + +// Get artwork URL +let url = artwork::get_track_url(track_id, 300)?; + +// Cache operations +cache::set_string("key", "value", 3600)?; +if let Some(value) = cache::get_string("key")? { + // Use the cached value +} + +// Schedule tasks +scheduler::schedule_one_time(60, "payload", "task-id")?; +scheduler::schedule_recurring("@every 30s", "heartbeat", "heartbeat-task")?; + +// WebSocket operations +let conn_id = websocket::connect("wss://example.com/socket", HashMap::new(), "my-conn")?; +websocket::send_text(&conn_id, "Hello")?; +``` + +## License + +GPL-3.0 diff --git a/plugins/examples/discord-rich-presence-rs/manifest.json b/plugins/examples/discord-rich-presence-rs/manifest.json new file mode 100644 index 000000000..4cf64b557 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/manifest.json @@ -0,0 +1,98 @@ +{ + "name": "Discord Rich Presence (Rust)", + "author": "Navidrome Team", + "version": "1.0.0", + "description": "Discord Rich Presence integration for Navidrome - Rust implementation", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/discord-rich-presence-rs", + "permissions": { + "users": { + "reason": "To process scrobbles on behalf of users" + }, + "http": { + "reason": "To communicate with Discord API for gateway discovery and image uploads", + "requiredHosts": ["discord.com"] + }, + "websocket": { + "reason": "To maintain real-time connection with Discord gateway", + "requiredHosts": ["gateway.discord.gg"] + }, + "cache": { + "reason": "To store connection state and sequence numbers" + }, + "scheduler": { + "reason": "To schedule heartbeat messages and activity clearing" + }, + "artwork": { + "reason": "To get track artwork URLs for rich presence display" + } + }, + "config": { + "schema": { + "type": "object", + "properties": { + "clientid": { + "type": "string", + "title": "Discord Application Client ID", + "description": "The Client ID from your Discord Developer Application. Create one at https://discord.com/developers/applications", + "minLength": 17, + "maxLength": 20, + "pattern": "^[0-9]+$" + }, + "users": { + "type": "array", + "title": "User Tokens", + "description": "Discord tokens for each Navidrome user. WARNING: Store tokens securely!", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "username": { + "type": "string", + "title": "Navidrome Username", + "description": "The Navidrome username to associate with this Discord token", + "minLength": 1 + }, + "token": { + "type": "string", + "title": "Discord Token", + "description": "The user's Discord token (keep this secret!)", + "minLength": 1 + } + }, + "required": ["username", "token"] + } + } + }, + "required": ["clientid", "users"] + }, + "uiSchema": { + "type": "VerticalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/clientid" + }, + { + "type": "Control", + "scope": "#/properties/users", + "options": { + "elementLabelProp": "username", + "detail": { + "type": "HorizontalLayout", + "elements": [ + { + "type": "Control", + "scope": "#/properties/username" + }, + { + "type": "Control", + "scope": "#/properties/token" + } + ] + } + } + } + ] + } + } +} diff --git a/plugins/examples/discord-rich-presence-rs/src/lib.rs b/plugins/examples/discord-rich-presence-rs/src/lib.rs new file mode 100644 index 000000000..12bf9ed3e --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/src/lib.rs @@ -0,0 +1,289 @@ +//! Discord Rich Presence Plugin for Navidrome - Rust Implementation +//! +//! This plugin integrates Navidrome with Discord Rich Presence. It demonstrates how to: +//! - Use the nd-pdk crate for host service calls +//! - Implement the Scrobbler capability for now-playing updates +//! - Implement SchedulerCallback for heartbeat and activity clearing +//! - Implement WebSocketCallback for Discord gateway communication +//! +//! ## Configuration +//! +//! Configure this plugin through the Navidrome UI with: +//! - Discord Application Client ID +//! - User tokens array mapping Navidrome usernames to Discord tokens +//! +//! **WARNING**: This plugin is for demonstration purposes only. Storing Discord tokens +//! in configuration files is not secure and may violate Discord's terms of service. + +use extism_pdk::*; +use nd_pdk::host::{artwork, config, scheduler}; +use nd_pdk::scrobbler::{ + Error as ScrobblerError, IsAuthorizedRequest, NowPlayingRequest, + ScrobbleRequest, Scrobbler, SCROBBLER_ERROR_NOT_AUTHORIZED, SCROBBLER_ERROR_RETRY_LATER, +}; +use nd_pdk::scheduler::{ + CallbackProvider, Error as SchedulerError, SchedulerCallbackRequest, +}; +use nd_pdk::websocket::{ + BinaryMessageProvider, CloseProvider, Error as WebSocketError, ErrorProvider, + OnBinaryMessageRequest, OnCloseRequest, OnErrorRequest, OnTextMessageRequest, + TextMessageProvider, +}; +use serde::Deserialize; + +mod rpc; + +// Register capabilities using PDK macros +nd_pdk::register_scrobbler!(DiscordPlugin); +nd_pdk::register_scheduler_callback!(DiscordPlugin); +nd_pdk::register_websocket_text_message!(DiscordPlugin); +nd_pdk::register_websocket_binary_message!(DiscordPlugin); +nd_pdk::register_websocket_error!(DiscordPlugin); +nd_pdk::register_websocket_close!(DiscordPlugin); + +// ============================================================================ +// Constants +// ============================================================================ + +const CLIENT_ID_KEY: &str = "clientid"; +const USERS_KEY: &str = "users"; +const PAYLOAD_HEARTBEAT: &str = "heartbeat"; +const PAYLOAD_CLEAR_ACTIVITY: &str = "clear-activity"; + +// ============================================================================ +// Plugin Implementation +// ============================================================================ + +/// The Discord Rich Presence plugin type. +#[derive(Default)] +struct DiscordPlugin; + +// ============================================================================ +// Configuration +// ============================================================================ + +/// User token entry from the config schema +#[derive(Debug, Deserialize)] +struct UserToken { + username: String, + token: String, +} + +fn get_config() -> Result<(String, std::collections::HashMap), Error> { + let client_id = config::get(CLIENT_ID_KEY)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("missing clientid in configuration"))?; + + // Get users array from config (JSON format) + let users_json = config::get(USERS_KEY)?.unwrap_or_default(); + + let mut users = std::collections::HashMap::new(); + if !users_json.is_empty() { + // Parse JSON array of user tokens + let user_tokens: Vec = serde_json::from_str(&users_json) + .map_err(|e| Error::msg(format!("failed to parse users config: {}", e)))?; + + for user_token in user_tokens { + if !user_token.username.is_empty() && !user_token.token.is_empty() { + users.insert(user_token.username, user_token.token); + } + } + } + + Ok((client_id, users)) +} + +fn get_image_url(track_id: &str) -> String { + match artwork::get_track_url(track_id, 300) { + Ok(url) => { + if url.starts_with("http://localhost") { + String::new() + } else { + url + } + } + Err(e) => { + warn!("Failed to get artwork URL: {:?}", e); + String::new() + } + } +} + +// ============================================================================ +// Scrobbler Implementation +// ============================================================================ + +impl Scrobbler for DiscordPlugin { + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result { + let (_, users) = match get_config() { + Ok(config) => config, + Err(e) => { + error!("Failed to get config: {:?}", e); + return Ok(false); + } + }; + + let authorized = users.contains_key(&req.username); + info!("IsAuthorized for user {}: {}", req.username, authorized); + Ok(authorized) + } + + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), ScrobblerError> { + info!( + "Setting presence for user {}, track: {}", + req.username, req.track.title + ); + + // Load configuration + let (client_id, users) = get_config() + .map_err(|e| ScrobblerError::new(format!("{}: failed to get config: {:?}", SCROBBLER_ERROR_RETRY_LATER, e)))?; + + // Check authorization + let user_token = users.get(&req.username).cloned().ok_or_else(|| { + ScrobblerError::new(format!( + "{}: user '{}' not authorized", + SCROBBLER_ERROR_NOT_AUTHORIZED, req.username + )) + })?; + + // Connect to Discord + rpc::connect(&req.username, &user_token) + .map_err(|e| ScrobblerError::new(format!( + "{}: failed to connect to Discord: {:?}", + SCROBBLER_ERROR_RETRY_LATER, e + )))?; + + // Cancel any existing completion schedule + let _ = scheduler::cancel_schedule(&format!("{}-clear", req.username)); + + // Calculate timestamps + let now = std::time::SystemTime::now() + .duration_since(std::time::UNIX_EPOCH) + .map(|d| d.as_secs() as i64) + .unwrap_or(0); + let start_time = (now - req.position as i64) * 1000; + let end_time = start_time + (req.track.duration as i64) * 1000; + + // Send activity update + rpc::send_activity( + &client_id, + &req.username, + &user_token, + rpc::Activity { + application: client_id.clone(), + name: "Navidrome".to_string(), + activity_type: 2, // Listening + details: req.track.title.clone(), + state: req.track.artist.clone(), + timestamps: rpc::ActivityTimestamps { + start: start_time, + end: end_time, + }, + assets: rpc::ActivityAssets { + large_image: get_image_url(&req.track.id), + large_text: req.track.album.clone(), + }, + }, + ) + .map_err(|e| ScrobblerError::new(format!( + "{}: failed to send activity: {:?}", + SCROBBLER_ERROR_RETRY_LATER, e + )))?; + + // Schedule a timer to clear the activity after the track completes + let remaining_seconds = (req.track.duration as i32) - req.position + 5; + if let Err(e) = scheduler::schedule_one_time( + remaining_seconds, + PAYLOAD_CLEAR_ACTIVITY, + &format!("{}-clear", req.username), + ) { + warn!("Failed to schedule completion timer: {:?}", e); + } + + Ok(()) + } + + fn scrobble(&self, _req: ScrobbleRequest) -> Result<(), ScrobblerError> { + // Discord Rich Presence doesn't need scrobble events - success + Ok(()) + } +} + +// ============================================================================ +// Scheduler Callback Implementation +// ============================================================================ + +impl CallbackProvider for DiscordPlugin { + fn on_callback(&self, req: SchedulerCallbackRequest) -> Result<(), SchedulerError> { + match req.payload.as_str() { + PAYLOAD_HEARTBEAT => { + // Heartbeat callback - schedule_id is the username + if let Err(e) = rpc::handle_heartbeat_callback(&req.schedule_id) { + // On heartbeat failure, clean up the connection (like the original Go plugin) + // The next NowPlaying call will reconnect if needed + warn!("Heartbeat failed for user {}, cleaning up connection: {:?}", req.schedule_id, e); + rpc::cleanup_connection(&req.schedule_id); + return Err(SchedulerError::new(format!("heartbeat failed, connection cleaned up: {}", e))); + } + } + PAYLOAD_CLEAR_ACTIVITY => { + // Clear activity callback - schedule_id is "username-clear" + let username = req.schedule_id.trim_end_matches("-clear"); + info!("Removing presence for user {}", username); + rpc::handle_clear_activity_callback(username) + .map_err(|e| SchedulerError::new(e.to_string()))?; + info!("Disconnecting user {}", username); + rpc::disconnect(username) + .map_err(|e| SchedulerError::new(e.to_string()))?; + } + _ => { + warn!("Unknown scheduler callback payload: {}", req.payload); + } + } + + Ok(()) + } +} + +// ============================================================================ +// WebSocket Callback Implementations +// ============================================================================ + +impl TextMessageProvider for DiscordPlugin { + fn on_text_message(&self, req: OnTextMessageRequest) -> Result<(), WebSocketError> { + rpc::handle_websocket_message(&req.connection_id, &req.message) + .map_err(|e| WebSocketError::new(e.to_string()))?; + Ok(()) + } +} + +impl BinaryMessageProvider for DiscordPlugin { + fn on_binary_message(&self, _req: OnBinaryMessageRequest) -> Result<(), WebSocketError> { + // Binary messages are not expected from Discord + Ok(()) + } +} + +impl ErrorProvider for DiscordPlugin { + fn on_error(&self, req: OnErrorRequest) -> Result<(), WebSocketError> { + warn!( + "WebSocket error for connection '{}': {}", + req.connection_id, req.error + ); + // Clean up all state associated with this connection since it's likely broken + rpc::handle_connection_close(&req.connection_id); + Ok(()) + } +} + +impl CloseProvider for DiscordPlugin { + fn on_close(&self, req: OnCloseRequest) -> Result<(), WebSocketError> { + info!( + "WebSocket connection '{}' closed with code {}: {}", + req.connection_id, req.code, req.reason + ); + // Clean up all state associated with this connection + rpc::handle_connection_close(&req.connection_id); + Ok(()) + } +} diff --git a/plugins/examples/discord-rich-presence-rs/src/rpc.rs b/plugins/examples/discord-rich-presence-rs/src/rpc.rs new file mode 100644 index 000000000..3de9eff63 --- /dev/null +++ b/plugins/examples/discord-rich-presence-rs/src/rpc.rs @@ -0,0 +1,547 @@ +//! Discord Rich Presence Plugin - RPC Communication +//! +//! This module handles all Discord gateway communication including WebSocket connections, +//! presence updates, and heartbeat management. + +use extism_pdk::*; +use nd_pdk::host::{cache, scheduler, websocket}; +use serde::{Deserialize, Serialize}; + +// ============================================================================ +// Constants +// ============================================================================ + +const HEARTBEAT_OP_CODE: i32 = 1; +const GATE_OP_CODE: i32 = 2; +const PRESENCE_OP_CODE: i32 = 3; +const HEARTBEAT_INTERVAL: i32 = 41; +const DEFAULT_IMAGE: &str = "https://i.imgur.com/hb3XPzA.png"; + +const PAYLOAD_HEARTBEAT: &str = "heartbeat"; + +// ============================================================================ +// Discord Types +// ============================================================================ + +#[derive(Serialize)] +pub struct Activity { + pub name: String, + #[serde(rename = "type")] + pub activity_type: i32, + pub details: String, + pub state: String, + #[serde(rename = "application_id")] + pub application: String, + pub timestamps: ActivityTimestamps, + pub assets: ActivityAssets, +} + +#[derive(Serialize)] +pub struct ActivityTimestamps { + pub start: i64, + pub end: i64, +} + +#[derive(Serialize)] +pub struct ActivityAssets { + pub large_image: String, + pub large_text: String, +} + +#[derive(Serialize)] +struct PresencePayload { + activities: Vec, + since: i64, + status: String, + afk: bool, +} + +#[derive(Serialize)] +struct IdentifyPayload { + token: String, + intents: i32, + properties: IdentifyProperties, +} + +#[derive(Serialize)] +struct IdentifyProperties { + os: String, + browser: String, + device: String, +} + +#[derive(Serialize)] +struct GatewayMessage { + op: i32, + d: T, +} + +#[derive(Deserialize)] +struct GatewayResponse { + op: i32, + #[serde(default)] + #[allow(dead_code)] + d: Option, + #[serde(default)] + s: Option, +} + +// ============================================================================ +// Cache Keys +// ============================================================================ + +fn connection_key(username: &str) -> String { + format!("discord.connection.{}", username) +} + +fn token_key(username: &str) -> String { + format!("discord.token.{}", username) +} + +fn sequence_key(username: &str) -> String { + format!("discord.sequence.{}", username) +} + +// ============================================================================ +// Connection Management +// ============================================================================ + +/// Tests if the connection is still valid by trying to send a heartbeat. +fn is_connected(username: &str) -> bool { + match send_heartbeat(username) { + Ok(_) => true, + Err(e) => { + trace!("Connection test failed for user {}: {:?}", username, e); + false + } + } +} + +/// Cleans up a connection for a user. +/// Called when heartbeat fails or connection is lost. +pub fn cleanup_connection(username: &str) { + info!("Cleaning up failed connection for user {}", username); + + // Cancel the heartbeat schedule + if let Err(e) = scheduler::cancel_schedule(username) { + warn!("Failed to cancel heartbeat schedule for user {}: {:?}", username, e); + } + + // Try to close the WebSocket connection + let conn_key = connection_key(username); + if let Ok(Some(conn_id)) = cache::get_string(&conn_key) { + if !conn_id.is_empty() { + if let Err(e) = websocket::close_connection(&conn_id, 1000, "Reconnecting") { + trace!("Failed to close WebSocket for user {}: {:?}", username, e); + } + // Clean up reverse mapping + let reverse_key = format!("discord.reverse.{}", conn_id); + let _ = cache::remove(&reverse_key); + } + } + + // Clean up cache entries + let _ = cache::remove(&conn_key); + let _ = cache::remove(&sequence_key(username)); + + info!("Cleaned up connection for user {}", username); +} + +/// Handles connection close by connection ID (called from WebSocket close callback). +/// This cleans up all state associated with the connection. +pub fn handle_connection_close(connection_id: &str) { + // Find the username for this connection using the reverse mapping + if let Ok(Some(username)) = find_username_for_connection(connection_id) { + info!("Connection closed for user {}, cleaning up", username); + + // Cancel the heartbeat schedule + if let Err(e) = scheduler::cancel_schedule(&username) { + // Not an error if schedule doesn't exist + trace!("Failed to cancel heartbeat schedule for user {}: {:?}", username, e); + } + + // Cancel any pending clear-activity schedule + let _ = scheduler::cancel_schedule(&format!("{}-clear", username)); + + // Clean up cache entries + let conn_key = connection_key(&username); + let _ = cache::remove(&conn_key); + let _ = cache::remove(&sequence_key(&username)); + + // Clean up reverse mapping + let reverse_key = format!("discord.reverse.{}", connection_id); + let _ = cache::remove(&reverse_key); + + info!("Cleaned up connection state for user {}", username); + } else { + // Just clean up the reverse mapping if we can't find the username + let reverse_key = format!("discord.reverse.{}", connection_id); + let _ = cache::remove(&reverse_key); + } +} + +/// Connects to the Discord gateway for a user. +pub fn connect(username: &str, token: &str) -> Result<(), Error> { + // Check if already connected and connection is valid + if is_connected(username) { + info!("Reusing existing connection for user {}", username); + return Ok(()); + } + + // Clean up any stale connection state + cleanup_connection(username); + + info!("Connecting to Discord gateway for user {}", username); + + // Store token for later use + cache::set_string(&token_key(username), token, 86400)?; + + // Get Discord Gateway URL + let gateway = get_discord_gateway()?; + info!("Using gateway: {}", gateway); + + // Connect to Discord gateway + let headers = std::collections::HashMap::new(); + let conn_id = websocket::connect( + &gateway, + headers, + username, // Use username as connection ID for easy lookup + )?; + info!("WebSocket connection established: {}", conn_id); + + // Store connection ID + let conn_key = connection_key(username); + cache::set_string(&conn_key, &conn_id, 86400)?; + + // Send identify immediately (don't wait for Hello) + identify(username)?; + + info!("Successfully connected and identified user {}", username); + Ok(()) +} + +/// Handles a WebSocket message from Discord. +pub fn handle_websocket_message(connection_id: &str, message: &str) -> Result<(), Error> { + let response: GatewayResponse = serde_json::from_str(message) + .map_err(|e| Error::msg(format!("Failed to parse gateway message: {}", e)))?; + + // Update sequence number if present + if let Some(seq) = response.s { + // Find username for this connection + if let Some(username) = find_username_for_connection(connection_id)? { + cache::set_string(&sequence_key(&username), &seq.to_string(), 86400)?; + } + } + + match response.op { + 10 => { + // Hello - we already identified in connect(), nothing to do + } + 11 => { + // Heartbeat ACK - no action needed + } + 1 => { + // Heartbeat request - send heartbeat + if let Some(username) = find_username_for_connection(connection_id)? { + send_heartbeat(&username)?; + } + } + _ => { + trace!("Received Discord gateway op: {}", response.op); + } + } + + Ok(()) +} + +/// Handles heartbeat callback from scheduler. +pub fn handle_heartbeat_callback(username: &str) -> Result<(), Error> { + send_heartbeat(username) +} + +/// Handles clear activity callback from scheduler. +pub fn handle_clear_activity_callback(username: &str) -> Result<(), Error> { + info!("Clearing activity for user {}", username); + + let conn_key = connection_key(username); + if let Some(conn_id) = cache::get_string(&conn_key)?.filter(|s| !s.is_empty()) { + // Send empty presence to clear activity + let msg = GatewayMessage { + op: PRESENCE_OP_CODE, + d: PresencePayload { + activities: vec![], + since: 0, + status: "dnd".to_string(), + afk: false, + }, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + } + + Ok(()) +} + +/// Disconnects from Discord for a user. +pub fn disconnect(username: &str) -> Result<(), Error> { + info!("Disconnecting from Discord for user {}", username); + + // Cancel the heartbeat schedule + if let Err(e) = scheduler::cancel_schedule(username) { + warn!("Failed to cancel heartbeat schedule: {:?}", e); + } + + // Close the WebSocket connection + let conn_key = connection_key(username); + if let Some(conn_id) = cache::get_string(&conn_key)?.filter(|s| !s.is_empty()) { + if let Err(e) = websocket::close_connection(&conn_id, 1000, "Navidrome disconnect") { + warn!("Failed to close WebSocket connection: {:?}", e); + } + // Clean up reverse mapping + let reverse_key = format!("discord.reverse.{}", conn_id); + let _ = cache::remove(&reverse_key); + } + + // Clean up cache entries + let _ = cache::remove(&conn_key); + let _ = cache::remove(&sequence_key(username)); + + Ok(()) +} + +/// Sends an activity update to Discord. +pub fn send_activity( + client_id: &str, + username: &str, + token: &str, + mut activity: Activity, +) -> Result<(), Error> { + let conn_key = connection_key(username); + let conn_id = cache::get_string(&conn_key)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("Not connected to Discord"))?; + + // Process image URL + activity.assets.large_image = process_image(&activity.assets.large_image, client_id, token)?; + + // Send presence update + let msg = GatewayMessage { + op: PRESENCE_OP_CODE, + d: PresencePayload { + activities: vec![activity], + since: 0, + status: "dnd".to_string(), + afk: false, + }, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + + Ok(()) +} + +// ============================================================================ +// Internal Functions +// ============================================================================ + +fn find_username_for_connection(connection_id: &str) -> Result, Error> { + // This is a simple approach - in production you might want to maintain a proper mapping + // For now, we'll use a known pattern to find the username + // The connection ID is stored as cache value, so we need to scan for it + // Since we can't iterate cache, we'll use a workaround with a reverse mapping + let reverse_key = format!("discord.reverse.{}", connection_id); + Ok(cache::get_string(&reverse_key)?.filter(|s| !s.is_empty())) +} + +fn get_discord_gateway() -> Result { + let req = HttpRequest::new("https://discord.com/api/gateway") + .with_method("GET"); + + let resp = http::request::(&req, None::)?; + if resp.status_code() >= 400 { + return Err(Error::msg(format!( + "Failed to get Discord gateway: HTTP {}", + resp.status_code() + ))); + } + + let body = resp.body(); + let data: std::collections::HashMap = serde_json::from_slice(&body) + .map_err(|e| Error::msg(format!("Failed to parse gateway response: {}", e)))?; + + data.get("url") + .map(|url| url.to_string()) + .ok_or_else(|| Error::msg("No URL in gateway response")) +} + +fn identify(username: &str) -> Result<(), Error> { + info!("Identifying with Discord for user {}", username); + + let conn_key = connection_key(username); + let conn_id = cache::get_string(&conn_key)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("No connection found"))?; + + let token_k = token_key(username); + let token = cache::get_string(&token_k)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("No token found"))?; + + // Store reverse mapping for connection -> username + let reverse_key = format!("discord.reverse.{}", conn_id); + cache::set_string(&reverse_key, username, 86400)?; + + // Send identify + let msg = GatewayMessage { + op: GATE_OP_CODE, + d: IdentifyPayload { + token, + intents: 0, + properties: IdentifyProperties { + os: "Windows 10".to_string(), + browser: "Discord Client".to_string(), + device: "Discord Client".to_string(), + }, + }, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + + // Schedule heartbeat + scheduler::schedule_recurring( + &format!("@every {}s", HEARTBEAT_INTERVAL), + PAYLOAD_HEARTBEAT, + username, + )?; + + Ok(()) +} + +fn send_heartbeat(username: &str) -> Result<(), Error> { + let conn_key = connection_key(username); + let conn_id = cache::get_string(&conn_key)? + .filter(|s| !s.is_empty()) + .ok_or_else(|| Error::msg("No connection found"))?; + + // Get sequence number + let seq_key = sequence_key(username); + let seq: Option = cache::get_string(&seq_key)? + .and_then(|s| s.parse().ok()); + + // Send heartbeat + let msg = GatewayMessage { + op: HEARTBEAT_OP_CODE, + d: seq, + }; + + let json = serde_json::to_string(&msg) + .map_err(|e| Error::msg(format!("Failed to serialize message: {}", e)))?; + + websocket::send_text(&conn_id, &json)?; + Ok(()) +} + +fn process_image(image_url: &str, client_id: &str, token: &str) -> Result { + process_image_inner(image_url, client_id, token, false) +} + +fn process_image_inner( + image_url: &str, + client_id: &str, + token: &str, + is_default: bool, +) -> Result { + let url = if image_url.is_empty() { + if is_default { + return Err(Error::msg("default image URL is empty")); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } else { + image_url + }; + + // Already processed + if url.starts_with("mp:") { + return Ok(url.to_string()); + } + + // Check cache + let cache_key = format!("discord.image.{:x}", md5_hash(url)); + if let Some(cached) = cache::get_string(&cache_key)?.filter(|s| !s.is_empty()) { + return Ok(cached); + } + + // Process via Discord API + let body = format!(r#"{{"urls":["{}"]}}"#, url); + let api_url = format!( + "https://discord.com/api/v9/applications/{}/external-assets", + client_id + ); + + let req = HttpRequest::new(&api_url) + .with_method("POST") + .with_header("Authorization", token) + .with_header("Content-Type", "application/json"); + + let resp = http::request::(&req, Some(body))?; + if resp.status_code() >= 400 { + if is_default { + return Err(Error::msg(format!( + "failed to process default image: HTTP {}", + resp.status_code() + ))); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } + + let body = resp.body(); + let data: Vec> = serde_json::from_slice(&body) + .map_err(|e| Error::msg(format!("Failed to parse image response: {}", e)))?; + + if data.is_empty() { + if is_default { + return Err(Error::msg("no data returned for default image")); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } + + let asset_path = data[0] + .get("external_asset_path") + .map(|s| s.as_str()) + .unwrap_or(""); + + if asset_path.is_empty() { + if is_default { + return Err(Error::msg("empty external_asset_path for default image")); + } + return process_image_inner(DEFAULT_IMAGE, client_id, token, true); + } + + let processed = format!("mp:{}", asset_path); + + // Cache the result + let ttl = if is_default { 48 * 60 * 60 } else { 4 * 60 * 60 }; + let _ = cache::set_string(&cache_key, &processed, ttl); + + Ok(processed) +} + +/// Simple hash function for cache keys. +fn md5_hash(input: &str) -> u64 { + // A simple hash - not actual MD5, but sufficient for cache keys + let mut hash: u64 = 0; + for (i, byte) in input.bytes().enumerate() { + hash = hash.wrapping_add((byte as u64).wrapping_mul((i as u64).wrapping_add(1))); + hash = hash.wrapping_mul(31); + } + hash +} diff --git a/plugins/examples/library-inspector-rs/.cargo/config.toml b/plugins/examples/library-inspector-rs/.cargo/config.toml new file mode 100644 index 000000000..6b509f5b7 --- /dev/null +++ b/plugins/examples/library-inspector-rs/.cargo/config.toml @@ -0,0 +1,2 @@ +[build] +target = "wasm32-wasip1" diff --git a/plugins/examples/library-inspector-rs/.gitignore b/plugins/examples/library-inspector-rs/.gitignore new file mode 100644 index 000000000..8f0c20473 --- /dev/null +++ b/plugins/examples/library-inspector-rs/.gitignore @@ -0,0 +1,5 @@ +# Rust build artifacts +/target/ + +# Cargo.lock is not needed for library crates (this is a cdylib) +Cargo.lock \ No newline at end of file diff --git a/plugins/examples/library-inspector-rs/Cargo.toml b/plugins/examples/library-inspector-rs/Cargo.toml new file mode 100644 index 000000000..a0bc9700c --- /dev/null +++ b/plugins/examples/library-inspector-rs/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "library-inspector-rs" +version = "1.0.0" +edition = "2021" +description = "Navidrome plugin that periodically logs library details and finds largest files" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/examples/library-inspector-rs/README.md b/plugins/examples/library-inspector-rs/README.md new file mode 100644 index 000000000..37c672679 --- /dev/null +++ b/plugins/examples/library-inspector-rs/README.md @@ -0,0 +1,93 @@ +# Library Inspector Plugin + +A Navidrome plugin written in Rust that demonstrates the Library host service. It periodically logs details about all configured music libraries and finds the largest file in the root of each library directory. + +## Features + +- Logs comprehensive library statistics (songs, albums, artists, size, duration) +- Lists the largest file found in each library's root directory +- Configurable inspection interval via cron expression +- Runs an initial inspection on plugin load + +## Requirements + +- Rust toolchain with `wasm32-wasip1` target +- Navidrome with plugins enabled + +## Building + +```bash +# Install the WASM target if you haven't already +rustup target add wasm32-wasip1 + +# Build the plugin +cargo build --target wasm32-wasip1 --release + +# Package as .ndp +zip -j library-inspector.ndp manifest.json target/wasm32-wasip1/release/library_inspector.wasm +``` + +Or use the provided Makefile from the examples directory: + +```bash +cd plugins/examples +make library-inspector.ndp +``` + +## Installation + +1. Copy the `.ndp` file to your Navidrome plugins folder +2. Enable plugins in your Navidrome configuration: + +```toml +[Plugins] +Enabled = true +Folder = "/path/to/plugins" +``` + +3. Restart Navidrome and enable the plugin in the UI + +## Configuration + +Configure the inspection interval in the Navidrome UI (Settings → Plugins → library-inspector): + +| Key | Description | Default | +|--------|------------------------------------------|--------------| +| `cron` | Cron expression for inspection interval | `@every 1m` | + +## Permissions + +This plugin requires: + +- **Library** (with filesystem): To read library metadata and scan directories +- **Scheduler**: To schedule periodic inspections + +## Example Output + +``` +=== Library Inspection Started === +Found 2 libraries +---------------------------------------- +Library: My Music (ID: 1) + Songs: 5432 tracks + Albums: 456 + Artists: 234 + Size: 45.67 GB + Duration: 312h 45m + Mount: /libraries/1 + Largest file in root: cover.jpg (2.34 MB) +---------------------------------------- +Library: Podcasts (ID: 2) + Songs: 128 tracks + Albums: 12 + Artists: 8 + Size: 3.21 GB + Duration: 48h 15m + Mount: /libraries/2 + Largest file in root: episode-001.mp3 (156.78 MB) +=== Library Inspection Complete === +``` + +## License + +GPL-3.0 - Same as Navidrome diff --git a/plugins/examples/library-inspector-rs/manifest.json b/plugins/examples/library-inspector-rs/manifest.json new file mode 100644 index 000000000..6288dc948 --- /dev/null +++ b/plugins/examples/library-inspector-rs/manifest.json @@ -0,0 +1,16 @@ +{ + "name": "Library Inspector", + "author": "Navidrome Team", + "version": "1.0.0", + "description": "Periodically logs library details and finds largest files", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/library-inspector", + "permissions": { + "library": { + "reason": "To read library metadata and scan directories for file sizes", + "filesystem": true + }, + "scheduler": { + "reason": "To schedule periodic library inspections" + } + } +} diff --git a/plugins/examples/library-inspector-rs/src/lib.rs b/plugins/examples/library-inspector-rs/src/lib.rs new file mode 100644 index 000000000..88ff1b787 --- /dev/null +++ b/plugins/examples/library-inspector-rs/src/lib.rs @@ -0,0 +1,207 @@ +//! Library Inspector Plugin for Navidrome +//! +//! This plugin demonstrates how to use the nd-pdk crate for accessing Navidrome +//! host services and implementing capabilities in Rust. It periodically logs details +//! about all music libraries and finds the largest file in the root of each library. +//! +//! ## Configuration +//! +//! Set the `cron` config key to customize the schedule (default: "@every 1m"): +//! ```toml +//! [PluginConfig.library-inspector] +//! cron = "@every 5m" +//! ``` + +use extism_pdk::*; +use nd_pdk::host::{library, scheduler}; +use nd_pdk::lifecycle::{Error as LifecycleError, InitProvider}; +use nd_pdk::scheduler::{CallbackProvider, Error as SchedulerError, SchedulerCallbackRequest}; +use std::fs; + +// Register capabilities using PDK macros +nd_pdk::register_lifecycle_init!(LibraryInspector); +nd_pdk::register_scheduler_callback!(LibraryInspector); + +// ============================================================================ +// Plugin Implementation +// ============================================================================ + +/// The library inspector plugin type. +#[derive(Default)] +struct LibraryInspector; + +impl InitProvider for LibraryInspector { + fn on_init(&self) -> Result<(), LifecycleError> { + info!("Library Inspector plugin initializing..."); + + // Get cron expression from config, default to every minute + let cron = config::get("cron") + .ok() + .flatten() + .unwrap_or_else(|| "@every 1m".to_string()); + + info!("Scheduling library inspection with cron: {}", cron); + + // Schedule the recurring task using nd-pdk host scheduler + match scheduler::schedule_recurring(&cron, "inspect", "library-inspect") { + Ok(schedule_id) => { + info!("Scheduled inspection task with ID: {}", schedule_id); + } + Err(e) => { + let error_msg = format!("Failed to schedule inspection: {}", e); + error!("{}", error_msg); + return Err(LifecycleError::new(error_msg)); + } + } + + // Run an initial inspection + inspect_libraries(); + + info!("Library Inspector plugin initialized successfully"); + Ok(()) + } +} + +impl CallbackProvider for LibraryInspector { + fn on_callback(&self, req: SchedulerCallbackRequest) -> Result<(), SchedulerError> { + info!( + "Scheduler callback fired: schedule_id={}, payload={}, recurring={}", + req.schedule_id, req.payload, req.is_recurring + ); + + if req.payload == "inspect" { + inspect_libraries(); + } + + Ok(()) + } +} + +// ============================================================================ +// Helper Functions +// ============================================================================ + +/// Format bytes into human-readable size +fn format_size(bytes: i64) -> String { + const KB: i64 = 1024; + const MB: i64 = KB * 1024; + const GB: i64 = MB * 1024; + const TB: i64 = GB * 1024; + + if bytes >= TB { + format!("{:.2} TB", bytes as f64 / TB as f64) + } else if bytes >= GB { + format!("{:.2} GB", bytes as f64 / GB as f64) + } else if bytes >= MB { + format!("{:.2} MB", bytes as f64 / MB as f64) + } else if bytes >= KB { + format!("{:.2} KB", bytes as f64 / KB as f64) + } else { + format!("{} bytes", bytes) + } +} + +/// Format duration in seconds to human-readable format +fn format_duration(seconds: f64) -> String { + let total_seconds = seconds as i64; + let hours = total_seconds / 3600; + let minutes = (total_seconds % 3600) / 60; + + if hours > 0 { + format!("{}h {}m", hours, minutes) + } else { + format!("{}m", minutes) + } +} + +/// Find the largest file in a directory (non-recursive) +fn find_largest_file(mount_point: &str) -> Option<(String, u64)> { + let entries = match fs::read_dir(mount_point) { + Ok(entries) => entries, + Err(e) => { + warn!("Failed to read directory {}: {}", mount_point, e); + return None; + } + }; + + let mut largest: Option<(String, u64)> = None; + + for entry in entries.flatten() { + let path = entry.path(); + + // Only consider files, not directories + if !path.is_file() { + continue; + } + + let metadata = match entry.metadata() { + Ok(m) => m, + Err(_) => continue, + }; + + let size = metadata.len(); + let name = entry.file_name().to_string_lossy().to_string(); + + match &largest { + None => largest = Some((name, size)), + Some((_, current_size)) if size > *current_size => { + largest = Some((name, size)); + } + _ => {} + } + } + + largest +} + +/// Inspect and log all library details +fn inspect_libraries() { + info!("=== Library Inspection Started ==="); + + let libraries = match library::get_all_libraries() { + Ok(libs) => libs, + Err(e) => { + error!("Failed to get libraries: {}", e); + return; + } + }; + + if libraries.is_empty() { + info!("No libraries configured"); + return; + } + + info!("Found {} libraries", libraries.len()); + + for lib in &libraries { + info!("----------------------------------------"); + info!("Library: {} (ID: {})", lib.name, lib.id); + info!(" Songs: {} tracks", lib.total_songs); + info!(" Albums: {}", lib.total_albums); + info!(" Artists: {}", lib.total_artists); + info!(" Size: {}", format_size(lib.total_size)); + info!(" Duration: {}", format_duration(lib.total_duration)); + + // If we have filesystem access, find the largest file + if !lib.mount_point.is_empty() { + info!(" Mount: {}", lib.mount_point); + + match find_largest_file(&lib.mount_point) { + Some((name, size)) => { + info!( + " Largest file in root: {} ({})", + name, + format_size(size as i64) + ); + } + None => { + info!(" Largest file in root: (no files found)"); + } + } + } else { + info!(" (Filesystem access not enabled)"); + } + } + + info!("=== Library Inspection Complete ==="); +} diff --git a/plugins/examples/minimal/README.md b/plugins/examples/minimal/README.md new file mode 100644 index 000000000..549a98a8f --- /dev/null +++ b/plugins/examples/minimal/README.md @@ -0,0 +1,72 @@ +# Minimal Navidrome Plugin Example + +This is a minimal example demonstrating how to create a Navidrome plugin using Go and the Navidrome PDK. + +## Building + +1. Install [TinyGo](https://tinygo.org/getting-started/install/) +2. Build the plugin: + ```bash + go mod tidy + tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared . + zip -j minimal.ndp manifest.json plugin.wasm + ``` + +Or using the examples Makefile: + ```bash + cd plugins/examples + make minimal.ndp + ``` + +## Installing + +Copy `minimal.ndp` to your Navidrome plugins folder (default: `/plugins/`). + +## Configuration + +Enable plugins in your `navidrome.toml`: + +```toml +[Plugins] +Enabled = true + +# Add the plugin to your agents list +Agents = "lastfm,spotify,minimal" +``` + +## What This Example Demonstrates + +- Plugin package structure (`.ndp` = zip with `manifest.json` + `plugin.wasm`) +- Using the Navidrome PDK `metadata` subpackage +- Implementing the `ArtistBiographyProvider` interface +- Registration pattern with `metadata.Register()` + +## PDK Usage + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + +type myPlugin struct{} + +func init() { + metadata.Register(&myPlugin{}) +} + +func (p *myPlugin) GetArtistBiography(input metadata.ArtistRequest) (metadata.ArtistBiographyResponse, error) { + return metadata.ArtistBiographyResponse{Biography: "..."}, nil +} +``` + +## Extending the Example + +To add more capabilities, implement additional provider interfaces from the `metadata` package: + +- `ArtistMBIDProvider` - Get MusicBrainz ID for an artist +- `ArtistURLProvider` - Get external URL for an artist +- `SimilarArtistsProvider` - Get similar artists +- `ArtistImagesProvider` - Get artist images +- `ArtistTopSongsProvider` - Get top songs for an artist +- `AlbumInfoProvider` - Get album information +- `AlbumImagesProvider` - Get album images + +See the full documentation in `/plugins/README.md` for input/output formats. diff --git a/plugins/examples/minimal/go.mod b/plugins/examples/minimal/go.mod new file mode 100644 index 000000000..b8f6c5fc0 --- /dev/null +++ b/plugins/examples/minimal/go.mod @@ -0,0 +1,16 @@ +module minimal-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/examples/minimal/go.sum b/plugins/examples/minimal/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/examples/minimal/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/examples/minimal/main.go b/plugins/examples/minimal/main.go new file mode 100644 index 000000000..18303891c --- /dev/null +++ b/plugins/examples/minimal/main.go @@ -0,0 +1,31 @@ +// Minimal example Navidrome plugin demonstrating the MetadataAgent capability. +// +// Build with: +// +// tinygo build -o minimal.wasm -target wasip1 -buildmode=c-shared . +// +// Install by copying minimal.ndp to your Navidrome plugins folder. +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" +) + +// minimalPlugin implements the metadata provider interfaces. +type minimalPlugin struct{} + +// init registers the plugin implementation +func init() { + metadata.Register(&minimalPlugin{}) +} + +var _ metadata.ArtistBiographyProvider = (*minimalPlugin)(nil) + +// GetArtistBiography returns a placeholder biography for the artist. +func (p *minimalPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{ + Biography: "This is a placeholder biography for " + input.Name + ".", + }, nil +} + +func main() {} diff --git a/plugins/examples/minimal/manifest.json b/plugins/examples/minimal/manifest.json new file mode 100644 index 000000000..de0c4d75d --- /dev/null +++ b/plugins/examples/minimal/manifest.json @@ -0,0 +1,6 @@ +{ + "name": "Minimal Example", + "author": "Navidrome", + "version": "1.0.0", + "description": "A minimal example plugin" +} diff --git a/plugins/examples/nowplaying-py/Makefile b/plugins/examples/nowplaying-py/Makefile new file mode 100644 index 000000000..2bf6ea971 --- /dev/null +++ b/plugins/examples/nowplaying-py/Makefile @@ -0,0 +1,12 @@ +# Build the Now Playing Logger Python plugin +.PHONY: build test clean + +WASM_FILE = nowplaying-py.wasm + +build: $(WASM_FILE) + +$(WASM_FILE): plugin/__init__.py + extism-py plugin/__init__.py -o $(WASM_FILE) + +clean: + rm -f $(WASM_FILE) diff --git a/plugins/examples/nowplaying-py/README.md b/plugins/examples/nowplaying-py/README.md new file mode 100644 index 000000000..ac4ba26f7 --- /dev/null +++ b/plugins/examples/nowplaying-py/README.md @@ -0,0 +1,112 @@ +# Now Playing Logger Plugin (Python) + +A Python example plugin that demonstrates the **Scheduler** and **SubsonicAPI** host services by periodically logging what is currently playing in Navidrome. + +## Features + +- Uses `scheduler_schedulerecurring` host function to set up a recurring task +- Uses `subsonicapi_call` host function to query the `getNowPlaying` API +- Configurable cron expression and user via plugin config +- Demonstrates Python host function imports using `@extism.import_fn` + +## Prerequisites + +- [extism-py](https://github.com/extism/python-pdk) - Python PDK compiler + ```bash + curl -Ls https://raw.githubusercontent.com/extism/python-pdk/main/install.sh | bash + ``` + +> **Note:** `extism-py` requires [Binaryen](https://github.com/WebAssembly/binaryen/) (`wasm-merge`, `wasm-opt`) to be installed. + +## Building + +From the `plugins/examples` directory: + +```bash +make nowplaying-py.ndp +``` + +Or directly: + +```bash +extism-py plugin/__init__.py -o plugin.wasm +zip -j nowplaying-py.ndp manifest.json plugin.wasm +``` + +## Installation + +1. Copy `nowplaying-py.ndp` to your Navidrome plugins folder + +2. Enable plugins in `navidrome.toml`: + ```toml + [Plugins] + Enabled = true + Folder = "/path/to/plugins" + ``` + +3. Configure the plugin in the UI (Settings → Plugins → nowplaying-py) + +## Configuration + +| Key | Description | Default | +|--------|-------------------------------------|---------------| +| `cron` | Cron expression for check frequency | `*/1 * * * *` | +| `user` | Navidrome user for SubsonicAPI | `admin` | + +## Testing + +Test the manifest: + +```bash +extism call nowplaying-py.wasm nd_manifest --wasi +``` + +## Output + +When running, the plugin logs messages like: + +``` +🎵 john is playing: Pink Floyd - Comfortably Numb (The Wall) +🎵 jane is playing: Radiohead - Paranoid Android (OK Computer) +``` + +Or when no one is playing: + +``` +🎵 No users currently playing music +``` + +## How It Works + +1. **Initialization (`nd_on_init`)**: Reads the cron expression from config and schedules a recurring task using the Scheduler host service. + +2. **Callback (`nd_scheduler_callback`)**: When the scheduled task fires, calls the SubsonicAPI `getNowPlaying` endpoint and logs the results. + +## Host Function Usage (Python) + +This plugin demonstrates how to call Navidrome host functions from Python: + +```python +import extism +import json + +# Import the host function +@extism.import_fn("extism:host/user", "subsonicapi_call") +def _subsonicapi_call(offset: int) -> int: + """Raw host function - returns memory offset.""" + ... + +# Wrapper for JSON marshalling +def subsonicapi_call(uri: str) -> dict: + request = {"uri": uri} + request_bytes = json.dumps(request).encode('utf-8') + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_call(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise Exception(response["error"]) + + return json.loads(response.get("responseJSON", "{}")) +``` \ No newline at end of file diff --git a/plugins/examples/nowplaying-py/manifest.json b/plugins/examples/nowplaying-py/manifest.json new file mode 100644 index 000000000..6284c4617 --- /dev/null +++ b/plugins/examples/nowplaying-py/manifest.json @@ -0,0 +1,18 @@ +{ + "name": "Now Playing Logger (Python)", + "author": "Navidrome", + "version": "1.0.0", + "description": "Periodically logs currently playing tracks - Python example demonstrating Scheduler and SubsonicAPI host services", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/nowplaying-py", + "permissions": { + "scheduler": { + "reason": "Schedule periodic checks for now playing status" + }, + "subsonicapi": { + "reason": "Query the getNowPlaying API endpoint" + }, + "users": { + "reason": "Access user information for SubsonicAPI authorization" + } + } +} diff --git a/plugins/examples/nowplaying-py/plugin/__init__.py b/plugins/examples/nowplaying-py/plugin/__init__.py new file mode 100644 index 000000000..f7453fdb7 --- /dev/null +++ b/plugins/examples/nowplaying-py/plugin/__init__.py @@ -0,0 +1,168 @@ +# Now Playing Logger Plugin for Navidrome +# +# This plugin demonstrates the Scheduler and SubsonicAPI host services by +# periodically logging what is currently playing in Navidrome. +# +# Build with: +# extism-py plugin/__init__.py -o nowplaying-py.wasm +# +# Configuration: +# [PluginConfig.nowplaying-py] +# cron = "*/1 * * * *" # Every minute (default) +# user = "admin" # User to query getNowPlaying (default) + +import extism +import json + +# Schedule ID for our recurring task +SCHEDULE_ID = "nowplaying-check" + + +# ============================================================================= +# Host Function Imports +# ============================================================================= +# These are custom host functions provided by Navidrome. +# We import them using the extism:host/user namespace. + + +@extism.import_fn("extism:host/user", "scheduler_schedulerecurring") +def _scheduler_schedulerecurring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "subsonicapi_call") +def _subsonicapi_call(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +# ============================================================================= +# Host Function Wrappers +# ============================================================================= +# These wrappers handle JSON marshalling/unmarshalling and memory management. +# They were copied from plugins/host/python due to extism-py limitations. + + +def scheduler_schedule_recurring(cron_expression: str, payload: str, schedule_id: str) -> str: + """Schedule a recurring task using a cron expression. + + Args: + cron_expression: Cron format (e.g., "*/1 * * * *" for every minute) + payload: Data to pass to the callback + schedule_id: Unique identifier for the schedule + + Returns: + The schedule ID (same as input or auto-generated) + """ + request = { + "cronExpression": cron_expression, + "payload": payload, + "scheduleId": schedule_id + } + request_bytes = json.dumps(request).encode('utf-8') + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_schedulerecurring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise Exception(response["error"]) + + return response.get("newScheduleId", schedule_id) + + +def subsonicapi_call(uri: str) -> dict: + """Call a Subsonic API endpoint. + + Args: + uri: API path (e.g., "getNowPlaying") + + Returns: + Parsed JSON response from the API + """ + request = {"uri": uri} + request_bytes = json.dumps(request).encode('utf-8') + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_call(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise Exception(response["error"]) + + # Parse the nested JSON response + response_json = response.get("responseJson", "{}") + return json.loads(response_json) + + +# ============================================================================= +# Plugin Exports +# ============================================================================= + + +@extism.plugin_fn +def nd_on_init(): + """Initialize the plugin by scheduling the recurring task.""" + # Read cron expression from config, default to every minute + cron = extism.Config.get_str("cron") + if not cron: + cron = "*/1 * * * *" + + extism.log(extism.LogLevel.Info, f"Now Playing Logger initializing with cron: {cron}") + + try: + schedule_id = scheduler_schedule_recurring(cron, "check", SCHEDULE_ID) + extism.log(extism.LogLevel.Info, f"Scheduled recurring task with ID: {schedule_id}") + except Exception as e: + extism.log(extism.LogLevel.Error, f"Failed to schedule task: {e}") + raise + # No output - lifecycle callbacks don't return responses + + +@extism.plugin_fn +def nd_scheduler_callback(): + """Handle scheduler callback - check and log now playing tracks.""" + input_data = extism.input_json() + schedule_id = input_data.get("scheduleId", "") + + # Only handle our schedule + if schedule_id != SCHEDULE_ID: + return + + try: + # Read user from config, default to admin + user = extism.Config.get_str("user") + if not user: + user = "admin" + + # Call the getNowPlaying API + response = subsonicapi_call(f"getNowPlaying?u={user}") + + # Extract the subsonic-response + subsonic_response = response.get("subsonic-response", {}) + now_playing = subsonic_response.get("nowPlaying", {}) + entries = now_playing.get("entry", []) + + if not entries: + extism.log(extism.LogLevel.Info, "🎵 No users currently playing music") + else: + # Handle both single entry and list of entries + if isinstance(entries, dict): + entries = [entries] + + for entry in entries: + artist = entry.get("artist", "Unknown Artist") + title = entry.get("title", "Unknown Title") + album = entry.get("album", "Unknown Album") + username = entry.get("username", "Unknown User") + + extism.log( + extism.LogLevel.Info, + f"🎵 {username} is playing: {artist} - {title} ({album})" + ) + # No output - scheduler callbacks don't return responses + + except Exception as e: + extism.log(extism.LogLevel.Error, f"Failed to get now playing: {e}") + # Errors are logged but scheduler callbacks don't return responses diff --git a/plugins/examples/webhook-rs/.cargo/config.toml b/plugins/examples/webhook-rs/.cargo/config.toml new file mode 100644 index 000000000..6b509f5b7 --- /dev/null +++ b/plugins/examples/webhook-rs/.cargo/config.toml @@ -0,0 +1,2 @@ +[build] +target = "wasm32-wasip1" diff --git a/plugins/examples/webhook-rs/Cargo.toml b/plugins/examples/webhook-rs/Cargo.toml new file mode 100644 index 000000000..d74e180fd --- /dev/null +++ b/plugins/examples/webhook-rs/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "webhook-rs" +version = "1.0.0" +edition = "2021" +description = "Navidrome webhook plugin that sends HTTP requests on scrobble events" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/examples/webhook-rs/README.md b/plugins/examples/webhook-rs/README.md new file mode 100644 index 000000000..86afad9bb --- /dev/null +++ b/plugins/examples/webhook-rs/README.md @@ -0,0 +1,77 @@ +# Webhook Scrobbler Plugin (Rust) + +A Navidrome plugin written in Rust that sends HTTP webhook notifications when tracks are scrobbled. This is useful for integrating with external services like home automation systems, Discord bots, monitoring tools, or any service that can receive HTTP requests. + +## Features + +- Sends HTTP GET requests to configured URLs on every scrobble event +- Includes track metadata (title, artist, album, username, timestamp) as query parameters +- Supports multiple webhook URLs (comma-separated) +- All users are automatically authorized (no external service authentication required) +- Now playing events are ignored (webhooks fire only on completed scrobbles) + +## Prerequisites + +- [Rust](https://rustup.rs/) toolchain +- WebAssembly target: `rustup target add wasm32-unknown-unknown` + +## Building + +From the `plugins/examples` directory: + +```bash +make webhook-rs.ndp +``` + +Or build directly with cargo: + +```bash +cd webhook-rs +cargo build --release +zip -j webhook-rs.ndp manifest.json target/wasm32-unknown-unknown/release/webhook_rs.wasm +``` + +## Installation + +Copy `webhook-rs.ndp` to your Navidrome plugins folder (configured via `Plugins.Folder` in your config). + +## Configuration + +Configure in the Navidrome UI (Settings → Plugins → webhook-rs): + +| Key | Description | Example | +|--------|--------------------------------------|-----------------------------------------------------------| +| `urls` | Comma-separated list of webhook URLs | `https://example.com/hook1,https://example.com/hook2` | + +## Webhook Request Format + +When a scrobble occurs, the plugin sends an HTTP GET request to each configured URL with the following query parameters: + +| Parameter | Description | +|-------------|-----------------------------------------------| +| `title` | Track title | +| `artist` | Track artist | +| `album` | Album name | +| `user` | Username who scrobbled | +| `timestamp` | Unix timestamp when the track started playing | + +Example request: +``` +GET https://example.com/webhook?title=Song%20Name&artist=Artist%20Name&album=Album%20Name&user=john×tamp=1703270400 +``` + +## Use Cases + +- **Home Automation**: Trigger lights or displays when music starts playing +- **Discord/Slack Notifications**: Post currently playing tracks to a channel +- **Logging/Analytics**: Track listening history in an external system +- **IFTTT/Zapier Integration**: Connect to thousands of services via webhook triggers + +## Development + +The plugin is built using the [Extism Rust PDK](https://github.com/extism/rust-pdk). Key exports: + +- `nd_manifest` - Returns plugin metadata and permissions +- `nd_scrobbler_is_authorized` - Always returns `true` (all users authorized) +- `nd_scrobbler_now_playing` - No-op (returns success without action) +- `nd_scrobbler_scrobble` - Sends webhooks to configured URLs diff --git a/plugins/examples/webhook-rs/manifest.json b/plugins/examples/webhook-rs/manifest.json new file mode 100644 index 000000000..88048a747 --- /dev/null +++ b/plugins/examples/webhook-rs/manifest.json @@ -0,0 +1,16 @@ +{ + "name": "Webhook Scrobbler", + "author": "Navidrome Team", + "version": "1.0.0", + "description": "Sends HTTP webhooks on scrobble events", + "website": "https://github.com/navidrome/navidrome/tree/master/plugins/examples/webhook-rs", + "permissions": { + "http": { + "reason": "To send webhook notifications to configured URLs", + "requiredHosts": ["*"] + }, + "users": { + "reason": "Receive scrobble events for users assigned to this plugin" + } + } +} diff --git a/plugins/examples/webhook-rs/src/lib.rs b/plugins/examples/webhook-rs/src/lib.rs new file mode 100644 index 000000000..e872d845d --- /dev/null +++ b/plugins/examples/webhook-rs/src/lib.rs @@ -0,0 +1,119 @@ +//! Webhook Scrobbler Plugin for Navidrome +//! +//! This plugin demonstrates how to build a Navidrome plugin in Rust using the nd-pdk crate. +//! It implements the Scrobbler capability and sends HTTP GET requests to configured URLs +//! whenever a track is scrobbled. +//! +//! ## Configuration +//! +//! Set the `urls` config key to a comma-separated list of webhook URLs: +//! ```toml +//! [PluginConfig.webhook-rs] +//! urls = "https://example.com/webhook1,https://example.com/webhook2" +//! ``` + +use extism_pdk::{config, error, http, info, warn, HttpRequest}; +use nd_pdk::scrobbler::{ + Error, IsAuthorizedRequest, NowPlayingRequest, ScrobbleRequest, + Scrobbler, +}; + +// Register the WASM exports for the Scrobbler capability +nd_pdk::register_scrobbler!(WebhookPlugin); + +// ============================================================================ +// Plugin Implementation +// ============================================================================ + +/// The webhook plugin type. Implements the Scrobbler trait. +#[derive(Default)] +struct WebhookPlugin; + +impl Scrobbler for WebhookPlugin { + /// Checks if a user is authorized. This plugin authorizes all users. + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result { + info!("Authorization check for user: {}", req.username); + Ok(true) + } + + /// Handles now playing notifications. This plugin ignores them (webhooks only on scrobble). + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error> { + info!( + "Now playing (ignored): {} - {} for user {}", + req.track.artist, req.track.title, req.username + ); + Ok(()) + } + + /// Handles scrobble events by sending HTTP GET requests to configured URLs. + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error> { + // Get configured URLs + let urls_config = match config::get("urls") { + Ok(Some(urls)) if !urls.is_empty() => urls, + _ => { + warn!("No webhook URLs configured. Set 'urls' in plugin config."); + return Ok(()); + } + }; + + info!( + "Scrobble: {} - {} by user {}", + req.track.artist, req.track.title, req.username + ); + + // Build query parameters + let query = format!( + "?title={}&artist={}&album={}&user={}×tamp={}", + urlencode(&req.track.title), + urlencode(&req.track.artist), + urlencode(&req.track.album), + urlencode(&req.username), + req.timestamp + ); + + // Send requests to each configured URL + for url in urls_config.split(',') { + let url = url.trim(); + if url.is_empty() { + continue; + } + + let full_url = format!("{}{}", url, query); + info!("Sending webhook to: {}", full_url); + + let http_req = HttpRequest::new(&full_url); + match http::request::<()>(&http_req, None) { + Ok(res) => { + let status = res.status_code(); + if status >= 200 && status < 300 { + info!("Webhook succeeded: {} (status {})", url, status); + } else { + warn!("Webhook returned non-2xx status: {} (status {})", url, status); + } + } + Err(e) => { + error!("Webhook failed for {}: {:?}", url, e); + } + } + } + + Ok(()) + } +} + +/// Simple URL encoding for query parameters. +fn urlencode(s: &str) -> String { + let mut result = String::with_capacity(s.len() * 3); + for c in s.chars() { + match c { + 'A'..='Z' | 'a'..='z' | '0'..='9' | '-' | '_' | '.' | '~' => result.push(c), + ' ' => result.push_str("%20"), + _ => { + for b in c.to_string().as_bytes() { + result.push_str(&format!("%{:02X}", b)); + } + } + } + } + result +} diff --git a/plugins/examples/wikimedia/README.md b/plugins/examples/wikimedia/README.md new file mode 100644 index 000000000..181055c69 --- /dev/null +++ b/plugins/examples/wikimedia/README.md @@ -0,0 +1,144 @@ +# Wikimedia Plugin for Navidrome + +A Navidrome plugin that fetches artist metadata from Wikidata, DBpedia, and Wikipedia. + +## Generating the Plugin + +This plugin was generated using the XTP CLI: + +```bash +xtp plugin init \ + --schema-file plugins/schemas/metadata_agent.yaml \ + --template go \ + --path ./wikimedia \ + --name wikimedia-plugin +``` + +## Features + +- **Artist URL**: Fetches Wikipedia URL for an artist using Wikidata (by MBID or name), DBpedia, or falls back to a Wikipedia search URL +- **Artist Biography**: Fetches the introductory text from the artist's Wikipedia page +- **Artist Images**: Fetches artist images from Wikidata + +## Building + +### Using TinyGo + +```bash +tinygo build -target wasip1 -buildmode=c-shared -o plugin.wasm . +zip -j wikimedia.ndp manifest.json plugin.wasm +``` + +### Using the Makefile + +From the `plugins/examples` directory: + +```bash +make wikimedia.ndp +``` + +### Using XTP CLI + +```bash +xtp plugin build +zip -j wikimedia.ndp manifest.json dist/plugin.wasm +``` + +## Installation + +Copy the `.ndp` file to your Navidrome plugins folder: + +```bash +cp wikimedia.ndp /path/to/navidrome/plugins/ +``` + +Then enable plugins in your `navidrome.toml`: + +```toml +[Plugins] +Enabled = true +Folder = "/path/to/navidrome/plugins" +``` + +Add the plugin to your agents list: + +```toml +Agents = "lastfm,wikimedia" +``` + +## Testing with Extism CLI + +Install the [Extism CLI](https://extism.org/docs/install): + +```bash +brew install extism/tap/extism # macOS +# or see https://extism.org/docs/install for other platforms +``` + +Extract the wasm file from the package and test: + +```bash +# Extract wasm from package +unzip -p wikimedia.ndp plugin.wasm > wikimedia.wasm + +# Test artist URL lookup with MBID (The Beatles) +extism call wikimedia.wasm nd_get_artist_url --wasi \ + --input '{"id":"1","name":"The Beatles","mbid":"b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d"}' \ + --allow-host "query.wikidata.org" +``` + +Expected output: +```json +{"url":"https://en.wikipedia.org/wiki/The_Beatles"} +``` + +### Test artist biography + +```bash +extism call wikimedia.wasm nd_get_artist_biography --wasi \ + --input '{"id":"1","name":"The Beatles","mbid":"b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d"}' \ + --allow-host "query.wikidata.org" \ + --allow-host "en.wikipedia.org" +``` + +### Test artist images + +```bash +extism call wikimedia.wasm nd_get_artist_images --wasi \ + --input '{"id":"1","name":"The Beatles","mbid":"b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d"}' \ + --allow-host "query.wikidata.org" +``` + +Expected output: +```json +{"images":[{"url":"http://commons.wikimedia.org/wiki/Special:FilePath/Beatles%20ad%201965%20just%20the%20beatles%20crop.jpg","size":0}]} +``` + +## Project Structure + +``` +wikimedia/ +├── main.go # Plugin implementation with Wikimedia API logic +├── pdk.gen.go # Generated types and export wrappers (DO NOT EDIT) +├── go.mod # Go module file +├── go.sum # Go module checksums +├── prepare.sh # Build preparation script +└── xtp.toml # XTP plugin configuration +``` + +## API Endpoints Used + +| Service | Endpoint | Purpose | +|-----------|--------------------------------------|-----------------------------------------------------------| +| Wikidata | `https://query.wikidata.org/sparql` | SPARQL queries for Wikipedia URLs and images | +| DBpedia | `https://dbpedia.org/sparql` | Fallback SPARQL queries for Wikipedia URLs and short bios | +| Wikipedia | `https://en.wikipedia.org/w/api.php` | MediaWiki API for article extracts | + +## Implemented Functions + +| Function | Description | +|---------------------------|-----------------------------------------------| +| `nd_manifest` | Returns plugin manifest with HTTP permissions | +| `nd_get_artist_url` | Returns Wikipedia URL for an artist | +| `nd_get_artist_biography` | Returns artist biography from Wikipedia | +| `nd_get_artist_images` | Returns artist image URLs from Wikidata | diff --git a/plugins/examples/wikimedia/go.mod b/plugins/examples/wikimedia/go.mod new file mode 100644 index 000000000..17f14b065 --- /dev/null +++ b/plugins/examples/wikimedia/go.mod @@ -0,0 +1,16 @@ +module wikimedia-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/examples/wikimedia/go.sum b/plugins/examples/wikimedia/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/examples/wikimedia/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/examples/wikimedia/main.go b/plugins/examples/wikimedia/main.go new file mode 100644 index 000000000..8508354cf --- /dev/null +++ b/plugins/examples/wikimedia/main.go @@ -0,0 +1,366 @@ +// Wikimedia plugin for Navidrome - fetches artist metadata from Wikidata, DBpedia and Wikipedia. +// +// Build with: +// +// tinygo build -o wikimedia.wasm -target wasip1 -buildmode=c-shared . +// +// Install by copying the .ndp file to your Navidrome plugins folder. +package main + +import ( + "encoding/json" + "errors" + "fmt" + "net/url" + "strings" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// wikimediaPlugin implements the metadata provider interfaces for the methods we support. +type wikimediaPlugin struct{} + +// init registers the plugin implementation +func init() { + metadata.Register(&wikimediaPlugin{}) +} + +// Ensure wikimediaPlugin implements the provider interfaces +var ( + _ metadata.ArtistURLProvider = (*wikimediaPlugin)(nil) + _ metadata.ArtistBiographyProvider = (*wikimediaPlugin)(nil) + _ metadata.ArtistImagesProvider = (*wikimediaPlugin)(nil) +) + +const ( + wikidataEndpoint = "https://query.wikidata.org/sparql" + dbpediaEndpoint = "https://dbpedia.org/sparql" + mediawikiAPIEndpoint = "https://en.wikipedia.org/w/api.php" +) + +// SPARQL response types +type SPARQLResult struct { + Results struct { + Bindings []SPARQLBinding `json:"bindings"` + } `json:"results"` +} + +type SPARQLBinding struct { + Sitelink *SPARQLValue `json:"sitelink,omitempty"` + Wiki *SPARQLValue `json:"wiki,omitempty"` + Comment *SPARQLValue `json:"comment,omitempty"` + Img *SPARQLValue `json:"img,omitempty"` +} + +type SPARQLValue struct { + Value string `json:"value"` +} + +// MediaWiki API response types +type MediaWikiExtractResult struct { + Query struct { + Pages map[string]MediaWikiPage `json:"pages"` + } `json:"query"` +} + +type MediaWikiPage struct { + PageID int `json:"pageid"` + Ns int `json:"ns"` + Title string `json:"title"` + Extract string `json:"extract"` + Missing bool `json:"missing"` +} + +// sparqlQuery executes a SPARQL query and returns the result +func sparqlQuery(endpoint, query string) (*SPARQLResult, error) { + form := url.Values{} + form.Set("query", query) + + pdk.Log(pdk.LogDebug, fmt.Sprintf("SPARQL query to %s: %s", endpoint, query)) + + resp, err := host.HTTPSend(host.HTTPRequest{ + Method: "POST", + URL: endpoint, + Headers: map[string]string{ + "Accept": "application/sparql-results+json", + "Content-Type": "application/x-www-form-urlencoded", + "User-Agent": "NavidromeWikimediaPlugin/1.0", + }, + Body: []byte(form.Encode()), + TimeoutMs: 10000, + }) + if err != nil { + return nil, fmt.Errorf("SPARQL HTTP error: %w", err) + } + if resp.StatusCode != 200 { + return nil, fmt.Errorf("SPARQL HTTP error: status %d", resp.StatusCode) + } + + var result SPARQLResult + if err := json.Unmarshal(resp.Body, &result); err != nil { + return nil, fmt.Errorf("failed to parse SPARQL response: %w", err) + } + if len(result.Results.Bindings) == 0 { + return nil, errors.New("not found") + } + return &result, nil +} + +// mediawikiQuery executes a MediaWiki API query +func mediawikiQuery(params url.Values) ([]byte, error) { + apiURL := fmt.Sprintf("%s?%s", mediawikiAPIEndpoint, params.Encode()) + + resp, err := host.HTTPSend(host.HTTPRequest{ + Method: "GET", + URL: apiURL, + Headers: map[string]string{ + "Accept": "application/json", + "User-Agent": "NavidromeWikimediaPlugin/1.0", + }, + TimeoutMs: 10000, + }) + if err != nil { + return nil, fmt.Errorf("MediaWiki HTTP error: %w", err) + } + if resp.StatusCode != 200 { + return nil, fmt.Errorf("MediaWiki HTTP error: status %d", resp.StatusCode) + } + return resp.Body, nil +} + +// getWikidataWikipediaURL fetches the Wikipedia URL from Wikidata using MBID or name +func getWikidataWikipediaURL(mbid, name string) (string, error) { + var q string + if mbid != "" { + q = fmt.Sprintf(`SELECT ?sitelink WHERE { ?artist wdt:P434 "%s". ?sitelink schema:about ?artist; schema:isPartOf . } LIMIT 1`, mbid) + } else if name != "" { + escapedName := strings.ReplaceAll(name, "\"", "\\\"") + q = fmt.Sprintf(`SELECT ?sitelink WHERE { ?artist rdfs:label "%s"@en. ?sitelink schema:about ?artist; schema:isPartOf . } LIMIT 1`, escapedName) + } else { + return "", errors.New("MBID or Name required for Wikidata URL lookup") + } + + result, err := sparqlQuery(wikidataEndpoint, q) + if err != nil { + return "", err + } + if result.Results.Bindings[0].Sitelink != nil { + return result.Results.Bindings[0].Sitelink.Value, nil + } + return "", errors.New("not found") +} + +// getDBpediaWikipediaURL fetches the Wikipedia URL from DBpedia using name +func getDBpediaWikipediaURL(name string) (string, error) { + if name == "" { + return "", errors.New("not found") + } + escapedName := strings.ReplaceAll(name, "\"", "\\\"") + q := fmt.Sprintf(`SELECT ?wiki WHERE { ?artist foaf:name "%s"@en; foaf:isPrimaryTopicOf ?wiki. FILTER regex(str(?wiki), "^https://en.wikipedia.org/") } LIMIT 1`, escapedName) + + result, err := sparqlQuery(dbpediaEndpoint, q) + if err != nil { + return "", err + } + if result.Results.Bindings[0].Wiki != nil { + return result.Results.Bindings[0].Wiki.Value, nil + } + return "", errors.New("not found") +} + +// getDBpediaComment fetches the DBpedia comment (short bio) for an artist +func getDBpediaComment(name string) (string, error) { + if name == "" { + return "", errors.New("not found") + } + escapedName := strings.ReplaceAll(name, "\"", "\\\"") + q := fmt.Sprintf(`SELECT ?comment WHERE { ?artist foaf:name "%s"@en; rdfs:comment ?comment. FILTER (lang(?comment) = 'en') } LIMIT 1`, escapedName) + + result, err := sparqlQuery(dbpediaEndpoint, q) + if err != nil { + return "", err + } + if result.Results.Bindings[0].Comment != nil { + return result.Results.Bindings[0].Comment.Value, nil + } + return "", errors.New("not found") +} + +// getWikipediaExtract fetches the intro text from Wikipedia +func getWikipediaExtract(pageTitle string) (string, error) { + if pageTitle == "" { + return "", errors.New("page title required") + } + params := url.Values{} + params.Set("action", "query") + params.Set("format", "json") + params.Set("prop", "extracts") + params.Set("exintro", "true") + params.Set("explaintext", "true") + params.Set("titles", pageTitle) + params.Set("redirects", "1") + + body, err := mediawikiQuery(params) + if err != nil { + return "", err + } + + var result MediaWikiExtractResult + if err := json.Unmarshal(body, &result); err != nil { + return "", fmt.Errorf("failed to parse MediaWiki response: %w", err) + } + + for _, page := range result.Query.Pages { + if page.Missing { + continue + } + if page.Extract != "" { + return strings.TrimSpace(page.Extract), nil + } + } + return "", errors.New("not found") +} + +// extractPageTitleFromURL extracts the page title from a Wikipedia URL +func extractPageTitleFromURL(wikiURL string) (string, error) { + parsedURL, err := url.Parse(wikiURL) + if err != nil { + return "", err + } + if parsedURL.Host != "en.wikipedia.org" { + return "", fmt.Errorf("URL host is not en.wikipedia.org: %s", parsedURL.Host) + } + pathParts := strings.Split(strings.TrimPrefix(parsedURL.Path, "/"), "/") + if len(pathParts) < 2 || pathParts[0] != "wiki" { + return "", fmt.Errorf("URL path does not match /wiki/ format: %s", parsedURL.Path) + } + title := pathParts[1] + if title == "" { + return "", errors.New("extracted title is empty") + } + decodedTitle, err := url.PathUnescape(title) + if err != nil { + return "", fmt.Errorf("failed to decode title '%s': %w", title, err) + } + return decodedTitle, nil +} + +// GetArtistURL returns the Wikipedia URL for an artist +func (*wikimediaPlugin) GetArtistURL(input metadata.ArtistRequest) (*metadata.ArtistURLResponse, error) { + pdk.Log(pdk.LogDebug, fmt.Sprintf("GetArtistURL: name=%s, mbid=%s", input.Name, input.MBID)) + + // 1. Try Wikidata (MBID first, then name) + wikiURL, err := getWikidataWikipediaURL(input.MBID, input.Name) + if err == nil && wikiURL != "" { + return &metadata.ArtistURLResponse{URL: wikiURL}, nil + } + if err != nil { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Wikidata URL failed: %v", err)) + } + + // 2. Try DBpedia (Name only) + if input.Name != "" { + wikiURL, err = getDBpediaWikipediaURL(input.Name) + if err == nil && wikiURL != "" { + return &metadata.ArtistURLResponse{URL: wikiURL}, nil + } + if err != nil { + pdk.Log(pdk.LogDebug, fmt.Sprintf("DBpedia URL failed: %v", err)) + } + } + + // 3. Fallback to search URL + if input.Name != "" { + searchURL := fmt.Sprintf("https://en.wikipedia.org/w/index.php?search=%s", url.QueryEscape(input.Name)) + pdk.Log(pdk.LogInfo, fmt.Sprintf("URL not found, falling back to search URL: %s", searchURL)) + return &metadata.ArtistURLResponse{URL: searchURL}, nil + } + + return nil, errors.New("could not determine Wikipedia URL") +} + +// GetArtistBiography returns the biography for an artist from Wikipedia +func (*wikimediaPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + pdk.Log(pdk.LogDebug, fmt.Sprintf("GetArtistBiography: name=%s, mbid=%s", input.Name, input.MBID)) + + // 1. Get Wikipedia URL (using the logic from GetArtistURL) + wikiURL := "" + tempURL, wdErr := getWikidataWikipediaURL(input.MBID, input.Name) + if wdErr == nil && tempURL != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Found Wikidata URL: %s", tempURL)) + wikiURL = tempURL + } else if input.Name != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Wikidata URL failed (%v), trying DBpedia", wdErr)) + tempURL, dbErr := getDBpediaWikipediaURL(input.Name) + if dbErr == nil && tempURL != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Found DBpedia URL: %s", tempURL)) + wikiURL = tempURL + } else { + pdk.Log(pdk.LogDebug, fmt.Sprintf("DBpedia URL failed: %v", dbErr)) + } + } + + // 2. If Wikipedia URL found, try MediaWiki API + if wikiURL != "" { + pageTitle, err := extractPageTitleFromURL(wikiURL) + if err == nil { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Extracted page title: %s", pageTitle)) + bio, err := getWikipediaExtract(pageTitle) + if err == nil && bio != "" { + pdk.Log(pdk.LogDebug, "Found Wikipedia extract") + return &metadata.ArtistBiographyResponse{Biography: bio}, nil + } + pdk.Log(pdk.LogDebug, fmt.Sprintf("Wikipedia extract failed: %v", err)) + } else { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Error extracting page title from URL '%s': %v", wikiURL, err)) + } + } + + // 3. Fallback to DBpedia Comment (Name only) + if input.Name != "" { + pdk.Log(pdk.LogDebug, fmt.Sprintf("Falling back to DBpedia comment for name: %s", input.Name)) + bio, err := getDBpediaComment(input.Name) + if err == nil && bio != "" { + pdk.Log(pdk.LogDebug, "Found DBpedia comment") + return &metadata.ArtistBiographyResponse{Biography: bio}, nil + } + pdk.Log(pdk.LogDebug, fmt.Sprintf("DBpedia comment failed: %v", err)) + } + + pdk.Log(pdk.LogInfo, fmt.Sprintf("Biography not found for: %s (%s)", input.Name, input.MBID)) + return nil, errors.New("biography not found") +} + +// GetArtistImages returns artist images from Wikidata +func (*wikimediaPlugin) GetArtistImages(input metadata.ArtistRequest) (*metadata.ArtistImagesResponse, error) { + pdk.Log(pdk.LogDebug, fmt.Sprintf("GetArtistImages: name=%s, mbid=%s", input.Name, input.MBID)) + + var q string + if input.MBID != "" { + q = fmt.Sprintf(`SELECT ?img WHERE { ?artist wdt:P434 "%s"; wdt:P18 ?img } LIMIT 1`, input.MBID) + } else if input.Name != "" { + escapedName := strings.ReplaceAll(input.Name, "\"", "\\\"") + q = fmt.Sprintf(`SELECT ?img WHERE { ?artist rdfs:label "%s"@en; wdt:P18 ?img } LIMIT 1`, escapedName) + } else { + return nil, errors.New("MBID or Name required for Wikidata Image lookup") + } + + result, err := sparqlQuery(wikidataEndpoint, q) + if err != nil { + pdk.Log(pdk.LogInfo, fmt.Sprintf("Image not found for: %s (%s)", input.Name, input.MBID)) + return nil, errors.New("image not found") + } + if result.Results.Bindings[0].Img != nil { + return &metadata.ArtistImagesResponse{ + Images: []metadata.ImageInfo{{URL: result.Results.Bindings[0].Img.Value, Size: 0}}, + }, nil + } + + pdk.Log(pdk.LogInfo, fmt.Sprintf("Image not found for: %s (%s)", input.Name, input.MBID)) + return nil, errors.New("image not found") +} + +// Required main function - init() handles registration +func main() {} diff --git a/plugins/examples/wikimedia/manifest.json b/plugins/examples/wikimedia/manifest.json new file mode 100644 index 000000000..8590d51a8 --- /dev/null +++ b/plugins/examples/wikimedia/manifest.json @@ -0,0 +1,17 @@ +{ + "name": "Wikimedia", + "author": "Navidrome", + "version": "1.0.0", + "description": "Fetches artist metadata from Wikidata, DBpedia and Wikipedia", + "website": "https://navidrome.org", + "permissions": { + "http": { + "reason": "Fetch metadata from Wikimedia APIs", + "requiredHosts": [ + "query.wikidata.org", + "dbpedia.org", + "en.wikipedia.org" + ] + } + } +} diff --git a/plugins/examples/wikimedia/prepare.sh b/plugins/examples/wikimedia/prepare.sh new file mode 100644 index 000000000..9fbb93cfb --- /dev/null +++ b/plugins/examples/wikimedia/prepare.sh @@ -0,0 +1,92 @@ +#!/bin/bash +set -eou pipefail + +# Function to check if a command exists +command_exists () { + command -v "$1" >/dev/null 2>&1 +} + +# Function to compare version numbers for "less than" +version_lt() { + test "$(echo "$@" | tr " " "\n" | sort -V | head -n 1)" = "$1" && test "$1" != "$2" +} + +missing_deps=0 + +# Check for Go +if ! (command_exists go); then + missing_deps=1 + echo "❌ Go (supported version between 1.20 - 1.24) is not installed." + echo "" + echo "To install Go, visit the official download page:" + echo "👉 https://go.dev/dl/" + echo "" + echo "Or install it using a package manager:" + echo "" + echo "🔹 macOS (Homebrew):" + echo " brew install go" + echo "" + echo "🔹 Ubuntu/Debian:" + echo " sudo apt-get -y install golang-go" + echo "" + echo "🔹 Arch Linux:" + echo " sudo pacman -S go" + echo "" + echo "🔹 Windows:" + echo " scoop install go" + echo "" +fi + +# Check for the right version of Go, needed by TinyGo (supports go 1.20 - 1.24) +if (command_exists go); then + compat=0 + for v in `seq 20 24`; do + if (go version | grep -q "go1.$v"); then + compat=1 + fi + done + + if [ $compat -eq 0 ]; then + echo "❌ Supported Go version is not installed. Must be Go 1.20 - 1.24." + echo "" + fi +fi + +ARCH=$(arch) + +# Check for TinyGo and its version +if ! (command_exists tinygo); then + missing_deps=1 + echo "❌ TinyGo is not installed." + echo "" + echo "To install TinyGo, visit the official download page:" + echo "👉 https://tinygo.org/getting-started/install/" + echo "" + echo "Or install it using a package manager:" + echo "" + echo "🔹 macOS (Homebrew):" + echo " brew tap tinygo-org/tools" + echo " brew install tinygo" + echo "" + echo "🔹 Ubuntu/Debian:" + echo " wget https://github.com/tinygo-org/tinygo/releases/download/v0.34.0/tinygo_0.34.0_$ARCH.deb" + echo " sudo dpkg -i tinygo_0.34.0_$ARCH.deb" + echo "" + echo "🔹 Arch Linux:" + echo " pacman -S extra/tinygo" + echo "" + echo "🔹 Windows:" + echo " scoop install tinygo" + echo "" +else + # Check TinyGo version + tinygo_version=$(tinygo version | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+' | head -n1) + if version_lt "$tinygo_version" "0.34.0"; then + missing_deps=1 + echo "❌ TinyGo version must be >= 0.34.0 (current version: $tinygo_version)" + echo "Please update TinyGo to a newer version." + echo "" + fi +fi + +go install golang.org/x/tools/cmd/goimports@latest diff --git a/plugins/examples/wikimedia/xtp.toml b/plugins/examples/wikimedia/xtp.toml new file mode 100755 index 000000000..73000ebcd --- /dev/null +++ b/plugins/examples/wikimedia/xtp.toml @@ -0,0 +1,17 @@ +app_id = "" + +# This is where 'xtp plugin push' expects to find the wasm file after the build script has run. +bin = "dist/plugin.wasm" +extension_point_id = "" +name = "wikimedia-plugin" + +[scripts] + + # xtp plugin build runs this script to generate the wasm file + build = "mkdir -p dist && tinygo build -buildmode c-shared -target wasip1 -o dist/plugin.wasm ." + + # xtp plugin init runs this script to format the plugin code + format = "go fmt && go mod tidy && goimports -w main.go" + + # xtp plugin init runs this script before running the format script + prepare = "bash prepare.sh && go get ./..." diff --git a/plugins/host/artwork.go b/plugins/host/artwork.go new file mode 100644 index 000000000..9b9d3e98e --- /dev/null +++ b/plugins/host/artwork.go @@ -0,0 +1,53 @@ +package host + +import "context" + +// ArtworkService provides artwork public URL generation capabilities for plugins. +// +// This service allows plugins to generate public URLs for artwork images of +// various entity types (artists, albums, tracks, playlists). The generated URLs +// include authentication tokens and can be used to display artwork in external +// services or custom UIs. +// +//nd:hostservice name=Artwork permission=artwork +type ArtworkService interface { + // GetArtistUrl generates a public URL for an artist's artwork. + // + // Parameters: + // - id: The artist's unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetArtistUrl(ctx context.Context, id string, size int32) (url string, err error) + + // GetAlbumUrl generates a public URL for an album's artwork. + // + // Parameters: + // - id: The album's unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetAlbumUrl(ctx context.Context, id string, size int32) (url string, err error) + + // GetTrackUrl generates a public URL for a track's artwork. + // + // Parameters: + // - id: The track's (media file) unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetTrackUrl(ctx context.Context, id string, size int32) (url string, err error) + + // GetPlaylistUrl generates a public URL for a playlist's artwork. + // + // Parameters: + // - id: The playlist's unique identifier + // - size: Desired image size in pixels (0 for original size) + // + // Returns the public URL for the artwork, or an error if generation fails. + //nd:hostfunc + GetPlaylistUrl(ctx context.Context, id string, size int32) (url string, err error) +} diff --git a/plugins/host/artwork_gen.go b/plugins/host/artwork_gen.go new file mode 100644 index 000000000..fbf807351 --- /dev/null +++ b/plugins/host/artwork_gen.go @@ -0,0 +1,230 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// ArtworkGetArtistUrlRequest is the request type for Artwork.GetArtistUrl. +type ArtworkGetArtistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetArtistUrlResponse is the response type for Artwork.GetArtistUrl. +type ArtworkGetArtistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetAlbumUrlRequest is the request type for Artwork.GetAlbumUrl. +type ArtworkGetAlbumUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetAlbumUrlResponse is the response type for Artwork.GetAlbumUrl. +type ArtworkGetAlbumUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetTrackUrlRequest is the request type for Artwork.GetTrackUrl. +type ArtworkGetTrackUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetTrackUrlResponse is the response type for Artwork.GetTrackUrl. +type ArtworkGetTrackUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetPlaylistUrlRequest is the request type for Artwork.GetPlaylistUrl. +type ArtworkGetPlaylistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +// ArtworkGetPlaylistUrlResponse is the response type for Artwork.GetPlaylistUrl. +type ArtworkGetPlaylistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterArtworkHostFunctions registers Artwork service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterArtworkHostFunctions(service ArtworkService) []extism.HostFunction { + return []extism.HostFunction{ + newArtworkGetArtistUrlHostFunction(service), + newArtworkGetAlbumUrlHostFunction(service), + newArtworkGetTrackUrlHostFunction(service), + newArtworkGetPlaylistUrlHostFunction(service), + } +} + +func newArtworkGetArtistUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_getartisturl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetArtistUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetArtistUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetArtistUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newArtworkGetAlbumUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_getalbumurl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetAlbumUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetAlbumUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetAlbumUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newArtworkGetTrackUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_gettrackurl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetTrackUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetTrackUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetTrackUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newArtworkGetPlaylistUrlHostFunction(service ArtworkService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "artwork_getplaylisturl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + artworkWriteError(p, stack, err) + return + } + var req ArtworkGetPlaylistUrlRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + artworkWriteError(p, stack, err) + return + } + + // Call the service method + url, svcErr := service.GetPlaylistUrl(ctx, req.Id, req.Size) + if svcErr != nil { + artworkWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := ArtworkGetPlaylistUrlResponse{ + Url: url, + } + artworkWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// artworkWriteResponse writes a JSON response to plugin memory. +func artworkWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + artworkWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// artworkWriteError writes an error response to plugin memory. +func artworkWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/cache.go b/plugins/host/cache.go new file mode 100644 index 000000000..37cb4da74 --- /dev/null +++ b/plugins/host/cache.go @@ -0,0 +1,117 @@ +package host + +import "context" + +// CacheService provides in-memory TTL-based caching capabilities for plugins. +// +// This service allows plugins to store and retrieve typed values (strings, integers, +// floats, and byte slices) with configurable time-to-live expiration. Each plugin's +// cache keys are automatically namespaced to prevent collisions between plugins. +// +// The cache is in-memory only and will be lost on server restart. Plugins should +// handle cache misses gracefully. +// +//nd:hostservice name=Cache permission=cache +type CacheService interface { + // SetString stores a string value in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The string value to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetString(ctx context.Context, key string, value string, ttlSeconds int64) error + + // GetString retrieves a string value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not a string, exists will be false. + //nd:hostfunc + GetString(ctx context.Context, key string) (value string, exists bool, err error) + + // SetInt stores an integer value in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The integer value to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetInt(ctx context.Context, key string, value int64, ttlSeconds int64) error + + // GetInt retrieves an integer value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not an integer, exists will be false. + //nd:hostfunc + GetInt(ctx context.Context, key string) (value int64, exists bool, err error) + + // SetFloat stores a float value in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The float value to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetFloat(ctx context.Context, key string, value float64, ttlSeconds int64) error + + // GetFloat retrieves a float value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not a float, exists will be false. + //nd:hostfunc + GetFloat(ctx context.Context, key string) (value float64, exists bool, err error) + + // SetBytes stores a byte slice in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // - value: The byte slice to store + // - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + // + // Returns an error if the operation fails. + //nd:hostfunc + SetBytes(ctx context.Context, key string, value []byte, ttlSeconds int64) error + + // GetBytes retrieves a byte slice from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns the value and whether the key exists. If the key doesn't exist + // or the stored value is not a byte slice, exists will be false. + //nd:hostfunc + GetBytes(ctx context.Context, key string) (value []byte, exists bool, err error) + + // Has checks if a key exists in the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns true if the key exists and has not expired. + //nd:hostfunc + Has(ctx context.Context, key string) (exists bool, err error) + + // Remove deletes a value from the cache. + // + // Parameters: + // - key: The cache key (will be namespaced with plugin ID) + // + // Returns an error if the operation fails. Does not return an error if the key doesn't exist. + //nd:hostfunc + Remove(ctx context.Context, key string) error +} diff --git a/plugins/host/cache_gen.go b/plugins/host/cache_gen.go new file mode 100644 index 000000000..5645c5495 --- /dev/null +++ b/plugins/host/cache_gen.go @@ -0,0 +1,498 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// CacheSetStringRequest is the request type for Cache.SetString. +type CacheSetStringRequest struct { + Key string `json:"key"` + Value string `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetStringResponse is the response type for Cache.SetString. +type CacheSetStringResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetStringRequest is the request type for Cache.GetString. +type CacheGetStringRequest struct { + Key string `json:"key"` +} + +// CacheGetStringResponse is the response type for Cache.GetString. +type CacheGetStringResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheSetIntRequest is the request type for Cache.SetInt. +type CacheSetIntRequest struct { + Key string `json:"key"` + Value int64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetIntResponse is the response type for Cache.SetInt. +type CacheSetIntResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetIntRequest is the request type for Cache.GetInt. +type CacheGetIntRequest struct { + Key string `json:"key"` +} + +// CacheGetIntResponse is the response type for Cache.GetInt. +type CacheGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheSetFloatRequest is the request type for Cache.SetFloat. +type CacheSetFloatRequest struct { + Key string `json:"key"` + Value float64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetFloatResponse is the response type for Cache.SetFloat. +type CacheSetFloatResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetFloatRequest is the request type for Cache.GetFloat. +type CacheGetFloatRequest struct { + Key string `json:"key"` +} + +// CacheGetFloatResponse is the response type for Cache.GetFloat. +type CacheGetFloatResponse struct { + Value float64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheSetBytesRequest is the request type for Cache.SetBytes. +type CacheSetBytesRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// CacheSetBytesResponse is the response type for Cache.SetBytes. +type CacheSetBytesResponse struct { + Error string `json:"error,omitempty"` +} + +// CacheGetBytesRequest is the request type for Cache.GetBytes. +type CacheGetBytesRequest struct { + Key string `json:"key"` +} + +// CacheGetBytesResponse is the response type for Cache.GetBytes. +type CacheGetBytesResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheHasRequest is the request type for Cache.Has. +type CacheHasRequest struct { + Key string `json:"key"` +} + +// CacheHasResponse is the response type for Cache.Has. +type CacheHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// CacheRemoveRequest is the request type for Cache.Remove. +type CacheRemoveRequest struct { + Key string `json:"key"` +} + +// CacheRemoveResponse is the response type for Cache.Remove. +type CacheRemoveResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterCacheHostFunctions registers Cache service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterCacheHostFunctions(service CacheService) []extism.HostFunction { + return []extism.HostFunction{ + newCacheSetStringHostFunction(service), + newCacheGetStringHostFunction(service), + newCacheSetIntHostFunction(service), + newCacheGetIntHostFunction(service), + newCacheSetFloatHostFunction(service), + newCacheGetFloatHostFunction(service), + newCacheSetBytesHostFunction(service), + newCacheGetBytesHostFunction(service), + newCacheHasHostFunction(service), + newCacheRemoveHostFunction(service), + } +} + +func newCacheSetStringHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setstring", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetStringRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetString(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetStringResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetStringHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getstring", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetStringRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetString(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetStringResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheSetIntHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setint", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetIntRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetInt(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetIntResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetIntHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getint", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetIntRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetInt(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetIntResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheSetFloatHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setfloat", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetFloatRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetFloat(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetFloatResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetFloatHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getfloat", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetFloatRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetFloat(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetFloatResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheSetBytesHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_setbytes", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheSetBytesRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetBytes(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheSetBytesResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheGetBytesHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_getbytes", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheGetBytesRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.GetBytes(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheGetBytesResponse{ + Value: value, + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheHasHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_has", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheHasRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + exists, svcErr := service.Has(ctx, req.Key) + if svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheHasResponse{ + Exists: exists, + } + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newCacheRemoveHostFunction(service CacheService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "cache_remove", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + cacheWriteError(p, stack, err) + return + } + var req CacheRemoveRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + cacheWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Remove(ctx, req.Key); svcErr != nil { + cacheWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := CacheRemoveResponse{} + cacheWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// cacheWriteResponse writes a JSON response to plugin memory. +func cacheWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + cacheWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// cacheWriteError writes an error response to plugin memory. +func cacheWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/config.go b/plugins/host/config.go new file mode 100644 index 000000000..0a0a62ca7 --- /dev/null +++ b/plugins/host/config.go @@ -0,0 +1,44 @@ +package host + +import "context" + +// ConfigService provides access to plugin configuration values. +// +// This service allows plugins to retrieve configuration values and enumerate +// available configuration keys. Unlike the built-in pdk.GetConfig(key) which +// only retrieves individual values, this service provides methods to list all +// available keys, making it useful for plugins that need to discover dynamic +// configuration (e.g., user-to-token mappings). +// +// This service is always available and does not require a permission in the manifest. +// +//nd:hostservice name=Config +type ConfigService interface { + // Get retrieves a configuration value as a string. + // + // Parameters: + // - key: The configuration key + // + // Returns the value and whether the key exists. + //nd:hostfunc + Get(ctx context.Context, key string) (value string, exists bool) + + // GetInt retrieves a configuration value as an integer. + // + // Parameters: + // - key: The configuration key + // + // Returns the value and whether the key exists. If the key exists but the + // value cannot be parsed as an integer, exists will be false. + //nd:hostfunc + GetInt(ctx context.Context, key string) (value int64, exists bool) + + // Keys returns configuration keys matching the given prefix. + // + // Parameters: + // - prefix: Key prefix to filter by. If empty, returns all keys. + // + // Returns a sorted slice of matching configuration keys. + //nd:hostfunc + Keys(ctx context.Context, prefix string) (keys []string) +} diff --git a/plugins/host/config_gen.go b/plugins/host/config_gen.go new file mode 100644 index 000000000..0fd1b6ef4 --- /dev/null +++ b/plugins/host/config_gen.go @@ -0,0 +1,169 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// ConfigGetRequest is the request type for Config.Get. +type ConfigGetRequest struct { + Key string `json:"key"` +} + +// ConfigGetResponse is the response type for Config.Get. +type ConfigGetResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +// ConfigGetIntRequest is the request type for Config.GetInt. +type ConfigGetIntRequest struct { + Key string `json:"key"` +} + +// ConfigGetIntResponse is the response type for Config.GetInt. +type ConfigGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +// ConfigKeysRequest is the request type for Config.Keys. +type ConfigKeysRequest struct { + Prefix string `json:"prefix"` +} + +// ConfigKeysResponse is the response type for Config.Keys. +type ConfigKeysResponse struct { + Keys []string `json:"keys,omitempty"` +} + +// RegisterConfigHostFunctions registers Config service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterConfigHostFunctions(service ConfigService) []extism.HostFunction { + return []extism.HostFunction{ + newConfigGetHostFunction(service), + newConfigGetIntHostFunction(service), + newConfigKeysHostFunction(service), + } +} + +func newConfigGetHostFunction(service ConfigService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "config_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + configWriteError(p, stack, err) + return + } + var req ConfigGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + configWriteError(p, stack, err) + return + } + + // Call the service method + value, exists := service.Get(ctx, req.Key) + + // Write JSON response to plugin memory + resp := ConfigGetResponse{ + Value: value, + Exists: exists, + } + configWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newConfigGetIntHostFunction(service ConfigService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "config_getint", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + configWriteError(p, stack, err) + return + } + var req ConfigGetIntRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + configWriteError(p, stack, err) + return + } + + // Call the service method + value, exists := service.GetInt(ctx, req.Key) + + // Write JSON response to plugin memory + resp := ConfigGetIntResponse{ + Value: value, + Exists: exists, + } + configWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newConfigKeysHostFunction(service ConfigService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "config_keys", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + configWriteError(p, stack, err) + return + } + var req ConfigKeysRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + configWriteError(p, stack, err) + return + } + + // Call the service method + keys := service.Keys(ctx, req.Prefix) + + // Write JSON response to plugin memory + resp := ConfigKeysResponse{ + Keys: keys, + } + configWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// configWriteResponse writes a JSON response to plugin memory. +func configWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + configWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// configWriteError writes an error response to plugin memory. +func configWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/doc.go b/plugins/host/doc.go new file mode 100644 index 000000000..10e2b846b --- /dev/null +++ b/plugins/host/doc.go @@ -0,0 +1,39 @@ +// Package host provides host services that can be called by plugins via Extism host functions. +// +// Host services allow plugins to access Navidrome functionality like the Subsonic API, +// scheduler, and other internal services. Services are defined as Go interfaces with +// special annotations that enable automatic code generation of Extism host function wrappers. +// +// # Annotation Format +// +// Host services use Go doc comment annotations to mark interfaces and methods for code generation: +// +// // MyService provides some functionality. +// //nd:hostservice name=MyService permission=myservice +// type MyService interface { +// // DoSomething performs an action. +// //nd:hostfunc +// DoSomething(ctx context.Context, input string) (output string, err error) +// } +// +// Service-level annotations: +// - //nd:hostservice - Marks an interface as a host service +// - name=<ServiceName> - Service identifier used in generated code +// - permission=<key> - Manifest permission key (e.g., "subsonicapi", "scheduler") +// +// Method-level annotations: +// - //nd:hostfunc - Marks a method for host function wrapper generation +// - name=<CustomName> - Optional: override the export name +// +// # Generated Code +// +// The ndpgen tool reads annotated interfaces and generates Extism host function wrappers +// that handle: +// - JSON serialization/deserialization of request/response types +// - Memory operations (ReadBytes, WriteBytes, Alloc) +// - Error handling and propagation +// - Service registration functions +// +// Generated files follow the pattern <servicename>_gen.go and include a header comment +// indicating they should not be edited manually. +package host diff --git a/plugins/host/http.go b/plugins/host/http.go new file mode 100644 index 000000000..96e832a0e --- /dev/null +++ b/plugins/host/http.go @@ -0,0 +1,41 @@ +package host + +import "context" + +// HTTPRequest represents an outbound HTTP request from a plugin. +type HTTPRequest struct { + Method string `json:"method"` + URL string `json:"url"` + Headers map[string]string `json:"headers,omitempty"` + NoFollowRedirects bool `json:"noFollowRedirects,omitempty"` + Body []byte `json:"body,omitempty"` + TimeoutMs int32 `json:"timeoutMs,omitempty"` +} + +// HTTPResponse represents the response from an outbound HTTP request. +type HTTPResponse struct { + StatusCode int32 `json:"statusCode"` + Headers map[string]string `json:"headers,omitempty"` + Body []byte `json:"body,omitempty"` +} + +// HTTPService provides outbound HTTP request capabilities for plugins. +// +// This service allows plugins to make HTTP requests to external services. +// Requests are validated against the plugin's declared requiredHosts patterns +// from the http permission in the manifest. Redirects are followed but each +// redirect destination is also validated against the allowed hosts. +// +//nd:hostservice name=HTTP permission=http +type HTTPService interface { + // Send executes an HTTP request and returns the response. + // + // Parameters: + // - request: The HTTP request to execute, including method, URL, headers, body, and timeout + // + // Returns the HTTP response with status code, headers, and body. + // Network errors, timeouts, and permission failures are returned as Go errors. + // Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. + //nd:hostfunc + Send(ctx context.Context, request HTTPRequest) (*HTTPResponse, error) +} diff --git a/plugins/host/http_gen.go b/plugins/host/http_gen.go new file mode 100644 index 000000000..c14a533d0 --- /dev/null +++ b/plugins/host/http_gen.go @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// HTTPSendRequest is the request type for HTTP.Send. +type HTTPSendRequest struct { + Request HTTPRequest `json:"request"` +} + +// HTTPSendResponse is the response type for HTTP.Send. +type HTTPSendResponse struct { + Result *HTTPResponse `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterHTTPHostFunctions registers HTTP service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterHTTPHostFunctions(service HTTPService) []extism.HostFunction { + return []extism.HostFunction{ + newHTTPSendHostFunction(service), + } +} + +func newHTTPSendHostFunction(service HTTPService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "http_send", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + httpWriteError(p, stack, err) + return + } + var req HTTPSendRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + httpWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Send(ctx, req.Request) + if svcErr != nil { + httpWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := HTTPSendResponse{ + Result: result, + } + httpWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// httpWriteResponse writes a JSON response to plugin memory. +func httpWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + httpWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// httpWriteError writes an error response to plugin memory. +func httpWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/kvstore.go b/plugins/host/kvstore.go new file mode 100644 index 000000000..aa2597f27 --- /dev/null +++ b/plugins/host/kvstore.go @@ -0,0 +1,98 @@ +package host + +import "context" + +// KVStoreService provides persistent key-value storage for plugins. +// +// Unlike CacheService which is in-memory only, KVStoreService persists data +// to disk and survives server restarts. Each plugin has its own isolated +// storage with configurable size limits. +// +// Values are stored as raw bytes, giving plugins full control over +// serialization (JSON, protobuf, etc.). +// +//nd:hostservice name=KVStore permission=kvstore +type KVStoreService interface { + // Set stores a byte value with the given key. + // + // Parameters: + // - key: The storage key (max 256 bytes, UTF-8) + // - value: The byte slice to store + // + // Returns an error if the storage limit would be exceeded or the operation fails. + //nd:hostfunc + Set(ctx context.Context, key string, value []byte) error + + // SetWithTTL stores a byte value with the given key and a time-to-live. + // + // After ttlSeconds, the key is treated as non-existent and will be + // cleaned up lazily. ttlSeconds must be greater than 0. + // + // Parameters: + // - key: The storage key (max 256 bytes, UTF-8) + // - value: The byte slice to store + // - ttlSeconds: Time-to-live in seconds (must be > 0) + // + // Returns an error if the storage limit would be exceeded or the operation fails. + //nd:hostfunc + SetWithTTL(ctx context.Context, key string, value []byte, ttlSeconds int64) error + + // Get retrieves a byte value from storage. + // + // Parameters: + // - key: The storage key + // + // Returns the value and whether the key exists. + //nd:hostfunc + Get(ctx context.Context, key string) (value []byte, exists bool, err error) + + // GetMany retrieves multiple values in a single call. + // + // Parameters: + // - keys: The storage keys to retrieve + // + // Returns a map of key to value for keys that exist and have not expired. + // Missing or expired keys are omitted from the result. + //nd:hostfunc + GetMany(ctx context.Context, keys []string) (values map[string][]byte, err error) + + // Has checks if a key exists in storage. + // + // Parameters: + // - key: The storage key + // + // Returns true if the key exists. + //nd:hostfunc + Has(ctx context.Context, key string) (exists bool, err error) + + // List returns all keys matching the given prefix. + // + // Parameters: + // - prefix: Key prefix to filter by (empty string returns all keys) + // + // Returns a slice of matching keys. + //nd:hostfunc + List(ctx context.Context, prefix string) (keys []string, err error) + + // Delete removes a value from storage. + // + // Parameters: + // - key: The storage key + // + // Returns an error if the operation fails. Does not return an error if the key doesn't exist. + //nd:hostfunc + Delete(ctx context.Context, key string) error + + // DeleteByPrefix removes all keys matching the given prefix. + // + // Parameters: + // - prefix: Key prefix to match (must not be empty) + // + // Returns the number of keys deleted. Includes expired keys. + //nd:hostfunc + DeleteByPrefix(ctx context.Context, prefix string) (deletedCount int64, err error) + + // GetStorageUsed returns the total storage used by this plugin in bytes. + //nd:hostfunc + GetStorageUsed(ctx context.Context) (bytes int64, err error) +} diff --git a/plugins/host/kvstore_gen.go b/plugins/host/kvstore_gen.go new file mode 100644 index 000000000..44ee3b131 --- /dev/null +++ b/plugins/host/kvstore_gen.go @@ -0,0 +1,433 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// KVStoreSetRequest is the request type for KVStore.Set. +type KVStoreSetRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` +} + +// KVStoreSetResponse is the response type for KVStore.Set. +type KVStoreSetResponse struct { + Error string `json:"error,omitempty"` +} + +// KVStoreSetWithTTLRequest is the request type for KVStore.SetWithTTL. +type KVStoreSetWithTTLRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +// KVStoreSetWithTTLResponse is the response type for KVStore.SetWithTTL. +type KVStoreSetWithTTLResponse struct { + Error string `json:"error,omitempty"` +} + +// KVStoreGetRequest is the request type for KVStore.Get. +type KVStoreGetRequest struct { + Key string `json:"key"` +} + +// KVStoreGetResponse is the response type for KVStore.Get. +type KVStoreGetResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreGetManyRequest is the request type for KVStore.GetMany. +type KVStoreGetManyRequest struct { + Keys []string `json:"keys"` +} + +// KVStoreGetManyResponse is the response type for KVStore.GetMany. +type KVStoreGetManyResponse struct { + Values map[string][]byte `json:"values,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreHasRequest is the request type for KVStore.Has. +type KVStoreHasRequest struct { + Key string `json:"key"` +} + +// KVStoreHasResponse is the response type for KVStore.Has. +type KVStoreHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreListRequest is the request type for KVStore.List. +type KVStoreListRequest struct { + Prefix string `json:"prefix"` +} + +// KVStoreListResponse is the response type for KVStore.List. +type KVStoreListResponse struct { + Keys []string `json:"keys,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreDeleteRequest is the request type for KVStore.Delete. +type KVStoreDeleteRequest struct { + Key string `json:"key"` +} + +// KVStoreDeleteResponse is the response type for KVStore.Delete. +type KVStoreDeleteResponse struct { + Error string `json:"error,omitempty"` +} + +// KVStoreDeleteByPrefixRequest is the request type for KVStore.DeleteByPrefix. +type KVStoreDeleteByPrefixRequest struct { + Prefix string `json:"prefix"` +} + +// KVStoreDeleteByPrefixResponse is the response type for KVStore.DeleteByPrefix. +type KVStoreDeleteByPrefixResponse struct { + DeletedCount int64 `json:"deletedCount,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreGetStorageUsedResponse is the response type for KVStore.GetStorageUsed. +type KVStoreGetStorageUsedResponse struct { + Bytes int64 `json:"bytes,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterKVStoreHostFunctions registers KVStore service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterKVStoreHostFunctions(service KVStoreService) []extism.HostFunction { + return []extism.HostFunction{ + newKVStoreSetHostFunction(service), + newKVStoreSetWithTTLHostFunction(service), + newKVStoreGetHostFunction(service), + newKVStoreGetManyHostFunction(service), + newKVStoreHasHostFunction(service), + newKVStoreListHostFunction(service), + newKVStoreDeleteHostFunction(service), + newKVStoreDeleteByPrefixHostFunction(service), + newKVStoreGetStorageUsedHostFunction(service), + } +} + +func newKVStoreSetHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_set", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreSetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Set(ctx, req.Key, req.Value); svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreSetResponse{} + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreSetWithTTLHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_setwithttl", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreSetWithTTLRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SetWithTTL(ctx, req.Key, req.Value, req.TtlSeconds); svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreSetWithTTLResponse{} + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreGetHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + value, exists, svcErr := service.Get(ctx, req.Key) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreGetResponse{ + Value: value, + Exists: exists, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreGetManyHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_getmany", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreGetManyRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + values, svcErr := service.GetMany(ctx, req.Keys) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreGetManyResponse{ + Values: values, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreHasHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_has", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreHasRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + exists, svcErr := service.Has(ctx, req.Key) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreHasResponse{ + Exists: exists, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreListHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_list", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreListRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + keys, svcErr := service.List(ctx, req.Prefix) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreListResponse{ + Keys: keys, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreDeleteHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_delete", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreDeleteRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Delete(ctx, req.Key); svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreDeleteResponse{} + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreDeleteByPrefixHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_deletebyprefix", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + var req KVStoreDeleteByPrefixRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + kvstoreWriteError(p, stack, err) + return + } + + // Call the service method + deletedcount, svcErr := service.DeleteByPrefix(ctx, req.Prefix) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreDeleteByPrefixResponse{ + DeletedCount: deletedcount, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newKVStoreGetStorageUsedHostFunction(service KVStoreService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "kvstore_getstorageused", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + bytes, svcErr := service.GetStorageUsed(ctx) + if svcErr != nil { + kvstoreWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := KVStoreGetStorageUsedResponse{ + Bytes: bytes, + } + kvstoreWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// kvstoreWriteResponse writes a JSON response to plugin memory. +func kvstoreWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + kvstoreWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// kvstoreWriteError writes an error response to plugin memory. +func kvstoreWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/library.go b/plugins/host/library.go new file mode 100644 index 000000000..ed86b8b3d --- /dev/null +++ b/plugins/host/library.go @@ -0,0 +1,41 @@ +package host + +import "context" + +// Library represents a music library with metadata. +type Library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path,omitempty"` + MountPoint string `json:"mountPoint,omitempty"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` +} + +// LibraryService provides access to music library metadata for plugins. +// +// This service allows plugins to query information about configured music libraries, +// including statistics and optionally filesystem access to library directories. +// Filesystem access is controlled via the `filesystem` permission flag. +// +//nd:hostservice name=Library permission=library +type LibraryService interface { + // GetLibrary retrieves metadata for a specific library by ID. + // + // Parameters: + // - id: The library's unique identifier + // + // Returns the library metadata, or an error if the library is not found. + //nd:hostfunc + GetLibrary(ctx context.Context, id int32) (*Library, error) + + // GetAllLibraries retrieves metadata for all configured libraries. + // + // Returns a slice of all libraries with their metadata. + //nd:hostfunc + GetAllLibraries(ctx context.Context) ([]Library, error) +} diff --git a/plugins/host/library_gen.go b/plugins/host/library_gen.go new file mode 100644 index 000000000..27195e85c --- /dev/null +++ b/plugins/host/library_gen.go @@ -0,0 +1,118 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// LibraryGetLibraryRequest is the request type for Library.GetLibrary. +type LibraryGetLibraryRequest struct { + Id int32 `json:"id"` +} + +// LibraryGetLibraryResponse is the response type for Library.GetLibrary. +type LibraryGetLibraryResponse struct { + Result *Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// LibraryGetAllLibrariesResponse is the response type for Library.GetAllLibraries. +type LibraryGetAllLibrariesResponse struct { + Result []Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterLibraryHostFunctions registers Library service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterLibraryHostFunctions(service LibraryService) []extism.HostFunction { + return []extism.HostFunction{ + newLibraryGetLibraryHostFunction(service), + newLibraryGetAllLibrariesHostFunction(service), + } +} + +func newLibraryGetLibraryHostFunction(service LibraryService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "library_getlibrary", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + libraryWriteError(p, stack, err) + return + } + var req LibraryGetLibraryRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + libraryWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.GetLibrary(ctx, req.Id) + if svcErr != nil { + libraryWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := LibraryGetLibraryResponse{ + Result: result, + } + libraryWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newLibraryGetAllLibrariesHostFunction(service LibraryService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "library_getalllibraries", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + result, svcErr := service.GetAllLibraries(ctx) + if svcErr != nil { + libraryWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := LibraryGetAllLibrariesResponse{ + Result: result, + } + libraryWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// libraryWriteResponse writes a JSON response to plugin memory. +func libraryWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + libraryWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// libraryWriteError writes an error response to plugin memory. +func libraryWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/scheduler.go b/plugins/host/scheduler.go new file mode 100644 index 000000000..d640bc97b --- /dev/null +++ b/plugins/host/scheduler.go @@ -0,0 +1,44 @@ +package host + +import "context" + +// SchedulerService provides task scheduling capabilities for plugins. +// +// This service allows plugins to schedule both one-time and recurring tasks using +// cron expressions. All scheduled tasks can be cancelled using their schedule ID. +// +//nd:hostservice name=Scheduler permission=scheduler +type SchedulerService interface { + // ScheduleOneTime schedules a one-time event to be triggered after the specified delay. + // Plugins that use this function must also implement the SchedulerCallback capability + // + // Parameters: + // - delaySeconds: Number of seconds to wait before triggering the event + // - payload: Data to be passed to the scheduled event handler + // - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + // + // Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + //nd:hostfunc + ScheduleOneTime(ctx context.Context, delaySeconds int32, payload string, scheduleID string) (newScheduleID string, err error) + + // ScheduleRecurring schedules a recurring event using a cron expression. + // Plugins that use this function must also implement the SchedulerCallback capability + // + // Parameters: + // - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) + // - payload: Data to be passed to each scheduled event handler invocation + // - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + // + // Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + //nd:hostfunc + ScheduleRecurring(ctx context.Context, cronExpression string, payload string, scheduleID string) (newScheduleID string, err error) + + // CancelSchedule cancels a scheduled job identified by its schedule ID. + // + // This works for both one-time and recurring schedules. Once cancelled, the job will not trigger + // any future events. + // + // Returns an error if the schedule ID is not found or if cancellation fails. + //nd:hostfunc + CancelSchedule(ctx context.Context, scheduleID string) error +} diff --git a/plugins/host/scheduler_gen.go b/plugins/host/scheduler_gen.go new file mode 100644 index 000000000..d3845419c --- /dev/null +++ b/plugins/host/scheduler_gen.go @@ -0,0 +1,180 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// SchedulerScheduleOneTimeRequest is the request type for Scheduler.ScheduleOneTime. +type SchedulerScheduleOneTimeRequest struct { + DelaySeconds int32 `json:"delaySeconds"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +// SchedulerScheduleOneTimeResponse is the response type for Scheduler.ScheduleOneTime. +type SchedulerScheduleOneTimeResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +// SchedulerScheduleRecurringRequest is the request type for Scheduler.ScheduleRecurring. +type SchedulerScheduleRecurringRequest struct { + CronExpression string `json:"cronExpression"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +// SchedulerScheduleRecurringResponse is the response type for Scheduler.ScheduleRecurring. +type SchedulerScheduleRecurringResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +// SchedulerCancelScheduleRequest is the request type for Scheduler.CancelSchedule. +type SchedulerCancelScheduleRequest struct { + ScheduleID string `json:"scheduleId"` +} + +// SchedulerCancelScheduleResponse is the response type for Scheduler.CancelSchedule. +type SchedulerCancelScheduleResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterSchedulerHostFunctions registers Scheduler service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterSchedulerHostFunctions(service SchedulerService) []extism.HostFunction { + return []extism.HostFunction{ + newSchedulerScheduleOneTimeHostFunction(service), + newSchedulerScheduleRecurringHostFunction(service), + newSchedulerCancelScheduleHostFunction(service), + } +} + +func newSchedulerScheduleOneTimeHostFunction(service SchedulerService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "scheduler_scheduleonetime", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + var req SchedulerScheduleOneTimeRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + schedulerWriteError(p, stack, err) + return + } + + // Call the service method + newscheduleid, svcErr := service.ScheduleOneTime(ctx, req.DelaySeconds, req.Payload, req.ScheduleID) + if svcErr != nil { + schedulerWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SchedulerScheduleOneTimeResponse{ + NewScheduleID: newscheduleid, + } + schedulerWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newSchedulerScheduleRecurringHostFunction(service SchedulerService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "scheduler_schedulerecurring", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + var req SchedulerScheduleRecurringRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + schedulerWriteError(p, stack, err) + return + } + + // Call the service method + newscheduleid, svcErr := service.ScheduleRecurring(ctx, req.CronExpression, req.Payload, req.ScheduleID) + if svcErr != nil { + schedulerWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SchedulerScheduleRecurringResponse{ + NewScheduleID: newscheduleid, + } + schedulerWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newSchedulerCancelScheduleHostFunction(service SchedulerService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "scheduler_cancelschedule", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + var req SchedulerCancelScheduleRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + schedulerWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.CancelSchedule(ctx, req.ScheduleID); svcErr != nil { + schedulerWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SchedulerCancelScheduleResponse{} + schedulerWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// schedulerWriteResponse writes a JSON response to plugin memory. +func schedulerWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + schedulerWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// schedulerWriteError writes an error response to plugin memory. +func schedulerWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/subsonicapi.go b/plugins/host/subsonicapi.go new file mode 100644 index 000000000..32de75e77 --- /dev/null +++ b/plugins/host/subsonicapi.go @@ -0,0 +1,24 @@ +package host + +import "context" + +// SubsonicAPIService provides access to Navidrome's Subsonic API from plugins. +// +// This service allows plugins to make Subsonic API requests on behalf of the plugin's user, +// enabling access to library data, user preferences, and other Subsonic-compatible operations. +// +//nd:hostservice name=SubsonicAPI permission=subsonicapi +type SubsonicAPIService interface { + // Call executes a Subsonic API request and returns the JSON response. + // + // The uri parameter should be the Subsonic API path without the server prefix, + // e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. + //nd:hostfunc + Call(ctx context.Context, uri string) (responseJSON string, err error) + + // CallRaw executes a Subsonic API request and returns the raw binary response. + // Designed for binary endpoints like getCoverArt and stream that return + // non-JSON data. The data is base64-encoded over JSON on the wire. + //nd:hostfunc + CallRaw(ctx context.Context, uri string) (contentType string, data []byte, err error) +} diff --git a/plugins/host/subsonicapi_gen.go b/plugins/host/subsonicapi_gen.go new file mode 100644 index 000000000..52474030e --- /dev/null +++ b/plugins/host/subsonicapi_gen.go @@ -0,0 +1,136 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// SubsonicAPICallRequest is the request type for SubsonicAPI.Call. +type SubsonicAPICallRequest struct { + Uri string `json:"uri"` +} + +// SubsonicAPICallResponse is the response type for SubsonicAPI.Call. +type SubsonicAPICallResponse struct { + ResponseJSON string `json:"responseJson,omitempty"` + Error string `json:"error,omitempty"` +} + +// SubsonicAPICallRawRequest is the request type for SubsonicAPI.CallRaw. +type SubsonicAPICallRawRequest struct { + Uri string `json:"uri"` +} + +// SubsonicAPICallRawResponse is the response type for SubsonicAPI.CallRaw. +type SubsonicAPICallRawResponse struct { + ContentType string `json:"contentType,omitempty"` + Data []byte `json:"data,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterSubsonicAPIHostFunctions registers SubsonicAPI service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterSubsonicAPIHostFunctions(service SubsonicAPIService) []extism.HostFunction { + return []extism.HostFunction{ + newSubsonicAPICallHostFunction(service), + newSubsonicAPICallRawHostFunction(service), + } +} + +func newSubsonicAPICallHostFunction(service SubsonicAPIService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "subsonicapi_call", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + subsonicapiWriteError(p, stack, err) + return + } + var req SubsonicAPICallRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + subsonicapiWriteError(p, stack, err) + return + } + + // Call the service method + responsejson, svcErr := service.Call(ctx, req.Uri) + if svcErr != nil { + subsonicapiWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SubsonicAPICallResponse{ + ResponseJSON: responsejson, + } + subsonicapiWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newSubsonicAPICallRawHostFunction(service SubsonicAPIService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "subsonicapi_callraw", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + subsonicapiWriteError(p, stack, err) + return + } + var req SubsonicAPICallRawRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + subsonicapiWriteError(p, stack, err) + return + } + + // Call the service method + contenttype, data, svcErr := service.CallRaw(ctx, req.Uri) + if svcErr != nil { + subsonicapiWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := SubsonicAPICallRawResponse{ + ContentType: contenttype, + Data: data, + } + subsonicapiWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// subsonicapiWriteResponse writes a JSON response to plugin memory. +func subsonicapiWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + subsonicapiWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// subsonicapiWriteError writes an error response to plugin memory. +func subsonicapiWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/task.go b/plugins/host/task.go new file mode 100644 index 000000000..dcaf7197e --- /dev/null +++ b/plugins/host/task.go @@ -0,0 +1,73 @@ +package host + +import "context" + +// TaskInfo holds the current state of a task. +type TaskInfo struct { + // Status is the current task status: "pending", "running", + // "completed", "failed", or "cancelled". + Status string `json:"status"` + // Message is the status/result message returned by the plugin callback. + Message string `json:"message"` + // Attempt is the current or last attempt number (1-based). + Attempt int32 `json:"attempt"` +} + +// QueueConfig holds configuration for a task queue. +type QueueConfig struct { + // Concurrency is the max number of parallel workers. Default: 1. + // Capped by the plugin's manifest maxConcurrency. + Concurrency int32 `json:"concurrency"` + + // MaxRetries is the number of times to retry a failed task. Default: 0. + MaxRetries int32 `json:"maxRetries"` + + // BackoffMs is the initial backoff between retries in milliseconds. + // Doubles each retry (exponential: backoffMs * 2^(attempt-1)). Default: 1000. + BackoffMs int64 `json:"backoffMs"` + + // DelayMs is the minimum delay between starting consecutive tasks + // in milliseconds. Useful for rate limiting. Default: 0. + DelayMs int64 `json:"delayMs"` + + // RetentionMs is how long completed/failed/cancelled tasks are kept + // in milliseconds. Default: 3600000 (1h). Min: 60000 (1m). Max: 604800000 (1w). + RetentionMs int64 `json:"retentionMs"` +} + +// TaskService provides persistent task queues for plugins. +// +// This service allows plugins to create named queues with configurable concurrency, +// retry policies, and rate limiting. Tasks are persisted to SQLite and survive +// server restarts. When a task is ready to execute, the host calls the plugin's +// nd_task_execute callback function. +// +//nd:hostservice name=Task permission=taskqueue +type TaskService interface { + // CreateQueue creates a named task queue with the given configuration. + // Zero-value fields in config use sensible defaults. + // If a queue with the same name already exists, returns an error. + // On startup, this also recovers any stale "running" tasks from a previous crash. + //nd:hostfunc + CreateQueue(ctx context.Context, name string, config QueueConfig) error + + // Enqueue adds a task to the named queue. Returns the task ID. + // payload is opaque bytes passed back to the plugin on execution. + //nd:hostfunc + Enqueue(ctx context.Context, queueName string, payload []byte) (string, error) + + // Get returns the current state of a task including its status, + // message, and attempt count. + //nd:hostfunc + Get(ctx context.Context, taskID string) (*TaskInfo, error) + + // Cancel cancels a pending task. Returns error if already + // running, completed, or failed. + //nd:hostfunc + Cancel(ctx context.Context, taskID string) error + + // ClearQueue removes all pending tasks from the named queue. + // Running tasks are not affected. Returns the number of tasks removed. + //nd:hostfunc + ClearQueue(ctx context.Context, queueName string) (int64, error) +} diff --git a/plugins/host/task_gen.go b/plugins/host/task_gen.go new file mode 100644 index 000000000..e4864bb5b --- /dev/null +++ b/plugins/host/task_gen.go @@ -0,0 +1,266 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// TaskCreateQueueRequest is the request type for Task.CreateQueue. +type TaskCreateQueueRequest struct { + Name string `json:"name"` + Config QueueConfig `json:"config"` +} + +// TaskCreateQueueResponse is the response type for Task.CreateQueue. +type TaskCreateQueueResponse struct { + Error string `json:"error,omitempty"` +} + +// TaskEnqueueRequest is the request type for Task.Enqueue. +type TaskEnqueueRequest struct { + QueueName string `json:"queueName"` + Payload []byte `json:"payload"` +} + +// TaskEnqueueResponse is the response type for Task.Enqueue. +type TaskEnqueueResponse struct { + Result string `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// TaskGetRequest is the request type for Task.Get. +type TaskGetRequest struct { + TaskID string `json:"taskId"` +} + +// TaskGetResponse is the response type for Task.Get. +type TaskGetResponse struct { + Result *TaskInfo `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// TaskCancelRequest is the request type for Task.Cancel. +type TaskCancelRequest struct { + TaskID string `json:"taskId"` +} + +// TaskCancelResponse is the response type for Task.Cancel. +type TaskCancelResponse struct { + Error string `json:"error,omitempty"` +} + +// TaskClearQueueRequest is the request type for Task.ClearQueue. +type TaskClearQueueRequest struct { + QueueName string `json:"queueName"` +} + +// TaskClearQueueResponse is the response type for Task.ClearQueue. +type TaskClearQueueResponse struct { + Result int64 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterTaskHostFunctions registers Task service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterTaskHostFunctions(service TaskService) []extism.HostFunction { + return []extism.HostFunction{ + newTaskCreateQueueHostFunction(service), + newTaskEnqueueHostFunction(service), + newTaskGetHostFunction(service), + newTaskCancelHostFunction(service), + newTaskClearQueueHostFunction(service), + } +} + +func newTaskCreateQueueHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_createqueue", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskCreateQueueRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.CreateQueue(ctx, req.Name, req.Config); svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskCreateQueueResponse{} + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskEnqueueHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_enqueue", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskEnqueueRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Enqueue(ctx, req.QueueName, req.Payload) + if svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskEnqueueResponse{ + Result: result, + } + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskGetHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_get", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskGetRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.Get(ctx, req.TaskID) + if svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskGetResponse{ + Result: result, + } + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskCancelHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_cancel", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskCancelRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.Cancel(ctx, req.TaskID); svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskCancelResponse{} + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newTaskClearQueueHostFunction(service TaskService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "task_clearqueue", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + taskWriteError(p, stack, err) + return + } + var req TaskClearQueueRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + taskWriteError(p, stack, err) + return + } + + // Call the service method + result, svcErr := service.ClearQueue(ctx, req.QueueName) + if svcErr != nil { + taskWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := TaskClearQueueResponse{ + Result: result, + } + taskWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// taskWriteResponse writes a JSON response to plugin memory. +func taskWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + taskWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// taskWriteError writes an error response to plugin memory. +func taskWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/users.go b/plugins/host/users.go new file mode 100644 index 000000000..c05a0c797 --- /dev/null +++ b/plugins/host/users.go @@ -0,0 +1,35 @@ +package host + +import "context" + +// User represents a Navidrome user with minimal information exposed to plugins. +// Sensitive fields like password, email, and internal IDs are intentionally excluded. +type User struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// UsersService provides access to user information for plugins. +// +// This service allows plugins to query information about users that the plugin +// has been granted access to. Access is controlled by the administrator who +// configures which users each plugin can see. +// +//nd:hostservice name=Users permission=users +type UsersService interface { + // GetUsers returns all users the plugin has been granted access to. + // Only minimal user information (userName, name, isAdmin) is returned. + // Sensitive fields like password and email are never exposed. + // + // Returns a slice of users the plugin can access, or an empty slice if none configured. + //nd:hostfunc + GetUsers(ctx context.Context) ([]User, error) + + // GetAdmins returns only admin users the plugin has been granted access to. + // This is a convenience method that filters GetUsers results to include only admins. + // + // Returns a slice of admin users the plugin can access, or an empty slice if none. + //nd:hostfunc + GetAdmins(ctx context.Context) ([]User, error) +} diff --git a/plugins/host/users_gen.go b/plugins/host/users_gen.go new file mode 100644 index 000000000..4e7210991 --- /dev/null +++ b/plugins/host/users_gen.go @@ -0,0 +1,102 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// UsersGetUsersResponse is the response type for Users.GetUsers. +type UsersGetUsersResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// UsersGetAdminsResponse is the response type for Users.GetAdmins. +type UsersGetAdminsResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// RegisterUsersHostFunctions registers Users service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterUsersHostFunctions(service UsersService) []extism.HostFunction { + return []extism.HostFunction{ + newUsersGetUsersHostFunction(service), + newUsersGetAdminsHostFunction(service), + } +} + +func newUsersGetUsersHostFunction(service UsersService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "users_getusers", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + result, svcErr := service.GetUsers(ctx) + if svcErr != nil { + usersWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := UsersGetUsersResponse{ + Result: result, + } + usersWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newUsersGetAdminsHostFunction(service UsersService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "users_getadmins", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + + // Call the service method + result, svcErr := service.GetAdmins(ctx) + if svcErr != nil { + usersWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := UsersGetAdminsResponse{ + Result: result, + } + usersWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// usersWriteResponse writes a JSON response to plugin memory. +func usersWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + usersWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// usersWriteError writes an error response to plugin memory. +func usersWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host/websocket.go b/plugins/host/websocket.go new file mode 100644 index 000000000..434a28a8a --- /dev/null +++ b/plugins/host/websocket.go @@ -0,0 +1,59 @@ +package host + +import "context" + +// WebSocketService provides WebSocket communication capabilities for plugins. +// +// This service allows plugins to establish WebSocket connections to external services, +// send and receive messages, and manage connection lifecycle. Plugins using this service +// must implement the WebSocketCallback capability to receive incoming messages and +// connection state changes. +// +//nd:hostservice name=WebSocket permission=websocket +type WebSocketService interface { + // Connect establishes a WebSocket connection to the specified URL. + // + // Plugins that use this function must also implement the WebSocketCallback capability + // to receive incoming messages and connection events. + // + // Parameters: + // - url: The WebSocket URL to connect to (ws:// or wss://) + // - headers: Optional HTTP headers to include in the handshake request + // - connectionID: Optional unique identifier for the connection. If empty, one will be generated + // + // Returns the connection ID that can be used to send messages or close the connection, + // or an error if the connection fails. + //nd:hostfunc + Connect(ctx context.Context, url string, headers map[string]string, connectionID string) (newConnectionID string, err error) + + // SendText sends a text message over an established WebSocket connection. + // + // Parameters: + // - connectionID: The connection identifier returned by Connect + // - message: The text message to send + // + // Returns an error if the connection is not found or if sending fails. + //nd:hostfunc + SendText(ctx context.Context, connectionID, message string) error + + // SendBinary sends binary data over an established WebSocket connection. + // + // Parameters: + // - connectionID: The connection identifier returned by Connect + // - data: The binary data to send + // + // Returns an error if the connection is not found or if sending fails. + //nd:hostfunc + SendBinary(ctx context.Context, connectionID string, data []byte) error + + // CloseConnection gracefully closes a WebSocket connection. + // + // Parameters: + // - connectionID: The connection identifier returned by Connect + // - code: WebSocket close status code (e.g., 1000 for normal closure) + // - reason: Optional human-readable reason for closing + // + // Returns an error if the connection is not found or if closing fails. + //nd:hostfunc + CloseConnection(ctx context.Context, connectionID string, code int32, reason string) error +} diff --git a/plugins/host/websocket_gen.go b/plugins/host/websocket_gen.go new file mode 100644 index 000000000..b7b630674 --- /dev/null +++ b/plugins/host/websocket_gen.go @@ -0,0 +1,220 @@ +// Code generated by ndpgen. DO NOT EDIT. + +package host + +import ( + "context" + "encoding/json" + + extism "github.com/extism/go-sdk" +) + +// WebSocketConnectRequest is the request type for WebSocket.Connect. +type WebSocketConnectRequest struct { + Url string `json:"url"` + Headers map[string]string `json:"headers"` + ConnectionID string `json:"connectionId"` +} + +// WebSocketConnectResponse is the response type for WebSocket.Connect. +type WebSocketConnectResponse struct { + NewConnectionID string `json:"newConnectionId,omitempty"` + Error string `json:"error,omitempty"` +} + +// WebSocketSendTextRequest is the request type for WebSocket.SendText. +type WebSocketSendTextRequest struct { + ConnectionID string `json:"connectionId"` + Message string `json:"message"` +} + +// WebSocketSendTextResponse is the response type for WebSocket.SendText. +type WebSocketSendTextResponse struct { + Error string `json:"error,omitempty"` +} + +// WebSocketSendBinaryRequest is the request type for WebSocket.SendBinary. +type WebSocketSendBinaryRequest struct { + ConnectionID string `json:"connectionId"` + Data []byte `json:"data"` +} + +// WebSocketSendBinaryResponse is the response type for WebSocket.SendBinary. +type WebSocketSendBinaryResponse struct { + Error string `json:"error,omitempty"` +} + +// WebSocketCloseConnectionRequest is the request type for WebSocket.CloseConnection. +type WebSocketCloseConnectionRequest struct { + ConnectionID string `json:"connectionId"` + Code int32 `json:"code"` + Reason string `json:"reason"` +} + +// WebSocketCloseConnectionResponse is the response type for WebSocket.CloseConnection. +type WebSocketCloseConnectionResponse struct { + Error string `json:"error,omitempty"` +} + +// RegisterWebSocketHostFunctions registers WebSocket service host functions. +// The returned host functions should be added to the plugin's configuration. +func RegisterWebSocketHostFunctions(service WebSocketService) []extism.HostFunction { + return []extism.HostFunction{ + newWebSocketConnectHostFunction(service), + newWebSocketSendTextHostFunction(service), + newWebSocketSendBinaryHostFunction(service), + newWebSocketCloseConnectionHostFunction(service), + } +} + +func newWebSocketConnectHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_connect", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketConnectRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + newconnectionid, svcErr := service.Connect(ctx, req.Url, req.Headers, req.ConnectionID) + if svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketConnectResponse{ + NewConnectionID: newconnectionid, + } + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newWebSocketSendTextHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_sendtext", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketSendTextRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SendText(ctx, req.ConnectionID, req.Message); svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketSendTextResponse{} + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newWebSocketSendBinaryHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_sendbinary", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketSendBinaryRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.SendBinary(ctx, req.ConnectionID, req.Data); svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketSendBinaryResponse{} + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +func newWebSocketCloseConnectionHostFunction(service WebSocketService) extism.HostFunction { + return extism.NewHostFunctionWithStack( + "websocket_closeconnection", + func(ctx context.Context, p *extism.CurrentPlugin, stack []uint64) { + // Read JSON request from plugin memory + reqBytes, err := p.ReadBytes(stack[0]) + if err != nil { + websocketWriteError(p, stack, err) + return + } + var req WebSocketCloseConnectionRequest + if err := json.Unmarshal(reqBytes, &req); err != nil { + websocketWriteError(p, stack, err) + return + } + + // Call the service method + if svcErr := service.CloseConnection(ctx, req.ConnectionID, req.Code, req.Reason); svcErr != nil { + websocketWriteError(p, stack, svcErr) + return + } + + // Write JSON response to plugin memory + resp := WebSocketCloseConnectionResponse{} + websocketWriteResponse(p, stack, resp) + }, + []extism.ValueType{extism.ValueTypePTR}, + []extism.ValueType{extism.ValueTypePTR}, + ) +} + +// websocketWriteResponse writes a JSON response to plugin memory. +func websocketWriteResponse(p *extism.CurrentPlugin, stack []uint64, resp any) { + respBytes, err := json.Marshal(resp) + if err != nil { + websocketWriteError(p, stack, err) + return + } + respPtr, err := p.WriteBytes(respBytes) + if err != nil { + stack[0] = 0 + return + } + stack[0] = respPtr +} + +// websocketWriteError writes an error response to plugin memory. +func websocketWriteError(p *extism.CurrentPlugin, stack []uint64, err error) { + errResp := struct { + Error string `json:"error"` + }{Error: err.Error()} + respBytes, _ := json.Marshal(errResp) + respPtr, _ := p.WriteBytes(respBytes) + stack[0] = respPtr +} diff --git a/plugins/host_artwork.go b/plugins/host_artwork.go new file mode 100644 index 000000000..49b9a285d --- /dev/null +++ b/plugins/host_artwork.go @@ -0,0 +1,37 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/core/publicurl" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" +) + +type artworkServiceImpl struct{} + +func newArtworkService() host.ArtworkService { + return &artworkServiceImpl{} +} + +func (a *artworkServiceImpl) GetArtistUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindArtistArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil +} + +func (a *artworkServiceImpl) GetAlbumUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindAlbumArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil +} + +func (a *artworkServiceImpl) GetTrackUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindMediaFileArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil +} + +func (a *artworkServiceImpl) GetPlaylistUrl(_ context.Context, id string, size int32) (string, error) { + artID := model.ArtworkID{Kind: model.KindPlaylistArtwork, ID: id} + return publicurl.ImageURL(nil, artID, int(size)), nil +} + +var _ host.ArtworkService = (*artworkServiceImpl)(nil) diff --git a/plugins/host_artwork_test.go b/plugins/host_artwork_test.go new file mode 100644 index 000000000..ed8a0e810 --- /dev/null +++ b/plugins/host_artwork_test.go @@ -0,0 +1,240 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "net/http" + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ArtworkService", Ordered, func() { + var ( + manager *Manager + tmpDir string + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "artwork-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-artwork plugin + srcPath := filepath.Join(testdataDir, "test-artwork"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-artwork"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Initialize auth (required for token generation) + ds := &tests.MockDataStore{MockedProperty: &tests.MockedPropertyRepo{}} + auth.Init(ds) + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-artwork", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedPlugin: mockPluginRepo, + } + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with artwork permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-artwork"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Artwork).ToNot(BeNil()) + }) + }) + + Describe("Artwork URL Generation", func() { + type testArtworkInput struct { + ArtworkType string `json:"artwork_type"` + ID string `json:"id"` + Size int32 `json:"size"` + } + type testArtworkOutput struct { + URL string `json:"url,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestArtwork := func(ctx context.Context, artworkType, id string, size int32) (string, error) { + manager.mu.RLock() + p := manager.plugins["test-artwork"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return "", err + } + defer instance.Close(ctx) + + input := testArtworkInput{ + ArtworkType: artworkType, + ID: id, + Size: size, + } + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_artwork", inputBytes) + if err != nil { + return "", err + } + + var output testArtworkOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return "", err + } + if output.Error != nil { + return "", Errorf(*output.Error) + } + return output.URL, nil + } + + It("should generate artist artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "artist", "ar-123", 0) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("/img/")) + Expect(url).ToNot(ContainSubstring("size=")) + + // Decode JWT and verify artwork ID + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindArtistArtwork)) + Expect(artID.ID).To(Equal("ar-123")) + }) + + It("should generate album artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "album", "al-456", 0) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("/img/")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindAlbumArtwork)) + Expect(artID.ID).To(Equal("al-456")) + }) + + It("should generate track artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "track", "mf-789", 0) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("/img/")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindMediaFileArtwork)) + Expect(artID.ID).To(Equal("mf-789")) + }) + + It("should generate playlist artwork URL", func() { + url, err := callTestArtwork(GinkgoT().Context(), "playlist", "pl-abc", 0) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("/img/")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindPlaylistArtwork)) + Expect(artID.ID).To(Equal("pl-abc")) + }) + + It("should include size parameter when specified", func() { + url, err := callTestArtwork(GinkgoT().Context(), "album", "al-456", 300) + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(ContainSubstring("size=300")) + + artID := decodeArtworkURL(url) + Expect(artID.Kind).To(Equal(model.KindAlbumArtwork)) + Expect(artID.ID).To(Equal("al-456")) + }) + + It("should handle unknown artwork type", func() { + _, err := callTestArtwork(GinkgoT().Context(), "unknown", "id-123", 0) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("unknown artwork type")) + }) + }) +}) + +// Errorf creates an error from a format string (helper for tests) +func Errorf(format string, args ...any) error { + return &errorString{s: format} +} + +type errorString struct { + s string +} + +func (e *errorString) Error() string { + return e.s +} + +// decodeArtworkURL extracts and decodes the JWT token from an artwork URL, +// returning the parsed ArtworkID. Panics on error (test helper). +func decodeArtworkURL(artworkURL string) model.ArtworkID { + // URL format: http://localhost/img/<token>?size=... + // Extract token from path after /img/ + idx := strings.Index(artworkURL, "/img/") + Expect(idx).To(BeNumerically(">=", 0), "URL should contain /img/") + + tokenPart := artworkURL[idx+5:] // skip "/img/" + // Remove query string if present + if qIdx := strings.Index(tokenPart, "?"); qIdx >= 0 { + tokenPart = tokenPart[:qIdx] + } + + // Decode JWT token + token, err := auth.TokenAuth.Decode(tokenPart) + Expect(err).ToNot(HaveOccurred(), "Failed to decode JWT token") + + c := auth.ClaimsFromToken(token) + + id := c.ID + Expect(id).ToNot(BeEmpty(), "Token should contain 'id' claim") + + artID, err := model.ParseArtworkID(id) + Expect(err).ToNot(HaveOccurred(), "Failed to parse artwork ID from token") + + return artID +} diff --git a/plugins/host_cache.go b/plugins/host_cache.go new file mode 100644 index 000000000..b90d790cf --- /dev/null +++ b/plugins/host_cache.go @@ -0,0 +1,153 @@ +package plugins + +import ( + "context" + "time" + + "github.com/jellydator/ttlcache/v3" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/plugins/host" +) + +const ( + defaultCacheTTL = 24 * time.Hour +) + +// cacheServiceImpl implements the host.CacheService interface. +// Each plugin gets its own cache instance for isolation. +type cacheServiceImpl struct { + pluginName string + cache *ttlcache.Cache[string, any] + defaultTTL time.Duration +} + +// newCacheService creates a new cacheServiceImpl instance with its own cache. +func newCacheService(pluginName string) *cacheServiceImpl { + cache := ttlcache.New[string, any]( + ttlcache.WithTTL[string, any](defaultCacheTTL), + ) + // Start the janitor goroutine to clean up expired entries + go cache.Start() + + return &cacheServiceImpl{ + pluginName: pluginName, + cache: cache, + defaultTTL: defaultCacheTTL, + } +} + +// getTTL converts seconds to a duration, using default if 0 or negative +func (s *cacheServiceImpl) getTTL(seconds int64) time.Duration { + if seconds <= 0 { + return s.defaultTTL + } + return time.Duration(seconds) * time.Second +} + +// SetString stores a string value in the cache. +func (s *cacheServiceImpl) SetString(ctx context.Context, key string, value string, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil +} + +// GetString retrieves a string value from the cache. +func (s *cacheServiceImpl) GetString(ctx context.Context, key string) (string, bool, error) { + item := s.cache.Get(key) + if item == nil { + return "", false, nil + } + + value, ok := item.Value().(string) + if !ok { + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "string") + return "", false, nil + } + return value, true, nil +} + +// SetInt stores an integer value in the cache. +func (s *cacheServiceImpl) SetInt(ctx context.Context, key string, value int64, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil +} + +// GetInt retrieves an integer value from the cache. +func (s *cacheServiceImpl) GetInt(ctx context.Context, key string) (int64, bool, error) { + item := s.cache.Get(key) + if item == nil { + return 0, false, nil + } + + value, ok := item.Value().(int64) + if !ok { + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "int64") + return 0, false, nil + } + return value, true, nil +} + +// SetFloat stores a float value in the cache. +func (s *cacheServiceImpl) SetFloat(ctx context.Context, key string, value float64, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil +} + +// GetFloat retrieves a float value from the cache. +func (s *cacheServiceImpl) GetFloat(ctx context.Context, key string) (float64, bool, error) { + item := s.cache.Get(key) + if item == nil { + return 0, false, nil + } + + value, ok := item.Value().(float64) + if !ok { + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "float64") + return 0, false, nil + } + return value, true, nil +} + +// SetBytes stores a byte slice in the cache. +func (s *cacheServiceImpl) SetBytes(ctx context.Context, key string, value []byte, ttlSeconds int64) error { + s.cache.Set(key, value, s.getTTL(ttlSeconds)) + return nil +} + +// GetBytes retrieves a byte slice from the cache. +func (s *cacheServiceImpl) GetBytes(ctx context.Context, key string) ([]byte, bool, error) { + item := s.cache.Get(key) + if item == nil { + return nil, false, nil + } + + value, ok := item.Value().([]byte) + if !ok { + log.Debug(ctx, "Cache type mismatch", "plugin", s.pluginName, "key", key, "expected", "[]byte") + return nil, false, nil + } + return value, true, nil +} + +// Has checks if a key exists in the cache. +func (s *cacheServiceImpl) Has(ctx context.Context, key string) (bool, error) { + item := s.cache.Get(key) + return item != nil, nil +} + +// Remove deletes a value from the cache. +func (s *cacheServiceImpl) Remove(ctx context.Context, key string) error { + s.cache.Delete(key) + return nil +} + +// Close stops the cache's janitor goroutine and clears all entries. +// This is called when the plugin is unloaded. +func (s *cacheServiceImpl) Close() error { + s.cache.Stop() + s.cache.DeleteAll() + log.Debug("Closed plugin cache", "plugin", s.pluginName) + return nil +} + +// Ensure cacheServiceImpl implements host.CacheService +var _ host.CacheService = (*cacheServiceImpl)(nil) diff --git a/plugins/host_cache_test.go b/plugins/host_cache_test.go new file mode 100644 index 000000000..cf3973fc4 --- /dev/null +++ b/plugins/host_cache_test.go @@ -0,0 +1,601 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("CacheService", func() { + var service *cacheServiceImpl + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + service = newCacheService("test_plugin") + }) + + AfterEach(func() { + if service != nil { + service.Close() + } + }) + + Describe("getTTL", func() { + It("returns default TTL when seconds is 0", func() { + ttl := service.getTTL(0) + Expect(ttl).To(Equal(defaultCacheTTL)) + }) + + It("returns default TTL when seconds is negative", func() { + ttl := service.getTTL(-10) + Expect(ttl).To(Equal(defaultCacheTTL)) + }) + + It("returns correct duration when seconds is positive", func() { + ttl := service.getTTL(60) + Expect(ttl).To(Equal(time.Minute)) + }) + }) + + Describe("Plugin Isolation", func() { + It("isolates keys between plugins", func() { + service1 := newCacheService("plugin1") + defer service1.Close() + service2 := newCacheService("plugin2") + defer service2.Close() + + // Both plugins set same key + err := service1.SetString(ctx, "shared", "value1", 0) + Expect(err).ToNot(HaveOccurred()) + err = service2.SetString(ctx, "shared", "value2", 0) + Expect(err).ToNot(HaveOccurred()) + + // Each plugin should get their own value + val1, exists1, err := service1.GetString(ctx, "shared") + Expect(err).ToNot(HaveOccurred()) + Expect(exists1).To(BeTrue()) + Expect(val1).To(Equal("value1")) + + val2, exists2, err := service2.GetString(ctx, "shared") + Expect(err).ToNot(HaveOccurred()) + Expect(exists2).To(BeTrue()) + Expect(val2).To(Equal("value2")) + }) + }) + + Describe("String Operations", func() { + It("sets and gets a string value", func() { + err := service.SetString(ctx, "string_key", "test_value", 300) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetString(ctx, "string_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal("test_value")) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.GetString(ctx, "missing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal("")) + }) + }) + + Describe("Integer Operations", func() { + It("sets and gets an integer value", func() { + err := service.SetInt(ctx, "int_key", 42, 300) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetInt(ctx, "int_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(int64(42))) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.GetInt(ctx, "missing_int_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + }) + + Describe("Float Operations", func() { + It("sets and gets a float value", func() { + err := service.SetFloat(ctx, "float_key", 3.14, 300) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetFloat(ctx, "float_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(3.14)) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.GetFloat(ctx, "missing_float_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(float64(0))) + }) + }) + + Describe("Bytes Operations", func() { + It("sets and gets a bytes value", func() { + byteData := []byte("hello world") + err := service.SetBytes(ctx, "bytes_key", byteData, 300) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetBytes(ctx, "bytes_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(byteData)) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.GetBytes(ctx, "missing_bytes_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) + }) + }) + + Describe("Type mismatch handling", func() { + It("returns not exists when type doesn't match the getter", func() { + // Set string + err := service.SetString(ctx, "mixed_key", "string value", 0) + Expect(err).ToNot(HaveOccurred()) + + // Try to get as int + value, exists, err := service.GetInt(ctx, "mixed_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + + It("returns not exists when getting string as float", func() { + err := service.SetString(ctx, "str_as_float", "not a float", 0) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetFloat(ctx, "str_as_float") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(float64(0))) + }) + + It("returns not exists when getting int as bytes", func() { + err := service.SetInt(ctx, "int_as_bytes", 123, 0) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.GetBytes(ctx, "int_as_bytes") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) + }) + }) + + Describe("Has Operation", func() { + It("returns true for existing key", func() { + err := service.SetString(ctx, "existing_key", "exists", 0) + Expect(err).ToNot(HaveOccurred()) + + exists, err := service.Has(ctx, "existing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + + It("returns false for non-existing key", func() { + exists, err := service.Has(ctx, "non_existing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + }) + + Describe("Remove Operation", func() { + It("removes a value from the cache", func() { + // Set a value + err := service.SetString(ctx, "remove_key", "to be removed", 0) + Expect(err).ToNot(HaveOccurred()) + + // Verify it exists + exists, err := service.Has(ctx, "remove_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + + // Remove it + err = service.Remove(ctx, "remove_key") + Expect(err).ToNot(HaveOccurred()) + + // Verify it's gone + exists, err = service.Has(ctx, "remove_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("does not error when removing non-existing key", func() { + err := service.Remove(ctx, "never_existed") + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("TTL Behavior", func() { + It("uses default TTL when 0 is provided", func() { + err := service.SetString(ctx, "default_ttl", "value", 0) + Expect(err).ToNot(HaveOccurred()) + + // Value should exist immediately + exists, err := service.Has(ctx, "default_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + + It("uses custom TTL when provided", func() { + err := service.SetString(ctx, "custom_ttl", "value", 300) + Expect(err).ToNot(HaveOccurred()) + + // Value should exist immediately + exists, err := service.Has(ctx, "custom_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + }) + + Describe("Close", func() { + It("removes all cache entries for the plugin", func() { + // Use a dedicated service for this test + closeService := newCacheService("close_test_plugin") + + // Set multiple values + err := closeService.SetString(ctx, "key1", "value1", 0) + Expect(err).ToNot(HaveOccurred()) + err = closeService.SetInt(ctx, "key2", 42, 0) + Expect(err).ToNot(HaveOccurred()) + err = closeService.SetFloat(ctx, "key3", 3.14, 0) + Expect(err).ToNot(HaveOccurred()) + + // Verify they exist + exists, _ := closeService.Has(ctx, "key1") + Expect(exists).To(BeTrue()) + exists, _ = closeService.Has(ctx, "key2") + Expect(exists).To(BeTrue()) + exists, _ = closeService.Has(ctx, "key3") + Expect(exists).To(BeTrue()) + + // Close the service + err = closeService.Close() + Expect(err).ToNot(HaveOccurred()) + + // All entries should be gone + exists, _ = closeService.Has(ctx, "key1") + Expect(exists).To(BeFalse()) + exists, _ = closeService.Has(ctx, "key2") + Expect(exists).To(BeFalse()) + exists, _ = closeService.Has(ctx, "key3") + Expect(exists).To(BeFalse()) + }) + + It("does not affect other plugins' cache entries", func() { + // Create two services for different plugins + service1 := newCacheService("plugin_close_test1") + service2 := newCacheService("plugin_close_test2") + defer service2.Close() + + // Set values for both plugins + err := service1.SetString(ctx, "key", "value1", 0) + Expect(err).ToNot(HaveOccurred()) + err = service2.SetString(ctx, "key", "value2", 0) + Expect(err).ToNot(HaveOccurred()) + + // Close only service1 + err = service1.Close() + Expect(err).ToNot(HaveOccurred()) + + // service1's key should be gone + exists, _ := service1.Has(ctx, "key") + Expect(exists).To(BeFalse()) + + // service2's key should still exist + exists, _ = service2.Has(ctx, "key") + Expect(exists).To(BeTrue()) + }) + }) +}) + +var _ = Describe("CacheService Integration", Ordered, func() { + var ( + manager *Manager + tmpDir string + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "cache-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-cache-plugin + srcPath := filepath.Join(testdataDir, "test-cache-plugin"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-cache-plugin"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-cache-plugin", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with cache permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-cache-plugin"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Cache).ToNot(BeNil()) + }) + }) + + Describe("Cache Operations via Plugin", func() { + type testCacheInput struct { + Operation string `json:"operation"` + Key string `json:"key"` + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + FloatVal float64 `json:"float_val,omitempty"` + BytesVal []byte `json:"bytes_val,omitempty"` + TTLSeconds int64 `json:"ttl_seconds,omitempty"` + } + type testCacheOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + FloatVal float64 `json:"float_val,omitempty"` + BytesVal []byte `json:"bytes_val,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestCache := func(ctx context.Context, input testCacheInput) (*testCacheOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-cache-plugin"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_cache", inputBytes) + if err != nil { + return nil, err + } + + var output testCacheOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + It("should set and get string value", func() { + ctx := GinkgoT().Context() + + // Set string + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_string", + Key: "test_string", + StringVal: "hello world", + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get string + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_string", + Key: "test_string", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.StringVal).To(Equal("hello world")) + }) + + It("should set and get integer value", func() { + ctx := GinkgoT().Context() + + // Set int + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_int", + Key: "test_int", + IntVal: 42, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get int + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_int", + Key: "test_int", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.IntVal).To(Equal(int64(42))) + }) + + It("should set and get float value", func() { + ctx := GinkgoT().Context() + + // Set float + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_float", + Key: "test_float", + FloatVal: 3.14159, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get float + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_float", + Key: "test_float", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.FloatVal).To(Equal(3.14159)) + }) + + It("should set and get bytes value", func() { + ctx := GinkgoT().Context() + testBytes := []byte{0x01, 0x02, 0x03, 0x04} + + // Set bytes + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_bytes", + Key: "test_bytes", + BytesVal: testBytes, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get bytes + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_bytes", + Key: "test_bytes", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.BytesVal).To(Equal(testBytes)) + }) + + It("should handle binary data with null bytes through WASM", func() { + ctx := GinkgoT().Context() + + // Binary data with null bytes, high bytes, and other edge cases + binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0x00, 0x80, 0x7F} + + // Set binary bytes + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_bytes", + Key: "binary_test", + BytesVal: binaryData, + TTLSeconds: 300, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get binary bytes and verify exact match + output, err := callTestCache(ctx, testCacheInput{ + Operation: "get_bytes", + Key: "binary_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.BytesVal).To(Equal(binaryData)) + }) + + It("should check if key exists", func() { + ctx := GinkgoT().Context() + + // Set a value + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_string", + Key: "exists_test", + StringVal: "value", + }) + Expect(err).ToNot(HaveOccurred()) + + // Check has + output, err := callTestCache(ctx, testCacheInput{ + Operation: "has", + Key: "exists_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + + // Check non-existent + output, err = callTestCache(ctx, testCacheInput{ + Operation: "has", + Key: "nonexistent", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should remove a key", func() { + ctx := GinkgoT().Context() + + // Set a value + _, err := callTestCache(ctx, testCacheInput{ + Operation: "set_string", + Key: "remove_test", + StringVal: "value", + }) + Expect(err).ToNot(HaveOccurred()) + + // Remove it + _, err = callTestCache(ctx, testCacheInput{ + Operation: "remove", + Key: "remove_test", + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify it's gone + output, err := callTestCache(ctx, testCacheInput{ + Operation: "has", + Key: "remove_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + }) +}) diff --git a/plugins/host_config.go b/plugins/host_config.go new file mode 100644 index 000000000..9e71db72f --- /dev/null +++ b/plugins/host_config.go @@ -0,0 +1,69 @@ +package plugins + +import ( + "context" + "sort" + "strconv" + "strings" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/plugins/host" +) + +// configServiceImpl implements the host.ConfigService interface. +// It provides access to plugin configuration values set in the Navidrome config file. +type configServiceImpl struct { + pluginName string + config map[string]string +} + +// newConfigService creates a new configServiceImpl instance. +func newConfigService(pluginName string, config map[string]string) *configServiceImpl { + if config == nil { + config = make(map[string]string) + } + return &configServiceImpl{ + pluginName: pluginName, + config: config, + } +} + +// Get retrieves a configuration value as a string. +func (s *configServiceImpl) Get(ctx context.Context, key string) (string, bool) { + value, exists := s.config[key] + log.Trace(ctx, "Config.Get", "plugin", s.pluginName, "key", key, "exists", exists) + return value, exists +} + +// GetInt retrieves a configuration value as an integer. +func (s *configServiceImpl) GetInt(ctx context.Context, key string) (int64, bool) { + value, exists := s.config[key] + if !exists { + log.Trace(ctx, "Config.GetInt", "plugin", s.pluginName, "key", key, "exists", false) + return 0, false + } + + intValue, err := strconv.ParseInt(value, 10, 64) + if err != nil { + log.Trace(ctx, "Config.GetInt parse error", "plugin", s.pluginName, "key", key, "value", value, "error", err) + return 0, false + } + + log.Trace(ctx, "Config.GetInt", "plugin", s.pluginName, "key", key, "value", intValue) + return intValue, true +} + +// Keys returns configuration keys matching the given prefix. +func (s *configServiceImpl) Keys(ctx context.Context, prefix string) []string { + keys := make([]string, 0, len(s.config)) + for k := range s.config { + if prefix == "" || strings.HasPrefix(k, prefix) { + keys = append(keys, k) + } + } + sort.Strings(keys) + log.Trace(ctx, "Config.Keys", "plugin", s.pluginName, "prefix", prefix, "keyCount", len(keys)) + return keys +} + +var _ host.ConfigService = (*configServiceImpl)(nil) diff --git a/plugins/host_config_test.go b/plugins/host_config_test.go new file mode 100644 index 000000000..b296d29fb --- /dev/null +++ b/plugins/host_config_test.go @@ -0,0 +1,381 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// testConfigInput is the input for nd_test_config callback. +type testConfigInput struct { + Operation string `json:"operation"` + Key string `json:"key,omitempty"` + Prefix string `json:"prefix,omitempty"` +} + +// testConfigOutput is the output from nd_test_config callback. +type testConfigOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + Keys []string `json:"keys,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` +} + +// setupTestConfigPlugin sets up a test environment with the test-config plugin loaded. +// Returns a cleanup function and a helper to call the plugin's nd_test_config function. +func setupTestConfigPlugin(configJSON string) (*Manager, func(context.Context, testConfigInput) (*testConfigOutput, error)) { + tmpDir, err := os.MkdirTemp("", "config-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-config plugin + srcPath := filepath.Join(testdataDir, "test-config"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-config"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-config", + Path: destPath, + SHA256: hashHex, + Enabled: true, + AllUsers: true, + Config: configJSON, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + + // Helper to call test plugin's exported function + callTestConfig := func(ctx context.Context, input testConfigInput) (*testConfigOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-config"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_config", inputBytes) + if err != nil { + return nil, err + } + + var output testConfigOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + return manager, callTestConfig +} + +var _ = Describe("ConfigService", func() { + var service *configServiceImpl + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + }) + + Describe("newConfigService", func() { + It("creates service with provided config", func() { + config := map[string]string{"key1": "value1", "key2": "value2"} + service = newConfigService("test_plugin", config) + Expect(service.pluginName).To(Equal("test_plugin")) + Expect(service.config).To(Equal(config)) + }) + + It("creates service with empty config when nil", func() { + service = newConfigService("test_plugin", nil) + Expect(service.config).ToNot(BeNil()) + Expect(service.config).To(BeEmpty()) + }) + }) + + Describe("Get", func() { + BeforeEach(func() { + service = newConfigService("test_plugin", map[string]string{ + "api_key": "secret123", + "debug_mode": "true", + "max_items": "100", + }) + }) + + It("returns value for existing key", func() { + value, exists := service.Get(ctx, "api_key") + Expect(exists).To(BeTrue()) + Expect(value).To(Equal("secret123")) + }) + + It("returns not exists for missing key", func() { + value, exists := service.Get(ctx, "missing_key") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal("")) + }) + }) + + Describe("GetInt", func() { + BeforeEach(func() { + service = newConfigService("test_plugin", map[string]string{ + "max_items": "100", + "timeout": "30", + "negative": "-50", + "not_a_number": "abc", + "float": "3.14", + }) + }) + + It("returns integer for valid numeric value", func() { + value, exists := service.GetInt(ctx, "max_items") + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(int64(100))) + }) + + It("returns negative integer", func() { + value, exists := service.GetInt(ctx, "negative") + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(int64(-50))) + }) + + It("returns not exists for non-numeric value", func() { + value, exists := service.GetInt(ctx, "not_a_number") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + + It("returns not exists for float value", func() { + value, exists := service.GetInt(ctx, "float") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + + It("returns not exists for missing key", func() { + value, exists := service.GetInt(ctx, "missing_key") + Expect(exists).To(BeFalse()) + Expect(value).To(Equal(int64(0))) + }) + }) + + Describe("Keys", func() { + BeforeEach(func() { + service = newConfigService("test_plugin", map[string]string{ + "zebra": "z", + "apple": "a", + "banana": "b", + "user_alice": "token1", + "user_bob": "token2", + "user_charlie": "token3", + }) + }) + + It("returns all keys in sorted order when prefix is empty", func() { + keys := service.Keys(ctx, "") + Expect(keys).To(Equal([]string{"apple", "banana", "user_alice", "user_bob", "user_charlie", "zebra"})) + }) + + It("returns only keys matching prefix", func() { + keys := service.Keys(ctx, "user_") + Expect(keys).To(Equal([]string{"user_alice", "user_bob", "user_charlie"})) + }) + + It("returns empty slice when no keys match prefix", func() { + keys := service.Keys(ctx, "nonexistent_") + Expect(keys).To(BeEmpty()) + }) + + It("returns empty slice for empty config", func() { + service = newConfigService("test_plugin", nil) + keys := service.Keys(ctx, "") + Expect(keys).To(BeEmpty()) + }) + }) +}) + +var _ = Describe("ConfigService Integration", Ordered, func() { + var ( + manager *Manager + callTestConfig func(context.Context, testConfigInput) (*testConfigOutput, error) + ) + + BeforeAll(func() { + manager, callTestConfig = setupTestConfigPlugin(`{"api_key":"test_secret","max_retries":"5","timeout":"30"}`) + }) + + Describe("Plugin Loading", func() { + It("should load plugin without config permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-config"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Name).To(Equal("Test Config Plugin")) + }) + }) + + Describe("Config Operations via Plugin", func() { + It("should get string value", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "api_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.StringVal).To(Equal("test_secret")) + Expect(output.Exists).To(BeTrue()) + }) + + It("should return not exists for missing key", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "nonexistent", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should get integer value", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get_int", + Key: "max_retries", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.IntVal).To(Equal(int64(5))) + Expect(output.Exists).To(BeTrue()) + }) + + It("should return not exists for non-integer value", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get_int", + Key: "api_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should list all config keys with empty prefix", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "list", + Prefix: "", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(ConsistOf("api_key", "max_retries", "timeout")) + }) + + It("should list config keys with prefix filter", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "list", + Prefix: "max", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(ConsistOf("max_retries")) + }) + }) +}) + +var _ = Describe("Complex Config Values Integration", Ordered, func() { + var callTestConfig func(context.Context, testConfigInput) (*testConfigOutput, error) + + BeforeAll(func() { + // Config with arrays and objects - these should be properly serialized as JSON strings + _, callTestConfig = setupTestConfigPlugin(`{"api_key":"secret123","users":[{"username":"admin","token":"tok1"},{"username":"user2","token":"tok2"}],"settings":{"enabled":true,"count":5}}`) + }) + + Describe("Config Serialization", func() { + It("should make simple string config values accessible to plugin", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "api_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.StringVal).To(Equal("secret123")) + }) + + It("should serialize array config values as JSON strings", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "users", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + // Array values are serialized as JSON strings - parse to verify structure + var users []map[string]string + Expect(json.Unmarshal([]byte(output.StringVal), &users)).To(Succeed()) + Expect(users).To(HaveLen(2)) + Expect(users[0]).To(HaveKeyWithValue("username", "admin")) + Expect(users[0]).To(HaveKeyWithValue("token", "tok1")) + Expect(users[1]).To(HaveKeyWithValue("username", "user2")) + Expect(users[1]).To(HaveKeyWithValue("token", "tok2")) + }) + + It("should serialize object config values as JSON strings", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "get", + Key: "settings", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + // Object values are serialized as JSON strings - parse to verify structure + var settings map[string]any + Expect(json.Unmarshal([]byte(output.StringVal), &settings)).To(Succeed()) + Expect(settings).To(HaveKeyWithValue("enabled", true)) + Expect(settings).To(HaveKeyWithValue("count", float64(5))) + }) + + It("should list all config keys including complex values", func() { + output, err := callTestConfig(GinkgoT().Context(), testConfigInput{ + Operation: "list", + Prefix: "", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(ConsistOf("api_key", "users", "settings")) + }) + }) +}) diff --git a/plugins/host_httpclient.go b/plugins/host_httpclient.go new file mode 100644 index 000000000..f1d64deb7 --- /dev/null +++ b/plugins/host_httpclient.go @@ -0,0 +1,204 @@ +package plugins + +import ( + "bytes" + "cmp" + "context" + "fmt" + "io" + "net" + "net/http" + "net/url" + "strings" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/plugins/host" +) + +const ( + httpClientDefaultTimeout = 10 * time.Second + httpClientMaxRedirects = 5 + httpClientMaxResponseBodyLen = 10 * 1024 * 1024 // 10 MB +) + +// contextKey is used for per-request redirect control via context. +type contextKey struct{} + +// noFollowRedirectsKey signals the CheckRedirect callback to stop following redirects. +var noFollowRedirectsKey = contextKey{} + +// httpServiceImpl implements host.HTTPService. +type httpServiceImpl struct { + pluginName string + requiredHosts []string + client *http.Client +} + +// newHTTPService creates a new HTTPService for a plugin. +func newHTTPService(pluginName string, permission *HTTPPermission) *httpServiceImpl { + var requiredHosts []string + if permission != nil { + requiredHosts = permission.RequiredHosts + } + svc := &httpServiceImpl{ + pluginName: pluginName, + requiredHosts: requiredHosts, + } + svc.client = &http.Client{ + Transport: http.DefaultTransport, + // Timeout is set per-request via context deadline, not here. + // CheckRedirect validates hosts and enforces redirect limits. + CheckRedirect: func(req *http.Request, via []*http.Request) error { + if req.Context().Value(noFollowRedirectsKey) != nil { + return http.ErrUseLastResponse + } + if len(via) >= httpClientMaxRedirects { + log.Warn(req.Context(), "HTTP redirect limit exceeded", "plugin", svc.pluginName, "url", req.URL.String(), "redirectCount", len(via)) + return http.ErrUseLastResponse + } + if err := svc.validateHost(req.Context(), req.URL.Host); err != nil { + log.Warn(req.Context(), "HTTP redirect blocked", "plugin", svc.pluginName, "url", req.URL.String(), "err", err) + return err + } + return nil + }, + } + return svc +} + +func (s *httpServiceImpl) Send(ctx context.Context, request host.HTTPRequest) (*host.HTTPResponse, error) { + // Parse and validate URL + parsedURL, err := url.Parse(request.URL) + if err != nil { + return nil, fmt.Errorf("invalid URL: %w", err) + } + + // Validate URL scheme + if parsedURL.Scheme != "http" && parsedURL.Scheme != "https" { + return nil, fmt.Errorf("invalid URL scheme %q: must be http or https", parsedURL.Scheme) + } + + // Validate host against allowed hosts and private IP restrictions + if err := s.validateHost(ctx, parsedURL.Host); err != nil { + return nil, err + } + + // Apply per-request timeout via context deadline + timeout := cmp.Or(time.Duration(request.TimeoutMs)*time.Millisecond, httpClientDefaultTimeout) + ctx, cancel := context.WithTimeout(ctx, timeout) + defer cancel() + + // Signal CheckRedirect to not follow redirects for this request + if request.NoFollowRedirects { + ctx = context.WithValue(ctx, noFollowRedirectsKey, true) + } + + // Build request body + method := strings.ToUpper(request.Method) + var body io.Reader + if len(request.Body) > 0 { + body = bytes.NewReader(request.Body) + } + + // Create HTTP request + httpReq, err := http.NewRequestWithContext(ctx, method, request.URL, body) + if err != nil { + return nil, fmt.Errorf("creating request: %w", err) + } + for k, v := range request.Headers { + httpReq.Header.Set(k, v) + } + + // Execute request + resp, err := s.client.Do(httpReq) //nolint:gosec // URL is validated against requiredHosts + if err != nil { + return nil, err + } + defer resp.Body.Close() + + log.Trace(ctx, "HTTP request", "plugin", s.pluginName, "method", method, "url", request.URL, "status", resp.StatusCode) + + // Read response body (with size limit to prevent memory exhaustion) + respBody, err := io.ReadAll(io.LimitReader(resp.Body, httpClientMaxResponseBodyLen)) + if err != nil { + return nil, fmt.Errorf("reading response body: %w", err) + } + + // Flatten response headers (first value only) + headers := make(map[string]string, len(resp.Header)) + for k, v := range resp.Header { + if len(v) > 0 { + headers[k] = v[0] + } + } + + return &host.HTTPResponse{ + StatusCode: int32(resp.StatusCode), + Headers: headers, + Body: respBody, + }, nil +} + +// validateHost checks whether a request to the given host is permitted. +// When requiredHosts is set, it checks against the allowlist. +// When requiredHosts is empty, it blocks private/loopback IPs to prevent SSRF. +func (s *httpServiceImpl) validateHost(ctx context.Context, hostStr string) error { + hostname := extractHostname(hostStr) + + if len(s.requiredHosts) > 0 { + if !s.isHostAllowed(hostname) { + return fmt.Errorf("host %q is not allowed", hostStr) + } + return nil + } + + // No explicit allowlist: block private/loopback IPs + if isPrivateOrLoopback(hostname) { + log.Warn(ctx, "HTTP request to private/loopback address blocked", "plugin", s.pluginName, "host", hostStr) + return fmt.Errorf("host %q is not allowed: private/loopback addresses require explicit requiredHosts in manifest", hostStr) + } + return nil +} + +func (s *httpServiceImpl) isHostAllowed(hostname string) bool { + for _, pattern := range s.requiredHosts { + if matchHostPattern(pattern, hostname) { + return true + } + } + return false +} + +// extractHostname returns the hostname portion of a host string, stripping +// any port number and IPv6 brackets. It handles IPv6 addresses correctly +// (e.g. "[::1]:8080" → "::1", "[::1]" → "::1"). +func extractHostname(hostStr string) string { + if h, _, err := net.SplitHostPort(hostStr); err == nil { + return h + } + // Strip IPv6 brackets when no port is present (e.g. "[::1]" → "::1") + if strings.HasPrefix(hostStr, "[") && strings.HasSuffix(hostStr, "]") { + return hostStr[1 : len(hostStr)-1] + } + return hostStr +} + +// isPrivateOrLoopback returns true if the given hostname resolves to or is +// a private, loopback, or link-local IP address. This includes: +// IPv4: 127.0.0.0/8, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 169.254.0.0/16 +// IPv6: ::1, fc00::/7, fe80::/10 +// It also blocks "localhost" by name. +func isPrivateOrLoopback(hostname string) bool { + if strings.EqualFold(hostname, "localhost") { + return true + } + ip := net.ParseIP(hostname) + if ip == nil { + return false + } + return ip.IsLoopback() || ip.IsPrivate() || ip.IsLinkLocalUnicast() || ip.IsLinkLocalMulticast() +} + +// Verify interface implementation +var _ host.HTTPService = (*httpServiceImpl)(nil) diff --git a/plugins/host_httpclient_test.go b/plugins/host_httpclient_test.go new file mode 100644 index 000000000..27e92d59d --- /dev/null +++ b/plugins/host_httpclient_test.go @@ -0,0 +1,585 @@ +//go:build !windows + +package plugins + +import ( + "context" + "io" + "net/http" + "net/http/httptest" + "strings" + "time" + + "github.com/navidrome/navidrome/plugins/host" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("httpServiceImpl", func() { + var ( + svc *httpServiceImpl + ts *httptest.Server + ) + + AfterEach(func() { + if ts != nil { + ts.Close() + } + }) + + Context("without host restrictions (default SSRF protection)", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", nil) + }) + + It("should block requests to loopback IPs", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(200) + })) + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to localhost by name", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://localhost:12345/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to private IPs (10.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://10.0.0.1/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to private IPs (192.168.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://192.168.1.1/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to private IPs (172.16.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://172.16.0.1/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to link-local IPs (169.254.x)", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://169.254.169.254/latest/meta-data/", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to IPv6 loopback with port", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://[::1]:8080/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should block requests to IPv6 loopback without port", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://[::1]/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("private/loopback")) + }) + + It("should allow requests to public hostnames", func() { + // This will fail at the network level (connection refused or DNS), + // but it should NOT fail with a "private/loopback" error + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://203.0.113.1:1/test", // TEST-NET-3, non-routable but not private + TimeoutMs: 100, + }) + // Should get a network error, not a permission error + if err != nil { + Expect(err.Error()).ToNot(ContainSubstring("private/loopback")) + } + }) + + It("should return error for invalid URL", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "://bad-url", + }) + Expect(err).To(HaveOccurred()) + }) + + It("should reject non-http/https URL schemes", func() { + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "ftp://example.com/file", + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("must be http or https")) + }) + }) + + Context("with explicit requiredHosts allowing loopback", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"127.0.0.1"}, + }) + }) + + It("should handle GET requests", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("GET")) + w.Header().Set("X-Test", "ok") + w.WriteHeader(201) + _, _ = w.Write([]byte("hello")) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + Headers: map[string]string{"Accept": "text/plain"}, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(201))) + Expect(string(resp.Body)).To(Equal("hello")) + Expect(resp.Headers["X-Test"]).To(Equal("ok")) + }) + + It("should handle POST requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("POST")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("got:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "POST", + URL: ts.URL, + Body: []byte("abc"), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("got:abc")) + }) + + It("should handle PUT requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("PUT")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("put:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "PUT", + URL: ts.URL, + Body: []byte("xyz"), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("put:xyz")) + }) + + It("should handle DELETE requests", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("DELETE")) + w.WriteHeader(204) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "DELETE", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(204))) + }) + + It("should handle DELETE requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("DELETE")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("del:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "DELETE", + URL: ts.URL, + Body: []byte(`{"id":"123"}`), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal(`del:{"id":"123"}`)) + }) + + It("should handle PATCH requests with body", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("PATCH")) + b, _ := io.ReadAll(r.Body) + _, _ = w.Write([]byte("patch:" + string(b))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "PATCH", + URL: ts.URL, + Body: []byte("data"), + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("patch:data")) + }) + + It("should handle HEAD requests", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + Expect(r.Method).To(Equal("HEAD")) + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(200) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "HEAD", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(200))) + Expect(resp.Headers["Content-Type"]).To(Equal("application/json")) + Expect(resp.Body).To(BeEmpty()) + }) + + It("should use default timeout when TimeoutMs is 0", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(200) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(200))) + }) + + It("should return error on timeout", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + time.Sleep(50 * time.Millisecond) + })) + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("deadline exceeded")) + }) + + It("should return error on context cancellation", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + time.Sleep(50 * time.Millisecond) + })) + ctx, cancel := context.WithCancel(context.Background()) + go func() { + time.Sleep(1 * time.Millisecond) + cancel() + }() + _, err := svc.Send(ctx, host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 5000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("context canceled")) + }) + + It("should not follow redirects when NoFollowRedirects is true", func() { + dest := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("final")) + })) + defer dest.Close() + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, dest.URL, http.StatusFound) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + NoFollowRedirects: true, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(302))) + Expect(resp.Headers["Location"]).To(Equal(dest.URL)) + Expect(string(resp.Body)).ToNot(Equal("final")) + }) + + It("should send request headers", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte(r.Header.Get("X-Custom"))) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + Headers: map[string]string{"X-Custom": "myvalue"}, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("myvalue")) + }) + }) + + Context("with host restrictions", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"allowed.example.com", "*.allowed.org"}, + }) + }) + + It("should block requests to non-allowed hosts", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(200) + })) + // httptest server is on 127.0.0.1 which is not in requiredHosts + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + + It("should follow redirects to allowed hosts", func() { + // Create a destination server + dest := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("final")) + })) + defer dest.Close() + // Create a redirect server + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, dest.URL, http.StatusFound) + })) + // Allow both servers (both on 127.0.0.1) + svc.requiredHosts = []string{"127.0.0.1"} + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.StatusCode).To(Equal(int32(200))) + Expect(string(resp.Body)).To(Equal("final")) + }) + + It("should block redirects to non-allowed hosts", func() { + // Server that redirects to a disallowed host + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, "http://evil.example.com/steal", http.StatusFound) + })) + // Override requiredHosts to allow the test server + svc.requiredHosts = []string{"127.0.0.1"} + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + + It("should block redirects to private IPs when allowlist is set", func() { + // Server that redirects to a private IP + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + http.Redirect(w, r, "http://10.0.0.1/internal", http.StatusFound) + })) + // Allow the test server; redirect to 10.0.0.1 is blocked by allowlist + svc.requiredHosts = []string{"127.0.0.1"} + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(resp).To(BeNil()) + }) + + It("should allow wildcard host patterns", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("wildcard")) + })) + // *.allowed.org is in the requiredHosts from BeforeEach, but test server is 127.0.0.1 + // Override with a wildcard that matches the test server + svc.requiredHosts = []string{"*.0.0.1"} + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("wildcard")) + }) + + It("should reject hosts not matching wildcard patterns", func() { + svc.requiredHosts = []string{"*.example.com"} + _, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: "http://evil.other.com/test", + TimeoutMs: 1000, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + }) + + Context("response body size limit", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"127.0.0.1"}, + }) + }) + + It("should truncate response body at the size limit", func() { + // Serve a body larger than the limit + oversizedBody := strings.Repeat("x", httpClientMaxResponseBodyLen+1024) + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte(oversizedBody)) + })) + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "GET", + URL: ts.URL, + TimeoutMs: 5000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(len(resp.Body)).To(Equal(httpClientMaxResponseBodyLen)) + }) + }) + + Context("edge cases", func() { + BeforeEach(func() { + svc = newHTTPService("test-plugin", &HTTPPermission{ + RequiredHosts: []string{"127.0.0.1"}, + }) + }) + + It("should default empty method to GET", func() { + ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("method:" + r.Method)) + })) + // Empty method — Go's http.NewRequestWithContext normalizes "" to "GET" + resp, err := svc.Send(context.Background(), host.HTTPRequest{ + Method: "", + URL: ts.URL, + TimeoutMs: 1000, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(string(resp.Body)).To(Equal("method:GET")) + }) + }) +}) + +var _ = Describe("extractHostname", func() { + It("should extract hostname from host:port", func() { + Expect(extractHostname("example.com:8080")).To(Equal("example.com")) + }) + + It("should return hostname when no port", func() { + Expect(extractHostname("example.com")).To(Equal("example.com")) + }) + + It("should handle IPv6 with port", func() { + Expect(extractHostname("[::1]:8080")).To(Equal("::1")) + }) + + It("should handle IPv6 without port", func() { + Expect(extractHostname("::1")).To(Equal("::1")) + }) + + It("should strip brackets from IPv6 without port", func() { + Expect(extractHostname("[::1]")).To(Equal("::1")) + }) + + It("should handle IPv4 with port", func() { + Expect(extractHostname("127.0.0.1:9090")).To(Equal("127.0.0.1")) + }) + + It("should handle IPv4 without port", func() { + Expect(extractHostname("127.0.0.1")).To(Equal("127.0.0.1")) + }) +}) + +var _ = Describe("isPrivateOrLoopback", func() { + It("should detect IPv4 loopback", func() { + Expect(isPrivateOrLoopback("127.0.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("127.0.0.2")).To(BeTrue()) + }) + + It("should detect IPv6 loopback", func() { + Expect(isPrivateOrLoopback("::1")).To(BeTrue()) + }) + + It("should detect localhost by name", func() { + Expect(isPrivateOrLoopback("localhost")).To(BeTrue()) + Expect(isPrivateOrLoopback("LOCALHOST")).To(BeTrue()) + }) + + It("should detect 10.x.x.x private range", func() { + Expect(isPrivateOrLoopback("10.0.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("10.255.255.255")).To(BeTrue()) + }) + + It("should detect 172.16.x.x private range", func() { + Expect(isPrivateOrLoopback("172.16.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("172.31.255.255")).To(BeTrue()) + }) + + It("should detect 192.168.x.x private range", func() { + Expect(isPrivateOrLoopback("192.168.0.1")).To(BeTrue()) + Expect(isPrivateOrLoopback("192.168.255.255")).To(BeTrue()) + }) + + It("should detect link-local addresses", func() { + Expect(isPrivateOrLoopback("169.254.169.254")).To(BeTrue()) + Expect(isPrivateOrLoopback("169.254.0.1")).To(BeTrue()) + }) + + It("should detect IPv6 private (fc00::/7)", func() { + Expect(isPrivateOrLoopback("fd00::1")).To(BeTrue()) + }) + + It("should detect IPv6 link-local (fe80::/10)", func() { + Expect(isPrivateOrLoopback("fe80::1")).To(BeTrue()) + }) + + It("should allow public IPs", func() { + Expect(isPrivateOrLoopback("8.8.8.8")).To(BeFalse()) + Expect(isPrivateOrLoopback("203.0.113.1")).To(BeFalse()) + Expect(isPrivateOrLoopback("2001:db8::1")).To(BeFalse()) + }) + + It("should allow non-IP hostnames (DNS names)", func() { + Expect(isPrivateOrLoopback("example.com")).To(BeFalse()) + Expect(isPrivateOrLoopback("api.example.com")).To(BeFalse()) + }) + + It("should not treat 172.32.x.x as private", func() { + Expect(isPrivateOrLoopback("172.32.0.1")).To(BeFalse()) + }) +}) diff --git a/plugins/host_kvstore.go b/plugins/host_kvstore.go new file mode 100644 index 000000000..2224b7485 --- /dev/null +++ b/plugins/host_kvstore.go @@ -0,0 +1,378 @@ +package plugins + +import ( + "context" + "database/sql" + "errors" + "fmt" + "os" + "path/filepath" + "slices" + "strings" + "sync" + "time" + + "github.com/dustin/go-humanize" + _ "github.com/mattn/go-sqlite3" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/utils/slice" +) + +const ( + defaultMaxKVStoreSize = 1 * 1024 * 1024 // 1MB default + maxKeyLength = 256 // Max key length in bytes +) + +// notExpiredFilter is the SQL condition to exclude expired keys. +const notExpiredFilter = "(expires_at IS NULL OR expires_at >= datetime('now'))" + +const cleanupInterval = 1 * time.Hour + +// kvstoreServiceImpl implements the host.KVStoreService interface. +// Each plugin gets its own SQLite database for isolation. +type kvstoreServiceImpl struct { + pluginName string + db *sql.DB + maxSize int64 + cancel context.CancelFunc + wg sync.WaitGroup +} + +// newKVStoreService creates a new kvstoreServiceImpl instance with its own SQLite database. +// The provided context controls the lifetime of the background cleanup goroutine. +func newKVStoreService(ctx context.Context, pluginName string, perm *KVStorePermission) (*kvstoreServiceImpl, error) { + // Parse max size from permission, default to 1MB + maxSize := int64(defaultMaxKVStoreSize) + if perm != nil && perm.MaxSize != nil && *perm.MaxSize != "" { + parsed, err := humanize.ParseBytes(*perm.MaxSize) + if err != nil { + return nil, fmt.Errorf("invalid maxSize %q: %w", *perm.MaxSize, err) + } + maxSize = int64(parsed) + } + + // Create plugin data directory + dataDir := filepath.Join(conf.Server.DataFolder.String(), "plugins", pluginName) + if err := os.MkdirAll(dataDir, 0700); err != nil { + return nil, fmt.Errorf("creating plugin data directory: %w", err) + } + + // Open SQLite database + dbPath := filepath.Join(dataDir, "kvstore.db") + db, err := sql.Open("sqlite3", dbPath+"?_busy_timeout=5000&_journal_mode=WAL&_foreign_keys=off") + if err != nil { + return nil, fmt.Errorf("opening kvstore database: %w", err) + } + + db.SetMaxOpenConns(3) + db.SetMaxIdleConns(1) + + // Apply schema migrations + if err := createKVStoreSchema(db); err != nil { + db.Close() + return nil, fmt.Errorf("migrating kvstore schema: %w", err) + } + + log.Debug("Initialized plugin kvstore", "plugin", pluginName, "path", dbPath, "maxSize", humanize.Bytes(uint64(maxSize))) + + cleanupCtx, cancel := context.WithCancel(ctx) + svc := &kvstoreServiceImpl{ + pluginName: pluginName, + db: db, + maxSize: maxSize, + cancel: cancel, + } + svc.wg.Add(1) + go svc.cleanupLoop(cleanupCtx) + return svc, nil +} + +// createKVStoreSchema applies schema migrations to the kvstore database. +// New migrations must be appended at the end of the slice. +func createKVStoreSchema(db *sql.DB) error { + return migrateDB(db, []string{ + `CREATE TABLE IF NOT EXISTS kvstore ( + key TEXT PRIMARY KEY NOT NULL, + value BLOB NOT NULL, + size INTEGER NOT NULL, + created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP, + updated_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP + )`, + `ALTER TABLE kvstore ADD COLUMN expires_at DATETIME DEFAULT NULL`, + `CREATE INDEX idx_kvstore_expires_at ON kvstore(expires_at)`, + }) +} + +// storageUsed returns the current total storage used by non-expired keys. +func (s *kvstoreServiceImpl) storageUsed(ctx context.Context) (int64, error) { + var used int64 + err := s.db.QueryRowContext(ctx, `SELECT COALESCE(SUM(size), 0) FROM kvstore WHERE `+notExpiredFilter).Scan(&used) + if err != nil { + return 0, fmt.Errorf("calculating storage used: %w", err) + } + return used, nil +} + +// checkStorageLimit verifies that adding delta bytes would not exceed the storage limit. +func (s *kvstoreServiceImpl) checkStorageLimit(ctx context.Context, delta int64) error { + if delta <= 0 { + return nil + } + used, err := s.storageUsed(ctx) + if err != nil { + return err + } + newTotal := used + delta + if newTotal > s.maxSize { + return fmt.Errorf("storage limit exceeded: would use %s of %s allowed", + humanize.Bytes(uint64(newTotal)), humanize.Bytes(uint64(s.maxSize))) + } + return nil +} + +// setValue is the shared implementation for Set and SetWithTTL. +// A ttlSeconds of 0 means no expiration. +func (s *kvstoreServiceImpl) setValue(ctx context.Context, key string, value []byte, ttlSeconds int64) error { + if len(key) == 0 { + return fmt.Errorf("key cannot be empty") + } + if len(key) > maxKeyLength { + return fmt.Errorf("key exceeds maximum length of %d bytes", maxKeyLength) + } + + newValueSize := int64(len(value)) + + // Get current size of this key (if it exists and not expired) to calculate delta + var oldSize int64 + err := s.db.QueryRowContext(ctx, `SELECT COALESCE(size, 0) FROM kvstore WHERE key = ? AND `+notExpiredFilter, key).Scan(&oldSize) + if err != nil && !errors.Is(err, sql.ErrNoRows) { + return fmt.Errorf("checking existing key: %w", err) + } + + if err := s.checkStorageLimit(ctx, newValueSize-oldSize); err != nil { + return err + } + + // Compute expires_at: sql.NullString{Valid:false} sends NULL (no expiration), + // otherwise we send a concrete timestamp. + var expiresAt sql.NullString + if ttlSeconds > 0 { + expiresAt = sql.NullString{String: fmt.Sprintf("+%d seconds", ttlSeconds), Valid: true} + } + + _, err = s.db.ExecContext(ctx, ` + INSERT INTO kvstore (key, value, size, created_at, updated_at, expires_at) + VALUES (?, ?, ?, CURRENT_TIMESTAMP, CURRENT_TIMESTAMP, datetime('now', ?)) + ON CONFLICT(key) DO UPDATE SET + value = excluded.value, + size = excluded.size, + updated_at = CURRENT_TIMESTAMP, + expires_at = excluded.expires_at + `, key, value, newValueSize, expiresAt) + if err != nil { + return fmt.Errorf("storing value: %w", err) + } + + log.Trace(ctx, "KVStore.Set", "plugin", s.pluginName, "key", key, "size", newValueSize, "ttlSeconds", ttlSeconds) + return nil +} + +// Set stores a byte value with the given key. +func (s *kvstoreServiceImpl) Set(ctx context.Context, key string, value []byte) error { + return s.setValue(ctx, key, value, 0) +} + +// SetWithTTL stores a byte value with the given key and a time-to-live. +func (s *kvstoreServiceImpl) SetWithTTL(ctx context.Context, key string, value []byte, ttlSeconds int64) error { + if ttlSeconds <= 0 { + return fmt.Errorf("ttlSeconds must be greater than 0") + } + return s.setValue(ctx, key, value, ttlSeconds) +} + +// Get retrieves a byte value from storage. +func (s *kvstoreServiceImpl) Get(ctx context.Context, key string) ([]byte, bool, error) { + var value []byte + err := s.db.QueryRowContext(ctx, `SELECT value FROM kvstore WHERE key = ? AND `+notExpiredFilter, key).Scan(&value) + if errors.Is(err, sql.ErrNoRows) { + return nil, false, nil + } + if err != nil { + return nil, false, fmt.Errorf("reading value: %w", err) + } + + log.Trace(ctx, "KVStore.Get", "plugin", s.pluginName, "key", key, "found", true) + return value, true, nil +} + +// Delete removes a value from storage. +func (s *kvstoreServiceImpl) Delete(ctx context.Context, key string) error { + _, err := s.db.ExecContext(ctx, `DELETE FROM kvstore WHERE key = ?`, key) + if err != nil { + return fmt.Errorf("deleting value: %w", err) + } + + log.Trace(ctx, "KVStore.Delete", "plugin", s.pluginName, "key", key) + return nil +} + +// Has checks if a key exists in storage. +func (s *kvstoreServiceImpl) Has(ctx context.Context, key string) (bool, error) { + var count int + err := s.db.QueryRowContext(ctx, `SELECT COUNT(*) FROM kvstore WHERE key = ? AND `+notExpiredFilter, key).Scan(&count) + if err != nil { + return false, fmt.Errorf("checking key: %w", err) + } + + return count > 0, nil +} + +// List returns all keys matching the given prefix. +func (s *kvstoreServiceImpl) List(ctx context.Context, prefix string) ([]string, error) { + var rows *sql.Rows + var err error + + if prefix == "" { + rows, err = s.db.QueryContext(ctx, `SELECT key FROM kvstore WHERE `+notExpiredFilter+` ORDER BY key`) + } else { + // Escape special LIKE characters in prefix + escapedPrefix := strings.ReplaceAll(prefix, "%", "\\%") + escapedPrefix = strings.ReplaceAll(escapedPrefix, "_", "\\_") + rows, err = s.db.QueryContext(ctx, `SELECT key FROM kvstore WHERE key LIKE ? ESCAPE '\' AND `+notExpiredFilter+` ORDER BY key`, escapedPrefix+"%") + } + if err != nil { + return nil, fmt.Errorf("listing keys: %w", err) + } + defer rows.Close() + + var keys []string + for rows.Next() { + var key string + if err := rows.Scan(&key); err != nil { + return nil, fmt.Errorf("scanning key: %w", err) + } + keys = append(keys, key) + } + + if err := rows.Err(); err != nil { + return nil, fmt.Errorf("iterating keys: %w", err) + } + + log.Trace(ctx, "KVStore.List", "plugin", s.pluginName, "prefix", prefix, "count", len(keys)) + return keys, nil +} + +// GetStorageUsed returns the total storage used by this plugin in bytes. +func (s *kvstoreServiceImpl) GetStorageUsed(ctx context.Context) (int64, error) { + used, err := s.storageUsed(ctx) + if err != nil { + return 0, err + } + log.Trace(ctx, "KVStore.GetStorageUsed", "plugin", s.pluginName, "bytes", used) + return used, nil +} + +// DeleteByPrefix removes all keys matching the given prefix. +func (s *kvstoreServiceImpl) DeleteByPrefix(ctx context.Context, prefix string) (int64, error) { + if prefix == "" { + return 0, fmt.Errorf("prefix cannot be empty") + } + + escapedPrefix := strings.ReplaceAll(prefix, "%", "\\%") + escapedPrefix = strings.ReplaceAll(escapedPrefix, "_", "\\_") + result, err := s.db.ExecContext(ctx, `DELETE FROM kvstore WHERE key LIKE ? ESCAPE '\'`, escapedPrefix+"%") + if err != nil { + return 0, fmt.Errorf("deleting keys: %w", err) + } + + count, err := result.RowsAffected() + if err != nil { + return 0, fmt.Errorf("getting deleted count: %w", err) + } + + log.Trace(ctx, "KVStore.DeleteByPrefix", "plugin", s.pluginName, "prefix", prefix, "deletedCount", count) + return count, nil +} + +// GetMany retrieves multiple values in a single call, processing keys in batches. +func (s *kvstoreServiceImpl) GetMany(ctx context.Context, keys []string) (map[string][]byte, error) { + if len(keys) == 0 { + return map[string][]byte{}, nil + } + + const batchSize = 200 + result := make(map[string][]byte) + for chunk := range slice.CollectChunks(slices.Values(keys), batchSize) { + placeholders := make([]string, len(chunk)) + args := make([]any, len(chunk)) + for i, key := range chunk { + placeholders[i] = "?" + args[i] = key + } + + query := `SELECT key, value FROM kvstore WHERE key IN (` + strings.Join(placeholders, ",") + `) AND ` + notExpiredFilter //nolint:gosec // placeholders are always "?" + rows, err := s.db.QueryContext(ctx, query, args...) + if err != nil { + return nil, fmt.Errorf("querying values: %w", err) + } + + for rows.Next() { + var key string + var value []byte + if err := rows.Scan(&key, &value); err != nil { + rows.Close() + return nil, fmt.Errorf("scanning value: %w", err) + } + result[key] = value + } + if err := rows.Err(); err != nil { + rows.Close() + return nil, fmt.Errorf("iterating values: %w", err) + } + rows.Close() + } + + log.Trace(ctx, "KVStore.GetMany", "plugin", s.pluginName, "requested", len(keys), "found", len(result)) + return result, nil +} + +// cleanupLoop periodically removes expired keys from the database. +// It stops when the provided context is cancelled. +func (s *kvstoreServiceImpl) cleanupLoop(ctx context.Context) { + defer s.wg.Done() + ticker := time.NewTicker(cleanupInterval) + defer ticker.Stop() + for { + select { + case <-ctx.Done(): + return + case <-ticker.C: + s.cleanupExpired(ctx) + } + } +} + +// cleanupExpired removes all expired keys from the database to reclaim disk space. +func (s *kvstoreServiceImpl) cleanupExpired(ctx context.Context) { + result, err := s.db.ExecContext(ctx, `DELETE FROM kvstore WHERE expires_at IS NOT NULL AND expires_at < datetime('now')`) + if err != nil { + log.Error(ctx, "KVStore cleanup: failed to delete expired keys", "plugin", s.pluginName, err) + return + } + if count, err := result.RowsAffected(); err == nil && count > 0 { + log.Debug("KVStore cleanup completed", "plugin", s.pluginName, "deletedKeys", count) + } +} + +// Close stops the cleanup goroutine and closes the SQLite database connection. +func (s *kvstoreServiceImpl) Close() error { + log.Debug("Closing plugin kvstore", "plugin", s.pluginName) + s.cancel() + s.wg.Wait() + return s.db.Close() +} + +// Compile-time verification +var _ host.KVStoreService = (*kvstoreServiceImpl)(nil) diff --git a/plugins/host_kvstore_test.go b/plugins/host_kvstore_test.go new file mode 100644 index 000000000..997409146 --- /dev/null +++ b/plugins/host_kvstore_test.go @@ -0,0 +1,1040 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + "strings" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("KVStoreService", func() { + var tmpDir string + var service *kvstoreServiceImpl + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + var err error + tmpDir, err = os.MkdirTemp("", "kvstore-test-*") + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = conf.NewDir(tmpDir) + + // Create service with 1KB limit for testing + service, err = newKVStoreService(ctx, "test_plugin", &KVStorePermission{MaxSize: new("1KB")}) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if service != nil { + service.Close() + } + os.RemoveAll(tmpDir) + }) + + Describe("Basic Operations", func() { + It("sets and gets a value", func() { + err := service.Set(ctx, "key1", []byte("value1")) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "key1") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("value1"))) + }) + + It("returns not exists for missing key", func() { + value, exists, err := service.Get(ctx, "missing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) + }) + + It("overwrites existing key", func() { + err := service.Set(ctx, "key1", []byte("value1")) + Expect(err).ToNot(HaveOccurred()) + + err = service.Set(ctx, "key1", []byte("value2")) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "key1") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("value2"))) + }) + + It("handles binary data", func() { + binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0xFD} + err := service.Set(ctx, "binary", binaryData) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "binary") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal(binaryData)) + }) + }) + + Describe("Delete Operation", func() { + It("deletes a value", func() { + err := service.Set(ctx, "delete_me", []byte("value")) + Expect(err).ToNot(HaveOccurred()) + + err = service.Delete(ctx, "delete_me") + Expect(err).ToNot(HaveOccurred()) + + _, exists, err := service.Get(ctx, "delete_me") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("does not error when deleting non-existing key", func() { + err := service.Delete(ctx, "never_existed") + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Has Operation", func() { + It("returns true for existing key", func() { + err := service.Set(ctx, "exists_key", []byte("value")) + Expect(err).ToNot(HaveOccurred()) + + exists, err := service.Has(ctx, "exists_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + }) + + It("returns false for non-existing key", func() { + exists, err := service.Has(ctx, "non_existing_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + }) + + Describe("List Operation", func() { + BeforeEach(func() { + Expect(service.Set(ctx, "user:1:name", []byte("Alice"))).To(Succeed()) + Expect(service.Set(ctx, "user:1:email", []byte("alice@test.com"))).To(Succeed()) + Expect(service.Set(ctx, "user:2:name", []byte("Bob"))).To(Succeed()) + Expect(service.Set(ctx, "config:theme", []byte("dark"))).To(Succeed()) + }) + + It("lists all keys with empty prefix", func() { + keys, err := service.List(ctx, "") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(4)) + Expect(keys).To(ContainElements("config:theme", "user:1:email", "user:1:name", "user:2:name")) + }) + + It("lists keys matching prefix", func() { + keys, err := service.List(ctx, "user:1:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(2)) + Expect(keys).To(ContainElements("user:1:name", "user:1:email")) + }) + + It("lists keys matching partial prefix", func() { + keys, err := service.List(ctx, "user:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(3)) + }) + + It("returns empty list for non-matching prefix", func() { + keys, err := service.List(ctx, "notfound:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(BeEmpty()) + }) + + It("handles special LIKE characters in prefix", func() { + // Add keys with special characters + Expect(service.Set(ctx, "test%key", []byte("value1"))).To(Succeed()) + Expect(service.Set(ctx, "test_key", []byte("value2"))).To(Succeed()) + Expect(service.Set(ctx, "testXkey", []byte("value3"))).To(Succeed()) + + // Search for "test%" + keys, err := service.List(ctx, "test%") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(1)) + Expect(keys).To(ContainElement("test%key")) + }) + }) + + Describe("Storage Usage", func() { + It("reports correct storage used", func() { + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(0))) + + err = service.Set(ctx, "key1", []byte("12345")) + Expect(err).ToNot(HaveOccurred()) + + used, err = service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(5))) + + err = service.Set(ctx, "key2", []byte("67890")) + Expect(err).ToNot(HaveOccurred()) + + used, err = service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(10))) + }) + + It("updates storage when value is overwritten", func() { + err := service.Set(ctx, "key1", []byte("12345")) + Expect(err).ToNot(HaveOccurred()) + + used, _ := service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(5))) + + // Overwrite with smaller value + err = service.Set(ctx, "key1", []byte("ab")) + Expect(err).ToNot(HaveOccurred()) + + used, _ = service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(2))) + }) + + It("decreases storage when key is deleted", func() { + Expect(service.Set(ctx, "key1", []byte("12345"))).To(Succeed()) + Expect(service.Set(ctx, "key2", []byte("67890"))).To(Succeed()) + + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(10))) + + Expect(service.Delete(ctx, "key1")).To(Succeed()) + + used, err = service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(5))) + }) + + It("updates storage when value is overwritten with larger value", func() { + err := service.Set(ctx, "key1", []byte("ab")) + Expect(err).ToNot(HaveOccurred()) + + used, _ := service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(2))) + + // Overwrite with larger value + err = service.Set(ctx, "key1", []byte("12345")) + Expect(err).ToNot(HaveOccurred()) + + used, _ = service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(5))) + }) + + It("restores correct size after service restart", func() { + // Add some data + Expect(service.Set(ctx, "key1", []byte("12345"))).To(Succeed()) + Expect(service.Set(ctx, "key2", []byte("67890"))).To(Succeed()) + + used, _ := service.GetStorageUsed(ctx) + Expect(used).To(Equal(int64(10))) + + // Close and reopen the service (simulating restart) + Expect(service.Close()).To(Succeed()) + + service2, err := newKVStoreService(ctx, "test_plugin", &KVStorePermission{MaxSize: new("1KB")}) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Size should be restored from database + used, err = service2.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(10))) + }) + }) + + Describe("Size Limits", func() { + It("rejects value when storage limit would be exceeded", func() { + // Service has 1KB limit + bigValue := make([]byte, 2048) + err := service.Set(ctx, "big", bigValue) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) + }) + + It("allows updating existing key even if total would exceed limit", func() { + // Fill up most of the storage + almostFull := make([]byte, 900) + err := service.Set(ctx, "big", almostFull) + Expect(err).ToNot(HaveOccurred()) + + // Overwrite with same size should work + err = service.Set(ctx, "big", almostFull) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Key Validation", func() { + It("rejects empty key", func() { + err := service.Set(ctx, "", []byte("value")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("key cannot be empty")) + }) + + It("rejects key exceeding max length", func() { + longKey := strings.Repeat("a", 300) + err := service.Set(ctx, longKey, []byte("value")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("key exceeds maximum length")) + }) + }) + + Describe("Plugin Isolation", func() { + It("isolates data between plugins", func() { + service2, err := newKVStoreService(ctx, "other_plugin", &KVStorePermission{}) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Set same key in both plugins + err = service.Set(ctx, "shared", []byte("value1")) + Expect(err).ToNot(HaveOccurred()) + err = service2.Set(ctx, "shared", []byte("value2")) + Expect(err).ToNot(HaveOccurred()) + + // Each plugin should get their own value + val1, _, _ := service.Get(ctx, "shared") + Expect(val1).To(Equal([]byte("value1"))) + + val2, _, _ := service2.Get(ctx, "shared") + Expect(val2).To(Equal([]byte("value2"))) + }) + + It("creates separate database files per plugin", func() { + service2, err := newKVStoreService(ctx, "other_plugin", &KVStorePermission{}) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Check that separate directories exist + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "test_plugin", "kvstore.db")) + Expect(err).ToNot(HaveOccurred()) + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "other_plugin", "kvstore.db")) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("Close", func() { + It("closes database connection", func() { + err := service.Close() + Expect(err).ToNot(HaveOccurred()) + + // After close, operations should fail + _, _, err = service.Get(ctx, "any") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("TTL Expiration", func() { + It("Get returns not-exists for expired keys", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_key', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + value, exists, err := service.Get(ctx, "expired_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + Expect(value).To(BeNil()) + }) + It("Has returns false for expired keys", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_has', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + exists, err := service.Has(ctx, "expired_has") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + It("List excludes expired keys", func() { + Expect(service.Set(ctx, "live:1", []byte("alive"))).To(Succeed()) + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('live:expired', 'dead', 4, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + keys, err := service.List(ctx, "live:") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(1)) + Expect(keys).To(ContainElement("live:1")) + }) + It("Get returns value for non-expired keys with TTL", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('future_key', 'still alive', 11, datetime('now', '+3600 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + value, exists, err := service.Get(ctx, "future_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("still alive"))) + }) + It("Set clears expires_at from a key previously set with TTL", func() { + // Insert a key with a TTL that has already expired + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('ttl_then_set', 'temp', 4, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Overwrite with Set (no TTL) — should become permanent + err = service.Set(ctx, "ttl_then_set", []byte("permanent")) + Expect(err).ToNot(HaveOccurred()) + + // Should exist because Set cleared expires_at + value, exists, err := service.Get(ctx, "ttl_then_set") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("permanent"))) + + // Verify expires_at is actually NULL + var expiresAt *string + Expect(service.db.QueryRow(`SELECT expires_at FROM kvstore WHERE key = 'ttl_then_set'`).Scan(&expiresAt)).To(Succeed()) + Expect(expiresAt).To(BeNil()) + }) + It("expired keys are not counted in storage used", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_key', '12345', 5, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Expired keys should not be counted + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(0))) + }) + It("cleanup removes expired rows from disk", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('cleanup_me', '12345', 5, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Row exists in DB but is logically expired + var count int + Expect(service.db.QueryRow(`SELECT COUNT(*) FROM kvstore`).Scan(&count)).To(Succeed()) + Expect(count).To(Equal(1)) + + service.cleanupExpired(ctx) + + // Row should be physically deleted + Expect(service.db.QueryRow(`SELECT COUNT(*) FROM kvstore`).Scan(&count)).To(Succeed()) + Expect(count).To(Equal(0)) + }) + }) + + Describe("Close", func() { + It("does not race with cleanupLoop goroutine", func() { + // Create a service with a dedicated context so we can verify + // that Close() properly waits for the cleanup goroutine. + closeCtx, closeCancel := context.WithCancel(ctx) + defer closeCancel() + + svc, err := newKVStoreService(closeCtx, "test_close_race", &KVStorePermission{MaxSize: new("1KB")}) + Expect(err).ToNot(HaveOccurred()) + + // Insert an expired key so cleanup has work to do + _, err = svc.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('cleanup_race', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Close should not panic or produce "database is closed" errors. + // Before the fix, the cleanup goroutine could race with db.Close(). + err = svc.Close() + Expect(err).ToNot(HaveOccurred()) + + // Verify the database is actually closed (further queries should fail) + _, err = svc.db.Exec(`SELECT 1`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("database is closed")) + }) + }) + + Describe("SetWithTTL", func() { + It("stores value that is retrievable before expiry", func() { + err := service.SetWithTTL(ctx, "ttl_key", []byte("ttl_value"), 3600) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "ttl_key") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("ttl_value"))) + }) + + It("value is not retrievable after expiry", func() { + // Insert a key with an already-expired TTL + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('short_ttl', 'gone_soon', 9, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + _, exists, err := service.Get(ctx, "short_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeFalse()) + }) + + It("rejects ttlSeconds <= 0", func() { + err := service.SetWithTTL(ctx, "bad_ttl", []byte("value"), 0) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ttlSeconds must be greater than 0")) + + err = service.SetWithTTL(ctx, "bad_ttl", []byte("value"), -5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("ttlSeconds must be greater than 0")) + }) + + It("validates key same as Set", func() { + err := service.SetWithTTL(ctx, "", []byte("value"), 60) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("key cannot be empty")) + }) + + It("enforces size limits same as Set", func() { + bigValue := make([]byte, 2048) + err := service.SetWithTTL(ctx, "big_ttl", bigValue, 60) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) + }) + + It("overwrites existing key and updates TTL", func() { + // Insert a key with an already-expired TTL + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('overwrite_ttl', 'first', 5, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + // Overwrite with a long TTL — should be retrievable + err = service.SetWithTTL(ctx, "overwrite_ttl", []byte("second"), 3600) + Expect(err).ToNot(HaveOccurred()) + + value, exists, err := service.Get(ctx, "overwrite_ttl") + Expect(err).ToNot(HaveOccurred()) + Expect(exists).To(BeTrue()) + Expect(value).To(Equal([]byte("second"))) + }) + + It("tracks storage correctly", func() { + err := service.SetWithTTL(ctx, "sized_ttl", []byte("12345"), 3600) + Expect(err).ToNot(HaveOccurred()) + + used, err := service.GetStorageUsed(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(used).To(Equal(int64(5))) + }) + }) + + Describe("DeleteByPrefix", func() { + BeforeEach(func() { + Expect(service.Set(ctx, "cache:user:1", []byte("Alice"))).To(Succeed()) + Expect(service.Set(ctx, "cache:user:2", []byte("Bob"))).To(Succeed()) + Expect(service.Set(ctx, "cache:item:1", []byte("Widget"))).To(Succeed()) + Expect(service.Set(ctx, "data:important", []byte("keep"))).To(Succeed()) + }) + + It("deletes all keys with the given prefix", func() { + deleted, err := service.DeleteByPrefix(ctx, "cache:user:") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(2))) + + keys, err := service.List(ctx, "") + Expect(err).ToNot(HaveOccurred()) + Expect(keys).To(HaveLen(2)) + Expect(keys).To(ContainElements("cache:item:1", "data:important")) + }) + + It("rejects empty prefix", func() { + _, err := service.DeleteByPrefix(ctx, "") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("prefix cannot be empty")) + }) + + It("returns 0 when no keys match", func() { + deleted, err := service.DeleteByPrefix(ctx, "nonexistent:") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(0))) + }) + + It("updates storage size correctly", func() { + usedBefore, _ := service.GetStorageUsed(ctx) + Expect(usedBefore).To(BeNumerically(">", 0)) + + _, err := service.DeleteByPrefix(ctx, "cache:") + Expect(err).ToNot(HaveOccurred()) + + usedAfter, _ := service.GetStorageUsed(ctx) + Expect(usedAfter).To(Equal(int64(4))) + }) + + It("handles special LIKE characters in prefix", func() { + Expect(service.Set(ctx, "test%special", []byte("v1"))).To(Succeed()) + Expect(service.Set(ctx, "test_special", []byte("v2"))).To(Succeed()) + Expect(service.Set(ctx, "testXspecial", []byte("v3"))).To(Succeed()) + + deleted, err := service.DeleteByPrefix(ctx, "test%") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(1))) + + exists, _ := service.Has(ctx, "test_special") + Expect(exists).To(BeTrue()) + exists, _ = service.Has(ctx, "testXspecial") + Expect(exists).To(BeTrue()) + }) + + It("also deletes expired keys matching prefix", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('cache:expired', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + deleted, err := service.DeleteByPrefix(ctx, "cache:") + Expect(err).ToNot(HaveOccurred()) + Expect(deleted).To(Equal(int64(4))) + }) + }) + + Describe("GetMany", func() { + BeforeEach(func() { + Expect(service.Set(ctx, "key1", []byte("value1"))).To(Succeed()) + Expect(service.Set(ctx, "key2", []byte("value2"))).To(Succeed()) + Expect(service.Set(ctx, "key3", []byte("value3"))).To(Succeed()) + }) + + It("retrieves multiple values at once", func() { + values, err := service.GetMany(ctx, []string{"key1", "key2", "key3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(HaveLen(3)) + Expect(values["key1"]).To(Equal([]byte("value1"))) + Expect(values["key2"]).To(Equal([]byte("value2"))) + Expect(values["key3"]).To(Equal([]byte("value3"))) + }) + + It("omits missing keys from result", func() { + values, err := service.GetMany(ctx, []string{"key1", "missing", "key3"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(HaveLen(2)) + Expect(values["key1"]).To(Equal([]byte("value1"))) + Expect(values["key3"]).To(Equal([]byte("value3"))) + _, hasMissing := values["missing"] + Expect(hasMissing).To(BeFalse()) + }) + + It("returns empty map for empty keys slice", func() { + values, err := service.GetMany(ctx, []string{}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(BeEmpty()) + }) + + It("returns empty map for nil keys slice", func() { + values, err := service.GetMany(ctx, nil) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(BeEmpty()) + }) + + It("excludes expired keys", func() { + _, err := service.db.Exec(` + INSERT INTO kvstore (key, value, size, expires_at) + VALUES ('expired_many', 'old', 3, datetime('now', '-1 seconds')) + `) + Expect(err).ToNot(HaveOccurred()) + + values, err := service.GetMany(ctx, []string{"key1", "expired_many"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(HaveLen(1)) + Expect(values["key1"]).To(Equal([]byte("value1"))) + }) + + It("handles all keys missing", func() { + values, err := service.GetMany(ctx, []string{"nope1", "nope2"}) + Expect(err).ToNot(HaveOccurred()) + Expect(values).To(BeEmpty()) + }) + }) +}) + +var _ = Describe("KVStoreService Integration", Ordered, func() { + var ( + manager *Manager + tmpDir string + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "kvstore-integration-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-kvstore plugin + srcPath := filepath.Join(testdataDir, "test-kvstore"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-kvstore"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + conf.Server.DataFolder = conf.NewDir(tmpDir) + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-kvstore", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with kvstore permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-kvstore"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Kvstore).ToNot(BeNil()) + Expect(*p.manifest.Permissions.Kvstore.MaxSize).To(Equal("10KB")) + }) + }) + + Describe("KVStore Operations via Plugin", func() { + type testKVStoreInput struct { + Operation string `json:"operation"` + Key string `json:"key"` + Value []byte `json:"value,omitempty"` + Prefix string `json:"prefix,omitempty"` + TTLSeconds int64 `json:"ttl_seconds,omitempty"` + Keys []string `json:"keys,omitempty"` + } + type testKVStoreOutput struct { + Value []byte `json:"value,omitempty"` + Values map[string][]byte `json:"values,omitempty"` + Exists bool `json:"exists,omitempty"` + Keys []string `json:"keys,omitempty"` + StorageUsed int64 `json:"storage_used,omitempty"` + DeletedCount int64 `json:"deleted_count,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestKVStore := func(ctx context.Context, input testKVStoreInput) (*testKVStoreOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-kvstore"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_kvstore", inputBytes) + if err != nil { + return nil, err + } + + var output testKVStoreOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + It("should set and get value", func() { + ctx := GinkgoT().Context() + + // Set value + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "test_key", + Value: []byte("hello kvstore"), + }) + Expect(err).ToNot(HaveOccurred()) + + // Get value + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "test_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.Value).To(Equal([]byte("hello kvstore"))) + }) + + It("should check key existence with has", func() { + ctx := GinkgoT().Context() + + // Check existing key + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "test_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + + // Check non-existing key + output, err = callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "non_existing", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should delete value", func() { + ctx := GinkgoT().Context() + + // Set another key + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "to_delete", + Value: []byte("delete me"), + }) + Expect(err).ToNot(HaveOccurred()) + + // Delete it + _, err = callTestKVStore(ctx, testKVStoreInput{ + Operation: "delete", + Key: "to_delete", + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify it's gone + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "to_delete", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeFalse()) + }) + + It("should list keys with prefix", func() { + ctx := GinkgoT().Context() + + // Set some keys + for _, key := range []string{"prefix:1", "prefix:2", "other:1"} { + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: key, + Value: []byte("value"), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // List with prefix + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "list", + Prefix: "prefix:", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Keys).To(HaveLen(2)) + Expect(output.Keys).To(ContainElements("prefix:1", "prefix:2")) + }) + + It("should report storage used", func() { + ctx := GinkgoT().Context() + + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get_storage_used", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.StorageUsed).To(BeNumerically(">", 0)) + }) + + It("should enforce size limits", func() { + ctx := GinkgoT().Context() + + // Plugin has 10KB limit, try to exceed it + bigValue := make([]byte, 15*1024) + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "too_big", + Value: bigValue, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("storage limit exceeded")) + }) + + It("should handle binary data with null bytes through WASM", func() { + ctx := GinkgoT().Context() + + // Binary data with null bytes, high bytes, and other edge cases + binaryData := []byte{0x00, 0x01, 0x02, 0xFF, 0xFE, 0x00, 0x80, 0x7F} + + // Set binary value + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: "binary_test", + Value: binaryData, + }) + Expect(err).ToNot(HaveOccurred()) + + // Get binary value and verify exact match + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "binary_test", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.Value).To(Equal(binaryData)) + }) + + It("should set value with TTL and expire it", func() { + ctx := GinkgoT().Context() + + // Set value with 1 second TTL + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set_with_ttl", + Key: "ttl_key", + Value: []byte("temporary"), + TTLSeconds: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Immediately should exist + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "ttl_key", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Exists).To(BeTrue()) + Expect(output.Value).To(Equal([]byte("temporary"))) + + // Poll until the key expires (1s TTL) + Eventually(func(g Gomega) { + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get", + Key: "ttl_key", + }) + g.Expect(err).ToNot(HaveOccurred()) + g.Expect(output.Exists).To(BeFalse()) + }).WithTimeout(3 * time.Second).WithPolling(200 * time.Millisecond).Should(Succeed()) + }) + + It("should delete keys by prefix", func() { + ctx := GinkgoT().Context() + + // Set multiple keys with shared prefix + for _, key := range []string{"del_prefix:a", "del_prefix:b", "keep:c"} { + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: key, + Value: []byte("value"), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // Delete by prefix + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "delete_by_prefix", + Prefix: "del_prefix:", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.DeletedCount).To(Equal(int64(2))) + + // Verify remaining key + getOutput, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "keep:c", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(getOutput.Exists).To(BeTrue()) + + // Verify deleted keys are gone + getOutput, err = callTestKVStore(ctx, testKVStoreInput{ + Operation: "has", + Key: "del_prefix:a", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(getOutput.Exists).To(BeFalse()) + }) + + It("should get many values at once", func() { + ctx := GinkgoT().Context() + + // Set multiple keys + for _, kv := range []struct{ k, v string }{ + {"many:1", "val1"}, + {"many:2", "val2"}, + {"many:3", "val3"}, + } { + _, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "set", + Key: kv.k, + Value: []byte(kv.v), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // Get many, including a missing key + output, err := callTestKVStore(ctx, testKVStoreInput{ + Operation: "get_many", + Keys: []string{"many:1", "many:3", "many:missing"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Values).To(HaveLen(2)) + Expect(output.Values["many:1"]).To(Equal([]byte("val1"))) + Expect(output.Values["many:3"]).To(Equal([]byte("val3"))) + _, hasMissing := output.Values["many:missing"] + Expect(hasMissing).To(BeFalse()) + }) + }) + + Describe("Database Isolation", func() { + It("should create separate database file for plugin", func() { + dbPath := filepath.Join(tmpDir, "plugins", "test-kvstore", "kvstore.db") + _, err := os.Stat(dbPath) + Expect(err).ToNot(HaveOccurred()) + }) + }) +}) diff --git a/plugins/host_library.go b/plugins/host_library.go new file mode 100644 index 000000000..3d9f61b4f --- /dev/null +++ b/plugins/host_library.go @@ -0,0 +1,99 @@ +package plugins + +import ( + "context" + "fmt" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" +) + +type libraryServiceImpl struct { + ds model.DataStore + hasFilesystemPerm bool + allowedLibraryIDs []int + allLibraries bool + libraryIDMap map[int]struct{} +} + +func newLibraryService(ds model.DataStore, perm *LibraryPermission, allowedLibraryIDs []int, allLibraries bool) host.LibraryService { + hasFS := perm != nil && perm.Filesystem + libraryIDMap := make(map[int]struct{}) + for _, id := range allowedLibraryIDs { + libraryIDMap[id] = struct{}{} + } + return &libraryServiceImpl{ + ds: ds, + hasFilesystemPerm: hasFS, + allowedLibraryIDs: allowedLibraryIDs, + allLibraries: allLibraries, + libraryIDMap: libraryIDMap, + } +} + +func (s *libraryServiceImpl) GetLibrary(ctx context.Context, id int32) (*host.Library, error) { + // Check if the library is accessible + if !s.isLibraryAccessible(int(id)) { + return nil, fmt.Errorf("library not accessible: library ID %d is not in the allowed list", id) + } + + lib, err := s.ds.Library(ctx).Get(int(id)) + if err != nil { + return nil, fmt.Errorf("library not found: %w", err) + } + + return s.convertLibrary(lib), nil +} + +// isLibraryAccessible checks if a library ID is accessible to this plugin. +func (s *libraryServiceImpl) isLibraryAccessible(id int) bool { + if s.allLibraries { + return true + } + _, ok := s.libraryIDMap[id] + return ok +} + +func (s *libraryServiceImpl) GetAllLibraries(ctx context.Context) ([]host.Library, error) { + libs, err := s.ds.Library(ctx).GetAll() + if err != nil { + return nil, fmt.Errorf("failed to get libraries: %w", err) + } + + // Filter libraries based on allowed list + var result []host.Library + for _, lib := range libs { + if s.isLibraryAccessible(lib.ID) { + result = append(result, *s.convertLibrary(&lib)) + } + } + + return result, nil +} + +func (s *libraryServiceImpl) convertLibrary(lib *model.Library) *host.Library { + hostLib := &host.Library{ + ID: int32(lib.ID), + Name: lib.Name, + LastScanAt: lib.LastScanAt.Unix(), + TotalSongs: int32(lib.TotalSongs), + TotalAlbums: int32(lib.TotalAlbums), + TotalArtists: int32(lib.TotalArtists), + TotalSize: lib.TotalSize, + TotalDuration: lib.TotalDuration, + } + + // Only include path and mount point if filesystem permission is granted + if s.hasFilesystemPerm { + hostLib.Path = lib.Path + hostLib.MountPoint = toPluginMountPoint(int32(lib.ID)) + } + + return hostLib +} + +func toPluginMountPoint(libID int32) string { + return fmt.Sprintf("/libraries/%d", libID) +} + +var _ host.LibraryService = (*libraryServiceImpl)(nil) diff --git a/plugins/host_library_test.go b/plugins/host_library_test.go new file mode 100644 index 000000000..eb5b17a02 --- /dev/null +++ b/plugins/host_library_test.go @@ -0,0 +1,567 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("LibraryService", Ordered, func() { + var ( + ctx context.Context + ds model.DataStore + service *libraryServiceImpl + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = context.Background() + ds = &tests.MockDataStore{} + }) + + Describe("GetLibrary", func() { + It("should return library metadata without filesystem permission", func() { + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: false}, nil, true).(*libraryServiceImpl) + + lib := &model.Library{ + ID: 1, + Name: "Test Library", + Path: "/music/test", + TotalSongs: 100, + TotalAlbums: 10, + TotalArtists: 5, + TotalSize: 1024000, + TotalDuration: 3600.5, + } + lib.LastScanAt = lib.LastScanAt.Add(0) // Ensure time is set + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{*lib}) + + result, err := service.GetLibrary(ctx, 1) + Expect(err).ToNot(HaveOccurred()) + Expect(result.ID).To(Equal(int32(1))) + Expect(result.Name).To(Equal("Test Library")) + Expect(result.TotalSongs).To(Equal(int32(100))) + Expect(result.TotalAlbums).To(Equal(int32(10))) + Expect(result.TotalArtists).To(Equal(int32(5))) + Expect(result.TotalSize).To(Equal(int64(1024000))) + Expect(result.TotalDuration).To(Equal(3600.5)) + Expect(result.Path).To(BeEmpty(), "Path should not be included without filesystem permission") + Expect(result.MountPoint).To(BeEmpty(), "MountPoint should not be included without filesystem permission") + }) + + It("should return library metadata with filesystem permission", func() { + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: true}, nil, true).(*libraryServiceImpl) + + lib := &model.Library{ + ID: 2, + Name: "FS Library", + Path: "/music/fs", + TotalSongs: 50, + TotalAlbums: 5, + TotalArtists: 3, + TotalSize: 512000, + TotalDuration: 1800.0, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{*lib}) + + result, err := service.GetLibrary(ctx, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(result.ID).To(Equal(int32(2))) + Expect(result.Name).To(Equal("FS Library")) + Expect(result.Path).To(Equal("/music/fs"), "Path should be included with filesystem permission") + Expect(result.MountPoint).To(Equal("/libraries/2"), "MountPoint should be included with filesystem permission") + }) + + It("should return error for non-existent library", func() { + service = newLibraryService(ds, &LibraryPermission{Reason: new("test")}, nil, true).(*libraryServiceImpl) + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{}) + + _, err := service.GetLibrary(ctx, 999) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("library not found")) + }) + }) + + Describe("GetAllLibraries", func() { + It("should return all libraries without filesystem permission", func() { + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: false}, nil, true).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results[0].Name).To(Equal("Rock")) + Expect(results[0].Path).To(BeEmpty()) + Expect(results[0].MountPoint).To(BeEmpty()) + Expect(results[1].Name).To(Equal("Jazz")) + Expect(results[1].Path).To(BeEmpty()) + Expect(results[1].MountPoint).To(BeEmpty()) + }) + + It("should return all libraries with filesystem permission", func() { + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: true}, nil, true).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + Expect(results[0].Path).To(Equal("/music/rock")) + Expect(results[0].MountPoint).To(Equal("/libraries/1")) + Expect(results[1].Path).To(Equal("/music/jazz")) + Expect(results[1].MountPoint).To(Equal("/libraries/2")) + }) + }) + + Describe("Library Access Filtering", func() { + It("should only return libraries in the allowed list", func() { // Only allow library ID 2 + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: false}, []int{2}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + {ID: 3, Name: "Classical", Path: "/music/classical", TotalSongs: 75}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(1)) + Expect(results[0].ID).To(Equal(int32(2))) + Expect(results[0].Name).To(Equal("Jazz")) + }) + + It("should return error when getting a library not in the allowed list", func() { // Only allow library ID 2 + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: false}, []int{2}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + // Requesting library 1 which is not in the allowed list + _, err := service.GetLibrary(ctx, 1) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not accessible")) + }) + + It("should allow access to a library in the allowed list", func() { // Only allow library ID 2 + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: false}, []int{2}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + result, err := service.GetLibrary(ctx, 2) + Expect(err).ToNot(HaveOccurred()) + Expect(result.ID).To(Equal(int32(2))) + Expect(result.Name).To(Equal("Jazz")) + }) + + It("should return empty list when no libraries are allowed and allLibraries is false", func() { // No libraries allowed + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: false}, []int{}, false).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(0)) + }) + + It("should return all libraries when allLibraries is true regardless of allowed list", func() { // allLibraries=true should ignore the allowed list + service = newLibraryService(ds, &LibraryPermission{Reason: new("test"), Filesystem: false}, []int{1}, true).(*libraryServiceImpl) + + libs := model.Libraries{ + {ID: 1, Name: "Rock", Path: "/music/rock", TotalSongs: 100}, + {ID: 2, Name: "Jazz", Path: "/music/jazz", TotalSongs: 50}, + } + + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(libs) + + results, err := service.GetAllLibraries(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(2)) + }) + }) + + Describe("Plugin Integration", func() { + var ( + manager *Manager + tmpDir string + ) + + BeforeEach(func() { + var err error + tmpDir, err = os.MkdirTemp("", "library-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Note: Since we don't have WASM test plugins yet, we can test + // the service registration and configuration without full plugin execution + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + + // Create mock &tests.MockLibraryRepo{} + mockLibRepo := &tests.MockLibraryRepo{} + mockLibRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test", Path: "/tmp/test-music", TotalSongs: 10}, + }) + + ds := &tests.MockDataStore{ + MockedProperty: &tests.MockedPropertyRepo{}, + MockedPlugin: tests.CreateMockPluginRepo(), + MockedLibrary: mockLibRepo, + } + + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: ds, + } + + DeferCleanup(func() { + if manager != nil { + _ = manager.Stop() + } + _ = os.RemoveAll(tmpDir) + }) + }) + + It("should register library service in hostServices table", func() { + // Verify the library service is in the hostServices table + found := false + for _, entry := range hostServices { + if entry.name == "Library" { + found = true + break + } + } + Expect(found).To(BeTrue(), "Library service should be registered in hostServices") + }) + + It("should configure AllowedPaths when filesystem permission is granted", func() { + // This test verifies the AllowedPaths configuration logic + // We can't fully test without a real WASM plugin, but we can verify the setup + Expect(manager.ds).ToNot(BeNil()) + + ctx := context.Background() + libs, err := manager.ds.Library(adminContext(ctx)).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(libs).To(HaveLen(1)) + Expect(libs[0].Path).To(Equal("/tmp/test-music")) + + // Verify mount point format + mountPoint := "/libraries/1" + Expect(mountPoint).To(MatchRegexp(`^/libraries/\d+$`)) + }) + }) +}) + +var _ = Describe("LibraryService Integration", Ordered, func() { + var ( + manager *Manager + tmpDir string + libraryDir string + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "library-integration-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Create a library directory with a test file + libraryDir = filepath.Join(tmpDir, "music-library") + err = os.MkdirAll(libraryDir, 0755) + Expect(err).ToNot(HaveOccurred()) + + // Create a test file in the library + testFile := filepath.Join(libraryDir, "test-track.txt") + err = os.WriteFile(testFile, []byte("test audio file content"), 0600) + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-library plugin + srcPath := filepath.Join(testdataDir, "test-library"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-library"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugin and library + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-library", + Path: destPath, + SHA256: hashHex, + Enabled: true, + AllLibraries: true, // Grant access to all libraries for testing + }}) + + mockLibraryRepo := &tests.MockLibraryRepo{} + mockLibraryRepo.SetData(model.Libraries{ + { + ID: 1, + Name: "Test Library", + Path: libraryDir, + TotalSongs: 100, + TotalAlbums: 10, + TotalArtists: 5, + TotalSize: 1024000, + TotalDuration: 3600.5, + }, + { + ID: 2, + Name: "Jazz Collection", + Path: "/nonexistent/jazz", + TotalSongs: 50, + TotalAlbums: 5, + TotalArtists: 3, + TotalSize: 512000, + TotalDuration: 1800.0, + }, + }) + + dataStore := &tests.MockDataStore{ + MockedPlugin: mockPluginRepo, + MockedLibrary: mockLibraryRepo, + } + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with library permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-library"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Library).ToNot(BeNil()) + Expect(p.manifest.Permissions.Library.Filesystem).To(BeTrue()) + }) + }) + + Describe("Library Operations via Plugin", func() { + type testLibraryInput struct { + Operation string `json:"operation"` + LibraryID int32 `json:"library_id,omitempty"` + MountPoint string `json:"mount_point,omitempty"` + FilePath string `json:"file_path,omitempty"` + } + type library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path,omitempty"` + MountPoint string `json:"mountPoint,omitempty"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` + } + type testLibraryOutput struct { + Library *library `json:"library,omitempty"` + Libraries []library `json:"libraries,omitempty"` + FileContent string `json:"file_content,omitempty"` + DirEntries []string `json:"dir_entries,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestLibrary := func(ctx context.Context, input testLibraryInput) (*testLibraryOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-library"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_library", inputBytes) + if err != nil { + return nil, err + } + + var output testLibraryOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + It("should get library by ID with metadata", func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_library", + LibraryID: 1, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Library).ToNot(BeNil()) + Expect(output.Library.ID).To(Equal(int32(1))) + Expect(output.Library.Name).To(Equal("Test Library")) + Expect(output.Library.TotalSongs).To(Equal(int32(100))) + Expect(output.Library.TotalAlbums).To(Equal(int32(10))) + Expect(output.Library.TotalArtists).To(Equal(int32(5))) + }) + + It("should include path and mount point with filesystem permission", func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_library", + LibraryID: 1, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Library).ToNot(BeNil()) + Expect(output.Library.Path).To(Equal(libraryDir)) + Expect(output.Library.MountPoint).To(Equal("/libraries/1")) + }) + + It("should get all libraries", func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_all_libraries", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Libraries).To(HaveLen(2)) + + // First library + Expect(output.Libraries[0].ID).To(Equal(int32(1))) + Expect(output.Libraries[0].Name).To(Equal("Test Library")) + Expect(output.Libraries[0].MountPoint).To(Equal("/libraries/1")) + + // Second library + Expect(output.Libraries[1].ID).To(Equal(int32(2))) + Expect(output.Libraries[1].Name).To(Equal("Jazz Collection")) + Expect(output.Libraries[1].MountPoint).To(Equal("/libraries/2")) + }) + + It("should return error for non-existent library", func() { + ctx := GinkgoT().Context() + + _, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "get_library", + LibraryID: 999, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("library not found")) + }) + + // Note: This test is slightly flaky due to a potential race condition in wazero's + // WASI filesystem mounting. The test passes ~85% of the time. Using FlakeAttempts + // to automatically retry on failure. + It("should read file from mounted library directory", FlakeAttempts(5), func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "read_file", + MountPoint: "/libraries/1", + FilePath: "test-track.txt", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.FileContent).To(Equal("test audio file content")) + }) + + // Note: Uses FlakeAttempts for the same reason as the read_file test above + It("should list files in mounted library directory", FlakeAttempts(5), func() { + ctx := GinkgoT().Context() + + output, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "list_dir", + MountPoint: "/libraries/1", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.DirEntries).To(ContainElement("test-track.txt")) + }) + + It("should fail to access unmapped library directory", func() { + ctx := GinkgoT().Context() + + // Try to access a path outside the mapped libraries + _, err := callTestLibrary(ctx, testLibraryInput{ + Operation: "list_dir", + MountPoint: "/etc", + }) + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/plugins/host_scheduler.go b/plugins/host_scheduler.go new file mode 100644 index 000000000..131f56521 --- /dev/null +++ b/plugins/host_scheduler.go @@ -0,0 +1,209 @@ +package plugins + +import ( + "context" + "fmt" + "maps" + "sync" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/plugins/capabilities" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/scheduler" +) + +// CapabilityScheduler indicates the plugin can receive scheduled event callbacks. +// Detected when the plugin exports the scheduler callback function. +const CapabilityScheduler Capability = "Scheduler" + +const FuncSchedulerCallback = "nd_scheduler_callback" + +func init() { + registerCapability( + CapabilityScheduler, + FuncSchedulerCallback, + ) +} + +// timeAfterFunc is a variable for time.AfterFunc, allowing tests to override it. +var timeAfterFunc = time.AfterFunc + +// scheduleEntry stores metadata about a scheduled task. +type scheduleEntry struct { + pluginName string + payload string + isRecurring bool + entryID int // Internal scheduler entry ID (for recurring tasks) + timer *time.Timer // Timer for one-time tasks (nil for recurring) +} + +// schedulerServiceImpl implements host.SchedulerService. +// It provides plugins with scheduling capabilities and invokes callbacks when schedules fire. +type schedulerServiceImpl struct { + pluginName string + manager *Manager + scheduler scheduler.Scheduler + + mu sync.Mutex + schedules map[string]*scheduleEntry +} + +// newSchedulerService creates a new SchedulerService for a plugin. +func newSchedulerService(pluginName string, manager *Manager, sched scheduler.Scheduler) *schedulerServiceImpl { + return &schedulerServiceImpl{ + pluginName: pluginName, + manager: manager, + scheduler: sched, + schedules: make(map[string]*scheduleEntry), + } +} + +func (s *schedulerServiceImpl) ScheduleOneTime(ctx context.Context, delaySeconds int32, payload string, scheduleID string) (string, error) { + if scheduleID == "" { + scheduleID = id.NewRandom() + } + + s.mu.Lock() + defer s.mu.Unlock() + + if _, exists := s.schedules[scheduleID]; exists { + return "", fmt.Errorf("schedule ID %q already exists", scheduleID) + } + + capturedID := scheduleID + timer := timeAfterFunc(time.Duration(delaySeconds)*time.Second, func() { + s.invokeCallback(context.Background(), capturedID) + // Clean up the entry after firing + s.mu.Lock() + delete(s.schedules, capturedID) + s.mu.Unlock() + }) + + s.schedules[scheduleID] = &scheduleEntry{ + pluginName: s.pluginName, + payload: payload, + isRecurring: false, + timer: timer, + } + + log.Debug(ctx, "Scheduled one-time task", "plugin", s.pluginName, "scheduleID", scheduleID, "delaySeconds", delaySeconds) + return scheduleID, nil +} + +func (s *schedulerServiceImpl) ScheduleRecurring(ctx context.Context, cronExpression string, payload string, scheduleID string) (string, error) { + if scheduleID == "" { + scheduleID = id.NewRandom() + } + + capturedID := scheduleID + callback := func() { + s.invokeCallback(context.Background(), capturedID) + } + + s.mu.Lock() + defer s.mu.Unlock() + + if _, exists := s.schedules[scheduleID]; exists { + return "", fmt.Errorf("schedule ID %q already exists", scheduleID) + } + + entryID, err := s.scheduler.Add(cronExpression, callback) + if err != nil { + return "", fmt.Errorf("failed to schedule task: %w", err) + } + + s.schedules[scheduleID] = &scheduleEntry{ + pluginName: s.pluginName, + payload: payload, + isRecurring: true, + entryID: entryID, + } + + log.Debug(ctx, "Scheduled recurring task", "plugin", s.pluginName, "scheduleID", scheduleID, "cron", cronExpression) + return scheduleID, nil +} + +func (s *schedulerServiceImpl) CancelSchedule(ctx context.Context, scheduleID string) error { + s.mu.Lock() + entry, exists := s.schedules[scheduleID] + if !exists { + s.mu.Unlock() + return fmt.Errorf("schedule ID %q not found", scheduleID) + } + delete(s.schedules, scheduleID) + s.mu.Unlock() + + if entry.timer != nil { + entry.timer.Stop() + } else { + s.scheduler.Remove(entry.entryID) + } + log.Debug(ctx, "Cancelled schedule", "plugin", s.pluginName, "scheduleID", scheduleID) + return nil +} + +// Close cancels all schedules for this plugin. +// This is called when the plugin is unloaded. +func (s *schedulerServiceImpl) Close() error { + s.mu.Lock() + schedules := maps.Clone(s.schedules) + s.schedules = make(map[string]*scheduleEntry) + s.mu.Unlock() + + for scheduleID, entry := range schedules { + if entry.timer != nil { + entry.timer.Stop() + } else { + s.scheduler.Remove(entry.entryID) + } + log.Debug("Cancelled schedule on plugin unload", "plugin", s.pluginName, "scheduleID", scheduleID) + } + return nil +} + +// invokeCallback calls the plugin's nd_scheduler_callback function. +func (s *schedulerServiceImpl) invokeCallback(ctx context.Context, scheduleID string) { + log.Debug(ctx, "Scheduler callback invoked", "plugin", s.pluginName, "scheduleID", scheduleID) + + s.mu.Lock() + entry, exists := s.schedules[scheduleID] + if !exists { + s.mu.Unlock() + log.Warn(ctx, "Schedule entry not found during callback", "plugin", s.pluginName, "scheduleID", scheduleID) + return + } + payload := entry.payload + isRecurring := entry.isRecurring + s.mu.Unlock() + + // Get the plugin instance from the manager + s.manager.mu.RLock() + instance, ok := s.manager.plugins[s.pluginName] + s.manager.mu.RUnlock() + + if !ok { + log.Warn(ctx, "Plugin not loaded when scheduler callback fired", "plugin", s.pluginName, "scheduleID", scheduleID) + return + } + + // Prepare callback input + input := capabilities.SchedulerCallbackRequest{ + ScheduleID: scheduleID, + Payload: payload, + IsRecurring: isRecurring, + } + + start := time.Now() + err := callPluginFunctionNoOutput(ctx, instance, FuncSchedulerCallback, input) + if err != nil { + log.Error(ctx, "Scheduler callback failed", "plugin", s.pluginName, "scheduleID", scheduleID, "duration", time.Since(start), err) + return + } + + log.Debug(ctx, "Scheduler callback completed", "plugin", s.pluginName, "scheduleID", scheduleID, "duration", time.Since(start)) +} + +// Verify interface implementation +var _ host.SchedulerService = (*schedulerServiceImpl)(nil) diff --git a/plugins/host_scheduler_test.go b/plugins/host_scheduler_test.go new file mode 100644 index 000000000..ca53aed56 --- /dev/null +++ b/plugins/host_scheduler_test.go @@ -0,0 +1,462 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "net/http" + "os" + "path/filepath" + "sync" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/scheduler" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("SchedulerService", Ordered, func() { + var ( + manager *Manager + tmpDir string + mockSched *mockScheduler + mockTimers *mockTimerRegistry + testService *testableSchedulerService + origAfterFn func(time.Duration, func()) *time.Timer + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "scheduler-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-scheduler plugin + srcPath := filepath.Join(testdataDir, "test-scheduler"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-scheduler"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Create mock scheduler and timer registry + mockSched = newMockScheduler() + mockTimers = newMockTimerRegistry() + + // Replace timeAfterFunc with mock + origAfterFn = timeAfterFunc + timeAfterFunc = mockTimers.AfterFunc + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-scheduler", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + metrics: noopMetricsRecorder{}, + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + // Get scheduler service from plugin's closers and wrap it for testing + service := findSchedulerService(manager, "test-scheduler") + Expect(service).ToNot(BeNil()) + testService = &testableSchedulerService{schedulerServiceImpl: service} + testService.scheduler = mockSched + + DeferCleanup(func() { + timeAfterFunc = origAfterFn + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + BeforeEach(func() { + mockSched.Reset() + mockTimers.Reset() + testService.ClearSchedules() + }) + + Describe("Plugin Loading", func() { + It("should detect scheduler capability", func() { + names := manager.PluginNames(string(CapabilityScheduler)) + Expect(names).To(ContainElement("test-scheduler")) + }) + + It("should register scheduler service for plugin", func() { + service := findSchedulerService(manager, "test-scheduler") + Expect(service).ToNot(BeNil()) + }) + }) + + Describe("ScheduleOneTime", func() { + It("should schedule a one-time task", func() { + scheduleID, err := testService.ScheduleOneTime(GinkgoT().Context(), 1, "test-payload", "test-id") + Expect(err).ToNot(HaveOccurred()) + Expect(scheduleID).To(Equal("test-id")) + + // Verify schedule was registered + Expect(testService.GetScheduleCount()).To(Equal(1)) + Expect(mockTimers.GetTimerCount()).To(Equal(1)) + }) + + It("should invoke plugin callback and auto-cleanup after firing", func() { + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 1, "data", "cleanup-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + + // Trigger fires the callback which calls the plugin's nd_scheduler_callback + // One-time schedules clean up after the callback completes + mockTimers.TriggerAll() + + // One-time schedules should self-cleanup + Expect(testService.GetScheduleCount()).To(Equal(0)) + }) + + It("should reject duplicate schedule ID", func() { + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 60, "data", "dup-id") + Expect(err).ToNot(HaveOccurred()) + + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "data2", "dup-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) + + It("should auto-generate schedule ID when empty", func() { + scheduleID, err := testService.ScheduleOneTime(GinkgoT().Context(), 1, "data", "") + Expect(err).ToNot(HaveOccurred()) + Expect(scheduleID).ToNot(BeEmpty()) + }) + }) + + Describe("ScheduleRecurring", func() { + It("should schedule recurring tasks", func() { + scheduleID, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "recurring-data", "recurring-id") + Expect(err).ToNot(HaveOccurred()) + Expect(scheduleID).To(Equal("recurring-id")) + + // Verify schedule was registered + Expect(testService.GetScheduleCount()).To(Equal(1)) + entry := testService.GetSchedule("recurring-id") + Expect(entry).ToNot(BeNil()) + Expect(entry.isRecurring).To(BeTrue()) + }) + + It("should invoke plugin callback multiple times without self-canceling", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "data", "persist-id") + Expect(err).ToNot(HaveOccurred()) + + // Trigger multiple times - recurring schedules should persist + mockSched.TriggerAll() + mockSched.TriggerAll() + + // Recurring schedules should persist + Expect(testService.GetScheduleCount()).To(Equal(1)) + }) + }) + + Describe("Plugin Calling Host Functions", func() { + It("should allow plugin to schedule a one-time task from callback", func() { + // Schedule with magic payload that triggers plugin to call SchedulerScheduleOneTime + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "schedule-followup", "trigger-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + + // Trigger - plugin callback will schedule a follow-up task + mockSched.TriggerAll() + + // Verify the plugin created a new schedule via host function + Expect(testService.GetScheduleCount()).To(Equal(2)) // original + followup + + // Verify the follow-up schedule was created with correct ID and properties + followup := testService.GetSchedule("followup-id") + Expect(followup).ToNot(BeNil()) + Expect(followup.payload).To(Equal("followup-created")) + Expect(followup.isRecurring).To(BeFalse()) + Expect(followup.timer).ToNot(BeNil()) // One-time tasks use timers + }) + + It("should allow plugin to schedule a recurring task from callback", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "schedule-recurring", "trigger-id") + Expect(err).ToNot(HaveOccurred()) + + mockSched.TriggerAll() + + // Verify the plugin created a recurring schedule + entry := testService.GetSchedule("recurring-from-plugin") + Expect(entry).ToNot(BeNil()) + Expect(entry.isRecurring).To(BeTrue()) + Expect(entry.payload).To(Equal("recurring-created")) + }) + }) + + Describe("CancelSchedule", func() { + It("should cancel a recurring task", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "data", "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + + err = testService.CancelSchedule(GinkgoT().Context(), "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(0)) + }) + + It("should cancel a one-time task", func() { + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 60, "data", "cancel-onetime-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + Expect(mockTimers.GetTimerCount()).To(Equal(1)) + + err = testService.CancelSchedule(GinkgoT().Context(), "cancel-onetime-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(0)) + }) + + It("should remove callback from scheduler for recurring tasks", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 1s", "data", "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(mockSched.GetCallbackCount()).To(Equal(1)) + + err = testService.CancelSchedule(GinkgoT().Context(), "cancel-id") + Expect(err).ToNot(HaveOccurred()) + Expect(mockSched.GetCallbackCount()).To(Equal(0)) + }) + + It("should return error for non-existent schedule", func() { + err := testService.CancelSchedule(GinkgoT().Context(), "non-existent") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + }) + + Describe("Scheduler Service Isolation", func() { + It("should share the same scheduler service across multiple plugin instances", func() { + // This test verifies that when we call plugin.instance() multiple times + // (creating multiple instances from the same compiled plugin), they all + // share the same scheduler service. This is the expected behavior since + // the scheduler service is registered once per plugin at compile time. + + // Get the plugin + manager.mu.RLock() + plugin, ok := manager.plugins["test-scheduler"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + + // Schedule a task using the service directly + _, err := testService.ScheduleOneTime(GinkgoT().Context(), 60, "shared-data", "shared-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(1)) + + // Create a plugin instance + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + // The scheduler service is shared, so the schedule ID should clash + // if another instance tries to use the same ID + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "other-data", "shared-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + + // But different IDs should work fine + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "instance2-data", "otherx-id") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(2)) + }) + }) + + Describe("Plugin Unload", func() { + It("should cancel all schedules when plugin is unloaded", func() { + _, err := testService.ScheduleRecurring(GinkgoT().Context(), "@every 10s", "data1", "unload-1") + Expect(err).ToNot(HaveOccurred()) + _, err = testService.ScheduleOneTime(GinkgoT().Context(), 60, "data2", "unload-2") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.GetScheduleCount()).To(Equal(2)) + Expect(mockSched.GetCallbackCount()).To(Equal(1)) // Only recurring task uses scheduler + Expect(mockTimers.GetTimerCount()).To(Equal(1)) // Only one-time task uses timer + + err = manager.unloadPlugin("test-scheduler") + Expect(err).ToNot(HaveOccurred()) + + Expect(findSchedulerService(manager, "test-scheduler")).To(BeNil()) + Expect(mockSched.GetCallbackCount()).To(Equal(0)) // Recurring task removed + }) + }) +}) + +// testableSchedulerService wraps schedulerServiceImpl with test helpers. +type testableSchedulerService struct { + *schedulerServiceImpl +} + +func (t *testableSchedulerService) GetScheduleCount() int { + t.mu.Lock() + defer t.mu.Unlock() + return len(t.schedules) +} + +func (t *testableSchedulerService) GetSchedule(id string) *scheduleEntry { + t.mu.Lock() + defer t.mu.Unlock() + return t.schedules[id] +} + +func (t *testableSchedulerService) ClearSchedules() { + t.mu.Lock() + defer t.mu.Unlock() + t.schedules = make(map[string]*scheduleEntry) +} + +// mockScheduler implements scheduler.Scheduler for testing without timing dependencies. +type mockScheduler struct { + mu sync.Mutex + callbacks map[int]func() + nextID int +} + +func newMockScheduler() *mockScheduler { + return &mockScheduler{ + callbacks: make(map[int]func()), + nextID: 1, + } +} + +func (s *mockScheduler) Run(_ context.Context) {} + +func (s *mockScheduler) Add(_ string, cmd func()) (int, error) { + s.mu.Lock() + defer s.mu.Unlock() + id := s.nextID + s.nextID++ + s.callbacks[id] = cmd + return id, nil +} + +func (s *mockScheduler) Remove(id int) { + s.mu.Lock() + defer s.mu.Unlock() + delete(s.callbacks, id) +} + +func (s *mockScheduler) TriggerAll() { + s.mu.Lock() + callbacks := make([]func(), 0, len(s.callbacks)) + for _, cb := range s.callbacks { + callbacks = append(callbacks, cb) + } + s.mu.Unlock() + for _, cb := range callbacks { + cb() + } +} + +func (s *mockScheduler) GetCallbackCount() int { + s.mu.Lock() + defer s.mu.Unlock() + return len(s.callbacks) +} + +func (s *mockScheduler) Reset() { + s.mu.Lock() + defer s.mu.Unlock() + s.callbacks = make(map[int]func()) + s.nextID = 1 +} + +var _ scheduler.Scheduler = (*mockScheduler)(nil) + +// mockTimerRegistry tracks mock timers created during tests. +type mockTimerRegistry struct { + mu sync.Mutex + callbacks []func() + timers []*time.Timer +} + +func newMockTimerRegistry() *mockTimerRegistry { + return &mockTimerRegistry{ + callbacks: make([]func(), 0), + timers: make([]*time.Timer, 0), + } +} + +// AfterFunc creates a timer that we control for testing. +func (r *mockTimerRegistry) AfterFunc(_ time.Duration, f func()) *time.Timer { + r.mu.Lock() + defer r.mu.Unlock() + + // Store callback for TriggerAll + r.callbacks = append(r.callbacks, f) + + // Create a real timer that won't fire (very long duration, immediately stopped) + t := time.NewTimer(time.Hour * 24 * 365) + t.Stop() + r.timers = append(r.timers, t) + + return t +} + +// TriggerAll fires all pending timer callbacks. +func (r *mockTimerRegistry) TriggerAll() { + r.mu.Lock() + callbacks := make([]func(), len(r.callbacks)) + copy(callbacks, r.callbacks) + r.mu.Unlock() + + for _, cb := range callbacks { + cb() + } +} + +func (r *mockTimerRegistry) GetTimerCount() int { + r.mu.Lock() + defer r.mu.Unlock() + return len(r.callbacks) +} + +func (r *mockTimerRegistry) Reset() { + r.mu.Lock() + defer r.mu.Unlock() + r.callbacks = make([]func(), 0) + r.timers = make([]*time.Timer, 0) +} + +// findSchedulerService finds the scheduler service from a plugin's closers. +func findSchedulerService(m *Manager, pluginName string) *schedulerServiceImpl { + m.mu.RLock() + instance, ok := m.plugins[pluginName] + m.mu.RUnlock() + if !ok { + return nil + } + for _, closer := range instance.closers { + if svc, ok := closer.(*schedulerServiceImpl); ok { + return svc + } + } + return nil +} diff --git a/plugins/host_subsonicapi.go b/plugins/host_subsonicapi.go new file mode 100644 index 000000000..01a33c039 --- /dev/null +++ b/plugins/host_subsonicapi.go @@ -0,0 +1,163 @@ +package plugins + +import ( + "context" + "errors" + "fmt" + "net/http" + "net/http/httptest" + "net/url" + "path" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/plugins/host" +) + +// subsonicAPIVersion is the Subsonic API version used for plugin calls. +// This is defined locally to avoid import cycle with server/subsonic. +const subsonicAPIVersion = "1.16.1" + +// subsonicAPIServiceImpl implements host.SubsonicAPIService. +// It provides plugins with access to Navidrome's Subsonic API. +// +// Authentication: The plugin must provide a valid 'u' (username) parameter in the URL. +// URL Format: Only the path and query parameters are used - host/protocol are ignored. +// Automatic Parameters: The service adds 'c' (client), 'v' (version), and optionally 'f' (format). +type subsonicAPIServiceImpl struct { + pluginID string + router SubsonicRouter + ds model.DataStore + allowedUserIDs []string // User IDs this plugin can access (from DB configuration) + allUsers bool // If true, plugin can access all users + userIDMap map[string]struct{} +} + +// newSubsonicAPIService creates a new SubsonicAPIService for a plugin. +func newSubsonicAPIService(pluginID string, router SubsonicRouter, ds model.DataStore, allowedUserIDs []string, allUsers bool) host.SubsonicAPIService { + userIDMap := make(map[string]struct{}) + for _, id := range allowedUserIDs { + userIDMap[id] = struct{}{} + } + return &subsonicAPIServiceImpl{ + pluginID: pluginID, + router: router, + ds: ds, + allowedUserIDs: allowedUserIDs, + allUsers: allUsers, + userIDMap: userIDMap, + } +} + +// executeRequest handles URL parsing, validation, permission checks, HTTP request creation, +// and router invocation. Shared between Call and CallRaw. +// If setJSON is true, the 'f=json' query parameter is added. +func (s *subsonicAPIServiceImpl) executeRequest(ctx context.Context, uri string, setJSON bool) (*httptest.ResponseRecorder, error) { + if s.router == nil { + return nil, fmt.Errorf("SubsonicAPI router not available") + } + + // Parse the input URL + parsedURL, err := url.Parse(uri) + if err != nil { + return nil, fmt.Errorf("invalid URL format: %w", err) + } + + // Extract query parameters + query := parsedURL.Query() + + // Validate that 'u' (username) parameter is present + username := query.Get("u") + if username == "" { + return nil, fmt.Errorf("missing required parameter 'u' (username)") + } + + if err := s.checkPermissions(ctx, username); err != nil { + log.Warn(ctx, "SubsonicAPI call blocked by permissions", "plugin", s.pluginID, "user", username, err) + return nil, err + } + + // Add required Subsonic API parameters + query.Set("c", s.pluginID) // Client name (plugin ID) + query.Set("v", subsonicAPIVersion) // API version + if setJSON { + query.Set("f", "json") // Response format + } + + // Extract the endpoint from the path + endpoint := path.Base(parsedURL.Path) + + // Build the final URL with processed path and modified query parameters + finalURL := &url.URL{ + Path: "/" + endpoint, + RawQuery: query.Encode(), + } + + // Create HTTP request with a fresh context to avoid Chi RouteContext pollution. + // Using http.NewRequest (instead of http.NewRequestWithContext) ensures the internal + // SubsonicAPI call doesn't inherit routing information from the parent handler, + // which would cause Chi to invoke the wrong handler. Authentication context is + // explicitly added in the next step via request.WithInternalAuth. + httpReq, err := http.NewRequest("GET", finalURL.String(), nil) + if err != nil { + return nil, fmt.Errorf("failed to create HTTP request: %w", err) + } + + // Set internal authentication context using the username from the 'u' parameter + authCtx := request.WithInternalAuth(httpReq.Context(), username) + httpReq = httpReq.WithContext(authCtx) + + // Use ResponseRecorder to capture the response + recorder := httptest.NewRecorder() + + // Call the subsonic router + s.router.ServeHTTP(recorder, httpReq) + + return recorder, nil +} + +func (s *subsonicAPIServiceImpl) Call(ctx context.Context, uri string) (string, error) { + recorder, err := s.executeRequest(ctx, uri, true) + if err != nil { + return "", err + } + return recorder.Body.String(), nil +} + +func (s *subsonicAPIServiceImpl) CallRaw(ctx context.Context, uri string) (string, []byte, error) { + recorder, err := s.executeRequest(ctx, uri, false) + if err != nil { + return "", nil, err + } + contentType := recorder.Header().Get("Content-Type") + return contentType, recorder.Body.Bytes(), nil +} + +func (s *subsonicAPIServiceImpl) checkPermissions(ctx context.Context, username string) error { + // If allUsers is true, allow any user + if s.allUsers { + return nil + } + + // Must have at least one allowed user ID configured + if len(s.allowedUserIDs) == 0 { + return fmt.Errorf("no users configured for plugin %s", s.pluginID) + } + + // Look up the user by username to get their ID + usr, err := s.ds.User(ctx).FindByUsername(username) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return fmt.Errorf("username %s not found", username) + } + return err + } + + // Check if the user's ID is in the allowed list + if _, ok := s.userIDMap[usr.ID]; !ok { + return fmt.Errorf("user %s is not authorized for this plugin", username) + } + + return nil +} diff --git a/plugins/host_subsonicapi_test.go b/plugins/host_subsonicapi_test.go new file mode 100644 index 000000000..6f7ff4dd3 --- /dev/null +++ b/plugins/host_subsonicapi_test.go @@ -0,0 +1,480 @@ +//go:build !windows + +package plugins + +import ( + "crypto/sha256" + "encoding/hex" + "encoding/json" + "net/http" + "os" + "path" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("SubsonicAPI Host Function", Ordered, func() { + var ( + manager *Manager + tmpDir string + router *fakeSubsonicRouter + userRepo *tests.MockedUserRepo + dataStore *tests.MockDataStore + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "subsonicapi-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy test plugin to temp dir + srcPath := filepath.Join(testdataDir, "test-subsonicapi-plugin"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-subsonicapi-plugin"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Setup mock router and data store + router = &fakeSubsonicRouter{} + userRepo = tests.CreateMockUserRepo() + dataStore = &tests.MockDataStore{MockedUser: userRepo} + + // Add test users + _ = userRepo.Put(&model.User{ + ID: "user1", + UserName: "testuser", + IsAdmin: false, + }) + _ = userRepo.Put(&model.User{ + ID: "admin1", + UserName: "adminuser", + IsAdmin: true, + }) + + // Create and configure manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + } + manager.SetSubsonicRouter(router) + + // Pre-enable the plugin in the mock repo so it loads on startup + // Compute SHA256 of the plugin file to match what syncPlugins will compute + pluginPath := filepath.Join(tmpDir, "test-subsonicapi-plugin"+PackageExtension) + wasmData, err := os.ReadFile(pluginPath) + Expect(err).ToNot(HaveOccurred()) + hash := sha256.Sum256(wasmData) + hashHex := hex.EncodeToString(hash[:]) + + mockPluginRepo := dataStore.Plugin(GinkgoT().Context()).(*tests.MockPluginRepo) + mockPluginRepo.Permitted = true + enabledPlugin := model.Plugin{ + ID: "test-subsonicapi-plugin", + Path: pluginPath, + SHA256: hashHex, + Enabled: true, + AllUsers: true, // Allow all users for test plugin + } + mockPluginRepo.SetData(model.Plugins{enabledPlugin}) + + // Start the manager + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + Describe("Plugin Loading", func() { + It("loads the plugin with SubsonicAPI permission", func() { + manager.mu.RLock() + plugin := manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() + + Expect(plugin).ToNot(BeNil()) + }) + + It("has the correct manifest", func() { + manager.mu.RLock() + plugin := manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() + + Expect(plugin).ToNot(BeNil()) + Expect(plugin.manifest.Name).To(Equal("Test SubsonicAPI Plugin")) + Expect(plugin.manifest.Permissions.Subsonicapi).ToNot(BeNil()) + }) + }) + + Describe("SubsonicAPI Call", func() { + var plugin *plugin + + BeforeEach(func() { + manager.mu.RLock() + plugin = manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() + Expect(plugin).ToNot(BeNil()) + }) + + It("successfully calls the ping endpoint", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + exit, output, err := instance.Call("call_subsonic_api", []byte("/ping?u=testuser")) + Expect(err).ToNot(HaveOccurred()) + Expect(exit).To(Equal(uint32(0))) + + // Verify the response contains the expected structure + var response map[string]any + err = json.Unmarshal(output, &response) + Expect(err).ToNot(HaveOccurred()) + + subsonicResponse, ok := response["subsonic-response"].(map[string]any) + Expect(ok).To(BeTrue()) + Expect(subsonicResponse["status"]).To(Equal("ok")) + }) + + It("adds required parameters (c, f, v) to the request", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + _, _, err = instance.Call("call_subsonic_api", []byte("/getAlbumList?u=testuser&type=newest")) + Expect(err).ToNot(HaveOccurred()) + + // Verify the parameters were added + Expect(router.lastRequest).ToNot(BeNil()) + query := router.lastRequest.URL.Query() + Expect(query.Get("c")).To(Equal("test-subsonicapi-plugin")) + Expect(query.Get("f")).To(Equal("json")) + Expect(query.Get("v")).To(Equal("1.16.1")) + Expect(query.Get("type")).To(Equal("newest")) + }) + + It("returns error when username is missing", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + exit, _, err := instance.Call("call_subsonic_api", []byte("/ping")) + Expect(err).To(HaveOccurred()) + Expect(exit).To(Equal(uint32(1))) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) + }) + }) + + Describe("SubsonicAPI CallRaw", func() { + var plugin *plugin + + BeforeEach(func() { + manager.mu.RLock() + plugin = manager.plugins["test-subsonicapi-plugin"] + manager.mu.RUnlock() + Expect(plugin).ToNot(BeNil()) + }) + + It("successfully calls getCoverArt and returns binary data", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + exit, output, err := instance.Call("call_subsonic_api_raw", []byte("/getCoverArt?u=testuser&id=al-1")) + Expect(err).ToNot(HaveOccurred()) + Expect(exit).To(Equal(uint32(0))) + + // Parse the metadata response from the test plugin + var result map[string]any + err = json.Unmarshal(output, &result) + Expect(err).ToNot(HaveOccurred()) + Expect(result["contentType"]).To(Equal("image/png")) + Expect(result["size"]).To(BeNumerically("==", len(fakePNGHeader))) + Expect(result["firstByte"]).To(BeNumerically("==", 0x89)) // PNG magic byte + }) + + It("does NOT set f=json parameter for raw calls", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + _, _, err = instance.Call("call_subsonic_api_raw", []byte("/getCoverArt?u=testuser&id=al-1")) + Expect(err).ToNot(HaveOccurred()) + + Expect(router.lastRequest).ToNot(BeNil()) + query := router.lastRequest.URL.Query() + Expect(query.Get("f")).To(BeEmpty()) + Expect(query.Get("c")).To(Equal("test-subsonicapi-plugin")) + Expect(query.Get("v")).To(Equal("1.16.1")) + }) + + It("returns error when username is missing", func() { + instance, err := plugin.instance(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + defer instance.Close(GinkgoT().Context()) + + exit, _, err := instance.Call("call_subsonic_api_raw", []byte("/getCoverArt")) + Expect(err).To(HaveOccurred()) + Expect(exit).To(Equal(uint32(1))) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) + }) + }) +}) + +var _ = Describe("SubsonicAPIService", func() { + var ( + router *fakeSubsonicRouter + userRepo *tests.MockedUserRepo + dataStore *tests.MockDataStore + ) + + BeforeEach(func() { + router = &fakeSubsonicRouter{} + userRepo = tests.CreateMockUserRepo() + dataStore = &tests.MockDataStore{MockedUser: userRepo} + + _ = userRepo.Put(&model.User{ + ID: "user1", + UserName: "testuser", + IsAdmin: false, + }) + _ = userRepo.Put(&model.User{ + ID: "admin1", + UserName: "adminuser", + IsAdmin: true, + }) + _ = userRepo.Put(&model.User{ + ID: "user2", + UserName: "alloweduser", + IsAdmin: false, + }) + }) + + Describe("Permission Enforcement", func() { + Context("with specific user IDs allowed", func() { + It("blocks users not in the allowed list", func() { + // allowedUserIDs contains "user2", but testuser is "user1" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user2"}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not authorized")) + }) + + It("allows users in the allowed list", func() { + // allowedUserIDs contains "user2" which is "alloweduser" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user2"}, false) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=alloweduser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + + It("blocks admin users when not in allowed list", func() { + // allowedUserIDs only contains "user1" (testuser), not "admin1" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user1"}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=adminuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not authorized")) + }) + + It("allows admin users when in allowed list", func() { + // allowedUserIDs contains "admin1" + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"admin1"}, false) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=adminuser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + }) + + Context("with allUsers=true", func() { + It("allows all users regardless of allowed list", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + + It("allows admin users when allUsers is true", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + response, err := service.Call(ctx, "/ping?u=adminuser") + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(ContainSubstring("ok")) + }) + }) + + Context("with no users configured", func() { + It("returns error when no users are configured", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no users configured")) + }) + + It("returns error for empty user list", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("no users configured")) + }) + }) + }) + + Describe("URL Handling", func() { + It("returns error for missing username parameter", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) + }) + + It("returns error for invalid URL", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "://invalid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid URL")) + }) + + It("extracts endpoint from path correctly", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user1"}, false) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/rest/ping.view?u=testuser") + Expect(err).ToNot(HaveOccurred()) + + // The endpoint should be extracted as "ping.view" + Expect(router.lastRequest.URL.Path).To(Equal("/ping.view")) + }) + }) + + Describe("CallRaw", func() { + It("returns binary data and content-type", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + contentType, data, err := service.CallRaw(ctx, "/getCoverArt?u=testuser&id=al-1") + Expect(err).ToNot(HaveOccurred()) + Expect(contentType).To(Equal("image/png")) + Expect(data).To(Equal(fakePNGHeader)) + }) + + It("does not set f=json parameter", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt?u=testuser&id=al-1") + Expect(err).ToNot(HaveOccurred()) + + Expect(router.lastRequest).ToNot(BeNil()) + query := router.lastRequest.URL.Query() + Expect(query.Get("f")).To(BeEmpty()) + }) + + It("enforces permission checks", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, []string{"user2"}, false) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt?u=testuser&id=al-1") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not authorized")) + }) + + It("returns error when username is missing", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing required parameter")) + }) + + It("returns error when router is nil", func() { + service := newSubsonicAPIService("test-plugin", nil, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "/getCoverArt?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("router not available")) + }) + + It("returns error for invalid URL", func() { + service := newSubsonicAPIService("test-plugin", router, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, _, err := service.CallRaw(ctx, "://invalid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid URL")) + }) + }) + + Describe("Router Availability", func() { + It("returns error when router is nil", func() { + service := newSubsonicAPIService("test-plugin", nil, dataStore, nil, true) + + ctx := GinkgoT().Context() + _, err := service.Call(ctx, "/ping?u=testuser") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("router not available")) + }) + }) +}) + +// fakePNGHeader is a minimal PNG file header used in tests. +var fakePNGHeader = []byte{0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A} + +// fakeSubsonicRouter is a mock Subsonic router that returns predictable responses. +type fakeSubsonicRouter struct { + lastRequest *http.Request +} + +func (r *fakeSubsonicRouter) ServeHTTP(w http.ResponseWriter, req *http.Request) { + r.lastRequest = req + + endpoint := path.Base(req.URL.Path) + switch endpoint { + case "getCoverArt": + w.Header().Set("Content-Type", "image/png") + _, _ = w.Write(fakePNGHeader) + default: + // Return a successful ping response + response := map[string]any{ + "subsonic-response": map[string]any{ + "status": "ok", + "version": "1.16.1", + }, + } + w.Header().Set("Content-Type", "application/json") + _ = json.NewEncoder(w).Encode(response) + } +} diff --git a/plugins/host_taskqueue.go b/plugins/host_taskqueue.go new file mode 100644 index 000000000..a5db3344f --- /dev/null +++ b/plugins/host_taskqueue.go @@ -0,0 +1,594 @@ +package plugins + +import ( + "context" + "database/sql" + "errors" + "fmt" + "io" + "maps" + "os" + "path/filepath" + "sync" + "time" + + _ "github.com/mattn/go-sqlite3" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/plugins/capabilities" + "github.com/navidrome/navidrome/plugins/host" + "golang.org/x/time/rate" +) + +const ( + defaultConcurrency int32 = 1 + defaultBackoffMs int64 = 1000 + defaultRetentionMs int64 = 3_600_000 // 1 hour + minRetentionMs int64 = 60_000 // 1 minute + maxRetentionMs int64 = 604_800_000 // 1 week + maxQueueNameLength = 128 + maxPayloadSize = 1 * 1024 * 1024 // 1MB + maxBackoffMs int64 = 3_600_000 // 1 hour + taskCleanupInterval = 5 * time.Minute + pollInterval = 5 * time.Second + shutdownTimeout = 10 * time.Second + + taskStatusPending = "pending" + taskStatusRunning = "running" + taskStatusCompleted = "completed" + taskStatusFailed = "failed" + taskStatusCancelled = "cancelled" +) + +// CapabilityTaskWorker indicates the plugin can receive task execution callbacks. +const CapabilityTaskWorker Capability = "TaskWorker" + +const FuncTaskWorkerCallback = "nd_task_execute" + +func init() { + registerCapability(CapabilityTaskWorker, FuncTaskWorkerCallback) +} + +type queueState struct { + config host.QueueConfig + signal chan struct{} + limiter *rate.Limiter +} + +// notifyWorkers sends a non-blocking signal to wake up queue workers. +func (qs *queueState) notifyWorkers() { + select { + case qs.signal <- struct{}{}: + default: + } +} + +// taskQueueServiceImpl implements host.TaskQueueService with SQLite persistence +// and background worker goroutines for task execution. +type taskQueueServiceImpl struct { + pluginName string + manager *Manager + maxConcurrency int32 + db *sql.DB + ctx context.Context + cancel context.CancelFunc + wg sync.WaitGroup + mu sync.Mutex + queues map[string]*queueState + + // For testing: override how callbacks are invoked + invokeCallbackFn func(ctx context.Context, queueName, taskID string, payload []byte, attempt int32) (string, error) +} + +// newTaskQueueService creates a new taskQueueServiceImpl with its own SQLite database. +func newTaskQueueService(pluginName string, manager *Manager, maxConcurrency int32) (*taskQueueServiceImpl, error) { + dataDir := filepath.Join(conf.Server.DataFolder.String(), "plugins", pluginName) + if err := os.MkdirAll(dataDir, 0700); err != nil { + return nil, fmt.Errorf("creating plugin data directory: %w", err) + } + + dbPath := filepath.Join(dataDir, "taskqueue.db") + db, err := sql.Open("sqlite3", dbPath+"?_busy_timeout=5000&_journal_mode=WAL&_foreign_keys=off") + if err != nil { + return nil, fmt.Errorf("opening taskqueue database: %w", err) + } + + db.SetMaxOpenConns(3) + db.SetMaxIdleConns(1) + + if err := createTaskQueueSchema(db); err != nil { + db.Close() + return nil, fmt.Errorf("creating taskqueue schema: %w", err) + } + + ctx, cancel := context.WithCancel(manager.ctx) //nolint:gosec // cancel is stored in struct and called in Close() + + s := &taskQueueServiceImpl{ + pluginName: pluginName, + manager: manager, + maxConcurrency: maxConcurrency, + db: db, + ctx: ctx, + cancel: cancel, + queues: make(map[string]*queueState), + } + s.invokeCallbackFn = s.defaultInvokeCallback + + s.wg.Go(s.cleanupLoop) + + log.Debug("Initialized plugin taskqueue", "plugin", pluginName, "path", dbPath, "maxConcurrency", maxConcurrency) + return s, nil +} + +// createTaskQueueSchema applies schema migrations to the taskqueue database. +// New migrations must be appended at the end of the slice. +func createTaskQueueSchema(db *sql.DB) error { + return migrateDB(db, []string{ + `CREATE TABLE IF NOT EXISTS queues ( + name TEXT PRIMARY KEY, + concurrency INTEGER NOT NULL DEFAULT 1, + max_retries INTEGER NOT NULL DEFAULT 0, + backoff_ms INTEGER NOT NULL DEFAULT 1000, + delay_ms INTEGER NOT NULL DEFAULT 0, + retention_ms INTEGER NOT NULL DEFAULT 3600000 + )`, + `CREATE TABLE IF NOT EXISTS tasks ( + id TEXT PRIMARY KEY, + queue_name TEXT NOT NULL REFERENCES queues(name), + payload BLOB NOT NULL, + status TEXT NOT NULL DEFAULT 'pending', + attempt INTEGER NOT NULL DEFAULT 0, + max_retries INTEGER NOT NULL, + next_run_at INTEGER NOT NULL, + created_at INTEGER NOT NULL, + updated_at INTEGER NOT NULL, + message TEXT NOT NULL DEFAULT '' + )`, + `CREATE INDEX IF NOT EXISTS idx_tasks_dequeue ON tasks(queue_name, status, next_run_at)`, + }) +} + +// applyConfigDefaults fills zero-value config fields with sensible defaults +// and clamps values to valid ranges, logging warnings for clamped values. +func (s *taskQueueServiceImpl) applyConfigDefaults(ctx context.Context, name string, config *host.QueueConfig) { + if config.Concurrency <= 0 { + config.Concurrency = defaultConcurrency + } + if config.BackoffMs <= 0 { + config.BackoffMs = defaultBackoffMs + } + if config.RetentionMs <= 0 { + config.RetentionMs = defaultRetentionMs + } + + if config.RetentionMs < minRetentionMs { + log.Warn(ctx, "TaskQueue retention clamped to minimum", "plugin", s.pluginName, "queue", name, + "requested", config.RetentionMs, "min", minRetentionMs) + config.RetentionMs = minRetentionMs + } + if config.RetentionMs > maxRetentionMs { + log.Warn(ctx, "TaskQueue retention clamped to maximum", "plugin", s.pluginName, "queue", name, + "requested", config.RetentionMs, "max", maxRetentionMs) + config.RetentionMs = maxRetentionMs + } +} + +// clampConcurrency reduces config.Concurrency if it exceeds the remaining budget. +// Returns an error when the concurrency budget is fully exhausted. +// Must be called with s.mu held. +func (s *taskQueueServiceImpl) clampConcurrency(ctx context.Context, name string, config *host.QueueConfig) error { + var allocated int32 + for _, qs := range s.queues { + allocated += qs.config.Concurrency + } + available := s.maxConcurrency - allocated + if available <= 0 { + log.Warn(ctx, "TaskQueue concurrency budget exhausted", "plugin", s.pluginName, "queue", name, + "allocated", allocated, "maxConcurrency", s.maxConcurrency) + return fmt.Errorf("concurrency budget exhausted (%d/%d allocated)", allocated, s.maxConcurrency) + } + if config.Concurrency > available { + log.Warn(ctx, "TaskQueue concurrency clamped", "plugin", s.pluginName, "queue", name, + "requested", config.Concurrency, "available", available, "maxConcurrency", s.maxConcurrency) + config.Concurrency = available + } + return nil +} + +func (s *taskQueueServiceImpl) CreateQueue(ctx context.Context, name string, config host.QueueConfig) error { + if len(name) == 0 { + return fmt.Errorf("queue name cannot be empty") + } + if len(name) > maxQueueNameLength { + return fmt.Errorf("queue name exceeds maximum length of %d bytes", maxQueueNameLength) + } + + s.applyConfigDefaults(ctx, name, &config) + + s.mu.Lock() + defer s.mu.Unlock() + + if err := s.clampConcurrency(ctx, name, &config); err != nil { + return err + } + + if _, exists := s.queues[name]; exists { + return fmt.Errorf("queue %q already exists", name) + } + + // Upsert into queues table (idempotent across restarts) + _, err := s.db.ExecContext(ctx, ` + INSERT INTO queues (name, concurrency, max_retries, backoff_ms, delay_ms, retention_ms) + VALUES (?, ?, ?, ?, ?, ?) + ON CONFLICT(name) DO UPDATE SET + concurrency = excluded.concurrency, + max_retries = excluded.max_retries, + backoff_ms = excluded.backoff_ms, + delay_ms = excluded.delay_ms, + retention_ms = excluded.retention_ms + `, name, config.Concurrency, config.MaxRetries, config.BackoffMs, config.DelayMs, config.RetentionMs) + if err != nil { + return fmt.Errorf("creating queue: %w", err) + } + + // Reset stale running tasks from previous crash + now := time.Now().UnixMilli() + _, err = s.db.ExecContext(ctx, ` + UPDATE tasks SET status = ?, updated_at = ? WHERE queue_name = ? AND status = ? + `, taskStatusPending, now, name, taskStatusRunning) + if err != nil { + return fmt.Errorf("resetting stale tasks: %w", err) + } + + qs := &queueState{ + config: config, + signal: make(chan struct{}, 1), + } + if config.DelayMs > 0 { + // Rate limit dispatches to enforce delay between tasks. + // Burst of 1 allows one immediate dispatch, then enforces the delay interval. + qs.limiter = rate.NewLimiter(rate.Every(time.Duration(config.DelayMs)*time.Millisecond), 1) + } + s.queues[name] = qs + + for i := int32(0); i < config.Concurrency; i++ { + s.wg.Go(func() { s.worker(name, qs) }) + } + + log.Debug(ctx, "Created task queue", "plugin", s.pluginName, "queue", name, + "concurrency", config.Concurrency, "maxRetries", config.MaxRetries, + "backoffMs", config.BackoffMs, "delayMs", config.DelayMs, "retentionMs", config.RetentionMs) + return nil +} + +func (s *taskQueueServiceImpl) Enqueue(ctx context.Context, queueName string, payload []byte) (string, error) { + s.mu.Lock() + qs, exists := s.queues[queueName] + s.mu.Unlock() + + if !exists { + return "", fmt.Errorf("queue %q does not exist", queueName) + } + if len(payload) > maxPayloadSize { + return "", fmt.Errorf("payload size %d exceeds maximum of %d bytes", len(payload), maxPayloadSize) + } + + taskID := id.NewRandom() + now := time.Now().UnixMilli() + + _, err := s.db.ExecContext(ctx, ` + INSERT INTO tasks (id, queue_name, payload, status, attempt, max_retries, next_run_at, created_at, updated_at) + VALUES (?, ?, ?, ?, 0, ?, ?, ?, ?) + `, taskID, queueName, payload, taskStatusPending, qs.config.MaxRetries, now, now, now) + if err != nil { + return "", fmt.Errorf("enqueuing task: %w", err) + } + + qs.notifyWorkers() + log.Trace(ctx, "Enqueued task", "plugin", s.pluginName, "queue", queueName, "taskID", taskID) + return taskID, nil +} + +// Get returns the current state of a task. +func (s *taskQueueServiceImpl) Get(ctx context.Context, taskID string) (*host.TaskInfo, error) { + var info host.TaskInfo + err := s.db.QueryRowContext(ctx, `SELECT status, message, attempt FROM tasks WHERE id = ?`, taskID). + Scan(&info.Status, &info.Message, &info.Attempt) + if errors.Is(err, sql.ErrNoRows) { + return nil, fmt.Errorf("task %q not found", taskID) + } + if err != nil { + return nil, fmt.Errorf("getting task info: %w", err) + } + return &info, nil +} + +// Cancel cancels a pending task. +func (s *taskQueueServiceImpl) Cancel(ctx context.Context, taskID string) error { + now := time.Now().UnixMilli() + result, err := s.db.ExecContext(ctx, ` + UPDATE tasks SET status = ?, updated_at = ? WHERE id = ? AND status = ? + `, taskStatusCancelled, now, taskID, taskStatusPending) + if err != nil { + return fmt.Errorf("cancelling task: %w", err) + } + + rowsAffected, err := result.RowsAffected() + if err != nil { + return fmt.Errorf("checking cancel result: %w", err) + } + + if rowsAffected == 0 { + // Check if task exists at all + var status string + err := s.db.QueryRowContext(ctx, `SELECT status FROM tasks WHERE id = ?`, taskID).Scan(&status) + if errors.Is(err, sql.ErrNoRows) { + return fmt.Errorf("task %q not found", taskID) + } + if err != nil { + return fmt.Errorf("checking task existence: %w", err) + } + return fmt.Errorf("task %q cannot be cancelled (status: %s)", taskID, status) + } + + log.Trace(ctx, "Cancelled task", "plugin", s.pluginName, "taskID", taskID) + return nil +} + +// ClearQueue removes all pending tasks from the named queue. +// Running tasks are not affected. Returns the number of tasks removed. +func (s *taskQueueServiceImpl) ClearQueue(ctx context.Context, queueName string) (int64, error) { + s.mu.Lock() + _, exists := s.queues[queueName] + s.mu.Unlock() + + if !exists { + return 0, fmt.Errorf("queue %q does not exist", queueName) + } + + now := time.Now().UnixMilli() + result, err := s.db.ExecContext(ctx, ` + UPDATE tasks SET status = ?, updated_at = ? WHERE queue_name = ? AND status = ? + `, taskStatusCancelled, now, queueName, taskStatusPending) + if err != nil { + return 0, fmt.Errorf("clearing queue: %w", err) + } + + cleared, err := result.RowsAffected() + if err != nil { + return 0, fmt.Errorf("checking clear result: %w", err) + } + + if cleared > 0 { + log.Debug(ctx, "Cleared pending tasks from queue", "plugin", s.pluginName, "queue", queueName, "cleared", cleared) + } + return cleared, nil +} + +// worker is the main loop for a single worker goroutine. +func (s *taskQueueServiceImpl) worker(queueName string, qs *queueState) { + // Process any existing pending tasks immediately on startup + s.drainQueue(queueName, qs) + + ticker := time.NewTicker(pollInterval) + defer ticker.Stop() + + for { + select { + case <-s.ctx.Done(): + return + case <-qs.signal: + s.drainQueue(queueName, qs) + case <-ticker.C: + s.drainQueue(queueName, qs) + } + } +} + +func (s *taskQueueServiceImpl) drainQueue(queueName string, qs *queueState) { + for s.ctx.Err() == nil && s.processTask(queueName, qs) { + } +} + +// processTask dequeues and processes a single task. Returns true if a task was processed. +func (s *taskQueueServiceImpl) processTask(queueName string, qs *queueState) bool { + now := time.Now().UnixMilli() + + // Atomically dequeue a task + var taskID string + var payload []byte + var attempt, maxRetries int32 + err := s.db.QueryRowContext(s.ctx, ` + UPDATE tasks SET status = ?, attempt = attempt + 1, updated_at = ? + WHERE id = ( + SELECT id FROM tasks + WHERE queue_name = ? AND status = ? AND next_run_at <= ? + ORDER BY next_run_at, created_at LIMIT 1 + ) + RETURNING id, payload, attempt, max_retries + `, taskStatusRunning, now, queueName, taskStatusPending, now).Scan(&taskID, &payload, &attempt, &maxRetries) + if errors.Is(err, sql.ErrNoRows) { + return false + } + if err != nil { + log.Error(s.ctx, "Failed to dequeue task", "plugin", s.pluginName, "queue", queueName, err) + return false + } + + // Enforce delay between task dispatches using a rate limiter. + // This is done after dequeue so that empty polls don't consume rate tokens. + if qs.limiter != nil { + if err := qs.limiter.Wait(s.ctx); err != nil { + // Context cancelled during wait — revert task to pending for recovery + s.revertTaskToPending(taskID) + return false + } + } + + // Invoke callback + log.Debug(s.ctx, "Executing task", "plugin", s.pluginName, "queue", queueName, "taskID", taskID, "attempt", attempt) + message, callbackErr := s.invokeCallbackFn(s.ctx, queueName, taskID, payload, attempt) + + // If context was cancelled (shutdown), revert task to pending for recovery + if s.ctx.Err() != nil { + s.revertTaskToPending(taskID) + return false + } + + if callbackErr == nil { + s.completeTask(queueName, taskID, message) + } else { + s.handleTaskFailure(queueName, taskID, attempt, maxRetries, qs, callbackErr, message) + } + return true +} + +func (s *taskQueueServiceImpl) completeTask(queueName, taskID, message string) { + now := time.Now().UnixMilli() + if _, err := s.db.ExecContext(s.ctx, `UPDATE tasks SET status = ?, message = ?, updated_at = ? WHERE id = ?`, taskStatusCompleted, message, now, taskID); err != nil { + log.Error(s.ctx, "Failed to mark task as completed", "plugin", s.pluginName, "taskID", taskID, err) + } + log.Debug(s.ctx, "Task completed", "plugin", s.pluginName, "queue", queueName, "taskID", taskID) +} + +func (s *taskQueueServiceImpl) handleTaskFailure(queueName, taskID string, attempt, maxRetries int32, qs *queueState, callbackErr error, message string) { + log.Warn(s.ctx, "Task execution failed", "plugin", s.pluginName, "queue", queueName, + "taskID", taskID, "attempt", attempt, "maxRetries", maxRetries, "err", callbackErr) + + // Use error message as fallback if no message was provided + if message == "" { + message = callbackErr.Error() + } + + now := time.Now().UnixMilli() + if attempt > maxRetries { + if _, err := s.db.ExecContext(s.ctx, `UPDATE tasks SET status = ?, message = ?, updated_at = ? WHERE id = ?`, taskStatusFailed, message, now, taskID); err != nil { + log.Error(s.ctx, "Failed to mark task as failed", "plugin", s.pluginName, "taskID", taskID, err) + } + log.Warn(s.ctx, "Task failed after all retries", "plugin", s.pluginName, "queue", queueName, "taskID", taskID) + return + } + + // Exponential backoff: backoffMs * 2^(attempt-1) + backoff := qs.config.BackoffMs << (attempt - 1) + if backoff <= 0 || backoff > maxBackoffMs { + backoff = maxBackoffMs + } + nextRunAt := now + backoff + if _, err := s.db.ExecContext(s.ctx, ` + UPDATE tasks SET status = ?, next_run_at = ?, updated_at = ? WHERE id = ? + `, taskStatusPending, nextRunAt, now, taskID); err != nil { + log.Error(s.ctx, "Failed to reschedule task for retry", "plugin", s.pluginName, "taskID", taskID, err) + } + + // Wake worker after backoff expires + time.AfterFunc(time.Duration(backoff)*time.Millisecond, func() { + qs.notifyWorkers() + }) +} + +// revertTaskToPending puts a running task back to pending status and decrements the attempt +// counter (used during shutdown to ensure the interrupted attempt doesn't count). +func (s *taskQueueServiceImpl) revertTaskToPending(taskID string) { + now := time.Now().UnixMilli() + _, err := s.db.Exec(`UPDATE tasks SET status = ?, attempt = MAX(attempt - 1, 0), updated_at = ? WHERE id = ? AND status = ?`, taskStatusPending, now, taskID, taskStatusRunning) + if err != nil { + log.Error("Failed to revert task to pending", "plugin", s.pluginName, "taskID", taskID, err) + } +} + +// defaultInvokeCallback calls the plugin's nd_task_execute function. +func (s *taskQueueServiceImpl) defaultInvokeCallback(ctx context.Context, queueName, taskID string, payload []byte, attempt int32) (string, error) { + s.manager.mu.RLock() + p, ok := s.manager.plugins[s.pluginName] + s.manager.mu.RUnlock() + + if !ok { + return "", fmt.Errorf("plugin %s not loaded", s.pluginName) + } + + input := capabilities.TaskExecuteRequest{ + QueueName: queueName, + TaskID: taskID, + Payload: payload, + Attempt: attempt, + } + + message, err := callPluginFunction[capabilities.TaskExecuteRequest, string](ctx, p, FuncTaskWorkerCallback, input) + if err != nil { + return "", err + } + return message, nil +} + +// cleanupLoop periodically removes terminal tasks past their retention period. +func (s *taskQueueServiceImpl) cleanupLoop() { + ticker := time.NewTicker(taskCleanupInterval) + defer ticker.Stop() + + for { + select { + case <-s.ctx.Done(): + return + case <-ticker.C: + s.runCleanup() + } + } +} + +// runCleanup deletes terminal tasks past their retention period. +func (s *taskQueueServiceImpl) runCleanup() { + s.mu.Lock() + queues := make(map[string]*queueState, len(s.queues)) + maps.Copy(queues, s.queues) + s.mu.Unlock() + + now := time.Now().UnixMilli() + for name, qs := range queues { + result, err := s.db.ExecContext(s.ctx, ` + DELETE FROM tasks WHERE queue_name = ? AND status IN (?, ?, ?) AND updated_at + ? < ? + `, name, taskStatusCompleted, taskStatusFailed, taskStatusCancelled, qs.config.RetentionMs, now) + if err != nil { + log.Error(s.ctx, "Failed to cleanup tasks", "plugin", s.pluginName, "queue", name, err) + continue + } + if deleted, _ := result.RowsAffected(); deleted > 0 { + log.Debug(s.ctx, "Cleaned up terminal tasks", "plugin", s.pluginName, "queue", name, "deleted", deleted) + } + } +} + +// Close shuts down the task queue service, stopping all workers and closing the database. +func (s *taskQueueServiceImpl) Close() error { + // Cancel context to signal all goroutines + s.cancel() + + // Wait for goroutines with timeout + done := make(chan struct{}) + go func() { + s.wg.Wait() + close(done) + }() + + select { + case <-done: + case <-time.After(shutdownTimeout): + log.Warn("TaskQueue shutdown timed out", "plugin", s.pluginName) + } + + // Mark running tasks as pending for recovery on next startup + if s.db != nil { + now := time.Now().UnixMilli() + if _, err := s.db.Exec(`UPDATE tasks SET status = ?, updated_at = ? WHERE status = ?`, taskStatusPending, now, taskStatusRunning); err != nil { + log.Error("Failed to reset running tasks on shutdown", "plugin", s.pluginName, err) + } + log.Debug("Closing plugin taskqueue", "plugin", s.pluginName) + return s.db.Close() + } + return nil +} + +// Compile-time verification +var _ host.TaskService = (*taskQueueServiceImpl)(nil) +var _ io.Closer = (*taskQueueServiceImpl)(nil) diff --git a/plugins/host_taskqueue_test.go b/plugins/host_taskqueue_test.go new file mode 100644 index 000000000..faff79c8e --- /dev/null +++ b/plugins/host_taskqueue_test.go @@ -0,0 +1,1221 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "fmt" + "net/http" + "os" + "path/filepath" + "sort" + "strings" + "sync" + "sync/atomic" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("TaskQueueService", func() { + var tmpDir string + var service *taskQueueServiceImpl + var ctx context.Context + var manager *Manager + + BeforeEach(func() { + ctx = GinkgoT().Context() + var err error + tmpDir, err = os.MkdirTemp("", "taskqueue-test-*") + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(configtest.SetupConfig()) + conf.Server.DataFolder = conf.NewDir(tmpDir) + + // Create a mock manager with context + managerCtx, cancel := context.WithCancel(ctx) + manager = &Manager{ + plugins: make(map[string]*plugin), + ctx: managerCtx, + } + DeferCleanup(cancel) + + service, err = newTaskQueueService("test_plugin", manager, 5) + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if service != nil { + service.Close() + } + os.RemoveAll(tmpDir) + }) + + Describe("CreateQueue", func() { + It("creates a queue successfully", func() { + err := service.CreateQueue(ctx, "my-queue", host.QueueConfig{ + Concurrency: 2, + MaxRetries: 3, + BackoffMs: 2000, + RetentionMs: 7200000, + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs, exists := service.queues["my-queue"] + service.mu.Unlock() + Expect(exists).To(BeTrue()) + Expect(qs.config.Concurrency).To(Equal(int32(2))) + Expect(qs.config.MaxRetries).To(Equal(int32(3))) + Expect(qs.config.BackoffMs).To(Equal(int64(2000))) + Expect(qs.config.RetentionMs).To(Equal(int64(7200000))) + }) + + It("returns error for duplicate queue name", func() { + err := service.CreateQueue(ctx, "dup-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + err = service.CreateQueue(ctx, "dup-queue", host.QueueConfig{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) + }) + + Describe("CreateQueue name validation", func() { + It("rejects empty queue name", func() { + err := service.CreateQueue(ctx, "", host.QueueConfig{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("queue name cannot be empty")) + }) + + It("rejects over-length queue name", func() { + longName := strings.Repeat("a", maxQueueNameLength+1) + err := service.CreateQueue(ctx, longName, host.QueueConfig{}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("exceeds maximum length")) + }) + + It("accepts queue name at maximum length", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + exactName := strings.Repeat("a", maxQueueNameLength) + err := service.CreateQueue(ctx, exactName, host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("CreateQueue defaults", func() { + It("applies defaults for zero-value config", func() { + err := service.CreateQueue(ctx, "defaults-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["defaults-queue"] + service.mu.Unlock() + Expect(qs.config.Concurrency).To(Equal(defaultConcurrency)) + Expect(qs.config.BackoffMs).To(Equal(defaultBackoffMs)) + Expect(qs.config.RetentionMs).To(Equal(defaultRetentionMs)) + }) + }) + + Describe("CreateQueue defaults with negative values", func() { + It("applies default RetentionMs for negative value", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "neg-retention", host.QueueConfig{ + RetentionMs: -500, + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["neg-retention"] + service.mu.Unlock() + Expect(qs.config.RetentionMs).To(Equal(defaultRetentionMs)) + }) + }) + + Describe("CreateQueue clamping", func() { + It("clamps concurrency exceeding maxConcurrency", func() { + // maxConcurrency is 5; request 10 + err := service.CreateQueue(ctx, "clamped-queue", host.QueueConfig{ + Concurrency: 10, + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["clamped-queue"] + service.mu.Unlock() + Expect(qs.config.Concurrency).To(Equal(int32(5))) + }) + + It("returns error when concurrency budget is exhausted", func() { + // maxConcurrency is 5; create a queue that uses all 5 + err := service.CreateQueue(ctx, "full-budget", host.QueueConfig{ + Concurrency: 5, + }) + Expect(err).ToNot(HaveOccurred()) + + // Next queue should fail — no budget remaining + err = service.CreateQueue(ctx, "over-budget", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("concurrency budget exhausted")) + }) + + It("clamps retention below minimum", func() { + err := service.CreateQueue(ctx, "low-retention", host.QueueConfig{ + RetentionMs: 100, // below minRetentionMs + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["low-retention"] + service.mu.Unlock() + Expect(qs.config.RetentionMs).To(Equal(minRetentionMs)) + }) + + It("clamps retention above maximum", func() { + err := service.CreateQueue(ctx, "high-retention", host.QueueConfig{ + RetentionMs: 999_999_999_999, // above maxRetentionMs + }) + Expect(err).ToNot(HaveOccurred()) + + service.mu.Lock() + qs := service.queues["high-retention"] + service.mu.Unlock() + Expect(qs.config.RetentionMs).To(Equal(maxRetentionMs)) + }) + }) + + Describe("Enqueue", func() { + BeforeEach(func() { + // Use a no-op callback to prevent actual execution attempts + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "enqueue-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + }) + + It("enqueues a task and returns task ID", func() { + taskID, err := service.Enqueue(ctx, "enqueue-test", []byte("payload")) + Expect(err).ToNot(HaveOccurred()) + Expect(taskID).ToNot(BeEmpty()) + }) + + It("returns error for non-existent queue", func() { + _, err := service.Enqueue(ctx, "no-such-queue", []byte("payload")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + + It("rejects payload exceeding maximum size", func() { + bigPayload := make([]byte, maxPayloadSize+1) + _, err := service.Enqueue(ctx, "enqueue-test", bigPayload) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("exceeds maximum")) + }) + + It("accepts payload at maximum size", func() { + exactPayload := make([]byte, maxPayloadSize) + taskID, err := service.Enqueue(ctx, "enqueue-test", exactPayload) + Expect(err).ToNot(HaveOccurred()) + Expect(taskID).ToNot(BeEmpty()) + }) + }) + + Describe("GetTaskStatus", func() { + BeforeEach(func() { + // Use a callback that blocks until context is cancelled so tasks stay pending + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + <-ctx.Done() + return "", ctx.Err() + } + }) + + It("returns pending for a new task", func() { + err := service.CreateQueue(ctx, "status-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "status-test", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + // The task may get picked up quickly; check initial status + // Since the callback blocks, it should be either pending or running + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info).ToNot(BeNil()) + Expect(info.Status).To(BeElementOf("pending", "running")) + }) + + It("returns error for unknown task ID", func() { + _, err := service.Get(ctx, "nonexistent-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + }) + + Describe("CancelTask", func() { + BeforeEach(func() { + // Block callback so tasks stay in pending/running + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + <-ctx.Done() + return "", ctx.Err() + } + }) + + It("cancels a pending task", func() { + // Block the callback so the first task occupies the worker + started := make(chan struct{}) + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + close(started) + <-ctx.Done() + return "", ctx.Err() + } + + err := service.CreateQueue(ctx, "cancel-test", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue a blocker task to occupy the single worker + _, err = service.Enqueue(ctx, "cancel-test", []byte("blocker")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for the blocker task to start running + Eventually(started).WithTimeout(5 * time.Second).Should(BeClosed()) + + // Enqueue a second task — it stays pending since the worker is busy + taskID, err := service.Enqueue(ctx, "cancel-test", []byte("cancel-me")) + Expect(err).ToNot(HaveOccurred()) + + err = service.Cancel(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Status).To(Equal("cancelled")) + }) + + It("returns error for unknown task ID", func() { + err := service.Cancel(ctx, "nonexistent-id") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + + It("returns error for non-pending task", func() { + // Create a queue where tasks complete immediately + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "completed-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "completed-test", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for task to complete + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + // Try to cancel completed task + err = service.Cancel(ctx, taskID) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("cannot be cancelled")) + }) + }) + + Describe("ClearQueue", func() { + It("clears all pending tasks from a queue", func() { + // Block the callback so the first task occupies the worker + started := make(chan struct{}) + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + close(started) + <-ctx.Done() + return "", ctx.Err() + } + + err := service.CreateQueue(ctx, "clear-test", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue a blocker task to occupy the single worker + _, err = service.Enqueue(ctx, "clear-test", []byte("blocker")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for the blocker task to start running + Eventually(started).WithTimeout(5 * time.Second).Should(BeClosed()) + + // Enqueue several more tasks — they stay pending since the worker is busy + var pendingIDs []string + for i := range 3 { + taskID, err := service.Enqueue(ctx, "clear-test", fmt.Appendf(nil, "task-%d", i)) + Expect(err).ToNot(HaveOccurred()) + pendingIDs = append(pendingIDs, taskID) + } + + // Clear the queue + cleared, err := service.ClearQueue(ctx, "clear-test") + Expect(err).ToNot(HaveOccurred()) + Expect(cleared).To(Equal(int64(3))) + + // Verify all pending tasks are now cancelled + for _, id := range pendingIDs { + info, err := service.Get(ctx, id) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Status).To(Equal("cancelled")) + } + }) + + It("returns zero when queue has no pending tasks", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + err := service.CreateQueue(ctx, "empty-clear", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + cleared, err := service.ClearQueue(ctx, "empty-clear") + Expect(err).ToNot(HaveOccurred()) + Expect(cleared).To(Equal(int64(0))) + }) + + It("returns error for non-existent queue", func() { + _, err := service.ClearQueue(ctx, "no-such-queue") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + + It("does not affect running tasks", func() { + // Block the callback so tasks stay running + started := make(chan struct{}, 1) + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + select { + case started <- struct{}{}: + default: + } + <-ctx.Done() + return "", ctx.Err() + } + + err := service.CreateQueue(ctx, "clear-running", host.QueueConfig{ + Concurrency: 1, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue a task that will start running + runningID, err := service.Enqueue(ctx, "clear-running", []byte("running-task")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for it to start running + Eventually(started).WithTimeout(5 * time.Second).Should(Receive()) + + // Clear the queue — should not affect the running task + cleared, err := service.ClearQueue(ctx, "clear-running") + Expect(err).ToNot(HaveOccurred()) + Expect(cleared).To(Equal(int64(0))) + + // Verify the running task is still running + info, err := service.Get(ctx, runningID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Status).To(Equal("running")) + }) + }) + + Describe("Worker execution", func() { + It("invokes callback and completes task", func() { + var callCount atomic.Int32 + var receivedQueueName, receivedTaskID string + var receivedPayload []byte + var receivedAttempt int32 + + service.invokeCallbackFn = func(_ context.Context, queueName, taskID string, payload []byte, attempt int32) (string, error) { + callCount.Add(1) + receivedQueueName = queueName + receivedTaskID = taskID + receivedPayload = payload + receivedAttempt = attempt + return "", nil + } + + err := service.CreateQueue(ctx, "worker-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "worker-test", []byte("test-payload")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + Expect(callCount.Load()).To(Equal(int32(1))) + Expect(receivedQueueName).To(Equal("worker-test")) + Expect(receivedTaskID).To(Equal(taskID)) + Expect(receivedPayload).To(Equal([]byte("test-payload"))) + Expect(receivedAttempt).To(Equal(int32(1))) + }) + }) + + Describe("Message storage", func() { + It("stores message on successful completion", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "task completed successfully", nil + } + + err := service.CreateQueue(ctx, "msg-success", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "msg-success", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Message).To(Equal("task completed successfully")) + Expect(info.Attempt).To(Equal(int32(1))) + }) + + It("stores error message on failure", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", fmt.Errorf("something went wrong") + } + + err := service.CreateQueue(ctx, "msg-fail", host.QueueConfig{ + MaxRetries: 0, + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "msg-fail", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("failed")) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Message).To(Equal("something went wrong")) + }) + + It("uses explicit message over error message on failure", func() { + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "partial progress made", fmt.Errorf("timeout exceeded") + } + + err := service.CreateQueue(ctx, "msg-fail-with-msg", host.QueueConfig{ + MaxRetries: 0, + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "msg-fail-with-msg", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("failed")) + + info, err := service.Get(ctx, taskID) + Expect(err).ToNot(HaveOccurred()) + Expect(info.Message).To(Equal("partial progress made")) + }) + }) + + Describe("Retry on failure", func() { + It("retries and eventually fails after exhausting retries", func() { + var callCount atomic.Int32 + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + callCount.Add(1) + return "", fmt.Errorf("task failed") + } + + err := service.CreateQueue(ctx, "retry-test", host.QueueConfig{ + MaxRetries: 2, + BackoffMs: 10, // Very short for testing + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "retry-test", []byte("retry-payload")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("failed")) + + // 1 initial attempt + 2 retries = 3 total calls + Expect(callCount.Load()).To(Equal(int32(3))) + }) + }) + + Describe("Retry then succeed", func() { + It("retries and succeeds on second attempt", func() { + var callCount atomic.Int32 + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, attempt int32) (string, error) { + callCount.Add(1) + if attempt == 1 { + return "", fmt.Errorf("temporary error") + } + return "success", nil + } + + err := service.CreateQueue(ctx, "retry-succeed", host.QueueConfig{ + MaxRetries: 1, + BackoffMs: 10, // Very short for testing + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "retry-succeed", []byte("data")) + Expect(err).ToNot(HaveOccurred()) + + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + Expect(callCount.Load()).To(Equal(int32(2))) + }) + }) + + Describe("Backoff overflow cap", func() { + It("caps backoff at maxRetentionMs to prevent overflow", func() { + var callCount atomic.Int32 + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + callCount.Add(1) + return "", fmt.Errorf("always fail") + } + + err := service.CreateQueue(ctx, "backoff-overflow", host.QueueConfig{ + MaxRetries: 3, + BackoffMs: 1_000_000_000, // Very large backoff to trigger overflow on exponentiation + }) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "backoff-overflow", []byte("overflow-test")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for first attempt to fail + Eventually(func() int32 { + return callCount.Load() + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(BeNumerically(">=", int32(1))) + + // Check next_run_at is positive and reasonable (capped at maxRetentionMs from now) + var nextRunAt int64 + err = service.db.QueryRow(`SELECT next_run_at FROM tasks WHERE id = ?`, taskID).Scan(&nextRunAt) + Expect(err).ToNot(HaveOccurred()) + + now := time.Now().UnixMilli() + Expect(nextRunAt).To(BeNumerically(">", int64(0)), "next_run_at should be positive") + Expect(nextRunAt).To(BeNumerically("<=", now+maxBackoffMs+1000), "next_run_at should be at most maxBackoffMs from now") + }) + }) + + Describe("Delay enforcement with concurrent workers", func() { + It("enforces delay between dispatches even with multiple workers", func() { + var mu sync.Mutex + var dispatchTimes []time.Time + + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + mu.Lock() + dispatchTimes = append(dispatchTimes, time.Now()) + mu.Unlock() + return "", nil + } + + err := service.CreateQueue(ctx, "delay-concurrent", host.QueueConfig{ + Concurrency: 3, + DelayMs: 200, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue 5 tasks + for i := range 5 { + _, err := service.Enqueue(ctx, "delay-concurrent", fmt.Appendf(nil, "task-%d", i)) + Expect(err).ToNot(HaveOccurred()) + } + + // Wait for all tasks to complete + Eventually(func() int { + mu.Lock() + defer mu.Unlock() + return len(dispatchTimes) + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal(5)) + + // Sort dispatch times and verify gaps + mu.Lock() + sort.Slice(dispatchTimes, func(i, j int) bool { + return dispatchTimes[i].Before(dispatchTimes[j]) + }) + times := make([]time.Time, len(dispatchTimes)) + copy(times, dispatchTimes) + mu.Unlock() + + // Consecutive dispatches should have at least ~160ms gap (80% of 200ms) + for i := 1; i < len(times); i++ { + gap := times[i].Sub(times[i-1]) + Expect(gap).To(BeNumerically(">=", 160*time.Millisecond), + fmt.Sprintf("gap between dispatch %d and %d was %v, expected >= 160ms", i-1, i, gap)) + } + }) + }) + + Describe("Shutdown recovery", func() { + It("resets stale running tasks on CreateQueue", func() { + // Create a first service and queue, enqueue a task + service.invokeCallbackFn = func(ctx context.Context, _, _ string, _ []byte, _ int32) (string, error) { + <-ctx.Done() + return "", ctx.Err() + } + err := service.CreateQueue(ctx, "recovery-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + taskID, err := service.Enqueue(ctx, "recovery-queue", []byte("stale-task")) + Expect(err).ToNot(HaveOccurred()) + + // Wait for the task to start running + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("running")) + + // Close the service (simulates crash - tasks left in running state) + service.Close() + + // Create a new service pointing to the same DB + managerCtx2, cancel2 := context.WithCancel(ctx) + DeferCleanup(cancel2) + manager2 := &Manager{ + plugins: make(map[string]*plugin), + ctx: managerCtx2, + } + + service, err = newTaskQueueService("test_plugin", manager2, 5) + Expect(err).ToNot(HaveOccurred()) + + // Override callback to succeed + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { + return "", nil + } + + // Re-create the queue - the upsert handles the existing row from the old service + err = service.CreateQueue(ctx, "recovery-queue", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + // The stale running task should now be reset to pending and eventually completed + Eventually(func() string { + info, err := service.Get(ctx, taskID) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(10 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + }) + }) + + Describe("Close", func() { + It("prevents subsequent operations after close", func() { + err := service.CreateQueue(ctx, "close-test", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + service.Close() + + // After close, operations should fail + _, err = service.Enqueue(ctx, "close-test", []byte("data")) + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("Plugin isolation", func() { + It("uses separate databases for different plugins", func() { + managerCtx2, cancel2 := context.WithCancel(ctx) + DeferCleanup(cancel2) + manager2 := &Manager{ + plugins: make(map[string]*plugin), + ctx: managerCtx2, + } + + service2, err := newTaskQueueService("other_plugin", manager2, 5) + Expect(err).ToNot(HaveOccurred()) + defer service2.Close() + + // Check that separate database files exist + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "test_plugin", "taskqueue.db")) + Expect(err).ToNot(HaveOccurred()) + _, err = os.Stat(filepath.Join(tmpDir, "plugins", "other_plugin", "taskqueue.db")) + Expect(err).ToNot(HaveOccurred()) + + // Both services should be able to create queues with the same name independently + service.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { return "", nil } + service2.invokeCallbackFn = func(_ context.Context, _, _ string, _ []byte, _ int32) (string, error) { return "", nil } + + err = service.CreateQueue(ctx, "shared-name", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + err = service2.CreateQueue(ctx, "shared-name", host.QueueConfig{}) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue to each and verify they work independently + taskID1, err := service.Enqueue(ctx, "shared-name", []byte("plugin1")) + Expect(err).ToNot(HaveOccurred()) + taskID2, err := service2.Enqueue(ctx, "shared-name", []byte("plugin2")) + Expect(err).ToNot(HaveOccurred()) + + Expect(taskID1).ToNot(Equal(taskID2)) + + // Both should complete + Eventually(func() string { + info, err := service.Get(ctx, taskID1) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + Eventually(func() string { + info, err := service2.Get(ctx, taskID2) + if err != nil || info == nil { + return "" + } + return info.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + }) + }) +}) + +var _ = Describe("TaskQueueService Integration", Ordered, func() { + var manager *Manager + var tmpDir string + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "taskqueue-integration-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-taskqueue plugin + srcPath := filepath.Join(testdataDir, "test-taskqueue"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-taskqueue"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + conf.Server.CacheFolder = conf.NewDir(filepath.Join(tmpDir, "cache")) + conf.Server.DataFolder = conf.NewDir(tmpDir) + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-taskqueue", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + metrics: noopMetricsRecorder{}, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + // Helper types for calling the test plugin + type testQueueConfig struct { + Concurrency int32 `json:"concurrency,omitempty"` + MaxRetries int32 `json:"maxRetries,omitempty"` + BackoffMs int64 `json:"backoffMs,omitempty"` + DelayMs int64 `json:"delayMs,omitempty"` + RetentionMs int64 `json:"retentionMs,omitempty"` + } + + type testTaskQueueInput struct { + Operation string `json:"operation"` + QueueName string `json:"queueName,omitempty"` + Config *testQueueConfig `json:"config,omitempty"` + Payload []byte `json:"payload,omitempty"` + TaskID string `json:"taskId,omitempty"` + } + + type testTaskQueueOutput struct { + TaskID string `json:"taskId,omitempty"` + Status string `json:"status,omitempty"` + Message string `json:"message,omitempty"` + Attempt int32 `json:"attempt,omitempty"` + Cleared int64 `json:"cleared,omitempty"` + Error *string `json:"error,omitempty"` + } + + callTestTaskQueue := func(ctx context.Context, input testTaskQueueInput) (*testTaskQueueOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-taskqueue"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_taskqueue", inputBytes) + if err != nil { + return nil, err + } + + var output testTaskQueueOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil + } + + Describe("Plugin Loading", func() { + It("should load plugin with taskqueue permission and TaskWorker capability", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-taskqueue"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Taskqueue).ToNot(BeNil()) + Expect(p.manifest.Permissions.Taskqueue.MaxConcurrency).To(Equal(10)) + Expect(p.capabilities).To(ContainElement(CapabilityTaskWorker)) + }) + }) + + Describe("Create Queue", func() { + It("should create a queue without error", func() { + ctx := GinkgoT().Context() + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-create", + }) + Expect(err).ToNot(HaveOccurred()) + }) + + It("should return error for duplicate queue name", func() { + ctx := GinkgoT().Context() + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-dup", + }) + Expect(err).ToNot(HaveOccurred()) + + _, err = callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-dup", + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) + }) + + Describe("Enqueue and Task Completion", func() { + It("should enqueue a task and complete successfully", func() { + ctx := GinkgoT().Context() + + // Create queue + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-complete", + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue task with payload "hello" + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-complete", + Payload: []byte("hello"), + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.TaskID).ToNot(BeEmpty()) + + taskID := output.TaskID + + // Poll until completed + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskID, + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(100 * time.Millisecond).Should(Equal("completed")) + }) + }) + + Describe("Enqueue with Failure, No Retries", func() { + It("should fail when payload is 'fail' and maxRetries is 0", func() { + ctx := GinkgoT().Context() + + // Create queue with no retries + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-fail-no-retry", + Config: &testQueueConfig{ + MaxRetries: 0, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue task that will fail + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-fail-no-retry", + Payload: []byte("fail"), + }) + Expect(err).ToNot(HaveOccurred()) + + taskID := output.TaskID + + // Poll until failed + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskID, + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(100 * time.Millisecond).Should(Equal("failed")) + }) + }) + + Describe("Enqueue with Retry Then Success", func() { + It("should retry and eventually succeed with 'fail-then-succeed' payload", func() { + ctx := GinkgoT().Context() + + // Create queue with retries and short backoff + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-retry-succeed", + Config: &testQueueConfig{ + MaxRetries: 2, + BackoffMs: 100, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue task that fails on attempt < 2, then succeeds + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-retry-succeed", + Payload: []byte("fail-then-succeed"), + }) + Expect(err).ToNot(HaveOccurred()) + + taskID := output.TaskID + + // Poll until completed + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskID, + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(100 * time.Millisecond).Should(Equal("completed")) + }) + }) + + Describe("Cancel Pending Task", func() { + It("should cancel a pending task", func() { + ctx := GinkgoT().Context() + + // Create queue with concurrency=1 and a large delay between dispatches. + // The first task completes immediately (burst token), the second is dequeued + // but blocks on the rate limiter. Tasks 3+ remain in 'pending' and can be cancelled. + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-cancel", + Config: &testQueueConfig{ + Concurrency: 1, + DelayMs: 60000, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue several tasks - the first will complete immediately, + // the second will be dequeued but block on the rate limiter (status=running), + // the rest will stay pending. + var taskIDs []string + for range 5 { + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-cancel", + Payload: []byte("hello"), + }) + Expect(err).ToNot(HaveOccurred()) + taskIDs = append(taskIDs, output.TaskID) + } + + // Wait for the first task to complete (it has no delay) + Eventually(func() string { + out, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: taskIDs[0], + }) + if err != nil { + return "error" + } + return out.Status + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Equal("completed")) + + // Give the worker a moment to dequeue the second task (which will + // block on the delay) so tasks 3+ stay in 'pending' + time.Sleep(100 * time.Millisecond) + + // Cancel the last task - it should still be pending + lastTaskID := taskIDs[len(taskIDs)-1] + _, err = callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "cancel_task", + TaskID: lastTaskID, + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify status is cancelled + statusOut, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "get_task_status", + TaskID: lastTaskID, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(statusOut.Status).To(Equal("cancelled")) + }) + }) + + Describe("Enqueue to Non-Existent Queue", func() { + It("should return error when enqueueing to a queue that does not exist", func() { + ctx := GinkgoT().Context() + + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "nonexistent-queue", + Payload: []byte("payload"), + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + }) + + Describe("Clear Queue", func() { + It("should clear pending tasks and return the count", func() { + ctx := GinkgoT().Context() + + // Create queue with large delay so tasks stay pending after the first completes + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "create_queue", + QueueName: "test-clear", + Config: &testQueueConfig{ + Concurrency: 1, + DelayMs: 60000, + }, + }) + Expect(err).ToNot(HaveOccurred()) + + // Enqueue several tasks + for i := range 4 { + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "enqueue", + QueueName: "test-clear", + Payload: fmt.Appendf(nil, "task-%d", i), + }) + Expect(err).ToNot(HaveOccurred()) + } + + // Wait for the first task to complete (burst token) + time.Sleep(200 * time.Millisecond) + + // Clear the queue — should cancel remaining pending tasks + output, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "clear_queue", + QueueName: "test-clear", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Cleared).To(BeNumerically(">=", int64(1))) + }) + + It("should return error for non-existent queue", func() { + ctx := GinkgoT().Context() + + _, err := callTestTaskQueue(ctx, testTaskQueueInput{ + Operation: "clear_queue", + QueueName: "nonexistent-clear", + }) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("does not exist")) + }) + }) +}) diff --git a/plugins/host_users.go b/plugins/host_users.go new file mode 100644 index 000000000..a56c8f866 --- /dev/null +++ b/plugins/host_users.go @@ -0,0 +1,64 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/utils/slice" +) + +type usersServiceImpl struct { + ds model.DataStore + allowedUsers []string // User IDs this plugin can access + allUsers bool // If true, plugin can access all users +} + +func newUsersService(ds model.DataStore, allowedUsers []string, allUsers bool) host.UsersService { + return &usersServiceImpl{ + ds: ds, + allowedUsers: allowedUsers, + allUsers: allUsers, + } +} + +func (s *usersServiceImpl) GetUsers(ctx context.Context) ([]host.User, error) { + users, err := s.ds.User(ctx).GetAll() + if err != nil { + return nil, err + } + + // Build allowed users map for efficient lookup + allowedMap := make(map[string]bool, len(s.allowedUsers)) + for _, id := range s.allowedUsers { + allowedMap[id] = true + } + + var result []host.User + for _, u := range users { + // If allUsers is true, include all users + // Otherwise, only include users in the allowed list + if s.allUsers || allowedMap[u.ID] { + result = append(result, host.User{ + UserName: u.UserName, + Name: u.Name, + IsAdmin: u.IsAdmin, + }) + } + } + + return result, nil +} + +func (s *usersServiceImpl) GetAdmins(ctx context.Context) ([]host.User, error) { + users, err := s.GetUsers(ctx) + if err != nil { + return nil, err + } + + return slice.Filter(users, func(u host.User) bool { + return u.IsAdmin + }), nil +} + +var _ host.UsersService = (*usersServiceImpl)(nil) diff --git a/plugins/host_users_test.go b/plugins/host_users_test.go new file mode 100644 index 000000000..42f6a3032 --- /dev/null +++ b/plugins/host_users_test.go @@ -0,0 +1,588 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "errors" + "net/http" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("UsersService", Ordered, func() { + var ( + ctx context.Context + ds model.DataStore + service host.UsersService + ) + + BeforeEach(func() { + ctx = GinkgoT().Context() + ds = &tests.MockDataStore{} + }) + + Describe("GetUsers", func() { + var mockUserRepo *tests.MockedUserRepo + + BeforeEach(func() { + mockUserRepo = ds.User(ctx).(*tests.MockedUserRepo) + // Add test users + _ = mockUserRepo.Put(&model.User{ + ID: "user1", + UserName: "alice", + Name: "Alice Admin", + IsAdmin: true, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user2", + UserName: "bob", + Name: "Bob User", + IsAdmin: false, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user3", + UserName: "charlie", + Name: "Charlie User", + IsAdmin: false, + }) + }) + + Context("with allUsers=true", func() { + BeforeEach(func() { + service = newUsersService(ds, nil, true) + }) + + It("should return all users", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(users).To(HaveLen(3)) + + // Verify that the correct fields are returned + userNames := make([]string, len(users)) + for i, u := range users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "bob", "charlie")) + }) + + It("should return correct user properties", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + + // Find alice + var alice *host.User + for i := range users { + if users[i].UserName == "alice" { + alice = &users[i] + break + } + } + + Expect(alice).ToNot(BeNil()) + Expect(alice.UserName).To(Equal("alice")) + Expect(alice.Name).To(Equal("Alice Admin")) + Expect(alice.IsAdmin).To(BeTrue()) + }) + }) + + Context("with specific allowed users", func() { + BeforeEach(func() { + // Only allow access to user1 and user3 + service = newUsersService(ds, []string{"user1", "user3"}, false) + }) + + It("should return only allowed users", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(users).To(HaveLen(2)) + + userNames := make([]string, len(users)) + for i, u := range users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "charlie")) + Expect(userNames).ToNot(ContainElement("bob")) + }) + }) + + Context("with empty allowed users and allUsers=false", func() { + BeforeEach(func() { + service = newUsersService(ds, []string{}, false) + }) + + It("should return no users", func() { + users, err := service.GetUsers(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(users).To(BeEmpty()) + }) + }) + + Context("when datastore returns error", func() { + BeforeEach(func() { + mockUserRepo.Error = model.ErrNotFound + service = newUsersService(ds, nil, true) + }) + + It("should propagate the error", func() { + _, err := service.GetUsers(ctx) + Expect(err).To(HaveOccurred()) + }) + }) + }) + + Describe("GetAdmins", func() { + var mockUserRepo *tests.MockedUserRepo + + BeforeEach(func() { + mockUserRepo = ds.User(ctx).(*tests.MockedUserRepo) + // Add test users - alice is admin, bob and charlie are not + _ = mockUserRepo.Put(&model.User{ + ID: "user1", + UserName: "alice", + Name: "Alice Admin", + IsAdmin: true, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user2", + UserName: "bob", + Name: "Bob User", + IsAdmin: false, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user3", + UserName: "charlie", + Name: "Charlie User", + IsAdmin: false, + }) + }) + + Context("with allUsers=true", func() { + BeforeEach(func() { + service = newUsersService(ds, nil, true) + }) + + It("should return only admin users", func() { + admins, err := service.GetAdmins(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(admins).To(HaveLen(1)) + Expect(admins[0].UserName).To(Equal("alice")) + Expect(admins[0].IsAdmin).To(BeTrue()) + }) + }) + + Context("with specific allowed users including admin", func() { + BeforeEach(func() { + // Allow access to user1 (admin) and user2 (non-admin) + service = newUsersService(ds, []string{"user1", "user2"}, false) + }) + + It("should return only admin users from allowed list", func() { + admins, err := service.GetAdmins(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(admins).To(HaveLen(1)) + Expect(admins[0].UserName).To(Equal("alice")) + }) + }) + + Context("with specific allowed users excluding admin", func() { + BeforeEach(func() { + // Only allow access to non-admin users + service = newUsersService(ds, []string{"user2", "user3"}, false) + }) + + It("should return empty when no admins in allowed list", func() { + admins, err := service.GetAdmins(ctx) + Expect(err).ToNot(HaveOccurred()) + Expect(admins).To(BeEmpty()) + }) + }) + + Context("when datastore returns error", func() { + BeforeEach(func() { + mockUserRepo.Error = model.ErrNotFound + service = newUsersService(ds, nil, true) + }) + + It("should propagate the error", func() { + _, err := service.GetAdmins(ctx) + Expect(err).To(HaveOccurred()) + }) + }) + }) +}) + +var _ = Describe("UsersService Integration", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + manager, cleanup = setupUsersIntegrationManager(true, "") + DeferCleanup(cleanup) + }) + + Describe("Plugin Loading", func() { + It("should load plugin with users permission", func() { + manager.mu.RLock() + p, ok := manager.plugins["test-users"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + Expect(p.manifest.Permissions).ToNot(BeNil()) + Expect(p.manifest.Permissions.Users).ToNot(BeNil()) + }) + }) + + Describe("Users Operations via Plugin", func() { + It("should get all users when allUsers is true", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(HaveLen(3)) + + // Verify user names + userNames := make([]string, len(output.Users)) + for i, u := range output.Users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "bob", "charlie")) + }) + + It("should return correct user properties", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + + // Find alice + var alice *testUser + for i := range output.Users { + if output.Users[i].UserName == "alice" { + alice = &output.Users[i] + break + } + } + + Expect(alice).ToNot(BeNil()) + Expect(alice.UserName).To(Equal("alice")) + Expect(alice.Name).To(Equal("Alice Admin")) + Expect(alice.IsAdmin).To(BeTrue()) + }) + + It("should return non-admin user correctly", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + + // Find bob + var bob *testUser + for i := range output.Users { + if output.Users[i].UserName == "bob" { + bob = &output.Users[i] + break + } + } + + Expect(bob).ToNot(BeNil()) + Expect(bob.UserName).To(Equal("bob")) + Expect(bob.Name).To(Equal("Bob User")) + Expect(bob.IsAdmin).To(BeFalse()) + }) + }) + + Describe("GetAdmins Operations via Plugin", func() { + It("should get only admin users when allUsers is true", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_admins"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(HaveLen(1)) + Expect(output.Users[0].UserName).To(Equal("alice")) + Expect(output.Users[0].IsAdmin).To(BeTrue()) + }) + }) +}) + +var _ = Describe("UsersService Integration with Specific Users", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + manager, cleanup = setupUsersIntegrationManager(false, `["user1", "user3"]`) + DeferCleanup(cleanup) + }) + + Describe("Users Operations with Specific Allowed Users", func() { + It("should only return allowed users", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_users"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(HaveLen(2)) + + // Verify only alice and charlie are returned, not bob + userNames := make([]string, len(output.Users)) + for i, u := range output.Users { + userNames[i] = u.UserName + } + Expect(userNames).To(ContainElements("alice", "charlie")) + Expect(userNames).ToNot(ContainElement("bob")) + }) + + It("should only return admin users from allowed list via GetAdmins", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_admins"}) + Expect(err).ToNot(HaveOccurred()) + // Only alice (user1) is admin, charlie (user3) is not + Expect(output.Users).To(HaveLen(1)) + Expect(output.Users[0].UserName).To(Equal("alice")) + Expect(output.Users[0].IsAdmin).To(BeTrue()) + }) + }) +}) + +var _ = Describe("UsersService Integration GetAdmins with No Admins", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + // Only allow user2 (bob) and user3 (charlie), both non-admins + manager, cleanup = setupUsersIntegrationManager(false, `["user2", "user3"]`) + DeferCleanup(cleanup) + }) + + Describe("GetAdmins with no admin users in allowed list", func() { + It("should return empty when no admins in allowed list", func() { + output, err := callTestUsersPlugin(GinkgoT().Context(), manager, testUsersInput{Operation: "get_admins"}) + Expect(err).ToNot(HaveOccurred()) + Expect(output.Users).To(BeEmpty()) + }) + }) +}) + +var _ = Describe("UsersService Enable Gate", Ordered, func() { + var manager *Manager + + BeforeAll(func() { + var cleanup func() + // Start with disabled plugin, no users configured + manager, cleanup = setupUsersIntegrationManagerWithEnabled(false, false, "") + DeferCleanup(cleanup) + }) + + Describe("Enable Gate Behavior", func() { + It("should block enabling when no users configured and allUsers is false", func() { + ctx := GinkgoT().Context() + err := manager.EnablePlugin(ctx, "test-users") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("users permission requires configuration")) + }) + + It("should allow enabling when allUsers is true", func() { + ctx := GinkgoT().Context() + + // Update the plugin to have allUsers=true + err := manager.UpdatePluginUsers(ctx, "test-users", "", true) + Expect(err).ToNot(HaveOccurred()) + + // Now enabling should succeed + err = manager.EnablePlugin(ctx, "test-users") + Expect(err).ToNot(HaveOccurred()) + + // Verify plugin is loaded + manager.mu.RLock() + _, ok := manager.plugins["test-users"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + }) + + It("should allow enabling when specific users are configured", func() { + ctx := GinkgoT().Context() + + // First disable the plugin + err := manager.DisablePlugin(ctx, "test-users") + Expect(err).ToNot(HaveOccurred()) + + // Update to have specific users (and allUsers=false) + err = manager.UpdatePluginUsers(ctx, "test-users", `["user1"]`, false) + Expect(err).ToNot(HaveOccurred()) + + // Now enabling should succeed + err = manager.EnablePlugin(ctx, "test-users") + Expect(err).ToNot(HaveOccurred()) + + // Verify plugin is loaded + manager.mu.RLock() + _, ok := manager.plugins["test-users"] + manager.mu.RUnlock() + Expect(ok).To(BeTrue()) + }) + }) +}) + +// testUsersSetup contains common setup data for users integration tests +type testUsersSetup struct { + tmpDir string + destPath string + hashHex string +} + +// setupTestUsersPlugin creates a temporary directory with the test-users plugin and returns setup info +func setupTestUsersPlugin() (*testUsersSetup, error) { + tmpDir, err := os.MkdirTemp("", "users-integration-test-*") + if err != nil { + return nil, err + } + + // Copy the test-users plugin + srcPath := filepath.Join(testdataDir, "test-users"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-users"+PackageExtension) + data, err := os.ReadFile(srcPath) + if err != nil { + _ = os.RemoveAll(tmpDir) + return nil, err + } + if err := os.WriteFile(destPath, data, 0600); err != nil { + _ = os.RemoveAll(tmpDir) + return nil, err + } + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + return &testUsersSetup{ + tmpDir: tmpDir, + destPath: destPath, + hashHex: hashHex, + }, nil +} + +// createTestUsers creates standard test users in the mock repo +func createTestUsers(mockUserRepo *tests.MockedUserRepo) { + _ = mockUserRepo.Put(&model.User{ + ID: "user1", + UserName: "alice", + Name: "Alice Admin", + IsAdmin: true, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user2", + UserName: "bob", + Name: "Bob User", + IsAdmin: false, + }) + _ = mockUserRepo.Put(&model.User{ + ID: "user3", + UserName: "charlie", + Name: "Charlie User", + IsAdmin: false, + }) +} + +// setupTestUsersConfig sets up common plugin configuration +func setupTestUsersConfig(tmpDir string) { + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false +} + +// testUsersInput represents input for test-users plugin calls +type testUsersInput struct { + Operation string `json:"operation"` +} + +// testUser represents a user returned from test-users plugin +type testUser struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// testUsersOutput represents output from test-users plugin +type testUsersOutput struct { + Users []testUser `json:"users,omitempty"` + Error *string `json:"error,omitempty"` +} + +// callTestUsersPlugin calls the test-users plugin with given input +func callTestUsersPlugin(ctx context.Context, manager *Manager, input testUsersInput) (*testUsersOutput, error) { + manager.mu.RLock() + p := manager.plugins["test-users"] + manager.mu.RUnlock() + + instance, err := p.instance(ctx) + if err != nil { + return nil, err + } + defer instance.Close(ctx) + + inputBytes, _ := json.Marshal(input) + _, outputBytes, err := instance.Call("nd_test_users", inputBytes) + if err != nil { + return nil, err + } + + var output testUsersOutput + if err := json.Unmarshal(outputBytes, &output); err != nil { + return nil, err + } + if output.Error != nil { + return nil, errors.New(*output.Error) + } + return &output, nil +} + +// setupUsersIntegrationManager creates a Manager for users integration tests with the given plugin settings. +// The plugin is enabled by default. +func setupUsersIntegrationManager(allUsers bool, allowedUsers string) (*Manager, func()) { + return setupUsersIntegrationManagerWithEnabled(true, allUsers, allowedUsers) +} + +// setupUsersIntegrationManagerWithEnabled creates a Manager for users integration tests with full control over plugin state +func setupUsersIntegrationManagerWithEnabled(enabled, allUsers bool, allowedUsers string) (*Manager, func()) { + setup, err := setupTestUsersPlugin() + Expect(err).ToNot(HaveOccurred()) + + // Setup config + cleanupConfig := configtest.SetupConfig() + setupTestUsersConfig(setup.tmpDir) + + // Setup mock DataStore with plugin and users + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-users", + Path: setup.destPath, + SHA256: setup.hashHex, + Enabled: enabled, + AllUsers: allUsers, + Users: allowedUsers, + }}) + + mockUserRepo := tests.CreateMockUserRepo() + createTestUsers(mockUserRepo) + + dataStore := &tests.MockDataStore{ + MockedPlugin: mockPluginRepo, + MockedUser: mockUserRepo, + } + + // Create and start manager + manager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + cleanup := func() { + _ = manager.Stop() + _ = os.RemoveAll(setup.tmpDir) + cleanupConfig() + } + + return manager, cleanup +} diff --git a/plugins/host_websocket.go b/plugins/host_websocket.go new file mode 100644 index 000000000..eef1e6236 --- /dev/null +++ b/plugins/host_websocket.go @@ -0,0 +1,389 @@ +package plugins + +import ( + "context" + "errors" + "fmt" + "maps" + "net/http" + "net/url" + "strings" + "sync" + "time" + + "github.com/gorilla/websocket" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model/id" + "github.com/navidrome/navidrome/plugins/capabilities" + "github.com/navidrome/navidrome/plugins/host" +) + +// CapabilityWebSocket indicates the plugin can receive WebSocket callbacks. +// Detected when the plugin exports any of the WebSocket callback functions. +const CapabilityWebSocket Capability = "WebSocket" + +// webSocketCallbackTimeout is the maximum duration allowed for a WebSocket callback. +const webSocketCallbackTimeout = 30 * time.Second + +// WebSocket callback function names +const ( + FuncWebSocketOnTextMessage = "nd_websocket_on_text_message" + FuncWebSocketOnBinaryMessage = "nd_websocket_on_binary_message" + FuncWebSocketOnError = "nd_websocket_on_error" + FuncWebSocketOnClose = "nd_websocket_on_close" +) + +func init() { + registerCapability( + CapabilityWebSocket, + FuncWebSocketOnTextMessage, + FuncWebSocketOnBinaryMessage, + FuncWebSocketOnError, + FuncWebSocketOnClose, + ) +} + +// wsConnection represents an active WebSocket connection. +type wsConnection struct { + conn *websocket.Conn + done chan struct{} + closeMu sync.Mutex + isClosed bool +} + +// webSocketServiceImpl implements host.WebSocketService. +// It provides plugins with WebSocket communication capabilities. +type webSocketServiceImpl struct { + pluginName string + manager *Manager + requiredHosts []string + + mu sync.RWMutex + connections map[string]*wsConnection +} + +// newWebSocketService creates a new WebSocketService for a plugin. +func newWebSocketService(pluginName string, manager *Manager, permission *WebSocketPermission) *webSocketServiceImpl { + return &webSocketServiceImpl{ + pluginName: pluginName, + manager: manager, + requiredHosts: permission.RequiredHosts, + connections: make(map[string]*wsConnection), + } +} + +func (s *webSocketServiceImpl) Connect(ctx context.Context, urlStr string, headers map[string]string, connectionID string) (string, error) { + // Parse and validate URL + parsedURL, err := url.Parse(urlStr) + if err != nil { + return "", fmt.Errorf("invalid URL: %w", err) + } + + // Validate scheme + if parsedURL.Scheme != "ws" && parsedURL.Scheme != "wss" { + return "", fmt.Errorf("invalid URL scheme: must be ws:// or wss://") + } + + // Validate host against allowed hosts + if !s.isHostAllowed(parsedURL.Host) { + return "", fmt.Errorf("host %q is not allowed", parsedURL.Host) + } + + // Generate connection ID if not provided + if connectionID == "" { + connectionID = id.NewRandom() + } + + s.mu.Lock() + if _, exists := s.connections[connectionID]; exists { + s.mu.Unlock() + return "", fmt.Errorf("connection ID %q already exists", connectionID) + } + s.mu.Unlock() + + // Create HTTP headers for handshake + httpHeaders := http.Header{} + for k, v := range headers { + httpHeaders.Set(k, v) + } + + // Establish WebSocket connection + dialer := websocket.Dialer{ + HandshakeTimeout: 30 * time.Second, + } + + conn, resp, err := dialer.DialContext(ctx, urlStr, httpHeaders) + if resp != nil && resp.Body != nil { + _ = resp.Body.Close() + } + if err != nil { + return "", fmt.Errorf("failed to connect: %w", err) + } + + wsConn := &wsConnection{ + conn: conn, + done: make(chan struct{}), + } + + s.mu.Lock() + s.connections[connectionID] = wsConn + s.mu.Unlock() + + // Start read goroutine with manager's context. + // We use manager.ctx instead of the caller's ctx because the readLoop must + // outlive the Connect() call. The manager's context is cancelled during + // application shutdown, ensuring graceful cleanup. + go s.readLoop(s.manager.ctx, connectionID, wsConn) + + log.Debug(ctx, "WebSocket connected", "plugin", s.pluginName, "connectionID", connectionID, "url", urlStr) + return connectionID, nil +} + +func (s *webSocketServiceImpl) SendText(ctx context.Context, connectionID, message string) error { + wsConn, err := s.getConnection(connectionID) + if err != nil { + return err + } + + if err := wsConn.conn.WriteMessage(websocket.TextMessage, []byte(message)); err != nil { + return fmt.Errorf("failed to send text message: %w", err) + } + + return nil +} + +func (s *webSocketServiceImpl) SendBinary(ctx context.Context, connectionID string, data []byte) error { + wsConn, err := s.getConnection(connectionID) + if err != nil { + return err + } + + if err := wsConn.conn.WriteMessage(websocket.BinaryMessage, data); err != nil { + return fmt.Errorf("failed to send binary message: %w", err) + } + + return nil +} + +func (s *webSocketServiceImpl) CloseConnection(ctx context.Context, connectionID string, code int32, reason string) error { + s.mu.Lock() + wsConn, exists := s.connections[connectionID] + if !exists { + s.mu.Unlock() + return fmt.Errorf("connection ID %q not found", connectionID) + } + delete(s.connections, connectionID) + s.mu.Unlock() + + // Mark as closed to prevent callback + wsConn.closeMu.Lock() + wsConn.isClosed = true + wsConn.closeMu.Unlock() + + // Send close message + closeMsg := websocket.FormatCloseMessage(int(code), reason) + _ = wsConn.conn.WriteControl(websocket.CloseMessage, closeMsg, time.Now().Add(5*time.Second)) + _ = wsConn.conn.Close() + + // Signal read goroutine to stop + close(wsConn.done) + + // Invoke close callback + s.invokeOnClose(ctx, connectionID, code, reason) + + log.Debug(ctx, "WebSocket connection closed", "plugin", s.pluginName, "connectionID", connectionID, "code", code) + return nil +} + +// Close closes all connections for this plugin. +// This is called when the plugin is unloaded. +func (s *webSocketServiceImpl) Close() error { + s.mu.Lock() + connections := make(map[string]*wsConnection, len(s.connections)) + maps.Copy(connections, s.connections) + s.connections = make(map[string]*wsConnection) + s.mu.Unlock() + + ctx := context.Background() + for connID, wsConn := range connections { + wsConn.closeMu.Lock() + wsConn.isClosed = true + wsConn.closeMu.Unlock() + + closeMsg := websocket.FormatCloseMessage(websocket.CloseGoingAway, "plugin unloaded") + err := wsConn.conn.WriteControl(websocket.CloseMessage, closeMsg, time.Now().Add(2*time.Second)) + if err != nil { + log.Warn("Failed to send WebSocket close message on plugin unload", "plugin", s.pluginName, "connectionID", connID, "error", err) + } + err = wsConn.conn.Close() + if err != nil { + log.Warn("Failed to close WebSocket connection on plugin unload", "plugin", s.pluginName, "connectionID", connID, "error", err) + } + close(wsConn.done) + + s.invokeOnClose(ctx, connID, websocket.CloseGoingAway, "plugin unloaded") + log.Debug("WebSocket connection closed on plugin unload", "plugin", s.pluginName, "connectionID", connID) + } + + return nil +} + +func (s *webSocketServiceImpl) getConnection(connectionID string) (*wsConnection, error) { + s.mu.RLock() + defer s.mu.RUnlock() + + wsConn, exists := s.connections[connectionID] + if !exists { + return nil, fmt.Errorf("connection ID %q not found", connectionID) + } + return wsConn, nil +} + +func (s *webSocketServiceImpl) isHostAllowed(host string) bool { + // Strip port from host if present + hostWithoutPort := host + if idx := strings.LastIndex(host, ":"); idx != -1 { + hostWithoutPort = host[:idx] + } + + for _, pattern := range s.requiredHosts { + if matchHostPattern(pattern, hostWithoutPort) { + return true + } + } + return false +} + +// matchHostPattern matches a host against a pattern. +// Supports "*" (allow all) and wildcards like "*.example.com". +func matchHostPattern(pattern, host string) bool { + if pattern == "*" { + return true + } + if pattern == host { + return true + } + + // Handle wildcard patterns like *.example.com + if strings.HasPrefix(pattern, "*.") { + suffix := pattern[1:] // Get .example.com + return strings.HasSuffix(host, suffix) + } + + return false +} + +func (s *webSocketServiceImpl) readLoop(ctx context.Context, connectionID string, wsConn *wsConnection) { + defer func() { + // Remove connection if still present + s.mu.Lock() + delete(s.connections, connectionID) + s.mu.Unlock() + }() + + for { + select { + case <-wsConn.done: + return + default: + } + + messageType, data, err := wsConn.conn.ReadMessage() + if err != nil { + wsConn.closeMu.Lock() + isClosed := wsConn.isClosed + wsConn.closeMu.Unlock() + + if isClosed { + return + } + + // Check if it's a close error + if websocket.IsCloseError(err, websocket.CloseNormalClosure, websocket.CloseGoingAway, websocket.CloseNoStatusReceived) { + closeCode := websocket.CloseNoStatusReceived + closeReason := "" + if ce, ok := errors.AsType[*websocket.CloseError](err); ok { + closeCode = ce.Code + closeReason = ce.Text + } + s.invokeOnClose(ctx, connectionID, int32(closeCode), closeReason) + return + } + + // Other read error + s.invokeOnError(ctx, connectionID, err.Error()) + return + } + + switch messageType { + case websocket.TextMessage: + s.invokeOnTextMessage(ctx, connectionID, string(data)) + case websocket.BinaryMessage: + s.invokeOnBinaryMessage(ctx, connectionID, data) + } + } +} + +// invokeWebSocketCallback is a generic helper that handles the common callback invocation pattern. +func invokeWebSocketCallback[I any](ctx context.Context, s *webSocketServiceImpl, funcName string, input I, callbackName string, connectionID string) { + instance := s.getPluginInstance() + if instance == nil { + return + } + + callbackCtx, cancel := context.WithTimeout(ctx, webSocketCallbackTimeout) + defer cancel() + + start := time.Now() + err := callPluginFunctionNoOutput(callbackCtx, instance, funcName, input) + if err != nil { + if !errors.Is(errFunctionNotFound, err) { + log.Error(ctx, "WebSocket "+callbackName+" callback failed", "plugin", s.pluginName, "connectionID", connectionID, "duration", time.Since(start), err) + } + } +} + +func (s *webSocketServiceImpl) invokeOnTextMessage(ctx context.Context, connectionID, message string) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnTextMessage, capabilities.OnTextMessageRequest{ + ConnectionID: connectionID, + Message: message, + }, "text message", connectionID) +} + +func (s *webSocketServiceImpl) invokeOnBinaryMessage(ctx context.Context, connectionID string, data []byte) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnBinaryMessage, capabilities.OnBinaryMessageRequest{ + ConnectionID: connectionID, + Data: data, + }, "binary message", connectionID) +} + +func (s *webSocketServiceImpl) invokeOnError(ctx context.Context, connectionID, errorMsg string) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnError, capabilities.OnErrorRequest{ + ConnectionID: connectionID, + Error: errorMsg, + }, "error", connectionID) +} + +func (s *webSocketServiceImpl) invokeOnClose(ctx context.Context, connectionID string, code int32, reason string) { + invokeWebSocketCallback(ctx, s, FuncWebSocketOnClose, capabilities.OnCloseRequest{ + ConnectionID: connectionID, + Code: code, + Reason: reason, + }, "close", connectionID) +} + +func (s *webSocketServiceImpl) getPluginInstance() *plugin { + s.manager.mu.RLock() + instance, ok := s.manager.plugins[s.pluginName] + s.manager.mu.RUnlock() + + if !ok { + log.Warn("Plugin not loaded for WebSocket callback", "plugin", s.pluginName) + return nil + } + + return instance +} + +// Verify interface implementation +var _ host.WebSocketService = (*webSocketServiceImpl)(nil) diff --git a/plugins/host_websocket_test.go b/plugins/host_websocket_test.go new file mode 100644 index 000000000..e41cfbb82 --- /dev/null +++ b/plugins/host_websocket_test.go @@ -0,0 +1,616 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + + "encoding/hex" + "maps" + "net/http" + "net/http/httptest" + "os" + "path/filepath" + "strings" + "sync" + + "github.com/gorilla/websocket" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("WebSocketService", Ordered, func() { + var ( + manager *Manager + tmpDir string + testService *testableWebSocketService + ) + + BeforeAll(func() { + var err error + tmpDir, err = os.MkdirTemp("", "websocket-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy the test-websocket plugin + srcPath := filepath.Join(testdataDir, "test-websocket"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-websocket"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugin + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(model.Plugins{{ + ID: "test-websocket", + Path: destPath, + SHA256: hashHex, + Enabled: true, + }}) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager = &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + metrics: noopMetricsRecorder{}, + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + // Get WebSocket service from plugin's closers and wrap it for testing + service := findWebSocketService(manager, "test-websocket") + Expect(service).ToNot(BeNil()) + testService = &testableWebSocketService{webSocketServiceImpl: service} + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + }) + + BeforeEach(func() { + // Clean up any connections from previous tests + testService.closeAllConnections() + }) + + Describe("Plugin Loading", func() { + It("should detect WebSocket capability", func() { + names := manager.PluginNames(string(CapabilityWebSocket)) + Expect(names).To(ContainElement("test-websocket")) + }) + + It("should register WebSocket service for plugin", func() { + service := findWebSocketService(manager, "test-websocket") + Expect(service).ToNot(BeNil()) + }) + }) + + Describe("URL Validation", func() { + It("should reject invalid URL schemes", func() { + ctx := GinkgoT().Context() + _, err := testService.Connect(ctx, "http://example.com", nil, "test-conn") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid URL scheme")) + }) + + It("should reject disallowed hosts", func() { + ctx := GinkgoT().Context() + _, err := testService.Connect(ctx, "wss://evil.com/socket", nil, "test-conn") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not allowed")) + }) + + It("should allow hosts matching wildcard patterns", func() { + // test-websocket manifest allows *.example.com + // The pattern *.example.com matches any host ending with .example.com + ctx := context.Background() + allowed := testService.isHostAllowed("api.example.com") + Expect(allowed).To(BeTrue()) + + // Deep subdomains also match (ends with .example.com) + allowed = testService.isHostAllowed("sub.api.example.com") + Expect(allowed).To(BeTrue()) + + // But exact match without subdomain doesn't match *.example.com + allowed = testService.isHostAllowed("example.com") + Expect(allowed).To(BeFalse()) + _ = ctx + }) + + It("should allow exact host matches", func() { + // test-websocket manifest allows echo.websocket.org + allowed := testService.isHostAllowed("echo.websocket.org") + Expect(allowed).To(BeTrue()) + + allowed = testService.isHostAllowed("other.org") + Expect(allowed).To(BeFalse()) + }) + + It("should strip port before checking host", func() { + // Implementation strips port before matching against patterns + // test-websocket manifest has "localhost:*" which matches "localhost" + // after port stripping + // Note: The port wildcard pattern isn't actually implemented, but + // since port is stripped, "localhost:*" is compared against "localhost" + // which won't match. To make localhost work, we'd need exact "localhost" + // in the allowed hosts list. + + // Testing that port is properly stripped + // The pattern "localhost:*" won't match "localhost" due to exact match + allowed := testService.isHostAllowed("localhost:8080") + Expect(allowed).To(BeFalse()) + }) + }) + + Describe("Connection Management", func() { + var wsServer *httptest.Server + var serverMessages []string + var serverMu sync.Mutex + + BeforeEach(func() { + serverMessages = nil + + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, + } + wsServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + + // Read messages until connection closes + for { + _, msg, err := conn.ReadMessage() + if err != nil { + break + } + serverMu.Lock() + serverMessages = append(serverMessages, string(msg)) + serverMu.Unlock() + } + })) + + // Add the server's host to allowed hosts for testing + // Since the implementation strips port before matching, we need to add + // the host without port + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) + }) + + AfterEach(func() { + testService.closeAllConnections() + if wsServer != nil { + wsServer.Close() + } + }) + + It("should connect to WebSocket server", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "test-conn") + Expect(err).ToNot(HaveOccurred()) + Expect(connID).To(Equal("test-conn")) + Expect(testService.getConnectionCount()).To(Equal(1)) + }) + + It("should generate connection ID when not provided", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "") + Expect(err).ToNot(HaveOccurred()) + Expect(connID).ToNot(BeEmpty()) + }) + + It("should reject duplicate connection IDs", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "dup-conn") + Expect(err).ToNot(HaveOccurred()) + + _, err = testService.Connect(ctx, wsURL, nil, "dup-conn") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("already exists")) + }) + + It("should send text messages", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "send-text-conn") + Expect(err).ToNot(HaveOccurred()) + + err = testService.SendText(ctx, connID, "hello world") + Expect(err).ToNot(HaveOccurred()) + + // Give server time to receive the message + Eventually(func() []string { + serverMu.Lock() + defer serverMu.Unlock() + return serverMessages + }).Should(ContainElement("hello world")) + }) + + It("should send binary messages", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "send-binary-conn") + Expect(err).ToNot(HaveOccurred()) + + binaryData := []byte{0x00, 0x01, 0x02, 0x03} + err = testService.SendBinary(ctx, connID, binaryData) + Expect(err).ToNot(HaveOccurred()) + + // Give server time to receive the message + Eventually(func() []string { + serverMu.Lock() + defer serverMu.Unlock() + return serverMessages + }).Should(ContainElement(string(binaryData))) + }) + + It("should close connections", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + connID, err := testService.Connect(ctx, wsURL, nil, "close-conn") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(1)) + + err = testService.CloseConnection(ctx, connID, 1000, "normal close") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(0)) + }) + + It("should return error for non-existent connection", func() { + ctx := GinkgoT().Context() + err := testService.SendText(ctx, "non-existent", "message") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + }) + + Describe("Plugin Callbacks", func() { + var wsServer *httptest.Server + var serverConn *websocket.Conn + var serverMessages []string + var serverBinaryMessages [][]byte + var serverMu sync.Mutex + + BeforeEach(func() { + serverConn = nil + serverMessages = nil + serverBinaryMessages = nil + + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, + } + wsServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + serverMu.Lock() + serverConn = conn + serverMu.Unlock() + + // Read and store messages + for { + msgType, msg, err := conn.ReadMessage() + if err != nil { + break + } + serverMu.Lock() + if msgType == websocket.BinaryMessage { + serverBinaryMessages = append(serverBinaryMessages, msg) + } else { + serverMessages = append(serverMessages, string(msg)) + } + serverMu.Unlock() + } + })) + + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) + }) + + AfterEach(func() { + testService.closeAllConnections() + if wsServer != nil { + wsServer.Close() + } + }) + + It("should invoke OnBinaryMessage callback when receiving binary", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "binary-cb-conn") + Expect(err).ToNot(HaveOccurred()) + + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Send binary message from server to plugin + binaryData := []byte{0xDE, 0xAD, 0xBE, 0xEF} + serverMu.Lock() + err = serverConn.WriteMessage(websocket.BinaryMessage, binaryData) + serverMu.Unlock() + Expect(err).ToNot(HaveOccurred()) + + // Plugin echoes binary data back as a binary message + Eventually(func() [][]byte { + serverMu.Lock() + defer serverMu.Unlock() + return serverBinaryMessages + }).Should(ContainElement(binaryData)) + }) + + It("should invoke OnClose callback when server closes connection", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "close-cb-conn") + Expect(err).ToNot(HaveOccurred()) + + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Close from server side + serverMu.Lock() + _ = serverConn.WriteMessage(websocket.CloseMessage, + websocket.FormatCloseMessage(websocket.CloseNormalClosure, "goodbye")) + serverConn.Close() + serverMu.Unlock() + + // Connection should be removed after close callback + Eventually(func() int { + return testService.getConnectionCount() + }).Should(Equal(0)) + }) + }) + + Describe("Plugin Host Function Calls", func() { + var wsServer *httptest.Server + var serverConn *websocket.Conn + var serverMessages []string + var serverMu sync.Mutex + + BeforeEach(func() { + serverMessages = nil + serverConn = nil + + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, + } + wsServer = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + serverMu.Lock() + serverConn = conn + serverMu.Unlock() + + // Read and store messages + for { + _, msg, err := conn.ReadMessage() + if err != nil { + break + } + serverMu.Lock() + serverMessages = append(serverMessages, string(msg)) + serverMu.Unlock() + } + })) + + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) + }) + + AfterEach(func() { + testService.closeAllConnections() + if wsServer != nil { + wsServer.Close() + } + }) + + It("should allow plugin to send messages via host function", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "host-send-conn") + Expect(err).ToNot(HaveOccurred()) + + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Server sends "echo" message to trigger plugin to echo back + serverMu.Lock() + err = serverConn.WriteMessage(websocket.TextMessage, []byte("echo")) + serverMu.Unlock() + Expect(err).ToNot(HaveOccurred()) + + // Plugin should have echoed back via host function + Eventually(func() []string { + serverMu.Lock() + defer serverMu.Unlock() + return serverMessages + }).Should(ContainElement("echo:echo")) + }) + + It("should allow plugin to close connection via host function", func() { + ctx := GinkgoT().Context() + wsURL := "ws://" + strings.TrimPrefix(wsServer.URL, "http://") + _, err := testService.Connect(ctx, wsURL, nil, "host-close-conn") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(1)) + + // Wait for server to have the connection + Eventually(func() *websocket.Conn { + serverMu.Lock() + defer serverMu.Unlock() + return serverConn + }).ShouldNot(BeNil()) + + // Server sends "close" message to trigger plugin to close connection + serverMu.Lock() + err = serverConn.WriteMessage(websocket.TextMessage, []byte("close")) + serverMu.Unlock() + Expect(err).ToNot(HaveOccurred()) + + // Connection should be closed by plugin + Eventually(func() int { + return testService.getConnectionCount() + }).Should(Equal(0)) + }) + }) + + Describe("Plugin Unload", func() { + It("should close all connections when plugin is unloaded", func() { + // Create a fresh server for this test + upgrader := websocket.Upgrader{ + CheckOrigin: func(r *http.Request) bool { return true }, + } + wsServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + conn, err := upgrader.Upgrade(w, r, nil) + if err != nil { + return + } + // Keep alive + for { + _, _, err := conn.ReadMessage() + if err != nil { + break + } + } + })) + defer wsServer.Close() + + serverURL := strings.TrimPrefix(wsServer.URL, "http://") + hostOnly := serverURL + if idx := strings.LastIndex(serverURL, ":"); idx != -1 { + hostOnly = serverURL[:idx] + } + testService.requiredHosts = append(testService.requiredHosts, hostOnly) + + ctx := GinkgoT().Context() + wsURL := "ws://" + serverURL + + // Create multiple connections + _, err := testService.Connect(ctx, wsURL, nil, "unload-conn-1") + Expect(err).ToNot(HaveOccurred()) + _, err = testService.Connect(ctx, wsURL, nil, "unload-conn-2") + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(2)) + + // Close the service (simulates plugin unload) + err = testService.Close() + Expect(err).ToNot(HaveOccurred()) + Expect(testService.getConnectionCount()).To(Equal(0)) + }) + }) + + Describe("matchHostPattern", func() { + It("should match exact hosts", func() { + Expect(matchHostPattern("example.com", "example.com")).To(BeTrue()) + Expect(matchHostPattern("example.com", "other.com")).To(BeFalse()) + }) + + It("should match wildcard patterns", func() { + Expect(matchHostPattern("*.example.com", "api.example.com")).To(BeTrue()) + Expect(matchHostPattern("*.example.com", "example.com")).To(BeFalse()) + Expect(matchHostPattern("*.example.com", "deep.api.example.com")).To(BeTrue()) + }) + + It("should match bare '*' as allow-all", func() { + Expect(matchHostPattern("*", "anything.example.com")).To(BeTrue()) + Expect(matchHostPattern("*", "127.0.0.1")).To(BeTrue()) + Expect(matchHostPattern("*", "::1")).To(BeTrue()) + }) + + It("should not match partial patterns", func() { + Expect(matchHostPattern("*.example.com", "example.com.evil.org")).To(BeFalse()) + }) + }) +}) + +// testableWebSocketService wraps webSocketServiceImpl with test helpers. +type testableWebSocketService struct { + *webSocketServiceImpl +} + +func (t *testableWebSocketService) getConnectionCount() int { + t.mu.RLock() + defer t.mu.RUnlock() + return len(t.connections) +} + +func (t *testableWebSocketService) closeAllConnections() { + t.mu.Lock() + conns := make(map[string]*wsConnection, len(t.connections)) + maps.Copy(conns, t.connections) + t.connections = make(map[string]*wsConnection) + t.mu.Unlock() + + for _, conn := range conns { + conn.closeMu.Lock() + conn.isClosed = true + conn.closeMu.Unlock() + _ = conn.conn.Close() + close(conn.done) + } +} + +// findWebSocketService finds the WebSocket service from a plugin's closers. +func findWebSocketService(m *Manager, pluginName string) *webSocketServiceImpl { + m.mu.RLock() + instance, ok := m.plugins[pluginName] + m.mu.RUnlock() + if !ok { + return nil + } + for _, closer := range instance.closers { + if svc, ok := closer.(*webSocketServiceImpl); ok { + return svc + } + } + return nil +} diff --git a/plugins/lyrics_adapter.go b/plugins/lyrics_adapter.go new file mode 100644 index 000000000..c66b027d7 --- /dev/null +++ b/plugins/lyrics_adapter.go @@ -0,0 +1,63 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/capabilities" +) + +const CapabilityLyrics Capability = "Lyrics" + +const ( + FuncLyricsGetLyrics = "nd_lyrics_get_lyrics" +) + +func init() { + registerCapability( + CapabilityLyrics, + FuncLyricsGetLyrics, + ) +} + +func newLyricsPlugin(p *plugin) *LyricsPlugin { + return &LyricsPlugin{name: p.name, plugin: p} +} + +// LyricsPlugin adapts a WASM plugin with the Lyrics capability. +type LyricsPlugin struct { + name string + plugin *plugin +} + +// GetLyrics calls the plugin to fetch lyrics, then parses the raw text responses +// using model.ToLyrics. +func (l *LyricsPlugin) GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) { + req := capabilities.GetLyricsRequest{ + Track: mediaFileToTrackInfo(l.plugin, mf), + } + resp, err := callPluginFunction[capabilities.GetLyricsRequest, capabilities.GetLyricsResponse]( + ctx, l.plugin, FuncLyricsGetLyrics, req, + ) + if err != nil { + return nil, err + } + + var result model.LyricList + for _, lt := range resp.Lyrics { + lang := lt.Lang + if lang == "" { + lang = "xxx" + } + parsed, err := model.ToLyrics(lang, lt.Text) + if err != nil { + log.Warn(ctx, "Error parsing plugin lyrics", "plugin", l.name, err) + continue + } + if parsed != nil && !parsed.IsEmpty() { + result = append(result, *parsed) + } + } + return result, nil +} diff --git a/plugins/lyrics_adapter_test.go b/plugins/lyrics_adapter_test.go new file mode 100644 index 000000000..a1a6c1809 --- /dev/null +++ b/plugins/lyrics_adapter_test.go @@ -0,0 +1,99 @@ +//go:build !windows + +package plugins + +import ( + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("LyricsPlugin", Ordered, func() { + var ( + lyricsManager *Manager + provider *LyricsPlugin + ) + + BeforeAll(func() { + lyricsManager, _ = createTestManagerWithPlugins(nil, + "test-lyrics"+PackageExtension, + "test-metadata-agent"+PackageExtension, + ) + + p, ok := lyricsManager.LoadLyricsProvider("test-lyrics") + Expect(ok).To(BeTrue()) + provider = p.(*LyricsPlugin) + }) + + Describe("LoadLyricsProvider", func() { + It("returns a lyrics provider for a plugin with Lyrics capability", func() { + Expect(provider).ToNot(BeNil()) + }) + + It("returns false for a plugin without Lyrics capability", func() { + _, ok := lyricsManager.LoadLyricsProvider("test-metadata-agent") + Expect(ok).To(BeFalse()) + }) + + It("returns false for non-existent plugin", func() { + _, ok := lyricsManager.LoadLyricsProvider("non-existent") + Expect(ok).To(BeFalse()) + }) + }) + + Describe("GetLyrics", func() { + It("successfully returns lyrics from the plugin", func() { + track := &model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Artist: "Test Artist", + } + + result, err := provider.GetLyrics(GinkgoT().Context(), track) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].Line).ToNot(BeEmpty()) + Expect(result[0].Line[0].Value).To(ContainSubstring("Test Song")) + }) + + It("defaults language to 'xxx' when plugin does not provide one", func() { + manager, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-lyrics": {"no_lang": "true"}, + }, "test-lyrics"+PackageExtension) + + p, ok := manager.LoadLyricsProvider("test-lyrics") + Expect(ok).To(BeTrue()) + + track := &model.MediaFile{ID: "track-1", Title: "Test Song", Artist: "Test Artist"} + result, err := p.GetLyrics(GinkgoT().Context(), track) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result[0].Lang).To(Equal("xxx")) + }) + + It("returns error when plugin returns error", func() { + manager, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-lyrics": {"error": "service unavailable"}, + }, "test-lyrics"+PackageExtension) + + p, ok := manager.LoadLyricsProvider("test-lyrics") + Expect(ok).To(BeTrue()) + + track := &model.MediaFile{ID: "track-1", Title: "Test Song"} + _, err := p.GetLyrics(GinkgoT().Context(), track) + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("PluginNames", func() { + It("returns plugin names with Lyrics capability", func() { + names := lyricsManager.PluginNames("Lyrics") + Expect(names).To(ContainElement("test-lyrics")) + }) + + It("does not return metadata agent plugins for Lyrics capability", func() { + names := lyricsManager.PluginNames("Lyrics") + Expect(names).ToNot(ContainElement("test-metadata-agent")) + }) + }) +}) diff --git a/plugins/manager.go b/plugins/manager.go new file mode 100644 index 000000000..67e0ee987 --- /dev/null +++ b/plugins/manager.go @@ -0,0 +1,646 @@ +package plugins + +import ( + "context" + "encoding/json" + "fmt" + "net/http" + "path/filepath" + "runtime" + "sync" + "sync/atomic" + "time" + + "github.com/Masterminds/squirrel" + extism "github.com/extism/go-sdk" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/lyrics" + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/utils/singleton" + "github.com/rjeczalik/notify" + "github.com/tetratelabs/wazero" +) + +const ( + // defaultTimeout is the default timeout for plugin function calls + defaultTimeout = 30 * time.Second + + // maxPluginLoadConcurrency is the maximum number of plugins that can be + // compiled/loaded in parallel during startup + maxPluginLoadConcurrency = 3 +) + +// SubsonicRouter is an http.Handler that serves Subsonic API requests. +type SubsonicRouter = http.Handler + +// PluginMetricsRecorder is an interface for recording plugin metrics. +// This is satisfied by core/metrics.Metrics but defined here to avoid import cycles. +type PluginMetricsRecorder interface { + RecordPluginRequest(ctx context.Context, plugin, method string, ok bool, elapsed int64) +} + +// Manager manages loading and lifecycle of WebAssembly plugins. +// It implements both agents.PluginLoader and scrobbler.PluginLoader interfaces. +type Manager struct { + mu sync.RWMutex + plugins map[string]*plugin + ctx context.Context + cancel context.CancelFunc + cache wazero.CompilationCache + stopped atomic.Bool // Set to true when Stop() is called + loadWg sync.WaitGroup // Tracks in-flight plugin load operations + + // File watcher fields (used when AutoReload is enabled) + watcherEvents chan notify.EventInfo + watcherDone chan struct{} + debounceTimers map[string]*time.Timer + debounceMu sync.Mutex + + // SubsonicAPI host function dependencies (set once before Start, not modified after) + subsonicRouter SubsonicRouter + ds model.DataStore + broker events.Broker + metrics PluginMetricsRecorder +} + +// GetManager returns a singleton instance of the plugin manager. +// The manager is not started automatically; call Start() to begin loading plugins. +func GetManager(ds model.DataStore, broker events.Broker, m PluginMetricsRecorder) *Manager { + return singleton.GetInstance(func() *Manager { + return &Manager{ + ds: ds, + broker: broker, + metrics: m, + plugins: make(map[string]*plugin), + } + }) +} + +// sendPluginRefreshEvent broadcasts a refresh event for the plugin resource. +// This notifies connected UI clients that plugin data has changed. +func (m *Manager) sendPluginRefreshEvent(ctx context.Context, pluginIDs ...string) { + if m.broker == nil { + return + } + event := (&events.RefreshResource{}).With("plugin", pluginIDs...) + m.broker.SendBroadcastMessage(ctx, event) +} + +// SetSubsonicRouter sets the Subsonic router for SubsonicAPI host functions. +// This should be called after the subsonic router is created but before plugins +// that require SubsonicAPI access are loaded. +func (m *Manager) SetSubsonicRouter(router SubsonicRouter) { + m.subsonicRouter = router +} + +// Start initializes the plugin manager and loads plugins from the configured folder. +// It should be called once during application startup when plugins are enabled. +// The startup flow is: +// 1. Sync plugins folder with DB (discover new, update changed, remove deleted) +// 2. Load only enabled plugins from DB +func (m *Manager) Start(ctx context.Context) error { + if !conf.Server.Plugins.Enabled { + log.Debug(ctx, "Plugin system is disabled") + return nil + } + + if m.subsonicRouter == nil { + log.Fatal(ctx, "Plugin manager requires DataStore to be configured") + } + + // Set extism log level based on plugin-specific config or global log level + pluginLogLevel := conf.Server.Plugins.LogLevel + if pluginLogLevel == "" { + pluginLogLevel = conf.Server.LogLevel + } + extism.SetLogLevel(toExtismLogLevel(log.ParseLogLevel(pluginLogLevel))) + + m.ctx, m.cancel = context.WithCancel(ctx) + + // Initialize wazero compilation cache for better performance + cacheDir := filepath.Join(conf.Server.CacheFolder.MustPath(), "plugins") + purgeCacheBySize(ctx, cacheDir, conf.Server.Plugins.CacheSize) + + var err error + m.cache, err = wazero.NewCompilationCacheWithDir(cacheDir) + if err != nil { + log.Error(ctx, "Failed to create wazero compilation cache", err) + return fmt.Errorf("creating wazero compilation cache: %w", err) + } + + if conf.Server.Plugins.Folder.String() == "" { + log.Debug(ctx, "No plugins folder configured") + return nil + } + + folder := conf.Server.Plugins.Folder.MustPath() + + log.Info(ctx, "Starting plugin manager", "folder", folder) + + // Clear previous error states so plugins can be retried on restart + adminCtx := adminContext(ctx) + if err := m.ds.Plugin(adminCtx).ClearErrors(); err != nil { + log.Error(ctx, "Error clearing plugin errors", err) + } + + // Sync plugins folder with DB + if err := m.syncPlugins(ctx, folder); err != nil { + log.Error(ctx, "Error syncing plugins with DB", err) + // Continue - we can still try to load plugins + } + + // Load enabled plugins from DB + if err := m.loadEnabledPlugins(ctx); err != nil { + log.Error(ctx, "Error loading enabled plugins", err) + return fmt.Errorf("loading enabled plugins: %w", err) + } + + // Start file watcher if auto-reload is enabled + if conf.Server.Plugins.AutoReload { + if err := m.startWatcher(); err != nil { + log.Error(ctx, "Failed to start plugin file watcher", err) + // Non-fatal - plugins are still loaded, just no auto-reload + } + } + + return nil +} + +// Stop shuts down the plugin manager and releases all resources. +func (m *Manager) Stop() error { + // Mark as stopped first to prevent new operations + m.stopped.Store(true) + + // Cancel context to signal all goroutines to stop + if m.cancel != nil { + m.cancel() + } + + // Stop file watcher + m.stopWatcher() + + // Wait for all in-flight plugin load operations to complete + // This is critical to avoid races with cache.Close() + m.loadWg.Wait() + + m.mu.Lock() + defer m.mu.Unlock() + + // Close all plugins + for name, plugin := range m.plugins { + err := plugin.Close() + if err != nil { + log.Error("Error during plugin cleanup", "plugin", name, err) + } + if plugin.compiled != nil { + if err := plugin.compiled.Close(context.Background()); err != nil { + log.Error("Error closing plugin", "plugin", name, err) + } + } + } + m.plugins = make(map[string]*plugin) + + // Close compilation cache + if m.cache != nil { + if err := m.cache.Close(context.Background()); err != nil { + log.Error("Error closing wazero cache", err) + } + m.cache = nil + } + + return nil +} + +// PluginNames returns the names of all plugins that implement a particular capability. +// This is used by both agents and scrobbler systems to discover available plugins. +// Capabilities are auto-detected from the plugin's exported functions. +func (m *Manager) PluginNames(capability string) []string { + m.mu.RLock() + defer m.mu.RUnlock() + + var names []string + cap := Capability(capability) + for name, plugin := range m.plugins { + if hasCapability(plugin.capabilities, cap) { + names = append(names, name) + } + } + return names +} + +func (m *Manager) LoadMediaAgent(name string) (agents.Interface, bool) { + return loadPlugin(m, name, CapabilityMetadataAgent, newMetadataAgent) +} + +func (m *Manager) LoadScrobbler(name string) (scrobbler.Scrobbler, bool) { + return loadPlugin(m, name, CapabilityScrobbler, newScrobblerPlugin) +} + +func (m *Manager) LoadLyricsProvider(name string) (lyrics.Lyrics, bool) { + return loadPlugin(m, name, CapabilityLyrics, newLyricsPlugin) +} + +func (m *Manager) LoadSonicSimilarity(name string) (sonic.Provider, bool) { + return loadPlugin(m, name, CapabilitySonicSimilarity, newSonicSimilarityPlugin) +} + +func loadPlugin[T any](m *Manager, name string, cap Capability, newAdapter func(*plugin) T) (T, bool) { + m.mu.RLock() + p, ok := m.plugins[name] + m.mu.RUnlock() + + var zero T + if !ok || !hasCapability(p.capabilities, cap) { + return zero, false + } + return newAdapter(p), true +} + +// PluginInfo contains basic information about a plugin for metrics/insights. +type PluginInfo struct { + Name string + Version string +} + +// GetPluginInfo returns information about all loaded plugins. +func (m *Manager) GetPluginInfo() map[string]PluginInfo { + m.mu.RLock() + defer m.mu.RUnlock() + + info := make(map[string]PluginInfo, len(m.plugins)) + for name, plugin := range m.plugins { + info[name] = PluginInfo{ + Name: plugin.manifest.Name, + Version: plugin.manifest.Version, + } + } + return info +} + +// EnablePlugin enables a plugin by loading it and updating the DB. +// Returns an error if the plugin is not found in DB or fails to load. +func (m *Manager) EnablePlugin(ctx context.Context, id string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + if plugin.Enabled { + return nil // Already enabled + } + + // Check permission gates before enabling + if err := m.checkPermissionGates(plugin); err != nil { + return err + } + + // Try to load the plugin + if err := m.loadPluginWithConfig(plugin); err != nil { + // Store error and return + plugin.LastError = err.Error() + plugin.UpdatedAt = time.Now() + _ = repo.Put(plugin) + return fmt.Errorf("loading plugin: %w", err) + } + + // Update DB + plugin.Enabled = true + plugin.LastError = "" + plugin.UpdatedAt = time.Now() + if err := repo.Put(plugin); err != nil { + // Unload since we couldn't update DB + _ = m.unloadPlugin(id) + return fmt.Errorf("updating plugin in DB: %w", err) + } + + log.Info(ctx, "Enabled plugin", "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil +} + +// DisablePlugin disables a plugin by unloading it and updating the DB. +// Returns an error if the plugin is not found in DB. +func (m *Manager) DisablePlugin(ctx context.Context, id string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + if !plugin.Enabled { + return nil // Already disabled + } + + // Unload the plugin + if err := m.unloadPlugin(id); err != nil { + log.Debug(ctx, "Plugin was not loaded", "plugin", id) + } + + // Update DB + plugin.Enabled = false + plugin.UpdatedAt = time.Now() + if err := repo.Put(plugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + + log.Info(ctx, "Disabled plugin", "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil +} + +// ValidatePluginConfig validates a config JSON string against the plugin's config schema. +// If the plugin has no config schema defined, it returns an error. +// Returns nil if validation passes, or an error describing the validation failure. +func (m *Manager) ValidatePluginConfig(ctx context.Context, id, configJSON string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + manifest, err := readManifest(plugin.Path) + if err != nil { + return fmt.Errorf("reading manifest: %w", err) + } + + return ValidateConfig(manifest, configJSON) +} + +// UpdatePluginConfig updates the configuration for a plugin. +// If the plugin is enabled, it will be reloaded with the new config. +func (m *Manager) UpdatePluginConfig(ctx context.Context, id, configJSON string) error { + return m.updatePluginSettings(ctx, id, func(p *model.Plugin) { + p.Config = configJSON + }) +} + +// UpdatePluginUsers updates the users permission settings for a plugin. +// If the plugin is enabled, it will be reloaded with the new settings. +// If the plugin requires users permission and no users are configured (and allUsers is false), +// the plugin will be automatically disabled. +func (m *Manager) UpdatePluginUsers(ctx context.Context, id, usersJSON string, allUsers bool) error { + return m.updatePluginSettings(ctx, id, func(p *model.Plugin) { + p.Users = usersJSON + p.AllUsers = allUsers + }) +} + +// UpdatePluginLibraries updates the libraries permission settings for a plugin. +// If the plugin is enabled, it will be reloaded with the new settings. +// If the plugin requires library permission and no libraries are configured (and allLibraries is false), +// the plugin will be automatically disabled. +func (m *Manager) UpdatePluginLibraries(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error { + return m.updatePluginSettings(ctx, id, func(p *model.Plugin) { + p.Libraries = librariesJSON + p.AllLibraries = allLibraries + p.AllowWriteAccess = allowWriteAccess + }) +} + +// RescanPlugins triggers a manual rescan of the plugins folder. +// This synchronizes the database with the filesystem, discovering new plugins, +// updating changed ones, and removing deleted ones. +func (m *Manager) RescanPlugins(ctx context.Context) error { + folder := conf.Server.Plugins.Folder.String() + if folder == "" { + return fmt.Errorf("plugins folder not configured") + } + log.Info(ctx, "Manual plugin rescan requested", "folder", folder) + return m.syncPlugins(ctx, folder) +} + +// updatePluginSettings is a common implementation for updating plugin settings. +// The updateFn is called to apply the specific field updates to the plugin. +// If the plugin is enabled, it will be reloaded. If users permission is required +// but no longer satisfied, the plugin will be disabled. +func (m *Manager) updatePluginSettings(ctx context.Context, id string, updateFn func(*model.Plugin)) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugin, err := repo.Get(id) + if err != nil { + return fmt.Errorf("getting plugin from DB: %w", err) + } + + wasEnabled := plugin.Enabled + + // Apply the specific updates + updateFn(plugin) + plugin.UpdatedAt = time.Now() + + // Check if plugin requires permission and if it's still satisfied + shouldDisable := false + disableReason := "" + if wasEnabled { + manifest, err := readManifest(plugin.Path) + if err == nil && manifest.Permissions != nil { + if manifest.Permissions.Users != nil && !hasValidUsersConfig(plugin.Users, plugin.AllUsers) { + shouldDisable = true + disableReason = "users permission removal" + } + if manifest.Permissions.Library != nil && !hasValidLibrariesConfig(plugin.Libraries, plugin.AllLibraries) { + shouldDisable = true + disableReason = "library permission removal" + } + } + } + + if shouldDisable { + // Disable the plugin since permission is no longer satisfied + if err := m.unloadPlugin(id); err != nil { + log.Debug(ctx, "Plugin was not loaded", "plugin", id) + } + plugin.Enabled = false + if err := repo.Put(plugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + log.Info(ctx, "Disabled plugin due to "+disableReason, "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil + } + + if err := repo.Put(plugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + + // Reload if enabled + if wasEnabled { + if err := m.unloadPlugin(id); err != nil { + log.Debug(ctx, "Plugin was not loaded", "plugin", id) + } + if err := m.loadPluginWithConfig(plugin); err != nil { + plugin.LastError = err.Error() + plugin.Enabled = false + _ = repo.Put(plugin) + return fmt.Errorf("reloading plugin: %w", err) + } + } + + log.Info(ctx, "Updated plugin settings", "plugin", id) + m.sendPluginRefreshEvent(ctx, id) + return nil +} + +// unloadPlugin removes a plugin from the manager and closes its resources. +// Returns an error if the plugin is not found. +func (m *Manager) unloadPlugin(name string) error { + m.mu.Lock() + plugin, ok := m.plugins[name] + if !ok { + m.mu.Unlock() + return fmt.Errorf("plugin %q not found", name) + } + delete(m.plugins, name) + m.mu.Unlock() + + // Run cleanup functions + err := plugin.Close() + if err != nil { + log.Error("Error during plugin cleanup", "plugin", name, err) + } + + // Close the compiled plugin outside the lock with a grace period + // to allow in-flight requests to complete + if plugin.compiled != nil { + // Use a brief timeout for cleanup + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) + defer cancel() + if err := plugin.compiled.Close(ctx); err != nil { + log.Error("Error closing plugin during unload", "plugin", name, err) + } + } + + runtime.GC() + log.Info(m.ctx, "Unloaded plugin", "plugin", name) + return nil +} + +// UnloadDisabledPlugins checks for plugins that are disabled in the database +// but still loaded in memory, and unloads them. This is called after user or +// library deletion to clean up plugins that were auto-disabled due to +// permission loss. +func (m *Manager) UnloadDisabledPlugins(ctx context.Context) { + if m.ds == nil { + return + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + // Get all disabled plugins from the database + plugins, err := repo.GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"enabled": false}, + }) + if err != nil { + log.Error(ctx, "Failed to get disabled plugins", err) + return + } + + // Check each disabled plugin and unload if still in memory + var unloaded []string + for _, p := range plugins { + m.mu.RLock() + _, loaded := m.plugins[p.ID] + m.mu.RUnlock() + + if loaded { + if err := m.unloadPlugin(p.ID); err != nil { + log.Warn(ctx, "Failed to unload disabled plugin", "plugin", p.ID, err) + } else { + unloaded = append(unloaded, p.ID) + log.Info(ctx, "Unloaded disabled plugin", "plugin", p.ID) + } + } + } + + // Send refresh events for unloaded plugins + if len(unloaded) > 0 { + m.sendPluginRefreshEvent(ctx, unloaded...) + } +} + +// checkPermissionGates validates that all permission-based requirements are met +// before a plugin can be enabled. Returns an error if any gate condition fails. +func (m *Manager) checkPermissionGates(p *model.Plugin) error { + // Parse manifest to check permissions + manifest, err := readManifest(p.Path) + if err != nil { + return fmt.Errorf("reading manifest: %w", err) + } + + // Check users permission gate + if manifest.Permissions != nil && manifest.Permissions.Users != nil { + if !hasValidUsersConfig(p.Users, p.AllUsers) { + return fmt.Errorf("users permission requires configuration: select users or enable 'all users' access") + } + } + + // Check library permission gate + if manifest.Permissions != nil && manifest.Permissions.Library != nil { + if !hasValidLibrariesConfig(p.Libraries, p.AllLibraries) { + return fmt.Errorf("library permission requires configuration: select libraries or enable 'all libraries' access") + } + } + + return nil +} + +// hasValidUsersConfig checks if a plugin has valid users configuration. +// Returns true if allUsers is true, or if usersJSON contains at least one user. +func hasValidUsersConfig(usersJSON string, allUsers bool) bool { + if allUsers { + return true + } + if usersJSON == "" { + return false + } + var users []string + if err := json.Unmarshal([]byte(usersJSON), &users); err != nil { + return false + } + return len(users) > 0 +} + +// hasValidLibrariesConfig checks if a plugin has valid libraries configuration. +// Returns true if allLibraries is true, or if librariesJSON contains at least one library. +func hasValidLibrariesConfig(librariesJSON string, allLibraries bool) bool { + if allLibraries { + return true + } + if librariesJSON == "" { + return false + } + var libraries []int + if err := json.Unmarshal([]byte(librariesJSON), &libraries); err != nil { + return false + } + return len(libraries) > 0 +} diff --git a/plugins/manager_cache.go b/plugins/manager_cache.go new file mode 100644 index 000000000..74b27171f --- /dev/null +++ b/plugins/manager_cache.go @@ -0,0 +1,92 @@ +package plugins + +import ( + "cmp" + "context" + "io/fs" + "os" + "path/filepath" + "slices" + "time" + + "github.com/dustin/go-humanize" + "github.com/navidrome/navidrome/log" +) + +// purgeCacheBySize removes the oldest files in dir until its total size is +// lower than or equal to maxSize. maxSize should be a human-readable string +// like "10MB" or "200K". If parsing fails or maxSize is "0", the function is +// a no-op. +func purgeCacheBySize(ctx context.Context, dir, maxSize string) { + sizeLimit, err := humanize.ParseBytes(maxSize) + if err != nil || sizeLimit == 0 { + return + } + + type fileInfo struct { + path string + size uint64 + mod int64 + } + + var files []fileInfo + var total uint64 + + walk := func(path string, d fs.DirEntry, err error) error { + if err != nil { + log.Trace(ctx, "Failed to access plugin cache entry", "path", path, err) + return nil //nolint:nilerr + } + if d.IsDir() { + return nil + } + info, err := d.Info() + if err != nil { + log.Trace(ctx, "Failed to get file info for plugin cache entry", "path", path, err) + return nil //nolint:nilerr + } + files = append(files, fileInfo{ + path: path, + size: uint64(info.Size()), + mod: info.ModTime().UnixMilli(), + }) + total += uint64(info.Size()) + return nil + } + + if err := filepath.WalkDir(dir, walk); err != nil { + if !os.IsNotExist(err) { + log.Warn(ctx, "Failed to traverse plugin cache directory", "path", dir, err) + } + return + } + + log.Trace(ctx, "Current plugin cache size", "path", dir, "size", humanize.Bytes(total), "sizeLimit", humanize.Bytes(sizeLimit)) + if total <= sizeLimit { + return + } + + log.Debug(ctx, "Purging plugin cache", "path", dir, "sizeLimit", humanize.Bytes(sizeLimit), "currentSize", humanize.Bytes(total)) + slices.SortFunc(files, func(i, j fileInfo) int { return cmp.Compare(i.mod, j.mod) }) + + for _, f := range files { + if total <= sizeLimit { + break + } + if err := os.Remove(f.path); err != nil { + log.Warn(ctx, "Failed to remove plugin cache entry", "path", f.path, "size", humanize.Bytes(f.size), err) + continue + } + total -= f.size + log.Debug(ctx, "Removed plugin cache entry", "path", f.path, "size", humanize.Bytes(f.size), "time", time.UnixMilli(f.mod), "remainingSize", humanize.Bytes(total)) + + // Remove empty parent directories + dirPath := filepath.Dir(f.path) + for dirPath != dir { + if err := os.Remove(dirPath); err != nil { + break + } + dirPath = filepath.Dir(dirPath) + } + } +} diff --git a/plugins/manager_cache_test.go b/plugins/manager_cache_test.go new file mode 100644 index 000000000..3dbfa45ee --- /dev/null +++ b/plugins/manager_cache_test.go @@ -0,0 +1,188 @@ +package plugins + +import ( + "context" + "os" + "path/filepath" + "strconv" + "time" + + "github.com/dustin/go-humanize" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("purgeCacheBySize", func() { + var ( + tmpDir string + ctx context.Context + ) + + BeforeEach(func() { + var err error + ctx = GinkgoT().Context() + tmpDir, err = os.MkdirTemp("", "cache-purge-test-*") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tmpDir) + }) + + createFileWithSize := func(path string, sizeBytes int64, modTime time.Time) { + dir := filepath.Dir(path) + err := os.MkdirAll(dir, 0755) + Expect(err).ToNot(HaveOccurred()) + + f, err := os.Create(path) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + // Write random data to reach desired size + if sizeBytes > 0 { + err = f.Truncate(sizeBytes) + Expect(err).ToNot(HaveOccurred()) + } + + // Set modification time + err = os.Chtimes(path, modTime, modTime) + Expect(err).ToNot(HaveOccurred()) + } + + getDirSize := func(dir string) uint64 { + var total uint64 + err := filepath.WalkDir(dir, func(path string, d os.DirEntry, err error) error { + if err != nil || d.IsDir() { + return nil + } + info, err := d.Info() + if err != nil { + return nil + } + total += uint64(info.Size()) + return nil + }) + Expect(err).ToNot(HaveOccurred()) + return total + } + + Context("when maxSize is invalid or zero", func() { + It("should not remove any files with invalid size", func() { + cacheDir := filepath.Join(tmpDir, "cache") + createFileWithSize(filepath.Join(cacheDir, "file1.bin"), 1000, time.Now()) + createFileWithSize(filepath.Join(cacheDir, "file2.bin"), 1000, time.Now()) + + purgeCacheBySize(ctx, cacheDir, "invalid") + + Expect(getDirSize(cacheDir)).To(Equal(uint64(2000))) + }) + + It("should not remove any files when maxSize is 0", func() { + cacheDir := filepath.Join(tmpDir, "cache") + createFileWithSize(filepath.Join(cacheDir, "file1.bin"), 1000, time.Now()) + createFileWithSize(filepath.Join(cacheDir, "file2.bin"), 1000, time.Now()) + + purgeCacheBySize(ctx, cacheDir, "0") + + Expect(getDirSize(cacheDir)).To(Equal(uint64(2000))) + }) + }) + + Context("when cache directory doesn't exist", func() { + It("should not error", func() { + nonExistentDir := filepath.Join(tmpDir, "nonexistent") + Expect(func() { + purgeCacheBySize(ctx, nonExistentDir, "100MB") + }).ToNot(Panic()) + }) + }) + + Context("when total size is under limit", func() { + It("should not remove any files", func() { + cacheDir := filepath.Join(tmpDir, "cache") + createFileWithSize(filepath.Join(cacheDir, "file1.bin"), 1000, time.Now()) + createFileWithSize(filepath.Join(cacheDir, "file2.bin"), 1000, time.Now()) + + purgeCacheBySize(ctx, cacheDir, "10KB") + + Expect(getDirSize(cacheDir)).To(Equal(uint64(2000))) + }) + }) + + Context("when total size exceeds limit", func() { + It("should remove oldest files first", func() { + cacheDir := filepath.Join(tmpDir, "cache") + now := time.Now() + + // Create files with different ages (1MB each) + oldestFile := filepath.Join(cacheDir, "old.bin") + middleFile := filepath.Join(cacheDir, "middle.bin") + newestFile := filepath.Join(cacheDir, "new.bin") + + createFileWithSize(oldestFile, 1*1024*1024, now.Add(-3*time.Hour)) + createFileWithSize(middleFile, 1*1024*1024, now.Add(-2*time.Hour)) + createFileWithSize(newestFile, 1*1024*1024, now.Add(-1*time.Hour)) + + // Set limit to 2MiB - should remove oldest file + purgeCacheBySize(ctx, cacheDir, "2MiB") + + // Oldest should be removed + _, err := os.Stat(oldestFile) + Expect(os.IsNotExist(err)).To(BeTrue(), "oldest file should be removed") + + // Others should remain + _, err = os.Stat(middleFile) + Expect(err).ToNot(HaveOccurred(), "middle file should remain") + + _, err = os.Stat(newestFile) + Expect(err).ToNot(HaveOccurred(), "newest file should remain") + }) + + It("should remove multiple files to get under limit", func() { + cacheDir := filepath.Join(tmpDir, "cache") + now := time.Now() + + // Create 5 files, 1MiB each (total 5MiB) + for i := range 5 { + path := filepath.Join(cacheDir, filepath.Join("dir", "file"+strconv.Itoa(i)+".bin")) + createFileWithSize(path, 1*1024*1024, now.Add(-time.Duration(5-i)*time.Hour)) + } + + // Set limit to 2.5MiB - should remove oldest 3 files (leaving 2MiB) + purgeCacheBySize(ctx, cacheDir, "2.5MiB") + + finalSize := getDirSize(cacheDir) + limit, _ := humanize.ParseBytes("2.5MiB") + Expect(finalSize).To(BeNumerically("<=", limit)) + }) + + It("should remove empty parent directories after removing files", func() { + cacheDir := filepath.Join(tmpDir, "cache") + now := time.Now() + + // Create files in subdirectories + oldFile := filepath.Join(cacheDir, "subdir1", "old.bin") + newFile := filepath.Join(cacheDir, "subdir2", "new.bin") + + createFileWithSize(oldFile, 2*1024*1024, now.Add(-2*time.Hour)) + createFileWithSize(newFile, 2*1024*1024, now.Add(-1*time.Hour)) + + // Set limit to 2MiB - should remove old file and its parent dir + purgeCacheBySize(ctx, cacheDir, "2MiB") + + // Old file and its parent dir should be removed + _, err := os.Stat(oldFile) + Expect(os.IsNotExist(err)).To(BeTrue()) + + _, err = os.Stat(filepath.Join(cacheDir, "subdir1")) + Expect(os.IsNotExist(err)).To(BeTrue(), "empty parent directory should be removed") + + // New file and its parent dir should remain + _, err = os.Stat(newFile) + Expect(err).ToNot(HaveOccurred()) + + _, err = os.Stat(filepath.Join(cacheDir, "subdir2")) + Expect(err).ToNot(HaveOccurred()) + }) + }) +}) diff --git a/plugins/manager_call.go b/plugins/manager_call.go new file mode 100644 index 000000000..b5c7536b6 --- /dev/null +++ b/plugins/manager_call.go @@ -0,0 +1,124 @@ +package plugins + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "time" + + extism "github.com/extism/go-sdk" + "github.com/navidrome/navidrome/log" +) + +var errFunctionNotFound = errors.New("function not found") +var errNotImplemented = errors.New("function not implemented") + +// notImplementedCode is the standard return code from plugin PDKs +// indicating a function exists but is not implemented by this plugin. +// The plugin returns -2 as int32, which becomes 0xFFFFFFFE as uint32. +const notImplementedCode uint32 = 0xFFFFFFFE + +// callPluginFunctionNoInput is a helper to call a plugin function with no input and output. +func callPluginFunctionNoInput(ctx context.Context, plugin *plugin, funcName string) error { + _, err := callPluginFunction[struct{}, struct{}](ctx, plugin, funcName, struct{}{}) + return err +} + +// callPluginFunctionNoOutput is a helper to call a plugin function with input and no output. +func callPluginFunctionNoOutput[I any](ctx context.Context, plugin *plugin, funcName string, input I) error { + _, err := callPluginFunction[I, struct{}](ctx, plugin, funcName, input) + return err +} + +// callPluginFunction is a helper to call a plugin function with input and output types. +// It handles JSON marshalling/unmarshalling and error checking. +// The context is used for cancellation - if cancelled during the call, the plugin +// instance will be terminated and context.Canceled or context.DeadlineExceeded will be returned. +func callPluginFunction[I any, O any](ctx context.Context, plugin *plugin, funcName string, input I) (O, error) { + start := time.Now() + + var result O + + // Create plugin instance with context for cancellation support + p, err := plugin.instance(ctx) + if err != nil { + return result, fmt.Errorf("failed to create plugin: %w", err) + } + defer p.Close(ctx) + + if !p.FunctionExists(funcName) { + log.Trace(ctx, "Plugin function not found", "plugin", plugin.name, "function", funcName) + return result, fmt.Errorf("%w: %s", errFunctionNotFound, funcName) + } + + inputBytes, err := json.Marshal(input) + if err != nil { + return result, fmt.Errorf("failed to marshal input: %w", err) + } + + startCall := time.Now() + exit, output, err := p.CallWithContext(ctx, funcName, inputBytes) + elapsed := time.Since(startCall) + if err != nil { + // If context was cancelled, return that error instead of the plugin error + if ctx.Err() != nil { + log.Debug(ctx, "Plugin call cancelled", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed) + return result, ctx.Err() + } + plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, false, elapsed.Milliseconds()) + log.Trace(ctx, "Plugin call failed", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed, "navidromeDuration", startCall.Sub(start), err) + return result, fmt.Errorf("plugin call failed: %w", err) + } + if exit != 0 { + if exit == notImplementedCode { + log.Trace(ctx, "Plugin function not implemented", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed, "navidromeDuration", startCall.Sub(start)) + // TODO Should we record metrics for not implemented calls? + //plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, true, elapsed.Milliseconds()) + return result, fmt.Errorf("%w: %s", errNotImplemented, funcName) + } + plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, false, elapsed.Milliseconds()) + return result, fmt.Errorf("plugin call exited with code %d", exit) + } + + if len(output) > 0 { + err = json.Unmarshal(output, &result) + if err != nil { + log.Trace(ctx, "Plugin call failed", "plugin", plugin.name, "function", funcName, "pluginDuration", elapsed, "navidromeDuration", startCall.Sub(start), err) + } + } + + // Record metrics for successful calls (or JSON unmarshal failures) + plugin.metrics.RecordPluginRequest(ctx, plugin.name, funcName, err == nil, elapsed.Milliseconds()) + + log.Trace(ctx, "Plugin call succeeded", "plugin", plugin.name, "function", funcName, "pluginDuration", time.Since(startCall), "navidromeDuration", startCall.Sub(start)) + return result, err +} + +// extismLogger is a helper to log messages from Extism plugins +func extismLogger(pluginName string) func(level extism.LogLevel, msg string) { + return func(level extism.LogLevel, msg string) { + if level == extism.LogLevelOff { + return + } + log.Log(log.ParseLogLevel(level.String()), msg, "plugin", pluginName) + } +} + +// toExtismLogLevel converts a Navidrome log level to an extism LogLevel +func toExtismLogLevel(level log.Level) extism.LogLevel { + switch level { + case log.LevelTrace: + return extism.LogLevelTrace + case log.LevelDebug: + return extism.LogLevelDebug + case log.LevelInfo: + return extism.LogLevelInfo + case log.LevelWarn: + return extism.LogLevelWarn + case log.LevelError, log.LevelFatal: + return extism.LogLevelError + default: + return extism.LogLevelInfo + } +} diff --git a/plugins/manager_call_test.go b/plugins/manager_call_test.go new file mode 100644 index 000000000..3e64f1cee --- /dev/null +++ b/plugins/manager_call_test.go @@ -0,0 +1,146 @@ +//go:build !windows + +package plugins + +import ( + "context" + "sync" + + "github.com/navidrome/navidrome/core/agents" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// mockMetricsRecorder tracks calls to RecordPluginRequest for testing +type mockMetricsRecorder struct { + mu sync.Mutex + calls []metricsCall +} + +type metricsCall struct { + plugin string + method string + ok bool + elapsed int64 +} + +func (m *mockMetricsRecorder) RecordPluginRequest(_ context.Context, plugin, method string, ok bool, elapsed int64) { + m.mu.Lock() + defer m.mu.Unlock() + m.calls = append(m.calls, metricsCall{plugin: plugin, method: method, ok: ok, elapsed: elapsed}) +} + +func (m *mockMetricsRecorder) getCalls() []metricsCall { + m.mu.Lock() + defer m.mu.Unlock() + return append([]metricsCall{}, m.calls...) +} + +func (m *mockMetricsRecorder) reset() { + m.mu.Lock() + defer m.mu.Unlock() + m.calls = nil +} + +var _ = Describe("callPluginFunction metrics", Ordered, func() { + var ( + metricsManager *Manager + metricsRecorder *mockMetricsRecorder + agent agents.Interface + ) + + BeforeAll(func() { + metricsRecorder = &mockMetricsRecorder{} + + // Create a manager with the metrics recorder + metricsManager, _ = createTestManagerWithPluginsAndMetrics( + nil, + metricsRecorder, + "test-metadata-agent"+PackageExtension, + ) + + var ok bool + agent, ok = metricsManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + BeforeEach(func() { + metricsRecorder.reset() + }) + + It("records metrics for successful plugin calls", func() { + retriever := agent.(agents.ArtistBiographyRetriever) + _, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).ToNot(HaveOccurred()) + + calls := metricsRecorder.getCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].plugin).To(Equal("test-metadata-agent")) + Expect(calls[0].method).To(Equal(FuncGetArtistBiography)) + Expect(calls[0].ok).To(BeTrue()) + Expect(calls[0].elapsed).To(BeNumerically(">=", 0)) + }) + + Context("with error config", Ordered, func() { + var ( + errorRecorder *mockMetricsRecorder + errorAgent agents.Interface + ) + + BeforeAll(func() { + errorRecorder = &mockMetricsRecorder{} + errorManager, _ := createTestManagerWithPluginsAndMetrics( + map[string]map[string]string{ + "test-metadata-agent": {"error": "simulated error"}, + }, + errorRecorder, + "test-metadata-agent"+PackageExtension, + ) + + var ok bool + errorAgent, ok = errorManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("records metrics for failed plugin calls (error returned)", func() { + retriever := errorAgent.(agents.ArtistBiographyRetriever) + _, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).To(HaveOccurred()) + + calls := errorRecorder.getCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].plugin).To(Equal("test-metadata-agent")) + Expect(calls[0].method).To(Equal(FuncGetArtistBiography)) + Expect(calls[0].ok).To(BeFalse()) + }) + }) + + Context("with partial metadata agent", Ordered, func() { + var ( + partialRecorder *mockMetricsRecorder + partialAgent agents.Interface + ) + + BeforeAll(func() { + partialRecorder = &mockMetricsRecorder{} + partialManager, _ := createTestManagerWithPluginsAndMetrics( + nil, + partialRecorder, + "partial-metadata-agent"+PackageExtension, + ) + + var ok bool + partialAgent, ok = partialManager.LoadMediaAgent("partial-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("does not record metrics for not-implemented functions", func() { + retriever := partialAgent.(agents.ArtistMBIDRetriever) + _, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "Test Artist") + Expect(err).To(MatchError(errNotImplemented)) + + calls := partialRecorder.getCalls() + Expect(calls).To(HaveLen(0)) + }) + }) +}) diff --git a/plugins/manager_loader.go b/plugins/manager_loader.go new file mode 100644 index 000000000..ccda9e4cb --- /dev/null +++ b/plugins/manager_loader.go @@ -0,0 +1,451 @@ +package plugins + +import ( + "context" + "encoding/json" + "fmt" + "io" + "time" + + extism "github.com/extism/go-sdk" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/host" + "github.com/navidrome/navidrome/scheduler" + "github.com/tetratelabs/wazero" + "github.com/tetratelabs/wazero/api" + "github.com/tetratelabs/wazero/experimental" + "golang.org/x/sync/errgroup" +) + +// serviceContext provides dependencies needed by host service factories. +type serviceContext struct { + pluginName string + manager *Manager + permissions *Permissions + config map[string]string + allowedUsers []string // User IDs this plugin can access + allUsers bool // If true, plugin can access all users + allowedLibraries []int // Library IDs this plugin can access + allLibraries bool // If true, plugin can access all libraries +} + +// hostServiceEntry defines a host service for table-driven registration. +type hostServiceEntry struct { + name string + hasPermission func(*Permissions) bool + create func(*serviceContext) ([]extism.HostFunction, io.Closer) +} + +// hostServices defines all available host services. +// Adding a new host service only requires adding an entry here. +var hostServices = []hostServiceEntry{ + { + name: "Config", + hasPermission: func(p *Permissions) bool { return true }, // Always available, no permission required + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newConfigService(ctx.pluginName, ctx.config) + return host.RegisterConfigHostFunctions(service), nil + }, + }, + { + name: "SubsonicAPI", + hasPermission: func(p *Permissions) bool { return p != nil && p.Subsonicapi != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newSubsonicAPIService(ctx.pluginName, ctx.manager.subsonicRouter, ctx.manager.ds, ctx.allowedUsers, ctx.allUsers) + return host.RegisterSubsonicAPIHostFunctions(service), nil + }, + }, + { + name: "Scheduler", + hasPermission: func(p *Permissions) bool { return p != nil && p.Scheduler != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newSchedulerService(ctx.pluginName, ctx.manager, scheduler.GetInstance()) + return host.RegisterSchedulerHostFunctions(service), service + }, + }, + { + name: "WebSocket", + hasPermission: func(p *Permissions) bool { return p != nil && p.Websocket != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Websocket + service := newWebSocketService(ctx.pluginName, ctx.manager, perm) + return host.RegisterWebSocketHostFunctions(service), service + }, + }, + { + name: "Artwork", + hasPermission: func(p *Permissions) bool { return p != nil && p.Artwork != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newArtworkService() + return host.RegisterArtworkHostFunctions(service), nil + }, + }, + { + name: "Cache", + hasPermission: func(p *Permissions) bool { return p != nil && p.Cache != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newCacheService(ctx.pluginName) + return host.RegisterCacheHostFunctions(service), service + }, + }, + { + name: "Library", + hasPermission: func(p *Permissions) bool { return p != nil && p.Library != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Library + service := newLibraryService(ctx.manager.ds, perm, ctx.allowedLibraries, ctx.allLibraries) + return host.RegisterLibraryHostFunctions(service), nil + }, + }, + { + name: "KVStore", + hasPermission: func(p *Permissions) bool { return p != nil && p.Kvstore != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Kvstore + service, err := newKVStoreService(ctx.manager.ctx, ctx.pluginName, perm) + if err != nil { + log.Error("Failed to create KVStore service", "plugin", ctx.pluginName, err) + return nil, nil + } + return host.RegisterKVStoreHostFunctions(service), service + }, + }, + { + name: "Users", + hasPermission: func(p *Permissions) bool { return p != nil && p.Users != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + service := newUsersService(ctx.manager.ds, ctx.allowedUsers, ctx.allUsers) + return host.RegisterUsersHostFunctions(service), nil + }, + }, + { + name: "HTTP", + hasPermission: func(p *Permissions) bool { return p != nil && p.Http != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Http + service := newHTTPService(ctx.pluginName, perm) + return host.RegisterHTTPHostFunctions(service), nil + }, + }, + { + name: "Task", + hasPermission: func(p *Permissions) bool { return p != nil && p.Taskqueue != nil }, + create: func(ctx *serviceContext) ([]extism.HostFunction, io.Closer) { + perm := ctx.permissions.Taskqueue + maxConcurrency := int32(1) + if perm.MaxConcurrency > 0 { + maxConcurrency = int32(perm.MaxConcurrency) + } + service, err := newTaskQueueService(ctx.pluginName, ctx.manager, maxConcurrency) + if err != nil { + log.Error("Failed to create Task service", "plugin", ctx.pluginName, err) + return nil, nil + } + return host.RegisterTaskHostFunctions(service), service + }, + }, +} + +// extractManifest reads manifest from an .ndp package and computes its SHA-256 hash. +// This is a lightweight operation used for plugin discovery and change detection. +// Unlike the old implementation, this does NOT compile the wasm - just reads the manifest JSON. +func (m *Manager) extractManifest(ndpPath string) (*PluginMetadata, error) { + if m.stopped.Load() { + return nil, fmt.Errorf("manager is stopped") + } + + manifest, err := readManifest(ndpPath) + if err != nil { + return nil, err + } + + sha256Hash, err := computeFileSHA256(ndpPath) + if err != nil { + return nil, fmt.Errorf("computing hash: %w", err) + } + + return &PluginMetadata{ + Manifest: manifest, + SHA256: sha256Hash, + }, nil +} + +// loadEnabledPlugins loads all enabled plugins from the database. +func (m *Manager) loadEnabledPlugins(ctx context.Context) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + repo := m.ds.Plugin(adminCtx) + + plugins, err := repo.GetAll() + if err != nil { + return fmt.Errorf("reading plugins from DB: %w", err) + } + + g := errgroup.Group{} + g.SetLimit(maxPluginLoadConcurrency) + + for _, p := range plugins { + if !p.Enabled { + continue + } + + plugin := p // Capture for goroutine + g.Go(func() error { + start := time.Now() + log.Debug(ctx, "Loading enabled plugin", "plugin", plugin.ID, "path", plugin.Path) + + // Panic recovery + defer func() { + if r := recover(); r != nil { + log.Error(ctx, "Panic while loading plugin", "plugin", plugin.ID, "panic", r) + } + }() + + if err := m.loadPluginWithConfig(&plugin); err != nil { + // Store error in DB + plugin.LastError = err.Error() + plugin.Enabled = false + plugin.UpdatedAt = time.Now() + if putErr := repo.Put(&plugin); putErr != nil { + log.Error(ctx, "Failed to update plugin error in DB", "plugin", plugin.ID, putErr) + } + log.Error(ctx, "Failed to load plugin", "plugin", plugin.ID, err) + return nil + } + + // Clear any previous error + if plugin.LastError != "" { + plugin.LastError = "" + plugin.UpdatedAt = time.Now() + if putErr := repo.Put(&plugin); putErr != nil { + log.Error(ctx, "Failed to clear plugin error in DB", "plugin", plugin.ID, putErr) + } + } + + m.mu.RLock() + loadedPlugin := m.plugins[plugin.ID] + m.mu.RUnlock() + if loadedPlugin != nil { + log.Info(ctx, "Loaded plugin", "plugin", plugin.ID, "manifest", loadedPlugin.manifest.Name, + "capabilities", loadedPlugin.capabilities, "duration", time.Since(start)) + } + return nil + }) + } + + return g.Wait() +} + +// loadPluginWithConfig loads a plugin with configuration from DB. +// The p.Path should point to an .ndp package file. +func (m *Manager) loadPluginWithConfig(p *model.Plugin) error { + ctx := log.NewContext(m.ctx, "plugin", p.ID) + + if m.stopped.Load() { + return fmt.Errorf("manager is stopped") + } + + // Track this operation + m.loadWg.Add(1) + defer m.loadWg.Done() + + if m.stopped.Load() { + return fmt.Errorf("manager is stopped") + } + + // Parse config from JSON + pluginConfig, err := parsePluginConfig(p.Config) + if err != nil { + return err + } + + // Parse users from JSON + var allowedUsers []string + if p.Users != "" { + if err := json.Unmarshal([]byte(p.Users), &allowedUsers); err != nil { + return fmt.Errorf("parsing plugin users: %w", err) + } + } + + // Parse libraries from JSON + var allowedLibraries []int + if p.Libraries != "" { + if err := json.Unmarshal([]byte(p.Libraries), &allowedLibraries); err != nil { + return fmt.Errorf("parsing plugin libraries: %w", err) + } + } + + // Open the .ndp package to get manifest and wasm bytes + pkg, err := openPackage(p.Path) + if err != nil { + return fmt.Errorf("opening package: %w", err) + } + + // Build extism manifest + pluginManifest := extism.Manifest{ + Wasm: []extism.Wasm{ + extism.WasmData{Data: pkg.WasmBytes, Name: "main"}, + }, + Config: pluginConfig, + Timeout: uint64(defaultTimeout.Milliseconds()), + } + + if pkg.Manifest.Permissions != nil && pkg.Manifest.Permissions.Http != nil { + if hosts := pkg.Manifest.Permissions.Http.RequiredHosts; len(hosts) > 0 { + pluginManifest.AllowedHosts = hosts + } + } + + // Configure filesystem access for library permission + if pkg.Manifest.HasLibraryFilesystemPermission() { + adminCtx := adminContext(ctx) + libraries, err := m.ds.Library(adminCtx).GetAll() + if err != nil { + return fmt.Errorf("failed to get libraries for filesystem access: %w", err) + } + + allowedPaths := buildAllowedPaths(ctx, libraries, allowedLibraries, p.AllLibraries, p.AllowWriteAccess) + pluginManifest.AllowedPaths = allowedPaths + } + + // Build host functions based on permissions from manifest + var hostFunctions []extism.HostFunction + var closers []io.Closer + + svcCtx := &serviceContext{ + pluginName: p.ID, + manager: m, + permissions: pkg.Manifest.Permissions, + config: pluginConfig, + allowedUsers: allowedUsers, + allUsers: p.AllUsers, + allowedLibraries: allowedLibraries, + allLibraries: p.AllLibraries, + } + for _, entry := range hostServices { + if entry.hasPermission(pkg.Manifest.Permissions) { + funcs, closer := entry.create(svcCtx) + hostFunctions = append(hostFunctions, funcs...) + if closer != nil { + closers = append(closers, closer) + } + } + } + + // Compile the plugin with all host functions + runtimeConfig := wazero.NewRuntimeConfig(). + WithCompilationCache(m.cache). + WithCloseOnContextDone(true) + + // Enable experimental threads if requested in manifest + if pkg.Manifest.HasExperimentalThreads() { + runtimeConfig = runtimeConfig.WithCoreFeatures(api.CoreFeaturesV2 | experimental.CoreFeaturesThreads) + log.Debug(ctx, "Enabling experimental threads support") + } + + extismConfig := extism.PluginConfig{ + EnableWasi: true, + RuntimeConfig: runtimeConfig, + EnableHttpResponseHeaders: true, + } + compiled, err := extism.NewCompiledPlugin(ctx, pluginManifest, extismConfig, hostFunctions) + if err != nil { + return fmt.Errorf("compiling plugin: %w", err) + } + + // Create instance to detect capabilities + instance, err := compiled.Instance(ctx, extism.PluginInstanceConfig{}) + if err != nil { + compiled.Close(ctx) + return fmt.Errorf("creating instance: %w", err) + } + instance.SetLogger(extismLogger(p.ID)) + capabilities := detectCapabilities(instance) + instance.Close(ctx) + + // Validate manifest against detected capabilities + if err := ValidateWithCapabilities(pkg.Manifest, capabilities); err != nil { + compiled.Close(ctx) + return fmt.Errorf("manifest validation: %w", err) + } + + m.mu.Lock() + m.plugins[p.ID] = &plugin{ + name: p.ID, + path: p.Path, + manifest: pkg.Manifest, + compiled: compiled, + capabilities: capabilities, + closers: closers, + metrics: m.metrics, + allowedUserIDs: allowedUsers, + allUsers: p.AllUsers, + libraries: newLibraryAccess(allowedLibraries, p.AllLibraries), + } + m.mu.Unlock() + + // Call plugin init function + callPluginInit(ctx, m.plugins[p.ID]) + + return nil +} + +// parsePluginConfig parses a JSON config string into a map of string values. +// For Extism, all config values must be strings, so non-string values are serialized as JSON. +func parsePluginConfig(configJSON string) (map[string]string, error) { + if configJSON == "" { + return nil, nil + } + var rawConfig map[string]any + if err := json.Unmarshal([]byte(configJSON), &rawConfig); err != nil { + return nil, fmt.Errorf("parsing plugin config: %w", err) + } + pluginConfig := make(map[string]string) + for key, value := range rawConfig { + switch v := value.(type) { + case string: + pluginConfig[key] = v + default: + // Serialize non-string values as JSON + jsonBytes, err := json.Marshal(v) + if err != nil { + return nil, fmt.Errorf("serializing config value %q: %w", key, err) + } + pluginConfig[key] = string(jsonBytes) + } + } + return pluginConfig, nil +} + +// buildAllowedPaths constructs the extism AllowedPaths map for filesystem access. +// When allowWriteAccess is false (default), paths are prefixed with "ro:" for read-only. +// Only libraries that match the allowed set (or all libraries if allLibraries is true) are included. +func buildAllowedPaths(ctx context.Context, libraries model.Libraries, allowedLibraryIDs []int, allLibraries, allowWriteAccess bool) map[string]string { + allowedLibrarySet := make(map[int]struct{}, len(allowedLibraryIDs)) + for _, id := range allowedLibraryIDs { + allowedLibrarySet[id] = struct{}{} + } + allowedPaths := make(map[string]string) + for _, lib := range libraries { + _, allowed := allowedLibrarySet[lib.ID] + if allLibraries || allowed { + mountPoint := toPluginMountPoint(int32(lib.ID)) + hostPath := lib.Path + if !allowWriteAccess { + hostPath = "ro:" + hostPath + } + allowedPaths[hostPath] = mountPoint + log.Trace(ctx, "Added library to allowed paths", "libraryID", lib.ID, "mountPoint", mountPoint, "writeAccess", allowWriteAccess, "hostPath", hostPath) + } + } + if allowWriteAccess { + log.Info(ctx, "Granting read-write filesystem access to libraries", "libraryCount", len(allowedPaths), "allLibraries", allLibraries) + } else { + log.Debug(ctx, "Granting read-only filesystem access to libraries", "libraryCount", len(allowedPaths), "allLibraries", allLibraries) + } + return allowedPaths +} diff --git a/plugins/manager_loader_test.go b/plugins/manager_loader_test.go new file mode 100644 index 000000000..cc07f0611 --- /dev/null +++ b/plugins/manager_loader_test.go @@ -0,0 +1,122 @@ +package plugins + +import ( + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("parsePluginConfig", func() { + It("returns nil for empty string", func() { + result, err := parsePluginConfig("") + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeNil()) + }) + + It("serializes object values as JSON strings", func() { + result, err := parsePluginConfig(`{"settings": {"enabled": true, "count": 5}}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result["settings"]).To(Equal(`{"count":5,"enabled":true}`)) + }) + + It("handles mixed value types", func() { + result, err := parsePluginConfig(`{"api_key": "secret", "timeout": 30, "rate": 1.5, "enabled": true, "tags": ["a", "b"]}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(5)) + Expect(result["api_key"]).To(Equal("secret")) + Expect(result["timeout"]).To(Equal("30")) + Expect(result["rate"]).To(Equal("1.5")) + Expect(result["enabled"]).To(Equal("true")) + Expect(result["tags"]).To(Equal(`["a","b"]`)) + }) + + It("returns error for invalid JSON", func() { + _, err := parsePluginConfig(`{invalid json}`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("parsing plugin config")) + }) + + It("returns error for non-object JSON", func() { + _, err := parsePluginConfig(`["array", "not", "object"]`) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("parsing plugin config")) + }) + + It("handles null values", func() { + result, err := parsePluginConfig(`{"key": null}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(1)) + Expect(result["key"]).To(Equal("null")) + }) + + It("handles empty object", func() { + result, err := parsePluginConfig(`{}`) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(HaveLen(0)) + Expect(result).ToNot(BeNil()) + }) +}) + +var _ = Describe("buildAllowedPaths", func() { + var libraries model.Libraries + + BeforeEach(func() { + libraries = model.Libraries{ + {ID: 1, Path: "/music/library1"}, + {ID: 2, Path: "/music/library2"}, + {ID: 3, Path: "/music/library3"}, + } + }) + + Context("read-only (default)", func() { + It("mounts all libraries with ro: prefix when allLibraries is true", func() { + result := buildAllowedPaths(nil, libraries, nil, true, false) + Expect(result).To(HaveLen(3)) + Expect(result).To(HaveKeyWithValue("ro:/music/library1", "/libraries/1")) + Expect(result).To(HaveKeyWithValue("ro:/music/library2", "/libraries/2")) + Expect(result).To(HaveKeyWithValue("ro:/music/library3", "/libraries/3")) + }) + + It("mounts only selected libraries with ro: prefix", func() { + result := buildAllowedPaths(nil, libraries, []int{1, 3}, false, false) + Expect(result).To(HaveLen(2)) + Expect(result).To(HaveKeyWithValue("ro:/music/library1", "/libraries/1")) + Expect(result).To(HaveKeyWithValue("ro:/music/library3", "/libraries/3")) + Expect(result).ToNot(HaveKey("ro:/music/library2")) + }) + }) + + Context("read-write (allowWriteAccess=true)", func() { + It("mounts all libraries without ro: prefix when allLibraries is true", func() { + result := buildAllowedPaths(nil, libraries, nil, true, true) + Expect(result).To(HaveLen(3)) + Expect(result).To(HaveKeyWithValue("/music/library1", "/libraries/1")) + Expect(result).To(HaveKeyWithValue("/music/library2", "/libraries/2")) + Expect(result).To(HaveKeyWithValue("/music/library3", "/libraries/3")) + }) + + It("mounts only selected libraries without ro: prefix", func() { + result := buildAllowedPaths(nil, libraries, []int{2}, false, true) + Expect(result).To(HaveLen(1)) + Expect(result).To(HaveKeyWithValue("/music/library2", "/libraries/2")) + }) + }) + + Context("edge cases", func() { + It("returns empty map when no libraries match", func() { + result := buildAllowedPaths(nil, libraries, []int{99}, false, false) + Expect(result).To(BeEmpty()) + }) + + It("returns empty map when libraries list is empty", func() { + result := buildAllowedPaths(nil, nil, []int{1}, false, false) + Expect(result).To(BeEmpty()) + }) + + It("returns empty map when allLibraries is false and no IDs provided", func() { + result := buildAllowedPaths(nil, libraries, nil, false, false) + Expect(result).To(BeEmpty()) + }) + }) +}) diff --git a/plugins/manager_plugin.go b/plugins/manager_plugin.go new file mode 100644 index 000000000..1d4a8c301 --- /dev/null +++ b/plugins/manager_plugin.go @@ -0,0 +1,77 @@ +package plugins + +import ( + "context" + "crypto/rand" + "errors" + "io" + + extism "github.com/extism/go-sdk" + "github.com/tetratelabs/wazero" +) + +// plugin represents a loaded plugin +type plugin struct { + name string // Plugin name (from filename) + path string // Path to the wasm file + manifest *Manifest + compiled *extism.CompiledPlugin + capabilities []Capability // Auto-detected capabilities based on exported functions + closers []io.Closer // Cleanup functions to call on unload + metrics PluginMetricsRecorder + allowedUserIDs []string // User IDs this plugin can access (from DB configuration) + allUsers bool // If true, plugin can access all users + libraries libraryAccess +} + +// instance creates a new plugin instance for the given context. +// The context is used for cancellation - if cancelled during a call, +// the module will be terminated and the instance becomes unusable. +func (p *plugin) instance(ctx context.Context) (*extism.Plugin, error) { + instance, err := p.compiled.Instance(ctx, extism.PluginInstanceConfig{ + ModuleConfig: wazero.NewModuleConfig().WithSysWalltime().WithRandSource(rand.Reader), + }) + if err != nil { + return nil, err + } + instance.SetLogger(extismLogger(p.name)) + return instance, nil +} + +func (p *plugin) Close() error { + var errs []error + for _, f := range p.closers { + err := f.Close() + if err != nil { + errs = append(errs, err) + } + } + return errors.Join(errs...) +} + +func (p *plugin) hasLibraryFilesystemAccess(libID int) bool { + return p.manifest.HasLibraryFilesystemPermission() && p.libraries.contains(libID) +} + +// libraryAccess captures the set of libraries a plugin is permitted to see, +// precomputed at load time for O(1) lookup. +type libraryAccess struct { + allLibraries bool + libraryIDSet map[int]struct{} +} + +func newLibraryAccess(allowedLibraryIDs []int, allLibraries bool) libraryAccess { + set := make(map[int]struct{}, len(allowedLibraryIDs)) + for _, id := range allowedLibraryIDs { + set[id] = struct{}{} + } + return libraryAccess{allLibraries: allLibraries, libraryIDSet: set} +} + +func (a libraryAccess) contains(libID int) bool { + if a.allLibraries { + return true + } + _, ok := a.libraryIDSet[libID] + return ok +} diff --git a/plugins/manager_plugin_test.go b/plugins/manager_plugin_test.go new file mode 100644 index 000000000..513b8cb8e --- /dev/null +++ b/plugins/manager_plugin_test.go @@ -0,0 +1,34 @@ +package plugins + +import ( + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("plugin", func() { + Describe("hasLibraryFilesystemAccess", func() { + fsManifest := &Manifest{ + Permissions: &Permissions{ + Library: &LibraryPermission{Filesystem: true}, + }, + } + + It("returns false when the manifest does not grant filesystem permission", func() { + p := &plugin{manifest: &Manifest{}, libraries: newLibraryAccess(nil, true)} + Expect(p.hasLibraryFilesystemAccess(1)).To(BeFalse()) + }) + + It("returns true for any library when allLibraries is set", func() { + p := &plugin{manifest: fsManifest, libraries: newLibraryAccess(nil, true)} + Expect(p.hasLibraryFilesystemAccess(1)).To(BeTrue()) + Expect(p.hasLibraryFilesystemAccess(42)).To(BeTrue()) + }) + + It("returns true only for libraries in the allowed list", func() { + p := &plugin{manifest: fsManifest, libraries: newLibraryAccess([]int{1, 3}, false)} + Expect(p.hasLibraryFilesystemAccess(1)).To(BeTrue()) + Expect(p.hasLibraryFilesystemAccess(3)).To(BeTrue()) + Expect(p.hasLibraryFilesystemAccess(2)).To(BeFalse()) + }) + }) +}) diff --git a/plugins/manager_sync.go b/plugins/manager_sync.go new file mode 100644 index 000000000..f97069e74 --- /dev/null +++ b/plugins/manager_sync.go @@ -0,0 +1,234 @@ +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "fmt" + "io" + "os" + "path/filepath" + "strings" + "time" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/events" +) + +// PluginMetadata holds the extracted information from a plugin file +// without fully initializing the plugin. +type PluginMetadata struct { + Manifest *Manifest + SHA256 string +} + +// adminContext returns a context with admin privileges for DB operations. +func adminContext(ctx context.Context) context.Context { + return request.WithUser(ctx, model.User{IsAdmin: true}) +} + +// marshalManifest marshals a manifest to JSON string, returning empty string on error. +func marshalManifest(m *Manifest) string { + b, _ := json.Marshal(m) + return string(b) +} + +// computeFileSHA256 computes the SHA-256 hash of a file without loading it into memory. +// This is used for quick change detection before full plugin compilation. +func computeFileSHA256(path string) (string, error) { + f, err := os.Open(path) + if err != nil { + return "", err + } + defer f.Close() + + h := sha256.New() + if _, err := io.Copy(h, f); err != nil { + return "", err + } + return hex.EncodeToString(h.Sum(nil)), nil +} + +// addPluginToDB adds a new plugin to the database as disabled. +func (m *Manager) addPluginToDB(ctx context.Context, repo model.PluginRepository, name, path string, metadata *PluginMetadata) error { + now := time.Now() + newPlugin := &model.Plugin{ + ID: name, + Path: path, + Manifest: marshalManifest(metadata.Manifest), + SHA256: metadata.SHA256, + Enabled: false, + CreatedAt: now, + UpdatedAt: now, + } + if err := repo.Put(newPlugin); err != nil { + return fmt.Errorf("adding plugin to DB: %w", err) + } + log.Info(ctx, "Discovered new plugin", "plugin", name) + m.sendPluginRefreshEvent(ctx, events.Any) + return nil +} + +// updatePluginInDB updates an existing plugin in the database after a file change. +// If the plugin was enabled, it will be unloaded and disabled. +func (m *Manager) updatePluginInDB(ctx context.Context, repo model.PluginRepository, dbPlugin *model.Plugin, path string, metadata *PluginMetadata) error { + wasEnabled := dbPlugin.Enabled + if wasEnabled { + if err := m.unloadPlugin(dbPlugin.ID); err != nil { + log.Debug(ctx, "Plugin not loaded during change", "plugin", dbPlugin.ID, err) + } + } + dbPlugin.Path = path + dbPlugin.Manifest = marshalManifest(metadata.Manifest) + dbPlugin.SHA256 = metadata.SHA256 + dbPlugin.Enabled = false + dbPlugin.LastError = "" + dbPlugin.UpdatedAt = time.Now() + if err := repo.Put(dbPlugin); err != nil { + return fmt.Errorf("updating plugin in DB: %w", err) + } + log.Info(ctx, "Plugin file changed", "plugin", dbPlugin.ID, "wasEnabled", wasEnabled) + m.sendPluginRefreshEvent(ctx, dbPlugin.ID) + return nil +} + +// removePluginFromDB removes a plugin from the database. +// If the plugin was enabled, it will be unloaded first. +func (m *Manager) removePluginFromDB(ctx context.Context, repo model.PluginRepository, dbPlugin *model.Plugin) error { + pluginID := dbPlugin.ID + if dbPlugin.Enabled { + if err := m.unloadPlugin(pluginID); err != nil { + log.Debug(ctx, "Plugin not loaded during removal", "plugin", pluginID, err) + } + } + if err := repo.Delete(pluginID); err != nil { + return fmt.Errorf("deleting plugin from DB: %w", err) + } + log.Info(ctx, "Plugin removed", "plugin", pluginID) + m.sendPluginRefreshEvent(ctx, events.Any) + return nil +} + +// syncPlugins scans the plugins folder and synchronizes with the database. +// It handles new, changed, and removed plugins by comparing SHA-256 hashes. +// - New plugins are added to DB as disabled +// - Changed plugins are updated in DB and disabled if they were enabled +// - Removed plugins are deleted from DB (after unloading if enabled) +func (m *Manager) syncPlugins(ctx context.Context, folder string) error { + if m.ds == nil { + return fmt.Errorf("datastore not configured") + } + + adminCtx := adminContext(ctx) + + // Read current plugins from folder + entries, err := os.ReadDir(folder) + if err != nil { + if os.IsNotExist(err) { + log.Debug(ctx, "Plugins folder does not exist", "folder", folder) + return nil + } + return fmt.Errorf("reading plugins folder: %w", err) + } + + // Build map of files in folder + filesOnDisk := make(map[string]string) // name -> path + for _, entry := range entries { + if entry.IsDir() || !strings.HasSuffix(entry.Name(), PackageExtension) { + log.Trace(ctx, "Skipping non-plugin entry", "name", entry.Name(), "isDir", entry.IsDir()) + continue + } + name := strings.TrimSuffix(entry.Name(), PackageExtension) + filesOnDisk[name] = filepath.Join(folder, entry.Name()) + } + log.Debug(ctx, "Plugin sync: scanned folder", "folder", folder, "entriesTotal", len(entries), "pluginsFound", len(filesOnDisk)) + + // Get all plugins from DB + repo := m.ds.Plugin(adminCtx) + dbPlugins, err := repo.GetAll() + if err != nil { + return fmt.Errorf("reading plugins from DB: %w", err) + } + pluginsInDB := make(map[string]*model.Plugin) + for i := range dbPlugins { + pluginsInDB[dbPlugins[i].ID] = &dbPlugins[i] + } + log.Debug(ctx, "Plugin sync: current DB state", "pluginsInDB", len(pluginsInDB)) + + now := time.Now() + + // Process files on disk + for name, path := range filesOnDisk { + dbPlugin, exists := pluginsInDB[name] + + // Compute SHA256 first (lightweight operation) to check if plugin changed + sha256Hash, err := computeFileSHA256(path) + if err != nil { + log.Error(ctx, "Failed to compute SHA256 for plugin", "plugin", name, "path", path, err) + continue + } + + // If plugin exists in DB with same hash, skip full manifest extraction + if exists && dbPlugin.SHA256 == sha256Hash { + // Plugin unchanged - just update path in case folder moved + if dbPlugin.Path != path { + dbPlugin.Path = path + dbPlugin.UpdatedAt = now + if err := repo.Put(dbPlugin); err != nil { + log.Error(ctx, "Failed to update plugin path in DB", "plugin", name, err) + } + } + delete(pluginsInDB, name) + continue + } + + // Plugin is new or changed - need full manifest extraction + metadata, err := m.extractManifest(path) + if err != nil { + log.Error(ctx, "Failed to extract manifest from plugin", "plugin", name, "path", path, err) + // Store error in DB if plugin exists + if exists { + dbPlugin.LastError = err.Error() + dbPlugin.UpdatedAt = now + if dbPlugin.Enabled { + // Unload broken plugin + if unloadErr := m.unloadPlugin(name); unloadErr != nil { + log.Debug(ctx, "Plugin not loaded", "plugin", name) + } + dbPlugin.Enabled = false + } + if putErr := repo.Put(dbPlugin); putErr != nil { + log.Error(ctx, "Failed to update plugin in DB", "plugin", name, err) + } + } + delete(pluginsInDB, name) + continue + } + + if !exists { + // New plugin - add to DB as disabled + if err := m.addPluginToDB(ctx, repo, name, path, metadata); err != nil { + log.Error(ctx, "Failed to add plugin to DB", "plugin", name, err) + } + } else { + // Plugin changed - update DB + if err := m.updatePluginInDB(ctx, repo, dbPlugin, path, metadata); err != nil { + log.Error(ctx, "Failed to update plugin in DB", "plugin", name, err) + } + } + // Mark as processed + delete(pluginsInDB, name) + } + + // Remove plugins no longer on disk + for _, dbPlugin := range pluginsInDB { + if err := m.removePluginFromDB(ctx, repo, dbPlugin); err != nil { + log.Error(ctx, "Failed to delete plugin from DB", "plugin", dbPlugin.ID, err) + } + } + + return nil +} diff --git a/plugins/manager_test.go b/plugins/manager_test.go new file mode 100644 index 000000000..9b6f7ea39 --- /dev/null +++ b/plugins/manager_test.go @@ -0,0 +1,198 @@ +//go:build !windows + +package plugins + +import ( + "context" + "fmt" + "net/http" + "sync" + + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/server/events" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Manager", Ordered, func() { + var ctx context.Context + + BeforeAll(func() { + ctx = GinkgoT().Context() + }) + + Describe("Plugin Loading", func() { + It("loads enabled plugins from DB on Start", func() { + // Plugin is already loaded by testManager.Start() via loadEnabledPlugins + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).To(ContainElement("test-metadata-agent")) + }) + }) + + Describe("unloadPlugin", func() { + It("removes a loaded plugin", func() { + // Plugin is already loaded from Start + err := testManager.unloadPlugin("test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).ToNot(ContainElement("test-metadata-agent")) + }) + + It("returns error when plugin not found", func() { + err := testManager.unloadPlugin("nonexistent") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not found")) + }) + }) + + Describe("EnablePlugin", func() { + It("enables and loads a disabled plugin", func() { + // First disable the plugin (which also unloads it) + err := testManager.DisablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(testManager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) + + // Enable it + err = testManager.EnablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).To(ContainElement("test-metadata-agent")) + }) + }) + + Describe("DisablePlugin", func() { + It("disables and unloads an enabled plugin", func() { + // Ensure the plugin is loaded first + _ = testManager.EnablePlugin(ctx, "test-metadata-agent") + + err := testManager.DisablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + + names := testManager.PluginNames(string(CapabilityMetadataAgent)) + Expect(names).ToNot(ContainElement("test-metadata-agent")) + }) + }) + + Describe("GetPluginInfo", func() { + BeforeEach(func() { + // Ensure plugin is loaded for this test + _ = testManager.EnablePlugin(ctx, "test-metadata-agent") + }) + + It("returns information about all loaded plugins", func() { + info := testManager.GetPluginInfo() + Expect(info).To(HaveKey("test-metadata-agent")) + Expect(info["test-metadata-agent"].Name).To(Equal("Test Plugin")) + Expect(info["test-metadata-agent"].Version).To(Equal("1.0.0")) + }) + }) + + It("can call the plugin concurrently", func() { + // Ensure plugin is loaded + _ = testManager.EnablePlugin(ctx, "test-metadata-agent") + + const concurrency = 30 + errs := make(chan error, concurrency) + bios := make(chan string, concurrency) + + g := sync.WaitGroup{} + g.Add(concurrency) + for i := range concurrency { + go func(i int) { + defer g.Done() + a, ok := testManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + agent := a.(agents.ArtistBiographyRetriever) + bio, err := agent.GetArtistBiography(ctx, fmt.Sprintf("artist-%d", i), fmt.Sprintf("Artist %d", i), "") + if err != nil { + errs <- err + return + } + bios <- bio + }(i) + } + g.Wait() + + // Collect results + for range concurrency { + select { + case err := <-errs: + Expect(err).ToNot(HaveOccurred()) + case bio := <-bios: + Expect(bio).To(ContainSubstring("Biography for Artist")) + } + } + }) + + Describe("sendPluginRefreshEvent", func() { + var broker *testBroker + var manager *Manager + + BeforeEach(func() { + broker = &testBroker{} + manager = &Manager{ + broker: broker, + } + }) + + It("sends refresh event with single plugin ID", func() { + manager.sendPluginRefreshEvent(ctx, "test-plugin") + + Expect(broker.broadcastCalled).To(BeTrue()) + Expect(broker.lastEvent).ToNot(BeNil()) + Expect(broker.lastEventCtx).To(Equal(ctx)) + + refreshEvent, ok := broker.lastEvent.(*events.RefreshResource) + Expect(ok).To(BeTrue(), "event should be a RefreshResource") + Expect(refreshEvent.Data(refreshEvent)).To(Equal(`{"plugin":["test-plugin"]}`)) + }) + + It("sends refresh event with multiple plugin IDs", func() { + manager.sendPluginRefreshEvent(ctx, "plugin-1", "plugin-2", "plugin-3") + + Expect(broker.broadcastCalled).To(BeTrue()) + refreshEvent, ok := broker.lastEvent.(*events.RefreshResource) + Expect(ok).To(BeTrue()) + Expect(refreshEvent.Data(refreshEvent)).To(Equal(`{"plugin":["plugin-1","plugin-2","plugin-3"]}`)) + }) + + It("sends refresh event with wildcard when using events.Any", func() { + manager.sendPluginRefreshEvent(ctx, events.Any) + + Expect(broker.broadcastCalled).To(BeTrue()) + refreshEvent, ok := broker.lastEvent.(*events.RefreshResource) + Expect(ok).To(BeTrue()) + Expect(refreshEvent.Data(refreshEvent)).To(Equal(`{"plugin":["*"]}`)) + }) + + It("does not panic when broker is nil", func() { + manager.broker = nil + Expect(func() { + manager.sendPluginRefreshEvent(ctx, "test-plugin") + }).ToNot(Panic()) + }) + }) +}) + +// testBroker is a simple mock implementation of events.Broker for testing +type testBroker struct { + lastEvent events.Event + lastEventCtx context.Context + broadcastCalled bool +} + +func (m *testBroker) ServeHTTP(w http.ResponseWriter, r *http.Request) { + // Not used in tests +} + +func (m *testBroker) SendMessage(ctx context.Context, event events.Event) { + // Not used in tests +} + +func (m *testBroker) SendBroadcastMessage(ctx context.Context, event events.Event) { + m.lastEvent = event + m.lastEventCtx = ctx + m.broadcastCalled = true +} diff --git a/plugins/manager_watcher.go b/plugins/manager_watcher.go new file mode 100644 index 000000000..b7022b46e --- /dev/null +++ b/plugins/manager_watcher.go @@ -0,0 +1,217 @@ +package plugins + +import ( + "os" + "path/filepath" + "strings" + "sync" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/rjeczalik/notify" +) + +// debounceDuration is the time to wait before acting on file events +// to handle multiple rapid events for the same file. +const debounceDuration = 2 * time.Second + +// startWatcher starts the file watcher for the plugins folder. +// It watches for CREATE, WRITE, and REMOVE events on .wasm files. +func (m *Manager) startWatcher() error { + folder := conf.Server.Plugins.Folder.String() + if folder == "" { + return nil + } + + m.watcherEvents = make(chan notify.EventInfo, 10) + m.watcherDone = make(chan struct{}) + m.debounceTimers = make(map[string]*time.Timer) + m.debounceMu = sync.Mutex{} + + // Watch the plugins folder (not recursive) + // We filter for .wasm files in the event handler + if err := notify.Watch(folder, m.watcherEvents, notify.Create, notify.Write, notify.Remove, notify.Rename); err != nil { + close(m.watcherEvents) + return err + } + + log.Info(m.ctx, "Started plugin file watcher", "folder", folder) + + go m.watcherLoop() + + return nil +} + +// stopWatcher stops the file watcher +func (m *Manager) stopWatcher() { + if m.watcherEvents == nil { + return + } + + notify.Stop(m.watcherEvents) + close(m.watcherDone) + + // Cancel any pending debounce timers + m.debounceMu.Lock() + for _, timer := range m.debounceTimers { + timer.Stop() + } + m.debounceTimers = nil + m.debounceMu.Unlock() + + log.Debug(m.ctx, "Stopped plugin file watcher") +} + +// watcherLoop processes file watcher events +func (m *Manager) watcherLoop() { + for { + select { + case event, ok := <-m.watcherEvents: + if !ok { + return + } + m.handleWatcherEvent(event) + case <-m.ctx.Done(): + return + case <-m.watcherDone: + return + } + } +} + +// handleWatcherEvent processes a single file watcher event with debouncing +func (m *Manager) handleWatcherEvent(event notify.EventInfo) { + path := event.Path() + + // Only process .ndp package files + if !strings.HasSuffix(path, PackageExtension) { + return + } + + pluginName := strings.TrimSuffix(filepath.Base(path), PackageExtension) + + log.Trace(m.ctx, "Plugin file event", "plugin", pluginName, "event", event.Event(), "path", path) + + // Debounce: cancel any pending timer for this plugin and start a new one + m.debounceMu.Lock() + if timer, exists := m.debounceTimers[pluginName]; exists { + timer.Stop() + } + + // Note: We don't capture the event type here. Instead, processPluginEvent + // checks if the file exists when the timer fires. This handles sequences like + // Remove+Create+Rename correctly by checking actual file state after debounce. + m.debounceTimers[pluginName] = time.AfterFunc(debounceDuration, func() { + m.processPluginEvent(pluginName) + }) + m.debounceMu.Unlock() +} + +// pluginAction represents the action to take on a plugin based on file state +type pluginAction int + +const ( + actionNone pluginAction = iota // No action needed + actionUpdate // File exists: add new or update existing plugin in DB + actionRemove // File gone: remove plugin from DB (unload if enabled) +) + +// determinePluginAction decides what action to take based on file existence. +// We check file existence rather than relying on event type because: +// 1. Events can be coalesced on some systems (macOS FSEvents) +// 2. Rename events can mean either "renamed away" (remove) or "renamed to" (add) +// 3. Build tools often do atomic writes (write temp file, rename to target) +// By checking existence, we handle all these cases correctly. +func determinePluginAction(path string) pluginAction { + if _, err := os.Stat(path); err == nil { + // File exists - treat as add/update + return actionUpdate + } + // File doesn't exist - it was removed + return actionRemove +} + +// processPluginEvent handles the actual plugin load/unload/reload after debouncing. +// - If file exists: extract manifest, add or update plugin in DB +// - If file gone: unload if enabled, delete from DB +func (m *Manager) processPluginEvent(pluginName string) { + // Don't process if manager is stopping/stopped (atomic check to avoid race with Stop()) + if m.stopped.Load() { + return + } + + // Clean up debounce timer entry + m.debounceMu.Lock() + delete(m.debounceTimers, pluginName) + m.debounceMu.Unlock() + + folder := conf.Server.Plugins.Folder.String() + ndpPath := filepath.Join(folder, pluginName+PackageExtension) + + action := determinePluginAction(ndpPath) + log.Debug(m.ctx, "Plugin event action", "plugin", pluginName, "action", action, "path", ndpPath) + + ctx := adminContext(m.ctx) + repo := m.ds.Plugin(ctx) + + switch action { + case actionUpdate: + // File changed - check SHA256 first, then extract manifest if needed + sha256Hash, err := computeFileSHA256(ndpPath) + if err != nil { + log.Error(m.ctx, "Failed to compute SHA256 for changed plugin", "plugin", pluginName, err) + return + } + + dbPlugin, err := repo.Get(pluginName) + if err != nil { + // Plugin not in DB yet, need full manifest extraction to add it + metadata, extractErr := m.extractManifest(ndpPath) + if extractErr != nil { + log.Error(m.ctx, "Failed to extract manifest from new plugin", "plugin", pluginName, extractErr) + return + } + if addErr := m.addPluginToDB(m.ctx, repo, pluginName, ndpPath, metadata); addErr != nil { + log.Error(m.ctx, "Failed to add plugin to DB", "plugin", pluginName, addErr) + } + return + } + + // Check if actually changed using lightweight SHA256 comparison + if dbPlugin.SHA256 == sha256Hash { + return // No actual change + } + + // Plugin changed - now extract full manifest + metadata, err := m.extractManifest(ndpPath) + if err != nil { + log.Error(m.ctx, "Failed to extract manifest from changed plugin", "plugin", pluginName, err) + // Update error in DB + dbPlugin.LastError = err.Error() + dbPlugin.UpdatedAt = time.Now() + if dbPlugin.Enabled { + _ = m.unloadPlugin(pluginName) + dbPlugin.Enabled = false + } + _ = repo.Put(dbPlugin) + return + } + + if err := m.updatePluginInDB(m.ctx, repo, dbPlugin, ndpPath, metadata); err != nil { + log.Error(m.ctx, "Failed to update plugin in DB", "plugin", pluginName, err) + } + + case actionRemove: + // File removed - unload if enabled, delete from DB + dbPlugin, err := repo.Get(pluginName) + if err != nil { + log.Debug(m.ctx, "Removed plugin not in DB", "plugin", pluginName) + return + } + + if err := m.removePluginFromDB(m.ctx, repo, dbPlugin); err != nil { + log.Error(m.ctx, "Failed to delete plugin from DB", "plugin", pluginName, err) + } + } +} diff --git a/plugins/manager_watcher_test.go b/plugins/manager_watcher_test.go new file mode 100644 index 000000000..5b5ffca02 --- /dev/null +++ b/plugins/manager_watcher_test.go @@ -0,0 +1,183 @@ +//go:build !windows + +package plugins + +import ( + "context" + "net/http" + "os" + "path/filepath" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Plugin Watcher", func() { + Describe("Integration Tests", Ordered, func() { + // Uses testdataDir and createTestManager from BeforeSuite + var ( + manager *Manager + tmpDir string + ctx context.Context + ) + + BeforeAll(func() { + ctx = GinkgoT().Context() + + // Create manager for watcher lifecycle tests (no plugin preloaded - tests copy plugin as needed) + manager, tmpDir = createTestManager(nil) + + // Remove the auto-loaded plugin so tests can control loading + _ = manager.unloadPlugin("test-metadata-agent") + _ = os.Remove(filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension)) + // Also remove from DB so tests start with a clean slate + _ = manager.ds.Plugin(ctx).Delete("test-metadata-agent") + }) + + // Helper to copy test plugin into the temp folder + copyTestPlugin := func() { + srcPath := filepath.Join(testdataDir, "test-metadata-agent"+PackageExtension) + destPath := filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + } + + Describe("Plugin event processing (integration)", func() { + // These tests verify the DB-driven flow with actual WASM plugin loading. + + AfterEach(func() { + // Clean up: unload plugin if loaded, remove copied file, delete from DB + _ = manager.unloadPlugin("test-metadata-agent") + _ = os.Remove(filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension)) + _ = manager.ds.Plugin(ctx).Delete("test-metadata-agent") + }) + + It("adds plugin to DB when file exists", func() { + copyTestPlugin() + manager.processPluginEvent("test-metadata-agent") + + // Plugin should be in DB but not loaded (starts disabled) + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) + + // Verify it was added to DB + repo := manager.ds.Plugin(ctx) + plugin, err := repo.Get("test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.ID).To(Equal("test-metadata-agent")) + Expect(plugin.Enabled).To(BeFalse()) + }) + + It("updates DB and disables plugin when file changes", func() { + copyTestPlugin() + + // First add and enable the plugin + manager.processPluginEvent("test-metadata-agent") + err := manager.EnablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).To(ContainElement("test-metadata-agent")) + + // Modify the stored SHA256 in DB to simulate a file change + // (In reality, the file would have different content) + repo := manager.ds.Plugin(ctx) + plugin, err := repo.Get("test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + plugin.SHA256 = "different-hash-to-simulate-change" + err = repo.Put(plugin) + Expect(err).ToNot(HaveOccurred()) + + // Simulate modification - the plugin should be disabled and unloaded + manager.processPluginEvent("test-metadata-agent") + + // Should be unloaded + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) + + // But still in DB (just disabled) + plugin, err = repo.Get("test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Enabled).To(BeFalse()) + }) + + It("removes plugin from DB when file is removed", func() { + copyTestPlugin() + + // First add and enable the plugin + manager.processPluginEvent("test-metadata-agent") + err := manager.EnablePlugin(ctx, "test-metadata-agent") + Expect(err).ToNot(HaveOccurred()) + + // Remove the file - plugin should be unloaded and removed from DB + _ = os.Remove(filepath.Join(tmpDir, "test-metadata-agent"+PackageExtension)) + manager.processPluginEvent("test-metadata-agent") + + // Should be unloaded + Expect(manager.PluginNames(string(CapabilityMetadataAgent))).ToNot(ContainElement("test-metadata-agent")) + + // And removed from DB + repo := manager.ds.Plugin(ctx) + _, err = repo.Get("test-metadata-agent") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("Watcher lifecycle", func() { + It("does not start file watcher when AutoReload is disabled", func() { + Expect(manager.watcherEvents).To(BeNil()) + Expect(manager.watcherDone).To(BeNil()) + }) + + It("starts file watcher when AutoReload is enabled", func() { + _ = manager.Stop() + + conf.Server.Plugins.AutoReload = true + + // Set up a mock DataStore for the auto-reload manager + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + autoReloadManager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + subsonicRouter: http.NotFoundHandler(), + } + err := autoReloadManager.Start(ctx) + Expect(err).ToNot(HaveOccurred()) + DeferCleanup(autoReloadManager.Stop) + + Expect(autoReloadManager.watcherEvents).ToNot(BeNil()) + Expect(autoReloadManager.watcherDone).ToNot(BeNil()) + }) + }) + }) + + Describe("determinePluginAction", func() { + var tmpDir string + + BeforeEach(func() { + var err error + tmpDir, err = os.MkdirTemp("", "plugin-action-test-*") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tmpDir) + }) + + It("returns actionUpdate when file exists", func() { + filePath := filepath.Join(tmpDir, "test.ndp") + err := os.WriteFile(filePath, []byte("test"), 0600) + Expect(err).ToNot(HaveOccurred()) + + Expect(determinePluginAction(filePath)).To(Equal(actionUpdate)) + }) + + It("returns actionRemove when file does not exist", func() { + filePath := filepath.Join(tmpDir, "nonexistent.ndp") + Expect(determinePluginAction(filePath)).To(Equal(actionRemove)) + }) + }) +}) diff --git a/plugins/manifest-schema.json b/plugins/manifest-schema.json new file mode 100644 index 000000000..c15a3bf3d --- /dev/null +++ b/plugins/manifest-schema.json @@ -0,0 +1,259 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://navidrome.org/schemas/Manifest.json", + "title": "Manifest", + "description": "Plugin manifest for Navidrome plugins", + "type": "object", + "additionalProperties": false, + "required": ["name", "author", "version"], + "properties": { + "name": { + "type": "string", + "description": "The display name of the plugin", + "minLength": 1 + }, + "author": { + "type": "string", + "description": "The author of the plugin", + "minLength": 1 + }, + "version": { + "type": "string", + "description": "The version of the plugin (semver recommended)", + "minLength": 1 + }, + "description": { + "type": "string", + "description": "A brief description of what the plugin does" + }, + "website": { + "type": "string", + "description": "URL to the plugin's website or repository", + "format": "uri" + }, + "permissions": { + "$ref": "#/$defs/Permissions" + }, + "experimental": { + "$ref": "#/$defs/Experimental" + }, + "config": { + "$ref": "#/$defs/ConfigDefinition" + } + }, + "$defs": { + "ConfigDefinition": { + "type": "object", + "description": "Configuration schema for the plugin using JSON Schema (draft-07) and optional JSONForms UI Schema", + "additionalProperties": false, + "required": ["schema"], + "properties": { + "schema": { + "type": "object", + "description": "JSON Schema (draft-07) defining the plugin's configuration options" + }, + "uiSchema": { + "type": "object", + "description": "Optional JSONForms UI Schema for customizing form layout" + } + } + }, + "Experimental": { + "type": "object", + "description": "Experimental features that may change or be removed in future versions", + "additionalProperties": false, + "properties": { + "threads": { + "$ref": "#/$defs/ThreadsFeature" + } + } + }, + "ThreadsFeature": { + "type": "object", + "description": "Enable experimental WebAssembly threads support", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why threads support is needed" + } + } + }, + "Permissions": { + "type": "object", + "description": "Permissions required by the plugin", + "additionalProperties": false, + "properties": { + "http": { + "$ref": "#/$defs/HTTPPermission" + }, + "subsonicapi": { + "$ref": "#/$defs/SubsonicAPIPermission" + }, + "scheduler": { + "$ref": "#/$defs/SchedulerPermission" + }, + "websocket": { + "$ref": "#/$defs/WebSocketPermission" + }, + "artwork": { + "$ref": "#/$defs/ArtworkPermission" + }, + "cache": { + "$ref": "#/$defs/CachePermission" + }, + "library": { + "$ref": "#/$defs/LibraryPermission" + }, + "kvstore": { + "$ref": "#/$defs/KVStorePermission" + }, + "users": { + "$ref": "#/$defs/UsersPermission" + }, + "taskqueue": { + "$ref": "#/$defs/TaskQueuePermission" + } + } + }, + "ArtworkPermission": { + "type": "object", + "description": "Artwork service permissions for generating artwork URLs", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why artwork access is needed" + } + } + }, + "CachePermission": { + "type": "object", + "description": "Cache service permissions for storing and retrieving data", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why cache access is needed" + } + } + }, + "HTTPPermission": { + "type": "object", + "description": "HTTP access permissions for a plugin", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why HTTP access is needed" + }, + "requiredHosts": { + "type": "array", + "description": "List of required host patterns for HTTP requests (e.g., 'api.example.com', '*.musicbrainz.org')", + "items": { + "type": "string" + } + } + } + }, + "SubsonicAPIPermission": { + "type": "object", + "description": "SubsonicAPI service permissions. Requires 'users' permission to be declared.", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why SubsonicAPI access is needed" + } + } + }, + "SchedulerPermission": { + "type": "object", + "description": "Scheduler service permissions for scheduling tasks", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why scheduler access is needed" + } + } + }, + "WebSocketPermission": { + "type": "object", + "description": "WebSocket service permissions for establishing WebSocket connections", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why WebSocket access is needed" + }, + "requiredHosts": { + "type": "array", + "description": "List of required host patterns for WebSocket connections (e.g., 'api.example.com', '*.musicbrainz.org')", + "items": { + "type": "string" + } + } + } + }, + "LibraryPermission": { + "type": "object", + "description": "Library service permissions for accessing library metadata and optionally filesystem", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why library access is needed" + }, + "filesystem": { + "type": "boolean", + "description": "Whether the plugin requires read-only filesystem access to library directories", + "default": false + } + } + }, + "KVStorePermission": { + "type": "object", + "description": "Key-value store permissions for persistent plugin storage", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why key-value store access is needed" + }, + "maxSize": { + "type": "string", + "description": "Maximum storage size (e.g., '1MB', '500KB'). Default: 1MB" + } + } + }, + "TaskQueuePermission": { + "type": "object", + "description": "Task queue permissions for background task processing", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why task queue access is needed" + }, + "maxConcurrency": { + "type": "integer", + "description": "Maximum total concurrent workers across all queues. Default: 1", + "minimum": 1, + "default": 1 + } + } + }, + "UsersPermission": { + "type": "object", + "description": "Users service permissions for accessing user information", + "additionalProperties": false, + "properties": { + "reason": { + "type": "string", + "description": "Explanation for why users access is needed" + } + } + } + } +} diff --git a/plugins/manifest.go b/plugins/manifest.go new file mode 100644 index 000000000..7484718e3 --- /dev/null +++ b/plugins/manifest.go @@ -0,0 +1,95 @@ +package plugins + +import ( + "encoding/json" + "fmt" + + "github.com/santhosh-tekuri/jsonschema/v6" +) + +//go:generate go tool go-jsonschema -p plugins --struct-name-from-title -o manifest_gen.go manifest-schema.json + +// ParseManifest unmarshals manifest JSON and performs cross-field validation. +// This is the single entry point for manifest parsing after reading from a file. +func ParseManifest(data []byte) (*Manifest, error) { + var m Manifest + if err := json.Unmarshal(data, &m); err != nil { + return nil, fmt.Errorf("parsing manifest JSON: %w", err) + } + if err := m.Validate(); err != nil { + return nil, fmt.Errorf("validating manifest: %w", err) + } + return &m, nil +} + +// Validate performs cross-field validation that cannot be expressed in JSON Schema. +// This validates rules like "SubsonicAPI permission requires users permission". +func (m *Manifest) Validate() error { + // SubsonicAPI permission requires users permission + if m.Permissions != nil && m.Permissions.Subsonicapi != nil { + if m.Permissions.Users == nil { + return fmt.Errorf("'subsonicapi' permission requires 'users' permission to be declared") + } + } + + // Validate config schema if present + if m.Config != nil && m.Config.Schema != nil { + if err := validateConfigSchema(m.Config.Schema); err != nil { + return fmt.Errorf("invalid config schema: %w", err) + } + } + + return nil +} + +// validateConfigSchema validates that the schema is a valid JSON Schema that can be compiled. +func validateConfigSchema(schema map[string]any) error { + compiler := jsonschema.NewCompiler() + if err := compiler.AddResource("schema.json", schema); err != nil { + return fmt.Errorf("invalid schema structure: %w", err) + } + if _, err := compiler.Compile("schema.json"); err != nil { + return err + } + return nil +} + +// ValidateWithCapabilities validates the manifest against detected capabilities. +// This must be called after WASM capability detection since Scrobbler capability +// is detected from exported functions, not manifest declarations. +func ValidateWithCapabilities(m *Manifest, capabilities []Capability) error { + // Scrobbler capability requires users permission + if hasCapability(capabilities, CapabilityScrobbler) { + if m.Permissions == nil || m.Permissions.Users == nil { + return fmt.Errorf("scrobbler capability requires 'users' permission to be declared in manifest") + } + } + + // Scheduler permission requires SchedulerCallback capability + if m.Permissions != nil && m.Permissions.Scheduler != nil { + if !hasCapability(capabilities, CapabilityScheduler) { + return fmt.Errorf("'scheduler' permission requires plugin to export '%s' function", FuncSchedulerCallback) + } + } + + // Task (taskqueue) permission requires TaskWorker capability + if m.Permissions != nil && m.Permissions.Taskqueue != nil { + if !hasCapability(capabilities, CapabilityTaskWorker) { + return fmt.Errorf("'taskqueue' permission requires plugin to export '%s' function", FuncTaskWorkerCallback) + } + } + + return nil +} + +// HasExperimentalThreads returns true if the manifest requests experimental threads support. +func (m *Manifest) HasExperimentalThreads() bool { + return m.Experimental != nil && m.Experimental.Threads != nil +} + +// HasLibraryFilesystemPermission checks if the manifest grants filesystem permission for libraries. +func (m *Manifest) HasLibraryFilesystemPermission() bool { + return m.Permissions != nil && + m.Permissions.Library != nil && + m.Permissions.Library.Filesystem +} diff --git a/plugins/manifest_gen.go b/plugins/manifest_gen.go new file mode 100644 index 000000000..efe93e05f --- /dev/null +++ b/plugins/manifest_gen.go @@ -0,0 +1,256 @@ +// Code generated by github.com/atombender/go-jsonschema, DO NOT EDIT. + +package plugins + +import "encoding/json" +import "fmt" + +// Artwork service permissions for generating artwork URLs +type ArtworkPermission struct { + // Explanation for why artwork access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Cache service permissions for storing and retrieving data +type CachePermission struct { + // Explanation for why cache access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Configuration schema for the plugin using JSON Schema (draft-07) and optional +// JSONForms UI Schema +type ConfigDefinition struct { + // JSON Schema (draft-07) defining the plugin's configuration options + Schema map[string]interface{} `json:"schema" yaml:"schema" mapstructure:"schema"` + + // Optional JSONForms UI Schema for customizing form layout + UiSchema map[string]interface{} `json:"uiSchema,omitempty" yaml:"uiSchema,omitempty" mapstructure:"uiSchema,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *ConfigDefinition) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + if _, ok := raw["schema"]; raw != nil && !ok { + return fmt.Errorf("field schema in ConfigDefinition: required") + } + type Plain ConfigDefinition + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + *j = ConfigDefinition(plain) + return nil +} + +// Experimental features that may change or be removed in future versions +type Experimental struct { + // Threads corresponds to the JSON schema field "threads". + Threads *ThreadsFeature `json:"threads,omitempty" yaml:"threads,omitempty" mapstructure:"threads,omitempty"` +} + +// HTTP access permissions for a plugin +type HTTPPermission struct { + // Explanation for why HTTP access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` + + // List of required host patterns for HTTP requests (e.g., 'api.example.com', + // '*.musicbrainz.org') + RequiredHosts []string `json:"requiredHosts,omitempty" yaml:"requiredHosts,omitempty" mapstructure:"requiredHosts,omitempty"` +} + +// Key-value store permissions for persistent plugin storage +type KVStorePermission struct { + // Maximum storage size (e.g., '1MB', '500KB'). Default: 1MB + MaxSize *string `json:"maxSize,omitempty" yaml:"maxSize,omitempty" mapstructure:"maxSize,omitempty"` + + // Explanation for why key-value store access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Library service permissions for accessing library metadata and optionally +// filesystem +type LibraryPermission struct { + // Whether the plugin requires read-only filesystem access to library directories + Filesystem bool `json:"filesystem,omitempty" yaml:"filesystem,omitempty" mapstructure:"filesystem,omitempty"` + + // Explanation for why library access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *LibraryPermission) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + type Plain LibraryPermission + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + if v, ok := raw["filesystem"]; !ok || v == nil { + plain.Filesystem = false + } + *j = LibraryPermission(plain) + return nil +} + +// Plugin manifest for Navidrome plugins +type Manifest struct { + // The author of the plugin + Author string `json:"author" yaml:"author" mapstructure:"author"` + + // Config corresponds to the JSON schema field "config". + Config *ConfigDefinition `json:"config,omitempty" yaml:"config,omitempty" mapstructure:"config,omitempty"` + + // A brief description of what the plugin does + Description *string `json:"description,omitempty" yaml:"description,omitempty" mapstructure:"description,omitempty"` + + // Experimental corresponds to the JSON schema field "experimental". + Experimental *Experimental `json:"experimental,omitempty" yaml:"experimental,omitempty" mapstructure:"experimental,omitempty"` + + // The display name of the plugin + Name string `json:"name" yaml:"name" mapstructure:"name"` + + // Permissions corresponds to the JSON schema field "permissions". + Permissions *Permissions `json:"permissions,omitempty" yaml:"permissions,omitempty" mapstructure:"permissions,omitempty"` + + // The version of the plugin (semver recommended) + Version string `json:"version" yaml:"version" mapstructure:"version"` + + // URL to the plugin's website or repository + Website *string `json:"website,omitempty" yaml:"website,omitempty" mapstructure:"website,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *Manifest) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + if _, ok := raw["author"]; raw != nil && !ok { + return fmt.Errorf("field author in Manifest: required") + } + if _, ok := raw["name"]; raw != nil && !ok { + return fmt.Errorf("field name in Manifest: required") + } + if _, ok := raw["version"]; raw != nil && !ok { + return fmt.Errorf("field version in Manifest: required") + } + type Plain Manifest + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + if len(plain.Author) < 1 { + return fmt.Errorf("field %s length: must be >= %d", "author", 1) + } + if len(plain.Name) < 1 { + return fmt.Errorf("field %s length: must be >= %d", "name", 1) + } + if len(plain.Version) < 1 { + return fmt.Errorf("field %s length: must be >= %d", "version", 1) + } + *j = Manifest(plain) + return nil +} + +// Permissions required by the plugin +type Permissions struct { + // Artwork corresponds to the JSON schema field "artwork". + Artwork *ArtworkPermission `json:"artwork,omitempty" yaml:"artwork,omitempty" mapstructure:"artwork,omitempty"` + + // Cache corresponds to the JSON schema field "cache". + Cache *CachePermission `json:"cache,omitempty" yaml:"cache,omitempty" mapstructure:"cache,omitempty"` + + // Http corresponds to the JSON schema field "http". + Http *HTTPPermission `json:"http,omitempty" yaml:"http,omitempty" mapstructure:"http,omitempty"` + + // Kvstore corresponds to the JSON schema field "kvstore". + Kvstore *KVStorePermission `json:"kvstore,omitempty" yaml:"kvstore,omitempty" mapstructure:"kvstore,omitempty"` + + // Library corresponds to the JSON schema field "library". + Library *LibraryPermission `json:"library,omitempty" yaml:"library,omitempty" mapstructure:"library,omitempty"` + + // Scheduler corresponds to the JSON schema field "scheduler". + Scheduler *SchedulerPermission `json:"scheduler,omitempty" yaml:"scheduler,omitempty" mapstructure:"scheduler,omitempty"` + + // Subsonicapi corresponds to the JSON schema field "subsonicapi". + Subsonicapi *SubsonicAPIPermission `json:"subsonicapi,omitempty" yaml:"subsonicapi,omitempty" mapstructure:"subsonicapi,omitempty"` + + // Taskqueue corresponds to the JSON schema field "taskqueue". + Taskqueue *TaskQueuePermission `json:"taskqueue,omitempty" yaml:"taskqueue,omitempty" mapstructure:"taskqueue,omitempty"` + + // Users corresponds to the JSON schema field "users". + Users *UsersPermission `json:"users,omitempty" yaml:"users,omitempty" mapstructure:"users,omitempty"` + + // Websocket corresponds to the JSON schema field "websocket". + Websocket *WebSocketPermission `json:"websocket,omitempty" yaml:"websocket,omitempty" mapstructure:"websocket,omitempty"` +} + +// Scheduler service permissions for scheduling tasks +type SchedulerPermission struct { + // Explanation for why scheduler access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// SubsonicAPI service permissions. Requires 'users' permission to be declared. +type SubsonicAPIPermission struct { + // Explanation for why SubsonicAPI access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Task queue permissions for background task processing +type TaskQueuePermission struct { + // Maximum total concurrent workers across all queues. Default: 1 + MaxConcurrency int `json:"maxConcurrency,omitempty" yaml:"maxConcurrency,omitempty" mapstructure:"maxConcurrency,omitempty"` + + // Explanation for why task queue access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// UnmarshalJSON implements json.Unmarshaler. +func (j *TaskQueuePermission) UnmarshalJSON(value []byte) error { + var raw map[string]interface{} + if err := json.Unmarshal(value, &raw); err != nil { + return err + } + type Plain TaskQueuePermission + var plain Plain + if err := json.Unmarshal(value, &plain); err != nil { + return err + } + if v, ok := raw["maxConcurrency"]; !ok || v == nil { + plain.MaxConcurrency = 1.0 + } + if 1 > plain.MaxConcurrency { + return fmt.Errorf("field %s: must be >= %v", "maxConcurrency", 1) + } + *j = TaskQueuePermission(plain) + return nil +} + +// Enable experimental WebAssembly threads support +type ThreadsFeature struct { + // Explanation for why threads support is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// Users service permissions for accessing user information +type UsersPermission struct { + // Explanation for why users access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` +} + +// WebSocket service permissions for establishing WebSocket connections +type WebSocketPermission struct { + // Explanation for why WebSocket access is needed + Reason *string `json:"reason,omitempty" yaml:"reason,omitempty" mapstructure:"reason,omitempty"` + + // List of required host patterns for WebSocket connections (e.g., + // 'api.example.com', '*.musicbrainz.org') + RequiredHosts []string `json:"requiredHosts,omitempty" yaml:"requiredHosts,omitempty" mapstructure:"requiredHosts,omitempty"` +} diff --git a/plugins/manifest_test.go b/plugins/manifest_test.go new file mode 100644 index 000000000..0d371d14a --- /dev/null +++ b/plugins/manifest_test.go @@ -0,0 +1,466 @@ +package plugins + +import ( + "encoding/json" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Manifest", func() { + Describe("UnmarshalJSON", func() { + It("parses a valid manifest", func() { + data := []byte(`{ + "name": "Test Plugin", + "author": "Test Author", + "version": "1.0.0", + "description": "A test plugin", + "website": "https://example.com", + "permissions": { + "http": { + "reason": "Fetch metadata", + "requiredHosts": ["api.example.com", "*.musicbrainz.org"] + } + } + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Test Plugin")) + Expect(m.Author).To(Equal("Test Author")) + Expect(m.Version).To(Equal("1.0.0")) + Expect(*m.Description).To(Equal("A test plugin")) + Expect(*m.Website).To(Equal("https://example.com")) + Expect(m.Permissions.Http).ToNot(BeNil()) + Expect(*m.Permissions.Http.Reason).To(Equal("Fetch metadata")) + Expect(m.Permissions.Http.RequiredHosts).To(ContainElements("api.example.com", "*.musicbrainz.org")) + }) + + It("parses a minimal manifest", func() { + data := []byte(`{ + "name": "Minimal Plugin", + "author": "Author", + "version": "1.0.0" + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Minimal Plugin")) + Expect(m.Author).To(Equal("Author")) + Expect(m.Version).To(Equal("1.0.0")) + Expect(m.Description).To(BeNil()) + Expect(m.Permissions).To(BeNil()) + }) + + It("returns an error for invalid JSON", func() { + data := []byte(`{invalid json}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + }) + + It("returns an error when name is missing", func() { + data := []byte(`{"author": "Test Author", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("name")) + }) + + It("returns an error when author is missing", func() { + data := []byte(`{"name": "Test Plugin", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("author")) + }) + + It("returns an error when version is missing", func() { + data := []byte(`{"name": "Test Plugin", "author": "Test Author"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("version")) + }) + + It("returns an error when name is empty", func() { + data := []byte(`{"name": "", "author": "Test Author", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("name")) + }) + + It("returns an error when author is empty", func() { + data := []byte(`{"name": "Test Plugin", "author": "", "version": "1.0.0"}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("author")) + }) + + It("returns an error when version is empty", func() { + data := []byte(`{"name": "Test Plugin", "author": "Test Author", "version": ""}`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("version")) + }) + }) + + Describe("HasExperimentalThreads", func() { + It("returns false when no experimental section", func() { + m := &Manifest{} + Expect(m.HasExperimentalThreads()).To(BeFalse()) + }) + + It("returns false when experimental section has no threads", func() { + m := &Manifest{ + Experimental: &Experimental{}, + } + Expect(m.HasExperimentalThreads()).To(BeFalse()) + }) + + It("returns true when threads feature is present", func() { + m := &Manifest{ + Experimental: &Experimental{ + Threads: &ThreadsFeature{}, + }, + } + Expect(m.HasExperimentalThreads()).To(BeTrue()) + }) + + It("returns true when threads feature has a reason", func() { + m := &Manifest{ + Experimental: &Experimental{ + Threads: &ThreadsFeature{ + Reason: new("Required for concurrent processing"), + }, + }, + } + Expect(m.HasExperimentalThreads()).To(BeTrue()) + }) + + It("parses experimental.threads from JSON", func() { + data := []byte(`{ + "name": "Threaded Plugin", + "author": "Test Author", + "version": "1.0.0", + "experimental": { + "threads": { + "reason": "To use multi-threaded WASM module" + } + } + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.HasExperimentalThreads()).To(BeTrue()) + Expect(m.Experimental.Threads.Reason).ToNot(BeNil()) + Expect(*m.Experimental.Threads.Reason).To(Equal("To use multi-threaded WASM module")) + }) + + It("parses experimental.threads without reason from JSON", func() { + data := []byte(`{ + "name": "Threaded Plugin", + "author": "Test Author", + "version": "1.0.0", + "experimental": { + "threads": {} + } + }`) + + var m Manifest + err := json.Unmarshal(data, &m) + Expect(err).ToNot(HaveOccurred()) + Expect(m.HasExperimentalThreads()).To(BeTrue()) + }) + }) + + Describe("ParseManifest", func() { + It("parses a valid manifest with users permission", func() { + data := []byte(`{ + "name": "Test Plugin", + "author": "Test Author", + "version": "1.0.0", + "permissions": { + "subsonicapi": {}, + "users": {} + } + }`) + + m, err := ParseManifest(data) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Test Plugin")) + Expect(m.Permissions.Subsonicapi).ToNot(BeNil()) + Expect(m.Permissions.Users).ToNot(BeNil()) + }) + + It("returns error for invalid JSON", func() { + data := []byte(`{invalid}`) + + _, err := ParseManifest(data) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when subsonicapi is requested without users permission", func() { + data := []byte(`{ + "name": "Test Plugin", + "author": "Test Author", + "version": "1.0.0", + "permissions": { + "subsonicapi": {} + } + }`) + + _, err := ParseManifest(data) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("subsonicapi")) + Expect(err.Error()).To(ContainSubstring("users")) + }) + }) + + Describe("Validate", func() { + It("validates manifest with subsonicapi and users permissions", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Subsonicapi: &SubsonicAPIPermission{}, + Users: &UsersPermission{}, + }, + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns error when subsonicapi without users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Subsonicapi: &SubsonicAPIPermission{}, + }, + } + + err := m.Validate() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("subsonicapi")) + }) + + It("validates manifest without subsonicapi", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Http: &HTTPPermission{}, + }, + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates manifest without any permissions", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates manifest with valid config schema", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "api_key": map[string]any{ + "type": "string", + }, + }, + }, + }, + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates manifest with complex config schema", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "users": map[string]any{ + "type": "array", + "items": map[string]any{ + "type": "object", + "properties": map[string]any{ + "username": map[string]any{"type": "string"}, + "token": map[string]any{"type": "string"}, + }, + "required": []any{"username", "token"}, + }, + }, + }, + }, + }, + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns error for invalid config schema - bad type", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "invalid_type", + }, + }, + } + + err := m.Validate() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("config schema")) + }) + + It("returns error for invalid config schema - bad minLength", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Config: &ConfigDefinition{ + Schema: map[string]any{ + "type": "object", + "properties": map[string]any{ + "name": map[string]any{ + "type": "string", + "minLength": "not_a_number", + }, + }, + }, + }, + } + + err := m.Validate() + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("config schema")) + }) + + It("validates manifest without config", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := m.Validate() + Expect(err).ToNot(HaveOccurred()) + }) + }) + + Describe("ValidateWithCapabilities", func() { + It("validates scrobbler capability with users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Users: &UsersPermission{}, + }, + } + + err := ValidateWithCapabilities(m, []Capability{CapabilityScrobbler}) + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns error when scrobbler capability without users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := ValidateWithCapabilities(m, []Capability{CapabilityScrobbler}) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("scrobbler")) + Expect(err.Error()).To(ContainSubstring("users")) + }) + + It("validates non-scrobbler capability without users permission", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := ValidateWithCapabilities(m, []Capability{CapabilityMetadataAgent}) + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates multiple capabilities including scrobbler", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + Permissions: &Permissions{ + Users: &UsersPermission{}, + }, + } + + err := ValidateWithCapabilities(m, []Capability{CapabilityMetadataAgent, CapabilityScrobbler}) + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates with nil capabilities", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := ValidateWithCapabilities(m, nil) + Expect(err).ToNot(HaveOccurred()) + }) + + It("validates with empty capabilities", func() { + m := &Manifest{ + Name: "Test", + Author: "Author", + Version: "1.0.0", + } + + err := ValidateWithCapabilities(m, []Capability{}) + Expect(err).ToNot(HaveOccurred()) + }) + }) +}) diff --git a/plugins/metadata_agent.go b/plugins/metadata_agent.go new file mode 100644 index 000000000..52542300c --- /dev/null +++ b/plugins/metadata_agent.go @@ -0,0 +1,264 @@ +package plugins + +import ( + "context" + "errors" + + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/plugins/capabilities" + "github.com/navidrome/navidrome/utils/slice" +) + +// CapabilityMetadataAgent indicates the plugin can provide artist/album metadata. +// Detected when the plugin exports at least one of the metadata agent functions. +const CapabilityMetadataAgent Capability = "MetadataAgent" + +// Export function names (snake_case as per design) +const ( + FuncGetArtistMBID = "nd_get_artist_mbid" + FuncGetArtistURL = "nd_get_artist_url" + FuncGetArtistBiography = "nd_get_artist_biography" + FuncGetSimilarArtists = "nd_get_similar_artists" + FuncGetArtistImages = "nd_get_artist_images" + FuncGetArtistTopSongs = "nd_get_artist_top_songs" + FuncGetAlbumInfo = "nd_get_album_info" + FuncGetAlbumImages = "nd_get_album_images" + FuncGetSimilarSongsByTrack = "nd_get_similar_songs_by_track" + FuncGetSimilarSongsByAlbum = "nd_get_similar_songs_by_album" + FuncGetSimilarSongsByArtist = "nd_get_similar_songs_by_artist" +) + +func init() { + registerCapability( + CapabilityMetadataAgent, + FuncGetArtistMBID, + FuncGetArtistURL, + FuncGetArtistBiography, + FuncGetSimilarArtists, + FuncGetArtistImages, + FuncGetArtistTopSongs, + FuncGetAlbumInfo, + FuncGetAlbumImages, + FuncGetSimilarSongsByTrack, + FuncGetSimilarSongsByAlbum, + FuncGetSimilarSongsByArtist, + ) +} + +func newMetadataAgent(p *plugin) *MetadataAgent { + return &MetadataAgent{name: p.name, plugin: p} +} + +// MetadataAgent is an adapter that wraps an Extism plugin and implements +// the agents interfaces for metadata retrieval. +type MetadataAgent struct { + name string + plugin *plugin +} + +// AgentName returns the plugin name +func (a *MetadataAgent) AgentName() string { + return a.name +} + +// --- Interface implementations --- + +// GetArtistMBID retrieves the MusicBrainz ID for an artist +func (a *MetadataAgent) GetArtistMBID(ctx context.Context, id string, name string) (string, error) { + input := capabilities.ArtistMBIDRequest{ID: id, Name: name} + result, err := callPluginFunction[capabilities.ArtistMBIDRequest, *capabilities.ArtistMBIDResponse](ctx, a.plugin, FuncGetArtistMBID, input) + if err != nil { + return "", errors.Join(agents.ErrNotFound, err) + } + + if result == nil || result.MBID == "" { + return "", agents.ErrNotFound + } + + return result.MBID, nil +} + +// GetArtistURL retrieves the external URL for an artist +func (a *MetadataAgent) GetArtistURL(ctx context.Context, id, name, mbid string) (string, error) { + input := capabilities.ArtistRequest{ID: id, Name: name, MBID: mbid} + result, err := callPluginFunction[capabilities.ArtistRequest, *capabilities.ArtistURLResponse](ctx, a.plugin, FuncGetArtistURL, input) + if err != nil { + return "", errors.Join(agents.ErrNotFound, err) + } + if result == nil || result.URL == "" { + return "", agents.ErrNotFound + } + return result.URL, nil +} + +// GetArtistBiography retrieves the biography for an artist +func (a *MetadataAgent) GetArtistBiography(ctx context.Context, id, name, mbid string) (string, error) { + input := capabilities.ArtistRequest{ID: id, Name: name, MBID: mbid} + result, err := callPluginFunction[capabilities.ArtistRequest, *capabilities.ArtistBiographyResponse](ctx, a.plugin, FuncGetArtistBiography, input) + if err != nil { + return "", errors.Join(agents.ErrNotFound, err) + } + + if result == nil || result.Biography == "" { + return "", agents.ErrNotFound + } + + return result.Biography, nil +} + +// GetSimilarArtists retrieves similar artists +func (a *MetadataAgent) GetSimilarArtists(ctx context.Context, id, name, mbid string, limit int) ([]agents.Artist, error) { + input := capabilities.SimilarArtistsRequest{ID: id, Name: name, MBID: mbid, Limit: int32(limit)} + result, err := callPluginFunction[capabilities.SimilarArtistsRequest, *capabilities.SimilarArtistsResponse](ctx, a.plugin, FuncGetSimilarArtists, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Artists) == 0 { + return nil, agents.ErrNotFound + } + + artists := make([]agents.Artist, len(result.Artists)) + for i, ar := range result.Artists { + artists[i] = agents.Artist{ID: ar.ID, Name: ar.Name, MBID: ar.MBID} + } + + return artists, nil +} + +// GetArtistImages retrieves images for an artist +func (a *MetadataAgent) GetArtistImages(ctx context.Context, id, name, mbid string) ([]agents.ExternalImage, error) { + input := capabilities.ArtistRequest{ID: id, Name: name, MBID: mbid} + result, err := callPluginFunction[capabilities.ArtistRequest, *capabilities.ArtistImagesResponse](ctx, a.plugin, FuncGetArtistImages, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Images) == 0 { + return nil, agents.ErrNotFound + } + + images := make([]agents.ExternalImage, len(result.Images)) + for i, img := range result.Images { + images[i] = agents.ExternalImage{URL: img.URL, Size: int(img.Size)} + } + + return images, nil +} + +// GetArtistTopSongs retrieves top songs for an artist +func (a *MetadataAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]agents.Song, error) { + input := capabilities.TopSongsRequest{ID: id, Name: artistName, MBID: mbid, Count: int32(count)} + result, err := callPluginFunction[capabilities.TopSongsRequest, *capabilities.TopSongsResponse](ctx, a.plugin, FuncGetArtistTopSongs, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Songs) == 0 { + return nil, agents.ErrNotFound + } + + return songRefsToAgentSongs(result.Songs), nil +} + +// GetAlbumInfo retrieves album information +func (a *MetadataAgent) GetAlbumInfo(ctx context.Context, name, artist, mbid string) (*agents.AlbumInfo, error) { + input := capabilities.AlbumRequest{Name: name, Artist: artist, MBID: mbid} + result, err := callPluginFunction[capabilities.AlbumRequest, *capabilities.AlbumInfoResponse](ctx, a.plugin, FuncGetAlbumInfo, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil { + return nil, agents.ErrNotFound + } + + return &agents.AlbumInfo{ + Name: result.Name, + MBID: result.MBID, + Description: result.Description, + URL: result.URL, + }, nil +} + +// GetAlbumImages retrieves images for an album +func (a *MetadataAgent) GetAlbumImages(ctx context.Context, name, artist, mbid string) ([]agents.ExternalImage, error) { + input := capabilities.AlbumRequest{Name: name, Artist: artist, MBID: mbid} + result, err := callPluginFunction[capabilities.AlbumRequest, *capabilities.AlbumImagesResponse](ctx, a.plugin, FuncGetAlbumImages, input) + if err != nil { + return nil, errors.Join(agents.ErrNotFound, err) + } + + if result == nil || len(result.Images) == 0 { + return nil, agents.ErrNotFound + } + + images := make([]agents.ExternalImage, len(result.Images)) + for i, img := range result.Images { + images[i] = agents.ExternalImage{URL: img.URL, Size: int(img.Size)} + } + + return images, nil +} + +func callSimilarSongsPluginFunction[T any](ctx context.Context, plugin *plugin, funcName string, input T) ([]agents.Song, error) { + result, err := callPluginFunction[T, *capabilities.SimilarSongsResponse](ctx, plugin, funcName, input) + if err != nil { + return nil, err + } + if result == nil || len(result.Songs) == 0 { + return nil, agents.ErrNotFound + } + return songRefsToAgentSongs(result.Songs), nil +} + +// GetSimilarSongsByTrack retrieves songs similar to a specific track +func (a *MetadataAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByTrackRequest](ctx, a.plugin, FuncGetSimilarSongsByTrack, capabilities.SimilarSongsByTrackRequest{ID: id, Name: name, Artist: artist, MBID: mbid, Count: int32(count)}) +} + +// GetSimilarSongsByAlbum retrieves songs similar to tracks on an album +func (a *MetadataAgent) GetSimilarSongsByAlbum(ctx context.Context, id, name, artist, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByAlbumRequest](ctx, a.plugin, FuncGetSimilarSongsByAlbum, capabilities.SimilarSongsByAlbumRequest{ID: id, Name: name, Artist: artist, MBID: mbid, Count: int32(count)}) +} + +// GetSimilarSongsByArtist retrieves songs similar to an artist's catalog +func (a *MetadataAgent) GetSimilarSongsByArtist(ctx context.Context, id, name, mbid string, count int) ([]agents.Song, error) { + return callSimilarSongsPluginFunction[capabilities.SimilarSongsByArtistRequest](ctx, a.plugin, FuncGetSimilarSongsByArtist, capabilities.SimilarSongsByArtistRequest{ID: id, Name: name, MBID: mbid, Count: int32(count)}) +} + +// songRefToAgentSong converts a single SongRef to agents.Song +func songRefToAgentSong(s capabilities.SongRef) agents.Song { + return agents.Song{ + ID: s.ID, + Name: s.Name, + MBID: s.MBID, + ISRC: s.ISRC, + Artist: s.Artist, + ArtistMBID: s.ArtistMBID, + Album: s.Album, + AlbumMBID: s.AlbumMBID, + Duration: uint32(s.Duration * 1000), + } +} + +// songRefsToAgentSongs converts a slice of SongRef to agents.Song +func songRefsToAgentSongs(refs []capabilities.SongRef) []agents.Song { + return slice.Map(refs, songRefToAgentSong) +} + +// Verify interface implementations at compile time +var ( + _ agents.Interface = (*MetadataAgent)(nil) + _ agents.ArtistMBIDRetriever = (*MetadataAgent)(nil) + _ agents.ArtistURLRetriever = (*MetadataAgent)(nil) + _ agents.ArtistBiographyRetriever = (*MetadataAgent)(nil) + _ agents.ArtistSimilarRetriever = (*MetadataAgent)(nil) + _ agents.ArtistImageRetriever = (*MetadataAgent)(nil) + _ agents.ArtistTopSongsRetriever = (*MetadataAgent)(nil) + _ agents.AlbumInfoRetriever = (*MetadataAgent)(nil) + _ agents.AlbumImageRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByTrackRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByAlbumRetriever = (*MetadataAgent)(nil) + _ agents.SimilarSongsByArtistRetriever = (*MetadataAgent)(nil) +) diff --git a/plugins/metadata_agent_test.go b/plugins/metadata_agent_test.go new file mode 100644 index 000000000..067ae80ca --- /dev/null +++ b/plugins/metadata_agent_test.go @@ -0,0 +1,331 @@ +//go:build !windows + +package plugins + +import ( + "github.com/navidrome/navidrome/core/agents" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("MetadataAgent", Ordered, func() { + var agent agents.Interface + + BeforeAll(func() { + // Load the agent via shared manager + var ok bool + agent, ok = testManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + Describe("AgentName", func() { + It("returns the plugin name", func() { + Expect(agent.AgentName()).To(Equal("test-metadata-agent")) + }) + }) + + Describe("GetArtistMBID", func() { + It("returns the MBID from the plugin", func() { + retriever := agent.(agents.ArtistMBIDRetriever) + mbid, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "The Beatles") + Expect(err).ToNot(HaveOccurred()) + Expect(mbid).To(Equal("test-mbid-The Beatles")) + }) + }) + + Describe("GetArtistURL", func() { + It("returns the URL from the plugin", func() { + retriever := agent.(agents.ArtistURLRetriever) + url, err := retriever.GetArtistURL(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(url).To(Equal("https://test.example.com/artist/The Beatles")) + }) + }) + + Describe("GetArtistBiography", func() { + It("returns the biography from the plugin", func() { + retriever := agent.(agents.ArtistBiographyRetriever) + bio, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(Equal("Biography for The Beatles")) + }) + }) + + Describe("GetArtistImages", func() { + It("returns images from the plugin", func() { + retriever := agent.(agents.ArtistImageRetriever) + images, err := retriever.GetArtistImages(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(HaveLen(2)) + Expect(images[0].URL).To(Equal("https://test.example.com/images/The Beatles/large.jpg")) + Expect(images[0].Size).To(Equal(500)) + Expect(images[1].URL).To(Equal("https://test.example.com/images/The Beatles/small.jpg")) + Expect(images[1].Size).To(Equal(100)) + }) + }) + + Describe("GetSimilarArtists", func() { + It("returns similar artists from the plugin", func() { + retriever := agent.(agents.ArtistSimilarRetriever) + artists, err := retriever.GetSimilarArtists(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(HaveLen(3)) + Expect(artists[0].Name).To(Equal("The Beatles Similar A")) + Expect(artists[1].Name).To(Equal("The Beatles Similar B")) + Expect(artists[2].Name).To(Equal("The Beatles Similar C")) + }) + }) + + Describe("GetArtistTopSongs", func() { + It("returns top songs from the plugin", func() { + retriever := agent.(agents.ArtistTopSongsRetriever) + songs, err := retriever.GetArtistTopSongs(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(Equal("The Beatles Song 1")) + Expect(songs[1].Name).To(Equal("The Beatles Song 2")) + Expect(songs[2].Name).To(Equal("The Beatles Song 3")) + }) + }) + + Describe("GetAlbumInfo", func() { + It("returns album info from the plugin", func() { + retriever := agent.(agents.AlbumInfoRetriever) + info, err := retriever.GetAlbumInfo(GinkgoT().Context(), "Abbey Road", "The Beatles", "album-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(info.Name).To(Equal("Abbey Road")) + Expect(info.MBID).To(Equal("test-album-mbid-Abbey Road")) + Expect(info.Description).To(Equal("Description for Abbey Road by The Beatles")) + Expect(info.URL).To(Equal("https://test.example.com/album/Abbey Road")) + }) + }) + + Describe("GetAlbumImages", func() { + It("returns album images from the plugin", func() { + retriever := agent.(agents.AlbumImageRetriever) + images, err := retriever.GetAlbumImages(GinkgoT().Context(), "Abbey Road", "The Beatles", "album-mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(images).To(HaveLen(1)) + Expect(images[0].URL).To(Equal("https://test.example.com/albums/Abbey Road/cover.jpg")) + Expect(images[0].Size).To(Equal(500)) + }) + }) + + Describe("GetSimilarSongsByTrack", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByTrackRetriever) + songs, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Yesterday", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(Equal("Similar to Yesterday #1")) + Expect(songs[0].Artist).To(Equal("The Beatles")) + }) + }) + + Describe("GetSimilarSongsByAlbum", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByAlbumRetriever) + songs, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Abbey Road", "The Beatles", "album-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Album).To(Equal("Abbey Road")) + }) + }) + + Describe("GetSimilarSongsByArtist", func() { + It("returns similar songs from the plugin", func() { + retriever := agent.(agents.SimilarSongsByArtistRetriever) + songs, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "The Beatles", "some-mbid", 3) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).To(HaveLen(3)) + Expect(songs[0].Name).To(ContainSubstring("The Beatles Style Song")) + }) + }) +}) + +var _ = Describe("MetadataAgent error handling", Ordered, func() { + // Tests error paths when plugin is configured to return errors + var ( + errorManager *Manager + errorAgent agents.Interface + ) + + BeforeAll(func() { + // Create manager with error injection config + errorManager, _ = createTestManager(map[string]map[string]string{ + "test-metadata-agent": { + "error": "simulated plugin error", + }, + }) + + // Load the agent + var ok bool + errorAgent, ok = errorManager.LoadMediaAgent("test-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("returns error from GetArtistMBID", func() { + retriever := errorAgent.(agents.ArtistMBIDRetriever) + _, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "Test") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistURL", func() { + retriever := errorAgent.(agents.ArtistURLRetriever) + _, err := retriever.GetArtistURL(GinkgoT().Context(), "artist-1", "Test", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistBiography", func() { + retriever := errorAgent.(agents.ArtistBiographyRetriever) + _, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistImages", func() { + retriever := errorAgent.(agents.ArtistImageRetriever) + _, err := retriever.GetArtistImages(GinkgoT().Context(), "artist-1", "Test", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarArtists", func() { + retriever := errorAgent.(agents.ArtistSimilarRetriever) + _, err := retriever.GetSimilarArtists(GinkgoT().Context(), "artist-1", "Test", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetArtistTopSongs", func() { + retriever := errorAgent.(agents.ArtistTopSongsRetriever) + _, err := retriever.GetArtistTopSongs(GinkgoT().Context(), "artist-1", "Test", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetAlbumInfo", func() { + retriever := errorAgent.(agents.AlbumInfoRetriever) + _, err := retriever.GetAlbumInfo(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetAlbumImages", func() { + retriever := errorAgent.(agents.AlbumImageRetriever) + _, err := retriever.GetAlbumImages(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByTrack", func() { + retriever := errorAgent.(agents.SimilarSongsByTrackRetriever) + _, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Test", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByAlbum", func() { + retriever := errorAgent.(agents.SimilarSongsByAlbumRetriever) + _, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Album", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from GetSimilarSongsByArtist", func() { + retriever := errorAgent.(agents.SimilarSongsByArtistRetriever) + _, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "Artist", "mbid", 5) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) +}) + +var _ = Describe("MetadataAgent partial implementation", Ordered, func() { + // Tests the "not implemented" code path when a plugin only implements some methods + var ( + partialManager *Manager + partialAgent agents.Interface + ) + + BeforeAll(func() { + // Create manager with the partial metadata agent plugin + partialManager, _ = createTestManagerWithPlugins(nil, "partial-metadata-agent"+PackageExtension) + + // Load the agent + var ok bool + partialAgent, ok = partialManager.LoadMediaAgent("partial-metadata-agent") + Expect(ok).To(BeTrue()) + }) + + It("returns data from implemented method (GetArtistBiography)", func() { + retriever := partialAgent.(agents.ArtistBiographyRetriever) + bio, err := retriever.GetArtistBiography(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).ToNot(HaveOccurred()) + Expect(bio).To(Equal("Partial agent biography for Test Artist")) + }) + + It("returns ErrNotFound for unimplemented method (GetArtistMBID)", func() { + retriever := partialAgent.(agents.ArtistMBIDRetriever) + _, err := retriever.GetArtistMBID(GinkgoT().Context(), "artist-1", "Test Artist") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetArtistURL)", func() { + retriever := partialAgent.(agents.ArtistURLRetriever) + _, err := retriever.GetArtistURL(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetArtistImages)", func() { + retriever := partialAgent.(agents.ArtistImageRetriever) + _, err := retriever.GetArtistImages(GinkgoT().Context(), "artist-1", "Test Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarArtists)", func() { + retriever := partialAgent.(agents.ArtistSimilarRetriever) + _, err := retriever.GetSimilarArtists(GinkgoT().Context(), "artist-1", "Test Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + + }) + + It("returns ErrNotFound for unimplemented method (GetArtistTopSongs)", func() { + retriever := partialAgent.(agents.ArtistTopSongsRetriever) + _, err := retriever.GetArtistTopSongs(GinkgoT().Context(), "artist-1", "Test Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + + }) + + It("returns ErrNotFound for unimplemented method (GetAlbumInfo)", func() { + retriever := partialAgent.(agents.AlbumInfoRetriever) + _, err := retriever.GetAlbumInfo(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + + }) + + It("returns ErrNotFound for unimplemented method (GetAlbumImages)", func() { + retriever := partialAgent.(agents.AlbumImageRetriever) + _, err := retriever.GetAlbumImages(GinkgoT().Context(), "Album", "Artist", "mbid") + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByTrack)", func() { + retriever := partialAgent.(agents.SimilarSongsByTrackRetriever) + _, err := retriever.GetSimilarSongsByTrack(GinkgoT().Context(), "track-1", "Test", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByAlbum)", func() { + retriever := partialAgent.(agents.SimilarSongsByAlbumRetriever) + _, err := retriever.GetSimilarSongsByAlbum(GinkgoT().Context(), "album-1", "Album", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) + + It("returns ErrNotFound for unimplemented method (GetSimilarSongsByArtist)", func() { + retriever := partialAgent.(agents.SimilarSongsByArtistRetriever) + _, err := retriever.GetSimilarSongsByArtist(GinkgoT().Context(), "artist-1", "Artist", "mbid", 5) + Expect(err).To(MatchError(errNotImplemented)) + }) +}) diff --git a/plugins/migrate.go b/plugins/migrate.go new file mode 100644 index 000000000..332e34838 --- /dev/null +++ b/plugins/migrate.go @@ -0,0 +1,47 @@ +package plugins + +import ( + "database/sql" + "fmt" +) + +// migrateDB applies schema migrations to a SQLite database. +// +// Each entry in migrations is a single SQL statement. The current schema version +// is tracked using SQLite's built-in PRAGMA user_version. Only statements after +// the current version are executed, within a single transaction. +func migrateDB(db *sql.DB, migrations []string) error { + var version int + if err := db.QueryRow(`PRAGMA user_version`).Scan(&version); err != nil { + return fmt.Errorf("reading schema version: %w", err) + } + + if version >= len(migrations) { + return nil + } + + tx, err := db.Begin() + if err != nil { + return fmt.Errorf("starting migration transaction: %w", err) + } + defer func() { _ = tx.Rollback() }() + + for i := version; i < len(migrations); i++ { + if _, err := tx.Exec(migrations[i]); err != nil { + return fmt.Errorf("migration %d failed: %w", i+1, err) + } + } + + // PRAGMA statements cannot be executed inside a transaction in some SQLite + // drivers, but with mattn/go-sqlite3 this works. We set it inside the tx + // so that a failed commit leaves the version unchanged. + if _, err := tx.Exec(fmt.Sprintf(`PRAGMA user_version = %d`, len(migrations))); err != nil { + return fmt.Errorf("updating schema version: %w", err) + } + + if err := tx.Commit(); err != nil { + return fmt.Errorf("committing migrations: %w", err) + } + + return nil +} diff --git a/plugins/migrate_test.go b/plugins/migrate_test.go new file mode 100644 index 000000000..568ad34cb --- /dev/null +++ b/plugins/migrate_test.go @@ -0,0 +1,97 @@ +package plugins + +import ( + "database/sql" + + _ "github.com/mattn/go-sqlite3" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("migrateDB", func() { + var db *sql.DB + + BeforeEach(func() { + var err error + db, err = sql.Open("sqlite3", ":memory:") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + if db != nil { + db.Close() + } + }) + + getUserVersion := func() int { + var version int + Expect(db.QueryRow(`PRAGMA user_version`).Scan(&version)).To(Succeed()) + return version + } + + It("applies all migrations on a fresh database", func() { + migrations := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY, name TEXT)`, + `ALTER TABLE test ADD COLUMN email TEXT`, + } + + Expect(migrateDB(db, migrations)).To(Succeed()) + Expect(getUserVersion()).To(Equal(2)) + + // Verify schema + _, err := db.Exec(`INSERT INTO test (id, name, email) VALUES (1, 'Alice', 'alice@test.com')`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("skips already applied migrations", func() { + migrations1 := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY, name TEXT)`, + } + Expect(migrateDB(db, migrations1)).To(Succeed()) + Expect(getUserVersion()).To(Equal(1)) + + // Add a new migration + migrations2 := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY, name TEXT)`, + `ALTER TABLE test ADD COLUMN email TEXT`, + } + Expect(migrateDB(db, migrations2)).To(Succeed()) + Expect(getUserVersion()).To(Equal(2)) + + // Verify the new column exists + _, err := db.Exec(`INSERT INTO test (id, name, email) VALUES (1, 'Alice', 'alice@test.com')`) + Expect(err).ToNot(HaveOccurred()) + }) + + It("is a no-op when all migrations are applied", func() { + migrations := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY)`, + } + Expect(migrateDB(db, migrations)).To(Succeed()) + Expect(migrateDB(db, migrations)).To(Succeed()) + Expect(getUserVersion()).To(Equal(1)) + }) + + It("is a no-op with empty migrations slice", func() { + Expect(migrateDB(db, nil)).To(Succeed()) + Expect(getUserVersion()).To(Equal(0)) + }) + + It("rolls back on failure", func() { + migrations := []string{ + `CREATE TABLE test (id INTEGER PRIMARY KEY)`, + `INVALID SQL STATEMENT`, + } + + err := migrateDB(db, migrations) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("migration 2 failed")) + + // Version should remain 0 (rolled back) + Expect(getUserVersion()).To(Equal(0)) + + // Table should not exist (rolled back) + _, err = db.Exec(`INSERT INTO test (id) VALUES (1)`) + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/plugins/package.go b/plugins/package.go new file mode 100644 index 000000000..475761231 --- /dev/null +++ b/plugins/package.go @@ -0,0 +1,112 @@ +package plugins + +import ( + "archive/zip" + "errors" + "fmt" + "io" +) + +const ( + // PackageExtension is the file extension for Navidrome plugin packages. + PackageExtension = ".ndp" + + // manifestFileName is the name of the manifest file inside the package. + manifestFileName = "manifest.json" + + // wasmFileName is the name of the WebAssembly module inside the package. + wasmFileName = "plugin.wasm" +) + +// ndpPackage represents a loaded .ndp plugin package. +// It contains the manifest and wasm bytes read from the archive. +type ndpPackage struct { + Manifest *Manifest + WasmBytes []byte +} + +// openPackage opens an .ndp file and extracts the manifest and wasm bytes. +// The caller does not need to call Close() - all resources are read into memory. +func openPackage(ndpPath string) (*ndpPackage, error) { + // Open the zip archive + zr, err := zip.OpenReader(ndpPath) + if err != nil { + return nil, fmt.Errorf("opening package: %w", err) + } + defer zr.Close() + + var manifestBytes []byte + var wasmBytes []byte + + for _, f := range zr.File { + switch f.Name { + case manifestFileName: + manifestBytes, err = readZipFile(f) + if err != nil { + return nil, fmt.Errorf("reading manifest: %w", err) + } + case wasmFileName: + wasmBytes, err = readZipFile(f) + if err != nil { + return nil, fmt.Errorf("reading wasm: %w", err) + } + } + } + + if manifestBytes == nil { + return nil, errors.New("package missing manifest.json") + } + if wasmBytes == nil { + return nil, errors.New("package missing plugin.wasm") + } + + // Parse and validate manifest + manifest, err := ParseManifest(manifestBytes) + if err != nil { + return nil, fmt.Errorf("parsing manifest: %w", err) + } + + return &ndpPackage{ + Manifest: manifest, + WasmBytes: wasmBytes, + }, nil +} + +// readManifest reads only the manifest from an .ndp file without loading the wasm bytes. +// This is useful for quick plugin discovery. +func readManifest(ndpPath string) (*Manifest, error) { + // Open the zip archive + zr, err := zip.OpenReader(ndpPath) + if err != nil { + return nil, fmt.Errorf("opening package: %w", err) + } + defer zr.Close() + + for _, f := range zr.File { + if f.Name == manifestFileName { + manifestBytes, err := readZipFile(f) + if err != nil { + return nil, fmt.Errorf("reading manifest: %w", err) + } + + manifest, err := ParseManifest(manifestBytes) + if err != nil { + return nil, fmt.Errorf("parsing manifest: %w", err) + } + + return manifest, nil + } + } + + return nil, errors.New("package missing manifest.json") +} + +// readZipFile reads the contents of a file from a zip archive. +func readZipFile(f *zip.File) ([]byte, error) { + rc, err := f.Open() + if err != nil { + return nil, err + } + defer rc.Close() + return io.ReadAll(rc) +} diff --git a/plugins/package_test.go b/plugins/package_test.go new file mode 100644 index 000000000..3d3fec022 --- /dev/null +++ b/plugins/package_test.go @@ -0,0 +1,269 @@ +package plugins + +import ( + "archive/zip" + "encoding/json" + "fmt" + "os" + "path/filepath" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ndpPackage", func() { + var tmpDir string + + BeforeEach(func() { + var err error + tmpDir, err = os.MkdirTemp("", "plugin-package-test-*") + Expect(err).ToNot(HaveOccurred()) + }) + + AfterEach(func() { + os.RemoveAll(tmpDir) + }) + + Describe("openPackage", func() { + It("should load a valid .ndp package", func() { + ndpPath := filepath.Join(tmpDir, "test.ndp") + manifest := &Manifest{ + Name: "Test Plugin", + Author: "Test Author", + Version: "1.0.0", + } + wasmBytes := []byte{0x00, 0x61, 0x73, 0x6d} // Minimal wasm header + + err := createTestPackage(ndpPath, manifest, wasmBytes) + Expect(err).ToNot(HaveOccurred()) + + pkg, err := openPackage(ndpPath) + Expect(err).ToNot(HaveOccurred()) + Expect(pkg.Manifest.Name).To(Equal("Test Plugin")) + Expect(pkg.Manifest.Author).To(Equal("Test Author")) + Expect(pkg.Manifest.Version).To(Equal("1.0.0")) + Expect(pkg.WasmBytes).To(Equal(wasmBytes)) + }) + + It("should return error for missing manifest.json", func() { + ndpPath := filepath.Join(tmpDir, "no-manifest.ndp") + + // Create a zip with only plugin.wasm + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing manifest.json")) + }) + + It("should return error for missing plugin.wasm", func() { + ndpPath := filepath.Join(tmpDir, "no-wasm.ndp") + + // Create a zip with only manifest.json + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("manifest.json", []byte(`{"name":"Test","author":"Test","version":"1.0.0"}`)) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing plugin.wasm")) + }) + + It("should return error for invalid manifest JSON", func() { + ndpPath := filepath.Join(tmpDir, "invalid-json.ndp") + + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("manifest.json", []byte(`{invalid json}`)) + Expect(err).ToNot(HaveOccurred()) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("parsing manifest")) + }) + + It("should return error for manifest missing required fields", func() { + ndpPath := filepath.Join(tmpDir, "invalid-manifest.ndp") + + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("manifest.json", []byte(`{"name":"Test"}`)) // Missing author and version + Expect(err).ToNot(HaveOccurred()) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = openPackage(ndpPath) + Expect(err).To(HaveOccurred()) + // JSON schema validation happens during unmarshaling + Expect(err.Error()).To(ContainSubstring("parsing manifest")) + Expect(err.Error()).To(ContainSubstring("author")) + }) + + It("should return error for non-existent file", func() { + _, err := openPackage(filepath.Join(tmpDir, "nonexistent.ndp")) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("opening package")) + }) + }) + + Describe("readManifest", func() { + It("should read only the manifest without loading wasm", func() { + ndpPath := filepath.Join(tmpDir, "test.ndp") + manifest := &Manifest{ + Name: "Test Plugin", + Author: "Test Author", + Version: "1.0.0", + Description: new("A test plugin"), + } + wasmBytes := make([]byte, 1024*1024) // 1MB of zeros + + err := createTestPackage(ndpPath, manifest, wasmBytes) + Expect(err).ToNot(HaveOccurred()) + + m, err := readManifest(ndpPath) + Expect(err).ToNot(HaveOccurred()) + Expect(m.Name).To(Equal("Test Plugin")) + Expect(*m.Description).To(Equal("A test plugin")) + }) + + It("should return error for missing manifest", func() { + ndpPath := filepath.Join(tmpDir, "no-manifest.ndp") + + f, err := os.Create(ndpPath) + Expect(err).ToNot(HaveOccurred()) + defer f.Close() + + zw := newTestZipWriter(f) + err = zw.addFile("plugin.wasm", []byte{0x00}) + Expect(err).ToNot(HaveOccurred()) + err = zw.close() + Expect(err).ToNot(HaveOccurred()) + + _, err = readManifest(ndpPath) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("missing manifest.json")) + }) + }) + + Describe("ComputePackageSHA256", func() { + It("should compute consistent hash for same file", func() { + ndpPath := filepath.Join(tmpDir, "test.ndp") + manifest := &Manifest{ + Name: "Test Plugin", + Author: "Test Author", + Version: "1.0.0", + } + wasmBytes := []byte{0x00, 0x61, 0x73, 0x6d} + + err := createTestPackage(ndpPath, manifest, wasmBytes) + Expect(err).ToNot(HaveOccurred()) + + hash1, err := computeFileSHA256(ndpPath) + Expect(err).ToNot(HaveOccurred()) + + hash2, err := computeFileSHA256(ndpPath) + Expect(err).ToNot(HaveOccurred()) + + Expect(hash1).To(Equal(hash2)) + Expect(hash1).To(HaveLen(64)) // SHA-256 produces 64 hex characters + }) + }) +}) + +// testZipHelper is a helper for creating test zip files with specific contents +type testZipHelper struct { + f *os.File + entries []zipEntry +} + +type zipEntry struct { + name string + data []byte +} + +func newTestZipWriter(f *os.File) *testZipHelper { + return &testZipHelper{f: f} +} + +func (h *testZipHelper) addFile(name string, data []byte) error { + h.entries = append(h.entries, zipEntry{name: name, data: data}) + return nil +} + +func (h *testZipHelper) close() error { + zw := zip.NewWriter(h.f) + for _, e := range h.entries { + w, err := zw.Create(e.name) + if err != nil { + return err + } + if _, err := w.Write(e.data); err != nil { + return err + } + } + return zw.Close() +} + +// createTestPackage creates an .ndp package file from a manifest and wasm bytes. +// This is primarily used for testing. +func createTestPackage(ndpPath string, manifest *Manifest, wasmBytes []byte) error { + f, err := os.Create(ndpPath) + if err != nil { + return fmt.Errorf("creating package file: %w", err) + } + defer f.Close() + + zw := zip.NewWriter(f) + defer zw.Close() + + // Write manifest.json + manifestBytes, err := json.Marshal(manifest) + if err != nil { + return fmt.Errorf("marshaling manifest: %w", err) + } + + mw, err := zw.Create(manifestFileName) + if err != nil { + return fmt.Errorf("creating manifest in zip: %w", err) + } + if _, err := mw.Write(manifestBytes); err != nil { + return fmt.Errorf("writing manifest: %w", err) + } + + // Write plugin.wasm + ww, err := zw.Create(wasmFileName) + if err != nil { + return fmt.Errorf("creating wasm in zip: %w", err) + } + if _, err := ww.Write(wasmBytes); err != nil { + return fmt.Errorf("writing wasm: %w", err) + } + + return nil +} diff --git a/plugins/pdk/go/README.md b/plugins/pdk/go/README.md new file mode 100644 index 000000000..70c680b1f --- /dev/null +++ b/plugins/pdk/go/README.md @@ -0,0 +1,379 @@ +# Navidrome Plugin Development Kit for Go + +This directory contains the auto-generated Go PDK (Plugin Development Kit) for building Navidrome plugins. +The PDK provides both **host function wrappers** for interacting with Navidrome and +**capability interfaces** for implementing plugin functionality. + +## ⚠️ Auto-Generated Code + +**Do not edit files in this directory manually.** They are generated by the `ndpgen` tool. + +To regenerate: + +```bash +make gen +``` + +## Module Structure + +This is a consolidated Go module that includes: + +- `host/` - Host function wrappers for calling Navidrome services from plugins +- `lifecycle/` - Plugin lifecycle hooks (initialization) +- `metadata/` - Metadata agent capability for artist/album info +- `scheduler/` - Scheduler callback capability for scheduled tasks +- `scrobbler/` - Scrobbler capability for play tracking +- `websocket/` - WebSocket callback capability for real-time messages + +## Usage + +Add this module as a dependency in your plugin's `go.mod`: + +```go +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go +``` + +Then import the packages you need: + +```go +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" +) + +func init() { + lifecycle.Register(&myPlugin{}) + scheduler.Register(&myPlugin{}) +} + +type myPlugin struct{} + +func (p *myPlugin) OnInit() error { + // Initialize your plugin + return nil +} + +func (p *myPlugin) OnCallback(req scheduler.SchedulerCallbackRequest) error { + // Handle scheduled task + return host.WebSocketBroadcast("task-complete", req.ScheduleID) +} + +func main() {} +``` + +## Host Services + +The `host` package provides wrappers for calling Navidrome's host services: + +| Service | Description | +|---------------|----------------------------------------------------| +| `Artwork` | Access album and artist artwork | +| `Cache` | Temporary key-value storage with TTL | +| `KVStore` | Persistent key-value storage | +| `Library` | Access the music library (albums, artists, tracks) | +| `Scheduler` | Schedule one-time and recurring tasks | +| `SubsonicAPI` | Make Subsonic API calls | +| `WebSocket` | Send real-time messages to clients | + +### Example: Using Host Services + +```go +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" +) + +func myPluginFunction() error { + // Use the cache service + _, err := host.CacheSetString("my_key", "my_value", 3600) + if err != nil { + return err + } + + // Schedule a recurring task + _, err = host.SchedulerScheduleRecurring("@every 5m", "payload", "task_id") + if err != nil { + return err + } + + // Access library data with typed structs + resp, err := host.LibraryGetAllLibraries() + if err != nil { + return err + } + for _, lib := range resp.Result { + // Library: %s with %d songs", lib.Name, lib.TotalSongs + } + + return nil +} +``` + +## Capabilities + +Capabilities define what functionality your plugin implements. Register your implementations +in the `init()` function. + +### Lifecycle + +Provides plugin initialization hooks. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/lifecycle" + +func init() { + lifecycle.Register(&myPlugin{}) +} + +type myPlugin struct{} + +func (p *myPlugin) OnInit() error { + // Called once when plugin is loaded + return nil +} +``` + +### MetadataAgent + +Provides artist and album metadata from external sources. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + +func init() { + metadata.Register(&myAgent{}) +} + +type myAgent struct{} + +func (a *myAgent) GetArtistBiography(req metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{ + Biography: "Artist biography text...", + }, nil +} + +func (a *myAgent) GetArtistImages(req metadata.ArtistRequest) (*metadata.ArtistImagesResponse, error) { + return &metadata.ArtistImagesResponse{ + Images: []metadata.ImageInfo{ + {URL: "https://example.com/image.jpg", Size: 1000}, + }, + }, nil +} +``` + +### Scheduler + +Handles callbacks from scheduled tasks. + +```go +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" +) + +func init() { + scheduler.Register(&myScheduler{}) +} + +type myScheduler struct{} + +func (s *myScheduler) OnCallback(req scheduler.SchedulerCallbackRequest) error { + // Handle the scheduled task + if req.Payload == "update-data" { + // Do work... + return host.WebSocketBroadcast("data-updated", "") + } + return nil +} +``` + +### Scrobbler + +Tracks play activity. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/scrobbler" + +func init() { + scrobbler.Register(&myScrobbler{}) +} + +type myScrobbler struct{} + +func (s *myScrobbler) Scrobble(req scrobbler.ScrobbleRequest) error { + // Track the play + return nil +} + +func (s *myScrobbler) NowPlaying(req scrobbler.NowPlayingRequest) error { + // Update now playing status + return nil +} +``` + +### WebSocket + +Handles incoming WebSocket messages. + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/websocket" + +func init() { + websocket.Register(&myHandler{}) +} + +type myHandler struct{} + +func (h *myHandler) OnWebSocketMessage(req websocket.WebSocketMessageRequest) error { + // Handle incoming message + return nil +} +``` + +## Building Plugins + +Go plugins must be compiled to WebAssembly using TinyGo: + +```bash +tinygo build -o plugin.wasm -target=wasip1 -buildmode=c-shared . +``` + +Or use the provided Makefile targets in plugin examples: + +```bash +make plugin.wasm +``` + +## Testing Plugins + +The PDK includes [testify/mock](https://github.com/stretchr/testify) implementations for all host services, +allowing you to unit test your plugin code on non-WASM platforms (your development machine). + +### PDK Abstraction Layer + +The `pdk` subpackage provides a testable wrapper around the Extism PDK functions. Instead of importing +`github.com/extism/go-pdk` directly, import the abstraction layer: + +```go +import "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + +func myFunction() { + // Use pdk functions - same API as extism/go-pdk + config, ok := pdk.GetConfig("my_setting") + if ok { + pdk.Log(pdk.LogInfo, "Setting: " + config) + } + + var input MyInput + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return + } + + output := processInput(input) + pdk.OutputJSON(output) +} +``` + +For WASM builds, these functions delegate directly to `extism/go-pdk` with zero overhead. +For native builds (tests), they use mocks that you can configure: + +```go +package myplugin + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +func TestMyFunction(t *testing.T) { + // Reset mock state before each test + pdk.ResetMock() + + // Set up expectations + pdk.PDKMock.On("GetConfig", "my_setting").Return("test_value", true) + pdk.PDKMock.On("Log", pdk.LogInfo, "Setting: test_value").Return() + pdk.PDKMock.On("InputJSON", mock.Anything).Return(nil).Run(func(args mock.Arguments) { + // Populate the input struct + input := args.Get(0).(*MyInput) + input.Name = "test" + }) + pdk.PDKMock.On("OutputJSON", mock.Anything).Return(nil) + + // Call your function + myFunction() + + // Verify expectations + pdk.PDKMock.AssertExpectations(t) +} +``` + +### Mock Instances + +Each host service has an auto-instantiated mock instance: + +| Service | Mock Instance | +|---------------|--------------------------| +| `Artwork` | `host.ArtworkMock` | +| `Cache` | `host.CacheMock` | +| `Config` | `host.ConfigMock` | +| `KVStore` | `host.KVStoreMock` | +| `Library` | `host.LibraryMock` | +| `Scheduler` | `host.SchedulerMock` | +| `SubsonicAPI` | `host.SubsonicAPIMock` | +| `WebSocket` | `host.WebSocketMock` | + +### Example Test + +```go +package myplugin + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" +) + +func TestMyPluginFunction(t *testing.T) { + // Set expectations on the mock + host.CacheMock.On("GetString", "my-key").Return("cached-value", true, nil) + host.CacheMock.On("SetString", "new-key", "new-value", int64(3600)).Return(nil) + + // Call your plugin code that uses host.CacheGetString / host.CacheSetString + result, err := myPluginFunction() + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Assert the result + if result != "expected" { + t.Errorf("unexpected result: %s", result) + } + + // Verify all expected calls were made + host.CacheMock.AssertExpectations(t) +} +``` + +### Running Tests + +Since tests run on your development machine (not WASM), use standard Go testing: + +```bash +go test ./... +``` + +The stub files with mocks are only compiled for non-WASM builds (`//go:build !wasip1`), +so they won't affect your production WASM binary. + +### Complete Examples + +For more comprehensive examples including HTTP requests, Memory handling, and various testing patterns, +see [pdk/example_test.go](pdk/example_test.go). diff --git a/plugins/pdk/go/go.mod b/plugins/pdk/go/go.mod new file mode 100644 index 000000000..4d5fcddfc --- /dev/null +++ b/plugins/pdk/go/go.mod @@ -0,0 +1,15 @@ +module github.com/navidrome/navidrome/plugins/pdk/go + +go 1.25 + +require ( + github.com/extism/go-pdk v1.1.3 + github.com/stretchr/testify v1.11.1 +) + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) diff --git a/plugins/pdk/go/go.sum b/plugins/pdk/go/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/pdk/go/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/pdk/go/host/doc.go b/plugins/pdk/go/host/doc.go new file mode 100644 index 000000000..5781a04c1 --- /dev/null +++ b/plugins/pdk/go/host/doc.go @@ -0,0 +1,58 @@ +// Code generated by ndpgen. DO NOT EDIT. + +/* +Package host provides Navidrome Plugin Development Kit wrappers for Go/TinyGo plugins. + +This package is auto-generated by the ndpgen tool and should not be edited manually. + +# Usage + +Add this module as a dependency in your plugin's go.mod: + + require github.com/navidrome/navidrome/plugins/pdk/go/host v0.0.0 + +Then import the package in your plugin code: + + import host "github.com/navidrome/navidrome/plugins/pdk/go/host" + + func myPluginFunction() error { + // Use the cache service + _, err := host.CacheSetString("my_key", "my_value", 3600) + if err != nil { + return err + } + + // Schedule a recurring task + _, err = host.SchedulerScheduleRecurring("@every 5m", "payload", "task_id") + if err != nil { + return err + } + + return nil + } + +# Available Services + +The following host services are available: + + - Artwork: provides artwork public URL generation capabilities for plugins. + - Cache: provides in-memory TTL-based caching capabilities for plugins. + - Config: provides access to plugin configuration values. + - HTTP: provides outbound HTTP request capabilities for plugins. + - KVStore: provides persistent key-value storage for plugins. + - Library: provides access to music library metadata for plugins. + - Scheduler: provides task scheduling capabilities for plugins. + - SubsonicAPI: provides access to Navidrome's Subsonic API from plugins. + - Task: provides persistent task queues for plugins. + - Users: provides access to user information for plugins. + - WebSocket: provides WebSocket communication capabilities for plugins. + +# Building Plugins + +Go plugins must be compiled to WebAssembly using TinyGo: + + tinygo build -o plugin.wasm -target=wasip1 -buildmode=c-shared . + +See the examples directory for complete plugin implementations. +*/ +package host diff --git a/plugins/pdk/go/host/nd_host_artwork.go b/plugins/pdk/go/host/nd_host_artwork.go new file mode 100644 index 000000000..05fcdebe2 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_artwork.go @@ -0,0 +1,243 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Artwork host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// artwork_getartisturl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_getartisturl +func artwork_getartisturl(uint64) uint64 + +// artwork_getalbumurl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_getalbumurl +func artwork_getalbumurl(uint64) uint64 + +// artwork_gettrackurl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_gettrackurl +func artwork_gettrackurl(uint64) uint64 + +// artwork_getplaylisturl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user artwork_getplaylisturl +func artwork_getplaylisturl(uint64) uint64 + +type artworkGetArtistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetArtistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +type artworkGetAlbumUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetAlbumUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +type artworkGetTrackUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetTrackUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +type artworkGetPlaylistUrlRequest struct { + Id string `json:"id"` + Size int32 `json:"size"` +} + +type artworkGetPlaylistUrlResponse struct { + Url string `json:"url,omitempty"` + Error string `json:"error,omitempty"` +} + +// ArtworkGetArtistUrl calls the artwork_getartisturl host function. +// GetArtistUrl generates a public URL for an artist's artwork. +// +// Parameters: +// - id: The artist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetArtistUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetArtistUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_getartisturl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetArtistUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} + +// ArtworkGetAlbumUrl calls the artwork_getalbumurl host function. +// GetAlbumUrl generates a public URL for an album's artwork. +// +// Parameters: +// - id: The album's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetAlbumUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetAlbumUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_getalbumurl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetAlbumUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} + +// ArtworkGetTrackUrl calls the artwork_gettrackurl host function. +// GetTrackUrl generates a public URL for a track's artwork. +// +// Parameters: +// - id: The track's (media file) unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetTrackUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetTrackUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_gettrackurl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetTrackUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} + +// ArtworkGetPlaylistUrl calls the artwork_getplaylisturl host function. +// GetPlaylistUrl generates a public URL for a playlist's artwork. +// +// Parameters: +// - id: The playlist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetPlaylistUrl(id string, size int32) (string, error) { + // Marshal request to JSON + req := artworkGetPlaylistUrlRequest{ + Id: id, + Size: size, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := artwork_getplaylisturl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response artworkGetPlaylistUrlResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Url, nil +} diff --git a/plugins/pdk/go/host/nd_host_artwork_stub.go b/plugins/pdk/go/host/nd_host_artwork_stub.go new file mode 100644 index 000000000..aa41e440c --- /dev/null +++ b/plugins/pdk/go/host/nd_host_artwork_stub.go @@ -0,0 +1,92 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockArtworkService is the mock implementation for testing. +type mockArtworkService struct { + mock.Mock +} + +// ArtworkMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.ArtworkMock.On("MethodName", args...).Return(values...) +var ArtworkMock = &mockArtworkService{} + +// GetArtistUrl is the mock method for ArtworkGetArtistUrl. +func (m *mockArtworkService) GetArtistUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetArtistUrl delegates to the mock instance. +// GetArtistUrl generates a public URL for an artist's artwork. +// +// Parameters: +// - id: The artist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetArtistUrl(id string, size int32) (string, error) { + return ArtworkMock.GetArtistUrl(id, size) +} + +// GetAlbumUrl is the mock method for ArtworkGetAlbumUrl. +func (m *mockArtworkService) GetAlbumUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetAlbumUrl delegates to the mock instance. +// GetAlbumUrl generates a public URL for an album's artwork. +// +// Parameters: +// - id: The album's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetAlbumUrl(id string, size int32) (string, error) { + return ArtworkMock.GetAlbumUrl(id, size) +} + +// GetTrackUrl is the mock method for ArtworkGetTrackUrl. +func (m *mockArtworkService) GetTrackUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetTrackUrl delegates to the mock instance. +// GetTrackUrl generates a public URL for a track's artwork. +// +// Parameters: +// - id: The track's (media file) unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetTrackUrl(id string, size int32) (string, error) { + return ArtworkMock.GetTrackUrl(id, size) +} + +// GetPlaylistUrl is the mock method for ArtworkGetPlaylistUrl. +func (m *mockArtworkService) GetPlaylistUrl(id string, size int32) (string, error) { + args := m.Called(id, size) + return args.String(0), args.Error(1) +} + +// ArtworkGetPlaylistUrl delegates to the mock instance. +// GetPlaylistUrl generates a public URL for a playlist's artwork. +// +// Parameters: +// - id: The playlist's unique identifier +// - size: Desired image size in pixels (0 for original size) +// +// Returns the public URL for the artwork, or an error if generation fails. +func ArtworkGetPlaylistUrl(id string, size int32) (string, error) { + return ArtworkMock.GetPlaylistUrl(id, size) +} diff --git a/plugins/pdk/go/host/nd_host_cache.go b/plugins/pdk/go/host/nd_host_cache.go new file mode 100644 index 000000000..7fd9d10fa --- /dev/null +++ b/plugins/pdk/go/host/nd_host_cache.go @@ -0,0 +1,557 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Cache host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// cache_setstring is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setstring +func cache_setstring(uint64) uint64 + +// cache_getstring is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getstring +func cache_getstring(uint64) uint64 + +// cache_setint is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setint +func cache_setint(uint64) uint64 + +// cache_getint is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getint +func cache_getint(uint64) uint64 + +// cache_setfloat is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setfloat +func cache_setfloat(uint64) uint64 + +// cache_getfloat is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getfloat +func cache_getfloat(uint64) uint64 + +// cache_setbytes is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_setbytes +func cache_setbytes(uint64) uint64 + +// cache_getbytes is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_getbytes +func cache_getbytes(uint64) uint64 + +// cache_has is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_has +func cache_has(uint64) uint64 + +// cache_remove is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user cache_remove +func cache_remove(uint64) uint64 + +type cacheSetStringRequest struct { + Key string `json:"key"` + Value string `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetStringRequest struct { + Key string `json:"key"` +} + +type cacheGetStringResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheSetIntRequest struct { + Key string `json:"key"` + Value int64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetIntRequest struct { + Key string `json:"key"` +} + +type cacheGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheSetFloatRequest struct { + Key string `json:"key"` + Value float64 `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetFloatRequest struct { + Key string `json:"key"` +} + +type cacheGetFloatResponse struct { + Value float64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheSetBytesRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type cacheGetBytesRequest struct { + Key string `json:"key"` +} + +type cacheGetBytesResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheHasRequest struct { + Key string `json:"key"` +} + +type cacheHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type cacheRemoveRequest struct { + Key string `json:"key"` +} + +// CacheSetString calls the cache_setstring host function. +// SetString stores a string value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The string value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetString(key string, value string, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetStringRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setstring(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetString calls the cache_getstring host function. +// GetString retrieves a string value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a string, exists will be false. +func CacheGetString(key string) (string, bool, error) { + // Marshal request to JSON + req := cacheGetStringRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getstring(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetStringResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheSetInt calls the cache_setint host function. +// SetInt stores an integer value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The integer value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetInt(key string, value int64, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetIntRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setint(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetInt calls the cache_getint host function. +// GetInt retrieves an integer value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not an integer, exists will be false. +func CacheGetInt(key string) (int64, bool, error) { + // Marshal request to JSON + req := cacheGetIntRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getint(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetIntResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheSetFloat calls the cache_setfloat host function. +// SetFloat stores a float value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The float value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetFloat(key string, value float64, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetFloatRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setfloat(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetFloat calls the cache_getfloat host function. +// GetFloat retrieves a float value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a float, exists will be false. +func CacheGetFloat(key string) (float64, bool, error) { + // Marshal request to JSON + req := cacheGetFloatRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getfloat(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetFloatResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheSetBytes calls the cache_setbytes host function. +// SetBytes stores a byte slice in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetBytes(key string, value []byte, ttlSeconds int64) error { + // Marshal request to JSON + req := cacheSetBytesRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_setbytes(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// CacheGetBytes calls the cache_getbytes host function. +// GetBytes retrieves a byte slice from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a byte slice, exists will be false. +func CacheGetBytes(key string) ([]byte, bool, error) { + // Marshal request to JSON + req := cacheGetBytesRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_getbytes(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheGetBytesResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// CacheHas calls the cache_has host function. +// Has checks if a key exists in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns true if the key exists and has not expired. +func CacheHas(key string) (bool, error) { + // Marshal request to JSON + req := cacheHasRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_has(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response cacheHasResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return false, errors.New(response.Error) + } + + return response.Exists, nil +} + +// CacheRemove calls the cache_remove host function. +// Remove deletes a value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func CacheRemove(key string) error { + // Marshal request to JSON + req := cacheRemoveRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := cache_remove(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/pdk/go/host/nd_host_cache_stub.go b/plugins/pdk/go/host/nd_host_cache_stub.go new file mode 100644 index 000000000..fbd80d13f --- /dev/null +++ b/plugins/pdk/go/host/nd_host_cache_stub.go @@ -0,0 +1,202 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockCacheService is the mock implementation for testing. +type mockCacheService struct { + mock.Mock +} + +// CacheMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.CacheMock.On("MethodName", args...).Return(values...) +var CacheMock = &mockCacheService{} + +// SetString is the mock method for CacheSetString. +func (m *mockCacheService) SetString(key string, value string, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetString delegates to the mock instance. +// SetString stores a string value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The string value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetString(key string, value string, ttlSeconds int64) error { + return CacheMock.SetString(key, value, ttlSeconds) +} + +// GetString is the mock method for CacheGetString. +func (m *mockCacheService) GetString(key string) (string, bool, error) { + args := m.Called(key) + return args.String(0), args.Bool(1), args.Error(2) +} + +// CacheGetString delegates to the mock instance. +// GetString retrieves a string value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a string, exists will be false. +func CacheGetString(key string) (string, bool, error) { + return CacheMock.GetString(key) +} + +// SetInt is the mock method for CacheSetInt. +func (m *mockCacheService) SetInt(key string, value int64, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetInt delegates to the mock instance. +// SetInt stores an integer value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The integer value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetInt(key string, value int64, ttlSeconds int64) error { + return CacheMock.SetInt(key, value, ttlSeconds) +} + +// GetInt is the mock method for CacheGetInt. +func (m *mockCacheService) GetInt(key string) (int64, bool, error) { + args := m.Called(key) + return args.Get(0).(int64), args.Bool(1), args.Error(2) +} + +// CacheGetInt delegates to the mock instance. +// GetInt retrieves an integer value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not an integer, exists will be false. +func CacheGetInt(key string) (int64, bool, error) { + return CacheMock.GetInt(key) +} + +// SetFloat is the mock method for CacheSetFloat. +func (m *mockCacheService) SetFloat(key string, value float64, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetFloat delegates to the mock instance. +// SetFloat stores a float value in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The float value to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetFloat(key string, value float64, ttlSeconds int64) error { + return CacheMock.SetFloat(key, value, ttlSeconds) +} + +// GetFloat is the mock method for CacheGetFloat. +func (m *mockCacheService) GetFloat(key string) (float64, bool, error) { + args := m.Called(key) + return args.Get(0).(float64), args.Bool(1), args.Error(2) +} + +// CacheGetFloat delegates to the mock instance. +// GetFloat retrieves a float value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a float, exists will be false. +func CacheGetFloat(key string) (float64, bool, error) { + return CacheMock.GetFloat(key) +} + +// SetBytes is the mock method for CacheSetBytes. +func (m *mockCacheService) SetBytes(key string, value []byte, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// CacheSetBytes delegates to the mock instance. +// SetBytes stores a byte slice in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +// +// Returns an error if the operation fails. +func CacheSetBytes(key string, value []byte, ttlSeconds int64) error { + return CacheMock.SetBytes(key, value, ttlSeconds) +} + +// GetBytes is the mock method for CacheGetBytes. +func (m *mockCacheService) GetBytes(key string) ([]byte, bool, error) { + args := m.Called(key) + return args.Get(0).([]byte), args.Bool(1), args.Error(2) +} + +// CacheGetBytes delegates to the mock instance. +// GetBytes retrieves a byte slice from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns the value and whether the key exists. If the key doesn't exist +// or the stored value is not a byte slice, exists will be false. +func CacheGetBytes(key string) ([]byte, bool, error) { + return CacheMock.GetBytes(key) +} + +// Has is the mock method for CacheHas. +func (m *mockCacheService) Has(key string) (bool, error) { + args := m.Called(key) + return args.Bool(0), args.Error(1) +} + +// CacheHas delegates to the mock instance. +// Has checks if a key exists in the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns true if the key exists and has not expired. +func CacheHas(key string) (bool, error) { + return CacheMock.Has(key) +} + +// Remove is the mock method for CacheRemove. +func (m *mockCacheService) Remove(key string) error { + args := m.Called(key) + return args.Error(0) +} + +// CacheRemove delegates to the mock instance. +// Remove deletes a value from the cache. +// +// Parameters: +// - key: The cache key (will be namespaced with plugin ID) +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func CacheRemove(key string) error { + return CacheMock.Remove(key) +} diff --git a/plugins/pdk/go/host/nd_host_config.go b/plugins/pdk/go/host/nd_host_config.go new file mode 100644 index 000000000..1d913e626 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_config.go @@ -0,0 +1,161 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// config_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_get +func config_get(uint64) uint64 + +// config_getint is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_getint +func config_getint(uint64) uint64 + +// config_keys is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user config_keys +func config_keys(uint64) uint64 + +type configGetRequest struct { + Key string `json:"key"` +} + +type configGetResponse struct { + Value string `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +type configGetIntRequest struct { + Key string `json:"key"` +} + +type configGetIntResponse struct { + Value int64 `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` +} + +type configKeysRequest struct { + Prefix string `json:"prefix"` +} + +type configKeysResponse struct { + Keys []string `json:"keys,omitempty"` +} + +// ConfigGet calls the config_get host function. +// Get retrieves a configuration value as a string. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. +func ConfigGet(key string) (string, bool) { + // Marshal request to JSON + req := configGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", false + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", false + } + + return response.Value, response.Exists +} + +// ConfigGetInt calls the config_getint host function. +// GetInt retrieves a configuration value as an integer. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. If the key exists but the +// value cannot be parsed as an integer, exists will be false. +func ConfigGetInt(key string) (int64, bool) { + // Marshal request to JSON + req := configGetIntRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, false + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_getint(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configGetIntResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, false + } + + return response.Value, response.Exists +} + +// ConfigKeys calls the config_keys host function. +// Keys returns configuration keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by. If empty, returns all keys. +// +// Returns a sorted slice of matching configuration keys. +func ConfigKeys(prefix string) []string { + // Marshal request to JSON + req := configKeysRequest{ + Prefix: prefix, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := config_keys(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response configKeysResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil + } + + return response.Keys +} diff --git a/plugins/pdk/go/host/nd_host_config_stub.go b/plugins/pdk/go/host/nd_host_config_stub.go new file mode 100644 index 000000000..2b8485ce9 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_config_stub.go @@ -0,0 +1,72 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockConfigService is the mock implementation for testing. +type mockConfigService struct { + mock.Mock +} + +// ConfigMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.ConfigMock.On("MethodName", args...).Return(values...) +var ConfigMock = &mockConfigService{} + +// Get is the mock method for ConfigGet. +func (m *mockConfigService) Get(key string) (string, bool) { + args := m.Called(key) + return args.String(0), args.Bool(1) +} + +// ConfigGet delegates to the mock instance. +// Get retrieves a configuration value as a string. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. +func ConfigGet(key string) (string, bool) { + return ConfigMock.Get(key) +} + +// GetInt is the mock method for ConfigGetInt. +func (m *mockConfigService) GetInt(key string) (int64, bool) { + args := m.Called(key) + return args.Get(0).(int64), args.Bool(1) +} + +// ConfigGetInt delegates to the mock instance. +// GetInt retrieves a configuration value as an integer. +// +// Parameters: +// - key: The configuration key +// +// Returns the value and whether the key exists. If the key exists but the +// value cannot be parsed as an integer, exists will be false. +func ConfigGetInt(key string) (int64, bool) { + return ConfigMock.GetInt(key) +} + +// Keys is the mock method for ConfigKeys. +func (m *mockConfigService) Keys(prefix string) []string { + args := m.Called(prefix) + return args.Get(0).([]string) +} + +// ConfigKeys delegates to the mock instance. +// Keys returns configuration keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by. If empty, returns all keys. +// +// Returns a sorted slice of matching configuration keys. +func ConfigKeys(prefix string) []string { + return ConfigMock.Keys(prefix) +} diff --git a/plugins/pdk/go/host/nd_host_http.go b/plugins/pdk/go/host/nd_host_http.go new file mode 100644 index 000000000..d999d3718 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_http.go @@ -0,0 +1,90 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the HTTP host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// HTTPRequest represents the HTTPRequest data structure. +// HTTPRequest represents an outbound HTTP request from a plugin. +type HTTPRequest struct { + Method string `json:"method"` + URL string `json:"url"` + Headers map[string]string `json:"headers"` + NoFollowRedirects bool `json:"noFollowRedirects"` + Body []byte `json:"body"` + TimeoutMs int32 `json:"timeoutMs"` +} + +// HTTPResponse represents the HTTPResponse data structure. +// HTTPResponse represents the response from an outbound HTTP request. +type HTTPResponse struct { + StatusCode int32 `json:"statusCode"` + Headers map[string]string `json:"headers"` + Body []byte `json:"body"` +} + +// http_send is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user http_send +func http_send(uint64) uint64 + +type hTTPSendRequest struct { + Request HTTPRequest `json:"request"` +} + +type hTTPSendResponse struct { + Result *HTTPResponse `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// HTTPSend calls the http_send host function. +// Send executes an HTTP request and returns the response. +// +// Parameters: +// - request: The HTTP request to execute, including method, URL, headers, body, and timeout +// +// Returns the HTTP response with status code, headers, and body. +// Network errors, timeouts, and permission failures are returned as Go errors. +// Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. +func HTTPSend(request HTTPRequest) (*HTTPResponse, error) { + // Marshal request to JSON + req := hTTPSendRequest{ + Request: request, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := http_send(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response hTTPSendResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_http_stub.go b/plugins/pdk/go/host/nd_host_http_stub.go new file mode 100644 index 000000000..2f15a91a9 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_http_stub.go @@ -0,0 +1,58 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// HTTPRequest represents the HTTPRequest data structure. +// HTTPRequest represents an outbound HTTP request from a plugin. +type HTTPRequest struct { + Method string `json:"method"` + URL string `json:"url"` + Headers map[string]string `json:"headers"` + NoFollowRedirects bool `json:"noFollowRedirects"` + Body []byte `json:"body"` + TimeoutMs int32 `json:"timeoutMs"` +} + +// HTTPResponse represents the HTTPResponse data structure. +// HTTPResponse represents the response from an outbound HTTP request. +type HTTPResponse struct { + StatusCode int32 `json:"statusCode"` + Headers map[string]string `json:"headers"` + Body []byte `json:"body"` +} + +// mockHTTPService is the mock implementation for testing. +type mockHTTPService struct { + mock.Mock +} + +// HTTPMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.HTTPMock.On("MethodName", args...).Return(values...) +var HTTPMock = &mockHTTPService{} + +// Send is the mock method for HTTPSend. +func (m *mockHTTPService) Send(request HTTPRequest) (*HTTPResponse, error) { + args := m.Called(request) + return args.Get(0).(*HTTPResponse), args.Error(1) +} + +// HTTPSend delegates to the mock instance. +// Send executes an HTTP request and returns the response. +// +// Parameters: +// - request: The HTTP request to execute, including method, URL, headers, body, and timeout +// +// Returns the HTTP response with status code, headers, and body. +// Network errors, timeouts, and permission failures are returned as Go errors. +// Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. +func HTTPSend(request HTTPRequest) (*HTTPResponse, error) { + return HTTPMock.Send(request) +} diff --git a/plugins/pdk/go/host/nd_host_kvstore.go b/plugins/pdk/go/host/nd_host_kvstore.go new file mode 100644 index 000000000..15e1e366a --- /dev/null +++ b/plugins/pdk/go/host/nd_host_kvstore.go @@ -0,0 +1,481 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the KVStore host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// kvstore_set is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_set +func kvstore_set(uint64) uint64 + +// kvstore_setwithttl is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_setwithttl +func kvstore_setwithttl(uint64) uint64 + +// kvstore_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_get +func kvstore_get(uint64) uint64 + +// kvstore_getmany is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_getmany +func kvstore_getmany(uint64) uint64 + +// kvstore_has is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_has +func kvstore_has(uint64) uint64 + +// kvstore_list is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_list +func kvstore_list(uint64) uint64 + +// kvstore_delete is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_delete +func kvstore_delete(uint64) uint64 + +// kvstore_deletebyprefix is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_deletebyprefix +func kvstore_deletebyprefix(uint64) uint64 + +// kvstore_getstorageused is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user kvstore_getstorageused +func kvstore_getstorageused(uint64) uint64 + +type kVStoreSetRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` +} + +type kVStoreSetWithTTLRequest struct { + Key string `json:"key"` + Value []byte `json:"value"` + TtlSeconds int64 `json:"ttlSeconds"` +} + +type kVStoreGetRequest struct { + Key string `json:"key"` +} + +type kVStoreGetResponse struct { + Value []byte `json:"value,omitempty"` + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreGetManyRequest struct { + Keys []string `json:"keys"` +} + +type kVStoreGetManyResponse struct { + Values map[string][]byte `json:"values,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreHasRequest struct { + Key string `json:"key"` +} + +type kVStoreHasResponse struct { + Exists bool `json:"exists,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreListRequest struct { + Prefix string `json:"prefix"` +} + +type kVStoreListResponse struct { + Keys []string `json:"keys,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreDeleteRequest struct { + Key string `json:"key"` +} + +type kVStoreDeleteByPrefixRequest struct { + Prefix string `json:"prefix"` +} + +type kVStoreDeleteByPrefixResponse struct { + DeletedCount int64 `json:"deletedCount,omitempty"` + Error string `json:"error,omitempty"` +} + +type kVStoreGetStorageUsedResponse struct { + Bytes int64 `json:"bytes,omitempty"` + Error string `json:"error,omitempty"` +} + +// KVStoreSet calls the kvstore_set host function. +// Set stores a byte value with the given key. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSet(key string, value []byte) error { + // Marshal request to JSON + req := kVStoreSetRequest{ + Key: key, + Value: value, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_set(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// KVStoreSetWithTTL calls the kvstore_setwithttl host function. +// SetWithTTL stores a byte value with the given key and a time-to-live. +// +// After ttlSeconds, the key is treated as non-existent and will be +// cleaned up lazily. ttlSeconds must be greater than 0. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (must be > 0) +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSetWithTTL(key string, value []byte, ttlSeconds int64) error { + // Marshal request to JSON + req := kVStoreSetWithTTLRequest{ + Key: key, + Value: value, + TtlSeconds: ttlSeconds, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_setwithttl(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// KVStoreGet calls the kvstore_get host function. +// Get retrieves a byte value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns the value and whether the key exists. +func KVStoreGet(key string) ([]byte, bool, error) { + // Marshal request to JSON + req := kVStoreGetRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, false, errors.New(response.Error) + } + + return response.Value, response.Exists, nil +} + +// KVStoreGetMany calls the kvstore_getmany host function. +// GetMany retrieves multiple values in a single call. +// +// Parameters: +// - keys: The storage keys to retrieve +// +// Returns a map of key to value for keys that exist and have not expired. +// Missing or expired keys are omitted from the result. +func KVStoreGetMany(keys []string) (map[string][]byte, error) { + // Marshal request to JSON + req := kVStoreGetManyRequest{ + Keys: keys, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_getmany(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreGetManyResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Values, nil +} + +// KVStoreHas calls the kvstore_has host function. +// Has checks if a key exists in storage. +// +// Parameters: +// - key: The storage key +// +// Returns true if the key exists. +func KVStoreHas(key string) (bool, error) { + // Marshal request to JSON + req := kVStoreHasRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return false, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_has(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreHasResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return false, err + } + + // Convert Error field to Go error + if response.Error != "" { + return false, errors.New(response.Error) + } + + return response.Exists, nil +} + +// KVStoreList calls the kvstore_list host function. +// List returns all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by (empty string returns all keys) +// +// Returns a slice of matching keys. +func KVStoreList(prefix string) ([]string, error) { + // Marshal request to JSON + req := kVStoreListRequest{ + Prefix: prefix, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_list(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreListResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Keys, nil +} + +// KVStoreDelete calls the kvstore_delete host function. +// Delete removes a value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func KVStoreDelete(key string) error { + // Marshal request to JSON + req := kVStoreDeleteRequest{ + Key: key, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_delete(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// KVStoreDeleteByPrefix calls the kvstore_deletebyprefix host function. +// DeleteByPrefix removes all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to match (must not be empty) +// +// Returns the number of keys deleted. Includes expired keys. +func KVStoreDeleteByPrefix(prefix string) (int64, error) { + // Marshal request to JSON + req := kVStoreDeleteByPrefixRequest{ + Prefix: prefix, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_deletebyprefix(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreDeleteByPrefixResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.DeletedCount, nil +} + +// KVStoreGetStorageUsed calls the kvstore_getstorageused host function. +// GetStorageUsed returns the total storage used by this plugin in bytes. +func KVStoreGetStorageUsed() (int64, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := kvstore_getstorageused(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response kVStoreGetStorageUsedResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Bytes, nil +} diff --git a/plugins/pdk/go/host/nd_host_kvstore_stub.go b/plugins/pdk/go/host/nd_host_kvstore_stub.go new file mode 100644 index 000000000..83b55d3a8 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_kvstore_stub.go @@ -0,0 +1,175 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockKVStoreService is the mock implementation for testing. +type mockKVStoreService struct { + mock.Mock +} + +// KVStoreMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.KVStoreMock.On("MethodName", args...).Return(values...) +var KVStoreMock = &mockKVStoreService{} + +// Set is the mock method for KVStoreSet. +func (m *mockKVStoreService) Set(key string, value []byte) error { + args := m.Called(key, value) + return args.Error(0) +} + +// KVStoreSet delegates to the mock instance. +// Set stores a byte value with the given key. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSet(key string, value []byte) error { + return KVStoreMock.Set(key, value) +} + +// SetWithTTL is the mock method for KVStoreSetWithTTL. +func (m *mockKVStoreService) SetWithTTL(key string, value []byte, ttlSeconds int64) error { + args := m.Called(key, value, ttlSeconds) + return args.Error(0) +} + +// KVStoreSetWithTTL delegates to the mock instance. +// SetWithTTL stores a byte value with the given key and a time-to-live. +// +// After ttlSeconds, the key is treated as non-existent and will be +// cleaned up lazily. ttlSeconds must be greater than 0. +// +// Parameters: +// - key: The storage key (max 256 bytes, UTF-8) +// - value: The byte slice to store +// - ttlSeconds: Time-to-live in seconds (must be > 0) +// +// Returns an error if the storage limit would be exceeded or the operation fails. +func KVStoreSetWithTTL(key string, value []byte, ttlSeconds int64) error { + return KVStoreMock.SetWithTTL(key, value, ttlSeconds) +} + +// Get is the mock method for KVStoreGet. +func (m *mockKVStoreService) Get(key string) ([]byte, bool, error) { + args := m.Called(key) + return args.Get(0).([]byte), args.Bool(1), args.Error(2) +} + +// KVStoreGet delegates to the mock instance. +// Get retrieves a byte value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns the value and whether the key exists. +func KVStoreGet(key string) ([]byte, bool, error) { + return KVStoreMock.Get(key) +} + +// GetMany is the mock method for KVStoreGetMany. +func (m *mockKVStoreService) GetMany(keys []string) (map[string][]byte, error) { + args := m.Called(keys) + return args.Get(0).(map[string][]byte), args.Error(1) +} + +// KVStoreGetMany delegates to the mock instance. +// GetMany retrieves multiple values in a single call. +// +// Parameters: +// - keys: The storage keys to retrieve +// +// Returns a map of key to value for keys that exist and have not expired. +// Missing or expired keys are omitted from the result. +func KVStoreGetMany(keys []string) (map[string][]byte, error) { + return KVStoreMock.GetMany(keys) +} + +// Has is the mock method for KVStoreHas. +func (m *mockKVStoreService) Has(key string) (bool, error) { + args := m.Called(key) + return args.Bool(0), args.Error(1) +} + +// KVStoreHas delegates to the mock instance. +// Has checks if a key exists in storage. +// +// Parameters: +// - key: The storage key +// +// Returns true if the key exists. +func KVStoreHas(key string) (bool, error) { + return KVStoreMock.Has(key) +} + +// List is the mock method for KVStoreList. +func (m *mockKVStoreService) List(prefix string) ([]string, error) { + args := m.Called(prefix) + return args.Get(0).([]string), args.Error(1) +} + +// KVStoreList delegates to the mock instance. +// List returns all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to filter by (empty string returns all keys) +// +// Returns a slice of matching keys. +func KVStoreList(prefix string) ([]string, error) { + return KVStoreMock.List(prefix) +} + +// Delete is the mock method for KVStoreDelete. +func (m *mockKVStoreService) Delete(key string) error { + args := m.Called(key) + return args.Error(0) +} + +// KVStoreDelete delegates to the mock instance. +// Delete removes a value from storage. +// +// Parameters: +// - key: The storage key +// +// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +func KVStoreDelete(key string) error { + return KVStoreMock.Delete(key) +} + +// DeleteByPrefix is the mock method for KVStoreDeleteByPrefix. +func (m *mockKVStoreService) DeleteByPrefix(prefix string) (int64, error) { + args := m.Called(prefix) + return args.Get(0).(int64), args.Error(1) +} + +// KVStoreDeleteByPrefix delegates to the mock instance. +// DeleteByPrefix removes all keys matching the given prefix. +// +// Parameters: +// - prefix: Key prefix to match (must not be empty) +// +// Returns the number of keys deleted. Includes expired keys. +func KVStoreDeleteByPrefix(prefix string) (int64, error) { + return KVStoreMock.DeleteByPrefix(prefix) +} + +// GetStorageUsed is the mock method for KVStoreGetStorageUsed. +func (m *mockKVStoreService) GetStorageUsed() (int64, error) { + args := m.Called() + return args.Get(0).(int64), args.Error(1) +} + +// KVStoreGetStorageUsed delegates to the mock instance. +// GetStorageUsed returns the total storage used by this plugin in bytes. +func KVStoreGetStorageUsed() (int64, error) { + return KVStoreMock.GetStorageUsed() +} diff --git a/plugins/pdk/go/host/nd_host_library.go b/plugins/pdk/go/host/nd_host_library.go new file mode 100644 index 000000000..0107d1afe --- /dev/null +++ b/plugins/pdk/go/host/nd_host_library.go @@ -0,0 +1,124 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Library host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Library represents the Library data structure. +// Library represents a music library with metadata. +type Library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path"` + MountPoint string `json:"mountPoint"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` +} + +// library_getlibrary is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user library_getlibrary +func library_getlibrary(uint64) uint64 + +// library_getalllibraries is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user library_getalllibraries +func library_getalllibraries(uint64) uint64 + +type libraryGetLibraryRequest struct { + Id int32 `json:"id"` +} + +type libraryGetLibraryResponse struct { + Result *Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type libraryGetAllLibrariesResponse struct { + Result []Library `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// LibraryGetLibrary calls the library_getlibrary host function. +// GetLibrary retrieves metadata for a specific library by ID. +// +// Parameters: +// - id: The library's unique identifier +// +// Returns the library metadata, or an error if the library is not found. +func LibraryGetLibrary(id int32) (*Library, error) { + // Marshal request to JSON + req := libraryGetLibraryRequest{ + Id: id, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := library_getlibrary(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response libraryGetLibraryResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} + +// LibraryGetAllLibraries calls the library_getalllibraries host function. +// GetAllLibraries retrieves metadata for all configured libraries. +// +// Returns a slice of all libraries with their metadata. +func LibraryGetAllLibraries() ([]Library, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := library_getalllibraries(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response libraryGetAllLibrariesResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_library_stub.go b/plugins/pdk/go/host/nd_host_library_stub.go new file mode 100644 index 000000000..9ad0d97e7 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_library_stub.go @@ -0,0 +1,66 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// Library represents the Library data structure. +// Library represents a music library with metadata. +type Library struct { + ID int32 `json:"id"` + Name string `json:"name"` + Path string `json:"path"` + MountPoint string `json:"mountPoint"` + LastScanAt int64 `json:"lastScanAt"` + TotalSongs int32 `json:"totalSongs"` + TotalAlbums int32 `json:"totalAlbums"` + TotalArtists int32 `json:"totalArtists"` + TotalSize int64 `json:"totalSize"` + TotalDuration float64 `json:"totalDuration"` +} + +// mockLibraryService is the mock implementation for testing. +type mockLibraryService struct { + mock.Mock +} + +// LibraryMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.LibraryMock.On("MethodName", args...).Return(values...) +var LibraryMock = &mockLibraryService{} + +// GetLibrary is the mock method for LibraryGetLibrary. +func (m *mockLibraryService) GetLibrary(id int32) (*Library, error) { + args := m.Called(id) + return args.Get(0).(*Library), args.Error(1) +} + +// LibraryGetLibrary delegates to the mock instance. +// GetLibrary retrieves metadata for a specific library by ID. +// +// Parameters: +// - id: The library's unique identifier +// +// Returns the library metadata, or an error if the library is not found. +func LibraryGetLibrary(id int32) (*Library, error) { + return LibraryMock.GetLibrary(id) +} + +// GetAllLibraries is the mock method for LibraryGetAllLibraries. +func (m *mockLibraryService) GetAllLibraries() ([]Library, error) { + args := m.Called() + return args.Get(0).([]Library), args.Error(1) +} + +// LibraryGetAllLibraries delegates to the mock instance. +// GetAllLibraries retrieves metadata for all configured libraries. +// +// Returns a slice of all libraries with their metadata. +func LibraryGetAllLibraries() ([]Library, error) { + return LibraryMock.GetAllLibraries() +} diff --git a/plugins/pdk/go/host/nd_host_scheduler.go b/plugins/pdk/go/host/nd_host_scheduler.go new file mode 100644 index 000000000..0159533ce --- /dev/null +++ b/plugins/pdk/go/host/nd_host_scheduler.go @@ -0,0 +1,185 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Scheduler host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// scheduler_scheduleonetime is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user scheduler_scheduleonetime +func scheduler_scheduleonetime(uint64) uint64 + +// scheduler_schedulerecurring is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user scheduler_schedulerecurring +func scheduler_schedulerecurring(uint64) uint64 + +// scheduler_cancelschedule is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user scheduler_cancelschedule +func scheduler_cancelschedule(uint64) uint64 + +type schedulerScheduleOneTimeRequest struct { + DelaySeconds int32 `json:"delaySeconds"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +type schedulerScheduleOneTimeResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +type schedulerScheduleRecurringRequest struct { + CronExpression string `json:"cronExpression"` + Payload string `json:"payload"` + ScheduleID string `json:"scheduleId"` +} + +type schedulerScheduleRecurringResponse struct { + NewScheduleID string `json:"newScheduleId,omitempty"` + Error string `json:"error,omitempty"` +} + +type schedulerCancelScheduleRequest struct { + ScheduleID string `json:"scheduleId"` +} + +// SchedulerScheduleOneTime calls the scheduler_scheduleonetime host function. +// ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - delaySeconds: Number of seconds to wait before triggering the event +// - payload: Data to be passed to the scheduled event handler +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleOneTime(delaySeconds int32, payload string, scheduleID string) (string, error) { + // Marshal request to JSON + req := schedulerScheduleOneTimeRequest{ + DelaySeconds: delaySeconds, + Payload: payload, + ScheduleID: scheduleID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := scheduler_scheduleonetime(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response schedulerScheduleOneTimeResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.NewScheduleID, nil +} + +// SchedulerScheduleRecurring calls the scheduler_schedulerecurring host function. +// ScheduleRecurring schedules a recurring event using a cron expression. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) +// - payload: Data to be passed to each scheduled event handler invocation +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleRecurring(cronExpression string, payload string, scheduleID string) (string, error) { + // Marshal request to JSON + req := schedulerScheduleRecurringRequest{ + CronExpression: cronExpression, + Payload: payload, + ScheduleID: scheduleID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := scheduler_schedulerecurring(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response schedulerScheduleRecurringResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.NewScheduleID, nil +} + +// SchedulerCancelSchedule calls the scheduler_cancelschedule host function. +// CancelSchedule cancels a scheduled job identified by its schedule ID. +// +// This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +// any future events. +// +// Returns an error if the schedule ID is not found or if cancellation fails. +func SchedulerCancelSchedule(scheduleID string) error { + // Marshal request to JSON + req := schedulerCancelScheduleRequest{ + ScheduleID: scheduleID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := scheduler_cancelschedule(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/pdk/go/host/nd_host_scheduler_stub.go b/plugins/pdk/go/host/nd_host_scheduler_stub.go new file mode 100644 index 000000000..3eaa0087a --- /dev/null +++ b/plugins/pdk/go/host/nd_host_scheduler_stub.go @@ -0,0 +1,77 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockSchedulerService is the mock implementation for testing. +type mockSchedulerService struct { + mock.Mock +} + +// SchedulerMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.SchedulerMock.On("MethodName", args...).Return(values...) +var SchedulerMock = &mockSchedulerService{} + +// ScheduleOneTime is the mock method for SchedulerScheduleOneTime. +func (m *mockSchedulerService) ScheduleOneTime(delaySeconds int32, payload string, scheduleID string) (string, error) { + args := m.Called(delaySeconds, payload, scheduleID) + return args.String(0), args.Error(1) +} + +// SchedulerScheduleOneTime delegates to the mock instance. +// ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - delaySeconds: Number of seconds to wait before triggering the event +// - payload: Data to be passed to the scheduled event handler +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleOneTime(delaySeconds int32, payload string, scheduleID string) (string, error) { + return SchedulerMock.ScheduleOneTime(delaySeconds, payload, scheduleID) +} + +// ScheduleRecurring is the mock method for SchedulerScheduleRecurring. +func (m *mockSchedulerService) ScheduleRecurring(cronExpression string, payload string, scheduleID string) (string, error) { + args := m.Called(cronExpression, payload, scheduleID) + return args.String(0), args.Error(1) +} + +// SchedulerScheduleRecurring delegates to the mock instance. +// ScheduleRecurring schedules a recurring event using a cron expression. +// Plugins that use this function must also implement the SchedulerCallback capability +// +// Parameters: +// - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) +// - payload: Data to be passed to each scheduled event handler invocation +// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +// +// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +func SchedulerScheduleRecurring(cronExpression string, payload string, scheduleID string) (string, error) { + return SchedulerMock.ScheduleRecurring(cronExpression, payload, scheduleID) +} + +// CancelSchedule is the mock method for SchedulerCancelSchedule. +func (m *mockSchedulerService) CancelSchedule(scheduleID string) error { + args := m.Called(scheduleID) + return args.Error(0) +} + +// SchedulerCancelSchedule delegates to the mock instance. +// CancelSchedule cancels a scheduled job identified by its schedule ID. +// +// This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +// any future events. +// +// Returns an error if the schedule ID is not found or if cancellation fails. +func SchedulerCancelSchedule(scheduleID string) error { + return SchedulerMock.CancelSchedule(scheduleID) +} diff --git a/plugins/pdk/go/host/nd_host_subsonicapi.go b/plugins/pdk/go/host/nd_host_subsonicapi.go new file mode 100644 index 000000000..e6e56ce6b --- /dev/null +++ b/plugins/pdk/go/host/nd_host_subsonicapi.go @@ -0,0 +1,119 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the SubsonicAPI host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// subsonicapi_call is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user subsonicapi_call +func subsonicapi_call(uint64) uint64 + +// subsonicapi_callraw is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user subsonicapi_callraw +func subsonicapi_callraw(uint64) uint64 + +type subsonicAPICallRequest struct { + Uri string `json:"uri"` +} + +type subsonicAPICallResponse struct { + ResponseJSON string `json:"responseJson,omitempty"` + Error string `json:"error,omitempty"` +} + +type subsonicAPICallRawRequest struct { + Uri string `json:"uri"` +} + +type subsonicAPICallRawResponse struct { + ContentType string `json:"contentType,omitempty"` + Data []byte `json:"data,omitempty"` + Error string `json:"error,omitempty"` +} + +// SubsonicAPICall calls the subsonicapi_call host function. +// Call executes a Subsonic API request and returns the JSON response. +// +// The uri parameter should be the Subsonic API path without the server prefix, +// e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. +func SubsonicAPICall(uri string) (string, error) { + // Marshal request to JSON + req := subsonicAPICallRequest{ + Uri: uri, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := subsonicapi_call(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response subsonicAPICallResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.ResponseJSON, nil +} + +// SubsonicAPICallRaw calls the subsonicapi_callraw host function. +// CallRaw executes a Subsonic API request and returns the raw binary response. +// Designed for binary endpoints like getCoverArt and stream that return +// non-JSON data. The data is base64-encoded over JSON on the wire. +func SubsonicAPICallRaw(uri string) (string, []byte, error) { + // Marshal request to JSON + req := subsonicAPICallRawRequest{ + Uri: uri, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := subsonicapi_callraw(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response subsonicAPICallRawResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", nil, errors.New(response.Error) + } + + return response.ContentType, response.Data, nil +} diff --git a/plugins/pdk/go/host/nd_host_subsonicapi_stub.go b/plugins/pdk/go/host/nd_host_subsonicapi_stub.go new file mode 100644 index 000000000..2fdaf2403 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_subsonicapi_stub.go @@ -0,0 +1,49 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockSubsonicAPIService is the mock implementation for testing. +type mockSubsonicAPIService struct { + mock.Mock +} + +// SubsonicAPIMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.SubsonicAPIMock.On("MethodName", args...).Return(values...) +var SubsonicAPIMock = &mockSubsonicAPIService{} + +// Call is the mock method for SubsonicAPICall. +func (m *mockSubsonicAPIService) Call(uri string) (string, error) { + args := m.Called(uri) + return args.String(0), args.Error(1) +} + +// SubsonicAPICall delegates to the mock instance. +// Call executes a Subsonic API request and returns the JSON response. +// +// The uri parameter should be the Subsonic API path without the server prefix, +// e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. +func SubsonicAPICall(uri string) (string, error) { + return SubsonicAPIMock.Call(uri) +} + +// CallRaw is the mock method for SubsonicAPICallRaw. +func (m *mockSubsonicAPIService) CallRaw(uri string) (string, []byte, error) { + args := m.Called(uri) + return args.String(0), args.Get(1).([]byte), args.Error(2) +} + +// SubsonicAPICallRaw delegates to the mock instance. +// CallRaw executes a Subsonic API request and returns the raw binary response. +// Designed for binary endpoints like getCoverArt and stream that return +// non-JSON data. The data is base64-encoded over JSON on the wire. +func SubsonicAPICallRaw(uri string) (string, []byte, error) { + return SubsonicAPIMock.CallRaw(uri) +} diff --git a/plugins/pdk/go/host/nd_host_task.go b/plugins/pdk/go/host/nd_host_task.go new file mode 100644 index 000000000..92a41c5bc --- /dev/null +++ b/plugins/pdk/go/host/nd_host_task.go @@ -0,0 +1,277 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Task host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// QueueConfig represents the QueueConfig data structure. +// QueueConfig holds configuration for a task queue. +type QueueConfig struct { + Concurrency int32 `json:"concurrency"` + MaxRetries int32 `json:"maxRetries"` + BackoffMs int64 `json:"backoffMs"` + DelayMs int64 `json:"delayMs"` + RetentionMs int64 `json:"retentionMs"` +} + +// TaskInfo represents the TaskInfo data structure. +// TaskInfo holds the current state of a task. +type TaskInfo struct { + Status string `json:"status"` + Message string `json:"message"` + Attempt int32 `json:"attempt"` +} + +// task_createqueue is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_createqueue +func task_createqueue(uint64) uint64 + +// task_enqueue is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_enqueue +func task_enqueue(uint64) uint64 + +// task_get is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_get +func task_get(uint64) uint64 + +// task_cancel is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_cancel +func task_cancel(uint64) uint64 + +// task_clearqueue is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user task_clearqueue +func task_clearqueue(uint64) uint64 + +type taskCreateQueueRequest struct { + Name string `json:"name"` + Config QueueConfig `json:"config"` +} + +type taskEnqueueRequest struct { + QueueName string `json:"queueName"` + Payload []byte `json:"payload"` +} + +type taskEnqueueResponse struct { + Result string `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type taskGetRequest struct { + TaskID string `json:"taskId"` +} + +type taskGetResponse struct { + Result *TaskInfo `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type taskCancelRequest struct { + TaskID string `json:"taskId"` +} + +type taskClearQueueRequest struct { + QueueName string `json:"queueName"` +} + +type taskClearQueueResponse struct { + Result int64 `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// TaskCreateQueue calls the task_createqueue host function. +// CreateQueue creates a named task queue with the given configuration. +// Zero-value fields in config use sensible defaults. +// If a queue with the same name already exists, returns an error. +// On startup, this also recovers any stale "running" tasks from a previous crash. +func TaskCreateQueue(name string, config QueueConfig) error { + // Marshal request to JSON + req := taskCreateQueueRequest{ + Name: name, + Config: config, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_createqueue(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// TaskEnqueue calls the task_enqueue host function. +// Enqueue adds a task to the named queue. Returns the task ID. +// payload is opaque bytes passed back to the plugin on execution. +func TaskEnqueue(queueName string, payload []byte) (string, error) { + // Marshal request to JSON + req := taskEnqueueRequest{ + QueueName: queueName, + Payload: payload, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_enqueue(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response taskEnqueueResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.Result, nil +} + +// TaskGet calls the task_get host function. +// Get returns the current state of a task including its status, +// message, and attempt count. +func TaskGet(taskID string) (*TaskInfo, error) { + // Marshal request to JSON + req := taskGetRequest{ + TaskID: taskID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return nil, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_get(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response taskGetResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} + +// TaskCancel calls the task_cancel host function. +// Cancel cancels a pending task. Returns error if already +// running, completed, or failed. +func TaskCancel(taskID string) error { + // Marshal request to JSON + req := taskCancelRequest{ + TaskID: taskID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_cancel(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// TaskClearQueue calls the task_clearqueue host function. +// ClearQueue removes all pending tasks from the named queue. +// Running tasks are not affected. Returns the number of tasks removed. +func TaskClearQueue(queueName string) (int64, error) { + // Marshal request to JSON + req := taskClearQueueRequest{ + QueueName: queueName, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return 0, err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := task_clearqueue(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response taskClearQueueResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return 0, err + } + + // Convert Error field to Go error + if response.Error != "" { + return 0, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_task_stub.go b/plugins/pdk/go/host/nd_host_task_stub.go new file mode 100644 index 000000000..4dde0e234 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_task_stub.go @@ -0,0 +1,105 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// QueueConfig represents the QueueConfig data structure. +// QueueConfig holds configuration for a task queue. +type QueueConfig struct { + Concurrency int32 `json:"concurrency"` + MaxRetries int32 `json:"maxRetries"` + BackoffMs int64 `json:"backoffMs"` + DelayMs int64 `json:"delayMs"` + RetentionMs int64 `json:"retentionMs"` +} + +// TaskInfo represents the TaskInfo data structure. +// TaskInfo holds the current state of a task. +type TaskInfo struct { + Status string `json:"status"` + Message string `json:"message"` + Attempt int32 `json:"attempt"` +} + +// mockTaskService is the mock implementation for testing. +type mockTaskService struct { + mock.Mock +} + +// TaskMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.TaskMock.On("MethodName", args...).Return(values...) +var TaskMock = &mockTaskService{} + +// CreateQueue is the mock method for TaskCreateQueue. +func (m *mockTaskService) CreateQueue(name string, config QueueConfig) error { + args := m.Called(name, config) + return args.Error(0) +} + +// TaskCreateQueue delegates to the mock instance. +// CreateQueue creates a named task queue with the given configuration. +// Zero-value fields in config use sensible defaults. +// If a queue with the same name already exists, returns an error. +// On startup, this also recovers any stale "running" tasks from a previous crash. +func TaskCreateQueue(name string, config QueueConfig) error { + return TaskMock.CreateQueue(name, config) +} + +// Enqueue is the mock method for TaskEnqueue. +func (m *mockTaskService) Enqueue(queueName string, payload []byte) (string, error) { + args := m.Called(queueName, payload) + return args.String(0), args.Error(1) +} + +// TaskEnqueue delegates to the mock instance. +// Enqueue adds a task to the named queue. Returns the task ID. +// payload is opaque bytes passed back to the plugin on execution. +func TaskEnqueue(queueName string, payload []byte) (string, error) { + return TaskMock.Enqueue(queueName, payload) +} + +// Get is the mock method for TaskGet. +func (m *mockTaskService) Get(taskID string) (*TaskInfo, error) { + args := m.Called(taskID) + return args.Get(0).(*TaskInfo), args.Error(1) +} + +// TaskGet delegates to the mock instance. +// Get returns the current state of a task including its status, +// message, and attempt count. +func TaskGet(taskID string) (*TaskInfo, error) { + return TaskMock.Get(taskID) +} + +// Cancel is the mock method for TaskCancel. +func (m *mockTaskService) Cancel(taskID string) error { + args := m.Called(taskID) + return args.Error(0) +} + +// TaskCancel delegates to the mock instance. +// Cancel cancels a pending task. Returns error if already +// running, completed, or failed. +func TaskCancel(taskID string) error { + return TaskMock.Cancel(taskID) +} + +// ClearQueue is the mock method for TaskClearQueue. +func (m *mockTaskService) ClearQueue(queueName string) (int64, error) { + args := m.Called(queueName) + return args.Get(0).(int64), args.Error(1) +} + +// TaskClearQueue delegates to the mock instance. +// ClearQueue removes all pending tasks from the named queue. +// Running tasks are not affected. Returns the number of tasks removed. +func TaskClearQueue(queueName string) (int64, error) { + return TaskMock.ClearQueue(queueName) +} diff --git a/plugins/pdk/go/host/nd_host_users.go b/plugins/pdk/go/host/nd_host_users.go new file mode 100644 index 000000000..21b6ad0ed --- /dev/null +++ b/plugins/pdk/go/host/nd_host_users.go @@ -0,0 +1,107 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// User represents the User data structure. +// User represents a Navidrome user with minimal information exposed to plugins. +// Sensitive fields like password, email, and internal IDs are intentionally excluded. +type User struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// users_getusers is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user users_getusers +func users_getusers(uint64) uint64 + +// users_getadmins is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user users_getadmins +func users_getadmins(uint64) uint64 + +type usersGetUsersResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +type usersGetAdminsResponse struct { + Result []User `json:"result,omitempty"` + Error string `json:"error,omitempty"` +} + +// UsersGetUsers calls the users_getusers host function. +// GetUsers returns all users the plugin has been granted access to. +// Only minimal user information (userName, name, isAdmin) is returned. +// Sensitive fields like password and email are never exposed. +// +// Returns a slice of users the plugin can access, or an empty slice if none configured. +func UsersGetUsers() ([]User, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := users_getusers(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response usersGetUsersResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} + +// UsersGetAdmins calls the users_getadmins host function. +// GetAdmins returns only admin users the plugin has been granted access to. +// This is a convenience method that filters GetUsers results to include only admins. +// +// Returns a slice of admin users the plugin can access, or an empty slice if none. +func UsersGetAdmins() ([]User, error) { + // No parameters - allocate empty JSON object + reqMem := pdk.AllocateBytes([]byte("{}")) + defer reqMem.Free() + + // Call the host function + responsePtr := users_getadmins(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response usersGetAdminsResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return nil, err + } + + // Convert Error field to Go error + if response.Error != "" { + return nil, errors.New(response.Error) + } + + return response.Result, nil +} diff --git a/plugins/pdk/go/host/nd_host_users_stub.go b/plugins/pdk/go/host/nd_host_users_stub.go new file mode 100644 index 000000000..f76854894 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_users_stub.go @@ -0,0 +1,60 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// User represents the User data structure. +// User represents a Navidrome user with minimal information exposed to plugins. +// Sensitive fields like password, email, and internal IDs are intentionally excluded. +type User struct { + UserName string `json:"userName"` + Name string `json:"name"` + IsAdmin bool `json:"isAdmin"` +} + +// mockUsersService is the mock implementation for testing. +type mockUsersService struct { + mock.Mock +} + +// UsersMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.UsersMock.On("MethodName", args...).Return(values...) +var UsersMock = &mockUsersService{} + +// GetUsers is the mock method for UsersGetUsers. +func (m *mockUsersService) GetUsers() ([]User, error) { + args := m.Called() + return args.Get(0).([]User), args.Error(1) +} + +// UsersGetUsers delegates to the mock instance. +// GetUsers returns all users the plugin has been granted access to. +// Only minimal user information (userName, name, isAdmin) is returned. +// Sensitive fields like password and email are never exposed. +// +// Returns a slice of users the plugin can access, or an empty slice if none configured. +func UsersGetUsers() ([]User, error) { + return UsersMock.GetUsers() +} + +// GetAdmins is the mock method for UsersGetAdmins. +func (m *mockUsersService) GetAdmins() ([]User, error) { + args := m.Called() + return args.Get(0).([]User), args.Error(1) +} + +// UsersGetAdmins delegates to the mock instance. +// GetAdmins returns only admin users the plugin has been granted access to. +// This is a convenience method that filters GetUsers results to include only admins. +// +// Returns a slice of admin users the plugin can access, or an empty slice if none. +func UsersGetAdmins() ([]User, error) { + return UsersMock.GetAdmins() +} diff --git a/plugins/pdk/go/host/nd_host_websocket.go b/plugins/pdk/go/host/nd_host_websocket.go new file mode 100644 index 000000000..956f63c21 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_websocket.go @@ -0,0 +1,235 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the WebSocket host service. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package host + +import ( + "encoding/json" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// websocket_connect is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_connect +func websocket_connect(uint64) uint64 + +// websocket_sendtext is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_sendtext +func websocket_sendtext(uint64) uint64 + +// websocket_sendbinary is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_sendbinary +func websocket_sendbinary(uint64) uint64 + +// websocket_closeconnection is the host function provided by Navidrome. +// +//go:wasmimport extism:host/user websocket_closeconnection +func websocket_closeconnection(uint64) uint64 + +type webSocketConnectRequest struct { + Url string `json:"url"` + Headers map[string]string `json:"headers"` + ConnectionID string `json:"connectionId"` +} + +type webSocketConnectResponse struct { + NewConnectionID string `json:"newConnectionId,omitempty"` + Error string `json:"error,omitempty"` +} + +type webSocketSendTextRequest struct { + ConnectionID string `json:"connectionId"` + Message string `json:"message"` +} + +type webSocketSendBinaryRequest struct { + ConnectionID string `json:"connectionId"` + Data []byte `json:"data"` +} + +type webSocketCloseConnectionRequest struct { + ConnectionID string `json:"connectionId"` + Code int32 `json:"code"` + Reason string `json:"reason"` +} + +// WebSocketConnect calls the websocket_connect host function. +// Connect establishes a WebSocket connection to the specified URL. +// +// Plugins that use this function must also implement the WebSocketCallback capability +// to receive incoming messages and connection events. +// +// Parameters: +// - url: The WebSocket URL to connect to (ws:// or wss://) +// - headers: Optional HTTP headers to include in the handshake request +// - connectionID: Optional unique identifier for the connection. If empty, one will be generated +// +// Returns the connection ID that can be used to send messages or close the connection, +// or an error if the connection fails. +func WebSocketConnect(url string, headers map[string]string, connectionID string) (string, error) { + // Marshal request to JSON + req := webSocketConnectRequest{ + Url: url, + Headers: headers, + ConnectionID: connectionID, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return "", err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_connect(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse the response + var response webSocketConnectResponse + if err := json.Unmarshal(responseBytes, &response); err != nil { + return "", err + } + + // Convert Error field to Go error + if response.Error != "" { + return "", errors.New(response.Error) + } + + return response.NewConnectionID, nil +} + +// WebSocketSendText calls the websocket_sendtext host function. +// SendText sends a text message over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - message: The text message to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendText(connectionID string, message string) error { + // Marshal request to JSON + req := webSocketSendTextRequest{ + ConnectionID: connectionID, + Message: message, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_sendtext(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// WebSocketSendBinary calls the websocket_sendbinary host function. +// SendBinary sends binary data over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - data: The binary data to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendBinary(connectionID string, data []byte) error { + // Marshal request to JSON + req := webSocketSendBinaryRequest{ + ConnectionID: connectionID, + Data: data, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_sendbinary(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} + +// WebSocketCloseConnection calls the websocket_closeconnection host function. +// CloseConnection gracefully closes a WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - code: WebSocket close status code (e.g., 1000 for normal closure) +// - reason: Optional human-readable reason for closing +// +// Returns an error if the connection is not found or if closing fails. +func WebSocketCloseConnection(connectionID string, code int32, reason string) error { + // Marshal request to JSON + req := webSocketCloseConnectionRequest{ + ConnectionID: connectionID, + Code: code, + Reason: reason, + } + reqBytes, err := json.Marshal(req) + if err != nil { + return err + } + reqMem := pdk.AllocateBytes(reqBytes) + defer reqMem.Free() + + // Call the host function + responsePtr := websocket_closeconnection(reqMem.Offset()) + + // Read the response from memory + responseMem := pdk.FindMemory(responsePtr) + responseBytes := responseMem.ReadBytes() + + // Parse error-only response + var response struct { + Error string `json:"error,omitempty"` + } + if err := json.Unmarshal(responseBytes, &response); err != nil { + return err + } + if response.Error != "" { + return errors.New(response.Error) + } + return nil +} diff --git a/plugins/pdk/go/host/nd_host_websocket_stub.go b/plugins/pdk/go/host/nd_host_websocket_stub.go new file mode 100644 index 000000000..23ac382f0 --- /dev/null +++ b/plugins/pdk/go/host/nd_host_websocket_stub.go @@ -0,0 +1,98 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported mock instances to set expectations in tests. +// +//go:build !wasip1 + +package host + +import "github.com/stretchr/testify/mock" + +// mockWebSocketService is the mock implementation for testing. +type mockWebSocketService struct { + mock.Mock +} + +// WebSocketMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: host.WebSocketMock.On("MethodName", args...).Return(values...) +var WebSocketMock = &mockWebSocketService{} + +// Connect is the mock method for WebSocketConnect. +func (m *mockWebSocketService) Connect(url string, headers map[string]string, connectionID string) (string, error) { + args := m.Called(url, headers, connectionID) + return args.String(0), args.Error(1) +} + +// WebSocketConnect delegates to the mock instance. +// Connect establishes a WebSocket connection to the specified URL. +// +// Plugins that use this function must also implement the WebSocketCallback capability +// to receive incoming messages and connection events. +// +// Parameters: +// - url: The WebSocket URL to connect to (ws:// or wss://) +// - headers: Optional HTTP headers to include in the handshake request +// - connectionID: Optional unique identifier for the connection. If empty, one will be generated +// +// Returns the connection ID that can be used to send messages or close the connection, +// or an error if the connection fails. +func WebSocketConnect(url string, headers map[string]string, connectionID string) (string, error) { + return WebSocketMock.Connect(url, headers, connectionID) +} + +// SendText is the mock method for WebSocketSendText. +func (m *mockWebSocketService) SendText(connectionID string, message string) error { + args := m.Called(connectionID, message) + return args.Error(0) +} + +// WebSocketSendText delegates to the mock instance. +// SendText sends a text message over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - message: The text message to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendText(connectionID string, message string) error { + return WebSocketMock.SendText(connectionID, message) +} + +// SendBinary is the mock method for WebSocketSendBinary. +func (m *mockWebSocketService) SendBinary(connectionID string, data []byte) error { + args := m.Called(connectionID, data) + return args.Error(0) +} + +// WebSocketSendBinary delegates to the mock instance. +// SendBinary sends binary data over an established WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - data: The binary data to send +// +// Returns an error if the connection is not found or if sending fails. +func WebSocketSendBinary(connectionID string, data []byte) error { + return WebSocketMock.SendBinary(connectionID, data) +} + +// CloseConnection is the mock method for WebSocketCloseConnection. +func (m *mockWebSocketService) CloseConnection(connectionID string, code int32, reason string) error { + args := m.Called(connectionID, code, reason) + return args.Error(0) +} + +// WebSocketCloseConnection delegates to the mock instance. +// CloseConnection gracefully closes a WebSocket connection. +// +// Parameters: +// - connectionID: The connection identifier returned by Connect +// - code: WebSocket close status code (e.g., 1000 for normal closure) +// - reason: Optional human-readable reason for closing +// +// Returns an error if the connection is not found or if closing fails. +func WebSocketCloseConnection(connectionID string, code int32, reason string) error { + return WebSocketMock.CloseConnection(connectionID, code, reason) +} diff --git a/plugins/pdk/go/lifecycle/lifecycle.go b/plugins/pdk/go/lifecycle/lifecycle.go new file mode 100644 index 000000000..93b5cf37b --- /dev/null +++ b/plugins/pdk/go/lifecycle/lifecycle.go @@ -0,0 +1,59 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lifecycle capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package lifecycle + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// Lifecycle is the marker interface for lifecycle plugins. +// Implement one or more of the provider interfaces below. +// Lifecycle provides plugin lifecycle hooks. +// This capability allows plugins to perform initialization when loaded, +// such as establishing connections, starting background processes, or +// validating configuration. +// +// The OnInit function is called once when the plugin is loaded, and is NOT +// called when the plugin is hot-reloaded. Plugins should not assume this +// function will be called on every startup. +type Lifecycle interface{} + +// InitProvider provides the OnInit function. +type InitProvider interface { + OnInit() error +} // Internal implementation holders +var ( + initImpl func() error +) + +// Register registers a lifecycle implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl Lifecycle) { + if p, ok := impl.(InitProvider); ok { + initImpl = p.OnInit + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_on_init +func _NdOnInit() int32 { + if initImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + if err := initImpl(); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/lifecycle/lifecycle_stub.go b/plugins/pdk/go/lifecycle/lifecycle_stub.go new file mode 100644 index 000000000..8d392f6c6 --- /dev/null +++ b/plugins/pdk/go/lifecycle/lifecycle_stub.go @@ -0,0 +1,33 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package lifecycle + +// Lifecycle is the marker interface for lifecycle plugins. +// Implement one or more of the provider interfaces below. +// Lifecycle provides plugin lifecycle hooks. +// This capability allows plugins to perform initialization when loaded, +// such as establishing connections, starting background processes, or +// validating configuration. +// +// The OnInit function is called once when the plugin is loaded, and is NOT +// called when the plugin is hot-reloaded. Plugins should not assume this +// function will be called on every startup. +type Lifecycle interface{} + +// InitProvider provides the OnInit function. +type InitProvider interface { + OnInit() error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Lifecycle) {} diff --git a/plugins/pdk/go/lyrics/lyrics.go b/plugins/pdk/go/lyrics/lyrics.go new file mode 100644 index 000000000..6696bc4a1 --- /dev/null +++ b/plugins/pdk/go/lyrics/lyrics.go @@ -0,0 +1,124 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lyrics capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package lyrics + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// GetLyricsRequest contains the track information for lyrics lookup. +type GetLyricsRequest struct { + Track TrackInfo `json:"track"` +} + +// GetLyricsResponse contains the lyrics returned by the plugin. +type GetLyricsResponse struct { + Lyrics []LyricsText `json:"lyrics"` +} + +// LyricsText represents a single set of lyrics in raw text format. +// Text can be plain text or LRC format — Navidrome will parse it. +type LyricsText struct { + Lang string `json:"lang,omitempty"` + Text string `json:"text"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` + // LibraryID is the ID of the library the track belongs to. + // Only included if the plugin has library permission with filesystem access for the track's library. + LibraryID int32 `json:"libraryId,omitempty"` + // Path is the full path to the track file, relative to the library root. + // Only included if the plugin has library permission with filesystem access for the track's library. + Path string `json:"path,omitempty"` +} + +// Lyrics requires all methods to be implemented. +// Lyrics provides lyrics for a given track from external sources. +type Lyrics interface { + // GetLyrics + GetLyrics(GetLyricsRequest) (GetLyricsResponse, error) +} // Internal implementation holders +var ( + lyricsImpl func(GetLyricsRequest) (GetLyricsResponse, error) +) + +// Register registers a lyrics implementation. +// All methods are required. +func Register(impl Lyrics) { + lyricsImpl = impl.GetLyrics +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_lyrics_get_lyrics +func _NdLyricsGetLyrics() int32 { + if lyricsImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input GetLyricsRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := lyricsImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/lyrics/lyrics_stub.go b/plugins/pdk/go/lyrics/lyrics_stub.go new file mode 100644 index 000000000..fb3e3fb1a --- /dev/null +++ b/plugins/pdk/go/lyrics/lyrics_stub.go @@ -0,0 +1,88 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package lyrics + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// GetLyricsRequest contains the track information for lyrics lookup. +type GetLyricsRequest struct { + Track TrackInfo `json:"track"` +} + +// GetLyricsResponse contains the lyrics returned by the plugin. +type GetLyricsResponse struct { + Lyrics []LyricsText `json:"lyrics"` +} + +// LyricsText represents a single set of lyrics in raw text format. +// Text can be plain text or LRC format — Navidrome will parse it. +type LyricsText struct { + Lang string `json:"lang,omitempty"` + Text string `json:"text"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` + // LibraryID is the ID of the library the track belongs to. + // Only included if the plugin has library permission with filesystem access for the track's library. + LibraryID int32 `json:"libraryId,omitempty"` + // Path is the full path to the track file, relative to the library root. + // Only included if the plugin has library permission with filesystem access for the track's library. + Path string `json:"path,omitempty"` +} + +// Lyrics requires all methods to be implemented. +// Lyrics provides lyrics for a given track from external sources. +type Lyrics interface { + // GetLyrics + GetLyrics(GetLyricsRequest) (GetLyricsResponse, error) +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Lyrics) {} diff --git a/plugins/pdk/go/metadata/metadata.go b/plugins/pdk/go/metadata/metadata.go new file mode 100644 index 000000000..7cd63865b --- /dev/null +++ b/plugins/pdk/go/metadata/metadata.go @@ -0,0 +1,621 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the MetadataAgent capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package metadata + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// AlbumImagesResponse is the response for GetAlbumImages. +type AlbumImagesResponse struct { + // Images is the list of album images. + Images []ImageInfo `json:"images"` +} + +// AlbumInfoResponse is the response for GetAlbumInfo. +type AlbumInfoResponse struct { + // Name is the album name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the album. + MBID string `json:"mbid"` + // Description is the album description/notes. + Description string `json:"description"` + // URL is the external URL for the album. + URL string `json:"url"` +} + +// AlbumRequest is the common request for album-related functions. +type AlbumRequest struct { + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz ID for the album (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistBiographyResponse is the response for GetArtistBiography. +type ArtistBiographyResponse struct { + // Biography is the artist biography text. + Biography string `json:"biography"` +} + +// ArtistImagesResponse is the response for GetArtistImages. +type ArtistImagesResponse struct { + // Images is the list of artist images. + Images []ImageInfo `json:"images"` +} + +// ArtistMBIDRequest is the request for GetArtistMBID. +type ArtistMBIDRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` +} + +// ArtistMBIDResponse is the response for GetArtistMBID. +type ArtistMBIDResponse struct { + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid"` +} + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// ArtistRequest is the common request for artist-related functions. +type ArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistURLResponse is the response for GetArtistURL. +type ArtistURLResponse struct { + // URL is the external URL for the artist. + URL string `json:"url"` +} + +// ImageInfo represents an image with URL and size. +type ImageInfo struct { + // URL is the URL of the image. + URL string `json:"url"` + // Size is the size of the image in pixels (width or height). + Size int32 `json:"size"` +} + +// SimilarArtistsRequest is the request for GetSimilarArtists. +type SimilarArtistsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Limit is the maximum number of similar artists to return. + Limit int32 `json:"limit"` +} + +// SimilarArtistsResponse is the response for GetSimilarArtists. +type SimilarArtistsResponse struct { + // Artists is the list of similar artists. + Artists []ArtistRef `json:"artists"` +} + +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// TopSongsRequest is the request for GetArtistTopSongs. +type TopSongsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of top songs to return. + Count int32 `json:"count"` +} + +// TopSongsResponse is the response for GetArtistTopSongs. +type TopSongsResponse struct { + // Songs is the list of top songs. + Songs []SongRef `json:"songs"` +} + +// Metadata is the marker interface for metadata plugins. +// Implement one or more of the provider interfaces below. +// MetadataAgent provides artist and album metadata retrieval. +// This capability allows plugins to provide external metadata for artists and albums, +// such as biographies, images, similar artists, and top songs. +// +// Plugins implementing this capability can choose which methods to implement. +// Each method is optional - plugins only need to provide the functionality they support. +type Metadata interface{} + +// ArtistMBIDProvider provides the GetArtistMBID function. +type ArtistMBIDProvider interface { + GetArtistMBID(ArtistMBIDRequest) (*ArtistMBIDResponse, error) +} + +// ArtistURLProvider provides the GetArtistURL function. +type ArtistURLProvider interface { + GetArtistURL(ArtistRequest) (*ArtistURLResponse, error) +} + +// ArtistBiographyProvider provides the GetArtistBiography function. +type ArtistBiographyProvider interface { + GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +} + +// SimilarArtistsProvider provides the GetSimilarArtists function. +type SimilarArtistsProvider interface { + GetSimilarArtists(SimilarArtistsRequest) (*SimilarArtistsResponse, error) +} + +// ArtistImagesProvider provides the GetArtistImages function. +type ArtistImagesProvider interface { + GetArtistImages(ArtistRequest) (*ArtistImagesResponse, error) +} + +// ArtistTopSongsProvider provides the GetArtistTopSongs function. +type ArtistTopSongsProvider interface { + GetArtistTopSongs(TopSongsRequest) (*TopSongsResponse, error) +} + +// AlbumInfoProvider provides the GetAlbumInfo function. +type AlbumInfoProvider interface { + GetAlbumInfo(AlbumRequest) (*AlbumInfoResponse, error) +} + +// AlbumImagesProvider provides the GetAlbumImages function. +type AlbumImagesProvider interface { + GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) +} + +// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +type SimilarSongsByTrackProvider interface { + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +type SimilarSongsByAlbumProvider interface { + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +type SimilarSongsByArtistProvider interface { + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +} // Internal implementation holders +var ( + artistMBIDImpl func(ArtistMBIDRequest) (*ArtistMBIDResponse, error) + artistURLImpl func(ArtistRequest) (*ArtistURLResponse, error) + artistBiographyImpl func(ArtistRequest) (*ArtistBiographyResponse, error) + similarArtistsImpl func(SimilarArtistsRequest) (*SimilarArtistsResponse, error) + artistImagesImpl func(ArtistRequest) (*ArtistImagesResponse, error) + artistTopSongsImpl func(TopSongsRequest) (*TopSongsResponse, error) + albumInfoImpl func(AlbumRequest) (*AlbumInfoResponse, error) + albumImagesImpl func(AlbumRequest) (*AlbumImagesResponse, error) + similarSongsByTrackImpl func(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) + similarSongsByAlbumImpl func(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) + similarSongsByArtistImpl func(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +) + +// Register registers a metadata implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl Metadata) { + if p, ok := impl.(ArtistMBIDProvider); ok { + artistMBIDImpl = p.GetArtistMBID + } + if p, ok := impl.(ArtistURLProvider); ok { + artistURLImpl = p.GetArtistURL + } + if p, ok := impl.(ArtistBiographyProvider); ok { + artistBiographyImpl = p.GetArtistBiography + } + if p, ok := impl.(SimilarArtistsProvider); ok { + similarArtistsImpl = p.GetSimilarArtists + } + if p, ok := impl.(ArtistImagesProvider); ok { + artistImagesImpl = p.GetArtistImages + } + if p, ok := impl.(ArtistTopSongsProvider); ok { + artistTopSongsImpl = p.GetArtistTopSongs + } + if p, ok := impl.(AlbumInfoProvider); ok { + albumInfoImpl = p.GetAlbumInfo + } + if p, ok := impl.(AlbumImagesProvider); ok { + albumImagesImpl = p.GetAlbumImages + } + if p, ok := impl.(SimilarSongsByTrackProvider); ok { + similarSongsByTrackImpl = p.GetSimilarSongsByTrack + } + if p, ok := impl.(SimilarSongsByAlbumProvider); ok { + similarSongsByAlbumImpl = p.GetSimilarSongsByAlbum + } + if p, ok := impl.(SimilarSongsByArtistProvider); ok { + similarSongsByArtistImpl = p.GetSimilarSongsByArtist + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_get_artist_mbid +func _NdGetArtistMbid() int32 { + if artistMBIDImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistMBIDRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistMBIDImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_url +func _NdGetArtistUrl() int32 { + if artistURLImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistURLImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_biography +func _NdGetArtistBiography() int32 { + if artistBiographyImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistBiographyImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_artists +func _NdGetSimilarArtists() int32 { + if similarArtistsImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarArtistsRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarArtistsImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_images +func _NdGetArtistImages() int32 { + if artistImagesImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistImagesImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_artist_top_songs +func _NdGetArtistTopSongs() int32 { + if artistTopSongsImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input TopSongsRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := artistTopSongsImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_album_info +func _NdGetAlbumInfo() int32 { + if albumInfoImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input AlbumRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := albumInfoImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_album_images +func _NdGetAlbumImages() int32 { + if albumImagesImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input AlbumRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := albumImagesImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_track +func _NdGetSimilarSongsByTrack() int32 { + if similarSongsByTrackImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByTrackRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByTrackImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_album +func _NdGetSimilarSongsByAlbum() int32 { + if similarSongsByAlbumImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByAlbumRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByAlbumImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_get_similar_songs_by_artist +func _NdGetSimilarSongsByArtist() int32 { + if similarSongsByArtistImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SimilarSongsByArtistRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := similarSongsByArtistImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/metadata/metadata_stub.go b/plugins/pdk/go/metadata/metadata_stub.go new file mode 100644 index 000000000..bdcd06fcb --- /dev/null +++ b/plugins/pdk/go/metadata/metadata_stub.go @@ -0,0 +1,273 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package metadata + +// AlbumImagesResponse is the response for GetAlbumImages. +type AlbumImagesResponse struct { + // Images is the list of album images. + Images []ImageInfo `json:"images"` +} + +// AlbumInfoResponse is the response for GetAlbumInfo. +type AlbumInfoResponse struct { + // Name is the album name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the album. + MBID string `json:"mbid"` + // Description is the album description/notes. + Description string `json:"description"` + // URL is the external URL for the album. + URL string `json:"url"` +} + +// AlbumRequest is the common request for album-related functions. +type AlbumRequest struct { + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz ID for the album (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistBiographyResponse is the response for GetArtistBiography. +type ArtistBiographyResponse struct { + // Biography is the artist biography text. + Biography string `json:"biography"` +} + +// ArtistImagesResponse is the response for GetArtistImages. +type ArtistImagesResponse struct { + // Images is the list of artist images. + Images []ImageInfo `json:"images"` +} + +// ArtistMBIDRequest is the request for GetArtistMBID. +type ArtistMBIDRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` +} + +// ArtistMBIDResponse is the response for GetArtistMBID. +type ArtistMBIDResponse struct { + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid"` +} + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// ArtistRequest is the common request for artist-related functions. +type ArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` +} + +// ArtistURLResponse is the response for GetArtistURL. +type ArtistURLResponse struct { + // URL is the external URL for the artist. + URL string `json:"url"` +} + +// ImageInfo represents an image with URL and size. +type ImageInfo struct { + // URL is the URL of the image. + URL string `json:"url"` + // Size is the size of the image in pixels (width or height). + Size int32 `json:"size"` +} + +// SimilarArtistsRequest is the request for GetSimilarArtists. +type SimilarArtistsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Limit is the maximum number of similar artists to return. + Limit int32 `json:"limit"` +} + +// SimilarArtistsResponse is the response for GetSimilarArtists. +type SimilarArtistsResponse struct { + // Artists is the list of similar artists. + Artists []ArtistRef `json:"artists"` +} + +// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +type SimilarSongsByAlbumRequest struct { + // ID is the internal Navidrome album ID. + ID string `json:"id"` + // Name is the album name. + Name string `json:"name"` + // Artist is the album artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz release ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +type SimilarSongsByArtistRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz artist ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +type SimilarSongsByTrackRequest struct { + // ID is the internal Navidrome mediafile ID. + ID string `json:"id"` + // Name is the track title. + Name string `json:"name"` + // Artist is the artist name. + Artist string `json:"artist"` + // MBID is the MusicBrainz recording ID (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of similar songs to return. + Count int32 `json:"count"` +} + +// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +type SimilarSongsResponse struct { + // Songs is the list of similar songs. + Songs []SongRef `json:"songs"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// TopSongsRequest is the request for GetArtistTopSongs. +type TopSongsRequest struct { + // ID is the internal Navidrome artist ID. + ID string `json:"id"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist (if known). + MBID string `json:"mbid,omitempty"` + // Count is the maximum number of top songs to return. + Count int32 `json:"count"` +} + +// TopSongsResponse is the response for GetArtistTopSongs. +type TopSongsResponse struct { + // Songs is the list of top songs. + Songs []SongRef `json:"songs"` +} + +// Metadata is the marker interface for metadata plugins. +// Implement one or more of the provider interfaces below. +// MetadataAgent provides artist and album metadata retrieval. +// This capability allows plugins to provide external metadata for artists and albums, +// such as biographies, images, similar artists, and top songs. +// +// Plugins implementing this capability can choose which methods to implement. +// Each method is optional - plugins only need to provide the functionality they support. +type Metadata interface{} + +// ArtistMBIDProvider provides the GetArtistMBID function. +type ArtistMBIDProvider interface { + GetArtistMBID(ArtistMBIDRequest) (*ArtistMBIDResponse, error) +} + +// ArtistURLProvider provides the GetArtistURL function. +type ArtistURLProvider interface { + GetArtistURL(ArtistRequest) (*ArtistURLResponse, error) +} + +// ArtistBiographyProvider provides the GetArtistBiography function. +type ArtistBiographyProvider interface { + GetArtistBiography(ArtistRequest) (*ArtistBiographyResponse, error) +} + +// SimilarArtistsProvider provides the GetSimilarArtists function. +type SimilarArtistsProvider interface { + GetSimilarArtists(SimilarArtistsRequest) (*SimilarArtistsResponse, error) +} + +// ArtistImagesProvider provides the GetArtistImages function. +type ArtistImagesProvider interface { + GetArtistImages(ArtistRequest) (*ArtistImagesResponse, error) +} + +// ArtistTopSongsProvider provides the GetArtistTopSongs function. +type ArtistTopSongsProvider interface { + GetArtistTopSongs(TopSongsRequest) (*TopSongsResponse, error) +} + +// AlbumInfoProvider provides the GetAlbumInfo function. +type AlbumInfoProvider interface { + GetAlbumInfo(AlbumRequest) (*AlbumInfoResponse, error) +} + +// AlbumImagesProvider provides the GetAlbumImages function. +type AlbumImagesProvider interface { + GetAlbumImages(AlbumRequest) (*AlbumImagesResponse, error) +} + +// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +type SimilarSongsByTrackProvider interface { + GetSimilarSongsByTrack(SimilarSongsByTrackRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +type SimilarSongsByAlbumProvider interface { + GetSimilarSongsByAlbum(SimilarSongsByAlbumRequest) (*SimilarSongsResponse, error) +} + +// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +type SimilarSongsByArtistProvider interface { + GetSimilarSongsByArtist(SimilarSongsByArtistRequest) (*SimilarSongsResponse, error) +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Metadata) {} diff --git a/plugins/pdk/go/pdk/example_test.go b/plugins/pdk/go/pdk/example_test.go new file mode 100644 index 000000000..5678bddd4 --- /dev/null +++ b/plugins/pdk/go/pdk/example_test.go @@ -0,0 +1,324 @@ +// Example test demonstrating how to use the PDK mock for unit testing. +// This file is only compiled for non-WASM builds. +// +//go:build !wasip1 + +package pdk_test + +import ( + "testing" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/stretchr/testify/mock" +) + +// ExamplePlugin demonstrates a simple plugin that uses PDK functions. +type ExamplePlugin struct{} + +// ProcessMessage reads input, logs it, and outputs a response. +func (p *ExamplePlugin) ProcessMessage() error { + // Get configuration + prefix, ok := pdk.GetConfig("message_prefix") + if !ok { + prefix = "Hello" + } + + // Read input + message := pdk.InputString() + + // Log the message + pdk.Log(pdk.LogInfo, "Processing: "+message) + + // Output the response + pdk.OutputString(prefix + ", " + message + "!") + + return nil +} + +func TestExamplePlugin_ProcessMessage(t *testing.T) { + // Reset mock state before the test + pdk.ResetMock() + + // Set up expectations + pdk.PDKMock.On("GetConfig", "message_prefix").Return("Hi", true) + pdk.PDKMock.On("InputString").Return("World") + pdk.PDKMock.On("Log", pdk.LogInfo, "Processing: World").Return() + pdk.PDKMock.On("OutputString", "Hi, World!").Return() + + // Call the plugin function + plugin := &ExamplePlugin{} + err := plugin.ProcessMessage() + + // Verify no error + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Verify all expected calls were made + pdk.PDKMock.AssertExpectations(t) +} + +func TestExamplePlugin_ProcessMessage_DefaultPrefix(t *testing.T) { + // Reset mock state before the test + pdk.ResetMock() + + // Set up expectations - config key not found + pdk.PDKMock.On("GetConfig", "message_prefix").Return("", false) + pdk.PDKMock.On("InputString").Return("Test") + pdk.PDKMock.On("Log", pdk.LogInfo, "Processing: Test").Return() + pdk.PDKMock.On("OutputString", "Hello, Test!").Return() + + // Call the plugin function + plugin := &ExamplePlugin{} + err := plugin.ProcessMessage() + + // Verify no error + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Verify all expected calls were made + pdk.PDKMock.AssertExpectations(t) +} + +// Example of testing JSON input/output +type Request struct { + Name string `json:"name"` + Count int `json:"count"` +} + +type Response struct { + Message string `json:"message"` + Total int `json:"total"` +} + +func ProcessJSONRequest() error { + var req Request + if err := pdk.InputJSON(&req); err != nil { + pdk.SetError(err) + return err + } + + resp := Response{ + Message: "Hello, " + req.Name, + Total: req.Count * 2, + } + + return pdk.OutputJSON(resp) +} + +func TestProcessJSONRequest(t *testing.T) { + pdk.ResetMock() + + // Mock InputJSON to populate the request struct + pdk.PDKMock.On("InputJSON", mock.AnythingOfType("*pdk_test.Request")). + Return(nil). + Run(func(args mock.Arguments) { + req := args.Get(0).(*Request) + req.Name = "Alice" + req.Count = 5 + }) + + // Expect OutputJSON with the correct response + pdk.PDKMock.On("OutputJSON", Response{ + Message: "Hello, Alice", + Total: 10, + }).Return(nil) + + // Call the function + err := ProcessJSONRequest() + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + pdk.PDKMock.AssertExpectations(t) +} + +// ============================================================================= +// Examples using stub types (Memory, HTTPRequest, HTTPResponse) +// ============================================================================= + +// FetchData demonstrates a plugin function that makes an HTTP request. +func FetchData(url string) ([]byte, error) { + // Create and configure the HTTP request + // Note: SetHeader and SetBody work directly on the stub - no mocking needed! + req := pdk.NewHTTPRequest(pdk.MethodGet, url) + req.SetHeader("Accept", "application/json") + req.SetHeader("User-Agent", "MyPlugin/1.0") + + // Send the request - this is mocked because it requires host interaction + resp := req.Send() + + // Check status - works directly on the stub + if resp.Status() != 200 { + return nil, nil + } + + // Return body - works directly on the stub + return resp.Body(), nil +} + +func TestFetchData(t *testing.T) { + pdk.ResetMock() + + // Create a stub response with test data + expectedBody := []byte(`{"result": "success"}`) + stubResponse := pdk.NewStubHTTPResponse(200, map[string]string{ + "Content-Type": "application/json", + }, expectedBody) + + // Mock NewHTTPRequest to return a real HTTPRequest struct + // The struct methods (SetHeader, SetBody) work without mocking + pdk.PDKMock.On("NewHTTPRequest", pdk.MethodGet, "https://api.example.com/data"). + Return(&pdk.HTTPRequest{}) + + // Mock Send to return our stub response + pdk.PDKMock.On("Send", mock.AnythingOfType("*pdk.HTTPRequest")). + Return(stubResponse) + + // Call the function + body, err := FetchData("https://api.example.com/data") + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + if string(body) != string(expectedBody) { + t.Errorf("expected body %q, got %q", expectedBody, body) + } + + pdk.PDKMock.AssertExpectations(t) +} + +func TestFetchData_NonOKStatus(t *testing.T) { + pdk.ResetMock() + + // Create a stub response with 404 status + stubResponse := pdk.NewStubHTTPResponse(404, nil, []byte("Not Found")) + + pdk.PDKMock.On("NewHTTPRequest", pdk.MethodGet, "https://api.example.com/missing"). + Return(&pdk.HTTPRequest{}) + pdk.PDKMock.On("Send", mock.AnythingOfType("*pdk.HTTPRequest")). + Return(stubResponse) + + // Call the function + body, err := FetchData("https://api.example.com/missing") + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + // Should return nil for non-200 status + if body != nil { + t.Errorf("expected nil body for 404, got %q", body) + } + + pdk.PDKMock.AssertExpectations(t) +} + +// ProcessMemoryData demonstrates working with Memory type. +func ProcessMemoryData(mem pdk.Memory) string { + // Memory methods work directly on the stub - no mocking needed! + data := mem.ReadBytes() + return "Processed " + string(data) + " (length: " + formatUint64(mem.Length()) + ")" +} + +func formatUint64(n uint64) string { + return string(rune('0' + n%10)) // Simplified for demo +} + +func TestProcessMemoryData(t *testing.T) { + // Create stub memory with test data - no mocking needed! + mem := pdk.NewStubMemory(0, 5, []byte("hello")) + + result := ProcessMemoryData(mem) + + expected := "Processed hello (length: 5)" + if result != expected { + t.Errorf("expected %q, got %q", expected, result) + } +} + +// StoreAndRetrieve demonstrates Memory Store/Load methods. +func TestMemoryStoreAndLoad(t *testing.T) { + // Create empty memory + mem := pdk.NewStubMemory(100, 0, nil) + + // Store data - works directly, no mock needed + mem.Store([]byte("test data")) + + // Verify the data was stored + if mem.Length() != 9 { + t.Errorf("expected length 9, got %d", mem.Length()) + } + + // Load into buffer + buffer := make([]byte, 9) + mem.Load(buffer) + + if string(buffer) != "test data" { + t.Errorf("expected 'test data', got %q", buffer) + } + + // Free the memory + mem.Free() + + if mem.Length() != 0 { + t.Errorf("expected length 0 after free, got %d", mem.Length()) + } +} + +// HTTPMethodString demonstrates that HTTPMethod.String() works without mocking. +func TestHTTPMethodString(t *testing.T) { + // These work directly - no mocking needed! + tests := []struct { + method pdk.HTTPMethod + expected string + }{ + {pdk.MethodGet, "GET"}, + {pdk.MethodPost, "POST"}, + {pdk.MethodPut, "PUT"}, + {pdk.MethodDelete, "DELETE"}, + } + + for _, tc := range tests { + result := tc.method.String() + if result != tc.expected { + t.Errorf("expected %q for method %d, got %q", tc.expected, tc.method, result) + } + } +} + +// PostJSON demonstrates a more complex HTTP request with body. +func PostJSON(url string, data []byte) (int, error) { + req := pdk.NewHTTPRequest(pdk.MethodPost, url) + req.SetHeader("Content-Type", "application/json") + req.SetBody(data) // Works directly on stub + + resp := req.Send() // This is mocked + return int(resp.Status()), nil +} + +func TestPostJSON(t *testing.T) { + pdk.ResetMock() + + stubResponse := pdk.NewStubHTTPResponse(201, nil, nil) + + pdk.PDKMock.On("NewHTTPRequest", pdk.MethodPost, "https://api.example.com/items"). + Return(&pdk.HTTPRequest{}) + pdk.PDKMock.On("Send", mock.AnythingOfType("*pdk.HTTPRequest")). + Return(stubResponse) + + status, err := PostJSON("https://api.example.com/items", []byte(`{"name":"test"}`)) + + if err != nil { + t.Fatalf("unexpected error: %v", err) + } + + if status != 201 { + t.Errorf("expected status 201, got %d", status) + } + + pdk.PDKMock.AssertExpectations(t) +} diff --git a/plugins/pdk/go/pdk/pdk.go b/plugins/pdk/go/pdk/pdk.go new file mode 100644 index 000000000..35394d700 --- /dev/null +++ b/plugins/pdk/go/pdk/pdk.go @@ -0,0 +1,204 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains wrapper functions for the extism/go-pdk package. +// For WASM builds, it provides type aliases and function wrappers that delegate +// to the real extism/go-pdk package with zero overhead. +// +//go:build wasip1 + +package pdk + +import ( + extism "github.com/extism/go-pdk" +) + +// Type aliases - zero overhead, full compatibility +type HTTPMethod = extism.HTTPMethod +type HTTPRequest = extism.HTTPRequest +type HTTPRequestMeta = extism.HTTPRequestMeta +type HTTPResponse = extism.HTTPResponse +type LogLevel = extism.LogLevel +type Memory = extism.Memory + +// Constants + +const ( + LogDebug = extism.LogDebug + LogError = extism.LogError + LogInfo = extism.LogInfo + LogTrace = extism.LogTrace + LogWarn = extism.LogWarn +) + +const ( + MethodConnect = extism.MethodConnect + MethodDelete = extism.MethodDelete + MethodGet = extism.MethodGet + MethodHead = extism.MethodHead + MethodOptions = extism.MethodOptions + MethodPatch = extism.MethodPatch + MethodPost = extism.MethodPost + MethodPut = extism.MethodPut + MethodTrace = extism.MethodTrace +) + +// Functions +func Allocate(length int) Memory { + return extism.Allocate(length) +} +func AllocateBytes(data []byte) Memory { + return extism.AllocateBytes(data) +} + +// AllocateJSON AllocateJSON allocates and saves the type `any` into Memory on the host. +func AllocateJSON(v any) (Memory, error) { + return extism.AllocateJSON(v) +} + +// AllocateString AllocateString allocates and saves the UTF-8 string `data` into Memory on the host. +func AllocateString(data string) Memory { + return extism.AllocateString(data) +} + +// FindMemory FindMemory finds the host memory block at the given `offset`. +func FindMemory(offset uint64) Memory { + return extism.FindMemory(offset) +} + +// GetConfig GetConfig returns the config string associated with `key` (if any). +func GetConfig(key string) (string, bool) { + return extism.GetConfig(key) +} + +// GetVar GetVar returns the byte slice (if any) associated with `key`. +func GetVar(key string) []byte { + return extism.GetVar(key) +} + +// GetVarInt GetVarInt returns the int associated with `key` (or 0 if none). +func GetVarInt(key string) int { + return extism.GetVarInt(key) +} + +// Input Input returns a slice of bytes from the host. +func Input() []byte { + return extism.Input() +} + +// InputJSON InputJSON returns unmartialed JSON data from the host "input". +func InputJSON(v any) error { + return extism.InputJSON(v) +} + +// InputString InputString returns the input data from the host as a UTF-8 string. +func InputString() string { + return extism.InputString() +} + +// JSONFrom JSONFrom unmarshals a `Memory` block located at `offset` from the host into the provided data `v`. +func JSONFrom(offset uint64, v any) error { + return extism.JSONFrom(offset, v) +} + +// Log Log logs the provided UTF-8 string `s` on the host using the provided log `level`. +func Log(level LogLevel, s string) { + extism.Log(level, s) +} + +// LogMemory LogMemory logs the `memory` block on the host using the provided log `level`. +func LogMemory(level LogLevel, m Memory) { + extism.LogMemory(level, m) +} + +// NewHTTPRequest NewHTTPRequest returns a new `HTTPRequest`. +func NewHTTPRequest(method HTTPMethod, url string) *HTTPRequest { + return extism.NewHTTPRequest(method, url) +} +func NewMemory(offset uint64, length uint64) Memory { + return extism.NewMemory(offset, length) +} + +// Output Output sends the `data` slice of bytes to the host output. +func Output(data []byte) { + extism.Output(data) +} + +// OutputJSON OutputJSON marshals the provided data `v` as output to the host. +func OutputJSON(v any) error { + return extism.OutputJSON(v) +} + +// OutputMemory OutputMemory sends the `mem` Memory to the host output. +func OutputMemory(mem Memory) { + extism.OutputMemory(mem) +} + +// OutputString OutputString sends the UTF-8 string `s` to the host output. +func OutputString(s string) { + extism.OutputString(s) +} + +// ParamBytes ParamBytes returns bytes from Extism host memory given an offset. +func ParamBytes(offset uint64) []byte { + return extism.ParamBytes(offset) +} + +// ParamString ParamString returns UTF-8 string data from Extism host memory given an offset. +func ParamString(offset uint64) string { + return extism.ParamString(offset) +} + +// ParamU32 ParamU32 returns a uint32 from Extism host memory given an offset. +func ParamU32(offset uint64) uint32 { + return extism.ParamU32(offset) +} + +// ParamU64 ParamU64 returns a uint64 from Extism host memory given an offset. +func ParamU64(offset uint64) uint64 { + return extism.ParamU64(offset) +} + +// RemoveVar RemoveVar removes (and frees) the host variable associated with `key`. +func RemoveVar(key string) { + extism.RemoveVar(key) +} + +// ResultBytes ResultBytes allocates bytes and returns the offset in Extism host memory. +func ResultBytes(d []byte) uint64 { + return extism.ResultBytes(d) +} + +// ResultString ResultString allocates a UTF-8 string and returns the offset in Extism host memory. +func ResultString(s string) uint64 { + return extism.ResultString(s) +} + +// ResultU32 ResultU32 allocates a uint32 and returns the offset in Extism host memory. +func ResultU32(d uint32) uint64 { + return extism.ResultU32(d) +} + +// ResultU64 ResultU64 allocates a uint64 and returns the offset in Extism host memory. +func ResultU64(d uint64) uint64 { + return extism.ResultU64(d) +} + +// SetError SetError sets the host error string from `err`. +func SetError(err error) { + extism.SetError(err) +} + +// SetErrorString SetErrorString sets the host error string from `err`. +func SetErrorString(err string) { + extism.SetErrorString(err) +} + +// SetVar SetVar sets the host variable associated with `key` to the `value` byte slice. +func SetVar(key string, value []byte) { + extism.SetVar(key, value) +} + +// SetVarInt SetVarInt sets the host variable associated with `key` to the `value` int. +func SetVarInt(key string, value int) { + extism.SetVarInt(key, value) +} diff --git a/plugins/pdk/go/pdk/pdk_stub.go b/plugins/pdk/go/pdk/pdk_stub.go new file mode 100644 index 000000000..3bdbb1cb7 --- /dev/null +++ b/plugins/pdk/go/pdk/pdk_stub.go @@ -0,0 +1,210 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains mock implementations for non-WASM builds. +// These mocks allow IDE support, compilation, and unit testing on non-WASM platforms. +// Plugin authors can use the exported PDKMock instance to set expectations in tests. +// +//go:build !wasip1 + +package pdk + +import "github.com/stretchr/testify/mock" + +// mockPDK is the mock implementation for testing PDK functions. +type mockPDK struct { + mock.Mock +} + +// PDKMock is the auto-instantiated mock instance for testing. +// Use this to set expectations: pdk.PDKMock.On("GetConfig", "key").Return("value", true) +var PDKMock = &mockPDK{} + +// ResetMock resets the mock to its initial state. +// Call this in test setup/teardown to ensure clean state between tests. +func ResetMock() { + PDKMock = &mockPDK{} +} + +// Functions +func Allocate(length int) Memory { + args := PDKMock.Called(length) + return args.Get(0).(Memory) +} +func AllocateBytes(data []byte) Memory { + args := PDKMock.Called(data) + return args.Get(0).(Memory) +} + +// AllocateJSON AllocateJSON allocates and saves the type `any` into Memory on the host. +func AllocateJSON(v any) (Memory, error) { + args := PDKMock.Called(v) + return args.Get(0).(Memory), args.Error(1) +} + +// AllocateString AllocateString allocates and saves the UTF-8 string `data` into Memory on the host. +func AllocateString(data string) Memory { + args := PDKMock.Called(data) + return args.Get(0).(Memory) +} + +// FindMemory FindMemory finds the host memory block at the given `offset`. +func FindMemory(offset uint64) Memory { + args := PDKMock.Called(offset) + return args.Get(0).(Memory) +} + +// GetConfig GetConfig returns the config string associated with `key` (if any). +func GetConfig(key string) (string, bool) { + args := PDKMock.Called(key) + return args.String(0), args.Bool(1) +} + +// GetVar GetVar returns the byte slice (if any) associated with `key`. +func GetVar(key string) []byte { + args := PDKMock.Called(key) + return args.Get(0).([]byte) +} + +// GetVarInt GetVarInt returns the int associated with `key` (or 0 if none). +func GetVarInt(key string) int { + args := PDKMock.Called(key) + return args.Int(0) +} + +// Input Input returns a slice of bytes from the host. +func Input() []byte { + args := PDKMock.Called() + return args.Get(0).([]byte) +} + +// InputJSON InputJSON returns unmartialed JSON data from the host "input". +func InputJSON(v any) error { + args := PDKMock.Called(v) + return args.Error(0) +} + +// InputString InputString returns the input data from the host as a UTF-8 string. +func InputString() string { + args := PDKMock.Called() + return args.String(0) +} + +// JSONFrom JSONFrom unmarshals a `Memory` block located at `offset` from the host into the provided data `v`. +func JSONFrom(offset uint64, v any) error { + args := PDKMock.Called(offset, v) + return args.Error(0) +} + +// Log Log logs the provided UTF-8 string `s` on the host using the provided log `level`. +func Log(level LogLevel, s string) { + PDKMock.Called(level, s) +} + +// LogMemory LogMemory logs the `memory` block on the host using the provided log `level`. +func LogMemory(level LogLevel, m Memory) { + PDKMock.Called(level, m) +} + +// NewHTTPRequest NewHTTPRequest returns a new `HTTPRequest`. +func NewHTTPRequest(method HTTPMethod, url string) *HTTPRequest { + args := PDKMock.Called(method, url) + return args.Get(0).(*HTTPRequest) +} +func NewMemory(offset uint64, length uint64) Memory { + args := PDKMock.Called(offset, length) + return args.Get(0).(Memory) +} + +// Output Output sends the `data` slice of bytes to the host output. +func Output(data []byte) { + PDKMock.Called(data) +} + +// OutputJSON OutputJSON marshals the provided data `v` as output to the host. +func OutputJSON(v any) error { + args := PDKMock.Called(v) + return args.Error(0) +} + +// OutputMemory OutputMemory sends the `mem` Memory to the host output. +func OutputMemory(mem Memory) { + PDKMock.Called(mem) +} + +// OutputString OutputString sends the UTF-8 string `s` to the host output. +func OutputString(s string) { + PDKMock.Called(s) +} + +// ParamBytes ParamBytes returns bytes from Extism host memory given an offset. +func ParamBytes(offset uint64) []byte { + args := PDKMock.Called(offset) + return args.Get(0).([]byte) +} + +// ParamString ParamString returns UTF-8 string data from Extism host memory given an offset. +func ParamString(offset uint64) string { + args := PDKMock.Called(offset) + return args.String(0) +} + +// ParamU32 ParamU32 returns a uint32 from Extism host memory given an offset. +func ParamU32(offset uint64) uint32 { + args := PDKMock.Called(offset) + return args.Get(0).(uint32) +} + +// ParamU64 ParamU64 returns a uint64 from Extism host memory given an offset. +func ParamU64(offset uint64) uint64 { + args := PDKMock.Called(offset) + return args.Get(0).(uint64) +} + +// RemoveVar RemoveVar removes (and frees) the host variable associated with `key`. +func RemoveVar(key string) { + PDKMock.Called(key) +} + +// ResultBytes ResultBytes allocates bytes and returns the offset in Extism host memory. +func ResultBytes(d []byte) uint64 { + args := PDKMock.Called(d) + return args.Get(0).(uint64) +} + +// ResultString ResultString allocates a UTF-8 string and returns the offset in Extism host memory. +func ResultString(s string) uint64 { + args := PDKMock.Called(s) + return args.Get(0).(uint64) +} + +// ResultU32 ResultU32 allocates a uint32 and returns the offset in Extism host memory. +func ResultU32(d uint32) uint64 { + args := PDKMock.Called(d) + return args.Get(0).(uint64) +} + +// ResultU64 ResultU64 allocates a uint64 and returns the offset in Extism host memory. +func ResultU64(d uint64) uint64 { + args := PDKMock.Called(d) + return args.Get(0).(uint64) +} + +// SetError SetError sets the host error string from `err`. +func SetError(err error) { + PDKMock.Called(err) +} + +// SetErrorString SetErrorString sets the host error string from `err`. +func SetErrorString(err string) { + PDKMock.Called(err) +} + +// SetVar SetVar sets the host variable associated with `key` to the `value` byte slice. +func SetVar(key string, value []byte) { + PDKMock.Called(key, value) +} + +// SetVarInt SetVarInt sets the host variable associated with `key` to the `value` int. +func SetVarInt(key string, value int) { + PDKMock.Called(key, value) +} diff --git a/plugins/pdk/go/pdk/types_stub.go b/plugins/pdk/go/pdk/types_stub.go new file mode 100644 index 000000000..06cbb4f1f --- /dev/null +++ b/plugins/pdk/go/pdk/types_stub.go @@ -0,0 +1,192 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains type definitions for non-WASM builds. +// These types match the extism/go-pdk signatures to allow compilation and testing +// on native platforms without importing the WASM-only extism package. +// +//go:build !wasip1 + +package pdk + +// LogLevel represents a logging level. +type LogLevel int + +// Log level constants +const ( + LogTrace LogLevel = iota + LogDebug + LogInfo + LogWarn + LogError +) + +// HTTPMethod represents an HTTP method. +type HTTPMethod int32 + +// HTTP method constants +const ( + MethodGet HTTPMethod = iota + MethodHead + MethodPost + MethodPut + MethodPatch + MethodDelete + MethodConnect + MethodOptions + MethodTrace +) + +// String returns the string representation of the HTTP method. +func (m HTTPMethod) String() string { + switch m { + case MethodGet: + return "GET" + case MethodHead: + return "HEAD" + case MethodPost: + return "POST" + case MethodPut: + return "PUT" + case MethodPatch: + return "PATCH" + case MethodDelete: + return "DELETE" + case MethodConnect: + return "CONNECT" + case MethodOptions: + return "OPTIONS" + case MethodTrace: + return "TRACE" + default: + return "UNKNOWN" + } +} + +// Memory represents memory allocated by (and shared with) the host. +// This is a stub implementation for non-WASM platforms. +type Memory struct { + offset uint64 + length uint64 + data []byte +} + +// Offset returns the offset of the memory block. +func (m Memory) Offset() uint64 { + return m.offset +} + +// Length returns the length of the memory block. +func (m Memory) Length() uint64 { + return m.length +} + +// ReadBytes reads all bytes from the memory block. +func (m Memory) ReadBytes() []byte { + return m.data +} + +// Load reads the memory block into the provided buffer. +func (m *Memory) Load(buffer []byte) { + copy(buffer, m.data) +} + +// Store writes data to the memory block. +func (m *Memory) Store(data []byte) { + m.data = make([]byte, len(data)) + copy(m.data, data) + m.length = uint64(len(data)) +} + +// Free frees the memory block. +func (m *Memory) Free() { + m.data = nil + m.length = 0 +} + +// NewStubMemory creates a new stub Memory for testing. +// This is a helper function not present in the real PDK. +func NewStubMemory(offset, length uint64, data []byte) Memory { + return Memory{ + offset: offset, + length: length, + data: data, + } +} + +// HTTPRequest represents an HTTP request sent by the host. +// This is a stub implementation for non-WASM platforms. +type HTTPRequest struct { + method HTTPMethod + url string + headers map[string]string + body []byte +} + +// SetHeader sets an HTTP header key to value. +func (r *HTTPRequest) SetHeader(key string, value string) *HTTPRequest { + if r.headers == nil { + r.headers = make(map[string]string) + } + r.headers[key] = value + return r +} + +// SetBody sets the HTTP request body. +func (r *HTTPRequest) SetBody(body []byte) *HTTPRequest { + r.body = body + return r +} + +// Send sends the HTTP request and returns the response. +// In the stub implementation, this delegates to the mock. +func (r *HTTPRequest) Send() HTTPResponse { + args := PDKMock.Called(r) + return args.Get(0).(HTTPResponse) +} + +// HTTPRequestMeta represents the metadata associated with an HTTP request. +type HTTPRequestMeta struct { + URL string `json:"url"` + Method string `json:"method"` + Headers map[string]string `json:"headers"` +} + +// HTTPResponse represents an HTTP response returned from the host. +// This is a stub implementation for non-WASM platforms. +type HTTPResponse struct { + status uint16 + headers map[string]string + body []byte + memory Memory +} + +// Status returns the status code from the response. +func (r HTTPResponse) Status() uint16 { + return r.status +} + +// Headers returns the HTTP response headers. +func (r *HTTPResponse) Headers() map[string]string { + return r.headers +} + +// Body returns the body byte slice from the response. +func (r HTTPResponse) Body() []byte { + return r.body +} + +// Memory returns the memory associated with the response. +func (r HTTPResponse) Memory() Memory { + return r.memory +} + +// NewStubHTTPResponse creates a new stub HTTPResponse for testing. +// This is a helper function not present in the real PDK. +func NewStubHTTPResponse(status uint16, headers map[string]string, body []byte) HTTPResponse { + return HTTPResponse{ + status: status, + headers: headers, + body: body, + memory: NewStubMemory(0, uint64(len(body)), body), + } +} diff --git a/plugins/pdk/go/scheduler/scheduler.go b/plugins/pdk/go/scheduler/scheduler.go new file mode 100644 index 000000000..b3dd67bd2 --- /dev/null +++ b/plugins/pdk/go/scheduler/scheduler.go @@ -0,0 +1,74 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the SchedulerCallback capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package scheduler + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// SchedulerCallbackRequest is the request provided when a scheduled task fires. +type SchedulerCallbackRequest struct { + // ScheduleID is the unique identifier for this scheduled task. + // This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + ScheduleID string `json:"scheduleId"` + // Payload is the payload data that was provided when the task was scheduled. + // Can be used to pass context or parameters to the callback handler. + Payload string `json:"payload"` + // IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + // false if it's a one-time schedule (created via ScheduleOneTime). + IsRecurring bool `json:"isRecurring"` +} + +// Scheduler is the marker interface for scheduler plugins. +// Implement one or more of the provider interfaces below. +// SchedulerCallback provides scheduled task handling. +// This capability allows plugins to receive callbacks when their scheduled tasks execute. +// Plugins that use the scheduler host service must implement this capability +// to handle task execution. +type Scheduler interface{} + +// CallbackProvider provides the OnCallback function. +type CallbackProvider interface { + OnCallback(SchedulerCallbackRequest) error +} // Internal implementation holders +var ( + callbackImpl func(SchedulerCallbackRequest) error +) + +// Register registers a scheduler implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl Scheduler) { + if p, ok := impl.(CallbackProvider); ok { + callbackImpl = p.OnCallback + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_scheduler_callback +func _NdSchedulerCallback() int32 { + if callbackImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input SchedulerCallbackRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := callbackImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/scheduler/scheduler_stub.go b/plugins/pdk/go/scheduler/scheduler_stub.go new file mode 100644 index 000000000..44b79c800 --- /dev/null +++ b/plugins/pdk/go/scheduler/scheduler_stub.go @@ -0,0 +1,42 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package scheduler + +// SchedulerCallbackRequest is the request provided when a scheduled task fires. +type SchedulerCallbackRequest struct { + // ScheduleID is the unique identifier for this scheduled task. + // This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + ScheduleID string `json:"scheduleId"` + // Payload is the payload data that was provided when the task was scheduled. + // Can be used to pass context or parameters to the callback handler. + Payload string `json:"payload"` + // IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + // false if it's a one-time schedule (created via ScheduleOneTime). + IsRecurring bool `json:"isRecurring"` +} + +// Scheduler is the marker interface for scheduler plugins. +// Implement one or more of the provider interfaces below. +// SchedulerCallback provides scheduled task handling. +// This capability allows plugins to receive callbacks when their scheduled tasks execute. +// Plugins that use the scheduler host service must implement this capability +// to handle task execution. +type Scheduler interface{} + +// CallbackProvider provides the OnCallback function. +type CallbackProvider interface { + OnCallback(SchedulerCallbackRequest) error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Scheduler) {} diff --git a/plugins/pdk/go/scrobbler/scrobbler.go b/plugins/pdk/go/scrobbler/scrobbler.go new file mode 100644 index 000000000..0d045e597 --- /dev/null +++ b/plugins/pdk/go/scrobbler/scrobbler.go @@ -0,0 +1,248 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Scrobbler capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package scrobbler + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// ScrobblerError represents an error type for scrobbling operations. +type ScrobblerError string + +const ( + // ScrobblerErrorNotAuthorized indicates the user is not authorized. + ScrobblerErrorNotAuthorized ScrobblerError = "scrobbler(not_authorized)" + // ScrobblerErrorRetryLater indicates the operation should be retried later. + ScrobblerErrorRetryLater ScrobblerError = "scrobbler(retry_later)" + // ScrobblerErrorUnrecoverable indicates an unrecoverable error. + ScrobblerErrorUnrecoverable ScrobblerError = "scrobbler(unrecoverable)" +) + +// Error implements the error interface for ScrobblerError. +func (e ScrobblerError) Error() string { return string(e) } + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// IsAuthorizedRequest is the request for authorization check. +type IsAuthorizedRequest struct { + // Username is the username of the user. + Username string `json:"username"` +} + +// NowPlayingRequest is the request for now playing notification. +type NowPlayingRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track currently playing. + Track TrackInfo `json:"track"` + // Position is the current playback position in seconds. + Position int32 `json:"position"` +} + +// PlaybackReportRequest is the request for playback report notifications. +type PlaybackReportRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track being played. + Track TrackInfo `json:"track"` + // State is the current playback state (starting/playing/paused/stopped/expired). + State string `json:"state"` + // PositionMs is the current playback position in milliseconds. + PositionMs int64 `json:"positionMs"` + // PlaybackRate is the playback speed (1.0 = normal). + PlaybackRate float64 `json:"playbackRate"` + // PlayerId is the unique client identifier. + PlayerId string `json:"playerId"` + // PlayerName is the human-readable player name. + PlayerName string `json:"playerName"` + // Timestamp is the Unix timestamp when this report was generated. + Timestamp int64 `json:"timestamp"` +} + +// ScrobbleRequest is the request for submitting a scrobble. +type ScrobbleRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track that was played. + Track TrackInfo `json:"track"` + // Timestamp is the Unix timestamp when the track started playing. + Timestamp int64 `json:"timestamp"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` + // LibraryID is the ID of the library the track belongs to. + // Only included if the plugin has library permission with filesystem access for the track's library. + LibraryID int32 `json:"libraryId,omitempty"` + // Path is the full path to the track file, relative to the library root. + // Only included if the plugin has library permission with filesystem access for the track's library. + Path string `json:"path,omitempty"` +} + +// Scrobbler requires all methods to be implemented. +// Scrobbler provides scrobbling functionality to external services. +// This capability allows plugins to submit listening history to services like Last.fm, +// ListenBrainz, or custom scrobbling backends. +// +// All methods are required - plugins implementing this capability must provide +// all four functions: IsAuthorized, NowPlaying, Scrobble, and PlaybackReport. +type Scrobbler interface { + // IsAuthorized - IsAuthorized checks if a user is authorized to scrobble to this service. + IsAuthorized(IsAuthorizedRequest) (bool, error) + // NowPlaying - NowPlaying sends a now playing notification to the scrobbling service. + NowPlaying(NowPlayingRequest) error + // Scrobble - Scrobble submits a completed scrobble to the scrobbling service. + Scrobble(ScrobbleRequest) error + // PlaybackReport - PlaybackReport sends a playback state report to the scrobbling service. + PlaybackReport(PlaybackReportRequest) error +} // Internal implementation holders +var ( + isAuthorizedImpl func(IsAuthorizedRequest) (bool, error) + nowPlayingImpl func(NowPlayingRequest) error + scrobbleImpl func(ScrobbleRequest) error + playbackReportImpl func(PlaybackReportRequest) error +) + +// Register registers a scrobbler implementation. +// All methods are required. +func Register(impl Scrobbler) { + isAuthorizedImpl = impl.IsAuthorized + nowPlayingImpl = impl.NowPlaying + scrobbleImpl = impl.Scrobble + playbackReportImpl = impl.PlaybackReport +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_scrobbler_is_authorized +func _NdScrobblerIsAuthorized() int32 { + if isAuthorizedImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input IsAuthorizedRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := isAuthorizedImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_scrobbler_now_playing +func _NdScrobblerNowPlaying() int32 { + if nowPlayingImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input NowPlayingRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := nowPlayingImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_scrobbler_scrobble +func _NdScrobblerScrobble() int32 { + if scrobbleImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input ScrobbleRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := scrobbleImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_scrobbler_playback_report +func _NdScrobblerPlaybackReport() int32 { + if playbackReportImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input PlaybackReportRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := playbackReportImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/scrobbler/scrobbler_stub.go b/plugins/pdk/go/scrobbler/scrobbler_stub.go new file mode 100644 index 000000000..b35e7c40e --- /dev/null +++ b/plugins/pdk/go/scrobbler/scrobbler_stub.go @@ -0,0 +1,143 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package scrobbler + +// ScrobblerError represents an error type for scrobbling operations. +type ScrobblerError string + +const ( + // ScrobblerErrorNotAuthorized indicates the user is not authorized. + ScrobblerErrorNotAuthorized ScrobblerError = "scrobbler(not_authorized)" + // ScrobblerErrorRetryLater indicates the operation should be retried later. + ScrobblerErrorRetryLater ScrobblerError = "scrobbler(retry_later)" + // ScrobblerErrorUnrecoverable indicates an unrecoverable error. + ScrobblerErrorUnrecoverable ScrobblerError = "scrobbler(unrecoverable)" +) + +// Error implements the error interface for ScrobblerError. +func (e ScrobblerError) Error() string { return string(e) } + +// ArtistRef is a reference to an artist with name and optional MBID. +type ArtistRef struct { + // ID is the internal Navidrome artist ID (if known). + ID string `json:"id,omitempty"` + // Name is the artist name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the artist. + MBID string `json:"mbid,omitempty"` +} + +// IsAuthorizedRequest is the request for authorization check. +type IsAuthorizedRequest struct { + // Username is the username of the user. + Username string `json:"username"` +} + +// NowPlayingRequest is the request for now playing notification. +type NowPlayingRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track currently playing. + Track TrackInfo `json:"track"` + // Position is the current playback position in seconds. + Position int32 `json:"position"` +} + +// PlaybackReportRequest is the request for playback report notifications. +type PlaybackReportRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track being played. + Track TrackInfo `json:"track"` + // State is the current playback state (starting/playing/paused/stopped/expired). + State string `json:"state"` + // PositionMs is the current playback position in milliseconds. + PositionMs int64 `json:"positionMs"` + // PlaybackRate is the playback speed (1.0 = normal). + PlaybackRate float64 `json:"playbackRate"` + // PlayerId is the unique client identifier. + PlayerId string `json:"playerId"` + // PlayerName is the human-readable player name. + PlayerName string `json:"playerName"` + // Timestamp is the Unix timestamp when this report was generated. + Timestamp int64 `json:"timestamp"` +} + +// ScrobbleRequest is the request for submitting a scrobble. +type ScrobbleRequest struct { + // Username is the username of the user. + Username string `json:"username"` + // Track is the track that was played. + Track TrackInfo `json:"track"` + // Timestamp is the Unix timestamp when the track started playing. + Timestamp int64 `json:"timestamp"` +} + +// TrackInfo contains track metadata. +type TrackInfo struct { + // ID is the internal Navidrome track ID. + ID string `json:"id"` + // Title is the track title. + Title string `json:"title"` + // Album is the album name. + Album string `json:"album"` + // Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + Artist string `json:"artist"` + // AlbumArtist is the formatted album artist name for display. + AlbumArtist string `json:"albumArtist"` + // Artists is the list of track artists. + Artists []ArtistRef `json:"artists"` + // AlbumArtists is the list of album artists. + AlbumArtists []ArtistRef `json:"albumArtists"` + // Duration is the track duration in seconds. + Duration float32 `json:"duration"` + // TrackNumber is the track number on the album. + TrackNumber int32 `json:"trackNumber"` + // DiscNumber is the disc number. + DiscNumber int32 `json:"discNumber"` + // MBZRecordingID is the MusicBrainz recording ID. + MBZRecordingID string `json:"mbzRecordingId,omitempty"` + // MBZAlbumID is the MusicBrainz album/release ID. + MBZAlbumID string `json:"mbzAlbumId,omitempty"` + // MBZReleaseGroupID is the MusicBrainz release group ID. + MBZReleaseGroupID string `json:"mbzReleaseGroupId,omitempty"` + // MBZReleaseTrackID is the MusicBrainz release track ID. + MBZReleaseTrackID string `json:"mbzReleaseTrackId,omitempty"` + // LibraryID is the ID of the library the track belongs to. + // Only included if the plugin has library permission with filesystem access for the track's library. + LibraryID int32 `json:"libraryId,omitempty"` + // Path is the full path to the track file, relative to the library root. + // Only included if the plugin has library permission with filesystem access for the track's library. + Path string `json:"path,omitempty"` +} + +// Scrobbler requires all methods to be implemented. +// Scrobbler provides scrobbling functionality to external services. +// This capability allows plugins to submit listening history to services like Last.fm, +// ListenBrainz, or custom scrobbling backends. +// +// All methods are required - plugins implementing this capability must provide +// all four functions: IsAuthorized, NowPlaying, Scrobble, and PlaybackReport. +type Scrobbler interface { + // IsAuthorized - IsAuthorized checks if a user is authorized to scrobble to this service. + IsAuthorized(IsAuthorizedRequest) (bool, error) + // NowPlaying - NowPlaying sends a now playing notification to the scrobbling service. + NowPlaying(NowPlayingRequest) error + // Scrobble - Scrobble submits a completed scrobble to the scrobbling service. + Scrobble(ScrobbleRequest) error + // PlaybackReport - PlaybackReport sends a playback state report to the scrobbling service. + PlaybackReport(PlaybackReportRequest) error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ Scrobbler) {} diff --git a/plugins/pdk/go/sonicsimilarity/sonicsimilarity.go b/plugins/pdk/go/sonicsimilarity/sonicsimilarity.go new file mode 100644 index 000000000..7a2681f93 --- /dev/null +++ b/plugins/pdk/go/sonicsimilarity/sonicsimilarity.go @@ -0,0 +1,136 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the SonicSimilarity capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package sonicsimilarity + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// FindSonicPathRequest represents the FindSonicPathRequest data structure. +type FindSonicPathRequest struct { + StartSong SongRef `json:"startSong"` + EndSong SongRef `json:"endSong"` + Count int32 `json:"count"` +} + +// GetSonicSimilarTracksRequest represents the GetSonicSimilarTracksRequest data structure. +type GetSonicSimilarTracksRequest struct { + Song SongRef `json:"song"` + Count int32 `json:"count"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// SonicMatch represents the SonicMatch data structure. +type SonicMatch struct { + Song SongRef `json:"song"` + Similarity float64 `json:"similarity"` +} + +// SonicSimilarityResponse represents the SonicSimilarityResponse data structure. +type SonicSimilarityResponse struct { + Matches []SonicMatch `json:"matches"` +} + +// SonicSimilarity requires all methods to be implemented. +// SonicSimilarity provides audio-similarity based track discovery. +type SonicSimilarity interface { + // GetSonicSimilarTracks + GetSonicSimilarTracks(GetSonicSimilarTracksRequest) (SonicSimilarityResponse, error) + // FindSonicPath + FindSonicPath(FindSonicPathRequest) (SonicSimilarityResponse, error) +} // Internal implementation holders +var ( + sonicSimilarTracksImpl func(GetSonicSimilarTracksRequest) (SonicSimilarityResponse, error) + findSonicPathImpl func(FindSonicPathRequest) (SonicSimilarityResponse, error) +) + +// Register registers a sonicsimilarity implementation. +// All methods are required. +func Register(impl SonicSimilarity) { + sonicSimilarTracksImpl = impl.GetSonicSimilarTracks + findSonicPathImpl = impl.FindSonicPath +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_get_sonic_similar_tracks +func _NdGetSonicSimilarTracks() int32 { + if sonicSimilarTracksImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input GetSonicSimilarTracksRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := sonicSimilarTracksImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_find_sonic_path +func _NdFindSonicPath() int32 { + if findSonicPathImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input FindSonicPathRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := findSonicPathImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/sonicsimilarity/sonicsimilarity_stub.go b/plugins/pdk/go/sonicsimilarity/sonicsimilarity_stub.go new file mode 100644 index 000000000..28d86301c --- /dev/null +++ b/plugins/pdk/go/sonicsimilarity/sonicsimilarity_stub.go @@ -0,0 +1,71 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package sonicsimilarity + +// FindSonicPathRequest represents the FindSonicPathRequest data structure. +type FindSonicPathRequest struct { + StartSong SongRef `json:"startSong"` + EndSong SongRef `json:"endSong"` + Count int32 `json:"count"` +} + +// GetSonicSimilarTracksRequest represents the GetSonicSimilarTracksRequest data structure. +type GetSonicSimilarTracksRequest struct { + Song SongRef `json:"song"` + Count int32 `json:"count"` +} + +// SongRef is a reference to a song with metadata for matching. +type SongRef struct { + // ID is the internal Navidrome mediafile ID (if known). + ID string `json:"id,omitempty"` + // Name is the song name. + Name string `json:"name"` + // MBID is the MusicBrainz ID for the song. + MBID string `json:"mbid,omitempty"` + // ISRC is the International Standard Recording Code for the song. + ISRC string `json:"isrc,omitempty"` + // Artist is the artist name. + Artist string `json:"artist,omitempty"` + // ArtistMBID is the MusicBrainz artist ID. + ArtistMBID string `json:"artistMbid,omitempty"` + // Album is the album name. + Album string `json:"album,omitempty"` + // AlbumMBID is the MusicBrainz release ID. + AlbumMBID string `json:"albumMbid,omitempty"` + // Duration is the song duration in seconds. + Duration float32 `json:"duration,omitempty"` +} + +// SonicMatch represents the SonicMatch data structure. +type SonicMatch struct { + Song SongRef `json:"song"` + Similarity float64 `json:"similarity"` +} + +// SonicSimilarityResponse represents the SonicSimilarityResponse data structure. +type SonicSimilarityResponse struct { + Matches []SonicMatch `json:"matches"` +} + +// SonicSimilarity requires all methods to be implemented. +// SonicSimilarity provides audio-similarity based track discovery. +type SonicSimilarity interface { + // GetSonicSimilarTracks + GetSonicSimilarTracks(GetSonicSimilarTracksRequest) (SonicSimilarityResponse, error) + // FindSonicPath + FindSonicPath(FindSonicPathRequest) (SonicSimilarityResponse, error) +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ SonicSimilarity) {} diff --git a/plugins/pdk/go/taskworker/taskworker.go b/plugins/pdk/go/taskworker/taskworker.go new file mode 100644 index 000000000..5d09a3209 --- /dev/null +++ b/plugins/pdk/go/taskworker/taskworker.go @@ -0,0 +1,79 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the TaskWorker capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package taskworker + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TaskExecuteRequest is the request provided when a task is ready to execute. +type TaskExecuteRequest struct { + // QueueName is the name of the queue this task belongs to. + QueueName string `json:"queueName"` + // TaskID is the unique identifier for this task. + TaskID string `json:"taskId"` + // Payload is the opaque data provided when the task was enqueued. + Payload []byte `json:"payload"` + // Attempt is the current attempt number (1-based: first attempt = 1). + Attempt int32 `json:"attempt"` +} + +// TaskWorker is the marker interface for taskworker plugins. +// Implement one or more of the provider interfaces below. +// TaskWorker provides task execution handling. +// This capability allows plugins to receive callbacks when their queued tasks +// are ready to execute. Plugins that use the taskqueue host service must +// implement this capability. +type TaskWorker interface{} + +// TaskExecuteProvider provides the OnTaskExecute function. +type TaskExecuteProvider interface { + OnTaskExecute(TaskExecuteRequest) (string, error) +} // Internal implementation holders +var ( + taskExecuteImpl func(TaskExecuteRequest) (string, error) +) + +// Register registers a taskworker implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl TaskWorker) { + if p, ok := impl.(TaskExecuteProvider); ok { + taskExecuteImpl = p.OnTaskExecute + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_task_execute +func _NdTaskExecute() int32 { + if taskExecuteImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input TaskExecuteRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + output, err := taskExecuteImpl(input) + if err != nil { + pdk.SetError(err) + return -1 + } + + if err := pdk.OutputJSON(output); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/taskworker/taskworker_stub.go b/plugins/pdk/go/taskworker/taskworker_stub.go new file mode 100644 index 000000000..e45054e8e --- /dev/null +++ b/plugins/pdk/go/taskworker/taskworker_stub.go @@ -0,0 +1,41 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package taskworker + +// TaskExecuteRequest is the request provided when a task is ready to execute. +type TaskExecuteRequest struct { + // QueueName is the name of the queue this task belongs to. + QueueName string `json:"queueName"` + // TaskID is the unique identifier for this task. + TaskID string `json:"taskId"` + // Payload is the opaque data provided when the task was enqueued. + Payload []byte `json:"payload"` + // Attempt is the current attempt number (1-based: first attempt = 1). + Attempt int32 `json:"attempt"` +} + +// TaskWorker is the marker interface for taskworker plugins. +// Implement one or more of the provider interfaces below. +// TaskWorker provides task execution handling. +// This capability allows plugins to receive callbacks when their queued tasks +// are ready to execute. Plugins that use the taskqueue host service must +// implement this capability. +type TaskWorker interface{} + +// TaskExecuteProvider provides the OnTaskExecute function. +type TaskExecuteProvider interface { + OnTaskExecute(TaskExecuteRequest) (string, error) +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ TaskWorker) {} diff --git a/plugins/pdk/go/websocket/websocket.go b/plugins/pdk/go/websocket/websocket.go new file mode 100644 index 000000000..47a53b7b3 --- /dev/null +++ b/plugins/pdk/go/websocket/websocket.go @@ -0,0 +1,187 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the WebSocketCallback capability. +// It is intended for use in Navidrome plugins built with TinyGo. +// +//go:build wasip1 + +package websocket + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// OnBinaryMessageRequest is the request provided when a binary message is received. +type OnBinaryMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Data is the binary data received from the WebSocket, encoded as base64. + Data []byte `json:"data"` +} + +// OnCloseRequest is the request provided when a WebSocket connection is closed. +type OnCloseRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that was closed. + ConnectionID string `json:"connectionId"` + // Code is the WebSocket close status code (e.g., 1000 for normal closure, + // 1001 for going away, 1006 for abnormal closure). + Code int32 `json:"code"` + // Reason is the human-readable reason for the connection closure, if provided. + Reason string `json:"reason"` +} + +// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +type OnErrorRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + ConnectionID string `json:"connectionId"` + // Error is the error message describing what went wrong. + Error string `json:"error"` +} + +// OnTextMessageRequest is the request provided when a text message is received. +type OnTextMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Message is the text message content received from the WebSocket. + Message string `json:"message"` +} + +// WebSocket is the marker interface for websocket plugins. +// Implement one or more of the provider interfaces below. +// WebSocketCallback provides WebSocket message handling. +// This capability allows plugins to receive callbacks for WebSocket events +// such as text messages, binary messages, errors, and connection closures. +// Plugins that use the WebSocket host service must implement this capability +// to handle incoming events. +type WebSocket interface{} + +// TextMessageProvider provides the OnTextMessage function. +type TextMessageProvider interface { + OnTextMessage(OnTextMessageRequest) error +} + +// BinaryMessageProvider provides the OnBinaryMessage function. +type BinaryMessageProvider interface { + OnBinaryMessage(OnBinaryMessageRequest) error +} + +// ErrorProvider provides the OnError function. +type ErrorProvider interface { + OnError(OnErrorRequest) error +} + +// CloseProvider provides the OnClose function. +type CloseProvider interface { + OnClose(OnCloseRequest) error +} // Internal implementation holders +var ( + textMessageImpl func(OnTextMessageRequest) error + binaryMessageImpl func(OnBinaryMessageRequest) error + errorImpl func(OnErrorRequest) error + closeImpl func(OnCloseRequest) error +) + +// Register registers a websocket implementation. +// The implementation is checked for optional provider interfaces. +func Register(impl WebSocket) { + if p, ok := impl.(TextMessageProvider); ok { + textMessageImpl = p.OnTextMessage + } + if p, ok := impl.(BinaryMessageProvider); ok { + binaryMessageImpl = p.OnBinaryMessage + } + if p, ok := impl.(ErrorProvider); ok { + errorImpl = p.OnError + } + if p, ok := impl.(CloseProvider); ok { + closeImpl = p.OnClose + } +} + +// NotImplementedCode is the standard return code for unimplemented functions. +// The host recognizes this and skips the plugin gracefully. +const NotImplementedCode int32 = -2 + +//go:wasmexport nd_websocket_on_text_message +func _NdWebsocketOnTextMessage() int32 { + if textMessageImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnTextMessageRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := textMessageImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_websocket_on_binary_message +func _NdWebsocketOnBinaryMessage() int32 { + if binaryMessageImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnBinaryMessageRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := binaryMessageImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_websocket_on_error +func _NdWebsocketOnError() int32 { + if errorImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnErrorRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := errorImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} + +//go:wasmexport nd_websocket_on_close +func _NdWebsocketOnClose() int32 { + if closeImpl == nil { + // Return standard code - host will skip this plugin gracefully + return NotImplementedCode + } + + var input OnCloseRequest + if err := pdk.InputJSON(&input); err != nil { + pdk.SetError(err) + return -1 + } + + if err := closeImpl(input); err != nil { + pdk.SetError(err) + return -1 + } + + return 0 +} diff --git a/plugins/pdk/go/websocket/websocket_stub.go b/plugins/pdk/go/websocket/websocket_stub.go new file mode 100644 index 000000000..214118a89 --- /dev/null +++ b/plugins/pdk/go/websocket/websocket_stub.go @@ -0,0 +1,80 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file provides stub implementations for non-WASM platforms. +// It allows Go plugins to compile and run tests outside of WASM, +// but the actual functionality is only available in WASM builds. +// +//go:build !wasip1 + +package websocket + +// OnBinaryMessageRequest is the request provided when a binary message is received. +type OnBinaryMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Data is the binary data received from the WebSocket, encoded as base64. + Data []byte `json:"data"` +} + +// OnCloseRequest is the request provided when a WebSocket connection is closed. +type OnCloseRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that was closed. + ConnectionID string `json:"connectionId"` + // Code is the WebSocket close status code (e.g., 1000 for normal closure, + // 1001 for going away, 1006 for abnormal closure). + Code int32 `json:"code"` + // Reason is the human-readable reason for the connection closure, if provided. + Reason string `json:"reason"` +} + +// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +type OnErrorRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + ConnectionID string `json:"connectionId"` + // Error is the error message describing what went wrong. + Error string `json:"error"` +} + +// OnTextMessageRequest is the request provided when a text message is received. +type OnTextMessageRequest struct { + // ConnectionID is the unique identifier for the WebSocket connection that received the message. + ConnectionID string `json:"connectionId"` + // Message is the text message content received from the WebSocket. + Message string `json:"message"` +} + +// WebSocket is the marker interface for websocket plugins. +// Implement one or more of the provider interfaces below. +// WebSocketCallback provides WebSocket message handling. +// This capability allows plugins to receive callbacks for WebSocket events +// such as text messages, binary messages, errors, and connection closures. +// Plugins that use the WebSocket host service must implement this capability +// to handle incoming events. +type WebSocket interface{} + +// TextMessageProvider provides the OnTextMessage function. +type TextMessageProvider interface { + OnTextMessage(OnTextMessageRequest) error +} + +// BinaryMessageProvider provides the OnBinaryMessage function. +type BinaryMessageProvider interface { + OnBinaryMessage(OnBinaryMessageRequest) error +} + +// ErrorProvider provides the OnError function. +type ErrorProvider interface { + OnError(OnErrorRequest) error +} + +// CloseProvider provides the OnClose function. +type CloseProvider interface { + OnClose(OnCloseRequest) error +} + +// NotImplementedCode is the standard return code for unimplemented functions. +const NotImplementedCode int32 = -2 + +// Register is a no-op on non-WASM platforms. +// This stub allows code to compile outside of WASM. +func Register(_ WebSocket) {} diff --git a/plugins/pdk/python/host/nd_host_artwork.py b/plugins/pdk/python/host/nd_host_artwork.py new file mode 100644 index 000000000..9bcb529ae --- /dev/null +++ b/plugins/pdk/python/host/nd_host_artwork.py @@ -0,0 +1,183 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Artwork host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "artwork_getartisturl") +def _artwork_getartisturl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "artwork_getalbumurl") +def _artwork_getalbumurl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "artwork_gettrackurl") +def _artwork_gettrackurl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "artwork_getplaylisturl") +def _artwork_getplaylisturl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def artwork_get_artist_url(id: str, size: int) -> str: + """GetArtistUrl generates a public URL for an artist's artwork. + +Parameters: + - id: The artist's unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_getartisturl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") + + +def artwork_get_album_url(id: str, size: int) -> str: + """GetAlbumUrl generates a public URL for an album's artwork. + +Parameters: + - id: The album's unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_getalbumurl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") + + +def artwork_get_track_url(id: str, size: int) -> str: + """GetTrackUrl generates a public URL for a track's artwork. + +Parameters: + - id: The track's (media file) unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_gettrackurl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") + + +def artwork_get_playlist_url(id: str, size: int) -> str: + """GetPlaylistUrl generates a public URL for a playlist's artwork. + +Parameters: + - id: The playlist's unique identifier + - size: Desired image size in pixels (0 for original size) + +Returns the public URL for the artwork, or an error if generation fails. + + Args: + id: str parameter. + size: int parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + "size": size, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _artwork_getplaylisturl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("url", "") diff --git a/plugins/pdk/python/host/nd_host_cache.py b/plugins/pdk/python/host/nd_host_cache.py new file mode 100644 index 000000000..b24e983cc --- /dev/null +++ b/plugins/pdk/python/host/nd_host_cache.py @@ -0,0 +1,448 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Cache host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "cache_setstring") +def _cache_setstring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getstring") +def _cache_getstring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_setint") +def _cache_setint(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getint") +def _cache_getint(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_setfloat") +def _cache_setfloat(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getfloat") +def _cache_getfloat(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_setbytes") +def _cache_setbytes(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_getbytes") +def _cache_getbytes(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_has") +def _cache_has(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "cache_remove") +def _cache_remove(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class CacheGetStringResult: + """Result type for cache_get_string.""" + value: str + exists: bool + + +@dataclass +class CacheGetIntResult: + """Result type for cache_get_int.""" + value: int + exists: bool + + +@dataclass +class CacheGetFloatResult: + """Result type for cache_get_float.""" + value: float + exists: bool + + +@dataclass +class CacheGetBytesResult: + """Result type for cache_get_bytes.""" + value: bytes + exists: bool + + +def cache_set_string(key: str, value: str, ttl_seconds: int) -> None: + """SetString stores a string value in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The string value to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: str parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setstring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_string(key: str) -> CacheGetStringResult: + """GetString retrieves a string value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not a string, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetStringResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getstring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetStringResult( + value=response.get("value", ""), + exists=response.get("exists", False), + ) + + +def cache_set_int(key: str, value: int, ttl_seconds: int) -> None: + """SetInt stores an integer value in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The integer value to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: int parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setint(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_int(key: str) -> CacheGetIntResult: + """GetInt retrieves an integer value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not an integer, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetIntResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getint(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetIntResult( + value=response.get("value", 0), + exists=response.get("exists", False), + ) + + +def cache_set_float(key: str, value: float, ttl_seconds: int) -> None: + """SetFloat stores a float value in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The float value to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: float parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": value, + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setfloat(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_float(key: str) -> CacheGetFloatResult: + """GetFloat retrieves a float value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not a float, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetFloatResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getfloat(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetFloatResult( + value=response.get("value", 0.0), + exists=response.get("exists", False), + ) + + +def cache_set_bytes(key: str, value: bytes, ttl_seconds: int) -> None: + """SetBytes stores a byte slice in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + - value: The byte slice to store + - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) + +Returns an error if the operation fails. + + Args: + key: str parameter. + value: bytes parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": base64.b64encode(value).decode("ascii"), + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_setbytes(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def cache_get_bytes(key: str) -> CacheGetBytesResult: + """GetBytes retrieves a byte slice from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns the value and whether the key exists. If the key doesn't exist +or the stored value is not a byte slice, exists will be false. + + Args: + key: str parameter. + + Returns: + CacheGetBytesResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_getbytes(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return CacheGetBytesResult( + value=base64.b64decode(response.get("value", "")), + exists=response.get("exists", False), + ) + + +def cache_has(key: str) -> bool: + """Has checks if a key exists in the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns true if the key exists and has not expired. + + Args: + key: str parameter. + + Returns: + bool: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_has(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("exists", False) + + +def cache_remove(key: str) -> None: + """Remove deletes a value from the cache. + +Parameters: + - key: The cache key (will be namespaced with plugin ID) + +Returns an error if the operation fails. Does not return an error if the key doesn't exist. + + Args: + key: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _cache_remove(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/pdk/python/host/nd_host_config.py b/plugins/pdk/python/host/nd_host_config.py new file mode 100644 index 000000000..1dab2fe0e --- /dev/null +++ b/plugins/pdk/python/host/nd_host_config.py @@ -0,0 +1,145 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Config host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "config_get") +def _config_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_getint") +def _config_getint(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "config_keys") +def _config_keys(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class ConfigGetResult: + """Result type for config_get.""" + value: str + exists: bool + + +@dataclass +class ConfigGetIntResult: + """Result type for config_get_int.""" + value: int + exists: bool + + +def config_get(key: str) -> ConfigGetResult: + """Get retrieves a configuration value as a string. + +Parameters: + - key: The configuration key + +Returns the value and whether the key exists. + + Args: + key: str parameter. + + Returns: + ConfigGetResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return ConfigGetResult( + value=response.get("value", ""), + exists=response.get("exists", False), + ) + + +def config_get_int(key: str) -> ConfigGetIntResult: + """GetInt retrieves a configuration value as an integer. + +Parameters: + - key: The configuration key + +Returns the value and whether the key exists. If the key exists but the +value cannot be parsed as an integer, exists will be false. + + Args: + key: str parameter. + + Returns: + ConfigGetIntResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_getint(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return ConfigGetIntResult( + value=response.get("value", 0), + exists=response.get("exists", False), + ) + + +def config_keys(prefix: str) -> Any: + """Keys returns configuration keys matching the given prefix. + +Parameters: + - prefix: Key prefix to filter by. If empty, returns all keys. + +Returns a sorted slice of matching configuration keys. + + Args: + prefix: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "prefix": prefix, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _config_keys(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + return response.get("keys", None) diff --git a/plugins/pdk/python/host/nd_host_http.py b/plugins/pdk/python/host/nd_host_http.py new file mode 100644 index 000000000..a806c8456 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_http.py @@ -0,0 +1,60 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the HTTP host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "http_send") +def _http_send(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def http_send(request: Any) -> Any: + """Send executes an HTTP request and returns the response. + +Parameters: + - request: The HTTP request to execute, including method, URL, headers, body, and timeout + +Returns the HTTP response with status code, headers, and body. +Network errors, timeouts, and permission failures are returned as Go errors. +Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. + + Args: + request: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "request": request, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _http_send(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_httpclient.py b/plugins/pdk/python/host/nd_host_httpclient.py new file mode 100644 index 000000000..c6bfb77c0 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_httpclient.py @@ -0,0 +1,59 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the HTTP host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "http_send") +def _http_send(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def http_send(request: Any) -> Any: + """Send executes an HTTP request and returns the response. + +Parameters: + - request: The HTTP request to execute, including method, URL, headers, body, and timeout + +Returns the HTTP response with status code, headers, and body. +Network errors, timeouts, and permission failures are returned as errors. +Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. + + Args: + request: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "request": request, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _http_send(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_kvstore.py b/plugins/pdk/python/host/nd_host_kvstore.py new file mode 100644 index 000000000..33eaffc52 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_kvstore.py @@ -0,0 +1,362 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the KVStore host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "kvstore_set") +def _kvstore_set(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_setwithttl") +def _kvstore_setwithttl(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_get") +def _kvstore_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_getmany") +def _kvstore_getmany(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_has") +def _kvstore_has(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_list") +def _kvstore_list(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_delete") +def _kvstore_delete(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_deletebyprefix") +def _kvstore_deletebyprefix(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "kvstore_getstorageused") +def _kvstore_getstorageused(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class KVStoreGetResult: + """Result type for kvstore_get.""" + value: bytes + exists: bool + + +def kvstore_set(key: str, value: bytes) -> None: + """Set stores a byte value with the given key. + +Parameters: + - key: The storage key (max 256 bytes, UTF-8) + - value: The byte slice to store + +Returns an error if the storage limit would be exceeded or the operation fails. + + Args: + key: str parameter. + value: bytes parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": base64.b64encode(value).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_set(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def kvstore_set_with_ttl(key: str, value: bytes, ttl_seconds: int) -> None: + """SetWithTTL stores a byte value with the given key and a time-to-live. + +After ttlSeconds, the key is treated as non-existent and will be +cleaned up lazily. ttlSeconds must be greater than 0. + +Parameters: + - key: The storage key (max 256 bytes, UTF-8) + - value: The byte slice to store + - ttlSeconds: Time-to-live in seconds (must be > 0) + +Returns an error if the storage limit would be exceeded or the operation fails. + + Args: + key: str parameter. + value: bytes parameter. + ttl_seconds: int parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + "value": base64.b64encode(value).decode("ascii"), + "ttlSeconds": ttl_seconds, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_setwithttl(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def kvstore_get(key: str) -> KVStoreGetResult: + """Get retrieves a byte value from storage. + +Parameters: + - key: The storage key + +Returns the value and whether the key exists. + + Args: + key: str parameter. + + Returns: + KVStoreGetResult containing value, exists,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return KVStoreGetResult( + value=base64.b64decode(response.get("value", "")), + exists=response.get("exists", False), + ) + + +def kvstore_get_many(keys: Any) -> Any: + """GetMany retrieves multiple values in a single call. + +Parameters: + - keys: The storage keys to retrieve + +Returns a map of key to value for keys that exist and have not expired. +Missing or expired keys are omitted from the result. + + Args: + keys: Any parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "keys": keys, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_getmany(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("values", None) + + +def kvstore_has(key: str) -> bool: + """Has checks if a key exists in storage. + +Parameters: + - key: The storage key + +Returns true if the key exists. + + Args: + key: str parameter. + + Returns: + bool: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_has(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("exists", False) + + +def kvstore_list(prefix: str) -> Any: + """List returns all keys matching the given prefix. + +Parameters: + - prefix: Key prefix to filter by (empty string returns all keys) + +Returns a slice of matching keys. + + Args: + prefix: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "prefix": prefix, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_list(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("keys", None) + + +def kvstore_delete(key: str) -> None: + """Delete removes a value from storage. + +Parameters: + - key: The storage key + +Returns an error if the operation fails. Does not return an error if the key doesn't exist. + + Args: + key: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "key": key, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_delete(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def kvstore_delete_by_prefix(prefix: str) -> int: + """DeleteByPrefix removes all keys matching the given prefix. + +Parameters: + - prefix: Key prefix to match (must not be empty) + +Returns the number of keys deleted. Includes expired keys. + + Args: + prefix: str parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "prefix": prefix, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_deletebyprefix(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("deletedCount", 0) + + +def kvstore_get_storage_used() -> int: + """GetStorageUsed returns the total storage used by this plugin in bytes. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _kvstore_getstorageused(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("bytes", 0) diff --git a/plugins/pdk/python/host/nd_host_library.py b/plugins/pdk/python/host/nd_host_library.py new file mode 100644 index 000000000..12e1bc4eb --- /dev/null +++ b/plugins/pdk/python/host/nd_host_library.py @@ -0,0 +1,86 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Library host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "library_getlibrary") +def _library_getlibrary(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "library_getalllibraries") +def _library_getalllibraries(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def library_get_library(id: int) -> Any: + """GetLibrary retrieves metadata for a specific library by ID. + +Parameters: + - id: The library's unique identifier + +Returns the library metadata, or an error if the library is not found. + + Args: + id: int parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "id": id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _library_getlibrary(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def library_get_all_libraries() -> Any: + """GetAllLibraries retrieves metadata for all configured libraries. + +Returns a slice of all libraries with their metadata. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _library_getalllibraries(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_scheduler.py b/plugins/pdk/python/host/nd_host_scheduler.py new file mode 100644 index 000000000..7f0d19241 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_scheduler.py @@ -0,0 +1,143 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Scheduler host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "scheduler_scheduleonetime") +def _scheduler_scheduleonetime(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "scheduler_schedulerecurring") +def _scheduler_schedulerecurring(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "scheduler_cancelschedule") +def _scheduler_cancelschedule(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def scheduler_schedule_one_time(delay_seconds: int, payload: str, schedule_id: str) -> str: + """ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +Plugins that use this function must also implement the SchedulerCallback capability + +Parameters: + - delaySeconds: Number of seconds to wait before triggering the event + - payload: Data to be passed to the scheduled event handler + - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + +Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + + Args: + delay_seconds: int parameter. + payload: str parameter. + schedule_id: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "delaySeconds": delay_seconds, + "payload": payload, + "scheduleId": schedule_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_scheduleonetime(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("newScheduleId", "") + + +def scheduler_schedule_recurring(cron_expression: str, payload: str, schedule_id: str) -> str: + """ScheduleRecurring schedules a recurring event using a cron expression. +Plugins that use this function must also implement the SchedulerCallback capability + +Parameters: + - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) + - payload: Data to be passed to each scheduled event handler invocation + - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated + +Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. + + Args: + cron_expression: str parameter. + payload: str parameter. + schedule_id: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "cronExpression": cron_expression, + "payload": payload, + "scheduleId": schedule_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_schedulerecurring(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("newScheduleId", "") + + +def scheduler_cancel_schedule(schedule_id: str) -> None: + """CancelSchedule cancels a scheduled job identified by its schedule ID. + +This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +any future events. + +Returns an error if the schedule ID is not found or if cancellation fails. + + Args: + schedule_id: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "scheduleId": schedule_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _scheduler_cancelschedule(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/pdk/python/host/nd_host_subsonicapi.py b/plugins/pdk/python/host/nd_host_subsonicapi.py new file mode 100644 index 000000000..cf35bc043 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_subsonicapi.py @@ -0,0 +1,101 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the SubsonicAPI host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "subsonicapi_call") +def _subsonicapi_call(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "subsonicapi_callraw") +def _subsonicapi_callraw(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@dataclass +class SubsonicAPICallRawResult: + """Result type for subsonicapi_call_raw.""" + content_type: str + data: bytes + + +def subsonicapi_call(uri: str) -> str: + """Call executes a Subsonic API request and returns the JSON response. + +The uri parameter should be the Subsonic API path without the server prefix, +e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. + + Args: + uri: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "uri": uri, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_call(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("responseJson", "") + + +def subsonicapi_call_raw(uri: str) -> SubsonicAPICallRawResult: + """CallRaw executes a Subsonic API request and returns the raw binary response. +Designed for binary endpoints like getCoverArt and stream that return +non-JSON data. The data is base64-encoded over JSON on the wire. + + Args: + uri: str parameter. + + Returns: + SubsonicAPICallRawResult containing content_type, data,. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "uri": uri, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _subsonicapi_callraw(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return SubsonicAPICallRawResult( + content_type=response.get("contentType", ""), + data=base64.b64decode(response.get("data", "")), + ) diff --git a/plugins/pdk/python/host/nd_host_task.py b/plugins/pdk/python/host/nd_host_task.py new file mode 100644 index 000000000..5d6e7474c --- /dev/null +++ b/plugins/pdk/python/host/nd_host_task.py @@ -0,0 +1,188 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Task host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "task_createqueue") +def _task_createqueue(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_enqueue") +def _task_enqueue(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_get") +def _task_get(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_cancel") +def _task_cancel(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "task_clearqueue") +def _task_clearqueue(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def task_create_queue(name: str, config: Any) -> None: + """CreateQueue creates a named task queue with the given configuration. +Zero-value fields in config use sensible defaults. +If a queue with the same name already exists, returns an error. +On startup, this also recovers any stale "running" tasks from a previous crash. + + Args: + name: str parameter. + config: Any parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "name": name, + "config": config, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_createqueue(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def task_enqueue(queue_name: str, payload: bytes) -> str: + """Enqueue adds a task to the named queue. Returns the task ID. +payload is opaque bytes passed back to the plugin on execution. + + Args: + queue_name: str parameter. + payload: bytes parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "queueName": queue_name, + "payload": base64.b64encode(payload).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_enqueue(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", "") + + +def task_get(task_id: str) -> Any: + """Get returns the current state of a task including its status, +message, and attempt count. + + Args: + task_id: str parameter. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "taskId": task_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_get(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def task_cancel(task_id: str) -> None: + """Cancel cancels a pending task. Returns error if already +running, completed, or failed. + + Args: + task_id: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "taskId": task_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_cancel(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def task_clear_queue(queue_name: str) -> int: + """ClearQueue removes all pending tasks from the named queue. +Running tasks are not affected. Returns the number of tasks removed. + + Args: + queue_name: str parameter. + + Returns: + int: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "queueName": queue_name, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _task_clearqueue(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", 0) diff --git a/plugins/pdk/python/host/nd_host_users.py b/plugins/pdk/python/host/nd_host_users.py new file mode 100644 index 000000000..a325156a7 --- /dev/null +++ b/plugins/pdk/python/host/nd_host_users.py @@ -0,0 +1,80 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the Users host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "users_getusers") +def _users_getusers(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "users_getadmins") +def _users_getadmins(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def users_get_users() -> Any: + """GetUsers returns all users the plugin has been granted access to. +Only minimal user information (userName, name, isAdmin) is returned. +Sensitive fields like password and email are never exposed. + +Returns a slice of users the plugin can access, or an empty slice if none configured. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _users_getusers(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) + + +def users_get_admins() -> Any: + """GetAdmins returns only admin users the plugin has been granted access to. +This is a convenience method that filters GetUsers results to include only admins. + +Returns a slice of admin users the plugin can access, or an empty slice if none. + + Returns: + Any: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request_bytes = b"{}" + request_mem = extism.memory.alloc(request_bytes) + response_offset = _users_getadmins(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("result", None) diff --git a/plugins/pdk/python/host/nd_host_websocket.py b/plugins/pdk/python/host/nd_host_websocket.py new file mode 100644 index 000000000..4e882914c --- /dev/null +++ b/plugins/pdk/python/host/nd_host_websocket.py @@ -0,0 +1,182 @@ +# Code generated by ndpgen. DO NOT EDIT. +# +# This file contains client wrappers for the WebSocket host service. +# It is intended for use in Navidrome plugins built with extism-py. +# +# IMPORTANT: Due to a limitation in extism-py, you cannot import this file directly. +# The @extism.import_fn decorators are only detected when defined in the plugin's +# main __init__.py file. Copy the needed functions from this file into your plugin. + +from dataclasses import dataclass +from typing import Any + +import extism +import json +import base64 + + +class HostFunctionError(Exception): + """Raised when a host function returns an error.""" + pass + + +@extism.import_fn("extism:host/user", "websocket_connect") +def _websocket_connect(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "websocket_sendtext") +def _websocket_sendtext(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "websocket_sendbinary") +def _websocket_sendbinary(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +@extism.import_fn("extism:host/user", "websocket_closeconnection") +def _websocket_closeconnection(offset: int) -> int: + """Raw host function - do not call directly.""" + ... + + +def websocket_connect(url: str, headers: Any, connection_id: str) -> str: + """Connect establishes a WebSocket connection to the specified URL. + +Plugins that use this function must also implement the WebSocketCallback capability +to receive incoming messages and connection events. + +Parameters: + - url: The WebSocket URL to connect to (ws:// or wss://) + - headers: Optional HTTP headers to include in the handshake request + - connectionID: Optional unique identifier for the connection. If empty, one will be generated + +Returns the connection ID that can be used to send messages or close the connection, +or an error if the connection fails. + + Args: + url: str parameter. + headers: Any parameter. + connection_id: str parameter. + + Returns: + str: The result value. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "url": url, + "headers": headers, + "connectionId": connection_id, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_connect(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + return response.get("newConnectionId", "") + + +def websocket_send_text(connection_id: str, message: str) -> None: + """SendText sends a text message over an established WebSocket connection. + +Parameters: + - connectionID: The connection identifier returned by Connect + - message: The text message to send + +Returns an error if the connection is not found or if sending fails. + + Args: + connection_id: str parameter. + message: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "connectionId": connection_id, + "message": message, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_sendtext(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def websocket_send_binary(connection_id: str, data: bytes) -> None: + """SendBinary sends binary data over an established WebSocket connection. + +Parameters: + - connectionID: The connection identifier returned by Connect + - data: The binary data to send + +Returns an error if the connection is not found or if sending fails. + + Args: + connection_id: str parameter. + data: bytes parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "connectionId": connection_id, + "data": base64.b64encode(data).decode("ascii"), + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_sendbinary(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + + + +def websocket_close_connection(connection_id: str, code: int, reason: str) -> None: + """CloseConnection gracefully closes a WebSocket connection. + +Parameters: + - connectionID: The connection identifier returned by Connect + - code: WebSocket close status code (e.g., 1000 for normal closure) + - reason: Optional human-readable reason for closing + +Returns an error if the connection is not found or if closing fails. + + Args: + connection_id: str parameter. + code: int parameter. + reason: str parameter. + + Raises: + HostFunctionError: If the host function returns an error. + """ + request = { + "connectionId": connection_id, + "code": code, + "reason": reason, + } + request_bytes = json.dumps(request).encode("utf-8") + request_mem = extism.memory.alloc(request_bytes) + response_offset = _websocket_closeconnection(request_mem.offset) + response_mem = extism.memory.find(response_offset) + response = json.loads(extism.memory.string(response_mem)) + + if response.get("error"): + raise HostFunctionError(response["error"]) + diff --git a/plugins/pdk/rust/README.md b/plugins/pdk/rust/README.md new file mode 100644 index 000000000..891465cc5 --- /dev/null +++ b/plugins/pdk/rust/README.md @@ -0,0 +1,145 @@ +# Navidrome Plugin Development Kit for Rust + +This directory contains the Rust PDK crates for building Navidrome plugins. + +## Crate Structure + +``` +plugins/pdk/rust/ +├── nd-pdk/ # Umbrella crate - use this as your dependency +├── nd-pdk-host/ # Host function wrappers (call Navidrome services) +└── nd-pdk-capabilities/ # Capability traits and types (generated) +``` + +## Usage + +Add the `nd-pdk` crate as a dependency in your plugin's `Cargo.toml`: + +```toml +[package] +name = "my-plugin" +edition = "2021" + +[lib] +crate-type = ["cdylib"] + +[dependencies] +nd-pdk = { path = "../../pdk/rust/nd-pdk" } +extism-pdk = "1.2" +``` + +### Implementing a Scrobbler (Required-All Pattern) + +The Scrobbler capability requires all methods to be implemented: + +```rust +use nd_pdk::scrobbler::{ + Error, IsAuthorizedRequest, + NowPlayingRequest, ScrobbleRequest, Scrobbler, +}; + +// Register WASM exports for all Scrobbler methods +nd_pdk::register_scrobbler!(MyPlugin); + +#[derive(Default)] +struct MyPlugin; + +impl Scrobbler for MyPlugin { + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result<bool, Error> { + Ok(true) + } + + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error> { + // Handle now playing notification + Ok(()) + } + + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error> { + // Submit scrobble + Ok(()) + } +} +``` + +### Implementing Metadata Agent (Optional Pattern) + +The MetadataAgent capability allows implementing individual methods: + +```rust +use nd_pdk::metadata::{ + ArtistBiographyProvider, GetArtistBiographyRequest, ArtistBiography, Error, +}; + +// Register only the methods you implement +nd_pdk::register_artist_biography!(MyPlugin); + +#[derive(Default)] +struct MyPlugin; + +impl ArtistBiographyProvider for MyPlugin { + fn get_artist_biography(&self, req: GetArtistBiographyRequest) + -> Result<ArtistBiography, Error> + { + // Return artist biography + Ok(ArtistBiography { + biography: "Artist bio text...".into(), + ..Default::default() + }) + } +} +``` + +### Using Host Services + +Access Navidrome services via the host module: + +```rust +use nd_pdk::host::{artwork, scheduler, library}; + +// Get artwork URL for a track +let url = artwork::get_track_url("track-id", 300)?; + +// Schedule a one-time callback +scheduler::schedule_one_time(60, "my-payload", "schedule-id")?; + +// Get library information +let libs = library::get_all()?; +``` + +## Available Capabilities + +| Capability | Pattern | Description | +|-------------|--------------|-----------------------------------------------------| +| `scrobbler` | Required-all | Submit listening history to external services | +| `metadata` | Optional | Provide artist/album metadata from external sources | +| `lifecycle` | Optional | Handle plugin initialization | +| `scheduler` | Optional | Receive scheduled callbacks | +| `websocket` | Optional | Handle WebSocket messages | + +## Building + +Rust plugins must be compiled to WASM using the `wasm32-wasip1` target: + +```bash +cargo build --release --target wasm32-wasip1 +``` + +The resulting `.wasm` file can be packaged into an `.ndp` plugin package. + +## Examples + +See the example plugins for complete implementations: + +- [webhook-rs](../../examples/webhook-rs/) - Simple scrobbler using the PDK +- [discord-rich-presence-rs](../../examples/discord-rich-presence-rs/) - Complex plugin with multiple capabilities +- [library-inspector-rs](../../examples/library-inspector-rs/) - Host service demonstration + +## Code Generation + +The capability modules in `nd-pdk-capabilities` are auto-generated from the Go capability definitions. To regenerate after capability changes: + +```bash +make gen +``` + +This generates both Go and Rust PDK code. diff --git a/plugins/pdk/rust/nd-pdk-capabilities/Cargo.toml b/plugins/pdk/rust/nd-pdk-capabilities/Cargo.toml new file mode 100644 index 000000000..443f19da5 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "nd-pdk-capabilities" +version = "0.1.0" +edition = "2021" +description = "Navidrome capability wrappers for Rust plugins" +authors = ["Navidrome Team"] +license = "GPL-3.0" + +[lib] +path = "src/lib.rs" +crate-type = ["rlib"] + +[dependencies] +base64 = "0.22" +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/lib.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/lib.rs new file mode 100644 index 000000000..b0361a3a3 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/lib.rs @@ -0,0 +1,15 @@ +// Code generated by ndpgen. DO NOT EDIT. + +//! Navidrome Plugin Development Kit - Capability Wrappers +//! +//! This crate provides type definitions, traits, and registration macros +//! for implementing Navidrome plugin capabilities in Rust. + +pub mod lifecycle; +pub mod lyrics; +pub mod metadata; +pub mod scheduler; +pub mod scrobbler; +pub mod sonicsimilarity; +pub mod taskworker; +pub mod websocket; diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/lifecycle.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/lifecycle.rs new file mode 100644 index 000000000..87b5485ba --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/lifecycle.rs @@ -0,0 +1,45 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lifecycle capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// InitProvider provides the OnInit function. +pub trait InitProvider { + fn on_init(&self) -> Result<(), Error>; +} + +/// Register the on_init export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_lifecycle_init { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_on_init( + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::lifecycle::InitProvider::on_init(&plugin)?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/lyrics.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/lyrics.rs new file mode 100644 index 000000000..0a861a1ed --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/lyrics.rs @@ -0,0 +1,156 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Lyrics capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// ArtistRef is a reference to an artist with name and optional MBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRef { + /// ID is the internal Navidrome artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// GetLyricsRequest contains the track information for lyrics lookup. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GetLyricsRequest { + #[serde(default)] + pub track: TrackInfo, +} +/// GetLyricsResponse contains the lyrics returned by the plugin. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GetLyricsResponse { + #[serde(default)] + pub lyrics: Vec<LyricsText>, +} +/// LyricsText represents a single set of lyrics in raw text format. +/// Text can be plain text or LRC format — Navidrome will parse it. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct LyricsText { + #[serde(default, skip_serializing_if = "String::is_empty")] + pub lang: String, + #[serde(default)] + pub text: String, +} +/// TrackInfo contains track metadata. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TrackInfo { + /// ID is the internal Navidrome track ID. + #[serde(default)] + pub id: String, + /// Title is the track title. + #[serde(default)] + pub title: String, + /// Album is the album name. + #[serde(default)] + pub album: String, + /// Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + #[serde(default)] + pub artist: String, + /// AlbumArtist is the formatted album artist name for display. + #[serde(default)] + pub album_artist: String, + /// Artists is the list of track artists. + #[serde(default)] + pub artists: Vec<ArtistRef>, + /// AlbumArtists is the list of album artists. + #[serde(default)] + pub album_artists: Vec<ArtistRef>, + /// Duration is the track duration in seconds. + #[serde(default)] + pub duration: f32, + /// TrackNumber is the track number on the album. + #[serde(default)] + pub track_number: i32, + /// DiscNumber is the disc number. + #[serde(default)] + pub disc_number: i32, + /// MBZRecordingID is the MusicBrainz recording ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_recording_id: String, + /// MBZAlbumID is the MusicBrainz album/release ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_album_id: String, + /// MBZReleaseGroupID is the MusicBrainz release group ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_group_id: String, + /// MBZReleaseTrackID is the MusicBrainz release track ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_track_id: String, + /// LibraryID is the ID of the library the track belongs to. + /// Only included if the plugin has library permission with filesystem access for the track's library. + #[serde(default, skip_serializing_if = "is_zero_i32")] + pub library_id: i32, + /// Path is the full path to the track file, relative to the library root. + /// Only included if the plugin has library permission with filesystem access for the track's library. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub path: String, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// Lyrics requires all methods to be implemented. +/// Lyrics provides lyrics for a given track from external sources. +pub trait Lyrics { + /// GetLyrics + fn get_lyrics(&self, req: GetLyricsRequest) -> Result<GetLyricsResponse, Error>; +} + +/// Register all exports for the Lyrics capability. +/// This macro generates the WASM export functions for all trait methods. +#[macro_export] +macro_rules! register_lyrics { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_lyrics_get_lyrics( + req: extism_pdk::Json<$crate::lyrics::GetLyricsRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::lyrics::GetLyricsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::lyrics::Lyrics::get_lyrics(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs new file mode 100644 index 000000000..463e52c37 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/metadata.rs @@ -0,0 +1,539 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the MetadataAgent capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// AlbumImagesResponse is the response for GetAlbumImages. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AlbumImagesResponse { + /// Images is the list of album images. + #[serde(default)] + pub images: Vec<ImageInfo>, +} +/// AlbumInfoResponse is the response for GetAlbumInfo. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AlbumInfoResponse { + /// Name is the album name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the album. + #[serde(default)] + pub mbid: String, + /// Description is the album description/notes. + #[serde(default)] + pub description: String, + /// URL is the external URL for the album. + #[serde(default)] + pub url: String, +} +/// AlbumRequest is the common request for album-related functions. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct AlbumRequest { + /// Name is the album name. + #[serde(default)] + pub name: String, + /// Artist is the album artist name. + #[serde(default)] + pub artist: String, + /// MBID is the MusicBrainz ID for the album (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// ArtistBiographyResponse is the response for GetArtistBiography. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistBiographyResponse { + /// Biography is the artist biography text. + #[serde(default)] + pub biography: String, +} +/// ArtistImagesResponse is the response for GetArtistImages. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistImagesResponse { + /// Images is the list of artist images. + #[serde(default)] + pub images: Vec<ImageInfo>, +} +/// ArtistMBIDRequest is the request for GetArtistMBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistMBIDRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, +} +/// ArtistMBIDResponse is the response for GetArtistMBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistMBIDResponse { + /// MBID is the MusicBrainz ID for the artist. + #[serde(default)] + pub mbid: String, +} +/// ArtistRef is a reference to an artist with name and optional MBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRef { + /// ID is the internal Navidrome artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// ArtistRequest is the common request for artist-related functions. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// ArtistURLResponse is the response for GetArtistURL. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistURLResponse { + /// URL is the external URL for the artist. + #[serde(default)] + pub url: String, +} +/// ImageInfo represents an image with URL and size. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ImageInfo { + /// URL is the URL of the image. + #[serde(default)] + pub url: String, + /// Size is the size of the image in pixels (width or height). + #[serde(default)] + pub size: i32, +} +/// SimilarArtistsRequest is the request for GetSimilarArtists. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarArtistsRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Limit is the maximum number of similar artists to return. + #[serde(default)] + pub limit: i32, +} +/// SimilarArtistsResponse is the response for GetSimilarArtists. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarArtistsResponse { + /// Artists is the list of similar artists. + #[serde(default)] + pub artists: Vec<ArtistRef>, +} +/// SimilarSongsByAlbumRequest is the request for GetSimilarSongsByAlbum. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsByAlbumRequest { + /// ID is the internal Navidrome album ID. + #[serde(default)] + pub id: String, + /// Name is the album name. + #[serde(default)] + pub name: String, + /// Artist is the album artist name. + #[serde(default)] + pub artist: String, + /// MBID is the MusicBrainz release ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of similar songs to return. + #[serde(default)] + pub count: i32, +} +/// SimilarSongsByArtistRequest is the request for GetSimilarSongsByArtist. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsByArtistRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of similar songs to return. + #[serde(default)] + pub count: i32, +} +/// SimilarSongsByTrackRequest is the request for GetSimilarSongsByTrack. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsByTrackRequest { + /// ID is the internal Navidrome mediafile ID. + #[serde(default)] + pub id: String, + /// Name is the track title. + #[serde(default)] + pub name: String, + /// Artist is the artist name. + #[serde(default)] + pub artist: String, + /// MBID is the MusicBrainz recording ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of similar songs to return. + #[serde(default)] + pub count: i32, +} +/// SimilarSongsResponse is the response for GetSimilarSongsBy* functions. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SimilarSongsResponse { + /// Songs is the list of similar songs. + #[serde(default)] + pub songs: Vec<SongRef>, +} +/// SongRef is a reference to a song with metadata for matching. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SongRef { + /// ID is the internal Navidrome mediafile ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the song name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the song. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// ISRC is the International Standard Recording Code for the song. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub isrc: String, + /// Artist is the artist name. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub artist: String, + /// ArtistMBID is the MusicBrainz artist ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub artist_mbid: String, + /// Album is the album name. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub album: String, + /// AlbumMBID is the MusicBrainz release ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub album_mbid: String, + /// Duration is the song duration in seconds. + #[serde(default, skip_serializing_if = "is_zero_f32")] + pub duration: f32, +} +/// TopSongsRequest is the request for GetArtistTopSongs. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TopSongsRequest { + /// ID is the internal Navidrome artist ID. + #[serde(default)] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// Count is the maximum number of top songs to return. + #[serde(default)] + pub count: i32, +} +/// TopSongsResponse is the response for GetArtistTopSongs. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TopSongsResponse { + /// Songs is the list of top songs. + #[serde(default)] + pub songs: Vec<SongRef>, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// ArtistMBIDProvider provides the GetArtistMBID function. +pub trait ArtistMBIDProvider { + fn get_artist_mbid(&self, req: ArtistMBIDRequest) -> Result<ArtistMBIDResponse, Error>; +} + +/// Register the get_artist_mbid export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_mbid { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_mbid( + req: extism_pdk::Json<$crate::metadata::ArtistMBIDRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistMBIDResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistMBIDProvider::get_artist_mbid(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistURLProvider provides the GetArtistURL function. +pub trait ArtistURLProvider { + fn get_artist_url(&self, req: ArtistRequest) -> Result<ArtistURLResponse, Error>; +} + +/// Register the get_artist_url export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_url { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_url( + req: extism_pdk::Json<$crate::metadata::ArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistURLResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistURLProvider::get_artist_url(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistBiographyProvider provides the GetArtistBiography function. +pub trait ArtistBiographyProvider { + fn get_artist_biography(&self, req: ArtistRequest) -> Result<ArtistBiographyResponse, Error>; +} + +/// Register the get_artist_biography export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_biography { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_biography( + req: extism_pdk::Json<$crate::metadata::ArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistBiographyResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistBiographyProvider::get_artist_biography(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarArtistsProvider provides the GetSimilarArtists function. +pub trait SimilarArtistsProvider { + fn get_similar_artists(&self, req: SimilarArtistsRequest) -> Result<SimilarArtistsResponse, Error>; +} + +/// Register the get_similar_artists export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_artists { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_artists( + req: extism_pdk::Json<$crate::metadata::SimilarArtistsRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarArtistsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarArtistsProvider::get_similar_artists(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistImagesProvider provides the GetArtistImages function. +pub trait ArtistImagesProvider { + fn get_artist_images(&self, req: ArtistRequest) -> Result<ArtistImagesResponse, Error>; +} + +/// Register the get_artist_images export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_images { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_images( + req: extism_pdk::Json<$crate::metadata::ArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::ArtistImagesResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistImagesProvider::get_artist_images(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// ArtistTopSongsProvider provides the GetArtistTopSongs function. +pub trait ArtistTopSongsProvider { + fn get_artist_top_songs(&self, req: TopSongsRequest) -> Result<TopSongsResponse, Error>; +} + +/// Register the get_artist_top_songs export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_artist_top_songs { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_artist_top_songs( + req: extism_pdk::Json<$crate::metadata::TopSongsRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::TopSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::ArtistTopSongsProvider::get_artist_top_songs(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// AlbumInfoProvider provides the GetAlbumInfo function. +pub trait AlbumInfoProvider { + fn get_album_info(&self, req: AlbumRequest) -> Result<AlbumInfoResponse, Error>; +} + +/// Register the get_album_info export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_album_info { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_album_info( + req: extism_pdk::Json<$crate::metadata::AlbumRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::AlbumInfoResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::AlbumInfoProvider::get_album_info(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// AlbumImagesProvider provides the GetAlbumImages function. +pub trait AlbumImagesProvider { + fn get_album_images(&self, req: AlbumRequest) -> Result<AlbumImagesResponse, Error>; +} + +/// Register the get_album_images export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_album_images { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_album_images( + req: extism_pdk::Json<$crate::metadata::AlbumRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::AlbumImagesResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::AlbumImagesProvider::get_album_images(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarSongsByTrackProvider provides the GetSimilarSongsByTrack function. +pub trait SimilarSongsByTrackProvider { + fn get_similar_songs_by_track(&self, req: SimilarSongsByTrackRequest) -> Result<SimilarSongsResponse, Error>; +} + +/// Register the get_similar_songs_by_track export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_songs_by_track { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_songs_by_track( + req: extism_pdk::Json<$crate::metadata::SimilarSongsByTrackRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarSongsByTrackProvider::get_similar_songs_by_track(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarSongsByAlbumProvider provides the GetSimilarSongsByAlbum function. +pub trait SimilarSongsByAlbumProvider { + fn get_similar_songs_by_album(&self, req: SimilarSongsByAlbumRequest) -> Result<SimilarSongsResponse, Error>; +} + +/// Register the get_similar_songs_by_album export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_songs_by_album { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_songs_by_album( + req: extism_pdk::Json<$crate::metadata::SimilarSongsByAlbumRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarSongsByAlbumProvider::get_similar_songs_by_album(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} + +/// SimilarSongsByArtistProvider provides the GetSimilarSongsByArtist function. +pub trait SimilarSongsByArtistProvider { + fn get_similar_songs_by_artist(&self, req: SimilarSongsByArtistRequest) -> Result<SimilarSongsResponse, Error>; +} + +/// Register the get_similar_songs_by_artist export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_metadata_similar_songs_by_artist { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_similar_songs_by_artist( + req: extism_pdk::Json<$crate::metadata::SimilarSongsByArtistRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::metadata::SimilarSongsResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::metadata::SimilarSongsByArtistProvider::get_similar_songs_by_artist(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/scheduler.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/scheduler.rs new file mode 100644 index 000000000..53b8564ee --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/scheduler.rs @@ -0,0 +1,78 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the SchedulerCallback capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// SchedulerCallbackRequest is the request provided when a scheduled task fires. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SchedulerCallbackRequest { + /// ScheduleID is the unique identifier for this scheduled task. + /// This is either the ID provided when scheduling, or an auto-generated UUID if none was specified. + #[serde(default)] + pub schedule_id: String, + /// Payload is the payload data that was provided when the task was scheduled. + /// Can be used to pass context or parameters to the callback handler. + #[serde(default)] + pub payload: String, + /// IsRecurring is true if this is a recurring schedule (created via ScheduleRecurring), + /// false if it's a one-time schedule (created via ScheduleOneTime). + #[serde(default)] + pub is_recurring: bool, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// CallbackProvider provides the OnCallback function. +pub trait CallbackProvider { + fn on_callback(&self, req: SchedulerCallbackRequest) -> Result<(), Error>; +} + +/// Register the on_callback export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_scheduler_callback { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_scheduler_callback( + req: extism_pdk::Json<$crate::scheduler::SchedulerCallbackRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::scheduler::CallbackProvider::on_callback(&plugin, req.into_inner())?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/scrobbler.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/scrobbler.rs new file mode 100644 index 000000000..1e9c51375 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/scrobbler.rs @@ -0,0 +1,240 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the Scrobbler capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// ScrobblerError represents an error type for scrobbling operations. +pub type ScrobblerError = &'static str; +/// ScrobblerErrorNotAuthorized indicates the user is not authorized. +pub const SCROBBLER_ERROR_NOT_AUTHORIZED: ScrobblerError = "scrobbler(not_authorized)"; +/// ScrobblerErrorRetryLater indicates the operation should be retried later. +pub const SCROBBLER_ERROR_RETRY_LATER: ScrobblerError = "scrobbler(retry_later)"; +/// ScrobblerErrorUnrecoverable indicates an unrecoverable error. +pub const SCROBBLER_ERROR_UNRECOVERABLE: ScrobblerError = "scrobbler(unrecoverable)"; +/// ArtistRef is a reference to an artist with name and optional MBID. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ArtistRef { + /// ID is the internal Navidrome artist ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the artist name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the artist. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, +} +/// IsAuthorizedRequest is the request for authorization check. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct IsAuthorizedRequest { + /// Username is the username of the user. + #[serde(default)] + pub username: String, +} +/// NowPlayingRequest is the request for now playing notification. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct NowPlayingRequest { + /// Username is the username of the user. + #[serde(default)] + pub username: String, + /// Track is the track currently playing. + #[serde(default)] + pub track: TrackInfo, + /// Position is the current playback position in seconds. + #[serde(default)] + pub position: i32, +} +/// PlaybackReportRequest is the request for playback report notifications. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct PlaybackReportRequest { + /// Username is the username of the user. + #[serde(default)] + pub username: String, + /// Track is the track being played. + #[serde(default)] + pub track: TrackInfo, + /// State is the current playback state (starting/playing/paused/stopped/expired). + #[serde(default)] + pub state: String, + /// PositionMs is the current playback position in milliseconds. + #[serde(default)] + pub position_ms: i64, + /// PlaybackRate is the playback speed (1.0 = normal). + #[serde(default)] + pub playback_rate: f64, + /// PlayerId is the unique client identifier. + #[serde(default)] + pub player_id: String, + /// PlayerName is the human-readable player name. + #[serde(default)] + pub player_name: String, + /// Timestamp is the Unix timestamp when this report was generated. + #[serde(default)] + pub timestamp: i64, +} +/// ScrobbleRequest is the request for submitting a scrobble. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ScrobbleRequest { + /// Username is the username of the user. + #[serde(default)] + pub username: String, + /// Track is the track that was played. + #[serde(default)] + pub track: TrackInfo, + /// Timestamp is the Unix timestamp when the track started playing. + #[serde(default)] + pub timestamp: i64, +} +/// TrackInfo contains track metadata. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TrackInfo { + /// ID is the internal Navidrome track ID. + #[serde(default)] + pub id: String, + /// Title is the track title. + #[serde(default)] + pub title: String, + /// Album is the album name. + #[serde(default)] + pub album: String, + /// Artist is the formatted artist name for display (e.g., "Artist1 • Artist2"). + #[serde(default)] + pub artist: String, + /// AlbumArtist is the formatted album artist name for display. + #[serde(default)] + pub album_artist: String, + /// Artists is the list of track artists. + #[serde(default)] + pub artists: Vec<ArtistRef>, + /// AlbumArtists is the list of album artists. + #[serde(default)] + pub album_artists: Vec<ArtistRef>, + /// Duration is the track duration in seconds. + #[serde(default)] + pub duration: f32, + /// TrackNumber is the track number on the album. + #[serde(default)] + pub track_number: i32, + /// DiscNumber is the disc number. + #[serde(default)] + pub disc_number: i32, + /// MBZRecordingID is the MusicBrainz recording ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_recording_id: String, + /// MBZAlbumID is the MusicBrainz album/release ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_album_id: String, + /// MBZReleaseGroupID is the MusicBrainz release group ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_group_id: String, + /// MBZReleaseTrackID is the MusicBrainz release track ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbz_release_track_id: String, + /// LibraryID is the ID of the library the track belongs to. + /// Only included if the plugin has library permission with filesystem access for the track's library. + #[serde(default, skip_serializing_if = "is_zero_i32")] + pub library_id: i32, + /// Path is the full path to the track file, relative to the library root. + /// Only included if the plugin has library permission with filesystem access for the track's library. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub path: String, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// Scrobbler requires all methods to be implemented. +/// Scrobbler provides scrobbling functionality to external services. +/// This capability allows plugins to submit listening history to services like Last.fm, +/// ListenBrainz, or custom scrobbling backends. +/// +/// All methods are required - plugins implementing this capability must provide +/// all four functions: IsAuthorized, NowPlaying, Scrobble, and PlaybackReport. +pub trait Scrobbler { + /// IsAuthorized - IsAuthorized checks if a user is authorized to scrobble to this service. + fn is_authorized(&self, req: IsAuthorizedRequest) -> Result<bool, Error>; + /// NowPlaying - NowPlaying sends a now playing notification to the scrobbling service. + fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error>; + /// Scrobble - Scrobble submits a completed scrobble to the scrobbling service. + fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error>; + /// PlaybackReport - PlaybackReport sends a playback state report to the scrobbling service. + fn playback_report(&self, req: PlaybackReportRequest) -> Result<(), Error>; +} + +/// Register all exports for the Scrobbler capability. +/// This macro generates the WASM export functions for all trait methods. +#[macro_export] +macro_rules! register_scrobbler { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_scrobbler_is_authorized( + req: extism_pdk::Json<$crate::scrobbler::IsAuthorizedRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<bool>> { + let plugin = <$plugin_type>::default(); + let result = $crate::scrobbler::Scrobbler::is_authorized(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + #[extism_pdk::plugin_fn] + pub fn nd_scrobbler_now_playing( + req: extism_pdk::Json<$crate::scrobbler::NowPlayingRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::scrobbler::Scrobbler::now_playing(&plugin, req.into_inner())?; + Ok(()) + } + #[extism_pdk::plugin_fn] + pub fn nd_scrobbler_scrobble( + req: extism_pdk::Json<$crate::scrobbler::ScrobbleRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::scrobbler::Scrobbler::scrobble(&plugin, req.into_inner())?; + Ok(()) + } + #[extism_pdk::plugin_fn] + pub fn nd_scrobbler_playback_report( + req: extism_pdk::Json<$crate::scrobbler::PlaybackReportRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::scrobbler::Scrobbler::playback_report(&plugin, req.into_inner())?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/sonicsimilarity.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/sonicsimilarity.rs new file mode 100644 index 000000000..eb2868929 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/sonicsimilarity.rs @@ -0,0 +1,141 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the SonicSimilarity capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// FindSonicPathRequest represents the FindSonicPathRequest data structure. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct FindSonicPathRequest { + #[serde(default)] + pub start_song: SongRef, + #[serde(default)] + pub end_song: SongRef, + #[serde(default)] + pub count: i32, +} +/// GetSonicSimilarTracksRequest represents the GetSonicSimilarTracksRequest data structure. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct GetSonicSimilarTracksRequest { + #[serde(default)] + pub song: SongRef, + #[serde(default)] + pub count: i32, +} +/// SongRef is a reference to a song with metadata for matching. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SongRef { + /// ID is the internal Navidrome mediafile ID (if known). + #[serde(default, skip_serializing_if = "String::is_empty")] + pub id: String, + /// Name is the song name. + #[serde(default)] + pub name: String, + /// MBID is the MusicBrainz ID for the song. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub mbid: String, + /// ISRC is the International Standard Recording Code for the song. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub isrc: String, + /// Artist is the artist name. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub artist: String, + /// ArtistMBID is the MusicBrainz artist ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub artist_mbid: String, + /// Album is the album name. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub album: String, + /// AlbumMBID is the MusicBrainz release ID. + #[serde(default, skip_serializing_if = "String::is_empty")] + pub album_mbid: String, + /// Duration is the song duration in seconds. + #[serde(default, skip_serializing_if = "is_zero_f32")] + pub duration: f32, +} +/// SonicMatch represents the SonicMatch data structure. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SonicMatch { + #[serde(default)] + pub song: SongRef, + #[serde(default)] + pub similarity: f64, +} +/// SonicSimilarityResponse represents the SonicSimilarityResponse data structure. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct SonicSimilarityResponse { + #[serde(default)] + pub matches: Vec<SonicMatch>, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// SonicSimilarity requires all methods to be implemented. +/// SonicSimilarity provides audio-similarity based track discovery. +pub trait SonicSimilarity { + /// GetSonicSimilarTracks + fn get_sonic_similar_tracks(&self, req: GetSonicSimilarTracksRequest) -> Result<SonicSimilarityResponse, Error>; + /// FindSonicPath + fn find_sonic_path(&self, req: FindSonicPathRequest) -> Result<SonicSimilarityResponse, Error>; +} + +/// Register all exports for the SonicSimilarity capability. +/// This macro generates the WASM export functions for all trait methods. +#[macro_export] +macro_rules! register_sonicsimilarity { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_get_sonic_similar_tracks( + req: extism_pdk::Json<$crate::sonicsimilarity::GetSonicSimilarTracksRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::sonicsimilarity::SonicSimilarityResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::sonicsimilarity::SonicSimilarity::get_sonic_similar_tracks(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + #[extism_pdk::plugin_fn] + pub fn nd_find_sonic_path( + req: extism_pdk::Json<$crate::sonicsimilarity::FindSonicPathRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<$crate::sonicsimilarity::SonicSimilarityResponse>> { + let plugin = <$plugin_type>::default(); + let result = $crate::sonicsimilarity::SonicSimilarity::find_sonic_path(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/taskworker.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/taskworker.rs new file mode 100644 index 000000000..e8aa106a2 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/taskworker.rs @@ -0,0 +1,102 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the TaskWorker capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// TaskExecuteRequest is the request provided when a task is ready to execute. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskExecuteRequest { + /// QueueName is the name of the queue this task belongs to. + #[serde(default)] + pub queue_name: String, + /// TaskID is the unique identifier for this task. + #[serde(default)] + pub task_id: String, + /// Payload is the opaque data provided when the task was enqueued. + #[serde(default)] + #[serde(with = "base64_bytes")] + pub payload: Vec<u8>, + /// Attempt is the current attempt number (1-based: first attempt = 1). + #[serde(default)] + pub attempt: i32, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// TaskExecuteProvider provides the OnTaskExecute function. +pub trait TaskExecuteProvider { + fn on_task_execute(&self, req: TaskExecuteRequest) -> Result<String, Error>; +} + +/// Register the on_task_execute export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_taskworker_task_execute { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_task_execute( + req: extism_pdk::Json<$crate::taskworker::TaskExecuteRequest> + ) -> extism_pdk::FnResult<extism_pdk::Json<String>> { + let plugin = <$plugin_type>::default(); + let result = $crate::taskworker::TaskExecuteProvider::on_task_execute(&plugin, req.into_inner())?; + Ok(extism_pdk::Json(result)) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-capabilities/src/websocket.rs b/plugins/pdk/rust/nd-pdk-capabilities/src/websocket.rs new file mode 100644 index 000000000..672233e4b --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-capabilities/src/websocket.rs @@ -0,0 +1,196 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains export wrappers for the WebSocketCallback capability. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +// Helper functions for skip_serializing_if with numeric types +#[allow(dead_code)] +fn is_zero_i32(value: &i32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u32(value: &u32) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_i64(value: &i64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_u64(value: &u64) -> bool { *value == 0 } +#[allow(dead_code)] +fn is_zero_f32(value: &f32) -> bool { *value == 0.0 } +#[allow(dead_code)] +fn is_zero_f64(value: &f64) -> bool { *value == 0.0 } +/// OnBinaryMessageRequest is the request provided when a binary message is received. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnBinaryMessageRequest { + /// ConnectionID is the unique identifier for the WebSocket connection that received the message. + #[serde(default)] + pub connection_id: String, + /// Data is the binary data received from the WebSocket, encoded as base64. + #[serde(default)] + #[serde(with = "base64_bytes")] + pub data: Vec<u8>, +} +/// OnCloseRequest is the request provided when a WebSocket connection is closed. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnCloseRequest { + /// ConnectionID is the unique identifier for the WebSocket connection that was closed. + #[serde(default)] + pub connection_id: String, + /// Code is the WebSocket close status code (e.g., 1000 for normal closure, + /// 1001 for going away, 1006 for abnormal closure). + #[serde(default)] + pub code: i32, + /// Reason is the human-readable reason for the connection closure, if provided. + #[serde(default)] + pub reason: String, +} +/// OnErrorRequest is the request provided when an error occurs on a WebSocket connection. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnErrorRequest { + /// ConnectionID is the unique identifier for the WebSocket connection where the error occurred. + #[serde(default)] + pub connection_id: String, + /// Error is the error message describing what went wrong. + #[serde(default)] + pub error: String, +} +/// OnTextMessageRequest is the request provided when a text message is received. +#[derive(Debug, Clone, Default, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct OnTextMessageRequest { + /// ConnectionID is the unique identifier for the WebSocket connection that received the message. + #[serde(default)] + pub connection_id: String, + /// Message is the text message content received from the WebSocket. + #[serde(default)] + pub message: String, +} + +/// Error represents an error from a capability method. +#[derive(Debug)] +pub struct Error { + pub message: String, +} + +impl std::fmt::Display for Error { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + write!(f, "{}", self.message) + } +} + +impl std::error::Error for Error {} + +impl Error { + pub fn new(message: impl Into<String>) -> Self { + Self { message: message.into() } + } +} + +/// TextMessageProvider provides the OnTextMessage function. +pub trait TextMessageProvider { + fn on_text_message(&self, req: OnTextMessageRequest) -> Result<(), Error>; +} + +/// Register the on_text_message export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_text_message { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_text_message( + req: extism_pdk::Json<$crate::websocket::OnTextMessageRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::TextMessageProvider::on_text_message(&plugin, req.into_inner())?; + Ok(()) + } + }; +} + +/// BinaryMessageProvider provides the OnBinaryMessage function. +pub trait BinaryMessageProvider { + fn on_binary_message(&self, req: OnBinaryMessageRequest) -> Result<(), Error>; +} + +/// Register the on_binary_message export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_binary_message { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_binary_message( + req: extism_pdk::Json<$crate::websocket::OnBinaryMessageRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::BinaryMessageProvider::on_binary_message(&plugin, req.into_inner())?; + Ok(()) + } + }; +} + +/// ErrorProvider provides the OnError function. +pub trait ErrorProvider { + fn on_error(&self, req: OnErrorRequest) -> Result<(), Error>; +} + +/// Register the on_error export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_error { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_error( + req: extism_pdk::Json<$crate::websocket::OnErrorRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::ErrorProvider::on_error(&plugin, req.into_inner())?; + Ok(()) + } + }; +} + +/// CloseProvider provides the OnClose function. +pub trait CloseProvider { + fn on_close(&self, req: OnCloseRequest) -> Result<(), Error>; +} + +/// Register the on_close export. +/// This macro generates the WASM export function for this method. +#[macro_export] +macro_rules! register_websocket_close { + ($plugin_type:ty) => { + #[extism_pdk::plugin_fn] + pub fn nd_websocket_on_close( + req: extism_pdk::Json<$crate::websocket::OnCloseRequest> + ) -> extism_pdk::FnResult<()> { + let plugin = <$plugin_type>::default(); + $crate::websocket::CloseProvider::on_close(&plugin, req.into_inner())?; + Ok(()) + } + }; +} diff --git a/plugins/pdk/rust/nd-pdk-host/.gitignore b/plugins/pdk/rust/nd-pdk-host/.gitignore new file mode 100644 index 000000000..9da4a887b --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/.gitignore @@ -0,0 +1 @@ +!Cargo.lock diff --git a/plugins/pdk/rust/nd-pdk-host/Cargo.lock b/plugins/pdk/rust/nd-pdk-host/Cargo.lock new file mode 100644 index 000000000..b4d9042d0 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/Cargo.lock @@ -0,0 +1,380 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "anyhow" +version = "1.0.100" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a23eb6b1614318a8071c9b2521f36b424b2c83db5eb3a0fead4a6c0809af6e61" + +[[package]] +name = "autocfg" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8" + +[[package]] +name = "base64" +version = "0.22.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" + +[[package]] +name = "bytemuck" +version = "1.24.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbdf580320f38b612e485521afda1ee26d10cc9884efaaa750d383e13e3c5f4" + +[[package]] +name = "bytes" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33" + +[[package]] +name = "either" +version = "1.15.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719" + +[[package]] +name = "equivalent" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" + +[[package]] +name = "extism-convert" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4f6612b4e92559eeb4c2dac88a53ee8b4729bea64025befcdeb2b3677e62fc1d" +dependencies = [ + "anyhow", + "base64", + "bytemuck", + "extism-convert-macros", + "prost", + "rmp-serde", + "serde", + "serde_json", +] + +[[package]] +name = "extism-convert-macros" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "525831f1f15079a7c43514905579aac10f90fee46bc6353b683ed632029dd945" +dependencies = [ + "manyhow", + "proc-macro-crate", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "extism-manifest" +version = "1.13.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e60e36345a96ad0d74adfca64dc22d93eb4979ab15a6c130cded5e0585f31b10" +dependencies = [ + "base64", + "serde", + "serde_json", +] + +[[package]] +name = "extism-pdk" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "352fcb5a66eb74145a1c4a01f2bd15d59c62c85be73aac8471880c65b26b798f" +dependencies = [ + "anyhow", + "base64", + "extism-convert", + "extism-manifest", + "extism-pdk-derive", + "serde", + "serde_json", +] + +[[package]] +name = "extism-pdk-derive" +version = "1.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d086daea5fd844e3c5ac69ddfe36df4a9a43e7218cf7d1f888182b089b09806c" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "hashbrown" +version = "0.16.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "841d1cc9bed7f9236f321df977030373f4a4163ae1a7dbfe1a51a2c1a51d9100" + +[[package]] +name = "indexmap" +version = "2.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ad4bb2b565bca0645f4d68c5c9af97fba094e9791da685bf83cb5f3ce74acf2" +dependencies = [ + "equivalent", + "hashbrown", +] + +[[package]] +name = "itertools" +version = "0.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b192c782037fadd9cfa75548310488aabdbf3d2da73885b31bd0abd03351285" +dependencies = [ + "either", +] + +[[package]] +name = "itoa" +version = "1.0.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92ecc6618181def0457392ccd0ee51198e065e016d1d527a7ac1b6dc7c1f09d2" + +[[package]] +name = "manyhow" +version = "0.11.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b33efb3ca6d3b07393750d4030418d594ab1139cee518f0dc88db70fec873587" +dependencies = [ + "manyhow-macros", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "manyhow-macros" +version = "0.11.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "46fce34d199b78b6e6073abf984c9cf5fd3e9330145a93ee0738a7443e371495" +dependencies = [ + "proc-macro-utils", + "proc-macro2", + "quote", +] + +[[package]] +name = "memchr" +version = "2.7.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f52b00d39961fc5b2736ea853c9cc86238e165017a493d1d5c8eac6bdc4cc273" + +[[package]] +name = "nd-pdk-host" +version = "0.1.0" +dependencies = [ + "extism-pdk", + "serde", + "serde_json", +] + +[[package]] +name = "num-traits" +version = "0.2.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" +dependencies = [ + "autocfg", +] + +[[package]] +name = "proc-macro-crate" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "219cb19e96be00ab2e37d6e299658a0cfa83e52429179969b0f0121b4ac46983" +dependencies = [ + "toml_edit", +] + +[[package]] +name = "proc-macro-utils" +version = "0.10.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "eeaf08a13de400bc215877b5bdc088f241b12eb42f0a548d3390dc1c56bb7071" +dependencies = [ + "proc-macro2", + "quote", + "smallvec", +] + +[[package]] +name = "proc-macro2" +version = "1.0.104" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9695f8df41bb4f3d222c95a67532365f569318332d03d5f3f67f37b20e6ebdf0" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "prost" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7231bd9b3d3d33c86b58adbac74b5ec0ad9f496b19d22801d773636feaa95f3d" +dependencies = [ + "bytes", + "prost-derive", +] + +[[package]] +name = "prost-derive" +version = "0.14.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9120690fafc389a67ba3803df527d0ec9cbbc9cc45e4cc20b332996dfb672425" +dependencies = [ + "anyhow", + "itertools", + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "quote" +version = "1.0.42" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a338cc41d27e6cc6dce6cefc13a0729dfbb81c262b1f519331575dd80ef3067f" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "rmp" +version = "0.8.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ba8be72d372b2c9b35542551678538b562e7cf86c3315773cae48dfbfe7790c" +dependencies = [ + "num-traits", +] + +[[package]] +name = "rmp-serde" +version = "1.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "72f81bee8c8ef9b577d1681a70ebbc962c232461e397b22c208c43c04b67a155" +dependencies = [ + "rmp", + "serde", +] + +[[package]] +name = "serde" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde_core" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "serde_json" +version = "1.0.148" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3084b546a1dd6289475996f182a22aba973866ea8e8b02c51d9f46b1336a22da" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "smallvec" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" + +[[package]] +name = "syn" +version = "2.0.111" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "390cc9a294ab71bdb1aa2e99d13be9c753cd2d7bd6560c77118597410c4d2e87" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "toml_datetime" +version = "0.7.5+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92e1cfed4a3038bc5a127e35a2d360f145e1f4b971b551a2ba5fd7aedf7e1347" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_edit" +version = "0.23.10+spec-1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "84c8b9f757e028cee9fa244aea147aab2a9ec09d5325a9b01e0a49730c2b5269" +dependencies = [ + "indexmap", + "toml_datetime", + "toml_parser", + "winnow", +] + +[[package]] +name = "toml_parser" +version = "1.0.6+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a3198b4b0a8e11f09dd03e133c0280504d0801269e9afa46362ffde1cbeebf44" +dependencies = [ + "winnow", +] + +[[package]] +name = "unicode-ident" +version = "1.0.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9312f7c4f6ff9069b165498234ce8be658059c6728633667c526e27dc2cf1df5" + +[[package]] +name = "winnow" +version = "0.7.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5a5364e9d77fcdeeaa6062ced926ee3381faa2ee02d3eb83a5c27a8825540829" +dependencies = [ + "memchr", +] + +[[package]] +name = "zmij" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f4a4e8e9dc5c62d159f04fcdbe07f4c3fb710415aab4754bf11505501e3251d" diff --git a/plugins/pdk/rust/nd-pdk-host/Cargo.toml b/plugins/pdk/rust/nd-pdk-host/Cargo.toml new file mode 100644 index 000000000..519096110 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "nd-pdk-host" +version = "0.1.0" +edition = "2021" +description = "Navidrome host function wrappers for Rust plugins" +authors = ["Navidrome Team"] +license = "GPL-3.0" +readme = "README.md" + +[lib] +crate-type = ["rlib"] + +[dependencies] +base64 = "0.22" +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/pdk/rust/nd-pdk-host/README.md b/plugins/pdk/rust/nd-pdk-host/README.md new file mode 100644 index 000000000..f722b2e5a --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/README.md @@ -0,0 +1,87 @@ +# Navidrome Host Function Wrappers for Rust + +This directory contains auto-generated Rust wrappers for Navidrome's host services. +These wrappers provide idiomatic Rust APIs for interacting with Navidrome from WASM plugins. + +## ⚠️ Auto-Generated Code + +**Do not edit these files manually.** They are generated by the `ndpgen` tool. + +To regenerate: + +```bash +make gen +``` + +## Usage + +Add this crate as a dependency in your plugin's `Cargo.toml`: + +```toml +[dependencies] +nd-host = { path = "../../pdk/rust/host" } +``` + +Then import the services you need: + +```rust +use nd_host::{cache, scheduler, library}; +use nd_host::library::Library; // Import the typed struct + +#[plugin_fn] +pub fn my_callback(input: String) -> FnResult<String> { + // Use the cache service + cache::set("my_key", b"my_value", 3600)?; + + // Schedule a recurring task + scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; + + // Access library data with typed structs + let libraries: Vec<Library> = library::get_all_libraries()?; + for lib in &libraries { + info!("Library: {} with {} songs", lib.name, lib.total_songs); + } + + Ok("done".to_string()) +} +``` + +## Typed Structs + +Services that work with domain objects provide typed Rust structs instead of +`serde_json::Value`. This enables compile-time type checking and IDE +autocompletion. + +For example, the `library` module provides a `Library` struct: + +```rust +use nd_host::library::Library; + +let libs: Vec<Library> = library::get_all_libraries()?; +println!("First library: {} ({} songs)", libs[0].name, libs[0].total_songs); +``` + +All structs derive `Debug`, `Clone`, `Serialize`, and `Deserialize` for +convenient use with logging and serialization. + +## Available Services + +| Module | Description | +|---------------|----------------------------------------------------| +| `artwork` | Access album and artist artwork | +| `cache` | Temporary key-value storage with TTL | +| `kvstore` | Persistent key-value storage | +| `library` | Access the music library (albums, artists, tracks) | +| `scheduler` | Schedule one-time and recurring tasks | +| `subsonicapi` | Make Subsonic API calls | +| `websocket` | Send real-time messages to clients | + +## Building Plugins + +Rust plugins must be compiled to WebAssembly: + +```bash +cargo build --target wasm32-wasip1 --release +``` + +See the [webhook-rs](../../examples/webhook-rs/) example for a complete plugin implementation. diff --git a/plugins/pdk/rust/nd-pdk-host/src/lib.rs b/plugins/pdk/rust/nd-pdk-host/src/lib.rs new file mode 100644 index 000000000..3a31bc489 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/lib.rs @@ -0,0 +1,125 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +//! Navidrome Host Function Wrappers for Rust Plugins +//! +//! This crate provides idiomatic Rust wrappers for all Navidrome host services. +//! It is auto-generated by the ndpgen tool and should not be edited manually. +//! +//! # Usage +//! +//! Add this crate as a dependency in your plugin's Cargo.toml: +//! +//! ```toml +//! [dependencies] +//! nd-host = { path = "../../host/rust" } +//! ``` +//! +//! Then import the services you need: +//! +//! ```ignore +//! use nd_host::{cache, scheduler}; +//! +//! fn my_plugin_function() -> Result<(), extism_pdk::Error> { +//! // Use the cache service +//! cache::set_string("my_key", "my_value", 3600)?; +//! +//! // Schedule a recurring task +//! scheduler::schedule_recurring("@every 5m", "payload", "task_id")?; +//! +//! Ok(()) +//! } +//! ``` +//! +//! # Available Services +//! +//! - [`artwork`] - provides artwork public URL generation capabilities for plugins. +//! - [`cache`] - provides in-memory TTL-based caching capabilities for plugins. +//! - [`config`] - provides access to plugin configuration values. +//! - [`http`] - provides outbound HTTP request capabilities for plugins. +//! - [`kvstore`] - provides persistent key-value storage for plugins. +//! - [`library`] - provides access to music library metadata for plugins. +//! - [`scheduler`] - provides task scheduling capabilities for plugins. +//! - [`subsonicapi`] - provides access to Navidrome's Subsonic API from plugins. +//! - [`task`] - provides persistent task queues for plugins. +//! - [`users`] - provides access to user information for plugins. +//! - [`websocket`] - provides WebSocket communication capabilities for plugins. + +#[doc(hidden)] +mod nd_host_artwork; +/// provides artwork public URL generation capabilities for plugins. +pub mod artwork { + pub use super::nd_host_artwork::*; +} + +#[doc(hidden)] +mod nd_host_cache; +/// provides in-memory TTL-based caching capabilities for plugins. +pub mod cache { + pub use super::nd_host_cache::*; +} + +#[doc(hidden)] +mod nd_host_config; +/// provides access to plugin configuration values. +pub mod config { + pub use super::nd_host_config::*; +} + +#[doc(hidden)] +mod nd_host_http; +/// provides outbound HTTP request capabilities for plugins. +pub mod http { + pub use super::nd_host_http::*; +} + +#[doc(hidden)] +mod nd_host_kvstore; +/// provides persistent key-value storage for plugins. +pub mod kvstore { + pub use super::nd_host_kvstore::*; +} + +#[doc(hidden)] +mod nd_host_library; +/// provides access to music library metadata for plugins. +pub mod library { + pub use super::nd_host_library::*; +} + +#[doc(hidden)] +mod nd_host_scheduler; +/// provides task scheduling capabilities for plugins. +pub mod scheduler { + pub use super::nd_host_scheduler::*; +} + +#[doc(hidden)] +mod nd_host_subsonicapi; +/// provides access to Navidrome's Subsonic API from plugins. +pub mod subsonicapi { + pub use super::nd_host_subsonicapi::*; +} + +#[doc(hidden)] +mod nd_host_task; +/// provides persistent task queues for plugins. +pub mod task { + pub use super::nd_host_task::*; +} + +#[doc(hidden)] +mod nd_host_users; +/// provides access to user information for plugins. +pub mod users { + pub use super::nd_host_users::*; +} + +#[doc(hidden)] +mod nd_host_websocket; +/// provides WebSocket communication capabilities for plugins. +pub mod websocket { + pub use super::nd_host_websocket::*; +} + +// Re-export commonly used types from extism-pdk for convenience +pub use extism_pdk::Error; diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_artwork.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_artwork.rs new file mode 100644 index 000000000..e565e0956 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_artwork.rs @@ -0,0 +1,207 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Artwork host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetArtistUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetArtistUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetAlbumUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetAlbumUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetTrackUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetTrackUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetPlaylistUrlRequest { + id: String, + size: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ArtworkGetPlaylistUrlResponse { + #[serde(default)] + url: String, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn artwork_getartisturl(input: Json<ArtworkGetArtistUrlRequest>) -> Json<ArtworkGetArtistUrlResponse>; + fn artwork_getalbumurl(input: Json<ArtworkGetAlbumUrlRequest>) -> Json<ArtworkGetAlbumUrlResponse>; + fn artwork_gettrackurl(input: Json<ArtworkGetTrackUrlRequest>) -> Json<ArtworkGetTrackUrlResponse>; + fn artwork_getplaylisturl(input: Json<ArtworkGetPlaylistUrlRequest>) -> Json<ArtworkGetPlaylistUrlResponse>; +} + +/// GetArtistUrl generates a public URL for an artist's artwork. +/// +/// Parameters: +/// - id: The artist's unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_artist_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_getartisturl(Json(ArtworkGetArtistUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} + +/// GetAlbumUrl generates a public URL for an album's artwork. +/// +/// Parameters: +/// - id: The album's unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_album_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_getalbumurl(Json(ArtworkGetAlbumUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} + +/// GetTrackUrl generates a public URL for a track's artwork. +/// +/// Parameters: +/// - id: The track's (media file) unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_track_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_gettrackurl(Json(ArtworkGetTrackUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} + +/// GetPlaylistUrl generates a public URL for a playlist's artwork. +/// +/// Parameters: +/// - id: The playlist's unique identifier +/// - size: Desired image size in pixels (0 for original size) +/// +/// Returns the public URL for the artwork, or an error if generation fails. +/// +/// # Arguments +/// * `id` - String parameter. +/// * `size` - i32 parameter. +/// +/// # Returns +/// The url value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_playlist_url(id: &str, size: i32) -> Result<String, Error> { + let response = unsafe { + artwork_getplaylisturl(Json(ArtworkGetPlaylistUrlRequest { + id: id.to_owned(), + size: size, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.url) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_cache.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_cache.rs new file mode 100644 index 000000000..267654136 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_cache.rs @@ -0,0 +1,521 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Cache host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetStringRequest { + key: String, + value: String, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetStringResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetStringRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetStringResponse { + #[serde(default)] + value: String, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetIntRequest { + key: String, + value: i64, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetIntResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetIntRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetIntResponse { + #[serde(default)] + value: i64, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetFloatRequest { + key: String, + value: f64, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetFloatResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetFloatRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetFloatResponse { + #[serde(default)] + value: f64, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetBytesRequest { + key: String, + #[serde(with = "base64_bytes")] + value: Vec<u8>, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheSetBytesResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetBytesRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheGetBytesResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + value: Vec<u8>, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheHasRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheHasResponse { + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct CacheRemoveRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct CacheRemoveResponse { + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn cache_setstring(input: Json<CacheSetStringRequest>) -> Json<CacheSetStringResponse>; + fn cache_getstring(input: Json<CacheGetStringRequest>) -> Json<CacheGetStringResponse>; + fn cache_setint(input: Json<CacheSetIntRequest>) -> Json<CacheSetIntResponse>; + fn cache_getint(input: Json<CacheGetIntRequest>) -> Json<CacheGetIntResponse>; + fn cache_setfloat(input: Json<CacheSetFloatRequest>) -> Json<CacheSetFloatResponse>; + fn cache_getfloat(input: Json<CacheGetFloatRequest>) -> Json<CacheGetFloatResponse>; + fn cache_setbytes(input: Json<CacheSetBytesRequest>) -> Json<CacheSetBytesResponse>; + fn cache_getbytes(input: Json<CacheGetBytesRequest>) -> Json<CacheGetBytesResponse>; + fn cache_has(input: Json<CacheHasRequest>) -> Json<CacheHasResponse>; + fn cache_remove(input: Json<CacheRemoveRequest>) -> Json<CacheRemoveResponse>; +} + +/// SetString stores a string value in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The string value to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - String parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_string(key: &str, value: &str, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setstring(Json(CacheSetStringRequest { + key: key.to_owned(), + value: value.to_owned(), + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetString retrieves a string value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not a string, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_string(key: &str) -> Result<Option<String>, Error> { + let response = unsafe { + cache_getstring(Json(CacheGetStringRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// SetInt stores an integer value in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The integer value to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - i64 parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_int(key: &str, value: i64, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setint(Json(CacheSetIntRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetInt retrieves an integer value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not an integer, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_int(key: &str) -> Result<Option<i64>, Error> { + let response = unsafe { + cache_getint(Json(CacheGetIntRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// SetFloat stores a float value in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The float value to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - f64 parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_float(key: &str, value: f64, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setfloat(Json(CacheSetFloatRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetFloat retrieves a float value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not a float, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_float(key: &str) -> Result<Option<f64>, Error> { + let response = unsafe { + cache_getfloat(Json(CacheGetFloatRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// SetBytes stores a byte slice in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// - value: The byte slice to store +/// - ttlSeconds: Time-to-live in seconds (0 uses default of 24 hours) +/// +/// Returns an error if the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - Vec<u8> parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_bytes(key: &str, value: Vec<u8>, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + cache_setbytes(Json(CacheSetBytesRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// GetBytes retrieves a byte slice from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns the value and whether the key exists. If the key doesn't exist +/// or the stored value is not a byte slice, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_bytes(key: &str) -> Result<Option<Vec<u8>>, Error> { + let response = unsafe { + cache_getbytes(Json(CacheGetBytesRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// Has checks if a key exists in the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns true if the key exists and has not expired. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The exists value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn has(key: &str) -> Result<bool, Error> { + let response = unsafe { + cache_has(Json(CacheHasRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.exists) +} + +/// Remove deletes a value from the cache. +/// +/// Parameters: +/// - key: The cache key (will be namespaced with plugin ID) +/// +/// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn remove(key: &str) -> Result<(), Error> { + let response = unsafe { + cache_remove(Json(CacheRemoveRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_config.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_config.rs new file mode 100644 index 000000000..effd5923e --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_config.rs @@ -0,0 +1,141 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Config host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetResponse { + #[serde(default)] + value: String, + #[serde(default)] + exists: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetIntRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigGetIntResponse { + #[serde(default)] + value: i64, + #[serde(default)] + exists: bool, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct ConfigKeysRequest { + prefix: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct ConfigKeysResponse { + #[serde(default)] + keys: Vec<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn config_get(input: Json<ConfigGetRequest>) -> Json<ConfigGetResponse>; + fn config_getint(input: Json<ConfigGetIntRequest>) -> Json<ConfigGetIntResponse>; + fn config_keys(input: Json<ConfigKeysRequest>) -> Json<ConfigKeysResponse>; +} + +/// Get retrieves a configuration value as a string. +/// +/// Parameters: +/// - key: The configuration key +/// +/// Returns the value and whether the key exists. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result<Option<String>, Error> { + let response = unsafe { + config_get(Json(ConfigGetRequest { + key: key.to_owned(), + }))? + }; + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// GetInt retrieves a configuration value as an integer. +/// +/// Parameters: +/// - key: The configuration key +/// +/// Returns the value and whether the key exists. If the key exists but the +/// value cannot be parsed as an integer, exists will be false. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_int(key: &str) -> Result<Option<i64>, Error> { + let response = unsafe { + config_getint(Json(ConfigGetIntRequest { + key: key.to_owned(), + }))? + }; + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// Keys returns configuration keys matching the given prefix. +/// +/// Parameters: +/// - prefix: Key prefix to filter by. If empty, returns all keys. +/// +/// Returns a sorted slice of matching configuration keys. +/// +/// # Arguments +/// * `prefix` - String parameter. +/// +/// # Returns +/// The keys value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn keys(prefix: &str) -> Result<Vec<String>, Error> { + let response = unsafe { + config_keys(Json(ConfigKeysRequest { + prefix: prefix.to_owned(), + }))? + }; + + Ok(response.0.keys) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_http.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_http.rs new file mode 100644 index 000000000..1c44cd2f3 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_http.rs @@ -0,0 +1,110 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the HTTP host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +/// HTTPRequest represents an outbound HTTP request from a plugin. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct HTTPRequest { + pub method: String, + pub url: String, + #[serde(default)] + pub headers: std::collections::HashMap<String, String>, + #[serde(default)] + pub no_follow_redirects: bool, + #[serde(default)] + #[serde(with = "base64_bytes")] + pub body: Vec<u8>, + #[serde(default)] + pub timeout_ms: i32, +} + +/// HTTPResponse represents the response from an outbound HTTP request. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct HTTPResponse { + pub status_code: i32, + #[serde(default)] + pub headers: std::collections::HashMap<String, String>, + #[serde(default)] + #[serde(with = "base64_bytes")] + pub body: Vec<u8>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct HTTPSendRequest { + request: HTTPRequest, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct HTTPSendResponse { + #[serde(default)] + result: Option<HTTPResponse>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn http_send(input: Json<HTTPSendRequest>) -> Json<HTTPSendResponse>; +} + +/// Send executes an HTTP request and returns the response. +/// +/// Parameters: +/// - request: The HTTP request to execute, including method, URL, headers, body, and timeout +/// +/// Returns the HTTP response with status code, headers, and body. +/// Network errors, timeouts, and permission failures are returned as Go errors. +/// Successful HTTP calls (including 4xx/5xx status codes) return a non-nil response with nil error. +/// +/// # Arguments +/// * `request` - HTTPRequest parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn send(request: HTTPRequest) -> Result<Option<HTTPResponse>, Error> { + let response = unsafe { + http_send(Json(HTTPSendRequest { + request: request, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_kvstore.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_kvstore.rs new file mode 100644 index 000000000..a85e72895 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_kvstore.rs @@ -0,0 +1,433 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the KVStore host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetRequest { + key: String, + #[serde(with = "base64_bytes")] + value: Vec<u8>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetWithTTLRequest { + key: String, + #[serde(with = "base64_bytes")] + value: Vec<u8>, + ttl_seconds: i64, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreSetWithTTLResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetResponse { + #[serde(default)] + #[serde(with = "base64_bytes")] + value: Vec<u8>, + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetManyRequest { + keys: Vec<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetManyResponse { + #[serde(default)] + values: std::collections::HashMap<String, Vec<u8>>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreHasRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreHasResponse { + #[serde(default)] + exists: bool, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreListRequest { + prefix: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreListResponse { + #[serde(default)] + keys: Vec<String>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteRequest { + key: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteByPrefixRequest { + prefix: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreDeleteByPrefixResponse { + #[serde(default)] + deleted_count: i64, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct KVStoreGetStorageUsedResponse { + #[serde(default)] + bytes: i64, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn kvstore_set(input: Json<KVStoreSetRequest>) -> Json<KVStoreSetResponse>; + fn kvstore_setwithttl(input: Json<KVStoreSetWithTTLRequest>) -> Json<KVStoreSetWithTTLResponse>; + fn kvstore_get(input: Json<KVStoreGetRequest>) -> Json<KVStoreGetResponse>; + fn kvstore_getmany(input: Json<KVStoreGetManyRequest>) -> Json<KVStoreGetManyResponse>; + fn kvstore_has(input: Json<KVStoreHasRequest>) -> Json<KVStoreHasResponse>; + fn kvstore_list(input: Json<KVStoreListRequest>) -> Json<KVStoreListResponse>; + fn kvstore_delete(input: Json<KVStoreDeleteRequest>) -> Json<KVStoreDeleteResponse>; + fn kvstore_deletebyprefix(input: Json<KVStoreDeleteByPrefixRequest>) -> Json<KVStoreDeleteByPrefixResponse>; + fn kvstore_getstorageused(input: Json<serde_json::Value>) -> Json<KVStoreGetStorageUsedResponse>; +} + +/// Set stores a byte value with the given key. +/// +/// Parameters: +/// - key: The storage key (max 256 bytes, UTF-8) +/// - value: The byte slice to store +/// +/// Returns an error if the storage limit would be exceeded or the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - Vec<u8> parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set(key: &str, value: Vec<u8>) -> Result<(), Error> { + let response = unsafe { + kvstore_set(Json(KVStoreSetRequest { + key: key.to_owned(), + value: value, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// SetWithTTL stores a byte value with the given key and a time-to-live. +/// +/// After ttlSeconds, the key is treated as non-existent and will be +/// cleaned up lazily. ttlSeconds must be greater than 0. +/// +/// Parameters: +/// - key: The storage key (max 256 bytes, UTF-8) +/// - value: The byte slice to store +/// - ttlSeconds: Time-to-live in seconds (must be > 0) +/// +/// Returns an error if the storage limit would be exceeded or the operation fails. +/// +/// # Arguments +/// * `key` - String parameter. +/// * `value` - Vec<u8> parameter. +/// * `ttl_seconds` - i64 parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn set_with_ttl(key: &str, value: Vec<u8>, ttl_seconds: i64) -> Result<(), Error> { + let response = unsafe { + kvstore_setwithttl(Json(KVStoreSetWithTTLRequest { + key: key.to_owned(), + value: value, + ttl_seconds: ttl_seconds, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Get retrieves a byte value from storage. +/// +/// Parameters: +/// - key: The storage key +/// +/// Returns the value and whether the key exists. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// `Some(value)` if found, `None` otherwise. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(key: &str) -> Result<Option<Vec<u8>>, Error> { + let response = unsafe { + kvstore_get(Json(KVStoreGetRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + if response.0.exists { + Ok(Some(response.0.value)) + } else { + Ok(None) + } +} + +/// GetMany retrieves multiple values in a single call. +/// +/// Parameters: +/// - keys: The storage keys to retrieve +/// +/// Returns a map of key to value for keys that exist and have not expired. +/// Missing or expired keys are omitted from the result. +/// +/// # Arguments +/// * `keys` - Vec<String> parameter. +/// +/// # Returns +/// The values value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_many(keys: Vec<String>) -> Result<std::collections::HashMap<String, Vec<u8>>, Error> { + let response = unsafe { + kvstore_getmany(Json(KVStoreGetManyRequest { + keys: keys, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.values) +} + +/// Has checks if a key exists in storage. +/// +/// Parameters: +/// - key: The storage key +/// +/// Returns true if the key exists. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Returns +/// The exists value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn has(key: &str) -> Result<bool, Error> { + let response = unsafe { + kvstore_has(Json(KVStoreHasRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.exists) +} + +/// List returns all keys matching the given prefix. +/// +/// Parameters: +/// - prefix: Key prefix to filter by (empty string returns all keys) +/// +/// Returns a slice of matching keys. +/// +/// # Arguments +/// * `prefix` - String parameter. +/// +/// # Returns +/// The keys value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn list(prefix: &str) -> Result<Vec<String>, Error> { + let response = unsafe { + kvstore_list(Json(KVStoreListRequest { + prefix: prefix.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.keys) +} + +/// Delete removes a value from storage. +/// +/// Parameters: +/// - key: The storage key +/// +/// Returns an error if the operation fails. Does not return an error if the key doesn't exist. +/// +/// # Arguments +/// * `key` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn delete(key: &str) -> Result<(), Error> { + let response = unsafe { + kvstore_delete(Json(KVStoreDeleteRequest { + key: key.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// DeleteByPrefix removes all keys matching the given prefix. +/// +/// Parameters: +/// - prefix: Key prefix to match (must not be empty) +/// +/// Returns the number of keys deleted. Includes expired keys. +/// +/// # Arguments +/// * `prefix` - String parameter. +/// +/// # Returns +/// The deleted_count value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn delete_by_prefix(prefix: &str) -> Result<i64, Error> { + let response = unsafe { + kvstore_deletebyprefix(Json(KVStoreDeleteByPrefixRequest { + prefix: prefix.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.deleted_count) +} + +/// GetStorageUsed returns the total storage used by this plugin in bytes. +/// +/// # Returns +/// The bytes value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_storage_used() -> Result<i64, Error> { + let response = unsafe { + kvstore_getstorageused(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.bytes) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_library.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_library.rs new file mode 100644 index 000000000..b4b9b3fb0 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_library.rs @@ -0,0 +1,105 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Library host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +/// Library represents a music library with metadata. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Library { + pub id: i32, + pub name: String, + #[serde(default)] + pub path: String, + #[serde(default)] + pub mount_point: String, + pub last_scan_at: i64, + pub total_songs: i32, + pub total_albums: i32, + pub total_artists: i32, + pub total_size: i64, + pub total_duration: f64, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct LibraryGetLibraryRequest { + id: i32, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct LibraryGetLibraryResponse { + #[serde(default)] + result: Option<Library>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct LibraryGetAllLibrariesResponse { + #[serde(default)] + result: Vec<Library>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn library_getlibrary(input: Json<LibraryGetLibraryRequest>) -> Json<LibraryGetLibraryResponse>; + fn library_getalllibraries(input: Json<serde_json::Value>) -> Json<LibraryGetAllLibrariesResponse>; +} + +/// GetLibrary retrieves metadata for a specific library by ID. +/// +/// Parameters: +/// - id: The library's unique identifier +/// +/// Returns the library metadata, or an error if the library is not found. +/// +/// # Arguments +/// * `id` - i32 parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_library(id: i32) -> Result<Option<Library>, Error> { + let response = unsafe { + library_getlibrary(Json(LibraryGetLibraryRequest { + id: id, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// GetAllLibraries retrieves metadata for all configured libraries. +/// +/// Returns a slice of all libraries with their metadata. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_all_libraries() -> Result<Vec<Library>, Error> { + let response = unsafe { + library_getalllibraries(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_scheduler.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_scheduler.rs new file mode 100644 index 000000000..042f97410 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_scheduler.rs @@ -0,0 +1,159 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Scheduler host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleOneTimeRequest { + delay_seconds: i32, + payload: String, + schedule_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleOneTimeResponse { + #[serde(default)] + new_schedule_id: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleRecurringRequest { + cron_expression: String, + payload: String, + schedule_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerScheduleRecurringResponse { + #[serde(default)] + new_schedule_id: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerCancelScheduleRequest { + schedule_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SchedulerCancelScheduleResponse { + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn scheduler_scheduleonetime(input: Json<SchedulerScheduleOneTimeRequest>) -> Json<SchedulerScheduleOneTimeResponse>; + fn scheduler_schedulerecurring(input: Json<SchedulerScheduleRecurringRequest>) -> Json<SchedulerScheduleRecurringResponse>; + fn scheduler_cancelschedule(input: Json<SchedulerCancelScheduleRequest>) -> Json<SchedulerCancelScheduleResponse>; +} + +/// ScheduleOneTime schedules a one-time event to be triggered after the specified delay. +/// Plugins that use this function must also implement the SchedulerCallback capability +/// +/// Parameters: +/// - delaySeconds: Number of seconds to wait before triggering the event +/// - payload: Data to be passed to the scheduled event handler +/// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +/// +/// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +/// +/// # Arguments +/// * `delay_seconds` - i32 parameter. +/// * `payload` - String parameter. +/// * `schedule_id` - String parameter. +/// +/// # Returns +/// The new_schedule_id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn schedule_one_time(delay_seconds: i32, payload: &str, schedule_id: &str) -> Result<String, Error> { + let response = unsafe { + scheduler_scheduleonetime(Json(SchedulerScheduleOneTimeRequest { + delay_seconds: delay_seconds, + payload: payload.to_owned(), + schedule_id: schedule_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.new_schedule_id) +} + +/// ScheduleRecurring schedules a recurring event using a cron expression. +/// Plugins that use this function must also implement the SchedulerCallback capability +/// +/// Parameters: +/// - cronExpression: Standard cron format expression (e.g., "0 0 * * *" for daily at midnight) +/// - payload: Data to be passed to each scheduled event handler invocation +/// - scheduleID: Optional unique identifier for the scheduled job. If empty, one will be generated +/// +/// Returns the schedule ID that can be used to cancel the job, or an error if scheduling fails. +/// +/// # Arguments +/// * `cron_expression` - String parameter. +/// * `payload` - String parameter. +/// * `schedule_id` - String parameter. +/// +/// # Returns +/// The new_schedule_id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn schedule_recurring(cron_expression: &str, payload: &str, schedule_id: &str) -> Result<String, Error> { + let response = unsafe { + scheduler_schedulerecurring(Json(SchedulerScheduleRecurringRequest { + cron_expression: cron_expression.to_owned(), + payload: payload.to_owned(), + schedule_id: schedule_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.new_schedule_id) +} + +/// CancelSchedule cancels a scheduled job identified by its schedule ID. +/// +/// This works for both one-time and recurring schedules. Once cancelled, the job will not trigger +/// any future events. +/// +/// Returns an error if the schedule ID is not found or if cancellation fails. +/// +/// # Arguments +/// * `schedule_id` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn cancel_schedule(schedule_id: &str) -> Result<(), Error> { + let response = unsafe { + scheduler_cancelschedule(Json(SchedulerCancelScheduleRequest { + schedule_id: schedule_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_subsonicapi.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_subsonicapi.rs new file mode 100644 index 000000000..56ba1066e --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_subsonicapi.rs @@ -0,0 +1,122 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the SubsonicAPI host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallRequest { + uri: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallResponse { + #[serde(default)] + response_json: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallRawRequest { + uri: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct SubsonicAPICallRawResponse { + #[serde(default)] + content_type: String, + #[serde(default)] + #[serde(with = "base64_bytes")] + data: Vec<u8>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn subsonicapi_call(input: Json<SubsonicAPICallRequest>) -> Json<SubsonicAPICallResponse>; + fn subsonicapi_callraw(input: Json<SubsonicAPICallRawRequest>) -> Json<SubsonicAPICallRawResponse>; +} + +/// Call executes a Subsonic API request and returns the JSON response. +/// +/// The uri parameter should be the Subsonic API path without the server prefix, +/// e.g., "getAlbumList2?type=random&size=10". The response is returned as raw JSON. +/// +/// # Arguments +/// * `uri` - String parameter. +/// +/// # Returns +/// The response_json value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn call(uri: &str) -> Result<String, Error> { + let response = unsafe { + subsonicapi_call(Json(SubsonicAPICallRequest { + uri: uri.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.response_json) +} + +/// CallRaw executes a Subsonic API request and returns the raw binary response. +/// Designed for binary endpoints like getCoverArt and stream that return +/// non-JSON data. The data is base64-encoded over JSON on the wire. +/// +/// # Arguments +/// * `uri` - String parameter. +/// +/// # Returns +/// A tuple of (content_type, data). +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn call_raw(uri: &str) -> Result<(String, Vec<u8>), Error> { + let response = unsafe { + subsonicapi_callraw(Json(SubsonicAPICallRawRequest { + uri: uri.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok((response.0.content_type, response.0.data)) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_task.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_task.rs new file mode 100644 index 000000000..4f43e165c --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_task.rs @@ -0,0 +1,258 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Task host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +/// QueueConfig holds configuration for a task queue. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct QueueConfig { + pub concurrency: i32, + pub max_retries: i32, + pub backoff_ms: i64, + pub delay_ms: i64, + pub retention_ms: i64, +} + +/// TaskInfo holds the current state of a task. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct TaskInfo { + pub status: String, + pub message: String, + pub attempt: i32, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskCreateQueueRequest { + name: String, + config: QueueConfig, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskCreateQueueResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskEnqueueRequest { + queue_name: String, + #[serde(with = "base64_bytes")] + payload: Vec<u8>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskEnqueueResponse { + #[serde(default)] + result: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskGetRequest { + task_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskGetResponse { + #[serde(default)] + result: Option<TaskInfo>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskCancelRequest { + task_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskCancelResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct TaskClearQueueRequest { + queue_name: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct TaskClearQueueResponse { + #[serde(default)] + result: i64, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn task_createqueue(input: Json<TaskCreateQueueRequest>) -> Json<TaskCreateQueueResponse>; + fn task_enqueue(input: Json<TaskEnqueueRequest>) -> Json<TaskEnqueueResponse>; + fn task_get(input: Json<TaskGetRequest>) -> Json<TaskGetResponse>; + fn task_cancel(input: Json<TaskCancelRequest>) -> Json<TaskCancelResponse>; + fn task_clearqueue(input: Json<TaskClearQueueRequest>) -> Json<TaskClearQueueResponse>; +} + +/// CreateQueue creates a named task queue with the given configuration. +/// Zero-value fields in config use sensible defaults. +/// If a queue with the same name already exists, returns an error. +/// On startup, this also recovers any stale "running" tasks from a previous crash. +/// +/// # Arguments +/// * `name` - String parameter. +/// * `config` - QueueConfig parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn create_queue(name: &str, config: QueueConfig) -> Result<(), Error> { + let response = unsafe { + task_createqueue(Json(TaskCreateQueueRequest { + name: name.to_owned(), + config: config, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// Enqueue adds a task to the named queue. Returns the task ID. +/// payload is opaque bytes passed back to the plugin on execution. +/// +/// # Arguments +/// * `queue_name` - String parameter. +/// * `payload` - Vec<u8> parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn enqueue(queue_name: &str, payload: Vec<u8>) -> Result<String, Error> { + let response = unsafe { + task_enqueue(Json(TaskEnqueueRequest { + queue_name: queue_name.to_owned(), + payload: payload, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Get returns the current state of a task including its status, +/// message, and attempt count. +/// +/// # Arguments +/// * `task_id` - String parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get(task_id: &str) -> Result<Option<TaskInfo>, Error> { + let response = unsafe { + task_get(Json(TaskGetRequest { + task_id: task_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// Cancel cancels a pending task. Returns error if already +/// running, completed, or failed. +/// +/// # Arguments +/// * `task_id` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn cancel(task_id: &str) -> Result<(), Error> { + let response = unsafe { + task_cancel(Json(TaskCancelRequest { + task_id: task_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// ClearQueue removes all pending tasks from the named queue. +/// Running tasks are not affected. Returns the number of tasks removed. +/// +/// # Arguments +/// * `queue_name` - String parameter. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn clear_queue(queue_name: &str) -> Result<i64, Error> { + let response = unsafe { + task_clearqueue(Json(TaskClearQueueRequest { + queue_name: queue_name.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_users.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_users.rs new file mode 100644 index 000000000..faa795bb9 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_users.rs @@ -0,0 +1,86 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the Users host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; + +/// User represents a Navidrome user with minimal information exposed to plugins. +/// Sensitive fields like password, email, and internal IDs are intentionally excluded. +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct User { + pub user_name: String, + pub name: String, + pub is_admin: bool, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetUsersResponse { + #[serde(default)] + result: Vec<User>, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct UsersGetAdminsResponse { + #[serde(default)] + result: Vec<User>, + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn users_getusers(input: Json<serde_json::Value>) -> Json<UsersGetUsersResponse>; + fn users_getadmins(input: Json<serde_json::Value>) -> Json<UsersGetAdminsResponse>; +} + +/// GetUsers returns all users the plugin has been granted access to. +/// Only minimal user information (userName, name, isAdmin) is returned. +/// Sensitive fields like password and email are never exposed. +/// +/// Returns a slice of users the plugin can access, or an empty slice if none configured. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_users() -> Result<Vec<User>, Error> { + let response = unsafe { + users_getusers(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} + +/// GetAdmins returns only admin users the plugin has been granted access to. +/// This is a convenience method that filters GetUsers results to include only admins. +/// +/// Returns a slice of admin users the plugin can access, or an empty slice if none. +/// +/// # Returns +/// The result value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn get_admins() -> Result<Vec<User>, Error> { + let response = unsafe { + users_getadmins(Json(serde_json::json!({})))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.result) +} diff --git a/plugins/pdk/rust/nd-pdk-host/src/nd_host_websocket.rs b/plugins/pdk/rust/nd-pdk-host/src/nd_host_websocket.rs new file mode 100644 index 000000000..05ceb5407 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk-host/src/nd_host_websocket.rs @@ -0,0 +1,228 @@ +// Code generated by ndpgen. DO NOT EDIT. +// +// This file contains client wrappers for the WebSocket host service. +// It is intended for use in Navidrome plugins built with extism-pdk. + +use extism_pdk::*; +use serde::{Deserialize, Serialize}; +use base64::Engine as _; +use base64::engine::general_purpose::STANDARD as BASE64; + +mod base64_bytes { + use serde::{self, Deserialize, Deserializer, Serializer}; + use base64::Engine as _; + use base64::engine::general_purpose::STANDARD as BASE64; + + pub fn serialize<S>(bytes: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error> + where + S: Serializer, + { + serializer.serialize_str(&BASE64.encode(bytes)) + } + + pub fn deserialize<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error> + where + D: Deserializer<'de>, + { + let s = String::deserialize(deserializer)?; + BASE64.decode(&s).map_err(serde::de::Error::custom) + } +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketConnectRequest { + url: String, + headers: std::collections::HashMap<String, String>, + connection_id: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketConnectResponse { + #[serde(default)] + new_connection_id: String, + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendTextRequest { + connection_id: String, + message: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendTextResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendBinaryRequest { + connection_id: String, + #[serde(with = "base64_bytes")] + data: Vec<u8>, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketSendBinaryResponse { + #[serde(default)] + error: Option<String>, +} + +#[derive(Debug, Clone, Serialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketCloseConnectionRequest { + connection_id: String, + code: i32, + reason: String, +} + +#[derive(Debug, Clone, Deserialize)] +#[serde(rename_all = "camelCase")] +struct WebSocketCloseConnectionResponse { + #[serde(default)] + error: Option<String>, +} + +#[host_fn] +extern "ExtismHost" { + fn websocket_connect(input: Json<WebSocketConnectRequest>) -> Json<WebSocketConnectResponse>; + fn websocket_sendtext(input: Json<WebSocketSendTextRequest>) -> Json<WebSocketSendTextResponse>; + fn websocket_sendbinary(input: Json<WebSocketSendBinaryRequest>) -> Json<WebSocketSendBinaryResponse>; + fn websocket_closeconnection(input: Json<WebSocketCloseConnectionRequest>) -> Json<WebSocketCloseConnectionResponse>; +} + +/// Connect establishes a WebSocket connection to the specified URL. +/// +/// Plugins that use this function must also implement the WebSocketCallback capability +/// to receive incoming messages and connection events. +/// +/// Parameters: +/// - url: The WebSocket URL to connect to (ws:// or wss://) +/// - headers: Optional HTTP headers to include in the handshake request +/// - connectionID: Optional unique identifier for the connection. If empty, one will be generated +/// +/// Returns the connection ID that can be used to send messages or close the connection, +/// or an error if the connection fails. +/// +/// # Arguments +/// * `url` - String parameter. +/// * `headers` - std::collections::HashMap<String, String> parameter. +/// * `connection_id` - String parameter. +/// +/// # Returns +/// The new_connection_id value. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn connect(url: &str, headers: std::collections::HashMap<String, String>, connection_id: &str) -> Result<String, Error> { + let response = unsafe { + websocket_connect(Json(WebSocketConnectRequest { + url: url.to_owned(), + headers: headers, + connection_id: connection_id.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(response.0.new_connection_id) +} + +/// SendText sends a text message over an established WebSocket connection. +/// +/// Parameters: +/// - connectionID: The connection identifier returned by Connect +/// - message: The text message to send +/// +/// Returns an error if the connection is not found or if sending fails. +/// +/// # Arguments +/// * `connection_id` - String parameter. +/// * `message` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn send_text(connection_id: &str, message: &str) -> Result<(), Error> { + let response = unsafe { + websocket_sendtext(Json(WebSocketSendTextRequest { + connection_id: connection_id.to_owned(), + message: message.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// SendBinary sends binary data over an established WebSocket connection. +/// +/// Parameters: +/// - connectionID: The connection identifier returned by Connect +/// - data: The binary data to send +/// +/// Returns an error if the connection is not found or if sending fails. +/// +/// # Arguments +/// * `connection_id` - String parameter. +/// * `data` - Vec<u8> parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn send_binary(connection_id: &str, data: Vec<u8>) -> Result<(), Error> { + let response = unsafe { + websocket_sendbinary(Json(WebSocketSendBinaryRequest { + connection_id: connection_id.to_owned(), + data: data, + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} + +/// CloseConnection gracefully closes a WebSocket connection. +/// +/// Parameters: +/// - connectionID: The connection identifier returned by Connect +/// - code: WebSocket close status code (e.g., 1000 for normal closure) +/// - reason: Optional human-readable reason for closing +/// +/// Returns an error if the connection is not found or if closing fails. +/// +/// # Arguments +/// * `connection_id` - String parameter. +/// * `code` - i32 parameter. +/// * `reason` - String parameter. +/// +/// # Errors +/// Returns an error if the host function call fails. +pub fn close_connection(connection_id: &str, code: i32, reason: &str) -> Result<(), Error> { + let response = unsafe { + websocket_closeconnection(Json(WebSocketCloseConnectionRequest { + connection_id: connection_id.to_owned(), + code: code, + reason: reason.to_owned(), + }))? + }; + + if let Some(err) = response.0.error { + return Err(Error::msg(err)); + } + + Ok(()) +} diff --git a/plugins/pdk/rust/nd-pdk/Cargo.toml b/plugins/pdk/rust/nd-pdk/Cargo.toml new file mode 100644 index 000000000..34fe9f032 --- /dev/null +++ b/plugins/pdk/rust/nd-pdk/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "nd-pdk" +version = "0.1.0" +edition = "2021" +description = "Navidrome Plugin Development Kit for Rust" +authors = ["Navidrome Team"] +license = "GPL-3.0" +readme = "../README.md" + +[lib] +crate-type = ["rlib"] + +[dependencies] +nd-pdk-host = { path = "../nd-pdk-host" } +nd-pdk-capabilities = { path = "../nd-pdk-capabilities" } +extism-pdk = "1.2" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" diff --git a/plugins/pdk/rust/nd-pdk/src/lib.rs b/plugins/pdk/rust/nd-pdk/src/lib.rs new file mode 100644 index 000000000..b1389938b --- /dev/null +++ b/plugins/pdk/rust/nd-pdk/src/lib.rs @@ -0,0 +1,35 @@ +//! Navidrome Plugin Development Kit for Rust +//! +//! This crate provides a unified API for building Navidrome plugins in Rust. +//! It re-exports all functionality from the host and capabilities sub-crates. +//! +//! # Example +//! +//! ```rust,no_run +//! use nd_pdk::scrobbler::{Scrobbler, IsAuthorizedRequest, Error}; +//! use nd_pdk::register_scrobbler; +//! +//! struct MyPlugin; +//! +//! impl Default for MyPlugin { +//! fn default() -> Self { MyPlugin } +//! } +//! +//! impl Scrobbler for MyPlugin { +//! fn is_authorized(&self, req: IsAuthorizedRequest) -> Result<bool, Error> { +//! Ok(true) +//! } +//! // ... implement other required methods +//! } +//! +//! register_scrobbler!(MyPlugin); +//! ``` + +/// Host function wrappers for calling Navidrome services from plugins. +pub use nd_pdk_host as host; + +/// Capability wrappers for implementing plugin exports. +pub use nd_pdk_capabilities::*; + +/// Re-export extism-pdk for convenience. +pub use extism_pdk; diff --git a/plugins/plugins_suite_test.go b/plugins/plugins_suite_test.go new file mode 100644 index 000000000..bb081988e --- /dev/null +++ b/plugins/plugins_suite_test.go @@ -0,0 +1,178 @@ +//go:build !windows + +package plugins + +import ( + "context" + "crypto/sha256" + "encoding/hex" + "encoding/json" + "net/http" + "os" + "os/exec" + "path/filepath" + "runtime" + "testing" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +const testDataDir = "plugins/testdata" + +// Shared test state initialized in BeforeSuite +var ( + testdataDir string // Path to testdata folder with test plugin .ndp packages + tmpPluginsDir string // Temp directory for plugin tests that modify files + testManager *Manager +) + +func TestPlugins(t *testing.T) { + tests.Init(t, false) + buildTestPlugins(t, testDataDir) + + // Create a shared wazero compilation cache directory. + // All test managers will point CacheFolder here so that WASM compilation + // is done once per binary and then reused from disk cache. + sharedCacheDir, err := os.MkdirTemp("", "plugins-shared-cache-*") + if err != nil { + t.Fatalf("Failed to create shared cache dir: %v", err) + } + t.Cleanup(func() { os.RemoveAll(sharedCacheDir) }) + + // Set CacheFolder globally so all tests (including those using + // configtest.SetupConfig) inherit it without needing to set it manually. + conf.Server.CacheFolder = conf.NewDir(sharedCacheDir) + + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Plugins Suite") +} + +func buildTestPlugins(t *testing.T, path string) { + t.Helper() + start := time.Now() + t.Logf("[BeforeSuite] Current working directory: %s", path) + cmd := exec.Command("make", "-C", path) + out, err := cmd.CombinedOutput() + t.Logf("[BeforeSuite] Make output: %s elapsed: %s", string(out), time.Since(start)) + if err != nil { + t.Fatalf("Failed to build test plugins: %v", err) + } +} + +// createTestManager creates a new plugin Manager with the given plugin config. +// It creates a temp directory, copies the test-metadata-agent plugin, and starts the manager. +// Returns the manager, temp directory path, and a cleanup function. +func createTestManager(pluginConfig map[string]map[string]string) (*Manager, string) { + return createTestManagerWithPlugins(pluginConfig, "test-metadata-agent"+PackageExtension) +} + +// createTestManagerWithPlugins creates a new plugin Manager with the given plugin config +// and specified plugins. It creates a temp directory, copies the specified plugins, and starts the manager. +// Returns the manager and temp directory path. +func createTestManagerWithPlugins(pluginConfig map[string]map[string]string, plugins ...string) (*Manager, string) { + return createTestManagerWithPluginsAndMetrics(pluginConfig, noopMetricsRecorder{}, plugins...) +} + +// createTestManagerWithPluginsAndMetrics creates a new plugin Manager with the given plugin config, +// metrics recorder, and specified plugins. It creates a temp directory, copies the specified plugins, and starts the manager. +// Returns the manager and temp directory path. +func createTestManagerWithPluginsAndMetrics(pluginConfig map[string]map[string]string, metrics PluginMetricsRecorder, plugins ...string) (*Manager, string) { + // Create temp directory + tmpDir, err := os.MkdirTemp("", "plugins-test-*") + Expect(err).ToNot(HaveOccurred()) + + // Copy test plugins to temp dir and build plugin list with SHA256 + var enabledPlugins model.Plugins + for _, plugin := range plugins { + srcPath := filepath.Join(testdataDir, plugin) + destPath := filepath.Join(tmpDir, plugin) + data, err := os.ReadFile(srcPath) + Expect(err).ToNot(HaveOccurred()) + err = os.WriteFile(destPath, data, 0600) + Expect(err).ToNot(HaveOccurred()) + + // Compute SHA256 for the plugin + hash := sha256.Sum256(data) + hashHex := hex.EncodeToString(hash[:]) + pluginName := plugin[:len(plugin)-len(PackageExtension)] // Remove .ndp extension + + // Build config JSON if provided + configJSON := "" + if pluginConfig != nil && pluginConfig[pluginName] != nil { + // Encode config to JSON + configBytes, err := json.Marshal(pluginConfig[pluginName]) + Expect(err).ToNot(HaveOccurred()) + configJSON = string(configBytes) + } + + enabledPlugins = append(enabledPlugins, model.Plugin{ + ID: pluginName, + Path: destPath, + SHA256: hashHex, + Enabled: true, + Config: configJSON, + AllUsers: true, // Allow all users by default in tests + }) + } + + // Setup config + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + conf.Server.Plugins.Folder = conf.NewDir(tmpDir) + conf.Server.Plugins.AutoReload = false + + // Setup mock DataStore with pre-enabled plugins + mockPluginRepo := tests.CreateMockPluginRepo() + mockPluginRepo.Permitted = true + mockPluginRepo.SetData(enabledPlugins) + dataStore := &tests.MockDataStore{MockedPlugin: mockPluginRepo} + + // Create and start manager + manager := &Manager{ + plugins: make(map[string]*plugin), + ds: dataStore, + metrics: metrics, + subsonicRouter: http.NotFoundHandler(), // Stub router for tests + } + err = manager.Start(GinkgoT().Context()) + Expect(err).ToNot(HaveOccurred()) + + DeferCleanup(func() { + _ = manager.Stop() + _ = os.RemoveAll(tmpDir) + }) + + return manager, tmpDir +} + +var _ = BeforeSuite(func() { + // Get testdata directory (where test plugin .ndp packages live) + _, currentFile, _, ok := runtime.Caller(0) + Expect(ok).To(BeTrue()) + testdataDir = filepath.Join(filepath.Dir(currentFile), "testdata") + + // Create shared manager for most tests + testManager, tmpPluginsDir = createTestManager(nil) +}) + +var _ = AfterSuite(func() { + if testManager != nil { + _ = testManager.Stop() + } + if tmpPluginsDir != "" { + _ = os.RemoveAll(tmpPluginsDir) + } +}) + +// noopMetricsRecorder is a no-op implementation of PluginMetricsRecorder for tests +type noopMetricsRecorder struct{} + +func (noopMetricsRecorder) RecordPluginRequest(context.Context, string, string, bool, int64) {} diff --git a/plugins/plugins_suite_windows_test.go b/plugins/plugins_suite_windows_test.go new file mode 100644 index 000000000..ed43bdcc3 --- /dev/null +++ b/plugins/plugins_suite_windows_test.go @@ -0,0 +1,23 @@ +//go:build windows + +package plugins + +import ( + "testing" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// Runs the subset of plugin specs compiled on Windows (files without the +// //go:build !windows tag): capabilities, manager_cache, manager_plugin, +// manifest, package. WASM-runtime-dependent specs live in !windows-tagged +// files and aren't reached here. +func TestPlugins(t *testing.T) { + tests.Init(t, false) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Plugins Suite") +} diff --git a/plugins/scrobbler_adapter.go b/plugins/scrobbler_adapter.go new file mode 100644 index 000000000..8abdccf07 --- /dev/null +++ b/plugins/scrobbler_adapter.go @@ -0,0 +1,209 @@ +package plugins + +import ( + "context" + "errors" + "strings" + + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/plugins/capabilities" +) + +// CapabilityScrobbler indicates the plugin can receive scrobble events. +// Detected when the plugin exports at least one of the scrobbler functions. +const CapabilityScrobbler Capability = "Scrobbler" + +// Scrobbler function names (snake_case as per design) +const ( + FuncScrobblerIsAuthorized = "nd_scrobbler_is_authorized" + FuncScrobblerNowPlaying = "nd_scrobbler_now_playing" + FuncScrobblerScrobble = "nd_scrobbler_scrobble" + FuncScrobblerPlaybackReport = "nd_scrobbler_playback_report" +) + +func init() { + registerCapability( + CapabilityScrobbler, + FuncScrobblerIsAuthorized, + FuncScrobblerNowPlaying, + FuncScrobblerScrobble, + FuncScrobblerPlaybackReport, + ) +} + +func newScrobblerPlugin(p *plugin) *ScrobblerPlugin { + userIDMap := make(map[string]struct{}) + for _, id := range p.allowedUserIDs { + userIDMap[id] = struct{}{} + } + return &ScrobblerPlugin{ + name: p.name, + plugin: p, + allowedUserIDs: p.allowedUserIDs, + allUsers: p.allUsers, + userIDMap: userIDMap, + } +} + +// ScrobblerPlugin is an adapter that wraps an Extism plugin and implements +// the scrobbler.Scrobbler interface for scrobbling to external services. +type ScrobblerPlugin struct { + name string + plugin *plugin + allowedUserIDs []string // User IDs this plugin can access (from DB configuration) + allUsers bool // If true, plugin can access all users + userIDMap map[string]struct{} // Cached map for fast lookups +} + +// IsAuthorized checks if the user is authorized with this scrobbler. +// First checks if the user is allowed to use this plugin (server-side), +// then delegates to the plugin for service-specific authorization. +func (s *ScrobblerPlugin) IsAuthorized(ctx context.Context, userId string) bool { + // First check server-side authorization based on plugin configuration + if !s.isUserAllowed(userId) { + return false + } + + // Then delegate to the plugin for service-specific authorization + username := getUsernameFromContext(ctx) + input := capabilities.IsAuthorizedRequest{ + Username: username, + } + + result, err := callPluginFunction[capabilities.IsAuthorizedRequest, bool](ctx, s.plugin, FuncScrobblerIsAuthorized, input) + if err != nil { + return false + } + + return result +} + +// isUserAllowed checks if the given user ID is allowed to use this plugin. +func (s *ScrobblerPlugin) isUserAllowed(userId string) bool { + if s.allUsers { + return true + } + if len(s.allowedUserIDs) == 0 { + return false + } + _, ok := s.userIDMap[userId] + return ok +} + +// NowPlaying sends a now playing notification to the scrobbler +func (s *ScrobblerPlugin) NowPlaying(ctx context.Context, userId string, track *model.MediaFile, position int) error { + username := getUsernameFromContext(ctx) + input := capabilities.NowPlayingRequest{ + Username: username, + Track: mediaFileToTrackInfo(s.plugin, track), + Position: int32(position), + } + + err := callPluginFunctionNoOutput(ctx, s.plugin, FuncScrobblerNowPlaying, input) + return mapScrobblerError(err) +} + +// Scrobble submits a scrobble to the scrobbler +func (s *ScrobblerPlugin) Scrobble(ctx context.Context, userId string, sc scrobbler.Scrobble) error { + username := getUsernameFromContext(ctx) + input := capabilities.ScrobbleRequest{ + Username: username, + Track: mediaFileToTrackInfo(s.plugin, &sc.MediaFile), + Timestamp: sc.TimeStamp.Unix(), + } + + err := callPluginFunctionNoOutput(ctx, s.plugin, FuncScrobblerScrobble, input) + return mapScrobblerError(err) +} + +// getUsernameFromContext extracts the username from the request context +func getUsernameFromContext(ctx context.Context) string { + if user, ok := request.UserFrom(ctx); ok { + return user.UserName + } + return "" +} + +// mediaFileToTrackInfo converts a model.MediaFile to capabilities.TrackInfo. +// Path is populated only when the plugin is allowed filesystem access to the +// track's library. +func mediaFileToTrackInfo(p *plugin, mf *model.MediaFile) capabilities.TrackInfo { + ti := capabilities.TrackInfo{ + ID: mf.ID, + Title: mf.Title, + Album: mf.Album, + Artist: mf.Artist, + AlbumArtist: mf.AlbumArtist, + Artists: participantsToArtistRefs(mf.Participants[model.RoleArtist]), + AlbumArtists: participantsToArtistRefs(mf.Participants[model.RoleAlbumArtist]), + Duration: mf.Duration, + TrackNumber: int32(mf.TrackNumber), + DiscNumber: int32(mf.DiscNumber), + MBZRecordingID: mf.MbzRecordingID, + MBZAlbumID: mf.MbzAlbumID, + MBZReleaseGroupID: mf.MbzReleaseGroupID, + MBZReleaseTrackID: mf.MbzReleaseTrackID, + } + if p.hasLibraryFilesystemAccess(mf.LibraryID) { + ti.LibraryID = int32(mf.LibraryID) + ti.Path = mf.Path + } + return ti +} + +// participantsToArtistRefs converts a ParticipantList to a slice of ArtistRef +func participantsToArtistRefs(participants model.ParticipantList) []capabilities.ArtistRef { + refs := make([]capabilities.ArtistRef, len(participants)) + for i, p := range participants { + refs[i] = capabilities.ArtistRef{ + ID: p.ID, + Name: p.Name, + MBID: p.MbzArtistID, + } + } + return refs +} + +// mapScrobblerError converts plugin errors to scrobbler errors based on error message, as errors are returned as +// strings from plugins. +func mapScrobblerError(err error) error { + if err == nil { + return nil + } + errMsg := err.Error() + switch { + case strings.Contains(errMsg, capabilities.ScrobblerErrorNotAuthorized.Error()): + return scrobbler.ErrNotAuthorized + case strings.Contains(errMsg, capabilities.ScrobblerErrorRetryLater.Error()): + return scrobbler.ErrRetryLater + case strings.Contains(errMsg, capabilities.ScrobblerErrorUnrecoverable.Error()): + return scrobbler.ErrUnrecoverable + default: + return scrobbler.ErrUnrecoverable + } +} + +// PlaybackReport sends a playback state report to the scrobbler +func (s *ScrobblerPlugin) PlaybackReport(ctx context.Context, info scrobbler.PlaybackSession) error { + input := capabilities.PlaybackReportRequest{ + Username: info.Username, + Track: mediaFileToTrackInfo(s.plugin, &info.MediaFile), + State: info.State, + PositionMs: info.PositionMs, + PlaybackRate: info.PlaybackRate, + PlayerId: info.PlayerId, + PlayerName: info.PlayerName, + Timestamp: info.LastReport.Unix(), + } + + err := callPluginFunctionNoOutput(ctx, s.plugin, FuncScrobblerPlaybackReport, input) + if errors.Is(err, errFunctionNotFound) || errors.Is(err, errNotImplemented) { + return nil + } + return mapScrobblerError(err) +} + +// Verify interface implementation at compile time +var _ scrobbler.Scrobbler = (*ScrobblerPlugin)(nil) diff --git a/plugins/scrobbler_adapter_test.go b/plugins/scrobbler_adapter_test.go new file mode 100644 index 000000000..56a452742 --- /dev/null +++ b/plugins/scrobbler_adapter_test.go @@ -0,0 +1,365 @@ +//go:build !windows + +package plugins + +import ( + "context" + "errors" + "time" + + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// ctxWithUser returns a fresh context with the test user. +// Must be called within each test, not in BeforeAll, because the context +// from BeforeAll gets cancelled before tests run. +func ctxWithUser() context.Context { + return request.WithUser(GinkgoT().Context(), model.User{ID: "user-1", UserName: "testuser"}) +} + +var _ = Describe("ScrobblerPlugin", Ordered, func() { + var ( + scrobblerManager *Manager + s scrobbler.Scrobbler + ) + + BeforeAll(func() { + // Load the scrobbler via a new manager with the test-scrobbler plugin + scrobblerManager, _ = createTestManagerWithPlugins(nil, "test-scrobbler"+PackageExtension) + + var ok bool + s, ok = scrobblerManager.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + Describe("LoadScrobbler", func() { + It("returns a scrobbler for a plugin with Scrobbler capability", func() { + Expect(s).ToNot(BeNil()) + }) + + It("returns false for a plugin without Scrobbler capability", func() { + _, ok := testManager.LoadScrobbler("test-metadata-agent") + Expect(ok).To(BeFalse()) + }) + + It("returns false for non-existent plugin", func() { + _, ok := scrobblerManager.LoadScrobbler("non-existent") + Expect(ok).To(BeFalse()) + }) + }) + + Describe("IsAuthorized", func() { + It("returns true when plugin is configured to authorize", func() { + result := s.IsAuthorized(ctxWithUser(), "user-1") + Expect(result).To(BeTrue()) + }) + + Context("when plugin is configured to not authorize", Ordered, func() { + var notAuthScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"authorized": "false"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + notAuthScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns false", func() { + result := notAuthScrobbler.IsAuthorized(ctxWithUser(), "user-1") + Expect(result).To(BeFalse()) + }) + }) + }) + + Describe("isUserAllowed", func() { + It("returns true when allUsers is true", func() { + sp := &ScrobblerPlugin{allUsers: true} + Expect(sp.isUserAllowed("any-user")).To(BeTrue()) + }) + + It("returns false when allowedUserIDs is empty and allUsers is false", func() { + sp := &ScrobblerPlugin{allUsers: false, allowedUserIDs: []string{}} + Expect(sp.isUserAllowed("user-1")).To(BeFalse()) + }) + + It("returns false when allowedUserIDs is nil and allUsers is false", func() { + sp := &ScrobblerPlugin{allUsers: false} + Expect(sp.isUserAllowed("user-1")).To(BeFalse()) + }) + + It("returns true when user is in allowedUserIDs", func() { + sp := &ScrobblerPlugin{ + allUsers: false, + allowedUserIDs: []string{"user-1", "user-2"}, + userIDMap: map[string]struct{}{"user-1": {}, "user-2": {}}, + } + Expect(sp.isUserAllowed("user-1")).To(BeTrue()) + }) + + It("returns false when user is not in allowedUserIDs", func() { + sp := &ScrobblerPlugin{ + allUsers: false, + allowedUserIDs: []string{"user-1", "user-2"}, + userIDMap: map[string]struct{}{"user-1": {}, "user-2": {}}, + } + Expect(sp.isUserAllowed("user-3")).To(BeFalse()) + }) + }) + + Describe("NowPlaying", func() { + It("successfully calls the plugin", func() { + track := &model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Album: "Test Album", + Artist: "Test Artist", + AlbumArtist: "Test Album Artist", + Duration: 180, + TrackNumber: 1, + DiscNumber: 1, + Participants: model.Participants{ + model.RoleArtist: {{Artist: model.Artist{ID: "artist-1", Name: "Test Artist"}}}, + model.RoleAlbumArtist: {{Artist: model.Artist{ID: "album-artist-1", Name: "Test Album Artist"}}}, + }, + } + + err := s.NowPlaying(ctxWithUser(), "user-1", track, 30) + Expect(err).ToNot(HaveOccurred()) + }) + + Context("when plugin returns error", Ordered, func() { + var retryScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"error": "service unavailable", "error_type": "scrobbler(retry_later)"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + retryScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns ErrRetryLater", func() { + track := &model.MediaFile{ID: "track-1", Title: "Test Song"} + err := retryScrobbler.NowPlaying(ctxWithUser(), "user-1", track, 30) + Expect(err).To(HaveOccurred()) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + }) + }) + + Describe("Scrobble", func() { + It("successfully calls the plugin", func() { + sc := scrobbler.Scrobble{ + MediaFile: model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Album: "Test Album", + Artist: "Test Artist", + AlbumArtist: "Test Album Artist", + Duration: 180, + TrackNumber: 1, + DiscNumber: 1, + Participants: model.Participants{ + model.RoleArtist: {{Artist: model.Artist{ID: "artist-1", Name: "Test Artist"}}}, + model.RoleAlbumArtist: {{Artist: model.Artist{ID: "album-artist-1", Name: "Test Album Artist"}}}, + }, + }, + TimeStamp: time.Now(), + } + + err := s.Scrobble(ctxWithUser(), "user-1", sc) + Expect(err).ToNot(HaveOccurred()) + }) + + Context("when plugin returns not_authorized error", Ordered, func() { + var notAuthScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"error": "user not linked", "error_type": "scrobbler(not_authorized)"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + notAuthScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns ErrNotAuthorized", func() { + scrobble := scrobbler.Scrobble{ + MediaFile: model.MediaFile{ID: "track-1", Title: "Test Song"}, + TimeStamp: time.Now(), + } + err := notAuthScrobbler.Scrobble(ctxWithUser(), "user-1", scrobble) + Expect(err).To(HaveOccurred()) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + }) + + Context("when plugin returns unrecoverable error", Ordered, func() { + var unrecoverableScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"error": "track rejected", "error_type": "scrobbler(unrecoverable)"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + unrecoverableScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns ErrUnrecoverable", func() { + scrobble := scrobbler.Scrobble{ + MediaFile: model.MediaFile{ID: "track-1", Title: "Test Song"}, + TimeStamp: time.Now(), + } + err := unrecoverableScrobbler.Scrobble(ctxWithUser(), "user-1", scrobble) + Expect(err).To(HaveOccurred()) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) + }) + }) + + Describe("PlaybackReport", func() { + It("successfully calls the plugin", func() { + info := scrobbler.PlaybackSession{ + MediaFile: model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Album: "Test Album", + Artist: "Test Artist", + AlbumArtist: "Test Album Artist", + Duration: 180, + TrackNumber: 1, + DiscNumber: 1, + Participants: model.Participants{ + model.RoleArtist: {{Artist: model.Artist{ID: "artist-1", Name: "Test Artist"}}}, + model.RoleAlbumArtist: {{Artist: model.Artist{ID: "album-artist-1", Name: "Test Album Artist"}}}, + }, + }, + Username: "testuser", + PlayerId: "player-1", + PlayerName: "Test Player", + State: "playing", + PositionMs: 30000, + PlaybackRate: 1.0, + LastReport: time.Now(), + } + + err := s.PlaybackReport(ctxWithUser(), info) + Expect(err).ToNot(HaveOccurred()) + }) + + Context("when plugin returns error", Ordered, func() { + var retryScrobbler scrobbler.Scrobbler + + BeforeAll(func() { + mgr, _ := createTestManagerWithPlugins(map[string]map[string]string{ + "test-scrobbler": {"error": "service unavailable", "error_type": "scrobbler(retry_later)"}, + }, "test-scrobbler"+PackageExtension) + + var ok bool + retryScrobbler, ok = mgr.LoadScrobbler("test-scrobbler") + Expect(ok).To(BeTrue()) + }) + + It("returns ErrRetryLater", func() { + info := scrobbler.PlaybackSession{ + MediaFile: model.MediaFile{ID: "track-1", Title: "Test Song"}, + State: "playing", + LastReport: time.Now(), + } + err := retryScrobbler.PlaybackReport(ctxWithUser(), info) + Expect(err).To(HaveOccurred()) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + }) + }) + + Describe("PluginNames", func() { + It("returns plugin names with Scrobbler capability", func() { + names := scrobblerManager.PluginNames("Scrobbler") + Expect(names).To(ContainElement("test-scrobbler")) + }) + + It("does not return metadata agent plugins for Scrobbler capability", func() { + names := testManager.PluginNames("Scrobbler") + Expect(names).ToNot(ContainElement("test-metadata-agent")) + }) + }) + + Describe("mediaFileToTrackInfo", func() { + var track *model.MediaFile + + BeforeEach(func() { + track = &model.MediaFile{ + ID: "track-1", + Title: "Test Song", + Path: "/music/test.flac", + LibraryID: 1, + } + }) + + fsManifest := &Manifest{ + Permissions: &Permissions{ + Library: &LibraryPermission{Filesystem: true}, + }, + } + + It("includes LibraryID and Path when the plugin has filesystem access to the track's library", func() { + p := &plugin{manifest: fsManifest, libraries: newLibraryAccess([]int{1}, false)} + ti := mediaFileToTrackInfo(p, track) + Expect(ti.LibraryID).To(Equal(int32(1))) + Expect(ti.Path).To(Equal("/music/test.flac")) + }) + + It("omits LibraryID and Path when the plugin lacks filesystem permission", func() { + p := &plugin{manifest: &Manifest{}, libraries: newLibraryAccess([]int{1}, false)} + ti := mediaFileToTrackInfo(p, track) + Expect(ti.LibraryID).To(BeZero()) + Expect(ti.Path).To(BeEmpty()) + }) + + It("omits LibraryID and Path when the track's library is not in the allowed set", func() { + p := &plugin{manifest: fsManifest, libraries: newLibraryAccess([]int{2}, false)} + ti := mediaFileToTrackInfo(p, track) + Expect(ti.LibraryID).To(BeZero()) + Expect(ti.Path).To(BeEmpty()) + }) + }) +}) + +var _ = Describe("mapScrobblerError", func() { + It("returns nil for nil error", func() { + Expect(mapScrobblerError(nil)).ToNot(HaveOccurred()) + }) + + It("returns ErrNotAuthorized for error containing 'not_authorized'", func() { + err := mapScrobblerError(errors.New("plugin error: scrobbler(not_authorized)")) + Expect(err).To(MatchError(scrobbler.ErrNotAuthorized)) + }) + + It("returns ErrRetryLater for error containing 'retry_later'", func() { + err := mapScrobblerError(errors.New("temporary failure: scrobbler(retry_later)")) + Expect(err).To(MatchError(scrobbler.ErrRetryLater)) + }) + + It("returns ErrUnrecoverable for error containing 'unrecoverable'", func() { + err := mapScrobblerError(errors.New("fatal error: scrobbler(unrecoverable)")) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) + + It("returns ErrUnrecoverable for unknown error", func() { + err := mapScrobblerError(errors.New("some unknown error")) + Expect(err).To(MatchError(scrobbler.ErrUnrecoverable)) + }) +}) diff --git a/plugins/sonic_similarity_adapter.go b/plugins/sonic_similarity_adapter.go new file mode 100644 index 000000000..ff399680e --- /dev/null +++ b/plugins/sonic_similarity_adapter.go @@ -0,0 +1,92 @@ +package plugins + +import ( + "context" + + "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/plugins/capabilities" +) + +const CapabilitySonicSimilarity Capability = "SonicSimilarity" + +const ( + FuncGetSonicSimilarTracks = "nd_get_sonic_similar_tracks" + FuncFindSonicPath = "nd_find_sonic_path" +) + +func init() { + registerCapability( + CapabilitySonicSimilarity, + FuncGetSonicSimilarTracks, + FuncFindSonicPath, + ) +} + +func newSonicSimilarityPlugin(p *plugin) *SonicSimilarityPlugin { + return &SonicSimilarityPlugin{name: p.name, plugin: p} +} + +type SonicSimilarityPlugin struct { + name string + plugin *plugin +} + +func (a *SonicSimilarityPlugin) GetSonicSimilarTracks(ctx context.Context, mf *model.MediaFile, count int) ([]sonic.SimilarResult, error) { + req := capabilities.GetSonicSimilarTracksRequest{ + Song: mediaFileToSongRef(mf), + Count: int32(count), + } + resp, err := callPluginFunction[capabilities.GetSonicSimilarTracksRequest, capabilities.SonicSimilarityResponse]( + ctx, a.plugin, FuncGetSonicSimilarTracks, req, + ) + if err != nil { + return nil, err + } + return sonicMatchesToSimilarResults(resp.Matches), nil +} + +func (a *SonicSimilarityPlugin) FindSonicPath(ctx context.Context, startMf, endMf *model.MediaFile, count int) ([]sonic.SimilarResult, error) { + req := capabilities.FindSonicPathRequest{ + StartSong: mediaFileToSongRef(startMf), + EndSong: mediaFileToSongRef(endMf), + Count: int32(count), + } + resp, err := callPluginFunction[capabilities.FindSonicPathRequest, capabilities.SonicSimilarityResponse]( + ctx, a.plugin, FuncFindSonicPath, req, + ) + if err != nil { + return nil, err + } + return sonicMatchesToSimilarResults(resp.Matches), nil +} + +func mediaFileToSongRef(mf *model.MediaFile) capabilities.SongRef { + ref := capabilities.SongRef{ + ID: mf.ID, + Name: mf.Title, + MBID: mf.MbzRecordingID, + Artist: mf.Artist, + ArtistMBID: mf.MbzArtistID, + Album: mf.Album, + AlbumMBID: mf.MbzAlbumID, + Duration: mf.Duration, + } + if isrcs := mf.Tags.Values(model.TagISRC); len(isrcs) > 0 { + ref.ISRC = isrcs[0] + } + return ref +} + +func sonicMatchesToSimilarResults(matches []capabilities.SonicMatch) []sonic.SimilarResult { + results := make([]sonic.SimilarResult, len(matches)) + for i, m := range matches { + results[i] = sonic.SimilarResult{ + Song: songRefToAgentSong(m.Song), + Similarity: m.Similarity, + } + } + return results +} + +var _ sonic.Provider = (*SonicSimilarityPlugin)(nil) diff --git a/plugins/sonic_similarity_adapter_test.go b/plugins/sonic_similarity_adapter_test.go new file mode 100644 index 000000000..daea04761 --- /dev/null +++ b/plugins/sonic_similarity_adapter_test.go @@ -0,0 +1,110 @@ +//go:build !windows + +package plugins + +import ( + "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("SonicSimilarityPlugin", Ordered, func() { + var ( + manager *Manager + provider sonic.Provider + ) + + BeforeAll(func() { + manager, _ = createTestManagerWithPlugins(nil, "test-sonic-similarity"+PackageExtension) + + var ok bool + provider, ok = manager.LoadSonicSimilarity("test-sonic-similarity") + Expect(ok).To(BeTrue()) + }) + + Describe("PluginNames", func() { + It("reports the sonic similarity capability", func() { + names := manager.PluginNames(string(CapabilitySonicSimilarity)) + Expect(names).To(ContainElement("test-sonic-similarity")) + }) + }) + + Describe("GetSonicSimilarTracks", func() { + It("returns similar tracks from the plugin", func() { + mf := &model.MediaFile{ + ID: "track-1", + Title: "Yesterday", + Artist: "The Beatles", + } + + results, err := provider.GetSonicSimilarTracks(GinkgoT().Context(), mf, 3) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + Expect(results[0].Song.Name).To(Equal("Similar to Yesterday #1")) + Expect(results[0].Song.Artist).To(Equal("The Beatles")) + Expect(results[0].Similarity).To(Equal(1.0)) + Expect(results[1].Similarity).To(Equal(0.9)) + Expect(results[2].Similarity).To(Equal(0.8)) + }) + }) + + Describe("FindSonicPath", func() { + It("returns a path between two tracks from the plugin", func() { + startMf := &model.MediaFile{ + ID: "track-1", + Title: "Yesterday", + Artist: "The Beatles", + } + + endMf := &model.MediaFile{ + ID: "track-2", + Title: "Tomorrow Never Knows", + Artist: "The Beatles", + } + + results, err := provider.FindSonicPath(GinkgoT().Context(), startMf, endMf, 3) + Expect(err).ToNot(HaveOccurred()) + Expect(results).To(HaveLen(3)) + Expect(results[0].Song.Name).To(Equal("Path Yesterday to Tomorrow Never Knows #1")) + Expect(results[0].Song.Artist).To(Equal("The Beatles")) + Expect(results[0].Similarity).To(Equal(1.0)) + Expect(results[1].Similarity).To(Equal(0.95)) + Expect(results[2].Similarity).To(Equal(0.9)) + }) + }) +}) + +var _ = Describe("SonicSimilarityPlugin error handling", Ordered, func() { + var ( + errorManager *Manager + errorProvider sonic.Provider + ) + + BeforeAll(func() { + errorManager, _ = createTestManagerWithPlugins(map[string]map[string]string{ + "test-sonic-similarity": { + "error": "simulated plugin error", + }, + }, "test-sonic-similarity"+PackageExtension) + + var ok bool + errorProvider, ok = errorManager.LoadSonicSimilarity("test-sonic-similarity") + Expect(ok).To(BeTrue()) + }) + + It("returns error from GetSonicSimilarTracks", func() { + mf := &model.MediaFile{ID: "track-1", Title: "Test"} + _, err := errorProvider.GetSonicSimilarTracks(GinkgoT().Context(), mf, 3) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) + + It("returns error from FindSonicPath", func() { + startMf := &model.MediaFile{ID: "track-1", Title: "Start"} + endMf := &model.MediaFile{ID: "track-2", Title: "End"} + _, err := errorProvider.FindSonicPath(GinkgoT().Context(), startMf, endMf, 3) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("simulated plugin error")) + }) +}) diff --git a/plugins/testdata/Makefile b/plugins/testdata/Makefile new file mode 100644 index 000000000..d53f2aaee --- /dev/null +++ b/plugins/testdata/Makefile @@ -0,0 +1,31 @@ +# Build test plugins used for integration testing +# Auto-discover all plugin folders (folders containing go.mod) +PLUGINS := $(patsubst %/go.mod,%,$(wildcard */go.mod)) + +# Prefer tinygo if available, it produces smaller wasm binaries and +# makes the tests faster. +TINYGO := $(shell command -v tinygo 2> /dev/null) + +all: $(PLUGINS:%=%.ndp) + +clean: + rm -f $(PLUGINS:%=%.ndp) $(PLUGINS:%=%.wasm) + +# PDK source files that trigger rebuild when changed (recursive) +PDK_SOURCES := $(shell find ../pdk/go -name '*.go' 2>/dev/null) + +# Build the .ndp package (zip containing manifest.json + plugin.wasm) +%.ndp: %.wasm %/manifest.json + @rm -f $@ + @cp $< plugin.wasm + zip -j $@ $*/manifest.json plugin.wasm + @rm -f plugin.wasm + @mv $< $<.tmp && mv $<.tmp $< # Touch wasm to ensure it's older than ndp + +# Build the wasm binary +%.wasm: %/*.go %/go.mod $(PDK_SOURCES) +ifdef TINYGO + cd $* && tinygo build -target wasip1 -buildmode=c-shared -o ../$@ . +else + cd $* && GOOS=wasip1 GOARCH=wasm go build -buildmode=c-shared -o ../$@ . +endif \ No newline at end of file diff --git a/plugins/testdata/partial-metadata-agent/go.mod b/plugins/testdata/partial-metadata-agent/go.mod new file mode 100644 index 000000000..b37144d9a --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/go.mod @@ -0,0 +1,16 @@ +module partial-metadata-agent + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/partial-metadata-agent/go.sum b/plugins/testdata/partial-metadata-agent/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/partial-metadata-agent/main.go b/plugins/testdata/partial-metadata-agent/main.go new file mode 100644 index 000000000..c11febf00 --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/main.go @@ -0,0 +1,23 @@ +// Test plugin that only implements some metadata methods. +// Used to test the "not implemented" code path (-2 return code). +// Build with: tinygo build -o ../partial-metadata-agent.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" +) + +func init() { + metadata.Register(&partialMetadataAgent{}) +} + +// partialMetadataAgent only implements GetArtistBiography. +// All other methods will return NotImplementedCode (-2). +type partialMetadataAgent struct{} + +// GetArtistBiography is the only method we implement. +func (t *partialMetadataAgent) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + return &metadata.ArtistBiographyResponse{Biography: "Partial agent biography for " + input.Name}, nil +} + +func main() {} diff --git a/plugins/testdata/partial-metadata-agent/manifest.json b/plugins/testdata/partial-metadata-agent/manifest.json new file mode 100644 index 000000000..a600985a8 --- /dev/null +++ b/plugins/testdata/partial-metadata-agent/manifest.json @@ -0,0 +1,6 @@ +{ + "name": "Partial Metadata Agent", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin that only implements some metadata methods" +} diff --git a/plugins/testdata/test-artwork/go.mod b/plugins/testdata/test-artwork/go.mod new file mode 100644 index 000000000..553f5e575 --- /dev/null +++ b/plugins/testdata/test-artwork/go.mod @@ -0,0 +1,16 @@ +module test-artwork + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-artwork/go.sum b/plugins/testdata/test-artwork/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-artwork/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-artwork/main.go b/plugins/testdata/test-artwork/main.go new file mode 100644 index 000000000..de857dd97 --- /dev/null +++ b/plugins/testdata/test-artwork/main.go @@ -0,0 +1,64 @@ +// Test Artwork plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-artwork.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "strings" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestInput is the input for nd_test_artwork callback. +type TestInput struct { + ArtworkType string `json:"artwork_type"` // "artist", "album", "track", "playlist" + ID string `json:"id"` + Size int32 `json:"size"` +} + +// TestOutput is the output from nd_test_artwork callback. +type TestOutput struct { + URL string `json:"url,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_artwork is the test callback that tests the artwork host functions. +// +//go:wasmexport nd_test_artwork +func ndTestArtwork() int32 { + var input TestInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + var url string + var err error + + switch strings.ToLower(input.ArtworkType) { + case "artist": + url, err = host.ArtworkGetArtistUrl(input.ID, input.Size) + case "album": + url, err = host.ArtworkGetAlbumUrl(input.ID, input.Size) + case "track": + url, err = host.ArtworkGetTrackUrl(input.ID, input.Size) + case "playlist": + url, err = host.ArtworkGetPlaylistUrl(input.ID, input.Size) + default: + errStr := "unknown artwork type: " + input.ArtworkType + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + pdk.OutputJSON(TestOutput{URL: url}) + return 0 +} + +func main() {} diff --git a/plugins/testdata/test-artwork/manifest.json b/plugins/testdata/test-artwork/manifest.json new file mode 100644 index 000000000..c6ddbcb05 --- /dev/null +++ b/plugins/testdata/test-artwork/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Artwork", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test artwork plugin for integration testing", + "permissions": { + "artwork": { + "reason": "For testing artwork URL generation" + } + } +} diff --git a/plugins/testdata/test-cache-plugin/go.mod b/plugins/testdata/test-cache-plugin/go.mod new file mode 100644 index 000000000..c41110b70 --- /dev/null +++ b/plugins/testdata/test-cache-plugin/go.mod @@ -0,0 +1,16 @@ +module test-cache-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-cache-plugin/go.sum b/plugins/testdata/test-cache-plugin/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-cache-plugin/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-cache-plugin/main.go b/plugins/testdata/test-cache-plugin/main.go new file mode 100644 index 000000000..1d193ac39 --- /dev/null +++ b/plugins/testdata/test-cache-plugin/main.go @@ -0,0 +1,150 @@ +// Test Cache plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-cache-plugin.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestCacheInput is the input for nd_test_cache callback. +type TestCacheInput struct { + Operation string `json:"operation"` // "set_string", "get_string", "set_int", "get_int", "set_float", "get_float", "set_bytes", "get_bytes", "has", "remove" + Key string `json:"key"` // Cache key + StringVal string `json:"string_val"` // For string operations + IntVal int64 `json:"int_val"` // For int operations + FloatVal float64 `json:"float_val"` // For float operations + BytesVal []byte `json:"bytes_val"` // For bytes operations + TTLSeconds int64 `json:"ttl_seconds"` // TTL in seconds +} + +// TestCacheOutput is the output from nd_test_cache callback. +type TestCacheOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + FloatVal float64 `json:"float_val,omitempty"` + BytesVal []byte `json:"bytes_val,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_cache is the test callback that tests the cache host functions. +// +//go:wasmexport nd_test_cache +func ndTestCache() int32 { + var input TestCacheInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "set_string": + err := host.CacheSetString(input.Key, input.StringVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_string": + value, exists, err := host.CacheGetString(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{StringVal: value, Exists: exists}) + return 0 + + case "set_int": + err := host.CacheSetInt(input.Key, input.IntVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_int": + value, exists, err := host.CacheGetInt(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{IntVal: value, Exists: exists}) + return 0 + + case "set_float": + err := host.CacheSetFloat(input.Key, input.FloatVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_float": + value, exists, err := host.CacheGetFloat(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{FloatVal: value, Exists: exists}) + return 0 + + case "set_bytes": + err := host.CacheSetBytes(input.Key, input.BytesVal, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + case "get_bytes": + value, exists, err := host.CacheGetBytes(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{BytesVal: value, Exists: exists}) + return 0 + + case "has": + exists, err := host.CacheHas(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{Exists: exists}) + return 0 + + case "remove": + err := host.CacheRemove(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestCacheOutput{}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestCacheOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-cache-plugin/manifest.json b/plugins/testdata/test-cache-plugin/manifest.json new file mode 100644 index 000000000..8c0d16a8b --- /dev/null +++ b/plugins/testdata/test-cache-plugin/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Cache Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test cache plugin for integration testing", + "permissions": { + "cache": { + "reason": "For testing cache operations" + } + } +} diff --git a/plugins/testdata/test-config/go.mod b/plugins/testdata/test-config/go.mod new file mode 100644 index 000000000..7fa19b41e --- /dev/null +++ b/plugins/testdata/test-config/go.mod @@ -0,0 +1,16 @@ +module test-config + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-config/go.sum b/plugins/testdata/test-config/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-config/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-config/main.go b/plugins/testdata/test-config/main.go new file mode 100644 index 000000000..1d058db11 --- /dev/null +++ b/plugins/testdata/test-config/main.go @@ -0,0 +1,60 @@ +// Test Config plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-config.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestConfigInput is the input for nd_test_config callback. +type TestConfigInput struct { + Operation string `json:"operation"` // "get", "get_int", "list" + Key string `json:"key"` // For get/get_int operations + Prefix string `json:"prefix"` // For list operation +} + +// TestConfigOutput is the output from nd_test_config callback. +type TestConfigOutput struct { + StringVal string `json:"string_val,omitempty"` + IntVal int64 `json:"int_val,omitempty"` + Keys []string `json:"keys,omitempty"` + Exists bool `json:"exists,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_config is the test callback that tests the config host functions. +// +//go:wasmexport nd_test_config +func ndTestConfig() int32 { + var input TestConfigInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestConfigOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "get": + value, exists := host.ConfigGet(input.Key) + pdk.OutputJSON(TestConfigOutput{StringVal: value, Exists: exists}) + return 0 + + case "get_int": + value, exists := host.ConfigGetInt(input.Key) + pdk.OutputJSON(TestConfigOutput{IntVal: value, Exists: exists}) + return 0 + + case "list": + keys := host.ConfigKeys(input.Prefix) + pdk.OutputJSON(TestConfigOutput{Keys: keys}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestConfigOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-config/manifest.json b/plugins/testdata/test-config/manifest.json new file mode 100644 index 000000000..b5ed5dd86 --- /dev/null +++ b/plugins/testdata/test-config/manifest.json @@ -0,0 +1,61 @@ +{ + "name": "Test Config Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin for config service integration testing", + "config": { + "schema": { + "type": "object", + "properties": { + "api_key": { + "type": "string", + "title": "API Key", + "minLength": 1 + }, + "max_retries": { + "type": "string", + "title": "Max Retries" + }, + "timeout": { + "type": "string", + "title": "Timeout" + }, + "users": { + "type": "array", + "title": "Users", + "items": { + "type": "object", + "properties": { + "username": { + "type": "string", + "title": "Username", + "minLength": 1 + }, + "token": { + "type": "string", + "title": "Token", + "minLength": 1 + } + }, + "required": ["username", "token"] + } + }, + "settings": { + "type": "object", + "title": "Settings", + "properties": { + "enabled": { + "type": "boolean", + "title": "Enabled" + }, + "count": { + "type": "integer", + "title": "Count" + } + } + } + }, + "required": ["api_key"] + } + } +} diff --git a/plugins/testdata/test-kvstore/go.mod b/plugins/testdata/test-kvstore/go.mod new file mode 100644 index 000000000..19fa0a47c --- /dev/null +++ b/plugins/testdata/test-kvstore/go.mod @@ -0,0 +1,16 @@ +module test-kvstore + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-kvstore/go.sum b/plugins/testdata/test-kvstore/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-kvstore/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-kvstore/main.go b/plugins/testdata/test-kvstore/main.go new file mode 100644 index 000000000..7fba14abe --- /dev/null +++ b/plugins/testdata/test-kvstore/main.go @@ -0,0 +1,140 @@ +// Test KVStore plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-kvstore.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestKVStoreInput is the input for nd_test_kvstore callback. +type TestKVStoreInput struct { + Operation string `json:"operation"` // "set", "get", "delete", "has", "list", "get_storage_used", "set_with_ttl", "delete_by_prefix", "get_many" + Key string `json:"key"` // Storage key + Value []byte `json:"value"` // For set operations + Prefix string `json:"prefix"` // For list/delete_by_prefix operations + TTLSeconds int64 `json:"ttl_seconds,omitempty"` // For set_with_ttl + Keys []string `json:"keys,omitempty"` // For get_many +} + +// TestKVStoreOutput is the output from nd_test_kvstore callback. +type TestKVStoreOutput struct { + Value []byte `json:"value,omitempty"` + Values map[string][]byte `json:"values,omitempty"` + Exists bool `json:"exists,omitempty"` + Keys []string `json:"keys,omitempty"` + StorageUsed int64 `json:"storage_used,omitempty"` + DeletedCount int64 `json:"deleted_count,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_kvstore is the test callback that tests the kvstore host functions. +// +//go:wasmexport nd_test_kvstore +func ndTestKVStore() int32 { + var input TestKVStoreInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "set": + err := host.KVStoreSet(input.Key, input.Value) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{}) + return 0 + + case "get": + value, exists, err := host.KVStoreGet(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Value: value, Exists: exists}) + return 0 + + case "delete": + err := host.KVStoreDelete(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{}) + return 0 + + case "has": + exists, err := host.KVStoreHas(input.Key) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Exists: exists}) + return 0 + + case "list": + keys, err := host.KVStoreList(input.Prefix) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Keys: keys}) + return 0 + + case "get_storage_used": + bytesUsed, err := host.KVStoreGetStorageUsed() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{StorageUsed: bytesUsed}) + return 0 + + case "set_with_ttl": + err := host.KVStoreSetWithTTL(input.Key, input.Value, input.TTLSeconds) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{}) + return 0 + + case "delete_by_prefix": + deletedCount, err := host.KVStoreDeleteByPrefix(input.Prefix) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{DeletedCount: deletedCount}) + return 0 + + case "get_many": + values, err := host.KVStoreGetMany(input.Keys) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestKVStoreOutput{Values: values}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestKVStoreOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-kvstore/manifest.json b/plugins/testdata/test-kvstore/manifest.json new file mode 100644 index 000000000..d2a411d93 --- /dev/null +++ b/plugins/testdata/test-kvstore/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test KVStore Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test kvstore plugin for integration testing", + "permissions": { + "kvstore": { + "reason": "For testing kvstore operations", + "maxSize": "10KB" + } + } +} diff --git a/plugins/testdata/test-library/go.mod b/plugins/testdata/test-library/go.mod new file mode 100644 index 000000000..d3efcf2fd --- /dev/null +++ b/plugins/testdata/test-library/go.mod @@ -0,0 +1,16 @@ +module test-library + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-library/go.sum b/plugins/testdata/test-library/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-library/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-library/main.go b/plugins/testdata/test-library/main.go new file mode 100644 index 000000000..9c04c5f9b --- /dev/null +++ b/plugins/testdata/test-library/main.go @@ -0,0 +1,98 @@ +// Test Library plugin for Navidrome plugin system integration tests. +// This plugin tests library metadata access WITH filesystem permission, +// allowing tests for both metadata and filesystem access. +// Build with: tinygo build -o ../test-library.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "os" + "path/filepath" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestLibraryInput is the input for nd_test_library callback. +type TestLibraryInput struct { + Operation string `json:"operation"` // "get_library", "get_all_libraries", "read_file", "list_dir" + LibraryID int32 `json:"library_id,omitempty"` + MountPoint string `json:"mount_point,omitempty"` // For filesystem operations + FilePath string `json:"file_path,omitempty"` // For read_file operation (relative to mount point) +} + +// TestLibraryOutput is the output from nd_test_library callback. +type TestLibraryOutput struct { + Library *host.Library `json:"library,omitempty"` + Libraries []host.Library `json:"libraries,omitempty"` + FileContent string `json:"file_content,omitempty"` + DirEntries []string `json:"dir_entries,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_library is the test callback that tests the library host functions. +// +//go:wasmexport nd_test_library +func ndTestLibrary() int32 { + var input TestLibraryInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "get_library": + library, err := host.LibraryGetLibrary(input.LibraryID) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestLibraryOutput{Library: library}) + return 0 + + case "get_all_libraries": + libraries, err := host.LibraryGetAllLibraries() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestLibraryOutput{Libraries: libraries}) + return 0 + + case "read_file": + // Read a file from the mounted library directory + fullPath := filepath.Join(input.MountPoint, input.FilePath) + content, err := os.ReadFile(fullPath) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestLibraryOutput{FileContent: string(content)}) + return 0 + + case "list_dir": + // List files in the mounted library directory + entries, err := os.ReadDir(input.MountPoint) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } + var names []string + for _, entry := range entries { + names = append(names, entry.Name()) + } + pdk.OutputJSON(TestLibraryOutput{DirEntries: names}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestLibraryOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-library/manifest.json b/plugins/testdata/test-library/manifest.json new file mode 100644 index 000000000..b06b3bbec --- /dev/null +++ b/plugins/testdata/test-library/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test Library Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test library plugin for integration testing", + "permissions": { + "library": { + "reason": "For testing library metadata and filesystem access", + "filesystem": true + } + } +} diff --git a/plugins/testdata/test-lyrics/go.mod b/plugins/testdata/test-lyrics/go.mod new file mode 100644 index 000000000..fbbb23fc0 --- /dev/null +++ b/plugins/testdata/test-lyrics/go.mod @@ -0,0 +1,16 @@ +module test-lyrics + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-lyrics/go.sum b/plugins/testdata/test-lyrics/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-lyrics/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-lyrics/main.go b/plugins/testdata/test-lyrics/main.go new file mode 100644 index 000000000..0e485ceba --- /dev/null +++ b/plugins/testdata/test-lyrics/main.go @@ -0,0 +1,42 @@ +// Test lyrics plugin for Navidrome plugin system integration tests. +package main + +import ( + "fmt" + + "github.com/navidrome/navidrome/plugins/pdk/go/lyrics" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +func init() { + lyrics.Register(&testLyrics{}) +} + +type testLyrics struct{} + +func (t *testLyrics) GetLyrics(input lyrics.GetLyricsRequest) (lyrics.GetLyricsResponse, error) { + // Check for configured error + errMsg, hasErr := pdk.GetConfig("error") + if hasErr && errMsg != "" { + return lyrics.GetLyricsResponse{}, fmt.Errorf("%s", errMsg) + } + + // Check if we should omit language (to test default language handling) + noLang, hasNoLang := pdk.GetConfig("no_lang") + lang := "eng" + if hasNoLang && noLang == "true" { + lang = "" + } + + // Return test lyrics based on track info + return lyrics.GetLyricsResponse{ + Lyrics: []lyrics.LyricsText{ + { + Lang: lang, + Text: "Test lyrics for " + input.Track.Title + "\nBy " + input.Track.Artist, + }, + }, + }, nil +} + +func main() {} diff --git a/plugins/testdata/test-lyrics/manifest.json b/plugins/testdata/test-lyrics/manifest.json new file mode 100644 index 000000000..a61299e92 --- /dev/null +++ b/plugins/testdata/test-lyrics/manifest.json @@ -0,0 +1,6 @@ +{ + "name": "Test Lyrics", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test lyrics plugin for integration testing" +} diff --git a/plugins/testdata/test-metadata-agent/go.mod b/plugins/testdata/test-metadata-agent/go.mod new file mode 100644 index 000000000..02aff736c --- /dev/null +++ b/plugins/testdata/test-metadata-agent/go.mod @@ -0,0 +1,16 @@ +module test-metadata-agent + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-metadata-agent/go.sum b/plugins/testdata/test-metadata-agent/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-metadata-agent/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-metadata-agent/main.go b/plugins/testdata/test-metadata-agent/main.go new file mode 100644 index 000000000..23e933eb3 --- /dev/null +++ b/plugins/testdata/test-metadata-agent/main.go @@ -0,0 +1,184 @@ +// Test plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-metadata-agent.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "errors" + "strconv" + + "github.com/navidrome/navidrome/plugins/pdk/go/metadata" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +func init() { + metadata.Register(&testMetadataAgent{}) +} + +type testMetadataAgent struct{} + +// checkConfigError checks if the plugin is configured to return an error. +// If "error" config is set, it returns an error with that message. +func checkConfigError() error { + errMsg, hasErr := pdk.GetConfig("error") + if !hasErr || errMsg == "" { + return nil + } + return errors.New(errMsg) +} + +func (t *testMetadataAgent) GetArtistMBID(input metadata.ArtistMBIDRequest) (*metadata.ArtistMBIDResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistMBIDResponse{MBID: "test-mbid-" + input.Name}, nil +} + +func (t *testMetadataAgent) GetArtistURL(input metadata.ArtistRequest) (*metadata.ArtistURLResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistURLResponse{URL: "https://test.example.com/artist/" + input.Name}, nil +} + +func (t *testMetadataAgent) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistBiographyResponse{Biography: "Biography for " + input.Name}, nil +} + +func (t *testMetadataAgent) GetArtistImages(input metadata.ArtistRequest) (*metadata.ArtistImagesResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.ArtistImagesResponse{ + Images: []metadata.ImageInfo{ + {URL: "https://test.example.com/images/" + input.Name + "/large.jpg", Size: 500}, + {URL: "https://test.example.com/images/" + input.Name + "/small.jpg", Size: 100}, + }, + }, nil +} + +func (t *testMetadataAgent) GetSimilarArtists(input metadata.SimilarArtistsRequest) (*metadata.SimilarArtistsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + limit := int(input.Limit) + if limit == 0 { + limit = 5 + } + artists := make([]metadata.ArtistRef, 0, limit) + for i := range limit { + artists = append(artists, metadata.ArtistRef{ + ID: "similar-artist-id-" + strconv.Itoa(i+1), + Name: input.Name + " Similar " + string(rune('A'+i)), + MBID: "similar-mbid-" + strconv.Itoa(i+1), + }) + } + return &metadata.SimilarArtistsResponse{Artists: artists}, nil +} + +func (t *testMetadataAgent) GetArtistTopSongs(input metadata.TopSongsRequest) (*metadata.TopSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "song-id-" + strconv.Itoa(i+1), + Name: input.Name + " Song " + strconv.Itoa(i+1), + MBID: "song-mbid-" + strconv.Itoa(i+1), + }) + } + return &metadata.TopSongsResponse{Songs: songs}, nil +} + +func (t *testMetadataAgent) GetAlbumInfo(input metadata.AlbumRequest) (*metadata.AlbumInfoResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.AlbumInfoResponse{ + Name: input.Name, + MBID: "test-album-mbid-" + input.Name, + Description: "Description for " + input.Name + " by " + input.Artist, + URL: "https://test.example.com/album/" + input.Name, + }, nil +} + +func (t *testMetadataAgent) GetAlbumImages(input metadata.AlbumRequest) (*metadata.AlbumImagesResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + return &metadata.AlbumImagesResponse{ + Images: []metadata.ImageInfo{ + {URL: "https://test.example.com/albums/" + input.Name + "/cover.jpg", Size: 500}, + }, + }, nil +} + +func (t *testMetadataAgent) GetSimilarSongsByTrack(input metadata.SimilarSongsByTrackRequest) (*metadata.SimilarSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "similar-track-id-" + strconv.Itoa(i+1), + Name: "Similar to " + input.Name + " #" + strconv.Itoa(i+1), + MBID: "similar-mbid-" + strconv.Itoa(i+1), + ISRC: "similar-isrc-" + strconv.Itoa(i+1), + Artist: input.Artist, + ArtistMBID: "artist-mbid-" + strconv.Itoa(i+1), + }) + } + return &metadata.SimilarSongsResponse{Songs: songs}, nil +} + +func (t *testMetadataAgent) GetSimilarSongsByAlbum(input metadata.SimilarSongsByAlbumRequest) (*metadata.SimilarSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "album-similar-id-" + strconv.Itoa(i+1), + Name: "Album Similar #" + strconv.Itoa(i+1), + Artist: input.Artist, + Album: input.Name, + }) + } + return &metadata.SimilarSongsResponse{Songs: songs}, nil +} + +func (t *testMetadataAgent) GetSimilarSongsByArtist(input metadata.SimilarSongsByArtistRequest) (*metadata.SimilarSongsResponse, error) { + if err := checkConfigError(); err != nil { + return nil, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + songs := make([]metadata.SongRef, 0, count) + for i := range count { + songs = append(songs, metadata.SongRef{ + ID: "artist-similar-id-" + strconv.Itoa(i+1), + Name: input.Name + " Style Song #" + strconv.Itoa(i+1), + Artist: input.Name + " Similar Artist", + }) + } + return &metadata.SimilarSongsResponse{Songs: songs}, nil +} + +func main() {} diff --git a/plugins/testdata/test-metadata-agent/manifest.json b/plugins/testdata/test-metadata-agent/manifest.json new file mode 100644 index 000000000..3a1838730 --- /dev/null +++ b/plugins/testdata/test-metadata-agent/manifest.json @@ -0,0 +1,15 @@ +{ + "name": "Test Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin for integration testing", + "capabilities": ["MetadataAgent"], + "permissions": { + "http": { + "reason": "Test HTTP access", + "allowedURLs": { + "https://test.example.com/*": ["GET"] + } + } + } +} diff --git a/plugins/testdata/test-scheduler/go.mod b/plugins/testdata/test-scheduler/go.mod new file mode 100644 index 000000000..337cc9650 --- /dev/null +++ b/plugins/testdata/test-scheduler/go.mod @@ -0,0 +1,16 @@ +module test-scheduler + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-scheduler/go.sum b/plugins/testdata/test-scheduler/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-scheduler/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-scheduler/main.go b/plugins/testdata/test-scheduler/main.go new file mode 100644 index 000000000..5276f9215 --- /dev/null +++ b/plugins/testdata/test-scheduler/main.go @@ -0,0 +1,40 @@ +// Test scheduler plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-scheduler.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/scheduler" +) + +func init() { + scheduler.Register(&testScheduler{}) +} + +type testScheduler struct{} + +// OnCallback is called when a scheduled task fires. +// Magic payloads trigger specific behaviors to test host functions: +// - "schedule-followup": schedules a one-time task via host function +// - "schedule-recurring": schedules a recurring task via host function +// - "schedule-duplicate:<id>": attempts to schedule with the given ID (for testing duplicate detection) +func (t *testScheduler) OnCallback(input scheduler.SchedulerCallbackRequest) error { + switch { + case input.Payload == "schedule-followup": + if _, err := host.SchedulerScheduleOneTime(1, "followup-created", "followup-id"); err != nil { + return err + } + case input.Payload == "schedule-recurring": + if _, err := host.SchedulerScheduleRecurring("@every 1s", "recurring-created", "recurring-from-plugin"); err != nil { + return err + } + case len(input.Payload) > 19 && input.Payload[:19] == "schedule-duplicate:": + duplicateID := input.Payload[19:] + if _, err := host.SchedulerScheduleOneTime(60, "duplicate-attempt", duplicateID); err != nil { + return err + } + } + return nil +} + +func main() {} diff --git a/plugins/testdata/test-scheduler/manifest.json b/plugins/testdata/test-scheduler/manifest.json new file mode 100644 index 000000000..b001ff2ad --- /dev/null +++ b/plugins/testdata/test-scheduler/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Scheduler", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test scheduler plugin for integration testing", + "permissions": { + "scheduler": { + "reason": "For testing scheduler callbacks" + } + } +} diff --git a/plugins/testdata/test-scrobbler/go.mod b/plugins/testdata/test-scrobbler/go.mod new file mode 100644 index 000000000..b9e2c3887 --- /dev/null +++ b/plugins/testdata/test-scrobbler/go.mod @@ -0,0 +1,16 @@ +module test-scrobbler + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-scrobbler/go.sum b/plugins/testdata/test-scrobbler/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-scrobbler/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-scrobbler/main.go b/plugins/testdata/test-scrobbler/main.go new file mode 100644 index 000000000..a8cee4a4e --- /dev/null +++ b/plugins/testdata/test-scrobbler/main.go @@ -0,0 +1,104 @@ +// Test scrobbler plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-scrobbler.wasm -target wasip1 -buildmode=c-shared ./main.go +package main + +import ( + "fmt" + "strconv" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/scrobbler" +) + +func init() { + scrobbler.Register(&testScrobbler{}) +} + +type testScrobbler struct{} + +// IsAuthorized checks if a user is authorized. +func (t *testScrobbler) IsAuthorized(scrobbler.IsAuthorizedRequest) (bool, error) { + return checkAuthConfig(), nil +} + +// NowPlaying sends a now playing notification. +func (t *testScrobbler) NowPlaying(input scrobbler.NowPlayingRequest) error { + // Check for configured error + if err := checkConfigError(); err != nil { + return err + } + + // Log the now playing (for potential debugging) + artistName := "" + if len(input.Track.Artists) > 0 { + artistName = input.Track.Artists[0].Name + } + pdk.Log(pdk.LogInfo, "NowPlaying: "+input.Track.Title+" by "+artistName) + return nil +} + +// Scrobble submits a scrobble. +func (t *testScrobbler) Scrobble(input scrobbler.ScrobbleRequest) error { + // Check for configured error + if err := checkConfigError(); err != nil { + return err + } + + // Log the scrobble (for potential debugging) + artistName := "" + if len(input.Track.Artists) > 0 { + artistName = input.Track.Artists[0].Name + } + pdk.Log(pdk.LogInfo, "Scrobble: "+input.Track.Title+" by "+artistName) + return nil +} + +// PlaybackReport receives a playback state report. +func (t *testScrobbler) PlaybackReport(input scrobbler.PlaybackReportRequest) error { + if err := checkConfigError(); err != nil { + return err + } + + artistName := "" + if len(input.Track.Artists) > 0 { + artistName = input.Track.Artists[0].Name + } + pdk.Log(pdk.LogInfo, "PlaybackReport: "+input.Track.Title+" by "+artistName+" state="+input.State) + return nil +} + +// checkConfigError checks if the plugin is configured to return an error. +// If "error" config is set, it returns the appropriate ScrobblerError. +// Error types: "not_authorized", "retry_later", "unrecoverable" +func checkConfigError() error { + errMsg, hasErr := pdk.GetConfig("error") + if !hasErr || errMsg == "" { + return nil + } + errType, _ := pdk.GetConfig("error_type") + switch errType { + case scrobbler.ScrobblerErrorNotAuthorized.Error(): + return fmt.Errorf("%w: %s", scrobbler.ScrobblerErrorNotAuthorized, errMsg) + case scrobbler.ScrobblerErrorRetryLater.Error(): + return fmt.Errorf("%w: %s", scrobbler.ScrobblerErrorRetryLater, errMsg) + default: + return fmt.Errorf("%w: %s", scrobbler.ScrobblerErrorUnrecoverable, errMsg) + } +} + +// checkAuthConfig returns whether the plugin is configured to authorize users. +// If "authorized" config is set to "false", users are not authorized. +// Default is true (authorized). +func checkAuthConfig() bool { + authStr, hasAuth := pdk.GetConfig("authorized") + if !hasAuth { + return true // Default: authorized + } + auth, err := strconv.ParseBool(authStr) + if err != nil { + return true // Default on parse error + } + return auth +} + +func main() {} diff --git a/plugins/testdata/test-scrobbler/manifest.json b/plugins/testdata/test-scrobbler/manifest.json new file mode 100644 index 000000000..6a6ec48ed --- /dev/null +++ b/plugins/testdata/test-scrobbler/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Scrobbler", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test scrobbler plugin for integration testing", + "permissions": { + "users": { + "reason": "Receive scrobble events for users assigned to this plugin" + } + } +} diff --git a/plugins/testdata/test-sonic-similarity/go.mod b/plugins/testdata/test-sonic-similarity/go.mod new file mode 100644 index 000000000..6265288f9 --- /dev/null +++ b/plugins/testdata/test-sonic-similarity/go.mod @@ -0,0 +1,16 @@ +module test-sonic-similarity + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-sonic-similarity/go.sum b/plugins/testdata/test-sonic-similarity/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-sonic-similarity/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-sonic-similarity/main.go b/plugins/testdata/test-sonic-similarity/main.go new file mode 100644 index 000000000..e315bff15 --- /dev/null +++ b/plugins/testdata/test-sonic-similarity/main.go @@ -0,0 +1,71 @@ +// Test plugin for Navidrome sonic similarity integration tests. +// Build with: tinygo build -o ../test-sonic-similarity.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "errors" + "strconv" + + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/sonicsimilarity" +) + +func init() { + sonicsimilarity.Register(&testSonicSimilarity{}) +} + +type testSonicSimilarity struct{} + +func checkConfigError() error { + errMsg, hasErr := pdk.GetConfig("error") + if !hasErr || errMsg == "" { + return nil + } + return errors.New(errMsg) +} + +func (t *testSonicSimilarity) GetSonicSimilarTracks(input sonicsimilarity.GetSonicSimilarTracksRequest) (sonicsimilarity.SonicSimilarityResponse, error) { + if err := checkConfigError(); err != nil { + return sonicsimilarity.SonicSimilarityResponse{}, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + matches := make([]sonicsimilarity.SonicMatch, 0, count) + for i := range count { + matches = append(matches, sonicsimilarity.SonicMatch{ + Song: sonicsimilarity.SongRef{ + ID: "similar-track-" + strconv.Itoa(i+1), + Name: "Similar to " + input.Song.Name + " #" + strconv.Itoa(i+1), + Artist: input.Song.Artist, + }, + Similarity: 1.0 - float64(i)*0.1, + }) + } + return sonicsimilarity.SonicSimilarityResponse{Matches: matches}, nil +} + +func (t *testSonicSimilarity) FindSonicPath(input sonicsimilarity.FindSonicPathRequest) (sonicsimilarity.SonicSimilarityResponse, error) { + if err := checkConfigError(); err != nil { + return sonicsimilarity.SonicSimilarityResponse{}, err + } + count := int(input.Count) + if count == 0 { + count = 5 + } + matches := make([]sonicsimilarity.SonicMatch, 0, count) + for i := range count { + matches = append(matches, sonicsimilarity.SonicMatch{ + Song: sonicsimilarity.SongRef{ + ID: "path-track-" + strconv.Itoa(i+1), + Name: "Path " + input.StartSong.Name + " to " + input.EndSong.Name + " #" + strconv.Itoa(i+1), + Artist: input.StartSong.Artist, + }, + Similarity: 1.0 - float64(i)*0.05, + }) + } + return sonicsimilarity.SonicSimilarityResponse{Matches: matches}, nil +} + +func main() {} diff --git a/plugins/testdata/test-sonic-similarity/manifest.json b/plugins/testdata/test-sonic-similarity/manifest.json new file mode 100644 index 000000000..a55c4021f --- /dev/null +++ b/plugins/testdata/test-sonic-similarity/manifest.json @@ -0,0 +1,7 @@ +{ + "name": "Test Sonic Similarity", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin for sonic similarity integration testing", + "capabilities": ["SonicSimilarity"] +} diff --git a/plugins/testdata/test-subsonicapi-plugin/go.mod b/plugins/testdata/test-subsonicapi-plugin/go.mod new file mode 100644 index 000000000..1fb943418 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/go.mod @@ -0,0 +1,16 @@ +module test-subsonicapi-plugin + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-subsonicapi-plugin/go.sum b/plugins/testdata/test-subsonicapi-plugin/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-subsonicapi-plugin/main.go b/plugins/testdata/test-subsonicapi-plugin/main.go new file mode 100644 index 000000000..573036b95 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/main.go @@ -0,0 +1,57 @@ +// Test plugin for SubsonicAPI host function integration tests. +// Build with: tinygo build -o ../test-subsonicapi-plugin.wasm -target wasip1 -buildmode=c-shared ./main.go +package main + +import ( + "fmt" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// call_subsonic_api is the exported function that tests the SubsonicAPI host function. +// Input: URI string (e.g., "/ping?u=testuser") +// Output: The raw JSON response from the Subsonic API +// +//go:wasmexport call_subsonic_api +func callSubsonicAPIExport() int32 { + // Get the URI from input + uri := pdk.InputString() + + // Call the Subsonic API via host function + responseJSON, err := host.SubsonicAPICall(uri) + if err != nil { + pdk.SetErrorString("failed to call SubsonicAPI: " + err.Error()) + return 1 + } + + // Return the response + pdk.OutputString(responseJSON) + return 0 +} + +// call_subsonic_api_raw is the exported function that tests the SubsonicAPI CallRaw host function. +// Input: URI string (e.g., "/getCoverArt?u=testuser&id=al-1") +// Output: JSON with contentType, size, and first bytes of the raw response +// +//go:wasmexport call_subsonic_api_raw +func callSubsonicAPIRawExport() int32 { + uri := pdk.InputString() + + contentType, data, err := host.SubsonicAPICallRaw(uri) + if err != nil { + pdk.SetErrorString("failed to call SubsonicAPI raw: " + err.Error()) + return 1 + } + + // Return metadata about the raw response as JSON + firstByte := 0 + if len(data) > 0 { + firstByte = int(data[0]) + } + result := fmt.Sprintf(`{"contentType":%q,"size":%d,"firstByte":%d}`, contentType, len(data), firstByte) + pdk.OutputString(result) + return 0 +} + +func main() {} diff --git a/plugins/testdata/test-subsonicapi-plugin/manifest.json b/plugins/testdata/test-subsonicapi-plugin/manifest.json new file mode 100644 index 000000000..027e17761 --- /dev/null +++ b/plugins/testdata/test-subsonicapi-plugin/manifest.json @@ -0,0 +1,14 @@ +{ + "name": "Test SubsonicAPI Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "Test plugin for SubsonicAPI host function", + "permissions": { + "subsonicapi": { + "reason": "Testing SubsonicAPI access" + }, + "users": { + "reason": "Access user information for SubsonicAPI authorization" + } + } +} diff --git a/plugins/testdata/test-taskqueue/go.mod b/plugins/testdata/test-taskqueue/go.mod new file mode 100644 index 000000000..37f857e5a --- /dev/null +++ b/plugins/testdata/test-taskqueue/go.mod @@ -0,0 +1,16 @@ +module test-taskqueue + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-taskqueue/go.sum b/plugins/testdata/test-taskqueue/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-taskqueue/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-taskqueue/main.go b/plugins/testdata/test-taskqueue/main.go new file mode 100644 index 000000000..9b734ed67 --- /dev/null +++ b/plugins/testdata/test-taskqueue/main.go @@ -0,0 +1,114 @@ +// Test TaskQueue plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-taskqueue.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "fmt" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/taskworker" +) + +func init() { + taskworker.Register(&handler{}) +} + +type handler struct{} + +func (h *handler) OnTaskExecute(req taskworker.TaskExecuteRequest) (string, error) { + payload := string(req.Payload) + if payload == "fail" { + return "", fmt.Errorf("task failed as instructed") + } + if payload == "fail-then-succeed" && req.Attempt < 2 { + return "", fmt.Errorf("transient failure") + } + return "completed successfully", nil +} + +// Test helper types +type TestInput struct { + Operation string `json:"operation"` + QueueName string `json:"queueName,omitempty"` + Config *host.QueueConfig `json:"config,omitempty"` + Payload []byte `json:"payload,omitempty"` + TaskID string `json:"taskId,omitempty"` +} + +type TestOutput struct { + TaskID string `json:"taskId,omitempty"` + Status string `json:"status,omitempty"` + Message string `json:"message,omitempty"` + Attempt int32 `json:"attempt,omitempty"` + Cleared int64 `json:"cleared,omitempty"` + Error *string `json:"error,omitempty"` +} + +//go:wasmexport nd_test_taskqueue +func ndTestTaskQueue() int32 { + var input TestInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "create_queue": + config := host.QueueConfig{} + if input.Config != nil { + config = *input.Config + } + err := host.TaskCreateQueue(input.QueueName, config) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{}) + + case "enqueue": + taskID, err := host.TaskEnqueue(input.QueueName, input.Payload) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{TaskID: taskID}) + + case "get_task_status": + info, err := host.TaskGet(input.TaskID) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{Status: info.Status, Message: info.Message, Attempt: info.Attempt}) + + case "cancel_task": + err := host.TaskCancel(input.TaskID) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{}) + + case "clear_queue": + cleared, err := host.TaskClearQueue(input.QueueName) + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestOutput{Cleared: cleared}) + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestOutput{Error: &errStr}) + } + return 0 +} + +func main() {} diff --git a/plugins/testdata/test-taskqueue/manifest.json b/plugins/testdata/test-taskqueue/manifest.json new file mode 100644 index 000000000..3cd3b0f0b --- /dev/null +++ b/plugins/testdata/test-taskqueue/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test TaskQueue Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test plugin for TaskQueue integration testing", + "permissions": { + "taskqueue": { + "reason": "For testing task queue operations", + "maxConcurrency": 10 + } + } +} diff --git a/plugins/testdata/test-users/go.mod b/plugins/testdata/test-users/go.mod new file mode 100644 index 000000000..973f29c9c --- /dev/null +++ b/plugins/testdata/test-users/go.mod @@ -0,0 +1,16 @@ +module test-users + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-users/go.sum b/plugins/testdata/test-users/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-users/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-users/main.go b/plugins/testdata/test-users/main.go new file mode 100644 index 000000000..08d07b360 --- /dev/null +++ b/plugins/testdata/test-users/main.go @@ -0,0 +1,61 @@ +// Test Users plugin for Navidrome plugin system integration tests. +// This plugin tests user metadata access via the Users host service. +// Build with: tinygo build -o ../test-users.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" +) + +// TestUsersInput is the input for nd_test_users callback. +type TestUsersInput struct { + Operation string `json:"operation"` // "get_users", "get_admins" +} + +// TestUsersOutput is the output from nd_test_users callback. +type TestUsersOutput struct { + Users []host.User `json:"users,omitempty"` + Error *string `json:"error,omitempty"` +} + +// nd_test_users is the test callback that tests the users host functions. +// +//go:wasmexport nd_test_users +func ndTestUsers() int32 { + var input TestUsersInput + if err := pdk.InputJSON(&input); err != nil { + errStr := err.Error() + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } + + switch input.Operation { + case "get_users": + users, err := host.UsersGetUsers() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestUsersOutput{Users: users}) + return 0 + + case "get_admins": + admins, err := host.UsersGetAdmins() + if err != nil { + errStr := err.Error() + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } + pdk.OutputJSON(TestUsersOutput{Users: admins}) + return 0 + + default: + errStr := "unknown operation: " + input.Operation + pdk.OutputJSON(TestUsersOutput{Error: &errStr}) + return 0 + } +} + +func main() {} diff --git a/plugins/testdata/test-users/manifest.json b/plugins/testdata/test-users/manifest.json new file mode 100644 index 000000000..787260785 --- /dev/null +++ b/plugins/testdata/test-users/manifest.json @@ -0,0 +1,11 @@ +{ + "name": "Test Users Plugin", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test users plugin for integration testing", + "permissions": { + "users": { + "reason": "For testing user metadata access" + } + } +} diff --git a/plugins/testdata/test-websocket/go.mod b/plugins/testdata/test-websocket/go.mod new file mode 100644 index 000000000..f786b8658 --- /dev/null +++ b/plugins/testdata/test-websocket/go.mod @@ -0,0 +1,16 @@ +module test-websocket + +go 1.25 + +require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0 + +require ( + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/extism/go-pdk v1.1.3 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/stretchr/objx v0.5.2 // indirect + github.com/stretchr/testify v1.11.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go diff --git a/plugins/testdata/test-websocket/go.sum b/plugins/testdata/test-websocket/go.sum new file mode 100644 index 000000000..af880eb51 --- /dev/null +++ b/plugins/testdata/test-websocket/go.sum @@ -0,0 +1,14 @@ +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/extism/go-pdk v1.1.3 h1:hfViMPWrqjN6u67cIYRALZTZLk/enSPpNKa+rZ9X2SQ= +github.com/extism/go-pdk v1.1.3/go.mod h1:Gz+LIU/YCKnKXhgge8yo5Yu1F/lbv7KtKFkiCSzW/P4= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/testdata/test-websocket/main.go b/plugins/testdata/test-websocket/main.go new file mode 100644 index 000000000..270f36a11 --- /dev/null +++ b/plugins/testdata/test-websocket/main.go @@ -0,0 +1,80 @@ +// Test WebSocket plugin for Navidrome plugin system integration tests. +// Build with: tinygo build -o ../test-websocket.wasm -target wasip1 -buildmode=c-shared . +package main + +import ( + "encoding/base64" + "errors" + + "github.com/navidrome/navidrome/plugins/pdk/go/host" + "github.com/navidrome/navidrome/plugins/pdk/go/pdk" + "github.com/navidrome/navidrome/plugins/pdk/go/websocket" +) + +func init() { + websocket.Register(&testWebSocket{}) +} + +type testWebSocket struct{} + +// OnTextMessage is called when a text message is received. +// Magic messages trigger specific behaviors to test host functions: +// - "echo": sends back the same message using SendText host function +// - "close": closes the connection using CloseConnection host function +// - "store:MESSAGE": stores MESSAGE in plugin config for later retrieval +// - "fail": returns an error to test error handling +func (t *testWebSocket) OnTextMessage(input websocket.OnTextMessageRequest) error { + // Store all received messages for test verification + storeReceivedMessage("text:" + input.Message) + + switch input.Message { + case "echo": + if err := host.WebSocketSendText(input.ConnectionID, "echo:"+input.Message); err != nil { + return err + } + + case "close": + if err := host.WebSocketCloseConnection(input.ConnectionID, 1000, "closed by plugin"); err != nil { + return err + } + + case "fail": + return errors.New("intentional test failure") + } + + return nil +} + +// OnBinaryMessage is called when a binary message is received. +// Echoes the data back as a binary message so tests can observe the callback fired. +func (t *testWebSocket) OnBinaryMessage(input websocket.OnBinaryMessageRequest) error { + encoded := base64.StdEncoding.EncodeToString(input.Data) + storeReceivedMessage("binary:" + encoded) + return host.WebSocketSendBinary(input.ConnectionID, input.Data) +} + +// OnError is called when an error occurs on a WebSocket connection. +func (t *testWebSocket) OnError(input websocket.OnErrorRequest) error { + // Store error for test verification + storeReceivedMessage("error:" + input.Error) + return nil +} + +// OnClose is called when a WebSocket connection is closed. +func (t *testWebSocket) OnClose(input websocket.OnCloseRequest) error { + // Store close event for test verification + storeReceivedMessage("close:" + input.Reason) + return nil +} + +// storeReceivedMessage stores messages in plugin variable storage for test verification. +// Messages are appended to an existing list. +func storeReceivedMessage(msg string) { + // Use Extism var storage for plugin state + if existingVar := pdk.GetVar("_received_messages"); existingVar != nil { + msg = string(existingVar) + "\n" + msg + } + pdk.SetVar("_received_messages", []byte(msg)) +} + +func main() {} diff --git a/plugins/testdata/test-websocket/manifest.json b/plugins/testdata/test-websocket/manifest.json new file mode 100644 index 000000000..0ac756470 --- /dev/null +++ b/plugins/testdata/test-websocket/manifest.json @@ -0,0 +1,12 @@ +{ + "name": "Test WebSocket", + "author": "Navidrome Test", + "version": "1.0.0", + "description": "A test WebSocket plugin for integration testing", + "permissions": { + "websocket": { + "reason": "For testing WebSocket callbacks", + "requiredHosts": ["*.example.com", "localhost:*", "echo.websocket.org"] + } + } +} diff --git a/reflex.conf b/reflex.conf index 2eb4d131c..47dd775ab 100644 --- a/reflex.conf +++ b/reflex.conf @@ -1 +1 @@ --s -r "(\.go$$|\.cpp$$|\.h$$|navidrome.toml|resources|token_received.html)" -R "(^ui|^data|^db/migrations)" -- go run -race -tags netgo . +-s -r "(\.go$$|\.cpp$$|\.h$$|navidrome.toml|resources|token_received.html)" -R "(^ui|^data|^db/migrations)" -R "_test\.go$$" -- go run -race -tags netgo,sqlite_fts5 . diff --git a/release/goreleaser.yml b/release/goreleaser.yml index 1a420c927..e5035adda 100644 --- a/release/goreleaser.yml +++ b/release/goreleaser.yml @@ -19,13 +19,15 @@ builds: - linux_arm_v6 - linux_arm_v7 - linux_arm64 + - linux_riscv64 - windows_386 - windows_amd64 archives: - format_overrides: - goos: windows - format: zip + formats: + - zip name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}{{ . }}{{ end }}{{ with .Mips }}_{{ . }}{{ end }}{{ if not (eq .Amd64 "v1") }}{{ .Amd64 }}{{ end }}' checksum: @@ -82,6 +84,15 @@ nfpms: owner: navidrome group: navidrome + - src: release/linux/.package.rpm # contents: "rpm" + dst: /var/lib/navidrome/.package + type: "config|noreplace" + packager: rpm + - src: release/linux/.package.deb # contents: "deb" + dst: /var/lib/navidrome/.package + type: "config|noreplace" + packager: deb + scripts: preinstall: "release/linux/preinstall.sh" postinstall: "release/linux/postinstall.sh" diff --git a/release/linux/.package.deb b/release/linux/.package.deb new file mode 100644 index 000000000..811c85f42 --- /dev/null +++ b/release/linux/.package.deb @@ -0,0 +1 @@ +deb \ No newline at end of file diff --git a/release/linux/.package.rpm b/release/linux/.package.rpm new file mode 100644 index 000000000..7c88ef3c0 --- /dev/null +++ b/release/linux/.package.rpm @@ -0,0 +1 @@ +rpm \ No newline at end of file diff --git a/release/linux/postinstall.sh b/release/linux/postinstall.sh index 65f1d208d..ed39fb127 100644 --- a/release/linux/postinstall.sh +++ b/release/linux/postinstall.sh @@ -4,7 +4,7 @@ # the package manager (in particular, deb) thinks that the file exists, while it is # no longer on disk. Specifically, doing a `rm /etc/navidrome/navidrome.toml` # without something like `apt purge navidrome` will result in the system believing that -# the file still exists. In this case, during isntall it will NOT extract the configuration +# the file still exists. In this case, during install it will NOT extract the configuration # file (as to not override it). Since `navidrome service install` depends on this file existing, # we will create it with the defaults anyway. if [ ! -f /etc/navidrome/navidrome.toml ]; then @@ -23,6 +23,8 @@ if [ ! -f "$postinstall_flag" ]; then # and not by root chown navidrome:navidrome /var/lib/navidrome/cache touch "$postinstall_flag" +else + navidrome service stop --configfile /etc/navidrome/navidrome.toml && navidrome service start --configfile /etc/navidrome/navidrome.toml fi diff --git a/release/wix/build_msi.sh b/release/wix/build_msi.sh index 9fc008446..a8781a965 100755 --- a/release/wix/build_msi.sh +++ b/release/wix/build_msi.sh @@ -43,12 +43,16 @@ FFMPEG_FILE="ffmpeg-n${FFMPEG_VERSION}-latest-${WIN_ARCH}-gpl-${FFMPEG_VERSION}" wget --quiet --output-document="${DOWNLOAD_FOLDER}/ffmpeg.zip" \ "https://github.com/${FFMPEG_REPOSITORY}/releases/download/latest/${FFMPEG_FILE}.zip" rm -rf "${DOWNLOAD_FOLDER}/extracted_ffmpeg" -unzip -d "${DOWNLOAD_FOLDER}/extracted_ffmpeg" "${DOWNLOAD_FOLDER}/ffmpeg.zip" "*/ffmpeg.exe" +unzip -d "${DOWNLOAD_FOLDER}/extracted_ffmpeg" "${DOWNLOAD_FOLDER}/ffmpeg.zip" "*/ffmpeg.exe" "*/ffprobe.exe" cp "${DOWNLOAD_FOLDER}"/extracted_ffmpeg/${FFMPEG_FILE}/bin/ffmpeg.exe "$MSI_OUTPUT_DIR" +cp "${DOWNLOAD_FOLDER}"/extracted_ffmpeg/${FFMPEG_FILE}/bin/ffprobe.exe "$MSI_OUTPUT_DIR" cp "$WORKSPACE"/LICENSE "$WORKSPACE"/README.md "$MSI_OUTPUT_DIR" cp "$BINARY" "$MSI_OUTPUT_DIR" +# package type indicator file +echo "msi" > "$MSI_OUTPUT_DIR/.package" + # workaround for wixl WixVariable not working to override bmp locations cp "$WORKSPACE"/release/wix/bmp/banner.bmp /usr/share/wixl-*/ext/ui/bitmaps/bannrbmp.bmp cp "$WORKSPACE"/release/wix/bmp/dialogue.bmp /usr/share/wixl-*/ext/ui/bitmaps/dlgbmp.bmp diff --git a/release/wix/navidrome.wxs b/release/wix/navidrome.wxs index ec8b164e8..6d94bab9d 100644 --- a/release/wix/navidrome.wxs +++ b/release/wix/navidrome.wxs @@ -67,8 +67,18 @@ <File Id='ffmpeg.exe' Name='ffmpeg.exe' DiskId='1' Source='ffmpeg.exe' KeyPath='yes' /> </Component> + <Component Id='FFProbeExecutable' Guid='f8a3b2c1-5d4e-4f6a-9b8c-7e2d1a0f3c5b' Win64="$(var.Win64)"> + <File Id='ffprobe.exe' Name='ffprobe.exe' DiskId='1' Source='ffprobe.exe' KeyPath='yes' /> + </Component> + </Directory> </Directory> + + <Directory Id="ND_DATAFOLDER" name="[ND_DATAFOLDER]"> + <Component Id='PackageFile' Guid='9eec0697-803c-4629-858f-20dc376c960b' Win64="$(var.Win64)"> + <File Id='package' Name='.package' DiskId='1' Source='.package' KeyPath='no' /> + </Component> + </Directory> </Directory> <InstallUISequence> @@ -81,6 +91,8 @@ <ComponentRef Id='Configuration'/> <ComponentRef Id='MainExecutable' /> <ComponentRef Id='FFMpegExecutable' /> + <ComponentRef Id='FFProbeExecutable' /> + <ComponentRef Id='PackageFile' /> </Feature> </Product> </Wix> diff --git a/resources/embed.go b/resources/embed.go index 0386e6f79..040bb5d84 100644 --- a/resources/embed.go +++ b/resources/embed.go @@ -16,6 +16,6 @@ var embedFS embed.FS func FS() fs.FS { return merge.FS{ Base: embedFS, - Overlay: os.DirFS(path.Join(conf.Server.DataFolder, "resources")), + Overlay: os.DirFS(path.Join(conf.Server.DataFolder.String(), "resources")), } } diff --git a/resources/i18n/bg.json b/resources/i18n/bg.json index ea97d1d1b..7a0281f33 100644 --- a/resources/i18n/bg.json +++ b/resources/i18n/bg.json @@ -1,460 +1,715 @@ { - "languageName": "Български", - "resources": { - "song": { - "name": "Песен |||| Песни", - "fields": { - "albumArtist": "Изпълнител албум", - "duration": "Време", - "trackNumber": "#", - "playCount": "Пускания", - "title": "Заглавие", - "artist": "Изпълнител", - "album": "Албум", - "path": "Път до файл", - "genre": "Жанр", - "compilation": "Компилация", - "year": "Година", - "size": "Размер на файла", - "updatedAt": "Актуализирана", - "bitRate": "Битрейт", - "discSubtitle": "Субтитри на диска", - "starred": "Любима", - "comment": "Коментар", - "rating": "Рейтинг", - "quality": "Качество", - "bpm": "BPM", - "playDate": "Последно слушана", - "channels": "Канала", - "createdAt": "Добавено на" - }, - "actions": { - "addToQueue": "Пусни по-късно", - "playNow": "Пусни сега", - "addToPlaylist": "Добави към плейлист", - "shuffleAll": "Разбъркай всички", - "download": "Свали", - "playNext": "Следваща", - "info": "Информация" - } - }, - "album": { - "name": "Албум |||| Албуми", - "fields": { - "albumArtist": "Изпълнител албум", - "artist": "Изпълнител", - "duration": "Време", - "songCount": "Песни", - "playCount": "Пускания", - "name": "Име", - "genre": "Жанр", - "compilation": "Компилация", - "year": "Година", - "updatedAt": "Актуализиран", - "comment": "Коментар", - "rating": "Рейтинг", - "createdAt": "Добавено на", - "size": "Размер", - "originalDate": "Оригинал", - "releaseDate": "Издаден", - "releases": "Издание |||| Издания", - "released": "Издаден" - }, - "actions": { - "playAll": "Пусни", - "playNext": "Пусни следваща", - "addToQueue": "Пусни по-късно", - "shuffle": "Разбъркай", - "addToPlaylist": "Добави към плейлист", - "download": "Свали", - "info": "Информация", - "share": "Сподели" - }, - "lists": { - "all": "Всички", - "random": "Случайни", - "recentlyAdded": "Последно добавени", - "recentlyPlayed": "Последно слушани", - "mostPlayed": "Най-слушани", - "starred": "Любими", - "topRated": "Най-висок рейтинг" - } - }, - "artist": { - "name": "Изпълнител |||| Изпълнители", - "fields": { - "name": "Име", - "albumCount": "Брой албуми", - "songCount": "Брой песни", - "playCount": "Пускания", - "rating": "Рейтинг", - "genre": "Жанр", - "size": "Размер" - } - }, - "user": { - "name": "Потребител |||| Потребители", - "fields": { - "userName": "Потребителско име", - "isAdmin": "Администратор", - "lastLoginAt": "Последен вход", - "updatedAt": "Актуализиран", - "name": "Име", - "password": "Парола", - "createdAt": "Създаден на", - "changePassword": "Промяна на паролата?", - "currentPassword": "Текуща парола", - "newPassword": "Нова парола", - "token": "Токен" - }, - "helperTexts": { - "name": "Промените в името ще бъдат отразени при следващото влизане" - }, - "notifications": { - "created": "Потребителят е създаден", - "updated": "Потребителят е актуализиран", - "deleted": "Потребителят е изтрит" - }, - "message": { - "listenBrainzToken": "Въведете Вашия токен за ListenBrainz.", - "clickHereForToken": "Кликнете тук, за да получите Вашия токен" - } - }, - "player": { - "name": "Плейър |||| Плейъри", - "fields": { - "name": "Име", - "transcodingId": "Транскодиране", - "maxBitRate": "Макс. битрейт", - "client": "Клиент", - "userName": "Потребителско име", - "lastSeen": "Последно видян", - "reportRealPath": "Докладвай реален път", - "scrobbleEnabled": "Изпрати Scrobbles към външни услуги" - } - }, - "transcoding": { - "name": "Транскодиране |||| Транскодинг", - "fields": { - "name": "Име", - "targetFormat": "Целеви формат", - "defaultBitRate": "Битрейт по подразбиране", - "command": "Команда" - } - }, - "playlist": { - "name": "Плейлист |||| Плейлисти", - "fields": { - "name": "Име", - "duration": "Продължителност", - "ownerName": "Собственик", - "public": "Публичен", - "updatedAt": "Актуализиран", - "createdAt": "Създаден на", - "songCount": "Песни", - "comment": "Коментар", - "sync": "Автоматично импортиране", - "path": "Импортиране от" - }, - "actions": { - "selectPlaylist": "Изберете плейлист:", - "addNewPlaylist": "Създай \"%{name}\"", - "export": "Експорт", - "makePublic": "Направи публичен", - "makePrivate": "Направи личен" - }, - "message": { - "duplicate_song": "Добави дублирани песни", - "song_exist": "Към плейлиста се добавят дублиращи. Желаете ли да ги добавите или предпочитате да ги пропуснете?" - } - }, - "radio": { - "name": "Радиостанция |||| Радиостанции", - "fields": { - "name": "Име", - "streamUrl": "Стрийм адрес", - "homePageUrl": "Начална страница адрес", - "updatedAt": "Актуализиранa на", - "createdAt": "Създаденa на" - }, - "actions": { - "playNow": "Възпроизвеждане сега" - } - }, - "share": { - "name": "Сподели |||| Споделени", - "fields": { - "username": "Споделено от", - "url": "Адрес", - "description": "Описание", - "contents": "Съдържание", - "expiresAt": "Изтича", - "lastVisitedAt": "Последно посетен", - "visitCount": "Посещения", - "format": "Формат", - "maxBitRate": "Макс. Bit Rate", - "updatedAt": "Актуализирана на", - "createdAt": "Създадена на", - "downloadable": "Разреши изтегляния?" - } - } + "languageName": "Български", + "resources": { + "song": { + "name": "Песен |||| Песни", + "fields": { + "albumArtist": "Изпълнител албум", + "duration": "Време", + "trackNumber": "#", + "playCount": "Пускания", + "title": "Заглавие", + "artist": "Изпълнител", + "album": "Албум", + "path": "Път до файл", + "genre": "Жанр", + "compilation": "Компилация", + "year": "Година", + "size": "Размер на файла", + "updatedAt": "Актуализирана", + "bitRate": "Битрейт", + "discSubtitle": "Субтитри на диска", + "starred": "Любима", + "comment": "Коментар", + "rating": "Рейтинг", + "quality": "Качество", + "bpm": "BPM", + "playDate": "Последно слушана", + "channels": "Канала", + "createdAt": "Добавено на", + "grouping": "Групиране", + "mood": "Настроение", + "participants": "Допълнителни участници", + "tags": "Допълнителни етикети", + "mappedTags": "Картирани тагове", + "rawTags": "Сурови тагове", + "bitDepth": "Битова дълбочина", + "sampleRate": "Честота на семплиране", + "missing": "Липсва", + "libraryName": "Библиотека", + "composer": "Композитор", + "disc": "" + }, + "actions": { + "addToQueue": "Пусни по-късно", + "playNow": "Пусни сега", + "addToPlaylist": "Добави към плейлист", + "shuffleAll": "Разбъркай всички", + "download": "Свали", + "playNext": "Следваща", + "info": "Информация", + "showInPlaylist": "Показване в плейлиста", + "instantMix": "Незабавен микс" + } }, - "ra": { - "auth": { - "welcome1": "Благодаря, че инсталирахте Navidrome!", - "welcome2": "За да започнете, създайте администраторски профил", - "confirmPassword": "Потвърдете паролата", - "buttonCreateAdmin": "Създaй администратор", - "auth_check_error": "Моля, влезте за да продължите", - "user_menu": "Профил", - "username": "Потребителско име", - "password": "Парола", - "sign_in": "Вход", - "sign_in_error": "Грешка при удостоверяването. Моля, опитайте отново", - "logout": "Изход" - }, - "validation": { - "invalidChars": "Моля, използвайте само букви и цифри", - "passwordDoesNotMatch": "Паролата не съвпада", - "required": "Задължително", - "minLength": "Трябва да съдържа поне %{min} знака", - "maxLength": "Трябва да съдържа %{max} знака или по-малко", - "minValue": "Трябва да е поне %{min}", - "maxValue": "Трябва да бъде %{max} или по-малко", - "number": "Трябва да е число", - "email": "Трябва да е валиден имейл", - "oneOf": "Трябва да е едно от: %{options}", - "regex": "Трябва да съответства на конкретен формат (regexp): %{pattern}", - "unique": "Трябва да е уникално", - "url": "Трябва да бъде валиден адрес" - }, - "action": { - "add_filter": "Добави филтър", - "add": "Добави", - "back": "Назад", - "bulk_actions": "Избран е 1 елемент |||| Избрани са %{smart_count} елемента", - "cancel": "Отмени", - "clear_input_value": "Изчисти въведеното", - "clone": "Клонирай", - "confirm": "Потвърди", - "create": "Създай", - "delete": "Изтрий", - "edit": "Редактирай", - "export": "Експорт", - "list": "Списък", - "refresh": "Обнови", - "remove_filter": "Премахни този филтър", - "remove": "Премахни", - "save": "Запази", - "search": "Търси", - "show": "Покажи", - "sort": "Сортирай", - "undo": "Отмени", - "expand": "Разгърни", - "close": "Затвори", - "open_menu": "Отвори меню", - "close_menu": "Затвори меню", - "unselect": "Премахни избора", - "skip": "Пропусни", - "bulk_actions_mobile": "1 |||| %{smart_count}", - "share": "Споделяне", - "download": "Сваляне" - }, - "boolean": { - "true": "Да", - "false": "Не" - }, - "page": { - "create": "Създаване на %{name}", - "dashboard": "Табло", - "edit": "%{name} #%{id}", - "error": "Нещо се обърка", - "list": "%{name}", - "loading": "Зареждане", - "not_found": "Не е намерен", - "show": "%{name} #%{id}", - "empty": "Все още няма %{name}.", - "invite": "Желаете ли да добавите?" - }, - "input": { - "file": { - "upload_several": "Пуснете файл за да качите, или кликнете за да изберете.", - "upload_single": "Пуснете файл за да качите, или кликнете за да изберете." - }, - "image": { - "upload_several": "Пуснете снимки за качване, или кликнете, за да изберете.", - "upload_single": "Пуснете снимка за качване, или кликнете за да изберете." - }, - "references": { - "all_missing": "Не намирам свързаните данни.", - "many_missing": "Изглежда, че поне една от свързаните препратки, вече не е налична.", - "single_missing": "Изглежда, че връзката вече не е налична." - }, - "password": { - "toggle_visible": "Скрий паролата", - "toggle_hidden": "Покажи паролата" - } - }, - "message": { - "about": "Относно", - "are_you_sure": "Сигурни ли сте?", - "bulk_delete_content": "Наистина ли желаете да изтриете това %{name}? |||| Наистина ли желаете да изтриете тези %{smart_count} елементи?", - "bulk_delete_title": "Изтрий %{name} |||| Изтрий %{smart_count} %{name}", - "delete_content": "Наистина ли желаете да изтриете този елемент?", - "delete_title": "Изтрий %{name} #%{id}", - "details": "Описание", - "error": "Възникна грешка с клиента и заявката Ви не може да бъде изпълнена.", - "invalid_form": "Формата не е валидна. Моля, проверете за грешки", - "loading": "Страницата се зарежда, моля изчакайте", - "no": "Не", - "not_found": "Или сте въвели грешен URL адрес, или сте следвали грешна връзка.", - "yes": "Да", - "unsaved_changes": "Някои от промените не бяха запазени. Сигурни ли сте, че желаете да ги игнорирате?" - }, - "navigation": { - "no_results": "Няма намерени резултати", - "no_more_results": "Страница %{page} е извън границите. Опитайте предишната страница.", - "page_out_of_boundaries": "Страница %{page} е извън границите", - "page_out_from_end": "Не може да отидете след последната страница", - "page_out_from_begin": "Не може да се премине преди страница 1", - "page_range_info": "%{offsetBegin}-%{offsetEnd} от %{total}", - "page_rows_per_page": "Елемента на страница:", - "next": "Следваща", - "prev": "Предишна", - "skip_nav": "Премини към съдържанието" - }, - "notification": { - "updated": "Елементът е актуализиран |||| %{smart_count} елемента са актуализирани", - "created": "Елементът е създаден", - "deleted": "Елементът е изтрит |||| %{smart_count} елемента са изтрити", - "bad_item": "Неправилен елемент", - "item_doesnt_exist": "Елементът не съществува", - "http_error": "Грешка в комуникацията със сървъра", - "data_provider_error": "Грешка в доставчика на данни. Проверете конзолата за подробности.", - "i18n_error": "Не мога да заредя преводите за посочения език", - "canceled": "Действието е отменено", - "logged_out": "Вашата сесия приключи. Моля, влезте отново.", - "new_version": "Налична е нова версия! Моля, опреснете този прозорец." - }, - "toggleFieldsMenu": { - "columnsToDisplay": "Колони за показване", - "layout": "Оформление", - "grid": "Решетка", - "table": "Таблица" - } + "album": { + "name": "Албум |||| Албуми", + "fields": { + "albumArtist": "Изпълнител албум", + "artist": "Изпълнител", + "duration": "Време", + "songCount": "Песни", + "playCount": "Пускания", + "name": "Име", + "genre": "Жанр", + "compilation": "Компилация", + "year": "Година", + "updatedAt": "Актуализиран", + "comment": "Коментар", + "rating": "Рейтинг", + "createdAt": "Добавено на", + "size": "Размер", + "originalDate": "Оригинал", + "releaseDate": "Издаден", + "releases": "Издание |||| Издания", + "released": "Издаден", + "recordLabel": "Лейбъл", + "catalogNum": "Каталожен номер", + "releaseType": "Тип", + "grouping": "Групиране", + "media": "Медия", + "mood": "Настроение", + "date": "Дата на запис", + "missing": "Липсва", + "libraryName": "Библиотека" + }, + "actions": { + "playAll": "Пусни", + "playNext": "Пусни следваща", + "addToQueue": "Пусни по-късно", + "shuffle": "Разбъркай", + "addToPlaylist": "Добави към плейлист", + "download": "Свали", + "info": "Информация", + "share": "Сподели" + }, + "lists": { + "all": "Всички", + "random": "Случайни", + "recentlyAdded": "Последно добавени", + "recentlyPlayed": "Последно слушани", + "mostPlayed": "Най-слушани", + "starred": "Любими", + "topRated": "Най-висок рейтинг" + } }, - "message": { - "note": "ЗАБЕЛЕЖКА", - "transcodingDisabled": "Промяната на конфигурацията за транскодиране през уеб интерфейса е забранена от съображения за сигурност. Ако желаете да промените (редактирате или добавите) опциите за транскодиране, рестартирайте сървъра с конфигурационната опция %{config}.", - "transcodingEnabled": "Navidrome в момента работи с %{config}, което прави възможно стартирането на системни команди от настройките за транскодиране с помощта на уеб интерфейса. Препоръчваме да го деактивирате от съображения за сигурност и да го активирате само при конфигуриране на опциите за транскодиране.", - "songsAddedToPlaylist": "Добавена 1 песен към плейлиста |||| Добавени %{smart_count} песни към плейлиста", - "noPlaylistsAvailable": "Няма налични", - "delete_user_title": "Изтрий потребителя '%{name}'", - "delete_user_content": "Наистина ли желаете да изтриете този потребител и всичките му данни (включително плейлисти и предпочитания)?", - "notifications_blocked": "В настройките на браузъра сте блокирали известията за този сайт", - "notifications_not_available": "Този браузър не поддържа известия на работния плот или нямате достъп до Navidrome през https", - "lastfmLinkSuccess": "Връзката с Last.fm е успешна! Scrobbling е активиран", - "lastfmLinkFailure": "Last.fm не можа да бъде свързан", - "lastfmUnlinkSuccess": "Връзката с Last.fm е прекъсната! Scrobbling е деактивиран", - "lastfmUnlinkFailure": "Last.fm връзката не можа да бъде премахната", - "openIn": { - "lastfm": "Отвори в Last.fm", - "musicbrainz": "Отвори в MusicBrainz" - }, - "lastfmLink": "Прочетете още...", - "listenBrainzLinkSuccess": "Връзката с ListenBrainz е успешна! Scrobbling е активиран от името на потребителя: %{user}", - "listenBrainzLinkFailure": "ListenBrainz не можа да бъде свързан: %{error}", - "listenBrainzUnlinkSuccess": "Връзката с ListenBrainz е прекъсната! Scrobbling е деактивиран", - "listenBrainzUnlinkFailure": "Връзката с ListenBrainz не можа да бъде прекратена", - "downloadOriginalFormat": "Свали в оригиналния формат", - "shareOriginalFormat": "Сподели в оригинален формат", - "shareDialogTitle": "Сподели %{resource} '%{name}'", - "shareBatchDialogTitle": "Сподели 1 %{resource} |||| Сподели %{smart_count} %{resource}", - "shareSuccess": "Адресът е копиран в клипборда: %{url}", - "shareFailure": "Грешка при копиране на адрес %{url} в клипборда", - "downloadDialogTitle": "Сваляне %{resource} '%{name}' (%{size})", - "shareCopyToClipboard": "Копиране в клипборда: Ctrl+C, Enter" + "artist": { + "name": "Изпълнител |||| Изпълнители", + "fields": { + "name": "Име", + "albumCount": "Брой албуми", + "songCount": "Брой песни", + "playCount": "Пускания", + "rating": "Рейтинг", + "genre": "Жанр", + "size": "Размер", + "role": "Роля", + "missing": "Липсва" + }, + "roles": { + "albumartist": "Изпълнител на албума |||| Изпълнители на албума", + "artist": "Изпълнител |||| Изпълнители", + "composer": "Композитор |||| Композитори", + "conductor": "Диригент |||| Диригенти", + "lyricist": "Текстописец |||| Текстописци", + "arranger": "Аранжор |||| Аранжори", + "producer": "Продуцент |||| Продуценти", + "director": "Директор |||| Директори", + "engineer": "Инженер |||| Инженери", + "mixer": "Миксер |||| Миксери", + "remixer": "Ремиксер |||| Ремиксери", + "djmixer": "DJ миксер |||| DJ миксери", + "performer": "Изпълнител |||| Изпълнители", + "maincredit": "Изпълнител на албума или изпълнител |||| Изпълнители на албума или изпълнители" + }, + "actions": { + "shuffle": "Разбъркване", + "radio": "Радио", + "topSongs": "Топ песни" + } }, - "menu": { - "library": "Библиотека", - "settings": "Настройки", - "version": "Версия", - "theme": "Тема", - "personal": { - "name": "Лични", - "options": { - "theme": "Тема", - "language": "Език", - "defaultView": "Изглед по подразбиране", - "desktop_notifications": "Известия на работния плот", - "lastfmScrobbling": "Scrobble към Last.fm", - "listenBrainzScrobbling": "Scrobble към ListenBrainz", - "replaygain": "Режим ReplayGain", - "preAmp": "ReplayGain PreAmp (dB)", - "gain": { - "none": "Изключен", - "album": "Използвай Album Gain", - "track": "Използвай Track Gain" - } - } - }, - "albumList": "Албуми", - "about": "Относно", - "playlists": "Плейлисти", - "sharedPlaylists": "Споделени плейлисти" + "user": { + "name": "Потребител |||| Потребители", + "fields": { + "userName": "Потребителско име", + "isAdmin": "Администратор", + "lastLoginAt": "Последен вход", + "updatedAt": "Актуализиран", + "name": "Име", + "password": "Парола", + "createdAt": "Създаден на", + "changePassword": "Промяна на паролата?", + "currentPassword": "Текуща парола", + "newPassword": "Нова парола", + "token": "Токен", + "lastAccessAt": "Последен достъп", + "libraries": "Библиотеки" + }, + "helperTexts": { + "name": "Промените в името ще бъдат отразени при следващото влизане", + "libraries": "Изберете конкретни библиотеки за този потребител или оставете празно, за да използвате библиотеки по подразбиране" + }, + "notifications": { + "created": "Потребителят е създаден", + "updated": "Потребителят е актуализиран", + "deleted": "Потребителят е изтрит" + }, + "message": { + "listenBrainzToken": "Въведете Вашия токен за ListenBrainz.", + "clickHereForToken": "Кликнете тук, за да получите Вашия токен", + "selectAllLibraries": "Изберете всички библиотеки", + "adminAutoLibraries": "Администраторите автоматично получават достъп до всички библиотеки" + }, + "validation": { + "librariesRequired": "Трябва да бъде избрана поне една библиотека за потребители без администраторски права" + } }, "player": { - "playListsText": "Списък с песни", - "openText": "Отвори", - "closeText": "Затвори", - "notContentText": "Няма песни", - "clickToPlayText": "Пускане", - "clickToPauseText": "Пауза", - "nextTrackText": "Следваща песен", - "previousTrackText": "Предишна песен", - "reloadText": "Презареди", - "volumeText": "Сила на звука", - "toggleLyricText": "Текст на песен", - "toggleMiniModeText": "Минимизирай", - "destroyText": "Унищожи", - "downloadText": "Свали", - "removeAudioListsText": "Изтриване на плейлисти", - "clickToDeleteText": "Кликнете, за да изтриете %{name}", - "emptyLyricText": "Няма текст", - "playModeText": { - "order": "По ред", - "orderLoop": "Повтаряй всички", - "singleLoop": "Повтаряй същата", - "shufflePlay": "Разбъркай" - } + "name": "Плейър |||| Плейъри", + "fields": { + "name": "Име", + "transcodingId": "Транскодиране", + "maxBitRate": "Макс. битрейт", + "client": "Клиент", + "userName": "Потребителско име", + "lastSeen": "Последно видян", + "reportRealPath": "Докладвай реален път", + "scrobbleEnabled": "Изпрати Scrobbles към външни услуги" + } }, - "about": { - "links": { - "homepage": "Начална страница", - "source": "Програмен код", - "featureRequests": "Заявете функционалност" - } + "transcoding": { + "name": "Транскодиране |||| Транскодинг", + "fields": { + "name": "Име", + "targetFormat": "Целеви формат", + "defaultBitRate": "Битрейт по подразбиране", + "command": "Команда" + } }, - "activity": { - "title": "Действия", - "totalScanned": "Сканирани папки", - "quickScan": "Бързо сканиране", - "fullScan": "Пълно сканиране", - "serverUptime": "Сървърът работи", - "serverDown": "ОФЛАЙН" + "playlist": { + "name": "Плейлист |||| Плейлисти", + "fields": { + "name": "Име", + "duration": "Продължителност", + "ownerName": "Собственик", + "public": "Публичен", + "updatedAt": "Актуализиран", + "createdAt": "Създаден на", + "songCount": "Песни", + "comment": "Коментар", + "sync": "Автоматично импортиране", + "path": "Импортиране от" + }, + "actions": { + "selectPlaylist": "Изберете плейлист:", + "addNewPlaylist": "Създай \"%{name}\"", + "export": "Експорт", + "makePublic": "Направи публичен", + "makePrivate": "Направи личен", + "saveQueue": "Запазване на опашката в плейлист", + "searchOrCreate": "Търсете в плейлисти или пишете, за да създадете нови...", + "pressEnterToCreate": "Натиснете Enter, за да създадете нов плейлист", + "removeFromSelection": "Премахване от селекцията" + }, + "message": { + "duplicate_song": "Добави дублирани песни", + "song_exist": "Към плейлиста се добавят дублиращи. Желаете ли да ги добавите или предпочитате да ги пропуснете?", + "noPlaylistsFound": "Няма намерени плейлисти", + "noPlaylists": "Няма налични плейлисти" + } }, - "help": { - "title": "Бързи клавиши на Navidrome", - "hotkeys": { - "show_help": "Показва този помощен текст", - "toggle_menu": "Превключване на страничната меню лента", - "toggle_play": "Пусни / Пауза", - "prev_song": "Предишна песен", - "next_song": "Следваща песен", - "vol_up": "Увеличи звука", - "vol_down": "Намали звука", - "toggle_love": "Добави песента към любими", - "current_song": "Премини към текущата песен" - } + "radio": { + "name": "Радиостанция |||| Радиостанции", + "fields": { + "name": "Име", + "streamUrl": "Стрийм адрес", + "homePageUrl": "Начална страница адрес", + "updatedAt": "Актуализиранa на", + "createdAt": "Създаденa на" + }, + "actions": { + "playNow": "Възпроизвеждане сега" + } + }, + "share": { + "name": "Сподели |||| Споделени", + "fields": { + "username": "Споделено от", + "url": "Адрес", + "description": "Описание", + "contents": "Съдържание", + "expiresAt": "Изтича", + "lastVisitedAt": "Последно посетен", + "visitCount": "Посещения", + "format": "Формат", + "maxBitRate": "Макс. Bit Rate", + "updatedAt": "Актуализирана на", + "createdAt": "Създадена на", + "downloadable": "Разреши изтегляния?" + } + }, + "missing": { + "name": "Липсващ файл |||| Липсващи файлове", + "fields": { + "path": "Път", + "size": "Размер", + "updatedAt": "Изчезнал на", + "libraryName": "Библиотека" + }, + "actions": { + "remove": "Премахни", + "remove_all": "Премахни всички" + }, + "notifications": { + "removed": "Липсващите файлове са премахнати" + }, + "empty": "Няма липсващи файлове" + }, + "library": { + "name": "Библиотека |||| Библиотеки", + "fields": { + "name": "Име", + "path": "Път", + "remotePath": "Отдалечен път", + "lastScanAt": "Последно сканиране", + "songCount": "Песни", + "albumCount": "Албуми", + "artistCount": "Изпълнители", + "totalSongs": "Песни", + "totalAlbums": "Албуми", + "totalArtists": "Изпълнители", + "totalFolders": "Папки", + "totalFiles": "Файлове", + "totalMissingFiles": "Липсващи файлове", + "totalSize": "Общ размер", + "totalDuration": "Продължителност", + "defaultNewUsers": "По подразбиране за нови потребители", + "createdAt": "Създаден", + "updatedAt": "Актуализиран" + }, + "sections": { + "basic": "Основна информация", + "statistics": "Статистика" + }, + "actions": { + "scan": "Сканирай библиотеката", + "manageUsers": "Управление на потребителския достъп", + "viewDetails": "Преглед на подробности", + "quickScan": "Quick Scan", + "fullScan": "Пълно сканиране" + }, + "notifications": { + "created": "Библиотеката е създадена успешно", + "updated": "Библиотеката е актуализирана успешно", + "deleted": "Библиотеката е изтрита успешно", + "scanStarted": "Сканирането на библиотеката започна", + "scanCompleted": "Сканирането на библиотеката е завършено", + "quickScanStarted": "Бързото сканиране започна", + "fullScanStarted": "Пълното сканиране започна", + "scanError": "Грешка при стартиране на сканирането. Проверете лог файловете" + }, + "validation": { + "nameRequired": "Името на библиотеката е задължително", + "pathRequired": "Пътят към библиотеката е задължителен", + "pathNotDirectory": "Пътят до библиотеката трябва да е директория", + "pathNotFound": "Пътят към библиотеката не е намерен", + "pathNotAccessible": "Пътят до библиотеката не е достъпен", + "pathInvalid": "Невалиден път към библиотеката" + }, + "messages": { + "deleteConfirm": "Сигурни ли сте, че желаете да изтриете тази библиотека? Това ще премахне всички свързани данни и потребителски достъп.", + "scanInProgress": "Сканирането е в ход...", + "noLibrariesAssigned": "Няма библиотеки, присвоени на този потребител" + } + }, + "plugin": { + "name": "Плъгин |||| Плъгини", + "fields": { + "id": "ID номер", + "name": "Име", + "description": "Описание", + "version": "Версия", + "author": "Автор", + "website": "Уебсайт", + "permissions": "Разрешения", + "enabled": "Активирано", + "status": "Статус", + "path": "Път", + "lastError": "Грешка", + "hasError": "Грешка", + "updatedAt": "Актуализирано", + "createdAt": "Инсталирано", + "configKey": "Ключ", + "configValue": "Стойност", + "allUsers": "Разрешаване на всички потребители", + "selectedUsers": "Избрани потребители", + "allLibraries": "Разрешаване на всички библиотеки", + "selectedLibraries": "Избрани библиотеки", + "allowWriteAccess": "" + }, + "sections": { + "status": "Статус", + "info": "Информация за плъгина", + "configuration": "Конфигурация", + "manifest": "Манифест", + "usersPermission": "Права за потребители", + "libraryPermission": "Права за библиотека" + }, + "status": { + "enabled": "Активирано", + "disabled": "Деактивирано" + }, + "actions": { + "enable": "Активирай", + "disable": "Деактивирай", + "disabledDueToError": "Поправете грешката преди активиране", + "disabledUsersRequired": "Изберете потребители преди активиране", + "disabledLibrariesRequired": "Изберете библиотеки преди активиране", + "addConfig": "Добавяне на конфигурация", + "rescan": "Повторно сканиране" + }, + "notifications": { + "enabled": "Плъгинът е активиран", + "disabled": "Плъгинът е деактивиран", + "updated": "Плъгинът е актуализиран", + "error": "Грешка при актуализиране на плъгина" + }, + "validation": { + "invalidJson": "Конфигурацията трябва да е валиден JSON" + }, + "messages": { + "configHelp": "Конфигурирайте плъгина, използвайки двойки ключ-стойност. Оставете празно, ако плъгинът не изисква конфигурация.", + "clickPermissions": "Кликнете върху разрешение за подробности", + "noConfig": "Няма зададена конфигурация", + "allUsersHelp": "Когато е активиран, плъгинът ще има достъп до всички потребители, включително тези, създадени в бъдеще.", + "noUsers": "Няма избрани потребители", + "permissionReason": "Причина", + "usersRequired": "Този плъгин изисква достъп до потребителска информация. Изберете до кои потребители плъгинът може да има достъп или активирайте „Разрешаване на всички потребители“.", + "allLibrariesHelp": "Когато е активиран, плъгинът ще има достъп до всички библиотеки, включително тези, създадени в бъдеще.", + "noLibraries": "Няма избрани библиотеки", + "librariesRequired": "Този плъгин изисква достъп до информация за библиотеката. Изберете до кои библиотеки плъгинът може да има достъп или активирайте „Разрешаване на всички библиотеки“.", + "requiredHosts": "Необходими хостове", + "configValidationError": "Валидирането на конфигурацията не бе успешно:", + "schemaRenderError": "Не може да се изобрази формята за конфигурация. Схемата на плъгина може да е невалидна.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "ключ", + "configValue": "стойност" + } } -} \ No newline at end of file + }, + "ra": { + "auth": { + "welcome1": "Благодаря, че инсталирахте Navidrome!", + "welcome2": "За да започнете, създайте администраторски профил", + "confirmPassword": "Потвърдете паролата", + "buttonCreateAdmin": "Създaй администратор", + "auth_check_error": "Моля, влезте за да продължите", + "user_menu": "Профил", + "username": "Потребителско име", + "password": "Парола", + "sign_in": "Вход", + "sign_in_error": "Грешка при удостоверяването. Моля, опитайте отново", + "logout": "Изход", + "insightsCollectionNote": "Navidrome събира анонимни данни, за да помогне\nподобряването на проекта. Кликнете [тук], за да\nнаучите повече и да се откажете, ако желаете" + }, + "validation": { + "invalidChars": "Моля, използвайте само букви и цифри", + "passwordDoesNotMatch": "Паролата не съвпада", + "required": "Задължително", + "minLength": "Трябва да съдържа поне %{min} знака", + "maxLength": "Трябва да съдържа %{max} знака или по-малко", + "minValue": "Трябва да е поне %{min}", + "maxValue": "Трябва да бъде %{max} или по-малко", + "number": "Трябва да е число", + "email": "Трябва да е валиден имейл", + "oneOf": "Трябва да е едно от: %{options}", + "regex": "Трябва да съответства на конкретен формат (regexp): %{pattern}", + "unique": "Трябва да е уникално", + "url": "Трябва да бъде валиден адрес" + }, + "action": { + "add_filter": "Добави филтър", + "add": "Добави", + "back": "Назад", + "bulk_actions": "Избран е 1 елемент |||| Избрани са %{smart_count} елемента", + "cancel": "Отмени", + "clear_input_value": "Изчисти въведеното", + "clone": "Клонирай", + "confirm": "Потвърди", + "create": "Създай", + "delete": "Изтрий", + "edit": "Редактирай", + "export": "Експорт", + "list": "Списък", + "refresh": "Обнови", + "remove_filter": "Премахни този филтър", + "remove": "Премахни", + "save": "Запази", + "search": "Търси", + "show": "Покажи", + "sort": "Сортирай", + "undo": "Отмени", + "expand": "Разгърни", + "close": "Затвори", + "open_menu": "Отвори меню", + "close_menu": "Затвори меню", + "unselect": "Премахни избора", + "skip": "Пропусни", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Споделяне", + "download": "Сваляне" + }, + "boolean": { + "true": "Да", + "false": "Не" + }, + "page": { + "create": "Създаване на %{name}", + "dashboard": "Табло", + "edit": "%{name} #%{id}", + "error": "Нещо се обърка", + "list": "%{name}", + "loading": "Зареждане", + "not_found": "Не е намерен", + "show": "%{name} #%{id}", + "empty": "Все още няма %{name}.", + "invite": "Желаете ли да добавите?" + }, + "input": { + "file": { + "upload_several": "Пуснете файл за да качите, или кликнете за да изберете.", + "upload_single": "Пуснете файл за да качите, или кликнете за да изберете." + }, + "image": { + "upload_several": "Пуснете снимки за качване, или кликнете, за да изберете.", + "upload_single": "Пуснете снимка за качване, или кликнете за да изберете." + }, + "references": { + "all_missing": "Не намирам свързаните данни.", + "many_missing": "Изглежда, че поне една от свързаните препратки, вече не е налична.", + "single_missing": "Изглежда, че връзката вече не е налична." + }, + "password": { + "toggle_visible": "Скрий паролата", + "toggle_hidden": "Покажи паролата" + } + }, + "message": { + "about": "Относно", + "are_you_sure": "Сигурни ли сте?", + "bulk_delete_content": "Наистина ли желаете да изтриете това %{name}? |||| Наистина ли желаете да изтриете тези %{smart_count} елементи?", + "bulk_delete_title": "Изтрий %{name} |||| Изтрий %{smart_count} %{name}", + "delete_content": "Наистина ли желаете да изтриете този елемент?", + "delete_title": "Изтрий %{name} #%{id}", + "details": "Описание", + "error": "Възникна грешка с клиента и заявката Ви не може да бъде изпълнена.", + "invalid_form": "Формата не е валидна. Моля, проверете за грешки", + "loading": "Страницата се зарежда, моля изчакайте", + "no": "Не", + "not_found": "Или сте въвели грешен URL адрес, или сте следвали грешна връзка.", + "yes": "Да", + "unsaved_changes": "Някои от промените не бяха запазени. Сигурни ли сте, че желаете да ги игнорирате?" + }, + "navigation": { + "no_results": "Няма намерени резултати", + "no_more_results": "Страница %{page} е извън границите. Опитайте предишната страница.", + "page_out_of_boundaries": "Страница %{page} е извън границите", + "page_out_from_end": "Не може да отидете след последната страница", + "page_out_from_begin": "Не може да се премине преди страница 1", + "page_range_info": "%{offsetBegin}-%{offsetEnd} от %{total}", + "page_rows_per_page": "Елемента на страница:", + "next": "Следваща", + "prev": "Предишна", + "skip_nav": "Премини към съдържанието" + }, + "notification": { + "updated": "Елементът е актуализиран |||| %{smart_count} елемента са актуализирани", + "created": "Елементът е създаден", + "deleted": "Елементът е изтрит |||| %{smart_count} елемента са изтрити", + "bad_item": "Неправилен елемент", + "item_doesnt_exist": "Елементът не съществува", + "http_error": "Грешка в комуникацията със сървъра", + "data_provider_error": "Грешка в доставчика на данни. Проверете конзолата за подробности.", + "i18n_error": "Не мога да заредя преводите за посочения език", + "canceled": "Действието е отменено", + "logged_out": "Вашата сесия приключи. Моля, влезте отново.", + "new_version": "Налична е нова версия! Моля, опреснете този прозорец." + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Колони за показване", + "layout": "Оформление", + "grid": "Решетка", + "table": "Таблица" + } + }, + "message": { + "note": "ЗАБЕЛЕЖКА", + "transcodingDisabled": "Промяната на конфигурацията за транскодиране през уеб интерфейса е забранена от съображения за сигурност. Ако желаете да промените (редактирате или добавите) опциите за транскодиране, рестартирайте сървъра с конфигурационната опция %{config}.", + "transcodingEnabled": "Navidrome в момента работи с %{config}, което прави възможно стартирането на системни команди от настройките за транскодиране с помощта на уеб интерфейса. Препоръчваме да го деактивирате от съображения за сигурност и да го активирате само при конфигуриране на опциите за транскодиране.", + "songsAddedToPlaylist": "Добавена 1 песен към плейлиста |||| Добавени %{smart_count} песни към плейлиста", + "noPlaylistsAvailable": "Няма налични", + "delete_user_title": "Изтрий потребителя '%{name}'", + "delete_user_content": "Наистина ли желаете да изтриете този потребител и всичките му данни (включително плейлисти и предпочитания)?", + "notifications_blocked": "В настройките на браузъра сте блокирали известията за този сайт", + "notifications_not_available": "Този браузър не поддържа известия на работния плот или нямате достъп до Navidrome през https", + "lastfmLinkSuccess": "Връзката с Last.fm е успешна! Scrobbling е активиран", + "lastfmLinkFailure": "Last.fm не можа да бъде свързан", + "lastfmUnlinkSuccess": "Връзката с Last.fm е прекъсната! Scrobbling е деактивиран", + "lastfmUnlinkFailure": "Last.fm връзката не можа да бъде премахната", + "openIn": { + "lastfm": "Отвори в Last.fm", + "musicbrainz": "Отвори в MusicBrainz" + }, + "lastfmLink": "Прочетете още...", + "listenBrainzLinkSuccess": "Връзката с ListenBrainz е успешна! Scrobbling е активиран от името на потребителя: %{user}", + "listenBrainzLinkFailure": "ListenBrainz не можа да бъде свързан: %{error}", + "listenBrainzUnlinkSuccess": "Връзката с ListenBrainz е прекъсната! Scrobbling е деактивиран", + "listenBrainzUnlinkFailure": "Връзката с ListenBrainz не можа да бъде прекратена", + "downloadOriginalFormat": "Свали в оригиналния формат", + "shareOriginalFormat": "Сподели в оригинален формат", + "shareDialogTitle": "Сподели %{resource} '%{name}'", + "shareBatchDialogTitle": "Сподели 1 %{resource} |||| Сподели %{smart_count} %{resource}", + "shareSuccess": "Адресът е копиран в клипборда: %{url}", + "shareFailure": "Грешка при копиране на адрес %{url} в клипборда", + "downloadDialogTitle": "Сваляне %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Копиране в клипборда: Ctrl+C, Enter", + "remove_missing_title": "Премахни липсващите файлове", + "remove_missing_content": "Сигурни ли сте, че желаете да премахнете избраните липсващи файлове от базата данни? Това ще премахне завинаги всички препратки към тях, включително броя на възпроизвежданията и оценките им.", + "remove_all_missing_title": "Премахни всички липсващи файлове", + "remove_all_missing_content": "Сигурни ли сте, че желаете да премахнете всички липсващи файлове от базата данни? Това ще премахне завинаги всички препратки към тях, включително броя на възпроизвежданията и оценките им.", + "noSimilarSongsFound": "Не са намерени подобни песни", + "noTopSongsFound": "Няма намерени топ песни", + "startingInstantMix": "Зареждане на незабавен микс..." + }, + "menu": { + "library": "Библиотека", + "settings": "Настройки", + "version": "Версия", + "theme": "Тема", + "personal": { + "name": "Лични", + "options": { + "theme": "Тема", + "language": "Език", + "defaultView": "Изглед по подразбиране", + "desktop_notifications": "Известия на работния плот", + "lastfmScrobbling": "Scrobble към Last.fm", + "listenBrainzScrobbling": "Scrobble към ListenBrainz", + "replaygain": "Режим ReplayGain", + "preAmp": "ReplayGain PreAmp (dB)", + "gain": { + "none": "Изключен", + "album": "Използвай Album Gain", + "track": "Използвай Track Gain" + }, + "lastfmNotConfigured": "API ключът на Last.fm не е конфигуриран" + } + }, + "albumList": "Албуми", + "about": "Относно", + "playlists": "Плейлисти", + "sharedPlaylists": "Споделени плейлисти", + "librarySelector": { + "allLibraries": "Всички библиотеки (%{count})", + "multipleLibraries": "%{selected} от %{total} библиотеки", + "selectLibraries": "Изберете библиотеки", + "none": "Няма" + } + }, + "player": { + "playListsText": "Списък с песни", + "openText": "Отвори", + "closeText": "Затвори", + "notContentText": "Няма песни", + "clickToPlayText": "Пускане", + "clickToPauseText": "Пауза", + "nextTrackText": "Следваща песен", + "previousTrackText": "Предишна песен", + "reloadText": "Презареди", + "volumeText": "Сила на звука", + "toggleLyricText": "Текст на песен", + "toggleMiniModeText": "Минимизирай", + "destroyText": "Унищожи", + "downloadText": "Свали", + "removeAudioListsText": "Изтриване на плейлисти", + "clickToDeleteText": "Кликнете, за да изтриете %{name}", + "emptyLyricText": "Няма текст", + "playModeText": { + "order": "По ред", + "orderLoop": "Повтаряй всички", + "singleLoop": "Повтаряй същата", + "shufflePlay": "Разбъркай" + } + }, + "about": { + "links": { + "homepage": "Начална страница", + "source": "Програмен код", + "featureRequests": "Заявете функционалност", + "lastInsightsCollection": "Последна колекция от анализи", + "insights": { + "disabled": "Деактивиран", + "waiting": "Изчакване" + } + }, + "tabs": { + "about": "Относно", + "config": "Конфигурация" + }, + "config": { + "configName": "Име на конфигурация", + "environmentVariable": "Променлива на средата", + "currentValue": "Текуща стойност", + "configurationFile": "Конфигурационен файл", + "exportToml": "Експортиране на конфигурация (TOML)", + "exportSuccess": "Конфигурация, експортирана в клипборда във формат TOML", + "exportFailed": "Неуспешно копиране на конфигурация", + "devFlagsHeader": "Флагове за разработка (подлежащи на промяна/премахване)", + "devFlagsComment": "Това са експериментални настройки и е възможно да бъдат премахнати в бъдещи версии.", + "downloadToml": "Изтегляне на конфигурация (TOML)" + } + }, + "activity": { + "title": "Действия", + "totalScanned": "Сканирани папки", + "quickScan": "Бързо сканиране", + "fullScan": "Пълно сканиране", + "serverUptime": "Сървърът работи", + "serverDown": "ОФЛАЙН", + "scanType": "Последно сканиране", + "status": "Грешка при сканиране", + "elapsedTime": "Изминало време", + "selectiveScan": "Селективен" + }, + "help": { + "title": "Бързи клавиши на Navidrome", + "hotkeys": { + "show_help": "Показва този помощен текст", + "toggle_menu": "Превключване на страничната меню лента", + "toggle_play": "Пусни / Пауза", + "prev_song": "Предишна песен", + "next_song": "Следваща песен", + "vol_up": "Увеличи звука", + "vol_down": "Намали звука", + "toggle_love": "Добави песента към любими", + "current_song": "Премини към текущата песен" + } + }, + "nowPlaying": { + "title": "Сега свири", + "empty": "Нищо не се възпроизвежда", + "minutesAgo": "преди %{smart_count} минута |||| преди %{smart_count} минути" + } +} diff --git a/resources/i18n/bs.json b/resources/i18n/bs.json new file mode 100644 index 000000000..9d5c552e7 --- /dev/null +++ b/resources/i18n/bs.json @@ -0,0 +1,628 @@ +{ + "languageName": "Bosanski", + "resources": { + "song": { + "name": "Pjesma |||| Pjesme", + "fields": { + "albumArtist": "Izvođač albuma", + "duration": "Trajanje", + "trackNumber": "Pjesma #", + "playCount": "Reprodukcija", + "title": "Naslov", + "artist": "Izvođač", + "album": "Album", + "path": "Putanja datoteke", + "genre": "Žanr", + "compilation": "Kompilacija", + "year": "Godina", + "size": "Veličina datoteke", + "updatedAt": "Dodano", + "bitRate": "Brzina prijenosa", + "discSubtitle": "Podnaslov CD-a", + "starred": "Favorit", + "comment": "Komentar", + "rating": "Ocjena", + "quality": "Kvaliteta", + "bpm": "BPM", + "playDate": "Posljednja reprodukcija", + "channels": "Kanali", + "createdAt": "Dodano", + "grouping": "Grupisanje", + "mood": "Raspoloženje", + "participants": "Dodatni učesnici", + "tags": "Dodatne oznake", + "mappedTags": "Mapirane oznake", + "rawTags": "Sirovi podaci oznaka", + "bitDepth": "Dubina bita", + "sampleRate": "Uzorkovanje", + "missing": "Nedostaje", + "libraryName": "Biblioteka" + }, + "actions": { + "addToQueue": "Reprodukcija kasnije", + "playNow": "Reprodukcija sada", + "addToPlaylist": "Dodaj u playlistu", + "shuffleAll": "Nasumična reprodukcija", + "download": "Preuzmi", + "playNext": "Reprodukcija sljedeće", + "info": "Više informacija", + "showInPlaylist": "Prikaži u playlisti" + } + }, + "album": { + "name": "Album |||| Albumi", + "fields": { + "albumArtist": "Izvođač albuma", + "artist": "Izvođač", + "duration": "Trajanje", + "songCount": "Broj pjesama", + "playCount": "Reprodukcija", + "name": "Naziv", + "genre": "Žanr", + "compilation": "Kompilacija", + "year": "Godina", + "updatedAt": "Ažurirano", + "comment": "Komentar", + "rating": "Ocjena", + "createdAt": "Dodano", + "size": "Veličina", + "originalDate": "Originalni datum", + "releaseDate": "Datum izdanja", + "releases": "Izdanje |||| Izdanja", + "released": "Objavljeno", + "recordLabel": "Izdavač", + "catalogNum": "Kataloški broj", + "releaseType": "Tip", + "grouping": "Grupisanje", + "media": "Medij", + "mood": "Raspoloženje", + "date": "Datum snimanja", + "missing": "Nedostaje", + "libraryName": "Biblioteka" + }, + "actions": { + "playAll": "Reprodukcija", + "playNext": "Reprodukcija sljedeće", + "addToQueue": "Dodaj u red", + "shuffle": "Nasumična reprodukcija", + "addToPlaylist": "Dodaj u playlistu", + "download": "Preuzmi", + "info": "Više informacija", + "share": "Podijeli" + }, + "lists": { + "all": "Sve", + "random": "Nasumično", + "recentlyAdded": "Nedavno dodano", + "recentlyPlayed": "Nedavno reproducirano", + "mostPlayed": "Najviše reproducirano", + "starred": "Favoriti", + "topRated": "Najbolje ocijenjeno" + } + }, + "artist": { + "name": "Izvođač |||| Izvođači", + "fields": { + "name": "Naziv", + "albumCount": "Broj albuma", + "songCount": "Broj pjesama", + "playCount": "Reprodukcija", + "rating": "Ocjena", + "genre": "Žanr", + "size": "Veličina", + "role": "Uloga", + "missing": "Nedostaje" + }, + "roles": { + "albumartist": "Izvođač albuma |||| Izvođači albuma", + "artist": "Izvođač |||| Izvođači", + "composer": "Kompozitor |||| Kompozitori", + "conductor": "Dirigent |||| Dirigenti", + "lyricist": "Tekstopisac |||| Tekstopisci", + "arranger": "Aranžer |||| Aranžeri", + "producer": "Producent |||| Producenti", + "director": "Direktor |||| Direktori", + "engineer": "Inženjer |||| Inženjeri", + "mixer": "Mikser |||| Mikseri", + "remixer": "Remikser |||| Remikseri", + "djmixer": "DJ Mikser |||| DJ Mikseri", + "performer": "Izvođač |||| Izvođači", + "maincredit": "Izvođač albuma ili izvođač |||| Izvođači albuma ili izvođači" + }, + "actions": { + "shuffle": "Nasumična reprodukcija", + "radio": "Radio", + "topSongs": "Najpopularnije pjesme" + } + }, + "user": { + "name": "Korisnik |||| Korisnici", + "fields": { + "userName": "Korisničko ime", + "isAdmin": "Je admin", + "lastLoginAt": "Posljednja prijava", + "updatedAt": "Ažurirano", + "name": "Ime", + "password": "Lozinka", + "createdAt": "Kreirano", + "changePassword": "Promijeni lozinku?", + "currentPassword": "Trenutna lozinka", + "newPassword": "Nova lozinka", + "token": "Token", + "lastAccessAt": "Posljednji pristup", + "libraries": "Biblioteke" + }, + "helperTexts": { + "name": "Promjena će biti aktivna nakon sljedeće prijave", + "libraries": "Odaberi specifične biblioteke za ovog korisnika ili ostavi prazno za standardne biblioteke" + }, + "notifications": { + "created": "Korisnik kreiran", + "updated": "Korisnik ažuriran", + "deleted": "Korisnik obrisan" + }, + "message": { + "listenBrainzToken": "Unesite svoj ListenBrainz korisnički token", + "clickHereForToken": "Kliknite ovdje za dobijanje tokena", + "selectAllLibraries": "Odaberi sve biblioteke", + "adminAutoLibraries": "Administratori automatski imaju pristup svim bibliotekama" + }, + "validation": { + "librariesRequired": "Ne-administratori moraju imati barem jednu odabranu biblioteku" + } + }, + "player": { + "name": "Player |||| Playeri", + "fields": { + "name": "Naziv", + "transcodingId": "ID transkodiranja", + "maxBitRate": "Maks. brzina prijenosa", + "client": "Klijent", + "userName": "Korisničko ime", + "lastSeen": "Posljednji put viđen", + "reportRealPath": "Prikaži stvarnu putanju", + "scrobbleEnabled": "Slanje podataka o reprodukciji (scrobbling)" + } + }, + "transcoding": { + "name": "Transkodiranje |||| Transkodiranja", + "fields": { + "name": "Naziv", + "targetFormat": "Ciljani format", + "defaultBitRate": "Zadana brzina prijenosa", + "command": "Komanda" + } + }, + "playlist": { + "name": "Playlista |||| Playliste", + "fields": { + "name": "Naziv", + "duration": "Trajanje", + "ownerName": "Vlasnik", + "public": "Javna", + "updatedAt": "Ažurirano", + "createdAt": "Kreirano", + "songCount": "Broj pjesama", + "comment": "Komentar", + "sync": "Auto-uvoz", + "path": "Uvezi iz" + }, + "actions": { + "selectPlaylist": "Odaberi playlistu:", + "addNewPlaylist": "Kreiraj \"%{name}\"", + "export": "Izvezi", + "makePublic": "Učini javnom", + "makePrivate": "Učini privatnom", + "saveQueue": "Sačuvaj red čekanja u playlistu", + "searchOrCreate": "Pretraži playlistu ili kreiraj novu...", + "pressEnterToCreate": "Pritisni Enter za kreiranje nove playliste", + "removeFromSelection": "Ukloni iz odabira" + }, + "message": { + "duplicate_song": "Dodaj duplikate", + "song_exist": "Neke pjesme su već u playlisti. Želiš li ih ipak dodati ili preskočiti?", + "noPlaylistsFound": "Nije pronađena nijedna playlista", + "noPlaylists": "Nema playlisti" + } + }, + "radio": { + "name": "Radio |||| Radiji", + "fields": { + "name": "Naziv", + "streamUrl": "Stream URL", + "homePageUrl": "URL početne stranice", + "updatedAt": "Ažurirano", + "createdAt": "Dodano" + }, + "actions": { + "playNow": "Reprodukcija sada" + } + }, + "share": { + "name": "Dijeljenje |||| Dijeljenja", + "fields": { + "username": "Podijeljeno od strane", + "url": "URL", + "description": "Opis", + "contents": "Sadržaj", + "expiresAt": "Vrijedi do", + "lastVisitedAt": "Posljednja posjeta", + "visitCount": "Posjete", + "format": "Format", + "maxBitRate": "Maks. brzina prijenosa", + "updatedAt": "Ažurirano", + "createdAt": "Kreirano", + "downloadable": "Dozvoli preuzimanje?" + } + }, + "missing": { + "name": "Nedostajuća datoteka |||| Nedostajuće datoteke", + "fields": { + "path": "Putanja", + "size": "Veličina", + "updatedAt": "Nedostaje od", + "libraryName": "Biblioteka" + }, + "actions": { + "remove": "Ukloni", + "remove_all": "ukloni sve" + }, + "notifications": { + "removed": "Nedostajuća(e) datoteka(e) uklonjena(e)" + }, + "empty": "nema nedostajućih datoteka" + }, + "library": { + "name": "Biblioteka |||| Biblioteke", + "fields": { + "name": "Naziv", + "path": "Putanja", + "remotePath": "Udaljena putanja", + "lastScanAt": "Posljednje skeniranje", + "songCount": "Pjesme", + "albumCount": "Albumi", + "artistCount": "Izvođači", + "totalSongs": "Pjesme", + "totalAlbums": "Albumi", + "totalArtists": "Izvođači", + "totalFolders": "Folderi", + "totalFiles": "Datoteke", + "totalMissingFiles": "Nedostajuće datoteke", + "totalSize": "Veličina", + "totalDuration": "Trajanje", + "defaultNewUsers": "Standardno za nove korisnike", + "createdAt": "Kreirano", + "updatedAt": "Ažurirano" + }, + "sections": { + "basic": "Osnovne informacije", + "statistics": "Statistika" + }, + "actions": { + "scan": "Skeniraj biblioteku", + "manageUsers": "Upravljaj pristupima", + "viewDetails": "Pogledaj detalje" + }, + "notifications": { + "created": "Biblioteka uspješno kreirana", + "updated": "Biblioteka uspješno ažurirana", + "deleted": "Biblioteka uspješno obrisana", + "scanStarted": "Skeniranje biblioteke započeto", + "scanCompleted": "Skeniranje biblioteke završeno" + }, + "validation": { + "nameRequired": "Naziv biblioteke je obavezan", + "pathRequired": "Putanja biblioteke je obavezna", + "pathNotDirectory": "Putanja biblioteke mora biti folder", + "pathNotFound": "Putanja biblioteke nije pronađena", + "pathNotAccessible": "Putanja biblioteke nije dostupna", + "pathInvalid": "Putanja biblioteke nije validna" + }, + "messages": { + "deleteConfirm": "Da li zaista želiš obrisati ovu biblioteku? Pristup i podaci će biti uklonjeni.", + "scanInProgress": "Skeniranje biblioteke u toku...", + "noLibrariesAssigned": "Nema dodijeljenih biblioteka" + } + } + }, + "ra": { + "auth": { + "welcome1": "Hvala što ste instalirali Navidrome!", + "welcome2": "Prvo kreirajte admin korisnika", + "confirmPassword": "Potvrdi lozinku", + "buttonCreateAdmin": "Kreiraj admina", + "auth_check_error": "Prijavite se da biste nastavili", + "user_menu": "Profil", + "username": "Korisničko ime", + "password": "Lozinka", + "sign_in": "Prijava", + "sign_in_error": "Greška pri prijavi", + "logout": "Odjava", + "insightsCollectionNote": "Navidrome prikuplja anonimne statistike \nda podrži razvoj projekta. \nKliknite [ovdje] za više informacija ili da isključite \"Insights\"" + }, + "validation": { + "invalidChars": "Koristite samo slova i brojeve", + "passwordDoesNotMatch": "Lozinke se ne podudaraju", + "required": "Obavezno", + "minLength": "Mora imati najmanje %{min} znakova", + "maxLength": "Mora imati najviše %{max} znakova", + "minValue": "Mora biti najmanje %{min}", + "maxValue": "Mora biti %{max} ili manje", + "number": "Mora biti broj", + "email": "Mora biti validna e-mail adresa", + "oneOf": "Mora biti jedan od: %{options}", + "regex": "Mora odgovarati regularnom izrazu: %{pattern}", + "unique": "Mora biti jedinstveno", + "url": "Mora biti validan URL" + }, + "action": { + "add_filter": "Dodaj filter", + "add": "Dodaj", + "back": "Nazad", + "bulk_actions": "1 odabrana stavka |||| %{smart_count} odabrane stavke", + "cancel": "Otkaži", + "clear_input_value": "Obriši unos", + "clone": "Kloniraj", + "confirm": "Potvrdi", + "create": "Kreiraj", + "delete": "Obriši", + "edit": "Uredi", + "export": "Izvezi", + "list": "Lista", + "refresh": "Osvježi", + "remove_filter": "Ukloni filter", + "remove": "Ukloni", + "save": "Sačuvaj", + "search": "Pretraži", + "show": "Prikaži", + "sort": "Sortiraj", + "undo": "Poništi", + "expand": "Proširi", + "close": "Zatvori", + "open_menu": "Otvori meni", + "close_menu": "Zatvori meni", + "unselect": "Poništi odabir", + "skip": "Preskoči", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Podijeli", + "download": "Preuzmi" + }, + "boolean": { + "true": "Da", + "false": "Ne" + }, + "page": { + "create": "Kreiraj %{name}", + "dashboard": "Kontrolna tabla", + "edit": "%{name} #%{id}", + "error": "Nešto je pošlo po zlu", + "list": "%{name}", + "loading": "Učitavanje", + "not_found": "Nije pronađeno", + "show": "%{name} #%{id}", + "empty": "Još nema %{name}.", + "invite": "Želiš li dodati jednu?" + }, + "input": { + "file": { + "upload_several": "Povuci datoteke ovdje za prijenos ili klikni za odabir.", + "upload_single": "Povuci datoteku ovdje za prijenos ili klikni za odabir." + }, + "image": { + "upload_several": "Povuci slike ovdje za prijenos ili klikni za odabir.", + "upload_single": "Povuci sliku ovdje za prijenos ili klikni za odabir." + }, + "references": { + "all_missing": "Povezane reference nisu pronađene.", + "many_missing": "Neke povezane reference više nisu dostupne.", + "single_missing": "Povezana referenca više nije dostupna." + }, + "password": { + "toggle_visible": "Sakrij lozinku", + "toggle_hidden": "Prikaži lozinku" + } + }, + "message": { + "about": "O aplikaciji", + "are_you_sure": "Jesi li siguran?", + "bulk_delete_content": "Da li zaista želiš obrisati \"%{name}\"? |||| Da li zaista želiš obrisati %{smart_count} stavki?", + "bulk_delete_title": "Obriši %{name} |||| Obriši %{smart_count} %{name} stavki", + "delete_content": "Da li zaista želiš obrisati ovaj sadržaj?", + "delete_title": "Obriši %{name} #%{id}", + "details": "Detalji", + "error": "Došlo je do greške i zahtjev nije mogao biti završen.", + "invalid_form": "Formular nije validan. Provjeri unose.", + "loading": "Stranica se učitava", + "no": "Ne", + "not_found": "Stranica nije pronađena.", + "yes": "Da", + "unsaved_changes": "Neke promjene nisu sačuvane. Želiš li ih ignorisati?" + }, + "navigation": { + "no_results": "Nema rezultata", + "no_more_results": "Stranica %{page} nema sadržaja.", + "page_out_of_boundaries": "Stranica %{page} je izvan opsega", + "page_out_from_end": "Posljednja stranica", + "page_out_from_begin": "Prva stranica", + "page_range_info": "%{offsetBegin}-%{offsetEnd} od %{total}", + "page_rows_per_page": "Redova po stranici:", + "next": "Sljedeća", + "prev": "Prethodna", + "skip_nav": "Preskoči na sadržaj" + }, + "notification": { + "updated": "Stavka ažurirana |||| %{smart_count} stavki ažurirano", + "created": "Stavka kreirana", + "deleted": "Stavka obrisana |||| %{smart_count} stavki obrisano", + "bad_item": "Neispravna stavka", + "item_doesnt_exist": "Stavka ne postoji", + "http_error": "Greška u komunikaciji sa serverom", + "data_provider_error": "Greška u dataProvider-u. Provjeri konzolu za detalje.", + "i18n_error": "Prijevod za odabrani jezik nije dostupan", + "canceled": "Akcija otkazana", + "logged_out": "Sesija je istekla. Ponovo se prijavi.", + "new_version": "Nova verzija dostupna! Osveži stranicu." + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Odaberi kolone", + "layout": "Izgled", + "grid": "Mreža", + "table": "Tabela" + } + }, + "message": { + "note": "NAPOMENA", + "transcodingDisabled": "Izmjena postavki transkodiranja preko web sučelja je onemogućena iz sigurnosnih razloga. Ako želiš promijeniti opcije transkodiranja (urediti ili dodati), ponovo pokreni server sa konfiguracijskom opcijom %{config}.", + "transcodingEnabled": "Navidrome trenutno radi sa %{config}, što omogućava izvršavanje sistemskih komandi kroz postavke transkodiranja preko web sučelja. Preporučujemo da ovo onemogućiš iz sigurnosnih razloga i koristiš samo prilikom konfiguracije transkodiranja.", + "songsAddedToPlaylist": "1 pjesma dodana u playlistu |||| %{smart_count} pjesme dodane u playlistu", + "noPlaylistsAvailable": "Nema dostupnih playlisti", + "delete_user_title": "Obriši korisnika '%{name}'", + "delete_user_content": "Da li zaista želiš obrisati ovog korisnika i sve njegove podatke (uključujući playliste i postavke)?", + "notifications_blocked": "Blokirali ste obavijesti za ovu stranicu u postavkama preglednika", + "notifications_not_available": "Ovaj preglednik ne podržava desktop obavijesti", + "lastfmLinkSuccess": "Last.fm veza uspostavljena i scrobbling omogućen", + "lastfmLinkFailure": "Last.fm veza nije uspjela", + "lastfmUnlinkSuccess": "Last.fm veza uklonjena i scrobbling onemogućen", + "lastfmUnlinkFailure": "Last.fm veza nije uklonjena", + "openIn": { + "lastfm": "Prikaži na Last.fm", + "musicbrainz": "Prikaži na MusicBrainz" + }, + "lastfmLink": "Pročitaj više", + "listenBrainzLinkSuccess": "ListenBrainz veza uspostavljena i scrobbling omogućen kao korisnik: %{user}", + "listenBrainzLinkFailure": "ListenBrainz veza nije uspjela: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz veza uklonjena i scrobbling onemogućen", + "listenBrainzUnlinkFailure": "ListenBrainz veza nije uklonjena", + "downloadOriginalFormat": "Preuzmi u originalnom formatu", + "shareOriginalFormat": "Podijeli u originalnom formatu", + "shareDialogTitle": "Podijeli %{resource} '%{name}'", + "shareBatchDialogTitle": "Podijeli 1 %{resource} |||| Podijeli %{smart_count} %{resource}", + "shareSuccess": "URL kopiran u međuspremnik: %{url}", + "shareFailure": "Greška pri kopiranju URL-a %{url} u međuspremnik", + "downloadDialogTitle": "Preuzmi %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Kopiraj u međuspremnik: Ctrl+C, Enter", + "remove_missing_title": "Ukloni nedostajuće datoteke", + "remove_missing_content": "Da li zaista želiš ukloniti odabrane nedostajuće datoteke iz baze podataka? Sve reference na datoteke (broj reprodukcija, ocjene) bit će trajno obrisane.", + "remove_all_missing_title": "Ukloni sve nedostajuće datoteke", + "remove_all_missing_content": "Da li zaista želiš ukloniti sve nedostajuće datoteke iz baze podataka? Sve reference na datoteke (broj reprodukcija, ocjene) bit će trajno obrisane.", + "noSimilarSongsFound": "Nema sličnih pjesama", + "noTopSongsFound": "Nema popularnih pjesama" + }, + "menu": { + "library": "Biblioteka", + "settings": "Postavke", + "version": "Verzija", + "theme": "Tema", + "personal": { + "name": "Lično", + "options": { + "theme": "Tema", + "language": "Jezik", + "defaultView": "Zadani pregled", + "desktop_notifications": "Desktop obavijesti", + "lastfmScrobbling": "Last.fm scrobbling", + "listenBrainzScrobbling": "ListenBrainz scrobbling", + "replaygain": "ReplayGain mod", + "preAmp": "ReplayGain pojačanje (dB)", + "gain": { + "none": "Isključeno", + "album": "Koristi album gain", + "track": "Koristi pjesmu gain" + }, + "lastfmNotConfigured": "Last.fm API ključ nije konfiguriran" + } + }, + "albumList": "Albumi", + "about": "O aplikaciji", + "playlists": "Playliste", + "sharedPlaylists": "Dijeljene playliste", + "librarySelector": { + "allLibraries": "Sve biblioteke (%{count})", + "multipleLibraries": "%{selected} od %{total} biblioteka", + "selectLibraries": "Odaberi biblioteke", + "none": "Nijedna" + } + }, + "player": { + "playListsText": "Reprodukcija reda čekanja", + "openText": "Otvori", + "closeText": "Zatvori", + "notContentText": "Nema muzike", + "clickToPlayText": "Klikni za reprodukciju", + "clickToPauseText": "Klikni za pauzu", + "nextTrackText": "Sljedeća pjesma", + "previousTrackText": "Prethodna pjesma", + "reloadText": "Ponovo učitaj", + "volumeText": "Glasnoća", + "toggleLyricText": "Prikaži/sakrij tekst", + "toggleMiniModeText": "Minimiziraj", + "destroyText": "Uništi", + "downloadText": "Preuzmi", + "removeAudioListsText": "Ukloni audio liste", + "clickToDeleteText": "Klikni za brisanje %{name}", + "emptyLyricText": "Nema teksta", + "playModeText": { + "order": "Redom", + "orderLoop": "Ponavljaj", + "singleLoop": "Ponavljaj jednu", + "shufflePlay": "Nasumična reprodukcija" + } + }, + "about": { + "links": { + "homepage": "Početna stranica", + "source": "Izvorni kod", + "featureRequests": "Zahtjevi za funkcijama", + "lastInsightsCollection": "Posljednje prikupljanje \"Insights\"", + "insights": { + "disabled": "Isključeno", + "waiting": "Čekanje" + } + }, + "tabs": { + "about": "O aplikaciji", + "config": "Konfiguracija" + }, + "config": { + "configName": "Postavka", + "environmentVariable": "Varijabla okruženja", + "currentValue": "Vrijednost", + "configurationFile": "Konfiguracijska datoteka", + "exportToml": "Izvezi konfiguraciju (TOML)", + "exportSuccess": "Konfiguracija kopirana u međuspremnik u TOML formatu", + "exportFailed": "Greška pri kopiranju konfiguracije", + "devFlagsHeader": "Dev postavke (mogu se promijeniti)", + "devFlagsComment": "Eksperimentalne postavke koje mogu biti uklonjene ili promijenjene u budućnosti" + } + }, + "activity": { + "title": "Aktivnost", + "totalScanned": "Ukupno skeniranih foldera", + "quickScan": "Brzo skeniranje", + "fullScan": "Potpuno skeniranje", + "serverUptime": "Vrijeme rada servera", + "serverDown": "ISKLJUČEN", + "scanType": "Tip", + "status": "Greška pri skeniranju", + "elapsedTime": "Proteklo vrijeme" + }, + "help": { + "title": "Navidrome prečice", + "hotkeys": { + "show_help": "Prikaži ovu pomoć", + "toggle_menu": "Uključi/isključi bočnu traku", + "toggle_play": "Reprodukcija / Pauza", + "prev_song": "Prethodna pjesma", + "next_song": "Sljedeća pjesma", + "vol_up": "Glasnije", + "vol_down": "Tiše", + "toggle_love": "Dodaj u favorite", + "current_song": "Prikaži trenutnu pjesmu" + } + }, + "nowPlaying": { + "title": "Trenutna reprodukcija", + "empty": "Nema reprodukcije", + "minutesAgo": "Prije %{smart_count} minute |||| Prije %{smart_count} minuta" + } +} diff --git a/resources/i18n/ca.json b/resources/i18n/ca.json index e3e7b544e..1ef2ce016 100644 --- a/resources/i18n/ca.json +++ b/resources/i18n/ca.json @@ -1,518 +1,715 @@ { - "languageName": "Català", - "resources": { - "song": { - "name": "Cançó |||| Cançons", - "fields": { - "albumArtist": "Artista de l'àlbum", - "duration": "Durada", - "trackNumber": "#", - "playCount": "Reproduccions", - "title": "Títol", - "artist": "Artista", - "album": "Àlbum", - "path": "Ruta del fitxer", - "genre": "Gènere", - "compilation": "Compilació", - "year": "Any", - "size": "Mida del fitxer", - "updatedAt": "Actualitzat", - "bitRate": "Taxa de bits", - "bitDepth": "Bits", - "sampleRate": "Freqüencia de mostreig", - "channels": "Canals", - "discSubtitle": "Subtítol del disc", - "starred": "Preferit", - "comment": "Comentari", - "rating": "Valoració", - "quality": "Qualitat", - "bpm": "tempo", - "playDate": "Darrer resproduït", - "createdAt": "Creat el", - "grouping": "Agrupació", - "mood": "Sentiment", - "participants": "Participants", - "tags": "Etiquetes", - "mappedTags": "Etiquetes assignades", - "rawTags": "Etiquetes sense processar" - }, - "actions": { - "addToQueue": "Reprodueix després", - "playNow": "Reprodueix ara", - "addToPlaylist": "Afegeix a la llista", - "shuffleAll": "Aleatori", - "download": "Descarrega", - "playNext": "Reprodueix següent", - "info": "Obtén informació" - } - }, - "album": { - "name": "Àlbum |||| Àlbums", - "fields": { - "albumArtist": "Artista de l'àlbum", - "artist": "Artista", - "duration": "Durada", - "songCount": "Cançons", - "playCount": "Reproduccions", - "size": "Mida", - "name": "Nom", - "genre": "Gènere", - "compilation": "Compilació", - "year": "Any", - "updatedAt": "Actualitzat ", - "comment": "Comentari", - "rating": "Valoració", - "createdAt": "Creat el", - "size": "Mida", - "originalDate": "Original", - "releaseDate": "Publicat", - "releases": "LLançament |||| Llançaments", - "released": "Publicat", - "recordLabel": "Discogràfica", - "catalogNum": "Número de catàleg", - "releaseType": "Tipus de publicació", - "grouping": "Agrupació", - "media": "Mitjà", - "mood": "Sentiment" - }, - "actions": { - "playAll": "Reprodueix", - "playNext": "Reprodueix la següent", - "addToQueue": "Reprodueix després", - "share": "Compartir", - "shuffle": "Aleatori", - "addToPlaylist": "Afegeix a la llista", - "download": "Descarrega", - "info": "Obtén informació" - }, - "lists": { - "all": "Tot", - "random": "Aleatori", - "recentlyAdded": "Afegit fa poc", - "recentlyPlayed": "Reproduït fa poc", - "mostPlayed": "Més reproduït", - "starred": "Preferits", - "topRated": "Més ben valorades" - } - }, - "artist": { - "name": "Artista |||| Artistes", - "fields": { - "name": "Nom", - "albumCount": "Nombre d'àlbums", - "songCount": "Nombre de cançons", - "size": "Mida", - "playCount": "Reproduccions", - "rating": "Valoració", - "genre": "Gènere", - "role": "Rol" - }, - "roles": { - "albumartist": "Artista de l'Àlbum |||| Artistes de l'Àlbum", - "artist": "Artista |||| Artistes", - "composer": "Compositor |||| Compositors", - "conductor": "Conductor |||| Conductors", - "lyricist": "Lletrista |||| Lletristes", - "arranger": "Arranjador |||| Arranjadors", - "producer": "Productor |||| Productors", - "director": "Director |||| Directors", - "engineer": "Enginyer |||| Enginyers", - "mixer": "Mesclador |||| Mescladors", - "remixer": "Remesclador |||| Remescladors", - "djmixer": "DJ Mesclador |||| DJ Mescladors", - "performer": "Intèrpret |||| Intèrprets" - } - }, - "user": { - "name": "Usuari |||| Usuaris", - "fields": { - "userName": "Nom d'usuari", - "isAdmin": "És admin", - "lastLoginAt": "Última connexió", - "lastAccessAt": "Últim Accés", - "updatedAt": "Actualitzat", - "name": "Nom", - "password": "Contrasenya", - "createdAt": "Creat", - "changePassword": "Canviar la contrasenya?", - "currentPassword": "Contrasenya actual", - "newPassword": "Contrasenya nova", - "token": "Token" - }, - "helperTexts": { - "name": "Els canvis en el nom s'hi aplicaran en la següent connexió" - }, - "notifications": { - "created": "Usuari creat", - "updated": "Usuari actualitzat", - "deleted": "Usuari eliminat" - }, - "message": { - "listenBrainzToken": "Introduïu el vostre token d'usuari de ListenBrainz", - "clickHereForToken": "Feu clic ací per a obtenir el vostre token" - } - }, - "player": { - "name": "Reproductor |||| Reproductors", - "fields": { - "name": "Nom", - "transcodingId": "Transcodificador", - "maxBitRate": "Taxa de bits màx.", - "client": "Client", - "userName": "Nom d'usuari", - "lastSeen": "Vist", - "reportRealPath": "Informa de la ruta real", - "scrobbleEnabled": "Activa el seguiment des de serveis externs" - } - }, - "transcoding": { - "name": "Transcodificador |||| Transcodificadors", - "fields": { - "name": "Nom", - "targetFormat": "Format desitjat", - "defaultBitRate": "Taxa de bits per defecte", - "command": "Ordre" - } - }, - "playlist": { - "name": "Llista |||| Llistes", - "fields": { - "name": "Nom", - "duration": "Durada", - "ownerName": "Propietari", - "public": "Públic", - "updatedAt": "Actualitzat ", - "createdAt": "Creat", - "songCount": "Cançons", - "comment": "Comentari", - "sync": "Auto-importació", - "path": "Importa de" - }, - "actions": { - "selectPlaylist": "Selecciona una llista:", - "addNewPlaylist": "Crea \"%{nom}", - "export": "Exporta", - "makePublic": "Fes públic", - "makePrivate": "Fes privat" - }, - "message": { - "duplicate_song": "Afegeix cançons duplicades", - "song_exist": "Heu afegit duplicats a la llista. Voleu afegir-los o ignorar-los?" - } - }, - "radio": { - "name": "Ràdio |||| Ràdios", - "fields": { - "name": "Nom", - "streamUrl": "URL del flux", - "homePageUrl": "URL principal", - "updatedAt": "Actualitzat", - "createdAt": "Creat" - }, - "actions": { - "playNow": "Reprodueix" - } - }, - "share": { - "name": "Compartir |||| Compartits", - "fields": { - "username": "Compartit per", - "url": "URL", - "description": "Descripció", - "downloadable": "Permet descarregar?", - "contents": "Continguts", - "expiresAt": "Caduca", - "lastVisitedAt": "Última Visita", - "visitCount": "Visites", - "format": "Format", - "maxBitRate": "Taxa de bits màx.", - "updatedAt": "Actualitzat", - "createdAt": "Creat" - }, - "notifications": {}, - "actions": {} - }, - "missing": { + "languageName": "Català", + "resources": { + "song": { + "name": "Cançó |||| Cançons", + "fields": { + "albumArtist": "Artista de l'àlbum", + "duration": "Durada", + "trackNumber": "#", + "playCount": "Reproduccions", + "title": "Títol", + "artist": "Artista", + "album": "Àlbum", + "path": "Ruta del fitxer", + "genre": "Gènere", + "compilation": "Compilació", + "year": "Any", + "size": "Mida del fitxer", + "updatedAt": "Actualitzat", + "bitRate": "Taxa de bits", + "discSubtitle": "Subtítol del disc", + "starred": "Preferit", + "comment": "Comentari", + "rating": "Valoració", + "quality": "Qualitat", + "bpm": "tempo", + "playDate": "Darrer resproduït", + "channels": "Canals", + "createdAt": "Data d'addició", + "grouping": "Agrupació", + "mood": "Sentiment", + "participants": "Participants", + "tags": "Etiquetes", + "mappedTags": "Etiquetes assignades", + "rawTags": "Etiquetes sense processar", + "bitDepth": "Bits", + "sampleRate": "Freqüencia de mostreig", + "missing": "Desaparegut", + "libraryName": "Biblioteca", + "composer": "Compositor", + "disc": "" + }, + "actions": { + "addToQueue": "Reprodueix després", + "playNow": "Reprodueix ara", + "addToPlaylist": "Afegeix a la llista", + "shuffleAll": "Aleatori", + "download": "Descarrega", + "playNext": "Reprodueix següent", + "info": "Obtén informació", + "showInPlaylist": "Mostra a la llista", + "instantMix": "Mescla immediata" + } + }, + "album": { + "name": "Àlbum |||| Àlbums", + "fields": { + "albumArtist": "Artista de l'àlbum", + "artist": "Artista", + "duration": "Durada", + "songCount": "Cançons", + "playCount": "Reproduccions", + "name": "Nom", + "genre": "Gènere", + "compilation": "Compilació", + "year": "Any", + "updatedAt": "Actualitzat ", + "comment": "Comentari", + "rating": "Valoració", + "createdAt": "Data d'addició", + "size": "Mida", + "originalDate": "Original", + "releaseDate": "Publicat", + "releases": "LLançament |||| Llançaments", + "released": "Publicat", + "recordLabel": "Discogràfica", + "catalogNum": "Número de catàleg", + "releaseType": "Tipus de publicació", + "grouping": "Agrupació", + "media": "Mitjà", + "mood": "Sentiment", + "date": "Data d'enregistrament", + "missing": "Desaparegut", + "libraryName": "Biblioteca" + }, + "actions": { + "playAll": "Reprodueix", + "playNext": "Reprodueix la següent", + "addToQueue": "Reprodueix després", + "shuffle": "Aleatori", + "addToPlaylist": "Afegeix a la llista", + "download": "Descarrega", + "info": "Obtén informació", + "share": "Compartir" + }, + "lists": { + "all": "Tot", + "random": "Aleatori", + "recentlyAdded": "Afegits recentment", + "recentlyPlayed": "Reproduïts recentment", + "mostPlayed": "Més reproduïts", + "starred": "Preferits", + "topRated": "Més ben valorats" + } + }, + "artist": { + "name": "Artista |||| Artistes", + "fields": { + "name": "Nom", + "albumCount": "Nombre d'àlbums", + "songCount": "Nombre de cançons", + "playCount": "Reproduccions", + "rating": "Valoració", + "genre": "Gènere", + "size": "Mida", + "role": "Rol", + "missing": "Desaparegut" + }, + "roles": { + "albumartist": "Artista de l'Àlbum |||| Artistes de l'Àlbum", + "artist": "Artista |||| Artistes", + "composer": "Compositor |||| Compositors", + "conductor": "Director |||| Directors", + "lyricist": "Lletrista |||| Lletristes", + "arranger": "Arranjador |||| Arranjadors", + "producer": "Productor |||| Productors", + "director": "Director |||| Directors", + "engineer": "Enginyer |||| Enginyers", + "mixer": "Mesclador |||| Mescladors", + "remixer": "Remesclador |||| Remescladors", + "djmixer": "Mesclador DJ |||| Mescladors DJ", + "performer": "Intèrpret |||| Intèrprets", + "maincredit": "Artista de l'àlbum or Artista |||| Artistes de l'àlbum or Artistes" + }, + "actions": { + "shuffle": "Barreja", + "radio": "Ràdio", + "topSongs": "Cançons populars" + } + }, + "user": { + "name": "Usuari |||| Usuaris", + "fields": { + "userName": "Nom d'usuari", + "isAdmin": "És admin", + "lastLoginAt": "Última connexió", + "updatedAt": "Actualitzat", + "name": "Nom", + "password": "Contrasenya", + "createdAt": "Creat", + "changePassword": "Canviar la contrasenya?", + "currentPassword": "Contrasenya actual", + "newPassword": "Contrasenya nova", + "token": "Token", + "lastAccessAt": "Últim accés", + "libraries": "Biblioteques" + }, + "helperTexts": { + "name": "Els canvis en el nom s'hi aplicaran en la següent connexió", + "libraries": "Seleccioneu biblioteques específiques per a aquest usuari o deixeu-ho buit per utilitzar les biblioteques predeterminades" + }, + "notifications": { + "created": "Usuari creat", + "updated": "Usuari actualitzat", + "deleted": "Usuari eliminat" + }, + "message": { + "listenBrainzToken": "Introduïu el vostre token d'usuari de ListenBrainz", + "clickHereForToken": "Feu clic ací per a obtenir el vostre token", + "selectAllLibraries": "Selecciona totes les biblioteques", + "adminAutoLibraries": "Els administradors tenen accés a totes les biblioteques automàticament" + }, + "validation": { + "librariesRequired": "Cal que trieu almenys una biblioteca per als usuaris que no siguin administradors" + } + }, + "player": { + "name": "Reproductor |||| Reproductors", + "fields": { + "name": "Nom", + "transcodingId": "Transcodificador", + "maxBitRate": "Taxa de bits màx.", + "client": "Client", + "userName": "Nom d'usuari", + "lastSeen": "Vist", + "reportRealPath": "Informa de la ruta real", + "scrobbleEnabled": "Activa el seguiment des de serveis externs" + } + }, + "transcoding": { + "name": "Transcodificador |||| Transcodificadors", + "fields": { + "name": "Nom", + "targetFormat": "Format desitjat", + "defaultBitRate": "Taxa de bits per defecte", + "command": "Ordre" + } + }, + "playlist": { + "name": "Llista |||| Llistes", + "fields": { + "name": "Nom", + "duration": "Durada", + "ownerName": "Propietari", + "public": "Públic", + "updatedAt": "Actualitzat ", + "createdAt": "Creat", + "songCount": "Cançons", + "comment": "Comentari", + "sync": "Auto-importació", + "path": "Importa de" + }, + "actions": { + "selectPlaylist": "Selecciona una llista:", + "addNewPlaylist": "Crea \"%{nom}", + "export": "Exporta", + "makePublic": "Fes públic", + "makePrivate": "Fes privat", + "saveQueue": "Desar la cua a una llista", + "searchOrCreate": "Cerca llistes o escriu per crear-ne de noves...", + "pressEnterToCreate": "Prem Retorn per crear una nova llista", + "removeFromSelection": "Elimina de la selecció" + }, + "message": { + "duplicate_song": "Afegeix cançons duplicades", + "song_exist": "Heu afegit duplicats a la llista. Voleu afegir-los o ignorar-los?", + "noPlaylistsFound": "No s'ha trobat cap llista", + "noPlaylists": "No hi ha cap llista disponible" + } + }, + "radio": { + "name": "Ràdio |||| Ràdios", + "fields": { + "name": "Nom", + "streamUrl": "URL del flux", + "homePageUrl": "URL principal", + "updatedAt": "Actualitzat", + "createdAt": "Creat" + }, + "actions": { + "playNow": "Reprodueix" + } + }, + "share": { + "name": "Compartir |||| Compartits", + "fields": { + "username": "Compartit per", + "url": "URL", + "description": "Descripció", + "contents": "Continguts", + "expiresAt": "Caduca", + "lastVisitedAt": "Última Visita", + "visitCount": "Visites", + "format": "Format", + "maxBitRate": "Taxa de bits màx.", + "updatedAt": "Actualitzat", + "createdAt": "Creat", + "downloadable": "Permet descarregar?" + } + }, + "missing": { "name": "Fitxer faltant |||| Fitxers Faltants", - "empty": "No falten fitxers", "fields": { "path": "Directori", "size": "Mida", - "updatedAt": "Desaparegut" + "updatedAt": "Desaparegut", + "libraryName": "Biblioteca" }, "actions": { - "remove": "Eliminar" + "remove": "Eliminar", + "remove_all": "Suprimeix-ho tot" }, "notifications": { "removed": "Fitxers faltants eliminats" + }, + "empty": "No falten fitxers" + }, + "library": { + "name": "Biblioteca |||| Biblioteques\n", + "fields": { + "name": "Nom", + "path": "Camí", + "remotePath": "Camí remot", + "lastScanAt": "Últim escaneig", + "songCount": "Cançons", + "albumCount": "Àlbums", + "artistCount": "Artistes", + "totalSongs": "Cançons", + "totalAlbums": "Àlbums", + "totalArtists": "Artistes", + "totalFolders": "Carpetes", + "totalFiles": "Fitxers", + "totalMissingFiles": "Fitxers desapareguts", + "totalSize": "Mida total", + "totalDuration": "Durada", + "defaultNewUsers": "Predeterminat per a usuaris nous", + "createdAt": "Creat", + "updatedAt": "Actualitzat" + }, + "sections": { + "basic": "Informació bàsica", + "statistics": "Estadístiques" + }, + "actions": { + "scan": "Escaneja la biblioteca", + "manageUsers": "Gestiona l'accés d'usuari", + "viewDetails": "Mostra els detalls", + "quickScan": "Escaneig ràpid", + "fullScan": "Escaneig complet" + }, + "notifications": { + "created": "La biblioteca s'ha creat correctament", + "updated": "La biblioteca s'ha actualitzat correctament", + "deleted": "La biblioteca s'ha suprimit correctament", + "scanStarted": "Començant l'escaneig de la biblioteca", + "scanCompleted": "S'ha completat l'escaneig de la biblioteca", + "quickScanStarted": "Començant escaneig ràpid", + "fullScanStarted": "Començant escaneig complet", + "scanError": "S'ha produït un error en començar l'escaneig. Comproveu els registres" + }, + "validation": { + "nameRequired": "Es requereix un nom per la biblioteca", + "pathRequired": "Es requereix un camí a la biblioteca", + "pathNotDirectory": "El camí a la biblioteca ha de ser un directori", + "pathNotFound": "No s'ha trobat el camí a la biblioteca", + "pathNotAccessible": "No es pot accedir al camí de la biblioteca ", + "pathInvalid": "Camí a la llibreria no vàlid" + }, + "messages": { + "deleteConfirm": "Esteu segur que voleu suprimir aquesta biblioteca? Se'n suprimiran totes les dades associades i els accessos d'usuari.", + "scanInProgress": "Escaneig en curs...", + "noLibrariesAssigned": "Aquest usuari no té cap biblioteca assignada" + } + }, + "plugin": { + "name": "\nConnector |||| Connectors", + "fields": { + "id": "ID", + "name": "Nom", + "description": "Descripció", + "version": "Versió", + "author": "Autor", + "website": "Lloc web", + "permissions": "Permissos", + "enabled": "Activat", + "status": "Estat", + "path": "Camí", + "lastError": "Error", + "hasError": "Error", + "updatedAt": "Actualitzat", + "createdAt": "Instal·lat", + "configKey": "Clau", + "configValue": "Valor", + "allUsers": "Permet tots els usuaris", + "selectedUsers": "Usuaris seleccionats", + "allLibraries": "Permet totes les llibreries", + "selectedLibraries": "Biblioteques seleccionades", + "allowWriteAccess": "" + }, + "sections": { + "status": "Estat", + "info": "Informació del controlador", + "configuration": "Configuració", + "manifest": "Manifest", + "usersPermission": "Permís dels usuaris", + "libraryPermission": "Permís de la llibreria" + }, + "status": { + "enabled": "Activat", + "disabled": "Desactivat" + }, + "actions": { + "enable": "Activa", + "disable": "Desactiva", + "disabledDueToError": "Arregleu l'error abans de l'activació", + "disabledUsersRequired": "Seleccioneu els usuaris abans de l'activació", + "disabledLibrariesRequired": "Seleccioneu les biblioteques abans de l'activació", + "addConfig": "Afegeix una configuració", + "rescan": "Torna a escanejar" + }, + "notifications": { + "enabled": "Controlador activat", + "disabled": "Controlador desactivat", + "updated": "Controlador activat", + "error": "S'ha produït un error en actualitzar el controlador" + }, + "validation": { + "invalidJson": "El fitxer Configuració ha de ser un JSON vàlid" + }, + "messages": { + "configHelp": "Configureu el controlador utilitzant parelles clau-valor. Deixeu-ho buit si el controlador no requereix cap configuració.", + "clickPermissions": "Feu clic en un permís per veure’n els detalls", + "noConfig": "No s'ha establert cap configuració", + "allUsersHelp": "Quan està activat, el controlador té accés a tots els usuaris, inclosos els creats a posteriori.", + "noUsers": "No s'ha seleccionat cap usuari", + "permissionReason": "Motiu", + "usersRequired": "Aquest controlador necessita accedir a la informació de la biblioteca. Selecciona a quines biblioteques pot accedir o activa «Permet tots els usuaris».", + "allLibrariesHelp": "Quan està activat, el controlador té accés a totes les llibreries, incloses les creades a posteriori.", + "noLibraries": "No s'ha seleccionat cap biblioteca", + "librariesRequired": "Aquest controlador necessita accedir a la informació de la biblioteca. Selecciona a quines biblioteques pot accedir o activa «Permet totes les biblioteques».", + "requiredHosts": "Hosts requerits", + "configValidationError": "Ha fallat la validació de la configuració:", + "schemaRenderError": "No s'ha pogut renderitzar el formulari de configuració. És possible que l'esquema del controlador sigui invàlid.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "clau", + "configValue": "valor" } } }, - "ra": { - "auth": { - "welcome1": "Gràcies d'haver instal·lat Navidrome!", - "welcome2": "Per a començar, creeu un usuari administrador", - "confirmPassword": "Confirmeu la contrasenya", - "buttonCreateAdmin": "Crea un administrador", - "auth_check_error": "Si us plau, inicieu sessió per a continuar", - "user_menu": "Perfil", - "username": "Nom d'usuari", - "password": "Contrasenya", - "sign_in": "Inicia sessió", - "sign_in_error": "L'autenticació ha fallat, torneu-ho a intentar", - "logout": "Sortida", - "insightsCollectionNote": "Navidrome recull dades d'us anonimitzades per\najudar a millorar el projecte. Clica [aquí] per a saber-ne\nmés i no participar-hi si no vols" - }, - "validation": { - "invalidChars": "Si us plau, useu només lletres i nombres", - "passwordDoesNotMatch": "Les contrasenyes no coincideixen", - "required": "Obligatori", - "minLength": "Ha de tenir, si més no, %{min} caràcters", - "maxLength": "Ha de tenir %{max} caràcters o menys", - "minValue": "Ha de ser com a mínim %{min}", - "maxValue": "Ha de ser %{max} o menys", - "number": "Ha de ser un nombre", - "email": "Ha de ser un correu vàlid", - "oneOf": "Ha de ser un de: %{options}", - "regex": "Ha de tenir el format (regexp): %{pattern}", - "unique": "Ha de ser únic", - "url": "Ha de ser una URL vàlida" - }, - "action": { - "add_filter": "Afegeix un filtre", - "add": "Afegeix", - "back": "Enrere", - "bulk_actions": "1 element seleccionat |||| %{smart_count} elements seleccionats", - "bulk_actions_mobile": "1 |||| %{smart_count}", - "cancel": "Cancel·la", - "clear_input_value": "Neteja el valor", - "clone": "Clona", - "confirm": "Confirma", - "create": "Crea", - "delete": "Suprimeix", - "edit": "Edita", - "export": "Exporta", - "list": "Llista", - "refresh": "Refresca", - "remove_filter": "Suprimeix aquest filtre", - "remove": "Elimina", - "save": "Desa", - "search": "Cerca", - "show": "Mostra", - "sort": "Ordena", - "undo": "Desfés", - "expand": "Expandeix", - "close": "Tanca", - "open_menu": "Obre el menú", - "close_menu": "Tanca el menú", - "unselect": "Anul·la la selecció", - "skip": "Omet", - "share": "Compartir", - "download": "Descarregar" - }, - "boolean": { - "true": "Sí", - "false": "No" - }, - "page": { - "create": "Crea %{nom}", - "dashboard": "Tauler", - "edit": "%{name} #%{id}", - "error": "Alguna cosa ha fallat", - "list": "%{name}", - "loading": "Ara es carrega", - "not_found": "No s'ha trobat", - "show": "%{name} #%{id}", - "empty": "No hi ha %{name} encara.", - "invite": "Voleu afegir-ne una?" - }, - "input": { - "file": { - "upload_several": "Deixeu caure-hi fitxers per a carregar-los o feu clic per a seleccionar-ne un.", - "upload_single": "Deixeu caure-hi un fitxer per a carregar o feu clic per a seleccionar-lo." - }, - "image": { - "upload_several": "Deixeu caure-hi imatges per a carregar-les o feu clic per a seleccionar-ne una.", - "upload_single": "Deixeu caure-hi una imatge per a carregar-la o feu clic per a seleccionar-la." - }, - "references": { - "all_missing": "No ha estat possible trobar les dades de referència.", - "many_missing": "Sembla que almenys una de les referències associades ja no està disponible.", - "single_missing": "Sembla que la referència associada ja no està disponible." - }, - "password": { - "toggle_visible": "Amaga la contrasenya", - "toggle_hidden": "Mostra la contrasenya" - } - }, - "message": { - "about": "Quant a...", - "are_you_sure": "N'esteu segur?", - "bulk_delete_content": "Voleu eliminar aquest %{name}? |||| Voleu eliminar aquests %{smart_count} element?\n", - "bulk_delete_title": "Esborra %{name} |||| Esborra %{smart_count} %{name}", - "delete_content": "Segur que voleu eliminar aquest element?", - "delete_title": "Elimina %{name} #%{id}", - "details": "Detalls", - "error": "S'ha produït un error en un client i la vostra sol·licitud no ha pogut ser completada.", - "invalid_form": "El formulari no és vàlid.", - "loading": "La pàgina es carrega, un moment si us plau.", - "no": "No", - "not_found": "La URL és incorrecta o heu seguit un enllaç erroni.", - "yes": "Sí", - "unsaved_changes": "Alguns canvis no s'hi han desat. Segur que voleu ignorar-los?" - }, - "navigation": { - "no_results": "No s'ha trobat", - "no_more_results": "La pàgina número %{page} no existeix. Proveu l'anterior.", - "page_out_of_boundaries": "La pàgina número %{page} no existeix", - "page_out_from_end": "No podeu anar més enllà de la darrera pàgina", - "page_out_from_begin": "No podeu anar més enllà de la primera pàgina", - "page_range_info": "%{offsetBegin}-%{offsetEnd} de %{total}", - "page_rows_per_page": "Elements per pàgina:", - "next": "Següent", - "prev": "Anterior", - "skip_nav": "Salta al contingut" - }, - "notification": { - "updated": "Element actualitzat |||| %{smart_count} elements actualitzats", - "created": "Element creat", - "deleted": "Element actualitzat |||| %{smart_count} elements actualitzats", - "bad_item": "Element incorrecte", - "item_doesnt_exist": "L'element no existeix", - "http_error": "Error de comunicació del servidor", - "data_provider_error": "dataProvider error. Vegeu la consola si en voleu més detalls.", - "i18n_error": "No ha estat possible carregar les traduccions per a l'idioma indicat", - "canceled": "Acció cancel·lada", - "logged_out": "La sessió ha acabat, si us plau reconnecteu", - "new_version": "Hi ha una versió nova disponible! Si us plau actualitzeu aquesta finestra." - }, - "toggleFieldsMenu": { - "columnsToDisplay": "Columnes a mostrar", - "layout": "Disposició", - "grid": "Quadrícula", - "table": "Taula" - } + "ra": { + "auth": { + "welcome1": "Gràcies d'haver instal·lat Navidrome!", + "welcome2": "Per a començar, creeu un usuari administrador", + "confirmPassword": "Confirmeu la contrasenya", + "buttonCreateAdmin": "Crea un administrador", + "auth_check_error": "Si us plau, inicieu sessió per a continuar", + "user_menu": "Perfil", + "username": "Nom d'usuari", + "password": "Contrasenya", + "sign_in": "Inicia sessió", + "sign_in_error": "L'autenticació ha fallat, torneu-ho a intentar", + "logout": "Sortida", + "insightsCollectionNote": "Navidrome recull dades d'us anonimitzades per\najudar a millorar el projecte. Clica [aquí] per a saber-ne\nmés i no participar-hi si no vols" + }, + "validation": { + "invalidChars": "Si us plau, utilitzeu només lletres i nombres", + "passwordDoesNotMatch": "Les contrasenyes no coincideixen", + "required": "Obligatori", + "minLength": "Ha de tenir, si més no, %{min} caràcters", + "maxLength": "Ha de tenir %{max} caràcters o menys", + "minValue": "Ha de ser com a mínim %{min}", + "maxValue": "Ha de ser %{max} o menys", + "number": "Ha de ser un nombre", + "email": "Ha de ser un correu vàlid", + "oneOf": "Ha de ser un de: %{options}", + "regex": "Ha de tenir el format (regexp): %{pattern}", + "unique": "Ha de ser únic", + "url": "Ha de ser una URL vàlida" + }, + "action": { + "add_filter": "Afegeix un filtre", + "add": "Afegeix", + "back": "Enrere", + "bulk_actions": "1 element seleccionat |||| %{smart_count} elements seleccionats", + "cancel": "Cancel·la", + "clear_input_value": "Neteja el valor", + "clone": "Clona", + "confirm": "Confirma", + "create": "Crea", + "delete": "Suprimeix", + "edit": "Edita", + "export": "Exporta", + "list": "Llista", + "refresh": "Refresca", + "remove_filter": "Suprimeix aquest filtre", + "remove": "Elimina", + "save": "Desa", + "search": "Cerca", + "show": "Mostra", + "sort": "Ordena", + "undo": "Desfés", + "expand": "Expandeix", + "close": "Tanca", + "open_menu": "Obre el menú", + "close_menu": "Tanca el menú", + "unselect": "Anul·la la selecció", + "skip": "Omet", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Compartir", + "download": "Descarregar" + }, + "boolean": { + "true": "Sí", + "false": "No" + }, + "page": { + "create": "Crea %{nom}", + "dashboard": "Tauler", + "edit": "%{name} #%{id}", + "error": "Alguna cosa ha fallat", + "list": "%{name}", + "loading": "Ara es carrega", + "not_found": "No s'ha trobat", + "show": "%{name} #%{id}", + "empty": "No hi ha %{name} encara.", + "invite": "Voleu afegir-ne una?" + }, + "input": { + "file": { + "upload_several": "Deixeu caure-hi fitxers per a carregar-los o feu clic per a seleccionar-ne un.", + "upload_single": "Deixeu caure-hi un fitxer per a carregar o feu clic per a seleccionar-lo." + }, + "image": { + "upload_several": "Deixeu caure-hi imatges per a carregar-les o feu clic per a seleccionar-ne una.", + "upload_single": "Deixeu caure-hi una imatge per a carregar-la o feu clic per a seleccionar-la." + }, + "references": { + "all_missing": "No ha estat possible trobar les dades de referència.", + "many_missing": "Sembla que almenys una de les referències associades ja no està disponible.", + "single_missing": "Sembla que la referència associada ja no està disponible." + }, + "password": { + "toggle_visible": "Amaga la contrasenya", + "toggle_hidden": "Mostra la contrasenya" + } }, "message": { - "note": "NOTA", - "transcodingDisabled": "Per motius de seguretat, el canvi de configuració del trasnscodificador amb la interfície web no està habilitat. Si voleu canviar les opcions de transcodificació (sia editar-les sia afegir-ne), reinicieu el servidor amb l'opció %{config}.", - "transcodingEnabled": "Ara Navidrome s'executa amb %{config}, cosa que fa possible executar ordres del sistema des de les opcions de transcodificació usant la interfície web. Per motius de seguretat us recomanem que només l'activeu quan necessiteu configurar les opcions de transcodificació.", - "songsAddedToPlaylist": "S'ha afegit 1 cançó a la llista |||| S'han afegit %{smart_count} a la llista", - "noPlaylistsAvailable": "No n'hi ha cap disponible", - "delete_user_title": "Esborra usuari '%{nom}'", - "delete_user_content": "Segur que voleu eliminar aquest usuari i les seues dades\n(incloent-hi llistes i preferències)", - "remove_missing_title": "Eliminar fitxers faltants", - "remove_missing_content": "Segur que vols eliminar els fitxers faltants seleccionats de la base de dades? Això eliminarà permanentment les referències a ells, incloent-hi el nombre de reproduccions i les valoracions.", - "notifications_blocked": "Heu blocat les notificacions d'escriptori en les preferències del navegador", - "notifications_not_available": "El navegador no suporta les notificacions o no heu connectat a Navidrome per https", - "lastfmLinkSuccess": "Ha reexit la vinculació amb Last.fm i se n'ha activat el seguiment", - "lastfmLinkFailure": "No ha estat possible la vinculació amb Last.fm", - "lastfmUnlinkSuccess": "Desvinculat de Last.fm i desactivat el seguiment", - "lastfmUnlinkFailure": "No s'ha pogut desvincular de Last.fm", - "listenBrainzLinkSuccess": "Connectat correctament a ListenBrainz i seguiment activat com a: %{user}", - "listenBrainzLinkFailure": "No s'ha pogut connectar a ListenBrainz: %{error}", - "listenBrainzUnlinkSuccess": "ListenBrainz desconnectat i seguiment desactivat", - "listenBrainzUnlinkFailure": "No s'ha pogut desconnectar de ListenBrainz", - "openIn": { - "lastfm": "Obri en Last.fm", - "musicbrainz": "Obri en MusicBrainz" - }, - "lastfmLink": "Llegeix més...", - "shareOriginalFormat": "Compartir en format original", - "shareDialogTitle": "Compartir %{resource} '%{name}'", - "shareBatchDialogTitle": "Compartir 1 %{resource} |||| Compartir %{smart_count} %{resource}", - "shareCopyToClipboard": "Copiar al porta-retalls: Ctrl+C, Enter", - "shareSuccess": "URL copiada al porta-retalls: %{url}", - "shareFailure": "Error copiant URL %{url} al porta-retalls", - "downloadDialogTitle": "Deascarregar %{resource} '%{name}' (%{size})", - "downloadOriginalFormat": "Descarregar en format original" + "about": "Quant a...", + "are_you_sure": "N'esteu segur?", + "bulk_delete_content": "Voleu eliminar aquest %{name}? |||| Voleu eliminar aquests %{smart_count} element?\n", + "bulk_delete_title": "Esborra %{name} |||| Esborra %{smart_count} %{name}", + "delete_content": "Segur que voleu eliminar aquest element?", + "delete_title": "Elimina %{name} #%{id}", + "details": "Detalls", + "error": "S'ha produït un error en un client i la vostra sol·licitud no ha pogut ser completada.", + "invalid_form": "El formulari no és vàlid.", + "loading": "La pàgina es carrega, un moment si us plau.", + "no": "No", + "not_found": "La URL és incorrecta o heu seguit un enllaç erroni.", + "yes": "Sí", + "unsaved_changes": "Alguns canvis no s'hi han desat. Segur que voleu ignorar-los?" }, - "menu": { - "library": "Discoteca", - "settings": "Configuració", - "version": "Versió", - "theme": "Tema", - "personal": { - "name": "Personal", - "options": { - "theme": "Tema", - "language": "Llengua", - "defaultView": "Vista per defecte", - "desktop_notifications": "Notificacions d'escriptori", - "lastfmNotConfigured": "No s'ha configurat l'API de Last.fm", - "lastfmScrobbling": "Activa el seguiment de Last.fm", - "listenBrainzScrobbling": "Activa el seguiment de ListenBrainz", - "replaygain": "Mode ReplayGain", - "preAmp": "PreAmp de ReplayGain (dB)", - "gain": { - "none": "Cap", - "album": "Guany de l'àlbum", - "track": "Guany de la pista" - } - } - }, - "albumList": "Àlbums", - "about": "Quant a...", - "playlists": "Llistes", - "sharedPlaylists": "Llistes compartides" + "navigation": { + "no_results": "No s'ha trobat", + "no_more_results": "La pàgina número %{page} no existeix. Proveu l'anterior.", + "page_out_of_boundaries": "La pàgina número %{page} no existeix", + "page_out_from_end": "No podeu anar més enllà de la darrera pàgina", + "page_out_from_begin": "No podeu anar més enllà de la primera pàgina", + "page_range_info": "%{offsetBegin}-%{offsetEnd} de %{total}", + "page_rows_per_page": "Elements per pàgina:", + "next": "Següent", + "prev": "Anterior", + "skip_nav": "Salta al contingut" }, - "player": { - "playListsText": "Reprodueix la cua", - "openText": "Obre", - "closeText": "Tanca", - "notContentText": "No hi ha música", - "clickToPlayText": "Feu clic per a reproduir", - "clickToPauseText": "Feu clic per a posar en pausa", - "nextTrackText": "Pista següent", - "previousTrackText": "Pista anterior", - "reloadText": "Recarrega", - "volumeText": "Volum", - "toggleLyricText": "Activa / desactiva lletra", - "toggleMiniModeText": "Minimitza", - "destroyText": "Destrueix", - "downloadText": "Descarrega", - "removeAudioListsText": "Elimina llistes d'àudio", - "clickToDeleteText": "Feu clic per a eliminar %{name}", - "emptyLyricText": "Sense lletra", - "playModeText": { - "order": "En ordre", - "orderLoop": "Repeteix", - "singleLoop": "Repeteix una vegada", - "shufflePlay": "Aleatori" - } + "notification": { + "updated": "Element actualitzat |||| %{smart_count} elements actualitzats", + "created": "Element creat", + "deleted": "Element actualitzat |||| %{smart_count} elements actualitzats", + "bad_item": "Element incorrecte", + "item_doesnt_exist": "L'element no existeix", + "http_error": "Error de comunicació del servidor", + "data_provider_error": "dataProvider error. Vegeu la consola si en voleu més detalls.", + "i18n_error": "No ha estat possible carregar les traduccions per a l'idioma indicat", + "canceled": "Acció cancel·lada", + "logged_out": "La sessió ha acabat, si us plau reconnecteu", + "new_version": "Hi ha una versió nova disponible! Si us plau actualitzeu aquesta finestra." }, - "about": { - "links": { - "homepage": "Inici", - "source": "Codi font", - "featureRequests": "Sol·licitud de funcionalitats", - "lastInsightsCollection": "Última recolecció d'informació", - "insights": { - "disabled": "Desactivada", - "waiting": "Esperant" - } - } - }, - "activity": { - "title": "Activitat", - "totalScanned": "Carpetes escanejades en total", - "quickScan": "Escaneig ràpid", - "fullScan": "Escaneig complet", - "serverUptime": "Temps de funcionament del servidor", - "serverDown": "Sense connexió" - }, - "help": { - "title": "Dreceres de teclat de Navidrome", - "hotkeys": { - "show_help": "Mostra aquesta ajuda", - "toggle_menu": "Commuta la barra lateral", - "toggle_play": "Reprodueix / Pausa", - "prev_song": "Cançó anterior", - "next_song": "Cançó següent", - "vol_up": "Apuja el volum", - "vol_down": "Abaixa el volum", - "toggle_love": "Afegeix la pista a favorits", - "current_song": "Anar a la cançó actual" - } + "toggleFieldsMenu": { + "columnsToDisplay": "Columnes a mostrar", + "layout": "Disposició", + "grid": "Quadrícula", + "table": "Taula" } + }, + "message": { + "note": "NOTA", + "transcodingDisabled": "Per motius de seguretat, el canvi de configuració del transcodificador amb la interfície web està desactivat. Si voleu canviar les opcions de transcodificació (sia editar-les sia afegir-ne), reinicieu el servidor amb l'opció %{config}.", + "transcodingEnabled": "Navidrome s'executa amb %{config}, cosa que fa possible executar ordres del sistema des de les opcions de transcodificació usant la interfície web. Per motius de seguretat us recomanem que només l'activeu quan necessiteu configurar les opcions de transcodificació.", + "songsAddedToPlaylist": "S'ha afegit 1 cançó a la llista |||| S'han afegit %{smart_count} a la llista", + "noPlaylistsAvailable": "No n'hi ha cap disponible", + "delete_user_title": "Esborra usuari '%{nom}'", + "delete_user_content": "Segur que voleu eliminar aquest usuari i les seues dades\n(incloent-hi llistes i preferències)", + "notifications_blocked": "Heu blocat les notificacions d'escriptori en les preferències del navegador", + "notifications_not_available": "El navegador no és compatible amb les notificacions o no us heu connectat a Navidrome per https", + "lastfmLinkSuccess": "Ha reexit la vinculació amb Last.fm i se n'ha activat el seguiment", + "lastfmLinkFailure": "No ha estat possible la vinculació amb Last.fm", + "lastfmUnlinkSuccess": "Desvinculat de Last.fm i desactivat el seguiment", + "lastfmUnlinkFailure": "No s'ha pogut desvincular de Last.fm", + "openIn": { + "lastfm": "Obri en Last.fm", + "musicbrainz": "Obri en MusicBrainz" + }, + "lastfmLink": "Llegeix més...", + "listenBrainzLinkSuccess": "Connectat correctament a ListenBrainz i seguiment activat com a: %{user}", + "listenBrainzLinkFailure": "No s'ha pogut connectar a ListenBrainz: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz desconnectat i seguiment desactivat", + "listenBrainzUnlinkFailure": "No s'ha pogut desconnectar de ListenBrainz", + "downloadOriginalFormat": "Descarregar en el format original", + "shareOriginalFormat": "Compartir en format original", + "shareDialogTitle": "Compartir %{resource} '%{name}'", + "shareBatchDialogTitle": "Compartir 1 %{resource} |||| Compartir %{smart_count} %{resource}", + "shareSuccess": "URL copiada al porta-retalls: %{url}", + "shareFailure": "Error copiant URL %{url} al porta-retalls", + "downloadDialogTitle": "Deascarregar %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Copiar al porta-retalls: Ctrl+C, Enter", + "remove_missing_title": "Eliminar fitxers faltants", + "remove_missing_content": "Segur que vols eliminar els fitxers faltants seleccionats de la base de dades? Això eliminarà permanentment les referències a ells, incloent-hi el nombre de reproduccions i les valoracions.", + "remove_all_missing_title": "Suprimir tots els fitxers perduts", + "remove_all_missing_content": "Esteu segur que voleu eliminar tots els fitxers desapareguts de la base de dades? Se n'eliminarà permanentment qualsevol referència, inclosos el nombre de reproduccions i les puntuacions.", + "noSimilarSongsFound": "No s'ha trobat cap cançó similar", + "noTopSongsFound": "No s'ha trobat cap cançó popular", + "startingInstantMix": "S'està carregant la mescla immediata..." + }, + "menu": { + "library": "Biblioteca", + "settings": "Configuració", + "version": "Versió", + "theme": "Tema", + "personal": { + "name": "Personal", + "options": { + "theme": "Tema", + "language": "Llengua", + "defaultView": "Vista per defecte", + "desktop_notifications": "Notificacions d'escriptori", + "lastfmScrobbling": "Activa el seguiment de Last.fm", + "listenBrainzScrobbling": "Activa el seguiment de ListenBrainz", + "replaygain": "Mode ReplayGain", + "preAmp": "PreAmp de ReplayGain (dB)", + "gain": { + "none": "Cap", + "album": "Guany de l'àlbum", + "track": "Guany de la pista" + }, + "lastfmNotConfigured": "No s'ha configurat l'API de Last.fm" + } + }, + "albumList": "Àlbums", + "about": "Quant a...", + "playlists": "Llistes", + "sharedPlaylists": "Llistes compartides", + "librarySelector": { + "allLibraries": "Totes les llibreries (%{count})", + "multipleLibraries": "%{selected} de %{total} Biblioteques", + "selectLibraries": "Selecciona les biblioteques", + "none": "Cap" + } + }, + "player": { + "playListsText": "Reprodueix la cua", + "openText": "Obre", + "closeText": "Tanca", + "notContentText": "No hi ha música", + "clickToPlayText": "Feu clic per a reproduir", + "clickToPauseText": "Feu clic per a posar en pausa", + "nextTrackText": "Pista següent", + "previousTrackText": "Pista anterior", + "reloadText": "Recarrega", + "volumeText": "Volum", + "toggleLyricText": "Activa / desactiva lletra", + "toggleMiniModeText": "Minimitza", + "destroyText": "Destrueix", + "downloadText": "Descarrega", + "removeAudioListsText": "Elimina llistes d'àudio", + "clickToDeleteText": "Feu clic per a eliminar %{name}", + "emptyLyricText": "Sense lletra", + "playModeText": { + "order": "En ordre", + "orderLoop": "Repeteix", + "singleLoop": "Repeteix una vegada", + "shufflePlay": "Aleatori" + } + }, + "about": { + "links": { + "homepage": "Inici", + "source": "Codi font", + "featureRequests": "Sol·licita funcionalitats", + "lastInsightsCollection": "Última recolecció d'informació", + "insights": { + "disabled": "Desactivada", + "waiting": "Esperant" + } + }, + "tabs": { + "about": "Quant a", + "config": "Configuració" + }, + "config": { + "configName": "Nom de Config", + "environmentVariable": "Variable d'entorn", + "currentValue": "Valor actual", + "configurationFile": "Fitxer de configuració", + "exportToml": "Exporta la configuració (TOML)", + "exportSuccess": "Configuració exportada al porta-retalls en format TOML", + "exportFailed": "La còpia de la configuració ha fallat", + "devFlagsHeader": "Indicadors de desenvolupament (subjecte a canvis o eliminació)", + "devFlagsComment": "Aquests paràmetres són experimentals i és possible que s'eliminin en versions futures", + "downloadToml": "Descarrega la configuració (TOML)" + } + }, + "activity": { + "title": "Activitat", + "totalScanned": "Carpetes escanejades en total", + "quickScan": "Escaneig ràpid", + "fullScan": "Escaneig complet", + "serverUptime": "Temps de funcionament del servidor", + "serverDown": "Sense connexió", + "scanType": "Últim escaneig", + "status": "Error d'escaneig", + "elapsedTime": "Temps transcorregut", + "selectiveScan": "Selectiu" + }, + "help": { + "title": "Dreceres de teclat de Navidrome", + "hotkeys": { + "show_help": "Mostra aquesta ajuda", + "toggle_menu": "Commuta la barra lateral", + "toggle_play": "Reprodueix / Pausa", + "prev_song": "Cançó anterior", + "next_song": "Cançó següent", + "vol_up": "Apuja el volum", + "vol_down": "Abaixa el volum", + "toggle_love": "Afegeix la pista a favorits", + "current_song": "Anar a la cançó actual" + } + }, + "nowPlaying": { + "title": "Està sonant", + "empty": "No s'està reproduint res", + "minutesAgo": "Fa %{smart_count} minut |||| Fa %{smart_count} minuts" + } } diff --git a/resources/i18n/da.json b/resources/i18n/da.json index 7d4258d2a..edb1df183 100644 --- a/resources/i18n/da.json +++ b/resources/i18n/da.json @@ -1,460 +1,721 @@ { - "languageName": "Dansk", - "resources": { - "song": { - "name": "Sang |||| Sange", - "fields": { - "albumArtist": "Album kunstner", - "duration": "Varighed", - "trackNumber": "#", - "playCount": "Afspilninger", - "title": "Titel", - "artist": "Kunstner", - "album": "Album navn", - "path": "Fil placering", - "genre": "Genre", - "compilation": "Samling", - "year": "År", - "size": "Fil størrelse", - "updatedAt": "Opdateret den", - "bitRate": "Bitrate", - "discSubtitle": "Plade undernavn", - "starred": "Stjernemarkeret", - "comment": "Kommentar", - "rating": "", - "quality": "", - "bpm": "", - "playDate": "", - "channels": "", - "createdAt": "" - }, - "actions": { - "addToQueue": "Afspil senere", - "playNow": "Afspil nu", - "addToPlaylist": "Tilføj til afspilningsliste", - "shuffleAll": "Bland alle", - "download": "Hent", - "playNext": "Spil næste", - "info": "" - } - }, - "album": { - "name": "Album |||| Albums", - "fields": { - "albumArtist": "Album kunstner", - "artist": "Kunstner", - "duration": "Varighed", - "songCount": "Sange", - "playCount": "Afspilninger", - "name": "Navn", - "genre": "Genre", - "compilation": "Samling", - "year": "År", - "updatedAt": "Opdateret den", - "comment": "Kommentar", - "rating": "", - "createdAt": "", - "size": "", - "originalDate": "", - "releaseDate": "", - "releases": "", - "released": "" - }, - "actions": { - "playAll": "Afspil", - "playNext": "Afspil næste", - "addToQueue": "Afspil senere", - "shuffle": "Bland", - "addToPlaylist": "Tilføj til afspilningsliste", - "download": "Hent", - "info": "", - "share": "" - }, - "lists": { - "all": "Alle", - "random": "Tilfældig", - "recentlyAdded": "Nyligt tilføjet", - "recentlyPlayed": "Nyligt Afspillet", - "mostPlayed": "Mest Afspillet", - "starred": "Stjernemarkeret", - "topRated": "" - } - }, - "artist": { - "name": "Kunstner |||| Kunstnere", - "fields": { - "name": "Navn", - "albumCount": "Antal album", - "songCount": "Antal sange", - "playCount": "Afspilninger", - "rating": "", - "genre": "", - "size": "" - } - }, - "user": { - "name": "Bruger |||| Brugere", - "fields": { - "userName": "Brugernavn", - "isAdmin": "Er administrator", - "lastLoginAt": "Sidste login", - "updatedAt": "Opdateret den", - "name": "Navn", - "password": "Kodeord", - "createdAt": "Oprettet den", - "changePassword": "", - "currentPassword": "", - "newPassword": "", - "token": "" - }, - "helperTexts": { - "name": "" - }, - "notifications": { - "created": "", - "updated": "", - "deleted": "" - }, - "message": { - "listenBrainzToken": "", - "clickHereForToken": "" - } - }, - "player": { - "name": "Afspiller |||| Afspillere", - "fields": { - "name": "Navn", - "transcodingId": "Omkodning", - "maxBitRate": "Maks. bitrate", - "client": "Klient", - "userName": "Brugernavn", - "lastSeen": "Sidst set", - "reportRealPath": "", - "scrobbleEnabled": "" - } - }, - "transcoding": { - "name": "Omkodning |||| Omkodninger", - "fields": { - "name": "Navn", - "targetFormat": "Målformat", - "defaultBitRate": "Standard bitrate", - "command": "Kommando" - } - }, - "playlist": { - "name": "Afspilningsliste |||| Afspilningslister", - "fields": { - "name": "Navn", - "duration": "Varighed", - "ownerName": "Ejer", - "public": "Offentlig", - "updatedAt": "Opdateret den", - "createdAt": "Oprettet den", - "songCount": "Sange", - "comment": "Kommentar", - "sync": "Auto-importér", - "path": "Importér fra" - }, - "actions": { - "selectPlaylist": "Vælg en afspilningsliste:", - "addNewPlaylist": "Opret \"%{name}\"", - "export": "Eksporter", - "makePublic": "", - "makePrivate": "" - }, - "message": { - "duplicate_song": "", - "song_exist": "" - } - }, - "radio": { - "name": "", - "fields": { - "name": "", - "streamUrl": "", - "homePageUrl": "", - "updatedAt": "", - "createdAt": "" - }, - "actions": { - "playNow": "" - } - }, - "share": { - "name": "", - "fields": { - "username": "", - "url": "", - "description": "", - "contents": "", - "expiresAt": "", - "lastVisitedAt": "", - "visitCount": "", - "format": "", - "maxBitRate": "", - "updatedAt": "", - "createdAt": "", - "downloadable": "" - } - } + "languageName": "Dansk", + "resources": { + "song": { + "name": "Sang |||| Sange", + "fields": { + "albumArtist": "Album kunstner", + "duration": "Varighed", + "trackNumber": "#", + "playCount": "Afspilninger", + "title": "Titel", + "artist": "Kunstner", + "album": "Album navn", + "path": "Filsti", + "genre": "Genre", + "compilation": "Opsamling", + "year": "År", + "size": "Fil størrelse", + "updatedAt": "Opdateret den", + "bitRate": "Bitrate", + "discSubtitle": "Plade undertitel", + "starred": "Stjernemarkeret", + "comment": "Kommentar", + "rating": "Bedømmelse", + "quality": "Kvalitet", + "bpm": "BPM", + "playDate": "Senest afspillet", + "channels": "Kanaler", + "createdAt": "Tilføjet d.", + "grouping": "Gruppering", + "mood": "Humør", + "participants": "Yderligere deltagere", + "tags": "Yderligere tags", + "mappedTags": "Mappede tags", + "rawTags": "Rå tags", + "bitDepth": "Bitdybde", + "sampleRate": "Samplingfrekvens", + "missing": "Manglende", + "libraryName": "Bibliotek", + "composer": "Komponist", + "disc": "Disk %{discNumber}" + }, + "actions": { + "addToQueue": "Afspil senere", + "playNow": "Afspil nu", + "addToPlaylist": "Føj til afspilningsliste", + "shuffleAll": "Bland alle", + "download": "Download", + "playNext": "Afspil næste", + "info": "Hent info", + "showInPlaylist": "Vis i afspilningsliste", + "instantMix": "Instant Mix" + } }, - "ra": { - "auth": { - "welcome1": "Tak fordi du installerede Navidrome!", - "welcome2": "Opret administrator for at begynde", - "confirmPassword": "Bekræft kodeord", - "buttonCreateAdmin": "Opret administrator", - "auth_check_error": "Venligst login for at fortsætte", - "user_menu": "Profil", - "username": "Brugernavn", - "password": "Password", - "sign_in": "Log ind", - "sign_in_error": "Dit log ind fejlede, prøv igen", - "logout": "Log ud" - }, - "validation": { - "invalidChars": "Vær venlig kun at benytte bogstaver og tal", - "passwordDoesNotMatch": "Kodeord er ikke ens", - "required": "Obligatorisk", - "minLength": "Skal være mindst %{min} tegn", - "maxLength": "Skal være max %{max} tegn", - "minValue": "Skal være mindst %{min}", - "maxValue": "Skal være max %{max}", - "number": "Skal være et nummer", - "email": "Skal være en gyldig e-mail-adresse", - "oneOf": "Skal være en af: %{options}", - "regex": "Skal matche et bestemt format (regexp): %{pattern}", - "unique": "", - "url": "" - }, - "action": { - "add_filter": "Tilføj filter", - "add": "Tilføj", - "back": "Tilbage", - "bulk_actions": "%{smart_count} valgt", - "cancel": "Annuller", - "clear_input_value": "Ryd", - "clone": "Klon", - "confirm": "Bekræft", - "create": "Opret", - "delete": "Slet", - "edit": "Rediger", - "export": "Eksporter", - "list": "Liste", - "refresh": "Opdater", - "remove_filter": "Slet filter", - "remove": "Fjern", - "save": "Gem", - "search": "Søg", - "show": "Vis", - "sort": "Sortér", - "undo": "Fortryd", - "expand": "Udvid", - "close": "Luk", - "open_menu": "Åben menu", - "close_menu": "Luk menu", - "unselect": "Fravælg", - "skip": "", - "bulk_actions_mobile": "", - "share": "", - "download": "" - }, - "boolean": { - "true": "Ja", - "false": "Nej" - }, - "page": { - "create": "Opret %{name}", - "dashboard": "Dashboard", - "edit": "%{name} #%{id}", - "error": "Noget gik galt", - "list": "%{name} liste", - "loading": "Henter", - "not_found": "Ikke fundet", - "show": "%{name} #%{id}", - "empty": "Ingen %{name} endnu", - "invite": "Vil du tilføje en?" - }, - "input": { - "file": { - "upload_several": "Træk og slip filer for at uploade, eller klik for at vælge filer.", - "upload_single": "Træk og slip en fil for at uploade, eller klik for at vælge en fil." - }, - "image": { - "upload_several": "Træk og slip filer for at uploade, eller klik for at vælge filer.", - "upload_single": "Træk og slip et billede for at uploade, eller klik for at vælge en fil." - }, - "references": { - "all_missing": "Kan ikke finde nogle referencedata.", - "many_missing": "Mindst en af de tilknyttede referencer synes ikke længere at være tilgængelig.", - "single_missing": "Tilknyttede referencer synes ikke længere at være tilgængelige." - }, - "password": { - "toggle_visible": "Skjul kodeord", - "toggle_hidden": "Vis kodeord" - } - }, - "message": { - "about": "Om", - "are_you_sure": "Er du sikker?", - "bulk_delete_content": "Er du sikker på du vil slette %{name}? |||| Er du sikker på du ville slette %{smart_count} poster?", - "bulk_delete_title": "Slet %{name} |||| Sletter %{smart_count} %{name} poster", - "delete_content": "Er du sikker på du ville slette denne post?", - "delete_title": "Slet %{name} #%{id}", - "details": "Detaljer", - "error": "Der opstod en klientfejl, og din forespørgsel kunne ikke udføres.", - "invalid_form": "Formularen er ikke gyldig. Kontroller for fejl", - "loading": "Siden indlæses, Vent et øjeblik", - "no": "Nej", - "not_found": "Enten har du skrevet en forkert URL eller du har fulgt et invalidt link.", - "yes": "Ja", - "unsaved_changes": "Du har lavet ændringer der ikke er gemt. Er du sikker på at du vil ignorere dem?" - }, - "navigation": { - "no_results": "Ingen resultater fundet", - "no_more_results": "Sidenummeret %{page} eksistere ikke. Gå tilbage til forrige side.", - "page_out_of_boundaries": "Sidenummeret %{page} eksistere ikke", - "page_out_from_end": "Der findes ikke flere sider", - "page_out_from_begin": "Der er ingen side før end side 1", - "page_range_info": "%{offsetBegin}-%{offsetEnd} af %{total}", - "page_rows_per_page": "Rækker pr. side:", - "next": "Næste", - "prev": "Forrige", - "skip_nav": "" - }, - "notification": { - "updated": "Objekt opdateret |||| %{smart_count} objekter opdateret", - "created": "Objekt oprettet", - "deleted": "Objekt slettet |||| %{smart_count} objekter slettet", - "bad_item": "Incorrect element", - "item_doesnt_exist": "Objektet findes ikke", - "http_error": "Kommunikationsfejl med serveren", - "data_provider_error": "dataProvider fejl. Check din console for detaljer.", - "i18n_error": "Kan ikke indlæse oversættelse af det ønskede sprog", - "canceled": "Handling blev annulleret", - "logged_out": "Din session er udløbet, venligst tilslut igen", - "new_version": "" - }, - "toggleFieldsMenu": { - "columnsToDisplay": "", - "layout": "", - "grid": "", - "table": "" - } + "album": { + "name": "Album |||| Albums", + "fields": { + "albumArtist": "Album kunstner", + "artist": "Kunstner", + "duration": "Varighed", + "songCount": "Sange", + "playCount": "Afspilninger", + "name": "Navn", + "genre": "Genre", + "compilation": "Opsamling", + "year": "År", + "updatedAt": "Opdateret d.", + "comment": "Kommentar", + "rating": "Bedømmelse", + "createdAt": "Tilføjet d.", + "size": "Størrelse", + "originalDate": "Original", + "releaseDate": "Udgivet", + "releases": "Udgivelse |||| Udgivelser", + "released": "Udgivet", + "recordLabel": "Plademærke", + "catalogNum": "Katalognummer", + "releaseType": "Type", + "grouping": "Gruppering", + "media": "Medier", + "mood": "Humør", + "date": "Optagelsesdato", + "missing": "Manglende", + "libraryName": "Bibliotek" + }, + "actions": { + "playAll": "Afspil", + "playNext": "Afspil næste", + "addToQueue": "Føj til kø", + "shuffle": "Bland", + "addToPlaylist": "Føj til afspilningsliste", + "download": "Download", + "info": "Hent info", + "share": "Del" + }, + "lists": { + "all": "Alle", + "random": "Tilfældig", + "recentlyAdded": "Nyligt tilføjet", + "recentlyPlayed": "Nyligt Afspillet", + "mostPlayed": "Mest Afspillet", + "starred": "Stjernemarkerede", + "topRated": "Top bedømmelse" + } }, - "message": { - "note": "NOTE", - "transcodingDisabled": "Skift af indstillinger for omkodning gennem web platformen er frakoblet af sikkerhedsgrunde. Genstart serveren med %{config} indstilling tilvalgt.", - "transcodingEnabled": "Navidrome kører i øjeblikket med %{config}, hvilket gør det muligt at køre system kommandoer fra web platformen. Vi anbefaler at slå det fra af sikkerhedsgrunde og kun slå det til ved indstilling af omkodning.", - "songsAddedToPlaylist": "Tilføjede 1 sang til afspilningsliste |||| Tilføjede %{smart_count} sange til afspilningsliste", - "noPlaylistsAvailable": "Ingen tilgængelige", - "delete_user_title": "Slet bruger '%{name}'", - "delete_user_content": "Er du sikker på at du vil slette denne bruger og tilhørende data (inklusive afspilningslister og indstillinger)?", - "notifications_blocked": "", - "notifications_not_available": "", - "lastfmLinkSuccess": "", - "lastfmLinkFailure": "", - "lastfmUnlinkSuccess": "", - "lastfmUnlinkFailure": "", - "openIn": { - "lastfm": "", - "musicbrainz": "" - }, - "lastfmLink": "", - "listenBrainzLinkSuccess": "", - "listenBrainzLinkFailure": "", - "listenBrainzUnlinkSuccess": "", - "listenBrainzUnlinkFailure": "", - "downloadOriginalFormat": "", - "shareOriginalFormat": "", - "shareDialogTitle": "", - "shareBatchDialogTitle": "", - "shareSuccess": "", - "shareFailure": "", - "downloadDialogTitle": "", - "shareCopyToClipboard": "" + "artist": { + "name": "Kunstner |||| Kunstnere", + "fields": { + "name": "Navn", + "albumCount": "Antal albums", + "songCount": "Antal sange", + "playCount": "Afspilninger", + "rating": "Bedømmelse", + "genre": "Genre", + "size": "Størrelse", + "role": "Rolle", + "missing": "Manglende" + }, + "roles": { + "albumartist": "Albumkunstner |||| Albumkunstnere", + "artist": "Kunstner |||| Kunstnere", + "composer": "Komponist |||| Komponister", + "conductor": "Dirigent |||| Dirigenter", + "lyricist": "Tekstforfatter |||| Tekstforfattere", + "arranger": "Arrangør |||| Arrangører", + "producer": "Producent |||| Producenter", + "director": "Instruktør |||| Instruktører", + "engineer": "Tekniker||||Teknikere", + "mixer": "Mixer |||| Mixere", + "remixer": "Remixer |||| Remixere", + "djmixer": "DJ-mixer |||| DJ-mixere", + "performer": "Udførende kunstner |||| Udførende kunstnere", + "maincredit": "Albumkunstner eller kunstner |||| Albumkunstnere eller kunstnere" + }, + "actions": { + "shuffle": "Bland", + "radio": "Radio", + "topSongs": "Topsange" + } }, - "menu": { - "library": "Bibliotek", - "settings": "Indstillinger", - "version": "Version", - "theme": "Tema", - "personal": { - "name": "Personligt", - "options": { - "theme": "Tema", - "language": "Sprog", - "defaultView": "Standardopsætning", - "desktop_notifications": "", - "lastfmScrobbling": "", - "listenBrainzScrobbling": "", - "replaygain": "", - "preAmp": "", - "gain": { - "none": "", - "album": "", - "track": "" - } - } - }, - "albumList": "Albums", - "about": "Om", - "playlists": "", - "sharedPlaylists": "" + "user": { + "name": "Bruger |||| Brugere", + "fields": { + "userName": "Brugernavn", + "isAdmin": "Er administrator", + "lastLoginAt": "Seneste login", + "updatedAt": "Opdateret d.", + "name": "Navn", + "password": "Kodeord", + "createdAt": "Oprettet d.", + "changePassword": "Skifte kodeord?", + "currentPassword": "Nuværende kodeord", + "newPassword": "Nyt kodeord", + "token": "Token", + "lastAccessAt": "Senest tilgået", + "libraries": "Biblioteker" + }, + "helperTexts": { + "name": "Ændringer i dit navn vises først ved næste login", + "libraries": "Vælg specifikke biblioteker til denne bruger, eller lad det stå tomt for at bruge standardbiblioteker" + }, + "notifications": { + "created": "Bruger oprettet", + "updated": "Bruger opdateret", + "deleted": "Bruger slettet" + }, + "message": { + "listenBrainzToken": "Skriv dit ListenBrainz token", + "clickHereForToken": "Tryk her for at få dit token", + "selectAllLibraries": "Vælg alle biblioteker", + "adminAutoLibraries": "Administratorbrugere har automatisk adgang til alle biblioteker" + }, + "validation": { + "librariesRequired": "Der skal være valgt mindst ét bibliotek til ikke-administrative brugere" + } }, "player": { - "playListsText": "Afspilnings kø", - "openText": "Åben", - "closeText": "Luk", - "notContentText": "Ingen musik", - "clickToPlayText": "Tryk for at afspille", - "clickToPauseText": "Tryk for at pause", - "nextTrackText": "Næste nummer", - "previousTrackText": "Forrige nummer", - "reloadText": "Genindlæs", - "volumeText": "Lydstyrke", - "toggleLyricText": "Skift sangtekst", - "toggleMiniModeText": "Minimer", - "destroyText": "Fjern", - "downloadText": "Hent", - "removeAudioListsText": "Slet afspillingsliste", - "clickToDeleteText": "Tryk for at slette %{name}", - "emptyLyricText": "Ingen sangtekst", - "playModeText": { - "order": "I rækkefølge", - "orderLoop": "Gentag", - "singleLoop": "Gentag enkelt", - "shufflePlay": "Bland" - } + "name": "Afspiller |||| Afspillere", + "fields": { + "name": "Navn", + "transcodingId": "Transkodning", + "maxBitRate": "Maks. bitrate", + "client": "Klient", + "userName": "Brugernavn", + "lastSeen": "Sidst set", + "reportRealPath": "Vis den virkelige sti", + "scrobbleEnabled": "Send scrobbles til eksterne tjenester" + } }, - "about": { - "links": { - "homepage": "Hjme", - "source": "Kildekode", - "featureRequests": "Ønskede funktioner" - } + "transcoding": { + "name": "Transkodning |||| Transkodninger", + "fields": { + "name": "Navn", + "targetFormat": "Målformat", + "defaultBitRate": "Standard bitrate", + "command": "Kommando" + } }, - "activity": { - "title": "Aktivitet", - "totalScanned": "Antal sange fundet", - "quickScan": "Hurtig søgning", - "fullScan": "Fuld søgning\n", - "serverUptime": "Server uptime", - "serverDown": "OFFLINE" + "playlist": { + "name": "Afspilningsliste |||| Afspilningslister", + "fields": { + "name": "Navn", + "duration": "Varighed", + "ownerName": "Ejer", + "public": "Offentlig", + "updatedAt": "Opdateret d.", + "createdAt": "Oprettet d.", + "songCount": "Sange", + "comment": "Kommentar", + "sync": "Auto-importér", + "path": "Importér fra" + }, + "actions": { + "selectPlaylist": "Vælg en afspilningsliste:", + "addNewPlaylist": "Opret \"%{name}\"", + "export": "Eksportér", + "makePublic": "Offentliggør", + "makePrivate": "Gør privat", + "saveQueue": "Gem kø på afspilningsliste", + "searchOrCreate": "Søg i afspilningslister eller skriv for at oprette nye...", + "pressEnterToCreate": "Tryk Enter for at oprette en ny afspilningsliste", + "removeFromSelection": "Fjern fra valg" + }, + "message": { + "duplicate_song": "Tilføj dubletter af sange", + "song_exist": "Der føjes dubletter til playlisten", + "noPlaylistsFound": "Ingen playlister fundet", + "noPlaylists": "Ingen tilgængelige playlister" + } }, - "help": { - "title": "", - "hotkeys": { - "show_help": "", - "toggle_menu": "", - "toggle_play": "", - "prev_song": "", - "next_song": "", - "vol_up": "", - "vol_down": "", - "toggle_love": "", - "current_song": "" - } + "radio": { + "name": "Radio |||| Radioer", + "fields": { + "name": "Navn", + "streamUrl": "Stream-URL", + "homePageUrl": "Hjemmeside-URL", + "updatedAt": "Opdateret d.", + "createdAt": "Oprettet d." + }, + "actions": { + "playNow": "Afspil nu" + } + }, + "share": { + "name": "Del |||| Delinger", + "fields": { + "username": "Delt af", + "url": "URL", + "description": "Beskrivelse", + "contents": "Indhold", + "expiresAt": "Udløber", + "lastVisitedAt": "Senest besøgt", + "visitCount": "Besøg", + "format": "Format", + "maxBitRate": "Maks. bitrate", + "updatedAt": "Opdateret d.", + "createdAt": "Oprettet d.", + "downloadable": "Tillad downloads?" + } + }, + "missing": { + "name": "Manglende fil |||| Manglende filer", + "fields": { + "path": "Sti", + "size": "Størrelse", + "updatedAt": "Forsvandt d.", + "libraryName": "Bibliotek" + }, + "actions": { + "remove": "Fjern", + "remove_all": "Fjern alle" + }, + "notifications": { + "removed": "Manglende fil(er) fjernet" + }, + "empty": "Ingen manglende filer" + }, + "library": { + "name": "Bibliotek |||| Biblioteker", + "fields": { + "name": "Navn", + "path": "Sti", + "remotePath": "Fjernsti", + "lastScanAt": "Sidste scanning", + "songCount": "Sange", + "albumCount": "Albummer", + "artistCount": "Kunstnere", + "totalSongs": "Sange", + "totalAlbums": "Albummer", + "totalArtists": "Kunstnere", + "totalFolders": "Mapper", + "totalFiles": "Filer", + "totalMissingFiles": "Manglende filer", + "totalSize": "Samlet størrelse", + "totalDuration": "Varighed", + "defaultNewUsers": "Standard for nye brugere", + "createdAt": "Oprettet d.", + "updatedAt": "Opdateret d." + }, + "sections": { + "basic": "Grundlæggende oplysninger", + "statistics": "Statistik" + }, + "actions": { + "scan": "Scanningsbibliotek", + "manageUsers": "Administrer brugeradgang", + "viewDetails": "Se detaljer", + "quickScan": "hurtig skanning", + "fullScan": "Fuld skanning" + }, + "notifications": { + "created": "Bibliotek oprettet", + "updated": "Biblioteket er blevet opdateret", + "deleted": "Biblioteket er blevet slettet", + "scanStarted": "Biblioteksscanning startet", + "scanCompleted": "Biblioteksscanning fuldført", + "quickScanStarted": "hurtig skanning startet", + "fullScanStarted": "Fuld skanning startet", + "scanError": "Kan ikke starte skanning. Tjek loggen" + }, + "validation": { + "nameRequired": "Biblioteksnavn er påkrævet", + "pathRequired": "Bibliotekssti er påkrævet", + "pathNotDirectory": "Biblioteksstien skal være en mappe", + "pathNotFound": "Biblioteksstien blev ikke fundet", + "pathNotAccessible": "Biblioteksstien er ikke tilgængelig", + "pathInvalid": "Ugyldig bibliotekssti" + }, + "messages": { + "deleteConfirm": "Er du sikker på, at du vil slette dette bibliotek? Dét vil fjerne alle tilknyttede data og brugeradgange", + "scanInProgress": "Scanning i gang...", + "noLibrariesAssigned": "Ingen biblioteker tildelt denne bruger" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Navn", + "description": "Beskrivelse", + "version": "Version", + "author": "Forfatter", + "website": "Hjemmeside", + "permissions": "Tilladelser", + "enabled": "Aktiveret", + "status": "Status", + "path": "Sti", + "lastError": "Fejl", + "hasError": "Fejl", + "updatedAt": "Opdateret", + "createdAt": "Installeret", + "configKey": "Nøgle", + "configValue": "Værdi", + "allUsers": "Tillad alle brugere", + "selectedUsers": "Valgte brugere", + "allLibraries": "Tillad alle biblioteker", + "selectedLibraries": "Valgte biblioteker", + "allowWriteAccess": "Tillad skriveadgang" + }, + "sections": { + "status": "Status", + "info": "Pluginoplysninger", + "configuration": "Konfiguration", + "manifest": "Manifest", + "usersPermission": "Brugertilladelse", + "libraryPermission": "Bibliotekstilladelse" + }, + "status": { + "enabled": "Aktiveret", + "disabled": "Deaktiveret" + }, + "actions": { + "enable": "Aktivér", + "disable": "Deaktivér", + "disabledDueToError": "Ret fejlen før aktivering", + "disabledUsersRequired": "Vælg brugere før aktivering", + "disabledLibrariesRequired": "Vælg biblioteker før aktivering", + "addConfig": "Tilføj konfiguration", + "rescan": "Genskan" + }, + "notifications": { + "enabled": "Plugin aktiveret", + "disabled": "Plugin deaktiveret", + "updated": "Plugin opdateret", + "error": "Fejl ved opdatering af plugin" + }, + "validation": { + "invalidJson": "Konfigurationen skal være gyldig JSON" + }, + "messages": { + "configHelp": "Konfigurér pluginet med nøgle-værdi-par. Lad stå tomt, hvis pluginet ikke kræver konfiguration.", + "clickPermissions": "Klik på en tilladelse for detaljer", + "noConfig": "Ingen konfiguration angivet", + "allUsersHelp": "Når aktiveret, vil pluginet have adgang til alle brugere, inklusiv dem der oprettes i fremtiden.", + "noUsers": "Ingen brugere valgt", + "permissionReason": "Årsag", + "usersRequired": "Dette plugin kræver adgang til brugeroplysninger. Vælg hvilke brugere pluginet kan tilgå, eller aktivér 'Tillad alle brugere'.", + "allLibrariesHelp": "Når aktiveret, vil pluginet have adgang til alle biblioteker, inklusiv dem der oprettes i fremtiden.", + "noLibraries": "Ingen biblioteker valgt", + "librariesRequired": "Dette plugin kræver adgang til biblioteksoplysninger. Vælg hvilke biblioteker pluginet kan tilgå, eller aktivér 'Tillad alle biblioteker'.", + "requiredHosts": "Påkrævede hosts", + "configValidationError": "Konfigurationsvalidering mislykkedes:", + "schemaRenderError": "Kan ikke vise konfigurationsformularen. Pluginets skema er muligvis ugyldigt.", + "allowWriteAccessHelp": "Når aktiveret, kan denne plugin rette filer i biblioteksmapper. På forhånd har plugins kun læseadgang." + }, + "placeholders": { + "configKey": "nøgle", + "configValue": "værdi" + } } + }, + "ra": { + "auth": { + "welcome1": "Tak fordi du installerede Navidrome!", + "welcome2": "Først, opret en administrator", + "confirmPassword": "Bekræft kodeord", + "buttonCreateAdmin": "Opret administrator", + "auth_check_error": "Venligst login for at fortsætte", + "user_menu": "Profil", + "username": "Brugernavn", + "password": "Kodeord", + "sign_in": "Log ind", + "sign_in_error": "Dit log ind slog fejl, prøv igen", + "logout": "Log ud", + "insightsCollectionNote": "Navidrome indsamler anonyme brugsdata for at forbedre projektet. Klik [her] for at få mere at vide og fravælge, hvis du ønsker det." + }, + "validation": { + "invalidChars": "Venligst, benyt kun bogstaver og tal", + "passwordDoesNotMatch": "Kodeord er ikke ens", + "required": "Nødvendig", + "minLength": "Skal være mindst %{min} tegn", + "maxLength": "Skal være op til %{max} tegn", + "minValue": "Skal være mindst %{min}", + "maxValue": "Skal være op til %{max}", + "number": "Skal være et tal", + "email": "Skal være en gyldig e-mail-adresse", + "oneOf": "Skal være én af: %{options}", + "regex": "Skal matche et specifikt format (regexp): %{pattern}", + "unique": "Skal være unik", + "url": "Skal være en gyldig URL" + }, + "action": { + "add_filter": "Tilføj filter", + "add": "Tilføj", + "back": "Tilbage", + "bulk_actions": "1 emne valgt |||| %{smart_count} emner valgt", + "cancel": "Annuller", + "clear_input_value": "Ryd", + "clone": "Klon", + "confirm": "Bekræft", + "create": "Opret", + "delete": "Slet", + "edit": "Rediger", + "export": "Eksportér", + "list": "Liste", + "refresh": "Opdater", + "remove_filter": "Slet filter", + "remove": "Fjern", + "save": "Gem", + "search": "Søg", + "show": "Vis", + "sort": "Sortér", + "undo": "Fortryd", + "expand": "Udvid", + "close": "Luk", + "open_menu": "Åbn menu", + "close_menu": "Luk menu", + "unselect": "Fravælg", + "skip": "Spring over", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Del", + "download": "Download" + }, + "boolean": { + "true": "Ja", + "false": "Nej" + }, + "page": { + "create": "Opret %{name}", + "dashboard": "Instrumentbræt", + "edit": "%{name} #%{id}", + "error": "Noget gik galt", + "list": "%{name} liste", + "loading": "Henter", + "not_found": "Ikke fundet", + "show": "%{name} #%{id}", + "empty": "Ingen %{name} endnu.", + "invite": "Vil du tilføje en?" + }, + "input": { + "file": { + "upload_several": "Træk nogle filer herind for at uploade, eller klik for at vælge en.", + "upload_single": "Træk en fil herind for at uploade, eller klik for at vælge den." + }, + "image": { + "upload_several": "Træk billedfiler herind for at uploade, eller klik for at vælge en.", + "upload_single": "Træk en billedfil herind for at uploade, eller klik for at vælge den." + }, + "references": { + "all_missing": "Kan ikke finde nogen referencedata.", + "many_missing": "Mindst en af de tilknyttede referencer synes ikke længere at være tilgængelig.", + "single_missing": "Tilknyttede referencer synes ikke længere at være tilgængelige." + }, + "password": { + "toggle_visible": "Skjul kodeord", + "toggle_hidden": "Vis kodeord" + } + }, + "message": { + "about": "Om", + "are_you_sure": "Er du sikker?", + "bulk_delete_content": "Er du sikker på, at du vil slette %{name}? |||| Er du sikker på, at du vil slette disse %{smart_count} poster?", + "bulk_delete_title": "Slet %{name} |||| Sletter %{smart_count} %{name} poster", + "delete_content": "Er du sikker på, at du vil slette denne post?", + "delete_title": "Slet %{name} #%{id}", + "details": "Detaljer", + "error": "Der opstod en klientfejl, og din forespørgsel kunne ikke udføres.", + "invalid_form": "Formularen er ikke gyldig. Tjek for fejl", + "loading": "Siden indlæses, vent et øjeblik", + "no": "Nej", + "not_found": "Enten har du skrevet en forkert URL eller du har fulgt et ugyldigt link.", + "yes": "Ja", + "unsaved_changes": "Du har lavet ændringer der ikke er gemt. Er du sikker på at du vil ignorere dem?" + }, + "navigation": { + "no_results": "Ingen resultater fundet", + "no_more_results": "Sidenummeret %{page} eksisterer ikke. Gå tilbage til forrige side.", + "page_out_of_boundaries": "Sidenummeret %{page} ligger uden for grænserne", + "page_out_from_end": "Dette er sidste side", + "page_out_from_begin": "Dette er side 1", + "page_range_info": "%{offsetBegin}-%{offsetEnd} af %{total}", + "page_rows_per_page": "Rækker pr. side:", + "next": "Næste", + "prev": "Forrige", + "skip_nav": "Hop til indhold" + }, + "notification": { + "updated": "Element opdateret |||| %{smart_count} elementer opdateret", + "created": "Element oprettet", + "deleted": "Element slettet |||| %{smart_count} elementer slettet", + "bad_item": "Forkert element", + "item_doesnt_exist": "Elementet findes ikke", + "http_error": "Kommunikationsfejl med serveren", + "data_provider_error": "dataProvider fejl. Tjek konsollen for detaljer.", + "i18n_error": "Kan ikke indlæse oversættelsen af det ønskede sprog", + "canceled": "Handling blev annulleret", + "logged_out": "Din session er udløbet, venligst tilslut igen", + "new_version": "Ny version tilgængelig! – genopfrisk venligst vinduet" + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Antal synlige kolonner", + "layout": "Layout", + "grid": "Gitter", + "table": "Tabel" + } + }, + "message": { + "note": "NOTE", + "transcodingDisabled": "Ændring af indstillinger til transkodning via webgrænsefladen er deaktiveret af sikkerhedshensyn.\nFor at ændre eller tilføje indstillinger skal du genstarte serveren med %{config} konfigurations option.", + "transcodingEnabled": "Navidrome kører i øjeblikket med %{config}. Dét gør det muligt at køre systemkommandoer fra transkodningsindstillingerne, via webgrænsefladen.\nVi anbefaler at deaktivere dette af sikkerhedshensyn og kun have det aktiveret, når du konfigurerer indstillinger til transkodning.", + "songsAddedToPlaylist": "Føjede 1 sang til afspilningsliste |||| Føjede %{smart_count} sange til afspilningsliste", + "noPlaylistsAvailable": "Ingen tilgængelige", + "delete_user_title": "Slet bruger '%{name}'", + "delete_user_content": "Er du sikker på at du vil slette denne bruger og tilhørende data (inklusive afspilningslister og valgte indstillinger)?", + "notifications_blocked": "Du blokerer for notifikationer fra dette site i dine browserindstillinger", + "notifications_not_available": "Denne browser understøtter ikke skrivebordsnotifikationer, eller: Du tilgår ikke Navidrome over https", + "lastfmLinkSuccess": "Du er koblet til Last.fm, og scrobbling er slået til", + "lastfmLinkFailure": "Du kan ikke kobles til Last.fm", + "lastfmUnlinkSuccess": "Last.fm frakoblet, og scrobbling deaktiveret", + "lastfmUnlinkFailure": "Last.fm kunne ikke frakobles", + "openIn": { + "lastfm": "Åbn i Last.fm", + "musicbrainz": "Åbn i MusicBrainz" + }, + "lastfmLink": "Læs mere...", + "listenBrainzLinkSuccess": "Du er koblet til ListenBrainz og scrobbling er aktiveret som bruger: %{user}", + "listenBrainzLinkFailure": "Du kunne ikke kobles til ListenBrainz: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz er frakoblet, og scrobbling deaktiveret", + "listenBrainzUnlinkFailure": "ListenBrainz kunne ikke frakobles", + "downloadOriginalFormat": "Download i originalformat", + "shareOriginalFormat": "Del i originalformat", + "shareDialogTitle": "Del %{resource} '%{name}'", + "shareBatchDialogTitle": "Del 1 %{resource} |||| Del %{smart_count} %{resource}", + "shareSuccess": "URL kopieret til udklipsholder: %{url}", + "shareFailure": "Fejl ved kopiering af URL %{url} til udklipsholder", + "downloadDialogTitle": "Download %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Kopiér til udklipsholder: Ctrl+C, Enter", + "remove_missing_title": "Fjern manglende filer", + "remove_missing_content": "Er du sikker på, at du vil fjerne de valgte manglende filer fra databasen? Dét vil permanent fjerne alle referencer til dem, inklusive deres afspilningstællere og vurderinger.", + "remove_all_missing_title": "Fjern alle manglende filer", + "remove_all_missing_content": "Er du sikker på, at du vil fjerne alle manglende filer fra databasen? Dét vil permanent fjerne alle referencer til dem, inklusive deres afspilningstællere og vurderinger.", + "noSimilarSongsFound": "Ingen lignende sange fundet", + "noTopSongsFound": "Ingen topsange fundet", + "startingInstantMix": "Indlæser Instant Mix...", + "uploadCover": "Upload omslag", + "removeCover": "Fjern omslag", + "coverUploaded": "Omslagsbillede opdateret", + "coverRemoved": "Omslagsbillede fjernet", + "coverUploadError": "Fejl ved upload af omslagsbillede", + "coverRemoveError": "Fejl ved fjernelse af omslagsbillede" + }, + "menu": { + "library": "Bibliotek", + "settings": "Indstillinger", + "version": "Version", + "theme": "Tema", + "personal": { + "name": "Personligt", + "options": { + "theme": "Tema", + "language": "Sprog", + "defaultView": "Standardopsætning", + "desktop_notifications": "Skrivebordsnotifikationer", + "lastfmScrobbling": "Scrobble til Last.fm", + "listenBrainzScrobbling": "Scrobble til ListenBrainz", + "replaygain": "ReplayGain-tilstand", + "preAmp": "ReplayGain PreAmp (dB)", + "gain": { + "none": "Slået fra", + "album": "Brug Album Gain", + "track": "Brug Gain for spor" + }, + "lastfmNotConfigured": "Last.fm API-nøglen er ikke konfigureret" + } + }, + "albumList": "Albums", + "about": "Om", + "playlists": "Afspilningslister", + "sharedPlaylists": "Delte afspilningslister", + "librarySelector": { + "allLibraries": "Alle biblioteker (%{count})", + "multipleLibraries": "%{selected} af %{total} biblioteker", + "selectLibraries": "Vælg biblioteker", + "none": "Ingen" + } + }, + "player": { + "playListsText": "Afspilningskø", + "openText": "Åbn", + "closeText": "Luk", + "notContentText": "Ingen musik", + "clickToPlayText": "Tryk for at afspille", + "clickToPauseText": "Tryk for at sætte på pause", + "nextTrackText": "Næste nummer", + "previousTrackText": "Forrige nummer", + "reloadText": "Genindlæs", + "volumeText": "Lydstyrke", + "toggleLyricText": "Skift sangtekst til/fra", + "toggleMiniModeText": "Minimer", + "destroyText": "Fjern", + "downloadText": "Hent", + "removeAudioListsText": "Slet afspilningslister", + "clickToDeleteText": "Tryk for at slette %{name}", + "emptyLyricText": "Ingen sangtekst", + "playModeText": { + "order": "I rækkefølge", + "orderLoop": "Gentag", + "singleLoop": "Gentag enkelt", + "shufflePlay": "Bland" + } + }, + "about": { + "links": { + "homepage": "Hjemmeside", + "source": "Kildekode", + "featureRequests": "Funktionsønsker", + "lastInsightsCollection": "Seneste indsamling af indsigter", + "insights": { + "disabled": "Slået fra", + "waiting": "Venter" + } + }, + "tabs": { + "about": "Om", + "config": "Konfiguration" + }, + "config": { + "configName": "Navn på konfiguration", + "environmentVariable": "Miljøvariabel", + "currentValue": "Nuværende værdi", + "configurationFile": "Konfigurationsfil", + "exportToml": "Eksportér konfigurationen (TOML)", + "exportSuccess": "Konfigurationen eksporteret til udklipsholder i TOML-format", + "exportFailed": "Kunne ikke kopiere konfigurationen", + "devFlagsHeader": "Udviklingsflagget (med forbehold for ændring/fjernelse)", + "devFlagsComment": "Disse er eksperimental-indstillinger og kan blive fjernet i fremtidige udgaver", + "downloadToml": "Download konfigurationen (TOML)" + } + }, + "activity": { + "title": "Aktivitet", + "totalScanned": "Antal mapper gennemsøgt", + "quickScan": "Hurtig søgning", + "fullScan": "Fuld søgning", + "serverUptime": "Server oppetid", + "serverDown": "OFFLINE", + "scanType": "Type", + "status": "Scanningsfejl", + "elapsedTime": "Medgået tid", + "selectiveScan": "Selektiv" + }, + "help": { + "title": "Navidrome genvejstaster", + "hotkeys": { + "show_help": "Vis denne hjælp", + "toggle_menu": "Skift menu sidepanel", + "toggle_play": "Play / Pause", + "prev_song": "Forrige sang", + "next_song": "Næste sang", + "vol_up": "Volumen op", + "vol_down": "Volumen ned", + "toggle_love": "Føj dette nummer til dine favoritter", + "current_song": "Gå til den aktuelle sang" + } + }, + "nowPlaying": { + "title": "Afspilles nu", + "empty": "Intet afspilles nu", + "minutesAgo": "for %{smart_count} minut siden |||| for %{smart_count} minutter siden" + } } \ No newline at end of file diff --git a/resources/i18n/de.json b/resources/i18n/de.json index 6ffb31165..1a516d393 100644 --- a/resources/i18n/de.json +++ b/resources/i18n/de.json @@ -2,7 +2,7 @@ "languageName": "Deutsch", "resources": { "song": { - "name": "Song |||| Songs", + "name": "Titel |||| Titel", "fields": { "albumArtist": "Albuminterpret", "duration": "Dauer", @@ -18,7 +18,7 @@ "size": "Dateigröße", "updatedAt": "Hochgeladen am", "bitRate": "Bitrate", - "discSubtitle": "CD Untertitel", + "discSubtitle": "Disc Untertitel", "starred": "Favorit", "comment": "Kommentar", "rating": "Bewertung", @@ -32,16 +32,26 @@ "participants": "Weitere Beteiligte", "tags": "Weitere Tags", "mappedTags": "Gemappte Tags", - "rawTags": "Tag Rohdaten" + "rawTags": "Tag Rohdaten", + "bitDepth": "Bittiefe", + "sampleRate": "Samplerate", + "missing": "Fehlend", + "libraryName": "Bibliothek", + "composer": "Komponist", + "disc": "Disc %{discNumber}", + "albumGain": "Album Gain", + "trackGain": "Titel Gain" }, "actions": { "addToQueue": "Später abspielen", "playNow": "Jetzt abspielen", - "addToPlaylist": "Zur Playlist hinzufügen", + "addToPlaylist": "Zu einer Wiedergabeliste hinzufügen", "shuffleAll": "Zufallswiedergabe", "download": "Herunterladen", "playNext": "Als nächstes abspielen", - "info": "Mehr Informationen" + "info": "Mehr Informationen", + "showInPlaylist": "In Wiedergabeliste anzeigen", + "instantMix": "Sofort-Mix" } }, "album": { @@ -70,14 +80,17 @@ "releaseType": "Typ", "grouping": "Gruppierung", "media": "Medium", - "mood": "Stimmung" + "mood": "Stimmung", + "date": "Aufnahmedatum", + "missing": "Fehlend", + "libraryName": "Bibliothek" }, "actions": { "playAll": "Abspielen", "playNext": "Als nächstes abspielen", "addToQueue": "Später abspielen", "shuffle": "Zufallswiedergabe", - "addToPlaylist": "Zur Playlist hinzufügen", + "addToPlaylist": "Zu einer Wiedergabeliste hinzufügen", "download": "Herunterladen", "info": "Mehr Informationen", "share": "Freigabe erstellen" @@ -102,7 +115,8 @@ "rating": "Bewertung", "genre": "Genre", "size": "Größe", - "role": "Rolle" + "role": "Rolle", + "missing": "Fehlend" }, "roles": { "albumartist": "Albuminterpret |||| Albuminterpreten", @@ -117,7 +131,13 @@ "mixer": "Mixer |||| Mixer", "remixer": "Remixer |||| Remixer", "djmixer": "DJ Mixer |||| DJ Mixer", - "performer": "ausübender Künstler |||| ausübende Künstler" + "performer": "ausübender Künstler |||| ausübende Künstler", + "maincredit": "Albuminterpret oder Interpret |||| Albuminterpreten oder Interpreten" + }, + "actions": { + "shuffle": "Zufallswiedergabe", + "radio": "Radio", + "topSongs": "Beliebteste Titel" } }, "user": { @@ -134,10 +154,12 @@ "currentPassword": "Aktuelles Passwort", "newPassword": "Neues Passwort", "token": "Token", - "lastAccessAt": "Letzter Zugriff am" + "lastAccessAt": "Letzter Zugriff am", + "libraries": "Bibliotheken" }, "helperTexts": { - "name": "Die Änderung wird erst nach dem nächsten Login gültig" + "name": "Die Änderung wird erst nach dem nächsten Login gültig", + "libraries": "Wähle spezifische Bibliotheken für diesen Benutzer, oder leer lassen für Standard Bibliotheken" }, "notifications": { "created": "Benutzer erstellt", @@ -146,7 +168,12 @@ }, "message": { "listenBrainzToken": "Gib deinen ListenBrainz Benutzer Token ein", - "clickHereForToken": "Hier klicken um deinen Token abzurufen" + "clickHereForToken": "Hier klicken um deinen Token abzurufen", + "selectAllLibraries": "Wähle alle Bibliotheken", + "adminAutoLibraries": "Administrator-Benutzer haben automatisch Zugriff auf alle Bibliotheken" + }, + "validation": { + "librariesRequired": "Mindestens eine Bibliothek muss für nicht-administrator Benutzer ausgewählt sein" } }, "player": { @@ -172,7 +199,7 @@ } }, "playlist": { - "name": "Playlist |||| Playlists", + "name": "Wiedergabeliste |||| Wiedergabelisten", "fields": { "name": "Name", "duration": "Dauer", @@ -186,15 +213,21 @@ "path": "Importieren aus" }, "actions": { - "selectPlaylist": "Titel zur Playlist hinzufügen", + "selectPlaylist": "Wiedergabeliste auswählen:", "addNewPlaylist": "\"%{name}\" erstellen", "export": "Exportieren", "makePublic": "Öffentlich machen", - "makePrivate": "Privat stellen" + "makePrivate": "Privat stellen", + "saveQueue": "Warteschlange in Wiedergabeliste speichern", + "searchOrCreate": "Wiedergabeliste suchen oder neue erstellen...", + "pressEnterToCreate": "Enter drücken um neue Wiedergabeliste zu erstellen", + "removeFromSelection": "Von Auswahl entfernen" }, "message": { "duplicate_song": "Duplikate hinzufügen", - "song_exist": "Manche Titel sind bereits in der Playlist. Möchtest du sie trotzdem hinzufügen oder überspringen?" + "song_exist": "Manche Titel sind bereits in der Playlist. Möchtest du sie trotzdem hinzufügen oder überspringen?", + "noPlaylistsFound": "Keine Wiedergabeliste gefunden", + "noPlaylists": "Keine Wiedergabelisten vorhanden" } }, "radio": { @@ -232,13 +265,149 @@ "fields": { "path": "Pfad", "size": "Größe", - "updatedAt": "Fehlt seit" + "updatedAt": "Fehlt seit", + "libraryName": "Bibliothek" }, "actions": { - "remove": "Entfernen" + "remove": "Entfernen", + "remove_all": "alle entfernen" }, "notifications": { "removed": "Fehlende Datei(en) entfernt" + }, + "empty": "keine fehlenden Dateien" + }, + "library": { + "name": "Bibliothek |||| Bibliotheken", + "fields": { + "name": "Name", + "path": "Pfad", + "remotePath": "Remote Pfad", + "lastScanAt": "Letzter Scan", + "songCount": "Lieder", + "albumCount": "Alben", + "artistCount": "Interpreten", + "totalSongs": "Lieder", + "totalAlbums": "Alben", + "totalArtists": "Interpreten", + "totalFolders": "Ordner", + "totalFiles": "Dateien", + "totalMissingFiles": "Fehlende Dateien", + "totalSize": "Größe", + "totalDuration": "Dauer", + "defaultNewUsers": "Standard für neue Benutzer", + "createdAt": "Erstellt", + "updatedAt": "Geändert" + }, + "sections": { + "basic": "Basis Informationen", + "statistics": "Statistik" + }, + "actions": { + "scan": "Bibliothek scannen", + "manageUsers": "Zugriff verwalten", + "viewDetails": "Details ansehen", + "quickScan": "Schneller Scan", + "fullScan": "Kompletter Scan" + }, + "notifications": { + "created": "Bibliothek erfolgreich erstellt", + "updated": "Bibliothek erfolgreich geändert", + "deleted": "Bibliothek erfolgreich gelöscht", + "scanStarted": "Bibliothek Scan gestartet", + "scanCompleted": "Bibliothek Scan vollständig", + "quickScanStarted": "Schneller Scan gestartet", + "fullScanStarted": "Kompletter Scan gestartet", + "scanError": "Fehler beim Starten des Scans. Logs prüfen" + }, + "validation": { + "nameRequired": "Bibliotheksname ist Pflichtfeld", + "pathRequired": "Bibliothekspfad ist Pflichtfeld", + "pathNotDirectory": "Bibliothekspfad muss ein Ordner sein", + "pathNotFound": "Bibliothekspfad nicht gefunden", + "pathNotAccessible": "Bibliothekspfad nicht zugänglich", + "pathInvalid": "Bibliothekspfad ungültig" + }, + "messages": { + "deleteConfirm": "Möchtest du diese Bibliothek wirklich löschen? Zugriffsrechte und Daten werden entfernt. ", + "scanInProgress": "Bibliothek Scan läuft...", + "noLibrariesAssigned": "Keine Bibliotheken zugeordnet" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Name", + "description": "Beschreibung", + "version": "Version", + "author": "Autor", + "website": "Website", + "permissions": "Berechtigungen", + "enabled": "Aktiv", + "status": "Status", + "path": "Pfad", + "lastError": "Fehler", + "hasError": "Fehler", + "updatedAt": "Aktualisiert am", + "createdAt": "Installiert", + "configKey": "Schlüssel", + "configValue": "Wert", + "allUsers": "Alle Benutzer", + "selectedUsers": "Ausgewählte Benutzer", + "allLibraries": "Alle Bibliotheken", + "selectedLibraries": "Ausgewählte Bibliotheken", + "allowWriteAccess": "Schreibzugriff erlauben" + }, + "sections": { + "status": "Status", + "info": "Plugin Information", + "configuration": "Konfiguration", + "manifest": "Manifest", + "usersPermission": "Benutzer Zugriff", + "libraryPermission": "Bibliotheken Zugriff" + }, + "status": { + "enabled": "Aktiv", + "disabled": "Inaktiv" + }, + "actions": { + "enable": "Aktivieren", + "disable": "Deaktivieren", + "disabledDueToError": "Fehler beheben um Plugin zu aktivieren", + "disabledUsersRequired": "Wähle Benutzer Zugriff um Plugin zu aktivieren", + "disabledLibrariesRequired": "Wähle Bibliotheken Zugriff um Plugin zu aktivieren", + "addConfig": "Konfiguration hinzufügen", + "rescan": "Scan" + }, + "notifications": { + "enabled": "Plugin aktiv", + "disabled": "Plugin inaktiv", + "updated": "Plugin aktualisiert", + "error": "Fehler beim aktualisieren des Plugins" + }, + "validation": { + "invalidJson": "Konfiguration muss valides JSON sein" + }, + "messages": { + "configHelp": "Plugin mit Schlüssel-Werte Paaren konfigurieren. Leer lassen wenn das Plugin keine Konfiguration benötigt.", + "clickPermissions": "Berechtigung anklicken für mehr Details", + "noConfig": "Keine Konfiguration gesetzt", + "allUsersHelp": "Wenn aktiviert, erhält das Plugin Zugriff auf alle Benutzer, inklusive solcher, die in Zukunft erstellt werden.", + "noUsers": "Keine Benutzer ausgewählt", + "permissionReason": "Begründung", + "usersRequired": "Dieses Plugin benötigt Zugriff auf Benutzerinformationen. Wähle aus, auf welche Nutzer das Plugin zugreifen darf oder wähle 'Alle Benutzer'.", + "allLibrariesHelp": "Wenn aktiviert, erhält das Plugin Zugriff auf alle Bibliotheken, inklusive solcher, die in Zukunft erstellt werden.", + "noLibraries": "Keine Bibliotheken ausgewählt", + "librariesRequired": "Dieses Plugin benötigt Zugriff auf Bibliotheken. Wähle aus, auf welche Bibliotheken das Plugin zugreifen darf oder wähle 'Alle Bibliotheken'.", + "requiredHosts": "Benötigte Hosts", + "configValidationError": "Validierung der Konfiguration fehlgeschlagen:", + "schemaRenderError": "Rendern der Konfiguration fehlgeschlagen. Das Schema das Plugins ist eventuell nicht korrekt.", + "allowWriteAccessHelp": "Wenn aktiviert, kann das Plugin Dateien in den Bibliotheken verändern. Als Standard haben Plugins nur Lesezugriff." + }, + "placeholders": { + "configKey": "Schlüssel", + "configValue": "Wert" } } }, @@ -391,10 +560,10 @@ "note": "HINWEIS", "transcodingDisabled": "Die Änderung der Transcodierungskonfiguration über die Web-UI ist aus Sicherheitsgründen deaktiviert. Wenn du die Transcodierungsoptionen ändern (bearbeiten oder hinzufügen) möchtest, starte den Server mit der Konfigurationsoption %{config} neu.", "transcodingEnabled": "Navidrome läuft derzeit mit %{config}, wodurch es möglich ist, Systembefehle aus den Transkodierungseinstellungen über die Webschnittstelle auszuführen. Wir empfehlen, es aus Sicherheitsgründen zu deaktivieren und nur bei der Konfiguration von Transkodierungsoptionen zu aktivieren.", - "songsAddedToPlaylist": "Einen Titel zur Playlist hinzugefügt |||| %{smart_count} Titel zur Playlist hinzugefügt", - "noPlaylistsAvailable": "Keine Playlist verfügbar", + "songsAddedToPlaylist": "Einen Titel zur Wiedergabeliste hinzugefügt |||| %{smart_count} Titel zur Wiedergabeliste hinzugefügt", + "noPlaylistsAvailable": "Keine Wiedergabeliste verfügbar", "delete_user_title": "Benutzer '%{name}' löschen", - "delete_user_content": "Möchtest du diesen Benutzer und alle seine Daten (einschließlich Playlisten und Einstellungen) wirklich löschen?", + "delete_user_content": "Möchtest du diesen Benutzer und alle seine Daten (einschließlich Wiedergabelisten und Einstellungen) wirklich löschen?", "notifications_blocked": "Sie haben Benachrichtigungen für diese Seite in den Einstellungen Ihres Browsers blockiert", "notifications_not_available": "Dieser Browser unterstützt keine Desktop-Benachrichtigungen", "lastfmLinkSuccess": "Last.fm Verbindung hergestellt und scrobbling aktiviert", @@ -419,7 +588,18 @@ "downloadDialogTitle": "Download %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "In Zwischenablage kopieren: Ctrl+C, Enter", "remove_missing_title": "Fehlende Dateien entfernen", - "remove_missing_content": "Möchtest du die ausgewählten Fehlenden Dateien wirklich aus der Datenbank entfernen? Alle Referenzen zu den Dateien wie Anzahl Wiedergaben und Bewertungen werden permanent gelöscht." + "remove_missing_content": "Möchtest du die ausgewählten Fehlenden Dateien wirklich aus der Datenbank entfernen? Alle Referenzen zu den Dateien wie Anzahl Wiedergaben und Bewertungen werden permanent gelöscht.", + "remove_all_missing_title": "Alle fehlenden Dateien entfernen", + "remove_all_missing_content": "Möchtest du wirklich alle Fehlenden Dateien aus der Datenbank entfernen? Alle Referenzen zu den Dateien wie Anzahl Wiedergaben und Bewertungen werden permanent gelöscht.", + "noSimilarSongsFound": "Keine ähnlichen Titel gefunden", + "noTopSongsFound": "Keine beliebten Titel gefunden", + "startingInstantMix": "Lade Sofort-Mix...", + "uploadCover": "Cover hochladen", + "removeCover": "Cover entfernen", + "coverUploaded": "Cover aktualisiert", + "coverRemoved": "Cover entfernt", + "coverUploadError": "Fehler beim Hochladen des Covers", + "coverRemoveError": "Fehler beim Entfernen des Covers" }, "menu": { "library": "Bibliothek", @@ -447,11 +627,17 @@ }, "albumList": "Alben", "about": "Über", - "playlists": "Playlisten", - "sharedPlaylists": "Geteilte Playlisten" + "playlists": "Wiedergabelisten", + "sharedPlaylists": "Geteilte Wiedergabelisten", + "librarySelector": { + "allLibraries": "Alle Bibliotheken (%{count})", + "multipleLibraries": "%{selected} von %{total} Bibliotheken", + "selectLibraries": "Bibliotheken auswählen", + "none": "Keine" + } }, "player": { - "playListsText": "Wiedergabeliste abspielen", + "playListsText": "Warteschlange abspielen", "openText": "Öffnen", "closeText": "Schließen", "notContentText": "Keine Musik", @@ -485,6 +671,22 @@ "disabled": "Deaktiviert", "waiting": "Warten" } + }, + "tabs": { + "about": "Über", + "config": "Konfiguration" + }, + "config": { + "configName": "Einstellung", + "environmentVariable": "Umbegungsvariable", + "currentValue": "Wert", + "configurationFile": "Konfigurationsdatei", + "exportToml": "Konfiguration exportieren (TOML)", + "exportSuccess": "Konfiguration im TOML Format in die Zwischenablage kopiert", + "exportFailed": "Fehler beim Kopieren der Konfiguration", + "devFlagsHeader": "Entwicklungseinstellungen (können sich ändern)", + "devFlagsComment": "Experimentelle Einstellungen, die eventuell in Zukunft entfernt oder geändert werden", + "downloadToml": "Konfiguration Herunterladen (TOML)" } }, "activity": { @@ -493,7 +695,11 @@ "quickScan": "Schneller Scan", "fullScan": "Kompletter Scan", "serverUptime": "Server-Betriebszeit", - "serverDown": "OFFLINE" + "serverDown": "OFFLINE", + "scanType": "Typ", + "status": "Scan Fehler", + "elapsedTime": "Laufzeit", + "selectiveScan": "Selektiver Scan" }, "help": { "title": "Navidrome Hotkeys", @@ -508,5 +714,10 @@ "toggle_love": "Titel zu Favoriten hinzufügen", "current_song": "Aktuellen Titel Anzeigen" } + }, + "nowPlaying": { + "title": "Aktuelle Wiedergabe", + "empty": "Keine Wiedergabe", + "minutesAgo": "Vor %{smart_count} Minute |||| Vor %{smart_count} Minuten" } } \ No newline at end of file diff --git a/resources/i18n/el.json b/resources/i18n/el.json index d574821d4..3876c2e33 100644 --- a/resources/i18n/el.json +++ b/resources/i18n/el.json @@ -33,7 +33,12 @@ "tags": "Πρόσθετες Ετικέτες", "mappedTags": "Χαρτογραφημένες ετικέτες", "rawTags": "Ακατέργαστες ετικέτες", - "bitDepth": "Λίγο βάθος" + "bitDepth": "Λίγο βάθος", + "sampleRate": "Ποσοστό δειγματοληψίας", + "missing": "Απών", + "libraryName": "Βιβλιοθήκη", + "composer": "Συνθέτης", + "disc": "Δίσκος %{discNumber}" }, "actions": { "addToQueue": "Αναπαραγωγη Μετα", @@ -42,7 +47,9 @@ "shuffleAll": "Ανακατεμα ολων", "download": "Ληψη", "playNext": "Επόμενη Αναπαραγωγή", - "info": "Εμφάνιση Πληροφοριών" + "info": "Εμφάνιση Πληροφοριών", + "showInPlaylist": "Εμφάνιση στη λίστα αναπαραγωγής", + "instantMix": "Άμεση Μίξη" } }, "album": { @@ -72,7 +79,9 @@ "grouping": "Ομαδοποίηση", "media": "Μέσα", "mood": "Διάθεση", - "date": "Ημερομηνία Ηχογράφησης" + "date": "Ημερομηνία Ηχογράφησης", + "missing": "Απών", + "libraryName": "Βιβλιοθήκη" }, "actions": { "playAll": "Αναπαραγωγή", @@ -104,7 +113,8 @@ "rating": "Βαθμολογια", "genre": "Είδος", "size": "Μέγεθος", - "role": "Ρόλος" + "role": "Ρόλος", + "missing": "Απών" }, "roles": { "albumartist": "Καλλιτέχνης Άλμπουμ |||| Καλλιτέχνες άλμπουμ", @@ -119,7 +129,13 @@ "mixer": "Μίξερ |||| Μίξερ", "remixer": "Ρεμίξερ |||| Ρεμίξερ", "djmixer": "Dj Μίξερ |||| Dj Μίξερ", - "performer": "Εκτελεστής |||| Ερμηνευτές" + "performer": "Εκτελεστής |||| Ερμηνευτές", + "maincredit": "Καλλιτέχνης Άλμπουμ ή Καλλιτέχνης |||| Καλλιτέχνες Άλμπουμ ή Καλλιτέχνες" + }, + "actions": { + "shuffle": "Ανάμιξη", + "radio": "Ραδιόφωνο", + "topSongs": "Κορυφαία τραγούδια" } }, "user": { @@ -132,14 +148,16 @@ "name": "Όνομα", "password": "Κωδικός Πρόσβασης", "createdAt": "Δημιουργήθηκε στις", - "changePassword": "Αλλαγή Κωδικού Πρόσβασης;", + "changePassword": "Αλλαγή Κωδικού Πρόσβασης?", "currentPassword": "Υπάρχων Κωδικός Πρόσβασης", "newPassword": "Νέος Κωδικός Πρόσβασης", "token": "Token", - "lastAccessAt": "Τελευταία Πρόσβαση" + "lastAccessAt": "Τελευταία Πρόσβαση", + "libraries": "Βιβλιοθήκες" }, "helperTexts": { - "name": "Αλλαγές στο όνομα σας θα εφαρμοστούν στην επόμενη σύνδεση" + "name": "Αλλαγές στο όνομα σας θα εφαρμοστούν στην επόμενη σύνδεση", + "libraries": "Επιλέξτε συγκεκριμένες βιβλιοθήκες για αυτόν τον χρήστη, ή αφήστε την κενή για να χρησιμοποιήσετε την προεπιλεγμένη βιβλιοθήκη" }, "notifications": { "created": "Ο χρήστης δημιουργήθηκε", @@ -148,7 +166,12 @@ }, "message": { "listenBrainzToken": "Εισάγετε το token του χρήστη σας στο ListenBrainz.", - "clickHereForToken": "Κάντε κλικ εδώ για να αποκτήσετε το token σας" + "clickHereForToken": "Κάντε κλικ εδώ για να αποκτήσετε το token σας", + "selectAllLibraries": "Επιλογή όλων των βιβλιοθηκών", + "adminAutoLibraries": "Οι χρήστες διαχειριστές έχουν αυτόματα πρόσβαση σε όλες τις βιβλιοθήκες" + }, + "validation": { + "librariesRequired": "Πρέπει να επιλεγεί τουλάχιστον μία βιβλιοθήκη για χρήστες που δεν είναι διαχειριστές" } }, "player": { @@ -192,11 +215,17 @@ "addNewPlaylist": "Δημιουργία \"%{name}\"", "export": "Εξαγωγη", "makePublic": "Να γίνει δημόσιο", - "makePrivate": "Να γίνει ιδιωτικό" + "makePrivate": "Να γίνει ιδιωτικό", + "saveQueue": "Αποθήκευση ουράς στη λίστα αναπαραγωγής", + "searchOrCreate": "Αναζητήστε λίστες αναπαραγωγής ή πληκτρολογήστε για να δημιουργήσετε νέες...", + "pressEnterToCreate": "Πατήστε Enter για να δημιουργήσετε νέα λίστα αναπαραγωγής", + "removeFromSelection": "Αφαίρεση από την επιλογή" }, "message": { "duplicate_song": "Προσθήκη διπλοεγγραφών τραγουδιών", - "song_exist": "Υπάρχουν διπλοεγγραφές στην λίστα αναπαραγωγής. Θέλετε να προστεθούν οι διπλοεγγραφές ή να τις παραβλέψετε;" + "song_exist": "Υπάρχουν διπλοεγγραφές στην λίστα αναπαραγωγής. Θέλετε να προστεθούν οι διπλοεγγραφές ή να τις παραβλέψετε?", + "noPlaylistsFound": "Δεν βρέθηκαν λίστες αναπαραγωγής", + "noPlaylists": "Δεν υπάρχουν διαθέσιμες λίστες αναπαραγωγής" } }, "radio": { @@ -234,15 +263,150 @@ "fields": { "path": "Διαδρομή", "size": "Μέγεθος", - "updatedAt": "Εξαφανίστηκε" + "updatedAt": "Εξαφανίστηκε", + "libraryName": "Βιβλιοθήκη" }, "actions": { - "remove": "Αφαίρεση" + "remove": "Αφαίρεση", + "remove_all": "Αφαίρεση όλων" }, "notifications": { "removed": "Λείπει αρχείο(α) αφαιρέθηκε" }, "empty": "Δεν λείπουν αρχεία" + }, + "library": { + "name": "Βιβλιοθήκη |||| Βιβλιοθήκες", + "fields": { + "name": "Ονομα", + "path": "διαδρομή", + "remotePath": "Απομακρυσμένη διαδρομή", + "lastScanAt": "Τελευταία σάρωση", + "songCount": "Τραγούδια", + "albumCount": "Άλμπουμ", + "artistCount": "Καλλιτέχνες", + "totalSongs": "Τραγούδια", + "totalAlbums": "Άλμπουμ", + "totalArtists": "Καλλιτέχνες", + "totalFolders": "Φάκελοι", + "totalFiles": "Αρχεία", + "totalMissingFiles": "Λείπει αρχείο", + "totalSize": "Συνολικό μέγεθος", + "totalDuration": "Διάρκεια", + "defaultNewUsers": "Προεπιλογή για νέους χρήστες", + "createdAt": "Δημιουργήθηκε", + "updatedAt": "Ενημερώθηκε" + }, + "sections": { + "basic": "Βασικές πληροφορίες", + "statistics": "Στατιστική" + }, + "actions": { + "scan": "Σάρωση βιβλιοθήκης", + "manageUsers": "Διαχείριση πρόσβασης χρήστη", + "viewDetails": "Προβολή λεπτομερειών", + "quickScan": "Γρήγορη σάρωση", + "fullScan": "Πλήρης σάρωση" + }, + "notifications": { + "created": "Η βιβλιοθήκη δημιουργήθηκε με επιτυχία", + "updated": "Η βιβλιοθήκη ενημερώθηκε με επιτυχία", + "deleted": "Η βιβλιοθήκη διαγράφηκε με επιτυχία", + "scanStarted": "Ξεκίνησε η σάρωση της βιβλιοθήκης", + "scanCompleted": "Η σάρωση της βιβλιοθήκης ολοκληρώθηκε", + "quickScanStarted": "Η Γρήγορη Σάρωση ξεκίνησε", + "fullScanStarted": "Η πλήρης σάρωση ξεκίνησε", + "scanError": "Σφάλμα κατά την έναρξη της σάρωσης. Ελέγξτε τα αρχεία καταγραφής." + }, + "validation": { + "nameRequired": "Απαιτείται όνομα βιβλιοθήκης", + "pathRequired": "Απαιτείται διαδρομή βιβλιοθήκης", + "pathNotDirectory": "Η διαδρομή της βιβλιοθήκης πρέπει να είναι ένας κατάλογος", + "pathNotFound": "Η διαδρομή της βιβλιοθήκης δεν βρέθηκε", + "pathNotAccessible": "Η διαδρομή της βιβλιοθήκης δεν είναι προσβάσιμη", + "pathInvalid": "Μη έγκυρη διαδρομή βιβλιοθήκης" + }, + "messages": { + "deleteConfirm": "Είστε βέβαιοι ότι θέλετε να διαγράψετε αυτήν τη βιβλιοθήκη? Αυτή η ενέργεια θα καταργήσει όλα τα σχετικά δεδομένα και την πρόσβαση των χρηστών.", + "scanInProgress": "Σάρωση σε εξέλιξη...", + "noLibrariesAssigned": "Δεν έχουν αντιστοιχιστεί βιβλιοθήκες σε αυτόν τον χρήστη" + } + }, + "plugin": { + "name": "Πρόσθετο |||| Πρόσθετα", + "fields": { + "id": "ID", + "name": "Όνομα", + "description": "Περιγραφή", + "version": "Έκδοση", + "author": "Καλλιτέχνης", + "website": "Ιστοσελίδα", + "permissions": "Άδειες", + "enabled": "Ενεργό", + "status": "Κατάσταση", + "path": "Διαδρομή", + "lastError": "Σφάλμα", + "hasError": "Σφάλμα", + "updatedAt": "Ενημερώθηκε", + "createdAt": "Εγκατασταθηκε", + "configKey": "Κλειδί", + "configValue": "Τιμή", + "allUsers": "Επιτρέψτε όλους τους χρήστες", + "selectedUsers": "Επιλογή χρηστών", + "allLibraries": "Επιτρέψτε όλες τις βιβλιοθήκες", + "selectedLibraries": "Επιλεγμένες βιβλιοθήκες", + "allowWriteAccess": "Επιτρέψτε την πρόσβαση εγγραφής" + }, + "sections": { + "status": "Κατάσταση", + "info": "Πληροφορίες Πρόσθετου", + "configuration": "Παραμετροποίηση", + "manifest": "Manifest", + "usersPermission": "Άδειες Χρηστών", + "libraryPermission": "Άδειες Βιβλιοθηκών" + }, + "status": { + "enabled": "Ενεργό", + "disabled": "Ανενεργό" + }, + "actions": { + "enable": "Ενεργοποίηση", + "disable": "Απενεργοποίηση", + "disabledDueToError": "Διορθώστε το σφάλμα πριν την ενεργοποίηση", + "disabledUsersRequired": "Επιλέξτε χρήστες πριν την ενεργοποίηση", + "disabledLibrariesRequired": "Επιλέξτε βιβλιοθήκες πριν την ενεργοποίηση", + "addConfig": "Προσθήκη παραμετροποίησης", + "rescan": "Σάρωση ξανά" + }, + "notifications": { + "enabled": "Πρόσθετο ενεργοποιημένο", + "disabled": "Πρόσθετο απενεργοποιημένο", + "updated": "Πρόσθετο ενημερωμένο", + "error": "Σφάλμα κατά την ενημέρωση του πρόσθετου" + }, + "validation": { + "invalidJson": "Η παραμετροποίηση πρέπει να είναι συμβατό JSON" + }, + "messages": { + "configHelp": "Παραμετροποιήστε το πρόσθετο με χρήση ζεύγων κλειδιών-τιμών. Αφήστε κενό αν το πρόσθετο δεν απαιτεί παραμετροποίηση", + "clickPermissions": "Κάνετε κλικ για λεπτομέρειες αδειών", + "noConfig": "Δεν ορίστηκε παραμετροποίηση", + "allUsersHelp": "Όταν είναι ενεργό, το πρόσθετο θα έχει πρόσβαση σε όλους τους χρήστες, συμπεριλαμβανομένων και όσων δημιουργηθούν στο μέλλον.", + "noUsers": "Δεν επιλέχθηκαν χρήστες", + "permissionReason": "Αιτία", + "usersRequired": "Το πρόσθετο απαιτεί πρόσβαση στις πληροφορίες χρηστών. Ορίστε τους χρήστες που θα έχει πρόσβαση το πρόσθετο, ή ενεργοποιήστε το 'Επιτρέψτε όλους τους χρήστες'", + "allLibrariesHelp": "Όταν είναι ενεργό, το πρόσθετο θα έχει πρόσβαση σε όλες τις βιβλιοθήκες, συμπεριλαμβανομένων και όσων δημιουργηθούν στο μέλλον.", + "noLibraries": "Δεν επιλέχθηκαν βιβλιοθήκες", + "librariesRequired": "Αυτό το πρόσθετο απαιτεί πρόσβαση στις πληροφορίες βιβλιοθήκης. Επιλέξτε σε ποιές βιβλιοθήκες μπορεί να έχει πρόσβαση το πρόσθετο, ή ενεργοποιήστε το 'Επιτρέψτε όλες τις βιβλιοθήκες'", + "requiredHosts": "Απαιτούμενοι hosts", + "configValidationError": "Η επικύρωση διαμόρφωσης απέτυχε:", + "schemaRenderError": "Δεν είναι δυνατή η απόδοση της φόρμας διαμόρφωσης. Το σχήμα της προσθήκης ενδέχεται να μην είναι έγκυρο.", + "allowWriteAccessHelp": "Όταν είναι ενεργοποιημένο, το πρόσθετο μπορεί να τροποποιήσει αρχεία στους καταλόγους της βιβλιοθήκης. Από προεπιλογή, τα πρόσθετα έχουν πρόσβαση μόνο για ανάγνωση." + }, + "placeholders": { + "configKey": "κλειδί", + "configValue": "τιμή" + } } }, "ra": { @@ -305,7 +469,7 @@ "skip": "Παράβλεψη", "bulk_actions_mobile": "1 |||| %{smart_count}", "share": "Κοινοποίηση", - "download": "Λήψη " + "download": "Λήψη" }, "boolean": { "true": "Ναι", @@ -344,10 +508,10 @@ }, "message": { "about": "Σχετικά", - "are_you_sure": "Είστε σίγουροι;", - "bulk_delete_content": "Είστε σίγουροι πως θέλετε να διαγράψετε το %{name}; |||| Είστε σίγουροι πως θέλετε να διαγράψετε τα %{smart_count};", + "are_you_sure": "Είστε σίγουροι?", + "bulk_delete_content": "Είστε σίγουροι πως θέλετε να διαγράψετε το %{name}? |||| Είστε σίγουροι πως θέλετε να διαγράψετε τα %{smart_count}?", "bulk_delete_title": "Διαγραφή του %{name} |||| Διαγραφή του %{smart_count} %{name}", - "delete_content": "Είστε σίγουροι πως θέλετε να διαγράψετε αυτό το αντικείμενο;", + "delete_content": "Είστε σίγουροι πως θέλετε να διαγράψετε αυτό το αντικείμενο?", "delete_title": "Διαγραφή του %{name} #%{id}", "details": "Λεπτομέρειες", "error": "Παρουσιάστηκε ένα πρόβλημα από τη μεριά του πελάτη και το αίτημα σας δεν μπορεί να ολοκληρωθεί.", @@ -356,12 +520,12 @@ "no": "Όχι", "not_found": "Είτε έχετε εισάγει λανθασμένο URL, είτε ακολουθήσατε έναν υπερσύνδεσμο που δεν ισχύει.", "yes": "Ναι", - "unsaved_changes": "Μερικές από τις αλλαγές σας δεν έχουν αποθηκευτεί. Είστε σίγουροι πως θέλετε να τις αγνοήσετε;" + "unsaved_changes": "Μερικές από τις αλλαγές σας δεν έχουν αποθηκευτεί. Είστε σίγουροι πως θέλετε να τις αγνοήσετε?" }, "navigation": { "no_results": "Δεν βρέθηκαν αποτελέσματα", "no_more_results": "Η σελίδα %{page} είναι εκτός ορίων. Δοκιμάστε την προηγούμενη σελίδα.", - "page_out_of_boundaries": "Η σελίδα {page} είναι εκτός ορίων", + "page_out_of_boundaries": "Η σελίδα %{page} είναι εκτός ορίων", "page_out_from_end": "Δεν είναι δυνατή η πλοήγηση πέραν της τελευταίας σελίδας", "page_out_from_begin": "Δεν είναι δυνατή η πλοήγηση πριν τη σελίδα 1", "page_range_info": "%{offsetBegin}-%{offsetEnd} από %{total}", @@ -397,7 +561,7 @@ "songsAddedToPlaylist": "Προστέθηκε 1 τραγούδι στη λίστα αναπαραγωγής |||| Προστέθηκαν %{smart_count} τραγούδια στη λίστα αναπαραγωγής", "noPlaylistsAvailable": "Κανένα διαθέσιμο", "delete_user_title": "Διαγραφή του χρήστη '%{name}'", - "delete_user_content": "Είστε σίγουροι πως θέλετε να διαγράψετε αυτό το χρήστη και όλα τα δεδομένα του (συμπεριλαμβανομένων των λιστών αναπαραγωγής και προτιμήσεων);", + "delete_user_content": "Είστε σίγουροι πως θέλετε να διαγράψετε αυτό το χρήστη και όλα τα δεδομένα του (συμπεριλαμβανομένων των λιστών αναπαραγωγής και προτιμήσεων)?", "notifications_blocked": "Έχετε μπλοκάρει τις Ειδοποιήσεις από τη σελίδα, μέσω των ρυθμίσεων του περιηγητή ιστού σας", "notifications_not_available": "Αυτός ο περιηγητής ιστού δεν υποστηρίζει ειδοποιήσεις στην επιφάνεια εργασίας ή δεν έχετε πρόσβαση στο Navidrome μέσω https", "lastfmLinkSuccess": "Το Last.fm έχει διασυνδεθεί επιτυχώς και η λειτουργία scrobbling ενεργοποιήθηκε", @@ -422,7 +586,18 @@ "downloadDialogTitle": "Λήψη %{resource} '%{name}'(%{size})", "shareCopyToClipboard": "Αντιγραφή στο πρόχειρο: Ctrl+C, Enter", "remove_missing_title": "Αφαιρέστε τα αρχεία που λείπουν", - "remove_missing_content": "Είστε βέβαιοι ότι θέλετε να αφαιρέσετε τα επιλεγμένα αρχεία που λείπουν από τη βάση δεδομένων; Αυτό θα καταργήσει οριστικά τυχόν αναφορές σε αυτά, συμπεριλαμβανομένων των αριθμών παιχνιδιών και των αξιολογήσεών τους." + "remove_missing_content": "Είστε βέβαιοι ότι θέλετε να αφαιρέσετε τα επιλεγμένα αρχεία που λείπουν από τη βάση δεδομένων? Αυτό θα καταργήσει οριστικά τυχόν αναφορές σε αυτά, συμπεριλαμβανομένων των αριθμών παιχνιδιών και των αξιολογήσεών τους.", + "remove_all_missing_title": "Αφαίρεση όλων των αρχείων που λείπουν", + "remove_all_missing_content": "Είστε βέβαιοι ότι θέλετε να καταργήσετε όλα τα αρχεία που λείπουν από τη βάση δεδομένων? Αυτό θα καταργήσει οριστικά τυχόν αναφορές σε αυτά, συμπεριλαμβανομένου του αριθμού αναπαραγωγών και των αξιολογήσεών τους.", + "noSimilarSongsFound": "Δεν βρέθηκαν παρόμοια τραγούδια", + "noTopSongsFound": "Δεν βρέθηκαν κορυφαία τραγούδια", + "startingInstantMix": "Φόρτωση Άμεσης Μίξης...", + "uploadCover": "Μεταφόρτωση εξωφύλλου", + "removeCover": "Αφαίρεση καλύμματος", + "coverUploaded": "Το εξώφυλλο ενημερώθηκε", + "coverRemoved": "Το εξώφυλλο αφαιρέθηκε", + "coverUploadError": "Σφάλμα κατά τη μεταφόρτωση του εξωφύλλου", + "coverRemoveError": "Σφάλμα κατά την αφαίρεση του εξωφύλλου" }, "menu": { "library": "Βιβλιοθήκη", @@ -451,7 +626,13 @@ "albumList": "Άλμπουμ", "about": "Σχετικά", "playlists": "Λίστες Αναπαραγωγής", - "sharedPlaylists": "Κοινοποιημένες Λίστες Αναπαραγωγής" + "sharedPlaylists": "Κοινοποιημένες Λίστες Αναπαραγωγής", + "librarySelector": { + "allLibraries": "Όλες οι βιβλιοθήκες (%{count})", + "multipleLibraries": "%{selected} από %{total} Βιβλιοθήκες", + "selectLibraries": "Επιλέξτε βιβλιοθήκες", + "none": "Κανένα" + } }, "player": { "playListsText": "Ουρά Αναπαραγωγής", @@ -488,6 +669,22 @@ "disabled": "Απενεργοποιημένο", "waiting": "Αναμονή" } + }, + "tabs": { + "about": "Σχετικά", + "config": "Διαμόρφωση" + }, + "config": { + "configName": "Όνομα διαμόρφωσης", + "environmentVariable": "Μεταβλητή περιβάλλοντος", + "currentValue": "Τρέχουσα Αξία", + "configurationFile": "Αρχείο διαμόρφωσης", + "exportToml": "Ρύθμιση παραμέτρων εξαγωγής (TOML)", + "exportSuccess": "Η διαμόρφωση εξήχθη στο πρόχειρο σε μορφή TOML", + "exportFailed": "Η αντιγραφή της διαμόρφωσης απέτυχε", + "devFlagsHeader": "Σημαίες Ανάπτυξης (υπόκειται σε αλλαγές / αφαίρεση)", + "devFlagsComment": "Αυτές είναι πειραματικές ρυθμίσεις και ενδέχεται να καταργηθούν σε μελλοντικές εκδόσεις", + "downloadToml": "Λήψη διαμόρφωσης (TOML)" } }, "activity": { @@ -496,7 +693,11 @@ "quickScan": "Γρήγορη Σάρωση", "fullScan": "Πλήρης Σάρωση", "serverUptime": "Λειτουργία Διακομιστή", - "serverDown": "ΕΚΤΟΣ ΣΥΝΔΕΣΗΣ" + "serverDown": "ΕΚΤΟΣ ΣΥΝΔΕΣΗΣ", + "scanType": "Τύπος", + "status": "Σφάλμα σάρωσης", + "elapsedTime": "Χρόνος που πέρασε", + "selectiveScan": "Εκλεκτικός" }, "help": { "title": "Συντομεύσεις του Navidrome", @@ -511,5 +712,10 @@ "toggle_love": "Προσθήκη αυτού του κομματιού στα αγαπημένα", "current_song": "Μεταβείτε στο Τρέχον τραγούδι" } + }, + "nowPlaying": { + "title": "Αναπαραγωγή τώρα", + "empty": "Δεν παίζει τίποτα", + "minutesAgo": "%{smart_count} λεπτό πριν |||| %{smart_count} λεπτά πριν" } } \ No newline at end of file diff --git a/resources/i18n/eo.json b/resources/i18n/eo.json index 570943a1d..60eaa6d7c 100644 --- a/resources/i18n/eo.json +++ b/resources/i18n/eo.json @@ -24,16 +24,21 @@ "rating": "Takso", "quality": "Kvalito", "bpm": "Pulsrapideco", - "playDate": "", - "channels": "", - "createdAt": "", - "grouping": "", - "mood": "", - "participants": "", - "tags": "", - "mappedTags": "", - "rawTags": "", - "bitDepth": "" + "playDate": "Laste Ludita", + "channels": "Kanaloj", + "createdAt": "Dato de aligo", + "grouping": "Grupo", + "mood": "Humoro", + "participants": "Aldonaj partoprenantoj", + "tags": "Aldonaj Etikedoj", + "mappedTags": "Mapigitaj etikedoj", + "rawTags": "Krudaj etikedoj", + "bitDepth": "Bitprofundo", + "sampleRate": "Elprena rapido", + "missing": "Mankaj", + "libraryName": "Biblioteko", + "composer": "", + "disc": "" }, "actions": { "addToQueue": "Ludi Poste", @@ -42,7 +47,9 @@ "shuffleAll": "Miksu Ĉiujn", "download": "Elŝuti", "playNext": "Ludu Poste", - "info": "" + "info": "Akiri Informon", + "showInPlaylist": "Montri en Ludlisto", + "instantMix": "" } }, "album": { @@ -60,19 +67,21 @@ "updatedAt": "Ĝisdatigita je :", "comment": "Komento", "rating": "Takso", - "createdAt": "", - "size": "", - "originalDate": "", - "releaseDate": "", - "releases": "", - "released": "", - "recordLabel": "", - "catalogNum": "", - "releaseType": "", - "grouping": "", - "media": "", - "mood": "", - "date": "" + "createdAt": "Dato aldonita", + "size": "Grando", + "originalDate": "Originala", + "releaseDate": "Publikiĝis", + "releases": "Publikiĝo |||| Publikiĝoj", + "released": "Publikiĝis", + "recordLabel": "Eldonejo", + "catalogNum": "Kataloga Numero", + "releaseType": "Tipo", + "grouping": "Grupo", + "media": "Aŭdvidaĵo", + "mood": "Humoro", + "date": "Registraĵa Dato", + "missing": "Mankaj", + "libraryName": "Biblioteko" }, "actions": { "playAll": "Ludi", @@ -81,45 +90,52 @@ "shuffle": "Miksi", "addToPlaylist": "Aldoni al la Ludlisto", "download": "Elŝuti", - "info": "", - "share": "" + "info": "Akiri Informon", + "share": "Diskonigi" }, "lists": { "all": "Ĉiuj", - "random": "Hazarda", - "recentlyAdded": "Lastatempe Aldonita", - "recentlyPlayed": "Lastatempe Ludita", + "random": "Hazardaj", + "recentlyAdded": "Lastatempe Aldonitaj", + "recentlyPlayed": "Lastatempe Luditaj", "mostPlayed": "Plej Luditaj", - "starred": "Stelplena", - "topRated": "Plej Alte Taksite" + "starred": "Stelplenaj", + "topRated": "Plej Alte Taksitaj" } }, "artist": { "name": "Artisto |||| Artistoj", "fields": { "name": "Nomo", - "albumCount": "Nombro da albumoj", - "songCount": "Kanto kalkula", - "playCount": "Teatraĵoj", + "albumCount": "Kvanto da Albumoj", + "songCount": "Kanta Kalkulo", + "playCount": "Ludoj", "rating": "Takso", - "genre": "", - "size": "", - "role": "" + "genre": "Ĝenro", + "size": "Grando", + "role": "Rolo", + "missing": "Mankaj" }, "roles": { - "albumartist": "", - "artist": "", - "composer": "", - "conductor": "", - "lyricist": "", - "arranger": "", - "producer": "", - "director": "", - "engineer": "", - "mixer": "", - "remixer": "", - "djmixer": "", - "performer": "" + "albumartist": "Albuma Artisto |||| Albumaj Artistoj", + "artist": "Artisto |||| Artistoj", + "composer": "Komponisto |||| Komponistoj", + "conductor": "Dirigento |||| Dirigentoj", + "lyricist": "Kantoteksisto |||| Kantotekstistoj", + "arranger": "Aranĝisto |||| Aranĝistoj", + "producer": "Produktisto |||| Produktistoj", + "director": "Direktoro |||| Direktoroj", + "engineer": "Inĝeniero |||| Inĝenieroj", + "mixer": "Miksisto |||| Miksistoj", + "remixer": "Remiksisto |||| Remiksistoj", + "djmixer": "Dĵ-a Miksisto |||| Dĵ-a Miksistoj", + "performer": "Plenumisto |||| Plenumistoj", + "maincredit": "Albuma Artisto aŭ Artisto |||| Albumaj Artistoj aŭ Artistoj" + }, + "actions": { + "shuffle": "Miksi", + "radio": "Radio", + "topSongs": "Plej Luditaj Kantoj" } }, "user": { @@ -135,11 +151,13 @@ "changePassword": "Ĉu Ŝanĝi Pasvorton?", "currentPassword": "Nuna Pasvorto", "newPassword": "Nova Pasvorto", - "token": "", - "lastAccessAt": "" + "token": "Ĵetono", + "lastAccessAt": "Lasta Atingo", + "libraries": "Bibliotekoj" }, "helperTexts": { - "name": "Ŝanĝoj de via nomo nur ĝisdatiĝs je via sekvanta ensaluto" + "name": "Ŝanĝoj de via nomo nur ĝisdatiĝs je via sekvanta ensaluto", + "libraries": "Elekti specifajn bibliotekojn por ĉi tiu uzanto, aŭ lasi malplena por uzi defaŭltajn bibliotekojn" }, "notifications": { "created": "Uzanto farita", @@ -147,8 +165,13 @@ "deleted": "Uzanto forigita" }, "message": { - "listenBrainzToken": "", - "clickHereForToken": "" + "listenBrainzToken": "Enigi vian uzantan ĵetonon de ListenBrainz.", + "clickHereForToken": "Alkakli ĉi tie por akiri vian ĵetonon", + "selectAllLibraries": "Elekti ĉiujn bibliotekojn", + "adminAutoLibraries": "Administrantoj aŭtomate havas aliron al ĉiuj bibliotekoj" + }, + "validation": { + "librariesRequired": "Almenaŭ unu biblioteko devas esti elektita por neadministrantoj" } }, "player": { @@ -161,7 +184,7 @@ "userName": "Uzantnomo", "lastSeen": "Laste Vidita Je", "reportRealPath": "Raporti vera pado", - "scrobbleEnabled": "" + "scrobbleEnabled": "Sendi Scrobbles al eksteraj servoj" } }, "transcoding": { @@ -191,58 +214,199 @@ "selectPlaylist": "Elektu ludliston :", "addNewPlaylist": "Krei \"%{name}\"", "export": "Eksporti", - "makePublic": "", - "makePrivate": "" + "makePublic": "Publikigi", + "makePrivate": "Malpublikigi", + "saveQueue": "Konservi Ludvicon al Ludlisto", + "searchOrCreate": "Serĉi ludlistojn aŭ tajpi por krei novan...", + "pressEnterToCreate": "Premu je Enter por krei novan ludliston", + "removeFromSelection": "Forigi de elekto" }, "message": { "duplicate_song": "Aldoni duobligitajn kantojn", - "song_exist": "Estas duoblaĵoj kiuj aldoniĝas al la kantolisto. Ĉu vi ŝatus aldoni la duoblaĵojn aŭ pasigi ilin?" + "song_exist": "Estas duoblaĵoj kiuj aldoniĝas al la kantolisto. Ĉu vi ŝatus aldoni la duoblaĵojn aŭ pasigi ilin?", + "noPlaylistsFound": "Neniuj ludlistoj trovitaj", + "noPlaylists": "Neniuj ludlistoj haveblaj" } }, "radio": { - "name": "", + "name": "Radio |||| Radioj", "fields": { - "name": "", - "streamUrl": "", - "homePageUrl": "", - "updatedAt": "", - "createdAt": "" + "name": "Nomo", + "streamUrl": "Flua Ligilo", + "homePageUrl": "Hejmpaĝa Ligilo", + "updatedAt": "Ĝisdatiĝis je", + "createdAt": "Kreiĝis je" }, "actions": { - "playNow": "" + "playNow": "Ludi Nun" } }, "share": { - "name": "", + "name": "Diskonigo |||| Diskonigoj", "fields": { - "username": "", - "url": "", - "description": "", - "contents": "", - "expiresAt": "", - "lastVisitedAt": "", - "visitCount": "", - "format": "", - "maxBitRate": "", - "updatedAt": "", - "createdAt": "", - "downloadable": "" + "username": "Diskonigite De", + "url": "Ligilo", + "description": "Priskribo", + "contents": "Enhavo", + "expiresAt": "Senvalidiĝas", + "lastVisitedAt": "Laste Vizitita", + "visitCount": "Vizitoj", + "format": "Formato", + "maxBitRate": "Maks. Bitrapido", + "updatedAt": "Ĝisdatiĝis je", + "createdAt": "Fariĝis je", + "downloadable": "Ĉu Ebligi Elŝutojn?" } }, "missing": { - "name": "", + "name": "Manka Dosiero |||| Mankaj Dosieroj", "fields": { - "path": "", - "size": "", - "updatedAt": "" + "path": "Vojo", + "size": "Grando", + "updatedAt": "Malaperis je", + "libraryName": "Biblioteko" }, "actions": { - "remove": "" + "remove": "Forigi", + "remove_all": "Forigi Ĉiujn" }, "notifications": { - "removed": "" + "removed": "Manka(j) dosiero(j) forigite" }, - "empty": "" + "empty": "Neniuj Mankaj Dosieroj" + }, + "library": { + "name": "Biblioteko |||| Bibliotekoj", + "fields": { + "name": "Nomo", + "path": "Vojo", + "remotePath": "Fora Vojo", + "lastScanAt": "Plej Lasta Skano", + "songCount": "Kantoj", + "albumCount": "Albumoj", + "artistCount": "Artistoj", + "totalSongs": "Kantoj", + "totalAlbums": "Albumoj", + "totalArtists": "Artistoj", + "totalFolders": "Dosierujoj", + "totalFiles": "Dosieroj", + "totalMissingFiles": "Mankaj Dosieroj", + "totalSize": "Totala Grando", + "totalDuration": "Daŭro", + "defaultNewUsers": "Defaŭlto por Novaj Uzantoj", + "createdAt": "Farite je", + "updatedAt": "Ĝisdatiĝis je" + }, + "sections": { + "basic": "Bazaj Informoj", + "statistics": "Statistikaĵoj" + }, + "actions": { + "scan": "Skani Bibliotekon", + "manageUsers": "Agordi Uzantan Aliron", + "viewDetails": "Montri Informojn", + "quickScan": "Rapida Skano", + "fullScan": "Plena Skano" + }, + "notifications": { + "created": "Biblioteko kreiĝis sukcese", + "updated": "Biblioteko ĝisdatiĝis sukcese", + "deleted": "Biblioteko foriĝis sukcese", + "scanStarted": "Biblioteka skano komenciĝis", + "scanCompleted": "Biblioteka skano finiĝis", + "quickScanStarted": "Rapida skano komenciĝis", + "fullScanStarted": "Plena skano komenciĝis", + "scanError": "Eraro de skana komenco. Kontrolu la protokolojn" + }, + "validation": { + "nameRequired": "Biblioteka nomo estas necesa", + "pathRequired": "Biblioteka vojo estas necesa", + "pathNotDirectory": "Biblioteka vojo devas esti dosierujo", + "pathNotFound": "Biblioteka vojo ne trovite", + "pathNotAccessible": "Biblioteka vojo ne estas alirebla", + "pathInvalid": "Nevalida biblioteka vojo" + }, + "messages": { + "deleteConfirm": "Ĉu vi certas, ke vi volas forigi ĉi tiun bibliotekon? Ĉi tio forigos ĉiujn rilatajn datumojn kaj uzantan aliron.", + "scanInProgress": "Skano progresas...", + "noLibrariesAssigned": "Neniuj bibliotekoj asignitaj por ĉi tiu uzanto" + } + }, + "plugin": { + "name": "", + "fields": { + "id": "", + "name": "", + "description": "", + "version": "Versio", + "author": "Aŭtoro", + "website": "Retejo", + "permissions": "Permesoj", + "enabled": "Ebligite", + "status": "", + "path": "Vojo", + "lastError": "Eraro", + "hasError": "Eraro", + "updatedAt": "Ĝisdatigite", + "createdAt": "", + "configKey": "Ŝlosilo", + "configValue": "", + "allUsers": "", + "selectedUsers": "", + "allLibraries": "", + "selectedLibraries": "", + "allowWriteAccess": "" + }, + "sections": { + "status": "", + "info": "", + "configuration": "", + "manifest": "", + "usersPermission": "", + "libraryPermission": "" + }, + "status": { + "enabled": "", + "disabled": "" + }, + "actions": { + "enable": "", + "disable": "", + "disabledDueToError": "", + "disabledUsersRequired": "", + "disabledLibrariesRequired": "", + "addConfig": "", + "rescan": "" + }, + "notifications": { + "enabled": "", + "disabled": "", + "updated": "", + "error": "" + }, + "validation": { + "invalidJson": "" + }, + "messages": { + "configHelp": "", + "clickPermissions": "", + "noConfig": "", + "allUsersHelp": "", + "noUsers": "", + "permissionReason": "", + "usersRequired": "", + "allLibrariesHelp": "", + "noLibraries": "", + "librariesRequired": "", + "requiredHosts": "", + "configValidationError": "", + "schemaRenderError": "", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "", + "configValue": "" + } } }, "ra": { @@ -258,7 +422,7 @@ "sign_in": "Ensaluti", "sign_in_error": "Aŭtentikigo malsukcesis, bonvolu reprovi", "logout": "Elsaluti", - "insightsCollectionNote": "" + "insightsCollectionNote": "Navidrome kolektas anoniman uzdatumon por helpi\nplibonigi la projekton. Alklaku [ĉi tie] por lerni pli kaj\nsupozi permeson se vi volas" }, "validation": { "invalidChars": "Bonvolu uzi nur literojn kaj ciferojn", @@ -273,7 +437,7 @@ "oneOf": "Devas esti unu el: %{options}", "regex": "Devas kongrui kun specifa formato (regexp): %{pattern}", "unique": "Devas esti unika", - "url": "" + "url": "Devas esti valida ligilo" }, "action": { "add_filter": "Aldoni filtrilon", @@ -303,9 +467,9 @@ "close_menu": "Fermu menuon", "unselect": "Malelekti", "skip": "Pasigi", - "bulk_actions_mobile": "", - "share": "", - "download": "" + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Diskonigi", + "download": "Elŝuti" }, "boolean": { "true": "Jes", @@ -381,13 +545,13 @@ "i18n_error": "Ne eblas ŝargi la tradukojn por la specifa lingvo", "canceled": "Ago nuligita", "logged_out": "Via seanco finiĝis, bonvolu rekonekti.", - "new_version": "" + "new_version": "Nova versio haveblas! Bonvolu reŝargi la fenestron." }, "toggleFieldsMenu": { - "columnsToDisplay": "", + "columnsToDisplay": "Kolumnoj Por Montri", "layout": "Aranĝo", "grid": "Krado", - "table": "" + "table": "Tabelo" } }, "message": { @@ -400,29 +564,40 @@ "delete_user_content": "Ĉu vi certas, ke vi volas forigi ĉi tiun uzanton kaj ĉiujn iliajn datumojn (inkluzive ludlistojn kaj preferojn) ?", "notifications_blocked": "Vi blokis sciigojn por ĉi tiu retejo en la agordoj de via retumilo", "notifications_not_available": "Ĉi tiu retumilo ne subtenas labortablajn sciigojn aŭ vi ne aliras Navidrome per https", - "lastfmLinkSuccess": "", - "lastfmLinkFailure": "", - "lastfmUnlinkSuccess": "", - "lastfmUnlinkFailure": "", + "lastfmLinkSuccess": "Last.fm sukcese ligiĝis kaj scrobbling ebliĝis", + "lastfmLinkFailure": "Last.fm ne povis ligiĝi", + "lastfmUnlinkSuccess": "Last.fm malligiĝis kaj scrobbling malebliĝis", + "lastfmUnlinkFailure": "Last.fm ne povis malligiĝi", "openIn": { - "lastfm": "", - "musicbrainz": "" + "lastfm": "Malfermi en Last.fm", + "musicbrainz": "Malfermi en MusicBrainz" }, - "lastfmLink": "", - "listenBrainzLinkSuccess": "", - "listenBrainzLinkFailure": "", - "listenBrainzUnlinkSuccess": "", - "listenBrainzUnlinkFailure": "", - "downloadOriginalFormat": "", - "shareOriginalFormat": "", - "shareDialogTitle": "", - "shareBatchDialogTitle": "", - "shareSuccess": "", - "shareFailure": "", - "downloadDialogTitle": "", - "shareCopyToClipboard": "", - "remove_missing_title": "", - "remove_missing_content": "" + "lastfmLink": "Legi Pli...", + "listenBrainzLinkSuccess": "ListenBrainz sukcese ligiĝis kaj scrobbling ebliĝis kiel uzanto: %{user}", + "listenBrainzLinkFailure": "ListenBrainz ne povis ligiĝi: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz malligiĝis kaj scrobbling malebliĝis", + "listenBrainzUnlinkFailure": "ListenBrainz ne povis malligiĝi", + "downloadOriginalFormat": "Elŝuti en originala formato", + "shareOriginalFormat": "Diskonigi en originala formato", + "shareDialogTitle": "Diskonigi %{resource} '%{name}'", + "shareBatchDialogTitle": "Diskonigi 1 %{resource} |||| Diskonigi %{smart_count} %{resource}", + "shareSuccess": "Ligilo kopiiĝis al la tondujo: %{url}", + "shareFailure": "Eraro de kopio de ligilo %{url} al la tondujo", + "downloadDialogTitle": "Elŝuti %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Kopii al la tondujo: Ctrl+C, Enter", + "remove_missing_title": "Forigi mankajn dosierojn", + "remove_missing_content": "Ĉu vi certas, ke vi volas forigi la elektitajn mankajn dosierojn de la datumbazo? Ĉi tio forigos eterne ĉiujn referencojn de ili, inkluzive iliajn ludkvantojn kaj taksojn.", + "remove_all_missing_title": "Forigi ĉiujn mankajn dosierojn", + "remove_all_missing_content": "Ĉu vi certas, ke vi volas forigi ĉiujn mankajn dosierojn de la datumbazo? Ĉi tio permanante forigos ĉiujn referencojn al ili, inkluzive iliajn ludnombrojn kaj taksojn.", + "noSimilarSongsFound": "Neniuj similaj kantoj trovitaj", + "noTopSongsFound": "Neniuj plej luditaj kantoj trovitaj", + "startingInstantMix": "", + "uploadCover": "", + "removeCover": "", + "coverUploaded": "", + "coverRemoved": "", + "coverUploadError": "", + "coverRemoveError": "" }, "menu": { "library": "Biblioteko", @@ -436,22 +611,28 @@ "language": "Lingvo", "defaultView": "Defaŭlta Vido", "desktop_notifications": "Labortablaj sciigoj", - "lastfmScrobbling": "", - "listenBrainzScrobbling": "", - "replaygain": "", - "preAmp": "", + "lastfmScrobbling": "Scrobble al Last.fm", + "listenBrainzScrobbling": "Scrobble al ListenBrainz", + "replaygain": "ReplayGain-Reĝimo", + "preAmp": "ReplayGain PreAmp (dB)", "gain": { - "none": "", - "album": "", - "track": "" + "none": "Malebligita", + "album": "Uzi Albuman Songajnon", + "track": "Uzi Kantan Songajnon" }, - "lastfmNotConfigured": "" + "lastfmNotConfigured": "API-ŝlosilo de Last.fm ne agordita" } }, "albumList": "Albumoj", "about": "Pri", - "playlists": "", - "sharedPlaylists": "" + "playlists": "Ludlistoj", + "sharedPlaylists": "Diskonigitaj Ludistoj", + "librarySelector": { + "allLibraries": "Ĉiuj Bibliotekoj (%{count})", + "multipleLibraries": "%{selected} el %{total} Bibliotekoj", + "selectLibraries": "Elekti Bibliotekojn", + "none": "Neniu" + } }, "player": { "playListsText": "Atendovico", @@ -483,11 +664,27 @@ "homepage": "Hejmpaĝo", "source": "Fontkodo", "featureRequests": "Trajta peto", - "lastInsightsCollection": "", + "lastInsightsCollection": "Plej lasta kolekto de datumoj", "insights": { - "disabled": "", - "waiting": "" + "disabled": "Malebligita", + "waiting": "Atendante" } + }, + "tabs": { + "about": "Pri", + "config": "Agordo" + }, + "config": { + "configName": "Agorda Nomo", + "environmentVariable": "Medivariablo", + "currentValue": "Nuna Valoro", + "configurationFile": "Agorda Dosiero", + "exportToml": "Eksporti Agordojn (TOML)", + "exportSuccess": "Agordoj eksportiĝis al la tondujo en TOML-a formato", + "exportFailed": "Malsukcesis kopii agordojn", + "devFlagsHeader": "Programadaj Flagoj (povas ŝanĝiĝi/foriĝi)", + "devFlagsComment": "Ĉi tiuj estas eksperimentaj agordoj kaj eble foriĝos en estontaj versioj", + "downloadToml": "" } }, "activity": { @@ -496,7 +693,11 @@ "quickScan": "Rapida Skanado", "fullScan": "Plena Skanado", "serverUptime": "Servila daŭro de funkciado", - "serverDown": "SENKONEKTA" + "serverDown": "SENKONEKTA", + "scanType": "Plej Lasta Skano", + "status": "Skana Eraro", + "elapsedTime": "Pasinta Tempo", + "selectiveScan": "Selektema" }, "help": { "title": "Navidrome klavkomando", @@ -508,8 +709,13 @@ "next_song": "Sekva kanto", "vol_up": "Pli volumo", "vol_down": "Malpli volumo", - "toggle_love": "Baskuli la stelon de nuna kanto", - "current_song": "" + "toggle_love": "Aldoni ĉi tiun kanton al plej ŝatataj", + "current_song": "Iri al Nuna Kanto" } + }, + "nowPlaying": { + "title": "Nun Ludanta", + "empty": "Nenio ludas", + "minutesAgo": "Antaŭ %{smart_count} minuto |||| Antaŭ %{smart_count} minutoj" } } \ No newline at end of file diff --git a/resources/i18n/es.json b/resources/i18n/es.json index 4c811b447..555c165d6 100644 --- a/resources/i18n/es.json +++ b/resources/i18n/es.json @@ -28,20 +28,30 @@ "channels": "Canales", "createdAt": "Creado el", "grouping": "Agrupación", - "mood": "", + "mood": "Estado de ánimo", "participants": "Participantes", "tags": "Etiquetas", "mappedTags": "Etiquetas asignadas", - "rawTags": "Etiquetas sin procesar" + "rawTags": "Etiquetas sin procesar", + "bitDepth": "Profundidad de bits", + "sampleRate": "Frecuencia de muestreo", + "albumGain": "Ganancia del álbum", + "trackGain": "Ganancia de pista", + "missing": "Faltante", + "libraryName": "Biblioteca", + "composer": "Compositor", + "disc": "Disco %{discNumber}" }, "actions": { "addToQueue": "Reproducir después", "playNow": "Reproducir ahora", - "addToPlaylist": "Agregar a la lista de reproducción", + "addToPlaylist": "Agregar a la playlist", "shuffleAll": "Todas aleatorias", "download": "Descarga", "playNext": "Siguiente", - "info": "Obtener información" + "info": "Obtener información", + "showInPlaylist": "Mostrar en la lista de reproducción", + "instantMix": "Mezcla instantánea" } }, "album": { @@ -69,8 +79,11 @@ "catalogNum": "Número de catálogo", "releaseType": "Tipo de lanzamiento", "grouping": "Agrupación", - "media": "", - "mood": "" + "media": "Medios", + "mood": "Estado de ánimo", + "date": "Fecha de grabación", + "missing": "Faltante", + "libraryName": "Biblioteca" }, "actions": { "playAll": "Reproducir", @@ -89,7 +102,7 @@ "recentlyPlayed": "Recientes", "mostPlayed": "Más reproducidos", "starred": "Favoritos", - "topRated": "Los mejores calificados" + "topRated": "Mejor calificados" } }, "artist": { @@ -102,22 +115,29 @@ "rating": "Calificación", "genre": "Género", "size": "Tamaño", - "role": "Rol" + "role": "Rol", + "missing": "Faltante" }, "roles": { - "albumartist": "Artista del álbum", - "artist": "Artista", - "composer": "Compositor", - "conductor": "Director de orquesta", - "lyricist": "Letrista", - "arranger": "Arreglista", - "producer": "Productor", - "director": "Director", - "engineer": "Ingeniero de sonido", - "mixer": "Mezclador", - "remixer": "Remixer", - "djmixer": "DJ Mixer", - "performer": "Intérprete" + "albumartist": "Artista del álbum |||| Artistas del álbum", + "artist": "Artista |||| Artistas", + "composer": "Compositor |||| Compositores", + "conductor": "Director de orquesta |||| Directores de orquesta", + "lyricist": "Letrista |||| Letristas", + "arranger": "Arreglista |||| Arreglistas", + "producer": "Productor |||| Productores", + "director": "Director |||| Directores", + "engineer": "Ingeniero de sonido |||| Ingenieros de sonido", + "mixer": "Mezclador |||| Mezcladores", + "remixer": "Remezclador |||| Remezcladores", + "djmixer": "DJ Mezclador |||| DJ Mezcladores", + "performer": "Intérprete |||| Intérpretes", + "maincredit": "Artista del álbum o Artista |||| Artistas del álbum o Artistas" + }, + "actions": { + "shuffle": "Aleatorio", + "radio": "Radio", + "topSongs": "Más destacadas" } }, "user": { @@ -134,10 +154,12 @@ "currentPassword": "Contraseña actual", "newPassword": "Nueva contraseña", "token": "Token", - "lastAccessAt": "Último acceso" + "lastAccessAt": "Último acceso", + "libraries": "Bibliotecas" }, "helperTexts": { - "name": "Los cambios a tu nombre se verán en el próximo inicio de sesión" + "name": "Los cambios a tu nombre se verán en el próximo inicio de sesión", + "libraries": "Selecciona bibliotecas específicas para este usuario o déjalo vacío para usar las bibliotecas por defecto" }, "notifications": { "created": "Usuario creado", @@ -146,7 +168,12 @@ }, "message": { "listenBrainzToken": "Escribe tu token de usuario de ListenBrainz", - "clickHereForToken": "Click aquí para obtener tu token" + "clickHereForToken": "Click aquí para obtener tu token", + "selectAllLibraries": "Seleccionar todas las bibliotecas", + "adminAutoLibraries": "Los usuarios administradores tienen acceso a todas las bibliotecas automáticamente" + }, + "validation": { + "librariesRequired": "Se debe seleccionar al menos una biblioteca para los usuarios que no sean administradores" } }, "player": { @@ -167,7 +194,7 @@ "fields": { "name": "Nombre", "targetFormat": "Formato de destino", - "defaultBitRate": "Tasa de bits default", + "defaultBitRate": "Tasa de bits por defecto", "command": "Comando" } }, @@ -190,11 +217,17 @@ "addNewPlaylist": "Creada \"%{name}\"", "export": "Exportar", "makePublic": "Hazla pública", - "makePrivate": "Hazla privada" + "makePrivate": "Hazla privada", + "saveQueue": "Guardar la fila de reproducción en una playlist", + "searchOrCreate": "Buscar listas de reproducción o escribe para crear una nueva…", + "pressEnterToCreate": "Pulsa Enter para crear una nueva lista de reproducción", + "removeFromSelection": "Quitar de la selección" }, "message": { - "duplicate_song": "Algunas de las canciones seleccionadas están presentes en la lista de reproducción", - "song_exist": "Se están agregando duplicados a la lista de reproducción. ¿Quieres agregar los duplicados o omitirlos?" + "duplicate_song": "Algunas de las canciones seleccionadas están presentes en la playlist", + "song_exist": "Se están agregando duplicados a la playlist. ¿Quieres agregar los duplicados o omitirlos?", + "noPlaylistsFound": "No se encontraron listas de reproducción", + "noPlaylists": "No hay listas de reproducción disponibles" } }, "radio": { @@ -211,9 +244,9 @@ } }, "share": { - "name": "Compartir", + "name": "Compartir |||| Compartidos", "fields": { - "username": "Nombre de usuario", + "username": "Compartido por", "url": "URL", "description": "Descripción", "contents": "Contenido", @@ -228,17 +261,153 @@ } }, "missing": { - "name": "Faltante", + "name": "Fichero faltante |||| Ficheros faltantes", "fields": { "path": "Ruta", "size": "Tamaño", - "updatedAt": "Actualizado el" + "updatedAt": "Actualizado el", + "libraryName": "Biblioteca" }, "actions": { - "remove": "Eliminar" + "remove": "Eliminar", + "remove_all": "Eliminar todo" }, "notifications": { "removed": "Eliminado" + }, + "empty": "No faltan archivos" + }, + "library": { + "name": "Biblioteca |||| Bibliotecas", + "fields": { + "name": "Nombre", + "path": "Ruta", + "remotePath": "Ruta remota", + "lastScanAt": "Último escaneo", + "songCount": "Canciones", + "albumCount": "Álbumes", + "artistCount": "Artistas", + "totalSongs": "Canciones", + "totalAlbums": "Álbumes", + "totalArtists": "Artistas", + "totalFolders": "Carpetas", + "totalFiles": "Archivos", + "totalMissingFiles": "Archivos faltantes", + "totalSize": "Tamaño total", + "totalDuration": "Duración", + "defaultNewUsers": "Por defecto para nuevos usuarios", + "createdAt": "Creado", + "updatedAt": "Actualizado" + }, + "sections": { + "basic": "Información básica", + "statistics": "Estadísticas" + }, + "actions": { + "scan": "Escanear biblioteca", + "manageUsers": "Gestionar el acceso de usarios", + "viewDetails": "Ver detalles", + "quickScan": "Escaneo rápido", + "fullScan": "Escaneo completo" + }, + "notifications": { + "created": "La biblioteca se creó correctamente", + "updated": "La biblioteca se actualizó correctamente", + "deleted": "La biblioteca se eliminó correctamente", + "scanStarted": "El escaneo de la biblioteca ha comenzado", + "scanCompleted": "El escaneo de la biblioteca se completó", + "quickScanStarted": "Escaneo rápido ha comenzado", + "fullScanStarted": "Escaneo completo ha comenzado", + "scanError": "Error al iniciar el escaneo. Revisa los registros" + }, + "validation": { + "nameRequired": "El nombre de la biblioteca es obligatorio", + "pathRequired": "La ruta de la biblioteca es obligatoria", + "pathNotDirectory": "La ruta de la biblioteca debe ser un directorio", + "pathNotFound": "Ruta de la biblioteca no encontrada", + "pathNotAccessible": "La ruta de la biblioteca no es accesible", + "pathInvalid": "Ruta de la biblioteca no válida" + }, + "messages": { + "deleteConfirm": "¿Estás seguro/a de que quieres eliminar esta biblioteca? Esto eliminará todos los datos asociados y el acceso de les usuaries.", + "scanInProgress": "Escaneo en curso...", + "noLibrariesAssigned": "No hay bibliotecas asignadas a este usuario" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Nombre", + "description": "Descripción", + "version": "Versión", + "author": "Autor", + "website": "Web", + "permissions": "Permisos", + "enabled": "Activado", + "status": "Estado", + "path": "Ruta", + "lastError": "Error", + "hasError": "Error", + "updatedAt": "Actualizado", + "createdAt": "Instalado", + "configKey": "Clave", + "configValue": "Valor", + "allUsers": "Permitir todos los usuarios", + "selectedUsers": "Usuarios seleccionados", + "allLibraries": "Permitir todas las bibliotecas", + "selectedLibraries": "Bibliotecas seleccionadas", + "allowWriteAccess": "Permitir acceso de escritura" + }, + "sections": { + "status": "Estado", + "info": "Información del Plugin", + "configuration": "Configuración", + "manifest": "Manifiesto", + "usersPermission": "Permiso del usuario", + "libraryPermission": "Permiso de la biblioteca" + }, + "status": { + "enabled": "Activado", + "disabled": "Deshabilitado" + }, + "actions": { + "enable": "Activar", + "disable": "Desactivar", + "disabledDueToError": "Corrige el error antes de activar", + "disabledUsersRequired": "Selecciona usuarios antes de activar", + "disabledLibrariesRequired": "Selecciona bibliotecas antes de activar", + "addConfig": "Añadir configuración", + "rescan": "Reescanear" + }, + "notifications": { + "enabled": "Plugin activado", + "disabled": "Plugin deshabilitado", + "updated": "Plugin actualizado", + "error": "Error al actualizar el plugin" + }, + "validation": { + "invalidJson": "La configuración debe ser un JSON válido" + }, + "messages": { + "configHelp": "Configura el plugin utilizando pares de clave-valor. Déjalo en blanco si el plugin no requiere configuración.", + "clickPermissions": "Haz clic en un permiso para ver los detalles", + "noConfig": "No hay configuración establecida", + "allUsersHelp": "Cuando se active, el plugin tendrá acceso a todos los usuarios, incluidos los que se creen en el futuro.", + "noUsers": "Ningún usuario seleccionado", + "permissionReason": "Razón", + "usersRequired": "Este plugin requiere acceso a la información de los usuarios. Selecciona a qué usuarios puede acceder el plugin, o activa 'Permitir todos los usuarios'.", + "allLibrariesHelp": "Cuando se active, el plugin tendrá acceso a todas las bibliotecas, incluidas las que se creen en el futuro.", + "noLibraries": "Ninguna biblioteca seleccionada", + "librariesRequired": "Este plugin requiere acceso a la información de las bibliotecas. Selecciona a qué bibliotecas puede acceder el plugin, o activa 'Permitir todas las bibliotecas'.", + "requiredHosts": "Hosts requeridos", + "configValidationError": "La validación de la configuración falló:", + "schemaRenderError": "No se pudo renderizar el formulario de configuración. Es posible que el esquema del complemento no sea válido.", + "allowWriteAccessHelp": "Cuando está activado, el plugin puede modificar archivos en los directorios de la biblioteca. Por defecto, los plugins tienen acceso de solo lectura." + }, + "placeholders": { + "configKey": "clave", + "configValue": "valor" } } }, @@ -406,9 +575,9 @@ "musicbrainz": "Ver en MusicBrainz" }, "lastfmLink": "Leer más...", - "listenBrainzLinkSuccess": "Se ha conectado correctamente a ListenBrainz y se activo el scrobbling como el usuario: %{user}", + "listenBrainzLinkSuccess": "Se ha conectado correctamente a ListenBrainz y se activó el scrobbling como el usuario: %{user}", "listenBrainzLinkFailure": "No se pudo conectar con ListenBrainz: %{error}", - "listenBrainzUnlinkSuccess": "Se desconecto ListenBrainz y se desactivo el scrobbling", + "listenBrainzUnlinkSuccess": "Se desconectó ListenBrainz y se desactivó el scrobbling", "listenBrainzUnlinkFailure": "No se pudo desconectar ListenBrainz", "downloadOriginalFormat": "Descargar formato original", "shareOriginalFormat": "Compartir formato original", @@ -418,8 +587,19 @@ "shareFailure": "Error al copiar la URL %{url} al portapapeles", "downloadDialogTitle": "Descargar %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Copiar al portapapeles: Ctrl+C, Intro", - "remove_missing_title": "Eliminar elemento faltante", - "remove_missing_content": "" + "remove_missing_title": "Eliminar archivos faltantes", + "remove_missing_content": "¿Realmente desea eliminar los archivos faltantes seleccionados de la base de datos? Esto eliminará permanentemente cualquier referencia a ellos, incluidas sus reproducciones y valoraciones.", + "remove_all_missing_title": "Eliminar todos los archivos faltantes", + "remove_all_missing_content": "¿Realmente desea eliminar todos los archivos faltantes de la base de datos? Esto eliminará permanentemente cualquier referencia a ellos, incluidas sus reproducciones y valoraciones.", + "noSimilarSongsFound": "No se encontraron canciones similares", + "noTopSongsFound": "No se encontraron canciones destacadas", + "startingInstantMix": "Cargando la mezcla instantánea...", + "uploadCover": "Subir portada", + "removeCover": "Eliminar portada", + "coverUploaded": "Portada actualizada", + "coverRemoved": "Portada eliminada", + "coverUploadError": "Error al subir la portada", + "coverRemoveError": "Error al eliminar la portada" }, "menu": { "library": "Biblioteca", @@ -438,9 +618,9 @@ "replaygain": "Modo de ReplayGain", "preAmp": "ReplayGain PreAmp (dB)", "gain": { - "none": "Ninguno", - "album": "Álbum", - "track": "Pista" + "none": "Desactivado", + "album": "Ganancia del álbum", + "track": "Ganancia de pista" }, "lastfmNotConfigured": "La clave API de Last.fm no está configurada" } @@ -448,10 +628,16 @@ "albumList": "Álbumes", "about": "Acerca de", "playlists": "Playlists", - "sharedPlaylists": "Playlists Compartidas" + "sharedPlaylists": "Playlists Compartidas", + "librarySelector": { + "allLibraries": "Todas las bibliotecas (%{count})", + "multipleLibraries": "%{selected} de %{total} bibliotecas", + "selectLibraries": "Seleccionar bibliotecas", + "none": "Ninguno" + } }, "player": { - "playListsText": "Lista de reproducción", + "playListsText": "Fila de reproducción", "openText": "Abrir", "closeText": "Cerrar", "notContentText": "Sin música", @@ -485,6 +671,22 @@ "disabled": "Deshabilitado", "waiting": "Esperando" } + }, + "tabs": { + "about": "Acerca de", + "config": "Configuración" + }, + "config": { + "configName": "Nombre de la configuración", + "environmentVariable": "Variables de entorno", + "currentValue": "Valor actual", + "configurationFile": "Archivo de configuración", + "exportToml": "Exportar configuración (TOML)", + "exportSuccess": "Configuración exportada al portapapeles en formato TOML", + "exportFailed": "Error al copiar la configuración", + "devFlagsHeader": "Indicadores de desarrollo (sujetos a cambios o eliminación)", + "devFlagsComment": "Estas son configuraciones experimentales y pueden eliminarse en versiones futuras", + "downloadToml": "Descargar la configuración (TOML)" } }, "activity": { @@ -493,7 +695,11 @@ "quickScan": "Escaneo rápido", "fullScan": "Escaneo completo", "serverUptime": "Uptime del servidor", - "serverDown": "OFFLINE" + "serverDown": "DESCONECTADO", + "scanType": "Tipo", + "status": "Error de escaneo", + "elapsedTime": "Tiempo transcurrido", + "selectiveScan": "Selectivo" }, "help": { "title": "Atajos de teclado de Navidrome", @@ -508,5 +714,10 @@ "toggle_love": "Marca esta canción como favorita", "current_song": "Canción actual" } + }, + "nowPlaying": { + "title": "En reproducción", + "empty": "Nada en reproducción", + "minutesAgo": "Hace %{smart_count} minuto |||| Hace %{smart_count} minutos" } -} +} \ No newline at end of file diff --git a/resources/i18n/et.json b/resources/i18n/et.json new file mode 100644 index 000000000..b0131f4ea --- /dev/null +++ b/resources/i18n/et.json @@ -0,0 +1,723 @@ +{ + "languageName": "eesti keel", + "resources": { + "song": { + "name": "Laul |||| Laulud", + "fields": { + "albumArtist": "Albumi esitaja", + "duration": "Kestus", + "trackNumber": "Nr", + "playCount": "Esituskordi", + "title": "Pealkiri", + "artist": "Esitaja", + "album": "Album", + "path": "Faili asukoht", + "genre": "Žanr", + "compilation": "Kogumik", + "year": "Aasta", + "size": "Faili suurus", + "updatedAt": "Uuendatud", + "bitRate": "Bitikiirus", + "discSubtitle": "Plaadi alapealkiri", + "starred": "Märgi lemmikuks", + "comment": "Kommentaar", + "rating": "Hinnang", + "quality": "Kvaliteet", + "bpm": "BPM", + "playDate": "Viimati esitatud", + "channels": "Kanaleid", + "createdAt": "Lisamise kuupäev", + "grouping": "Rühmitamine", + "mood": "Meeleolu", + "participants": "Täiendavad osalejad", + "tags": "Täiendavad sildid", + "mappedTags": "Tuvastatud sildid", + "rawTags": "Sildid töötlemata vaates", + "bitDepth": "Bitisügavus", + "sampleRate": "Diskreetmisagedus", + "missing": "Puudub", + "libraryName": "Kogumik", + "composer": "Helilooja", + "disc": "%{discNumber}. plaat", + "albumGain": "Albumikohane esitusvaljuse tundlikkus", + "trackGain": "Rajakohane esitusvaljuse tundlikkus" + }, + "actions": { + "addToQueue": "Esita hiljem", + "playNow": "Esita kohe", + "addToPlaylist": "Lisa esitusloendisse", + "shuffleAll": "Sega kõik", + "download": "Laadi alla", + "playNext": "Esita järgmisena", + "info": "Loo teave", + "showInPlaylist": "Näita esitusloendis", + "instantMix": "Kohene miks" + } + }, + "album": { + "name": "Album |||| Albumid", + "fields": { + "albumArtist": "Albumi esitaja", + "artist": "Esitaja", + "duration": "Kestus", + "songCount": "laulu", + "playCount": "Esituskordi", + "name": "Nimi", + "genre": "Žanr", + "compilation": "Kogumik", + "year": "Aasta", + "updatedAt": "Uuendatud", + "comment": "Kommentaar", + "rating": "Hinnangud", + "createdAt": "Lisamise kuupäev", + "size": "Suurus", + "originalDate": "Originaal", + "releaseDate": "Avaldatud", + "releases": "Väljalase ||| Väljalasked", + "released": "Avaldatud", + "recordLabel": "Plaadifirma", + "catalogNum": "Tunnus kataloogides", + "releaseType": "Tüüp", + "grouping": "Grupeerimine", + "media": "Meedium", + "mood": "Meeleolu", + "date": "Salvestuskuupäev", + "missing": "Puudu", + "libraryName": "Kogumik" + }, + "actions": { + "playAll": "Esita", + "playNext": "Esita järgmisena", + "addToQueue": "Esita hiljem", + "shuffle": "Sega lood", + "addToPlaylist": "Lisa esitusloendisse", + "download": "Laadi alla", + "info": "Albumi teave", + "share": "Jaga" + }, + "lists": { + "all": "Kõik", + "random": "Juhuslik", + "recentlyAdded": "Hiljuti lisatud", + "recentlyPlayed": "Hiljuti esitatud", + "mostPlayed": "Enimesitatud", + "starred": "Lemmikud", + "topRated": "Kõrgeima hinnanguga" + } + }, + "artist": { + "name": "Esitaja |||| Esitajad", + "fields": { + "name": "Nimi", + "albumCount": "Albumeid", + "songCount": "Lugusid", + "playCount": "Esituskordi", + "rating": "Hinnang", + "genre": "Žanr", + "size": "Suurus", + "role": "Roll", + "missing": "Puudub" + }, + "roles": { + "albumartist": "Albumi esitaja ||| Albumi esitajad", + "artist": "Esitaja ||| Esitajad", + "composer": "Helilooja ||| Heliloojad", + "conductor": "Dirigent ||| Dirigendid", + "lyricist": "Laulusõnade autor ||| Laulusõnade autorid", + "arranger": "Seade autor ||| Seade autorid", + "producer": "Produtsent ||| Produtsendid", + "director": "Lavastaja ||| Lavastajad", + "engineer": "Helirežissöör ||| Helirežissöörid", + "mixer": "Miksija ||| Miksijad", + "remixer": "Remiksija ||| Remiksijad", + "djmixer": "DJ-versiooni remiksija ||| DJ-versiooni remiksijad", + "performer": "Esineja ||| Esinejad", + "maincredit": "Albumi esitaja või Esitaja ||| Albumi esitajad või Esitajad" + }, + "actions": { + "shuffle": "Sega", + "radio": "Raadio", + "topSongs": "Populaarsed lood" + } + }, + "user": { + "name": "Kasutaja |||| Kasutajad", + "fields": { + "userName": "Kasutajanimi", + "isAdmin": "On peakasutaja", + "lastLoginAt": "Viimane sisselogimine", + "updatedAt": "Uuendatud", + "name": "Nimi", + "password": "Salasõna", + "createdAt": "Loodud", + "changePassword": "Kas soovid salasõna muuta?", + "currentPassword": "Senine salasõna", + "newPassword": "Uus salasõna", + "token": "Tunnusluba", + "lastAccessAt": "Viimati avatud", + "libraries": "Kogumikud" + }, + "helperTexts": { + "name": "Sinu nime muudatused on näha järgmisel sisselogimisel", + "libraries": "Vali selle kasutaja jaoks konkreetsed kogumikud või jäta vaikimisi väärtuse kasutamiseks tühjaks" + }, + "notifications": { + "created": "Kasutaja on lisatud", + "updated": "Kasutaja andmed on uuendatud", + "deleted": "Kasutaja on kustutatud" + }, + "message": { + "listenBrainzToken": "Sisesta oma ListenBrainzi tunnusluba.", + "clickHereForToken": "Tunnusloa saamiseks klõpsi siin", + "selectAllLibraries": "Vali kõik kogumikud", + "adminAutoLibraries": "Peakasutajatel on automaatselt ligipääs kõikidele kogumikele" + }, + "validation": { + "librariesRequired": "Vähemalt üks kogumik peab olema valitud muude, kui peakasutajate jaoks" + } + }, + "player": { + "name": "Meediaesitaja |||| Meediaesitajad", + "fields": { + "name": "Nimi", + "transcodingId": "Teisendamine", + "maxBitRate": "Maksimaalne bitikiirus", + "client": "Klient", + "userName": "Kasutajanimi", + "lastSeen": "Viimati nähtud", + "reportRealPath": "Teata tegelikust asukohast", + "scrobbleEnabled": "Saada kraasimisandmed välistesse teenustesse" + } + }, + "transcoding": { + "name": "Teisendamine |||| Teisendamised", + "fields": { + "name": "Nimi", + "targetFormat": "Sihtvorming", + "defaultBitRate": "Vaikimisi bitikiirus", + "command": "Käsk" + } + }, + "playlist": { + "name": "Esitusloend ||| Esitusloendid", + "fields": { + "name": "Nimi", + "duration": "Kestus", + "ownerName": "Omanik", + "public": "Avalik", + "updatedAt": "Muudetud", + "createdAt": "Loodud", + "songCount": "Lood", + "comment": "Kommentaar", + "sync": "Automaatne import", + "path": "Impordi siit" + }, + "actions": { + "selectPlaylist": "Valo esitusloend:", + "addNewPlaylist": "Loo „%{name}\"“", + "export": "Ekspordi", + "makePublic": "Muuda avalikuks", + "makePrivate": "Muuda privaatseks", + "saveQueue": "Salvesta esitusjärjekord esitusloendina", + "searchOrCreate": "Otsi esitusloendeid või uue loomiseks sisesta nimi...", + "pressEnterToCreate": "Uue esitusloendi lisamiseks vajuta sisestusklahvi", + "removeFromSelection": "Eemalda valikust" + }, + "message": { + "duplicate_song": "Lisa topeltlood", + "song_exist": "Tundub, et oled esitusloendisse lisamas topeltkirjeid. Kas tahad nii jätkata või soovid topeltkirjed vahele jätta?", + "noPlaylistsFound": "Esitusloendeid ei leidu", + "noPlaylists": "Esitusloendeid pole saadaval" + } + }, + "radio": { + "name": "Raadio ||| Raadiod", + "fields": { + "name": "Nimi", + "streamUrl": "Voogedastuse võrguaadress", + "homePageUrl": "Avalehe võrguaadress", + "updatedAt": "Uuendatud", + "createdAt": "Lisatud" + }, + "actions": { + "playNow": "Esita kohe" + } + }, + "share": { + "name": "Jagamine ||| Jagamised", + "fields": { + "username": "Seda jagas", + "url": "Võrguaadress", + "description": "Kirjeldus", + "contents": "Sisu", + "expiresAt": "Aegub", + "lastVisitedAt": "Viimati vaadatud", + "visitCount": "Külastusi", + "format": "Vorming", + "maxBitRate": "Maksimaalne bitikiirus", + "updatedAt": "Muudetud", + "createdAt": "Lisatud", + "downloadable": "Kas lubad allalaadimised?" + } + }, + "missing": { + "name": "Puuduv fail ||| Puuduvad failid", + "fields": { + "path": "Asukoht", + "size": "Suurus", + "updatedAt": "Kadumise aeg", + "libraryName": "Kogumik" + }, + "actions": { + "remove": "Eemalda", + "remove_all": "Eemalda kõik" + }, + "notifications": { + "removed": "Puuduv(ad) fail(id) on eemaldatud" + }, + "empty": "Puuduvaid faile pole" + }, + "library": { + "name": "Kogumik ||| Kogumikud", + "fields": { + "name": "Nimi", + "path": "Asukoht", + "remotePath": "Asukoht kaugseadmes", + "lastScanAt": "Viimane skaneerimine", + "songCount": "Lood", + "albumCount": "Albumid", + "artistCount": "Esitajad", + "totalSongs": "Lood", + "totalAlbums": "Albumid", + "totalArtists": "Esitajad", + "totalFolders": "Kaustad", + "totalFiles": "Failid", + "totalMissingFiles": "Puuduvad failid", + "totalSize": "Kogumaht", + "totalDuration": "Kestus", + "defaultNewUsers": "Vaikimisi väärtus uutele kasutajatele", + "createdAt": "Lisatud", + "updatedAt": "Muudetud" + }, + "sections": { + "basic": "Põhiteave", + "statistics": "Statistika" + }, + "actions": { + "scan": "Skaneeri kogumikku", + "manageUsers": "Halda kasutajate õigusi", + "viewDetails": "Vaata üksikasju", + "quickScan": "Kiirskaneerimine", + "fullScan": "Täismahuline skaneerimine" + }, + "notifications": { + "created": "Kogumiku loomine õnnestus", + "updated": "Kogumiku uuendamine õnnestus", + "deleted": "Kogumiku kustutamine õnnestus", + "scanStarted": "Kogumiku skaneerimine algas", + "scanCompleted": "Kogumiku skaneerimine lõppes", + "quickScanStarted": "Kiirskaneerimine algas", + "fullScanStarted": "Täismahuline skaneerimine algas", + "scanError": "Viga skaneerimise käivitamisel. Lisateavet leiad logidest" + }, + "validation": { + "nameRequired": "Pead sisestama kogumiku nime", + "pathRequired": "Pead sisestama kogumiku asukoha", + "pathNotDirectory": "Kogumiku asukoht peab olema kaust", + "pathNotFound": "Kogumiku asukoha kausta ei leidu", + "pathNotAccessible": "Kogumiku asukoha kaust pole ligipääsetav", + "pathInvalid": "Vigane kogumiku asukoha kaust" + }, + "messages": { + "deleteConfirm": "Kas oled kindel, et soovid selle kogumiku kustutada? Samaga eemaldad ka kõik seotud andmed ja kasutajate ligipääsu.", + "scanInProgress": "Skaneerimine on pooleli...", + "noLibrariesAssigned": "Selle kasutajaga pole veel ühtegi kogumikku seotud" + } + }, + "plugin": { + "name": "Lisamoodul |||| Lisamoodulid", + "fields": { + "id": "Tunnus", + "name": "Nimi", + "description": "Kirjeldus", + "version": "Versioon", + "author": "Autor", + "website": "Veebisait", + "permissions": "Õigused", + "enabled": "Kasutusel", + "status": "Olek", + "path": "Asukoht", + "lastError": "Viga", + "hasError": "Viga", + "updatedAt": "Uuendatud", + "createdAt": "Paigaldatud", + "configKey": "Võti", + "configValue": "Väärtus", + "allUsers": "Luba kõiki kasutajaid", + "selectedUsers": "Valitud kasutajad", + "allLibraries": "Luba kõik kogumikud", + "selectedLibraries": "Valitud kogumikud", + "allowWriteAccess": "Luba kirjutusõigused" + }, + "sections": { + "status": "Olek", + "info": "Lisamooduli teave", + "configuration": "Seadistus", + "manifest": "Manifest", + "usersPermission": "Kasutajate õigused", + "libraryPermission": "Kogumike õigused" + }, + "status": { + "enabled": "Kasutusel", + "disabled": "Pole kasutusel" + }, + "actions": { + "enable": "Võta kasutusele", + "disable": "Eemalda kasutuselt", + "disabledDueToError": "Enne kasutuselevõtmist paranda viga", + "disabledUsersRequired": "Enne kasutuselevõtmist vali kasutajad", + "disabledLibrariesRequired": "Enne kasutuselevõtmist vali kogumikud", + "addConfig": "Lisa seadistus", + "rescan": "Skaneeri uuesti" + }, + "notifications": { + "enabled": "Lisamoodul on kasutusel", + "disabled": "Lisamoodul pole kasutusel", + "updated": "Lisamoodul on uuendatud", + "error": "Viga lisamooduli uuendamisel" + }, + "validation": { + "invalidJson": "Seadistus peab olema koostatud korrektses JSON-vormingus" + }, + "messages": { + "configHelp": "Seadista lisamoodulit võti-väärtus paaride abil. Kui lisamoodul seadistamist ei vaja, siis jäta tühjaks.", + "clickPermissions": "Üksikasjade vaatamiseks klõpsa õigust", + "noConfig": "Ühtegi seadistust pole määratud", + "allUsersHelp": "Kasutuselevõetuna on sellel lisamoodulil ligipääs kõikidele kasutajatele, sealhulgas tulevikus loodavatele.", + "noUsers": "Ühtegi kasutajat pole valitud", + "permissionReason": "Põhjus", + "usersRequired": "See lisamoodul vajab ligipääsu kasutajate teabele. Vali kasutajad, millele ta ligi peaks saama või vali „Kõik kasutajad“.", + "allLibrariesHelp": "Kasutuselevõetuna on sellel lisamoodulil ligipääs kõikidele kogumikele, sealhulgas tulevikus loodavatele.", + "noLibraries": "Ühtegi kogumikku pole valitud", + "librariesRequired": "See lisamoodul vajab ligipääsu kogumiku teabele. Vali kogumikud, millele ta ligi peaks saama või vali „Kõik kogumikud“.", + "requiredHosts": "Nõutavad hostid", + "configValidationError": "Seadistuse õigsuse kontrollimine ei õnnestunud:", + "schemaRenderError": "Seadistuste vormi lugemine ja töötlemine ei õnnestunud. Lisamooduli ülesehitus/skeem võib olla vigane.", + "allowWriteAccessHelp": "Kui valik on kasutusel, siis lisamoodul võib muuta vaid faile kogumike kaustades. Vaikimisi on lisamoodulitel vaid lugemisõigus." + }, + "placeholders": { + "configKey": "võti", + "configValue": "väärtus" + } + } + }, + "ra": { + "auth": { + "welcome1": "Aitäh, et paigaldasid Navidrome'i!", + "welcome2": "Alustamiseks lisa peakasutaja", + "confirmPassword": "Korda salasõna", + "buttonCreateAdmin": "Lisa peakasutaja", + "auth_check_error": "Jätkamiseks palun logi sisse", + "user_menu": "Profiil", + "username": "Kasutajanimi", + "password": "Salasõna", + "sign_in": "Logi sisse", + "sign_in_error": "Tuvastamine ei toiminud, palun proovi uuesti", + "logout": "Logi välja", + "insightsCollectionNote": "Navidrome kogub anonüümset kasutustusstatistikat, mille alusel on võimalik projekti paremaks muuta. Klõpsides [siin], saad lugeda lisateavet ning soovi korral sellest kogumisest loobuda" + }, + "validation": { + "invalidChars": "Palun kasuta ainult tähti ja numbreid", + "passwordDoesNotMatch": "Salasõnad ei kattu", + "required": "Nõutav", + "minLength": "Pikkus peab olema vähemalt %{min} tähemärki", + "maxLength": "Pikkus ei tohi olla üle %{max} tähemärgi", + "minValue": "Väärtus peab olema vähemalt %{min}", + "maxValue": "Väärtus ei tohi olla enam, kui %{max}", + "number": "Sisend peab olema number", + "email": "Sisend peab korrektne e-posti aadress", + "oneOf": "Väärtus peab olema üks järgnevaist: %{options}", + "regex": "Väärtus peab vastama kindlale vormingule (regulaaravaldis): %{pattern}", + "unique": "Sisend peab olema unikaalne", + "url": "Sisend peab olema korrektne võrguaadress" + }, + "action": { + "add_filter": "Lisa filter", + "add": "Lisa", + "back": "Mine tagasi", + "bulk_actions": "1 objekt on valitud |||| %{smart_count} objekti on valitud", + "cancel": "Katkesta", + "clear_input_value": "Eemalda väärtus", + "clone": "Klooni", + "confirm": "Kinnita", + "create": "Loo", + "delete": "Kustuta", + "edit": "Muuda", + "export": "Ekspordi", + "list": "Loend", + "refresh": "Uuenda andmed", + "remove_filter": "Eemalda see filter", + "remove": "Eemalda", + "save": "Salvesta", + "search": "Otsi", + "show": "Näita", + "sort": "Järjesta", + "undo": "Võta tegevus tagasi", + "expand": "Laienda", + "close": "Sulge", + "open_menu": "Ava menüü", + "close_menu": "Sulge menüü", + "unselect": "Eemalda valik", + "skip": "Jäta vahele", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Jaga", + "download": "Laadi alla" + }, + "boolean": { + "true": "Jah", + "false": "Ei" + }, + "page": { + "create": "Loo %{name}", + "dashboard": "Töölaud", + "edit": "%{name} #%{id}", + "error": "Midagi läks valesti", + "list": "%{name}", + "loading": "Laadin", + "not_found": "Ei leidu", + "show": "%{name} #%{id}", + "empty": "Nimi on veel puudu - %{name}.", + "invite": "Kas sa sooviksid ühe sellise lisada?" + }, + "input": { + "file": { + "upload_several": "Lohista üleslaadimiseks mõned failid või vali üks failivalijast.", + "upload_single": "Lohista üleslaadimiseks fail või vali ta failivalijast." + }, + "image": { + "upload_several": "Lohista üleslaadimiseks mõned pildid või vali üks failivalijast.", + "upload_single": "Lohista üleslaadimiseks pilt või vali ta failivalijast." + }, + "references": { + "all_missing": "Viitenumbrite andmeid ei leidu.", + "many_missing": "Vähemalt üks seotud viide ei tundu enam olema saadaval.", + "single_missing": "Seotud viide ei tundu enam olema saadaval." + }, + "password": { + "toggle_visible": "Peida salasõna", + "toggle_hidden": "Näita salasõna" + } + }, + "message": { + "about": "Teave", + "are_you_sure": "Kas oled kindel?", + "bulk_delete_content": "Kas sa oled kindel, et soovid kustutada selle objekti - %{name}? |||| Kas sa oled kindel, et soovid kustutada need %{smart_count} objekti?", + "bulk_delete_title": "Kustuta %{name} |||| Kustuta %{name} - %{smart_count} kirjet", + "delete_content": "Kas oled kindel, et soovid selle objekti kustutada?", + "delete_title": "Kustuta %{name} #%{id}", + "details": "Üksikasjad", + "error": "Tekkis klientrakenduse viga ja päringut polnud võimalik lõpetada.", + "invalid_form": "Vormi andmed pole õiged. Palun kontrolli sisestusi", + "loading": "Leht on just laadimisel, palun oota hetke", + "no": "Ei", + "not_found": "Sa kas sisestasid vigase võrguaadressi või klõpsisid vigast linki.", + "yes": "Jah", + "unsaved_changes": "Mõned sinu muudatused pole salvestatud. Kas sa soovid neist loobuda?" + }, + "navigation": { + "no_results": "Tulemusi ei leidu", + "no_more_results": "Lehe number %{page} on väljaspool etteantud piire. Proovi eelmist lehte.", + "page_out_of_boundaries": "Lehe number %{page} on väljaspool etteantud piire", + "page_out_from_end": "Viimasest lehest ei saa edasi minna", + "page_out_from_begin": "Esimese lehe ette ei saa minna", + "page_range_info": "%{offsetBegin}-%{offsetEnd} - kokku %{total}", + "page_rows_per_page": "Kirjeid lehel:", + "next": "Edasi", + "prev": "Tagasi", + "skip_nav": "Mine sisu juurde" + }, + "notification": { + "updated": "Objekt on uuendatud |||| %{smart_count} objekti on uuendatud", + "created": "Objekt on loodud", + "deleted": "Objekt on kustutatud |||| %{smart_count} objekti on kustutatud", + "bad_item": "Vigane objekt", + "item_doesnt_exist": "Objekti pole olemas", + "http_error": "Viga suhtlemisel serveriga", + "data_provider_error": "Andmeteenusepakkuja viga. Lisateavet leiad brauseri konsoolist.", + "i18n_error": "Vastava keele tõlget ei saa laadida", + "canceled": "Tegevus on tühistatud", + "logged_out": "Sinu sessioon on lõppenud, palun ühenda uuesti.", + "new_version": "Uus versioon on saadaval! Palun laadi see vaade uuesti." + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Kuvatavad veerud", + "layout": "Paigutus", + "grid": "Ruudustik", + "table": "Tabel" + } + }, + "message": { + "note": "MÄRGE", + "transcodingDisabled": "Teisendusseadistuste muutmine läbi veebiliidese ei ole turvariskide tõttu saadaval. Kui soovid muuta või lisada teisendamisega seotud seadistusi, taaskäivita server %{config} valikuga.", + "transcodingEnabled": "Navidrome käivitati %{config} valikuga, mis lubab läbi veebiliidese teisendusseadistuste käivitada süsteemikäsklusi. Turvakaalutlustel on soovitatav kasutada seda valikut ainult teisendusvalikute muutmiseks.", + "songsAddedToPlaylist": "Lisasin ühe loo esitusloendisse |||| Lisasin %{smart_count} lugu esitusloendisse", + "noPlaylistsAvailable": "Pole saadaval", + "delete_user_title": "Kustuta kasutaja „%{name}“", + "delete_user_content": "Kas oled kindel, et soovid selle kasutaja ja kõik tema andmed (sh esitusloendid ja eelistused) kustutada?", + "notifications_blocked": "Sa oled selle saidi teavitused veebibrauseri seadistusest keelanud", + "notifications_not_available": "See veebibrauser kas ei toeta töölauateavitusi või sa ei kasuta Navidrome'i üle https-protokolli", + "lastfmLinkSuccess": "Last.fm-i seos on lisatud ja kraasimine on lülitatud sisse", + "lastfmLinkFailure": "Last.fm-i seose lisamine ei õnnestunud", + "lastfmUnlinkSuccess": "Last.fm-i seos on eemaldatud ja kraasimine on lülitatud välja", + "lastfmUnlinkFailure": "Last.fm-i seose eemaldamine ei õnnestunud", + "openIn": { + "lastfm": "Ava Last.fm-is", + "musicbrainz": "Ava MusicBrainzis" + }, + "lastfmLink": "Lisateave...", + "listenBrainzLinkSuccess": "ListenBrainzi seos on lisatud ja kraasimine on lülitatud sisse kasutajana: %{user}", + "listenBrainzLinkFailure": "ListenBrainzi seose lisamine ei õnnestunud: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainzi seos on eemaldatud ja kraasimine on lülitatud välja", + "listenBrainzUnlinkFailure": "ListenBrainzi seose eemaldamine ei õnnestunud", + "downloadOriginalFormat": "Laadi alla algses vormingus", + "shareOriginalFormat": "Jaga algses vormingus", + "shareDialogTitle": "Jaga - %{resource} „%{name}“", + "shareBatchDialogTitle": "Jaga - %{resource} |||| Jaga %{smart_count} kirjet - %{resource}", + "shareSuccess": "Võrguaadress on kopeeritud lõikelauale: %{url}", + "shareFailure": "Viga %{url} võrguaadressi kopeerimisel lõikelauale", + "downloadDialogTitle": "Laadi alla - %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Kopeeri lõikelauale: Ctrl+C, sisestusklahv", + "remove_missing_title": "Eemalda puuduvad failid", + "remove_missing_content": "Kas sa oled kindel, et soovid valitud puuduvate failide andmed andmebaasist eemaldada? Sellega kaovad kõik viited neile, sealhulgas esituskordade ja hinnangute märked.", + "remove_all_missing_title": "Eemalda kõik puuduvad failid", + "remove_all_missing_content": "Kas sa oled kindel, et soovid kõik puuduvate failide andmed andmebaasist eemaldada? Sellega kaovad kõik viited neile, sealhulgas esituskordade ja hinnangute märked.", + "noSimilarSongsFound": "Sarnaseid lugusid ei leidu", + "noTopSongsFound": "Populaarsemaid lugusid ei leidu", + "startingInstantMix": "Laadin kohest miksi...", + "uploadCover": "Laadi kaanepilt üles", + "removeCover": "Eemalda kaanepilt", + "coverUploaded": "Kaanepilt on uuendatud", + "coverRemoved": "Kaanepilt on eemaldatud", + "coverUploadError": "Viga kaanepildi üleslaadimisel", + "coverRemoveError": "Viga kaanepildi eemaldamisel" + }, + "menu": { + "library": "Kogumik", + "settings": "Seadistused", + "version": "Versioon", + "theme": "Kujundus", + "personal": { + "name": "Isiklik", + "options": { + "theme": "Kujundus", + "language": "Keel", + "defaultView": "Vaikimisi vaade", + "desktop_notifications": "Teavitused töölaual", + "lastfmScrobbling": "Kraasi Last.fm-i teenusesse", + "listenBrainzScrobbling": "Kraasi ListenBrainzi teenusesse", + "replaygain": "Esitusvaljuse tundlikkuse režiim", + "preAmp": "Esitusvaljuse tundlikkuse eelvõimendus (dB)", + "gain": { + "none": "Pole kasutusel", + "album": "Kasuta albumikohast esitusvaljuse tundlikkust", + "track": "Kasuta lookohast esitusvaljuse tundlikkust" + }, + "lastfmNotConfigured": "Last.fm-i API-võti pole seadistatud" + } + }, + "albumList": "Albumid", + "about": "Rakenduse teave", + "playlists": "Esitusloendid", + "sharedPlaylists": "Jagatud esitusloendid", + "librarySelector": { + "allLibraries": "Kõik kogumikud (%{count})", + "multipleLibraries": "%{selected} / %{total} kogumikest", + "selectLibraries": "Vali kogumikud", + "none": "Puudub" + } + }, + "player": { + "playListsText": "Esitusjärjekord", + "openText": "Ava", + "closeText": "Sulge", + "notContentText": "Muusikat pole", + "clickToPlayText": "Klõpsa esitamiseks", + "clickToPauseText": "Klõpsa peatamiseks", + "nextTrackText": "Järgmine lugu", + "previousTrackText": "Eelmine lugu", + "reloadText": "Laadi uuesti", + "volumeText": "Helivaljus", + "toggleLyricText": "Näita/peida laulusõnad", + "toggleMiniModeText": "Minimeeri", + "destroyText": "Hävita", + "downloadText": "Laadi alla", + "removeAudioListsText": "Kustuta heliloendid", + "clickToDeleteText": "„%{name}“ kustutamiseks klõpsa", + "emptyLyricText": "Laulusõnu pole", + "playModeText": { + "order": "Oma järjekorras", + "orderLoop": "Korda", + "singleLoop": "Korda üks kord", + "shufflePlay": "Sega lood" + } + }, + "about": { + "links": { + "homepage": "Avaleht", + "source": "Lähtekood", + "featureRequests": "Arendusettepanekud", + "lastInsightsCollection": "Viimati kogutud statistika", + "insights": { + "disabled": "Pole kasutusel", + "waiting": "Ootel" + } + }, + "tabs": { + "about": "Teave", + "config": "Seadistus" + }, + "config": { + "configName": "Seadistuse nimi", + "environmentVariable": "Keskkonnamuutuja", + "currentValue": "Praegune väärtus", + "configurationFile": "Seadistusfail", + "exportToml": "Ekspordi seadistused (TOML-failina)", + "exportSuccess": "Seadistused on eksporditud lõikelauale TOML-failina", + "exportFailed": "Seadistuse kopeerimine ei õnnestunud", + "devFlagsHeader": "Arendusparameetrid (võivad muutuda või sootuks kaduda)", + "devFlagsComment": "Need on katselised seadistused, mis võivad tulevastest versioonidest kaduda", + "downloadToml": "Laadi seadistused alla (TOML-failina)" + } + }, + "activity": { + "title": "Tegevus", + "totalScanned": "Kokku skaneeritud kaustu", + "quickScan": "Kiirskaneerimine", + "fullScan": "Täisskaneerimine", + "serverUptime": "Serveri katkematu tööaeg", + "serverDown": "POLE VÕRGUS", + "scanType": "Tüüp", + "status": "Skaneerimisviga", + "elapsedTime": "Möödunud aeg", + "selectiveScan": "Valikuline" + }, + "help": { + "title": "Navidrome'i kiirklahvid", + "hotkeys": { + "show_help": "Näita seda abiteavet", + "toggle_menu": "Lülita menüü külgriba sisse/välja", + "toggle_play": "Esita / Peata esitus", + "prev_song": "Eelmine lugu", + "next_song": "Järgmine lugu", + "vol_up": "Heli valjemaks", + "vol_down": "Heli vaiksemaks", + "toggle_love": "Lisa see lugu lemmikute hulka", + "current_song": "Mine esitamisel loo juurde" + } + }, + "nowPlaying": { + "title": "Hetkel esitamisel", + "empty": "Mitte midagi pole hetkel esitamisel", + "minutesAgo": "%{smart_count} minut tagasi |||| %{smart_count} minutit tagasi" + } +} \ No newline at end of file diff --git a/resources/i18n/eu.json b/resources/i18n/eu.json index 5470ab38b..30db91cde 100644 --- a/resources/i18n/eu.json +++ b/resources/i18n/eu.json @@ -10,8 +10,10 @@ "playCount": "Erreprodukzioak", "title": "Titulua", "artist": "Artista", + "composer": "Konpositorea", "album": "Albuma", "path": "Fitxategiaren bidea", + "libraryName": "Liburutegia", "genre": "Generoa", "compilation": "Konpilazioa", "year": "Urtea", @@ -20,30 +22,36 @@ "bitRate": "Bit-tasa", "bitDepth": "Bit-sakonera", "sampleRate": "Lagin-tasa", + "albumGain": "Album-irabazia", + "trackGain": "Pista-irabazia", "channels": "Kanalak", + "disc": "%{discNumber}. diskoa", "discSubtitle": "Diskoaren azpititulua", "starred": "Gogokoa", "comment": "Iruzkina", "rating": "Balorazioa", "quality": "Kalitatea", "bpm": "BPM", - "playDate": "Azkenekoz erreproduzitua:", + "playDate": "Azken erreprodukzioa:", "createdAt": "Gehitu zen data:", "grouping": "Multzokatzea", "mood": "Aldartea", "participants": "Partaide gehiago", - "tags": "Traola gehiago", - "mappedTags": "Esleitutako traolak", - "rawTags": "Traola gordinak" + "tags": "Etiketa gehiago", + "mappedTags": "Esleitutako etiketak", + "rawTags": "Etiketa gordinak", + "missing": "Ez da aurkitu" }, "actions": { "addToQueue": "Erreproduzitu ondoren", "playNow": "Erreproduzitu orain", "addToPlaylist": "Gehitu erreprodukzio-zerrendara", + "showInPlaylist": "Erakutsi erreprodukzio-zerrendan", "shuffleAll": "Erreprodukzio aleatorioa", "download": "Deskargatu", "playNext": "Hurrengoa", - "info": "Lortu informazioa" + "info": "Erakutsi informazioa", + "instantMix": "Berehalako nahastea" } }, "album": { @@ -56,13 +64,14 @@ "playCount": "Erreprodukzioak", "size": "Fitxategiaren tamaina", "name": "Izena", + "libraryName": "Liburutegia", "genre": "Generoa", "compilation": "Konpilazioa", "year": "Urtea", "date": "Recording Date", "originalDate": "Jatorrizkoa", - "releaseDate": "Argitaratze-data:", - "releases": "Argitaratzea |||| Argitaratzeak", + "releaseDate": "Argitaratze-data", + "releases": "Argitaratzea |||| Argitaratze", "released": "Argitaratua", "updatedAt": "Aktualizatze-data:", "comment": "Iruzkina", @@ -73,21 +82,22 @@ "releaseType": "Mota", "grouping": "Multzokatzea", "media": "Multimedia", - "mood": "Aldartea" + "mood": "Aldartea", + "missing": "Ez da aurkitu" }, "actions": { "playAll": "Erreproduzitu", - "playNext": "Erreproduzitu segidan", + "playNext": "Erreproduzitu orain", "addToQueue": "Erreproduzitu amaieran", "shuffle": "Aletorioa", "addToPlaylist": "Gehitu zerrendara", "download": "Deskargatu", - "info": "Lortu informazioa", + "info": "Erakutsi informazioa", "share": "Partekatu" }, "lists": { "all": "Guztiak", - "random": "Aleatorioki", + "random": "Aleatorioa", "recentlyAdded": "Berriki gehitutakoak", "recentlyPlayed": "Berriki entzundakoak", "mostPlayed": "Gehien entzundakoak", @@ -105,10 +115,11 @@ "playCount": "Erreprodukzio kopurua", "rating": "Balorazioa", "genre": "Generoa", - "role": "Rola" + "role": "Rola", + "missing": "Ez da aurkitu" }, "roles": { - "albumartist": "Albumeko egilea |||| Albumeko artistak", + "albumartist": "Albumeko artista |||| Albumeko artistak", "artist": "Artista |||| Artistak", "composer": "Konpositorea |||| Konpositoreak", "conductor": "Orkestra zuzendaria |||| Orkestra zuzendariak", @@ -120,7 +131,13 @@ "mixer": "Nahaslea |||| Nahasleak", "remixer": "Remixerra |||| Remixerrak", "djmixer": "DJ nahaslea |||| DJ nahasleak", - "performer": "Interpretatzailea |||| Interpretatzaileak" + "performer": "Interpretatzailea |||| Interpretatzaileak", + "maincredit": "Albumeko egilea edo egilea |||| Albumeko egileak edo egileak" + }, + "actions": { + "topSongs": "Abesti apartak", + "shuffle": "Aleatorioki", + "radio": "Irratia" } }, "user": { @@ -137,19 +154,26 @@ "currentPassword": "Uneko pasahitza", "newPassword": "Pasahitz berria", "token": "Tokena", - "lastAccessAt": "Azken sarbidea" + "lastAccessAt": "Azken sarbidea", + "libraries": "Liburutegiak" }, "helperTexts": { - "name": "Aldaketak saioa hasten duzun hurrengoan islatuko dira" + "name": "Aldaketak saioa hasten duzun hurrengoan islatuko dira", + "libraries": "Hautatu erabiltzaile honentzat liburutegi jakinak, edo utzi hutsik defektuzko liburutegiak erabiltzeko" }, "notifications": { "created": "Erabiltzailea sortu da", "updated": "Erabiltzailea eguneratu da", "deleted": "Erabiltzailea ezabatu da" }, + "validation": { + "librariesRequired": "Gutxienez liburutegi bat hautatu behar da administratzaile ez diren erabiltzaileentzat" + }, "message": { "listenBrainzToken": "Idatzi zure ListenBrainz erabiltzailearen tokena", - "clickHereForToken": "Egin klik hemen tokena lortzeko" + "clickHereForToken": "Egin klik hemen tokena lortzeko", + "selectAllLibraries": "Hautatu liburutegi guztiak", + "adminAutoLibraries": "Administratzaileek automatikoki dute liburutegi guztietara sarbidea" } }, "player": { @@ -192,12 +216,18 @@ "selectPlaylist": "Hautatu zerrenda:", "addNewPlaylist": "Sortu \"%{name}\"", "export": "Esportatu", + "saveQueue": "Gorde ilaran daudek erreprodukzio-zerrendan", "makePublic": "Egin publikoa", - "makePrivate": "Egin pribatua" + "makePrivate": "Egin pribatua", + "searchOrCreate": "Bilatu erreprodukzio-zerrenda edo idatzi berria sortzeko…", + "pressEnterToCreate": "Sakatu Enter erreprodukzio-zerrenda berria sortzeko", + "removeFromSelection": "Kendu hautaketatik" }, "message": { "duplicate_song": "Hautatutako abesti batzuk lehendik ere daude zerrendan", - "song_exist": "Bikoiztutakoak gehitzen ari dira erreprodukzio-zerrendara. Ziur gehitu nahi dituzula?" + "song_exist": "Bikoiztutakoak gehitzen ari dira erreprodukzio-zerrendara. Ziur gehitu nahi dituzula?", + "noPlaylistsFound": "Ez da erreprodukzio-zerrenda aurkitu", + "noPlaylists": "Ez dago erreprodukzio-zerrendarik eskuragarri" } }, "radio": { @@ -233,19 +263,153 @@ "actions": {} }, "missing": { - "name": "Fitxategia falta da|||| Fitxategiak falta dira", + "name": "Aurkitu ez den fitxategia |||| Aurkitu ez diren fitxategiak", "empty": "Ez da fitxategirik falta", "fields": { "path": "Bidea", "size": "Tamaina", + "libraryName": "Liburutegia", "updatedAt": "Desagertze-data:" }, "actions": { "remove": "Kendu", - "remove_all": "Kendu guztia" + "remove_all": "Kendu guztiak" }, "notifications": { - "removed": "Faltan zeuden fitxategiak kendu dira" + "removed": "Aurkitzen ez ziren fitxategiak kendu dira" + } + }, + "library": { + "name": "Liburutegia |||| Liburutegiak", + "fields": { + "name": "Izena", + "path": "Fitxategiaren bidea", + "remotePath": "Urruneko bidea", + "lastScanAt": "Azken araketa", + "songCount": "Abestiak", + "albumCount": "Albumak", + "artistCount": "Artistak", + "totalSongs": "Abestiak", + "totalAlbums": "Albumak", + "totalArtists": "Artistak", + "totalFolders": "Karpetak", + "totalFiles": "Fitxategiak", + "totalMissingFiles": "Fitxategiak faltan", + "totalSize": "Tamaina guztira", + "totalDuration": "Iraupena", + "defaultNewUsers": "Defektuz erabiltzaile berrientzat", + "createdAt": "Sortze-data", + "updatedAt": "Eguneratze-data" + }, + "sections": { + "basic": "Oinarrizko informazioa", + "statistics": "Estatistikak" + }, + "actions": { + "scan": "Arakatu liburutegia", + "quickScan": "Araketa bizkorra", + "fullScan": "Araketa sakona", + "manageUsers": "Kudeatu erabiltzaileen sarbidea", + "viewDetails": "Ikusi xehetasunak" + }, + "notifications": { + "created": "Liburutegia ondo sortu da", + "updated": "Liburutegia ondo eguneratu da", + "deleted": "Liburutegia ondo ezabatu da", + "scanStarted": "Liburutegiaren araketa hasi da", + "quickScanStarted": "Araketa bizkorra hasi da", + "fullScanStarted": "Araketa sakona hasi da", + "scanError": "Errorea araketa abiaraztean. Aztertu erregistroak", + "scanCompleted": "Liburutegiaren araketa amaitu da" + }, + "validation": { + "nameRequired": "Liburutegiaren izena beharrezkoa da", + "pathRequired": "Liburutegiaren bidea beharrezkoa da", + "pathNotDirectory": "Liburutegiaren bidea direktorio bat izan behar da", + "pathNotFound": "Ez da liburutegiaren bidea aurkitu", + "pathNotAccessible": "Liburutegiaren bidea ez dago eskuragai", + "pathInvalid": "Liburutegiaren bidea ez da baliozkoa" + }, + "messages": { + "deleteConfirm": "Ziur liburutegia ezabatu nahi duzula? Erlazionatutako datu guztiak eta erabiltzaileen sarbidea kenduko ditu.", + "scanInProgress": "Araketa abian da…", + "noLibrariesAssigned": "Ez da liburutegirik egokitu erabiltzaile honentzat" + } + }, + "plugin": { + "name": "Plugina |||| Pluginak", + "fields": { + "id": "IDa", + "name": "Izena", + "description": "Deskribapena", + "version": "Bertsioa", + "author": "Autorea", + "website": "Webgunea", + "permissions": "Baimenak", + "enabled": "Gaituta", + "status": "Egoera", + "path": "Bidea", + "lastError": "Errorea", + "hasError": "Errorea", + "updatedAt": "Eguneratuta", + "createdAt": "Instalatuta", + "configKey": "Gakoa", + "configValue": "Balioa", + "allUsers": "Baimendu erabiltzaile guztiak", + "selectedUsers": "Hautatutako erabiltzaileak", + "allLibraries": "Baimendu liburutegi guztiak", + "selectedLibraries": "Hautatutako liburutegiak", + "allowWriteAccess": "Eman idazteko baimena" + }, + "sections": { + "status": "Egoera", + "info": "Pluginaren informazioa", + "configuration": "Konfigurazioa", + "manifest": "Manifestua", + "usersPermission": "Erabiltzaileen baimenak", + "libraryPermission": "Liburutegien baimenak" + }, + "status": { + "enabled": "Gaituta", + "disabled": "Ezgaituta" + }, + "actions": { + "enable": "Gaitu", + "disable": "Ezgaitu", + "disabledDueToError": "Konpondu errorea gaitu baino lehen", + "disabledUsersRequired": "Hautatu erabiltzaileak gaitu baino lehen", + "disabledLibrariesRequired": "Hautatu liburutegiak gaitu baino lehen", + "addConfig": "Gehitu konfigurazioa", + "rescan": "Arakatu berriro" + }, + "notifications": { + "enabled": "Plugina gaituta", + "disabled": "Plugina ezgaituta", + "updated": "Plugina eguneratuta", + "error": "Errorea plugina eguneratzean" + }, + "validation": { + "invalidJson": "Konfigurazioa baliozko JSON-a izan behar da" + }, + "messages": { + "configHelp": "Konfiguratu plugina gako-balio bikoteak erabiliz. Utzi hutsik pluginak konfiguraziorik behar ez badu.", + "configValidationError": "Huts egin du konfigurazioaren balidazioak:", + "schemaRenderError": "Ezin izan da konfigurazioaren formularioa bihurtu. Litekeena da pluginaren eskema baliozkoa ez izatea.", + "clickPermissions": "Sakatu baimen batean xehetasunetarako", + "noConfig": "Ez da konfiguraziorik ezarri", + "allUsersHelp": "Gaituta dagoenean, pluginak erabiltzaile guztiak atzitu ditzazke, baita etorkizunean sortuko direnak ere.", + "noUsers": "Ez da erabiltzailerik hautatu", + "permissionReason": "Arrazoia", + "usersRequired": "Plugin honek erabiltzaileen informaziora sarbidea behar du. Hautatu zein erabiltzaile atzitu dezakeen pluginak, edo gaitu 'Baimendu erabiltzaile guztiak'.", + "allLibrariesHelp": "Gaituta dagoenean, pluginak liburutegi guztietara izango du sarbidea, baita etorkizunean sortuko direnetara ere.", + "noLibraries": "Ez da liburutegirik hautatu", + "librariesRequired": "Plugin honek liburutegien informaziora sarbidea behar du. Hautatu zein liburutegi atzitu dezakeen pluginak, edo gaitu 'Baimendu liburutegi guztiak'.", + "allowWriteAccessHelp": "Gaituta dagoenean, pluginak liburutegien direktorioko fitxategiak moldatu ditzake. Defektuz, pluginek bakarrik irakurtzeko baimena dute.", + "requiredHosts": "Beharrezko ostatatzaileak" + }, + "placeholders": { + "configKey": "gakoa", + "configValue": "balioa" } } }, @@ -330,7 +494,7 @@ "input": { "file": { "upload_several": "Jaregin edo hautatu igo nahi dituzun fitxategiak.", - "upload_single": "AJaregin edo hautatu igo nahi duzun fitxategia." + "upload_single": "Jaregin edo hautatu igo nahi duzun fitxategia." }, "image": { "upload_several": "Jaregin edo hautatu igo nahi dituzun irudiak.", @@ -375,13 +539,13 @@ "skip_nav": "Joan edukira" }, "notification": { - "updated": "Elementu bat eguneratu da |||| %{smart_count} elementu eguneratu dira", + "updated": "Elementua eguneratu da |||| %{smart_count} elementu eguneratu dira", "created": "Elementua sortu da", - "deleted": "Elementu bat ezabatu da |||| %{smart_count} elementu ezabatu dira.", + "deleted": "Elementua ezabatu da |||| %{smart_count} elementu ezabatu dira.", "bad_item": "Elementu okerra", "item_doesnt_exist": "Elementua ez dago", "http_error": "Errorea zerbitzariarekin komunikatzerakoan", - "data_provider_error": "Errorea datuen hornitzailean. Berrikusi kontsola xehetasun gehiagorako.", + "data_provider_error": "Errorea datuen hornitzailean. Aztertu kontsola xehetasun gehiagorako.", "i18n_error": "Ezin izan dira zehaztutako hizkuntzaren itzulpenak kargatu", "canceled": "Ekintza bertan behera utzi da", "logged_out": "Saioa amaitu da, konektatu berriro.", @@ -395,10 +559,19 @@ } }, "message": { + "uploadCover": "Igo azala", + "removeCover": "Kendu azala", + "coverUploaded": "Diskoaren azala eguneratu da", + "coverRemoved": "Diskoaren azala kendu da", + "coverUploadError": "Errorea diskoaren azala igotzean", + "coverRemoveError": "Errorea diskoaren azala kentzean", "note": "OHARRA", "transcodingDisabled": "Segurtasun arrazoiak direla-eta, transkodeketaren ezarpenak web-interfazearen bidez aldatzea ezgaituta dago. Transkodeketa-aukerak aldatu (editatu edo gehitu) nahi badituzu, berrabiarazi zerbitzaria konfigurazio-aukeraren %{config}-arekin.", "transcodingEnabled": "Navidrome %{config}-ekin martxan dago eta, beraz, web-interfazeko transkodeketa-ataletik sistema-komandoak exekuta daitezke. Segurtasun arrazoiak tarteko, ezgaitzea gomendatzen dugu, eta transkodeketa-aukerak konfiguratzen ari zarenean bakarrik gaitzea.", "songsAddedToPlaylist": "Abesti bat zerrendara gehitu da |||| %{smart_count} abesti zerrendara gehitu dira", + "noSimilarSongsFound": "Ez da antzeko abestirik aurkitu", + "startingInstantMix": "Berehalako nahastea kargatzen…", + "noTopSongsFound": "Ez da aparteko abestirik aurkitu", "noPlaylistsAvailable": "Ez dago zerrendarik erabilgarri", "delete_user_title": "Ezabatu '%{name}' erabiltzailea", "delete_user_content": "Ziur zaide erabiltzaile hau eta bere datu guztiak (zerrendak eta hobespenak barne) ezabatu nahi dituzula?", @@ -417,7 +590,7 @@ "listenBrainzUnlinkSuccess": "ListenBrainz deskonektatu da eta erabiltzailearen ohiturak hirugarrenen zerbitzuekin partekatzea desaktibatu da", "listenBrainzUnlinkFailure": "Ezin izan da ListenBrainz deskonektatu", "openIn": { - "lastfm": "Ikusi Last.fm-n", + "lastfm": "Ikusi Last.fm-en", "musicbrainz": "Ikusi MusicBrainz-en" }, "lastfmLink": "Irakurri gehiago…", @@ -432,6 +605,12 @@ }, "menu": { "library": "Liburutegia", + "librarySelector": { + "allLibraries": "Liburutegi guztiak (%{count})", + "multipleLibraries": "%{total} liburutegitik %{selected} hautatuta", + "selectLibraries": "Hautatu liburutegiak", + "none": "Bat ere ez" + }, "settings": "Ezarpenak", "version": "Bertsioa", "theme": "Itxura", @@ -480,8 +659,8 @@ "playModeText": { "order": "Ordenean", "orderLoop": "Errepikatu", - "singleLoop": "Errepikatu bakarra", - "shufflePlay": "Aleatorioa" + "singleLoop": "Errepikatu abesti hau", + "shufflePlay": "Aleatorioki" } }, "about": { @@ -494,19 +673,41 @@ "disabled": "Ezgaituta", "waiting": "Zain" } + }, + "tabs": { + "about": "Honi buruz", + "config": "Konfigurazioa" + }, + "config": { + "configName": "Konfigurazioaren izena", + "environmentVariable": "Ingurune-aldagaia", + "currentValue": "Uneko balioa", + "configurationFile": "Konfigurazio-fitxategia", + "exportToml": "Esportatu konfigurazioa (TOML)", + "downloadToml": "Deskargatu konfigurazioa (TOML)", + "exportSuccess": "Konfigurazioa arbelera esportatu da TOML formatuan", + "exportFailed": "Konfigurazioa kopiatzeak huts egin du", + "devFlagsHeader": "Garapen-adierazleak (aldatu/kendu litezke)", + "devFlagsComment": "Ezarpen esperimentalak dira eta litekeena da etorkizunean desagertzea" } }, "activity": { "title": "Ekintzak", "totalScanned": "Arakatutako karpeta guztiak", - "quickScan": "Arakatze azkarra", + "quickScan": "Arakatze bizkorra", "fullScan": "Arakatze sakona", + "selectiveScan": "Arakatze selektiboa", "serverUptime": "Zerbitzariak piztuta daraman denbora", "serverDown": "LINEAZ KANPO", "scanType": "Mota", "status": "Errorea arakatzean", "elapsedTime": "Igarotako denbora" }, + "nowPlaying": { + "title": "Une honetan erreproduzitzen", + "empty": "Ez dago erreproduzitzeko ezer", + "minutesAgo": "Duela minutu %{smart_count} |||| Duela %{smart_count} minutu" + }, "help": { "title": "Navidromeren laster-teklak", "hotkeys": { diff --git a/resources/i18n/fi.json b/resources/i18n/fi.json index 6c084a196..0e6149f87 100644 --- a/resources/i18n/fi.json +++ b/resources/i18n/fi.json @@ -31,8 +31,16 @@ "mood": "Tunnelma", "participants": "Lisäosallistujat", "tags": "Lisätunnisteet", - "mappedTags": "Mäpättyt tunnisteet", - "rawTags": "Raakatunnisteet" + "mappedTags": "Mäpätyt tunnisteet", + "rawTags": "Raakatunnisteet", + "bitDepth": "Bittisyvyys", + "sampleRate": "Näytteenottotaajuus", + "missing": "Puuttuva", + "libraryName": "Kirjasto", + "composer": "Säveltäjä", + "disc": "Levy %{discNumber}", + "albumGain": "Albumin äänenvoimakkuus", + "trackGain": "Kappaleen äänenvoimakkuus" }, "actions": { "addToQueue": "Lisää jonoon", @@ -41,7 +49,9 @@ "shuffleAll": "Sekoita kaikki", "download": "Lataa", "playNext": "Soita seuraavaksi", - "info": "Info" + "info": "Info", + "showInPlaylist": "Näytä soittolistassa", + "instantMix": "Pikasekoitus" } }, "album": { @@ -70,7 +80,10 @@ "releaseType": "Tyyppi", "grouping": "Ryhmittely", "media": "Media", - "mood": "Tunnelma" + "mood": "Tunnelma", + "date": "Tallennuspäivä", + "missing": "Puuttuva", + "libraryName": "Kirjasto" }, "actions": { "playAll": "Soita", @@ -102,7 +115,8 @@ "rating": "Arvostelu", "genre": "Tyylilaji", "size": "Koko", - "role": "Rooli" + "role": "Rooli", + "missing": "Puuttuva" }, "roles": { "albumartist": "Albumitaiteilija |||| Albumitaiteilijat", @@ -117,7 +131,13 @@ "mixer": "Miksaaja |||| Miksaajat", "remixer": "Remiksaaja |||| Remiksaajat", "djmixer": "DJ-miksaaja |||| DJ-miksaajat", - "performer": "Esiintyjä |||| Esiintyjät" + "performer": "Esiintyjä |||| Esiintyjät", + "maincredit": "Albumin artisti tai artisti |||| Albumin artistit tai artistit" + }, + "actions": { + "shuffle": "Sekoita", + "radio": "Radio", + "topSongs": "Suosituimmat kappaleet" } }, "user": { @@ -134,10 +154,12 @@ "currentPassword": "Nykyinen salasana", "newPassword": "Uusi salasana", "token": "Avain", - "lastAccessAt": "Viimeisin käyttö" + "lastAccessAt": "Viimeisin käyttö", + "libraries": "Kirjastot" }, "helperTexts": { - "name": "Nimen muutos tulee voimaan kun seuraavan kerran kirjaudut sisään" + "name": "Nimen muutos tulee voimaan kun seuraavan kerran kirjaudut sisään", + "libraries": "Valitse tietyt kirjastot tälle käyttäjälle tai jätä tyhjäksi käyttääksesi oletuskirjastoja" }, "notifications": { "created": "Käyttäjä luotu", @@ -146,7 +168,12 @@ }, "message": { "listenBrainzToken": "Syötä ListenBrainz avain.", - "clickHereForToken": "Paina tästä saadaksesi avaimen" + "clickHereForToken": "Paina tästä saadaksesi avaimen", + "selectAllLibraries": "Valitse kaikki kirjastot", + "adminAutoLibraries": "Admin-käyttäjillä on automaattisesti pääsy kaikkiin kirjastoihin" + }, + "validation": { + "librariesRequired": "Vähintään yksi kirjasto on valittava ei-admin käyttäjille" } }, "player": { @@ -190,11 +217,17 @@ "addNewPlaylist": "Luo \"%{name}\"", "export": "Vie", "makePublic": "Tee julkinen", - "makePrivate": "Tee yksityinen" + "makePrivate": "Tee yksityinen", + "saveQueue": "Tallenna jono soittolistaan", + "searchOrCreate": "Etsi soittolistoja tai kirjoita luodaksesi uuden...", + "pressEnterToCreate": "Paina Enter luodaksesi uuden soittolistan", + "removeFromSelection": "Poista valinnasta" }, "message": { "duplicate_song": "Lisää olemassa oleva kappale", - "song_exist": "Olet lisäämässä soittolistalla jo olevaa kappaletta. Haluatko lisätä saman kappaleen vai ohittaa sen?" + "song_exist": "Olet lisäämässä soittolistalla jo olevaa kappaletta. Haluatko lisätä saman kappaleen vai ohittaa sen?", + "noPlaylistsFound": "Soittolistoja ei löytynyt", + "noPlaylists": "Soittolistoja ei ole saatavilla" } }, "radio": { @@ -232,13 +265,149 @@ "fields": { "path": "Polku", "size": "Koko", - "updatedAt": "Katosi" + "updatedAt": "Katosi", + "libraryName": "Kirjasto" }, "actions": { - "remove": "Poista" + "remove": "Poista", + "remove_all": "Poista kaikki" }, "notifications": { "removed": "Puuttuvat tiedostot poistettu" + }, + "empty": "Ei puuttuvia tiedostoja" + }, + "library": { + "name": "Kirjasto |||| Kirjastot", + "fields": { + "name": "Nimi", + "path": "Polku", + "remotePath": "Etäpolku", + "lastScanAt": "Viimeisin skannaus", + "songCount": "Kappaleet", + "albumCount": "Albumit", + "artistCount": "Artistit", + "totalSongs": "Kappaleet", + "totalAlbums": "Albumit", + "totalArtists": "Artistit", + "totalFolders": "Kansiot", + "totalFiles": "Tiedostot", + "totalMissingFiles": "Puuttuvat tiedostot", + "totalSize": "Kokonaiskoko", + "totalDuration": "Kesto", + "defaultNewUsers": "Oletus uusille käyttäjille", + "createdAt": "Luotu", + "updatedAt": "Päivitetty" + }, + "sections": { + "basic": "Perustiedot", + "statistics": "Tilastot" + }, + "actions": { + "scan": "Skannaa kirjasto", + "manageUsers": "Hallitse käyttäjien pääsyä", + "viewDetails": "Näytä tiedot", + "quickScan": "Nopea skannaus", + "fullScan": "Täysi skannaus" + }, + "notifications": { + "created": "Kirjasto luotu onnistuneesti", + "updated": "Kirjasto päivitetty onnistuneesti", + "deleted": "Kirjasto poistettu onnistuneesti", + "scanStarted": "Kirjaston skannaus aloitettu", + "scanCompleted": "Kirjaston skannaus valmistunut", + "quickScanStarted": "Nopea skannaus aloitettu", + "fullScanStarted": "Täysi skannaus aloitettu", + "scanError": "Virhe skannauksen käynnistyksessä. Tarkista lokit" + }, + "validation": { + "nameRequired": "Kirjaston nimi vaaditaan", + "pathRequired": "Kirjaston polku vaaditaan", + "pathNotDirectory": "Kirjaston polun tulee olla hakemisto", + "pathNotFound": "Kirjaston polkua ei löytynyt", + "pathNotAccessible": "Kirjaston polku ei ole käytettävissä", + "pathInvalid": "Virheellinen kirjaston polku" + }, + "messages": { + "deleteConfirm": "Haluatko varmasti poistaa tämän kirjaston? Kaikki siihen liittyvät tiedot ja käyttäjien pääsy poistetaan.", + "scanInProgress": "Skannaus käynnissä...", + "noLibrariesAssigned": "Tälle käyttäjälle ei ole määritetty kirjastoja" + } + }, + "plugin": { + "name": "Liitännäinen |||| Liitännäiset", + "fields": { + "id": "ID", + "name": "Nimi", + "description": "Kuvaus", + "version": "Versio", + "author": "Tekijä", + "website": "Verkkosivusto", + "permissions": "Oikeudet", + "enabled": "Käytössä", + "status": "Tila", + "path": "Polku", + "lastError": "Virhe", + "hasError": "Virhe", + "updatedAt": "Päivitetty", + "createdAt": "Asennettu", + "configKey": "Avain", + "configValue": "Arvo", + "allUsers": "Salli kaikki käyttäjät", + "selectedUsers": "Valitut käyttäjät", + "allLibraries": "Salli kaikki kirjastot", + "selectedLibraries": "Valitut kirjastot", + "allowWriteAccess": "Salli kirjoitusoikeus" + }, + "sections": { + "status": "Tila", + "info": "Lisäosan tiedot", + "configuration": "Määritykset", + "manifest": "Luettelo", + "usersPermission": "Käyttäjäoikeudet", + "libraryPermission": "Kirjaston oikeudet" + }, + "status": { + "enabled": "Käytössä", + "disabled": "Ei käytössä" + }, + "actions": { + "enable": "Ota käyttöön", + "disable": "Poista käytöstä", + "disabledDueToError": "Korjaa virhe ennen käyttöönottoa", + "disabledUsersRequired": "Valitse käyttäjät ennen käyttöönottoa", + "disabledLibrariesRequired": "Valitse kirjastot ennen käyttöönottoa", + "addConfig": "Lisää määritykset", + "rescan": "Skannaa uudelleen" + }, + "notifications": { + "enabled": "Lisäosa käytössä", + "disabled": "Lisäosa ei käytössä", + "updated": "Lisäosa päivitetty", + "error": "Virhe lisäosaa päivitettäessä" + }, + "validation": { + "invalidJson": "Määrityksen on oltava kelvollinen JSON" + }, + "messages": { + "configHelp": "Määritä lisäosa avain-arvo-parien avulla. Jätä tyhjäksi, jos lisäosa ei vaadi määrityksiä.", + "clickPermissions": "Napsauta käyttöoikeutta saadaksesi lisätietoja", + "noConfig": "Ei määritettyjä asetuksia", + "allUsersHelp": "Kun tämä on käytössä, laajennuksella on pääsy kaikkiin käyttäjiin, myös tulevaisuudessa luotaviin.", + "noUsers": "Ei valittuja käyttäjiä", + "permissionReason": "Syy", + "usersRequired": "Tämä laajennus vaatii pääsyn käyttäjätietoihin. Valitse käyttäjät, joihin laajennus voi päästä, tai ota käyttöön 'Salli kaikki käyttäjät'.", + "allLibrariesHelp": "Kun tämä on käytössä, laajennuksella on pääsy kaikkiin kirjastoihin, myös tulevaisuudessa luotaviin.", + "noLibraries": "Ei valittuja kirjastoja", + "librariesRequired": "Tämä laajennus vaatii pääsyn kirjastotietoihin. Valitse, mihin kirjastoihin laajennus voi käyttää, tai ota käyttöön 'Salli kaikki kirjastot'.", + "requiredHosts": "Vaaditut palvelimet", + "configValidationError": "Määrityksen validointi epäonnistui:", + "schemaRenderError": "Konfiguraatiolomaketta ei voi näyttää. Lisäosan skeema saattaa olla virheellinen.", + "allowWriteAccessHelp": "Kun otettu käyttöön, liitännäinen voi muokata tiedostoja kirjastohakemistoissa. Oletuksena liitännäisillä on vain luku -oikeus." + }, + "placeholders": { + "configKey": "avain", + "configValue": "arvo" } } }, @@ -253,7 +422,7 @@ "username": "Käyttäjänimi", "password": "Salasana", "sign_in": "Kirjaudu", - "sign_in_error": "Autentikointi epäonnistui. Yritä uudelleen", + "sign_in_error": "Kirjautuminen epäonnistui. Yritä uudelleen", "logout": "Kirjaudu ulos", "insightsCollectionNote": "Navidrome kerää anonyymejä käyttötietoja auttaakseen parantamaan\nprojektia. Paina [tästä] saadaksesi lisätietoa\nja halutessasi kieltäytyä" }, @@ -263,7 +432,7 @@ "required": "Pakollinen", "minLength": "Pitää vähintään olla %{min} merkkiä", "maxLength": "Saa olla enintään %{max} merkkiä", - "minValue": "pitää olla vähintään %{min}", + "minValue": "Pitää olla vähintään %{min}", "maxValue": "Saa olla enentään %{max}", "number": "Pitää olla numero", "email": "Pitää olla oikea sähköpostiosoite", @@ -357,7 +526,7 @@ }, "navigation": { "no_results": "Ei tuloksia", - "no_more_results": "Sivunumero %{page} on rajojen ulkopuolella. Kokeile edellinen sivu.", + "no_more_results": "Sivunumeroa %{page} ei löydy. Yritä edellistä sivua.", "page_out_of_boundaries": "Sivunumero %{page} on rajojen ulkopuolella", "page_out_from_end": "Viimeinen sivu, ei voi edetä", "page_out_from_begin": "Ensimmäinen sivu, ei voi palata", @@ -419,7 +588,18 @@ "downloadDialogTitle": "Lataa %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Kopio leikepöydälle: Ctrl+C, Enter", "remove_missing_title": "Poista puuttuvat tiedostot", - "remove_missing_content": "Oletko varma, että haluat poistaa valitut puuttuvat tiedostot tietokannasta? Tämä poistaa pysyvästi kaikki viittaukset niihin, mukaan lukien niiden soittojen määrät ja arvostelut." + "remove_missing_content": "Oletko varma, että haluat poistaa valitut puuttuvat tiedostot tietokannasta? Tämä poistaa pysyvästi kaikki viittaukset niihin, mukaan lukien niiden soittojen määrät ja arvostelut.", + "remove_all_missing_title": "Poista kaikki puuttuvat tiedostot", + "remove_all_missing_content": "Haluatko varmasti poistaa kaikki puuttuvat tiedostot tietokannasta? Tämä poistaa pysyvästi kaikki viittaukset niihin, mukaan lukien toistomäärät ja arvostelut.", + "noSimilarSongsFound": "Samankaltaisia kappaleita ei löytynyt", + "noTopSongsFound": "Suosituimpia kappaleita ei löytynyt", + "startingInstantMix": "Ladataan Pikasekoitus...", + "uploadCover": "Lataa kansikuva", + "removeCover": "Poista kansikuva", + "coverUploaded": "Kansikuva päivitetty", + "coverRemoved": "Kansikuva poistettu", + "coverUploadError": "Virhe ladattaessa kansikuvaa", + "coverRemoveError": "Virhe poistettaessa kansikuvaa" }, "menu": { "library": "Kirjasto", @@ -435,7 +615,7 @@ "desktop_notifications": "Työpöytäilmoitukset", "lastfmScrobbling": "Kuuntelutottumuksen lähetys Last.fm-palveluun", "listenBrainzScrobbling": "Kuuntelutottumuksen lähetys ListenBrainz-palveluun", - "replaygain": "RepleyGain -tila", + "replaygain": "ReplayGain -tila", "preAmp": "ReplayGain esivahvistus (dB)", "gain": { "none": "Pois käytöstä", @@ -448,7 +628,13 @@ "albumList": "Albumit", "about": "Tietoa", "playlists": "Soittolista", - "sharedPlaylists": "Jaettu soittolista" + "sharedPlaylists": "Jaettu soittolista", + "librarySelector": { + "allLibraries": "Kaikki kirjastot (%{count})", + "multipleLibraries": "%{selected} / %{total} kirjastoa", + "selectLibraries": "Valitse kirjastot", + "none": "Ei mitään" + } }, "player": { "playListsText": "Jono", @@ -461,7 +647,7 @@ "previousTrackText": "Edellinen kappale", "reloadText": "Päivitä", "volumeText": "Äänenvoimakkuus", - "toggleLyricText": "Toggle lyric", + "toggleLyricText": "Näytä/piilota sanat", "toggleMiniModeText": "Minimoi", "destroyText": "Poista", "downloadText": "Lataa", @@ -485,6 +671,22 @@ "disabled": "Ei käytössä", "waiting": "Odottaa" } + }, + "tabs": { + "about": "Tietoja", + "config": "Määritykset" + }, + "config": { + "configName": "Konfiguraation nimi", + "environmentVariable": "Ympäristömuuttuja", + "currentValue": "Nykyinen arvo", + "configurationFile": "Määritystiedosto", + "exportToml": "Vie määritys (TOML)", + "exportSuccess": "Määritykset viety leikepöydälle TOML-muodossa", + "exportFailed": "Määritysten kopiointi epäonnistui", + "devFlagsHeader": "Kehitysliput (voivat muuttua/poistua)", + "devFlagsComment": "Nämä ovat kokeellisia asetuksia ja ne voidaan poistaa tulevissa versioissa", + "downloadToml": "Lataa määritykset (TOML)" } }, "activity": { @@ -493,7 +695,11 @@ "quickScan": "Nopea tarkistus", "fullScan": "Täysi tarkistus", "serverUptime": "Palvelun käyttöaika", - "serverDown": "SAMMUTETTU" + "serverDown": "SAMMUTETTU", + "scanType": "Tyyppi", + "status": "Skannausvirhe", + "elapsedTime": "Kulunut aika", + "selectiveScan": "Valikoiva" }, "help": { "title": "Navidrome pikapainikkeet", @@ -501,12 +707,17 @@ "show_help": "Näytä tämä apuvalikko", "toggle_menu": "Menuvalikko päälle ja pois", "toggle_play": "Toista / Tauko", - "prev_song": "Esellinen kappale", + "prev_song": "Edellinen kappale", "next_song": "Seuraava kappale", "vol_up": "Kovemmalle", "vol_down": "Hiljemmalle", "toggle_love": "Lisää kappale suosikkeihin", "current_song": "Siirry nykyiseen kappaleeseen" } + }, + "nowPlaying": { + "title": "Nyt soi", + "empty": "Ei soita mitään", + "minutesAgo": "%{smart_count} minuutti sitten |||| %{smart_count} minuuttia sitten" } } \ No newline at end of file diff --git a/resources/i18n/fr.json b/resources/i18n/fr.json index 4137f5b26..dae9f47e7 100644 --- a/resources/i18n/fr.json +++ b/resources/i18n/fr.json @@ -2,7 +2,7 @@ "languageName": "Français", "resources": { "song": { - "name": "Piste |||| Pistes", + "name": "Titre |||| Titres", "fields": { "albumArtist": "Artiste", "duration": "Durée", @@ -11,14 +11,13 @@ "title": "Titre", "artist": "Artiste", "album": "Album", - "path": "Chemin", + "path": "Chemin d'accès", "genre": "Genre", "compilation": "Compilation", "year": "Année", "size": "Taille", "updatedAt": "Mise à jour", "bitRate": "Bitrate", - "sampleRate": "Fréquence d'échantillonnage", "discSubtitle": "Sous-titre du disque", "starred": "Favoris", "comment": "Commentaire", @@ -34,7 +33,12 @@ "tags": "Étiquettes supplémentaires", "mappedTags": "Étiquettes correspondantes", "rawTags": "Étiquettes brutes", - "bitDepth": "Profondeur de bit" + "bitDepth": "Profondeur de bits", + "sampleRate": "Fréquence d'échantillonnage", + "missing": "Manquant", + "libraryName": "Bibliothèque", + "composer": "Compositeur·e", + "disc": "Disque %{discNumber}" }, "actions": { "addToQueue": "Ajouter à la file", @@ -43,7 +47,9 @@ "shuffleAll": "Tout mélanger", "download": "Télécharger", "playNext": "Jouer ensuite", - "info": "Plus d'informations" + "info": "Plus d'informations", + "showInPlaylist": "Montrer dans la playlist", + "instantMix": "Mix instantanné" } }, "album": { @@ -52,13 +58,12 @@ "albumArtist": "Artiste", "artist": "Artiste", "duration": "Durée", - "songCount": "Nombre de pistes", + "songCount": "Titres", "playCount": "Nombre d'écoutes", "name": "Nom", "genre": "Genre", "compilation": "Compilation", "year": "Année", - "date": "Date d'enregistrement", "updatedAt": "Mis à jour le", "comment": "Commentaire", "rating": "Classement", @@ -73,7 +78,10 @@ "releaseType": "Type", "grouping": "Regroupement", "media": "Média", - "mood": "Humeur" + "mood": "Humeur", + "date": "Date d'enregistrement", + "missing": "Manquant", + "libraryName": "Bibliothèque" }, "actions": { "playAll": "Lire", @@ -100,12 +108,13 @@ "fields": { "name": "Nom", "albumCount": "Nombre d'albums", - "songCount": "Nombre de pistes", + "songCount": "Nombre de titres", "playCount": "Lectures", "rating": "Classement", "genre": "Genre", "size": "Taille", - "role": "Rôle" + "role": "Rôle", + "missing": "Manquant" }, "roles": { "albumartist": "Artiste de l'album |||| Artistes de l'album", @@ -120,7 +129,13 @@ "mixer": "Mixeur |||| Mixeurs", "remixer": "Remixeur |||| Remixeurs", "djmixer": "Mixeur DJ |||| Mixeurs DJ", - "performer": "Interprète |||| Interprètes" + "performer": "Interprète |||| Interprètes", + "maincredit": "Artiste de l'album ou Artiste |||| Artistes de l'album ou Artistes" + }, + "actions": { + "shuffle": "Lecture aléatoire", + "radio": "Radio", + "topSongs": "Meilleurs titres" } }, "user": { @@ -137,10 +152,12 @@ "currentPassword": "Mot de passe actuel", "newPassword": "Nouveau mot de passe", "token": "Token", - "lastAccessAt": "Dernier accès" + "lastAccessAt": "Dernier accès", + "libraries": "Bibliothèques" }, "helperTexts": { - "name": "Les changements liés à votre nom ne seront reflétés qu'à la prochaine connexion" + "name": "Les changements liés à votre nom ne seront reflétés qu'à la prochaine connexion", + "libraries": "Sélectionner une bibliothèque pour cet utilisateur ou laisser vide pour utiliser la bibliothèque par défaut" }, "notifications": { "created": "Utilisateur créé", @@ -149,7 +166,12 @@ }, "message": { "listenBrainzToken": "Entrez votre token ListenBrainz.", - "clickHereForToken": "Cliquez ici pour recevoir votre token" + "clickHereForToken": "Cliquez ici pour recevoir votre token", + "selectAllLibraries": "Sélectionner toutes les bibliothèques", + "adminAutoLibraries": "Les utilisateurs admin ont automatiquement accès à l'ensemble des bibliothèques" + }, + "validation": { + "librariesRequired": "Au moins une bibliothèque doit être sélectionnée pour les utilisateurs non administrateurs" } }, "player": { @@ -161,7 +183,7 @@ "client": "Client", "userName": "Nom d'utilisateur", "lastSeen": "Vu pour la dernière fois", - "reportRealPath": "Rapporter le chemin absolu", + "reportRealPath": "Rapporter le chemin d'accès absolu", "scrobbleEnabled": "Scrobbler vers des services externes" } }, @@ -189,15 +211,21 @@ "path": "Importer depuis" }, "actions": { - "selectPlaylist": "Ajouter les pistes à la playlist", + "selectPlaylist": "Sélectionner une playlist :", "addNewPlaylist": "Créer \"%{name}\"", "export": "Exporter", "makePublic": "Rendre publique", - "makePrivate": "Rendre privée" + "makePrivate": "Rendre privée", + "saveQueue": "Sauvegarder la file de lecture dans la playlist", + "searchOrCreate": "Chercher ou créer une nouvelle playlist...", + "pressEnterToCreate": "Appuyer sur entrée pour créer une nouvelle playlist", + "removeFromSelection": "Supprimer de la sélection" }, "message": { - "duplicate_song": "Pistes déjà présentes dans la playlist", - "song_exist": "Certaines des pistes sélectionnées font déjà partie de la playlist. Voulez-vous les ajouter ou les ignorer ?" + "duplicate_song": "Ajouter les titres déjà présents dans la playlist", + "song_exist": "Certains des titres sélectionnés font déjà partie de la playlist. Voulez-vous les ajouter ou les ignorer ?", + "noPlaylistsFound": "Aucune playlist trouvée", + "noPlaylists": "Aucune playlist disponible" } }, "radio": { @@ -233,17 +261,152 @@ "missing": { "name": "Fichier manquant|||| Fichiers manquants", "fields": { - "path": "Chemin", + "path": "Chemin d'accès", "size": "Taille", - "updatedAt": "A disparu le" + "updatedAt": "A disparu le", + "libraryName": "Bibliothèque" }, "actions": { - "remove": "Supprimer" + "remove": "Supprimer", + "remove_all": "Tout supprimer" }, "notifications": { "removed": "Fichier(s) manquant(s) supprimé(s)" }, "empty": "Aucun fichier manquant" + }, + "library": { + "name": "Bibliothèque |||| Bibliothèques", + "fields": { + "name": "Nom", + "path": "Chemin d'accès", + "remotePath": "Chemin d'accès distant", + "lastScanAt": "Dernier scan", + "songCount": "Titres", + "albumCount": "Albums", + "artistCount": "Artistes", + "totalSongs": "Titres", + "totalAlbums": "Albums", + "totalArtists": "Artistes", + "totalFolders": "Dossiers", + "totalFiles": "Fichiers", + "totalMissingFiles": "Fichiers manquants", + "totalSize": "Taille totale", + "totalDuration": "Durée", + "defaultNewUsers": "Défaut pour les nouveaux utilisateurs", + "createdAt": "Crée", + "updatedAt": "Mise à jour" + }, + "sections": { + "basic": "Informations", + "statistics": "Statistiques" + }, + "actions": { + "scan": "Scanner la bibliothèque", + "manageUsers": "Gérer les accès utilisateurs", + "viewDetails": "Voir les détails", + "quickScan": "Scan Rapide", + "fullScan": "Scan Complet" + }, + "notifications": { + "created": "Bibliothèque créée avec succès", + "updated": "Bibliothèque mise à jour avec succès", + "deleted": "Bibliothèque supprimée avec succès", + "scanStarted": "Le scan de la bibliothèque a commencé", + "scanCompleted": "Le scan de la bibliothèque est terminé", + "quickScanStarted": "Scan rapide démarré", + "fullScanStarted": "Scan complet démarré", + "scanError": "Une erreur est survenue en démarrant le scan. Veuillez regarder les logs" + }, + "validation": { + "nameRequired": "La bibliothèque doit obligatoirement avoir un nom", + "pathRequired": "La bibliothèque doit obligatoirement avoir un chemin d'accès", + "pathNotDirectory": "Le chemin d'accès de la bibliothèque doit pointer sur un dossier", + "pathNotFound": "Impossible de trouver ce chemin d'accès", + "pathNotAccessible": "Impossible d'accéder à ce chemin d'accès", + "pathInvalid": "Ce chemin d'accès n'est pas valide" + }, + "messages": { + "deleteConfirm": "Êtes-vous sûr(e) de vouloir supprimer cette bibliothèque ? Cela supprimera toutes les données associées ainsi que les accès utilisateurs.", + "scanInProgress": "Scan en cours...", + "noLibrariesAssigned": "Aucune bibliothèque pour cet utilisateur" + } + }, + "plugin": { + "name": "Extension |||| Extensions", + "fields": { + "id": "ID", + "name": "Nom", + "description": "Description", + "version": "Version", + "author": "Auteur.e", + "website": "Site web", + "permissions": "Permissions", + "enabled": "Activée", + "status": "Statut", + "path": "Chemin", + "lastError": "Erreur", + "hasError": "Erreur", + "updatedAt": "Mise à jour", + "createdAt": "Installée", + "configKey": "Clef", + "configValue": "Valeur", + "allUsers": "Autoriser tous les utilisateur·rices", + "selectedUsers": "Utilisateur·rices sélectionné.e.s", + "allLibraries": "Autoriser toutes les bibliothèques", + "selectedLibraries": "Bibliothèques sélectionnées", + "allowWriteAccess": "Autoriser l'accès en écriture" + }, + "sections": { + "status": "Statut", + "info": "Informations de l'extension", + "configuration": "Configuration", + "manifest": "Manifeste", + "usersPermission": "Permissions utilisateur·ices", + "libraryPermission": "Permissions des bibliothèques" + }, + "status": { + "enabled": "Activées", + "disabled": "Désactivées" + }, + "actions": { + "enable": "Activer", + "disable": "Désactiver", + "disabledDueToError": "L'erreur doit être réglée avant de pouvoir activer la bibliothèque", + "disabledUsersRequired": "Sélectionner des utilisateur·ices avant d'activer la bibliothèque", + "disabledLibrariesRequired": "Sélectionner au moins une bibliothèque", + "addConfig": "Ajouter une configuration", + "rescan": "Rescanner" + }, + "notifications": { + "enabled": "Extension activée", + "disabled": "Extension désactivée", + "updated": "Extension mise à jour", + "error": "Erreur pendant la mise à jour de l'extension" + }, + "validation": { + "invalidJson": "La configuration doit être un JSON valide" + }, + "messages": { + "configHelp": "Configurer l'extension en utilisant des paires clef/valeurs. Laisser vide si l'extension ne requiert aucune configuration.", + "clickPermissions": "Cliquer sur une permission pour plus de détails", + "noConfig": "Aucune configuration", + "allUsersHelp": "Quand sélectionnée, l'extension aura accès à l'ensemble des utilisateur·rices, y compris ceux créé.e.s dans le future.", + "noUsers": "Aucun.e utilisateur·rice sélectionné.e", + "permissionReason": "Raison", + "usersRequired": "Cette extension nécessite un accès aux informations utilisateurs. Sélectionnez les utilisateur·rices autorisé.e.s ou sélectionnez 'Tout autoriser'.", + "allLibrariesHelp": "Quand sélectionnée, cette extension aura accès à l'ensemble des bibliothèques, y compris celles créées dans le futur.", + "noLibraries": "Aucune bibliothèque sélectionnée", + "librariesRequired": "Cette extension nécessite l'accès aux information de la bibliothèque. Sélectionnez à quelles bibliothèque cette extension a accès, ou sélectionnez 'Autoriser toutes les bibliothèques'.", + "requiredHosts": "Hôtes requis", + "configValidationError": "Erreur lors de la validation de la configuration", + "schemaRenderError": "Impossible de processer la configuration. Le schéma de l'extension n'est peut-être pas valide.", + "allowWriteAccessHelp": "Lorsque cette option est activée, le plugin peut modifier les fichiers dans les répertoires de la bibliothèque. Par défaut, les plugins ont un accès en lecture seule." + }, + "placeholders": { + "configKey": "clef", + "configValue": "valeur" + } } }, "ra": { @@ -395,7 +558,7 @@ "note": "NOTE", "transcodingDisabled": "Le changement de paramètres depuis l'interface web est désactivé pour des raisons de sécurité. Pour changer (éditer ou supprimer) les options de transcodage, relancer le serveur avec l'option %{config} activée.", "transcodingEnabled": "Navidrome fonctionne actuellement avec %{config}, rendant possible l’exécution de commandes arbitraires depuis l'interface web. Il est recommandé d'activer cette fonctionnalité uniquement lors de la configuration du transcodage.", - "songsAddedToPlaylist": "Une piste a été ajoutée à la playlist |||| %{smart_count} pistes ont été ajoutées à la playlist", + "songsAddedToPlaylist": "1 titre a été ajouté à la playlist |||| %{smart_count} titres ont été ajoutés à la playlist", "noPlaylistsAvailable": "Aucune playlist", "delete_user_title": "Supprimer l'utilisateur '%{name}'", "delete_user_content": "Êtes-vous sûr(e) de vouloir supprimer cet utilisateur et ses données associées (y compris ses playlists et préférences) ?", @@ -423,7 +586,18 @@ "downloadDialogTitle": "Télécharger %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Copier vers le presse-papier : Ctrl+C, Enter", "remove_missing_title": "Supprimer les fichiers manquants", - "remove_missing_content": "Êtes-vous sûr(e) de vouloir supprimer les fichiers manquants sélectionnés de la base de données ? Ceci supprimera définitivement toute référence à ceux-ci, y compris leurs nombres d'écoutes et leurs notations" + "remove_missing_content": "Êtes-vous sûr(e) de vouloir supprimer les fichiers manquants sélectionnés de la base de données ? Ceci supprimera définitivement toute référence à ceux-ci, y compris leurs nombres d'écoutes et leurs notations", + "remove_all_missing_title": "Supprimer tous les fichiers manquants", + "remove_all_missing_content": "Êtes-vous sûr(e) de vouloir supprimer tous les fichiers manquants de la base de données ? Cette action est permanente et supprimera leurs nombres d'écoutes, leur notations et tout ce qui y fait référence.", + "noSimilarSongsFound": "Aucun titre similaire n'a été trouvé", + "noTopSongsFound": "Aucun meilleur titre n'a été trouvé", + "startingInstantMix": "Chargement du mix instantané...", + "uploadCover": "Téléverser la pochette", + "removeCover": "Supprimer la pochette", + "coverUploaded": "Pochette mise à jour", + "coverRemoved": "Pochette supprimée", + "coverUploadError": "Erreur lors du téléversement de la pochette", + "coverRemoveError": "Erreur lors de la suppression de la pochette" }, "menu": { "library": "Bibliothèque", @@ -444,7 +618,7 @@ "gain": { "none": "Désactivé", "album": "Utiliser le gain de l'album", - "track": "Utiliser le gain des pistes" + "track": "Utiliser le gain des titres" }, "lastfmNotConfigured": "La clef API de Last.fm n'est pas configurée" } @@ -452,7 +626,13 @@ "albumList": "Albums", "about": "À propos", "playlists": "Playlists", - "sharedPlaylists": "Playlists partagées" + "sharedPlaylists": "Playlists partagées", + "librarySelector": { + "allLibraries": "Toutes les bibliothèques (%{count})", + "multipleLibraries": "%{selected} bibliothèque(s) sélectionnée(s) sur %{total}", + "selectLibraries": "Sélectionner les bibliothèques", + "none": "Aucune" + } }, "player": { "playListsText": "File de lecture", @@ -489,6 +669,22 @@ "disabled": "Désactivée", "waiting": "En attente" } + }, + "tabs": { + "about": "À propos", + "config": "Paramètres" + }, + "config": { + "configName": "Nom de la configuration", + "environmentVariable": "Variable d'environnement", + "currentValue": "Valeur actuelle", + "configurationFile": "Fichier de configuration", + "exportToml": "Exporter la configuration (TOML)", + "exportSuccess": "La configuration a été copiée vers le presse-papier au format TOML", + "exportFailed": "Une erreur est survenue en copiant la configuration", + "devFlagsHeader": "Options de développement (peuvent être amenés à changer / être supprimés)", + "devFlagsComment": "Ces paramètres sont expérimentaux et peuvent être amenés à changer dans le futur", + "downloadToml": "Télécharger la configuration (TOML)" } }, "activity": { @@ -497,7 +693,11 @@ "quickScan": "Scan rapide", "fullScan": "Scan complet", "serverUptime": "Disponibilité du serveur", - "serverDown": "HORS LIGNE" + "serverDown": "HORS LIGNE", + "scanType": "Type", + "status": "Erreur de scan", + "elapsedTime": "Temps écoulé", + "selectiveScan": "Sélectif" }, "help": { "title": "Raccourcis Navidrome", @@ -510,7 +710,12 @@ "vol_up": "Augmenter le volume", "vol_down": "Baisser le volume", "toggle_love": "Ajouter/Enlever le morceau des favoris", - "current_song": "Aller à la chanson en cours" + "current_song": "Aller au titre en cours" } + }, + "nowPlaying": { + "title": "En cours de lecture", + "empty": "Aucun titre en cours de lecture", + "minutesAgo": "Il y a %{smart_count} minute |||| Il y a %{smart_count} minutes" } } \ No newline at end of file diff --git a/resources/i18n/gl.json b/resources/i18n/gl.json index 4d9a1a9a0..444998d03 100644 --- a/resources/i18n/gl.json +++ b/resources/i18n/gl.json @@ -31,8 +31,16 @@ "mood": "Estado", "participants": "Participantes adicionais", "tags": "Etiquetas adicionais", - "mappedTags": "", - "rawTags": "Etiquetas en cru" + "mappedTags": "Etiquetas mapeadas", + "rawTags": "Etiquetas en cru", + "bitDepth": "Calidade de Bit", + "sampleRate": "Taxa de mostra", + "missing": "Falta", + "libraryName": "Biblioteca", + "composer": "Composición", + "disc": "Disco %{discNumber}", + "albumGain": "Gañancia de Album", + "trackGain": "Gañancia de Canción" }, "actions": { "addToQueue": "Ao final da cola", @@ -41,7 +49,9 @@ "shuffleAll": "Remexer todo", "download": "Descargar", "playNext": "A continuación", - "info": "Obter info" + "info": "Obter info", + "showInPlaylist": "Mostrar en Lista de reprodución", + "instantMix": "Mestura Súbita" } }, "album": { @@ -63,14 +73,17 @@ "size": "Tamaño", "originalDate": "Orixinal", "releaseDate": "Publicado", - "releases": "Publicación ||| Publicacións", + "releases": "Publicación |||| Publicacións", "released": "Publicado", "recordLabel": "Editorial", "catalogNum": "Número de catálogo", "releaseType": "Tipo", "grouping": "Grupos", "media": "Multimedia", - "mood": "Estado" + "mood": "Estado", + "date": "Data de gravación", + "missing": "Falta", + "libraryName": "Biblioteca" }, "actions": { "playAll": "Reproducir", @@ -102,7 +115,8 @@ "rating": "Valoración", "genre": "Xénero", "size": "Tamaño", - "role": "Rol" + "role": "Rol", + "missing": "Falta" }, "roles": { "albumartist": "Artista do álbum |||| Artistas do álbum", @@ -117,7 +131,13 @@ "mixer": "Mistura |||| Mistura", "remixer": "Remezcla |||| Remezcla", "djmixer": "Mezcla DJs |||| Mezcla DJs", - "performer": "Intérprete |||| Intérpretes" + "performer": "Intérprete |||| Intérpretes", + "maincredit": "Artista do álbum ou Artista |||| Artistas do álbum ou Artistas" + }, + "actions": { + "shuffle": "Barallar", + "radio": "Radio", + "topSongs": "Cancións destacadas" } }, "user": { @@ -134,10 +154,12 @@ "currentPassword": "Contrasinal actual", "newPassword": "Novo contrasinal", "token": "Token", - "lastAccessAt": "Último acceso" + "lastAccessAt": "Último acceso", + "libraries": "Bibliotecas" }, "helperTexts": { - "name": "Os cambios no nome aplicaranse a próxima vez que accedas" + "name": "Os cambios no nome aplicaranse a próxima vez que accedas", + "libraries": "Selecciona bibliotecas específicas para esta usuaria, ou deixa baleiro para usar as bibliotecas por defecto" }, "notifications": { "created": "Creouse a usuaria", @@ -146,7 +168,12 @@ }, "message": { "listenBrainzToken": "Escribe o token de usuaria de ListenBrainz", - "clickHereForToken": "Preme aquí para obter o token" + "clickHereForToken": "Preme aquí para obter o token", + "selectAllLibraries": "Seleccionar todas as bibliotecas", + "adminAutoLibraries": "As usuarias Admin teñen acceso por defecto a todas as bibliotecas" + }, + "validation": { + "librariesRequired": "Debes seleccionar polo menos unha biblioteca para usuarias non admins" } }, "player": { @@ -190,11 +217,17 @@ "addNewPlaylist": "Crear \"%{name}\"", "export": "Exportar", "makePublic": "Facela Pública", - "makePrivate": "Facela Privada" + "makePrivate": "Facela Privada", + "saveQueue": "Salvar a Cola como Lista de reprodución", + "searchOrCreate": "Buscar listas ou escribe para crear nova…", + "pressEnterToCreate": "Preme Enter para crear nova lista", + "removeFromSelection": "Retirar da selección" }, "message": { "duplicate_song": "Engadir cancións duplicadas", - "song_exist": "Hai duplicadas que serán engadidas á lista de reprodución. Desexas engadir as duplicadas ou omitilas?" + "song_exist": "Hai duplicadas que serán engadidas á lista de reprodución. Desexas engadir as duplicadas ou omitilas?", + "noPlaylistsFound": "Sen listas de reprodución", + "noPlaylists": "Sen listas dispoñibles" } }, "radio": { @@ -232,13 +265,149 @@ "fields": { "path": "Ruta", "size": "Tamaño", - "updatedAt": "Desapareceu o" + "updatedAt": "Desapareceu o", + "libraryName": "Biblioteca" }, "actions": { - "remove": "Retirar" + "remove": "Retirar", + "remove_all": "Retirar todo" }, "notifications": { "removed": "Ficheiro(s) faltantes retirados" + }, + "empty": "Sen ficheiros faltantes" + }, + "library": { + "name": "Biblioteca |||| Bibliotecas", + "fields": { + "name": "Nome", + "path": "Ruta", + "remotePath": "Ruta remota", + "lastScanAt": "Último escaneado", + "songCount": "Cancións", + "albumCount": "Álbums", + "artistCount": "Artistas", + "totalSongs": "Cancións", + "totalAlbums": "Álbums", + "totalArtists": "Artistas", + "totalFolders": "Cartafoles", + "totalFiles": "Ficheiros", + "totalMissingFiles": "Ficheiros que faltan", + "totalSize": "Tamaño total", + "totalDuration": "Duración", + "defaultNewUsers": "Por defecto para novas usuarias", + "createdAt": "Creada", + "updatedAt": "Actualizada" + }, + "sections": { + "basic": "Información básica", + "statistics": "Estatísticas" + }, + "actions": { + "scan": "Escanear Biblioteca", + "manageUsers": "Xestionar acceso das usuarias", + "viewDetails": "Ver detalles", + "quickScan": "Escaneado rápido", + "fullScan": "Escaneado completo" + }, + "notifications": { + "created": "Biblioteca creada correctamente", + "updated": "Biblioteca actualizada correctamente", + "deleted": "Biblioteca eliminada correctamente", + "scanStarted": "Comezou o escaneo da biblioteca", + "scanCompleted": "Completouse o escaneado da biblioteca", + "quickScanStarted": "Iniciado o escaneado rápido", + "fullScanStarted": "Iniciado o escaneado completo", + "scanError": "Erro ao escanear. Comproba o rexistro" + }, + "validation": { + "nameRequired": "Requírese un nome para a biblioteca", + "pathRequired": "Requírese unha ruta para a biblioteca", + "pathNotDirectory": "A ruta á biblioteca ten que ser un directorio", + "pathNotFound": "Non se atopa a ruta á biblioteca", + "pathNotAccessible": "A ruta á biblioteca non é accesible", + "pathInvalid": "Ruta non válida á biblioteca" + }, + "messages": { + "deleteConfirm": "Tes certeza de querer eliminar esta biblioteca? Isto eliminará todos os datos asociados e accesos de usuarias.", + "scanInProgress": "Escaneo en progreso…", + "noLibrariesAssigned": "Sen bibliotecas asignadas a esta usuaria" + } + }, + "plugin": { + "name": "Complemento |||| Complementos", + "fields": { + "id": "ID", + "name": "Nome", + "description": "Descrición", + "version": "Versión", + "author": "Autoría", + "website": "Sitio web", + "permissions": "Permisos", + "enabled": "Activado", + "status": "Estado", + "path": "Ruta", + "lastError": "Erro", + "hasError": "Erro", + "updatedAt": "Actualizado", + "createdAt": "Instalado", + "configKey": "Clave", + "configValue": "Valor", + "allUsers": "Para todas as usuarias", + "selectedUsers": "Usuarias seleccionadas", + "allLibraries": "Permitir todas as bibliotecas", + "selectedLibraries": "Selecciona bibliotecas", + "allowWriteAccess": "Conceder acceso de escritura" + }, + "sections": { + "status": "Estado", + "info": "Info do complemento", + "configuration": "Configuración", + "manifest": "Manifesto", + "usersPermission": "Permiso sobre usuarias", + "libraryPermission": "Permiso sobre bibliotecas" + }, + "status": { + "enabled": "Activado", + "disabled": "Desactivado" + }, + "actions": { + "enable": "Activar", + "disable": "Desactivar", + "disabledDueToError": "Arranxar erro antes de activar", + "disabledUsersRequired": "Selección de usuarias antes de activar", + "disabledLibrariesRequired": "Selección de bibliotecas antes de activar", + "addConfig": "Engadir configuración", + "rescan": "Volver a escanear" + }, + "notifications": { + "enabled": "Complemento activado", + "disabled": "Complemento desactivado", + "updated": "Complemento actualizado", + "error": "Erro ao actualizar o complemento" + }, + "validation": { + "invalidJson": "A configuración debe ser un JSON válido" + }, + "messages": { + "configHelp": "Configura o complemento usando pares clave-valor. Deixa baleiro se o complemento non require configuración.", + "clickPermissions": "Preme nun permiso para ver detalles", + "noConfig": "Sen configuración establecida", + "allUsersHelp": "Ao activalo, o complemento terá acceso a todas as usuarias, incluíndo aquelas que se creen no futuro.", + "noUsers": "Sen usuarias seleccionadas", + "permissionReason": "Motivo", + "usersRequired": "O complemento precisa acceso á información sobre a usuaria. Selecciona as usuarias ás que pode acceder, ou activa 'Todas as usuarias'.", + "allLibrariesHelp": "Ao activalo, o complemento terá acceso a todas as bibliotecas, incluíndo aquelas que se creen no futuro.", + "noLibraries": "Sen bibliotecas seleccionadas", + "librariesRequired": "O complemento precisa acceso á información sobre a biblioteca. Selecciona as bibliotecas ás que pode acceder, ou activa 'Todas as bibliotecas'.", + "requiredHosts": "Servidores requeridos", + "configValidationError": "Fallou a comprobación da configuración:", + "schemaRenderError": "Non se puido aplicar a configuración. O esquema do complemento podería non ser válido.", + "allowWriteAccessHelp": "A activalo, este complemento pode modificar ficheiros nos directorios da biblioteca. Por defecto os complementos teñen acceso de só-lectura." + }, + "placeholders": { + "configKey": "clave", + "configValue": "valor" } } }, @@ -419,7 +588,18 @@ "downloadDialogTitle": "Descargar %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Copiar ao portapapeis: Ctrl+C, Enter", "remove_missing_title": "Retirar ficheiros que faltan", - "remove_missing_content": "Tes certeza de querer retirar da base de datos os ficheiros que faltan? Isto retirará de xeito permanente todas a referencias a eles, incluíndo a conta de reproducións e valoracións." + "remove_missing_content": "Tes certeza de querer retirar da base de datos os ficheiros que faltan? Isto retirará de xeito permanente todas a referencias a eles, incluíndo a conta de reproducións e valoracións.", + "remove_all_missing_title": "Retirar todos os ficheiros que faltan", + "remove_all_missing_content": "Tes certeza de querer retirar da base de datos todos os ficheiros que faltan? Isto eliminará todas as referencias a eles, incluíndo o número de reproducións e valoracións.", + "noSimilarSongsFound": "Sen cancións parecidas", + "noTopSongsFound": "Sen cancións destacadas", + "startingInstantMix": "Cargando Mestura Súbita…", + "uploadCover": "Subir capa", + "removeCover": "Retirar capa", + "coverUploaded": "Subiuse a capa", + "coverRemoved": "Retirouse a capa", + "coverUploadError": "Erro ao subir a capa", + "coverRemoveError": "Erro ao retirar a capa" }, "menu": { "library": "Biblioteca", @@ -448,7 +628,13 @@ "albumList": "Álbums", "about": "Acerca de", "playlists": "Listas de reprodución", - "sharedPlaylists": "Listas compartidas" + "sharedPlaylists": "Listas compartidas", + "librarySelector": { + "allLibraries": "Todas as bibliotecas (%{count})", + "multipleLibraries": "%{selected} de %{total} Bibliotecas", + "selectLibraries": "Seleccionar Bibliotecas", + "none": "Ningunha" + } }, "player": { "playListsText": "Reproducir cola", @@ -485,6 +671,22 @@ "disabled": "Desactivado", "waiting": "Agardando" } + }, + "tabs": { + "about": "Sobre", + "config": "Configuración" + }, + "config": { + "configName": "Nome", + "environmentVariable": "Variable de entorno", + "currentValue": "Valor actual", + "configurationFile": "Ficheiro de configuración", + "exportToml": "Exportar configuración (TOML)", + "exportSuccess": "Configuración exportada ao portapapeis no formato TOML", + "exportFailed": "Fallou a copia da configuración", + "devFlagsHeader": "Configuracións de Desenvolvemento (suxeitas a cambio/retirada)", + "devFlagsComment": "Son axustes experimentais e poden retirarse en futuras versións", + "downloadToml": "Descargar configuración (TOML)" } }, "activity": { @@ -493,7 +695,11 @@ "quickScan": "Escaneo rápido", "fullScan": "Escaneo completo", "serverUptime": "Servidor a funcionar", - "serverDown": "SEN CONEXIÓN" + "serverDown": "SEN CONEXIÓN", + "scanType": "Tipo", + "status": "Erro de escaneado", + "elapsedTime": "Tempo transcurrido", + "selectiveScan": "Selectivo" }, "help": { "title": "Atallos de Navidrome", @@ -508,5 +714,10 @@ "toggle_love": "Engadir canción a favoritas", "current_song": "Ir á Canción actual " } + }, + "nowPlaying": { + "title": "En reprodución", + "empty": "Sen reprodución", + "minutesAgo": "hai %{smart_count} minuto |||| hai %{smart_count} minutos" } } \ No newline at end of file diff --git a/resources/i18n/hi.json b/resources/i18n/hi.json new file mode 100644 index 000000000..5b9ece530 --- /dev/null +++ b/resources/i18n/hi.json @@ -0,0 +1,630 @@ +{ + "languageName": "हिंदी", + "resources": { + "song": { + "name": "गाना |||| गाने", + "fields": { + "albumArtist": "एल्बम कलाकार", + "duration": "समय", + "trackNumber": "#", + "playCount": "प्ले संख्या", + "title": "शीर्षक", + "artist": "कलाकार", + "album": "एल्बम", + "path": "फ़ाइल पथ", + "libraryName": "लाइब्रेरी", + "genre": "शैली", + "compilation": "संकलन", + "year": "वर्ष", + "size": "फ़ाइल का आकार", + "updatedAt": "अपडेट किया गया", + "bitRate": "बिट रेट", + "bitDepth": "बिट गहराई", + "sampleRate": "सैंपल रेट", + "channels": "चैनल", + "discSubtitle": "डिस्क उपशीर्षक", + "starred": "पसंदीदा", + "comment": "टिप्पणी", + "rating": "रेटिंग", + "quality": "गुणवत्ता", + "bpm": "BPM", + "playDate": "अंतिम बार चलाया गया", + "createdAt": "जोड़ने की तारीख", + "grouping": "समूहीकरण", + "mood": "मूड", + "participants": "अतिरिक्त प्रतिभागी", + "tags": "अतिरिक्त टैग", + "mappedTags": "मैप किए गए टैग", + "rawTags": "रॉ टैग", + "missing": "गुम" + }, + "actions": { + "addToQueue": "बाद में चलाएं", + "playNow": "अभी चलाएं", + "addToPlaylist": "प्लेलिस्ट में जोड़ें", + "showInPlaylist": "प्लेलिस्ट में दिखाएं", + "shuffleAll": "सभी को शफल करें", + "download": "डाउनलोड", + "playNext": "अगला चलाएं", + "info": "जानकारी प्राप्त करें" + } + }, + "album": { + "name": "एल्बम |||| एल्बम", + "fields": { + "albumArtist": "एल्बम कलाकार", + "artist": "कलाकार", + "duration": "समय", + "songCount": "गाने", + "playCount": "प्ले संख्या", + "size": "आकार", + "name": "नाम", + "libraryName": "लाइब्रेरी", + "genre": "शैली", + "compilation": "संकलन", + "year": "वर्ष", + "date": "रिकॉर्डिंग की तारीख", + "originalDate": "मूल", + "releaseDate": "रिलीज़", + "releases": "रिलीज़ |||| रिलीज़", + "released": "रिलीज़ किया गया", + "updatedAt": "अपडेट किया गया", + "comment": "टिप्पणी", + "rating": "रेटिंग", + "createdAt": "जोड़ने की तारीख", + "recordLabel": "लेबल", + "catalogNum": "कैटलॉग नंबर", + "releaseType": "प्रकार", + "grouping": "समूहीकरण", + "media": "मीडिया", + "mood": "मूड", + "missing": "गुम" + }, + "actions": { + "playAll": "चलाएं", + "playNext": "अगला चलाएं", + "addToQueue": "बाद में चलाएं", + "share": "साझा करें", + "shuffle": "शफल", + "addToPlaylist": "प्लेलिस्ट में जोड़ें", + "download": "डाउनलोड", + "info": "जानकारी प्राप्त करें" + }, + "lists": { + "all": "सभी", + "random": "रैंडम", + "recentlyAdded": "हाल ही में जोड़े गए", + "recentlyPlayed": "हाल ही में चलाए गए", + "mostPlayed": "सबसे ज्यादा चलाए गए", + "starred": "पसंदीदा", + "topRated": "टॉप रेटेड" + } + }, + "artist": { + "name": "कलाकार |||| कलाकार", + "fields": { + "name": "नाम", + "albumCount": "एल्बम की संख्या", + "songCount": "गानों की संख्या", + "size": "आकार", + "playCount": "प्ले संख्या", + "rating": "रेटिंग", + "genre": "शैली", + "role": "भूमिका", + "missing": "गुम" + }, + "roles": { + "albumartist": "एल्बम कलाकार |||| एल्बम कलाकार", + "artist": "कलाकार |||| कलाकार", + "composer": "संगीतकार |||| संगीतकार", + "conductor": "संचालक |||| संचालक", + "lyricist": "गीतकार |||| गीतकार", + "arranger": "संयोजक |||| संयोजक", + "producer": "निर्माता |||| निर्माता", + "director": "निदेशक |||| निदेशक", + "engineer": "इंजीनियर |||| इंजीनियर", + "mixer": "मिक्सर |||| मिक्सर", + "remixer": "रीमिक्सर |||| रीमिक्सर", + "djmixer": "डीजे मिक्सर |||| डीजे मिक्सर", + "performer": "कलाकार |||| कलाकार", + "maincredit": "एल्बम कलाकार या कलाकार |||| एल्बम कलाकार या कलाकार" + }, + "actions": { + "topSongs": "टॉप गाने", + "shuffle": "शफल", + "radio": "रेडियो" + } + }, + "user": { + "name": "उपयोगकर्ता |||| उपयोगकर्ता", + "fields": { + "userName": "उपयोगकर्ता नाम", + "isAdmin": "एडमिन है", + "lastLoginAt": "अंतिम लॉगिन", + "lastAccessAt": "अंतिम पहुंच", + "updatedAt": "अपडेट किया गया", + "name": "नाम", + "password": "पासवर्ड", + "createdAt": "बनाया गया", + "changePassword": "पासवर्ड बदलें?", + "currentPassword": "वर्तमान पासवर्ड", + "newPassword": "नया पासवर्ड", + "token": "टोकन", + "libraries": "लाइब्रेरी" + }, + "helperTexts": { + "name": "आपके नाम में परिवर्तन केवल अगली लॉगिन पर प्रभावी होगा", + "libraries": "इस उपयोगकर्ता के लिए विशिष्ट लाइब्रेरी चुनें, या डिफ़ॉल्ट लाइब्रेरी का उपयोग करने के लिए खाली छोड़ें" + }, + "notifications": { + "created": "उपयोगकर्ता बनाया गया", + "updated": "उपयोगकर्ता अपडेट किया गया", + "deleted": "उपयोगकर्ता हटाया गया" + }, + "validation": { + "librariesRequired": "गैर-एडमिन उपयोगकर्ताओं के लिए कम से कम एक लाइब्रेरी चुननी होगी" + }, + "message": { + "listenBrainzToken": "अपना ListenBrainz उपयोगकर्ता टोकन दर्ज करें।", + "clickHereForToken": "अपना टोकन प्राप्त करने के लिए यहां क्लिक करें", + "selectAllLibraries": "सभी लाइब्रेरी चुनें", + "adminAutoLibraries": "एडमिन उपयोगकर्ताओं की सभी लाइब्रेरी तक स्वचालित पहुंच है" + } + }, + "player": { + "name": "प्लेयर |||| प्लेयर", + "fields": { + "name": "नाम", + "transcodingId": "ट्रांसकोडिंग", + "maxBitRate": "अधिकतम बिट रेट", + "client": "क्लाइंट", + "userName": "उपयोगकर्ता नाम", + "lastSeen": "अंतिम बार देखा गया", + "reportRealPath": "वास्तविक पथ रिपोर्ट करें", + "scrobbleEnabled": "बाहरी सेवाओं को स्क्रॉबल भेजें" + } + }, + "transcoding": { + "name": "ट्रांसकोडिंग |||| ट्रांसकोडिंग", + "fields": { + "name": "नाम", + "targetFormat": "लक्ष्य प्रारूप", + "defaultBitRate": "डिफ़ॉल्ट बिट रेट", + "command": "कमांड" + } + }, + "playlist": { + "name": "प्लेलिस्ट |||| प्लेलिस्ट", + "fields": { + "name": "नाम", + "duration": "अवधि", + "ownerName": "मालिक", + "public": "सार्वजनिक", + "updatedAt": "अपडेट किया गया", + "createdAt": "बनाया गया", + "songCount": "गाने", + "comment": "टिप्पणी", + "sync": "ऑटो-इंपोर्ट", + "path": "से इंपोर्ट करें" + }, + "actions": { + "selectPlaylist": "एक प्लेलिस्ट चुनें:", + "addNewPlaylist": "\"%{name}\" बनाएं", + "export": "निर्यात", + "saveQueue": "क्यू को प्लेलिस्ट में सेव करें", + "makePublic": "सार्वजनिक बनाएं", + "makePrivate": "निजी बनाएं", + "searchOrCreate": "प्लेलिस्ट खोजें या नई बनाने के लिए टाइप करें...", + "pressEnterToCreate": "नई प्लेलिस्ट बनाने के लिए Enter दबाएं", + "removeFromSelection": "चयन से हटाएं" + }, + "message": { + "duplicate_song": "डुप्लिकेट गाने जोड़ें", + "song_exist": "प्लेलिस्ट में डुप्लिकेट जोड़े जा रहे हैं। क्या आप डुप्लिकेट जोड़ना चाहते हैं या उन्हें छोड़ना चाहते हैं?", + "noPlaylistsFound": "कोई प्लेलिस्ट नहीं मिली", + "noPlaylists": "कोई प्लेलिस्ट उपलब्ध नहीं" + } + }, + "radio": { + "name": "रेडियो |||| रेडियो", + "fields": { + "name": "नाम", + "streamUrl": "स्ट्रीम URL", + "homePageUrl": "होम पेज URL", + "updatedAt": "अपडेट किया गया", + "createdAt": "बनाया गया" + }, + "actions": { + "playNow": "अभी चलाएं" + } + }, + "share": { + "name": "साझा |||| साझा", + "fields": { + "username": "द्वारा साझा किया गया", + "url": "URL", + "description": "विवरण", + "downloadable": "डाउनलोड की अनुमति दें?", + "contents": "सामग्री", + "expiresAt": "समाप्त होता है", + "lastVisitedAt": "अंतिम बार देखा गया", + "visitCount": "विज़िट", + "format": "प्रारूप", + "maxBitRate": "अधिकतम बिट रेट", + "updatedAt": "अपडेट किया गया", + "createdAt": "बनाया गया" + }, + "notifications": {}, + "actions": {} + }, + "missing": { + "name": "गुम फ़ाइल |||| गुम फ़ाइलें", + "empty": "कोई गुम फ़ाइल नहीं", + "fields": { + "path": "पथ", + "size": "आकार", + "libraryName": "लाइब्रेरी", + "updatedAt": "गायब हुई" + }, + "actions": { + "remove": "हटाएं", + "remove_all": "सभी हटाएं" + }, + "notifications": { + "removed": "गुम फ़ाइल(एं) हटा दी गईं" + } + }, + "library": { + "name": "लाइब्रेरी |||| लाइब्रेरी", + "fields": { + "name": "नाम", + "path": "पथ", + "remotePath": "रिमोट पथ", + "lastScanAt": "अंतिम स्कैन", + "songCount": "गाने", + "albumCount": "एल्बम", + "artistCount": "कलाकार", + "totalSongs": "गाने", + "totalAlbums": "एल्बम", + "totalArtists": "कलाकार", + "totalFolders": "फ़ोल्डर", + "totalFiles": "फ़ाइलें", + "totalMissingFiles": "गुम फ़ाइलें", + "totalSize": "कुल आकार", + "totalDuration": "अवधि", + "defaultNewUsers": "नए उपयोगकर्ताओं के लिए डिफ़ॉल्ट", + "createdAt": "बनाया गया", + "updatedAt": "अपडेट किया गया" + }, + "sections": { + "basic": "बुनियादी जानकारी", + "statistics": "आंकड़े" + }, + "actions": { + "scan": "लाइब्रेरी स्कैन करें", + "manageUsers": "उपयोगकर्ता पहुंच प्रबंधित करें", + "viewDetails": "विवरण देखें" + }, + "notifications": { + "created": "लाइब्रेरी सफलतापूर्वक बनाई गई", + "updated": "लाइब्रेरी सफलतापूर्वक अपडेट की गई", + "deleted": "लाइब्रेरी सफलतापूर्वक हटाई गई", + "scanStarted": "लाइब्रेरी स्कैन शुरू किया गया", + "scanCompleted": "लाइब्रेरी स्कैन पूरा हुआ" + }, + "validation": { + "nameRequired": "लाइब्रेरी का नाम आवश्यक है", + "pathRequired": "लाइब्रेरी पथ आवश्यक है", + "pathNotDirectory": "लाइब्रेरी पथ एक डायरेक्टरी होना चाहिए", + "pathNotFound": "लाइब्रेरी पथ नहीं मिला", + "pathNotAccessible": "लाइब्रेरी पथ पहुंच योग्य नहीं है", + "pathInvalid": "अमान्य लाइब्रेरी पथ" + }, + "messages": { + "deleteConfirm": "क्या आप वाकई इस लाइब्रेरी को हटाना चाहते हैं? इससे सभी संबंधित डेटा और उपयोगकर्ता पहुंच हट जाएगी।", + "scanInProgress": "स्कैन चल रहा है...", + "noLibrariesAssigned": "इस उपयोगकर्ता को कोई लाइब्रेरी असाइन नहीं की गई" + } + } + }, + "ra": { + "auth": { + "welcome1": "Navidrome इंस्टॉल करने के लिए धन्यवाद!", + "welcome2": "शुरू करने के लिए, एक एडमिन उपयोगकर्ता बनाएं", + "confirmPassword": "पासवर्ड की पुष्टि करें", + "buttonCreateAdmin": "एडमिन बनाएं", + "auth_check_error": "जारी रखने के लिए कृपया लॉगिन करें", + "user_menu": "प्रोफ़ाइल", + "username": "उपयोगकर्ता नाम", + "password": "पासवर्ड", + "sign_in": "साइन इन", + "sign_in_error": "प्रमाणीकरण विफल, कृपया पुनः प्रयास करें", + "logout": "लॉगआउट", + "insightsCollectionNote": "Navidrome परियोजना को बेहतर बनाने में मदद के लिए\nअज्ञात उपयोग डेटा एकत्र करता है। अधिक जानने\nऔर चाहें तो ऑप्ट-आउट करने के लिए [यहां] क्लिक करें" + }, + "validation": { + "invalidChars": "कृपया केवल अक्षर और संख्याओं का उपयोग करें।", + "passwordDoesNotMatch": "पासवर्ड मेल नहीं खाता।", + "required": "आवश्यक", + "minLength": "कम से कम %{min} अक्षर होने चाहिए", + "maxLength": "%{max} अक्षर या उससे कम होने चाहिए", + "minValue": "कम से कम %{min} होना चाहिए", + "maxValue": "%{max} या उससे कम होना चाहिए", + "number": "एक संख्या होनी चाहिए", + "email": "एक वैध ईमेल होना चाहिए", + "oneOf": "इनमें से एक होना चाहिए: %{options}", + "regex": "एक विशिष्ट प्रारूप से मेल खाना चाहिए (regexp): %{pattern}", + "unique": "अद्वितीय होना चाहिए", + "url": "एक वैध URL होना चाहिए" + }, + "action": { + "add_filter": "फ़िल्टर जोड़ें", + "add": "जोड़ें", + "back": "वापस जाएं", + "bulk_actions": "1 आइटम चुना गया |||| %{smart_count} आइटम चुने गए", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "cancel": "रद्द करें", + "clear_input_value": "मान साफ़ करें", + "clone": "क्लोन", + "confirm": "पुष्टि करें", + "create": "बनाएं", + "delete": "हटाएं", + "edit": "संपादित करें", + "export": "निर्यात", + "list": "सूची", + "refresh": "रीफ्रेश", + "remove_filter": "इस फ़िल्टर को हटाएं", + "remove": "हटाएं", + "save": "सेव करें", + "search": "खोजें", + "show": "दिखाएं", + "sort": "क्रमबद्ध करें", + "undo": "पूर्ववत करें", + "expand": "विस्तार करें", + "close": "बंद करें", + "open_menu": "मेनू खोलें", + "close_menu": "मेनू बंद करें", + "unselect": "चयन हटाएं", + "skip": "छोड़ें", + "share": "साझा करें", + "download": "डाउनलोड" + }, + "boolean": { + "true": "हां", + "false": "नहीं" + }, + "page": { + "create": "%{name} बनाएं", + "dashboard": "डैशबोर्ड", + "edit": "%{name} #%{id}", + "error": "कुछ गलत हुआ", + "list": "%{name}", + "loading": "लोड हो रहा है", + "not_found": "नहीं मिला", + "show": "%{name} #%{id}", + "empty": "अभी तक कोई %{name} नहीं।", + "invite": "क्या आप एक जोड़ना चाहते हैं?" + }, + "input": { + "file": { + "upload_several": "अपलोड करने के लिए कुछ फ़ाइलें छोड़ें, या चुनने के लिए क्लिक करें।", + "upload_single": "अपलोड करने के लिए एक फ़ाइल छोड़ें, या इसे चुनने के लिए क्लिक करें।" + }, + "image": { + "upload_several": "अपलोड करने के लिए कुछ तस्वीरें छोड़ें, या चुनने के लिए क्लिक करें।", + "upload_single": "अपलोड करने के लिए एक तस्वीर छोड़ें, या इसे चुनने के लिए क्लिक करें।" + }, + "references": { + "all_missing": "संदर्भ डेटा खोजने में असमर्थ।", + "many_missing": "संबंधित संदर्भों में से कम से कम एक अब उपलब्ध नहीं लगता।", + "single_missing": "संबंधित संदर्भ अब उपलब्ध नहीं लगता।" + }, + "password": { + "toggle_visible": "पासवर्ड छुपाएं", + "toggle_hidden": "पासवर्ड दिखाएं" + } + }, + "message": { + "about": "के बारे में", + "are_you_sure": "क्या आप सुनिश्चित हैं?", + "bulk_delete_content": "क्या आप वाकई इस %{name} को हटाना चाहते हैं? |||| क्या आप वाकई इन %{smart_count} आइटमों को हटाना चाहते हैं?", + "bulk_delete_title": "%{name} हटाएं |||| %{smart_count} %{name} हटाएं", + "delete_content": "क्या आप वाकई इस आइटम को हटाना चाहते हैं?", + "delete_title": "%{name} #%{id} हटाएं", + "details": "विवरण", + "error": "एक क्लाइंट त्रुटि हुई और आपका अनुरोध पूरा नहीं हो सका।", + "invalid_form": "फॉर्म मान्य नहीं है। कृपया त्रुटियों की जांच करें।", + "loading": "पेज लोड हो रहा है, कृपया एक क्षण प्रतीक्षा करें", + "no": "नहीं", + "not_found": "या तो आपने गलत URL टाइप किया है, या आपने गलत लिंक फॉलो किया है।", + "yes": "हां", + "unsaved_changes": "आपके कुछ बदलाव सेव नहीं हुए। क्या आप वाकई उन्हें नज़रअंदाज़ करना चाहते हैं?" + }, + "navigation": { + "no_results": "कोई परिणाम नहीं मिला", + "no_more_results": "पेज नंबर %{page} सीमा से बाहर है। पिछले पेज को आज़माएं।", + "page_out_of_boundaries": "पेज नंबर %{page} सीमा से बाहर", + "page_out_from_end": "अंतिम पेज के बाद नहीं जा सकते", + "page_out_from_begin": "पेज 1 से पहले नहीं जा सकते", + "page_range_info": "%{total} में से %{offsetBegin}-%{offsetEnd}", + "page_rows_per_page": "प्रति पेज आइटम:", + "next": "अगला", + "prev": "पिछला", + "skip_nav": "सामग्री पर जाएं" + }, + "notification": { + "updated": "एलिमेंट अपडेट किया गया |||| %{smart_count} एलिमेंट अपडेट किए गए", + "created": "एलिमेंट बनाया गया", + "deleted": "एलिमेंट हटाया गया |||| %{smart_count} एलिमेंट हटाए गए", + "bad_item": "गलत एलिमेंट", + "item_doesnt_exist": "एलिमेंट मौजूद नहीं है", + "http_error": "सर्वर संचार त्रुटि", + "data_provider_error": "dataProvider त्रुटि। विवरण के लिए कंसोल जांचें।", + "i18n_error": "निर्दिष्ट भाषा के लिए अनुवाद लोड नहीं हो सकते", + "canceled": "कार्रवाई रद्द की गई", + "logged_out": "आपका सत्र समाप्त हो गया है, कृपया फिर से कनेक्ट करें।", + "new_version": "नया संस्करण उपलब्ध! कृपया इस विंडो को रीफ्रेश करें।" + }, + "toggleFieldsMenu": { + "columnsToDisplay": "प्रदर्शित करने वाले कॉलम", + "layout": "लेआउट", + "grid": "ग्रिड", + "table": "टेबल" + } + }, + "message": { + "note": "नोट", + "transcodingDisabled": "सुरक्षा कारणों से वेब इंटरफेस के माध्यम से ट्रांसकोडिंग कॉन्फ़िगरेशन बदलना अक्षम है। यदि आप ट्रांसकोडिंग विकल्प बदलना (संपादित या जोड़ना) चाहते हैं, तो %{config} कॉन्फ़िगरेशन विकल्प के साथ सर्वर को पुनः आरंभ करें।", + "transcodingEnabled": "Navidrome वर्तमान में %{config} के साथ चल रहा है, जो वेब इंटरफेस का उपयोग करके ट्रांसकोडिंग सेटिंग्स से सिस्टम कमांड चलाना संभव बनाता है। हम सुरक्षा कारणों से इसे अक्षम करने और केवल ट्रांसकोडिंग विकल्प कॉन्फ़िगर करते समय इसे सक्षम करने की सलाह देते हैं।", + "songsAddedToPlaylist": "प्लेलिस्ट में 1 गाना जोड़ा गया |||| प्लेलिस्ट में %{smart_count} गाने जोड़े गए", + "noSimilarSongsFound": "कोई समान गाने नहीं मिले", + "noTopSongsFound": "कोई टॉप गाने नहीं मिले", + "noPlaylistsAvailable": "कोई उपलब्ध नहीं", + "delete_user_title": "उपयोगकर्ता '%{name}' को हटाएं", + "delete_user_content": "क्या आप वाकई इस उपयोगकर्ता और उनके सभी डेटा (प्लेलिस्ट और प्राथमिकताओं सहित) को हटाना चाहते हैं?", + "remove_missing_title": "गुम फ़ाइलें हटाएं", + "remove_missing_content": "क्या आप वाकई चयनित गुम फ़ाइलों को डेटाबेस से हटाना चाहते हैं? इससे उनके सभी संदर्भ स्थायी रूप से हट जाएंगे, जिसमें उनकी प्ले काउंट और रेटिंग शामिल है।", + "remove_all_missing_title": "सभी गुम फ़ाइलें हटाएं", + "remove_all_missing_content": "क्या आप वाकई सभी गुम फ़ाइलों को डेटाबेस से हटाना चाहते हैं? इससे उनके सभी संदर्भ स्थायी रूप से हट जाएंगे, जिसमें उनकी प्ले काउंट और रेटिंग शामिल है।", + "notifications_blocked": "आपने अपने ब्राउज़र की सेटिंग्स में इस साइट के लिए सूचनाएं ब्लॉक की हैं।", + "notifications_not_available": "यह ब्राउज़र डेस्कटॉप सूचनाओं का समर्थन नहीं करता या आप https पर Navidrome का उपयोग नहीं कर रहे।", + "lastfmLinkSuccess": "Last.fm सफलतापूर्वक लिंक किया गया और स्क्रॉबलिंग सक्षम की गई", + "lastfmLinkFailure": "Last.fm लिंक नहीं हो सका", + "lastfmUnlinkSuccess": "Last.fm अनलिंक किया गया और स्क्रॉबलिंग अक्षम की गई", + "lastfmUnlinkFailure": "Last.fm अनलिंक नहीं हो सका", + "listenBrainzLinkSuccess": "ListenBrainz सफलतापूर्वक लिंक किया गया और उपयोगकर्ता के रूप में स्क्रॉबलिंग सक्षम की गई: %{user}", + "listenBrainzLinkFailure": "ListenBrainz लिंक नहीं हो सका: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz अनलिंक किया गया और स्क्रॉबलिंग अक्षम की गई", + "listenBrainzUnlinkFailure": "ListenBrainz अनलिंक नहीं हो सका", + "openIn": { + "lastfm": "Last.fm में खोलें", + "musicbrainz": "MusicBrainz में खोलें" + }, + "lastfmLink": "और पढ़ें...", + "shareOriginalFormat": "मूल प्रारूप में साझा करें", + "shareDialogTitle": "%{resource} '%{name}' साझा करें", + "shareBatchDialogTitle": "1 %{resource} साझा करें |||| %{smart_count} %{resource} साझा करें", + "shareCopyToClipboard": "क्लिपबोर्ड में कॉपी करें: Ctrl+C, Enter", + "shareSuccess": "URL क्लिपबोर्ड में कॉपी किया गया: %{url}", + "shareFailure": "URL %{url} को क्लिपबोर्ड में कॉपी करने में त्रुटि", + "downloadDialogTitle": "%{resource} '%{name}' (%{size}) डाउनलोड करें", + "downloadOriginalFormat": "मूल प्रारूप में डाउनलोड करें" + }, + "menu": { + "library": "लाइब्रेरी", + "librarySelector": { + "allLibraries": "सभी लाइब्रेरी (%{count})", + "multipleLibraries": "%{total} में से %{selected} लाइब्रेरी", + "selectLibraries": "लाइब्रेरी चुनें", + "none": "कोई नहीं" + }, + "settings": "सेटिंग्स", + "version": "संस्करण", + "theme": "थीम", + "personal": { + "name": "व्यक्तिगत", + "options": { + "theme": "थीम", + "language": "भाषा", + "defaultView": "डिफ़ॉल्ट दृश्य", + "desktop_notifications": "डेस्कटॉप सूचनाएं", + "lastfmNotConfigured": "Last.fm API-Key कॉन्फ़िगर नहीं है", + "lastfmScrobbling": "Last.fm में स्क्रॉबल करें", + "listenBrainzScrobbling": "ListenBrainz में स्क्रॉबल करें", + "replaygain": "ReplayGain मोड", + "preAmp": "ReplayGain PreAmp (dB)", + "gain": { + "none": "अक्षम", + "album": "एल्बम गेन का उपयोग करें", + "track": "ट्रैक गेन का उपयोग करें" + } + } + }, + "albumList": "एल्बम", + "playlists": "प्लेलिस्ट", + "sharedPlaylists": "साझा की गई प्लेलिस्ट", + "about": "के बारे में" + }, + "player": { + "playListsText": "प्ले क्यू", + "openText": "खोलें", + "closeText": "बंद करें", + "notContentText": "कोई संगीत नहीं", + "clickToPlayText": "चलाने के लिए क्लिक करें", + "clickToPauseText": "रोकने के लिए क्लिक करें", + "nextTrackText": "अगला ट्रैक", + "previousTrackText": "पिछला ट्रैक", + "reloadText": "रीलोड", + "volumeText": "वॉल्यूम", + "toggleLyricText": "गीत टॉगल करें", + "toggleMiniModeText": "मिनिमाइज़ करें", + "destroyText": "नष्ट करें", + "downloadText": "डाउनलोड", + "removeAudioListsText": "ऑडियो सूची हटाएं", + "clickToDeleteText": "%{name} को हटाने के लिए क्लिक करें", + "emptyLyricText": "कोई गीत नहीं", + "playModeText": { + "order": "क्रम में", + "orderLoop": "दोहराएं", + "singleLoop": "एक दोहराएं", + "shufflePlay": "शफल" + } + }, + "about": { + "links": { + "homepage": "होम पेज", + "source": "सोर्स कोड", + "featureRequests": "फीचर अनुरोध", + "lastInsightsCollection": "अंतिम अंतर्दृष्टि संग्रह", + "insights": { + "disabled": "अक्षम", + "waiting": "प्रतीक्षा में" + } + }, + "tabs": { + "about": "के बारे में", + "config": "कॉन्फ़िगरेशन" + }, + "config": { + "configName": "कॉन्फ़िग नाम", + "environmentVariable": "पर्यावरण चर", + "currentValue": "वर्तमान मान", + "configurationFile": "कॉन्फ़िगरेशन फ़ाइल", + "exportToml": "कॉन्फ़िगरेशन निर्यात करें (TOML)", + "exportSuccess": "कॉन्फ़िगरेशन TOML प्रारूप में क्लिपबोर्ड में निर्यात किया गया", + "exportFailed": "कॉन्फ़िगरेशन कॉपी करने में विफल", + "devFlagsHeader": "विकास फ्लैग (परिवर्तन/हटाने के अधीन)", + "devFlagsComment": "ये प्रयोगात्मक सेटिंग्स हैं और भविष्य के संस्करणों में हटाई जा सकती हैं" + } + }, + "activity": { + "title": "गतिविधि", + "totalScanned": "कुल स्कैन किए गए फ़ोल्डर", + "quickScan": "त्वरित स्कैन", + "fullScan": "पूर्ण स्कैन", + "serverUptime": "सर्वर अपटाइम", + "serverDown": "ऑफलाइन", + "scanType": "प्रकार", + "status": "स्कैन त्रुटि", + "elapsedTime": "बीता समय" + }, + "nowPlaying": { + "title": "अभी चल रहा है", + "empty": "कुछ नहीं चल रहा", + "minutesAgo": "%{smart_count} मिनट पहले |||| %{smart_count} मिनट पहले" + }, + "help": { + "title": "Navidrome हॉटकीज़", + "hotkeys": { + "show_help": "यह सहायता दिखाएं", + "toggle_menu": "मेनू साइड बार टॉगल करें", + "toggle_play": "चलाएं / रोकें", + "prev_song": "पिछला गाना", + "next_song": "अगला गाना", + "current_song": "वर्तमान गाने पर जाएं", + "vol_up": "वॉल्यूम बढ़ाएं", + "vol_down": "वॉल्यूम कम करें", + "toggle_love": "इस ट्रैक को पसंदीदा में जोड़ें" + } + } +} diff --git a/resources/i18n/hu.json b/resources/i18n/hu.json index edee39e38..ce3d5ae87 100644 --- a/resources/i18n/hu.json +++ b/resources/i18n/hu.json @@ -10,8 +10,10 @@ "playCount": "Lejátszások", "title": "Cím", "artist": "Előadó", + "composer": "Zeneszerző", "album": "Album", "path": "Elérési út", + "libraryName": "Könyvtár", "genre": "Műfaj", "compilation": "Válogatásalbum", "year": "Év", @@ -20,6 +22,7 @@ "bitRate": "Bitráta", "bitDepth": "Bitmélység", "sampleRate": "Mintavételezési frekvencia", + "disc": "Lemez %{discNumber}", "discSubtitle": "Lemezfelirat", "starred": "Kedvenc", "comment": "Megjegyzés", @@ -34,16 +37,19 @@ "participants": "További résztvevők", "tags": "További címkék", "mappedTags": "Feldolgozott címkék", - "rawTags": "Nyers címkék" + "rawTags": "Nyers címkék", + "missing": "Hiányzó" }, "actions": { "addToQueue": "Lejátszás útolsóként", "playNow": "Lejátszás", "addToPlaylist": "Lejátszási listához adás", + "showInPlaylist": "Megjelenítés a lejátszási listában", "shuffleAll": "Keverés", "download": "Letöltés", "playNext": "Lejátszás következőként", - "info": "Részletek" + "info": "Részletek", + "instantMix": "Instant keverés" } }, "album": { @@ -55,6 +61,7 @@ "songCount": "Számok", "playCount": "Lejátszások", "name": "Név", + "libraryName": "Könyvtár", "genre": "Stílus", "compilation": "Válogatásalbum", "year": "Év", @@ -73,7 +80,8 @@ "releaseType": "Típus", "grouping": "Csoportosítás", "media": "Média", - "mood": "Hangulat" + "mood": "Hangulat", + "missing": "Hiányzó" }, "actions": { "playAll": "Lejátszás", @@ -105,7 +113,8 @@ "rating": "Értékelés", "genre": "Stílus", "size": "Méret", - "role": "Szerep" + "role": "Szerep", + "missing": "Hiányzó" }, "roles": { "albumartist": "Album előadó |||| Album előadók", @@ -120,7 +129,13 @@ "mixer": "Keverő |||| Keverők", "remixer": "Átdolgozó |||| Átdolgozók", "djmixer": "DJ keverő |||| DJ keverők", - "performer": "Előadóművész |||| Előadóművészek" + "performer": "Előadóművész |||| Előadóművészek", + "maincredit": "Album előadó vagy előadó |||| Album előadók vagy előadók" + }, + "actions": { + "topSongs": "Top számok", + "shuffle": "Keverés", + "radio": "Rádió" } }, "user": { @@ -137,19 +152,26 @@ "currentPassword": "Jelenlegi jelszó", "newPassword": "Új jelszó", "token": "Token", - "lastAccessAt": "Utolsó elérés" + "lastAccessAt": "Utolsó elérés", + "libraries": "Könyvtárak" }, "helperTexts": { - "name": "A névváltoztatások csak a következő bejelentkezéskor jelennek meg" + "name": "A névváltoztatások csak a következő bejelentkezéskor jelennek meg", + "libraries": "Válassz könyvtárakat ehhez a felhasználóhoz vagy ne jelölj be egyet sem, az alapértelmezett könyvtárak használatához" }, "notifications": { "created": "Felhasználó létrehozva", "updated": "Felhasználó frissítve", "deleted": "Felhasználó törölve" }, + "validation": { + "librariesRequired": "Legalább egy könyvtárat ki kell választani nem admin felhasználókhoz" + }, "message": { "listenBrainzToken": "Add meg a ListenBrainz felhasználó tokened.", - "clickHereForToken": "Kattints ide, hogy megszerezd a tokened" + "clickHereForToken": "Kattints ide, hogy megszerezd a tokened", + "selectAllLibraries": "Minden könyvtár kiválasztása", + "adminAutoLibraries": "Minden admin felhasználó hozzáfér bármely könyvtárhoz" } }, "player": { @@ -194,11 +216,16 @@ "export": "Exportálás", "saveQueue": "Műsorlista elmentése lejátszási listaként", "makePublic": "Publikussá tétel", - "makePrivate": "Priváttá tétel" + "makePrivate": "Priváttá tétel", + "searchOrCreate": "Keress lejátszási listák között vagy hozz létre egyet...", + "pressEnterToCreate": "Nyomj Entert, hogy létrehozz egy lejátszási listát", + "removeFromSelection": "Eltávolítás a kiválasztásból" }, "message": { "duplicate_song": "Duplikált számok hozzáadása", - "song_exist": "Egyes számok már hozzá vannak adva a listához. Még egyszer hozzá akarod adni?" + "song_exist": "Egyes számok már hozzá vannak adva a listához. Még egyszer hozzá akarod adni?", + "noPlaylistsFound": "Nem található lejátszási lista", + "noPlaylists": "Nincsenek lejátszási listák" } }, "radio": { @@ -237,6 +264,7 @@ "fields": { "path": "Útvonal", "size": "Méret", + "libraryName": "Könyvtár", "updatedAt": "Eltűnt ekkor:" }, "actions": { @@ -246,6 +274,136 @@ "notifications": { "removed": "Hiányzó fájl(ok) eltávolítva" } + }, + "library": { + "name": "Könyvtár |||| Könyvtárak", + "fields": { + "name": "Név", + "path": "Elérési út", + "remotePath": "Távoli elérési út", + "lastScanAt": "Legutóbbi szkennelés", + "songCount": "Számok", + "albumCount": "Albumok", + "artistCount": "Előadók", + "totalSongs": "Számok", + "totalAlbums": "Albumok", + "totalArtists": "Előadók", + "totalFolders": "Mappák", + "totalFiles": "Fájlok", + "totalMissingFiles": "Hiányzó fájlok", + "totalSize": "Teljes méret", + "totalDuration": "Hossz", + "defaultNewUsers": "Alapértelmezett könyvtár új felhasználóknak", + "createdAt": "Létrehozva", + "updatedAt": "Frissítve" + }, + "sections": { + "basic": "Alapinformációk", + "statistics": "Statisztikák" + }, + "actions": { + "scan": "Könyvtár szkennelése", + "quickScan": "Gyors szkennelés", + "fullScan": "Teljes szkennelés", + "manageUsers": "Hozzáférés kezelése", + "viewDetails": "Részletek" + }, + "notifications": { + "created": "Könyvtár létrehozva", + "updated": "Könyvtár frissítve", + "deleted": "Könyvtár törölve", + "scanStarted": "Szkennelés folyamatban", + "scanCompleted": "Könyvtár szkennelés befelyezve" + }, + "validation": { + "nameRequired": "Adj meg egy könyvtárnevet", + "pathRequired": "Adj meg egy útvonalat", + "pathNotDirectory": "A könyvtárútvonalnak egy mappának kell lennie", + "pathNotFound": "A könyvtár útvonala nem található", + "pathNotAccessible": "A könyvtár útvonala nem elérhető", + "pathInvalid": "Helytelen könyvtár útvonal" + }, + "messages": { + "deleteConfirm": "Biztosan törlöd ezt a könyvtárt? Minden adata törlődni fog és elérhetetlenné válik.", + "scanInProgress": "Szkennelés folyamatban...", + "noLibrariesAssigned": "Ehhez a felhasználóhoz nincsenek könyvtárak adva" + } + }, + "plugin": { + "name": "Kiegészítő |||| Kiegészítők", + "fields": { + "id": "ID", + "name": "Név", + "description": "Leírás", + "version": "Verzió", + "author": "Fejlesztő", + "website": "Weboldal", + "permissions": "Engedélyek", + "enabled": "Engedélyezve", + "status": "Státusz", + "path": "Útvonal", + "lastError": "Hiba", + "hasError": "Hiba", + "updatedAt": "Frissítve", + "createdAt": "Telepítve", + "configKey": "Kulcs", + "configValue": "Érték", + "allUsers": "Összes felhasználó engedélyezése", + "selectedUsers": "Kiválasztott felhasználók engedélyezése", + "allLibraries": "Összes könyvtár engedélyezése", + "selectedLibraries": "Kiválasztott könyvtárak engedélyezése", +"allowWriteAccess": "Írási hozzáférés engedélyezése" + }, + "sections": { + "status": "Státusz", + "info": "Kiegészítő információi", + "configuration": "Konfiguráció", + "manifest": "Manifest", + "usersPermission": "Felhasználói engedélyek", + "libraryPermission": "Könyvtári engedélyek" + }, + "status": { + "enabled": "Engedélyezve", + "disabled": "Letiltva" + }, + "actions": { + "enable": "Engedélyezés", + "disable": "Letiltás", + "disabledDueToError": "Javítsd ki a kiegészítő hibáját", + "disabledUsersRequired": "Válassz felhasználókat", + "disabledLibrariesRequired": "Válassz könyvtárakat", + "addConfig": "Konfiguráció hozzáadása", + "rescan": "Újraszkennelés" + }, + "notifications": { + "enabled": "Kiegészítő engedélyezve", + "disabled": "Kiegészítő letiltva", + "updated": "Kiegészítő frissítve", + "error": "Hiba történt a kiegészítő frissítése közben" + }, + "validation": { + "invalidJson": "A konfigurációs JSON érvénytelen" + }, + "messages": { + "configHelp": "Konfiguráld a kiegészítőt kulcs-érték párokkal. Hagyd a mezőt üresen, ha nincs szükség konfigurációra.", + "configValidationError": "Helytelen konfiguráció:", + "schemaRenderError": "Nem sikerült megjeleníteni a konfigurációs űrlapot. A bővítmény sémája érvénytelen lehet.", + "clickPermissions": "Kattints egy engedélyre a részletekért", + "noConfig": "Nincs konfiguráció beállítva", + "allUsersHelp": "Engedélyezés esetén ez a kiegészítő hozzá fog férni minden jelenlegi és jövőben létrehozott felhasználóhoz.", + "noUsers": "Nincsenek kiválasztott felhasználók", + "permissionReason": "Indok", + "usersRequired": "Ez a kiegészítő hozzáférést kér felhasználói információkhoz. Válaszd ki, melyik felhasználókat érheti el, vagy az 'Összes felhasználó engedélyezése' opciót.", + "allLibrariesHelp": "Engedélyezés esetén ez a kiegészítő hozzá fog férni minden jelenlegi és jövőben létrehozott könyvtárhoz.", + "noLibraries": "Nincs kiválasztott könyvtár", + "librariesRequired": "Ez a kiegészítő hozzáférést kér könyvtárinformációkhoz. Válaszd ki, melyik könyvtárakat érheti el, vagy az 'Összes könyvtár engedélyezése' opciót.", +"allowWriteAccessHelp": "Amikor ez engedélyezve van, a kiegészítő módosíthatja a könyvtár mappáit. Alapbeállításon a kiegészítőknek csak olvasási joguk van.", + "requiredHosts": "Szükséges hostok" + }, + "placeholders": { + "configKey": "kulcs", + "configValue": "érték" + } } }, "ra": { @@ -323,7 +481,7 @@ "loading": "Betöltés", "not_found": "Nem található", "show": "%{name} #%{id}", - "empty": "Nincs %{name} még.", + "empty": "Nincsenek %{name}.", "invite": "Szeretnél egyet hozzáadni?" }, "input": { @@ -394,10 +552,19 @@ } }, "message": { + "uploadCover": "Borítókép feltöltése", + "removeCover": "Borítókép törlése", + "coverUploaded": "Borítókép feltöltve", + "coverRemoved": "Borítókép eltávolítva", + "coverUploadError": "Borítókép feltöltése sikertelen", + "coverRemoveError": "Borítókép törlése sikertelen", "note": "MEGJEGYZÉS", "transcodingDisabled": "Az átkódolási konfiguráció módosítása a webes felületen keresztül biztonsági okokból nem lehetséges. Ha módosítani szeretnéd az átkódolási beállításokat, indítsd újra a kiszolgálót a %{config} konfigurációs opcióval.", "transcodingEnabled": "A Navidrome jelenleg a következőkkel fut %{config}, ez lehetővé teszi a rendszerparancsok futtatását az átkódolási beállításokból a webes felület segítségével. Javasoljuk, hogy biztonsági okokból tiltsd ezt le, és csak az átkódolási beállítások konfigurálásának idejére kapcsold be.", "songsAddedToPlaylist": "1 szám hozzáadva a lejátszási listához |||| %{smart_count} szám hozzáadva a lejátszási listához", + "noSimilarSongsFound": "Nem találhatóak hasonló számok", + "startingInstantMix": "Instant keverés töltődik...", + "noTopSongsFound": "Nincsenek top számok", "noPlaylistsAvailable": "Nem áll rendelkezésre", "delete_user_title": "Felhasználó törlése '%{name}'", "delete_user_content": "Biztos, hogy törölni akarod ezt a felhasználót az adataival (beállítások és lejátszási listák) együtt?", @@ -431,6 +598,12 @@ }, "menu": { "library": "Könyvtár", + "librarySelector": { + "allLibraries": "Minden %{count} könyvtár", + "multipleLibraries": "%{selected} kiválasztva %{total} könyvtárból", + "selectLibraries": "Kiválasztott kőnyvtárak", + "none": "Semmi" + }, "settings": "Beállítások", "version": "Verzió", "theme": "Téma", @@ -493,19 +666,41 @@ "disabled": "Kikapcsolva", "waiting": "Várakozás" } + }, + "tabs": { + "about": "Rólunk", + "config": "Konfiguráció" + }, + "config": { + "configName": "Beállítás neve", + "environmentVariable": "Környezeti változó", + "currentValue": "Jelenlegi érték", + "configurationFile": "Konfigurációs fájl", + "exportToml": "Konfiguráció exportálása (TOML)", + "downloadToml": "Konfiguráció letöltése (TOML)", + "exportSuccess": "Konfiguráció kiexportálva a vágólapra, TOML formában", + "exportFailed": "Nem sikerült kimásolni a konfigurációt", + "devFlagsHeader": "Fejlesztői beállítások (változások/eltávolítás jogát fenntartjuk)", + "devFlagsComment": "Ezek kísérleti beállítások, és a jövőbeli verziókban eltávolíthatók" } }, "activity": { "title": "Aktivitás", "totalScanned": "Összes beolvasott mappa:", - "quickScan": "Gyors beolvasás", - "fullScan": "Teljes beolvasás", + "quickScan": "Gyors", + "fullScan": "Teljes", + "selectiveScan": "Szelektív", "serverUptime": "Szerver üzemidő", "serverDown": "OFFLINE", - "scanType": "Típus", + "scanType": "Legutóbbi szkennelés", "status": "Szkennelési hiba", "elapsedTime": "Eltelt idő" }, + "nowPlaying": { + "title": "Most megy", + "empty": "Nem hallgatsz semmit", + "minutesAgo": "%{smart_count} perce |||| %{smart_count} perce" + }, "help": { "title": "Navidrome Gyorsbillentyűk", "hotkeys": { diff --git a/resources/i18n/id.json b/resources/i18n/id.json index 3269b37b1..762ce4ebb 100644 --- a/resources/i18n/id.json +++ b/resources/i18n/id.json @@ -32,7 +32,15 @@ "participants": "Partisipan tambahan", "tags": "Tag tambahan", "mappedTags": "Tag yang dipetakan", - "rawTags": "Tag raw" + "rawTags": "Tag raw", + "bitDepth": "Bit depth", + "sampleRate": "Sample rate", + "missing": "Hilang", + "libraryName": "Pustaka", + "composer": "Komposer", + "disc": "Disk %{discNumber}", + "albumGain": "Album gain", + "trackGain": "Trek gain" }, "actions": { "addToQueue": "Tambah ke antrean", @@ -41,7 +49,9 @@ "shuffleAll": "Acak Semua", "download": "Unduh", "playNext": "Putar Berikutnya", - "info": "Lihat Info" + "info": "Lihat Info", + "showInPlaylist": "Tampilkan di Playlist", + "instantMix": "Mix Instan" } }, "album": { @@ -70,7 +80,10 @@ "releaseType": "Tipe", "grouping": "Pengelompokkan", "media": "Media", - "mood": "Mood" + "mood": "Mood", + "date": "Tanggal Perekaman", + "missing": "Hilang", + "libraryName": "Pustaka" }, "actions": { "playAll": "Putar", @@ -102,7 +115,8 @@ "rating": "Peringkat", "genre": "Genre", "size": "Ukuran", - "role": "Peran" + "role": "Peran", + "missing": "Hilang" }, "roles": { "albumartist": "Artis Album |||| Artis Album", @@ -117,7 +131,13 @@ "mixer": "Mixer |||| Mixer", "remixer": "Remixer |||| Remixer", "djmixer": "DJ Mixer |||| Dj Mixer", - "performer": "Performer |||| Performer" + "performer": "Performer |||| Performer", + "maincredit": "Artis Album atau Artis |||| Artis Album or Artis" + }, + "actions": { + "shuffle": "Acak", + "radio": "Radio", + "topSongs": "Lagu Teratas" } }, "user": { @@ -134,10 +154,12 @@ "currentPassword": "Kata Sandi Sebelumnya", "newPassword": "Kata Sandi Baru", "token": "Token", - "lastAccessAt": "Terakhir Diakses" + "lastAccessAt": "Terakhir Diakses", + "libraries": "Perpustakaan" }, "helperTexts": { - "name": "Perubahan pada nama Kamu akan terlihat pada login berikutnya" + "name": "Perubahan pada nama Kamu akan terlihat pada login berikutnya", + "libraries": "Pilih pustaka yang ditentukan untuk pengguna ini, atau biarkan kosong untuk menggunakan pustaka default" }, "notifications": { "created": "Pengguna dibuat", @@ -146,7 +168,12 @@ }, "message": { "listenBrainzToken": "Masukkan token pengguna ListenBrainz Kamu.", - "clickHereForToken": "Klik di sini untuk mendapatkan token baru anda" + "clickHereForToken": "Klik di sini untuk mendapatkan token baru anda", + "selectAllLibraries": "Pilih semua pustaka", + "adminAutoLibraries": "Pengguna admin otomatis langsung memiliki akses ke semua perpustakaan" + }, + "validation": { + "librariesRequired": "Setidaknya satu pustaka harus dipilih untuk pengguna non-admin" } }, "player": { @@ -163,7 +190,7 @@ } }, "transcoding": { - "name": "Transkode |||| Transkode", + "name": "Transkoding |||| Transkoding", "fields": { "name": "Nama", "targetFormat": "Target Format", @@ -190,11 +217,17 @@ "addNewPlaylist": "Buat \"%{name}\"", "export": "Ekspor", "makePublic": "Jadikan Publik", - "makePrivate": "Jadikan Pribadi" + "makePrivate": "Jadikan Pribadi", + "saveQueue": "Simpan Antrean ke Playlist", + "searchOrCreate": "Cari playlist atau ketik untuk buat baru..", + "pressEnterToCreate": "Tekan Enter untuk membuat playlist baru", + "removeFromSelection": "Hapus yang dipilih" }, "message": { "duplicate_song": "Tambahkan lagu duplikat", - "song_exist": "Ada lagu duplikat yang ditambahkan ke daftar putar. Apakah Kamu ingin menambahkan lagu duplikat atau melewatkannya?" + "song_exist": "Ada lagu duplikat yang ditambahkan ke daftar putar. Apakah Kamu ingin menambahkan lagu duplikat atau melewatkannya?", + "noPlaylistsFound": "Playlist tidak ditemukan", + "noPlaylists": "Playlist tidak tersedia" } }, "radio": { @@ -232,13 +265,149 @@ "fields": { "path": "Jalur", "size": "Ukuran", - "updatedAt": "Tidak muncul di" + "updatedAt": "Tidak muncul di", + "libraryName": "Pustaka" }, "actions": { - "remove": "Hapus" + "remove": "Hapus", + "remove_all": "Hapus Semua" }, "notifications": { "removed": "File yang hilang dihapus" + }, + "empty": "Tidak ada File yang Hilang" + }, + "library": { + "name": "Pustaka |||| Perpustakaan", + "fields": { + "name": "Nama", + "path": "Jalur", + "remotePath": "Jalur Remote", + "lastScanAt": "Terakhir Dipindai", + "songCount": "Lagu", + "albumCount": "Album", + "artistCount": "Artis", + "totalSongs": "Lagu", + "totalAlbums": "Album", + "totalArtists": "Artis", + "totalFolders": "Folder", + "totalFiles": "File", + "totalMissingFiles": "File hilang", + "totalSize": "Ukuran Total", + "totalDuration": "Durasi", + "defaultNewUsers": "Default untuk Pengguna Baru", + "createdAt": "Dibuat", + "updatedAt": "Diperbarui" + }, + "sections": { + "basic": "Informasi Dasar", + "statistics": "Statistik" + }, + "actions": { + "scan": "Pindai Pustaka", + "manageUsers": "Kelola Akses Pengguna", + "viewDetails": "Lihat Detail", + "quickScan": "Pindai Cepat", + "fullScan": "Pindai Keseluruhan" + }, + "notifications": { + "created": "Pustaka berhasil dibuat", + "updated": "Pustaka berhasil dibuat", + "deleted": "Berhasil menghapus pustaka", + "scanStarted": "Memindai pustaka dimulai", + "scanCompleted": "Memindai pustaka selesai", + "quickScanStarted": "Pemindaian cepat dimulai", + "fullScanStarted": "Pemindaian keseluruhan dimulai", + "scanError": "Kesalahan saat memulai pemindaian. Periksa log" + }, + "validation": { + "nameRequired": "Nama pustaka diperlukan", + "pathRequired": "Lokasi pustaka diperlukan", + "pathNotDirectory": "Lokasi pustaka harus ada di direktori", + "pathNotFound": "Lokasi pustaka tidak ditemukan", + "pathNotAccessible": "Lokasi pustaka tidak dapat diakses", + "pathInvalid": "Lokasi pustaka tidak valid" + }, + "messages": { + "deleteConfirm": "Kamu yakin ingin menghapus pustaka ini? Ini akan menghapus semua data yang terkait dan akses pengguna.", + "scanInProgress": "Pemindaian sedang berlangsung...", + "noLibrariesAssigned": "Tidak ada pustaka yang ditugaskan ke pengguna ini" + } + }, + "plugin": { + "name": "Plugin |||| Plugin", + "fields": { + "id": "ID", + "name": "Nama", + "description": "Deskripsi", + "version": "Versi", + "author": "Pembuat", + "website": "Situs Web", + "permissions": "Perizinan", + "enabled": "Diaktifkan", + "status": "Status", + "path": "Jalur", + "lastError": "Kesalahan", + "hasError": "Kesalahan", + "updatedAt": "Diperbarui", + "createdAt": "Terinstal", + "configKey": "Key", + "configValue": "Value", + "allUsers": "Izinkan semua pengguna", + "selectedUsers": "Pengguna yang dipilih", + "allLibraries": "Izinkan semua pustaka", + "selectedLibraries": "Pustaka dipilih", + "allowWriteAccess": "Izinkan akses tulis" + }, + "sections": { + "status": "Status", + "info": "Informasi plugin", + "configuration": "Konfigurasi", + "manifest": "Manifes", + "usersPermission": "Pengguna yang Diizinkan", + "libraryPermission": "Pustaka yang Diizinkan" + }, + "status": { + "enabled": "Diaktifkan", + "disabled": "Dinonaktifkan" + }, + "actions": { + "enable": "Aktifkan", + "disable": "Nonaktifkan", + "disabledDueToError": "Perbaiki kesalahan sebelum diaktifkan", + "disabledUsersRequired": "Pilih pengguna sebelum diaktifkan", + "disabledLibrariesRequired": "Pilih pustaka sebelum diaktifkan", + "addConfig": "Tambahkan Konfigurasi", + "rescan": "Pindai ulang" + }, + "notifications": { + "enabled": "Plugin diaktifkan", + "disabled": "Plugin dinonaktifkan", + "updated": "Plugin diperbarui", + "error": "Kesalahan saat memperbarui plugin" + }, + "validation": { + "invalidJson": "Konfigurasi harus berupa JSON yang valid" + }, + "messages": { + "configHelp": "Konfigurasikan plugin menggunakan key-value pairs. Biarkan kosong jika plugin tidak membutuhkan konfigurasi.", + "clickPermissions": "Klik perizinan untuk detail", + "noConfig": "Konfigurasi tidak diatur", + "allUsersHelp": "Ketika diaktifkan, plugin akan mengakses untuk semua pengguna, termasuk yang akan dibuat di masa depan.", + "noUsers": "Tidak ada pengguna yang dipilih", + "permissionReason": "Alasan", + "usersRequired": "Plugin ini membutuhkan akses ke informasi pengguna. Pilih pengguna yang bisa mengakses plugin, atau aktifkan 'Izinkan semua pengguna'.", + "allLibrariesHelp": "Ketika diaktifkan, plugin akan memiliki akses ke semua pustaka, termasuk yang dibuat di masa depan.", + "noLibraries": "Tidak ada pustaka yang dipilih", + "librariesRequired": "Plugin ini membutuhkan akses ke informasi pustaka. Pilih beberapa pustaka yang bisa diakses, atau aktifkan 'Izinkan semua pustaka'.", + "requiredHosts": "Hosts diperlukan", + "configValidationError": "Validasi konfigurasi gagal:", + "schemaRenderError": "Tidak dapat menampilkan form konfigurasi. Skema plugin mungkin tidak valid.", + "allowWriteAccessHelp": "Ketika diaktifkan, plugin dapat mengubah file di direktori pustaka. Bawaannya, plugin hanya memiliki akses read-only" + }, + "placeholders": { + "configKey": "key", + "configValue": "value" } } }, @@ -277,7 +446,7 @@ "add": "Tambah", "back": "Kembali", "bulk_actions": "1 item dipilih |||| %{smart_count} item dipilih", - "cancel": "Batalkan", + "cancel": "Batal", "clear_input_value": "Hapus", "clone": "Klon", "confirm": "Konfirmasi", @@ -292,7 +461,7 @@ "save": "Simpan", "search": "Cari", "show": "Tampilkan", - "sort": "Sortir", + "sort": "Urutkan", "undo": "Batalkan", "expand": "Luaskan", "close": "Tutup", @@ -312,7 +481,7 @@ "create": "Buat %{name}", "dashboard": "Dasbor", "edit": "%{name} #%{id}", - "error": "Ada yang tidak beres", + "error": "Terjadi kesalahan", "list": "%{name}", "loading": "Memuat", "not_found": "Tidak ditemukan", @@ -356,7 +525,7 @@ "unsaved_changes": "Beberapa perubahan tidak disimpan. Apakah Kamu yakin ingin mengabaikannya?" }, "navigation": { - "no_results": "Tidak ada hasil yang ditemukan", + "no_results": "Hasil tidak ditemukan", "no_more_results": "Nomor halaman %{page} melampaui batas. Coba halaman sebelumnya.", "page_out_of_boundaries": "Nomor halaman %{page} melampaui batas", "page_out_from_end": "Tidak dapat menelusuri sebelum halaman terakhir", @@ -371,8 +540,8 @@ "updated": "Elemen diperbarui |||| %{smart_count} elemen diperbarui", "created": "Elemen dibuat", "deleted": "Elemen dihapus |||| %{smart_count} elemen dihapus", - "bad_item": "Elemen salah", - "item_doesnt_exist": "Tidak ada elemen", + "bad_item": "Kesalahan elemen", + "item_doesnt_exist": "Elemen tidak ditemukan", "http_error": "Kesalahan komunikasi peladen", "data_provider_error": "dataProvider galat. Periksa konsol untuk detailnya.", "i18n_error": "Tidak dapat memuat terjemahan untuk bahasa yang diatur", @@ -419,7 +588,18 @@ "downloadDialogTitle": "Unduh %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Salin ke papan klip: Ctrl+C, Enter", "remove_missing_title": "Hapus file yang hilang", - "remove_missing_content": "Apakah Anda yakin ingin menghapus file-file yang hilang dari basis data? Tindakan ini akan menghapus secara permanen semua referensi ke file-file tersebut, termasuk jumlah pemutaran dan peringkatnya." + "remove_missing_content": "Apakah Anda yakin ingin menghapus file-file yang hilang dari basis data? Tindakan ini akan menghapus secara permanen semua referensi ke file-file tersebut, termasuk jumlah pemutaran dan peringkatnya.", + "remove_all_missing_title": "Hapus semua file yang hilang", + "remove_all_missing_content": "Apa kamu yakin ingin menghapus semua file dari database? Ini akan menghapus permanen dan apapun referensi ke mereka, termasuk hitungan pemutaran dan rating mereka.", + "noSimilarSongsFound": "Tidak ada lagu yang serupa ditemukan", + "noTopSongsFound": "Tidak ada lagu teratas ditemukan", + "startingInstantMix": "Memuat Mix Instan...", + "uploadCover": "Unggah Sampul", + "removeCover": "Hapus Sampul", + "coverUploaded": "Sampul diperbarui", + "coverRemoved": "Sampul dihapus", + "coverUploadError": "Kesalahan mengunggah sampul", + "coverRemoveError": "Kesalahan menghapus sampul" }, "menu": { "library": "Pustaka", @@ -448,10 +628,16 @@ "albumList": "Album", "about": "Tentang", "playlists": "Playlist", - "sharedPlaylists": "Playlist yang Dibagikan" + "sharedPlaylists": "Playlist yang Dibagikan", + "librarySelector": { + "allLibraries": "Semua Pustaka (%{count})", + "multipleLibraries": "Pustaka %{selected} dari %{total}", + "selectLibraries": "Pilih Perpustakaan", + "none": "Tidak ada" + } }, "player": { - "playListsText": "Mainkan Antrean", + "playListsText": "Putar Antrean", "openText": "Buka", "closeText": "Tutup", "notContentText": "Tidak ada musik", @@ -471,7 +657,7 @@ "playModeText": { "order": "Berurutan", "orderLoop": "Ulang", - "singleLoop": "Ulangi Satu", + "singleLoop": "Ulangi Sekali", "shufflePlay": "Acak" } }, @@ -485,6 +671,22 @@ "disabled": "Nonaktifkan", "waiting": "Menunggu" } + }, + "tabs": { + "about": "Tentang", + "config": "Konfigurasi" + }, + "config": { + "configName": "Nama Konfigurasi", + "environmentVariable": "Variabel Environment", + "currentValue": "Value Saat Ini", + "configurationFile": "File Konfigurasi", + "exportToml": "Ekspor Konfigurasi (TOML)", + "exportSuccess": "Konfigurasi sudah diekspor ke papan klip dalam bentuk format TOML", + "exportFailed": "Gagal menyalin konfigurasi", + "devFlagsHeader": "Flag Pengembangan (subyek untuk perubahan/pemindahan)", + "devFlagsComment": "Ini adalan pengaturan eksperimen dan mungkin akan dihapus di versi mendatang", + "downloadToml": "Unduh Konfigurasi (TOML)" } }, "activity": { @@ -493,7 +695,11 @@ "quickScan": "Pemindaian Cepat", "fullScan": "Pemindaian Penuh", "serverUptime": "Waktu Aktif Peladen", - "serverDown": "LURING" + "serverDown": "LURING", + "scanType": "Tipe", + "status": "Kesalahan Memindai", + "elapsedTime": "Waktu Berakhir", + "selectiveScan": "Selektif" }, "help": { "title": "Tombol Pintasan Navidrome", @@ -508,5 +714,10 @@ "toggle_love": "Tambahkan lagu ini ke favorit", "current_song": "Buka Lagu Saat Ini" } + }, + "nowPlaying": { + "title": "Sedang Diputar", + "empty": "Tidak ada yang diputar", + "minutesAgo": "%{smart_count} menit yang lalu |||| %{smart_count} menit yang lalu" } } \ No newline at end of file diff --git a/resources/i18n/it.json b/resources/i18n/it.json index aaaa2f8c2..b91c04064 100644 --- a/resources/i18n/it.json +++ b/resources/i18n/it.json @@ -10,32 +10,48 @@ "playCount": "Riproduzioni", "title": "Titolo", "artist": "Artista", + "composer": "Compositore", "album": "Album", "path": "Percorso", + "libraryName": "Libreria", "genre": "Genere", "compilation": "Compilation", "year": "Anno", "size": "Dimensioni", "updatedAt": "Ultimo aggiornamento", "bitRate": "Bitrate", - "discSubtitle": "Sottotitoli disco", + "bitDepth": "Profondità di bit", + "sampleRate": "Frequenza di campionamento", + "albumGain": "Guadagno album", + "trackGain": "Guadagno traccia", + "channels": "Canali", + "disc": "Disco %{discNumber}", + "discSubtitle": "Sottotitolo disco", "starred": "Preferita", "comment": "Commento", "rating": "Valutazione", "quality": "Qualità", "bpm": "BPM", "playDate": "Ultima riproduzione", - "channels": "Canali", - "createdAt": "" + "createdAt": "Data di aggiunta", + "grouping": "Raggruppamento", + "mood": "Umore", + "participants": "Partecipanti aggiuntivi", + "tags": "Tag aggiuntivi", + "mappedTags": "Tag mappati", + "rawTags": "Tag grezzi", + "missing": "Mancante" }, "actions": { "addToQueue": "Aggiungi alla coda", "playNow": "Riproduci adesso", "addToPlaylist": "Aggiungi alla playlist", + "showInPlaylist": "Mostra nella playlist", "shuffleAll": "Riproduci casualmente", "download": "Scarica", "playNext": "Riproduci come successivo", - "info": "Informazioni" + "info": "Informazioni", + "instantMix": "Mix istantaneo" } }, "album": { @@ -46,29 +62,38 @@ "duration": "Durata", "songCount": "Tracce", "playCount": "Riproduzioni", + "size": "Dimensione", "name": "Nome", + "libraryName": "Libreria", "genre": "Genere", "compilation": "Compilation", "year": "Anno", + "date": "Data di registrazione", + "originalDate": "Originale", + "releaseDate": "Data di pubblicazione", + "releases": "Pubblicazione |||| Pubblicazioni", + "released": "Pubblicato", "updatedAt": "Ultimo aggiornamento", "comment": "Commento", "rating": "Valutazione", - "createdAt": "Data di creazione", - "size": "Dimensione", - "originalDate": "", - "releaseDate": "Data di pubblicazione", - "releases": "Pubblicazione |||| Pubblicazioni", - "released": "Pubblicato" + "createdAt": "Data di aggiunta", + "recordLabel": "Etichetta", + "catalogNum": "Numero di catalogo", + "releaseType": "Tipo", + "grouping": "Raggruppamento", + "media": "Media", + "mood": "Umore", + "missing": "Mancante" }, "actions": { "playAll": "Riproduci", "playNext": "Riproduci come successivo", "addToQueue": "Aggiungi alla coda", + "share": "Condividi", "shuffle": "Riproduci casualmente", - "addToPlaylist": "Aggiungi alla Playlist", + "addToPlaylist": "Aggiungi alla playlist", "download": "Scarica", - "info": "Informazioni", - "share": "Condividi" + "info": "Informazioni" }, "lists": { "all": "Tutti", @@ -86,10 +111,33 @@ "name": "Nome", "albumCount": "Album", "songCount": "Numero tracce", + "size": "Dimensione", "playCount": "Riproduzioni", "rating": "Valutazione", "genre": "Genere", - "size": "Dimensione" + "role": "Ruolo", + "missing": "Mancante" + }, + "roles": { + "albumartist": "Artista Album |||| Artisti Album", + "artist": "Artista |||| Artisti", + "composer": "Compositore |||| Compositori", + "conductor": "Direttore d'orchestra |||| Direttori d'orchestra", + "lyricist": "Paroliere |||| Parolieri", + "arranger": "Arrangiatore |||| Arrangiatori", + "producer": "Produttore |||| Produttori", + "director": "Direttore |||| Direttori", + "engineer": "Ingegnere del suono |||| Ingegneri del suono", + "mixer": "Mixer |||| Mixer", + "remixer": "Remixer |||| Remixer", + "djmixer": "DJ Mixer |||| DJ Mixer", + "performer": "Esecutore |||| Esecutori", + "maincredit": "Artista Album o Artista |||| Artisti Album o Artisti" + }, + "actions": { + "topSongs": "Brani più ascoltati", + "shuffle": "Riproduci casualmente", + "radio": "Radio" } }, "user": { @@ -97,31 +145,39 @@ "fields": { "userName": "Nome utente", "isAdmin": "Amministratore", - "lastLoginAt": "Ultimo accesso", + "lastLoginAt": "Ultimo login", + "lastAccessAt": "Ultimo accesso", "updatedAt": "Ultimo aggiornamento", "name": "Nome", "password": "Password", - "createdAt": "Creato a", + "createdAt": "Creato il", "changePassword": "Cambiare la password?", "currentPassword": "Password Attuale", "newPassword": "Nuova Password", - "token": "Token" + "token": "Token", + "libraries": "Librerie" }, "helperTexts": { - "name": "Le modifiche effettuate al tuo nome verrano mostrate al prossimo accesso" + "name": "Le modifiche effettuate al tuo nome verranno mostrate al prossimo accesso", + "libraries": "Seleziona librerie specifiche per questo utente, o lascia vuoto per usare le librerie predefinite" }, "notifications": { "created": "Utente creato", "updated": "Utente aggiornato", "deleted": "Utente eliminato" }, + "validation": { + "librariesRequired": "Almeno una libreria deve essere selezionata per gli utenti non amministratori" + }, "message": { - "listenBrainzToken": "Inserisci il tuo token utente ListenBrainz.", - "clickHereForToken": "Clicca qui per ottenere il tuo token" + "listenBrainzToken": "Inserisci il tuo token utente ListenBrainz", + "clickHereForToken": "Clicca qui per ottenere il tuo token", + "selectAllLibraries": "Seleziona tutte le librerie", + "adminAutoLibraries": "Gli utenti amministratori hanno automaticamente accesso a tutte le librerie" } }, "player": { - "name": "Client |||| Client", + "name": "Lettore |||| Lettori", "fields": { "name": "Nome", "transcodingId": "Transcodifica", @@ -130,7 +186,7 @@ "userName": "Nome utente", "lastSeen": "Ultimo accesso", "reportRealPath": "Mostra percorso reale", - "scrobbleEnabled": "" + "scrobbleEnabled": "Invia scrobble ai servizi esterni" } }, "transcoding": { @@ -157,45 +213,203 @@ "path": "Importa da" }, "actions": { - "selectPlaylist": "Aggiungi tracce alla playlist:", - "addNewPlaylist": "Aggiungi \"%{name}\"", + "selectPlaylist": "Seleziona una playlist:", + "addNewPlaylist": "Crea \"%{name}\"", "export": "Esporta", + "saveQueue": "Salva la coda nella playlist", "makePublic": "Rendi Pubblica", - "makePrivate": "Rendi Privata" + "makePrivate": "Rendi Privata", + "searchOrCreate": "Cerca playlist o digita per crearne una nuova...", + "pressEnterToCreate": "Premi Invio per creare una nuova playlist", + "removeFromSelection": "Rimuovi dalla selezione" }, "message": { "duplicate_song": "Aggiungere i duplicati", - "song_exist": "Stanno essendo aggiunti dei duplicati nella playlist. Vuoi aggiungerli o saltarli?" + "song_exist": "Si stanno aggiungendo dei duplicati nella playlist. Vuoi aggiungerli o saltarli?", + "noPlaylistsFound": "Nessuna playlist trovata", + "noPlaylists": "Nessuna playlist disponibile" } }, "radio": { "name": "Radio |||| Radio", "fields": { "name": "Nome", - "streamUrl": "", - "homePageUrl": "", - "updatedAt": "", - "createdAt": "" + "streamUrl": "URL dello stream", + "homePageUrl": "URL della pagina web", + "updatedAt": "Ultimo aggiornamento", + "createdAt": "Data di creazione" }, "actions": { - "playNow": "" + "playNow": "Riproduci adesso" } }, "share": { - "name": "", + "name": "Condivisione |||| Condivisioni", "fields": { - "username": "", - "url": "", - "description": "", - "contents": "", - "expiresAt": "", - "lastVisitedAt": "", - "visitCount": "", - "format": "", - "maxBitRate": "", - "updatedAt": "", - "createdAt": "", - "downloadable": "" + "username": "Condiviso da", + "url": "URL", + "description": "Descrizione", + "downloadable": "Consenti i download?", + "contents": "Contenuti", + "expiresAt": "Scade il", + "lastVisitedAt": "Ultima visita", + "visitCount": "Visite", + "format": "Formato", + "maxBitRate": "Bitrate massimo", + "updatedAt": "Ultimo aggiornamento", + "createdAt": "Data di creazione" + }, + "notifications": {}, + "actions": {} + }, + "missing": { + "name": "File mancante |||| File mancanti", + "empty": "Nessun file mancante", + "fields": { + "path": "Percorso", + "size": "Dimensione", + "libraryName": "Libreria", + "updatedAt": "Scomparso il" + }, + "actions": { + "remove": "Rimuovi", + "remove_all": "Rimuovi tutti" + }, + "notifications": { + "removed": "File mancanti rimossi" + } + }, + "library": { + "name": "Libreria |||| Librerie", + "fields": { + "name": "Nome", + "path": "Percorso", + "remotePath": "Percorso remoto", + "lastScanAt": "Ultima scansione", + "songCount": "Tracce", + "albumCount": "Album", + "artistCount": "Artisti", + "totalSongs": "Tracce", + "totalAlbums": "Album", + "totalArtists": "Artisti", + "totalFolders": "Cartelle", + "totalFiles": "File", + "totalMissingFiles": "File mancanti", + "totalSize": "Dimensione totale", + "totalDuration": "Durata", + "defaultNewUsers": "Predefinita per i nuovi utenti", + "createdAt": "Creata il", + "updatedAt": "Aggiornata il" + }, + "sections": { + "basic": "Informazioni di base", + "statistics": "Statistiche" + }, + "actions": { + "scan": "Scansiona la libreria", + "quickScan": "Scansione rapida", + "fullScan": "Scansione completa", + "manageUsers": "Gestisci accesso utenti", + "viewDetails": "Visualizza dettagli" + }, + "notifications": { + "created": "Libreria creata con successo", + "updated": "Libreria aggiornata con successo", + "deleted": "Libreria eliminata con successo", + "scanStarted": "Scansione della libreria avviata", + "quickScanStarted": "Scansione rapida avviata", + "fullScanStarted": "Scansione completa avviata", + "scanError": "Errore durante l'avvio della scansione. Controlla i log", + "scanCompleted": "Scansione della libreria completata" + }, + "validation": { + "nameRequired": "Il nome della libreria è obbligatorio", + "pathRequired": "Il percorso della libreria è obbligatorio", + "pathNotDirectory": "Il percorso della libreria deve essere una directory", + "pathNotFound": "Percorso della libreria non trovato", + "pathNotAccessible": "Il percorso della libreria non è accessibile", + "pathInvalid": "Percorso della libreria non valido" + }, + "messages": { + "deleteConfirm": "Sei sicuro di voler eliminare questa libreria? Verranno rimossi tutti i dati associati e gli accessi degli utenti.", + "scanInProgress": "Scansione in corso...", + "noLibrariesAssigned": "Nessuna libreria assegnata a questo utente" + } + }, + "plugin": { + "name": "Plugin |||| Plugin", + "fields": { + "id": "ID", + "name": "Nome", + "description": "Descrizione", + "version": "Versione", + "author": "Autore", + "website": "Sito web", + "permissions": "Permessi", + "enabled": "Abilitato", + "status": "Stato", + "path": "Percorso", + "lastError": "Errore", + "hasError": "Errore", + "updatedAt": "Aggiornato il", + "createdAt": "Installato il", + "configKey": "Chiave", + "configValue": "Valore", + "allUsers": "Consenti tutti gli utenti", + "selectedUsers": "Utenti selezionati", + "allLibraries": "Consenti tutte le librerie", + "selectedLibraries": "Librerie selezionate", + "allowWriteAccess": "Consenti accesso in scrittura" + }, + "sections": { + "status": "Stato", + "info": "Informazioni sul plugin", + "configuration": "Configurazione", + "manifest": "Manifest", + "usersPermission": "Permessi utenti", + "libraryPermission": "Permesso libreria" + }, + "status": { + "enabled": "Abilitato", + "disabled": "Disabilitato" + }, + "actions": { + "enable": "Abilita", + "disable": "Disabilita", + "disabledDueToError": "Correggi l'errore prima di abilitare", + "disabledUsersRequired": "Seleziona gli utenti prima di abilitare", + "disabledLibrariesRequired": "Seleziona le librerie prima di abilitare", + "addConfig": "Aggiungi configurazione", + "rescan": "Riscansiona" + }, + "notifications": { + "enabled": "Plugin abilitato", + "disabled": "Plugin disabilitato", + "updated": "Plugin aggiornato", + "error": "Errore durante l'aggiornamento del plugin" + }, + "validation": { + "invalidJson": "La configurazione deve essere un JSON valido" + }, + "messages": { + "configHelp": "Configura il plugin usando coppie chiave-valore. Lascia vuoto se il plugin non richiede configurazione.", + "configValidationError": "Validazione della configurazione fallita:", + "schemaRenderError": "Impossibile visualizzare il modulo di configurazione. Lo schema del plugin potrebbe non essere valido.", + "clickPermissions": "Clicca su un permesso per i dettagli", + "noConfig": "Nessuna configurazione impostata", + "allUsersHelp": "Se abilitato, il plugin avrà accesso a tutti gli utenti, inclusi quelli creati in futuro.", + "noUsers": "Nessun utente selezionato", + "permissionReason": "Motivo", + "usersRequired": "Questo plugin richiede accesso alle informazioni degli utenti. Seleziona quali utenti il plugin può accedere, oppure abilita 'Consenti tutti gli utenti'.", + "allLibrariesHelp": "Se abilitato, il plugin avrà accesso a tutte le librerie, incluse quelle create in futuro.", + "noLibraries": "Nessuna libreria selezionata", + "librariesRequired": "Questo plugin richiede accesso alle informazioni delle librerie. Seleziona quali librerie il plugin può accedere, oppure abilita 'Consenti tutte le librerie'.", + "allowWriteAccessHelp": "Se abilitato, il plugin può modificare i file nelle directory della libreria. Per impostazione predefinita, i plugin hanno accesso in sola lettura.", + "requiredHosts": "Host richiesti" + }, + "placeholders": { + "configKey": "chiave", + "configValue": "valore" } } }, @@ -206,12 +420,13 @@ "confirmPassword": "Conferma la password", "buttonCreateAdmin": "Crea amministratore", "auth_check_error": "Per favore accedi per continuare", - "user_menu": "Profile", + "user_menu": "Profilo", "username": "Nome utente", "password": "Password", "sign_in": "Accedi", "sign_in_error": "Autenticazione fallita, per favore riprova", - "logout": "Disconnetti" + "logout": "Disconnetti", + "insightsCollectionNote": "Navidrome raccoglie dati di utilizzo anonimi per\nmigliorare il progetto. Clicca [qui] per saperne di più\ne per disattivarlo se lo desideri" }, "validation": { "invalidChars": "Per favore usa solo lettere e numeri", @@ -226,13 +441,14 @@ "oneOf": "Deve essere uno di: %{options}", "regex": "Deve rispettare il formato (espressione regolare): %{pattern}", "unique": "Deve essere unico", - "url": "" + "url": "Deve essere un URL valido" }, "action": { "add_filter": "Aggiungi un filtro", "add": "Aggiungi", "back": "Indietro", - "bulk_actions": "Un elemento selezionato ||| %{smart_count} elementi selezionati", + "bulk_actions": "Un elemento selezionato |||| %{smart_count} elementi selezionati", + "bulk_actions_mobile": "1 |||| %{smart_count}", "cancel": "Annulla", "clear_input_value": "Cancella", "clone": "Duplica", @@ -244,7 +460,7 @@ "list": "Elenco", "refresh": "Aggiorna", "remove_filter": "Rimuovi questo filtro", - "remove": "Remove", + "remove": "Rimuovi", "save": "Salva", "search": "Cerca", "show": "Mostra", @@ -255,17 +471,16 @@ "open_menu": "Apri menù", "close_menu": "Chiudi menù", "unselect": "Deseleziona", - "skip": "Saltare i duplicati", - "bulk_actions_mobile": "", - "share": "", - "download": "" + "skip": "Salta", + "share": "Condividi", + "download": "Scarica" }, "boolean": { - "true": "Si", + "true": "Sì", "false": "No" }, "page": { - "create": "Aggiungi %{name}", + "create": "Crea %{name}", "dashboard": "Pannello di controllo", "edit": "%{name} #%{id}", "error": "Qualcosa è andato storto", @@ -274,7 +489,7 @@ "not_found": "Non trovato", "show": "%{name} #%{id}", "empty": "Nessun %{name} per adesso.", - "invite": "Vuoi invitare un amico?" + "invite": "Vuoi aggiungerne uno?" }, "input": { "file": { @@ -308,17 +523,17 @@ "loading": "La pagina si sta caricando, solo un momento per favore", "no": "No", "not_found": "Hai inserito un URL inesistente, oppure hai cliccato un link errato.", - "yes": "Si", - "unsaved_changes": "Alcune modifiche non sono state salvate. Vuoi ripristinarle?" + "yes": "Sì", + "unsaved_changes": "Alcune modifiche non sono state salvate. Sei sicuro di volerle ignorare?" }, "navigation": { "no_results": "Nessun risultato trovato", "no_more_results": "La pagina numero %{page} è fuori dall'intervallo. Prova la pagina precedente.", - "page_out_of_boundaries": "Il numero di pagina %{page} è fuori dall’intervallo", - "page_out_from_end": "Non è possibile andare oltre l’ultima pagina", + "page_out_of_boundaries": "Il numero di pagina %{page} è fuori dall'intervallo", + "page_out_from_end": "Non è possibile andare oltre l'ultima pagina", "page_out_from_begin": "Non è possibile andare prima della prima pagina", "page_range_info": "%{offsetBegin}-%{offsetEnd} di %{total}", - "page_rows_per_page": "Righe per pagina:", + "page_rows_per_page": "Elementi per pagina:", "next": "Successivo", "prev": "Precedente", "skip_nav": "Passa al contenuto" @@ -334,7 +549,7 @@ "i18n_error": "Impossibile caricare la traduzione per la lingua selezionata", "canceled": "Azione annullata", "logged_out": "La sessione è scaduta, per favore accedi di nuovo.", - "new_version": "Una nuova versione è disponibile! Ricarica la pagina" + "new_version": "Una nuova versione è disponibile! Ricarica la pagina." }, "toggleFieldsMenu": { "columnsToDisplay": "Colonne da mostrare", @@ -344,39 +559,58 @@ } }, "message": { - "note": "Note", - "transcodingDisabled": "La possibilità di modificare le opzioni di transcodifica attraverso l’interfaccia web è disabilitata per ragioni di sicurezza. Se desideri cambiare (modificare o aggiungere) opzioni di transcodifica, riavvia il server con l’opzione %{config}.", - "transcodingEnabled": "Navidrome è al momento attivo con %{config}, rendendo possibile eseguire comandi remoti attraverso l’interfaccia web. Si raccomanda di disabilitare questa opzione per ragioni di sicurezza e di abilitarla solo per configurare le opzioni di transcodifica.", + "uploadCover": "Carica copertina", + "removeCover": "Rimuovi copertina", + "coverUploaded": "Copertina aggiornata", + "coverRemoved": "Copertina rimossa", + "coverUploadError": "Errore durante il caricamento della copertina", + "coverRemoveError": "Errore durante la rimozione della copertina", + "note": "NOTA", + "transcodingDisabled": "La possibilità di modificare le opzioni di transcodifica attraverso l'interfaccia web è disabilitata per ragioni di sicurezza. Se desideri cambiare (modificare o aggiungere) opzioni di transcodifica, riavvia il server con l'opzione %{config}.", + "transcodingEnabled": "Navidrome è al momento attivo con %{config}, rendendo possibile eseguire comandi di sistema dalle impostazioni di transcodifica tramite l'interfaccia web. Si raccomanda di disabilitare questa opzione per ragioni di sicurezza e di abilitarla solo per configurare le opzioni di transcodifica.", "songsAddedToPlaylist": "Aggiunta una traccia alla playlist |||| Aggiunte %{smart_count} tracce alla playlist", - "noPlaylistsAvailable": "Nessuna playlist", + "noSimilarSongsFound": "Nessuna traccia simile trovata", + "startingInstantMix": "Caricamento del Mix istantaneo...", + "noTopSongsFound": "Nessun brano più ascoltato trovato", + "noPlaylistsAvailable": "Nessuna disponibile", "delete_user_title": "Rimuovi utente '%{name}'", - "delete_user_content": "Sei sicuro di voler rimuovere questo utente e tutti i suoi dati, incluse playlist e impostazioni?", + "delete_user_content": "Sei sicuro di voler rimuovere questo utente e tutti i suoi dati (incluse playlist e impostazioni)?", + "remove_missing_title": "Rimuovi i file mancanti", + "remove_missing_content": "Sei sicuro di voler rimuovere i file mancanti selezionati dal database? Verranno eliminati permanentemente tutti i riferimenti ad essi, inclusi i conteggi delle riproduzioni e le valutazioni.", + "remove_all_missing_title": "Rimuovi tutti i file mancanti", + "remove_all_missing_content": "Sei sicuro di voler rimuovere tutti i file mancanti dal database? Verranno eliminati permanentemente tutti i riferimenti ad essi, inclusi i conteggi delle riproduzioni e le valutazioni.", "notifications_blocked": "Hai bloccato le notifiche per questo sito nelle tue impostazioni del browser", "notifications_not_available": "Questo browser non supporta le notifiche desktop o non stai accedendo a Navidrome tramite HTTPS", "lastfmLinkSuccess": "Collegamento a Last.fm riuscito e scrobbling abilitato", - "lastfmLinkFailure": "Non è stato possible collegare Last.fm", + "lastfmLinkFailure": "Non è stato possibile collegare Last.fm", "lastfmUnlinkSuccess": "Lo scrobbling è stato disabilitato e Last.fm è stato disconnesso", "lastfmUnlinkFailure": "Non è stato possibile scollegare Last.fm", + "listenBrainzLinkSuccess": "ListenBrainz collegato con successo, abilitato lo scrobbling per l'utente: %{user}", + "listenBrainzLinkFailure": "Non è stato possibile collegare ListenBrainz: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz disconnesso e scrobbling disabilitato", + "listenBrainzUnlinkFailure": "Non è stato possibile disconnettere ListenBrainz", "openIn": { "lastfm": "Apri in Last.fm", "musicbrainz": "Apri in MusicBrainz" }, "lastfmLink": "Per saperne di più...", - "listenBrainzLinkSuccess": "ListenBrainz collegato con successo, abilitato lo scrobbling per l'utente %{user}", - "listenBrainzLinkFailure": "Non è stato possibile collegare ListenBrainz: %{error}", - "listenBrainzUnlinkSuccess": "", - "listenBrainzUnlinkFailure": "", - "downloadOriginalFormat": "", - "shareOriginalFormat": "", - "shareDialogTitle": "", - "shareBatchDialogTitle": "", - "shareSuccess": "", - "shareFailure": "", - "downloadDialogTitle": "", - "shareCopyToClipboard": "" + "shareOriginalFormat": "Condividi nel formato originale", + "shareDialogTitle": "Condividi %{resource} '%{name}'", + "shareBatchDialogTitle": "Condividi 1 %{resource} |||| Condividi %{smart_count} %{resource}", + "shareCopyToClipboard": "Copia negli appunti: Ctrl+C, Invio", + "shareSuccess": "URL copiato negli appunti: %{url}", + "shareFailure": "Errore durante la copia dell'URL %{url} negli appunti", + "downloadDialogTitle": "Scarica %{resource} '%{name}' (%{size})", + "downloadOriginalFormat": "Scarica nel formato originale" }, "menu": { "library": "Libreria", + "librarySelector": { + "allLibraries": "Tutte le librerie (%{count})", + "multipleLibraries": "%{selected} di %{total} librerie", + "selectLibraries": "Seleziona librerie", + "none": "Nessuna" + }, "settings": "Impostazioni", "version": "Versione", "theme": "Tema", @@ -387,21 +621,22 @@ "language": "Lingua", "defaultView": "Vista Predefinita", "desktop_notifications": "Notifiche desktop", + "lastfmNotConfigured": "La chiave API di Last.fm non è configurata", "lastfmScrobbling": "Esegui lo scrobbling tramite Last.fm", - "listenBrainzScrobbling": "", - "replaygain": "", - "preAmp": "", + "listenBrainzScrobbling": "Esegui lo scrobbling tramite ListenBrainz", + "replaygain": "Modalità ReplayGain", + "preAmp": "ReplayGain PreAmp (dB)", "gain": { - "none": "", - "album": "", - "track": "" + "none": "Disabilitato", + "album": "Usa guadagno album", + "track": "Usa guadagno traccia" } } }, "albumList": "Album", - "about": "Info", - "playlists": "Scalette", - "sharedPlaylists": "Scalette Condivise" + "playlists": "Playlist", + "sharedPlaylists": "Playlist Condivise", + "about": "Info" }, "player": { "playListsText": "Coda", @@ -432,29 +667,59 @@ "links": { "homepage": "Sito web", "source": "Codice sorgente", - "featureRequests": "Richieste" + "featureRequests": "Richieste", + "lastInsightsCollection": "Ultima raccolta dati", + "insights": { + "disabled": "Disabilitato", + "waiting": "In attesa" + } + }, + "tabs": { + "about": "Info", + "config": "Configurazione" + }, + "config": { + "configName": "Nome configurazione", + "environmentVariable": "Variabile d'ambiente", + "currentValue": "Valore attuale", + "configurationFile": "File di configurazione", + "exportToml": "Esporta configurazione (TOML)", + "downloadToml": "Scarica configurazione (TOML)", + "exportSuccess": "Configurazione esportata negli appunti in formato TOML", + "exportFailed": "Impossibile copiare la configurazione", + "devFlagsHeader": "Flag di sviluppo (soggetti a modifiche/rimozione)", + "devFlagsComment": "Queste sono impostazioni sperimentali e potrebbero essere rimosse in versioni future" } }, "activity": { "title": "Attività", - "totalScanned": "Cartelle scansionate", - "quickScan": "Scansione veloce", - "fullScan": "Scansione completa", - "serverUptime": "Periodo di attività", - "serverDown": "OFFLINE" + "totalScanned": "Cartelle scansionate totali", + "quickScan": "Rapida", + "fullScan": "Completa", + "selectiveScan": "Selettiva", + "serverUptime": "Periodo di attività del server", + "serverDown": "OFFLINE", + "scanType": "Ultima scansione", + "status": "Errore di scansione", + "elapsedTime": "Tempo trascorso" + }, + "nowPlaying": { + "title": "In riproduzione", + "empty": "Nessuna riproduzione in corso", + "minutesAgo": "%{smart_count} minuto fa |||| %{smart_count} minuti fa" }, "help": { - "title": "Scorciatoie da Tastiera", + "title": "Scorciatoie da Tastiera di Navidrome", "hotkeys": { "show_help": "Mostra questa schermata", "toggle_menu": "Mostra/Nascondi la barra laterale", "toggle_play": "Riproduzione/Pausa", "prev_song": "Traccia Precedente", "next_song": "Traccia Successiva", + "current_song": "Vai alla traccia corrente", "vol_up": "Alza il Volume", "vol_down": "Abbassa il Volume", - "toggle_love": "Aggiungi questa traccia ai preferiti", - "current_song": "" + "toggle_love": "Aggiungi questa traccia ai preferiti" } } } \ No newline at end of file diff --git a/resources/i18n/ja.json b/resources/i18n/ja.json index fbf8cefd2..29975b92b 100644 --- a/resources/i18n/ja.json +++ b/resources/i18n/ja.json @@ -27,12 +27,16 @@ "playDate": "最後の再生", "channels": "チャンネル", "createdAt": "追加日", - "grouping": "", - "mood": "", - "participants": "", - "tags": "", - "mappedTags": "", - "rawTags": "" + "grouping": "グループ分け", + "mood": "ムード", + "participants": "追加参加者", + "tags": "追加タグ", + "mappedTags": "マッピング済みタグ", + "rawTags": "未処理タグ", + "bitDepth": "ビット深度", + "sampleRate": "サンプリングレート", + "missing": "不明", + "libraryName": "ライブラリ" }, "actions": { "addToQueue": "最後に再生", @@ -41,7 +45,8 @@ "shuffleAll": "全曲シャッフル", "download": "ダウンロード", "playNext": "次に再生", - "info": "詳細" + "info": "詳細", + "showInPlaylist": "含まれるプレイリスト" } }, "album": { @@ -65,12 +70,15 @@ "releaseDate": "リリース日", "releases": "リリース", "released": "リリース", - "recordLabel": "", - "catalogNum": "", - "releaseType": "", - "grouping": "", - "media": "", - "mood": "" + "recordLabel": "ラベル", + "catalogNum": "カタログ番号", + "releaseType": "タイプ", + "grouping": "グループ分け", + "media": "メディア", + "mood": "ムード", + "date": "録音日", + "missing": "不明", + "libraryName": "ライブラリ" }, "actions": { "playAll": "再生", @@ -102,22 +110,29 @@ "rating": "レート", "genre": "ジャンル", "size": "サイズ", - "role": "" + "role": "役割", + "missing": "不明" }, "roles": { - "albumartist": "", - "artist": "", - "composer": "", - "conductor": "", - "lyricist": "", - "arranger": "", - "producer": "", - "director": "", - "engineer": "", - "mixer": "", - "remixer": "", - "djmixer": "", - "performer": "" + "albumartist": "アルバムアーティスト", + "artist": "アーティスト", + "composer": "作曲家", + "conductor": "指揮者", + "lyricist": "作詞家", + "arranger": "編曲者", + "producer": "プロデューサー", + "director": "ディレクター", + "engineer": "エンジニア", + "mixer": "ミキサー", + "remixer": "リミキサー", + "djmixer": "DJ ミキサー", + "performer": "演奏者", + "maincredit": "アルバムアーティストもしくはアーティスト" + }, + "actions": { + "shuffle": "シャッフル", + "radio": "ラジオ", + "topSongs": "トップソング" } }, "user": { @@ -134,10 +149,12 @@ "currentPassword": "現在のパスワード", "newPassword": "新しいパスワード", "token": "トークン", - "lastAccessAt": "最終アクセス" + "lastAccessAt": "最終アクセス", + "libraries": "ライブラリ" }, "helperTexts": { - "name": "名前の変更は次回ログイン以降反映されます" + "name": "名前の変更は次回ログイン以降反映されます", + "libraries": "このユーザーに対して特定ライブラリを選択するか、デフォルトのライブラリを使用する場合は空欄のままにします" }, "notifications": { "created": "ユーザーが作成されました", @@ -146,7 +163,12 @@ }, "message": { "listenBrainzToken": "ListenBrainzユーザートークンを入力", - "clickHereForToken": "ここをクリックしトークンを入手" + "clickHereForToken": "ここをクリックしトークンを入手", + "selectAllLibraries": "全てのライブラリを選択", + "adminAutoLibraries": "管理者ユーザーは自動的にすべてのライブラリにアクセスできます" + }, + "validation": { + "librariesRequired": "管理者以外のユーザーには少なくとも1つのライブラリを選択する必要があります" } }, "player": { @@ -190,11 +212,17 @@ "addNewPlaylist": "'%{name}' を作成", "export": "エクスポート", "makePublic": "公開する", - "makePrivate": "非公開にする" + "makePrivate": "非公開にする", + "saveQueue": "キューをプレイリストに保存", + "searchOrCreate": "プレイリストを検索または入力して新規作成...", + "pressEnterToCreate": "Enterキーを押して新しいプレイリストを作成", + "removeFromSelection": "選択から削除" }, "message": { "duplicate_song": "重複する曲を追加", - "song_exist": "既にプレイリストに存在する曲です。追加しますか?" + "song_exist": "既にプレイリストに存在する曲です。追加しますか?", + "noPlaylistsFound": "プレイリストが見つかりません", + "noPlaylists": "利用可能なプレイリストはありません" } }, "radio": { @@ -228,17 +256,77 @@ } }, "missing": { - "name": "", + "name": "欠落したファイル", "fields": { - "path": "", - "size": "", - "updatedAt": "" + "path": "パス", + "size": "サイズ", + "updatedAt": "欠落日", + "libraryName": "ライブラリ" }, "actions": { - "remove": "" + "remove": "削除", + "remove_all": "全て削除" }, "notifications": { - "removed": "" + "removed": "欠落ファイルが削除されました" + }, + "empty": "ファイルの欠落はありません" + }, + "library": { + "name": "ライブラリ", + "fields": { + "name": "名前", + "path": "パス", + "remotePath": "リモートパス", + "lastScanAt": "最終スキャン", + "songCount": "曲数", + "albumCount": "アルバム数", + "artistCount": "アーティスト数", + "totalSongs": "曲数", + "totalAlbums": "アルバム数", + "totalArtists": "アーティスト数", + "totalFolders": "フォルダー数", + "totalFiles": "ファイル数", + "totalMissingFiles": "欠落したファイル", + "totalSize": "合計サイズ", + "totalDuration": "合計時間", + "defaultNewUsers": "新規ユーザーに対するデフォルト", + "createdAt": "作成日", + "updatedAt": "更新日" + }, + "sections": { + "basic": "基本情報", + "statistics": "統計" + }, + "actions": { + "scan": "ライブラリをスキャン", + "manageUsers": "ユーザーアクセス管理", + "viewDetails": "詳細を表示", + "quickScan": "クイックスキャン", + "fullScan": "フルスキャン" + }, + "notifications": { + "created": "ライブラリが正常に作成されました", + "updated": "ライブラリが正常に更新されました", + "deleted": "ライブラリが正常に削除されました", + "scanStarted": "スキャンを開始しました", + "scanCompleted": "スキャンが完了しました", + "quickScanStarted": "クイックスキャンを開始しました", + "fullScanStarted": "フルスキャンを開始しました", + "scanError": "スキャン開始中にエラーが発生。ログを確認してください" + }, + "validation": { + "nameRequired": "ライブラリの名前が必要です", + "pathRequired": "ライブラリのパスが必要です", + "pathNotDirectory": "ライブラリパスはディレクトリである必要があります", + "pathNotFound": "ライブラリのパスが見つかりません", + "pathNotAccessible": "ライブラリパスへアクセスできません", + "pathInvalid": "無効なライブラリパス" + }, + "messages": { + "deleteConfirm": "このライブラリを削除しますか?関連する全てのデータとユーザーアクセスが削除されます。", + "scanInProgress": "スキャン中...", + "noLibrariesAssigned": "このユーザーに割り当てられているライブラリはありません" } } }, @@ -418,8 +506,12 @@ "shareFailure": "コピーに失敗しました %{url}", "downloadDialogTitle": "ダウンロード %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "クリップボードへコピー: Ctrl+C, Enter", - "remove_missing_title": "", - "remove_missing_content": "" + "remove_missing_title": "欠落ファイルを削除", + "remove_missing_content": "選択した欠落ファイルをデータベースから削除してもよろしいですか?これにより、再生数や評価を含むそれらのファイルへの参照が完全に削除されます。", + "remove_all_missing_title": "全ての欠落ファイルを削除", + "remove_all_missing_content": "データベースから欠落ファイルをすべて削除してもよろしいですか?これにより、再生数や評価を含むそれらのファイルへの参照が永久に削除されます。", + "noSimilarSongsFound": "類似の曲が見つかりませんでした", + "noTopSongsFound": "トップソングが見つかりません" }, "menu": { "library": "ライブラリ", @@ -448,7 +540,13 @@ "albumList": "アルバム", "about": "詳細", "playlists": "プレイリスト", - "sharedPlaylists": "共有プレイリスト" + "sharedPlaylists": "共有プレイリスト", + "librarySelector": { + "allLibraries": "全てのライブラリ( %{count} )", + "multipleLibraries": "%{selected} 個 / %{total} 個のライブラリ", + "selectLibraries": "ライブラリを選択", + "none": "無し" + } }, "player": { "playListsText": "再生リスト", @@ -485,15 +583,34 @@ "disabled": "無効", "waiting": "待機中" } + }, + "tabs": { + "about": "詳細", + "config": "設定" + }, + "config": { + "configName": "設定名", + "environmentVariable": "環境変数", + "currentValue": "現在値", + "configurationFile": "設定ファイル", + "exportToml": "設定をエクスポート(TOML)", + "exportSuccess": "設定をTOML形式でクリップボードへエクスポートしました", + "exportFailed": "設定のコピーに失敗しました", + "devFlagsHeader": "開発フラグ(変更・削除の可能性あり)", + "devFlagsComment": "これらは実験的な設定であり、将来のバージョンで削除される可能性があります" } }, "activity": { "title": "活動", "totalScanned": "スキャン済みフォルダー", - "quickScan": "クイックスキャン", - "fullScan": "フルスキャン", + "quickScan": "クイック", + "fullScan": "フル", "serverUptime": "サーバー稼働時間", - "serverDown": "サーバーオフライン" + "serverDown": "サーバーオフライン", + "scanType": "最終スキャン", + "status": "スキャンエラー", + "elapsedTime": "経過時間", + "selectiveScan": "選択的スキャン" }, "help": { "title": "ホットキー", @@ -508,5 +625,10 @@ "toggle_love": "星の付け外し", "current_song": "現在の曲へ移動" } + }, + "nowPlaying": { + "title": "再生中", + "empty": "何も再生されていません", + "minutesAgo": "%{smart_count} 分前 |||| %{smart_count} 分前" } } \ No newline at end of file diff --git a/resources/i18n/ko.json b/resources/i18n/ko.json index a8b26df6d..6b81e02d8 100644 --- a/resources/i18n/ko.json +++ b/resources/i18n/ko.json @@ -12,6 +12,7 @@ "artist": "아티스트", "album": "앨범", "path": "파일 경로", + "libraryName": "라이브러리", "genre": "장르", "compilation": "컴필레이션", "year": "년", @@ -34,7 +35,8 @@ "participants": "추가 참가자", "tags": "추가 태그", "mappedTags": "매핑된 태그", - "rawTags": "원시 태그" + "rawTags": "원시 태그", + "missing": "누락" }, "actions": { "addToQueue": "나중에 재생", @@ -56,6 +58,7 @@ "playCount": "재생 횟수", "size": "크기", "name": "이름", + "libraryName": "라이브러리", "genre": "장르", "compilation": "컴필레이션", "year": "년", @@ -73,7 +76,8 @@ "releaseType": "유형", "grouping": "그룹", "media": "미디어", - "mood": "분위기" + "mood": "분위기", + "missing": "누락" }, "actions": { "playAll": "재생", @@ -105,7 +109,8 @@ "playCount": "재생 횟수", "rating": "평가", "genre": "장르", - "role": "역할" + "role": "역할", + "missing": "누락" }, "roles": { "albumartist": "앨범 아티스트 |||| 앨범 아티스트들", @@ -120,7 +125,13 @@ "mixer": "믹서 |||| 믹서들", "remixer": "리믹서 |||| 리믹서들", "djmixer": "DJ 믹서 |||| DJ 믹서들", - "performer": "공연자 |||| 공연자들" + "performer": "공연자 |||| 공연자들", + "maincredit": "앨범 아티스트 또는 아티스트 |||| 앨범 아티스트들 또는 아티스트들" + }, + "actions": { + "topSongs": "인기곡", + "shuffle": "셔플", + "radio": "라디오" } }, "user": { @@ -137,19 +148,26 @@ "changePassword": "비밀번호를 변경할까요?", "currentPassword": "현재 비밀번호", "newPassword": "새 비밀번호", - "token": "토큰" + "token": "토큰", + "libraries": "라이브러리" }, "helperTexts": { - "name": "이름 변경 사항은 다음 로그인 시에만 반영됨" + "name": "이름 변경 사항은 다음 로그인 시에만 반영됨", + "libraries": "이 사용자에 대한 특정 라이브러리를 선택하거나 기본 라이브러리를 사용하려면 비움" }, "notifications": { "created": "사용자 생성됨", "updated": "사용자 업데이트됨", "deleted": "사용자 삭제됨" }, + "validation": { + "librariesRequired": "관리자가 아닌 사용자의 경우 최소한 하나의 라이브러리를 선택해야 함" + }, "message": { "listenBrainzToken": "ListenBrainz 사용자 토큰을 입력하세요.", - "clickHereForToken": "여기를 클릭하여 토큰을 얻으세요" + "clickHereForToken": "여기를 클릭하여 토큰을 얻으세요", + "selectAllLibraries": "모든 라이브러리 선택", + "adminAutoLibraries": "관리자 사용자는 자동으로 모든 라이브러리에 접속할 수 있음" } }, "player": { @@ -192,12 +210,18 @@ "selectPlaylist": "재생목록 선택:", "addNewPlaylist": "\"%{name}\" 만들기", "export": "내보내기", + "saveQueue": "재생목록에 대기열 저장", "makePublic": "공개 만들기", - "makePrivate": "비공개 만들기" + "makePrivate": "비공개 만들기", + "searchOrCreate": "재생목록을 검색하거나 입력하여 새 재생목록을 만드세요...", + "pressEnterToCreate": "새 재생목록을 만드려면 Enter 키를 누름", + "removeFromSelection": "선택에서 제거" }, "message": { "duplicate_song": "중복된 노래 추가", - "song_exist": "이미 재생목록에 존재하는 노래입니다. 중복을 추가할까요 아니면 건너뛸까요?" + "song_exist": "이미 재생목록에 존재하는 노래입니다. 중복을 추가할까요 아니면 건너뛸까요?", + "noPlaylistsFound": "재생목록을 찾을 수 없음", + "noPlaylists": "사용 가능한 재생 목록이 없음" } }, "radio": { @@ -238,14 +262,68 @@ "fields": { "path": "경로", "size": "크기", + "libraryName": "라이브러리", "updatedAt": "사라짐" }, "actions": { - "remove": "제거" + "remove": "제거", + "remove_all": "모두 제거" }, "notifications": { "removed": "누락된 파일이 제거되었음" } + }, + "library": { + "name": "라이브러리 |||| 라이브러리들", + "fields": { + "name": "이름", + "path": "경로", + "remotePath": "원격 경로", + "lastScanAt": "최근 스캔", + "songCount": "노래", + "albumCount": "앨범", + "artistCount": "아티스트", + "totalSongs": "노래", + "totalAlbums": "앨범", + "totalArtists": "아티스트", + "totalFolders": "폴더", + "totalFiles": "파일", + "totalMissingFiles": "누락된 파일", + "totalSize": "총 크기", + "totalDuration": "기간", + "defaultNewUsers": "신규 사용자 기본값", + "createdAt": "생성됨", + "updatedAt": "업데이트됨" + }, + "sections": { + "basic": "기본 정보", + "statistics": "통계" + }, + "actions": { + "scan": "라이브러리 스캔", + "manageUsers": "자용자 접속 관리", + "viewDetails": "상세 보기" + }, + "notifications": { + "created": "라이브러리가 성공적으로 생성됨", + "updated": "라이브러리가 성공적으로 업데이트됨", + "deleted": "라이브러리가 성공적으로 삭제됨", + "scanStarted": "라이브러리 스캔 스작됨", + "scanCompleted": "라이브러리 스캔 완료됨" + }, + "validation": { + "nameRequired": "라이브러리 이름이 필요함", + "pathRequired": "라이브러리 경로가 필요함", + "pathNotDirectory": "라이브러리 경로는 디렉터리여야 함", + "pathNotFound": "라이브러리 경로를 찾을 수 없음", + "pathNotAccessible": "라이브러리 경로에 접근할 수 없음", + "pathInvalid": "잘못된 라이브러리 경로" + }, + "messages": { + "deleteConfirm": "이 라이브러리를 삭제할까요? 삭제하면 연결된 모든 데이터와 사용자 접속 권한이 제거됩니다.", + "scanInProgress": "스캔 진행 중...", + "noLibrariesAssigned": "이 사용자에게 할당된 라이브러리가 없음" + } } }, "ra": { @@ -398,11 +476,15 @@ "transcodingDisabled": "웹 인터페이스를 통한 트랜스코딩 구성 변경은 보안상의 이유로 비활성화되어 있습니다. 트랜스코딩 옵션을 변경(편집 또는 추가)하려면, %{config} 구성 옵션으로 서버를 다시 시작하세요.", "transcodingEnabled": "Navidrome은 현재 %{config}로 실행 중이므로 웹 인터페이스를 사용하여 트랜스코딩 설정에서 시스템 명령을 실행할 수 있습니다. 보안상의 이유로 비활성화하고 트랜스코딩 옵션을 구성할 때만 활성화하는 것이 좋습니다.", "songsAddedToPlaylist": "1 개의 노래를 재생목록에 추가하였음 |||| %{smart_count} 개의 노래를 재생 목록에 추가하였음", + "noSimilarSongsFound": "비슷한 노래를 찾을 수 없음", + "noTopSongsFound": "인기곡을 찾을 수 없음", "noPlaylistsAvailable": "사용 가능한 노래 없음", "delete_user_title": "사용자 '%{name}' 삭제", "delete_user_content": "이 사용자와 해당 사용자의 모든 데이터(재생 목록 및 환경 설정 포함)를 삭제할까요?", "remove_missing_title": "누락된 파일들 제거", "remove_missing_content": "선택한 누락된 파일을 데이터베이스에서 삭제할까요? 삭제하면 재생 횟수 및 평점을 포함하여 해당 파일에 대한 모든 참조가 영구적으로 삭제됩니다.", + "remove_all_missing_title": "누락된 모든 파일 제거", + "remove_all_missing_content": "데이터베이스에서 누락된 모든 파일을 제거할까요? 이렇게 하면 해당 게임의 플레이 횟수와 평점을 포함한 모든 참조 내용이 영구적으로 삭제됩니다.", "notifications_blocked": "브라우저 설정에서 이 사이트의 알림을 차단하였음", "notifications_not_available": "이 브라우저는 데스크톱 알림을 지원하지 않거나 https를 통해 Navidrome에 접속하고 있지 않음", "lastfmLinkSuccess": "Last.fm이 성공적으로 연결되었고 스크로블링이 활성화되었음", @@ -429,6 +511,12 @@ }, "menu": { "library": "라이브러리", + "librarySelector": { + "allLibraries": "모든 라이브러리 (%{count})", + "multipleLibraries": "%{selected} / %{total} 라이브러리", + "selectLibraries": "라이브러리 선택", + "none": "없음" + }, "settings": "설정", "version": "버전", "theme": "테마", @@ -491,6 +579,21 @@ "disabled": "비활성화", "waiting": "대기중" } + }, + "tabs": { + "about": "정보", + "config": "구성" + }, + "config": { + "configName": "구성 이름", + "environmentVariable": "환경 변수", + "currentValue": "현재 값", + "configurationFile": "구성 파일", + "exportToml": "구성 내보내기 (TOML)", + "exportSuccess": "TOML 형식으로 클립보드로 내보낸 구성", + "exportFailed": "구성 복사 실패", + "devFlagsHeader": "개발 플래그 (변경/삭제 가능)", + "devFlagsComment": "이는 실험적 설정이므로 향후 버전에서 제거될 수 있음" } }, "activity": { @@ -499,7 +602,15 @@ "quickScan": "빠른 스캔", "fullScan": "전체 스캔", "serverUptime": "서버 가동 시간", - "serverDown": "오프라인" + "serverDown": "오프라인", + "scanType": "유형", + "status": "스캔 오류", + "elapsedTime": "경과 시간" + }, + "nowPlaying": { + "title": "현재 재생 중", + "empty": "재생 중인 콘텐츠 없음", + "minutesAgo": "%{smart_count} 분 전" }, "help": { "title": "Navidrome 단축키", diff --git a/resources/i18n/nl.json b/resources/i18n/nl.json index 07e222e2a..46c3df9de 100644 --- a/resources/i18n/nl.json +++ b/resources/i18n/nl.json @@ -5,7 +5,7 @@ "name": "Nummer |||| Nummers", "fields": { "albumArtist": "Album Artiest", - "duration": "Lengte", + "duration": "Afspeelduur", "trackNumber": "Nummer #", "playCount": "Aantal keren afgespeeld", "title": "Titel", @@ -26,7 +26,21 @@ "bpm": "BPM", "playDate": "Laatst afgespeeld", "channels": "Kanalen", - "createdAt": "Datum toegevoegd" + "createdAt": "Datum toegevoegd", + "grouping": "Groep", + "mood": "Sfeer", + "participants": "Extra deelnemers", + "tags": "Extra tags", + "mappedTags": "Gemapte tags", + "rawTags": "Onbewerkte tags", + "bitDepth": "Bit diepte", + "sampleRate": "Sample waarde", + "missing": "Ontbrekend", + "libraryName": "Bibliotheek", + "composer": "Componist", + "disc": "Schijf %{discNumber}", + "albumGain": "Album gain", + "trackGain": "Nummer gain" }, "actions": { "addToQueue": "Voeg toe aan wachtrij", @@ -35,7 +49,9 @@ "shuffleAll": "Shuffle alles", "download": "Downloaden", "playNext": "Volgende", - "info": "Meer info" + "info": "Meer info", + "showInPlaylist": "Toon in afspeellijst", + "instantMix": "Instant mix" } }, "album": { @@ -46,7 +62,7 @@ "duration": "Afspeelduur", "songCount": "Nummers", "playCount": "Aantal keren afgespeeld", - "name": "Naam", + "name": "Titel", "genre": "Genre", "compilation": "Compilatie", "year": "Jaar", @@ -56,9 +72,18 @@ "createdAt": "Datum toegevoegd", "size": "Grootte", "originalDate": "Origineel", - "releaseDate": "Uitgegeven", + "releaseDate": "Uitgave", "releases": "Uitgave |||| Uitgaven", - "released": "Uitgegeven" + "released": "Uitgave", + "recordLabel": "Label", + "catalogNum": "Catalogus nummer", + "releaseType": "Type", + "grouping": "Groep", + "media": "Media", + "mood": "Sfeer", + "date": "Opnamedatum", + "missing": "Ontbrekend", + "libraryName": "Bibliotheek" }, "actions": { "playAll": "Afspelen", @@ -89,7 +114,30 @@ "playCount": "Afgespeeld", "rating": "Beoordeling", "genre": "Genre", - "size": "Grootte" + "size": "Grootte", + "role": "Rol", + "missing": "Ontbrekend" + }, + "roles": { + "albumartist": "Album artiest |||| Album artiesten", + "artist": "Artiest |||| Artiesten", + "composer": "Componist |||| Componisten", + "conductor": "Dirigent |||| Dirigenten", + "lyricist": "Tekstschrijver |||| Tekstschrijvers", + "arranger": "Arrangeur |||| Arrangeurs", + "producer": "Producent |||| Producenten", + "director": "Regisseur |||| Regisseurs", + "engineer": "Opnametechnicus |||| Opnametechnici", + "mixer": "Mixer |||| Mixers", + "remixer": "Remixer |||| Remixers", + "djmixer": "DJ Mixer |||| DJ Mixers", + "performer": "Performer |||| Performers", + "maincredit": "Album Artiest of Artiest |||| Album Artiesten or Artiesten" + }, + "actions": { + "shuffle": "Shuffle", + "radio": "Radio", + "topSongs": "Beste nummers" } }, "user": { @@ -98,7 +146,7 @@ "userName": "Gebruikersnaam", "isAdmin": "Is beheerder", "lastLoginAt": "Laatst ingelogd op", - "updatedAt": "Laatst gewijzigd op", + "updatedAt": "Laatst bijgewerkt op", "name": "Naam", "password": "Wachtwoord", "createdAt": "Aangemaakt op", @@ -106,19 +154,26 @@ "currentPassword": "Huidig wachtwoord", "newPassword": "Nieuw wachtwoord", "token": "Token", - "lastAccessAt": "Meest recente toegang" + "lastAccessAt": "Meest recente toegang", + "libraries": "Bibliotheken" }, "helperTexts": { - "name": "Naamswijziging wordt pas zichtbaar bij de volgende login" + "name": "Naamswijziging wordt pas zichtbaar bij de volgende login", + "libraries": "Selecteer specifieke bibliotheken voor deze gebruiker, of laat leeg om de standaardbiblliotheken te gebruiken" }, "notifications": { "created": "Aangemaakt door gebruiker", - "updated": "Gewijzigd door gebruiker", - "deleted": "Gewist door gebruiker" + "updated": "Bijgewerkt door gebruiker", + "deleted": "Gebruiker verwijderd" }, "message": { "listenBrainzToken": "Vul je ListenBrainz gebruikers-token in.", - "clickHereForToken": "Klik hier voor je token" + "clickHereForToken": "Klik hier voor je token", + "selectAllLibraries": "Selecteer alle bibliotheken", + "adminAutoLibraries": "Admin gebruikers hebben automatisch toegang tot alle bibliotheken" + }, + "validation": { + "librariesRequired": "Minstens één bibliotheek moet geselecteerd worden voor niet-admin gebruikers" } }, "player": { @@ -147,10 +202,10 @@ "name": "Afspeellijst |||| Afspeellijsten", "fields": { "name": "Titel", - "duration": "Lengte", + "duration": "Afspeelduur", "ownerName": "Eigenaar", "public": "Publiek", - "updatedAt": "Laatst gewijzigd op", + "updatedAt": "Laatst bijgewerkt op", "createdAt": "Aangemaakt op", "songCount": "Nummers", "comment": "Commentaar", @@ -162,11 +217,17 @@ "addNewPlaylist": "Creëer \"%{name}\"", "export": "Exporteer", "makePublic": "Openbaar maken", - "makePrivate": "Privé maken" + "makePrivate": "Privé maken", + "saveQueue": "Bewaar wachtrij als playlist", + "searchOrCreate": "Zoek afspeellijsten of typ om een nieuwe te starten...", + "pressEnterToCreate": "Druk Enter om nieuwe afspeellijst te maken", + "removeFromSelection": "Verwijder van selectie" }, "message": { "duplicate_song": "Dubbele nummers toevoegen", - "song_exist": "Er komen nummers dubbel in de afspeellijst. Wil je de dubbele nummers toevoegen of overslaan?" + "song_exist": "Er komen nummers dubbel in de afspeellijst. Wil je de dubbele nummers toevoegen of overslaan?", + "noPlaylistsFound": "Geen playlists gevonden", + "noPlaylists": "Geen playlists beschikbaar" } }, "radio": { @@ -175,8 +236,8 @@ "name": "Naam", "streamUrl": "Stream URL", "homePageUrl": "Hoofdpagina URL", - "updatedAt": "Geüpdate op", - "createdAt": "Gecreëerd op" + "updatedAt": "Bijgewerkt op", + "createdAt": "Aangemaakt op" }, "actions": { "playNow": "Speel nu" @@ -194,10 +255,160 @@ "visitCount": "Bezocht", "format": "Formaat", "maxBitRate": "Max. bitrate", - "updatedAt": "Geüpdatet op", - "createdAt": "Gecreëerd op", + "updatedAt": "Bijgewerkt op", + "createdAt": "Aangemaakt op", "downloadable": "Downloads toestaan?" } + }, + "missing": { + "name": "Ontbrekend bestand |||| Ontbrekende bestanden", + "fields": { + "path": "Pad", + "size": "Grootte", + "updatedAt": "Verdwenen op", + "libraryName": "Bibliotheek" + }, + "actions": { + "remove": "Verwijder", + "remove_all": "Alles verwijderen" + }, + "notifications": { + "removed": "Ontbrekende bestanden verwijderd" + }, + "empty": "Geen ontbrekende bestanden" + }, + "library": { + "name": "Bibliotheek |||| Bibliotheken", + "fields": { + "name": "Naam", + "path": "Pad", + "remotePath": "Extern pad", + "lastScanAt": "Laatste scan", + "songCount": "Nummers", + "albumCount": "Albums", + "artistCount": "Artiesten", + "totalSongs": "Nummers", + "totalAlbums": "Albums", + "totalArtists": "Artiesten", + "totalFolders": "Mappen", + "totalFiles": "Bestanden", + "totalMissingFiles": "Ontbrekende bestanden", + "totalSize": "Totale bestandsgrootte", + "totalDuration": "Afspeelduur", + "defaultNewUsers": "Standaard voor nieuwe gebruikers", + "createdAt": "Aangemaakt", + "updatedAt": "Bijgewerkt" + }, + "sections": { + "basic": "Basisinformatie", + "statistics": "Statistieken" + }, + "actions": { + "scan": "Scan bibliotheek", + "manageUsers": "Beheer gebruikerstoegang", + "viewDetails": "Bekijk details", + "quickScan": "Snelle scan", + "fullScan": "Volledige scan" + }, + "notifications": { + "created": "Bibliotheek succesvol aangemaakt", + "updated": "Bibliotheek succesvol bijgewerkt", + "deleted": "Bibliotheek succesvol verwijderd", + "scanStarted": "Bibliotheekscan is gestart", + "scanCompleted": "Bibliotheekscan is voltooid", + "quickScanStarted": "Snelle scan gestart", + "fullScanStarted": "Volledige scan gestart", + "scanError": "Fout bij start van scan. Check de logs" + }, + "validation": { + "nameRequired": "Bibliotheek naam is vereist", + "pathRequired": "Pad naar bibliotheek is vereist", + "pathNotDirectory": "Pad naar bibliotheek moet een map zijn", + "pathNotFound": "Pad naar bibliotheek niet gevonden", + "pathNotAccessible": "Pad naar bibliotheek is niet toegankelijk", + "pathInvalid": "Ongeldig pad naar bibliotheek" + }, + "messages": { + "deleteConfirm": "Weet je zeker dat je deze bibliotheek wil verwijderen? Dit verwijdert ook alle gerelateerde data en gebruikerstoegang.", + "scanInProgress": "Scan is bezig...", + "noLibrariesAssigned": "Geen bibliotheken aan deze gebruiker toegewezen" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Naam", + "description": "Omschrijving", + "version": "Versie", + "author": "Auteur", + "website": "Website", + "permissions": "Permissies", + "enabled": "Aangezet", + "status": "Status", + "path": "Pad", + "lastError": "Fout", + "hasError": "Fout", + "updatedAt": "Geupdate", + "createdAt": "Geinstalleerd", + "configKey": "Sleutel", + "configValue": "Waarde", + "allUsers": "Sta toe voor alle gebruikers", + "selectedUsers": "Geselecteerde gebruikers", + "allLibraries": "Sta toe voor alle bibliotheken", + "selectedLibraries": "Geselecteerde bibliotheken", + "allowWriteAccess": "Sta schrijftoegang toe" + }, + "sections": { + "status": "Status", + "info": "Plugin informatie", + "configuration": "Configuratie", + "manifest": "Manifest", + "usersPermission": "Gebruikers permissie", + "libraryPermission": "Bibliotheekpermissie" + }, + "status": { + "enabled": "Aangezet", + "disabled": "Uitgezet" + }, + "actions": { + "enable": "Aanzetten", + "disable": "Uitzetten", + "disabledDueToError": "Herstel de fout voor aanzetten", + "disabledUsersRequired": "Selecteer gebruikers voor aanzetten", + "disabledLibrariesRequired": "Selecteer bibliotheek voor aanzetten", + "addConfig": "Configuratie toevoegen", + "rescan": "Opnieuw scannen" + }, + "notifications": { + "enabled": "Plugin actief", + "disabled": "Plugin niet actief", + "updated": "Plugin bijgewerkt", + "error": "Fout bij updaten plugin" + }, + "validation": { + "invalidJson": "Configuratie moet geldige JSON zijn" + }, + "messages": { + "configHelp": "Configureer de plug-in met key-value paren. Leeglaten als de plug-in niet geconfigueerd hoeft te worden.", + "clickPermissions": "Klik op permissie voor details", + "noConfig": "Geen configuratie ingesteld", + "allUsersHelp": "Als dit aanstaat heeft de plug-in toegang tot alle gebruikers, inclusief toekomstige.", + "noUsers": "Geen gebruikers geselecteerd", + "permissionReason": "Reden", + "usersRequired": "Deze plug-in heeft toegang nodig tot gebruikersinformatie. Selecteer welke gebruikers de plug-in toegang toe heeft, of schakel 'sta toe voor alle gebruikers' in.", + "allLibrariesHelp": "Als dit aanstaat, heeft de plug-in toegang tot alle bibliotheken, inclusief toekomstige.", + "noLibraries": "Geen bibliotheken geselecteerd", + "librariesRequired": "Deze plug-in heeft toegang nodig tot bibliotheek informatie. Selecteer welke bibliotheken de plug-in toegang to heeft, of schakel 'sta toe voor alle bibliotheken' in.", + "requiredHosts": "Benodigde hosts", + "configValidationError": "Configuratiecheck mislukt", + "schemaRenderError": "Kan het configuratieformulier niet verwerken. Het plugin schema is wellicht ongeldig.", + "allowWriteAccessHelp": "Met dit ingeschakeld, kan de plug-in bestanden bewerken in de bibliotheekmappen. Standaard kunnen plug-ins alleen lezen." + }, + "placeholders": { + "configKey": "Sleutel", + "configValue": "Waarde" + } } }, "ra": { @@ -212,7 +423,8 @@ "password": "Wachtwoord", "sign_in": "Inloggen", "sign_in_error": "Authenticatie mislukt, probeer opnieuw a.u.b.", - "logout": "Uitloggen" + "logout": "Uitloggen", + "insightsCollectionNote": "Navidrome verzamelt anonieme gebruiksdata om het project te verbeteren. Klik [hier] voor meer info en de mogelijkheid om te weigeren" }, "validation": { "invalidChars": "Gebruik alleen letters en cijfers", @@ -374,7 +586,20 @@ "shareSuccess": "URL gekopieeerd naar klembord: %{url}", "shareFailure": "Fout bij kopieren URL %{url} naar klembord", "downloadDialogTitle": "Download %{resource} '%{name}' (%{size})", - "shareCopyToClipboard": "Kopieeer naar klembord: Ctrl+C, Enter" + "shareCopyToClipboard": "Kopieeer naar klembord: Ctrl+C, Enter", + "remove_missing_title": "Verwijder ontbrekende bestanden", + "remove_missing_content": "Weet je zeker dat je alle ontbrekende bestanden van de database wil verwijderen? Dit wist permanent al hun referenties inclusief afspeel tellers en beoordelingen.", + "remove_all_missing_title": "Verwijder alle ontbrekende bestanden", + "remove_all_missing_content": "Weet je zeker dat je alle ontbrekende bestanden van de database wil verwijderen? Dit wist permanent al hun referenties inclusief afspeel tellers en beoordelingen.", + "noSimilarSongsFound": "Geen vergelijkbare nummers gevonden", + "noTopSongsFound": "Geen beste nummers gevonden", + "startingInstantMix": "Laden van Instant mix...", + "uploadCover": "Albumhoes toevoegen", + "removeCover": "Verwijder albumhoes", + "coverUploaded": "Albumhoes bijgewerkt", + "coverRemoved": "Albumhoes verwijderd", + "coverUploadError": "Fout bij het toevoegen albumhoes", + "coverRemoveError": "Fout bij verwijderen albumhoes" }, "menu": { "library": "Bibliotheek", @@ -396,22 +621,29 @@ "none": "Uitgeschakeld", "album": "Gebruik Album Gain", "track": "Gebruik Track Gain" - } + }, + "lastfmNotConfigured": "Last.fm API-sleutel is niet geconfigureerd" } }, "albumList": "Albums", "about": "Over", - "playlists": "Playlists", - "sharedPlaylists": "Gedeelde playlists" + "playlists": "Afspeellijsten", + "sharedPlaylists": "Gedeelde afspeellijsten", + "librarySelector": { + "allLibraries": "Alle bibliotheken (%{count})", + "multipleLibraries": "%{selected} van %{total} bibliotheken", + "selectLibraries": "Selecteer bibliotheken", + "none": "Geen" + } }, "player": { - "playListsText": "Afspeellijst afspelen", + "playListsText": "Wachtrij", "openText": "Openen", "closeText": "Sluiten", "notContentText": "Geen muziek", "clickToPlayText": "Klik om af te spelen", "clickToPauseText": "Klik om te pauzeren", - "nextTrackText": "Volgende", + "nextTrackText": "Volgend nummer", "previousTrackText": "Vorige", "reloadText": "Herladen", "volumeText": "Volume", @@ -433,16 +665,41 @@ "links": { "homepage": "Thuispagina", "source": "Broncode", - "featureRequests": "Functie verzoeken" + "featureRequests": "Functie verzoeken", + "lastInsightsCollection": "Laatste inzichten", + "insights": { + "disabled": "Uitgeschakeld", + "waiting": "Wachten" + } + }, + "tabs": { + "about": "Over", + "config": "Configuratie" + }, + "config": { + "configName": "Config Naam", + "environmentVariable": "Omgevingsvariabele", + "currentValue": "Huidige waarde", + "configurationFile": "Configuratiebestand", + "exportToml": "Exporteer configuratie (TOML)", + "exportSuccess": "Configuratie geëxporteerd naar klembord in TOML formaat", + "exportFailed": "Kopiëren van configuratie mislukt", + "devFlagsHeader": "Ontwikkelaarsinstellingen (onder voorbehoud)", + "devFlagsComment": "Dit zijn experimentele instellingen en worden mogelijk in latere versies verwijderd", + "downloadToml": "Download configuratie (TOML)" } }, "activity": { "title": "Activiteit", - "totalScanned": "Totaal gescande folders", + "totalScanned": "Totaal gescande mappen", "quickScan": "Snelle scan", "fullScan": "Volledige scan", "serverUptime": "Server uptime", - "serverDown": "Offline" + "serverDown": "Offline", + "scanType": "Type", + "status": "Scan fout", + "elapsedTime": "Verlopen tijd", + "selectiveScan": "Selectief" }, "help": { "title": "Navidrome sneltoetsen", @@ -457,5 +714,10 @@ "toggle_love": "Voeg toe aan favorieten", "current_song": "Ga naar huidig nummer" } + }, + "nowPlaying": { + "title": "Speelt nu", + "empty": "Er wordt niets afgespeed", + "minutesAgo": "%{smart_count} minuut geleden |||| %{smart_count} minuten geleden" } } \ No newline at end of file diff --git a/resources/i18n/no.json b/resources/i18n/no.json index 84198fca7..3b75bab25 100644 --- a/resources/i18n/no.json +++ b/resources/i18n/no.json @@ -18,8 +18,6 @@ "size": "Filstørrelse", "updatedAt": "Oppdatert", "bitRate": "Bit rate", - "bitDepth": "Bit depth", - "channels": "Kanaler", "discSubtitle": "Disk Undertittel", "starred": "Favoritt", "comment": "Kommentar", @@ -27,13 +25,18 @@ "quality": "Kvalitet", "bpm": "BPM", "playDate": "Sist Avspilt", + "channels": "Kanaler", "createdAt": "Lagt til", "grouping": "Gruppering", "mood": "Stemning", "participants": "Ytterlige deltakere", "tags": "Ytterlige Tags", "mappedTags": "Kartlagte tags", - "rawTags": "Rå tags" + "rawTags": "Rå tags", + "bitDepth": "Bit depth", + "sampleRate": "", + "missing": "", + "libraryName": "" }, "actions": { "addToQueue": "Avspill senere", @@ -42,7 +45,8 @@ "shuffleAll": "Shuffle Alle", "download": "Last ned", "playNext": "Avspill neste", - "info": "Få Info" + "info": "Få Info", + "showInPlaylist": "" } }, "album": { @@ -53,36 +57,38 @@ "duration": "Tid", "songCount": "Sanger", "playCount": "Avspillinger", - "size": "Størrelse", "name": "Navn", "genre": "Sjanger", "compilation": "Samling", "year": "År", - "date": "Inspillingsdato", - "originalDate": "Original", - "releaseDate": "Utgitt", - "releases": "Utgivelse |||| Utgivelser", - "released": "Utgitt", "updatedAt": "Oppdatert", "comment": "Kommentar", "rating": "Rangering", "createdAt": "Lagt Til", + "size": "Størrelse", + "originalDate": "Original", + "releaseDate": "Utgitt", + "releases": "Utgivelse |||| Utgivelser", + "released": "Utgitt", "recordLabel": "Plateselskap", "catalogNum": "Katalognummer", "releaseType": "Type", "grouping": "Gruppering", "media": "Media", - "mood": "Stemning" + "mood": "Stemning", + "date": "Inspillingsdato", + "missing": "", + "libraryName": "" }, "actions": { "playAll": "Avspill", "playNext": "Avspill Neste", "addToQueue": "Avspill Senere", - "share": "Del", "shuffle": "Shuffle", "addToPlaylist": "Legg til i spilleliste", "download": "Last ned", - "info": "Få Info" + "info": "Få Info", + "share": "Del" }, "lists": { "all": "Alle", @@ -100,11 +106,12 @@ "name": "Navn", "albumCount": "Album Antall", "songCount": "Song Antall", - "size": "Størrelse", "playCount": "Avspillinger", "rating": "Rangering", "genre": "Sjanger", - "role": "Rolle" + "size": "Størrelse", + "role": "Rolle", + "missing": "" }, "roles": { "albumartist": "Album Artist |||| Album Artister", @@ -119,7 +126,13 @@ "mixer": "Mixer |||| Mixers", "remixer": "Remixer |||| Remixers", "djmixer": "DJ Mixer |||| DJ Mixers", - "performer": "Performer |||| Performers" + "performer": "Performer |||| Performers", + "maincredit": "" + }, + "actions": { + "shuffle": "", + "radio": "", + "topSongs": "" } }, "user": { @@ -128,7 +141,6 @@ "userName": "Brukernavn", "isAdmin": "Admin", "lastLoginAt": "Sist Pålogging", - "lastAccessAt": "Sist Tilgang", "updatedAt": "Oppdatert", "name": "Navn", "password": "Passord", @@ -136,10 +148,13 @@ "changePassword": "Bytt Passord?", "currentPassword": "Nåværende Passord", "newPassword": "Nytt Passord", - "token": "Token" + "token": "Token", + "lastAccessAt": "Sist Tilgang", + "libraries": "" }, "helperTexts": { - "name": "Navnendringer vil ikke være synlig før neste pålogging" + "name": "Navnendringer vil ikke være synlig før neste pålogging", + "libraries": "" }, "notifications": { "created": "Bruker opprettet", @@ -148,7 +163,12 @@ }, "message": { "listenBrainzToken": "Fyll inn din ListenBrainz bruker token.", - "clickHereForToken": "Klikk her for å hente din token" + "clickHereForToken": "Klikk her for å hente din token", + "selectAllLibraries": "", + "adminAutoLibraries": "" + }, + "validation": { + "librariesRequired": "" } }, "player": { @@ -192,11 +212,17 @@ "addNewPlaylist": "Opprett \"%{name}\"", "export": "Eksporter", "makePublic": "Gjør Offentlig", - "makePrivate": "Gjør Privat" + "makePrivate": "Gjør Privat", + "saveQueue": "", + "searchOrCreate": "", + "pressEnterToCreate": "", + "removeFromSelection": "" }, "message": { "duplicate_song": "Legg til Duplikater", - "song_exist": "Duplikater har blitt lagt til i spillelisten. Ønsker du å legge til duplikater eller hoppe over de?" + "song_exist": "Duplikater har blitt lagt til i spillelisten. Ønsker du å legge til duplikater eller hoppe over de?", + "noPlaylistsFound": "", + "noPlaylists": "" } }, "radio": { @@ -218,7 +244,6 @@ "username": "Delt Av", "url": "URL", "description": "Beskrivelse", - "downloadable": "Tillat Nedlastinger?", "contents": "Innhold", "expiresAt": "Utløper", "lastVisitedAt": "Sist Besøkt", @@ -226,24 +251,82 @@ "format": "Format", "maxBitRate": "Maks. Bit Rate", "updatedAt": "Oppdatert", - "createdAt": "Opprettet" - }, - "notifications": {}, - "actions": {} + "createdAt": "Opprettet", + "downloadable": "Tillat Nedlastinger?" + } }, "missing": { "name": "Manglende Fil|||| Manglende Filer", - "empty": "Ingen Manglende Filer", "fields": { "path": "Filsti", "size": "Størrelse", - "updatedAt": "Ble borte" + "updatedAt": "Ble borte", + "libraryName": "" }, "actions": { - "remove": "Fjern" + "remove": "Fjern", + "remove_all": "" }, "notifications": { "removed": "Manglende fil(er) fjernet" + }, + "empty": "Ingen Manglende Filer" + }, + "library": { + "name": "", + "fields": { + "name": "", + "path": "", + "remotePath": "", + "lastScanAt": "", + "songCount": "", + "albumCount": "", + "artistCount": "", + "totalSongs": "", + "totalAlbums": "", + "totalArtists": "", + "totalFolders": "", + "totalFiles": "", + "totalMissingFiles": "", + "totalSize": "", + "totalDuration": "", + "defaultNewUsers": "", + "createdAt": "", + "updatedAt": "" + }, + "sections": { + "basic": "", + "statistics": "" + }, + "actions": { + "scan": "", + "manageUsers": "", + "viewDetails": "", + "quickScan": "", + "fullScan": "" + }, + "notifications": { + "created": "", + "updated": "", + "deleted": "Biblioteket slettet", + "scanStarted": "Skanning startet", + "scanCompleted": "", + "quickScanStarted": "", + "fullScanStarted": "", + "scanError": "Error starte skanning. Sjekk loggene" + }, + "validation": { + "nameRequired": "", + "pathRequired": "", + "pathNotDirectory": "", + "pathNotFound": "", + "pathNotAccessible": "", + "pathInvalid": "" + }, + "messages": { + "deleteConfirm": "", + "scanInProgress": "", + "noLibrariesAssigned": "" } } }, @@ -282,7 +365,6 @@ "add": "Legg Til", "back": "Tilbake", "bulk_actions": "1 element valgt |||| %{smart_count} elementer valgt", - "bulk_actions_mobile": "1 |||| %{smart_count}", "cancel": "Avbryt", "clear_input_value": "Nullstill verdi", "clone": "Klone", @@ -306,6 +388,7 @@ "close_menu": "Lukk meny", "unselect": "Avvelg", "skip": "Hopp over", + "bulk_actions_mobile": "1 |||| %{smart_count}", "share": "Del", "download": "Last Ned" }, @@ -400,31 +483,35 @@ "noPlaylistsAvailable": "Ingen tilgjengelig", "delete_user_title": "Slett bruker '%{name}'", "delete_user_content": "Er du sikker på at du vil slette denne brukeren og all tilhørlig data (inkludert spillelister og preferanser)?", - "remove_missing_title": "Fjern manglende filer", - "remove_missing_content": "Er du sikker på at du ønsker å fjerne de valgte manglende filene fra databasen? Dette vil permanent fjerne alle referanser til de, inkludert antall avspillinger og rangeringer.", "notifications_blocked": "Du har blokkert notifikasjoner for denne nettsiden i din nettleser.", "notifications_not_available": "Denne nettleseren støtter ikke skrivebordsnotifikasjoner, eller så er du ikke tilkoblet Navidrome via https.", "lastfmLinkSuccess": "Last.fm er tilkoblet og scrobbling er aktivert", "lastfmLinkFailure": "Last.fm kunne ikke koble til", "lastfmUnlinkSuccess": "Last.fm er avkoblet og scrobbling er deaktivert", "lastfmUnlinkFailure": "Last.fm kunne ikke avkobles", - "listenBrainzLinkSuccess": "ListenBrainz er koblet til og scrobbling er aktivert som bruker: %{user}", - "listenBrainzLinkFailure": "ListenBrainz kunne ikke koble til: %{error}", - "listenBrainzUnlinkSuccess": "ListenBrainz er avkoblet og scrobbling er deaktivert", - "listenBrainzUnlinkFailure": "ListenBrainz kunne ikke avkobles", "openIn": { "lastfm": "Åpne i Last.fm", "musicbrainz": "Åpne i MusicBrainz" }, "lastfmLink": "Les Mer...", + "listenBrainzLinkSuccess": "ListenBrainz er koblet til og scrobbling er aktivert som bruker: %{user}", + "listenBrainzLinkFailure": "ListenBrainz kunne ikke koble til: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz er avkoblet og scrobbling er deaktivert", + "listenBrainzUnlinkFailure": "ListenBrainz kunne ikke avkobles", + "downloadOriginalFormat": "Last ned i originalformat", "shareOriginalFormat": "Del i originalformat", "shareDialogTitle": "Del %{resource} '%{name}'", "shareBatchDialogTitle": "Del 1 %{resource} |||| Del %{smart_count} %{resource}", - "shareCopyToClipboard": "Kopier til utklippstavle: Ctrl+C, Enter", "shareSuccess": "URL kopiert til utklippstavle: %{url}", "shareFailure": "Error ved kopiering av URL %{url} til utklippstavle", "downloadDialogTitle": "Last ned %{resource} '%{name}' (%{size})", - "downloadOriginalFormat": "Last ned i originalformat" + "shareCopyToClipboard": "Kopier til utklippstavle: Ctrl+C, Enter", + "remove_missing_title": "Fjern manglende filer", + "remove_missing_content": "Er du sikker på at du ønsker å fjerne de valgte manglende filene fra databasen? Dette vil permanent fjerne alle referanser til de, inkludert antall avspillinger og rangeringer.", + "remove_all_missing_title": "", + "remove_all_missing_content": "", + "noSimilarSongsFound": "", + "noTopSongsFound": "" }, "menu": { "library": "Bibliotek", @@ -438,7 +525,6 @@ "language": "Språk", "defaultView": "Standardvisning", "desktop_notifications": "Skrivebordsnotifikasjoner", - "lastfmNotConfigured": "Last.fm API-Key er ikke konfigurert", "lastfmScrobbling": "Scrobble til Last.fm", "listenBrainzScrobbling": "Scrobble til ListenBrainz", "replaygain": "ReplayGain Mode", @@ -447,13 +533,20 @@ "none": "Deaktivert", "album": "Bruk Album Gain", "track": "Bruk Track Gain" - } + }, + "lastfmNotConfigured": "Last.fm API-Key er ikke konfigurert" } }, "albumList": "Album", + "about": "Om", "playlists": "Spillelister", "sharedPlaylists": "Delte Spillelister", - "about": "Om" + "librarySelector": { + "allLibraries": "", + "multipleLibraries": "", + "selectLibraries": "", + "none": "" + } }, "player": { "playListsText": "Spill Av Kø", @@ -490,6 +583,21 @@ "disabled": "Deaktivert", "waiting": "Venter" } + }, + "tabs": { + "about": "", + "config": "" + }, + "config": { + "configName": "", + "environmentVariable": "", + "currentValue": "", + "configurationFile": "", + "exportToml": "", + "exportSuccess": "", + "exportFailed": "", + "devFlagsHeader": "", + "devFlagsComment": "" } }, "activity": { @@ -498,7 +606,11 @@ "quickScan": "Hurtigskann", "fullScan": "Full Skann", "serverUptime": "Server Oppetid", - "serverDown": "OFFLINE" + "serverDown": "OFFLINE", + "scanType": "", + "status": "", + "elapsedTime": "", + "selectiveScan": "Utvalgt" }, "help": { "title": "Navidrome Hurtigtaster", @@ -508,10 +620,15 @@ "toggle_play": "Avspill / Pause", "prev_song": "Forrige Sang", "next_song": "Neste Sang", - "current_song": "Gå til Nåværende Sang", "vol_up": "Volum Opp", "vol_down": "Volum Ned", - "toggle_love": "Legg til spor i favoritter" + "toggle_love": "Legg til spor i favoritter", + "current_song": "Gå til Nåværende Sang" } + }, + "nowPlaying": { + "title": "", + "empty": "", + "minutesAgo": "" } -} +} \ No newline at end of file diff --git a/resources/i18n/pl.json b/resources/i18n/pl.json index e75a9f404..6229798e9 100644 --- a/resources/i18n/pl.json +++ b/resources/i18n/pl.json @@ -33,7 +33,11 @@ "tags": "Dodatkowe Tagi", "mappedTags": "Zmapowane tagi", "rawTags": "Surowe tagi", - "bitDepth": "Głębokość próbkowania" + "bitDepth": "Głębokość próbkowania", + "sampleRate": "Częstotliwość próbkowania", + "missing": "Brak", + "libraryName": "Biblioteka", + "composer": "Kompozytor" }, "actions": { "addToQueue": "Odtwarzaj Później", @@ -42,7 +46,9 @@ "shuffleAll": "Losuj Wszystkie", "download": "Pobierz", "playNext": "Odtwarzaj Następny", - "info": "Zdobądź Informacje" + "info": "Zdobądź Informacje", + "showInPlaylist": "Pokaż w Liście Odtwarzania", + "instantMix": "Natychmiastowy Miks" } }, "album": { @@ -72,7 +78,9 @@ "grouping": "Grupowanie", "media": "Media", "mood": "Nastrój", - "date": "" + "date": "Data Nagrania", + "missing": "Brak", + "libraryName": "Biblioteka" }, "actions": { "playAll": "Odtwarzaj", @@ -104,7 +112,8 @@ "rating": "Ocena", "genre": "Gatunek", "size": "Rozmiar", - "role": "Rola" + "role": "Rola", + "missing": "Brak" }, "roles": { "albumartist": "Wykonawca Albumu |||| Wykonawcy Albumu", @@ -119,7 +128,13 @@ "mixer": "Mikser |||| Mikserzy", "remixer": "Remixer |||| Remixerzy", "djmixer": "Didżej |||| Didżerzy", - "performer": "Wykonawca |||| Wykonawcy" + "performer": "Wykonawca |||| Wykonawcy", + "maincredit": "Artysta albumu lub Artysta |||| Artyści albumu lub Artyści" + }, + "actions": { + "shuffle": "Losuj", + "radio": "Radio", + "topSongs": "Najlepsze Utwory" } }, "user": { @@ -136,10 +151,12 @@ "currentPassword": "Obecne hasło", "newPassword": "Nowe hasło", "token": "Token", - "lastAccessAt": "Ostatnia Aktywność" + "lastAccessAt": "Ostatnia Aktywność", + "libraries": "Biblioteki" }, "helperTexts": { - "name": "Zmiana nazwy będzie widoczna przy następnym logowaniu" + "name": "Zmiana nazwy będzie widoczna przy następnym logowaniu", + "libraries": "Wybierz biblioteki dla użytkownika lub pozostaw pustę, aby użyć domyślnej biblioteki" }, "notifications": { "created": "Dodano użytkownika", @@ -148,7 +165,12 @@ }, "message": { "listenBrainzToken": "Wprowadź swój token ListenBrainz.", - "clickHereForToken": "Kliknij tutaj, aby uzyskać token" + "clickHereForToken": "Kliknij tutaj, aby uzyskać token", + "selectAllLibraries": "Wybierz wszystkie biblioteki", + "adminAutoLibraries": "Administratorzy automatycznie mają dostęp do wszystkich bibliotek" + }, + "validation": { + "librariesRequired": "Przynajmniej jedna biblioteka musi być wybrana dla zwykłego użytkownika" } }, "player": { @@ -192,11 +214,17 @@ "addNewPlaylist": "Stwórz \"%{name}\"", "export": "Wyeksportuj", "makePublic": "Zmień na Publiczną", - "makePrivate": "Zmień na Prywatną" + "makePrivate": "Zmień na Prywatną", + "saveQueue": "Zapisz Kolejkę do Playlisty", + "searchOrCreate": "Szukaj list odtwarzania lub zacznij pisać, aby stworzyć nową...", + "pressEnterToCreate": "Wciśnij Enter, aby stworzyć nową listę odtwarzania", + "removeFromSelection": "Usuń z zaznaczenia" }, "message": { "duplicate_song": "Dodaj zduplikowane utwory", - "song_exist": "Do playlisty dodawane są duplikaty. Czy chcesz je dodać czy pominąć?" + "song_exist": "Do playlisty dodawane są duplikaty. Czy chcesz je dodać czy pominąć?", + "noPlaylistsFound": "Brak list odtwarzania", + "noPlaylists": "Brak dostępnych list odtwarzania" } }, "radio": { @@ -234,15 +262,148 @@ "fields": { "path": "Ścieżka", "size": "Rozmiar", - "updatedAt": "Zniknął na" + "updatedAt": "Zniknął na", + "libraryName": "Biblioteka" }, "actions": { - "remove": "Usuń" + "remove": "Usuń", + "remove_all": "Usuń Wszystko" }, "notifications": { "removed": "Usunięto brakujące pliki" }, - "empty": "Bez Brakujących Plików" + "empty": "Brak Brakujących Plików" + }, + "library": { + "name": "Biblioteka |||| Biblioteki", + "fields": { + "name": "Nazwa", + "path": "Ścieżka", + "remotePath": "Zdalna Ścieżka", + "lastScanAt": "Ostatni Skan", + "songCount": "Utwory", + "albumCount": "Albumy", + "artistCount": "Artyści", + "totalSongs": "Utwory", + "totalAlbums": "Albumy", + "totalArtists": "Artyści", + "totalFolders": "Foldery", + "totalFiles": "Pliki", + "totalMissingFiles": "Brakujące Pliki", + "totalSize": "Całkowity Rozmiar", + "totalDuration": "Czas Trwania", + "defaultNewUsers": "Domyślne dla Nowych Użytkowników", + "createdAt": "Stworzona", + "updatedAt": "Zaktualizowana" + }, + "sections": { + "basic": "Podstawowe Informacje", + "statistics": "Statystyki" + }, + "actions": { + "scan": "Skanuj Bibliotekę", + "manageUsers": "Zarządzaj Dostępami Użytkownika", + "viewDetails": "Zobacz Szczegóły", + "quickScan": "Szybkie Skanowanie", + "fullScan": "Pełne Skanowanie" + }, + "notifications": { + "created": "Biblioteka utworzona prawidłowo", + "updated": "Biblioteka zaktualizowana prawidłowo", + "deleted": "Biblioteka usunięta prawidłowo", + "scanStarted": "Rozpoczęto skan biblioteki", + "scanCompleted": "Zakończono skan biblioteki", + "quickScanStarted": "Szybkie skanowanie rozpoczęte", + "fullScanStarted": "Pełne skanowanie rozpoczęte", + "scanError": "Błąd podczas startu skanowania. Sprawdź logi" + }, + "validation": { + "nameRequired": "Nazwa biblioteki jest wymagana", + "pathRequired": "Ścieżka biblioteki jest wymagana", + "pathNotDirectory": "Ścieżka biblioteki musi być katalogiem", + "pathNotFound": "Brak ścieżki biblioteki", + "pathNotAccessible": "Ścieżka biblioteki niedostępna", + "pathInvalid": "Niepoprawna ścieżka biblioteki" + }, + "messages": { + "deleteConfirm": "Czy chcesz usunąć tę bibliotekę? Spowoduje to usunięcie wszystkich powiązanych danych i dostępów użytkowników.", + "scanInProgress": "Skanowanie w trakcie...", + "noLibrariesAssigned": "Brak bibliotek przypisanych do tego użytkownika" + } + }, + "plugin": { + "name": "\nWtyczka |||| Wtyczki", + "fields": { + "id": "ID", + "name": "Nazwa", + "description": "Opis", + "version": "Wersja", + "author": "Autor", + "website": "Witryna", + "permissions": "Uprawnienia", + "enabled": "Aktywny", + "status": "Status", + "path": "Ścieżka", + "lastError": "Błąd", + "hasError": "Błąd", + "updatedAt": "Zaktualizowana", + "createdAt": "Zainstalowana", + "configKey": "Klucz", + "configValue": "Wartość", + "allUsers": "Zezwalaj wszystkim użytkownikom", + "selectedUsers": "Wybrani użytkownicy", + "allLibraries": "Zezwalaj dla wszystkich bibliotek", + "selectedLibraries": "Wybrane biblioteki" + }, + "sections": { + "status": "Status", + "info": "Informacje O Wtyczce", + "configuration": "Konfiguracja", + "manifest": "Manifest", + "usersPermission": "Uprawnienia Użytkowników", + "libraryPermission": "Uprawnienia Biblioteki" + }, + "status": { + "enabled": "Włączona", + "disabled": "Wyłączona" + }, + "actions": { + "enable": "Włącz", + "disable": "Wyłącz", + "disabledDueToError": "Napraw błąd przed włączeniem", + "disabledUsersRequired": "Wybierz użytkowników przed włączeniem", + "disabledLibrariesRequired": "Wybierz biblioteki przed włączaniem", + "addConfig": "Dodaj Konfigurację", + "rescan": "Przeskanuj Ponownie" + }, + "notifications": { + "enabled": "Wtyczka włączona", + "disabled": "Wtyczka wyłączona", + "updated": "Wtyczka zaktualizowana", + "error": "Błąd aktualizacji wtyczki" + }, + "validation": { + "invalidJson": "Konfiguracja musić być w poprawnym formacie JSON" + }, + "messages": { + "configHelp": "Użyj par klucz-wartość, aby skonfigurować wtyczkę. Pozostaw puste, jeśli wtyczka nie wymaga konfiguracji.", + "clickPermissions": "Kliknij uprawnienie, aby uzyskać szczegółowe informacje", + "noConfig": "Nie wybrano konfiguracji", + "allUsersHelp": "Po włączeniu wtyczka będzie miała dostęp do wszystkich użytkowników, także tych utworzonych w przyszłości.", + "noUsers": "Nie wybrano użytkowników", + "permissionReason": "Powód", + "usersRequired": "Ta wtyczka wymaga dostępu do informacji o użytkowniku. Wybierz użytkowników, do których wtyczka ma mieć dostęp, lub włącz opcję „Zezwól wszystkim użytkownikom”.", + "allLibrariesHelp": "Po włączeniu wtyczka będzie miała dostęp do wszystkich bibliotek, także tych utworzonych w przyszłości.", + "noLibraries": "Nie wybrano biblioteki", + "librariesRequired": "Wtyczka wymaga dostępu do informacji o bibliotece. Wybierz, dla której biblioteki zezwolić dostęp, lub włącz 'Zezwalaj dla wszystkich bibliotek'.", + "requiredHosts": "Wymagane hosty", + "configValidationError": "Weryfikacja konfiguracji nie powiodła się:", + "schemaRenderError": "Nie można wyrenderować formularza konfiguracji. Schemat wtyczki może być nieprawidłowy." + }, + "placeholders": { + "configKey": "klucz", + "configValue": "wartość" + } } }, "ra": { @@ -422,7 +583,12 @@ "downloadDialogTitle": "Pobierz %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Skopiuj do schowka: Ctrl+C, Enter", "remove_missing_title": "Usuń brakujące dane", - "remove_missing_content": "Czy na pewno chcesz usunąć wybrane brakujące pliki z bazy danych? Spowoduje to trwałe usunięcie wszystkich powiązań, takich jak liczba odtworzeń i oceny." + "remove_missing_content": "Czy na pewno chcesz usunąć wybrane brakujące pliki z bazy danych? Spowoduje to trwałe usunięcie wszystkich powiązań, takich jak liczba odtworzeń i oceny.", + "remove_all_missing_title": "Usuń wszystkie brakujące pliki", + "remove_all_missing_content": "Czy chcesz usunąć wszystkie brakujące pliki z bazy danych? Spowoduje to trwałe usunięcie wszelkich odniesień do tych plików, takich jak liczba odtworzeń, czy oceny.", + "noSimilarSongsFound": "Brak podobnych utworów", + "noTopSongsFound": "Brak najlepszych utworów", + "startingInstantMix": "Ładowanie Natychmiastowego Miksu..." }, "menu": { "library": "Biblioteka", @@ -451,7 +617,13 @@ "albumList": "Albumy", "about": "O aplikacji", "playlists": "Playlisty", - "sharedPlaylists": "Udostępnione Playlisty" + "sharedPlaylists": "Udostępnione Playlisty", + "librarySelector": { + "allLibraries": "Wszystkie Biblioteki (%{count})", + "multipleLibraries": "%{selected} z %{total} Bibliotek", + "selectLibraries": "Wybierz Biblioteki", + "none": "Żadna" + } }, "player": { "playListsText": "Kolejka Odtwarzania", @@ -488,6 +660,21 @@ "disabled": "Wyłączone", "waiting": "Oczekujące" } + }, + "tabs": { + "about": "O", + "config": "Konfiguracja" + }, + "config": { + "configName": "Nazwa Konfiguracji", + "environmentVariable": "Zmienna Środowiskowa", + "currentValue": "Obecna Wartość", + "configurationFile": "Plik Konfiguracyjny", + "exportToml": "Eksportuj Konfigurację (TOML)", + "exportSuccess": "Konfiguracja wyeksportowana do schowka w formacie TOML", + "exportFailed": "Błąd kopiowania konfiguracji", + "devFlagsHeader": "Flagi Rozwojowe (mogą ulec zmianie/usunięciu)", + "devFlagsComment": "To są ustawienia eksperymentalne i mogą zostać usunięte w przyszłych wydaniach" } }, "activity": { @@ -496,7 +683,11 @@ "quickScan": "Szybkie Skanowanie", "fullScan": "Pełne Skanowanie", "serverUptime": "Czas Działania Serwera", - "serverDown": "NIEDOSTĘPNY" + "serverDown": "NIEDOSTĘPNY", + "scanType": "Typ", + "status": "Błąd Skanowania", + "elapsedTime": "Upłynięty Czas", + "selectiveScan": "Selektywne" }, "help": { "title": "Skróty Klawiszowe Navidrome", @@ -511,5 +702,10 @@ "toggle_love": "Dodaj ten utwór do ulubionych", "current_song": "Przejdź do Bieżącego Utworu" } + }, + "nowPlaying": { + "title": "Teraz Odtwarzane", + "empty": "Nic nie jest odtwarzane", + "minutesAgo": "%{smart_count} minutę temu |||| %{smart_count} minut temu" } } \ No newline at end of file diff --git a/resources/i18n/pt-br.json b/resources/i18n/pt-br.json index 3faa1b149..d9f29f5d4 100644 --- a/resources/i18n/pt-br.json +++ b/resources/i18n/pt-br.json @@ -18,7 +18,6 @@ "size": "Tamanho", "updatedAt": "Últ. Atualização", "bitRate": "Bitrate", - "bitDepth": "Profundidade de bits", "discSubtitle": "Sub-título do disco", "starred": "Favorita", "comment": "Comentário", @@ -34,7 +33,14 @@ "tags": "Outras Tags", "mappedTags": "Tags mapeadas", "rawTags": "Tags originais", - "missing": "Ausente" + "bitDepth": "Profundidade de bits", + "sampleRate": "Taxa de amostragem", + "albumGain": "Ganho do álbum", + "trackGain": "Ganho da faixa", + "missing": "Ausente", + "libraryName": "Biblioteca", + "composer": "Compositor", + "disc": "Disco %{discNumber}" }, "actions": { "addToQueue": "Adicionar à fila", @@ -43,7 +49,9 @@ "shuffleAll": "Aleatório", "download": "Baixar", "playNext": "Toca a seguir", - "info": "Detalhes" + "info": "Detalhes", + "showInPlaylist": "Ir para playlist", + "instantMix": "Mix Instantâneo" } }, "album": { @@ -58,7 +66,6 @@ "genre": "Gênero", "compilation": "Coletânea", "year": "Ano", - "date": "Data de Lançamento", "updatedAt": "Últ. Atualização", "comment": "Comentário", "rating": "Classificação", @@ -74,7 +81,9 @@ "grouping": "Agrupamento", "media": "Mídia", "mood": "Mood", - "missing": "Ausente" + "date": "Data de Lançamento", + "missing": "Ausente", + "libraryName": "Biblioteca" }, "actions": { "playAll": "Tocar", @@ -122,7 +131,13 @@ "mixer": "Mixador |||| Mixadores", "remixer": "Remixador |||| Remixadores", "djmixer": "DJ Mixer |||| DJ Mixers", - "performer": "Músico |||| Músicos" + "performer": "Músico |||| Músicos", + "maincredit": "Artista do Álbum ou Artista |||| Artistas do Álbum ou Artistas" + }, + "actions": { + "shuffle": "Aleatório", + "radio": "Rádio", + "topSongs": "Mais tocadas" } }, "user": { @@ -139,10 +154,12 @@ "currentPassword": "Senha Atual", "newPassword": "Nova Senha", "token": "Token", - "lastAccessAt": "Últ. Acesso" + "lastAccessAt": "Últ. Acesso", + "libraries": "Bibliotecas" }, "helperTexts": { - "name": "Alterações no seu nome só serão refletidas no próximo login" + "name": "Alterações no seu nome só serão refletidas no próximo login", + "libraries": "Selecione bibliotecas específicas para este usuário, ou deixe vazio para usar bibliotecas padrão" }, "notifications": { "created": "Novo usuário criado", @@ -151,7 +168,12 @@ }, "message": { "listenBrainzToken": "Entre seu token do ListenBrainz", - "clickHereForToken": "Clique aqui para obter seu token" + "clickHereForToken": "Clique aqui para obter seu token", + "selectAllLibraries": "Selecionar todas as bibliotecas", + "adminAutoLibraries": "Usuários administradores têm acesso automático a todas as bibliotecas" + }, + "validation": { + "librariesRequired": "Pelo menos uma biblioteca deve ser selecionada para usuários não-administradores" } }, "player": { @@ -194,13 +216,18 @@ "selectPlaylist": "Selecione a playlist:", "addNewPlaylist": "Criar \"%{name}\"", "export": "Exportar", - "saveQueue": "Salvar fila em nova Playlist", "makePublic": "Pública", - "makePrivate": "Pessoal" + "makePrivate": "Pessoal", + "saveQueue": "Salvar fila em nova Playlist", + "searchOrCreate": "Buscar playlists ou criar nova...", + "pressEnterToCreate": "Pressione Enter para criar nova playlist", + "removeFromSelection": "Remover da seleção" }, "message": { "duplicate_song": "Adicionar músicas duplicadas", - "song_exist": "Algumas destas músicas já existem na playlist. Você quer adicionar as duplicadas ou ignorá-las?" + "song_exist": "Algumas destas músicas já existem na playlist. Você quer adicionar as duplicadas ou ignorá-las?", + "noPlaylistsFound": "Nenhuma playlist encontrada", + "noPlaylists": "Nenhuma playlist disponível" } }, "radio": { @@ -235,11 +262,11 @@ }, "missing": { "name": "Arquivo ausente |||| Arquivos ausentes", - "empty": "Nenhum arquivo ausente", "fields": { "path": "Caminho", "size": "Tamanho", - "updatedAt": "Desaparecido em" + "updatedAt": "Desaparecido em", + "libraryName": "Biblioteca" }, "actions": { "remove": "Remover", @@ -247,6 +274,140 @@ }, "notifications": { "removed": "Arquivo(s) ausente(s) removido(s)" + }, + "empty": "Nenhum arquivo ausente" + }, + "library": { + "name": "Biblioteca |||| Bibliotecas", + "fields": { + "name": "Nome", + "path": "Caminho", + "remotePath": "Caminho Remoto", + "lastScanAt": "Último Scan", + "songCount": "Músicas", + "albumCount": "Álbuns", + "artistCount": "Artistas", + "totalSongs": "Músicas", + "totalAlbums": "Álbuns", + "totalArtists": "Artistas", + "totalFolders": "Pastas", + "totalFiles": "Arquivos", + "totalMissingFiles": "Arquivos Ausentes", + "totalSize": "Tamanho Total", + "totalDuration": "Duração", + "defaultNewUsers": "Padrão para Novos Usuários", + "createdAt": "Data de Criação", + "updatedAt": "Últ. Atualização" + }, + "sections": { + "basic": "Informações Básicas", + "statistics": "Estatísticas" + }, + "actions": { + "scan": "Scanear Biblioteca", + "manageUsers": "Gerenciar Acesso do Usuário", + "viewDetails": "Ver Detalhes", + "quickScan": "Scan Rápido", + "fullScan": "Scan Completo" + }, + "notifications": { + "created": "Biblioteca criada com sucesso", + "updated": "Biblioteca atualizada com sucesso", + "deleted": "Biblioteca excluída com sucesso", + "scanStarted": "Scan da biblioteca iniciada", + "scanCompleted": "Scan da biblioteca concluída", + "quickScanStarted": "Scan rápido iniciado", + "fullScanStarted": "Scan completo iniciado", + "scanError": "Erro ao iniciar o scan. Verifique os logs" + }, + "validation": { + "nameRequired": "Nome da biblioteca é obrigatório", + "pathRequired": "Caminho da biblioteca é obrigatório", + "pathNotDirectory": "Caminho da biblioteca deve ser um diretório", + "pathNotFound": "Caminho da biblioteca não encontrado", + "pathNotAccessible": "Caminho da biblioteca não está acessível", + "pathInvalid": "Caminho da biblioteca inválido" + }, + "messages": { + "deleteConfirm": "Tem certeza que deseja excluir esta biblioteca? Isso removerá todos os dados associados.", + "scanInProgress": "Scan em progresso...", + "noLibrariesAssigned": "Nenhuma biblioteca atribuída a este usuário" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Nome", + "description": "Descrição", + "version": "Versão", + "author": "Autor", + "website": "Website", + "permissions": "Permissões", + "enabled": "Habilitado", + "status": "Status", + "path": "Caminho", + "lastError": "Erro", + "hasError": "Erro", + "updatedAt": "Atualizado", + "createdAt": "Instalado", + "configKey": "Chave", + "configValue": "Valor", + "allUsers": "Permitir todos os usuários", + "selectedUsers": "Usuários selecionados", + "allLibraries": "Permitir todas as bibliotecas", + "selectedLibraries": "Bibliotecas selecionadas", + "allowWriteAccess": "Permitir acesso de escrita" + }, + "sections": { + "status": "Status", + "info": "Informações do Plugin", + "configuration": "Configuração", + "manifest": "Manifesto", + "usersPermission": "Permissão de Usuários", + "libraryPermission": "Permissão de Bibliotecas" + }, + "status": { + "enabled": "Habilitado", + "disabled": "Desabilitado" + }, + "actions": { + "enable": "Habilitar", + "disable": "Desabilitar", + "disabledDueToError": "Corrija o erro antes de habilitar", + "disabledUsersRequired": "Selecione usuários antes de habilitar", + "disabledLibrariesRequired": "Selecione bibliotecas antes de habilitar", + "addConfig": "Adicionar configuração", + "rescan": "Rescanear" + }, + "notifications": { + "enabled": "Plugin habilitado", + "disabled": "Plugin desabilitado", + "updated": "Plugin atualizado", + "error": "Erro ao atualizar plugin" + }, + "validation": { + "invalidJson": "A configuração deve ser um JSON válido" + }, + "messages": { + "configHelp": "Configure o plugin usando pares chave-valor. Deixe vazio se o plugin não precisa de configuração.", + "clickPermissions": "Clique em uma permissão para ver detalhes", + "noConfig": "Nenhuma configuração definida", + "allUsersHelp": "Quando habilitado, o plugin terá acesso a todos os usuários, incluindo os criados no futuro.", + "noUsers": "Nenhum usuário selecionado", + "permissionReason": "Motivo", + "usersRequired": "Este plugin requer acesso a informações de usuário. Selecione quais usuários o plugin pode acessar, ou habilite 'Permitir todos os usuários'.", + "allLibrariesHelp": "Quando habilitado, o plugin terá acesso a todas as bibliotecas, incluindo as criadas no futuro.", + "noLibraries": "Nenhuma biblioteca selecionada", + "librariesRequired": "Este plugin requer acesso a informações de bibliotecas. Selecione quais bibliotecas o plugin pode acessar, ou habilite 'Permitir todas as bibliotecas'.", + "requiredHosts": "Hosts necessários", + "configValidationError": "Falha na validação da configuração:", + "schemaRenderError": "Não foi possível renderizar o formulário de configuração. O schema do plugin pode estar inválido.", + "allowWriteAccessHelp": "Quando habilitado, o plugin pode modificar arquivos nos diretórios das bibliotecas. Por padrão, plugins têm acesso somente leitura." + }, + "placeholders": { + "configKey": "chave", + "configValue": "valor" } } }, @@ -429,7 +590,16 @@ "remove_missing_title": "Remover arquivos ausentes", "remove_missing_content": "Você tem certeza que deseja remover os arquivos selecionados do banco de dados? Isso removerá permanentemente qualquer referência a eles, incluindo suas contagens de reprodução e classificações.", "remove_all_missing_title": "Remover todos os arquivos ausentes", - "remove_all_missing_content": "Você tem certeza que deseja remover todos os arquivos ausentes do banco de dados? Isso removerá permanentemente qualquer referência a eles, incluindo suas contagens de reprodução e classificações." + "remove_all_missing_content": "Você tem certeza que deseja remover todos os arquivos ausentes do banco de dados? Isso removerá permanentemente qualquer referência a eles, incluindo suas contagens de reprodução e classificações.", + "noSimilarSongsFound": "Nenhuma música semelhante encontrada", + "noTopSongsFound": "Nenhuma música mais tocada encontrada", + "startingInstantMix": "Carregando Mix Instantâneo...", + "uploadCover": "Enviar Capa", + "removeCover": "Remover Capa", + "coverUploaded": "Capa atualizada", + "coverRemoved": "Capa removida", + "coverUploadError": "Erro ao enviar capa", + "coverRemoveError": "Erro ao remover capa" }, "menu": { "library": "Biblioteca", @@ -458,7 +628,13 @@ "albumList": "Álbuns", "about": "Info", "playlists": "Playlists", - "sharedPlaylists": "Compartilhadas" + "sharedPlaylists": "Compartilhadas", + "librarySelector": { + "allLibraries": "Todas as Bibliotecas (%{count})", + "multipleLibraries": "%{selected} de %{total} Bibliotecas", + "selectLibraries": "Selecionar Bibliotecas", + "none": "Nenhuma" + } }, "player": { "playListsText": "Fila de Execução", @@ -495,18 +671,35 @@ "disabled": "Desligado", "waiting": "Aguardando" } + }, + "tabs": { + "about": "Sobre", + "config": "Configuração" + }, + "config": { + "configName": "Nome da Configuração", + "environmentVariable": "Variável de Ambiente", + "currentValue": "Valor Atual", + "configurationFile": "Arquivo de Configuração", + "exportToml": "Exportar Configuração (TOML)", + "exportSuccess": "Configuração exportada para o clipboard em formato TOML", + "exportFailed": "Falha ao copiar configuração", + "devFlagsHeader": "Flags de Desenvolvimento (sujeitas a mudança/remoção)", + "devFlagsComment": "Estas são configurações experimentais e podem ser removidas em versões futuras", + "downloadToml": "Baixar configuração (TOML)" } }, "activity": { "title": "Atividade", - "totalScanned": "Total de pastas analisadas", - "quickScan": "Scan rápido", - "fullScan": "Scan completo", + "totalScanned": "Total de pastas scaneadas", + "quickScan": "Rápido", + "fullScan": "Completo", "serverUptime": "Uptime do servidor", "serverDown": "DESCONECTADO", - "scanType": "Tipo", + "scanType": "Último Scan", "status": "Erro", - "elapsedTime": "Duração" + "elapsedTime": "Duração", + "selectiveScan": "Seletivo" }, "help": { "title": "Teclas de atalho", @@ -521,5 +714,10 @@ "toggle_love": "Marcar/desmarcar favorita", "current_song": "Vai para música atual" } + }, + "nowPlaying": { + "title": "Tocando agora", + "empty": "Nada tocando", + "minutesAgo": "%{smart_count} minuto atrás |||| %{smart_count} minutos atrás" } -} +} \ No newline at end of file diff --git a/resources/i18n/ru.json b/resources/i18n/ru.json index a4de263e4..1a7adcc4a 100644 --- a/resources/i18n/ru.json +++ b/resources/i18n/ru.json @@ -1,5 +1,5 @@ { - "languageName": "Pусский", + "languageName": "Русский", "resources": { "song": { "name": "Трек |||| Треки |||| Треков", @@ -7,23 +7,23 @@ "albumArtist": "Исполнитель альбома", "duration": "Длительность", "trackNumber": "#", - "playCount": "Проигрывания", - "title": "Название", - "artist": "Исполнитель", + "playCount": "Прослушивания", + "title": "Название трека", + "artist": "Артист", "album": "Альбом", "path": "Путь", "genre": "Жанр", "compilation": "Сборник", "year": "Год", "size": "Размер", - "updatedAt": "Обновлен", + "updatedAt": "Обновлено", "bitRate": "Битрейт", "discSubtitle": "Название диска", - "starred": "Избранные", + "starred": "Избранное", "comment": "Комментарий", "rating": "Рейтинг", "quality": "Качество", - "bpm": "Кол-во ударов в минуту", + "bpm": "BPM", "playDate": "Последнее воспроизведение", "channels": "Каналы", "createdAt": "Дата добавления", @@ -33,8 +33,14 @@ "tags": "Дополнительные теги", "mappedTags": "Сопоставленные теги", "rawTags": "Исходные теги", - "bitDepth": "Битовая глубина", - "sampleRate": "Частота дискретизации (Гц)" + "bitDepth": "Битовая глубина (Bit)", + "sampleRate": "Частота дискретизации (Hz)", + "albumGain": "Усиление альбома", + "trackGain": "Усиление трека", + "missing": "Поле отсутствует", + "libraryName": "Библиотека", + "composer": "Композитор", + "disc": "Диск %{discNumber}" }, "actions": { "addToQueue": "В очередь", @@ -43,22 +49,24 @@ "shuffleAll": "Перемешать", "download": "Скачать", "playNext": "Следующий", - "info": "Информация" + "info": "Информация", + "showInPlaylist": "Показать в плейлисте", + "instantMix": "Быстрый микс" } }, "album": { - "name": "Альбом |||| Альбомы", + "name": "Альбом |||| Альбомы |||| Альбомов", "fields": { "albumArtist": "Исполнитель альбома", - "artist": "Исполнитель", + "artist": "Артист", "duration": "Длительность", - "songCount": "Треков", - "playCount": "Проигрывания", - "name": "Название", + "songCount": "Трек |||| Треки |||| Треков", + "playCount": "Прослушивания", + "name": "Название альбома", "genre": "Жанр", "compilation": "Сборник", "year": "Год", - "updatedAt": "Обновлен", + "updatedAt": "Обновлено", "comment": "Комментарий", "rating": "Рейтинг", "createdAt": "Дата добавления", @@ -73,7 +81,9 @@ "grouping": "Группирование", "media": "Медиа", "mood": "Настроение", - "date": "Дата записи" + "date": "Дата записи", + "missing": "Поле отсутствует", + "libraryName": "Библиотека" }, "actions": { "playAll": "Играть", @@ -88,43 +98,50 @@ "lists": { "all": "Все", "random": "Случайные", - "recentlyAdded": "Свежие", + "recentlyAdded": "Новые", "recentlyPlayed": "Проигранные", "mostPlayed": "Популярные", - "starred": "Избранные", + "starred": "Избранное", "topRated": "Лучшие" } }, "artist": { - "name": "Исполнитель |||| Исполнители", + "name": "Артист |||| Артисты |||| Артистов", "fields": { - "name": "Название", + "name": "Название исполнителя", "albumCount": "Количество альбомов", "songCount": "Количество треков", - "playCount": "Проигрывания", + "playCount": "Прослушивания", "rating": "Рейтинг", "genre": "Жанр", "size": "Размер", - "role": "Роль" + "role": "Роль", + "missing": "Поле отсутствует" }, "roles": { - "albumartist": "Исполнитель альбома |||| Исполнители альбома", - "artist": "Исполнитель |||| Исполнители", - "composer": "Композитор |||| Композиторы", - "conductor": "Дирижёр |||| Дирижёры", - "lyricist": "Автор текста |||| Авторы текста", - "arranger": "Аранжировщик |||| Аранжировщики", - "producer": "Продюсер |||| Продюсеры", - "director": "Режиссёр |||| Режиссёры", - "engineer": "Инженер |||| Инженеры", - "mixer": "Звукоинженер |||| Звукоинженеры", - "remixer": "Ремиксер |||| Ремиксеры", - "djmixer": "DJ-миксер |||| DJ-миксеры", - "performer": "Исполнитель |||| Исполнители" + "albumartist": "Исполнитель альбома |||| Исполнители альбома |||| Исполнителей альбома", + "artist": "Артист |||| Артисты |||| Артистов", + "composer": "Композитор |||| Композиторы |||| Композиторов", + "conductor": "Дирижёр |||| Дирижёры |||| Дирижёров", + "lyricist": "Автор текста |||| Авторы текста |||| Авторов текста", + "arranger": "Аранжировщик |||| Аранжировщики |||| Аранжировщиков", + "producer": "Продюсер |||| Продюсеры |||| Продюсеров", + "director": "Режиссёр |||| Режиссёры |||| Режиссёров", + "engineer": "Инженер |||| Инженеры |||| Инженеров", + "mixer": "Звукоинженер |||| Звукоинженеры |||| Звукоинженеров", + "remixer": "Ремиксер |||| Ремиксеры |||| Ремиксеров", + "djmixer": "DJ-миксер |||| DJ-миксеры |||| DJ-миксеров", + "performer": "Исполнитель |||| Исполнители |||| Исполнителей", + "maincredit": "Исполнитель альбома или артист |||| Исполнители альбома или артисты |||| Исполнителей альбома или артистов" + }, + "actions": { + "shuffle": "Перемешать", + "radio": "Радио", + "topSongs": "Топовые треки" } }, "user": { - "name": "Пользователь |||| Пользователи", + "name": "Пользователь |||| Пользователи |||| Пользователей", "fields": { "userName": "Имя пользователя", "isAdmin": "Администратор", @@ -132,15 +149,17 @@ "updatedAt": "Обновлено", "name": "Имя", "password": "Пароль", - "createdAt": "Создан", + "createdAt": "Аккаунт создан", "changePassword": "Сменить пароль?", "currentPassword": "Текущий пароль", "newPassword": "Новый пароль", "token": "Токен", - "lastAccessAt": "Последний доступ" + "lastAccessAt": "Последний доступ", + "libraries": "Библиотеки" }, "helperTexts": { - "name": "Изменение вступит в силу после следующего входа в систему" + "name": "Изменение вступит в силу после следующего входа в систему", + "libraries": "Выберите конкретные библиотеки для этого пользователя или оставьте поле пустым, чтобы использовать библиотеки по умолчанию" }, "notifications": { "created": "Пользователь создан", @@ -149,15 +168,20 @@ }, "message": { "listenBrainzToken": "Введите свой токен пользователя ListenBrainz.", - "clickHereForToken": "Нажмите здесь, чтобы получить токен" + "clickHereForToken": "Нажмите здесь, чтобы получить токен", + "selectAllLibraries": "Выбрать все библиотеки", + "adminAutoLibraries": "Пользователи-администраторы автоматически получают доступ ко всем библиотекам" + }, + "validation": { + "librariesRequired": "Для пользователей, не являющихся администраторами, должна быть выбрана хотя бы одна библиотека" } }, "player": { - "name": "Плеер |||| Плееры", + "name": "Плеер |||| Плееры |||| Плееров", "fields": { - "name": "Имя", + "name": "Название", "transcodingId": "Транскодирование", - "maxBitRate": "Макс. Битрейт", + "maxBitRate": "Макс. битрейт", "client": "Клиент", "userName": "Пользователь", "lastSeen": "Был на сайте", @@ -166,7 +190,7 @@ } }, "transcoding": { - "name": "Транскодирование |||| Транскодирование", + "name": "Транскодирование |||| Транскодирование |||| Транскодирований", "fields": { "name": "Название", "targetFormat": "Целевой формат", @@ -175,15 +199,15 @@ } }, "playlist": { - "name": "Плейлистов |||| Плейлисты", + "name": "Плейлист |||| Плейлисты |||| Плейлистов", "fields": { "name": "Название", "duration": "Длительность", "ownerName": "Владелец", "public": "Публичный", - "updatedAt": "Обновлен", + "updatedAt": "Обновлено", "createdAt": "Создан", - "songCount": "Треков", + "songCount": "Трек |||| Трека |||| Треков", "comment": "Комментарий", "sync": "Автоимпорт", "path": "Импортировать из" @@ -193,17 +217,23 @@ "addNewPlaylist": "Создать \"%{name}\"", "export": "Экспорт", "makePublic": "Опубликовать", - "makePrivate": "Сделать личным" + "makePrivate": "Сделать личным", + "saveQueue": "Сохранить очередь в плейлист", + "searchOrCreate": "Поиск плейлистов или введите текст для создания новых...", + "pressEnterToCreate": "Нажмите Enter, чтобы создать новый плейлист", + "removeFromSelection": "Удалить из списка выделенных" }, "message": { "duplicate_song": "Повторяющиеся треки", - "song_exist": "Некоторые треки уже есть в плейлисте. Вы хотите добавить их или пропустить?" + "song_exist": "Некоторые треки уже есть в плейлисте. Вы хотите добавить их или пропустить?", + "noPlaylistsFound": "Плейлисты не найдены", + "noPlaylists": "Нет доступных плейлистов" } }, "radio": { - "name": "Радио |||| Радио", + "name": "Радио |||| Радио |||| Радио", "fields": { - "name": "Имя", + "name": "Название", "streamUrl": "Ссылка на поток", "homePageUrl": "Домашняя страница", "updatedAt": "Обновлено", @@ -214,7 +244,7 @@ } }, "share": { - "name": "Общий доступ |||| Общий доступ", + "name": "Общий доступ |||| Общий доступ |||| Общий доступ", "fields": { "username": "Поделился", "url": "Ссылка", @@ -222,36 +252,171 @@ "contents": "Содержание", "expiresAt": "Ссылка истекает", "lastVisitedAt": "Последнее посещение", - "visitCount": "Посещения", + "visitCount": "Количество посещений", "format": "Формат", - "maxBitRate": "Макс. Битрейт", - "updatedAt": "Обновлено в", + "maxBitRate": "Макс. битрейт", + "updatedAt": "Обновлено", "createdAt": "Создано", "downloadable": "Разрешить загрузку?" } }, "missing": { - "name": "Файл отсутствует |||| Файлы отсутствуют", + "name": "Отсутствующий файл |||| Отсутствующие файлы |||| Отсутствующих файлов", "fields": { - "path": "Место расположения", + "path": "Путь", "size": "Размер", - "updatedAt": "Исчез" + "updatedAt": "Исчез", + "libraryName": "Библиотека" }, "actions": { - "remove": "Удалить" + "remove": "Удалить", + "remove_all": "Убрать все" }, "notifications": { "removed": "Отсутствующие файлы удалены" }, "empty": "Нет отсутствующих файлов" + }, + "library": { + "name": "Библиотека |||| Библиотеки |||| Библиотек", + "fields": { + "name": "Название", + "path": "Путь", + "remotePath": "Удаленный путь", + "lastScanAt": "Последнее сканирование", + "songCount": "Треки", + "albumCount": "Альбомы", + "artistCount": "Артисты", + "totalSongs": "Треки", + "totalAlbums": "Альбомы", + "totalArtists": "Артисты", + "totalFolders": "Папки", + "totalFiles": "Файлы", + "totalMissingFiles": "Отсутствующие файлы", + "totalSize": "Общий размер", + "totalDuration": "Длительность", + "defaultNewUsers": "По умолчанию для новых пользователей", + "createdAt": "Создано", + "updatedAt": "Обновлено" + }, + "sections": { + "basic": "Основная информация", + "statistics": "Статистика" + }, + "actions": { + "scan": "Сканировать библиотеку", + "manageUsers": "Управление доступом пользователей", + "viewDetails": "Просмотреть подробности", + "quickScan": "Быстрое сканирование", + "fullScan": "Полное сканирование" + }, + "notifications": { + "created": "Библиотека успешно создана", + "updated": "Библиотека успешно обновлена", + "deleted": "Библиотека успешно удалена", + "scanStarted": "Сканирование библиотеки начато", + "scanCompleted": "Сканирование библиотеки закончено", + "quickScanStarted": "Быстрое сканирование началось", + "fullScanStarted": "Началось полное сканирование", + "scanError": "Ошибка при запуске сканирования. Проверьте логи" + }, + "validation": { + "nameRequired": "Название библиотеки обязательно", + "pathRequired": "Путь к библиотеке обязателен", + "pathNotDirectory": "Путь к библиотеке должен быть директорией", + "pathNotFound": "Путь к библиотеке не найден", + "pathNotAccessible": "Путь к библиотеке недоступен", + "pathInvalid": "Неверный путь к библиотеке" + }, + "messages": { + "deleteConfirm": "Вы уверены, что хотите удалить эту библиотеку? Это приведет к удалению всех связанных с ней данных и доступа пользователей.", + "scanInProgress": "Сканирование продолжается...", + "noLibrariesAssigned": "Нет библиотек, назначенных этому пользователю" + } + }, + "plugin": { + "name": "Плагин |||| Плагины |||| Плагинов", + "fields": { + "id": "ID", + "name": "Название", + "description": "Описание", + "version": "Версия", + "author": "Автор", + "website": "Веб-сайт", + "permissions": "Разрешения", + "enabled": "Включено", + "status": "Статус", + "path": "Путь", + "lastError": "Ошибка", + "hasError": "Ошибка", + "updatedAt": "Обновлено", + "createdAt": "Дата установки", + "configKey": "Ключ", + "configValue": "Значение", + "allUsers": "Разрешить всем пользователям", + "selectedUsers": "Выбранные пользователи", + "allLibraries": "Разрешить доступ ко всем библиотекам", + "selectedLibraries": "Выбранные библиотеки", + "allowWriteAccess": "Разрешить запись" + }, + "sections": { + "status": "Статус", + "info": "Информация о плагине", + "configuration": "Конфигурация", + "manifest": "Манифест", + "usersPermission": "Права доступа пользователей", + "libraryPermission": "Права доступа к библиотекам" + }, + "status": { + "enabled": "Включено", + "disabled": "Отключено" + }, + "actions": { + "enable": "Включить", + "disable": "Отключить", + "disabledDueToError": "Исправьте ошибку перед включением", + "disabledUsersRequired": "Выберите пользователей перед включением", + "disabledLibrariesRequired": "Выберите библиотеки перед включением", + "addConfig": "Добавить конфигурацию", + "rescan": "Повторное сканирование" + }, + "notifications": { + "enabled": "Плагин включен", + "disabled": "Плагин отключен", + "updated": "Плагин обновлен", + "error": "Ошибка обновления плагина" + }, + "validation": { + "invalidJson": "Конфигурация должна быть в формате JSON, допустимом для всех пользователей" + }, + "messages": { + "configHelp": "Настройте плагин, используя пары ключ-значение. Оставьте поле пустым, если плагин не требует настройки.", + "clickPermissions": "Нажмите на разрешение для получения подробной информации", + "noConfig": "Конфигурация не задана", + "allUsersHelp": "При включении плагин получит доступ ко всем пользователям, включая тех, кто будет создан в будущем.", + "noUsers": "Не выбрано ни одного пользователя", + "permissionReason": "Причина", + "usersRequired": "Этому плагину требуется доступ к пользовательской информации. Выберите, к каким пользователям плагин может получить доступ, или включите \"Разрешить всем пользователям\".", + "allLibrariesHelp": "После включения плагин будет иметь доступ ко всем библиотекам, включая те, которые будут созданы в будущем.", + "noLibraries": "Библиотеки не выбраны", + "librariesRequired": "Этому плагину требуется доступ к библиотечной информации. Выберите, к каким библиотекам плагин может получить доступ, или включите \"Разрешить все библиотеки\".", + "requiredHosts": "Необходимые хосты", + "configValidationError": "Проверка конфигурации завершилась неудачей:", + "schemaRenderError": "Не удалось отобразить форму конфигурации. Возможно, схема плагина недействительна.", + "allowWriteAccessHelp": "Разрешить плагину изменять файлы в вашей библиотеке" + }, + "placeholders": { + "configKey": "ключ", + "configValue": "значение" + } } }, "ra": { "auth": { "welcome1": "Спасибо за установку Navidrome!", - "welcome2": "Для начала, создайте аккаунт Администратора", - "confirmPassword": "Подтвердить Пароль", - "buttonCreateAdmin": "Создать аккаунт Администратора", + "welcome2": "Для начала создайте аккаунт администратора", + "confirmPassword": "Подтвердите пароль", + "buttonCreateAdmin": "Создать аккаунт администратора", "auth_check_error": "Пожалуйста, авторизуйтесь для продолжения работы", "user_menu": "Профиль", "username": "Имя пользователя", @@ -265,22 +430,22 @@ "invalidChars": "Пожалуйста, используйте только буквы и цифры", "passwordDoesNotMatch": "Пароли не совпадают", "required": "Обязательно для заполнения", - "minLength": "Минимальное кол-во символов %{min}", - "maxLength": "Максимальное кол-во символов %{max}", - "minValue": "Минимальное значение %{min}", - "maxValue": "Значение может быть %{max} или меньше", - "number": "Должно быть цифрой", + "minLength": "Минимальное количество символов: %{min}", + "maxLength": "Максимальное количество символов: %{max}", + "minValue": "Минимальное значение: %{min}", + "maxValue": "Максимальное значение: %{max}", + "number": "Должно быть числом", "email": "Некорректный Email", "oneOf": "Должно быть одним из: %{options}", - "regex": "Должно быть в формате (regexp): %{pattern}", + "regex": "Должно соответствовать формату: %{pattern}", "unique": "Должно быть уникальным", - "url": "Должен быть действительным URL адрес" + "url": "Должен быть действительный URL" }, "action": { "add_filter": "Фильтр", "add": "Добавить", "back": "Назад", - "bulk_actions": "1 выбран |||| %{smart_count} выбрано |||| %{smart_count} выбрано", + "bulk_actions": "1 выбран |||| %{smart_count} выбраны |||| %{smart_count} выбрано", "cancel": "Отмена", "clear_input_value": "Очистить", "clone": "Дублировать", @@ -291,20 +456,20 @@ "export": "Экспорт", "list": "Список", "refresh": "Обновить", - "remove_filter": "Убрать фильтр", + "remove_filter": "Убрать этот фильтр", "remove": "Удалить", "save": "Сохранить", "search": "Поиск", "show": "Просмотр", "sort": "Сортировать", "undo": "Отменить", - "expand": "Расширить", + "expand": "Развернуть", "close": "Закрыть", "open_menu": "Открыть меню", "close_menu": "Закрыть меню", - "unselect": "Отменить выделение", + "unselect": "Снять выделение", "skip": "Пропустить", - "bulk_actions_mobile": "1 |||| %{smart_count}", + "bulk_actions_mobile": "1 |||| %{smart_count} |||| %{smart_count}", "share": "Поделиться", "download": "Скачать" }, @@ -318,7 +483,7 @@ "edit": "%{name} #%{id}", "error": "Что-то пошло не так", "list": "%{name}", - "loading": "Загрузка", + "loading": "Загрузка...", "not_found": "Не найдено", "show": "%{name} #%{id}", "empty": "Нет %{name}.", @@ -330,13 +495,13 @@ "upload_single": "Перетащите файл для загрузки или щёлкните для выбора." }, "image": { - "upload_several": "Перетащите картинки для загрузки или щёлкните для выбора.", - "upload_single": "Перетащите картинку для загрузки или щёлкните для выбора." + "upload_several": "Перетащите изображения для загрузки или щёлкните для выбора.", + "upload_single": "Перетащите изображение для загрузки или щёлкните для выбора." }, "references": { "all_missing": "Связанных данных не найдено.", - "many_missing": "Некоторые из связанных данных не доступны", - "single_missing": "Связанный объект не доступен" + "many_missing": "Некоторые из связанных данных недоступны", + "single_missing": "Связанный объект недоступен" }, "password": { "toggle_visible": "Скрыть пароль", @@ -344,45 +509,45 @@ } }, "message": { - "about": "Справка", + "about": "О программе", "are_you_sure": "Вы уверены?", - "bulk_delete_content": "Вы уверены, что хотите удалить %{name}? |||| Вы уверены, что хотите удалить объекты, кол-вом %{smart_count} ? |||| Вы уверены, что хотите удалить объекты, кол-вом %{smart_count} ?", - "bulk_delete_title": "Удалить %{name} |||| Удалить %{smart_count} %{name} |||| Удалить %{smart_count} %{name}", - "delete_content": "Вы уверены что хотите удалить этот объект", + "bulk_delete_content": "Вы уверены, что хотите удалить %{name}? |||| Удалить %{smart_count} объекта? |||| Удалить %{smart_count} объектов?", + "bulk_delete_title": "Удалить %{name} |||| Удалить %{smart_count} объекта |||| Удалить %{smart_count} объектов", + "delete_content": "Вы уверены, что хотите удалить этот объект?", "delete_title": "Удалить %{name} #%{id}", - "details": "Описание", - "error": "При выполнении запроса возникла ошибка, и он не может быть завершен", - "invalid_form": "Форма заполнена неверно, проверьте, пожалуйста, ошибки", - "loading": "Идет загрузка, пожалуйста, немного подождите", + "details": "Подробности", + "error": "При выполнении запроса возникла ошибка", + "invalid_form": "Форма заполнена неверно, проверьте ошибки", + "loading": "Загрузка, пожалуйста, подождите...", "no": "Нет", - "not_found": "Либо вы ввели неправильный URL, либо перешли по некорректной ссылке.", + "not_found": "Страница не найдена. Возможно, вы ввели неправильный URL.", "yes": "Да", - "unsaved_changes": "Некоторые из ваших изменений не сохранены. Продолжить без сохранения?" + "unsaved_changes": "Есть несохраненные изменения. Продолжить без сохранения?" }, "navigation": { "no_results": "Результатов не найдено", - "no_more_results": "Страница %{page} выходит за пределы нумерации, попробуйте предыдущую", - "page_out_of_boundaries": "Страница %{page} выходит за пределы нумерации", + "no_more_results": "Страница %{page} выходит за пределы, попробуйте предыдущую", + "page_out_of_boundaries": "Страница %{page} выходит за пределы", "page_out_from_end": "Невозможно переместиться дальше последней страницы", "page_out_from_begin": "Номер страницы не может быть меньше 1", "page_range_info": "%{offsetBegin}-%{offsetEnd} из %{total}", "page_rows_per_page": "Строк на странице:", - "next": "Следующая", - "prev": "Предыдущая", - "skip_nav": "Перейти к содержанию" + "next": "Вперед", + "prev": "Назад", + "skip_nav": "Перейти к основному контенту" }, "notification": { - "updated": "Элемент обновлен |||| %{smart_count} обновлено |||| %{smart_count} обновлено", + "updated": "Элемент обновлен |||| %{smart_count} элемента обновлены |||| %{smart_count} элементов обновлено", "created": "Элемент создан", - "deleted": "Элемент удален |||| %{smart_count} удалено |||| %{smart_count} удалено", - "bad_item": "Неправильный элемент", + "deleted": "Элемент удален |||| %{smart_count} элемента удалены |||| %{smart_count} элементов удалено", + "bad_item": "Некорректный элемент", "item_doesnt_exist": "Элемент не существует", "http_error": "Ошибка сервера", - "data_provider_error": "Ошибка dataProvider, проверьте консоль", - "i18n_error": "Не удалось загрузить перевод для указанного языка", + "data_provider_error": "Ошибка поставщика данных, проверьте консоль", + "i18n_error": "Не удалось загрузить перевод", "canceled": "Операция отменена", - "logged_out": "Ваша сессия завершена, попробуйте переподключиться/войти снова", - "new_version": "Доступна новая версия! Пожалуйста, обновите это окно" + "logged_out": "Сессия завершена, пожалуйста, войдите снова", + "new_version": "Доступна новая версия! Пожалуйста, обновите страницу." }, "toggleFieldsMenu": { "columnsToDisplay": "Отображение столбцов", @@ -393,37 +558,42 @@ }, "message": { "note": "ПРИМЕЧАНИЕ", - "transcodingDisabled": "Изменение настроек транскодирования через веб интерфейс, отключено по соображениям безопасности. Если вы хотите изменить или добавить опции транскодирования, перезапустите сервер с опцией конфигурации %{config}.", - "transcodingEnabled": "Navidrome работает с настройками %{config}, позволяющими запускать команды с настройками транскодирования через веб интерфейс. В целях безопасности, мы рекомендуем отключить эту возможность.", - "songsAddedToPlaylist": "Один трек добавлен в плейлист |||| %{smart_count} треков добавлено в плейлист", + "transcodingDisabled": "Изменение настроек транскодирования через веб-интерфейс отключено по соображениям безопасности. Если вы хотите изменить или добавить опции транскодирования, перезапустите сервер с опцией конфигурации %{config}.", + "transcodingEnabled": "Navidrome работает с настройками %{config}, позволяющими запускать команды транскодирования через веб-интерфейс. В целях безопасности мы рекомендуем отключить эту возможность.", + "songsAddedToPlaylist": "Добавлен 1 трек |||| Добавлены %{smart_count} трека |||| Добавлено %{smart_count} треков", "noPlaylistsAvailable": "Недоступно", "delete_user_title": "Удалить пользователя '%{name}'", - "delete_user_content": "Вы уверены, что вы хотите удалить пользователя и все его данные (включая плейлисты и настройки)?", + "delete_user_content": "Вы уверены, что хотите удалить пользователя и все его данные (включая плейлисты и настройки)?", "notifications_blocked": "Вы заблокировали уведомления для этой страницы в настройках вашего браузера", "notifications_not_available": "Ваш браузер не поддерживает всплывающие уведомления", "lastfmLinkSuccess": "Соединение с Last.fm установлено, скробблинг включен", - "lastfmLinkFailure": "Last.fm не может быть подключен", - "lastfmUnlinkSuccess": "Соединение с Last.fm удалено, скробблинг отключен", - "lastfmUnlinkFailure": "Соединение с Last.fm не может быть удалено", + "lastfmLinkFailure": "Не удалось подключиться к Last.fm", + "lastfmUnlinkSuccess": "Соединение с Last.fm разорвано, скробблинг отключен", + "lastfmUnlinkFailure": "Не удалось разорвать соединение с Last.fm", "openIn": { "lastfm": "Показать на Last.fm", "musicbrainz": "Показать на MusicBrainz" }, "lastfmLink": "Подробнее...", "listenBrainzLinkSuccess": "ListenBrainz скробблинг успешно подключен для пользователя: %{user}", - "listenBrainzLinkFailure": "ListenBrainz не может быть связан:", + "listenBrainzLinkFailure": "Не удалось подключить ListenBrainz:", "listenBrainzUnlinkSuccess": "ListenBrainz скробблинг отключен", - "listenBrainzUnlinkFailure": "ListenBrainz не удалось отключить", + "listenBrainzUnlinkFailure": "Не удалось отключить ListenBrainz", "downloadOriginalFormat": "Скачать в оригинальном формате", "shareOriginalFormat": "Поделиться в оригинальном формате", "shareDialogTitle": "Поделиться %{resource} '%{name}'", - "shareBatchDialogTitle": "Поделиться 1 %{resource} |||| Поделиться %{smart_count} %{resource}", + "shareBatchDialogTitle": "Поделиться 1 %{resource} |||| Поделиться %{smart_count} %{resource} |||| Поделиться %{smart_count} %{resource}", "shareSuccess": "URL скопирован в буфер обмена: %{url}", - "shareFailure": "Ошибка копирования URL-адреса %{url} в буфер обмена", + "shareFailure": "Ошибка копирования URL %{url} в буфер обмена", "downloadDialogTitle": "Скачать %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Копировать в буфер обмена: Ctrl+C, Enter", - "remove_missing_title": "Удалить отсутствующие файлы", - "remove_missing_content": "Вы уверены, что хотите удалить выбранные отсутствующие файлы из базы данных? Это навсегда удалит все ссылки на них, включая данные о прослушиваниях и рейтингах." + "remove_missing_title": "Удалить отсутствующие файлы?", + "remove_missing_content": "Вы уверены, что хотите удалить выбранные отсутствующие файлы из базы данных? Это навсегда удалит все ссылки на них, включая данные о прослушиваниях и рейтингах.", + "remove_all_missing_title": "Удалить все отсутствующие файлы", + "remove_all_missing_content": "Вы уверены, что хотите удалить все отсутствующие файлы из базы данных? Это навсегда удалит все упоминания о них, включая количество прослушиваний и рейтинг.", + "noSimilarSongsFound": "Похожих треков не найдено", + "noTopSongsFound": "Лучших треков не найдено", + "startingInstantMix": "Загрузка быстрого микса..." }, "menu": { "library": "Библиотека", @@ -431,7 +601,7 @@ "version": "Версия", "theme": "Тема", "personal": { - "name": "Личные", + "name": "Личное", "options": { "theme": "Тема", "language": "Язык", @@ -439,10 +609,10 @@ "desktop_notifications": "Уведомления на рабочем столе", "lastfmScrobbling": "Скробблинг Last.fm", "listenBrainzScrobbling": "Скробблинг ListenBrainz", - "replaygain": "ReplayGain режим", - "preAmp": "ReplayGain предусилитель (dB)", + "replaygain": "Режим ReplayGain", + "preAmp": "Предусилитель ReplayGain (дБ)", "gain": { - "none": "Отключить", + "none": "Отключено", "album": "Использовать усиление альбома", "track": "Использовать усиление трека" }, @@ -450,12 +620,18 @@ } }, "albumList": "Альбомы", - "about": "О нас", + "about": "О программе", "playlists": "Плейлисты", - "sharedPlaylists": "Поделиться плейлистом" + "sharedPlaylists": "Общие плейлисты", + "librarySelector": { + "allLibraries": "Все библиотеки (%{count})", + "multipleLibraries": "%{selected} из %{total} библиотек |||| %{selected} из %{total} библиотек |||| %{selected} из %{total} библиотек", + "selectLibraries": "Выбор библиотек", + "none": "Отсутствует" + } }, "player": { - "playListsText": "Очередь Воспроизведения", + "playListsText": "Очередь воспроизведения", "openText": "Открыть", "closeText": "Закрыть", "notContentText": "Нет музыки", @@ -469,48 +645,73 @@ "toggleMiniModeText": "Свернуть", "destroyText": "Выключить", "downloadText": "Скачать", - "removeAudioListsText": "Удалить список воспроизведения", + "removeAudioListsText": "Очистить очередь", "clickToDeleteText": "Нажмите для удаления %{name}", - "emptyLyricText": "Без текста", + "emptyLyricText": "Текст песни отсутствует", "playModeText": { "order": "По порядку", "orderLoop": "Повторять", - "singleLoop": "Повторить один раз", + "singleLoop": "Повторять один трек", "shufflePlay": "Перемешать" } }, "about": { "links": { - "homepage": "Главная", - "source": "Код", + "homepage": "Сайт проекта", + "source": "Исходный код", "featureRequests": "Предложения", "lastInsightsCollection": "Последний сбор данных", "insights": { "disabled": "Выключено", "waiting": "Ожидание" } + }, + "tabs": { + "about": "О программе", + "config": "Конфигурация" + }, + "config": { + "configName": "Параметр", + "environmentVariable": "Переменная окружения", + "currentValue": "Текущее значение", + "configurationFile": "Файл конфигурации", + "exportToml": "Экспорт в TOML", + "exportSuccess": "Конфигурация скопирована в буфер обмена в формате TOML", + "exportFailed": "Не удалось скопировать конфигурацию", + "devFlagsHeader": "Флаги разработки (могут быть изменены/удалены)", + "devFlagsComment": "Это экспериментальные настройки, которые могут быть удалены в будущих версиях.", + "downloadToml": "Скачать TOML" } }, "activity": { - "title": "Действия", + "title": "Активность", "totalScanned": "Всего просканировано папок", "quickScan": "Быстрое сканирование", "fullScan": "Полное сканирование", "serverUptime": "Время работы сервера", - "serverDown": "Оффлайн" + "serverDown": "Офлайн", + "scanType": "Тип", + "status": "Статус", + "elapsedTime": "Прошедшее время", + "selectiveScan": "Избирательное" }, "help": { "title": "Горячие клавиши Navidrome", "hotkeys": { "show_help": "Показать справку", - "toggle_menu": "Показать / скрыть боковое меню", - "toggle_play": "Играть / Пауза", + "toggle_menu": "Показать/скрыть боковое меню", + "toggle_play": "Играть/Пауза", "prev_song": "Предыдущий трек", "next_song": "Следующий трек", "vol_up": "Увеличить громкость", "vol_down": "Уменьшить громкость", - "toggle_love": "Добавить / удалить песню из избранного", - "current_song": "Перейти к текущей песне" + "toggle_love": "Добавить/удалить из избранного", + "current_song": "Перейти к текущему треку" } + }, + "nowPlaying": { + "title": "Сейчас играет", + "empty": "Ничего не играет", + "minutesAgo": "%{smart_count} минуту назад |||| %{smart_count} минуты назад |||| %{smart_count} минут назад" } -} \ No newline at end of file +} diff --git a/resources/i18n/sk.json b/resources/i18n/sk.json new file mode 100644 index 000000000..f294d1602 --- /dev/null +++ b/resources/i18n/sk.json @@ -0,0 +1,723 @@ +{ + "languageName": "Slovenčina", + "resources": { + "song": { + "name": "Skladba |||| Skladby", + "fields": { + "albumArtist": "Interpret albumu", + "duration": "Dĺžka", + "trackNumber": "#", + "playCount": "Počet prehratí", + "title": "Názov", + "artist": "Interpret", + "album": "Album", + "path": "Cesta k súboru", + "genre": "Žáner", + "compilation": "Kompilácia", + "year": "Rok", + "size": "Veľkosť súboru", + "updatedAt": "Nahrané", + "bitRate": "Prenosová rýchlosť", + "discSubtitle": "Podtitul disku", + "starred": "Obľúbené", + "comment": "Komentár", + "rating": "Hodnotenie", + "quality": "Kvalita", + "bpm": "BPM", + "playDate": "Naposledy prehraná skladba", + "channels": "Kanály", + "createdAt": "Pridané", + "grouping": "Zoskupovanie", + "mood": "Nálada", + "participants": "Ďalší účastníci", + "tags": "Ďalšie značky", + "mappedTags": "Mapované značky", + "rawTags": "Nespracované značky", + "bitDepth": "Bitová hĺbka", + "sampleRate": "Vzorkovacia frekvencia", + "missing": "Chýbajúce", + "libraryName": "Knižnica", + "composer": "Skladateľ", + "disc": "Disk %{discNumber}", + "albumGain": "Zosilnenie albumu", + "trackGain": "Zosilnenie stopy" + }, + "actions": { + "addToQueue": "Prehrať neskôr", + "playNow": "Prehrať teraz", + "addToPlaylist": "Pridať do zoznamu skladieb", + "shuffleAll": "Zamiešať všetko", + "download": "Stiahnuť", + "playNext": "Prehrať ako ďalšie", + "info": "Získať informácie", + "showInPlaylist": "Zobraziť v zozname skladieb", + "instantMix": "Okamžitý mix" + } + }, + "album": { + "name": "Album |||| Albumy", + "fields": { + "albumArtist": "Interpret albumu", + "artist": "Interpret", + "duration": "Dĺžka", + "songCount": "Skladby", + "playCount": "Počet prehratí", + "name": "Názov", + "genre": "Žáner", + "compilation": "Kompilácia", + "year": "Rok", + "updatedAt": "Aktualizované", + "comment": "Komentár", + "rating": "Hodnotenie", + "createdAt": "Pridané", + "size": "Veľkosť", + "originalDate": "Pôvodné", + "releaseDate": "Vydané", + "releases": "Vydanie |||| Vydania", + "released": "Vydané", + "recordLabel": "Štítok", + "catalogNum": "Katalógové číslo", + "releaseType": "Typ vydania", + "grouping": "Zoskupovanie", + "media": "Médiá", + "mood": "Nálada", + "date": "Dátum záznamu", + "missing": "Chýbajúce", + "libraryName": "Knižnica" + }, + "actions": { + "playAll": "Prehrať", + "playNext": "Prehrať ako ďalšie", + "addToQueue": "Prehrať neskôr", + "shuffle": "Zamiešať", + "addToPlaylist": "Pridať do zoznamu skladieb", + "download": "Stiahnuť", + "info": "Získať informácie", + "share": "Zdieľať" + }, + "lists": { + "all": "Všetko", + "random": "Náhodné", + "recentlyAdded": "Nedávno pridané", + "recentlyPlayed": "Nedávno prehrané", + "mostPlayed": "Najviac prehrávané", + "starred": "Obľúbené", + "topRated": "Najlepšie hodnotené" + } + }, + "artist": { + "name": "Interpret |||| Interpreti", + "fields": { + "name": "Názov", + "albumCount": "Počet albumov", + "songCount": "Počet skladieb", + "playCount": "Prehrania", + "rating": "Hodnotenie", + "genre": "Žáner", + "size": "Veľkosť", + "role": "Rola", + "missing": "Chýbajúci" + }, + "roles": { + "albumartist": "Interpret albumu |||| Interpreti albumov", + "artist": "Interpret |||| Interpreti", + "composer": "Skladateľ |||| Skladatelia", + "conductor": "Dirigent |||| Dirigenti", + "lyricist": "Textár |||| Textári", + "arranger": "Aranžér |||| Aranžéri", + "producer": "Producent |||| Producenti", + "director": "Režisér |||| Režiséri", + "engineer": "Zvukový technik |||| Zvukoví technici", + "mixer": "Mixér |||| Mixéri", + "remixer": "Remixér |||| Remixéri", + "djmixer": "DJ Mixér |||| DJ Mixéri", + "performer": "Účinkujúci |||| Účinkujúci", + "maincredit": "Interpret albumu alebo interpret |||| Interpreti albumov alebo interpreti" + }, + "actions": { + "shuffle": "Zamiešať", + "radio": "Rádio", + "topSongs": "Najpopulárnejšie skladby" + } + }, + "user": { + "name": "Používateľ |||| Používatelia", + "fields": { + "userName": "Používateľské meno", + "isAdmin": "Správca", + "lastLoginAt": "Naposledy prihlásený", + "updatedAt": "Upravený", + "name": "Meno", + "password": "Heslo", + "createdAt": "Vytvorený", + "changePassword": "Zmeniť heslo?", + "currentPassword": "Súčastné heslo", + "newPassword": "Nové heslo", + "token": "Token", + "lastAccessAt": "Posledný Prístup", + "libraries": "Knižnice" + }, + "helperTexts": { + "name": "Zmena mena sa zobrazí až po ďalšom prihlásení", + "libraries": "Vyberte konkrétne knižnice pre tohto používateľa alebo nechajte pole prázdne, ak chcete použiť predvolené knižnice" + }, + "notifications": { + "created": "Používateľ vytvorený", + "updated": "Používateľ upravený", + "deleted": "Používateľ odstránený" + }, + "message": { + "listenBrainzToken": "Vložte svoj používateľský ListenBrainz token.", + "clickHereForToken": "Kliknite sem pre získanie svojho tokenu", + "selectAllLibraries": "Vybrať všetky knižnice", + "adminAutoLibraries": "Administrátori majú automaticky prístup ku všetkým knižniciam" + }, + "validation": { + "librariesRequired": "Pre používateľov bez administrátorských práv musí byť vybratá aspoň jedna knižnica" + } + }, + "player": { + "name": "Prehrávač |||| Prehrávače", + "fields": { + "name": "Názov", + "transcodingId": "ID transkódovania", + "maxBitRate": "Max. prenosová rýchlosť", + "client": "Klient", + "userName": "Používateľské meno", + "lastSeen": "Naposledy videný", + "reportRealPath": "Skutočná cesta hlásenia", + "scrobbleEnabled": "Odosielať scrobbling na externé služby" + } + }, + "transcoding": { + "name": "Transkódovanie |||| Transkódovania", + "fields": { + "name": "Názov", + "targetFormat": "Cieľový formát", + "defaultBitRate": "Predvolená prenosová rýchlosť", + "command": "Príkaz" + } + }, + "playlist": { + "name": "Zoznam skladieb |||| Zoznamy skladieb", + "fields": { + "name": "Názov", + "duration": "Dĺžka", + "ownerName": "Autor", + "public": "Verejný", + "updatedAt": "Nahraný", + "createdAt": "Vytvorený", + "songCount": "Skladby", + "comment": "Komentár", + "sync": "Auto-import", + "path": "Importovať z" + }, + "actions": { + "selectPlaylist": "Vybrať zoznam skladieb:", + "addNewPlaylist": "Vytvoriť \"%{name}\"", + "export": "Export", + "makePublic": "Zverejniť", + "makePrivate": "Nastaviť ako súkromné", + "saveQueue": "Uložiť rad do zoznamu skladieb", + "searchOrCreate": "Vyhľadajte zoznamy skladieb alebo napíšte pre vytvorenie nového...", + "pressEnterToCreate": "Stlačte Enter pre vytvorenie nového zoznamu skladieb", + "removeFromSelection": "Odstrániť z výberu" + }, + "message": { + "duplicate_song": "Pridať duplicitné položky", + "song_exist": "Pridávate duplikát už existujúcej položky v zozname skladieb. Chcete pridať duplikát alebo ho preskočiť?", + "noPlaylistsFound": "Žiadne zoznamy skladieb sa nenašli", + "noPlaylists": "Žiadne zoznamy skladieb nie sú dostupné" + } + }, + "radio": { + "name": "Rádio |||| Rádiá", + "fields": { + "name": "Názov", + "streamUrl": "URL streamu", + "homePageUrl": "URL stránky", + "updatedAt": "Nahrané", + "createdAt": "Vytvorené" + }, + "actions": { + "playNow": "Spustiť" + } + }, + "share": { + "name": "Zdieľanie |||| Zdieľania", + "fields": { + "username": "Zdieľané", + "url": "URL", + "description": "Popis", + "contents": "Obsah", + "expiresAt": "Vyprší", + "lastVisitedAt": "Naposledy navštívené", + "visitCount": "Počet návštev", + "format": "Formát", + "maxBitRate": "Max. Bit Rate", + "updatedAt": "Nahrané", + "createdAt": "Vytvorené", + "downloadable": "Povoliť sťahovanie?" + } + }, + "missing": { + "name": "Chýbajúci súbor |||| Chýbajúce súbory", + "fields": { + "path": "Cesta", + "size": "Veľkosť", + "updatedAt": "Zmizol dňa", + "libraryName": "Knižnica" + }, + "actions": { + "remove": "Odstrániť", + "remove_all": "Odstrániť všetky" + }, + "notifications": { + "removed": "Chýbajúce súbory odstránené" + }, + "empty": "Žiadne chýbajúce súbory" + }, + "library": { + "name": "Knižnica |||| Knižnice", + "fields": { + "name": "Názov", + "path": "Cesta", + "remotePath": "Vzdialená cesta", + "lastScanAt": "Posledný sken", + "songCount": "Skladby", + "albumCount": "Albumy", + "artistCount": "Interpreti", + "totalSongs": "Skladby", + "totalAlbums": "Albumy", + "totalArtists": "Interpreti", + "totalFolders": "Priečinky", + "totalFiles": "Súbory", + "totalMissingFiles": "Chýbajúce súbory", + "totalSize": "Celková veľkosť", + "totalDuration": "Dĺžka", + "defaultNewUsers": "Predvolené pre nových používateľov", + "createdAt": "Vytvorené", + "updatedAt": "Aktualizované" + }, + "sections": { + "basic": "Základné informácie", + "statistics": "Štatistiky" + }, + "actions": { + "scan": "Skenovať knižnicu", + "manageUsers": "Spravovať prístup používateľov", + "viewDetails": "Zobraziť detaily", + "quickScan": "Rýchly sken", + "fullScan": "Úplný sken" + }, + "notifications": { + "created": "Knižnica úspešne vytvorená", + "updated": "Knižnica úspešne aktualizovaná", + "deleted": "Knižnica úspešne odstránená", + "scanStarted": "Skenovanie knižnice spustené", + "scanCompleted": "Skenovanie knižnice dokončené", + "quickScanStarted": "Rýchly sken spustený", + "fullScanStarted": "Úplný sken spustený", + "scanError": "Chyba pri spustení skenu. Skontrolujte logy" + }, + "validation": { + "nameRequired": "Názov knižnice je povinný", + "pathRequired": "Cesta ku knižnici je povinná", + "pathNotDirectory": "Cesta ku knižnici musí byť priečinok", + "pathNotFound": "Cesta ku knižnici sa nenašla", + "pathNotAccessible": "Cesta ku knižnici nie je dostupná", + "pathInvalid": "Neplatná cesta ku knižnici" + }, + "messages": { + "deleteConfirm": "Ste si istý, že chcete odstrániť túto knižnicu? Tým sa odstránia všetky súvisiace dáta a prístupy používateľov.", + "scanInProgress": "Skenovanie prebieha...", + "noLibrariesAssigned": "Tomuto používateľovi nie sú priradené žiadne knižnice" + } + }, + "plugin": { + "name": "Plugin |||| Pluginy", + "fields": { + "id": "ID", + "name": "Názov", + "description": "Popis", + "version": "Verzia", + "author": "Autor", + "website": "Webová stránka", + "permissions": "Oprávnenia", + "enabled": "Povolený", + "status": "Stav", + "path": "Cesta", + "lastError": "Chyba", + "hasError": "Chyba", + "updatedAt": "Aktualizovaný", + "createdAt": "Nainštalovaný", + "configKey": "Kľúč", + "configValue": "Hodnota", + "allUsers": "Povoliť všetkých používateľov", + "selectedUsers": "Vybraní používatelia", + "allLibraries": "Povoliť všetky knižnice", + "selectedLibraries": "Vybrané knižnice", + "allowWriteAccess": "Povoliť prístup na zápis" + }, + "sections": { + "status": "Stav", + "info": "Informácie o plugine", + "configuration": "Konfigurácia", + "manifest": "Manifest", + "usersPermission": "Oprávnenia používateľov", + "libraryPermission": "Oprávnenia knižnice" + }, + "status": { + "enabled": "Povolený", + "disabled": "Zakázaný" + }, + "actions": { + "enable": "Povoliť", + "disable": "Zakázať", + "disabledDueToError": "Opravte chybu pred povolením", + "disabledUsersRequired": "Vyberte používateľov pred povolením", + "disabledLibrariesRequired": "Vyberte knižnice pred povolením", + "addConfig": "Pridať konfiguráciu", + "rescan": "Znovu skenovať" + }, + "notifications": { + "enabled": "Plugin povolený", + "disabled": "Plugin zakázaný", + "updated": "Plugin aktualizovaný", + "error": "Chyba pri aktualizácii pluginu" + }, + "validation": { + "invalidJson": "Konfigurácia musí byť platný JSON" + }, + "messages": { + "configHelp": "Nakonfigurujte plugin pomocou párov kľúč-hodnota. Nechajte prázdne, ak plugin nevyžaduje žiadnu konfiguráciu.", + "clickPermissions": "Kliknite na oprávnenie pre detaily", + "noConfig": "Žiadna konfigurácia nastavená", + "allUsersHelp": "Keď je povolené, plugin bude mať prístup ku všetkým používateľom, vrátane tých vytvorených v budúcnosti.", + "noUsers": "Žiadni používatelia nevybraní", + "permissionReason": "Dôvod", + "usersRequired": "Tento plugin vyžaduje prístup k informáciám o používateľoch. Vyberte, ku ktorým používateľom má plugin prístup, alebo povolte 'Povoliť všetkých používateľov'.", + "allLibrariesHelp": "Keď je povolené, plugin bude mať prístup ku všetkým knižniciam, vrátane tých vytvorených v budúcnosti.", + "noLibraries": "Žiadne knižnice nevybrané", + "librariesRequired": "Tento plugin vyžaduje prístup k informáciám o knižniciach. Vyberte, ku ktorým knižniciam má plugin prístup, alebo povolte 'Povoliť všetky knižnice'.", + "requiredHosts": "Požadovaní hostitelia", + "configValidationError": "Overenie konfigurácie zlyhalo:", + "schemaRenderError": "Nie je možné zobraziť konfiguračný formulár. Schéma pluginu môže byť neplatná.", + "allowWriteAccessHelp": "Keď je povolené, plugin môže upravovať súbory v adresároch knižníc. Predvolene majú pluginy prístup iba na čítanie." + }, + "placeholders": { + "configKey": "kľúč", + "configValue": "hodnota" + } + } + }, + "ra": { + "auth": { + "welcome1": "Ďakujeme, že ste si nainštalovali Navidrome!", + "welcome2": "Najskôr vytvorte účet správcu", + "confirmPassword": "Potvrďte heslo", + "buttonCreateAdmin": "Vytvoriť správcu", + "auth_check_error": "Pre pokračovanie sa prosím prihláste", + "user_menu": "Profil", + "username": "Používateľské meno", + "password": "Heslo", + "sign_in": "Prihlásiť sa", + "sign_in_error": "Overenie zlyhalo, skúste to znova", + "logout": "Odhlásiť sa", + "insightsCollectionNote": "Navidrome zhromažďuje anonymné údaje\n o používaní, aby pomohol zlepšiť projekt.\nKliknite [sem] a dozviete sa viac a v prípade\npotreby sa odhláste." + }, + "validation": { + "invalidChars": "Prosím, používajte iba písmená a čísla", + "passwordDoesNotMatch": "Heslá sa nezhodujú", + "required": "Povinné pole", + "minLength": "Musí obsahovať najmenej %{min} znakov", + "maxLength": "Môže obsahovať maximálne %{max} znakov", + "minValue": "Musí byť aspoň %{min}", + "maxValue": "Môže byť maximálne %{max}", + "number": "Musí byť číslo", + "email": "Musí byť platná e-mailová adresa", + "oneOf": "Musí spĺňať jedno z: %{options}", + "regex": "Musí byť v špecifickom formáte (regexp): %{pattern}", + "unique": "Musí byť jedinečný", + "url": "Musí byť platná URL" + }, + "action": { + "add_filter": "Pridať filter", + "add": "Pridať", + "back": "Ísť späť", + "bulk_actions": "1 vybraná |||| %{smart_count} vybraných", + "cancel": "Zrušiť", + "clear_input_value": "Vymazať hodnotu", + "clone": "Klonovať", + "confirm": "Potvrdiť", + "create": "Vytvoriť", + "delete": "Vymazať", + "edit": "Upraviť", + "export": "Exportovať", + "list": "Zoznam", + "refresh": "Obnoviť", + "remove_filter": "Odstrániť filter", + "remove": "Odstrániť", + "save": "Uložiť", + "search": "Vyhľadať", + "show": "Zobraziť", + "sort": "Zoradiť", + "undo": "Vrátiť", + "expand": "Rozbaliť", + "close": "Zavrieť", + "open_menu": "Otvoriť ponuku", + "close_menu": "Zavrieť ponuku", + "unselect": "Zrušiť výber", + "skip": "Preskočiť", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Zdieľať", + "download": "Stiahnuť" + }, + "boolean": { + "true": "Áno", + "false": "Nie" + }, + "page": { + "create": "Vytvoriť %{name}", + "dashboard": "Dashboard", + "edit": "%{name} #%{id}", + "error": "Niečo sa pokazilo", + "list": "%{name}", + "loading": "Načítavanie", + "not_found": "Nenájdené", + "show": "%{name} #%{id}", + "empty": "Zatiaľ žiaden %{name}.", + "invite": "Chcete pridať nové?" + }, + "input": { + "file": { + "upload_several": "Presuňte súbory pre nahranie alebo kliknite pre výber.", + "upload_single": "Presuňte súbor pre nahranie alebo kliknite pre jeho výber." + }, + "image": { + "upload_several": "Presuňte obrázky pre nahranie alebo kliknite pre výber.", + "upload_single": "Presuňte obrázok pre nahranie alebo kliknite pre jeho výber." + }, + "references": { + "all_missing": "Referencované dáta sa nenašli.", + "many_missing": "Aspoň jedna z referencií už nie je dostupná.", + "single_missing": "Referencia sa zdá byť nedostupná." + }, + "password": { + "toggle_visible": "Skryť heslo", + "toggle_hidden": "Zobraziť heslo" + } + }, + "message": { + "about": "O Navidrome", + "are_you_sure": "Ste si istý?", + "bulk_delete_content": "Ste si istý, že chcete vymazať %{name}? |||| Ste si istý, že chcete vymazať týchto %{smart_count} položiek?", + "bulk_delete_title": "Vymazať %{name} |||| Vymazať %{smart_count} %{name} položiek", + "delete_content": "Ste si istý, že chcete vymazať túto položku?", + "delete_title": "Vymazať %{name} #%{id}", + "details": "Detaily", + "error": "Vyskytla sa chyba klienta a vaša požiadavka nemohla byť splnená.", + "invalid_form": "Formulár nie je platný. Prosím skontrolujte ho.", + "loading": "Stránka sa načítava, prosím počkajte", + "no": "Nie", + "not_found": "Zadali ste nesprávnu adresu URL, alebo ste nasledovali nesprávny odkaz.", + "yes": "Áno", + "unsaved_changes": "Niektoré vaše zmeny neboli uložené. Ste si istí, že ich chcete ignorovať?" + }, + "navigation": { + "no_results": "Nenašli sa žiadne výsledky", + "no_more_results": "Stránka číslo %{page} je mimo rozsah. Skúste predchádzajúcu.", + "page_out_of_boundaries": "Stránka číslo %{page} je mimo rozsah", + "page_out_from_end": "Nemožno ísť za poslednú stranu", + "page_out_from_begin": "Nemožno ísť pred prvú stranu", + "page_range_info": "%{offsetBegin}-%{offsetEnd} z %{total}", + "page_rows_per_page": "Položiek na stránke:", + "next": "Ďalší", + "prev": "Predchádzajúci", + "skip_nav": "Preskočiť na obsah" + }, + "notification": { + "updated": "Prvok aktualizovaný |||| %{smart_count} prvkov aktualizovaných", + "created": "Prvok vytvorený", + "deleted": "Prvok vymazaný |||| %{smart_count} prvkov vymazaných", + "bad_item": "Nesprávny prvok", + "item_doesnt_exist": "Prvok neexistuje", + "http_error": "Chyba komunikácie servera", + "data_provider_error": "Chyba dataProvideru. Detaily nájdete v konzole.", + "i18n_error": "Nemožno načítať preklady pre vybraný jazyk", + "canceled": "Akcia zrušená", + "logged_out": "Vaša relácia skončila, prosím pripojte sa znova.", + "new_version": "Je dostupná nová verzia! Prosím obnovte toto okno." + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Stĺpce na zobrazenie", + "layout": "Rozloženie", + "grid": "Mriežka", + "table": "Tabuľka" + } + }, + "message": { + "note": "POZNÁMKA", + "transcodingDisabled": "Zmena nastavení transkódovania je vo webovom prostredí vypnutá z bezpečnostných dôvodov. Ak chcete zmeniť (upraviť alebo pridať) možnosti transkódovania, reštartujte server s možnosťou %{config}.", + "transcodingEnabled": "Navidrome práve beží s možnosťou %{config}, ktorá umožňuje spúšťanie systémových príkazov z nastavení transkódovania pomocou webového rozhrania. Odporúčame ju vypnúť z bezpečnostných dôvodov a používať ju iba pri úprave nastavení transkódovania.", + "songsAddedToPlaylist": "1 skladba pridaná do zoznamu skladieb |||| %{smart_count} skladieb pridaných do zoznamu skladieb", + "noPlaylistsAvailable": "Žiadne nie sú dostupné", + "delete_user_title": "Odstrániť používateľa '%{name}'", + "delete_user_content": "Ste si istí, že chcete odstrániť tohto používateľa a všetky jeho dáta (vrátane zoznamov skladieb a nastavení)?", + "notifications_blocked": "Zablokovali ste si oznámenia pre túto stránku v nastaveniach vášho prehliadača", + "notifications_not_available": "Tento prehliadač nepodporuje oznámenia na ploche alebo nepristupujete k Navidrome cez https", + "lastfmLinkSuccess": "Last.fm úspešne pripojené a scrobbling zapnutý", + "lastfmLinkFailure": "Last.fm sa nepodarilo pripojiť", + "lastfmUnlinkSuccess": "Last.fm odpojené a scrobbling vypnutý", + "lastfmUnlinkFailure": "Last.fm sa nepodarilo odpojiť", + "openIn": { + "lastfm": "Otvoriť na Last.fm", + "musicbrainz": "Otvoriť na MusicBrainz" + }, + "lastfmLink": "Čítať ďalej...", + "listenBrainzLinkSuccess": "ListenBrainz úspešne pripojený a scrobbling zapnutý ako používateľ: %{user}", + "listenBrainzLinkFailure": "ListenBrainz sa nepodarilo pripojiť: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz odpojený a scrobbling vypnutý", + "listenBrainzUnlinkFailure": "ListenBrainz sa nepodarilo odpojiť", + "downloadOriginalFormat": "Stiahnuť v pôvodnom formáte", + "shareOriginalFormat": "Zdieľať v pôvodnom formáte", + "shareDialogTitle": "Zdieľať %{resource} '%{name}'", + "shareBatchDialogTitle": "Zdieľať 1 %{resource} |||| Zdieľať %{smart_count} %{resource}", + "shareSuccess": "URL skopírovaná do schránky: %{url}", + "shareFailure": "Chyba pri kopírovaní URL %{url} do schránky", + "downloadDialogTitle": "Stiahnuť %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Skopírovať do schránky: Ctrl+C, Enter", + "remove_missing_title": "Odstráňte chýbajúce súbory", + "remove_missing_content": "Naozaj chcete odstrániť vybraté chýbajúce súbory z databázy? Týmto sa natrvalo odstránia všetky odkazy na ne vrátane ich počtu prehratí a hodnotení.", + "remove_all_missing_title": "Odstráňte všetky chýbajúce súbory", + "remove_all_missing_content": "Naozaj chcete z databázy odstrániť všetky chýbajúce súbory? Týmto sa natrvalo odstránia všetky odkazy na ne vrátane ich počtu prehratí a hodnotení.", + "noSimilarSongsFound": "Nenašli sa žiadne podobné skladby", + "noTopSongsFound": "Nenašli sa žiadne top skladby", + "startingInstantMix": "Načítava sa Instant Mix...", + "uploadCover": "Nahrať obrázok obalu", + "removeCover": "Odstrániť obrázok obalu", + "coverUploaded": "Obrázok obalu albumu aktualizovaný", + "coverRemoved": "Obrázok obalu albumu odstránený", + "coverUploadError": "Chyba pri nahrávaní obrázku obalu albumu", + "coverRemoveError": "Chyba pri odstraňovaní obrázku obalu albumu" + }, + "menu": { + "library": "Knižnica", + "settings": "Nastavenia", + "version": "Verzia", + "theme": "Téma", + "personal": { + "name": "Osobné", + "options": { + "theme": "Téma", + "language": "Jazyk", + "defaultView": "Predvolená stránka", + "desktop_notifications": "Oznámenia na ploche", + "lastfmScrobbling": "Scrobblovať na Last.fm", + "listenBrainzScrobbling": "Scrobblovať na ListenBrainz", + "replaygain": "Mód ReplayGain", + "preAmp": "ReplayGain PreAmp (dB)", + "gain": { + "none": "Vypnuté", + "album": "Použiť Album Gain", + "track": "Použiť Track Gain" + }, + "lastfmNotConfigured": "Kľúč API Last.fm nie je nakonfigurovaný" + } + }, + "albumList": "Albumy", + "about": "O Navidrome", + "playlists": "Zoznamy skladieb", + "sharedPlaylists": "Zdieľané zoznamy skladieb", + "librarySelector": { + "allLibraries": "Všetky knižnice (%{count})", + "multipleLibraries": "%{selected} z %{total} knižníc", + "selectLibraries": "Vyberte knižnice", + "none": "Žiadne" + } + }, + "player": { + "playListsText": "Rad", + "openText": "Otvoriť", + "closeText": "Zavrieť", + "notContentText": "Žiadne skladby", + "clickToPlayText": "Kliknite pre prehranie", + "clickToPauseText": "Kliknite pre pozastavenie", + "nextTrackText": "Ďalšia skladba", + "previousTrackText": "Predchádzajúca skladba", + "reloadText": "Znovu načítať", + "volumeText": "Hlasitosť", + "toggleLyricText": "Prepnúť text", + "toggleMiniModeText": "Zmenšiť", + "destroyText": "Zničiť", + "downloadText": "Stiahnuť", + "removeAudioListsText": "Vymazať zoznam", + "clickToDeleteText": "Kliknite pre odstránenie %{name}", + "emptyLyricText": "Bez textu", + "playModeText": { + "order": "Po poradí", + "orderLoop": "Opakovať", + "singleLoop": "Opakovať raz", + "shufflePlay": "Zamiešať" + } + }, + "about": { + "links": { + "homepage": "Domovská stránka", + "source": "Zdrojový kód", + "featureRequests": "Požiadavky na funkcie", + "lastInsightsCollection": "Posledný zber štatistík", + "insights": { + "disabled": "Zakázané", + "waiting": "Čakanie" + } + }, + "tabs": { + "about": "O aplikácii", + "config": "Konfigurácia" + }, + "config": { + "configName": "Názov konfigurácie", + "environmentVariable": "Premenná prostredia", + "currentValue": "Aktuálna hodnota", + "configurationFile": "Konfiguračný súbor", + "exportToml": "Exportovať konfiguráciu (TOML)", + "exportSuccess": "Konfigurácia exportovaná do schránky vo formáte TOML", + "exportFailed": "Nepodarilo sa skopírovať konfiguráciu", + "devFlagsHeader": "Vývojové príznaky (môžu byť zmenené/odstránené)", + "devFlagsComment": "Toto sú experimentálne nastavenia a môžu byť odstránené v budúcich verziách", + "downloadToml": "Stiahnuť konfiguráciu (TOML)" + } + }, + "activity": { + "title": "Aktivita", + "totalScanned": "Naskenované priečinky", + "quickScan": "Rýchly sken", + "fullScan": "Úplný sken", + "serverUptime": "Doba od spustenia", + "serverDown": "OFFLINE", + "scanType": "Posledný Sken", + "status": "Chyba skenovania", + "elapsedTime": "Uplynutý čas", + "selectiveScan": "Selektívne" + }, + "help": { + "title": "Klávesové skratky Navidrome", + "hotkeys": { + "show_help": "Zobraziť túto nápovedu", + "toggle_menu": "Prepnúť bočné menu", + "toggle_play": "Prehrať / Pozastaviť", + "prev_song": "Predchádzajúca skladba", + "next_song": "Nasledujúca skladba", + "vol_up": "Zvýšiť hlasitosť", + "vol_down": "Znížiť hlasitosť", + "toggle_love": "Pridať túto skladbu do obľúbených", + "current_song": "Prejsť na aktuálnu skladbu" + } + }, + "nowPlaying": { + "title": "Práve hrá", + "empty": "Nič sa neprehráva", + "minutesAgo": "pred %{smart_count} minútou |||| pred %{smart_count} minútami" + } +} \ No newline at end of file diff --git a/resources/i18n/sl.json b/resources/i18n/sl.json index f860245e8..ceb56e9b7 100644 --- a/resources/i18n/sl.json +++ b/resources/i18n/sl.json @@ -1,460 +1,715 @@ { - "languageName": "Slovenščina", - "resources": { - "song": { - "name": "Pesem |||| Pesmi", - "fields": { - "albumArtist": "Avtor albuma", - "duration": "Dolžina", - "trackNumber": "#", - "playCount": "Predvajano", - "title": "Naslov", - "artist": "Avtor", - "album": "Album", - "path": "Pot datoteke", - "genre": "Žanr", - "compilation": "Kompilacija", - "year": "Leto", - "size": "Velikost datoteke", - "updatedAt": "Posodobljeno", - "bitRate": "Bitna hitrost", - "discSubtitle": "Podnapisi", - "starred": "Priljubljen", - "comment": "Opomba", - "rating": "Ocena", - "quality": "Kakovost", - "bpm": "BPM", - "playDate": "Zadnja predvajana", - "channels": "Kanali", - "createdAt": "Datum dodano" - }, - "actions": { - "addToQueue": "Predvajaj kasneje", - "playNow": "Predvajaj", - "addToPlaylist": "Dodaj na seznam predvajanj", - "shuffleAll": "Premešaj vse", - "download": "Naloži", - "playNext": "Naslednji", - "info": "Več informacij" - } - }, - "album": { - "name": "Album |||| Albumi", - "fields": { - "albumArtist": "Avtor albuma", - "artist": "Izvajalec", - "duration": "Dolžina", - "songCount": "Pesmi", - "playCount": "Predvajano", - "name": "Naslov", - "genre": "Žanr", - "compilation": "Kompilacija", - "year": "Leto", - "updatedAt": "Posodobljeno", - "comment": "Opomba", - "rating": "Ocena", - "createdAt": "Datum dodano", - "size": "Velikost", - "originalDate": "Original", - "releaseDate": "Izdano", - "releases": "Izdaja |||| Izdaje", - "released": "Izdano" - }, - "actions": { - "playAll": "Predvajaj vse", - "playNext": "Naslednji", - "addToQueue": "Predvajaj kasneje", - "shuffle": "Premešaj", - "addToPlaylist": "Dodaj v seznam predvajanja", - "download": "Naloži", - "info": "Več informacij", - "share": "Deli" - }, - "lists": { - "all": "Vse", - "random": "Naključno", - "recentlyAdded": "Dodan nedavno", - "recentlyPlayed": "Predvajan nedavno", - "mostPlayed": "Največ predvajano", - "starred": "Priljubljeni", - "topRated": "Najvišje ocenjeno" - } - }, - "artist": { - "name": "Izvajalec |||| Izvajalci", - "fields": { - "name": "Ime", - "albumCount": "# albumov", - "songCount": "# pesmi", - "playCount": "# predvajanj", - "rating": "Ocena", - "genre": "Žanr", - "size": "Velikost" - } - }, - "user": { - "name": "Uporabnik |||| Uporabniki", - "fields": { - "userName": "Uporabnik", - "isAdmin": "Upravitelj", - "lastLoginAt": "Zadnji vpis", - "updatedAt": "Posodobljeno", - "name": "Ime", - "password": "Geslo", - "createdAt": "Ustvarjeno", - "changePassword": "Spremeni geslo?", - "currentPassword": "Trenutno geslo", - "newPassword": "Novo geslo", - "token": "Žeton" - }, - "helperTexts": { - "name": "Sprememba imena bo vidna pri naslednjem vpisu" - }, - "notifications": { - "created": "Uporabnik ustvarjen", - "updated": "Uporabnik posodobljen", - "deleted": "Uporabnik izbrisan" - }, - "message": { - "listenBrainzToken": "Vnesi žeton uporabnika ListenBrainz.", - "clickHereForToken": "Klikni za žeton" - } - }, - "player": { - "name": "Predvajalnik |||| Predvajalniki", - "fields": { - "name": "Naziv", - "transcodingId": "Transkodiranje", - "maxBitRate": "Maks. bitrate", - "client": "Klijent", - "userName": "Uporabnik", - "lastSeen": "Zadnjič viden", - "reportRealPath": "Zabeleži pravo pot", - "scrobbleEnabled": "Pošlji Scrobbles zunanjim storitvam" - } - }, - "transcoding": { - "name": "Transkodiranje |||| Transkodiranje", - "fields": { - "name": "Ime", - "targetFormat": "Ciljni format", - "defaultBitRate": "Privzet bitrate", - "command": "Ukaz" - } - }, - "playlist": { - "name": "Seznam predvajanj |||| Seznami predvajanj", - "fields": { - "name": "Ime", - "duration": "Dolžina", - "ownerName": "Lastnik", - "public": "Javno", - "updatedAt": "Posodobljen", - "createdAt": "Ustvarjen", - "songCount": "# pesmi", - "comment": "Opomba", - "sync": "Avtomatski uvoz", - "path": "Uvozi iz" - }, - "actions": { - "selectPlaylist": "Izberi seznam", - "addNewPlaylist": "Ustvari \"%{name}\"", - "export": "Izvozi", - "makePublic": "Naredi javno", - "makePrivate": "Naredi zasebno" - }, - "message": { - "duplicate_song": "Dodaj podvojene pesmi", - "song_exist": "Seznamu predvajanja boste dodali duplikate. Jih želite dodati ali izpustiti?" - } - }, - "radio": { - "name": "Radio |||| Radiji", - "fields": { - "name": "Ime", - "streamUrl": "URL toka", - "homePageUrl": "URL domače strani", - "updatedAt": "Posodobljeno ob", - "createdAt": "Ustvarjeno ob" - }, - "actions": { - "playNow": "Predvajaj" - } - }, - "share": { - "name": "Deli |||| Delitev", - "fields": { - "username": "Delil z", - "url": "URL", - "description": "Opis", - "contents": "Vsebine", - "expiresAt": "Poteče", - "lastVisitedAt": "Nazadnje obiskano", - "visitCount": "Obiski", - "format": "Oblika", - "maxBitRate": "Maks. bitna hitrost", - "updatedAt": "Posodobljeno ob", - "createdAt": "Ustvarjeno ob", - "downloadable": "Dovoli prenose?" - } - } + "languageName": "Slovenščina", + "resources": { + "song": { + "name": "Pesem |||| Pesmi", + "fields": { + "albumArtist": "Avtor albuma", + "duration": "Dolžina", + "trackNumber": "#", + "playCount": "Predvajano", + "title": "Naslov", + "artist": "Avtor", + "album": "Album", + "path": "Pot datoteke", + "genre": "Žanr", + "compilation": "Kompilacija", + "year": "Leto", + "size": "Velikost datoteke", + "updatedAt": "Posodobljeno", + "bitRate": "Bitna hitrost", + "discSubtitle": "Podnapisi", + "starred": "Priljubljen", + "comment": "Opomba", + "rating": "Ocena", + "quality": "Kakovost", + "bpm": "BPM", + "playDate": "Zadnja predvajana", + "channels": "Kanali", + "createdAt": "Datum dodano", + "grouping": "Grupiranje", + "mood": "Razpoloženje", + "participants": "Dodatni udeleženci", + "tags": "Dodatne oznake", + "mappedTags": "Preslikane oznake", + "rawTags": "Nespremenjene oznake", + "bitDepth": "Bitna globina", + "sampleRate": "Frekvenca vzorčenja", + "missing": "Manjka", + "libraryName": "Knjižnica", + "composer": "Skladatelj", + "disc": "" + }, + "actions": { + "addToQueue": "Predvajaj kasneje", + "playNow": "Predvajaj", + "addToPlaylist": "Dodaj na seznam predvajanj", + "shuffleAll": "Premešaj vse", + "download": "Naloži", + "playNext": "Naslednji", + "info": "Več informacij", + "showInPlaylist": "Prikaži na seznamu predvajanja", + "instantMix": "Instant Mix" + } }, - "ra": { - "auth": { - "welcome1": "Hvala, da ste naložili Navidrome!", - "welcome2": "Za začetek, ustvarite upraviteljski račun", - "confirmPassword": "Potrdi Geslo", - "buttonCreateAdmin": "Ustvari upravitelja", - "auth_check_error": "Vpišite se za nadaljevanje", - "user_menu": "Profil", - "username": "Uporabnik", - "password": "Geslo", - "sign_in": "Vpis", - "sign_in_error": "Avtentikacija neuspešna, poskusite ponovno", - "logout": "Izpis" - }, - "validation": { - "invalidChars": "Uporabi samo alfanumerične znake", - "passwordDoesNotMatch": "Geslo se ne ujema", - "required": "Potreben", - "minLength": "Potrebnih je vsaj %{min} znakov", - "maxLength": "Potrebnih je največ %{max}", - "minValue": "Potrebnih je vsaj %{min}", - "maxValue": "Potrebnih je največ %{max}", - "number": "Mora biti številka", - "email": "Veljaven e-poštni naslov", - "oneOf": "Mora biti ena izmed %{options}", - "regex": "Mora se ujemati z določeno obliko (regexp): %{pattern}", - "unique": "Mora biti edinstven", - "url": "Biti mora veljaven URL" - }, - "action": { - "add_filter": "Dodaj filter", - "add": "Dodaj", - "back": "Nazaj", - "bulk_actions": "Izbran 1 element |||| Izbranih %{smart_count} elementov", - "cancel": "Prekliči", - "clear_input_value": "Pobriši", - "clone": "Podvoji", - "confirm": "Potrdi", - "create": "Ustvari", - "delete": "Izbriši", - "edit": "Uredi", - "export": "Izvozi", - "list": "Seznam", - "refresh": "Osveži", - "remove_filter": "Odstrani filter", - "remove": "Odstrani", - "save": "Shrani", - "search": "Išči", - "show": "Prikaži", - "sort": "Razvrsti", - "undo": "Razveljavi", - "expand": "Razširi", - "close": "Zapri", - "open_menu": "Odpri meni", - "close_menu": "Zapri meni", - "unselect": "Prekliči izbiro", - "skip": "Izpusti", - "bulk_actions_mobile": "1 |||| %{smart_count}", - "share": "Deli", - "download": "Prenesi" - }, - "boolean": { - "true": "Da", - "false": "Ne" - }, - "page": { - "create": "Ustvari %{name}", - "dashboard": "Nadzorna plošča", - "edit": "%{name} #%{id}", - "error": "Nedoločena napaka", - "list": "%{name}", - "loading": "Nalagam", - "not_found": "Ni zadetka", - "show": "%{name} #%{id}", - "empty": "Še brez %{name}.", - "invite": "Ga želite dodati?" - }, - "input": { - "file": { - "upload_several": "Povlecite datoteke ali pa kliknite in izberite.", - "upload_single": "Povlecite datoteko ali pa kliknite in izberite." - }, - "image": { - "upload_several": "Povlecite slike, ali pa kliknite in izberite.", - "upload_single": "Povlecite sliko, ali pa kliknite in izberite." - }, - "references": { - "all_missing": "Ne najdem referenciranih podatkov.", - "many_missing": "Zdi se, da vsaj ena asociirana referenca ni več na voljo.", - "single_missing": "Zdi se, da asociirana referenca ni več na voljo." - }, - "password": { - "toggle_visible": "Skrij geslo", - "toggle_hidden": "Prikaži geslo" - } - }, - "message": { - "about": "O programu", - "are_you_sure": "Ste prepričani?", - "bulk_delete_content": "Ste prepričani, da želite izbrisati %{name}? |||| Ste prepričani, da želite izbrisati %{smart_count} elementov?", - "bulk_delete_title": "Izbriši %{name} |||| Izbriši %{smart_count} %{name}", - "delete_content": "Ste prepričani, da želite izbrisati ta element?", - "delete_title": "Izbriši %{name} #%{id}", - "details": "Podrobnosti", - "error": "Napak klijenta. Vaš zahtevek se je zaključil neuspešno.", - "invalid_form": "Oblika ni veljavna. Prosim preverite napake", - "loading": "Stran se nalaga, trenutek", - "no": "Ne", - "not_found": "Ali ste vtipkali napačen naslov (URL), ali pa sledili neobstoječi povezavi.", - "yes": "Da", - "unsaved_changes": "Nekate spremembe se niso shranile. Ste prepričani, da jih želite ignorirati?" - }, - "navigation": { - "no_results": "Ni zadetkov", - "no_more_results": "Številka strani %{page} je zunaj meja. Preizkusite prejšnjo stran.", - "page_out_of_boundaries": "Številka strani %{page} je zunaj meja", - "page_out_from_end": "Ne gre dalje od zadnje strani", - "page_out_from_begin": "Ne gre pred prvo stran", - "page_range_info": "%{offsetBegin}-%{offsetEnd} od %{total}", - "page_rows_per_page": "Elementov na stran:", - "next": "Naslednji", - "prev": "Prejšnji", - "skip_nav": "Preskoči k vsebini" - }, - "notification": { - "updated": "Element posodobljen |||| Posodobljenih %{smart_count} elementov", - "created": "Element dodan", - "deleted": "Element izbrisan |||| %{smart_count} elementov izbrisanih", - "bad_item": "Nepravilen element", - "item_doesnt_exist": "Element ne obstaja", - "http_error": "Strežnika napaka v komunikaciji", - "data_provider_error": "Napaka dataProvider error. Preverite konzolo za podrobnosti.", - "i18n_error": "Ne uspem naložiti prevode za izbran jezik", - "canceled": "Akcija preklicana", - "logged_out": "Seja je potekla, prosim povežite se ponovno.", - "new_version": "Na voljo je nova verzija! Prosim osvežite okno." - }, - "toggleFieldsMenu": { - "columnsToDisplay": "Prikaži stolpce", - "layout": "Razporeditev", - "grid": "Mreža", - "table": "Tabela" - } + "album": { + "name": "Album |||| Albumi", + "fields": { + "albumArtist": "Avtor albuma", + "artist": "Izvajalec", + "duration": "Dolžina", + "songCount": "Pesmi", + "playCount": "Predvajano", + "name": "Naslov", + "genre": "Žanr", + "compilation": "Kompilacija", + "year": "Leto", + "updatedAt": "Posodobljeno", + "comment": "Opomba", + "rating": "Ocena", + "createdAt": "Datum dodano", + "size": "Velikost", + "originalDate": "Original", + "releaseDate": "Izdano", + "releases": "Izdaja |||| Izdaje", + "released": "Izdano", + "recordLabel": "Založba", + "catalogNum": "Kataloška številka", + "releaseType": "Tip", + "grouping": "Grupiranje", + "media": "Medij", + "mood": "Razpoloženje", + "date": "Datum snemanja", + "missing": "Manjka", + "libraryName": "Knjižnica" + }, + "actions": { + "playAll": "Predvajaj vse", + "playNext": "Naslednji", + "addToQueue": "Predvajaj kasneje", + "shuffle": "Premešaj", + "addToPlaylist": "Dodaj v seznam predvajanja", + "download": "Naloži", + "info": "Več informacij", + "share": "Deli" + }, + "lists": { + "all": "Vse", + "random": "Naključno", + "recentlyAdded": "Dodan nedavno", + "recentlyPlayed": "Predvajan nedavno", + "mostPlayed": "Največ predvajano", + "starred": "Priljubljeni", + "topRated": "Najvišje ocenjeno" + } }, - "message": { - "note": "OPOMBA", - "transcodingDisabled": "Sprememba konfiguracije transkodiranja skozi spletni vmesnik je onemogočeno zaradi varnostnih razlogov. Če želite spremeniti (urediti ali izbrisati) možnosti transkodiranja, ponovno zaženite strežnik z %{config} nastavitvami.", - "transcodingEnabled": "Navidrome trenutno uporablja nastavitve %{config}, kar pomeni da je možno pognati sistemske ukaze v nastavitvah transkodiranja preko spletnega vmesnika.\nZaradi varnostnih razlogov je možnost priporočeno onemogočiti , razen v primeru spreminjanja nastavitev.", - "songsAddedToPlaylist": "Dodaj pesem na seznam predvajanj |||| Dodaj %{smart_count} pesmi na seznam predvajanj", - "noPlaylistsAvailable": "Ni seznamov", - "delete_user_title": "Odstrani uporabnika '%{name}'", - "delete_user_content": "Ste prepričani o izbrisu uporabnika, vključno z njegovimi podatki (tudi seznami predvajanj in nastavitvami)?", - "notifications_blocked": "V vašem brskljalniku Imate blokirana možnost obvestil za to spletno stran", - "notifications_not_available": "Vaš brskljalnik ne omogoča obvestil na namizju ali pa do Navidrome ne dostopate po varni povezavi (https)", - "lastfmLinkSuccess": "Last.fm uspešno povezan in 'scrobbling' omogočen", - "lastfmLinkFailure": "Last.fm ni uspešno povezan", - "lastfmUnlinkSuccess": "Last.fm povezava prekinjena in 'scrobbling' onemogočen", - "lastfmUnlinkFailure": "Last.fm povezava neuspešno prekinjena", - "openIn": { - "lastfm": "Odpri v Last.fm", - "musicbrainz": "Odpri v MusicBrainz" - }, - "lastfmLink": "Preberi več...", - "listenBrainzLinkSuccess": "ListenBrainz uspešno povezan in scrobbling vključen za uporabnika: %{user}", - "listenBrainzLinkFailure": "ListBrainz neuspešno povezan: %{error}", - "listenBrainzUnlinkSuccess": "ListenBrainz povezava prekinjena in scrobbling izključen", - "listenBrainzUnlinkFailure": "ListenBrainz prekinitev povezave neuspešna", - "downloadOriginalFormat": "Prenesi v izvirni obliki", - "shareOriginalFormat": "Deli v izvirni obliki", - "shareDialogTitle": "Deli %{resource} '%{name}'", - "shareBatchDialogTitle": "Deli 1 %{resource} |||| Deli %{smart_count} %{resource}", - "shareSuccess": "URL kopiran v odložišče: %{url}", - "shareFailure": "Napaka pri kopiranju URL-ja %{url} v odložišče", - "downloadDialogTitle": "Prenesi %{resource} '%{name}' (%{size})", - "shareCopyToClipboard": "Kopiraj v odložišče: Ctrl+C, Enter" + "artist": { + "name": "Izvajalec |||| Izvajalci", + "fields": { + "name": "Ime", + "albumCount": "# albumov", + "songCount": "# pesmi", + "playCount": "# predvajanj", + "rating": "Ocena", + "genre": "Žanr", + "size": "Velikost", + "role": "Vloga", + "missing": "Manjka" + }, + "roles": { + "albumartist": "Izvajalec albuma |||| Izvajalci albuma", + "artist": "Izvajalec |||| Izvajalci", + "composer": "Skladatelj |||| Skladatelji", + "conductor": "Dirigent |||| Dirigenti", + "lyricist": "Tekstopisec |||| Tekstopisci", + "arranger": "Aranžer |||| Aranžerji", + "producer": "Producent |||| Producenti", + "director": "Glasbeni vodja |||| Glasbene vodje", + "engineer": "Inženir |||| Inženirji", + "mixer": "Mešalec |||| Mešalci", + "remixer": "Remikser |||| Remikserji", + "djmixer": "DJ mešalec |||| DJ mešalci", + "performer": "Izvajalec |||| Izvajalci", + "maincredit": "Izvajalec albuma ali izvajalec |||| Izvajalci albuma ali izvajalci" + }, + "actions": { + "shuffle": "Naključno predvajanje", + "radio": "Radio", + "topSongs": "Najboljše pesmi" + } }, - "menu": { - "library": "Knjižnica", - "settings": "Nastavitve", - "version": "Različica", - "theme": "Tema", - "personal": { - "name": "Osebno", - "options": { - "theme": "Tema", - "language": "Jezik", - "defaultView": "Privzet pogled", - "desktop_notifications": "Namizna obvestila", - "lastfmScrobbling": "'Scrobble' do Last.fm", - "listenBrainzScrobbling": "Scrobble k ListenBrainz", - "replaygain": "ReplayGain način", - "preAmp": "ReplayGain PreAmp (dB)", - "gain": { - "none": "Onemogočeno", - "album": "Uporabi Album Gain", - "track": "Uporabi Track Gain" - } - } - }, - "albumList": "Albumi", - "about": "O programu", - "playlists": "Seznami predvajanj", - "sharedPlaylists": "Deljeni seznami predvajanj" + "user": { + "name": "Uporabnik |||| Uporabniki", + "fields": { + "userName": "Uporabnik", + "isAdmin": "Upravitelj", + "lastLoginAt": "Zadnji vpis", + "updatedAt": "Posodobljeno", + "name": "Ime", + "password": "Geslo", + "createdAt": "Ustvarjeno", + "changePassword": "Spremeni geslo?", + "currentPassword": "Trenutno geslo", + "newPassword": "Novo geslo", + "token": "Žeton", + "lastAccessAt": "Zadnji dostop", + "libraries": "Knjižnice" + }, + "helperTexts": { + "name": "Sprememba imena bo vidna pri naslednjem vpisu", + "libraries": "Izberite določene knjižnice za uporabnika ali pustite prazno, če želite uporabiti privzete knjižnice" + }, + "notifications": { + "created": "Uporabnik ustvarjen", + "updated": "Uporabnik posodobljen", + "deleted": "Uporabnik izbrisan" + }, + "message": { + "listenBrainzToken": "Vnesi žeton uporabnika ListenBrainz.", + "clickHereForToken": "Klikni za žeton", + "selectAllLibraries": "Izberi vse knjižnice", + "adminAutoLibraries": "Skrbniški uporabniki imajo samodejno dostop do vseh knjižnic" + }, + "validation": { + "librariesRequired": "Za uporabnike brez skrbniških pravic mora biti izbrana vsaj ena knjižnica" + } }, "player": { - "playListsText": "Predvajaj vrsto", - "openText": "Odpri", - "closeText": "Zapri", - "notContentText": "Ni glasbe", - "clickToPlayText": "Predvajaj", - "clickToPauseText": "Premor predvajanja", - "nextTrackText": "Naslednje predvajanje", - "previousTrackText": "Prejšnji", - "reloadText": "Ponovno naloži", - "volumeText": "Glasnost", - "toggleLyricText": "Preklopi besedila", - "toggleMiniModeText": "Pomanjšaj", - "destroyText": "Uniči", - "downloadText": "Naloži", - "removeAudioListsText": "Izbriši avdio seznam", - "clickToDeleteText": "Klikni za izbris %{name}", - "emptyLyricText": "Ni besedila", - "playModeText": { - "order": "Po vrsti", - "orderLoop": "Ponavljaj", - "singleLoop": "Ponovi enkrat", - "shufflePlay": "Premešaj" - } + "name": "Predvajalnik |||| Predvajalniki", + "fields": { + "name": "Naziv", + "transcodingId": "Transkodiranje", + "maxBitRate": "Maks. bitrate", + "client": "Klijent", + "userName": "Uporabnik", + "lastSeen": "Zadnjič viden", + "reportRealPath": "Zabeleži pravo pot", + "scrobbleEnabled": "Pošlji Scrobbles zunanjim storitvam" + } }, - "about": { - "links": { - "homepage": "Domača stran", - "source": "Izvorna koda", - "featureRequests": "Funkcionalni zahtevki" - } + "transcoding": { + "name": "Transkodiranje |||| Transkodiranje", + "fields": { + "name": "Ime", + "targetFormat": "Ciljni format", + "defaultBitRate": "Privzet bitrate", + "command": "Ukaz" + } }, - "activity": { - "title": "Aktivnost", - "totalScanned": "Skupaj preiskanih map", - "quickScan": "Hitro preišči", - "fullScan": "Polno preišči", - "serverUptime": "Čas delovanja", - "serverDown": "NEPOVEZAN" + "playlist": { + "name": "Seznam predvajanj |||| Seznami predvajanj", + "fields": { + "name": "Ime", + "duration": "Dolžina", + "ownerName": "Lastnik", + "public": "Javno", + "updatedAt": "Posodobljen", + "createdAt": "Ustvarjen", + "songCount": "# pesmi", + "comment": "Opomba", + "sync": "Avtomatski uvoz", + "path": "Uvozi iz" + }, + "actions": { + "selectPlaylist": "Izberi seznam", + "addNewPlaylist": "Ustvari \"%{name}\"", + "export": "Izvozi", + "makePublic": "Naredi javno", + "makePrivate": "Naredi zasebno", + "saveQueue": "Shrani čakalno vrsto na seznam predvajanja", + "searchOrCreate": "Iščite po seznamih predvajanja ali vnesite besedilo, da ustvarite nove ...", + "pressEnterToCreate": "Pritisnite Enter za ustvarjanje novega seznama predvajanja", + "removeFromSelection": "Odstrani iz izbora" + }, + "message": { + "duplicate_song": "Dodaj podvojene pesmi", + "song_exist": "Seznamu predvajanja boste dodali duplikate. Jih želite dodati ali izpustiti?", + "noPlaylistsFound": "Ni najdenih seznamov predvajanja", + "noPlaylists": "Ni na voljo seznamov predvajanja" + } }, - "help": { - "title": "Hitre tipke", - "hotkeys": { - "show_help": "Prikaži pomoč", - "toggle_menu": "Preklopi stransko vrstico menija", - "toggle_play": "Predvajaj / Pavza", - "prev_song": "Prejšnja", - "next_song": "Naslednja", - "vol_up": "Zvišaj glasnost", - "vol_down": "Znižaj glasnost", - "toggle_love": "Dodaj med priljubljene", - "current_song": "Skoči na predvajano" - } + "radio": { + "name": "Radio |||| Radiji", + "fields": { + "name": "Ime", + "streamUrl": "URL toka", + "homePageUrl": "URL domače strani", + "updatedAt": "Posodobljeno ob", + "createdAt": "Ustvarjeno ob" + }, + "actions": { + "playNow": "Predvajaj" + } + }, + "share": { + "name": "Deli |||| Delitev", + "fields": { + "username": "Delil z", + "url": "URL", + "description": "Opis", + "contents": "Vsebine", + "expiresAt": "Poteče", + "lastVisitedAt": "Nazadnje obiskano", + "visitCount": "Obiski", + "format": "Oblika", + "maxBitRate": "Maks. bitna hitrost", + "updatedAt": "Posodobljeno ob", + "createdAt": "Ustvarjeno ob", + "downloadable": "Dovoli prenose?" + } + }, + "missing": { + "name": "Manjkajoča datoteka |||| Manjkajoče datoteke", + "fields": { + "path": "Pot", + "size": "Velikost", + "updatedAt": "Izginil", + "libraryName": "Knjižnica" + }, + "actions": { + "remove": "Odstrani", + "remove_all": "Odstrani vse" + }, + "notifications": { + "removed": "Manjkajoče datoteke odstranjene" + }, + "empty": "Brez manjkajočih datotek" + }, + "library": { + "name": "Knjižnica |||| Knjižnice", + "fields": { + "name": "Ime", + "path": "Pot", + "remotePath": "Oddaljena pot", + "lastScanAt": "Zadnje skeniranje", + "songCount": "Pesmi", + "albumCount": "Albumi", + "artistCount": "Umetniki", + "totalSongs": "Pesmi", + "totalAlbums": "Albumi", + "totalArtists": "Umetniki", + "totalFolders": "Mape", + "totalFiles": "Datoteke", + "totalMissingFiles": "Manjkajoče datoteke", + "totalSize": "Skupna velikost", + "totalDuration": "Trajanje", + "defaultNewUsers": "Privzeto za nove uporabnike", + "createdAt": "Ustvarjeno", + "updatedAt": "Posodobljeno" + }, + "sections": { + "basic": "Osnovne informacije", + "statistics": "Statistika" + }, + "actions": { + "scan": "Skeniraj knjižnico", + "manageUsers": "Upravljanje dostopa uporabnikov", + "viewDetails": "Ogled podrobnosti", + "quickScan": "Hitro skeniranje", + "fullScan": "Popolno skeniranje" + }, + "notifications": { + "created": "Knjižnica je uspešno ustvarjena", + "updated": "Knjižnica je bila uspešno posodobljena", + "deleted": "Knjižnica je uspešno izbrisana", + "scanStarted": "Skeniranje knjižnice se je začelo", + "scanCompleted": "Skeniranje knjižnice končano", + "quickScanStarted": "Hitro skeniranje se je začelo", + "fullScanStarted": "Popolno skeniranje se je začelo", + "scanError": "Napaka pri začetku skeniranja. Preverite dnevnike" + }, + "validation": { + "nameRequired": "Ime knjižnice je obvezno", + "pathRequired": "Pot do knjižnice je obvezna", + "pathNotDirectory": "Pot do knjižnice mora biti imenik", + "pathNotFound": "Pot do knjižnice ni bila najdena", + "pathNotAccessible": "Pot do knjižnice ni dostopna", + "pathInvalid": "Neveljavna pot do knjižnice" + }, + "messages": { + "deleteConfirm": "Ali ste prepričani, da želite izbrisati to knjižnico? S tem boste odstranili vse povezane podatke in dostop uporabnikov.", + "scanInProgress": "Skeniranje v teku...", + "noLibrariesAssigned": "Uporabnik nima dodeljenih knjižnic" + } + }, + "plugin": { + "name": "Vtičnik |||| Vtičniki", + "fields": { + "id": "ID", + "name": "Ime", + "description": "Opis", + "version": "Verzija", + "author": "Avtor", + "website": "Spletna stran", + "permissions": "Dovoljenja", + "enabled": "Vključeno", + "status": "Status", + "path": "Pot", + "lastError": "Napaka", + "hasError": "Napaka", + "updatedAt": "Posodobljeno", + "createdAt": "Inštalirano", + "configKey": "Ključ", + "configValue": "Vrednost", + "allUsers": "Dovoli vsem uporabnikom", + "selectedUsers": "Izbrani uporabniki", + "allLibraries": "Dovoli vse knjižnice", + "selectedLibraries": "Izbrane knjižnice", + "allowWriteAccess": "" + }, + "sections": { + "status": "Status", + "info": "Informacije o vtičniku", + "configuration": "Konfiguracija", + "manifest": "Manifest", + "usersPermission": "Uporabniška dovoljenja", + "libraryPermission": "Knjižnična dovoljenja" + }, + "status": { + "enabled": "Vključeno", + "disabled": "Izključeno" + }, + "actions": { + "enable": "Vključi", + "disable": "Izključi", + "disabledDueToError": "Popravi napako pred vključitvijo", + "disabledUsersRequired": "Izberi uporabnike pred vključitvijo", + "disabledLibrariesRequired": "Izberi knjižnice pred vključitvijo", + "addConfig": "Dodaj konfiguracijo", + "rescan": "Ponovi skeniranje" + }, + "notifications": { + "enabled": "Vtičnik vključen", + "disabled": "Vtičnik izključen", + "updated": "Vtičnik posodobljen", + "error": "Napaka pri posodobitvi vtičnika" + }, + "validation": { + "invalidJson": "Konfiguracija mora biti pravilen JSON" + }, + "messages": { + "configHelp": "Konfiguriraj vtičnik z uporabo key-value parov. Pusti prazno, če vtičnik ne potrebuje konfiguracije.", + "clickPermissions": "Klikni za dovoljenje o podrobnostih", + "noConfig": "Konfiguracija ni nastavljena", + "allUsersHelp": "Ko vključeno, bo vtičnik imel dostop do vseh uporabnikov, tudi prihodnjih.", + "noUsers": "Uporabniki niso izbrani", + "permissionReason": "Razlog", + "usersRequired": "Vtičnik potrebuje dostop do uporabnikovih informacij. Izberi uporabnike ali vključi dostop vsem uporabnikom.", + "allLibrariesHelp": "Ko vključeno, bo vtičnik imel dostop do vseh knjižnic, tudi prihodnjih.", + "noLibraries": "Ni izbranih knjižnic", + "librariesRequired": "Vtičnik zahteva dostop do knjižnih informacij. Izberi do katerih knjižnic lahko dostopa, ali vključi dostop do vseh knjižnic.", + "requiredHosts": "Zahtevani gostitelji", + "configValidationError": "Validacija konfiguracije neuspešna:", + "schemaRenderError": "Konfiguracijskega obrazca ni mogoče upodobiti. Shema vtičnika je morda neveljavna.", + "allowWriteAccessHelp": "" + }, + "placeholders": { + "configKey": "ključ", + "configValue": "vrednost" + } } -} \ No newline at end of file + }, + "ra": { + "auth": { + "welcome1": "Hvala, da ste naložili Navidrome!", + "welcome2": "Za začetek, ustvarite upraviteljski račun", + "confirmPassword": "Potrdi Geslo", + "buttonCreateAdmin": "Ustvari upravitelja", + "auth_check_error": "Vpišite se za nadaljevanje", + "user_menu": "Profil", + "username": "Uporabnik", + "password": "Geslo", + "sign_in": "Vpis", + "sign_in_error": "Avtentikacija neuspešna, poskusite ponovno", + "logout": "Izpis", + "insightsCollectionNote": "Navidrome zbira anonimne podatke o uporabi \nz namenom izboljšanja projekta. \nKliknite [tukaj], če želite izvedeti več ali se odjaviti" + }, + "validation": { + "invalidChars": "Uporabi samo alfanumerične znake", + "passwordDoesNotMatch": "Geslo se ne ujema", + "required": "Potreben", + "minLength": "Potrebnih je vsaj %{min} znakov", + "maxLength": "Potrebnih je največ %{max}", + "minValue": "Potrebnih je vsaj %{min}", + "maxValue": "Potrebnih je največ %{max}", + "number": "Mora biti številka", + "email": "Veljaven e-poštni naslov", + "oneOf": "Mora biti ena izmed %{options}", + "regex": "Mora se ujemati z določeno obliko (regexp): %{pattern}", + "unique": "Mora biti edinstven", + "url": "Biti mora veljaven URL" + }, + "action": { + "add_filter": "Dodaj filter", + "add": "Dodaj", + "back": "Nazaj", + "bulk_actions": "Izbran 1 element |||| Izbranih %{smart_count} elementov", + "cancel": "Prekliči", + "clear_input_value": "Pobriši", + "clone": "Podvoji", + "confirm": "Potrdi", + "create": "Ustvari", + "delete": "Izbriši", + "edit": "Uredi", + "export": "Izvozi", + "list": "Seznam", + "refresh": "Osveži", + "remove_filter": "Odstrani filter", + "remove": "Odstrani", + "save": "Shrani", + "search": "Išči", + "show": "Prikaži", + "sort": "Razvrsti", + "undo": "Razveljavi", + "expand": "Razširi", + "close": "Zapri", + "open_menu": "Odpri meni", + "close_menu": "Zapri meni", + "unselect": "Prekliči izbiro", + "skip": "Izpusti", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "Deli", + "download": "Prenesi" + }, + "boolean": { + "true": "Da", + "false": "Ne" + }, + "page": { + "create": "Ustvari %{name}", + "dashboard": "Nadzorna plošča", + "edit": "%{name} #%{id}", + "error": "Nedoločena napaka", + "list": "%{name}", + "loading": "Nalagam", + "not_found": "Ni zadetka", + "show": "%{name} #%{id}", + "empty": "Še brez %{name}.", + "invite": "Ga želite dodati?" + }, + "input": { + "file": { + "upload_several": "Povlecite datoteke ali pa kliknite in izberite.", + "upload_single": "Povlecite datoteko ali pa kliknite in izberite." + }, + "image": { + "upload_several": "Povlecite slike, ali pa kliknite in izberite.", + "upload_single": "Povlecite sliko, ali pa kliknite in izberite." + }, + "references": { + "all_missing": "Ne najdem referenciranih podatkov.", + "many_missing": "Zdi se, da vsaj ena asociirana referenca ni več na voljo.", + "single_missing": "Zdi se, da asociirana referenca ni več na voljo." + }, + "password": { + "toggle_visible": "Skrij geslo", + "toggle_hidden": "Prikaži geslo" + } + }, + "message": { + "about": "O programu", + "are_you_sure": "Ste prepričani?", + "bulk_delete_content": "Ste prepričani, da želite izbrisati %{name}? |||| Ste prepričani, da želite izbrisati %{smart_count} elementov?", + "bulk_delete_title": "Izbriši %{name} |||| Izbriši %{smart_count} %{name}", + "delete_content": "Ste prepričani, da želite izbrisati ta element?", + "delete_title": "Izbriši %{name} #%{id}", + "details": "Podrobnosti", + "error": "Napak klijenta. Vaš zahtevek se je zaključil neuspešno.", + "invalid_form": "Oblika ni veljavna. Prosim preverite napake", + "loading": "Stran se nalaga, trenutek", + "no": "Ne", + "not_found": "Ali ste vtipkali napačen naslov (URL), ali pa sledili neobstoječi povezavi.", + "yes": "Da", + "unsaved_changes": "Nekate spremembe se niso shranile. Ste prepričani, da jih želite ignorirati?" + }, + "navigation": { + "no_results": "Ni zadetkov", + "no_more_results": "Številka strani %{page} je zunaj meja. Preizkusite prejšnjo stran.", + "page_out_of_boundaries": "Številka strani %{page} je zunaj meja", + "page_out_from_end": "Ne gre dalje od zadnje strani", + "page_out_from_begin": "Ne gre pred prvo stran", + "page_range_info": "%{offsetBegin}-%{offsetEnd} od %{total}", + "page_rows_per_page": "Elementov na stran:", + "next": "Naslednji", + "prev": "Prejšnji", + "skip_nav": "Preskoči k vsebini" + }, + "notification": { + "updated": "Element posodobljen |||| Posodobljenih %{smart_count} elementov", + "created": "Element dodan", + "deleted": "Element izbrisan |||| %{smart_count} elementov izbrisanih", + "bad_item": "Nepravilen element", + "item_doesnt_exist": "Element ne obstaja", + "http_error": "Strežnika napaka v komunikaciji", + "data_provider_error": "Napaka dataProvider error. Preverite konzolo za podrobnosti.", + "i18n_error": "Ne uspem naložiti prevode za izbran jezik", + "canceled": "Akcija preklicana", + "logged_out": "Seja je potekla, prosim povežite se ponovno.", + "new_version": "Na voljo je nova verzija! Prosim osvežite okno." + }, + "toggleFieldsMenu": { + "columnsToDisplay": "Prikaži stolpce", + "layout": "Razporeditev", + "grid": "Mreža", + "table": "Tabela" + } + }, + "message": { + "note": "OPOMBA", + "transcodingDisabled": "Sprememba konfiguracije transkodiranja skozi spletni vmesnik je onemogočeno zaradi varnostnih razlogov. Če želite spremeniti (urediti ali izbrisati) možnosti transkodiranja, ponovno zaženite strežnik z %{config} nastavitvami.", + "transcodingEnabled": "Navidrome trenutno uporablja nastavitve %{config}, kar pomeni da je možno pognati sistemske ukaze v nastavitvah transkodiranja preko spletnega vmesnika.\nZaradi varnostnih razlogov je možnost priporočeno onemogočiti , razen v primeru spreminjanja nastavitev.", + "songsAddedToPlaylist": "Dodaj pesem na seznam predvajanj |||| Dodaj %{smart_count} pesmi na seznam predvajanj", + "noPlaylistsAvailable": "Ni seznamov", + "delete_user_title": "Odstrani uporabnika '%{name}'", + "delete_user_content": "Ste prepričani o izbrisu uporabnika, vključno z njegovimi podatki (tudi seznami predvajanj in nastavitvami)?", + "notifications_blocked": "V vašem brskljalniku Imate blokirana možnost obvestil za to spletno stran", + "notifications_not_available": "Vaš brskljalnik ne omogoča obvestil na namizju ali pa do Navidrome ne dostopate po varni povezavi (https)", + "lastfmLinkSuccess": "Last.fm uspešno povezan in 'scrobbling' omogočen", + "lastfmLinkFailure": "Last.fm ni uspešno povezan", + "lastfmUnlinkSuccess": "Last.fm povezava prekinjena in 'scrobbling' onemogočen", + "lastfmUnlinkFailure": "Last.fm povezava neuspešno prekinjena", + "openIn": { + "lastfm": "Odpri v Last.fm", + "musicbrainz": "Odpri v MusicBrainz" + }, + "lastfmLink": "Preberi več...", + "listenBrainzLinkSuccess": "ListenBrainz uspešno povezan in scrobbling vključen za uporabnika: %{user}", + "listenBrainzLinkFailure": "ListBrainz neuspešno povezan: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz povezava prekinjena in scrobbling izključen", + "listenBrainzUnlinkFailure": "ListenBrainz prekinitev povezave neuspešna", + "downloadOriginalFormat": "Prenesi v izvirni obliki", + "shareOriginalFormat": "Deli v izvirni obliki", + "shareDialogTitle": "Deli %{resource} '%{name}'", + "shareBatchDialogTitle": "Deli 1 %{resource} |||| Deli %{smart_count} %{resource}", + "shareSuccess": "URL kopiran v odložišče: %{url}", + "shareFailure": "Napaka pri kopiranju URL-ja %{url} v odložišče", + "downloadDialogTitle": "Prenesi %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "Kopiraj v odložišče: Ctrl+C, Enter", + "remove_missing_title": "Odstrani manjkajoče datoteke", + "remove_missing_content": "Ste prepričani, da želite odstraniti izbrane manjkajoče datoteke iz baze? Trajno boste odstranili vse reference nanje, vključno s številom predvajanj in ocenami.", + "remove_all_missing_title": "Odstrani vse manjkajoče datoteke", + "remove_all_missing_content": "Ste prepričani, da želite odstraniti vse manjkajoče datoteke iz baze? Trajno boste odstranili vse reference nanje, vključno s številom predvajanj in ocenami.", + "noSimilarSongsFound": "Ni najdenih podobnih pesmi", + "noTopSongsFound": "Ni najdenih najboljših pesmi", + "startingInstantMix": "Nalaganje Instant Mix..." + }, + "menu": { + "library": "Knjižnica", + "settings": "Nastavitve", + "version": "Različica", + "theme": "Tema", + "personal": { + "name": "Osebno", + "options": { + "theme": "Tema", + "language": "Jezik", + "defaultView": "Privzet pogled", + "desktop_notifications": "Namizna obvestila", + "lastfmScrobbling": "'Scrobble' do Last.fm", + "listenBrainzScrobbling": "Scrobble k ListenBrainz", + "replaygain": "ReplayGain način", + "preAmp": "ReplayGain PreAmp (dB)", + "gain": { + "none": "Onemogočeno", + "album": "Uporabi Album Gain", + "track": "Uporabi Track Gain" + }, + "lastfmNotConfigured": "Last.fm API ključ ni konfiguriran" + } + }, + "albumList": "Albumi", + "about": "O programu", + "playlists": "Seznami predvajanj", + "sharedPlaylists": "Deljeni seznami predvajanj", + "librarySelector": { + "allLibraries": "Vse knjižnice (%{count})", + "multipleLibraries": "%{selected} od %{total} knjižnic", + "selectLibraries": "Izberite knjižnice", + "none": "Nobena" + } + }, + "player": { + "playListsText": "Predvajaj vrsto", + "openText": "Odpri", + "closeText": "Zapri", + "notContentText": "Ni glasbe", + "clickToPlayText": "Predvajaj", + "clickToPauseText": "Premor predvajanja", + "nextTrackText": "Naslednje predvajanje", + "previousTrackText": "Prejšnji", + "reloadText": "Ponovno naloži", + "volumeText": "Glasnost", + "toggleLyricText": "Preklopi besedila", + "toggleMiniModeText": "Pomanjšaj", + "destroyText": "Uniči", + "downloadText": "Naloži", + "removeAudioListsText": "Izbriši avdio seznam", + "clickToDeleteText": "Klikni za izbris %{name}", + "emptyLyricText": "Ni besedila", + "playModeText": { + "order": "Po vrsti", + "orderLoop": "Ponavljaj", + "singleLoop": "Ponovi enkrat", + "shufflePlay": "Premešaj" + } + }, + "about": { + "links": { + "homepage": "Domača stran", + "source": "Izvorna koda", + "featureRequests": "Funkcionalni zahtevki", + "lastInsightsCollection": "Zbirka zadnjih vpogledov", + "insights": { + "disabled": "Onemogočeno", + "waiting": "Čakanje" + } + }, + "tabs": { + "about": "O nas", + "config": "Konfiguracija" + }, + "config": { + "configName": "Ime konfiguracije", + "environmentVariable": "Spremenljivka okolja", + "currentValue": "Trenutna vrednost", + "configurationFile": "Konfiguracijska datoteka", + "exportToml": "Izvozi konfiguracijo (TOML)", + "exportSuccess": "Konfiguracija izvožena v odložišče v formatu TOML", + "exportFailed": "Kopiranje konfiguracije ni uspelo", + "devFlagsHeader": "Razvojne zastavice (lahko se spremenijo/odstranijo)", + "devFlagsComment": "To so eksperimentalne nastavitve in bodo morda odstranjene v prihodnjih različicah", + "downloadToml": "Naloži konfiguracijo (TOML)" + } + }, + "activity": { + "title": "Aktivnost", + "totalScanned": "Skupaj preiskanih map", + "quickScan": "Hitro preišči", + "fullScan": "Polno preišči", + "serverUptime": "Čas delovanja", + "serverDown": "NEPOVEZAN", + "scanType": "Tip", + "status": "Napaka pri skeniranju", + "elapsedTime": "Pretečeni čas", + "selectiveScan": "Selektivno" + }, + "help": { + "title": "Hitre tipke", + "hotkeys": { + "show_help": "Prikaži pomoč", + "toggle_menu": "Preklopi stransko vrstico menija", + "toggle_play": "Predvajaj / Pavza", + "prev_song": "Prejšnja", + "next_song": "Naslednja", + "vol_up": "Zvišaj glasnost", + "vol_down": "Znižaj glasnost", + "toggle_love": "Dodaj med priljubljene", + "current_song": "Skoči na predvajano" + } + }, + "nowPlaying": { + "title": "Zdaj se predvaja", + "empty": "Nič se ne predvaja", + "minutesAgo": "Pred %{smart_count} minuto |||| Pred %{smart_count} minutami" + } +} diff --git a/resources/i18n/sr.json b/resources/i18n/sr.json index 1cf7e39e7..cf0fc5d2f 100644 --- a/resources/i18n/sr.json +++ b/resources/i18n/sr.json @@ -4,45 +4,54 @@ "song": { "name": "Песма |||| Песме", "fields": { - "album": "Албум", "albumArtist": "Уметник албума", - "artist": "Уметник", - "bitDepth": "Битова", - "bitRate": "Битски проток", - "bpm": "BPM", - "channels": "Канала", - "comment": "Коментар", - "compilation": "Компилација", - "createdAt": "Датум додавања", - "discSubtitle": "Поднаслов диска", "duration": "Трајање", + "trackNumber": "#", + "playCount": "Пуштано", + "title": "Наслов", + "artist": "Уметник", + "composer": "Композитор", + "album": "Албум", + "path": "Путања фајла", + "libraryName": "Библиотека", "genre": "Жанр", + "compilation": "Компилација", + "year": "Година", + "size": "Величина фајла", + "updatedAt": "Ажурирано", + "bitRate": "Битски проток", + "bitDepth": "Битска дубина", + "sampleRate": "Учестаност узорковања", + "albumGain": "Појачање албума", + "trackGain": "Појачање нумере", + "channels": "Канали", + "disc": "Диск %{discNumber}", + "discSubtitle": "Поднаслов диска", + "starred": "Омиљено", + "comment": "Коментар", + "rating": "Рејтинг", + "quality": "Квалитет", + "bpm": "BPM", + "playDate": "Последње пуштано", + "createdAt": "Датум додавања", "grouping": "Груписање", - "mappedTags": "Мапиране ознаке", "mood": "Расположење", "participants": "Додатни учесници", - "path": "Путања фајла", - "playCount": "Пуштано", - "playDate": "Последње пуштано", - "quality": "Квалитет", - "rating": "Рејтинг", - "rawTags": "Сирове ознаке", - "size": "Величина фајла", - "starred": "Омиљено", "tags": "Додатне ознаке", - "title": "Наслов", - "trackNumber": "#", - "updatedAt": "Ажурирано", - "year": "Година" + "mappedTags": "Мапиране ознаке", + "rawTags": "Сирове ознаке", + "missing": "Недостаје" }, "actions": { - "addToPlaylist": "Додај у плејлисту", "addToQueue": "Пусти касније", - "download": "Преузми", - "info": "Прикажи инфо", - "playNext": "Пусти наредно", "playNow": "Пусти одмах", - "shuffleAll": "Измешај све" + "addToPlaylist": "Додај у плејлисту", + "showInPlaylist": "Прикажи у плејлисти", + "shuffleAll": "Измешај све", + "download": "Преузми", + "playNext": "Пусти наредно", + "info": "Прикажи инфо", + "instantMix": "Инстант микс" } }, "album": { @@ -50,46 +59,48 @@ "fields": { "albumArtist": "Уметник албума", "artist": "Уметник", - "catalogNum": "Каталошки број", - "comment": "Коментар", - "compilation": "Компилација", - "createdAt": "Датум додавања", - "date": "Датум снимања", "duration": "Трајање", + "songCount": "Песме", + "playCount": "Пуштано", + "size": "Величина", + "name": "Назив", + "libraryName": "Библиотека", "genre": "Жанр", + "compilation": "Компилација", + "year": "Година", + "date": "Датум снимања", + "originalDate": "Оригинално", + "releaseDate": "Објављено", + "releases": "Издање|||| Издања", + "released": "Објављено", + "updatedAt": "Ажурирано", + "comment": "Коментар", + "rating": "Рејтинг", + "createdAt": "Датум додавања", + "recordLabel": "Издавачка кућа", + "catalogNum": "Каталошки број", + "releaseType": "Тип", "grouping": "Груписање", "media": "Медијум", "mood": "Расположење", - "name": "Назив", - "originalDate": "Оригинално", - "playCount": "Пуштано", - "rating": "Рејтинг", - "recordLabel": "Издавачка кућа", - "releaseDate": "Објављено", - "releaseType": "Тип", - "released": "Објављено", - "releases": "Издање|||| Издања", - "size": "Величина", - "songCount": "Песме", - "updatedAt": "Ажурирано", - "year": "Година" + "missing": "Недостаје" }, "actions": { - "addToPlaylist": "Додај у плејлисту", - "addToQueue": "Пусти касније", - "download": "Преузми", - "info": "Прикажи инфо", "playAll": "Пусти", "playNext": "Пусти наредно", + "addToQueue": "Пусти касније", "share": "Дели", - "shuffle": "Измешај" + "shuffle": "Измешај", + "addToPlaylist": "Додај у плејлисту", + "download": "Преузми", + "info": "Прикажи инфо" }, "lists": { "all": "Све", - "mostPlayed": "Најчешће пуштано", "random": "Насумично", "recentlyAdded": "Додато недавно", "recentlyPlayed": "Пуштано недавно", + "mostPlayed": "Најчешће пуштано", "starred": "Омиљено", "topRated": "Најбоље рангирано" } @@ -97,116 +108,136 @@ "artist": { "name": "Уметник |||| Уметници", "fields": { - "albumCount": "Број албума", - "genre": "Жанр", "name": "Назив", + "albumCount": "Број албума", + "songCount": "Број песама", + "size": "Величина", "playCount": "Пуштано", "rating": "Рејтинг", + "genre": "Жанр", "role": "Улога", - "size": "Величина", - "songCount": "Број песама" + "missing": "Недостаје" }, "roles": { "albumartist": "Уметник албума |||| Уметници албума", - "arranger": "Аранжер |||| Аранжери", "artist": "Уметник |||| Уметници", "composer": "Композитор |||| Композитори", "conductor": "Диригент |||| Диригенти", - "director": "Режисер |||| Режисери", - "djmixer": "Ди-џеј миксер |||| Ди-џеј миксер", - "engineer": "Инжењер |||| Инжењери", "lyricist": "Текстописац |||| Текстописци", - "mixer": "Миксер |||| Миксери", - "performer": "Извођач |||| Извођачи", + "arranger": "Аранжер |||| Аранжери", "producer": "Продуцент |||| Продуценти", - "remixer": "Ремиксер |||| Ремиксери" + "director": "Режисер |||| Режисери", + "engineer": "Инжењер |||| Инжењери", + "mixer": "Миксер |||| Миксери", + "remixer": "Ремиксер |||| Ремиксери", + "djmixer": "Ди-џеј миксер |||| Ди-џеј миксер", + "performer": "Извођач |||| Извођачи", + "maincredit": "Уметник албума или уметник |||| Уметници албума или уметници" + }, + "actions": { + "topSongs": "Најбоље песме", + "shuffle": "Измешај", + "radio": "Радио" } }, "user": { "name": "Корисник |||| Корисници", "fields": { - "changePassword": "Измени лозинку?", - "createdAt": "Креирана", - "currentPassword": "Текућа лозинка", + "userName": "Корисничко име", "isAdmin": "Да ли је Админ", - "lastAccessAt": "Последњи приступ", "lastLoginAt": "Последња пријава", - "name": "Назив", - "newPassword": "Нова лозинка", - "password": "Лозинка", - "token": "Жетон", + "lastAccessAt": "Последњи приступ", "updatedAt": "Ажурирано", - "userName": "Корисничко име" + "name": "Назив", + "password": "Лозинка", + "createdAt": "Креирана", + "changePassword": "Измени лозинку?", + "currentPassword": "Текућа лозинка", + "newPassword": "Нова лозинка", + "token": "Жетон", + "libraries": "Библиотеке" }, "helperTexts": { - "name": "Измене вашег имена ће постати видљиве након следеће пријаве" + "name": "Измене вашег имена ће постати видљиве након следеће пријаве", + "libraries": "Изаберите одређене библиотеке за овог корисника, или оставите празно да се користе подразумеване библиотеке" }, "notifications": { "created": "Корисник креиран", - "deleted": "Корисник обрисан", - "updated": "Корисник ажуриран" + "updated": "Корисник ажуриран", + "deleted": "Корисник обрисан" + }, + "validation": { + "librariesRequired": "Барем једна библиотека мора да буде изабрана за кориснике који нису администратори" }, "message": { + "listenBrainzToken": "Унесите свој ListenBrainz кориснички жетон.", "clickHereForToken": "Кликните овде да преузмете свој жетон", - "listenBrainzToken": "Унесите свој ListenBrainz кориснички жетон." + "selectAllLibraries": "Изабери све библиотеке", + "adminAutoLibraries": "Администратори аутоматски имају приступ свим библиотекама" } }, "player": { "name": "Плејер |||| Плејери", "fields": { - "client": "Клијент", - "lastSeen": "Последњи пут виђен", - "maxBitRate": "Макс. битски проток", "name": "Назив", - "reportRealPath": "Пријављуј реалну путању", - "scrobbleEnabled": "Шаљи скроблове на спољне сервисе", "transcodingId": "Транскодирање", - "userName": "Корисничко име" + "maxBitRate": "Макс. битски проток", + "client": "Клијент", + "userName": "Корисничко име", + "lastSeen": "Последњи пут виђен", + "reportRealPath": "Пријављуј реалну путању", + "scrobbleEnabled": "Шаљи скроблове на спољне сервисе" } }, "transcoding": { "name": "Транскодирање |||| Транскодирања", "fields": { - "command": "Команда", - "defaultBitRate": "Подразумевани битски проток", "name": "Назив", - "targetFormat": "Циљни формат" + "targetFormat": "Циљни формат", + "defaultBitRate": "Подразумевани битски проток", + "command": "Команда" } }, "playlist": { "name": "Плејлиста |||| Плејлисте", "fields": { - "comment": "Коментар", - "createdAt": "Креирана", - "duration": "Трајање", "name": "Назив", + "duration": "Трајање", "ownerName": "Власник", - "path": "Увоз из", "public": "Јавна", + "updatedAt": "Ажурирано", + "createdAt": "Креирана", "songCount": "Песме", + "comment": "Коментар", "sync": "Ауто-увоз", - "updatedAt": "Ажурирано" + "path": "Увоз из" }, "actions": { + "selectPlaylist": "Изабери плејлисту", "addNewPlaylist": "Креирај „%{name}”", "export": "Извези", - "makePrivate": "Учини приватном", + "saveQueue": "Сачувај ред у плејлисту", "makePublic": "Учини јавном", - "selectPlaylist": "Изабери плејлисту" + "makePrivate": "Учини приватном", + "searchOrCreate": "Претражите плејлисте или унесите назив за нову…", + "pressEnterToCreate": "Притисните Ентер да креирате нову плејлисту", + "removeFromSelection": "Уклони из избора" }, "message": { "duplicate_song": "Додај дуплиране песме", - "song_exist": "У плејлисту се додају дупликати. Желите ли да се додају, или да се прескоче?" + "song_exist": "У плејлисту се додају дупликати. Желите ли да се додају, или да се прескоче?", + "noPlaylistsFound": "Нема пронађених плејлиста", + "noPlaylists": "Нема доступних плејлиста" } }, "radio": { - "name": "Радио |||| Радији", + "name": "Радио |||| Радио-станице", "fields": { - "createdAt": "Креирана", - "homePageUrl": "URL почетне странице", "name": "Назив", "streamUrl": "URL тока", - "updatedAt": "Ажурирано" + "homePageUrl": "URL почетне странице", + "updatedAt": "Ажурирано", + "createdAt": "Креирана" }, "actions": { "playNow": "Пусти одмах" @@ -215,18 +246,18 @@ "share": { "name": "Дељење |||| Дељења", "fields": { - "contents": "Садржај", - "createdAt": "Креирано", + "username": "Поделио", + "url": "URL", "description": "Опис", "downloadable": "Допушта се преузимање?", + "contents": "Садржај", "expiresAt": "Истиче", - "format": "Формат", "lastVisitedAt": "Последњи пут посећено", + "visitCount": "Број посета", + "format": "Формат", "maxBitRate": "Макс. битски проток", "updatedAt": "Ажурирано", - "url": "URL", - "username": "Поделио", - "visitCount": "Број посета" + "createdAt": "Креирано" }, "notifications": {}, "actions": {} @@ -237,111 +268,246 @@ "fields": { "path": "Путања", "size": "Величина", + "libraryName": "Библиотека", "updatedAt": "Нестао дана" }, "actions": { - "remove": "Уклони" + "remove": "Уклони", + "remove_all": "Уклони све" }, "notifications": { "removed": "Фајл који недостаје, или више њих, је уклоњен" } + }, + "library": { + "name": "Библиотека |||| Библиотеке", + "fields": { + "name": "Назив", + "path": "Путања", + "remotePath": "Удаљена путања", + "lastScanAt": "Последње скенирање", + "songCount": "Песме", + "albumCount": "Албуми", + "artistCount": "Уметници", + "totalSongs": "Песме", + "totalAlbums": "Албуми", + "totalArtists": "Уметници", + "totalFolders": "Фасцикле", + "totalFiles": "Фајлови", + "totalMissingFiles": "Фајлови који недостају", + "totalSize": "Укупна величина", + "totalDuration": "Трајање", + "defaultNewUsers": "Подразумевано за нове кориснике", + "createdAt": "Креирана", + "updatedAt": "Ажурирана" + }, + "sections": { + "basic": "Основне информације", + "statistics": "Статистика" + }, + "actions": { + "scan": "Скенирај библиотеку", + "quickScan": "Брзо скенирање", + "fullScan": "Комплетно скенирање", + "manageUsers": "Управљај приступом корисника", + "viewDetails": "Прикажи детаље" + }, + "notifications": { + "created": "Библиотека је успешно креирана", + "updated": "Библиотека је успешно ажурирана", + "deleted": "Библиотека је успешно обрисана", + "scanStarted": "Скенирање библиотеке је покренуто", + "quickScanStarted": "Брзо скенирање је покренуто", + "fullScanStarted": "Комплетно скенирање је покренуто", + "scanError": "Грешка при покретању скенирања. Проверите дневнике.", + "scanCompleted": "Скенирање библиотеке је завршено" + }, + "validation": { + "nameRequired": "Назив библиотеке је обавезан", + "pathRequired": "Путања библиотеке је обавезна", + "pathNotDirectory": "Путања библиотеке мора да буде фасцикла", + "pathNotFound": "Путања библиотеке није пронађена", + "pathNotAccessible": "Путања библиотеке није доступна", + "pathInvalid": "Неисправна путања библиотеке" + }, + "messages": { + "deleteConfirm": "Да ли сте сигурни да желите да обришете ову библиотеку? Ово ће да уклони све повезане податке и приступ корисника.", + "scanInProgress": "Скенирање је у току…", + "noLibrariesAssigned": "Овом кориснику нема додељених библиотека" + } + }, + "plugin": { + "name": "Додатак |||| Додаци", + "fields": { + "id": "ИД", + "name": "Назив", + "description": "Опис", + "version": "Верзија", + "author": "Аутор", + "website": "Веб-сајт", + "permissions": "Дозволе", + "enabled": "Омогућено", + "status": "Статус", + "path": "Путања", + "lastError": "Грешка", + "hasError": "Грешка", + "updatedAt": "Ажурирано", + "createdAt": "Инсталирано", + "configKey": "Кључ", + "configValue": "Вредност", + "allUsers": "Дозволи свим корисницима", + "selectedUsers": "Изабрани корисници", + "allLibraries": "Дозволи све библиотеке", + "selectedLibraries": "Изабране библиотеке", + "allowWriteAccess": "Дозволи приступ за упис" + }, + "sections": { + "status": "Статус", + "info": "Информације о додатку", + "configuration": "Конфигурација", + "manifest": "Манифест", + "usersPermission": "Дозволе корисника", + "libraryPermission": "Дозволе библиотеке" + }, + "status": { + "enabled": "Омогућено", + "disabled": "Онемогућено" + }, + "actions": { + "enable": "Омогући", + "disable": "Онемогући", + "disabledDueToError": "Поправите грешку пре омогућавања", + "disabledUsersRequired": "Изаберите кориснике пре омогућавања", + "disabledLibrariesRequired": "Изаберите библиотеке пре омогућавања", + "addConfig": "Додај конфигурацију", + "rescan": "Поново скенирај" + }, + "notifications": { + "enabled": "Додатак је омогућен", + "disabled": "Додатак је онемогућен", + "updated": "Додатак је ажуриран", + "error": "Грешка при ажурирању додатка" + }, + "validation": { + "invalidJson": "Конфигурација мора да буде исправан JSON" + }, + "messages": { + "configHelp": "Конфигуришите додатак користећи парове кључ-вредност. Оставите празно ако додатак не захтева конфигурацију.", + "configValidationError": "Провера исправности конфигурације није успела:", + "schemaRenderError": "Не може да се прикаже образац за конфигурацију. Шема додатка можда није исправна.", + "clickPermissions": "Кликните на дозволу за детаље", + "noConfig": "Конфигурација није постављена", + "allUsersHelp": "Када је омогућено, додатак ће имати приступ свим корисницима, укључујући оне који буду креирани у будућности.", + "noUsers": "Нема изабраних корисника", + "permissionReason": "Разлог", + "usersRequired": "Овај додатак захтева приступ информацијама о корисницима. Изаберите којим корисницима додатак може да приступи, или омогућите „Дозволи свим корисницима”.", + "allLibrariesHelp": "Када је омогућено, додатак ће имати приступ свим библиотекама, укључујући оне које буду креиране у будућности.", + "noLibraries": "Нема изабраних библиотека", + "librariesRequired": "Овај додатак захтева приступ информацијама о библиотекама. Изаберите којим библиотекама додатак може да приступи, или омогућите „Дозволи све библиотеке”.", + "allowWriteAccessHelp": "Када је омогућено, додатак може да мења фајлове у фасциклама библиотеке. Подразумевано, додаци имају приступ само за читање.", + "requiredHosts": "Потребни хостови" + }, + "placeholders": { + "configKey": "кључ", + "configValue": "вредност" + } } }, "ra": { "auth": { - "auth_check_error": "Ако желите да наставите, молимо вас да се пријавите", - "buttonCreateAdmin": "Креирај админа", + "welcome1": "Хвала што сте инсталирали Navidrome!", + "welcome2": "За почетак, креирајте админ корисника", "confirmPassword": "Потврдите лозинку", - "insightsCollectionNote": "Navidrome прикупља анонимне податке о коришћењу\nшто олакшава унапређење пројекта. Кликните [овде] да\nсазнате више и да одустанете од прикупљања ако желите", - "logout": "Одјави се", + "buttonCreateAdmin": "Креирај админа", + "auth_check_error": "Ако желите да наставите, молимо вас да се пријавите", + "user_menu": "Профил", + "username": "Корисничко име", "password": "Лозинка", "sign_in": "Пријави се", "sign_in_error": "Потврда идентитета није успела, покушајте поново", - "user_menu": "Профил", - "username": "Корисничко име", - "welcome1": "Хвала што сте инсталирали Navidrome!", - "welcome2": "За почетак, креирајте админ корисника" + "logout": "Одјави се", + "insightsCollectionNote": "Navidrome прикупља анонимне податке о коришћењу\nшто олакшава унапређење пројекта. Кликните [овде] да\nсазнате више и да одустанете од прикупљања ако желите" }, "validation": { - "email": "Мора да буде исправна и-мејл адреса", "invalidChars": "Молимо вас да користите само слова и цифре", - "maxLength": "Мора да буде %{max} карактера или мање", - "maxValue": "Мора да буде %{max} или мање", - "minLength": "Мора да буде барем %{min} карактера", - "minValue": "Мора да буде барем %{min}", - "number": "Мора да буде број", - "oneOf": "Мора да буде једно од: %{options}", "passwordDoesNotMatch": "Лозинка се не подудара", - "regex": "Мора да се подудара са одређеним форматом (регуларни израз): %{pattern}", "required": "Неопходно", + "minLength": "Мора да буде барем %{min} карактера", + "maxLength": "Мора да буде %{max} карактера или мање", + "minValue": "Мора да буде барем %{min}", + "maxValue": "Мора да буде %{max} или мање", + "number": "Мора да буде број", + "email": "Мора да буде исправна и-мејл адреса", + "oneOf": "Мора да буде једно од: %{options}", + "regex": "Мора да се подудара са одређеним форматом (регуларни израз): %{pattern}", "unique": "Мора да буде јединствено", "url": "Мора да буде исправна URL адреса" }, "action": { - "add": "Додај", "add_filter": "Додај филтер", + "add": "Додај", "back": "Иди назад", "bulk_actions": "изабрана је 1 ставка |||| изабрано је %{smart_count} ставки", "bulk_actions_mobile": "1 |||| %{smart_count}", "cancel": "Откажи", "clear_input_value": "Обриши вредност", "clone": "Клонирај", - "close": "Затвори", - "close_menu": "Затвори мени", "confirm": "Потврди", "create": "Креирај", "delete": "Обриши", - "download": "Преузми", "edit": "Уреди", - "expand": "Развиј", "export": "Извези", "list": "Листа", - "open_menu": "Отвори мени", "refresh": "Освежи", - "remove": "Уклони", "remove_filter": "Уклони овај филтер", + "remove": "Уклони", "save": "Сачувај", "search": "Тражи", - "share": "Дели", "show": "Прикажи", - "skip": "Прескочи", "sort": "Сортирај", "undo": "Поништи", - "unselect": "Уклони избор" + "expand": "Развиј", + "close": "Затвори", + "open_menu": "Отвори мени", + "close_menu": "Затвори мени", + "unselect": "Уклони избор", + "skip": "Прескочи", + "share": "Дели", + "download": "Преузми" }, "boolean": { - "false": "Не", - "true": "Да" + "true": "Да", + "false": "Не" }, "page": { "create": "Креирај %{name}", "dashboard": "Контролна табла", "edit": "%{name} #%{id}", - "empty": "Још увек нема %{name}.", "error": "Нешто је пошло наопако", - "invite": "Желите ли да се дода?", "list": "%{name}", "loading": "Учитава се", "not_found": "Није пронађено", - "show": "%{name} #%{id}" + "show": "%{name} #%{id}", + "empty": "Још увек нема %{name}.", + "invite": "Желите ли да се дода?" }, "input": { "file": { - "upload_several": "Упустите фајлове да се отпреме, или кликните да их изаберете.", - "upload_single": "Упустите фајл да се отпреми, или кликните да га изаберете." + "upload_several": "Превуците фајлове да се отпреме, или кликните да их изаберете.", + "upload_single": "Превуците фајл да се отпреми, или кликните да га изаберете." }, "image": { - "upload_several": "Упустите слике да се отпреме, или кликните да их изаберете.", - "upload_single": "Упустите слику да се отпреми, или кликните да је изаберете." - }, - "password": { - "toggle_hidden": "Прикажи лозинку", - "toggle_visible": "Сакриј лозинку" + "upload_several": "Превуците слике да се отпреме, или кликните да их изаберете.", + "upload_single": "Превуците слику да се отпреми, или кликните да је изаберете." }, "references": { "all_missing": "Не могу да се нађу подаци референци.", "many_missing": "Изгледа да барем једна од придружених референци више није доступна.", "single_missing": "Изгледа да придружена референца више није доступна." + }, + "password": { + "toggle_visible": "Сакриј лозинку", + "toggle_hidden": "Прикажи лозинку" } }, "message": { @@ -357,161 +523,203 @@ "loading": "Страница се учитава, сачекајте мало", "no": "Не", "not_found": "Или сте откуцали погрешну URL адресу, или сте следили неисправан линк.", - "unsaved_changes": "Неке од ваших измена нису сачуване. Да ли заиста желите да их одбаците?", - "yes": "Да" + "yes": "Да", + "unsaved_changes": "Неке од ваших измена нису сачуване. Да ли заиста желите да их одбаците?" }, "navigation": { - "next": "Наредна", - "no_more_results": "Број странице %{page} је ван опсега. Покушајте претходну страницу.", "no_results": "Није пронађен ниједан резултат", - "page_out_from_begin": "Не може да се иде испред странице 1", - "page_out_from_end": "Не може да се иде након последње странице", + "no_more_results": "Број странице %{page} је ван опсега. Покушајте претходну страницу.", "page_out_of_boundaries": "Број странице %{page} је ван опсега", + "page_out_from_end": "Не може да се иде након последње странице", + "page_out_from_begin": "Не може да се иде испред странице 1", "page_range_info": "%{offsetBegin}-%{offsetEnd} од %{total}", "page_rows_per_page": "Ставки по страници:", - "prev": "Претход", + "next": "Наредна", + "prev": "Претх.", "skip_nav": "Прескочи на садржај" }, "notification": { - "bad_item": "Неисправни елемент", - "canceled": "Акција је отказана", + "updated": "Елемент је ажуриран |||| %{smart_count} елемената је ажурирано", "created": "Елемент је креиран", - "data_provider_error": "dataProvider грешка. За више детаља погледајте конзолу.", "deleted": "Елемент је обрисан |||| %{smart_count} елемената је обрисано", - "http_error": "Грешка у комуникацији са сервером", - "i18n_error": "Не могу да се учитају преводи за наведени језик", + "bad_item": "Неисправни елемент", "item_doesnt_exist": "Елемент не постоји", + "http_error": "Грешка у комуникацији са сервером", + "data_provider_error": "dataProvider грешка. За више детаља погледајте конзолу.", + "i18n_error": "Не могу да се учитају преводи за наведени језик", + "canceled": "Акција је отказана", "logged_out": "Ваша сесија је завршена, молимо вас да се повежите поново.", - "new_version": "Доступна је нова верзија! Молимо вас да освежите овај прозор.", - "updated": "Елемент је ажуриран |||| %{smart_count} елемената је ажурирано" + "new_version": "Доступна је нова верзија! Молимо вас да освежите овај прозор." }, "toggleFieldsMenu": { "columnsToDisplay": "Колоне за приказ", - "grid": "Мрежа", "layout": "Распоред", + "grid": "Мрежа", "table": "Табела" } }, "message": { - "delete_user_content": "Да ли заиста желите да обришете овог корисника, заједно са свим његовим подацима (плејлистама и подешавањима)?", - "delete_user_title": "Брисање корисника ’%{name}’", - "downloadDialogTitle": "Преузимање %{resource} ’%{name}’ (%{size})", - "downloadOriginalFormat": "Преузми у оригиналном формату", - "lastfmLink": "Прочитај још...", - "lastfmLinkFailure": "Last.fm није могао да се повеже", - "lastfmLinkSuccess": "Last.fm је успешно повезан и укључено је скробловање", - "lastfmUnlinkFailure": "Није могла да се уклони веза са Last.fm", - "lastfmUnlinkSuccess": "Last.fm више није повезан и скробловање је искључено", - "listenBrainzLinkFailure": "ListenBrainz није могао да се повеже: %{error}", - "listenBrainzLinkSuccess": "ListenBrainz је успешно повезан и скробловање је укључено као корисник: %{user}", - "listenBrainzUnlinkFailure": "Није могла да се уклони веза са ListenBrainz", - "listenBrainzUnlinkSuccess": "ListenBrainz више није повезан и скробловање је искључено", - "noPlaylistsAvailable": "Није доступна ниједна", + "uploadCover": "Отпреми омот", + "removeCover": "Уклони омот", + "coverUploaded": "Омот је ажуриран", + "coverRemoved": "Омот је уклоњен", + "coverUploadError": "Грешка при отпремању омота", + "coverRemoveError": "Грешка при уклањању омота", "note": "НАПОМЕНА", + "transcodingDisabled": "Измена конфигурације транскодирања кроз веб интерфејс је искључена из разлога безбедности. Ако желите да измените (уредите или додате) опције транскодирања, поново покрените сервер са %{config} конфигурационом опцијом.", + "transcodingEnabled": "Navidrome се тренутно извршава са %{config}, чиме је омогућено извршавање системских команди из подешавања транскодирања коришћењем веб интерфејса. Из разлога безбедности, препоручујемо да то искључите, а да омогућите само када конфигуришете опције транскодирања.", + "songsAddedToPlaylist": "У плејлисту је додата 1 песма |||| У плејлисту је додато %{smart_count} песама", + "noSimilarSongsFound": "Нису пронађене сличне песме", + "startingInstantMix": "Учитава се инстант микс…", + "noTopSongsFound": "Нису пронађене најбоље песме", + "noPlaylistsAvailable": "Није доступна ниједна", + "delete_user_title": "Брисање корисника ’%{name}’", + "delete_user_content": "Да ли заиста желите да обришете овог корисника, заједно са свим његовим подацима (плејлистама и подешавањима)?", + "remove_missing_title": "Уклони фајлове који недостају", + "remove_missing_content": "Да ли сте сигурни да из базе података желите да уклоните фајлове који недостају? Ово ће трајно да уклони све референце на њих, укључујући број пуштања и рангирања.", + "remove_all_missing_title": "Уклони све фајлове који недостају", + "remove_all_missing_content": "Да ли сте сигурни да желите да из базе података уклоните све фајлове који недостају? Ово ће трајно да уклони све референце на њих, укључујући број пуштања и рангирања.", "notifications_blocked": "У подешавањима интернет прегледача за овај сајт, блокирали сте обавештења", "notifications_not_available": "Овај интернет прегледач не подржава десктоп обавештења, или Navidrome серверу не приступате преко https протокола", + "lastfmLinkSuccess": "Last.fm је успешно повезан и укључено је скробловање", + "lastfmLinkFailure": "Last.fm није могао да се повеже", + "lastfmUnlinkSuccess": "Last.fm више није повезан и скробловање је искључено", + "lastfmUnlinkFailure": "Није могла да се уклони веза са Last.fm", + "listenBrainzLinkSuccess": "ListenBrainz је успешно повезан и скробловање је укључено као корисник: %{user}", + "listenBrainzLinkFailure": "ListenBrainz није могао да се повеже: %{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz више није повезан и скробловање је искључено", + "listenBrainzUnlinkFailure": "Није могла да се уклони веза са ListenBrainz", "openIn": { "lastfm": "Отвори у Last.fm", "musicbrainz": "Отвори у MusicBrainz" }, - "remove_missing_content": "Да ли сте сигурни да из базе података желите да уклоните фајлове који недостају? Ово ће трајно да уклони све референце на њих, укључујући број пуштања и рангирања.", - "remove_missing_title": "Уклони фајлове који недостају", + "lastfmLink": "Прочитај још...", + "shareOriginalFormat": "Подели у оригиналном формату", + "shareDialogTitle": "Подели %{resource} ’%{name}’", "shareBatchDialogTitle": "Подели 1 %{resource} |||| Подели %{smart_count} %{resource}", "shareCopyToClipboard": "Копирај у клипборд: Ctrl+C, Ентер", - "shareDialogTitle": "Подели %{resource} ’%{name}’", - "shareFailure": "Грешка приликом копирања URL адресе %{url} у клипборд", - "shareOriginalFormat": "Подели у оригиналном формату", "shareSuccess": "URL је копиран у клипборд: %{url}", - "songsAddedToPlaylist": "У плејлисту је додата 1 песма |||| У плејлисту је додато %{smart_count} песама", - "transcodingDisabled": "Измена конфигурације транскодирања кроз веб интерфејс је искључена из разлога безбедности. Ако желите да измените (уредите или додате) опције транскодирања, поново покрените сервер са %{config} конфигурационом опцијом.", - "transcodingEnabled": "Navidrome се тренутно извршава са %{config}, чиме је омогућено извршавање системских команди из подешавања транскодирања коришћењем веб интерфејса. Из разлога безбедности, препоручујемо да то искључите, а да омогућите само када конфигуришете опције транскодирања." + "shareFailure": "Грешка приликом копирања URL адресе %{url} у клипборд", + "downloadDialogTitle": "Преузимање %{resource} ’%{name}’ (%{size})", + "downloadOriginalFormat": "Преузми у оригиналном формату" }, "menu": { - "about": "О", - "albumList": "Албуми", "library": "Библиотека", + "librarySelector": { + "allLibraries": "Све библиотеке (%{count})", + "multipleLibraries": "%{selected} од %{total} библиотека", + "selectLibraries": "Изабери библиотеке", + "none": "Ниједна" + }, + "settings": "Подешавања", + "version": "Верзија", + "theme": "Тема", "personal": { "name": "Лична", "options": { + "theme": "Тема", + "language": "Језик", "defaultView": "Подразумевани поглед", "desktop_notifications": "Десктоп обавештења", - "gain": { - "album": "Користи Album појачање", - "none": "Искључено", - "track": "Користи Track појачање" - }, - "language": "Језик", "lastfmNotConfigured": "Није подешен Last.fm API-кључ", "lastfmScrobbling": "Скроблуј на Last.fm", "listenBrainzScrobbling": "Скроблуј на ListenBrainz", - "preAmp": "ReplayGain претпојачање (dB)", "replaygain": "ReplayGain режим", - "theme": "Тема" + "preAmp": "ReplayGain претпојачање (dB)", + "gain": { + "none": "Искључено", + "album": "Користи Album појачање", + "track": "Користи Track појачање" + } } }, + "albumList": "Албуми", "playlists": "Плејлисте", - "settings": "Подешавања", "sharedPlaylists": "Дељене плејлисте", - "theme": "Тема", - "version": "Верзија" + "about": "О" }, "player": { - "clickToDeleteText": "Кликните да обришете %{name}", - "clickToPauseText": "Кликни за паузирање", - "clickToPlayText": "Кликни за пуштање", + "playListsText": "Ред за пуштање", + "openText": "Отвори", "closeText": "Затвори", + "notContentText": "Нема музике", + "clickToPlayText": "Кликните за пуштање", + "clickToPauseText": "Кликните за паузирање", + "nextTrackText": "Наредна нумера", + "previousTrackText": "Претходна нумера", + "reloadText": "Поново учитај", + "volumeText": "Јачина", + "toggleLyricText": "Укљ./Искљ. стихове", + "toggleMiniModeText": "Умањи", "destroyText": "Уништи", "downloadText": "Преузми", + "removeAudioListsText": "Обриши аудио листе", + "clickToDeleteText": "Кликните да обришете %{name}", "emptyLyricText": "Нема стихова", - "nextTrackText": "Наредна нумера", - "notContentText": "Нема музике", - "openText": "Отвори", - "playListsText": "Ред за пуштање", "playModeText": { "order": "По редоследу", "orderLoop": "Понови", - "shufflePlay": "Измешај", - "singleLoop": "Понови једну" - }, - "previousTrackText": "Претходна нумера", - "reloadText": "Поново учитај", - "removeAudioListsText": "Обриши аудио листе", - "toggleLyricText": "Укљ./Искљ. стихове", - "toggleMiniModeText": "Умањи", - "volumeText": "Јачина" + "singleLoop": "Понови једну", + "shufflePlay": "Измешај" + } }, "about": { "links": { - "featureRequests": "Захтеви за функцијама", "homepage": "Почетна страница", + "source": "Изворни кôд", + "featureRequests": "Захтеви за функције", + "lastInsightsCollection": "Последња колекција увида", "insights": { "disabled": "Искључено", "waiting": "Чека се" - }, - "lastInsightsCollection": "Последња колекција увида", - "source": "Изворни кôд" + } + }, + "tabs": { + "about": "О програму", + "config": "Конфигурација" + }, + "config": { + "configName": "Назив конфигурације", + "environmentVariable": "Променљива окружења", + "currentValue": "Тренутна вредност", + "configurationFile": "Конфигурациони фајл", + "exportToml": "Извези конфигурацију (TOML)", + "downloadToml": "Преузми конфигурацију (TOML)", + "exportSuccess": "Конфигурација је извезена у клипборд у TOML формату", + "exportFailed": "Копирање конфигурације није успело", + "devFlagsHeader": "Развојне заставице (подложне промени или уклањању)", + "devFlagsComment": "Ово су експерименталне поставке и могу бити уклоњене у будућим верзијама" } }, "activity": { - "fullScan": "Комплетно скенирање", - "quickScan": "Брзо скенирање", - "serverDown": "ВАН МРЕЖЕ", - "serverUptime": "Сервер се извршава", "title": "Активност", - "totalScanned": "Укупан број скенираних фолдера" + "totalScanned": "Укупан број скенираних фолдера", + "quickScan": "Брзо скенирање", + "fullScan": "Комплетно скенирање", + "selectiveScan": "Селективно", + "serverUptime": "Сервер се извршава", + "serverDown": "ВАН МРЕЖЕ", + "scanType": "Последње скенирање", + "status": "Грешка скенирања", + "elapsedTime": "Протекло време" + }, + "nowPlaying": { + "title": "Сада се пушта", + "empty": "Ништа се не пушта", + "minutesAgo": "Пре %{smart_count} минут |||| Пре %{smart_count} минута" }, "help": { "title": "Navidrome пречице", "hotkeys": { - "current_song": "Иди на текућу песму", - "next_song": "Наредна песма", - "prev_song": "Претходна песма", "show_help": "Прикажи ову помоћ", - "toggle_love": "Додај ову нумеру у омиљене", "toggle_menu": "Укљ./Искљ. бочну траку менија", "toggle_play": "Пусти / Паузирај", + "prev_song": "Претходна песма", + "next_song": "Наредна песма", + "current_song": "Иди на текућу песму", + "vol_up": "Појачај", "vol_down": "Утишај", - "vol_up": "Појачај" + "toggle_love": "Додај ову нумеру у омиљене" } } } diff --git a/resources/i18n/sv.json b/resources/i18n/sv.json index 9392706cb..228cc2cf3 100644 --- a/resources/i18n/sv.json +++ b/resources/i18n/sv.json @@ -26,7 +26,19 @@ "bpm": "BPM", "playDate": "Senast spelad", "channels": "Channels", - "createdAt": "Skapad" + "createdAt": "Skapad", + "grouping": "Gruppering", + "mood": "Stämning", + "participants": "Ytterligare medverkande", + "tags": "Ytterligare taggar", + "mappedTags": "Mappade taggar", + "rawTags": "Omodifierade taggar", + "bitDepth": "Bitdjup", + "sampleRate": "Samplingsfrekvens", + "missing": "Saknade", + "libraryName": "Bibliotek", + "composer": "Kompositör", + "disc": "Disc %{discNumber}" }, "actions": { "addToQueue": "Lägg till i kön", @@ -35,7 +47,9 @@ "shuffleAll": "Shuffle", "download": "Ladda ner", "playNext": "Spela nästa", - "info": "Mer information" + "info": "Mer information", + "showInPlaylist": "Visa i spellista", + "instantMix": "Direktmix" } }, "album": { @@ -58,7 +72,16 @@ "originalDate": "Originaldatum", "releaseDate": "Utgivningsdatum", "releases": "Utgåva |||| Utgåvor", - "released": "Utgiven" + "released": "Utgiven", + "recordLabel": "Skivbolag", + "catalogNum": "Katalognummer", + "releaseType": "Typ", + "grouping": "Gruppering", + "media": "Media", + "mood": "Stämning", + "date": "Inspelningsdatum", + "missing": "Saknade", + "libraryName": "Bibliotek" }, "actions": { "playAll": "Spela", @@ -89,7 +112,30 @@ "playCount": "Spelningar", "rating": "Betyg", "genre": "Genre", - "size": "Storlek" + "size": "Storlek", + "role": "Roll", + "missing": "Saknade" + }, + "roles": { + "albumartist": "Albumartist |||| Albumartister", + "artist": "Artist |||| Artister", + "composer": "Kompositör |||| Kompositörer", + "conductor": "Dirigent |||| Dirigenter", + "lyricist": "Textförfattare |||| Textförfattare", + "arranger": "Arrangör |||| Arrangörer", + "producer": "Producent |||| Producenter", + "director": "Inspelningsledare |||| Inspelningsledare", + "engineer": "Ljudtekniker |||| Ljudtekniker", + "mixer": "Mixare |||| Mixare", + "remixer": "Remixare |||| Remixare", + "djmixer": "DJ-mixare |||| DJ-mixare", + "performer": "Utövande artist |||| Utövande artister", + "maincredit": "Albumartister eller Artist |||| Albumartister eller Artister" + }, + "actions": { + "shuffle": "Shuffle", + "radio": "Radio", + "topSongs": "Topplåtar" } }, "user": { @@ -106,10 +152,12 @@ "currentPassword": "Nuvarande lösenord", "newPassword": "Nytt lösenord", "token": "Token", - "lastAccessAt": "Senaste åtkomst" + "lastAccessAt": "Senaste åtkomst", + "libraries": "Bibliotek" }, "helperTexts": { - "name": "Ändringar av ditt namn syns först vid nästa inloggning" + "name": "Ändringar av ditt namn syns först vid nästa inloggning", + "libraries": "Välj ett bibliotek för denna användare eller lämna blankt för standardbibliotek" }, "notifications": { "created": "Användare skapad", @@ -118,7 +166,12 @@ }, "message": { "listenBrainzToken": "Ange din ListenBrainz användar-token.", - "clickHereForToken": "Klicka här för att hämta din token" + "clickHereForToken": "Klicka här för att hämta din token", + "selectAllLibraries": "Välj alla bibliotek", + "adminAutoLibraries": "Administratörer har automatiskt tillgång till alla bibliotek" + }, + "validation": { + "librariesRequired": "Minst ett bibliotek måste väljas för icke-administratörer" } }, "player": { @@ -162,11 +215,17 @@ "addNewPlaylist": "Skapa \"%{name}\"", "export": "Exportera", "makePublic": "Gör offentlig", - "makePrivate": "Gör privat" + "makePrivate": "Gör privat", + "saveQueue": "Spara kö till spellista", + "searchOrCreate": "Sök spellista eller skapa ny...", + "pressEnterToCreate": "Tryck Enter för att skapa ny spellista", + "removeFromSelection": "Ta bort från urval" }, "message": { "duplicate_song": "Lägg till dubletter", - "song_exist": "Vissa låtar finns redan i spellistan. Vill du lägga till dubbletterna eller hoppa över dem?" + "song_exist": "Vissa låtar finns redan i spellistan. Vill du lägga till dubbletterna eller hoppa över dem?", + "noPlaylistsFound": "Hittade inga spellistor", + "noPlaylists": "Inga spellistor tillgängliga" } }, "radio": { @@ -198,6 +257,156 @@ "createdAt": "Skapad", "downloadable": "Tillåt nedladdning?" } + }, + "missing": { + "name": "Saknad fil |||| Saknade filer", + "fields": { + "path": "Sökväg", + "size": "Storlek", + "updatedAt": "Försvann", + "libraryName": "Bibliotek" + }, + "actions": { + "remove": "Radera", + "remove_all": "Radera alla" + }, + "notifications": { + "removed": "Saknade fil(er) borttagna" + }, + "empty": "Inga saknade filer" + }, + "library": { + "name": "Bibliotek |||| Bibliotek", + "fields": { + "name": "Namn", + "path": "Sökväg", + "remotePath": "Ta bort sökväg", + "lastScanAt": "Senaste scan", + "songCount": "Låtar", + "albumCount": "Album", + "artistCount": "Artister", + "totalSongs": "Låtar", + "totalAlbums": "Album", + "totalArtists": "Artister", + "totalFolders": "Mappar", + "totalFiles": "Filer", + "totalMissingFiles": "Saknade filer", + "totalSize": "Sammanlagd storlek", + "totalDuration": "Längd", + "defaultNewUsers": "Standard för nya användare", + "createdAt": "Skapad", + "updatedAt": "Uppdaterad" + }, + "sections": { + "basic": "Grundinformation", + "statistics": "Statistik" + }, + "actions": { + "scan": "Scanna bibliotek", + "manageUsers": "Hantera användaråtkomst", + "viewDetails": "Se detaljer", + "quickScan": "Snabbscan", + "fullScan": "Komplett scan" + }, + "notifications": { + "created": "Biblioteket har skapats", + "updated": "Biblioteket har uppdaterats", + "deleted": "Biblioteket har raderats", + "scanStarted": "Biblioteksscan startad", + "scanCompleted": "Biblioteksscan avslutad", + "quickScanStarted": "Snabbscan startad", + "fullScanStarted": "Komplett scan startad", + "scanError": "Fel vid start av scan. Se loggarna" + }, + "validation": { + "nameRequired": "Biblioteksnamn krävs", + "pathRequired": "Bibliotekssökväg krävs", + "pathNotDirectory": "Bibliotekssökvägen måste vara en katalog", + "pathNotFound": "Bibliotekssökväg hittades inte", + "pathNotAccessible": "Bibliotekssökväg inte tillgänglig", + "pathInvalid": "Ogiltig bibliotekssökväg" + }, + "messages": { + "deleteConfirm": "Är du säker på att du vill ta bort detta bibliotek? Detta raderar all förbunden data och användartillgång.", + "scanInProgress": "Scanning pågår...", + "noLibrariesAssigned": "Inga bibliotek har tilldelats den här användaren" + } + }, + "plugin": { + "name": "Tillägg |||| Tillägg", + "fields": { + "id": "ID", + "name": "Namn", + "description": "Beskrivning", + "version": "Version", + "author": "Författare", + "website": "Website", + "permissions": "Behörigheter", + "enabled": "Aktiverad", + "status": "Status", + "path": "Sökväg", + "lastError": "Fel", + "hasError": "Fel", + "updatedAt": "Uppdaterad", + "createdAt": "Installerad", + "configKey": "Nyckel", + "configValue": "Värde", + "allUsers": "Tillåt alla användare", + "selectedUsers": "Valda användare", + "allLibraries": "Tillåt alla bibliotek", + "selectedLibraries": "Valda bibliotek", + "allowWriteAccess": "Tillåt skrivrättigheter" + }, + "sections": { + "status": "Status", + "info": "Tilläggsinformation", + "configuration": "Konfiguration", + "manifest": "Manifest", + "usersPermission": "Användarbehörigheter", + "libraryPermission": "Biblioteksbehörigheter" + }, + "status": { + "enabled": "Aktiverad", + "disabled": "Inaktiverad" + }, + "actions": { + "enable": "Aktivera", + "disable": "Inaktivera", + "disabledDueToError": "Åtgärda felet innan aktivering", + "disabledUsersRequired": "Välj användare före aktivering", + "disabledLibrariesRequired": "Välj bibliotek före aktivering", + "addConfig": "Lägg till konfiguration", + "rescan": "Scanna om" + }, + "notifications": { + "enabled": "Tillägg aktiverat", + "disabled": "Tillägg inaktiverat", + "updated": "Tillägg uppdaterat", + "error": "Fel vid uppdatering av tillägg" + }, + "validation": { + "invalidJson": "Konfigurationen måste vara giltig JSON" + }, + "messages": { + "configHelp": "Konfigurera tillägget med nyckel–värde-par. Lämna tomt om tillägget inte kräver någon konfiguration.", + "clickPermissions": "Klicka på en behörighet för mer information", + "noConfig": "Ingen konfiguration angiven", + "allUsersHelp": "När den är aktiverad får tillägget tillgång till alla användare, inklusive de som skapas i framtiden.", + "noUsers": "Inga användare valda", + "permissionReason": "Orsak", + "usersRequired": "Detta tillägg kräver åtkomst till användarinformation. Välj vilka användare insticksprogrammet ska ha åtkomst till, eller aktivera 'Tillåt alla användare'.", + "allLibrariesHelp": "När den är aktiverad får tillägget tillgång till alla bibliotek, inklusive de som skapas i framtiden.", + "noLibraries": "Inga bibliotek valda", + "librariesRequired": "Detta tillägg kräver tillgång till biblioteksinformation. Välj vilka bibliotek tillägget kan komma åt eller aktivera 'Tillåt alla bibliotek'.", + "requiredHosts": "Krävda värdar", + "configValidationError": "Validering av konfigurationen misslyckades:", + "schemaRenderError": "Kunde inte rendera konfigurationsformuläret. Tilläggets schema kan vara ogiltigt.", + "allowWriteAccessHelp": "När detta är aktiverat kan tillägget ändra filer i bibliotekets kataloger. Som standard har tillägget endast läsrättigheter." + }, + "placeholders": { + "configKey": "nyckel", + "configValue": "värde" + } } }, "ra": { @@ -375,7 +584,20 @@ "shareSuccess": "URL kopierades till urklipp: %{url}", "shareFailure": "Fel vid kopiering av URL %{url} till urklipp", "downloadDialogTitle": "Ladda ner %{resource} '%{name}' (%{size})", - "shareCopyToClipboard": "Kopiera till urklipp: Ctrl+C, Enter" + "shareCopyToClipboard": "Kopiera till urklipp: Ctrl+C, Enter", + "remove_missing_title": "Ta bort saknade filer", + "remove_missing_content": "Är du säker på att du vill ta bort de valda saknade filerna från databasen? Detta kommer permanent radera alla referenser till dem, inklusive antal spelningar och betyg.", + "remove_all_missing_title": "Ta bort alla saknade filer", + "remove_all_missing_content": "Är du säker på att du vill ta bort alla saknade filer från databasen? Detta kommer permanent radera alla referenser till dem, inklusive antal spelningar och betyg.", + "noSimilarSongsFound": "Hittade inga liknande låtar", + "noTopSongsFound": "Hittade inga topplåtar", + "startingInstantMix": "Laddar direktmix...", + "uploadCover": "Ladda upp omslagsbild", + "removeCover": "Ta bort omslagsbild", + "coverUploaded": "Omslagsbild uppdaterad", + "coverRemoved": "Omslagsbild borttagen", + "coverUploadError": "Fel vid uppladdning av omslagsbild", + "coverRemoveError": "Fel vid borttagning av omslagsbild" }, "menu": { "library": "Bibliotek", @@ -404,7 +626,13 @@ "albumList": "Album", "about": "Om", "playlists": "Spellistor", - "sharedPlaylists": "Delade spellistor" + "sharedPlaylists": "Delade spellistor", + "librarySelector": { + "allLibraries": "Alla bibliotek (%{count})", + "multipleLibraries": "%{selected} av %{total} bibliotek", + "selectLibraries": "Välj bibliotek", + "none": "Inga" + } }, "player": { "playListsText": "Spela kön", @@ -441,6 +669,22 @@ "disabled": "Inaktiverad", "waiting": "Väntar" } + }, + "tabs": { + "about": "Om", + "config": "Inställningar" + }, + "config": { + "configName": "Inställningsnamn", + "environmentVariable": "Miljövariabel", + "currentValue": "Nuvarande värde", + "configurationFile": "Inställningsfil", + "exportToml": "Exportera inställningar (TOML)", + "exportSuccess": "Inställningarna kopierade till urklippet i TOML-format", + "exportFailed": "Kopiering av inställningarna misslyckades", + "devFlagsHeader": "Utvecklingsflaggor (kan ändras eller tas bort)", + "devFlagsComment": "Dessa inställningar är experimentella och kan tas bort i framtida versioner", + "downloadToml": "Ladda ner konfiguration (TOML)" } }, "activity": { @@ -449,7 +693,11 @@ "quickScan": "Snabbscan", "fullScan": "Komplett scan", "serverUptime": "Serverdrifttid", - "serverDown": "OFFLINE" + "serverDown": "OFFLINE", + "scanType": "Typ", + "status": "Fel vid scanning", + "elapsedTime": "Spelad tid", + "selectiveScan": "Urval" }, "help": { "title": "Navidrome kortkommandon", @@ -464,5 +712,10 @@ "toggle_love": "Lägg till låt i favoriter", "current_song": "Hoppa till nuvarande låt" } + }, + "nowPlaying": { + "title": "Spelas nu", + "empty": "Inget spelas", + "minutesAgo": "%{smart_count} minut sedan |||| %{smart_count} minuter sedan" } } \ No newline at end of file diff --git a/resources/i18n/th.json b/resources/i18n/th.json index 2f96f4958..fde89494e 100644 --- a/resources/i18n/th.json +++ b/resources/i18n/th.json @@ -26,7 +26,21 @@ "bpm": "BPM", "playDate": "เล่นล่าสุด", "channels": "ช่อง", - "createdAt": "เพิ่มเมื่อ" + "createdAt": "เพิ่มเมื่อ", + "grouping": "จัดกลุ่ม", + "mood": "อารมณ์", + "participants": "ผู้มีส่วนร่วม", + "tags": "แทกเพิ่มเติม", + "mappedTags": "แมพแทก", + "rawTags": "แทกเริ่มต้น", + "bitDepth": "Bit depth", + "sampleRate": "แซมเปิ้ลเรต", + "missing": "หายไป", + "libraryName": "ห้องสมุด", + "composer": "ผู้แต่ง", + "disc": "พื้นที่ %{discNumber}", + "albumGain": "เนื้อหาในอัลบั้ม", + "trackGain": "เนื้อหาในเพลง" }, "actions": { "addToQueue": "เพิ่มในคิว", @@ -35,7 +49,9 @@ "shuffleAll": "สุ่มทั้งหมด", "download": "ดาวน์โหลด", "playNext": "เล่นถัดไป", - "info": "ดูรายละเอียด" + "info": "ดูรายละเอียด", + "showInPlaylist": "แสดงในเพลย์ลิสต์", + "instantMix": "อินสแตนต์ มิก" } }, "album": { @@ -58,7 +74,16 @@ "originalDate": "วันที่เริ่ม", "releaseDate": "เผยแพร่เมื่อ", "releases": "เผยแพร่ |||| เผยแพร่", - "released": "เผยแพร่เมื่อ" + "released": "เผยแพร่เมื่อ", + "recordLabel": "ป้าย", + "catalogNum": "หมายเลขแคตาล็อก", + "releaseType": "ประเภท", + "grouping": "จัดกลุ่ม", + "media": "มีเดีย", + "mood": "อารมณ์", + "date": "บันทึกเมื่อ", + "missing": "หายไป", + "libraryName": "ห้องสมุด" }, "actions": { "playAll": "เล่นทั้งหมด", @@ -89,7 +114,30 @@ "playCount": "เล่นแล้ว", "rating": "ความนิยม", "genre": "ประเภท", - "size": "ขนาด" + "size": "ขนาด", + "role": "Role", + "missing": "หายไป" + }, + "roles": { + "albumartist": "ศิลปินอัลบั้ม |||| ศิลปินอัลบั้ม", + "artist": "ศิลปิน |||| ศิลปิน", + "composer": "ผู้แต่ง |||| ผู้แต่ง", + "conductor": "คอนดักเตอร์ |||| คอนดักเตอร์", + "lyricist": "เนื้อเพลง |||| เนื้อเพลง", + "arranger": "ผู้ดำเนินการ |||| ผู้ดำเนินการ", + "producer": "ผู้จัด |||| ผู้จัด", + "director": "ไดเรกเตอร์ |||| ไดเรกเตอร์", + "engineer": "วิศวกร |||| วิศวกร", + "mixer": "มิกเซอร์ |||| มิกเซอร์", + "remixer": "รีมิกเซอร์ |||| รีมิกเซอร์", + "djmixer": "ดีเจมิกเซอร์ |||| ดีเจมิกเซอร์", + "performer": "ผู้เล่น |||| ผู้เล่น", + "maincredit": "ศิลปิน |||| ศิลปิน" + }, + "actions": { + "shuffle": "เล่นสุ่ม", + "radio": "วิทยุ", + "topSongs": "เพลงยอดนิยม" } }, "user": { @@ -106,10 +154,12 @@ "currentPassword": "รหัสผ่านปัจจุบัน", "newPassword": "รหัสผ่านใหม่", "token": "โทเคน", - "lastAccessAt": "เข้าใช้ล่าสุด" + "lastAccessAt": "เข้าใช้ล่าสุด", + "libraries": "ห้องสมุด" }, "helperTexts": { - "name": "การเปลี่ยนชื่อจะมีผลในการล็อกอินครั้งถัดไป" + "name": "การเปลี่ยนชื่อจะมีผลในการล็อกอินครั้งถัดไป", + "libraries": "เลือกห้องสมุดสำหรับผู้ใช้นี้หรือปล่อยว่างเพื่อใช้ห้องสมุดเริ่มต้น" }, "notifications": { "created": "สร้างชื่อผู้ใช้", @@ -118,7 +168,12 @@ }, "message": { "listenBrainzToken": "ใส่โทเคน ListenBrainz ของคุณ", - "clickHereForToken": "กดที่นี่เพื่อรับโทเคนของคุณ" + "clickHereForToken": "กดที่นี่เพื่อรับโทเคนของคุณ", + "selectAllLibraries": "เลือกห้องสมุดทั้งหมด", + "adminAutoLibraries": "ผู้ดูแลเข้าถึงห้องสมุดทั้งหมดโดยอัตโนมัติ" + }, + "validation": { + "librariesRequired": "ต้องเลือกห้องสมุด 1 ห้อง สำหรับผู้ใช้ที่ไม่ใช่ผู้ดูแล" } }, "player": { @@ -162,11 +217,17 @@ "addNewPlaylist": "สร้าง \"%{name}\"", "export": "ส่งออก", "makePublic": "ทำเป็นสาธารณะ", - "makePrivate": "ทำเป็นส่วนตัว" + "makePrivate": "ทำเป็นส่วนตัว", + "saveQueue": "บันทึกคิวลงเพลย์ลิสต์", + "searchOrCreate": "ค้นหาเพลย์ลิสต์หรือพิมพ์เพื่อสร้างใหม่", + "pressEnterToCreate": "กด Enter เพื่อสร้างเพลย์ลิสต์", + "removeFromSelection": "เอาออกจากที่เลือกไว้" }, "message": { "duplicate_song": "เพิ่มเพลงซ้ำ", - "song_exist": "เพิ่มเพลงซ้ำกันในเพลย์ลิสต์ คุณจะเพิ่มเพลงต่อหรือข้าม" + "song_exist": "เพิ่มเพลงซ้ำกันในเพลย์ลิสต์ คุณจะเพิ่มเพลงต่อหรือข้าม", + "noPlaylistsFound": "ไม่พบเพลย์ลิสต์", + "noPlaylists": "ไม่มีเพลย์ลิสต์อยู่" } }, "radio": { @@ -198,6 +259,156 @@ "createdAt": "สร้างเมื่อ", "downloadable": "อนุญาตให้ดาวโหลด?" } + }, + "missing": { + "name": "ไฟล์ที่หายไป |||| ไฟล์ที่หายไป", + "fields": { + "path": "พาร์ท", + "size": "ขนาด", + "updatedAt": "หายไปจาก", + "libraryName": "ห้องสมุด" + }, + "actions": { + "remove": "เอาออก", + "remove_all": "เอาออกทั้งหมด" + }, + "notifications": { + "removed": "เอาไฟล์ที่หายไปออกแล้ว" + }, + "empty": "ไม่มีไฟล์หาย" + }, + "library": { + "name": "ห้องสมุด |||| ห้องสมุด", + "fields": { + "name": "ชื่อ", + "path": "พาร์ท", + "remotePath": "รีโมทพาร์ท", + "lastScanAt": "สแกนล่าสุด", + "songCount": "เพลง", + "albumCount": "อัลบัม", + "artistCount": "ศิลปิน", + "totalSongs": "เพลง", + "totalAlbums": "อัลบัม", + "totalArtists": "ศิลปิน", + "totalFolders": "แฟ้ม", + "totalFiles": "ไฟล์", + "totalMissingFiles": "ไฟล์ที่หายไป", + "totalSize": "ขนาดทั้งหมด", + "totalDuration": "ความยาว", + "defaultNewUsers": "ค่าเริ่มต้นผู้ใช้ใหม่", + "createdAt": "สร้าง", + "updatedAt": "อัพเดท" + }, + "sections": { + "basic": "ข้อมูลเบื้องต้น", + "statistics": "สถิติ" + }, + "actions": { + "scan": "สแกนห้องสมุด", + "manageUsers": "ตั้งค่าการเข้าถึง", + "viewDetails": "ดูรายละเอียด", + "quickScan": "สแกนแบบเร็ว", + "fullScan": "สแกนแบบเต็ม" + }, + "notifications": { + "created": "สร้างห้องสมุดเรียบร้อย", + "updated": "อัพเดทห้องสมุดเรียบร้อย", + "deleted": "ลบห้องสมุดเพลงเรียบร้อยแล้ว", + "scanStarted": "เริ่มสแกนห้องสมุด", + "scanCompleted": "สแกนห้องสมุดเสร็จแล้ว", + "quickScanStarted": "เริ่มสแกนแบบเร็ว", + "fullScanStarted": "เริ่มสแกนแบบเต็ม", + "scanError": "การเริ่มสแกนผิดพลาด ดูในบันทึก" + }, + "validation": { + "nameRequired": "ต้องใส่ชื่อห้องสมุดเพลง", + "pathRequired": "ต้องใส่พาร์ทของห้องสมุด", + "pathNotDirectory": "พาร์ทของห้องสมุดต้องเป็นแฟ้ม", + "pathNotFound": "ไม่เจอพาร์ทของห้องสมุด", + "pathNotAccessible": "ไม่สามารถเข้าพาร์ทของห้องสมุด", + "pathInvalid": "พาร์ทห้องสมุดไม่ถูก" + }, + "messages": { + "deleteConfirm": "คุณแน่ใจว่าจะลบห้องสมุดนี้? นี่จะลบข้อมูลและการเข้าถึงของผู้ใช้ที่เกี่ยวข้องทั้งหมด", + "scanInProgress": "กำลังสแกน...", + "noLibrariesAssigned": "ไม่มีห้องสมุดสำหรับผู้ใช้นี้" + } + }, + "plugin": { + "name": "ปลั๊กอิน |||| ปลั๊กอิน", + "fields": { + "id": "ID", + "name": "ชื่อ", + "description": "รายละเอียด", + "version": "เวอร์ชั่น", + "author": "ผู้สร้าง", + "website": "เว็บไซต์", + "permissions": "การอนุญาติ", + "enabled": "เปิดใช้", + "status": "สถานะ", + "path": "เส้นทาง", + "lastError": "ผิดพลาด", + "hasError": "ผิดพลาด", + "updatedAt": "อัพเดทแล้ว", + "createdAt": "ติดตั้งแล้ว", + "configKey": "คีย์", + "configValue": "ค่า", + "allUsers": "อนุญาติผู้ใช้ทั้งหมด", + "selectedUsers": "ผู้ใช้ถูกเลือก", + "allLibraries": "อนุญาติห้องสมุดเพลงทั้งหมด", + "selectedLibraries": "ห้องสมุดเพลงถูกเลือก", + "allowWriteAccess": "อนุญาตให้เขียน" + }, + "sections": { + "status": "สถานะ", + "info": "ข้อมูลปลั๊กอิน", + "configuration": "การตั้งค่า", + "manifest": "แสดง", + "usersPermission": "สิทธิของผู้ใช้", + "libraryPermission": "สิทธิของห้องสมุดเพลง" + }, + "status": { + "enabled": "เปิดใช้งานแล้ว", + "disabled": "ปิดใช้งานแล้ว" + }, + "actions": { + "enable": "เปิดใช้งาน", + "disable": "ปิดใช้งาน", + "disabledDueToError": "แก้ไขข้อผิดพลาดก่อนเปิดใช้งาน", + "disabledUsersRequired": "เลือกผู้ใช้ที่จะเปิดใช้งาน", + "disabledLibrariesRequired": "เลือกห้องสมุดเพลงที่จะเปิดใช้งาน", + "addConfig": "เพิ่มการตั้งค่า", + "rescan": "สแกนซ้ำ" + }, + "notifications": { + "enabled": "เปิดใช้ปลั๊กอินแล้ว", + "disabled": "ปิดใช้ปลั๊กอินแล้ว", + "updated": "ปลั๊กอินอัพเดท", + "error": "อัพเดทผิดพลาด" + }, + "validation": { + "invalidJson": "ต้องตั้งค่าตามไวยากรณ์ JSON" + }, + "messages": { + "configHelp": "ใส่ค่าให้เข้าคู่กับคีย์ของปลั๊กอิน ปล่อยว่างถ้าปลั๊กอินไม่ต้องการใช้", + "clickPermissions": "กดดูรายละเอียดของการอนุญาติ", + "noConfig": "ไม่ได้ตั้งค่า", + "allUsersHelp": "เมื่อเปิดใช้ ปลั๊กอินจะใช้กับผู้ใช้ทุกคน รวมถึงผู้ใช้ใหม่ในอนาคต", + "noUsers": "ไม่ได้เลือกผู้ใช้", + "permissionReason": "เหตุผล", + "usersRequired": "ปลั๊กอินนี้ต้องการเข้าถึงข้อมูลผู้ใช้ เลือกผู้ใช้ที่ต้องการให้ปลั๊กอินเข้าถึงหรือเปิดใช้งานกับผู้ใช้ทั้งหมด", + "allLibrariesHelp": "เมื่อเปิดใช้งาน ปลั๊กอินจะเข้าถึงทุกห้องสมุดเพลง รวมถึงของผู้ใช้ใหม่ในอนาคต", + "noLibraries": "ไม่มีห้องสมุดเพลงถูกเลือก", + "librariesRequired": "ปลั๊กอินนี้ต้องการเข้าถึงข้อมูลห้องสมุดเพลง เลือกห้องสมุดเพลงที่ต้องการให้ปลั๊กอินเข้าถึงหรือเปิดใช้งานกับห้องสมุดเพลงทั้งหมด", + "requiredHosts": "ต้องการ Host", + "configValidationError": "การตั้งค่าเกิดความผิดพลาด", + "schemaRenderError": "ไม่สามารถแสดงหน้าจอการตั้งค่า อาจเกิดจากความผิดพลาดจากปลั๊กอิน", + "allowWriteAccessHelp": "เมื่อเปิดใช้งาน ปลั๊กอินสามารถแก้ไขไฟล์ในห้องสมุด ปลั๊กอินอยู่ในโหมดอ่านอย่างเดียวเป็นค่าเริ่มต้น" + }, + "placeholders": { + "configKey": "คีย์", + "configValue": "ค่า" + } } }, "ra": { @@ -375,7 +586,20 @@ "shareSuccess": "คัดลอก URL ไปคลิปบอร์ด: %{url}", "shareFailure": "คัดลอก URL %{url} ไปคลิปบอร์ดผิดพลาด", "downloadDialogTitle": "ดาวโหลด %{resource} '%{name}' (%{size})", - "shareCopyToClipboard": "คัดลอกไปคลิปบอร์ด: Ctrl+C, Enter" + "shareCopyToClipboard": "คัดลอกไปคลิปบอร์ด: Ctrl+C, Enter", + "remove_missing_title": "ลบรายการไฟล์ที่หายไป", + "remove_missing_content": "คุณแน่ใจว่าจะเอารายการไฟล์ที่หายไปออกจากดาต้าเบส นี่จะเป็นการลบข้อมูลอ้างอิงทั้งหมดของไฟล์ออกอย่างถาวร", + "remove_all_missing_title": "เอารายการไฟล์ที่หายไปออกทั้งหมด", + "remove_all_missing_content": "คุณแน่ใจว่าจะเอารายการไฟล์ที่หายไปออกจากดาต้าเบส นี่จะเป็นการลบข้อมูลอ้างอิงทั้งหมดของไฟล์ออกอย่างถาวร", + "noSimilarSongsFound": "ไม่มีเพลงคล้ายกัน", + "noTopSongsFound": "ไม่พบเพลงยอดนิยม", + "startingInstantMix": "กำลังโหลดอินสแตนท์ มิก...", + "uploadCover": "อัพโหลดภาพหน้าปก", + "removeCover": "ลบถาพหน้าปก", + "coverUploaded": "ภาพหน้าปกถูกอัพเดทแล้ว", + "coverRemoved": "ภาพหน้าปกถูกลบแล้ว", + "coverUploadError": "อัพโหลดภาพหน้าปกผิดพลาด", + "coverRemoveError": "ลบภาพหน้าปกผิดพลาด" }, "menu": { "library": "ห้องสมุดเพลง", @@ -404,7 +628,13 @@ "albumList": "อัลบั้ม", "about": "เกี่ยวกับ", "playlists": "เพลย์ลิสต์", - "sharedPlaylists": "เพลย์ลิสต์ที่แบ่งปัน" + "sharedPlaylists": "เพลย์ลิสต์ที่แบ่งปัน", + "librarySelector": { + "allLibraries": "ห้องสมุด (%{count}) ห้อง", + "multipleLibraries": "%{selected} ของ %{total} ห้องสมุด", + "selectLibraries": "เลือกห้องสมุด", + "none": "ไม่มี" + } }, "player": { "playListsText": "คิวเล่น", @@ -441,6 +671,22 @@ "disabled": "ปิดการทำงาน", "waiting": "รอ" } + }, + "tabs": { + "about": "เกี่ยวกับ", + "config": "การตั้งค่า" + }, + "config": { + "configName": "ชื่อการตั้งค่า", + "environmentVariable": "ค่าทั่วไป", + "currentValue": "ค่าปัจจุบัน", + "configurationFile": "ไฟล์การตั้งค่า", + "exportToml": "นำออกการตั้งค่า (TOML)", + "exportSuccess": "นำออกการตั้งค่าไปยังคลิปบอร์ดในรูปแบบ TOML แล้ว", + "exportFailed": "คัดลอกการตั้งค่าล้มเหลว", + "devFlagsHeader": "ปักธงการพัฒนา (อาจมีการเปลี่ยน/เอาออก)", + "devFlagsComment": "การตั้งค่านี้อยู่ในช่วงทดลองและอาจจะมีการเอาออกในเวอร์ชั่นหลัง", + "downloadToml": "ดาวน์โหลดการตั้งค่า (TOML)" } }, "activity": { @@ -449,7 +695,11 @@ "quickScan": "สแกนแบบเร็ว", "fullScan": "สแกนทั้งหมด", "serverUptime": "เซิร์ฟเวอร์ออนไลน์นาน", - "serverDown": "ออฟไลน์" + "serverDown": "ออฟไลน์", + "scanType": "ประเภท", + "status": "สแกนผิดพลาด", + "elapsedTime": "เวลาที่ใช้", + "selectiveScan": "เลือก" }, "help": { "title": "คีย์ลัด Navidrome", @@ -464,5 +714,10 @@ "toggle_love": "เพิ่มเพลงนี้ไปยังรายการโปรด", "current_song": "ไปยังเพลงปัจจุบัน" } + }, + "nowPlaying": { + "title": "กำลังเล่น", + "empty": "ไม่มีเพลงเล่น", + "minutesAgo": "%{smart_count} นาทีที่แล้ว |||| %{smart_count} นาทีที่แล้ว" } } \ No newline at end of file diff --git a/resources/i18n/tr.json b/resources/i18n/tr.json index cb1a0262d..d1fdb2ed4 100644 --- a/resources/i18n/tr.json +++ b/resources/i18n/tr.json @@ -34,7 +34,9 @@ "mappedTags": "Eşlenen etiketler", "rawTags": "Ham etiketler", "bitDepth": "Bit derinliği", - "sampleRate": "Örnekleme Oranı" + "sampleRate": "Örnekleme Oranı", + "missing": "Eksik", + "libraryName": "Kütüphane" }, "actions": { "addToQueue": "Oynatma Sırasına Ekle", @@ -43,7 +45,8 @@ "shuffleAll": "Tümünü karıştır", "download": "İndir", "playNext": "Dinlenenden Sonra Oynat", - "info": "Bilgiler" + "info": "Bilgiler", + "showInPlaylist": "Çalma Listesinde Göster" } }, "album": { @@ -73,7 +76,9 @@ "grouping": "Gruplama", "media": "Medya", "mood": "Mod", - "date": "Kayıt Tarihi" + "date": "Kayıt Tarihi", + "missing": "Eksik", + "libraryName": "Kütüphane" }, "actions": { "playAll": "Oynat", @@ -105,7 +110,8 @@ "rating": "Derecelendirme", "genre": "Tür", "size": "Boyut", - "role": "Rol" + "role": "Rol", + "missing": "Eksik" }, "roles": { "albumartist": "Albüm Sanatçısı |||| Albüm Sanatçısı", @@ -120,7 +126,13 @@ "mixer": "Mikser |||| Mikser", "remixer": "Remiks |||| Remiks", "djmixer": "DJ Mikseri |||| DJ Mikseri", - "performer": "Sanatçı |||| Sanatçı" + "performer": "Sanatçı |||| Sanatçı", + "maincredit": "Albüm Sanatçısı veya Sanatçı |||| Albüm Sanatçısı veya Sanatçılar" + }, + "actions": { + "shuffle": "Karıştır", + "radio": "Radyo", + "topSongs": "En İyi Şarkılar" } }, "user": { @@ -137,10 +149,12 @@ "currentPassword": "Mevcut Şifre", "newPassword": "Yeni Şifre", "token": "Token", - "lastAccessAt": "Son Erişim Tarihi" + "lastAccessAt": "Son Erişim Tarihi", + "libraries": "Kütüphaneler" }, "helperTexts": { - "name": "Adınızda yaptığımız değişikliğin geçerli olması için tekrar giriş yapmanız gerekmektedir" + "name": "Adınızda yaptığımız değişikliğin geçerli olması için tekrar giriş yapmanız gerekmektedir", + "libraries": "Bu kullanıcı için belirli kütüphaneleri seçin veya varsayılan kütüphaneleri kullanmak için boş bırakın" }, "notifications": { "created": "Kullanıcı oluşturuldu", @@ -149,7 +163,12 @@ }, "message": { "listenBrainzToken": "ListenBrainz kullanıcı Token'ınızı girin.", - "clickHereForToken": "Token almak için buraya tıklayın" + "clickHereForToken": "Token almak için buraya tıklayın", + "selectAllLibraries": "Tüm kütüphaneleri seç", + "adminAutoLibraries": "Yönetici yetkili kullanıcılar tüm kütüphanelere otomatik olarak erişebilir" + }, + "validation": { + "librariesRequired": "Yönetici olmayan kullanıcılar için en az bir kütüphane seçilmelidir" } }, "player": { @@ -193,11 +212,17 @@ "addNewPlaylist": "Oluştur \"%{name}\"", "export": "Aktar", "makePublic": "Herkese Açık Yap", - "makePrivate": "Özel Yap" + "makePrivate": "Özel Yap", + "saveQueue": "Kuyruktakileri Çalma Listesine Kaydet", + "searchOrCreate": "Çalma listelerini arayın veya yenisini oluşturmak için yazın...", + "pressEnterToCreate": "Yeni çalma listesi oluşturmak için Enter'a basın", + "removeFromSelection": "Seçimden kaldır" }, "message": { "duplicate_song": "Yinelenen şarkıları ekle", - "song_exist": "Seçili müziklerin bazıları eklemek istediğin çalma listesinde mevcut. Yine de eklemek ister misin ?" + "song_exist": "Seçili müziklerin bazıları eklemek istediğin çalma listesinde mevcut. Yine de eklemek ister misin ?", + "noPlaylistsFound": "Hiç çalma listesi bulunamadı", + "noPlaylists": "Çalma listesi mevcut değil" } }, "radio": { @@ -235,15 +260,74 @@ "fields": { "path": "Yol", "size": "Boyut", - "updatedAt": "Kaybolma" + "updatedAt": "Kaybolma", + "libraryName": "Kütüphane" }, "actions": { - "remove": "Kaldır" + "remove": "Kaldır", + "remove_all": "Tümünü Kaldır" }, "notifications": { "removed": "Eksik dosya(lar) kaldırıldı" }, "empty": "Eksik Dosya Yok" + }, + "library": { + "name": "Kütüphane |||| Kütüphaneler", + "fields": { + "name": "İsim", + "path": "Yol", + "remotePath": "Uzak Yol", + "lastScanAt": "Son Tarama", + "songCount": "Şarkılar", + "albumCount": "Albümler", + "artistCount": "Sanatçılar", + "totalSongs": "Şarkılar", + "totalAlbums": "Albümler", + "totalArtists": "Sanatçılar", + "totalFolders": "Klasörler", + "totalFiles": "Dosyalar", + "totalMissingFiles": "Eksik Dosyalar", + "totalSize": "Toplam Boyut", + "totalDuration": "Süre", + "defaultNewUsers": "Yeni Kullanıcılar için Varsayılan", + "createdAt": "Oluşturuldu", + "updatedAt": "Güncellendi" + }, + "sections": { + "basic": "Temel Bilgiler", + "statistics": "İstatistikler" + }, + "actions": { + "scan": "Kütüphaneyi Tara", + "manageUsers": "Kullanıcı Erişimini Yönet", + "viewDetails": "Ayrıntıları Görüntüle", + "quickScan": "Hızlı Tarama", + "fullScan": "Tam Tarama" + }, + "notifications": { + "created": "Kütüphane başarıyla oluşturuldu", + "updated": "Kütüphane başarıyla güncellendi", + "deleted": "Kütüphane başarıyla silindi", + "scanStarted": "Kütüphane taraması başladı", + "scanCompleted": "Kütüphane taraması tamamlandı", + "quickScanStarted": "Hızlı tarama başlatıldı", + "fullScanStarted": "Tam tarama başlatıldı", + "scanError": "Tarama başlatılırken hata oluştu. Günlükleri kontrol edin." + }, + "validation": { + "nameRequired": "Kütüphane adı gereklidir", + "pathRequired": "Kütüphane yolu gereklidir", + "pathNotDirectory": "Kütüphane yolu bir dizin olmalıdır", + "pathNotFound": "Kütüphane yolu bulunamadı", + "pathNotAccessible": "Kütüphane yoluna erişim sağlanamıyor", + "pathInvalid": "Geçersiz kütüphane yolu" + }, + "messages": { + "deleteConfirm": "Bu kütüphaneyi silmek istediğinizden emin misiniz? Bu işlem, ilgili tüm verileri ve kullanıcı erişimini kaldıracaktır.", + "scanInProgress": "Tarama devam ediyor...", + "noLibrariesAssigned": "Bu kullanıcıya hiçbir kütüphane atanmadı" + } } }, "ra": { @@ -423,7 +507,11 @@ "downloadDialogTitle": "%{resource}: '%{name}' (%{size}) dosyasını indirin", "shareCopyToClipboard": "Panoya kopyala: Ctrl+C, Enter", "remove_missing_title": "Eksik dosyaları kaldır", - "remove_missing_content": "Seçili eksik dosyaları veritabanından kaldırmak istediğinizden emin misiniz? Bu, oynatma sayıları ve derecelendirmeleri dahil olmak üzere bunlara ilişkin tüm referansları kalıcı olarak kaldıracaktır." + "remove_missing_content": "Seçili eksik dosyaları veritabanından kaldırmak istediğinizden emin misiniz? Bu, oynatma sayıları ve derecelendirmeleri dahil olmak üzere bunlara ilişkin tüm referansları kalıcı olarak kaldıracaktır.", + "remove_all_missing_title": "Tüm eksik dosyaları kaldırın", + "remove_all_missing_content": "Veritabanından tüm eksik dosyaları kaldırmak istediğinizden emin misiniz? Bu, oynatma sayısı ve derecelendirmelerde dahil olmak üzere bunlara ilişkili tüm değerleri kalıcı olarak kaldıracaktır.", + "noSimilarSongsFound": "Benzer şarkı bulunamadı", + "noTopSongsFound": "En iyi şarkı listesi boş" }, "menu": { "library": "Kütüphane", @@ -452,7 +540,13 @@ "albumList": "Albümler", "about": "Hakkında", "playlists": "Çalma Listeleri", - "sharedPlaylists": "Paylaşılan Çalma Listeleri" + "sharedPlaylists": "Paylaşılan Çalma Listeleri", + "librarySelector": { + "allLibraries": "Tüm Kitaplıklar (%{count})", + "multipleLibraries": "%{total} kütüphaneden %{selected} tanesi seçildi", + "selectLibraries": "Seçili Kütüphaneler", + "none": "Hiçbiri" + } }, "player": { "playListsText": "Oynatma Sırası", @@ -489,6 +583,21 @@ "disabled": "Pasif", "waiting": "Bekle" } + }, + "tabs": { + "about": "Hakkında", + "config": "Yapılandırma" + }, + "config": { + "configName": "Yapılandırma Adı", + "environmentVariable": "Çevre Değişkeni", + "currentValue": "Güncel Değer", + "configurationFile": "Yapılandırma Dosyası", + "exportToml": "Yapılandırmayı Dışa Aktar (TOML)", + "exportSuccess": "Yapılandırma TOML formatında dışa aktarıldı", + "exportFailed": "Yapılandırma kopyalanamadı", + "devFlagsHeader": "Geliştirme Bayrakları (değişime/kaldırılmaya tabidir)", + "devFlagsComment": "Bunlar deneysel ayarlardır ve gelecekteki sürümlerde kaldırılabilir" } }, "activity": { @@ -497,7 +606,11 @@ "quickScan": "Hızlı Tarama", "fullScan": "Tam Tarama", "serverUptime": "Sunucu Çalışma Süresi", - "serverDown": "ÇEVRİMDIŞI" + "serverDown": "ÇEVRİMDIŞI", + "scanType": "Tür", + "status": "Tarama Hatası", + "elapsedTime": "Geçen Süre", + "selectiveScan": "Seçmeli" }, "help": { "title": "Navidrome Kısayolları", @@ -512,5 +625,10 @@ "toggle_love": "Bu şarkıyı favorilere ekle", "current_song": "Mevcut Şarkıya Git" } + }, + "nowPlaying": { + "title": "Şu An Çalıyor", + "empty": "Çalan şarkı yok", + "minutesAgo": "%{smart_count} dakika önce" } } \ No newline at end of file diff --git a/resources/i18n/uk.json b/resources/i18n/uk.json index d0c4713e3..c5644fde7 100644 --- a/resources/i18n/uk.json +++ b/resources/i18n/uk.json @@ -32,7 +32,13 @@ "participants": "Додаткові вчасники", "tags": "Додаткові теги", "mappedTags": "Зіставлені теги", - "rawTags": "Вихідні теги" + "rawTags": "Вихідні теги", + "bitDepth": "Глибина розрядності", + "sampleRate": "Частота дискретизації", + "missing": "Поле відсутнє", + "libraryName": "Бібліотека", + "composer": "Композитор", + "disc": "Диск %{discNumber}" }, "actions": { "addToQueue": "Прослухати пізніше", @@ -41,7 +47,9 @@ "shuffleAll": "Перемішати", "download": "Завантажити", "playNext": "Наступна", - "info": "Отримати інформацію" + "info": "Отримати інформацію", + "showInPlaylist": "Показати у плейлісті", + "instantMix": "Мікс" } }, "album": { @@ -70,7 +78,10 @@ "releaseType": "Тип", "grouping": "Групування", "media": "Медіа", - "mood": "Настрій" + "mood": "Настрій", + "date": "Дата запису", + "missing": "Поле відсутнє", + "libraryName": "Бібліотека" }, "actions": { "playAll": "Прослухати", @@ -102,7 +113,8 @@ "rating": "Рейтинг", "genre": "Жанр", "size": "Розмір", - "role": "Роль" + "role": "Роль", + "missing": "Поле відсутнє" }, "roles": { "albumartist": "Виконавець альбому |||| Виконавці альбому", @@ -117,7 +129,13 @@ "mixer": "Звукоінженер |||| Звукоінженери", "remixer": "Реміксер |||| Реміксери", "djmixer": "DJ-звукоінженер |||| DJ-звукоінженери", - "performer": "Виконавець |||| Виконавці" + "performer": "Виконавець |||| Виконавці", + "maincredit": "Виконавець альбому або Виконавець |||| Виконавці альбому або Виконавці" + }, + "actions": { + "shuffle": "Перетасовка", + "radio": "Радіо", + "topSongs": "ТОП-треки" } }, "user": { @@ -134,10 +152,12 @@ "currentPassword": "Поточний пароль", "newPassword": "Новий пароль", "token": "Токен", - "lastAccessAt": "Останній доступ" + "lastAccessAt": "Останній доступ", + "libraries": "Бібліотеки" }, "helperTexts": { - "name": "Змінене ім'я буде відображатися при наступній авторизації" + "name": "Змінене ім'я буде відображатися при наступній авторизації", + "libraries": "Виберіть конкретні бібліотеки для цього користувача, або залиште поле порожнім, щоб використовувати бібліотеки за замовчуванням" }, "notifications": { "created": "Користувача створено", @@ -146,7 +166,12 @@ }, "message": { "listenBrainzToken": "Введіть свій токен користувача ListenBrainz.", - "clickHereForToken": "Натисніть тут для отримання токену" + "clickHereForToken": "Натисніть тут для отримання токену", + "selectAllLibraries": "Вибрати всі бібліотеки", + "adminAutoLibraries": "Користувачі-адміністратори автоматично отримують доступ до всіх бібліотек" + }, + "validation": { + "librariesRequired": "Для користувачів, які не є адміністраторами, має бути обрана хоча б одна бібліотека" } }, "player": { @@ -190,11 +215,17 @@ "addNewPlaylist": "Створити \"%{name}\"", "export": "Експортувати", "makePublic": "Зробити публічним", - "makePrivate": "Зробити приватним" + "makePrivate": "Зробити приватним", + "saveQueue": "Зберегти чергу до плейлиста", + "searchOrCreate": "Знайти плейлист або введіть текст, щоб створити новий...", + "pressEnterToCreate": "Натисніть Enter щоб створити новий плейлист", + "removeFromSelection": "Вилучити з вибору" }, "message": { "duplicate_song": "Додати повторювані пісні", - "song_exist": "У список відтворення додаються дублікати. Хочете додати дублікати або пропустити їх?" + "song_exist": "У список відтворення додаються дублікати. Хочете додати дублікати або пропустити їх?", + "noPlaylistsFound": "Не знайдено плейлистів", + "noPlaylists": "Немає доступних плейлистів" } }, "radio": { @@ -232,13 +263,149 @@ "fields": { "path": "Шлях файлу", "size": "Розмір", - "updatedAt": "Зник" + "updatedAt": "Зник", + "libraryName": "Бібліотека" }, "actions": { - "remove": "Видалити" + "remove": "Видалити", + "remove_all": "Вилучити всі" }, "notifications": { "removed": "Видалено зниклі файл(и)" + }, + "empty": "Немає відсутніх файлів" + }, + "library": { + "name": "Бібліотека |||| Бібліотеки", + "fields": { + "name": "Ім'я", + "path": "Шлях", + "remotePath": "Віддалений шлях", + "lastScanAt": "Останнє сканування", + "songCount": "Треки", + "albumCount": "Альбоми", + "artistCount": "Виконавці", + "totalSongs": "Треки", + "totalAlbums": "Альбоми", + "totalArtists": "Виконавці", + "totalFolders": "Папки", + "totalFiles": "Файлів", + "totalMissingFiles": "Зниклих файлів", + "totalSize": "Загальний розмір", + "totalDuration": "Тривалість", + "defaultNewUsers": "За замовчуванням для нових користувачів", + "createdAt": "Створено", + "updatedAt": "Оновлено" + }, + "sections": { + "basic": "Основна інформація", + "statistics": "Статистика" + }, + "actions": { + "scan": "Сканувати бібліотеку", + "manageUsers": "Керування доступом користувачів", + "viewDetails": "Переглянути подробиці", + "quickScan": "Швидке сканування", + "fullScan": "Повне сканування" + }, + "notifications": { + "created": "Бібліотеку успішно створено", + "updated": "Бібліотеку успішно оновлено", + "deleted": "Бібліотеку успішно видалено", + "scanStarted": "Сканування бібліотеки розпочато", + "scanCompleted": "Сканування бібліотеки закінчено", + "quickScanStarted": "Швидке сканування виконується", + "fullScanStarted": "Повне сканування виконується", + "scanError": "Помилка при виконанні сканування. Перевірте лоґи" + }, + "validation": { + "nameRequired": "Ім'я бібліотеки обов'язкове", + "pathRequired": "Шлях до бібліотеки обов'язковий", + "pathNotDirectory": "Шлях до бібліотеки має бути директорією", + "pathNotFound": "Шлях до бібліотеки не знайдено", + "pathNotAccessible": "Шлях до бібліотеки недоступний", + "pathInvalid": "Помилковий шлях до бібліотеки" + }, + "messages": { + "deleteConfirm": "Ви впевнені, що хочете видалити цю бібліотеку? Це призведе до видалення всіх пов'язаних з нею даних і доступу користувачів.", + "scanInProgress": "Сканування триває...", + "noLibrariesAssigned": "Немає бібліотек, призначених цьому користувачеві" + } + }, + "plugin": { + "name": "Плагін |||| Плагіни", + "fields": { + "id": "ІД", + "name": "Назва", + "description": "Опис", + "version": "Версія", + "author": "Автор", + "website": "Вебсайт", + "permissions": "Дозволи", + "enabled": "Увімкнено", + "status": "Стан", + "path": "Шлях", + "lastError": "Помилка", + "hasError": "Помилка", + "updatedAt": "Оновлено", + "createdAt": "Встановлено", + "configKey": "Ключ", + "configValue": "Значення", + "allUsers": "Дозволити усім користувачам", + "selectedUsers": "Вибрані користувачі", + "allLibraries": "Дозволити всі бібліотеки", + "selectedLibraries": "Вибрані бібліотеки", + "allowWriteAccess": "Дозволити доступ до запису" + }, + "sections": { + "status": "Стан", + "info": "Інформація про плагін", + "configuration": "Конфігурація", + "manifest": "Маніфест", + "usersPermission": "Дозволи користувачів", + "libraryPermission": "Дозволи бібліотеки" + }, + "status": { + "enabled": "Увімкнено", + "disabled": "Вимкнено" + }, + "actions": { + "enable": "Увімкнути", + "disable": "Вимкнути", + "disabledDueToError": "Виправте помилку перед увімкненням", + "disabledUsersRequired": "Виберіть користувачі перед увімкненням", + "disabledLibrariesRequired": "Виберіть бібліотеки перед увімкненням", + "addConfig": "Додати конфігурацію", + "rescan": "Пересканувати" + }, + "notifications": { + "enabled": "Увімкнути плагін", + "disabled": "Вимкнути плагін", + "updated": "Плагін оновлено", + "error": "Помилка оновлення плагіну" + }, + "validation": { + "invalidJson": "Конфігурація повинна має відповідати формату JSON" + }, + "messages": { + "configHelp": "Налаштуйте плагін використовуючи пару ключ-значення. Залиште порожнім, якщо плагін не вимагає конфігурації.", + "clickPermissions": "Натисніть дозволи для детальної інформації", + "noConfig": "Конфігурація не налаштована", + "allUsersHelp": "При увімкненні плагін матиме доступ до всіх користувачів, включно ті, які будуть створені в майбутньому.", + "noUsers": "Немає вибраних користувачів", + "permissionReason": "Причина", + "usersRequired": "Цей плагін вимагає доступу до інформації про користувача. Виберіть, до яких користувачів плагін може отримати доступ, або ввімкніть «Дозволити всім користувачам».", + "allLibrariesHelp": "Коли увімкнуто, плагін матиме доступ до всіх бібліотек, включаючи ті, які будуть створені в майбутньому.", + "noLibraries": "Немає виділених бібліотек", + "librariesRequired": "Цей плагін вимагає доступу до інформації бібліотеки. Виберіть, до яких бібліотек плагін може отримати доступ, або ввімкніть «Дозволити всі бібліотеки».", + "requiredHosts": "Обов'язкові хости", + "configValidationError": "Перевірка конфігурації зазнала невдачі:", + "schemaRenderError": "Неможливо відобразити форму конфігурації. Схема плагіна може бути недійсною.", + "allowWriteAccessHelp": "При включенні плагін може змінювати файли в каталогах бібліотеки. За замовчуванням плагіни мають доступ лише для читання." + }, + "placeholders": { + "configKey": "ключ", + "configValue": "значення" } } }, @@ -419,7 +586,18 @@ "downloadDialogTitle": "Завантаження %{resource} '%{name}' (%{size})", "shareCopyToClipboard": "Скопіювати в буфер: Ctrl+C, Enter", "remove_missing_title": "Видалити зниклі файли", - "remove_missing_content": "Ви впевнені, що хочете видалити вибрані відсутні файли з бази даних? Це назавжди видалить усі посилання на них, включаючи кількість прослуховувань та рейтинги." + "remove_missing_content": "Ви впевнені, що хочете видалити вибрані відсутні файли з бази даних? Це назавжди видалить усі посилання на них, включаючи кількість прослуховувань та рейтинги.", + "remove_all_missing_title": "Видалити всі відсутні файли", + "remove_all_missing_content": "Ви впевнені, що хочете видалити всі відсутні файли з бази даних? Це назавжди видалить будь-які посилання на них, включно з кількістю відтворень та рейтингами.", + "noSimilarSongsFound": "Не знайдено схожих треків", + "noTopSongsFound": "Не знайдено ТОП-треків", + "startingInstantMix": "Завантаження міксу...", + "uploadCover": "Завантажити обкладинку", + "removeCover": "Видалити обкладинку", + "coverUploaded": "Обкладинку оновлено", + "coverRemoved": "Обкладинка видалена", + "coverUploadError": "Помилка завантаження обкладинки", + "coverRemoveError": "Помилка видалення обкладинки" }, "menu": { "library": "Бібліотека", @@ -448,7 +626,13 @@ "albumList": "Альбом", "about": "Довідка", "playlists": "Списки відтворення", - "sharedPlaylists": "Загальнодоступний список відтворення" + "sharedPlaylists": "Загальнодоступний список відтворення", + "librarySelector": { + "allLibraries": "Усі бібліотеки (%{count})", + "multipleLibraries": "%{selected} з %{total} Бібліотеки", + "selectLibraries": "Вибір бібліотек", + "none": "Відсутня" + } }, "player": { "playListsText": "Грати по черзі", @@ -485,6 +669,22 @@ "disabled": "Вимкнено", "waiting": "Очікування" } + }, + "tabs": { + "about": "Про", + "config": "Конфігурація" + }, + "config": { + "configName": "Назва конфігурації", + "environmentVariable": "Змінна середовища", + "currentValue": "Поточне значення", + "configurationFile": "Файл конфігурації", + "exportToml": "Експортувати Конфігурацію (у форматі TOML)", + "exportSuccess": "Конфігурацію експортовано в буфер обміну у форматі TOML", + "exportFailed": "Не вдалося скопіювати конфігурацію", + "devFlagsHeader": "Прапорці розробки (можуть бути змінені/видалені)", + "devFlagsComment": "Це експериментальні налаштування, які можуть бути видалені в майбутніх версіях.", + "downloadToml": "Завантажити конфігурацію (TOML)" } }, "activity": { @@ -493,7 +693,11 @@ "quickScan": "Швидке сканування", "fullScan": "Повне сканування", "serverUptime": "Час роботи", - "serverDown": "Оффлайн" + "serverDown": "Оффлайн", + "scanType": "Тип", + "status": "Помилка сканування", + "elapsedTime": "Пройдений час", + "selectiveScan": "Вибірковий" }, "help": { "title": "Гарячі клавіші Navidrome", @@ -508,5 +712,10 @@ "toggle_love": "Відмітити поточні пісні", "current_song": "Перейти до поточної пісні" } + }, + "nowPlaying": { + "title": "Зараз грає", + "empty": "Нічого не грає", + "minutesAgo": "%{smart_count} хвилин тому |||| %{smart_count} хвилин тому" } } \ No newline at end of file diff --git a/resources/i18n/zh-Hans.json b/resources/i18n/zh-Hans.json index c447f7d72..63ea5cf60 100644 --- a/resources/i18n/zh-Hans.json +++ b/resources/i18n/zh-Hans.json @@ -1,517 +1,723 @@ { - "languageName": "简体中文", - "resources": { - "song": { - "name": "歌曲", - "fields": { - "albumArtist": "专辑歌手", - "duration": "时长", - "trackNumber": "歌曲序号", - "playCount": "播放次数", - "title": "曲名", - "artist": "歌手", - "album": "专辑", - "path": "文件路径", - "genre": "流派", - "compilation": "合辑", - "year": "发行年份", - "size": "文件大小", - "updatedAt": "更新于", - "bitRate": "比特率", - "bitDepth": "比特深度", - "channels": "声道", - "discSubtitle": "字幕", - "starred": "收藏", - "comment": "注释", - "rating": "评分", - "quality": "品质", - "bpm": "BPM", - "playDate": "最后一次播放", - "createdAt": "创建于", - "grouping": "分组", - "mood": "情绪", - "participants": "其他参与人员", - "tags": "附加标签", - "mappedTags": "映射标签", - "rawTags": "原始标签" - }, - "actions": { - "addToQueue": "加入播放列表", - "playNow": "立即播放", - "addToPlaylist": "加入歌单", - "shuffleAll": "全部随机播放", - "download": "下载", - "playNext": "下一首播放", - "info": "查看信息" - } - }, - "album": { - "name": "专辑", - "fields": { - "albumArtist": "专辑歌手", - "artist": "歌手", - "duration": "时长", - "songCount": "歌曲数量", - "playCount": "播放次数", - "size": "文件大小", - "name": "名称", - "genre": "流派", - "compilation": "合辑", - "year": "发行年份", - "date": "录制日期", - "originalDate": "原始日期", - "releaseDate": "发⾏日期", - "releases": "发⾏", - "released": "已发⾏", - "updatedAt": "更新于", - "comment": "注释", - "rating": "评分", - "createdAt": "创建于", - "recordLabel": "厂牌", - "catalogNum": "目录编号", - "releaseType": "发行类型", - "grouping": "分组", - "media": "媒体类型", - "mood": "情绪" - }, - "actions": { - "playAll": "立即播放", - "playNext": "下首播放", - "addToQueue": "加入播放列表", - "share": "分享", - "shuffle": "随机播放", - "addToPlaylist": "加入歌单", - "download": "下载", - "info": "查看信息" - }, - "lists": { - "all": "所有", - "random": "随机", - "recentlyAdded": "最近添加", - "recentlyPlayed": "最近播放", - "mostPlayed": "最多播放", - "starred": "收藏", - "topRated": "评分排行" - } - }, - "artist": { - "name": "艺术家", - "fields": { - "name": "名称", - "albumCount": "专辑数", - "songCount": "歌曲数", - "size": "文件大小", - "playCount": "播放次数", - "rating": "评分", - "genre": "流派", - "role": "参与角色" - }, - "roles": { - "albumartist": "专辑歌手", - "artist": "歌手", - "composer": "作曲", - "conductor": "指挥", - "lyricist": "作词", - "arranger": "编曲", - "producer": "制作人", - "director": "总监", - "engineer": "工程师", - "mixer": "混音师", - "remixer": "重混师", - "djmixer": "DJ混音师", - "performer": "演奏家" - } - }, - "user": { - "name": "用户", - "fields": { - "userName": "用户名", - "isAdmin": "是否管理员", - "lastLoginAt": "上次登录", - "lastAccessAt": "上次访问", - "updatedAt": "更新于", - "name": "名称", - "password": "密码", - "createdAt": "创建于", - "changePassword": "修改密码?", - "currentPassword": "当前密码", - "newPassword": "新密码", - "token": "令牌" - }, - "helperTexts": { - "name": "名称的更改将在下次登录时生效" - }, - "notifications": { - "created": "用户已创建", - "updated": "用户已更新", - "deleted": "用户已删除" - }, - "message": { - "listenBrainzToken": "输入您的 ListenBrainz 用户令牌", - "clickHereForToken": "点击这里来获得你的 ListenBrainz 令牌" - } - }, - "player": { - "name": "客户端", - "fields": { - "name": "名称", - "transcodingId": "转码编号", - "maxBitRate": "最大比特率", - "client": "客户端", - "userName": "用户名", - "lastSeen": "上次浏览", - "reportRealPath": "回报实际路径", - "scrobbleEnabled": "发送喜好记录到外部服务" - } - }, - "transcoding": { - "name": "转码", - "fields": { - "name": "名称", - "targetFormat": "目标格式", - "defaultBitRate": "默认比特率", - "command": "命令" - } - }, - "playlist": { - "name": "歌单", - "fields": { - "name": "名称", - "duration": "时长", - "ownerName": "所有者", - "public": "公开", - "updatedAt": "更新于", - "createdAt": "创建于", - "songCount": "歌曲数", - "comment": "注释", - "sync": "自动导入", - "path": "导入" - }, - "actions": { - "selectPlaylist": "选择歌单", - "addNewPlaylist": "新建 %{name}", - "export": "导出", - "makePublic": "设为公开", - "makePrivate": "设为私有" - }, - "message": { - "duplicate_song": "添加重复的歌曲", - "song_exist": "部分选定的歌曲已存在歌单中,继续添加或是跳过它们?" - } - }, - "radio": { - "name": "电台", - "fields": { - "name": "名称", - "streamUrl": "推流地址", - "homePageUrl": "首页链接", - "updatedAt": "更新于", - "createdAt": "创建于" - }, - "actions": { - "playNow": "开始播放" - } - }, - "share": { - "name": "分享", - "fields": { - "username": "分享者", - "url": "链接", - "description": "描述", - "downloadable": "是否允许下载?", - "contents": "目录", - "expiresAt": "过期于", - "lastVisitedAt": "上次访问于", - "visitCount": "访问数", - "format": "格式", - "maxBitRate": "最大比特率", - "updatedAt": "更新于", - "createdAt": "创建于" - }, - "notifications": {}, - "actions": {} - }, - "missing": { - "name": "丢失文件", - "empty": "无丢失文件", - "fields": { - "path": "路径", - "size": "文件大小", - "updatedAt": "丢失于" - }, - "actions": { - "remove": "移除" - }, - "notifications": { - "removed": "丢失文件已移除" - } - } + "languageName": "简体中文", + "resources": { + "song": { + "name": "歌曲", + "fields": { + "albumArtist": "专辑艺人", + "duration": "时长", + "trackNumber": "音轨号", + "playCount": "播放次数", + "title": "标题", + "artist": "艺人", + "composer": "作曲者", + "album": "专辑", + "path": "文件路径", + "genre": "流派", + "libraryName": "媒体库", + "compilation": "合辑", + "year": "发行年份", + "size": "文件大小", + "updatedAt": "更新于", + "bitRate": "比特率", + "bitDepth": "位深度", + "sampleRate": "采样率", + "channels": "声道", + "disc": "碟片 %{discNumber}", + "discSubtitle": "碟片副标题", + "starred": "收藏", + "comment": "注释", + "rating": "评分", + "quality": "品质", + "bpm": "BPM", + "playDate": "最后一次播放", + "createdAt": "加入日期", + "grouping": "分组", + "mood": "情绪", + "participants": "其他参与人员", + "tags": "附加标签", + "mappedTags": "映射标签", + "rawTags": "原始标签", + "missing": "丢失" + }, + "actions": { + "addToQueue": "添加到播放队列", + "playNow": "立即播放", + "addToPlaylist": "添加到歌单", + "showInPlaylist": "在歌单中显示", + "shuffleAll": "全部随机播放", + "download": "下载", + "playNext": "下一首播放", + "info": "查看信息", + "instantMix": "即兴推荐" + } }, - "ra": { - "auth": { - "welcome1": "感谢您安装 Navidrome!", - "welcome2": "开始使用前,请创建一个管理员账户", - "confirmPassword": "确认密码", - "buttonCreateAdmin": "创建管理员", - "auth_check_error": "请登录访问更多内容", - "user_menu": "配置", - "username": "用户名", - "password": "密码", - "sign_in": "登录", - "sign_in_error": "验证失败,请重试", - "logout": "注销", - "insightsCollectionNote": "Navidrome 会收集匿名使用数据以协助改进项目。\n点击[此处]了解详情或选择退出。" - }, - "validation": { - "invalidChars": "请使用字母和数字", - "passwordDoesNotMatch": "密码不匹配", - "required": "必填", - "minLength": "必须不少于 %{min} 个字符", - "maxLength": "必须不多于 %{max} 个字符", - "minValue": "必须不小于 %{min}", - "maxValue": "必须不大于 %{max}", - "number": "必须为数字", - "email": "必须是有效的电子邮箱", - "oneOf": "必须为: %{options} 其中一项", - "regex": "必须符合指定的格式(正则表达式):%{pattern}", - "unique": "必须唯一", - "url": "必须是有效的链接" - }, - "action": { - "add_filter": "添加筛选", - "add": "添加", - "back": "返回", - "bulk_actions": "选中 %{smart_count} 项", - "bulk_actions_mobile": "%{smart_count}", - "cancel": "取消", - "clear_input_value": "清除", - "clone": "复制", - "confirm": "确认", - "create": "新建", - "delete": "删除", - "edit": "编辑", - "export": "导出", - "list": "列表", - "refresh": "刷新", - "remove_filter": "取消筛选", - "remove": "删除", - "save": "保存", - "search": "搜索", - "show": "显示", - "sort": "排序", - "undo": "撤销", - "expand": "展开", - "close": "关闭", - "open_menu": "打开菜单", - "close_menu": "关闭菜单", - "unselect": "未选择", - "skip": "跳过", - "share": "分享", - "download": "下载" - }, - "boolean": { - "true": "是", - "false": "否" - }, - "page": { - "create": "新建 %{name}", - "dashboard": "仪表盘", - "edit": "%{name} #%{id}", - "error": "发生错误", - "list": "%{name}", - "loading": "加载中", - "not_found": "未找到", - "show": "%{name} #%{id}", - "empty": "还没有 %{name}。", - "invite": "您要创建一个吗?" - }, - "input": { - "file": { - "upload_several": "拖拽多个文件上传或点击选择一个", - "upload_single": "拖拽单个文件上传或点击选择一个" - }, - "image": { - "upload_several": "拖拽多个图片上传或点击选择一个", - "upload_single": "拖拽单个图片上传或点击选择一个" - }, - "references": { - "all_missing": "未找到参考数据", - "many_missing": "至少有一条参考数据不再可用", - "single_missing": "关联的参考数据不再可用" - }, - "password": { - "toggle_visible": "隐藏密码", - "toggle_hidden": "显示密码" - } - }, - "message": { - "about": "关于", - "are_you_sure": "您确定要进行此操作?", - "bulk_delete_content": "您确定要删除 %{smart_count} 项 %{name}?", - "bulk_delete_title": "删除 %{smart_count} 项 %{name}", - "delete_content": "您确定要删除该条目?", - "delete_title": "删除 %{name} #%{id}", - "details": "详情", - "error": "发生一个客户端错误,您的请求无法完成", - "invalid_form": "提交内容无效,请检查错误", - "loading": "正在加载页面,请稍候", - "no": "否", - "not_found": "您输入的链接格式不对或链接丢失", - "yes": "是", - "unsaved_changes": "某些更改尚未保存,您确定要离开此页面吗?" - }, - "navigation": { - "no_results": "无内容", - "no_more_results": "页码 %{page} 超出范围,尝试返回上一页", - "page_out_of_boundaries": "页码 %{page} 超出范围", - "page_out_from_end": "已经最后一页", - "page_out_from_begin": "已经是第一页", - "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", - "page_rows_per_page": "每页行数:", - "next": "下一页", - "prev": "上一页", - "skip_nav": "跳过" - }, - "notification": { - "updated": "已更新 %{smart_count} 项", - "created": "已新建 1 项", - "deleted": "已删除 %{smart_count} 项", - "bad_item": "不正确的项", - "item_doesnt_exist": "该项不存在", - "http_error": "与服务通信出错", - "data_provider_error": "数据来源错误,请检查控制台的详细信息", - "i18n_error": "加载所选语言时出错", - "canceled": "操作已取消", - "logged_out": "您的会话已结束,请重新登录", - "new_version": "发现新版本!请刷新此页面" - }, - "toggleFieldsMenu": { - "columnsToDisplay": "显示的项", - "layout": "布局", - "grid": "网格", - "table": "表格" - } + "album": { + "name": "专辑", + "fields": { + "albumArtist": "专辑艺人", + "artist": "艺人", + "duration": "时长", + "songCount": "歌曲数", + "playCount": "播放次数", + "size": "文件大小", + "name": "名称", + "genre": "流派", + "libraryName": "媒体库", + "compilation": "合辑", + "year": "发行年份", + "date": "录制日期", + "originalDate": "原始日期", + "releaseDate": "发⾏日期", + "releases": "发行版本", + "released": "已发⾏", + "updatedAt": "更新于", + "comment": "注释", + "rating": "评分", + "createdAt": "加入日期", + "recordLabel": "厂牌", + "catalogNum": "目录编号", + "releaseType": "发行类型", + "grouping": "分组", + "media": "发行媒介", + "mood": "情绪", + "missing": "丢失" + }, + "actions": { + "playAll": "立即播放", + "playNext": "下一首播放", + "addToQueue": "添加到播放队列", + "share": "分享", + "shuffle": "随机播放", + "addToPlaylist": "添加到歌单", + "download": "下载", + "info": "查看信息" + }, + "lists": { + "all": "全部", + "random": "随机", + "recentlyAdded": "最近加入", + "recentlyPlayed": "最近播放", + "mostPlayed": "最多播放", + "starred": "收藏", + "topRated": "评分榜单" + } }, - "message": { - "note": "说明", - "transcodingDisabled": "出于安全原因,从 Web 界面更改转码配置的功能已被禁用。要更改(编辑或新增)转码选项,请在启用 %{config} 选项的情况下重新启动服务器。", - "transcodingEnabled": "Navidrome 当前与 %{config} 一起使用,可以通过配置转码选项来执行任意命令,建议仅在配置转码选项时启用此功能。", - "songsAddedToPlaylist": "已添加 %{smart_count} 首歌到歌单", - "noPlaylistsAvailable": "没有有效的歌单", - "delete_user_title": "删除用户 %{name}", - "delete_user_content": "您确定要删除该用户及其相关数据(包括歌单和用户配置)吗?", - "remove_missing_title": "移除丢失文件", - "remove_missing_content": "您确定要将选中的丢失文件从数据库中永久移除吗?此操作将删除所有相关信息,包括播放次数和评分。", - "notifications_blocked": "您已在浏览器的设置中屏蔽了此网站的通知", - "notifications_not_available": "此浏览器不支持桌面通知", - "lastfmLinkSuccess": "Last.fm 已关联并启用喜好记录", - "lastfmLinkFailure": "Last.fm 无法关联", - "lastfmUnlinkSuccess": "已成功解除与 Last.fm 的链接,且喜好记录已禁用", - "lastfmUnlinkFailure": "Last.fm 无法取消关联", - "listenBrainzLinkSuccess": "ListenBrainz 已关联并启用喜好记录", - "listenBrainzLinkFailure": "ListenBrainz 无法关联:%{error}", - "listenBrainzUnlinkSuccess": "已成功解除与 ListenBrainz 的链接,且喜好记录已禁用", - "listenBrainzUnlinkFailure": "ListenBrainz 无法取消关联", - "openIn": { - "lastfm": "在 Last.fm 中打开", - "musicbrainz": "在 MusicBrainz 中打开" - }, - "lastfmLink": "查看更多…", - "shareOriginalFormat": "分享原始格式", - "shareDialogTitle": "分享 %{resource} '%{name}'", - "shareBatchDialogTitle": "分享 %{smart_count} 个 %{resource}", - "shareCopyToClipboard": "复制到剪切板: Ctrl+C, Enter", - "shareSuccess": "分享链接已复制: %{url}", - "shareFailure": "分享链接复制失败: %{url}", - "downloadDialogTitle": "下载 %{resource} '%{name}' (%{size})", - "downloadOriginalFormat": "下载原始格式" + "artist": { + "name": "艺人", + "fields": { + "name": "名称", + "albumCount": "专辑数", + "songCount": "歌曲数", + "size": "文件大小", + "playCount": "播放次数", + "rating": "评分", + "genre": "流派", + "role": "参与角色", + "missing": "丢失" + }, + "roles": { + "albumartist": "专辑艺人", + "artist": "艺人", + "composer": "作曲者", + "conductor": "指挥家", + "lyricist": "作词者", + "arranger": "编曲者", + "producer": "制作人", + "director": "总监", + "engineer": "工程师", + "mixer": "混音师", + "remixer": "重混师", + "djmixer": "DJ混音师", + "performer": "演奏家", + "maincredit": "专辑艺人或艺人" + }, + "actions": { + "topSongs": "热门歌曲", + "shuffle": "随机播放", + "radio": "电台" + } }, - "menu": { - "library": "曲库", - "settings": "设置", - "version": "版本", - "theme": "主题", - "personal": { - "name": "个性化", - "options": { - "theme": "主题", - "language": "语言", - "defaultView": "默认界面", - "desktop_notifications": "桌面通知", - "lastfmNotConfigured": "没有配置 Last.fm 的 API-Key", - "lastfmScrobbling": "启用 Last.fm 的喜好记录", - "listenBrainzScrobbling": "启用 ListenBrainz 的喜好记录", - "replaygain": "回放增益", - "preAmp": "前置放大器 (dB)", - "gain": { - "none": "禁用增益", - "album": "使用专辑增益信息", - "track": "使用歌曲增益信息" - } - } - }, - "albumList": "专辑", - "playlists": "歌单", - "sharedPlaylists": "共享的歌单", - "about": "关于" + "user": { + "name": "用户", + "fields": { + "userName": "用户名", + "isAdmin": "是否管理员", + "lastLoginAt": "上次登录", + "lastAccessAt": "上次访问", + "updatedAt": "更新于", + "name": "名称", + "password": "密码", + "createdAt": "创建于", + "changePassword": "修改密码?", + "currentPassword": "当前密码", + "newPassword": "新密码", + "token": "令牌", + "libraries": "媒体库" + }, + "helperTexts": { + "name": "名称的更改将在下次登录时生效", + "libraries": "为此用户选择指定媒体库,留空则使用默认媒体库" + }, + "notifications": { + "created": "用户已创建", + "updated": "用户已更新", + "deleted": "用户已删除" + }, + "validation": { + "librariesRequired": "至少为非管理员用户选择一个媒体库" + }, + "message": { + "listenBrainzToken": "输入您的 ListenBrainz 用户令牌", + "clickHereForToken": "点此获得您的令牌", + "selectAllLibraries": "选择全部媒体库", + "adminAutoLibraries": "管理员用户自动拥有所有媒体库的访问权限" + } }, "player": { - "playListsText": "播放列表", - "openText": "打开", - "closeText": "关闭", - "notContentText": "没有音乐", - "clickToPlayText": "点击播放", - "clickToPauseText": "点击暂停", - "nextTrackText": "下一首", - "previousTrackText": "上一首", - "reloadText": "重新播放", - "volumeText": "音量", - "toggleLyricText": "切换歌词", - "toggleMiniModeText": "最小化", - "destroyText": "关闭", - "downloadText": "下载", - "removeAudioListsText": "清空播放列表", - "clickToDeleteText": "点击删除 %{name}", - "emptyLyricText": "无歌词", - "playModeText": { - "order": "顺序播放", - "orderLoop": "列表循环", - "singleLoop": "单曲循环", - "shufflePlay": "随机播放" - } + "name": "播放器", + "fields": { + "name": "名称", + "transcodingId": "转码", + "maxBitRate": "最大比特率", + "client": "客户端", + "userName": "用户名", + "lastSeen": "上次浏览", + "reportRealPath": "报告真实路径", + "scrobbleEnabled": "发送个性化记录到外部服务" + } }, - "about": { - "links": { - "homepage": "主页", - "source": "源代码", - "featureRequests": "功能需求", - "lastInsightsCollection": " 最近的分析收集", - "insights": { - "disabled": "禁用", - "waiting": "等待" - } - } + "transcoding": { + "name": "转码", + "fields": { + "name": "名称", + "targetFormat": "目标格式", + "defaultBitRate": "默认比特率", + "command": "命令" + } }, - "activity": { - "title": "运行情况", - "totalScanned": "已完成扫描的目录", + "playlist": { + "name": "歌单", + "fields": { + "name": "名称", + "duration": "时长", + "ownerName": "所有者", + "public": "公开", + "updatedAt": "更新于", + "createdAt": "创建于", + "songCount": "歌曲数", + "comment": "注释", + "sync": "自动导入", + "path": "导入路径" + }, + "actions": { + "selectPlaylist": "选择歌单", + "addNewPlaylist": "创建%{name}", + "export": "导出", + "saveQueue": "保存为歌单", + "makePublic": "设为公开", + "makePrivate": "设为私有", + "searchOrCreate": "搜索歌单,或输入名称以创建…", + "pressEnterToCreate": "按 Enter 键创建歌单", + "removeFromSelection": "移除选中项" + }, + "message": { + "duplicate_song": "添加了重复的歌曲", + "song_exist": "部分选定的歌曲已存在歌单中,继续添加或是跳过它们?", + "noPlaylistsFound": "未找到歌单", + "noPlaylists": "暂无可用歌单" + } + }, + "radio": { + "name": "电台", + "fields": { + "name": "名称", + "streamUrl": "推流 URL", + "homePageUrl": "首页 URL", + "updatedAt": "更新于", + "createdAt": "创建于" + }, + "actions": { + "playNow": "开始播放" + } + }, + "share": { + "name": "分享", + "fields": { + "username": "分享者", + "url": "URL", + "description": "描述", + "downloadable": "是否允许下载?", + "contents": "目录", + "expiresAt": "过期于", + "lastVisitedAt": "上次访问", + "visitCount": "访问数", + "format": "格式", + "maxBitRate": "最大比特率", + "updatedAt": "更新于", + "createdAt": "创建于" + }, + "notifications": {}, + "actions": {} + }, + "missing": { + "name": "丢失文件", + "empty": "无丢失文件", + "fields": { + "path": "路径", + "size": "文件大小", + "libraryName": "媒体库", + "updatedAt": "丢失于" + }, + "actions": { + "remove": "移除", + "remove_all": "移除所有" + }, + "notifications": { + "removed": "丢失文件已移除" + } + }, + "library": { + "name": "媒体库", + "fields": { + "name": "名称", + "path": "路径", + "remotePath": "远程路径", + "lastScanAt": "上次扫描", + "songCount": "歌曲数", + "albumCount": "专辑数", + "artistCount": "艺人数", + "totalSongs": "歌曲数", + "totalAlbums": "专辑数", + "totalArtists": "艺人数", + "totalFolders": "目录数", + "totalFiles": "文件数", + "totalMissingFiles": "丢失的文件数", + "totalSize": "总大小", + "totalDuration": "时长", + "defaultNewUsers": "新用户默认", + "createdAt": "创建于", + "updatedAt": "更新于" + }, + "sections": { + "basic": "基本信息", + "statistics": "统计数据" + }, + "actions": { + "scan": "扫描媒体库", "quickScan": "快速扫描", "fullScan": "完全扫描", - "serverUptime": "服务器已运行", - "serverDown": "服务器已离线" + "manageUsers": "管理用户权限", + "viewDetails": "查看详情" + }, + "notifications": { + "created": "媒体库创建成功", + "updated": "媒体库更新成功", + "deleted": "媒体库删除成功", + "scanStarted": "媒体库扫描已开始", + "quickScanStarted": "快速扫描已开始", + "fullScanStarted": "完全扫描已开始", + "scanError": "开始扫描时出错,请检查日志", + "scanCompleted": "媒体库扫描已完成" + }, + "validation": { + "nameRequired": "媒体库名称不能为空", + "pathRequired": "媒体库路径不能为空", + "pathNotDirectory": "媒体库路径必须为目录", + "pathNotFound": "媒体库路径未找到", + "pathNotAccessible": "媒体库路径无法访问", + "pathInvalid": "媒体库路径无效" + }, + "messages": { + "deleteConfirm": "您确定要删除此媒体库吗?这将删除所有关联数据及用户访问权限。", + "scanInProgress": "正在扫描...", + "noLibrariesAssigned": "未向此用户分配媒体库" + } }, - "help": { - "title": "Navidrome 快捷键", - "hotkeys": { - "show_help": "显示此帮助", - "toggle_menu": "显示/隐藏菜单侧栏", - "toggle_play": "播放/暂停", - "prev_song": "上一首歌", - "next_song": "下一首歌", - "current_song": "转到当前播放", - "vol_up": "增大音量", - "vol_down": "减小音量", - "toggle_love": "添加/移除星标" - } + "plugin": { + "name": "插件", + "fields": { + "id": "ID", + "name": "名称", + "description": "描述", + "version": "版本", + "author": "作者", + "website": "网页", + "permissions": "权限", + "enabled": "已启用", + "status": "状态", + "path": "路径", + "lastError": "错误", + "hasError": "错误", + "updatedAt": "更新于", + "createdAt": "安装于", + "configKey": "键", + "configValue": "值", + "allUsers": "允许所有用户", + "selectedUsers": "指定用户", + "allLibraries": "允许所有媒体库", + "selectedLibraries": "指定媒体库", + "allowWriteAccess": "允许写入权限" + }, + "sections": { + "status": "状态", + "info": "插件信息", + "configuration": "配置", + "manifest": "清单", + "usersPermission": "用户权限", + "libraryPermission": "媒体库权限" + }, + "status": { + "enabled": "已启用", + "disabled": "已禁用" + }, + "actions": { + "enable": "启用", + "disable": "禁用", + "disabledDueToError": "需要在启用前解决错误", + "disabledUsersRequired": "需要在启用前选择用户", + "disabledLibrariesRequired": "需要在启用前选择媒体库", + "addConfig": "添加配置", + "rescan": "重新扫描" + }, + "notifications": { + "enabled": "插件已启用", + "disabled": "插件已禁用", + "updated": "插件已更新", + "error": "插件更新时出错" + }, + "validation": { + "invalidJson": "配置必须是有效的 JSON" + }, + "messages": { + "configHelp": "使用键值对配置插件。如果插件无需配置则留空。", + "configValidationError": "配置验证失败:", + "schemaRenderError": "无法渲染配置表单。此插件的 schema 定义可能无效。", + "clickPermissions": "点击权限以查看详情", + "noConfig": "未设定配置", + "allUsersHelp": "启用时,插件将可以访问所有用户,包括将来创建的。", + "noUsers": "未选择用户", + "permissionReason": "原因", + "usersRequired": "此插件需要访问用户信息。请选择允许此插件访问的用户, 或启用 '允许所有用户'。", + "allLibrariesHelp": "启用时,插件将可以访问所有媒体库,包括将来创建的。", + "noLibraries": "未选择媒体库", + "librariesRequired": "此插件需要访问媒体库信息。请选择允许此插件访问的媒体库, 或启用 '允许所有媒体库'。", + "allowWriteAccessHelp": "启用时,插件将可以修改媒体库目录中的文件。默认情况下,插件仅拥有只读权限。", + "requiredHosts": "必需的主机" + }, + "placeholders": { + "configKey": "键", + "configValue": "值" + } } -} \ No newline at end of file + }, + "ra": { + "auth": { + "welcome1": "感谢您安装 Navidrome!", + "welcome2": "开始使用前,请创建一个管理员账户", + "confirmPassword": "确认密码", + "buttonCreateAdmin": "创建管理员", + "auth_check_error": "请登录以继续", + "user_menu": "用户档案", + "username": "用户名", + "password": "密码", + "sign_in": "登录", + "sign_in_error": "验证失败,请重试", + "logout": "注销", + "insightsCollectionNote": "Navidrome 会收集匿名使用数据以帮助改进项目。\n点击[此处]了解详情或选择不参与收集。" + }, + "validation": { + "invalidChars": "请只使用字母和数字", + "passwordDoesNotMatch": "密码不匹配", + "required": "必填", + "minLength": "不得少于 %{min} 个字符", + "maxLength": "不得多于 %{max} 个字符", + "minValue": "不得小于 %{min}", + "maxValue": "不得大于 %{max}", + "number": "必须为数字", + "email": "必须为有效的电子邮箱", + "oneOf": "必须为: %{options} 其中一项", + "regex": "必须符合指定的格式(正则表达式):%{pattern}", + "unique": "必须唯一", + "url": "必须为有效的 URL" + }, + "action": { + "add_filter": "添加筛选", + "add": "添加", + "back": "返回", + "bulk_actions": "选中 %{smart_count} 项", + "bulk_actions_mobile": "%{smart_count}", + "cancel": "取消", + "clear_input_value": "清除", + "clone": "复制", + "confirm": "确认", + "create": "创建", + "delete": "删除", + "edit": "编辑", + "export": "导出", + "list": "列表", + "refresh": "刷新", + "remove_filter": "取消筛选", + "remove": "移除", + "save": "保存", + "search": "搜索", + "show": "显示", + "sort": "排序", + "undo": "撤销", + "expand": "展开", + "close": "关闭", + "open_menu": "打开菜单", + "close_menu": "关闭菜单", + "unselect": "取消选择", + "skip": "跳过", + "share": "分享", + "download": "下载" + }, + "boolean": { + "true": "是", + "false": "否" + }, + "page": { + "create": "创建%{name}", + "dashboard": "仪表盘", + "edit": "%{name} #%{id}", + "error": "发生错误", + "list": "%{name}", + "loading": "加载中", + "not_found": "未找到", + "show": "%{name} #%{id}", + "empty": "还没有%{name}。", + "invite": "您要创建一个吗?" + }, + "input": { + "file": { + "upload_several": "拖拽多个文件上传或点击以选择", + "upload_single": "拖拽文件上传或点击以选择" + }, + "image": { + "upload_several": "拖拽多个图片上传或点击以选择", + "upload_single": "拖拽图片上传或点击以选择" + }, + "references": { + "all_missing": "未找到引用数据", + "many_missing": "至少有一条关联的引用不再可用", + "single_missing": "关联的引用不再可用" + }, + "password": { + "toggle_visible": "隐藏密码", + "toggle_hidden": "显示密码" + } + }, + "message": { + "about": "关于", + "are_you_sure": "您确定要进行此操作?", + "bulk_delete_content": "您确定要删除这 %{smart_count} 项%{name}?", + "bulk_delete_title": "删除 %{smart_count} 项%{name}", + "delete_content": "您确定要删除此项?", + "delete_title": "删除 %{name} #%{id}", + "details": "详情", + "error": "发生一个客户端错误,您的请求无法完成", + "invalid_form": "提交内容无效,请检查错误", + "loading": "页面加载中,请稍候", + "no": "否", + "not_found": "您输入了错误的 URL,或 URL 无效", + "yes": "是", + "unsaved_changes": "某些更改尚未保存,您确定要忽视吗?" + }, + "navigation": { + "no_results": "未找到结果", + "no_more_results": "页码 %{page} 超出范围,尝试返回上一页", + "page_out_of_boundaries": "页码 %{page} 超出范围", + "page_out_from_end": "已经最后一页", + "page_out_from_begin": "已经是第一页", + "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", + "page_rows_per_page": "每页项目数:", + "next": "下一页", + "prev": "上一页", + "skip_nav": "跳转到内容" + }, + "notification": { + "updated": "项目已更新 |||| 已更新 %{smart_count} 项", + "created": "项目已创建", + "deleted": "项目已删除 |||| 已删除 %{smart_count} 项", + "bad_item": "不正确的项", + "item_doesnt_exist": "项目不存在", + "http_error": "与服务器通信出错", + "data_provider_error": "dataProvider 错误,请检查控制台以查看详情。", + "i18n_error": "加载所选语言时出错", + "canceled": "操作已取消", + "logged_out": "您的会话已结束,请重新登录。", + "new_version": "发现新版本!请刷新此页面。" + }, + "toggleFieldsMenu": { + "columnsToDisplay": "显示的列", + "layout": "布局", + "grid": "网格", + "table": "表格" + } + }, + "message": { + "uploadCover": "上传封面", + "removeCover": "移除封面", + "coverUploaded": "封面已上传", + "coverRemoved": "封面已移除", + "coverUploadError": "上传封面时出错", + "coverRemoveError": "移除封面时出错", + "note": "注意", + "transcodingDisabled": "出于安全原因,从 Web 界面更改转码配置的功能已被禁用。要更改(编辑或新增)转码选项,请在启用 %{config} 选项的情况下重新启动服务器。", + "transcodingEnabled": "Navidrome 当前与 %{config} 一起使用,可以通过从 Web 界面配置转码选项来执行任意命令。建议禁用此选项,并且仅在需要配置转码选项时启用此功能。", + "songsAddedToPlaylist": "已添加 %{smart_count} 首歌到歌单", + "noSimilarSongsFound": "未找到相似歌曲", + "startingInstantMix": "即兴推荐加载中...", + "noTopSongsFound": "未找到热门歌曲", + "noPlaylistsAvailable": "没有有效的歌单", + "delete_user_title": "删除用户%{name}", + "delete_user_content": "您确定要删除此用户及其相关数据(包括歌单和用户配置)吗?", + "remove_missing_title": "移除丢失文件", + "remove_missing_content": "您确定要从数据库中移除选中的丢失文件吗?这将永久删除对它们的所有引用,包括播放次数和评分。", + "remove_all_missing_title": "移除所有丢失文件", + "remove_all_missing_content": "您确定要从数据库中移除所有丢失文件吗?这将永久删除对它们的所有引用,包括播放次数和评分。", + "notifications_blocked": "您已在浏览器的设置中屏蔽了此网站的通知", + "notifications_not_available": "此浏览器不支持桌面通知,或者您未通过 https 访问 Navidrome", + "lastfmLinkSuccess": "Last.fm 成功关联并启用个性化记录", + "lastfmLinkFailure": "Last.fm 无法关联", + "lastfmUnlinkSuccess": "Last.fm 已取消关联并禁用个性化记录", + "lastfmUnlinkFailure": "Last.fm 无法取消关联", + "listenBrainzLinkSuccess": "ListenBrainz 成功关联并启用个性化记录,用户:%{user}", + "listenBrainzLinkFailure": "ListenBrainz 无法关联:%{error}", + "listenBrainzUnlinkSuccess": "ListenBrainz 已取消关联并禁用个性化记录", + "listenBrainzUnlinkFailure": "ListenBrainz 无法取消关联", + "openIn": { + "lastfm": "在 Last.fm 中打开", + "musicbrainz": "在 MusicBrainz 中打开" + }, + "lastfmLink": "查看更多…", + "shareOriginalFormat": "分享原始格式", + "shareDialogTitle": "分享 %{resource} '%{name}'", + "shareBatchDialogTitle": "分享 %{smart_count} 项 %{resource}", + "shareCopyToClipboard": "复制到剪切板: Ctrl+C, Enter", + "shareSuccess": "URL 已复制: %{url}", + "shareFailure": "URL 复制失败: %{url}", + "downloadDialogTitle": "下载 %{resource} '%{name}' (%{size})", + "downloadOriginalFormat": "下载原始格式" + }, + "menu": { + "library": "媒体库", + "librarySelector": { + "allLibraries": "全部媒体库 (%{count})", + "multipleLibraries": "已选 %{selected} 共 %{total} 个媒体库", + "selectLibraries": "选择媒体库", + "none": "无" + }, + "settings": "设置", + "version": "版本", + "theme": "主题", + "personal": { + "name": "个性化", + "options": { + "theme": "主题", + "language": "语言", + "defaultView": "默认视图", + "desktop_notifications": "桌面通知", + "lastfmNotConfigured": "未配置 Last.fm 的 API-Key", + "lastfmScrobbling": "启用 Last.fm 的个性化记录", + "listenBrainzScrobbling": "启用 ListenBrainz 的个性化记录", + "replaygain": "回放增益", + "preAmp": "前置放大器 (dB)", + "gain": { + "none": "禁用增益", + "album": "使用专辑增益信息", + "track": "使用歌曲增益信息" + } + } + }, + "albumList": "专辑", + "playlists": "歌单", + "sharedPlaylists": "共享的歌单", + "about": "关于" + }, + "player": { + "playListsText": "播放队列", + "openText": "打开", + "closeText": "关闭", + "notContentText": "没有音乐", + "clickToPlayText": "点击播放", + "clickToPauseText": "点击暂停", + "nextTrackText": "下一首", + "previousTrackText": "上一首", + "reloadText": "重新播放", + "volumeText": "音量", + "toggleLyricText": "切换歌词", + "toggleMiniModeText": "最小化", + "destroyText": "关闭", + "downloadText": "下载", + "removeAudioListsText": "清空播放队列", + "clickToDeleteText": "点击删除%{name}", + "emptyLyricText": "无歌词", + "playModeText": { + "order": "顺序播放", + "orderLoop": "列表循环", + "singleLoop": "单曲循环", + "shufflePlay": "随机播放" + } + }, + "about": { + "links": { + "homepage": "主页", + "source": "源代码", + "featureRequests": "功能需求", + "lastInsightsCollection": "最近的分析收集", + "insights": { + "disabled": "禁用", + "waiting": "等待" + } + }, + "tabs": { + "about": "关于", + "config": "配置" + }, + "config": { + "configName": "配置名称", + "environmentVariable": "环境变量", + "currentValue": "当前值", + "configurationFile": "配置文件", + "exportToml": "导出配置(TOML)", + "downloadToml": "下载配置(TOML)", + "exportSuccess": "配置以 TOML 格式导出到剪贴板完成", + "exportFailed": "复制配置失败", + "devFlagsHeader": "开发标志(可能会更改/删除)", + "devFlagsComment": "这些是实验性设置,可能会在未来版本中删除" + } + }, + "activity": { + "title": "运行情况", + "totalScanned": "已完成扫描的文件夹", + "quickScan": "快速扫描", + "fullScan": "完全扫描", + "selectiveScan": "选择性扫描", + "serverUptime": "服务器已运行", + "serverDown": "服务器已离线", + "scanType": "上次扫描", + "status": "扫描错误", + "elapsedTime": "用时" + }, + "nowPlaying": { + "title": "正在播放", + "empty": "无播放内容", + "minutesAgo": "%{smart_count} 分钟前" + }, + "help": { + "title": "Navidrome 快捷键", + "hotkeys": { + "show_help": "显示此帮助", + "toggle_menu": "显示/隐藏菜单侧栏", + "toggle_play": "播放/暂停", + "prev_song": "上一首", + "next_song": "下一首", + "current_song": "转到当前播放", + "vol_up": "增大音量", + "vol_down": "减小音量", + "toggle_love": "添加/移除收藏" + } + } +} diff --git a/resources/i18n/zh-Hant.json b/resources/i18n/zh-Hant.json index 3d6bbd268..d00ae2ac3 100644 --- a/resources/i18n/zh-Hant.json +++ b/resources/i18n/zh-Hant.json @@ -1,463 +1,723 @@ { - "languageName": "繁體中文", - "resources": { - "song": { - "name": "歌曲 |||| 歌曲", - "fields": { - "albumArtist": "專輯藝人", - "duration": "長度", - "trackNumber": "#", - "playCount": "播放次數", - "title": "標題", - "artist": "藝人", - "album": "專輯", - "path": "文件路徑", - "genre": "類型", - "compilation": "合輯", - "year": "發行年份", - "size": "檔案大小", - "updatedAt": "更新於", - "bitRate": "位元率", - "discSubtitle": "字幕", - "starred": "收藏", - "comment": "註解", - "rating": "評分", - "quality": "品質", - "bpm": "BPM", - "playDate": "上次播放", - "channels": "聲道", - "createdAt": "創建於" - }, - "actions": { - "addToQueue": "加入至播放佇列", - "playNow": "立即播放", - "addToPlaylist": "加入至播放清單", - "shuffleAll": "全部隨機播放", - "download": "下載", - "playNext": "下一首播放", - "info": "取得資訊" - } - }, - "album": { - "name": "專輯 |||| 專輯", - "fields": { - "albumArtist": "專輯藝人", - "artist": "藝人", - "duration": "長度", - "songCount": "歌曲數量", - "playCount": "播放次數", - "name": "名稱", - "genre": "類型", - "compilation": "合輯", - "year": "發行年份", - "updatedAt": "更新於", - "comment": "註解", - "rating": "評分", - "createdAt": "創建於", - "size": "檔案大小", - "originalDate": "原始日期", - "releaseDate": "發行日期", - "releases": "發行", - "released": "已發行" - }, - "actions": { - "playAll": "立即播放", - "playNext": "下首播放", - "addToQueue": "加入至播放佇列", - "shuffle": "隨機播放", - "addToPlaylist": "加入播放清單", - "download": "下載", - "info": "取得資訊", - "share": "分享" - }, - "lists": { - "all": "所有", - "random": "隨機", - "recentlyAdded": "最近加入", - "recentlyPlayed": "最近播放", - "mostPlayed": "最多播放的", - "starred": "收藏", - "topRated": "最高評分" - } - }, - "artist": { - "name": "藝人 |||| 藝人", - "fields": { - "name": "名稱", - "albumCount": "專輯數", - "songCount": "歌曲數", - "playCount": "播放次數", - "rating": "評分", - "genre": "類型", - "size": "檔案大小" - } - }, - "user": { - "name": "使用者 |||| 使用者", - "fields": { - "userName": "使用者名稱", - "isAdmin": "是否管理員", - "lastLoginAt": "上次登入", - "lastAccessAt": "上此訪問", - "updatedAt": "更新於", - "name": "名稱", - "password": "密碼", - "createdAt": "創建於", - "changePassword": "變更密碼?", - "currentPassword": "現在的密碼", - "newPassword": "新密碼", - "token": "權杖" - }, - "helperTexts": { - "name": "你的名稱會在下次登入時生效" - }, - "notifications": { - "created": "使用者已創建", - "updated": "使用者已更新", - "deleted": "使用者已刪除" - }, - "message": { - "listenBrainzToken": "輸入您的 ListenBrainz 使用者權杖", - "clickHereForToken": "點擊此處來獲得你的 ListenBrainz 權杖" - } - }, - "player": { - "name": "用戶端 |||| 用戶端", - "fields": { - "name": "名稱", - "transcodingId": "轉碼", - "maxBitRate": "最大位元率", - "client": "用戶端", - "userName": "使用者名稱", - "lastSeen": "上次瀏覽", - "reportRealPath": "回報實際路徑", - "scrobbleEnabled": "傳送音樂記錄至外部服務" - } - }, - "transcoding": { - "name": "轉碼 |||| 轉碼", - "fields": { - "name": "名稱", - "targetFormat": "目標格式", - "defaultBitRate": "預設位元率", - "command": "命令" - } - }, - "playlist": { - "name": "播放清單 |||| 播放清單", - "fields": { - "name": "名稱", - "duration": "長度", - "ownerName": "擁有者", - "public": "公開", - "updatedAt": "更新於", - "createdAt": "創建於", - "songCount": "歌曲數", - "comment": "註解", - "sync": "自動導入", - "path": "導入" - }, - "actions": { - "selectPlaylist": "選擇播放清單", - "addNewPlaylist": "創建 %{name}", - "export": "導出", - "makePublic": "設為公開", - "makePrivate": "設為私人" - }, - "message": { - "duplicate_song": "加入重複的歌曲", - "song_exist": "有重複歌曲正在播放清單裡,您要加入或略過重複歌曲?" - } - }, - "radio": { - "name": "電台", - "fields": { - "name": "名稱", - "streamUrl": "串流網址", - "homePageUrl": "首頁網址", - "updatedAt": "更新於", - "createdAt": "創建於" - }, - "actions": { - "playNow": "立即播放" - } - }, - "share": { - "name": "分享", - "fields": { - "username": "使用者名稱", - "url": "網址", - "description": "描述", - "contents": "內容", - "expiresAt": "過期時間", - "lastVisitedAt": "上次訪問時間", - "visitCount": "訪問次數", - "format": "格式", - "maxBitRate": "最大位元率", - "updatedAt": "更新於", - "createdAt": "創建於", - "downloadable": "可下載" - }, - "notifications": {}, - "actions": {} - } + "languageName": "繁體中文", + "resources": { + "song": { + "name": "歌曲 |||| 歌曲", + "fields": { + "albumArtist": "專輯藝人", + "duration": "長度", + "trackNumber": "#", + "playCount": "播放次數", + "title": "標題", + "artist": "藝人", + "album": "專輯", + "path": "檔案路徑", + "genre": "曲風", + "compilation": "合輯", + "year": "發行年份", + "size": "檔案大小", + "updatedAt": "更新於", + "bitRate": "位元率", + "discSubtitle": "光碟副標題", + "starred": "收藏", + "comment": "註解", + "rating": "評分", + "quality": "品質", + "bpm": "BPM", + "playDate": "上次播放", + "channels": "聲道", + "createdAt": "建立於", + "grouping": "分組", + "mood": "情緒", + "participants": "其他參與人員", + "tags": "額外標籤", + "mappedTags": "分類後標籤", + "rawTags": "原始標籤", + "bitDepth": "位元深度", + "sampleRate": "取樣率", + "missing": "遺失", + "libraryName": "媒體庫", + "composer": "作曲者", + "disc": "光碟 %{discNumber}", + "albumGain": "專輯增益", + "trackGain": "曲目增益" + }, + "actions": { + "addToQueue": "加入至播放佇列", + "playNow": "立即播放", + "addToPlaylist": "加入至播放清單", + "shuffleAll": "全部隨機播放", + "download": "下載", + "playNext": "下一首播放", + "info": "取得資訊", + "showInPlaylist": "在播放清單中顯示", + "instantMix": "即時混音" + } }, - "ra": { - "auth": { - "welcome1": "感謝您安裝 Navidrome!", - "welcome2": "開始前,請創建一個管理員帳戶", - "confirmPassword": "確認密碼", - "buttonCreateAdmin": "創建管理員", - "auth_check_error": "請登入以訪問更多內容", - "user_menu": "配置", - "username": "使用者名稱", - "password": "密碼", - "sign_in": "登入", - "sign_in_error": "驗證失敗,請重試", - "logout": "登出" - }, - "validation": { - "invalidChars": "請使用字母和數字", - "passwordDoesNotMatch": "密碼不相符", - "required": "必填", - "minLength": "必須不少於 %{min} 個字元", - "maxLength": "必須不多於 %{max} 個字元", - "minValue": "必須不小於 %{min}", - "maxValue": "必須不大於 %{max}", - "number": "必須為數字", - "email": "必須是有效的電子郵件", - "oneOf": "必須為: %{options}其中一項", - "regex": "必須符合指定的格式(正規表達式):%{pattern}", - "unique": "必須是唯一的", - "url": "網址" - }, - "action": { - "add_filter": "加入篩選", - "add": "加入", - "back": "返回", - "bulk_actions": "選中 %{smart_count} 項", - "cancel": "取消", - "clear_input_value": "清除", - "clone": "複製", - "confirm": "確認", - "create": "創建", - "delete": "刪除", - "edit": "編輯", - "export": "匯出", - "list": "列表", - "refresh": "重新整理", - "remove_filter": "清除此條件", - "remove": "清除", - "save": "保存", - "search": "搜尋", - "show": "顯示", - "sort": "排序", - "undo": "撤銷", - "expand": "展開", - "close": "關閉", - "open_menu": "打開選單", - "close_menu": "關閉選單", - "unselect": "未選擇", - "skip": "略過", - "bulk_actions_mobile": "%{smart_count}", - "share": "分享", - "download": "下載" - }, - "boolean": { - "true": "是", - "false": "否" - }, - "page": { - "create": "創建 %{name}", - "dashboard": "儀表板", - "edit": "%{name} #%{id}", - "error": "發生錯誤", - "list": "%{name}", - "loading": "載入中", - "not_found": "未發現", - "show": "%{name} #%{id}", - "empty": "還沒有 %{name}。", - "invite": "你要創建一個嗎?" - }, - "input": { - "file": { - "upload_several": "拖拽多個文件上傳或點擊選擇一個", - "upload_single": "拖拽單個文件上傳或點擊選擇一個" - }, - "image": { - "upload_several": "拖拽多個圖片上傳或點擊選擇一個", - "upload_single": "拖拽單個圖片上傳或點擊選擇一個" - }, - "references": { - "all_missing": "未找到參考數據", - "many_missing": "至少有一條參考數據不再可用", - "single_missing": "關聯的參考數據不再可用" - }, - "password": { - "toggle_visible": "隱藏密碼", - "toggle_hidden": "顯示密碼" - } - }, - "message": { - "about": "關於", - "are_you_sure": "確定進行此操作?", - "bulk_delete_content": "您確定要刪除 %{name}? |||| 您確定要刪除 %{smart_count} 項?", - "bulk_delete_title": "刪除 %{name} |||| 刪除 %{smart_count} 項 %{name}", - "delete_content": "您確定要刪除該項目?", - "delete_title": "刪除 %{name} #%{id}", - "details": "詳細資訊", - "error": "發生一個用戶端錯誤,您的請求無法完成", - "invalid_form": "提交內容無效,請檢查錯誤", - "loading": "正在載入頁面,請稍候", - "no": "否", - "not_found": "您輸入的連結格式不對或連結遺失", - "yes": "是", - "unsaved_changes": "某些更改尚未保存,您確定要離開此頁面嗎?" - }, - "navigation": { - "no_results": "無內容", - "no_more_results": "頁碼 %{page} 超出邊界,嘗試返回上一頁", - "page_out_of_boundaries": "頁碼 %{page} 超出邊界", - "page_out_from_end": "已經最後一頁", - "page_out_from_begin": "已經是第一頁", - "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", - "page_rows_per_page": "每頁行數:", - "next": "下一頁", - "prev": "上一頁", - "skip_nav": "跳過" - }, - "notification": { - "updated": "項已更新 |||| %{smart_count} 項已更新", - "created": "項已創建", - "deleted": "項已刪除 |||| %{smart_count} 項已刪除", - "bad_item": "不確定的項", - "item_doesnt_exist": "項不存在", - "http_error": "伺服器通訊錯誤", - "data_provider_error": "資料來源錯誤,請檢查控制台的詳細資訊", - "i18n_error": "無法載入所選語言", - "canceled": "操作已取消", - "logged_out": "您的會話已結束,請重新登入", - "new_version": "發現新版本!請重新整理視窗" - }, - "toggleFieldsMenu": { - "columnsToDisplay": "顯示欄目", - "layout": "版面", - "grid": "框格", - "table": "表格" - } + "album": { + "name": "專輯 |||| 專輯", + "fields": { + "albumArtist": "專輯藝人", + "artist": "藝人", + "duration": "長度", + "songCount": "歌曲數", + "playCount": "播放次數", + "name": "名稱", + "genre": "曲風", + "compilation": "合輯", + "year": "發行年份", + "updatedAt": "更新於", + "comment": "註解", + "rating": "評分", + "createdAt": "建立於", + "size": "檔案大小", + "originalDate": "原始日期", + "releaseDate": "發行日期", + "releases": "發行", + "released": "已發行", + "recordLabel": "唱片公司", + "catalogNum": "目錄編號", + "releaseType": "發行類型", + "grouping": "分組", + "media": "媒體類型", + "mood": "情緒", + "date": "錄製日期", + "missing": "遺失", + "libraryName": "媒體庫" + }, + "actions": { + "playAll": "播放全部", + "playNext": "下一首播放", + "addToQueue": "加入至播放佇列", + "shuffle": "隨機播放", + "addToPlaylist": "加入至播放清單", + "download": "下載", + "info": "取得資訊", + "share": "分享" + }, + "lists": { + "all": "所有", + "random": "隨機", + "recentlyAdded": "最近加入", + "recentlyPlayed": "最近播放", + "mostPlayed": "最常播放", + "starred": "收藏", + "topRated": "最高評分" + } }, - "message": { - "note": "註解", - "transcodingDisabled": "出於安全原因,禁用了從 Web 介面更改參數。要更改(編輯或新增)轉檔選項,請在啟用 %{config} 選項的情況下重新啟動伺服器。", - "transcodingEnabled": "Navidrome 當前與 %{config} 一起使用,可以通過配置轉檔參數執行任意命令,建議僅在配置轉檔選項時啟用此功能。", - "songsAddedToPlaylist": "已加入一首歌到播放清單 |||| 已添加 %{smart_count} 首歌到播放清單", - "noPlaylistsAvailable": "沒有可用的播放清單", - "delete_user_title": "刪除使用者 %{name}", - "delete_user_content": "您確定要刪除該使用者及其相關數據(包括播放清單和使用者配置)嗎?", - "notifications_blocked": "您已在瀏覽器的設置中封鎖了此網站的通知", - "notifications_not_available": "此瀏覽器不支援桌面通知", - "lastfmLinkSuccess": "Last.fm 成功連接並開啟音樂記錄", - "lastfmLinkFailure": "Last.fm 無法連接", - "lastfmUnlinkSuccess": "Last.fm 已無連接並停用音樂記錄", - "lastfmUnlinkFailure": "Last.fm 無法取消連接", - "openIn": { - "lastfm": "在 Last.fm 打開", - "musicbrainz": "在 MusicBrainz 打開" - }, - "lastfmLink": "繼續閱讀…", - "listenBrainzLinkSuccess": "ListenBrainz 成功連接並開啟音樂記錄", - "listenBrainzLinkFailure": "ListenBrainz 無法連接:%{error}", - "listenBrainzUnlinkSuccess": "ListenBrainz 已無連接並停用音樂記錄", - "listenBrainzUnlinkFailure": "ListenBrainz 無法取消連接", - "downloadOriginalFormat": "下載原始格式", - "shareOriginalFormat": "分享原始格式", - "shareDialogTitle": "分享", - "shareBatchDialogTitle": "批次分享", - "shareSuccess": "分享成功", - "shareFailure": "分享失敗", - "downloadDialogTitle": "下載", - "shareCopyToClipboard": "複製到剪貼簿" + "artist": { + "name": "藝人 |||| 藝人", + "fields": { + "name": "名稱", + "albumCount": "專輯數", + "songCount": "歌曲數", + "playCount": "播放次數", + "rating": "評分", + "genre": "曲風", + "size": "檔案大小", + "role": "參與角色", + "missing": "遺失" + }, + "roles": { + "albumartist": "專輯藝人 |||| 專輯藝人", + "artist": "藝人 |||| 藝人", + "composer": "作曲 |||| 作曲", + "conductor": "指揮 |||| 指揮", + "lyricist": "作詞 |||| 作詞", + "arranger": "編曲 |||| 編曲", + "producer": "製作人 |||| 製作人", + "director": "導演 |||| 導演", + "engineer": "工程師 |||| 工程師", + "mixer": "混音師 |||| 混音師", + "remixer": "重混師 |||| 重混師", + "djmixer": "DJ 混音師 |||| DJ 混音師", + "performer": "表演者 |||| 表演者", + "maincredit": "專輯藝人或藝人 |||| 專輯藝人或藝人" + }, + "actions": { + "shuffle": "隨機播放", + "radio": "電台", + "topSongs": "熱門歌曲" + } }, - "menu": { - "library": "音樂庫", - "settings": "設定", - "version": "版本", - "theme": "主題", - "personal": { - "name": "個人化", - "options": { - "theme": "主題", - "language": "語言", - "defaultView": "預設畫面", - "desktop_notifications": "桌面通知", - "lastfmScrobbling": "啟用 Last.fm 音樂記錄", - "listenBrainzScrobbling": "啟用 ListenBrainz 音樂記錄", - "replaygain": "重播增益", - "preAmp": "前置放大器 (dB)", - "gain": { - "none": "無", - "album": "專輯增益", - "track": "曲目增益" - } - } - }, - "albumList": "專輯", - "about": "關於", - "playlists": "播放清單", - "sharedPlaylists": "分享的播放清單" + "user": { + "name": "使用者 |||| 使用者", + "fields": { + "userName": "使用者名稱", + "isAdmin": "管理員", + "lastLoginAt": "上次登入", + "updatedAt": "更新於", + "name": "名稱", + "password": "密碼", + "createdAt": "建立於", + "changePassword": "變更密碼?", + "currentPassword": "目前密碼", + "newPassword": "新密碼", + "token": "權杖", + "lastAccessAt": "上次存取", + "libraries": "媒體庫" + }, + "helperTexts": { + "name": "您的名稱會在下次登入時生效", + "libraries": "為該使用者選擇指定媒體庫,留空則使用預設媒體庫" + }, + "notifications": { + "created": "使用者已建立", + "updated": "使用者已更新", + "deleted": "使用者已刪除" + }, + "message": { + "listenBrainzToken": "輸入您的 ListenBrainz 使用者權杖", + "clickHereForToken": "點擊此處來獲得您的 ListenBrainz 權杖", + "selectAllLibraries": "選取全部媒體庫", + "adminAutoLibraries": "管理員預設可存取所有媒體庫" + }, + "validation": { + "librariesRequired": "非管理員使用者必須至少選擇一個媒體庫" + } }, "player": { - "playListsText": "播放佇列", - "openText": "打開", - "closeText": "關閉", - "notContentText": "沒有音樂", - "clickToPlayText": "點擊播放", - "clickToPauseText": "點擊暫停", - "nextTrackText": "下一首", - "previousTrackText": "上一首", - "reloadText": "重新播放", - "volumeText": "音量", - "toggleLyricText": "切換歌詞", - "toggleMiniModeText": "最小化", - "destroyText": "關閉", - "downloadText": "下載", - "removeAudioListsText": "清空播放佇列", - "clickToDeleteText": "點擊刪除 %{name}", - "emptyLyricText": "無歌詞", - "playModeText": { - "order": "順序播放", - "orderLoop": "列表循環", - "singleLoop": "單曲循環", - "shufflePlay": "隨機播放" - } + "name": "播放器 |||| 播放器", + "fields": { + "name": "名稱", + "transcodingId": "轉碼", + "maxBitRate": "最大位元率", + "client": "用戶端", + "userName": "使用者名稱", + "lastSeen": "上次上線", + "reportRealPath": "回報實際路徑", + "scrobbleEnabled": "傳送音樂記錄至外部服務" + } }, - "about": { - "links": { - "homepage": "主頁", - "source": "原始碼", - "featureRequests": "功能請求" - } + "transcoding": { + "name": "轉碼 |||| 轉碼", + "fields": { + "name": "名稱", + "targetFormat": "目標格式", + "defaultBitRate": "預設位元率", + "command": "指令" + } }, - "activity": { - "title": "運作狀況", - "totalScanned": "已完成掃描的目錄", + "playlist": { + "name": "播放清單 |||| 播放清單", + "fields": { + "name": "名稱", + "duration": "長度", + "ownerName": "擁有者", + "public": "公開", + "updatedAt": "更新於", + "createdAt": "建立於", + "songCount": "歌曲數", + "comment": "註解", + "sync": "自動匯入", + "path": "匯入來源" + }, + "actions": { + "selectPlaylist": "選取播放清單:", + "addNewPlaylist": "建立「%{name}」", + "export": "匯出", + "makePublic": "設為公開", + "makePrivate": "設為私人", + "saveQueue": "將播放佇列儲存到播放清單", + "searchOrCreate": "搜尋播放清單,或輸入名稱來新建…", + "pressEnterToCreate": "按 Enter 鍵建立新的播放清單", + "removeFromSelection": "移除選取項目" + }, + "message": { + "duplicate_song": "加入重複的歌曲", + "song_exist": "有重複歌曲正要加入播放清單,您要加入或略過重複歌曲?", + "noPlaylistsFound": "找不到播放清單", + "noPlaylists": "暫無播放清單" + } + }, + "radio": { + "name": "電台 |||| 電台", + "fields": { + "name": "名稱", + "streamUrl": "串流網址", + "homePageUrl": "首頁網址", + "updatedAt": "更新於", + "createdAt": "建立於" + }, + "actions": { + "playNow": "立即播放" + } + }, + "share": { + "name": "分享 |||| 分享", + "fields": { + "username": "分享者", + "url": "網址", + "description": "描述", + "contents": "內容", + "expiresAt": "過期時間", + "lastVisitedAt": "上次造訪時間", + "visitCount": "造訪次數", + "format": "格式", + "maxBitRate": "最大位元率", + "updatedAt": "更新於", + "createdAt": "建立於", + "downloadable": "允許下載?" + } + }, + "missing": { + "name": "遺失檔案 |||| 遺失檔案", + "fields": { + "path": "路徑", + "size": "檔案大小", + "updatedAt": "遺失於", + "libraryName": "媒體庫" + }, + "actions": { + "remove": "刪除", + "remove_all": "刪除所有" + }, + "notifications": { + "removed": "遺失檔案已刪除" + }, + "empty": "無遺失檔案" + }, + "library": { + "name": "媒體庫 |||| 媒體庫", + "fields": { + "name": "名稱", + "path": "路徑", + "remotePath": "遠端路徑", + "lastScanAt": "上次掃描", + "songCount": "歌曲", + "albumCount": "專輯", + "artistCount": "藝人", + "totalSongs": "歌曲", + "totalAlbums": "專輯", + "totalArtists": "藝人", + "totalFolders": "資料夾", + "totalFiles": "檔案", + "totalMissingFiles": "遺失檔案", + "totalSize": "總大小", + "totalDuration": "時長", + "defaultNewUsers": "新使用者預設媒體庫", + "createdAt": "建立於", + "updatedAt": "更新於" + }, + "sections": { + "basic": "基本資訊", + "statistics": "統計" + }, + "actions": { + "scan": "掃描媒體庫", + "manageUsers": "管理使用者權限", + "viewDetails": "查看詳細資料", "quickScan": "快速掃描", - "fullScan": "完全掃描", - "serverUptime": "伺服器已運作時間", - "serverDown": "伺服器離線" + "fullScan": "完整掃描" + }, + "notifications": { + "created": "成功建立媒體庫", + "updated": "成功更新媒體庫", + "deleted": "成功刪除媒體庫", + "scanStarted": "開始掃描媒體庫", + "scanCompleted": "媒體庫掃描完成", + "quickScanStarted": "快速掃描已開始", + "fullScanStarted": "完整掃描已開始", + "scanError": "掃描啟動失敗,請檢查日誌" + }, + "validation": { + "nameRequired": "請輸入媒體庫名稱", + "pathRequired": "請提供媒體庫路徑", + "pathNotDirectory": "媒體庫路徑必須為目錄", + "pathNotFound": "媒體庫路徑不存在", + "pathNotAccessible": "無法存取媒體庫路徑", + "pathInvalid": "媒體庫路徑無效" + }, + "messages": { + "deleteConfirm": "您確定要刪除此媒體庫嗎?這將刪除所有相關資料和使用者存取權限。", + "scanInProgress": "正在掃描...", + "noLibrariesAssigned": "沒有為該使用者指派任何媒體庫" + } }, - "help": { - "title": "Navidrome 快捷鍵", - "hotkeys": { - "show_help": "顯示此幫助", - "toggle_menu": "顯示/隱藏選單側欄", - "toggle_play": "播放/暫停", - "prev_song": "上一首歌", - "next_song": "下一首歌", - "vol_up": "提高音量", - "vol_down": "降低音量", - "toggle_love": "添加或移除星標", - "current_song": "目前歌曲" - } + "plugin": { + "name": "外掛 |||| 外掛", + "fields": { + "id": "ID", + "name": "名稱", + "description": "描述", + "version": "版本", + "author": "作者", + "website": "網站", + "permissions": "權限", + "enabled": "已啟用", + "status": "狀態", + "path": "路徑", + "lastError": "錯誤", + "hasError": "錯誤", + "updatedAt": "更新於", + "createdAt": "安裝於", + "configKey": "鍵", + "configValue": "值", + "allUsers": "允許所有使用者", + "selectedUsers": "選定的使用者", + "allLibraries": "允許所有媒體庫", + "selectedLibraries": "選定的媒體庫", + "allowWriteAccess": "允許寫入權限" + }, + "sections": { + "status": "狀態", + "info": "外掛資訊", + "configuration": "設定", + "manifest": "資訊清單", + "usersPermission": "使用者權限", + "libraryPermission": "媒體庫權限" + }, + "status": { + "enabled": "已啟用", + "disabled": "已停用" + }, + "actions": { + "enable": "啟用", + "disable": "停用", + "disabledDueToError": "修復錯誤後才能啟用", + "disabledUsersRequired": "啟用前請先選擇使用者", + "disabledLibrariesRequired": "啟用前請先選擇媒體庫", + "addConfig": "新增設定", + "rescan": "重新掃描" + }, + "notifications": { + "enabled": "外掛已啟用", + "disabled": "外掛已停用", + "updated": "外掛已更新", + "error": "更新外掛時發生錯誤" + }, + "validation": { + "invalidJson": "設定必須是有效的 JSON" + }, + "messages": { + "configHelp": "使用鍵值對設定外掛。若外掛無需設定則留空。", + "clickPermissions": "點擊權限以查看詳細資訊", + "noConfig": "無設定", + "allUsersHelp": "啟用後,外掛將可存取所有使用者,包含未來建立的使用者。", + "noUsers": "未選擇使用者", + "permissionReason": "原因", + "usersRequired": "此外掛需要存取使用者資訊。請選擇外掛可存取的使用者,或啟用「允許所有使用者」。", + "allLibrariesHelp": "啟用後,外掛將可存取所有媒體庫,包含未來建立的媒體庫。", + "noLibraries": "未選擇媒體庫", + "librariesRequired": "此外掛需要存取媒體庫資訊。請選擇外掛可存取的媒體庫,或啟用「允許所有媒體庫」。", + "requiredHosts": "必要的 Hosts", + "configValidationError": "設定驗證失敗:", + "schemaRenderError": "無法顯示設定表單。外掛的 schema 可能無效。", + "allowWriteAccessHelp": "啟用後,外掛可以修改媒體庫目錄中的檔案。 預設情況下,外掛具有唯讀權限。" + }, + "placeholders": { + "configKey": "鍵", + "configValue": "值" + } } -} + }, + "ra": { + "auth": { + "welcome1": "感謝您安裝 Navidrome!", + "welcome2": "開始前,請先建立一個管理員帳號", + "confirmPassword": "確認密碼", + "buttonCreateAdmin": "建立管理員", + "auth_check_error": "請登入以繼續", + "user_menu": "個人檔案", + "username": "使用者名稱", + "password": "密碼", + "sign_in": "登入", + "sign_in_error": "驗證失敗,請重試", + "logout": "登出", + "insightsCollectionNote": "Navidrome 會收集匿名使用資料以協助改善項目。\n點擊[此處]了解更多資訊或選擇退出。" + }, + "validation": { + "invalidChars": "請使用字母和數字", + "passwordDoesNotMatch": "密碼不相符", + "required": "必填", + "minLength": "必須不少於 %{min} 個字元", + "maxLength": "必須不多於 %{max} 個字元", + "minValue": "必須不小於 %{min}", + "maxValue": "必須不大於 %{max}", + "number": "必須為數字", + "email": "必須為有效的電子郵件", + "oneOf": "必須為以下其中一項:%{options}", + "regex": "必須符合指定的格式(正規表達式):%{pattern}", + "unique": "必須是唯一的", + "url": "必須為有效的網址" + }, + "action": { + "add_filter": "加入篩選", + "add": "加入", + "back": "返回", + "bulk_actions": "選中 1 項 |||| 選中 %{smart_count} 項", + "cancel": "取消", + "clear_input_value": "清除", + "clone": "複製", + "confirm": "確認", + "create": "建立", + "delete": "刪除", + "edit": "編輯", + "export": "匯出", + "list": "清單", + "refresh": "重新整理", + "remove_filter": "清除此條件", + "remove": "移除", + "save": "儲存", + "search": "搜尋", + "show": "顯示", + "sort": "排序", + "undo": "復原", + "expand": "展開", + "close": "關閉", + "open_menu": "開啟選單", + "close_menu": "關閉選單", + "unselect": "取消選取", + "skip": "略過", + "bulk_actions_mobile": "1 |||| %{smart_count}", + "share": "分享", + "download": "下載" + }, + "boolean": { + "true": "是", + "false": "否" + }, + "page": { + "create": "建立 %{name}", + "dashboard": "儀表板", + "edit": "%{name} #%{id}", + "error": "發生錯誤", + "list": "%{name}", + "loading": "載入中", + "not_found": "找不到", + "show": "%{name} #%{id}", + "empty": "還沒有 %{name}。", + "invite": "您要建立一個嗎?" + }, + "input": { + "file": { + "upload_several": "拖曳多個檔案上傳或點擊選擇一個", + "upload_single": "拖曳單個檔案上傳或點擊選擇一個" + }, + "image": { + "upload_several": "拖曳多個圖片上傳或點擊選擇一個", + "upload_single": "拖曳單個圖片上傳或點擊選擇一個" + }, + "references": { + "all_missing": "未找到參考資料", + "many_missing": "至少有一條參考資料不再可用", + "single_missing": "關聯的參考資料不再可用" + }, + "password": { + "toggle_visible": "隱藏密碼", + "toggle_hidden": "顯示密碼" + } + }, + "message": { + "about": "關於", + "are_you_sure": "您確定嗎?", + "bulk_delete_content": "您確定要刪除 %{name}? |||| 您確定要刪除這 %{smart_count} 個項目嗎?", + "bulk_delete_title": "刪除 %{name} |||| 刪除 %{smart_count} 項 %{name}", + "delete_content": "您確定要刪除該項目?", + "delete_title": "刪除 %{name} #%{id}", + "details": "詳細資訊", + "error": "發生用戶端錯誤,您的請求無法完成", + "invalid_form": "提交內容無效,請檢查錯誤", + "loading": "正在載入頁面,請稍候", + "no": "否", + "not_found": "您輸入了錯誤的連結或連結遺失", + "yes": "是", + "unsaved_changes": "某些更改尚未儲存,您確定要離開此頁面嗎?" + }, + "navigation": { + "no_results": "沒有找到結果", + "no_more_results": "頁碼 %{page} 超出邊界,嘗試返回上一頁", + "page_out_of_boundaries": "頁碼 %{page} 超出邊界", + "page_out_from_end": "已經是最後一頁", + "page_out_from_begin": "已經是第一頁", + "page_range_info": "%{offsetBegin}-%{offsetEnd} / %{total}", + "page_rows_per_page": "每頁項目數:", + "next": "下一頁", + "prev": "上一頁", + "skip_nav": "跳至內容" + }, + "notification": { + "updated": "項目已更新 |||| %{smart_count} 項已更新", + "created": "項目已建立", + "deleted": "項目已刪除 |||| %{smart_count} 項已刪除", + "bad_item": "項目不正確", + "item_doesnt_exist": "項目不存在", + "http_error": "伺服器通訊錯誤", + "data_provider_error": "資料來源錯誤,請檢查控制台的詳細資訊", + "i18n_error": "無法載入所選語言", + "canceled": "操作已取消", + "logged_out": "您的工作階段已結束,請重新登入", + "new_version": "發現新版本!請重新整理視窗" + }, + "toggleFieldsMenu": { + "columnsToDisplay": "顯示欄位", + "layout": "版面", + "grid": "網格", + "table": "表格" + } + }, + "message": { + "note": "注意", + "transcodingDisabled": "出於安全原因,已禁用了從 Web 介面更改參數。要更改(編輯或新增)轉碼選項,請在啟用 %{config} 設定選項的情況下重新啟動伺服器。", + "transcodingEnabled": "Navidrome 目前與 %{config} 一起使用,因此可以透過 Web 介面從轉碼設定中執行系統命令。出於安全考慮,我們建議停用此功能,並僅在設定轉碼選項時啟用。", + "songsAddedToPlaylist": "已加入一首歌到播放清單 |||| 已新增 %{smart_count} 首歌到播放清單", + "noPlaylistsAvailable": "沒有可用的播放清單", + "delete_user_title": "刪除使用者「%{name}」", + "delete_user_content": "您確定要刪除此使用者及其所有資料(包括播放清單和偏好設定)嗎?", + "notifications_blocked": "您已在瀏覽器設定中封鎖了此網站的通知", + "notifications_not_available": "此瀏覽器不支援桌面通知,或您並非透過 HTTPS 存取 Navidrome", + "lastfmLinkSuccess": "已成功連結 Last.fm 並開啟音樂記錄", + "lastfmLinkFailure": "無法連結 Last.fm", + "lastfmUnlinkSuccess": "已取消與 Last.fm 的連結並停用音樂記錄", + "lastfmUnlinkFailure": "無法取消與 Last.fm 的連結", + "openIn": { + "lastfm": "在 Last.fm 中開啟", + "musicbrainz": "在 MusicBrainz 中開啟" + }, + "lastfmLink": "查看更多…", + "listenBrainzLinkSuccess": "已成功以 %{user} 的身份連結 ListenBrainz 並開啟音樂記錄", + "listenBrainzLinkFailure": "無法連結 ListenBrainz:%{error}", + "listenBrainzUnlinkSuccess": "已取消與 ListenBrainz 的連結並停用音樂記錄", + "listenBrainzUnlinkFailure": "無法取消與 ListenBrainz 的連結", + "downloadOriginalFormat": "下載原始格式", + "shareOriginalFormat": "分享原始格式", + "shareDialogTitle": "分享 %{resource} '%{name}'", + "shareBatchDialogTitle": "分享 1 個%{resource} |||| 分享 %{smart_count} 個%{resource}", + "shareSuccess": "分享成功,連結已複製到剪貼簿:%{url}", + "shareFailure": "分享連結複製失敗:%{url}", + "downloadDialogTitle": "下載 %{resource} '%{name}' (%{size})", + "shareCopyToClipboard": "複製到剪貼簿:Ctrl+C, Enter", + "remove_missing_title": "刪除遺失檔案", + "remove_missing_content": "您確定要從媒體庫中刪除所選的遺失的檔案嗎?這將永久刪除它們的所有相關資訊,包括其播放次數和評分。", + "remove_all_missing_title": "刪除所有遺失檔案", + "remove_all_missing_content": "您確定要從媒體庫中刪除所有遺失的檔案嗎?這將永久刪除它們的所有相關資訊,包括它們的播放次數和評分。", + "noSimilarSongsFound": "找不到相似歌曲", + "noTopSongsFound": "找不到熱門歌曲", + "startingInstantMix": "正在載入即時混音...", + "uploadCover": "上傳封面", + "removeCover": "移除封面", + "coverUploaded": "已更新封面圖", + "coverRemoved": "已移除封面圖", + "coverUploadError": "上傳封面圖時發生錯誤", + "coverRemoveError": "移除封面圖時發生錯誤" + }, + "menu": { + "library": "媒體庫", + "settings": "設定", + "version": "版本", + "theme": "主題", + "personal": { + "name": "個人化", + "options": { + "theme": "主題", + "language": "語言", + "defaultView": "預設畫面", + "desktop_notifications": "桌面通知", + "lastfmScrobbling": "啟用 Last.fm 音樂記錄", + "listenBrainzScrobbling": "啟用 ListenBrainz 音樂記錄", + "replaygain": "重播增益模式", + "preAmp": "重播增益前置放大器 (dB)", + "gain": { + "none": "無", + "album": "專輯增益", + "track": "曲目增益" + }, + "lastfmNotConfigured": "Last.fm API 金鑰未設定" + } + }, + "albumList": "專輯", + "about": "關於", + "playlists": "播放清單", + "sharedPlaylists": "分享的播放清單", + "librarySelector": { + "allLibraries": "所有媒體庫 (%{count})", + "multipleLibraries": "已選 %{selected} 共 %{total} 媒體庫", + "selectLibraries": "選取媒體庫", + "none": "無" + } + }, + "player": { + "playListsText": "播放佇列", + "openText": "開啟", + "closeText": "關閉", + "notContentText": "沒有音樂", + "clickToPlayText": "點擊播放", + "clickToPauseText": "點擊暫停", + "nextTrackText": "下一首", + "previousTrackText": "上一首", + "reloadText": "重新載入", + "volumeText": "音量", + "toggleLyricText": "歌詞顯示", + "toggleMiniModeText": "最小化", + "destroyText": "關閉", + "downloadText": "下載", + "removeAudioListsText": "清空播放佇列", + "clickToDeleteText": "點擊刪除 %{name}", + "emptyLyricText": "無歌詞", + "playModeText": { + "order": "順序播放", + "orderLoop": "循環播放", + "singleLoop": "單曲循環", + "shufflePlay": "隨機播放" + } + }, + "about": { + "links": { + "homepage": "首頁", + "source": "原始碼", + "featureRequests": "功能請求", + "lastInsightsCollection": "最近一次洞察資料收集", + "insights": { + "disabled": "已停用", + "waiting": "等待中" + } + }, + "tabs": { + "about": "關於", + "config": "設定" + }, + "config": { + "configName": "設定名稱", + "environmentVariable": "環境變數", + "currentValue": "目前值", + "configurationFile": "設定檔案", + "exportToml": "匯出設定(TOML 格式)", + "exportSuccess": "設定已以 TOML 格式匯出至剪貼簿", + "exportFailed": "設定複製失敗", + "devFlagsHeader": "開發旗標(可能會更改/刪除)", + "devFlagsComment": "這些是實驗性設定,可能會在未來版本中刪除", + "downloadToml": "下載設定檔 (TOML)" + } + }, + "activity": { + "title": "運作狀況", + "totalScanned": "已掃描的資料夾總數", + "quickScan": "快速掃描", + "fullScan": "完全掃描", + "serverUptime": "伺服器運作時間", + "serverDown": "伺服器已離線", + "scanType": "掃描類型", + "status": "掃描錯誤", + "elapsedTime": "經過時間", + "selectiveScan": "選擇性掃描" + }, + "help": { + "title": "Navidrome 快捷鍵", + "hotkeys": { + "show_help": "顯示此說明", + "toggle_menu": "顯示/隱藏選單側欄", + "toggle_play": "播放/暫停", + "prev_song": "上一首歌", + "next_song": "下一首歌", + "vol_up": "提高音量", + "vol_down": "降低音量", + "toggle_love": "新增此歌曲至收藏", + "current_song": "前往目前歌曲" + } + }, + "nowPlaying": { + "title": "正在播放", + "empty": "無播放內容", + "minutesAgo": "1 分鐘前 |||| %{smart_count} 分鐘前" + } +} \ No newline at end of file diff --git a/resources/mappings.yaml b/resources/mappings.yaml index 650665c78..16dddd504 100644 --- a/resources/mappings.yaml +++ b/resources/mappings.yaml @@ -69,7 +69,7 @@ main: remixer: aliases: [ tpe4, remixer, mixartist, ----:com.apple.itunes:remixer, wm/modifiedby ] albumartist: - aliases: [ tpe2, albumartist, album artist, aart, wm/albumartist ] + aliases: [ tpe2, albumartist, album artist, album_artist, aart, wm/albumartist ] albumartistsort: aliases: [ tso2, txxx:albumartistsort, albumartistsort, soaa, wm/albumartistsortorder ] albumartists: @@ -81,7 +81,7 @@ main: albumsort: aliases: [ tsoa, albumsort, soal, wm/albumsortorder ] albumversion: - aliases: [albumversion, musicbrainz_albumcomment, musicbrainz album comment, version] + aliases: [albumversion, musicbrainz_albumcomment, musicbrainz album comment] album: true genre: aliases: [ tcon, genre, ©gen, wm/genre, ignr ] @@ -108,14 +108,15 @@ main: bpm: aliases: [ tbpm, bpm, tmpo, wm/beatsperminute ] lyrics: - aliases: [ uslt:description, lyrics, ©lyr, wm/lyrics, unsyncedlyrics ] + # Note, @lyr and wm/lyrics have been removed. Taglib somehow appears to always populate `lyrics:xxx` + aliases: [ uslt:description, lyrics, unsyncedlyrics ] maxLength: 32768 type: pair # ex: lyrics:eng, lyrics:xxx comment: aliases: [ comm:description, comment, ©cmt, description, icmt ] maxLength: 4096 originaldate: - aliases: [ tdor, originaldate, ----:com.apple.itunes:originaldate, wm/originalreleasetime, tory, originalyear, ----:com.apple.itunes:originalyear, wm/originalreleaseyear ] + aliases: [ tdor, originaldate, ----:com.apple.itunes:originaldate, wm/originalreleasetime, tory, originalyear, ----:com.apple.itunes:originalyear, wm/originalreleaseyear, origyear, ----:com.apple.itunes:origyear ] type: date recordingdate: aliases: [ tdrc, date, recordingdate, icrd, record date ] diff --git a/scanner/controller.go b/scanner/controller.go index 0b3e5d122..175b92e26 100644 --- a/scanner/controller.go +++ b/scanner/controller.go @@ -7,18 +7,16 @@ import ( "sync/atomic" "time" - "github.com/Masterminds/squirrel" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/events" - . "github.com/navidrome/navidrome/utils/gg" "github.com/navidrome/navidrome/utils/pl" "golang.org/x/time/rate" ) @@ -27,49 +25,34 @@ var ( ErrAlreadyScanning = errors.New("already scanning") ) -type Scanner interface { - // ScanAll starts a full scan of the music library. This is a blocking operation. - ScanAll(ctx context.Context, fullScan bool) (warnings []string, err error) - Status(context.Context) (*StatusInfo, error) -} - -type StatusInfo struct { - Scanning bool - LastScan time.Time - Count uint32 - FolderCount uint32 - LastError string - ScanType string - ElapsedTime time.Duration -} - func New(rootCtx context.Context, ds model.DataStore, cw artwork.CacheWarmer, broker events.Broker, - pls core.Playlists, m metrics.Metrics) Scanner { + pls playlists.Playlists, m metrics.Metrics) model.Scanner { c := &controller{ - rootCtx: rootCtx, - ds: ds, - cw: cw, - broker: broker, - pls: pls, - metrics: m, + rootCtx: rootCtx, + ds: ds, + cw: cw, + broker: broker, + pls: pls, + metrics: m, + devExternalScanner: conf.Server.DevExternalScanner, } - if !conf.Server.DevExternalScanner { - c.limiter = P(rate.Sometimes{Interval: conf.Server.DevActivityPanelUpdateRate}) + if !c.devExternalScanner { + c.limiter = new(rate.Sometimes{Interval: conf.Server.DevActivityPanelUpdateRate}) } return c } func (s *controller) getScanner() scanner { - if conf.Server.DevExternalScanner { + if s.devExternalScanner { return &scannerExternal{} } - return &scannerImpl{ds: s.ds, cw: s.cw, pls: s.pls, metrics: s.metrics} + return &scannerImpl{ds: s.ds, cw: s.cw, pls: s.pls} } -// CallScan starts an in-process scan of the music library. +// CallScan starts an in-process scan of specific library/folder pairs. +// If targets is empty, it scans all libraries. // This is meant to be called from the command line (see cmd/scan.go). -func CallScan(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, pls core.Playlists, - metrics metrics.Metrics, fullScan bool) (<-chan *ProgressInfo, error) { +func CallScan(ctx context.Context, ds model.DataStore, pls playlists.Playlists, fullScan bool, targets []model.ScanTarget) (<-chan *ProgressInfo, error) { release, err := lockScan(ctx) if err != nil { return nil, err @@ -80,8 +63,8 @@ func CallScan(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, p progress := make(chan *ProgressInfo, 100) go func() { defer close(progress) - scanner := &scannerImpl{ds: ds, cw: cw, pls: pls, metrics: metrics} - scanner.scanAll(ctx, fullScan, progress) + scanner := &scannerImpl{ds: ds, cw: artwork.NoopCacheWarmer(), pls: pls} + scanner.scanFolders(ctx, fullScan, targets, progress) }() return progress, nil } @@ -101,21 +84,43 @@ type ProgressInfo struct { ForceUpdate bool } +// scanner defines the interface for different scanner implementations. +// This allows for swapping between in-process and external scanners. type scanner interface { - scanAll(ctx context.Context, fullScan bool, progress chan<- *ProgressInfo) + // scanFolders performs the actual scanning of folders. If targets is nil, it scans all libraries. + scanFolders(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) } type controller struct { - rootCtx context.Context - ds model.DataStore - cw artwork.CacheWarmer - broker events.Broker - metrics metrics.Metrics - pls core.Playlists - limiter *rate.Sometimes - count atomic.Uint32 - folderCount atomic.Uint32 - changesDetected bool + rootCtx context.Context + ds model.DataStore + cw artwork.CacheWarmer + broker events.Broker + metrics metrics.Metrics + pls playlists.Playlists + limiter *rate.Sometimes + devExternalScanner bool + count atomic.Uint32 + folderCount atomic.Uint32 + changesDetected bool +} + +// getLastScanTime returns the most recent scan time across all libraries +func (s *controller) getLastScanTime(ctx context.Context) (time.Time, error) { + libs, err := s.ds.Library(ctx).GetAll(model.QueryOptions{ + Sort: "last_scan_at", + Order: "desc", + Max: 1, + }) + if err != nil { + return time.Time{}, fmt.Errorf("getting libraries: %w", err) + } + + if len(libs) == 0 { + return time.Time{}, nil + } + + return libs[0].LastScanAt, nil } // getScanInfo retrieves scan status from the database @@ -130,10 +135,10 @@ func (s *controller) getScanInfo(ctx context.Context) (scanType string, elapsed if running.Load() { elapsed = time.Since(startTime) } else { - // If scan is not running, try to get the last scan time for the library - lib, err := s.ds.Library(ctx).Get(1) //TODO Multi-library - if err == nil { - elapsed = lib.LastScanAt.Sub(startTime) + // If scan is not running, calculate elapsed time using the most recent scan time + lastScanTime, err := s.getLastScanTime(ctx) + if err == nil && !lastScanTime.IsZero() { + elapsed = lastScanTime.Sub(startTime) } } } @@ -142,18 +147,18 @@ func (s *controller) getScanInfo(ctx context.Context) (scanType string, elapsed return scanType, elapsed, lastErr } -func (s *controller) Status(ctx context.Context) (*StatusInfo, error) { - lib, err := s.ds.Library(ctx).Get(1) //TODO Multi-library +func (s *controller) Status(ctx context.Context) (*model.ScannerStatus, error) { + lastScanTime, err := s.getLastScanTime(ctx) if err != nil { - return nil, fmt.Errorf("getting library: %w", err) + return nil, fmt.Errorf("getting last scan time: %w", err) } scanType, elapsed, lastErr := s.getScanInfo(ctx) if running.Load() { - status := &StatusInfo{ + status := &model.ScannerStatus{ Scanning: true, - LastScan: lib.LastScanAt, + LastScan: lastScanTime, Count: s.count.Load(), FolderCount: s.folderCount.Load(), LastError: lastErr, @@ -167,9 +172,9 @@ func (s *controller) Status(ctx context.Context) (*StatusInfo, error) { if err != nil { return nil, fmt.Errorf("getting library stats: %w", err) } - return &StatusInfo{ + return &model.ScannerStatus{ Scanning: false, - LastScan: lib.LastScanAt, + LastScan: lastScanTime, Count: uint32(count), FolderCount: uint32(folderCount), LastError: lastErr, @@ -179,25 +184,23 @@ func (s *controller) Status(ctx context.Context) (*StatusInfo, error) { } func (s *controller) getCounters(ctx context.Context) (int64, int64, error) { - count, err := s.ds.MediaFile(ctx).CountAll() + libs, err := s.ds.Library(ctx).GetAll() if err != nil { - return 0, 0, fmt.Errorf("media file count: %w", err) + return 0, 0, fmt.Errorf("library count: %w", err) } - folderCount, err := s.ds.Folder(ctx).CountAll( - model.QueryOptions{ - Filters: squirrel.And{ - squirrel.Gt{"num_audio_files": 0}, - squirrel.Eq{"missing": false}, - }, - }, - ) - if err != nil { - return 0, 0, fmt.Errorf("folder count: %w", err) + var count, folderCount int64 + for _, l := range libs { + count += int64(l.TotalSongs) + folderCount += int64(l.TotalFolders) } return count, folderCount, nil } func (s *controller) ScanAll(requestCtx context.Context, fullScan bool) ([]string, error) { + return s.ScanFolders(requestCtx, fullScan, nil) +} + +func (s *controller) ScanFolders(requestCtx context.Context, fullScan bool, targets []model.ScanTarget) ([]string, error) { release, err := lockScan(requestCtx) if err != nil { return nil, err @@ -206,7 +209,6 @@ func (s *controller) ScanAll(requestCtx context.Context, fullScan bool) ([]strin // Prepare the context for the scan ctx := request.AddValues(s.rootCtx, requestCtx) - ctx = events.BroadcastToAll(ctx) ctx = auth.WithAdminUser(ctx, s.ds) // Send the initial scan status event @@ -215,7 +217,7 @@ func (s *controller) ScanAll(requestCtx context.Context, fullScan bool) ([]strin go func() { defer close(progress) scanner := s.getScanner() - scanner.scanAll(ctx, fullScan, progress) + scanner.scanFolders(ctx, fullScan, targets, progress) }() // Wait for the scan to finish, sending progress events to all connected clients @@ -223,16 +225,22 @@ func (s *controller) ScanAll(requestCtx context.Context, fullScan bool) ([]strin for _, w := range scanWarnings { log.Warn(ctx, fmt.Sprintf("Scan warning: %s", w)) } + // Store scan error in database so it can be displayed in the UI + if scanError != nil { + _ = s.ds.Property(ctx).Put(consts.LastScanErrorKey, scanError.Error()) + } // If changes were detected, send a refresh event to all clients if s.changesDetected { log.Debug(ctx, "Library changes imported. Sending refresh event") - s.broker.SendMessage(ctx, &events.RefreshResource{}) + s.broker.SendBroadcastMessage(ctx, &events.RefreshResource{}) } // Send the final scan status event, with totals if count, folderCount, err := s.getCounters(ctx); err != nil { + s.metrics.WriteAfterScanMetrics(ctx, false) return scanWarnings, err } else { scanType, elapsed, lastErr := s.getScanInfo(ctx) + s.metrics.WriteAfterScanMetrics(ctx, true) s.sendMessage(ctx, &events.ScanStatus{ Scanning: false, Count: count, @@ -303,5 +311,5 @@ func (s *controller) trackProgress(ctx context.Context, progress <-chan *Progres } func (s *controller) sendMessage(ctx context.Context, status *events.ScanStatus) { - s.broker.SendMessage(ctx, status) + s.broker.SendBroadcastMessage(ctx, status) } diff --git a/scanner/controller_test.go b/scanner/controller_test.go index 4f6576a39..d60d432b4 100644 --- a/scanner/controller_test.go +++ b/scanner/controller_test.go @@ -8,6 +8,7 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/persistence" @@ -21,7 +22,7 @@ import ( var _ = Describe("Controller", func() { var ctx context.Context var ds *tests.MockDataStore - var ctrl scanner.Scanner + var ctrl model.Scanner Describe("Status", func() { BeforeEach(func() { @@ -31,8 +32,7 @@ var _ = Describe("Controller", func() { DeferCleanup(configtest.SetupConfig()) ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} ds.MockedProperty = &tests.MockedPropertyRepo{} - ctrl = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), core.NewPlaylists(ds), metrics.NewNoopInstance()) - Expect(ds.Library(ctx).Put(&model.Library{ID: 1, Name: "lib", Path: "/tmp"})).To(Succeed()) + ctrl = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) }) It("includes last scan error", func() { diff --git a/scanner/external.go b/scanner/external.go index c4a29efa3..7f573fe3e 100644 --- a/scanner/external.go +++ b/scanner/external.go @@ -11,7 +11,13 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" - . "github.com/navidrome/navidrome/utils/gg" + "github.com/navidrome/navidrome/model" +) + +const ( + // argLengthThreshold is the threshold for switching from command-line args to file-based target passing. + // Set conservatively at 24KB to support Windows (~32KB limit) with margin for env vars. + argLengthThreshold = 24 * 1024 ) // scannerExternal is a scanner that runs an external process to do the scanning. It is used to avoid @@ -23,19 +29,46 @@ import ( // process will forward them to the caller. type scannerExternal struct{} -func (s *scannerExternal) scanAll(ctx context.Context, fullScan bool, progress chan<- *ProgressInfo) { +func (s *scannerExternal) scanFolders(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) { + s.scan(ctx, fullScan, targets, progress) +} + +func (s *scannerExternal) scan(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) { exe, err := os.Executable() if err != nil { progress <- &ProgressInfo{Error: fmt.Sprintf("failed to get executable path: %s", err)} return } - log.Debug(ctx, "Spawning external scanner process", "fullScan", fullScan, "path", exe) - cmd := exec.CommandContext(ctx, exe, "scan", + + // Build command arguments + args := []string{ + "scan", "--nobanner", "--subprocess", "--configfile", conf.Server.ConfigFile, - "--datafolder", conf.Server.DataFolder, - "--cachefolder", conf.Server.CacheFolder, - If(fullScan, "--full", "")) + "--datafolder", conf.Server.DataFolder.String(), + "--cachefolder", conf.Server.CacheFolder.String(), + } + + // Add targets if provided + if len(targets) > 0 { + targetArgs, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + if err != nil { + progress <- &ProgressInfo{Error: err.Error()} + return + } + defer cleanup() + log.Debug(ctx, "Spawning external scanner process with target file", "fullScan", fullScan, "path", exe, "numTargets", len(targets)) + args = append(args, targetArgs...) + } else { + log.Debug(ctx, "Spawning external scanner process", "fullScan", fullScan, "path", exe) + } + + // Add full scan flag if needed + if fullScan { + args = append(args, "--full") + } + + cmd := exec.CommandContext(ctx, exe, args...) in, out := io.Pipe() defer in.Close() @@ -64,8 +97,7 @@ func (s *scannerExternal) scanAll(ctx context.Context, fullScan bool, progress c func (s *scannerExternal) wait(cmd *exec.Cmd, out *io.PipeWriter) { if err := cmd.Wait(); err != nil { - var exitErr *exec.ExitError - if errors.As(err, &exitErr) { + if exitErr, ok := errors.AsType[*exec.ExitError](err); ok { _ = out.CloseWithError(fmt.Errorf("%s exited with non-zero status code: %w", cmd, exitErr)) } else { _ = out.CloseWithError(fmt.Errorf("waiting %s cmd: %w", cmd, err)) @@ -75,4 +107,62 @@ func (s *scannerExternal) wait(cmd *exec.Cmd, out *io.PipeWriter) { _ = out.Close() } +// targetArguments builds command-line arguments for the given scan targets. +// If the estimated argument length exceeds a threshold, it writes the targets to a temp file +// and returns the --target-file argument instead. +// Returns the arguments, a cleanup function to remove any temp file created, and an error if any. +func targetArguments(ctx context.Context, targets []model.ScanTarget, lengthThreshold int) ([]string, func(), error) { + var args []string + + // Estimate argument length to decide whether to use file-based approach + argLength := estimateArgLength(targets) + + if argLength > lengthThreshold { + // Write targets to temp file and pass via --target-file + targetFile, err := writeTargetsToFile(targets) + if err != nil { + return nil, nil, fmt.Errorf("failed to write targets to file: %w", err) + } + args = append(args, "--target-file", targetFile) + return args, func() { + os.Remove(targetFile) // Clean up temp file + }, nil + } + + // Use command-line arguments for small target lists + for _, target := range targets { + args = append(args, "-t", target.String()) + } + return args, func() {}, nil +} + +// estimateArgLength estimates the total length of command-line arguments for the given targets. +func estimateArgLength(targets []model.ScanTarget) int { + length := 0 + for _, target := range targets { + // Each target adds: "-t " + target string + space + length += 3 + len(target.String()) + 1 + } + return length +} + +// writeTargetsToFile writes the targets to a temporary file, one per line. +// Returns the path to the temp file, which the caller should clean up. +func writeTargetsToFile(targets []model.ScanTarget) (string, error) { + tmpFile, err := os.CreateTemp("", "navidrome-scan-targets-*.txt") + if err != nil { + return "", fmt.Errorf("failed to create temp file: %w", err) + } + defer tmpFile.Close() + + for _, target := range targets { + if _, err := fmt.Fprintln(tmpFile, target.String()); err != nil { + os.Remove(tmpFile.Name()) //nolint:gosec + return "", fmt.Errorf("failed to write to temp file: %w", err) + } + } + + return tmpFile.Name(), nil +} + var _ scanner = (*scannerExternal)(nil) diff --git a/scanner/external_test.go b/scanner/external_test.go new file mode 100644 index 000000000..55f103f4d --- /dev/null +++ b/scanner/external_test.go @@ -0,0 +1,160 @@ +package scanner + +import ( + "context" + "os" + "strings" + + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("targetArguments", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = GinkgoT().Context() + }) + + Context("with small target list", func() { + It("returns command-line arguments for single target", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock"}, + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{"-t", "1:Music/Rock"})) + }) + + It("returns command-line arguments for multiple targets", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock"}, + {LibraryID: 2, FolderPath: "Music/Jazz"}, + {LibraryID: 3, FolderPath: "Classical"}, + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{ + "-t", "1:Music/Rock", + "-t", "2:Music/Jazz", + "-t", "3:Classical", + })) + }) + + It("handles targets with special characters", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock & Roll"}, + {LibraryID: 2, FolderPath: "Music/Jazz (Modern)"}, + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{ + "-t", "1:Music/Rock & Roll", + "-t", "2:Music/Jazz (Modern)", + })) + }) + }) + + Context("with large target list exceeding threshold", func() { + It("returns --target-file argument when exceeding threshold", func() { + // Create enough targets to exceed the threshold + var targets []model.ScanTarget + for i := 1; i <= 600; i++ { + targets = append(targets, model.ScanTarget{ + LibraryID: 1, + FolderPath: "Music/VeryLongFolderPathToSimulateRealScenario/SubFolder", + }) + } + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(HaveLen(2)) + Expect(args[0]).To(Equal("--target-file")) + + // Verify the file exists and has correct format + filePath := args[1] + Expect(filePath).To(ContainSubstring("navidrome-scan-targets-")) + Expect(filePath).To(HaveSuffix(".txt")) + + // Verify file actually exists + _, err = os.Stat(filePath) + Expect(err).ToNot(HaveOccurred()) + }) + + It("creates temp file with correct format", func() { + // Use custom threshold to easily exceed it + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music/Rock"}, + {LibraryID: 2, FolderPath: "Music/Jazz"}, + {LibraryID: 3, FolderPath: "Classical"}, + } + + // Set threshold very low to force file usage + args, cleanup, err := targetArguments(ctx, targets, 10) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args[0]).To(Equal("--target-file")) + + // Verify file exists with correct format + filePath := args[1] + Expect(filePath).To(ContainSubstring("navidrome-scan-targets-")) + Expect(filePath).To(HaveSuffix(".txt")) + + // Verify file content + content, err := os.ReadFile(filePath) + Expect(err).ToNot(HaveOccurred()) + lines := strings.Split(strings.TrimSpace(string(content)), "\n") + Expect(lines).To(HaveLen(3)) + Expect(lines[0]).To(Equal("1:Music/Rock")) + Expect(lines[1]).To(Equal("2:Music/Jazz")) + Expect(lines[2]).To(Equal("3:Classical")) + }) + }) + + Context("edge cases", func() { + It("handles empty target list", func() { + var targets []model.ScanTarget + + args, cleanup, err := targetArguments(ctx, targets, argLengthThreshold) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(BeEmpty()) + }) + + It("uses command-line args when exactly at threshold", func() { + // Create targets that are exactly at threshold + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music"}, + } + + // Estimate length should be 11 bytes + estimatedLength := estimateArgLength(targets) + + args, cleanup, err := targetArguments(ctx, targets, estimatedLength) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args).To(Equal([]string{"-t", "1:Music"})) + }) + + It("uses file when one byte over threshold", func() { + targets := []model.ScanTarget{ + {LibraryID: 1, FolderPath: "Music"}, + } + + // Set threshold just below the estimated length + estimatedLength := estimateArgLength(targets) + args, cleanup, err := targetArguments(ctx, targets, estimatedLength-1) + Expect(err).ToNot(HaveOccurred()) + defer cleanup() + Expect(args[0]).To(Equal("--target-file")) + }) + }) +}) diff --git a/scanner/folder_entry.go b/scanner/folder_entry.go new file mode 100644 index 000000000..c7cc88ee1 --- /dev/null +++ b/scanner/folder_entry.go @@ -0,0 +1,118 @@ +package scanner + +import ( + "crypto/md5" + "encoding/hex" + "fmt" + "io" + "io/fs" + "maps" + "slices" + "time" + + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/chrono" +) + +func newFolderEntry(job *scanJob, id, path string, updTime time.Time, hash string) *folderEntry { + f := &folderEntry{ + id: id, + job: job, + path: path, + audioFiles: make(map[string]fs.DirEntry), + imageFiles: make(map[string]fs.DirEntry), + albumIDMap: make(map[string]string), + updTime: updTime, + prevHash: hash, + } + return f +} + +type folderEntry struct { + job *scanJob + elapsed chrono.Meter + path string // Full path + id string // DB ID + modTime time.Time // From FS + updTime time.Time // from DB + audioFiles map[string]fs.DirEntry + imageFiles map[string]fs.DirEntry + numPlaylists int + numSubFolders int + imagesUpdatedAt time.Time + prevHash string // Previous hash from DB + tracks model.MediaFiles + albums model.Albums + albumIDMap map[string]string + artists model.Artists + tags model.TagList + missingTracks []*model.MediaFile +} + +func (f *folderEntry) hasNoFiles() bool { + return len(f.audioFiles) == 0 && len(f.imageFiles) == 0 && f.numPlaylists == 0 +} + +func (f *folderEntry) isEmpty() bool { + return f.hasNoFiles() && f.numSubFolders == 0 +} + +func (f *folderEntry) isNew() bool { + return f.updTime.IsZero() +} + +func (f *folderEntry) isOutdated() bool { + if f.job.lib.FullScanInProgress && f.updTime.Before(f.job.lib.LastScanStartedAt) { + return true + } + return f.prevHash != f.hash() +} + +func (f *folderEntry) toFolder() *model.Folder { + folder := model.NewFolder(f.job.lib, f.path) + folder.NumAudioFiles = len(f.audioFiles) + if playlists.InPath(*folder) { + folder.NumPlaylists = f.numPlaylists + } + folder.ImageFiles = slices.Collect(maps.Keys(f.imageFiles)) + folder.ImagesUpdatedAt = f.imagesUpdatedAt + folder.Hash = f.hash() + return folder +} + +func (f *folderEntry) hash() string { + h := md5.New() + _, _ = fmt.Fprintf( + h, + "%s:%d:%d:%s", + f.modTime.UTC(), + f.numPlaylists, + f.numSubFolders, + f.imagesUpdatedAt.UTC(), + ) + + // Sort the keys of audio and image files to ensure consistent hashing + audioKeys := slices.Collect(maps.Keys(f.audioFiles)) + slices.Sort(audioKeys) + imageKeys := slices.Collect(maps.Keys(f.imageFiles)) + slices.Sort(imageKeys) + + // Include audio files with their size and modtime + for _, key := range audioKeys { + _, _ = io.WriteString(h, key) + if info, err := f.audioFiles[key].Info(); err == nil { + _, _ = fmt.Fprintf(h, ":%d:%s", info.Size(), info.ModTime().UTC().String()) + } + } + + // Include image files with their size and modtime + for _, key := range imageKeys { + _, _ = io.WriteString(h, key) + if info, err := f.imageFiles[key].Info(); err == nil { + _, _ = fmt.Fprintf(h, ":%d:%s", info.Size(), info.ModTime().UTC().String()) + } + } + + return hex.EncodeToString(h.Sum(nil)) +} diff --git a/scanner/folder_entry_test.go b/scanner/folder_entry_test.go new file mode 100644 index 000000000..0328c6653 --- /dev/null +++ b/scanner/folder_entry_test.go @@ -0,0 +1,543 @@ +package scanner + +import ( + "io/fs" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("folder_entry", func() { + var ( + lib model.Library + job *scanJob + path string + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + lib = model.Library{ + ID: 500, + Path: "/music", + LastScanStartedAt: time.Now().Add(-1 * time.Hour), + FullScanInProgress: false, + } + job = &scanJob{ + lib: lib, + lastUpdates: make(map[string]model.FolderUpdateInfo), + } + path = "test/folder" + }) + + Describe("newFolderEntry", func() { + It("creates a new folder entry with correct initialization", func() { + folderID := model.FolderID(lib, path) + updateInfo := model.FolderUpdateInfo{ + UpdatedAt: time.Now().Add(-30 * time.Minute), + Hash: "previous-hash", + } + + entry := newFolderEntry(job, folderID, path, updateInfo.UpdatedAt, updateInfo.Hash) + + Expect(entry.id).To(Equal(folderID)) + Expect(entry.job).To(Equal(job)) + Expect(entry.path).To(Equal(path)) + Expect(entry.audioFiles).To(BeEmpty()) + Expect(entry.imageFiles).To(BeEmpty()) + Expect(entry.albumIDMap).To(BeEmpty()) + Expect(entry.updTime).To(Equal(updateInfo.UpdatedAt)) + Expect(entry.prevHash).To(Equal(updateInfo.Hash)) + }) + }) + + Describe("createFolderEntry", func() { + It("removes the lastUpdate from the job after creation", func() { + folderID := model.FolderID(lib, path) + updateInfo := model.FolderUpdateInfo{ + UpdatedAt: time.Now().Add(-30 * time.Minute), + Hash: "previous-hash", + } + job.lastUpdates[folderID] = updateInfo + + entry := job.createFolderEntry(path) + + Expect(entry.updTime).To(Equal(updateInfo.UpdatedAt)) + Expect(entry.prevHash).To(Equal(updateInfo.Hash)) + Expect(job.lastUpdates).ToNot(HaveKey(folderID)) + }) + }) + + Describe("folderEntry", func() { + var entry *folderEntry + + BeforeEach(func() { + folderID := model.FolderID(lib, path) + entry = newFolderEntry(job, folderID, path, time.Time{}, "") + }) + + Describe("hasNoFiles", func() { + It("returns true when folder has no files or subfolders", func() { + Expect(entry.hasNoFiles()).To(BeTrue()) + }) + + It("returns false when folder has audio files", func() { + entry.audioFiles["test.mp3"] = &fakeDirEntry{name: "test.mp3"} + Expect(entry.hasNoFiles()).To(BeFalse()) + }) + + It("returns false when folder has image files", func() { + entry.imageFiles["cover.jpg"] = &fakeDirEntry{name: "cover.jpg"} + Expect(entry.hasNoFiles()).To(BeFalse()) + }) + + It("returns false when folder has playlists", func() { + entry.numPlaylists = 1 + Expect(entry.hasNoFiles()).To(BeFalse()) + }) + + It("ignores subfolders when checking for no files", func() { + entry.numSubFolders = 1 + Expect(entry.hasNoFiles()).To(BeTrue()) + }) + + It("returns false when folder has multiple types of content", func() { + entry.audioFiles["test.mp3"] = &fakeDirEntry{name: "test.mp3"} + entry.imageFiles["cover.jpg"] = &fakeDirEntry{name: "cover.jpg"} + entry.numPlaylists = 2 + entry.numSubFolders = 3 + Expect(entry.hasNoFiles()).To(BeFalse()) + }) + }) + + Describe("isEmpty", func() { + It("returns true when folder has no files or subfolders", func() { + Expect(entry.isEmpty()).To(BeTrue()) + }) + It("returns false when folder has audio files", func() { + entry.audioFiles["test.mp3"] = &fakeDirEntry{name: "test.mp3"} + Expect(entry.isEmpty()).To(BeFalse()) + }) + It("returns false when folder has subfolders", func() { + entry.numSubFolders = 1 + Expect(entry.isEmpty()).To(BeFalse()) + }) + }) + + Describe("isNew", func() { + It("returns true when updTime is zero", func() { + entry.updTime = time.Time{} + Expect(entry.isNew()).To(BeTrue()) + }) + + It("returns false when updTime is not zero", func() { + entry.updTime = time.Now() + Expect(entry.isNew()).To(BeFalse()) + }) + }) + + Describe("toFolder", func() { + BeforeEach(func() { + entry.audioFiles = map[string]fs.DirEntry{ + "song1.mp3": &fakeDirEntry{name: "song1.mp3"}, + "song2.mp3": &fakeDirEntry{name: "song2.mp3"}, + } + entry.imageFiles = map[string]fs.DirEntry{ + "cover.jpg": &fakeDirEntry{name: "cover.jpg"}, + "folder.png": &fakeDirEntry{name: "folder.png"}, + } + entry.numPlaylists = 3 + entry.imagesUpdatedAt = time.Now() + }) + + It("converts folder entry to model.Folder correctly", func() { + folder := entry.toFolder() + + Expect(folder.LibraryID).To(Equal(lib.ID)) + Expect(folder.ID).To(Equal(entry.id)) + Expect(folder.NumAudioFiles).To(Equal(2)) + Expect(folder.ImageFiles).To(ConsistOf("cover.jpg", "folder.png")) + Expect(folder.ImagesUpdatedAt).To(Equal(entry.imagesUpdatedAt)) + Expect(folder.Hash).To(Equal(entry.hash())) + }) + + It("sets NumPlaylists when folder is in playlists path", func() { + // Mock InPlaylistsPath to return true by setting empty PlaylistsPath + originalPath := conf.Server.PlaylistsPath + conf.Server.PlaylistsPath = "" + DeferCleanup(func() { conf.Server.PlaylistsPath = originalPath }) + + folder := entry.toFolder() + Expect(folder.NumPlaylists).To(Equal(3)) + }) + + It("does not set NumPlaylists when folder is not in playlists path", func() { + // Mock InPlaylistsPath to return false by setting a different path + originalPath := conf.Server.PlaylistsPath + conf.Server.PlaylistsPath = "different/path" + DeferCleanup(func() { conf.Server.PlaylistsPath = originalPath }) + + folder := entry.toFolder() + Expect(folder.NumPlaylists).To(BeZero()) + }) + }) + + Describe("hash", func() { + BeforeEach(func() { + entry.modTime = time.Date(2023, 1, 15, 12, 0, 0, 0, time.UTC) + entry.imagesUpdatedAt = time.Date(2023, 1, 16, 14, 30, 0, 0, time.UTC) + }) + + It("produces deterministic hash for same content", func() { + entry.audioFiles = map[string]fs.DirEntry{ + "b.mp3": &fakeDirEntry{name: "b.mp3"}, + "a.mp3": &fakeDirEntry{name: "a.mp3"}, + } + entry.imageFiles = map[string]fs.DirEntry{ + "z.jpg": &fakeDirEntry{name: "z.jpg"}, + "x.png": &fakeDirEntry{name: "x.png"}, + } + entry.numPlaylists = 2 + entry.numSubFolders = 3 + + hash1 := entry.hash() + + // Reverse order of maps + entry.audioFiles = map[string]fs.DirEntry{ + "a.mp3": &fakeDirEntry{name: "a.mp3"}, + "b.mp3": &fakeDirEntry{name: "b.mp3"}, + } + entry.imageFiles = map[string]fs.DirEntry{ + "x.png": &fakeDirEntry{name: "x.png"}, + "z.jpg": &fakeDirEntry{name: "z.jpg"}, + } + + hash2 := entry.hash() + Expect(hash1).To(Equal(hash2)) + }) + + It("produces different hash when audio files change", func() { + entry.audioFiles = map[string]fs.DirEntry{ + "song1.mp3": &fakeDirEntry{name: "song1.mp3"}, + } + hash1 := entry.hash() + + entry.audioFiles["song2.mp3"] = &fakeDirEntry{name: "song2.mp3"} + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when image files change", func() { + entry.imageFiles = map[string]fs.DirEntry{ + "cover.jpg": &fakeDirEntry{name: "cover.jpg"}, + } + hash1 := entry.hash() + + entry.imageFiles["folder.png"] = &fakeDirEntry{name: "folder.png"} + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when modification time changes", func() { + hash1 := entry.hash() + + entry.modTime = entry.modTime.Add(1 * time.Hour) + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when playlist count changes", func() { + hash1 := entry.hash() + + entry.numPlaylists = 5 + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when subfolder count changes", func() { + hash1 := entry.hash() + + entry.numSubFolders = 3 + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when images updated time changes", func() { + hash1 := entry.hash() + + entry.imagesUpdatedAt = entry.imagesUpdatedAt.Add(2 * time.Hour) + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when audio file size changes", func() { + entry.audioFiles["test.mp3"] = &fakeDirEntry{ + name: "test.mp3", + fileInfo: &fakeFileInfo{ + name: "test.mp3", + size: 1000, + modTime: time.Now(), + }, + } + hash1 := entry.hash() + + entry.audioFiles["test.mp3"] = &fakeDirEntry{ + name: "test.mp3", + fileInfo: &fakeFileInfo{ + name: "test.mp3", + size: 2000, // Different size + modTime: time.Now(), + }, + } + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when audio file modification time changes", func() { + baseTime := time.Now() + entry.audioFiles["test.mp3"] = &fakeDirEntry{ + name: "test.mp3", + fileInfo: &fakeFileInfo{ + name: "test.mp3", + size: 1000, + modTime: baseTime, + }, + } + hash1 := entry.hash() + + entry.audioFiles["test.mp3"] = &fakeDirEntry{ + name: "test.mp3", + fileInfo: &fakeFileInfo{ + name: "test.mp3", + size: 1000, + modTime: baseTime.Add(1 * time.Hour), // Different modtime + }, + } + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when image file size changes", func() { + entry.imageFiles["cover.jpg"] = &fakeDirEntry{ + name: "cover.jpg", + fileInfo: &fakeFileInfo{ + name: "cover.jpg", + size: 5000, + modTime: time.Now(), + }, + } + hash1 := entry.hash() + + entry.imageFiles["cover.jpg"] = &fakeDirEntry{ + name: "cover.jpg", + fileInfo: &fakeFileInfo{ + name: "cover.jpg", + size: 6000, // Different size + modTime: time.Now(), + }, + } + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces different hash when image file modification time changes", func() { + baseTime := time.Now() + entry.imageFiles["cover.jpg"] = &fakeDirEntry{ + name: "cover.jpg", + fileInfo: &fakeFileInfo{ + name: "cover.jpg", + size: 5000, + modTime: baseTime, + }, + } + hash1 := entry.hash() + + entry.imageFiles["cover.jpg"] = &fakeDirEntry{ + name: "cover.jpg", + fileInfo: &fakeFileInfo{ + name: "cover.jpg", + size: 5000, + modTime: baseTime.Add(1 * time.Hour), // Different modtime + }, + } + hash2 := entry.hash() + + Expect(hash1).ToNot(Equal(hash2)) + }) + + It("produces valid hex-encoded hash", func() { + hash := entry.hash() + Expect(hash).To(HaveLen(32)) // MD5 hash should be 32 hex characters + Expect(hash).To(MatchRegexp("^[a-f0-9]{32}$")) + }) + }) + + Describe("isOutdated", func() { + BeforeEach(func() { + entry.prevHash = entry.hash() + }) + + Context("when full scan is in progress", func() { + BeforeEach(func() { + entry.job.lib.FullScanInProgress = true + entry.job.lib.LastScanStartedAt = time.Now() + }) + + It("returns true when updTime is before LastScanStartedAt", func() { + entry.updTime = entry.job.lib.LastScanStartedAt.Add(-1 * time.Hour) + Expect(entry.isOutdated()).To(BeTrue()) + }) + + It("returns false when updTime is after LastScanStartedAt", func() { + entry.updTime = entry.job.lib.LastScanStartedAt.Add(1 * time.Hour) + Expect(entry.isOutdated()).To(BeFalse()) + }) + + It("returns false when updTime equals LastScanStartedAt", func() { + entry.updTime = entry.job.lib.LastScanStartedAt + Expect(entry.isOutdated()).To(BeFalse()) + }) + }) + + Context("when full scan is not in progress", func() { + BeforeEach(func() { + entry.job.lib.FullScanInProgress = false + }) + + It("returns false when hash hasn't changed", func() { + Expect(entry.isOutdated()).To(BeFalse()) + }) + + It("returns true when hash has changed", func() { + entry.numPlaylists = 10 // Change something to change the hash + Expect(entry.isOutdated()).To(BeTrue()) + }) + + It("returns true when prevHash is empty", func() { + entry.prevHash = "" + Expect(entry.isOutdated()).To(BeTrue()) + }) + }) + + Context("priority between conditions", func() { + BeforeEach(func() { + entry.job.lib.FullScanInProgress = true + entry.job.lib.LastScanStartedAt = time.Now() + entry.updTime = entry.job.lib.LastScanStartedAt.Add(-1 * time.Hour) + }) + + It("returns true for full scan condition even when hash hasn't changed", func() { + // Hash is the same but full scan condition should take priority + Expect(entry.isOutdated()).To(BeTrue()) + }) + + It("returns true when full scan condition is not met but hash changed", func() { + entry.updTime = entry.job.lib.LastScanStartedAt.Add(1 * time.Hour) + entry.numPlaylists = 10 // Change hash + Expect(entry.isOutdated()).To(BeTrue()) + }) + }) + }) + }) + + Describe("integration scenarios", func() { + It("handles complete folder lifecycle", func() { + // Create new folder entry + folderPath := "music/rock/album" + folderID := model.FolderID(lib, folderPath) + entry := newFolderEntry(job, folderID, folderPath, time.Time{}, "") + + // Initially new and has no files + Expect(entry.isNew()).To(BeTrue()) + Expect(entry.hasNoFiles()).To(BeTrue()) + + // Add some files + entry.audioFiles["track1.mp3"] = &fakeDirEntry{name: "track1.mp3"} + entry.audioFiles["track2.mp3"] = &fakeDirEntry{name: "track2.mp3"} + entry.imageFiles["cover.jpg"] = &fakeDirEntry{name: "cover.jpg"} + entry.numSubFolders = 1 + entry.modTime = time.Now() + entry.imagesUpdatedAt = time.Now() + + // No longer empty + Expect(entry.hasNoFiles()).To(BeFalse()) + + // Set previous hash to current hash (simulating it's been saved) + entry.prevHash = entry.hash() + entry.updTime = time.Now() + + // Should not be new or outdated + Expect(entry.isNew()).To(BeFalse()) + Expect(entry.isOutdated()).To(BeFalse()) + + // Convert to model folder + folder := entry.toFolder() + Expect(folder.NumAudioFiles).To(Equal(2)) + Expect(folder.ImageFiles).To(HaveLen(1)) + Expect(folder.Hash).To(Equal(entry.hash())) + + // Modify folder and verify it becomes outdated + entry.audioFiles["track3.mp3"] = &fakeDirEntry{name: "track3.mp3"} + Expect(entry.isOutdated()).To(BeTrue()) + }) + }) +}) + +// fakeDirEntry implements fs.DirEntry for testing +type fakeDirEntry struct { + name string + isDir bool + typ fs.FileMode + fileInfo fs.FileInfo +} + +func (f *fakeDirEntry) Name() string { + return f.name +} + +func (f *fakeDirEntry) IsDir() bool { + return f.isDir +} + +func (f *fakeDirEntry) Type() fs.FileMode { + return f.typ +} + +func (f *fakeDirEntry) Info() (fs.FileInfo, error) { + if f.fileInfo != nil { + return f.fileInfo, nil + } + return &fakeFileInfo{ + name: f.name, + isDir: f.isDir, + mode: f.typ, + }, nil +} + +// fakeFileInfo implements fs.FileInfo for testing +type fakeFileInfo struct { + name string + size int64 + mode fs.FileMode + modTime time.Time + isDir bool +} + +func (f *fakeFileInfo) Name() string { return f.name } +func (f *fakeFileInfo) Size() int64 { return f.size } +func (f *fakeFileInfo) Mode() fs.FileMode { return f.mode } +func (f *fakeFileInfo) ModTime() time.Time { return f.modTime } +func (f *fakeFileInfo) IsDir() bool { return f.isDir } +func (f *fakeFileInfo) Sys() any { return nil } diff --git a/scanner/ignore_checker.go b/scanner/ignore_checker.go new file mode 100644 index 000000000..f0aedb079 --- /dev/null +++ b/scanner/ignore_checker.go @@ -0,0 +1,163 @@ +package scanner + +import ( + "bufio" + "context" + "io/fs" + "path" + "strings" + + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" + ignore "github.com/sabhiram/go-gitignore" +) + +// IgnoreChecker manages .ndignore patterns using a stack-based approach. +// Use Push() to add patterns when entering a folder, Pop() when leaving, +// and ShouldIgnore() to check if a path should be ignored. +type IgnoreChecker struct { + fsys fs.FS + patternStack [][]string // Stack of patterns for each folder level + currentPatterns []string // Flattened current patterns + matcher *ignore.GitIgnore // Compiled matcher for current patterns +} + +// newIgnoreChecker creates a new IgnoreChecker for the given filesystem. +func newIgnoreChecker(fsys fs.FS) *IgnoreChecker { + return &IgnoreChecker{ + fsys: fsys, + patternStack: make([][]string, 0), + } +} + +// Push loads .ndignore patterns from the specified folder and adds them to the pattern stack. +// Use this when entering a folder during directory tree traversal. +func (ic *IgnoreChecker) Push(ctx context.Context, folder string) error { + patterns := ic.loadPatternsFromFolder(ctx, folder) + ic.patternStack = append(ic.patternStack, patterns) + ic.rebuildCurrentPatterns() + return nil +} + +// Pop removes the most recent patterns from the stack. +// Use this when leaving a folder during directory tree traversal. +func (ic *IgnoreChecker) Pop() { + if len(ic.patternStack) > 0 { + ic.patternStack = ic.patternStack[:len(ic.patternStack)-1] + ic.rebuildCurrentPatterns() + } +} + +// PushAllParents pushes patterns from root down to the target path. +// This is a convenience method for when you need to check a specific path +// without recursively walking the tree. It handles the common pattern of +// pushing all parent directories from root to the target. +// This method is optimized to compile patterns only once at the end. +func (ic *IgnoreChecker) PushAllParents(ctx context.Context, targetPath string) error { + if targetPath == "." || targetPath == "" { + // Simple case: just push root + return ic.Push(ctx, ".") + } + + // Load patterns for root + patterns := ic.loadPatternsFromFolder(ctx, ".") + ic.patternStack = append(ic.patternStack, patterns) + + // Load patterns for each parent directory + currentPath := "." + parts := strings.SplitSeq(path.Clean(targetPath), "/") + for part := range parts { + if part == "." || part == "" { + continue + } + currentPath = path.Join(currentPath, part) + patterns = ic.loadPatternsFromFolder(ctx, currentPath) + ic.patternStack = append(ic.patternStack, patterns) + } + + // Rebuild and compile patterns only once at the end + ic.rebuildCurrentPatterns() + return nil +} + +// ShouldIgnore checks if the given path should be ignored based on the current patterns. +// Returns true if the path matches any ignore pattern, false otherwise. +func (ic *IgnoreChecker) ShouldIgnore(ctx context.Context, relPath string) bool { + // Handle root/empty path - never ignore + if relPath == "" || relPath == "." { + return false + } + + // If no patterns loaded, nothing to ignore + if ic.matcher == nil { + return false + } + + matches := ic.matcher.MatchesPath(relPath) + if matches { + log.Trace(ctx, "Scanner: Ignoring entry matching .ndignore", "path", relPath) + } + return matches +} + +// loadPatternsFromFolder reads the .ndignore file in the specified folder and returns the patterns. +// If the file doesn't exist, returns an empty slice. +// If the file exists but is empty, returns a pattern to ignore everything ("**/*"). +func (ic *IgnoreChecker) loadPatternsFromFolder(ctx context.Context, folder string) []string { + ignoreFilePath := path.Join(folder, consts.ScanIgnoreFile) + var patterns []string + + // Check if .ndignore file exists + if _, err := fs.Stat(ic.fsys, ignoreFilePath); err != nil { + // No .ndignore file in this folder + return patterns + } + + // Read and parse the .ndignore file + ignoreFile, err := ic.fsys.Open(ignoreFilePath) + if err != nil { + log.Warn(ctx, "Scanner: Error opening .ndignore file", "path", ignoreFilePath, err) + return patterns + } + defer ignoreFile.Close() + + lineScanner := bufio.NewScanner(ignoreFile) + for lineScanner.Scan() { + line := strings.TrimSpace(lineScanner.Text()) + if line == "" || strings.HasPrefix(line, "#") { + continue // Skip empty lines, whitespace-only lines, and comments + } + patterns = append(patterns, line) + } + + if err := lineScanner.Err(); err != nil { + log.Warn(ctx, "Scanner: Error reading .ndignore file", "path", ignoreFilePath, err) + return patterns + } + + // If the .ndignore file is empty, ignore everything + if len(patterns) == 0 { + log.Trace(ctx, "Scanner: .ndignore file is empty, ignoring everything", "path", folder) + patterns = []string{"**/*"} + } + + return patterns +} + +// rebuildCurrentPatterns flattens the pattern stack into currentPatterns and recompiles the matcher. +func (ic *IgnoreChecker) rebuildCurrentPatterns() { + ic.currentPatterns = make([]string, 0) + for _, patterns := range ic.patternStack { + ic.currentPatterns = append(ic.currentPatterns, patterns...) + } + ic.compilePatterns() +} + +// compilePatterns compiles the current patterns into a GitIgnore matcher. +func (ic *IgnoreChecker) compilePatterns() { + if len(ic.currentPatterns) == 0 { + ic.matcher = nil + return + } + ic.matcher = ignore.CompileIgnoreLines(ic.currentPatterns...) +} diff --git a/scanner/ignore_checker_test.go b/scanner/ignore_checker_test.go new file mode 100644 index 000000000..5378ed4fa --- /dev/null +++ b/scanner/ignore_checker_test.go @@ -0,0 +1,313 @@ +package scanner + +import ( + "context" + "testing/fstest" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("IgnoreChecker", func() { + Describe("loadPatternsFromFolder", func() { + var ic *IgnoreChecker + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + }) + + Context("when .ndignore file does not exist", func() { + It("should return empty patterns", func() { + fsys := fstest.MapFS{} + ic = newIgnoreChecker(fsys) + patterns := ic.loadPatternsFromFolder(ctx, ".") + Expect(patterns).To(BeEmpty()) + }) + }) + + Context("when .ndignore file is empty", func() { + It("should return wildcard to ignore everything", func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("")}, + } + ic = newIgnoreChecker(fsys) + patterns := ic.loadPatternsFromFolder(ctx, ".") + Expect(patterns).To(Equal([]string{"**/*"})) + }) + }) + + DescribeTable("parsing .ndignore content", + func(content string, expectedPatterns []string) { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte(content)}, + } + ic = newIgnoreChecker(fsys) + patterns := ic.loadPatternsFromFolder(ctx, ".") + Expect(patterns).To(Equal(expectedPatterns)) + }, + Entry("single pattern", "*.txt", []string{"*.txt"}), + Entry("multiple patterns", "*.txt\n*.log", []string{"*.txt", "*.log"}), + Entry("with comments", "# comment\n*.txt\n# another\n*.log", []string{"*.txt", "*.log"}), + Entry("with empty lines", "*.txt\n\n*.log\n\n", []string{"*.txt", "*.log"}), + Entry("mixed content", "# header\n\n*.txt\n# middle\n*.log\n\n", []string{"*.txt", "*.log"}), + Entry("only comments and empty lines", "# comment\n\n# another\n", []string{"**/*"}), + Entry("trailing newline", "*.txt\n*.log\n", []string{"*.txt", "*.log"}), + Entry("directory pattern", "temp/", []string{"temp/"}), + Entry("wildcard pattern", "**/*.mp3", []string{"**/*.mp3"}), + Entry("multiple wildcards", "**/*.mp3\n**/*.flac\n*.log", []string{"**/*.mp3", "**/*.flac", "*.log"}), + Entry("negation pattern", "!important.txt", []string{"!important.txt"}), + Entry("comment with hash not at start is pattern", "not#comment", []string{"not#comment"}), + Entry("whitespace-only lines skipped", "*.txt\n \n*.log\n\t\n", []string{"*.txt", "*.log"}), + Entry("patterns with whitespace trimmed", " *.txt \n\t*.log\t", []string{"*.txt", "*.log"}), + ) + }) + + Describe("Push and Pop", func() { + var ic *IgnoreChecker + var fsys fstest.MapFS + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + fsys = fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("*.txt")}, + "folder1/.ndignore": &fstest.MapFile{Data: []byte("*.mp3")}, + "folder2/.ndignore": &fstest.MapFile{Data: []byte("*.flac")}, + } + ic = newIgnoreChecker(fsys) + }) + + Context("Push", func() { + It("should add patterns to stack", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(1)) + Expect(ic.currentPatterns).To(ContainElement("*.txt")) + }) + + It("should compile matcher after push", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.matcher).ToNot(BeNil()) + }) + + It("should accumulate patterns from multiple levels", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(2)) + Expect(ic.currentPatterns).To(ConsistOf("*.txt", "*.mp3")) + }) + + It("should handle push when no .ndignore exists", func() { + err := ic.Push(ctx, "nonexistent") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(1)) + Expect(ic.currentPatterns).To(BeEmpty()) + }) + }) + + Context("Pop", func() { + It("should remove most recent patterns", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + ic.Pop() + Expect(len(ic.patternStack)).To(Equal(1)) + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + }) + + It("should handle Pop on empty stack gracefully", func() { + Expect(func() { ic.Pop() }).ToNot(Panic()) + Expect(ic.patternStack).To(BeEmpty()) + }) + + It("should set matcher to nil when all patterns popped", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.matcher).ToNot(BeNil()) + ic.Pop() + Expect(ic.matcher).To(BeNil()) + }) + + It("should update matcher after pop", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + matcher1 := ic.matcher + ic.Pop() + matcher2 := ic.matcher + Expect(matcher1).ToNot(Equal(matcher2)) + }) + }) + + Context("multiple Push/Pop cycles", func() { + It("should maintain correct state through cycles", func() { + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + + err = ic.Push(ctx, "folder1") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.currentPatterns).To(ConsistOf("*.txt", "*.mp3")) + + ic.Pop() + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + + err = ic.Push(ctx, "folder2") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.currentPatterns).To(ConsistOf("*.txt", "*.flac")) + + ic.Pop() + Expect(ic.currentPatterns).To(Equal([]string{"*.txt"})) + + ic.Pop() + Expect(ic.currentPatterns).To(BeEmpty()) + }) + }) + }) + + Describe("PushAllParents", func() { + var ic *IgnoreChecker + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("root.txt")}, + "folder1/.ndignore": &fstest.MapFile{Data: []byte("level1.txt")}, + "folder1/folder2/.ndignore": &fstest.MapFile{Data: []byte("level2.txt")}, + "folder1/folder2/folder3/.ndignore": &fstest.MapFile{Data: []byte("level3.txt")}, + } + ic = newIgnoreChecker(fsys) + }) + + DescribeTable("loading parent patterns", + func(targetPath string, expectedStackDepth int, expectedPatterns []string) { + err := ic.PushAllParents(ctx, targetPath) + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(expectedStackDepth)) + Expect(ic.currentPatterns).To(ConsistOf(expectedPatterns)) + }, + Entry("root path", ".", 1, []string{"root.txt"}), + Entry("empty path", "", 1, []string{"root.txt"}), + Entry("single level", "folder1", 2, []string{"root.txt", "level1.txt"}), + Entry("two levels", "folder1/folder2", 3, []string{"root.txt", "level1.txt", "level2.txt"}), + Entry("three levels", "folder1/folder2/folder3", 4, []string{"root.txt", "level1.txt", "level2.txt", "level3.txt"}), + ) + + It("should only compile patterns once at the end", func() { + // This is more of a behavioral test - we verify the matcher is not nil after PushAllParents + err := ic.PushAllParents(ctx, "folder1/folder2") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.matcher).ToNot(BeNil()) + }) + + It("should handle paths with dot", func() { + err := ic.PushAllParents(ctx, "./folder1") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(2)) + }) + + Context("when some parent folders have no .ndignore", func() { + BeforeEach(func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("root.txt")}, + "folder1/folder2/.ndignore": &fstest.MapFile{Data: []byte("level2.txt")}, + } + ic = newIgnoreChecker(fsys) + }) + + It("should still push all parent levels", func() { + err := ic.PushAllParents(ctx, "folder1/folder2") + Expect(err).ToNot(HaveOccurred()) + Expect(len(ic.patternStack)).To(Equal(3)) // root, folder1 (empty), folder2 + Expect(ic.currentPatterns).To(ConsistOf("root.txt", "level2.txt")) + }) + }) + }) + + Describe("ShouldIgnore", func() { + var ic *IgnoreChecker + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + }) + + Context("with no patterns loaded", func() { + It("should not ignore any path", func() { + fsys := fstest.MapFS{} + ic = newIgnoreChecker(fsys) + Expect(ic.ShouldIgnore(ctx, "anything.txt")).To(BeFalse()) + Expect(ic.ShouldIgnore(ctx, "folder/file.mp3")).To(BeFalse()) + }) + }) + + Context("special paths", func() { + BeforeEach(func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("**/*")}, + } + ic = newIgnoreChecker(fsys) + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + }) + + It("should never ignore root or empty paths", func() { + Expect(ic.ShouldIgnore(ctx, "")).To(BeFalse()) + Expect(ic.ShouldIgnore(ctx, ".")).To(BeFalse()) + }) + + It("should ignore all other paths with wildcard", func() { + Expect(ic.ShouldIgnore(ctx, "file.txt")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "folder/file.mp3")).To(BeTrue()) + }) + }) + + DescribeTable("pattern matching", + func(pattern string, path string, shouldMatch bool) { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte(pattern)}, + } + ic = newIgnoreChecker(fsys) + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + Expect(ic.ShouldIgnore(ctx, path)).To(Equal(shouldMatch)) + }, + Entry("glob match", "*.txt", "file.txt", true), + Entry("glob no match", "*.txt", "file.mp3", false), + Entry("directory pattern match", "tmp/", "tmp/file.txt", true), + Entry("directory pattern no match", "tmp/", "temporary/file.txt", false), + Entry("nested glob match", "**/*.log", "deep/nested/file.log", true), + Entry("nested glob no match", "**/*.log", "deep/nested/file.txt", false), + Entry("specific file match", "ignore.me", "ignore.me", true), + Entry("specific file no match", "ignore.me", "keep.me", false), + Entry("wildcard all", "**/*", "any/path/file.txt", true), + Entry("nested specific match", "temp/*", "temp/cache.db", true), + Entry("nested specific no match", "temp/*", "temporary/cache.db", false), + ) + + Context("with multiple patterns", func() { + BeforeEach(func() { + fsys := fstest.MapFS{ + ".ndignore": &fstest.MapFile{Data: []byte("*.txt\n*.log\ntemp/")}, + } + ic = newIgnoreChecker(fsys) + err := ic.Push(ctx, ".") + Expect(err).ToNot(HaveOccurred()) + }) + + It("should match any of the patterns", func() { + Expect(ic.ShouldIgnore(ctx, "file.txt")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "debug.log")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "temp/cache")).To(BeTrue()) + Expect(ic.ShouldIgnore(ctx, "music.mp3")).To(BeFalse()) + }) + }) + }) +}) diff --git a/scanner/metadata_old/metadata.go b/scanner/metadata_old/metadata.go index 6530ee8d1..3ccbd8961 100644 --- a/scanner/metadata_old/metadata.go +++ b/scanner/metadata_old/metadata.go @@ -215,8 +215,8 @@ func (t Tags) Lyrics() string { } for tag, value := range t.Tags { - if strings.HasPrefix(tag, "lyrics-") { - language := strings.TrimSpace(strings.TrimPrefix(tag, "lyrics-")) + if after, ok := strings.CutPrefix(tag, "lyrics-"); ok { + language := strings.TrimSpace(after) if language == "" { language = "xxx" diff --git a/scanner/metadata_old/metadata_internal_test.go b/scanner/metadata_old/metadata_internal_test.go index 2d21e07eb..aff1ede9c 100644 --- a/scanner/metadata_old/metadata_internal_test.go +++ b/scanner/metadata_old/metadata_internal_test.go @@ -93,7 +93,7 @@ var _ = Describe("Tags", func() { var t *Tags BeforeEach(func() { t = &Tags{Tags: map[string][]string{ - "fbpm": []string{"141.7"}, + "fbpm": {"141.7"}, }} }) diff --git a/scanner/phase_1_folders.go b/scanner/phase_1_folders.go index ae0d906de..38967832c 100644 --- a/scanner/phase_1_folders.go +++ b/scanner/phase_1_folders.go @@ -26,52 +26,46 @@ import ( "github.com/navidrome/navidrome/utils/slice" ) -func createPhaseFolders(ctx context.Context, state *scanState, ds model.DataStore, cw artwork.CacheWarmer, libs []model.Library) *phaseFolders { +func createPhaseFolders(ctx context.Context, state *scanState, ds model.DataStore, cw artwork.CacheWarmer) *phaseFolders { var jobs []*scanJob - for _, lib := range libs { - if lib.LastScanStartedAt.IsZero() { - err := ds.Library(ctx).ScanBegin(lib.ID, state.fullScan) - if err != nil { - log.Error(ctx, "Scanner: Error updating last scan started at", "lib", lib.Name, err) - state.sendWarning(err.Error()) - continue - } - // Reload library to get updated state - l, err := ds.Library(ctx).Get(lib.ID) - if err != nil { - log.Error(ctx, "Scanner: Error reloading library", "lib", lib.Name, err) - state.sendWarning(err.Error()) - continue - } - lib = *l - } else { - log.Debug(ctx, "Scanner: Resuming previous scan", "lib", lib.Name, "lastScanStartedAt", lib.LastScanStartedAt, "fullScan", lib.FullScanInProgress) + + // Create scan jobs for all libraries + for _, lib := range state.libraries { + // Get target folders for this library if selective scan + var targetFolders []string + if state.isSelectiveScan() { + targetFolders = state.targets[lib.ID] } - job, err := newScanJob(ctx, ds, cw, lib, state.fullScan) + + job, err := newScanJob(ctx, ds, cw, lib, state.fullScan, targetFolders) if err != nil { log.Error(ctx, "Scanner: Error creating scan context", "lib", lib.Name, err) - state.sendWarning(err.Error()) + state.sendError(err) continue } jobs = append(jobs, job) } + return &phaseFolders{jobs: jobs, ctx: ctx, ds: ds, state: state} } type scanJob struct { - lib model.Library - fs storage.MusicFS - cw artwork.CacheWarmer - lastUpdates map[string]time.Time - lock sync.Mutex - numFolders atomic.Int64 + lib model.Library + fs storage.MusicFS + cw artwork.CacheWarmer + lastUpdates map[string]model.FolderUpdateInfo // Holds last update info for all (DB) folders in this library + targetFolders []string // Specific folders to scan (including all descendants) + lock sync.Mutex + numFolders atomic.Int64 } -func newScanJob(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, lib model.Library, fullScan bool) (*scanJob, error) { - lastUpdates, err := ds.Folder(ctx).GetLastUpdates(lib) +func newScanJob(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, lib model.Library, fullScan bool, targetFolders []string) (*scanJob, error) { + // Get folder updates, optionally filtered to specific target folders + lastUpdates, err := ds.Folder(ctx).GetFolderUpdateInfo(lib, targetFolders...) if err != nil { return nil, fmt.Errorf("getting last updates: %w", err) } + fileStore, err := storage.For(lib.Path) if err != nil { log.Error(ctx, "Error getting storage for library", "library", lib.Name, "path", lib.Path, err) @@ -82,16 +76,24 @@ func newScanJob(ctx context.Context, ds model.DataStore, cw artwork.CacheWarmer, log.Error(ctx, "Error getting fs for library", "library", lib.Name, "path", lib.Path, err) return nil, fmt.Errorf("getting fs for library: %w", err) } + + // Ensure FullScanInProgress reflects the current scan request. + // This is important when resuming an interrupted quick scan as a full scan: + // the DB may have FullScanInProgress=false, but we need it true for isOutdated() to work correctly. lib.FullScanInProgress = lib.FullScanInProgress || fullScan + return &scanJob{ - lib: lib, - fs: fsys, - cw: cw, - lastUpdates: lastUpdates, + lib: lib, + fs: fsys, + cw: cw, + lastUpdates: lastUpdates, + targetFolders: targetFolders, }, nil } -func (j *scanJob) popLastUpdate(folderID string) time.Time { +// popLastUpdate retrieves and removes the last update info for the given folder ID +// This is used to track which folders have been found during the walk_dir_tree +func (j *scanJob) popLastUpdate(folderID string) model.FolderUpdateInfo { j.lock.Lock() defer j.lock.Unlock() @@ -100,6 +102,15 @@ func (j *scanJob) popLastUpdate(folderID string) time.Time { return lastUpdate } +// createFolderEntry creates a new folderEntry for the given path, using the last update info from the job +// to populate the previous update time and hash. It also removes the folder from the job's lastUpdates map. +// This is used to track which folders have been found during the walk_dir_tree. +func (j *scanJob) createFolderEntry(path string) *folderEntry { + id := model.FolderID(j.lib, path) + info := j.popLastUpdate(id) + return newFolderEntry(j, id, path, info.UpdatedAt, info.Hash) +} + // phaseFolders represents the first phase of the scanning process, which is responsible // for scanning all libraries and importing new or updated files. This phase involves // traversing the directory tree of each library, identifying new or modified media files, @@ -138,7 +149,8 @@ func (p *phaseFolders) producer() ppl.Producer[*folderEntry] { if utils.IsCtxDone(p.ctx) { break } - outputChan, err := walkDirTree(p.ctx, job) + + outputChan, err := walkDirTree(p.ctx, job, job.targetFolders...) if err != nil { log.Warn(p.ctx, "Scanner: Error scanning library", "lib", job.lib.Name, err) } @@ -164,7 +176,7 @@ func (p *phaseFolders) producer() ppl.Producer[*folderEntry] { log.Trace(p.ctx, "Scanner: Skipping new folder with no files", "folder", folder.path, "lib", job.lib.Name) continue } - log.Trace(p.ctx, "Scanner: Detected changes in folder", "folder", folder.path, "lastUpdate", folder.modTime, "lib", job.lib.Name) + log.Debug(p.ctx, "Scanner: Detected changes in folder", "folder", folder.path, "lastUpdate", folder.modTime, "lib", job.lib.Name) } totalChanged++ folder.elapsed.Stop() @@ -318,6 +330,9 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) defer p.measure(entry)() p.state.changesDetected.Store(true) + // Collect artwork IDs to pre-cache after the transaction commits + var artworkIDs []model.ArtworkID + err := p.ds.WithTx(func(tx model.DataStore) error { // Instantiate all repositories just once per folder folderRepo := tx.Folder(p.ctx) @@ -336,7 +351,7 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) } // Save all tags to DB - err = tagRepo.Add(entry.tags...) + err = tagRepo.Add(entry.job.lib.ID, entry.tags...) if err != nil { log.Error(p.ctx, "Scanner: Error persisting tags to DB", "folder", entry.path, err) return err @@ -345,7 +360,7 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) // Save all new/modified artists to DB. Their information will be incomplete, but they will be refreshed later for i := range entry.artists { err = artistRepo.Put(&entry.artists[i], "name", - "mbz_artist_id", "sort_artist_name", "order_artist_name", "full_text") + "mbz_artist_id", "sort_artist_name", "order_artist_name", "full_text", "updated_at") if err != nil { log.Error(p.ctx, "Scanner: Error persisting artist to DB", "folder", entry.path, "artist", entry.artists[i].Name, err) return err @@ -356,7 +371,7 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) return err } if entry.artists[i].Name != consts.UnknownArtist && entry.artists[i].Name != consts.VariousArtists { - entry.job.cw.PreCache(entry.artists[i].CoverArtID()) + artworkIDs = append(artworkIDs, entry.artists[i].CoverArtID()) } } @@ -368,7 +383,7 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) return err } if entry.albums[i].Name != consts.UnknownAlbum { - entry.job.cw.PreCache(entry.albums[i].CoverArtID()) + artworkIDs = append(artworkIDs, entry.albums[i].CoverArtID()) } } @@ -405,6 +420,14 @@ func (p *phaseFolders) persistChanges(entry *folderEntry) (*folderEntry, error) if err != nil { log.Error(p.ctx, "Scanner: Error persisting changes to DB", "folder", entry.path, err) } + + // Pre-cache artwork after the transaction commits successfully + if err == nil { + for _, artID := range artworkIDs { + entry.job.cw.PreCache(artID) + } + } + return entry, err } @@ -418,12 +441,14 @@ func (p *phaseFolders) persistAlbum(repo model.AlbumRepository, a *model.Album, if prevID == "" { return nil } + // Reassign annotation from previous album to new album log.Trace(p.ctx, "Reassigning album annotations", "from", prevID, "to", a.ID, "album", a.Name) if err := repo.ReassignAnnotation(prevID, a.ID); err != nil { log.Warn(p.ctx, "Scanner: Could not reassign annotations", "from", prevID, "to", a.ID, "album", a.Name, err) p.state.sendWarning(fmt.Sprintf("Could not reassign annotations from %s to %s ('%s'): %v", prevID, a.ID, a.Name, err)) } + // Keep created_at field from previous instance of the album if err := repo.CopyAttributes(prevID, a.ID, "created_at"); err != nil { // Silently ignore when the previous album is not found @@ -439,7 +464,7 @@ func (p *phaseFolders) persistAlbum(repo model.AlbumRepository, a *model.Album, func (p *phaseFolders) logFolder(entry *folderEntry) (*folderEntry, error) { logCall := log.Info - if entry.hasNoFiles() { + if entry.isEmpty() { logCall = log.Trace } logCall(p.ctx, "Scanner: Completed processing folder", diff --git a/scanner/phase_2_missing_tracks.go b/scanner/phase_2_missing_tracks.go index 6f56f6a52..8c258b833 100644 --- a/scanner/phase_2_missing_tracks.go +++ b/scanner/phase_2_missing_tracks.go @@ -2,7 +2,9 @@ package scanner import ( "context" + "errors" "fmt" + "sync" "sync/atomic" ppl "github.com/google/go-pipeline/pkg/pipeline" @@ -31,14 +33,21 @@ type missingTracks struct { // 4. Updates the database with the new locations of the matched files and removes the old entries. // 5. Logs the results and finalizes the phase by reporting the total number of matched files. type phaseMissingTracks struct { - ctx context.Context - ds model.DataStore - totalMatched atomic.Uint32 - state *scanState + ctx context.Context + ds model.DataStore + totalMatched atomic.Uint32 + state *scanState + processedAlbumAnnotations map[string]bool // Track processed album annotation reassignments + annotationMutex sync.RWMutex // Protects processedAlbumAnnotations } func createPhaseMissingTracks(ctx context.Context, state *scanState, ds model.DataStore) *phaseMissingTracks { - return &phaseMissingTracks{ctx: ctx, ds: ds, state: state} + return &phaseMissingTracks{ + ctx: ctx, + ds: ds, + state: state, + processedAlbumAnnotations: make(map[string]bool), + } } func (p *phaseMissingTracks) description() string { @@ -52,20 +61,15 @@ func (p *phaseMissingTracks) producer() ppl.Producer[*missingTracks] { func (p *phaseMissingTracks) produce(put func(tracks *missingTracks)) error { count := 0 var putIfMatched = func(mt missingTracks) { - if mt.pid != "" && len(mt.matched) > 0 { - log.Trace(p.ctx, "Scanner: Found missing and matching tracks", "pid", mt.pid, "missing", len(mt.missing), "matched", len(mt.matched), "lib", mt.lib.Name) + if mt.pid != "" && len(mt.missing) > 0 { + log.Trace(p.ctx, "Scanner: Found missing tracks", "pid", mt.pid, "missing", "title", mt.missing[0].Title, + len(mt.missing), "matched", len(mt.matched), "lib", mt.lib.Name, + ) count++ put(&mt) } } - libs, err := p.ds.Library(p.ctx).GetAll() - if err != nil { - return fmt.Errorf("loading libraries: %w", err) - } - for _, lib := range libs { - if lib.LastScanStartedAt.IsZero() { - continue - } + for _, lib := range p.state.libraries { log.Debug(p.ctx, "Scanner: Checking missing tracks", "libraryId", lib.ID, "libraryName", lib.Name) cursor, err := p.ds.MediaFile(p.ctx).GetMissingAndMatching(lib.ID) if err != nil { @@ -104,16 +108,26 @@ func (p *phaseMissingTracks) produce(put func(tracks *missingTracks)) error { func (p *phaseMissingTracks) stages() []ppl.Stage[*missingTracks] { return []ppl.Stage[*missingTracks]{ ppl.NewStage(p.processMissingTracks, ppl.Name("process missing tracks")), + ppl.NewStage(p.processCrossLibraryMoves, ppl.Name("process cross-library moves")), } } func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTracks, error) { + hasMatches := false + // Track which matched entries have already been consumed, so each matched track + // is only used once. Without this, the same matched track could be paired with + // multiple missing tracks, creating duplicate records with the same path. + usedMatched := make(map[string]bool, len(in.matched)) + for _, ms := range in.missing { var exactMatch model.MediaFile var equivalentMatch model.MediaFile // Identify exact and equivalent matches for _, mt := range in.matched { + if usedMatched[mt.ID] { + continue + } if ms.Equals(mt) { exactMatch = mt break // Prioritize exact match @@ -131,12 +145,14 @@ func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTr log.Error(p.ctx, "Scanner: Error moving matched track", "missing", ms.Path, "movedTo", exactMatch.Path, "lib", in.lib.Name, err) return nil, err } + usedMatched[exactMatch.ID] = true p.totalMatched.Add(1) + hasMatches = true continue } // If there is only one missing and one matched track, consider them equivalent (same PID) - if len(in.missing) == 1 && len(in.matched) == 1 { + if len(in.missing) == 1 && len(in.matched) == 1 && !usedMatched[in.matched[0].ID] { singleMatch := in.matched[0] log.Debug(p.ctx, "Scanner: Found track with same persistent ID in a new place", "missing", ms.Path, "movedTo", singleMatch.Path, "lib", in.lib.Name) err := p.moveMatched(singleMatch, ms) @@ -144,7 +160,9 @@ func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTr log.Error(p.ctx, "Scanner: Error updating matched track", "missing", ms.Path, "movedTo", singleMatch.Path, "lib", in.lib.Name, err) return nil, err } + usedMatched[singleMatch.ID] = true p.totalMatched.Add(1) + hasMatches = true continue } @@ -156,24 +174,162 @@ func (p *phaseMissingTracks) processMissingTracks(in *missingTracks) (*missingTr log.Error(p.ctx, "Scanner: Error updating matched track", "missing", ms.Path, "movedTo", equivalentMatch.Path, "lib", in.lib.Name, err) return nil, err } + usedMatched[equivalentMatch.ID] = true p.totalMatched.Add(1) + hasMatches = true } } + + // If any matches were found in this missingTracks group, return nil + // This signals the next stage to skip processing this group + if hasMatches { + return nil, nil + } + + // If no matches found, pass through to next stage return in, nil } -func (p *phaseMissingTracks) moveMatched(mt, ms model.MediaFile) error { +// processCrossLibraryMoves processes files that weren't matched within their library +// and attempts to find matches in other libraries +func (p *phaseMissingTracks) processCrossLibraryMoves(in *missingTracks) (*missingTracks, error) { + // Skip if input is nil (meaning previous stage found matches) + if in == nil { + return nil, nil + } + + // Skip cross-library move detection when only one library is configured + // since there are no other libraries to search in. + if p.state.totalLibraryCount == 1 { + log.Debug(p.ctx, "Scanner: Skipping cross-library move detection (single library)") + return in, nil + } + + log.Debug(p.ctx, "Scanner: Processing cross-library moves", "pid", in.pid, "missing", len(in.missing), "lib", in.lib.Name) + + for _, missing := range in.missing { + found, err := p.findCrossLibraryMatch(missing) + if err != nil { + log.Error(p.ctx, "Scanner: Error searching for cross-library matches", "missing", missing.Path, "lib", in.lib.Name, err) + continue + } + + if found.ID != "" { + log.Debug(p.ctx, "Scanner: Found cross-library moved track", "missing", missing.Path, "movedTo", found.Path, "fromLib", in.lib.Name, "toLib", found.LibraryName) + err := p.moveMatched(found, missing) + if err != nil { + log.Error(p.ctx, "Scanner: Error moving cross-library track", "missing", missing.Path, "movedTo", found.Path, err) + continue + } + p.totalMatched.Add(1) + } + } + + return in, nil +} + +// findCrossLibraryMatch searches for a missing file in other libraries using two-tier matching +func (p *phaseMissingTracks) findCrossLibraryMatch(missing model.MediaFile) (model.MediaFile, error) { + // First tier: Search by MusicBrainz Track ID if available + if missing.MbzReleaseTrackID != "" { + matches, err := p.ds.MediaFile(p.ctx).FindRecentFilesByMBZTrackID(missing, missing.CreatedAt) + if err != nil { + log.Error(p.ctx, "Scanner: Error searching for recent files by MBZ Track ID", "mbzTrackID", missing.MbzReleaseTrackID, err) + } else { + // Apply the same matching logic as within-library matching + for _, match := range matches { + if missing.Equals(match) { + return match, nil // Exact match found + } + } + + // If only one match and it's equivalent, use it + if len(matches) == 1 && missing.IsEquivalent(matches[0]) { + return matches[0], nil + } + } + } + + // Second tier: Search by intrinsic properties (title, size, suffix, etc.) + matches, err := p.ds.MediaFile(p.ctx).FindRecentFilesByProperties(missing, missing.CreatedAt) + if err != nil { + log.Error(p.ctx, "Scanner: Error searching for recent files by properties", "missing", missing.Path, err) + return model.MediaFile{}, err + } + + // Apply the same matching logic as within-library matching + for _, match := range matches { + if missing.Equals(match) { + return match, nil // Exact match found + } + } + + // If only one match and it's equivalent, use it + if len(matches) == 1 && missing.IsEquivalent(matches[0]) { + return matches[0], nil + } + + return model.MediaFile{}, nil +} + +func (p *phaseMissingTracks) moveMatched(target, missing model.MediaFile) error { return p.ds.WithTx(func(tx model.DataStore) error { - discardedID := mt.ID - mt.ID = ms.ID - err := tx.MediaFile(p.ctx).Put(&mt) + discardedID := target.ID + oldAlbumID := missing.AlbumID + newAlbumID := target.AlbumID + + // Preserve the original created_at from the missing file, so moved tracks + // don't appear in "Recently Added" + target.CreatedAt = missing.CreatedAt + + // Update the target media file with the missing file's ID. This effectively "moves" the track + // to the new location while keeping its annotations and references intact. + target.ID = missing.ID + err := tx.MediaFile(p.ctx).Put(&target) if err != nil { return fmt.Errorf("update matched track: %w", err) } + + // Discard the new mediafile row (the one that was moved to) err = tx.MediaFile(p.ctx).Delete(discardedID) if err != nil { return fmt.Errorf("delete discarded track: %w", err) } + + // Handle album annotation reassignment if AlbumID changed + if oldAlbumID != newAlbumID { + // Use newAlbumID as key since we only care about avoiding duplicate reassignments to the same target + p.annotationMutex.RLock() + alreadyProcessed := p.processedAlbumAnnotations[newAlbumID] + p.annotationMutex.RUnlock() + + if !alreadyProcessed { + p.annotationMutex.Lock() + // Double-check pattern to avoid race conditions + if !p.processedAlbumAnnotations[newAlbumID] { + // Reassign direct album annotations (starred, rating) + log.Debug(p.ctx, "Scanner: Reassigning album annotations", "from", oldAlbumID, "to", newAlbumID) + if err := tx.Album(p.ctx).ReassignAnnotation(oldAlbumID, newAlbumID); err != nil { + log.Warn(p.ctx, "Scanner: Could not reassign album annotations", "from", oldAlbumID, "to", newAlbumID, err) + } + + // Keep created_at field from previous instance of the album, so moved albums + // don't appear in "Recently Added" + if err := tx.Album(p.ctx).CopyAttributes(oldAlbumID, newAlbumID, "created_at"); err != nil { + if !errors.Is(err, model.ErrNotFound) { + log.Warn(p.ctx, "Scanner: Could not copy album created_at", "from", oldAlbumID, "to", newAlbumID, err) + } + } + + // Note: RefreshPlayCounts will be called in later phases, so we don't need to call it here + p.processedAlbumAnnotations[newAlbumID] = true + } + p.annotationMutex.Unlock() + } else { + log.Trace(p.ctx, "Scanner: Skipping album annotation reassignment", "from", oldAlbumID, "to", newAlbumID) + } + } + p.state.changesDetected.Store(true) return nil }) diff --git a/scanner/phase_2_missing_tracks_test.go b/scanner/phase_2_missing_tracks_test.go index 5dd6cc679..d54ceee40 100644 --- a/scanner/phase_2_missing_tracks_test.go +++ b/scanner/phase_2_missing_tracks_test.go @@ -28,7 +28,10 @@ var _ = Describe("phaseMissingTracks", func() { lr = &tests.MockLibraryRepo{} lr.SetData(model.Libraries{{ID: 1, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}}) ds = &tests.MockDataStore{MockedMediaFile: mr, MockedLibrary: lr} - state = &scanState{} + state = &scanState{ + libraries: model.Libraries{{ID: 1, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}}, + totalLibraryCount: 1, + } phase = createPhaseMissingTracks(ctx, state, ds) }) @@ -68,12 +71,31 @@ var _ = Describe("phaseMissingTracks", func() { err := phase.produce(put) Expect(err).ToNot(HaveOccurred()) - Expect(produced).To(HaveLen(1)) - Expect(produced[0].pid).To(Equal("A")) - Expect(produced[0].missing).To(HaveLen(1)) - Expect(produced[0].matched).To(HaveLen(1)) + Expect(produced).To(HaveLen(2)) + // PID A should have both missing and matched tracks + var pidA *missingTracks + for _, p := range produced { + if p.pid == "A" { + pidA = p + break + } + } + Expect(pidA).ToNot(BeNil()) + Expect(pidA.missing).To(HaveLen(1)) + Expect(pidA.matched).To(HaveLen(1)) + // PID B should have only missing tracks + var pidB *missingTracks + for _, p := range produced { + if p.pid == "B" { + pidB = p + break + } + } + Expect(pidB).ToNot(BeNil()) + Expect(pidB.missing).To(HaveLen(1)) + Expect(pidB.matched).To(HaveLen(0)) }) - It("should not call put if there are no matches for any missing tracks", func() { + It("should call put for any missing tracks even without matches", func() { mr.SetData(model.MediaFiles{ {ID: "1", PID: "A", Missing: true, LibraryID: 1}, {ID: "2", PID: "B", Missing: true, LibraryID: 1}, @@ -82,7 +104,22 @@ var _ = Describe("phaseMissingTracks", func() { err := phase.produce(put) Expect(err).ToNot(HaveOccurred()) - Expect(produced).To(BeZero()) + Expect(produced).To(HaveLen(2)) + // Both PID A and PID B should be produced even without matches + var pidA, pidB *missingTracks + for _, p := range produced { + if p.pid == "A" { + pidA = p + } else if p.pid == "B" { + pidB = p + } + } + Expect(pidA).ToNot(BeNil()) + Expect(pidA.missing).To(HaveLen(1)) + Expect(pidA.matched).To(HaveLen(0)) + Expect(pidB).ToNot(BeNil()) + Expect(pidB.missing).To(HaveLen(1)) + Expect(pidB.matched).To(HaveLen(0)) }) }) }) @@ -204,6 +241,39 @@ var _ = Describe("phaseMissingTracks", func() { Expect(movedTrack.Size).To(Equal(missingTrack.Size)) }) + It("should not match the same target to multiple missing tracks (prevents duplicate paths)", func() { + // Simulate a scenario where two missing tracks from different locations have the same + // base filename and match the same newly imported track via IsEquivalent. + // Without deduplication, both missing tracks would be "moved" to the same target, + // creating two non-missing records with the same path. + missingTrack1 := model.MediaFile{ID: "1", PID: "A", Path: "old_dir1/song.mp3", Title: "title1", Size: 100} + missingTrack2 := model.MediaFile{ID: "2", PID: "A", Path: "old_dir2/song.mp3", Title: "title1", Size: 100} + matchedTrack := model.MediaFile{ID: "3", PID: "A", Path: "new_dir/song.mp3", Title: "title1", Size: 200} + + _ = ds.MediaFile(ctx).Put(&missingTrack1) + _ = ds.MediaFile(ctx).Put(&missingTrack2) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + in := &missingTracks{ + missing: []model.MediaFile{missingTrack1, missingTrack2}, + matched: []model.MediaFile{matchedTrack}, + } + + _, err := phase.processMissingTracks(in) + Expect(err).ToNot(HaveOccurred()) + // Only one of the missing tracks should be matched + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // The matched track should have been consumed by the first missing track + movedTrack, _ := ds.MediaFile(ctx).Get("1") + Expect(movedTrack.Path).To(Equal(matchedTrack.Path)) + + // The second missing track should remain unchanged + unmatchedTrack, _ := ds.MediaFile(ctx).Get("2") + Expect(unmatchedTrack.Path).To(Equal(missingTrack2.Path)) + }) + It("should return an error when there's an error moving the matched track", func() { missingTrack := model.MediaFile{ID: "1", PID: "A", Path: "path1.mp3", Tags: model.Tags{"title": []string{"title1"}}} matchedTrack := model.MediaFile{ID: "2", PID: "A", Path: "path1.mp3", Tags: model.Tags{"title": []string{"title1"}}} @@ -286,4 +356,604 @@ var _ = Describe("phaseMissingTracks", func() { }) }) }) + + Describe("processCrossLibraryMoves", func() { + It("should skip processing if input is nil", func() { + result, err := phase.processCrossLibraryMoves(nil) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(BeNil()) + }) + + It("should skip cross-library move detection when only one library is configured", func() { + // Default BeforeEach sets up single library, so we just need to verify skip behavior + Expect(state.totalLibraryCount).To(Equal(1)) + + missingTrack := model.MediaFile{ + ID: "missing1", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-123", + Title: "Test Track", + Size: 1000, + Suffix: "mp3", + Path: "/lib1/track.mp3", + Missing: true, + CreatedAt: time.Now().Add(-30 * time.Minute), + } + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + // Should return input unchanged (no processing done) + Expect(result).To(Equal(in)) + // No matches should be found since cross-library search was skipped + Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + // No changes should be detected + Expect(state.changesDetected.Load()).To(BeFalse()) + }) + + Context("with multiple libraries", func() { + BeforeEach(func() { + // Set up multiple libraries for cross-library move tests + state.libraries = model.Libraries{ + {ID: 1, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}, + {ID: 2, LastScanStartedAt: time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)}, + } + state.totalLibraryCount = 2 + }) + + It("should process cross-library moves using MusicBrainz Track ID", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing1", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-123", + Title: "Test Track", + Size: 1000, + Suffix: "mp3", + Path: "/lib1/track.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + movedTrack := model.MediaFile{ + ID: "moved1", + LibraryID: 2, + MbzReleaseTrackID: "mbz-track-123", + Title: "Test Track", + Size: 1000, + Suffix: "mp3", + Path: "/lib2/track.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&movedTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the move was performed + updatedTrack, _ := ds.MediaFile(ctx).Get("missing1") + Expect(updatedTrack.Path).To(Equal("/lib2/track.mp3")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should fall back to intrinsic properties when MBZ Track ID is empty", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing2", + LibraryID: 1, + MbzReleaseTrackID: "", + Title: "Test Track 2", + Size: 2000, + Suffix: "flac", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib1/track2.flac", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + movedTrack := model.MediaFile{ + ID: "moved2", + LibraryID: 2, + MbzReleaseTrackID: "", + Title: "Test Track 2", + Size: 2000, + Suffix: "flac", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib2/track2.flac", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&movedTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the move was performed + updatedTrack, _ := ds.MediaFile(ctx).Get("missing2") + Expect(updatedTrack.Path).To(Equal("/lib2/track2.flac")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should not match files in the same library", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing3", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-456", + Title: "Test Track 3", + Size: 3000, + Suffix: "mp3", + Path: "/lib1/track3.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + sameLibTrack := model.MediaFile{ + ID: "same1", + LibraryID: 1, // Same library + MbzReleaseTrackID: "mbz-track-456", + Title: "Test Track 3", + Size: 3000, + Suffix: "mp3", + Path: "/lib1/other/track3.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&sameLibTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + Expect(state.changesDetected.Load()).To(BeFalse()) + }) + + It("should prioritize MBZ Track ID over intrinsic properties", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing4", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-789", + Title: "Test Track 4", + Size: 4000, + Suffix: "mp3", + Path: "/lib1/track4.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + // Track with same MBZ ID + mbzTrack := model.MediaFile{ + ID: "mbz1", + LibraryID: 2, + MbzReleaseTrackID: "mbz-track-789", + Title: "Test Track 4", + Size: 4000, + Suffix: "mp3", + Path: "/lib2/track4.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + // Track with same intrinsic properties but no MBZ ID + intrinsicTrack := model.MediaFile{ + ID: "intrinsic1", + LibraryID: 3, + MbzReleaseTrackID: "", + Title: "Test Track 4", + Size: 4000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib3/track4.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-5 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&mbzTrack) + _ = ds.MediaFile(ctx).Put(&intrinsicTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the MBZ track was chosen (not the intrinsic one) + updatedTrack, _ := ds.MediaFile(ctx).Get("missing4") + Expect(updatedTrack.Path).To(Equal("/lib2/track4.mp3")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should handle equivalent matches correctly", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing5", + LibraryID: 1, + MbzReleaseTrackID: "", + Title: "Test Track 5", + Size: 5000, + Suffix: "mp3", + Path: "/lib1/path/track5.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + // Equivalent match (same filename, different directory) + equivalentTrack := model.MediaFile{ + ID: "equiv1", + LibraryID: 2, + MbzReleaseTrackID: "", + Title: "Test Track 5", + Size: 5000, + Suffix: "mp3", + Path: "/lib2/different/track5.mp3", + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&equivalentTrack) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(1))) + Expect(state.changesDetected.Load()).To(BeTrue()) + + // Verify the equivalent match was accepted + updatedTrack, _ := ds.MediaFile(ctx).Get("missing5") + Expect(updatedTrack.Path).To(Equal("/lib2/different/track5.mp3")) + Expect(updatedTrack.LibraryID).To(Equal(2)) + }) + + It("should skip matching when multiple matches are found but none are exact", func() { + scanStartTime := time.Now().Add(-1 * time.Hour) + missingTrack := model.MediaFile{ + ID: "missing6", + LibraryID: 1, + MbzReleaseTrackID: "", + Title: "Test Track 6", + Size: 6000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib1/track6.mp3", + Missing: true, + CreatedAt: scanStartTime.Add(-30 * time.Minute), + } + + // Multiple matches with different metadata (not exact matches) + match1 := model.MediaFile{ + ID: "match1", + LibraryID: 2, + MbzReleaseTrackID: "", + Title: "Test Track 6", + Size: 6000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib2/different_track.mp3", + Artist: "Different Artist", // This makes it non-exact + Missing: false, + CreatedAt: scanStartTime.Add(-10 * time.Minute), + } + + match2 := model.MediaFile{ + ID: "match2", + LibraryID: 3, + MbzReleaseTrackID: "", + Title: "Test Track 6", + Size: 6000, + Suffix: "mp3", + DiscNumber: 1, + TrackNumber: 1, + Album: "Test Album", + Path: "/lib3/another_track.mp3", + Artist: "Another Artist", // This makes it non-exact + Missing: false, + CreatedAt: scanStartTime.Add(-5 * time.Minute), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&match1) + _ = ds.MediaFile(ctx).Put(&match2) + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + Expect(state.changesDetected.Load()).To(BeFalse()) + + // Verify no move was performed + unchangedTrack, _ := ds.MediaFile(ctx).Get("missing6") + Expect(unchangedTrack.Path).To(Equal("/lib1/track6.mp3")) + Expect(unchangedTrack.LibraryID).To(Equal(1)) + }) + + It("should handle errors gracefully", func() { + // Set up mock to return error + mr.Err = true + + missingTrack := model.MediaFile{ + ID: "missing7", + LibraryID: 1, + MbzReleaseTrackID: "mbz-track-error", + Title: "Test Track 7", + Size: 7000, + Suffix: "mp3", + Path: "/lib1/track7.mp3", + Missing: true, + CreatedAt: time.Now().Add(-30 * time.Minute), + } + + in := &missingTracks{ + lib: model.Library{ID: 1, Name: "Library 1"}, + missing: []model.MediaFile{missingTrack}, + } + + // Should not fail completely, just skip the problematic file + result, err := phase.processCrossLibraryMoves(in) + Expect(err).ToNot(HaveOccurred()) + Expect(result).To(Equal(in)) + Expect(phase.totalMatched.Load()).To(Equal(uint32(0))) + Expect(state.changesDetected.Load()).To(BeFalse()) + }) + }) // End of Context "with multiple libraries" + }) + + Describe("CreatedAt preservation (#5050)", func() { + var albumRepo *tests.MockAlbumRepo + + BeforeEach(func() { + albumRepo = ds.Album(ctx).(*tests.MockAlbumRepo) + albumRepo.ReassignAnnotationCalls = make(map[string]string) + albumRepo.CopyAttributesCalls = make(map[string]string) + }) + + It("should preserve the missing track's created_at when moving within a library", func() { + originalTime := time.Date(2020, 3, 15, 10, 0, 0, 0, time.UTC) + missingTrack := model.MediaFile{ + ID: "1", PID: "A", Path: "old/song.mp3", + AlbumID: "album-1", + LibraryID: 1, + CreatedAt: originalTime, + Tags: model.Tags{"title": []string{"My Song"}}, + Size: 100, + } + matchedTrack := model.MediaFile{ + ID: "2", PID: "A", Path: "new/song.mp3", + AlbumID: "album-1", // Same album + LibraryID: 1, + CreatedAt: time.Now(), // Much newer + Tags: model.Tags{"title": []string{"My Song"}}, + Size: 100, + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + in := &missingTracks{ + missing: []model.MediaFile{missingTrack}, + matched: []model.MediaFile{matchedTrack}, + } + + _, err := phase.processMissingTracks(in) + Expect(err).ToNot(HaveOccurred()) + + movedTrack, _ := ds.MediaFile(ctx).Get("1") + Expect(movedTrack.Path).To(Equal("new/song.mp3")) + Expect(movedTrack.CreatedAt).To(Equal(originalTime)) + }) + + It("should preserve created_at during cross-library moves with album change", func() { + originalTime := time.Date(2019, 6, 1, 12, 0, 0, 0, time.UTC) + missingTrack := model.MediaFile{ + ID: "missing-ca", PID: "B", Path: "lib1/song.mp3", + AlbumID: "old-album", + LibraryID: 1, + CreatedAt: originalTime, + } + matchedTrack := model.MediaFile{ + ID: "matched-ca", PID: "B", Path: "lib2/song.mp3", + AlbumID: "new-album", + LibraryID: 2, + CreatedAt: time.Now(), + } + + // Set up albums so CopyAttributes can find them + albumRepo.SetData(model.Albums{ + {ID: "old-album", LibraryID: 1, CreatedAt: originalTime}, + {ID: "new-album", LibraryID: 2, CreatedAt: time.Now()}, + }) + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + err := phase.moveMatched(matchedTrack, missingTrack) + Expect(err).ToNot(HaveOccurred()) + + // Track's created_at should be preserved from the missing file + movedTrack, _ := ds.MediaFile(ctx).Get("missing-ca") + Expect(movedTrack.CreatedAt).To(Equal(originalTime)) + + // Album's created_at should be copied from old to new + Expect(albumRepo.CopyAttributesCalls).To(HaveKeyWithValue("old-album", "new-album")) + + // Verify the new album's CreatedAt was actually updated + newAlbum, err := albumRepo.Get("new-album") + Expect(err).ToNot(HaveOccurred()) + Expect(newAlbum.CreatedAt).To(Equal(originalTime)) + }) + + It("should not copy album created_at when album ID does not change", func() { + originalTime := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC) + missingTrack := model.MediaFile{ + ID: "missing-same", PID: "C", Path: "dir1/song.mp3", + AlbumID: "same-album", + LibraryID: 1, + CreatedAt: originalTime, + } + matchedTrack := model.MediaFile{ + ID: "matched-same", PID: "C", Path: "dir2/song.mp3", + AlbumID: "same-album", // Same album + LibraryID: 1, + CreatedAt: time.Now(), + } + + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + + err := phase.moveMatched(matchedTrack, missingTrack) + Expect(err).ToNot(HaveOccurred()) + + // Track's created_at should still be preserved + movedTrack, _ := ds.MediaFile(ctx).Get("missing-same") + Expect(movedTrack.CreatedAt).To(Equal(originalTime)) + + // CopyAttributes should NOT have been called (same album) + Expect(albumRepo.CopyAttributesCalls).To(BeEmpty()) + }) + }) + + Describe("Album Annotation Reassignment", func() { + var ( + albumRepo *tests.MockAlbumRepo + missingTrack model.MediaFile + matchedTrack model.MediaFile + oldAlbumID string + newAlbumID string + ) + + BeforeEach(func() { + albumRepo = ds.Album(ctx).(*tests.MockAlbumRepo) + albumRepo.ReassignAnnotationCalls = make(map[string]string) + + oldAlbumID = "old-album-id" + newAlbumID = "new-album-id" + + missingTrack = model.MediaFile{ + ID: "missing-track-id", + PID: "same-pid", + Path: "old/path.mp3", + AlbumID: oldAlbumID, + LibraryID: 1, + Missing: true, + Annotations: model.Annotations{ + PlayCount: 5, + Rating: 4, + Starred: true, + }, + } + + matchedTrack = model.MediaFile{ + ID: "matched-track-id", + PID: "same-pid", + Path: "new/path.mp3", + AlbumID: newAlbumID, + LibraryID: 2, // Different library + Missing: false, + Annotations: model.Annotations{ + PlayCount: 2, + Rating: 3, + Starred: false, + }, + } + + // Store both tracks in the database + _ = ds.MediaFile(ctx).Put(&missingTrack) + _ = ds.MediaFile(ctx).Put(&matchedTrack) + }) + + When("album ID changes during cross-library move", func() { + It("should reassign album annotations when AlbumID changes", func() { + err := phase.moveMatched(matchedTrack, missingTrack) + Expect(err).ToNot(HaveOccurred()) + + // Verify that ReassignAnnotation was called + Expect(albumRepo.ReassignAnnotationCalls).To(HaveKeyWithValue(oldAlbumID, newAlbumID)) + }) + + It("should not reassign annotations when AlbumID is the same", func() { + missingTrack.AlbumID = newAlbumID // Same album + + err := phase.moveMatched(matchedTrack, missingTrack) + Expect(err).ToNot(HaveOccurred()) + + // Verify that ReassignAnnotation was NOT called + Expect(albumRepo.ReassignAnnotationCalls).To(BeEmpty()) + }) + }) + + When("error handling", func() { + It("should handle ReassignAnnotation errors gracefully", func() { + // Make the album repo return an error + albumRepo.SetError(true) + + // The move should still succeed even if annotation reassignment fails + err := phase.moveMatched(matchedTrack, missingTrack) + Expect(err).ToNot(HaveOccurred()) + + // Verify that the track was still moved (ID should be updated) + movedTrack, err := ds.MediaFile(ctx).Get(missingTrack.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(movedTrack.Path).To(Equal(matchedTrack.Path)) + }) + }) + }) }) diff --git a/scanner/phase_3_refresh_albums.go b/scanner/phase_3_refresh_albums.go index f51aa8f4b..33e0fed01 100644 --- a/scanner/phase_3_refresh_albums.go +++ b/scanner/phase_3_refresh_albums.go @@ -27,14 +27,13 @@ import ( type phaseRefreshAlbums struct { ds model.DataStore ctx context.Context - libs model.Libraries refreshed atomic.Uint32 skipped atomic.Uint32 state *scanState } -func createPhaseRefreshAlbums(ctx context.Context, state *scanState, ds model.DataStore, libs model.Libraries) *phaseRefreshAlbums { - return &phaseRefreshAlbums{ctx: ctx, ds: ds, libs: libs, state: state} +func createPhaseRefreshAlbums(ctx context.Context, state *scanState, ds model.DataStore) *phaseRefreshAlbums { + return &phaseRefreshAlbums{ctx: ctx, ds: ds, state: state} } func (p *phaseRefreshAlbums) description() string { @@ -47,7 +46,7 @@ func (p *phaseRefreshAlbums) producer() ppl.Producer[*model.Album] { func (p *phaseRefreshAlbums) produce(put func(album *model.Album)) error { count := 0 - for _, lib := range p.libs { + for _, lib := range p.state.libraries { cursor, err := p.ds.Album(p.ctx).GetTouchedAlbums(lib.ID) if err != nil { return fmt.Errorf("loading touched albums: %w", err) diff --git a/scanner/phase_3_refresh_albums_test.go b/scanner/phase_3_refresh_albums_test.go index dea2556f0..1f0baf428 100644 --- a/scanner/phase_3_refresh_albums_test.go +++ b/scanner/phase_3_refresh_albums_test.go @@ -32,8 +32,8 @@ var _ = Describe("phaseRefreshAlbums", func() { {ID: 1, Name: "Library 1"}, {ID: 2, Name: "Library 2"}, } - state = &scanState{} - phase = createPhaseRefreshAlbums(ctx, state, ds, libs) + state = &scanState{libraries: libs} + phase = createPhaseRefreshAlbums(ctx, state, ds) }) Describe("description", func() { diff --git a/scanner/phase_4_playlists.go b/scanner/phase_4_playlists.go index c98b51ee6..d52743966 100644 --- a/scanner/phase_4_playlists.go +++ b/scanner/phase_4_playlists.go @@ -10,8 +10,8 @@ import ( ppl "github.com/google/go-pipeline/pkg/pipeline" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" @@ -21,12 +21,12 @@ type phasePlaylists struct { ctx context.Context scanState *scanState ds model.DataStore - pls core.Playlists + pls playlists.Playlists cw artwork.CacheWarmer refreshed atomic.Uint32 } -func createPhasePlaylists(ctx context.Context, scanState *scanState, ds model.DataStore, pls core.Playlists, cw artwork.CacheWarmer) *phasePlaylists { +func createPhasePlaylists(ctx context.Context, scanState *scanState, ds model.DataStore, pls playlists.Playlists, cw artwork.CacheWarmer) *phasePlaylists { return &phasePlaylists{ ctx: ctx, scanState: scanState, @@ -50,7 +50,7 @@ func (p *phasePlaylists) produce(put func(entry *model.Folder)) error { return nil } u, _ := request.UserFrom(p.ctx) - if !u.IsAdmin { + if !u.IsAdmin || u.ID == "" { log.Warn(p.ctx, "Playlists will not be imported, as there are no admin users yet, "+ "Please create an admin user first, and then update the playlists for them to be imported") return nil @@ -100,7 +100,7 @@ func (p *phasePlaylists) processPlaylistsInFolder(folder *model.Folder) (*model. continue } // BFR: Check if playlist needs to be refreshed (timestamp, sync flag, etc) - pls, err := p.pls.ImportFile(p.ctx, folder, f.Name()) + pls, err := p.pls.ImportFromFolder(p.ctx, folder, f.Name()) if err != nil { continue } diff --git a/scanner/phase_4_playlists_test.go b/scanner/phase_4_playlists_test.go index 218aa3c7b..0e01a7549 100644 --- a/scanner/phase_4_playlists_test.go +++ b/scanner/phase_4_playlists_test.go @@ -9,8 +9,8 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/tests" @@ -97,9 +97,9 @@ var _ = Describe("phasePlaylists", func() { _ = os.WriteFile(file1, []byte{}, 0600) _ = os.WriteFile(file2, []byte{}, 0600) - pls.On("ImportFile", mock.Anything, folder, "playlist1.m3u"). + pls.On("ImportFromFolder", mock.Anything, folder, "playlist1.m3u"). Return(&model.Playlist{}, nil) - pls.On("ImportFile", mock.Anything, folder, "playlist2.m3u"). + pls.On("ImportFromFolder", mock.Anything, folder, "playlist2.m3u"). Return(&model.Playlist{}, nil) _, err := phase.processPlaylistsInFolder(folder) @@ -111,6 +111,7 @@ var _ = Describe("phasePlaylists", func() { }) It("reports an error if there is an error reading files", func() { + tests.SkipOnWindows("relies on Unix /etc filesystem") progress := make(chan *ProgressInfo) state.progress = progress folder := &model.Folder{Path: "/invalid/path"} @@ -130,10 +131,10 @@ var _ = Describe("phasePlaylists", func() { type mockPlaylists struct { mock.Mock - core.Playlists + playlists.Playlists } -func (p *mockPlaylists) ImportFile(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) { +func (p *mockPlaylists) ImportFromFolder(ctx context.Context, folder *model.Folder, filename string) (*model.Playlist, error) { args := p.Called(ctx, folder, filename) return args.Get(0).(*model.Playlist), args.Error(1) } diff --git a/scanner/scanner.go b/scanner/scanner.go index f08dec311..871b0c696 100644 --- a/scanner/scanner.go +++ b/scanner/scanner.go @@ -3,33 +3,37 @@ package scanner import ( "context" "fmt" + "maps" + "slices" "sync/atomic" "time" ppl "github.com/google/go-pipeline/pkg/pipeline" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" - "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/utils/chain" + "github.com/navidrome/navidrome/utils/run" + "github.com/navidrome/navidrome/utils/slice" ) type scannerImpl struct { - ds model.DataStore - cw artwork.CacheWarmer - pls core.Playlists - metrics metrics.Metrics + ds model.DataStore + cw artwork.CacheWarmer + pls playlists.Playlists } // scanState holds the state of an in-progress scan, to be passed to the various phases type scanState struct { - progress chan<- *ProgressInfo - fullScan bool - changesDetected atomic.Bool + progress chan<- *ProgressInfo + fullScan bool + changesDetected atomic.Bool + libraries model.Libraries // Store libraries list for consistency across phases + targets map[int][]string // Optional: map[libraryID][]folderPaths for selective scans + totalLibraryCount int // Total number of libraries (unfiltered), for cross-library move detection } func (s *scanState) sendProgress(info *ProgressInfo) { @@ -38,6 +42,10 @@ func (s *scanState) sendProgress(info *ProgressInfo) { } } +func (s *scanState) isSelectiveScan() bool { + return len(s.targets) > 0 +} + func (s *scanState) sendWarning(msg string) { s.sendProgress(&ProgressInfo{Warning: msg}) } @@ -46,48 +54,98 @@ func (s *scanState) sendError(err error) { s.sendProgress(&ProgressInfo{Error: err.Error()}) } -func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan<- *ProgressInfo) { - state := scanState{progress: progress, fullScan: fullScan} - libs, err := s.ds.Library(ctx).GetAll() +func (s *scannerImpl) scanFolders(ctx context.Context, fullScan bool, targets []model.ScanTarget, progress chan<- *ProgressInfo) { + startTime := time.Now() + + state := scanState{ + progress: progress, + fullScan: fullScan, + changesDetected: atomic.Bool{}, + } + + // Set changesDetected to true for full scans to ensure all maintenance operations run + if fullScan { + state.changesDetected.Store(true) + } + + // Get libraries and optionally filter by targets + allLibs, err := s.ds.Library(ctx).GetAll() if err != nil { state.sendWarning(fmt.Sprintf("getting libraries: %s", err)) return } + state.totalLibraryCount = len(allLibs) - startTime := time.Now() - log.Info(ctx, "Scanner: Starting scan", "fullScan", state.fullScan, "numLibraries", len(libs)) + if len(targets) > 0 { + // Selective scan: filter libraries and build targets map + state.targets = make(map[int][]string) + + for _, target := range targets { + folderPath := target.FolderPath + if folderPath == "" { + folderPath = "." + } + state.targets[target.LibraryID] = append(state.targets[target.LibraryID], folderPath) + } + + // Filter libraries to only those in targets + state.libraries = slice.Filter(allLibs, func(lib model.Library) bool { + return len(state.targets[lib.ID]) > 0 + }) + + log.Info(ctx, "Scanner: Starting selective scan", "fullScan", state.fullScan, "numLibraries", len(state.libraries), "numTargets", len(targets)) + } else { + // Full library scan + state.libraries = allLibs + log.Info(ctx, "Scanner: Starting scan", "fullScan", state.fullScan, "numLibraries", len(state.libraries)) + } // Store scan type and start time scanType := "quick" if state.fullScan { scanType = "full" } + if state.isSelectiveScan() { + scanType += "-selective" + } _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, scanType) _ = s.ds.Property(ctx).Put(consts.LastScanStartTimeKey, startTime.Format(time.RFC3339)) // if there was a full scan in progress, force a full scan if !state.fullScan { - for _, lib := range libs { + for _, lib := range state.libraries { if lib.FullScanInProgress { log.Info(ctx, "Scanner: Interrupted full scan detected", "lib", lib.Name) state.fullScan = true - _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, "full") + if state.isSelectiveScan() { + _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, "full-selective") + } else { + _ = s.ds.Property(ctx).Put(consts.LastScanTypeKey, "full") + } break } } } - err = chain.RunSequentially( + // Prepare libraries for scanning (initialize LastScanStartedAt if needed) + err = s.prepareLibrariesForScan(ctx, &state) + if err != nil { + log.Error(ctx, "Scanner: Error preparing libraries for scan", err) + state.sendError(err) + return + } + + err = run.Sequentially( // Phase 1: Scan all libraries and import new/updated files - runPhase[*folderEntry](ctx, 1, createPhaseFolders(ctx, &state, s.ds, s.cw, libs)), + runPhase[*folderEntry](ctx, 1, createPhaseFolders(ctx, &state, s.ds, s.cw)), // Phase 2: Process missing files, checking for moves runPhase[*missingTracks](ctx, 2, createPhaseMissingTracks(ctx, &state, s.ds)), // Phases 3 and 4 can be run in parallel - chain.RunParallel( + run.Parallel( // Phase 3: Refresh all new/changed albums and update artists - runPhase[*model.Album](ctx, 3, createPhaseRefreshAlbums(ctx, &state, s.ds, libs)), + runPhase[*model.Album](ctx, 3, createPhaseRefreshAlbums(ctx, &state, s.ds)), // Phase 4: Import/update playlists runPhase[*model.Folder](ctx, 4, createPhasePlaylists(ctx, &state, s.ds, s.pls, s.cw)), @@ -102,7 +160,7 @@ func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan< s.runRefreshStats(ctx, &state), // Update last_scan_completed_at for all libraries - s.runUpdateLibraries(ctx, libs), + s.runUpdateLibraries(ctx, &state), // Optimize DB s.runOptimize(ctx), @@ -111,7 +169,6 @@ func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan< log.Error(ctx, "Scanner: Finished with error", "duration", time.Since(startTime), err) _ = s.ds.Property(ctx).Put(consts.LastScanErrorKey, err.Error()) state.sendError(err) - s.metrics.WriteAfterScanMetrics(ctx, false) return } @@ -121,8 +178,53 @@ func (s *scannerImpl) scanAll(ctx context.Context, fullScan bool, progress chan< state.sendProgress(&ProgressInfo{ChangesDetected: true}) } - s.metrics.WriteAfterScanMetrics(ctx, err == nil) - log.Info(ctx, "Scanner: Finished scanning all libraries", "duration", time.Since(startTime)) + if state.isSelectiveScan() { + log.Info(ctx, "Scanner: Finished scanning selected folders", "duration", time.Since(startTime), "numTargets", len(targets)) + } else { + log.Info(ctx, "Scanner: Finished scanning all libraries", "duration", time.Since(startTime)) + } +} + +// prepareLibrariesForScan initializes the scan for all libraries in the state. +// It calls ScanBegin for libraries that haven't started scanning yet (LastScanStartedAt is zero), +// reloads them to get the updated state, and filters out any libraries that fail to initialize. +func (s *scannerImpl) prepareLibrariesForScan(ctx context.Context, state *scanState) error { + var successfulLibs []model.Library + + for _, lib := range state.libraries { + if lib.LastScanStartedAt.IsZero() { + // This is a new scan - mark it as started + err := s.ds.Library(ctx).ScanBegin(lib.ID, state.fullScan) + if err != nil { + log.Error(ctx, "Scanner: Error marking scan start", "lib", lib.Name, err) + state.sendWarning(err.Error()) + continue + } + + // Reload library to get updated state (timestamps, etc.) + reloadedLib, err := s.ds.Library(ctx).Get(lib.ID) + if err != nil { + log.Error(ctx, "Scanner: Error reloading library", "lib", lib.Name, err) + state.sendWarning(err.Error()) + continue + } + lib = *reloadedLib + } else { + // This is a resumed scan + log.Debug(ctx, "Scanner: Resuming previous scan", "lib", lib.Name, + "lastScanStartedAt", lib.LastScanStartedAt, "fullScan", lib.FullScanInProgress) + } + + successfulLibs = append(successfulLibs, lib) + } + + if len(successfulLibs) == 0 { + return fmt.Errorf("no libraries available for scanning") + } + + // Update state with only successfully initialized libraries + state.libraries = successfulLibs + return nil } func (s *scannerImpl) runGC(ctx context.Context, state *scanState) func() error { @@ -131,7 +233,15 @@ func (s *scannerImpl) runGC(ctx context.Context, state *scanState) func() error return s.ds.WithTx(func(tx model.DataStore) error { if state.changesDetected.Load() { start := time.Now() - err := tx.GC(ctx) + + // For selective scans, extract library IDs to scope GC operations + var libraryIDs []int + if state.isSelectiveScan() { + libraryIDs = slices.Collect(maps.Keys(state.targets)) + log.Debug(ctx, "Scanner: Running selective GC", "libraryIDs", libraryIDs) + } + + err := tx.GC(ctx, libraryIDs...) if err != nil { log.Error(ctx, "Scanner: Error running GC", err) return fmt.Errorf("running GC: %w", err) @@ -152,7 +262,7 @@ func (s *scannerImpl) runRefreshStats(ctx context.Context, state *scanState) fun return nil } start := time.Now() - stats, err := s.ds.Artist(ctx).RefreshStats() + stats, err := s.ds.Artist(ctx).RefreshStats(state.fullScan) if err != nil { log.Error(ctx, "Scanner: Error refreshing artists stats", err) return fmt.Errorf("refreshing artists stats: %w", err) @@ -179,10 +289,11 @@ func (s *scannerImpl) runOptimize(ctx context.Context) func() error { } } -func (s *scannerImpl) runUpdateLibraries(ctx context.Context, libs model.Libraries) func() error { +func (s *scannerImpl) runUpdateLibraries(ctx context.Context, state *scanState) func() error { return func() error { + start := time.Now() return s.ds.WithTx(func(tx model.DataStore) error { - for _, lib := range libs { + for _, lib := range state.libraries { err := tx.Library(ctx).ScanEnd(lib.ID) if err != nil { log.Error(ctx, "Scanner: Error updating last scan completed", "lib", lib.Name, err) @@ -198,7 +309,17 @@ func (s *scannerImpl) runUpdateLibraries(ctx context.Context, libs model.Librari log.Error(ctx, "Scanner: Error updating album PID conf", err) return fmt.Errorf("updating album PID conf: %w", err) } + if state.changesDetected.Load() { + log.Debug(ctx, "Scanner: Refreshing library stats", "lib", lib.Name) + if err := tx.Library(ctx).RefreshStats(lib.ID); err != nil { + log.Error(ctx, "Scanner: Error refreshing library stats", "lib", lib.Name, err) + return fmt.Errorf("refreshing library stats: %w", err) + } + } else { + log.Debug(ctx, "Scanner: No changes detected, skipping library stats refresh", "lib", lib.Name) + } } + log.Debug(ctx, "Scanner: Updated libraries after scan", "elapsed", time.Since(start), "numLibraries", len(state.libraries)) return nil }, "scanner: update libraries") } diff --git a/scanner/scanner_benchmark_test.go b/scanner/scanner_benchmark_test.go index 2b1c0a140..8f0dcd340 100644 --- a/scanner/scanner_benchmark_test.go +++ b/scanner/scanner_benchmark_test.go @@ -15,6 +15,7 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/storage/storagetest" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/model" @@ -40,7 +41,7 @@ func BenchmarkScan(b *testing.B) { ds := persistence.New(db.Db()) conf.Server.DevExternalScanner = false s := scanner.New(context.Background(), ds, artwork.NoopCacheWarmer(), events.NoopBroker(), - core.NewPlaylists(ds), metrics.NewNoopInstance()) + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) fs := storagetest.FakeFS{} storagetest.Register("fake", &fs) diff --git a/scanner/scanner_multilibrary_test.go b/scanner/scanner_multilibrary_test.go new file mode 100644 index 000000000..3ae50933c --- /dev/null +++ b/scanner/scanner_multilibrary_test.go @@ -0,0 +1,839 @@ +package scanner_test + +import ( + "context" + "errors" + "path/filepath" + "testing/fstest" + "time" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/tests" + "github.com/navidrome/navidrome/utils/slice" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Scanner - Multi-Library", Ordered, func() { + var ctx context.Context + var lib1, lib2 model.Library + var ds *tests.MockDataStore + var s model.Scanner + + createFS := func(path string, files fstest.MapFS) storagetest.FakeFS { + fs := storagetest.FakeFS{} + fs.SetFiles(files) + storagetest.Register(path, &fs) + return fs + } + + BeforeAll(func() { + tests.SkipOnWindows("SQLite file lock blocks TempDir cleanup (#TBD-path-sep-scanner)") + ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "123", IsAdmin: true}) + tmpDir := GinkgoT().TempDir() + conf.Server.DbPath = filepath.Join(tmpDir, "test-scanner-multilibrary.db?_journal_mode=WAL") + log.Warn("Using DB at " + conf.Server.DbPath) + db.Db().SetMaxOpenConns(1) + }) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.MusicFolder = "default:///music" // Use a distinct schema for the default library + conf.Server.DevExternalScanner = false + + // Register an empty fake storage for the default library + emptyFS := storagetest.FakeFS{} + emptyFS.SetFiles(fstest.MapFS{}) + storagetest.Register("default", &emptyFS) + + db.Init(ctx) + DeferCleanup(func() { + Expect(tests.ClearDB()).To(Succeed()) + }) + + ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} + + // Create the admin user in the database to match the context + adminUser := model.User{ + ID: "123", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&adminUser)).To(Succeed()) + + s = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + + // Create two test libraries (let DB auto-assign IDs) + lib1 = model.Library{Name: "Rock Collection", Path: "rock:///music"} + lib2 = model.Library{Name: "Jazz Collection", Path: "jazz:///music"} + Expect(ds.Library(ctx).Put(&lib1)).To(Succeed()) + Expect(ds.Library(ctx).Put(&lib2)).To(Succeed()) + }) + + runScanner := func(ctx context.Context, fullScan bool) error { + _, err := s.ScanAll(ctx, fullScan) + return err + } + + Context("Two Libraries with Different Content", func() { + BeforeEach(func() { + // Rock library content + beatles := template(_t{"albumartist": "The Beatles", "album": "Abbey Road", "year": 1969, "genre": "Rock"}) + zeppelin := template(_t{"albumartist": "Led Zeppelin", "album": "IV", "year": 1971, "genre": "Rock"}) + + _ = createFS("rock", fstest.MapFS{ + "The Beatles/Abbey Road/01 - Come Together.mp3": beatles(track(1, "Come Together")), + "The Beatles/Abbey Road/02 - Something.mp3": beatles(track(2, "Something")), + "Led Zeppelin/IV/01 - Black Dog.mp3": zeppelin(track(1, "Black Dog")), + "Led Zeppelin/IV/02 - Rock and Roll.mp3": zeppelin(track(2, "Rock and Roll")), + }) + + // Jazz library content + miles := template(_t{"albumartist": "Miles Davis", "album": "Kind of Blue", "year": 1959, "genre": "Jazz"}) + coltrane := template(_t{"albumartist": "John Coltrane", "album": "Giant Steps", "year": 1960, "genre": "Jazz"}) + + _ = createFS("jazz", fstest.MapFS{ + "Miles Davis/Kind of Blue/01 - So What.mp3": miles(track(1, "So What")), + "Miles Davis/Kind of Blue/02 - Freddie Freeloader.mp3": miles(track(2, "Freddie Freeloader")), + "John Coltrane/Giant Steps/01 - Giant Steps.mp3": coltrane(track(1, "Giant Steps")), + "John Coltrane/Giant Steps/02 - Cousin Mary.mp3": coltrane(track(2, "Cousin Mary")), + }) + }) + + When("scanning both libraries", func() { + It("should import files with correct library_id", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + // Check Rock library media files + rockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + Sort: "title", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(rockFiles).To(HaveLen(4)) + + rockTitles := slice.Map(rockFiles, func(f model.MediaFile) string { return f.Title }) + Expect(rockTitles).To(ContainElements("Come Together", "Something", "Black Dog", "Rock and Roll")) + + // Verify all rock files have correct library_id + for _, mf := range rockFiles { + Expect(mf.LibraryID).To(Equal(lib1.ID), "Rock file %s should have library_id %d", mf.Title, lib1.ID) + } + + // Check Jazz library media files + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + Sort: "title", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(4)) + + jazzTitles := slice.Map(jazzFiles, func(f model.MediaFile) string { return f.Title }) + Expect(jazzTitles).To(ContainElements("So What", "Freddie Freeloader", "Giant Steps", "Cousin Mary")) + + // Verify all jazz files have correct library_id + for _, mf := range jazzFiles { + Expect(mf.LibraryID).To(Equal(lib2.ID), "Jazz file %s should have library_id %d", mf.Title, lib2.ID) + } + }) + + It("should create albums with correct library_id", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + // Check Rock library albums + rockAlbums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + Sort: "name", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(rockAlbums).To(HaveLen(2)) + Expect(rockAlbums[0].Name).To(Equal("Abbey Road")) + Expect(rockAlbums[0].LibraryID).To(Equal(lib1.ID)) + Expect(rockAlbums[0].SongCount).To(Equal(2)) + Expect(rockAlbums[1].Name).To(Equal("IV")) + Expect(rockAlbums[1].LibraryID).To(Equal(lib1.ID)) + Expect(rockAlbums[1].SongCount).To(Equal(2)) + + // Check Jazz library albums + jazzAlbums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + Sort: "name", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzAlbums).To(HaveLen(2)) + Expect(jazzAlbums[0].Name).To(Equal("Giant Steps")) + Expect(jazzAlbums[0].LibraryID).To(Equal(lib2.ID)) + Expect(jazzAlbums[0].SongCount).To(Equal(2)) + Expect(jazzAlbums[1].Name).To(Equal("Kind of Blue")) + Expect(jazzAlbums[1].LibraryID).To(Equal(lib2.ID)) + Expect(jazzAlbums[1].SongCount).To(Equal(2)) + }) + + It("should create folders with correct library_id", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + // Check Rock library folders + rockFolders, err := ds.Folder(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(rockFolders).To(HaveLen(5)) // ., The Beatles, Led Zeppelin, Abbey Road, IV + + for _, folder := range rockFolders { + Expect(folder.LibraryID).To(Equal(lib1.ID), "Rock folder %s should have library_id %d", folder.Name, lib1.ID) + } + + // Check Jazz library folders + jazzFolders, err := ds.Folder(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFolders).To(HaveLen(5)) // ., Miles Davis, John Coltrane, Kind of Blue, Giant Steps + + for _, folder := range jazzFolders { + Expect(folder.LibraryID).To(Equal(lib2.ID), "Jazz folder %s should have library_id %d", folder.Name, lib2.ID) + } + }) + + It("should create library-artist associations correctly", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + // Check library-artist associations + + // Get all artists and check library associations + allArtists, err := ds.Artist(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + + rockArtistNames := []string{} + jazzArtistNames := []string{} + + for _, artist := range allArtists { + // Check if artist is associated with rock library + var count int64 + err := db.Db().QueryRow( + "SELECT COUNT(*) FROM library_artist WHERE library_id = ? AND artist_id = ?", + lib1.ID, artist.ID, + ).Scan(&count) + Expect(err).ToNot(HaveOccurred()) + if count > 0 { + rockArtistNames = append(rockArtistNames, artist.Name) + } + + // Check if artist is associated with jazz library + err = db.Db().QueryRow( + "SELECT COUNT(*) FROM library_artist WHERE library_id = ? AND artist_id = ?", + lib2.ID, artist.ID, + ).Scan(&count) + Expect(err).ToNot(HaveOccurred()) + if count > 0 { + jazzArtistNames = append(jazzArtistNames, artist.Name) + } + } + + Expect(rockArtistNames).To(ContainElements("The Beatles", "Led Zeppelin")) + Expect(jazzArtistNames).To(ContainElements("Miles Davis", "John Coltrane")) + + // Artists should not be shared between libraries (except [Unknown Artist]) + for _, name := range rockArtistNames { + if name != "[Unknown Artist]" { + Expect(jazzArtistNames).ToNot(ContainElement(name)) + } + } + }) + + It("should update library statistics correctly", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + // Check Rock library stats + rockLib, err := ds.Library(ctx).Get(lib1.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(rockLib.TotalSongs).To(Equal(4)) + Expect(rockLib.TotalAlbums).To(Equal(2)) + + Expect(rockLib.TotalArtists).To(Equal(3)) // The Beatles, Led Zeppelin, [Unknown Artist] + Expect(rockLib.TotalFolders).To(Equal(2)) // Abbey Road, IV (only folders with audio files) + + // Check Jazz library stats + jazzLib, err := ds.Library(ctx).Get(lib2.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzLib.TotalSongs).To(Equal(4)) + Expect(jazzLib.TotalAlbums).To(Equal(2)) + Expect(jazzLib.TotalArtists).To(Equal(3)) // Miles Davis, John Coltrane, [Unknown Artist] + Expect(jazzLib.TotalFolders).To(Equal(2)) // Kind of Blue, Giant Steps (only folders with audio files) + }) + }) + + When("libraries have different content", func() { + It("should maintain separate statistics per library", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify rock library stats + rockLib, err := ds.Library(ctx).Get(lib1.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(rockLib.TotalSongs).To(Equal(4)) + Expect(rockLib.TotalAlbums).To(Equal(2)) + + // Verify jazz library stats + jazzLib, err := ds.Library(ctx).Get(lib2.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzLib.TotalSongs).To(Equal(4)) + Expect(jazzLib.TotalAlbums).To(Equal(2)) + + // Verify that libraries don't interfere with each other + rockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(rockFiles).To(HaveLen(4)) + + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(4)) + }) + }) + + When("verifying library isolation", func() { + It("should keep library data completely separate", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify that rock library only contains rock content + rockAlbums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + rockAlbumNames := slice.Map(rockAlbums, func(a model.Album) string { return a.Name }) + Expect(rockAlbumNames).To(ContainElements("Abbey Road", "IV")) + Expect(rockAlbumNames).ToNot(ContainElements("Kind of Blue", "Giant Steps")) + + // Verify that jazz library only contains jazz content + jazzAlbums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + jazzAlbumNames := slice.Map(jazzAlbums, func(a model.Album) string { return a.Name }) + Expect(jazzAlbumNames).To(ContainElements("Kind of Blue", "Giant Steps")) + Expect(jazzAlbumNames).ToNot(ContainElements("Abbey Road", "IV")) + }) + }) + + When("same artist appears in different libraries", func() { + It("should associate artist with both libraries correctly", func() { + // Create libraries with Jeff Beck albums in both + jeffRock := template(_t{"albumartist": "Jeff Beck", "album": "Truth", "year": 1968, "genre": "Rock"}) + jeffJazz := template(_t{"albumartist": "Jeff Beck", "album": "Blow by Blow", "year": 1975, "genre": "Jazz"}) + beatles := template(_t{"albumartist": "The Beatles", "album": "Abbey Road", "year": 1969, "genre": "Rock"}) + miles := template(_t{"albumartist": "Miles Davis", "album": "Kind of Blue", "year": 1959, "genre": "Jazz"}) + + // Create rock library with Jeff Beck's Truth album + _ = createFS("rock", fstest.MapFS{ + "The Beatles/Abbey Road/01 - Come Together.mp3": beatles(track(1, "Come Together")), + "The Beatles/Abbey Road/02 - Something.mp3": beatles(track(2, "Something")), + "Jeff Beck/Truth/01 - Beck's Bolero.mp3": jeffRock(track(1, "Beck's Bolero")), + "Jeff Beck/Truth/02 - Ol' Man River.mp3": jeffRock(track(2, "Ol' Man River")), + }) + + // Create jazz library with Jeff Beck's Blow by Blow album + _ = createFS("jazz", fstest.MapFS{ + "Miles Davis/Kind of Blue/01 - So What.mp3": miles(track(1, "So What")), + "Miles Davis/Kind of Blue/02 - Freddie Freeloader.mp3": miles(track(2, "Freddie Freeloader")), + "Jeff Beck/Blow by Blow/01 - You Know What I Mean.mp3": jeffJazz(track(1, "You Know What I Mean")), + "Jeff Beck/Blow by Blow/02 - She's a Woman.mp3": jeffJazz(track(2, "She's a Woman")), + }) + + Expect(runScanner(ctx, true)).To(Succeed()) + + // Jeff Beck should be associated with both libraries + var rockCount, jazzCount int64 + + // Get Jeff Beck artist ID + jeffArtists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "Jeff Beck"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jeffArtists).To(HaveLen(1)) + jeffID := jeffArtists[0].ID + + // Check rock library association + err = db.Db().QueryRow( + "SELECT COUNT(*) FROM library_artist WHERE library_id = ? AND artist_id = ?", + lib1.ID, jeffID, + ).Scan(&rockCount) + Expect(err).ToNot(HaveOccurred()) + Expect(rockCount).To(Equal(int64(1))) + + // Check jazz library association + err = db.Db().QueryRow( + "SELECT COUNT(*) FROM library_artist WHERE library_id = ? AND artist_id = ?", + lib2.ID, jeffID, + ).Scan(&jazzCount) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzCount).To(Equal(int64(1))) + + // Verify Jeff Beck albums are in correct libraries + rockAlbums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID, "album_artist": "Jeff Beck"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(rockAlbums).To(HaveLen(1)) + Expect(rockAlbums[0].Name).To(Equal("Truth")) + + jazzAlbums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID, "album_artist": "Jeff Beck"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzAlbums).To(HaveLen(1)) + Expect(jazzAlbums[0].Name).To(Equal("Blow by Blow")) + }) + }) + }) + + Context("Incremental Scan Behavior", func() { + BeforeEach(func() { + // Start with minimal content in both libraries + rock := template(_t{"albumartist": "Queen", "album": "News of the World", "year": 1977, "genre": "Rock"}) + jazz := template(_t{"albumartist": "Bill Evans", "album": "Waltz for Debby", "year": 1961, "genre": "Jazz"}) + + createFS("rock", fstest.MapFS{ + "Queen/News of the World/01 - We Will Rock You.mp3": rock(track(1, "We Will Rock You")), + }) + + createFS("jazz", fstest.MapFS{ + "Bill Evans/Waltz for Debby/01 - My Foolish Heart.mp3": jazz(track(1, "My Foolish Heart")), + }) + }) + + It("should handle incremental scans per library correctly", func() { + // Initial full scan + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify initial state + rockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(rockFiles).To(HaveLen(1)) + + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(1)) + + // Incremental scan should not duplicate existing files + Expect(runScanner(ctx, false)).To(Succeed()) + + // Verify counts remain the same + rockFiles, err = ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(rockFiles).To(HaveLen(1)) + + jazzFiles, err = ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(1)) + }) + }) + + Context("Missing Files Handling", func() { + var rockFS storagetest.FakeFS + + BeforeEach(func() { + rock := template(_t{"albumartist": "AC/DC", "album": "Back in Black", "year": 1980, "genre": "Rock"}) + + rockFS = createFS("rock", fstest.MapFS{ + "AC-DC/Back in Black/01 - Hells Bells.mp3": rock(track(1, "Hells Bells")), + "AC-DC/Back in Black/02 - Shoot to Thrill.mp3": rock(track(2, "Shoot to Thrill")), + }) + + createFS("jazz", fstest.MapFS{ + "Herbie Hancock/Head Hunters/01 - Chameleon.mp3": template(_t{ + "albumartist": "Herbie Hancock", "album": "Head Hunters", "year": 1973, "genre": "Jazz", + })(track(1, "Chameleon")), + }) + }) + + It("should mark missing files correctly per library", func() { + // Initial scan + Expect(runScanner(ctx, true)).To(Succeed()) + + // Remove one file from rock library only + rockFS.Remove("AC-DC/Back in Black/02 - Shoot to Thrill.mp3") + + // Rescan + Expect(runScanner(ctx, false)).To(Succeed()) + + // Check that only the rock library file is marked as missing + missingRockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"library_id": lib1.ID}, + squirrel.Eq{"missing": true}, + }, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(missingRockFiles).To(HaveLen(1)) + Expect(missingRockFiles[0].Title).To(Equal("Shoot to Thrill")) + + // Check that jazz library files are not affected + missingJazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"library_id": lib2.ID}, + squirrel.Eq{"missing": true}, + }, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(missingJazzFiles).To(HaveLen(0)) + + // Verify non-missing files + presentRockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"library_id": lib1.ID}, + squirrel.Eq{"missing": false}, + }, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(presentRockFiles).To(HaveLen(1)) + Expect(presentRockFiles[0].Title).To(Equal("Hells Bells")) + }) + }) + + Context("Error Handling - Multi-Library", func() { + Context("Filesystem errors affecting one library", func() { + var rockFS storagetest.FakeFS + + BeforeEach(func() { + // Set up content for both libraries + rock := template(_t{"albumartist": "AC/DC", "album": "Back in Black", "year": 1980, "genre": "Rock"}) + jazz := template(_t{"albumartist": "Miles Davis", "album": "Kind of Blue", "year": 1959, "genre": "Jazz"}) + + rockFS = createFS("rock", fstest.MapFS{ + "AC-DC/Back in Black/01 - Hells Bells.mp3": rock(track(1, "Hells Bells")), + "AC-DC/Back in Black/02 - Shoot to Thrill.mp3": rock(track(2, "Shoot to Thrill")), + }) + + createFS("jazz", fstest.MapFS{ + "Miles Davis/Kind of Blue/01 - So What.mp3": jazz(track(1, "So What")), + "Miles Davis/Kind of Blue/02 - Freddie Freeloader.mp3": jazz(track(2, "Freddie Freeloader")), + }) + }) + + It("should not affect scanning of other libraries", func() { + // Inject filesystem read error in rock library only + rockFS.SetError("AC-DC/Back in Black/01 - Hells Bells.mp3", errors.New("filesystem read error")) + + // Scan should succeed overall and return warnings + warnings, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + Expect(warnings).ToNot(BeEmpty(), "Should have warnings for filesystem errors") + + // Jazz library should have been scanned successfully + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(2)) + Expect(jazzFiles[0].Title).To(BeElementOf("So What", "Freddie Freeloader")) + Expect(jazzFiles[1].Title).To(BeElementOf("So What", "Freddie Freeloader")) + + // Rock library may have partial content (depending on scanner implementation) + rockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + // No specific expectation - some files may have been imported despite errors + _ = rockFiles + + // Verify jazz library stats are correct + jazzLib, err := ds.Library(ctx).Get(lib2.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzLib.TotalSongs).To(Equal(2)) + + // Error should be empty (warnings don't count as scan errors) + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "unset") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(BeEmpty()) + }) + + It("should continue with warnings for affected library", func() { + // Inject read errors on multiple files in rock library + rockFS.SetError("AC-DC/Back in Black/01 - Hells Bells.mp3", errors.New("read error 1")) + rockFS.SetError("AC-DC/Back in Black/02 - Shoot to Thrill.mp3", errors.New("read error 2")) + + // Scan should complete with warnings for multiple filesystem errors + warnings, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + Expect(warnings).ToNot(BeEmpty(), "Should have warnings for multiple filesystem errors") + + // Jazz library should be completely unaffected + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(2)) + + // Jazz library statistics should be accurate + jazzLib, err := ds.Library(ctx).Get(lib2.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzLib.TotalSongs).To(Equal(2)) + Expect(jazzLib.TotalAlbums).To(Equal(1)) + + // Error should be empty (warnings don't count as scan errors) + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "unset") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(BeEmpty()) + }) + }) + + Context("Database errors during multi-library scanning", func() { + BeforeEach(func() { + // Set up content for both libraries + rock := template(_t{"albumartist": "Queen", "album": "News of the World", "year": 1977, "genre": "Rock"}) + jazz := template(_t{"albumartist": "Bill Evans", "album": "Waltz for Debby", "year": 1961, "genre": "Jazz"}) + + createFS("rock", fstest.MapFS{ + "Queen/News of the World/01 - We Will Rock You.mp3": rock(track(1, "We Will Rock You")), + }) + + createFS("jazz", fstest.MapFS{ + "Bill Evans/Waltz for Debby/01 - My Foolish Heart.mp3": jazz(track(1, "My Foolish Heart")), + }) + }) + + It("should propagate database errors and stop scanning", func() { + // Install mock repo that injects DB error + mfRepo := &mockMediaFileRepo{ + MediaFileRepository: ds.RealDS.MediaFile(ctx), + GetMissingAndMatchingError: errors.New("database connection failed"), + } + ds.MockedMediaFile = mfRepo + + // Scan should return the database error + Expect(runScanner(ctx, false)).To(MatchError(ContainSubstring("database connection failed"))) + + // Error should be recorded in scanner properties + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(ContainSubstring("database connection failed")) + }) + + It("should preserve error information in scanner properties", func() { + // Install mock repo that injects DB error + mfRepo := &mockMediaFileRepo{ + MediaFileRepository: ds.RealDS.MediaFile(ctx), + GetMissingAndMatchingError: errors.New("critical database error"), + } + ds.MockedMediaFile = mfRepo + + // Attempt scan (should fail) + Expect(runScanner(ctx, false)).To(HaveOccurred()) + + // Check that error is recorded in scanner properties + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(ContainSubstring("critical database error")) + + // Scan type should still be recorded + scanType, _ := ds.Property(ctx).DefaultGet(consts.LastScanTypeKey, "") + Expect(scanType).To(BeElementOf("incremental", "quick")) + }) + }) + + Context("Mixed error scenarios", func() { + var rockFS storagetest.FakeFS + + BeforeEach(func() { + // Set up rock library with filesystem that can error + rock := template(_t{"albumartist": "Metallica", "album": "Master of Puppets", "year": 1986, "genre": "Metal"}) + rockFS = createFS("rock", fstest.MapFS{ + "Metallica/Master of Puppets/01 - Battery.mp3": rock(track(1, "Battery")), + "Metallica/Master of Puppets/02 - Master of Puppets.mp3": rock(track(2, "Master of Puppets")), + }) + + // Set up jazz library normally + jazz := template(_t{"albumartist": "Herbie Hancock", "album": "Head Hunters", "year": 1973, "genre": "Jazz"}) + createFS("jazz", fstest.MapFS{ + "Herbie Hancock/Head Hunters/01 - Chameleon.mp3": jazz(track(1, "Chameleon")), + }) + }) + + It("should handle filesystem errors in one library while other succeeds", func() { + // Inject filesystem error in rock library + rockFS.SetError("Metallica/Master of Puppets/01 - Battery.mp3", errors.New("disk read error")) + + // Scan should complete with warnings (not hard error) + warnings, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + Expect(warnings).ToNot(BeEmpty(), "Should have warnings for filesystem error") + + // Jazz library should scan completely successfully + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(1)) + Expect(jazzFiles[0].Title).To(Equal("Chameleon")) + + // Jazz library statistics should be accurate + jazzLib, err := ds.Library(ctx).Get(lib2.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzLib.TotalSongs).To(Equal(1)) + Expect(jazzLib.TotalAlbums).To(Equal(1)) + + // Rock library may have partial content (depending on scanner implementation) + rockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + // No specific expectation - some files may have been imported despite errors + _ = rockFiles + + // Error should be empty (warnings don't count as scan errors) + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "unset") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(BeEmpty()) + }) + + It("should handle partial failures gracefully", func() { + // Create a scenario where rock has filesystem issues and jazz has normal content + rockFS.SetError("Metallica/Master of Puppets/01 - Battery.mp3", errors.New("file corruption")) + + // Do an initial scan with filesystem error + warnings, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + Expect(warnings).ToNot(BeEmpty(), "Should have warnings for file corruption") + + // Verify that the working parts completed successfully + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(1)) + + // Scanner properties should reflect successful completion despite warnings + scanType, _ := ds.Property(ctx).DefaultGet(consts.LastScanTypeKey, "") + Expect(scanType).To(Equal("full")) + + // Start time should be recorded + startTimeStr, _ := ds.Property(ctx).DefaultGet(consts.LastScanStartTimeKey, "") + Expect(startTimeStr).ToNot(BeEmpty()) + + // Error should be empty (warnings don't count as scan errors) + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "unset") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(BeEmpty()) + }) + }) + + Context("Error recovery in multi-library context", func() { + It("should recover from previous library-specific errors", func() { + // Set up initial content + rock := template(_t{"albumartist": "Iron Maiden", "album": "The Number of the Beast", "year": 1982, "genre": "Metal"}) + jazz := template(_t{"albumartist": "John Coltrane", "album": "Giant Steps", "year": 1960, "genre": "Jazz"}) + + rockFS := createFS("rock", fstest.MapFS{ + "Iron Maiden/The Number of the Beast/01 - Invaders.mp3": rock(track(1, "Invaders")), + }) + + createFS("jazz", fstest.MapFS{ + "John Coltrane/Giant Steps/01 - Giant Steps.mp3": jazz(track(1, "Giant Steps")), + }) + + // First scan with filesystem error in rock + rockFS.SetError("Iron Maiden/The Number of the Beast/01 - Invaders.mp3", errors.New("temporary disk error")) + warnings, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) // Should succeed with warnings + Expect(warnings).ToNot(BeEmpty(), "Should have warnings for temporary disk error") + + // Clear the error and add more content - recreate the filesystem completely + rockFS.ClearError("Iron Maiden/The Number of the Beast/01 - Invaders.mp3") + + // Create a new filesystem with both files + createFS("rock", fstest.MapFS{ + "Iron Maiden/The Number of the Beast/01 - Invaders.mp3": rock(track(1, "Invaders")), + "Iron Maiden/The Number of the Beast/02 - Children of the Damned.mp3": rock(track(2, "Children of the Damned")), + }) + + // Second scan should recover and import all rock content + warnings, err = s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + Expect(warnings).To(BeEmpty(), "Should have no warnings after error recovery") + + // Verify both libraries now have content (at least jazz should work) + rockFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib1.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + // The scanner should recover and import both rock files + Expect(len(rockFiles)).To(Equal(2)) + + jazzFiles, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzFiles).To(HaveLen(1)) + + // Both libraries should have correct content counts + rockLib, err := ds.Library(ctx).Get(lib1.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(rockLib.TotalSongs).To(Equal(2)) + + jazzLib, err := ds.Library(ctx).Get(lib2.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(jazzLib.TotalSongs).To(Equal(1)) + + // Error should be empty (successful recovery) + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "unset") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(BeEmpty()) + }) + }) + }) + + Context("Scanner Properties", func() { + It("should persist last scan type, start time and error properties", func() { + // trivial FS setup + rock := template(_t{"albumartist": "AC/DC", "album": "Back in Black", "year": 1980, "genre": "Rock"}) + _ = createFS("rock", fstest.MapFS{ + "AC-DC/Back in Black/01 - Hells Bells.mp3": rock(track(1, "Hells Bells")), + }) + + // Run a full scan + Expect(runScanner(ctx, true)).To(Succeed()) + + // Validate properties + scanType, _ := ds.Property(ctx).DefaultGet(consts.LastScanTypeKey, "") + Expect(scanType).To(Equal("full")) + + startTimeStr, _ := ds.Property(ctx).DefaultGet(consts.LastScanStartTimeKey, "") + Expect(startTimeStr).ToNot(BeEmpty()) + _, err := time.Parse(time.RFC3339, startTimeStr) + Expect(err).ToNot(HaveOccurred()) + + lastError, err := ds.Property(ctx).DefaultGet(consts.LastScanErrorKey, "unset") + Expect(err).ToNot(HaveOccurred()) + Expect(lastError).To(BeEmpty()) + }) + }) +}) diff --git a/scanner/scanner_selective_test.go b/scanner/scanner_selective_test.go new file mode 100644 index 000000000..6c70eb268 --- /dev/null +++ b/scanner/scanner_selective_test.go @@ -0,0 +1,295 @@ +package scanner_test + +import ( + "context" + "path/filepath" + "testing/fstest" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/tests" + "github.com/navidrome/navidrome/utils/slice" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ScanFolders", Ordered, func() { + var ctx context.Context + var lib model.Library + var ds model.DataStore + var s model.Scanner + var fsys storagetest.FakeFS + + BeforeAll(func() { + tests.SkipOnWindows("SQLite file lock blocks TempDir cleanup (#TBD-path-sep-scanner)") + ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "123", IsAdmin: true}) + tmpDir := GinkgoT().TempDir() + conf.Server.DbPath = filepath.Join(tmpDir, "test-selective-scan.db?_journal_mode=WAL") + log.Warn("Using DB at " + conf.Server.DbPath) + db.Db().SetMaxOpenConns(1) + }) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + + db.Init(ctx) + DeferCleanup(func() { + Expect(tests.ClearDB()).To(Succeed()) + }) + + ds = persistence.New(db.Db()) + + // Create the admin user in the database to match the context + adminUser := model.User{ + ID: "123", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&adminUser)).To(Succeed()) + + s = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + + lib = model.Library{ID: 1, Name: "Fake Library", Path: "fake:///music"} + Expect(ds.Library(ctx).Put(&lib)).To(Succeed()) + + // Initialize fake filesystem + fsys = storagetest.FakeFS{} + storagetest.Register("fake", &fsys) + }) + + Describe("Adding tracks to the library", func() { + It("scans specified folders recursively including all subdirectories", func() { + rock := template(_t{"albumartist": "Rock Artist", "album": "Rock Album"}) + jazz := template(_t{"albumartist": "Jazz Artist", "album": "Jazz Album"}) + pop := template(_t{"albumartist": "Pop Artist", "album": "Pop Album"}) + createFS(fstest.MapFS{ + "rock/track1.mp3": rock(track(1, "Rock Track 1")), + "rock/track2.mp3": rock(track(2, "Rock Track 2")), + "rock/subdir/track3.mp3": rock(track(3, "Rock Track 3")), + "jazz/track4.mp3": jazz(track(1, "Jazz Track 1")), + "jazz/subdir/track5.mp3": jazz(track(2, "Jazz Track 2")), + "pop/track6.mp3": pop(track(1, "Pop Track 1")), + }) + + // Scan only the "rock" and "jazz" folders (including their subdirectories) + targets := []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "rock"}, + {LibraryID: lib.ID, FolderPath: "jazz"}, + } + + warnings, err := s.ScanFolders(ctx, false, targets) + Expect(err).ToNot(HaveOccurred()) + Expect(warnings).To(BeEmpty()) + + // Verify all tracks in rock and jazz folders (including subdirectories) were imported + allFiles, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + + // Should have 5 tracks (all rock and jazz tracks including subdirectories) + Expect(allFiles).To(HaveLen(5)) + + // Get the file paths + paths := slice.Map(allFiles, func(mf model.MediaFile) string { + return filepath.ToSlash(mf.Path) + }) + + // Verify the correct files were scanned (including subdirectories) + Expect(paths).To(ContainElements( + "rock/track1.mp3", + "rock/track2.mp3", + "rock/subdir/track3.mp3", + "jazz/track4.mp3", + "jazz/subdir/track5.mp3", + )) + + // Verify files in the pop folder were NOT scanned + Expect(paths).ToNot(ContainElement("pop/track6.mp3")) + }) + }) + + Describe("Deleting folders", func() { + Context("when a child folder is deleted", func() { + var ( + revolver, help func(...map[string]any) *fstest.MapFile + artistFolderID string + album1FolderID string + album2FolderID string + album1TrackIDs []string + album2TrackIDs []string + ) + + BeforeEach(func() { + // Setup template functions for creating test files + revolver = storagetest.Template(_t{"albumartist": "The Beatles", "album": "Revolver", "year": 1966}) + help = storagetest.Template(_t{"albumartist": "The Beatles", "album": "Help!", "year": 1965}) + + // Initial filesystem with nested folders + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + "The Beatles/Help!/01 - Help!.mp3": help(storagetest.Track(1, "Help!")), + "The Beatles/Help!/02 - The Night Before.mp3": help(storagetest.Track(2, "The Night Before")), + }) + + // First scan - import everything + _, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + + // Verify initial state - all folders exist + folders, err := ds.Folder(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"library_id": lib.ID}}) + Expect(err).ToNot(HaveOccurred()) + Expect(folders).To(HaveLen(4)) // root, Artist, Album1, Album2 + + // Store folder IDs for later verification + for _, f := range folders { + switch f.Name { + case "The Beatles": + artistFolderID = f.ID + case "Revolver": + album1FolderID = f.ID + case "Help!": + album2FolderID = f.ID + } + } + + // Verify all tracks exist + allTracks, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(allTracks).To(HaveLen(4)) + + // Store track IDs for later verification + for _, t := range allTracks { + if t.Album == "Revolver" { + album1TrackIDs = append(album1TrackIDs, t.ID) + } else if t.Album == "Help!" { + album2TrackIDs = append(album2TrackIDs, t.ID) + } + } + + // Verify no tracks are missing initially + for _, t := range allTracks { + Expect(t.Missing).To(BeFalse()) + } + }) + + It("should mark child folder and its tracks as missing when parent is scanned", func() { + // Delete the child folder (Help!) from the filesystem + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + // "The Beatles/Help!" folder and its contents are DELETED + }) + + // Run selective scan on the parent folder (Artist) + // This simulates what the watcher does when a child folder is deleted + _, err := s.ScanFolders(ctx, false, []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify the deleted child folder is now marked as missing + deletedFolder, err := ds.Folder(ctx).Get(album2FolderID) + Expect(err).ToNot(HaveOccurred()) + Expect(deletedFolder.Missing).To(BeTrue(), "Deleted child folder should be marked as missing") + + // Verify the deleted folder's tracks are marked as missing + for _, trackID := range album2TrackIDs { + track, err := ds.MediaFile(ctx).Get(trackID) + Expect(err).ToNot(HaveOccurred()) + Expect(track.Missing).To(BeTrue(), "Track in deleted folder should be marked as missing") + } + + // Verify the parent folder is still present and not marked as missing + parentFolder, err := ds.Folder(ctx).Get(artistFolderID) + Expect(err).ToNot(HaveOccurred()) + Expect(parentFolder.Missing).To(BeFalse(), "Parent folder should not be marked as missing") + + // Verify the sibling folder and its tracks are still present and not missing + siblingFolder, err := ds.Folder(ctx).Get(album1FolderID) + Expect(err).ToNot(HaveOccurred()) + Expect(siblingFolder.Missing).To(BeFalse(), "Sibling folder should not be marked as missing") + + for _, trackID := range album1TrackIDs { + track, err := ds.MediaFile(ctx).Get(trackID) + Expect(err).ToNot(HaveOccurred()) + Expect(track.Missing).To(BeFalse(), "Track in sibling folder should not be marked as missing") + } + }) + + It("should mark deeply nested child folders as missing", func() { + // Add a deeply nested folder structure + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + "The Beatles/Help!/01 - Help!.mp3": help(storagetest.Track(1, "Help!")), + "The Beatles/Help!/02 - The Night Before.mp3": help(storagetest.Track(2, "The Night Before")), + "The Beatles/Help!/Bonus/01 - Bonus Track.mp3": help(storagetest.Track(99, "Bonus Track")), + "The Beatles/Help!/Bonus/Nested/01 - Deep Track.mp3": help(storagetest.Track(100, "Deep Track")), + }) + + // Rescan to import the new nested structure + _, err := s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + + // Verify nested folders were created + allFolders, err := ds.Folder(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"library_id": lib.ID}}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(allFolders)).To(BeNumerically(">", 4), "Should have more folders with nested structure") + + // Now delete the entire Help! folder including nested children + fsys.SetFiles(fstest.MapFS{ + "The Beatles/Revolver/01 - Taxman.mp3": revolver(storagetest.Track(1, "Taxman")), + "The Beatles/Revolver/02 - Eleanor Rigby.mp3": revolver(storagetest.Track(2, "Eleanor Rigby")), + // All Help! subfolders are deleted + }) + + // Run selective scan on parent + _, err = s.ScanFolders(ctx, false, []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + + // Verify all Help! folders (including nested ones) are marked as missing + missingFolders, err := ds.Folder(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.And{ + squirrel.Eq{"library_id": lib.ID}, + squirrel.Eq{"missing": true}, + }, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(len(missingFolders)).To(BeNumerically(">", 0), "At least one folder should be marked as missing") + + // Verify all tracks in deleted folders are marked as missing + allTracks, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(allTracks).To(HaveLen(6)) + + for _, track := range allTracks { + if track.Album == "Help!" { + Expect(track.Missing).To(BeTrue(), "All tracks in deleted Help! folder should be marked as missing") + } else if track.Album == "Revolver" { + Expect(track.Missing).To(BeFalse(), "Tracks in Revolver folder should not be marked as missing") + } + } + }) + }) + }) +}) diff --git a/scanner/scanner_suite_test.go b/scanner/scanner_suite_test.go index 8a2c6b260..9ee6fc89b 100644 --- a/scanner/scanner_suite_test.go +++ b/scanner/scanner_suite_test.go @@ -2,6 +2,7 @@ package scanner_test import ( "context" + "os" "testing" "github.com/navidrome/navidrome/db" @@ -13,10 +14,16 @@ import ( ) func TestScanner(t *testing.T) { - // Detect any goroutine leaks in the scanner code under test - defer goleak.VerifyNone(t, - goleak.IgnoreTopFunction("github.com/onsi/ginkgo/v2/internal/interrupt_handler.(*InterruptHandler).registerForInterrupts.func2"), - ) + // Only run goleak checks when the GOLEAK env var is set + if os.Getenv("GOLEAK") != "" { + // Detect any goroutine leaks in the scanner code under test + defer goleak.VerifyNone(t, + goleak.IgnoreTopFunction("github.com/onsi/ginkgo/v2/internal/interrupt_handler.(*InterruptHandler).registerForInterrupts.func2"), + // The notify library creates internal goroutines for file watching that persist after Stop() is called. + // These are created by the plugins package tests and are expected behavior. + goleak.IgnoreTopFunction("github.com/rjeczalik/notify.(*recursiveTree).dispatch"), + ) + } tests.Init(t, true) defer db.Close(context.Background()) diff --git a/scanner/scanner_test.go b/scanner/scanner_test.go index 3ed5a4704..7bf91d64f 100644 --- a/scanner/scanner_test.go +++ b/scanner/scanner_test.go @@ -14,6 +14,7 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/storage/storagetest" "github.com/navidrome/navidrome/db" "github.com/navidrome/navidrome/log" @@ -34,19 +35,19 @@ type _t = map[string]any var template = storagetest.Template var track = storagetest.Track +func createFS(files fstest.MapFS) storagetest.FakeFS { + fs := storagetest.FakeFS{} + fs.SetFiles(files) + storagetest.Register("fake", &fs) + return fs +} + var _ = Describe("Scanner", Ordered, func() { var ctx context.Context var lib model.Library var ds *tests.MockDataStore var mfRepo *mockMediaFileRepo - var s scanner.Scanner - - createFS := func(files fstest.MapFS) storagetest.FakeFS { - fs := storagetest.FakeFS{} - fs.SetFiles(files) - storagetest.Register("fake", &fs) - return fs - } + var s model.Scanner BeforeAll(func() { ctx = request.WithUser(GinkgoT().Context(), model.User{ID: "123", IsAdmin: true}) @@ -58,12 +59,14 @@ var _ = Describe("Scanner", Ordered, func() { }) BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.MusicFolder = "fake:///music" // Set to match test library path + conf.Server.DevExternalScanner = false + db.Init(ctx) DeferCleanup(func() { Expect(tests.ClearDB()).To(Succeed()) }) - DeferCleanup(configtest.SetupConfig()) - conf.Server.DevExternalScanner = false ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} mfRepo = &mockMediaFileRepo{ @@ -71,8 +74,18 @@ var _ = Describe("Scanner", Ordered, func() { } ds.MockedMediaFile = mfRepo + // Create the admin user in the database to match the context + adminUser := model.User{ + ID: "123", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&adminUser)).To(Succeed()) + s = scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), - core.NewPlaylists(ds), metrics.NewNoopInstance()) + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) lib = model.Library{ID: 1, Name: "Fake Library", Path: "fake:///music"} Expect(ds.Library(ctx).Put(&lib)).To(Succeed()) @@ -155,6 +168,7 @@ var _ = Describe("Scanner", Ordered, func() { }) It("should update the album", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") Expect(runScanner(ctx, true)).To(Succeed()) albums, err := ds.Album(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"album.name": "Help!"}}) @@ -255,6 +269,7 @@ var _ = Describe("Scanner", Ordered, func() { var beatlesMBID = uuid.NewString() BeforeEach(func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") By("Having two MP3 albums") beatles := _t{ "artist": "The Beatles", @@ -466,6 +481,56 @@ var _ = Describe("Scanner", Ordered, func() { Expect(mf.Missing).To(BeFalse()) }) + It("marks tracks as missing when scanning a deleted folder with ScanFolders", func() { + By("Adding a third track to Revolver to have more test data") + fsys.Add("The Beatles/Revolver/03 - I'm Only Sleeping.mp3", revolver(track(3, "I'm Only Sleeping"))) + Expect(runScanner(ctx, false)).To(Succeed()) + + By("Verifying initial state has 5 tracks") + Expect(ds.MediaFile(ctx).CountAll(model.QueryOptions{ + Filters: squirrel.Eq{"missing": false}, + })).To(Equal(int64(5))) + + By("Removing the entire Revolver folder from filesystem") + fsys.Remove("The Beatles/Revolver/01 - Taxman.mp3") + fsys.Remove("The Beatles/Revolver/02 - Eleanor Rigby.mp3") + fsys.Remove("The Beatles/Revolver/03 - I'm Only Sleeping.mp3") + + By("Scanning the parent folder (simulating watcher behavior)") + targets := []model.ScanTarget{ + {LibraryID: lib.ID, FolderPath: "The Beatles"}, + } + _, err := s.ScanFolders(ctx, false, targets) + Expect(err).To(Succeed()) + + By("Checking all Revolver tracks are marked as missing") + mf, err := findByPath("The Beatles/Revolver/01 - Taxman.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeTrue()) + + mf, err = findByPath("The Beatles/Revolver/02 - Eleanor Rigby.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeTrue()) + + mf, err = findByPath("The Beatles/Revolver/03 - I'm Only Sleeping.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeTrue()) + + By("Checking the Help! tracks are not affected") + mf, err = findByPath("The Beatles/Help!/01 - Help!.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeFalse()) + + mf, err = findByPath("The Beatles/Help!/02 - The Night Before.mp3") + Expect(err).ToNot(HaveOccurred()) + Expect(mf.Missing).To(BeFalse()) + + By("Verifying only 2 non-missing tracks remain (Help! tracks)") + Expect(ds.MediaFile(ctx).CountAll(model.QueryOptions{ + Filters: squirrel.Eq{"missing": false}, + })).To(Equal(int64(2))) + }) + It("does not override artist fields when importing an undertagged file", func() { By("Making sure artist in the DB contains MBID and sort name") aa, err := ds.Artist(ctx).GetAll(model.QueryOptions{ @@ -612,6 +677,249 @@ var _ = Describe("Scanner", Ordered, func() { }) }) }) + + Describe("Interrupted scan resumption", func() { + var fsys storagetest.FakeFS + var help func(...map[string]any) *fstest.MapFile + + BeforeEach(func() { + help = template(_t{"albumartist": "The Beatles", "album": "Help!", "year": 1965}) + fsys = createFS(fstest.MapFS{ + "The Beatles/Help!/01 - Help!.mp3": help(track(1, "Help!")), + "The Beatles/Help!/02 - The Night Before.mp3": help(track(2, "The Night Before")), + }) + }) + + simulateInterruptedScan := func(fullScan bool) { + // Call ScanBegin to properly set LastScanStartedAt and FullScanInProgress + // This simulates what would happen if a scan was interrupted (ScanBegin called but ScanEnd not) + Expect(ds.Library(ctx).ScanBegin(lib.ID, fullScan)).To(Succeed()) + + // Verify the update was persisted + reloaded, err := ds.Library(ctx).Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(reloaded.LastScanStartedAt).ToNot(BeZero()) + Expect(reloaded.FullScanInProgress).To(Equal(fullScan)) + } + + Context("when a quick scan is interrupted and resumed with a full scan request", func() { + BeforeEach(func() { + // First, complete a full scan to populate the database + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify files were imported + mfs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(2)) + + // Now simulate an interrupted quick scan + // (LastScanStartedAt is set, FullScanInProgress is false) + simulateInterruptedScan(false) + }) + + It("should rescan all folders when resumed as full scan", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + // In a quick scan, this wouldn't be detected because the folder hash hasn't changed. + // But in a full scan, all files should be re-read regardless of hash. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "updated comment"}, origModTime) + + // Resume with a full scan - this should process all folders + // even though folder hashes haven't changed + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify the comment was updated (which means the folder was processed and file re-imported) + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(Equal("updated comment")) + }) + }) + + Context("when a full scan is interrupted and resumed with a quick scan request", func() { + BeforeEach(func() { + // First, complete a full scan to populate the database + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify files were imported + mfs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(2)) + + // Now simulate an interrupted full scan + // (LastScanStartedAt is set, FullScanInProgress is true) + simulateInterruptedScan(true) + }) + + It("should continue as full scan even when quick scan is requested", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "full scan comment"}, origModTime) + + // Request a quick scan - but because a full scan was in progress, + // it should continue as a full scan + Expect(runScanner(ctx, false)).To(Succeed()) + + // Verify the comment was updated (folder was processed despite unchanged hash) + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(Equal("full scan comment")) + }) + }) + + Context("when no scan was in progress", func() { + BeforeEach(func() { + // First, complete a full scan to populate the database + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify files were imported + mfs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(2)) + + // Library should have LastScanStartedAt cleared after successful scan + updatedLib, err := ds.Library(ctx).Get(lib.ID) + Expect(err).ToNot(HaveOccurred()) + Expect(updatedLib.LastScanStartedAt).To(BeZero()) + Expect(updatedLib.FullScanInProgress).To(BeFalse()) + }) + + It("should respect the full scan flag for new scans", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "new full scan"}, origModTime) + + // Start a new full scan + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify the comment was updated + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(Equal("new full scan")) + }) + + It("should not rescan unchanged folders during quick scan", func() { + // Update a tag without changing the folder hash by preserving the original modtime. + // This simulates editing tags in a file (e.g., with a tag editor) without modifying its timestamp. + // In a quick scan, this should NOT be detected because the folder hash remains unchanged. + origModTime := fsys.MapFS["The Beatles/Help!/01 - Help!.mp3"].ModTime + fsys.UpdateTags("The Beatles/Help!/01 - Help!.mp3", _t{"comment": "should not appear"}, origModTime) + + // Do a quick scan - unchanged folders should be skipped + Expect(runScanner(ctx, false)).To(Succeed()) + + // Verify the comment was NOT updated (folder was skipped) + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Help!"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).To(HaveLen(1)) + Expect(mfs[0].Comment).To(BeEmpty()) + }) + }) + }) + + Describe("RefreshStats", func() { + var refreshStatsCalls []bool + var fsys storagetest.FakeFS + var help func(...map[string]any) *fstest.MapFile + + BeforeEach(func() { + refreshStatsCalls = nil + + // Create a mock artist repository that tracks RefreshStats calls + originalArtistRepo := ds.RealDS.Artist(ctx) + ds.MockedArtist = &testArtistRepo{ + ArtistRepository: originalArtistRepo, + callTracker: &refreshStatsCalls, + } + + // Create a simple filesystem for testing + help = template(_t{"albumartist": "The Beatles", "album": "Help!", "year": 1965}) + fsys = createFS(fstest.MapFS{ + "The Beatles/Help!/01 - Help!.mp3": help(track(1, "Help!")), + }) + }) + + It("should call RefreshStats with allArtists=true for full scans", func() { + Expect(runScanner(ctx, true)).To(Succeed()) + + Expect(refreshStatsCalls).To(HaveLen(1)) + Expect(refreshStatsCalls[0]).To(BeTrue(), "RefreshStats should be called with allArtists=true for full scans") + }) + + It("should call RefreshStats with allArtists=false for incremental scans", func() { + // First do a full scan to set up the data + Expect(runScanner(ctx, true)).To(Succeed()) + + // Reset the tracker to only track the incremental scan + refreshStatsCalls = nil + + // Add a new file to trigger changes detection + fsys.Add("The Beatles/Help!/02 - The Night Before.mp3", help(track(2, "The Night Before"))) + + // Do an incremental scan + Expect(runScanner(ctx, false)).To(Succeed()) + + Expect(refreshStatsCalls).To(HaveLen(1)) + Expect(refreshStatsCalls[0]).To(BeFalse(), "RefreshStats should be called with allArtists=false for incremental scans") + }) + + It("should update artist stats during quick scans when new albums are added", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") + // Don't use the mocked artist repo for this test - we need the real one + ds.MockedArtist = nil + + By("Initial scan with one album") + Expect(runScanner(ctx, true)).To(Succeed()) + + // Verify initial artist stats - should have 1 album, 1 song + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(HaveLen(1)) + artist := artists[0] + Expect(artist.AlbumCount).To(Equal(1)) // 1 album + Expect(artist.SongCount).To(Equal(1)) // 1 song + + By("Adding files to an existing directory during incremental scan") + // Add more files to the existing Help! album - this should trigger artist stats update during incremental scan + fsys.Add("The Beatles/Help!/02 - The Night Before.mp3", help(track(2, "The Night Before"))) + fsys.Add("The Beatles/Help!/03 - You've Got to Hide Your Love Away.mp3", help(track(3, "You've Got to Hide Your Love Away"))) + + // Do a quick scan (incremental) + Expect(runScanner(ctx, false)).To(Succeed()) + + By("Verifying artist stats were updated correctly") + // Fetch the artist again to check updated stats + artists, err = ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).To(HaveLen(1)) + updatedArtist := artists[0] + + // Should now have 1 album and 3 songs total + // This is the key test - that artist stats are updated during quick scans + Expect(updatedArtist.AlbumCount).To(Equal(1)) // 1 album + Expect(updatedArtist.SongCount).To(Equal(3)) // 3 songs + + // Also verify that role-specific stats are updated (albumartist role) + Expect(updatedArtist.Stats).To(HaveKey(model.RoleAlbumArtist)) + albumArtistStats := updatedArtist.Stats[model.RoleAlbumArtist] + Expect(albumArtistStats.AlbumCount).To(Equal(1)) // 1 album + Expect(albumArtistStats.SongCount).To(Equal(3)) // 3 songs + }) + }) }) func createFindByPath(ctx context.Context, ds model.DataStore) func(string) (*model.MediaFile, error) { @@ -638,3 +946,13 @@ func (m *mockMediaFileRepo) GetMissingAndMatching(libId int) (model.MediaFileCur } return m.MediaFileRepository.GetMissingAndMatching(libId) } + +type testArtistRepo struct { + model.ArtistRepository + callTracker *[]bool +} + +func (m *testArtistRepo) RefreshStats(allArtists bool) (int64, error) { + *m.callTracker = append(*m.callTracker, allArtists) + return m.ArtistRepository.RefreshStats(allArtists) +} diff --git a/scanner/walk_dir_tree.go b/scanner/walk_dir_tree.go index 4f9f26b1b..e6a694f2b 100644 --- a/scanner/walk_dir_tree.go +++ b/scanner/walk_dir_tree.go @@ -1,7 +1,6 @@ package scanner import ( - "bufio" "context" "io/fs" "maps" @@ -9,102 +8,71 @@ import ( "slices" "sort" "strings" - "time" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils" - "github.com/navidrome/navidrome/utils/chrono" - ignore "github.com/sabhiram/go-gitignore" ) -type folderEntry struct { - job *scanJob - elapsed chrono.Meter - path string // Full path - id string // DB ID - modTime time.Time // From FS - updTime time.Time // from DB - audioFiles map[string]fs.DirEntry - imageFiles map[string]fs.DirEntry - numPlaylists int - numSubFolders int - imagesUpdatedAt time.Time - tracks model.MediaFiles - albums model.Albums - albumIDMap map[string]string - artists model.Artists - tags model.TagList - missingTracks []*model.MediaFile -} - -func (f *folderEntry) hasNoFiles() bool { - return len(f.audioFiles) == 0 && len(f.imageFiles) == 0 && f.numPlaylists == 0 && f.numSubFolders == 0 -} - -func (f *folderEntry) isNew() bool { - return f.updTime.IsZero() -} - -func (f *folderEntry) toFolder() *model.Folder { - folder := model.NewFolder(f.job.lib, f.path) - folder.NumAudioFiles = len(f.audioFiles) - if core.InPlaylistsPath(*folder) { - folder.NumPlaylists = f.numPlaylists - } - folder.ImageFiles = slices.Collect(maps.Keys(f.imageFiles)) - folder.ImagesUpdatedAt = f.imagesUpdatedAt - return folder -} - -func newFolderEntry(job *scanJob, path string) *folderEntry { - id := model.FolderID(job.lib, path) - f := &folderEntry{ - id: id, - job: job, - path: path, - audioFiles: make(map[string]fs.DirEntry), - imageFiles: make(map[string]fs.DirEntry), - albumIDMap: make(map[string]string), - updTime: job.popLastUpdate(id), - } - return f -} - -func (f *folderEntry) isOutdated() bool { - if f.job.lib.FullScanInProgress { - return f.updTime.Before(f.job.lib.LastScanStartedAt) - } - return f.updTime.Before(f.modTime) -} - -func walkDirTree(ctx context.Context, job *scanJob) (<-chan *folderEntry, error) { +// walkDirTree recursively walks the directory tree starting from the given targetFolders. +// If no targetFolders are provided, it starts from the root folder ("."). +// It returns a channel of folderEntry pointers representing each folder found. +func walkDirTree(ctx context.Context, job *scanJob, targetFolders ...string) (<-chan *folderEntry, error) { results := make(chan *folderEntry) + folders := targetFolders + if len(targetFolders) == 0 { + // No specific folders provided, scan the root folder + folders = []string{"."} + } go func() { defer close(results) - err := walkFolder(ctx, job, ".", nil, results) - if err != nil { - log.Error(ctx, "Scanner: There were errors reading directories from filesystem", "path", job.lib.Path, err) - return + for _, folderPath := range folders { + if utils.IsCtxDone(ctx) { + return + } + + // Check if target folder exists before walking it + // If it doesn't exist (e.g., deleted between watcher detection and scan execution), + // skip it so it remains in job.lastUpdates and gets handled in following steps + _, err := fs.Stat(job.fs, folderPath) + if err != nil { + log.Warn(ctx, "Scanner: Target folder does not exist.", "path", folderPath, err) + continue + } + + // Create checker and push patterns from root to this folder + checker := newIgnoreChecker(job.fs) + err = checker.PushAllParents(ctx, folderPath) + if err != nil { + log.Error(ctx, "Scanner: Error pushing ignore patterns for target folder", "path", folderPath, err) + continue + } + + // Recursively walk this folder and all its children + err = walkFolder(ctx, job, folderPath, checker, results) + if err != nil { + log.Error(ctx, "Scanner: Error walking target folder", "path", folderPath, err) + continue + } } - log.Debug(ctx, "Scanner: Finished reading folders", "lib", job.lib.Name, "path", job.lib.Path, "numFolders", job.numFolders.Load()) + log.Debug(ctx, "Scanner: Finished reading target folders", "lib", job.lib.Name, "path", job.lib.Path, "numFolders", job.numFolders.Load()) }() return results, nil } -func walkFolder(ctx context.Context, job *scanJob, currentFolder string, ignorePatterns []string, results chan<- *folderEntry) error { - ignorePatterns = loadIgnoredPatterns(ctx, job.fs, currentFolder, ignorePatterns) +func walkFolder(ctx context.Context, job *scanJob, currentFolder string, checker *IgnoreChecker, results chan<- *folderEntry) error { + // Push patterns for this folder onto the stack + _ = checker.Push(ctx, currentFolder) + defer checker.Pop() // Pop patterns when leaving this folder - folder, children, err := loadDir(ctx, job, currentFolder, ignorePatterns) + folder, children, err := loadDir(ctx, job, currentFolder, checker) if err != nil { log.Warn(ctx, "Scanner: Error loading dir. Skipping", "path", currentFolder, err) return nil } for _, c := range children { - err := walkFolder(ctx, job, c, ignorePatterns, results) + err := walkFolder(ctx, job, c, checker, results) if err != nil { return err } @@ -122,50 +90,17 @@ func walkFolder(ctx context.Context, job *scanJob, currentFolder string, ignoreP return nil } -func loadIgnoredPatterns(ctx context.Context, fsys fs.FS, currentFolder string, currentPatterns []string) []string { - ignoreFilePath := path.Join(currentFolder, consts.ScanIgnoreFile) - var newPatterns []string - if _, err := fs.Stat(fsys, ignoreFilePath); err == nil { - // Read and parse the .ndignore file - ignoreFile, err := fsys.Open(ignoreFilePath) - if err != nil { - log.Warn(ctx, "Scanner: Error opening .ndignore file", "path", ignoreFilePath, err) - // Continue with previous patterns - } else { - defer ignoreFile.Close() - scanner := bufio.NewScanner(ignoreFile) - for scanner.Scan() { - line := scanner.Text() - if line == "" || strings.HasPrefix(line, "#") { - continue // Skip empty lines and comments - } - newPatterns = append(newPatterns, line) - } - if err := scanner.Err(); err != nil { - log.Warn(ctx, "Scanner: Error reading .ignore file", "path", ignoreFilePath, err) - } - } - // If the .ndignore file is empty, mimic the current behavior and ignore everything - if len(newPatterns) == 0 { - log.Trace(ctx, "Scanner: .ndignore file is empty, ignoring everything", "path", currentFolder) - newPatterns = []string{"**/*"} - } else { - log.Trace(ctx, "Scanner: .ndignore file found ", "path", ignoreFilePath, "patterns", newPatterns) - } - } - // Combine the patterns from the .ndignore file with the ones passed as argument - combinedPatterns := append([]string{}, currentPatterns...) - return append(combinedPatterns, newPatterns...) -} - -func loadDir(ctx context.Context, job *scanJob, dirPath string, ignorePatterns []string) (folder *folderEntry, children []string, err error) { - folder = newFolderEntry(job, dirPath) - +func loadDir(ctx context.Context, job *scanJob, dirPath string, checker *IgnoreChecker) (folder *folderEntry, children []string, err error) { + // Check if directory exists before creating the folder entry + // This is important to avoid removing the folder from lastUpdates if it doesn't exist dirInfo, err := fs.Stat(job.fs, dirPath) if err != nil { log.Warn(ctx, "Scanner: Error stating dir", "path", dirPath, err) return nil, nil, err } + + // Now that we know the folder exists, create the entry (which removes it from lastUpdates) + folder = job.createFolderEntry(dirPath) folder.modTime = dirInfo.ModTime() dir, err := job.fs.Open(dirPath) @@ -180,12 +115,11 @@ func loadDir(ctx context.Context, job *scanJob, dirPath string, ignorePatterns [ return folder, children, err } - ignoreMatcher := ignore.CompileIgnoreLines(ignorePatterns...) entries := fullReadDir(ctx, dirFile) children = make([]string, 0, len(entries)) for _, entry := range entries { entryPath := path.Join(dirPath, entry.Name()) - if len(ignorePatterns) > 0 && isScanIgnored(ctx, ignoreMatcher, entryPath) { + if checker.ShouldIgnore(ctx, entryPath) { log.Trace(ctx, "Scanner: Ignoring entry", "path", entryPath) continue } @@ -297,6 +231,7 @@ func isDirReadable(ctx context.Context, fsys fs.FS, dirPath string) bool { var ignoredDirs = []string{ "$RECYCLE.BIN", "#snapshot", + "@Recycle", "@Recently-Snapshot", ".streams", "lost+found", @@ -317,11 +252,3 @@ func isDirIgnored(name string) bool { func isEntryIgnored(name string) bool { return strings.HasPrefix(name, ".") && !strings.HasPrefix(name, "..") } - -func isScanIgnored(ctx context.Context, matcher *ignore.GitIgnore, entryPath string) bool { - matches := matcher.MatchesPath(entryPath) - if matches { - log.Trace(ctx, "Scanner: Ignoring entry matching .ndignore: ", "path", entryPath) - } - return matches -} diff --git a/scanner/walk_dir_tree_test.go b/scanner/walk_dir_tree_test.go index c4278ef82..42b7af7ba 100644 --- a/scanner/walk_dir_tree_test.go +++ b/scanner/walk_dir_tree_test.go @@ -12,6 +12,7 @@ import ( "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/storage" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" "golang.org/x/sync/errgroup" @@ -25,82 +26,196 @@ var _ = Describe("walk_dir_tree", func() { ctx context.Context ) - BeforeEach(func() { - DeferCleanup(configtest.SetupConfig()) - ctx = GinkgoT().Context() - fsys = &mockMusicFS{ - FS: fstest.MapFS{ - "root/a/.ndignore": {Data: []byte("ignored/*")}, - "root/a/f1.mp3": {}, - "root/a/f2.mp3": {}, - "root/a/ignored/bad.mp3": {}, - "root/b/cover.jpg": {}, - "root/c/f3": {}, - "root/d": {}, - "root/d/.ndignore": {}, - "root/d/f1.mp3": {}, - "root/d/f2.mp3": {}, - "root/d/f3.mp3": {}, - "root/e/original/f1.mp3": {}, - "root/e/symlink": {Mode: fs.ModeSymlink, Data: []byte("root/e/original")}, + Context("full library", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = GinkgoT().Context() + fsys = &mockMusicFS{ + FS: fstest.MapFS{ + "root/a/.ndignore": {Data: []byte("ignored/*")}, + "root/a/f1.mp3": {}, + "root/a/f2.mp3": {}, + "root/a/ignored/bad.mp3": {}, + "root/b/cover.jpg": {}, + "root/c/f3": {}, + "root/d": {}, + "root/d/.ndignore": {}, + "root/d/f1.mp3": {}, + "root/d/f2.mp3": {}, + "root/d/f3.mp3": {}, + "root/e/original/f1.mp3": {}, + "root/e/symlink": {Mode: fs.ModeSymlink, Data: []byte("original")}, + }, + } + job = &scanJob{ + fs: fsys, + lib: model.Library{Path: "/music"}, + } + }) + + // Helper function to call walkDirTree and collect folders from the results channel + getFolders := func() map[string]*folderEntry { + results, err := walkDirTree(ctx, job) + Expect(err).ToNot(HaveOccurred()) + + folders := map[string]*folderEntry{} + g := errgroup.Group{} + g.Go(func() error { + for folder := range results { + folders[folder.path] = folder + } + return nil + }) + _ = g.Wait() + return folders + } + + DescribeTable("symlink handling", + func(followSymlinks bool, expectedFolderCount int) { + conf.Server.Scanner.FollowSymlinks = followSymlinks + folders := getFolders() + + Expect(folders).To(HaveLen(expectedFolderCount + 2)) // +2 for `.` and `root` + + // Basic folder structure checks + Expect(folders["root/a"].audioFiles).To(SatisfyAll( + HaveLen(2), + HaveKey("f1.mp3"), + HaveKey("f2.mp3"), + )) + Expect(folders["root/a"].imageFiles).To(BeEmpty()) + Expect(folders["root/b"].audioFiles).To(BeEmpty()) + Expect(folders["root/b"].imageFiles).To(SatisfyAll( + HaveLen(1), + HaveKey("cover.jpg"), + )) + Expect(folders["root/c"].audioFiles).To(BeEmpty()) + Expect(folders["root/c"].imageFiles).To(BeEmpty()) + Expect(folders).ToNot(HaveKey("root/d")) + + // Symlink specific checks + if followSymlinks { + Expect(folders["root/e/symlink"].audioFiles).To(HaveLen(1)) + } else { + Expect(folders).ToNot(HaveKey("root/e/symlink")) + } }, - } - job = &scanJob{ - fs: fsys, - lib: model.Library{Path: "/music"}, - } + Entry("with symlinks enabled", true, 7), + Entry("with symlinks disabled", false, 6), + ) }) - // Helper function to call walkDirTree and collect folders from the results channel - getFolders := func() map[string]*folderEntry { - results, err := walkDirTree(ctx, job) - Expect(err).ToNot(HaveOccurred()) - - folders := map[string]*folderEntry{} - g := errgroup.Group{} - g.Go(func() error { - for folder := range results { - folders[folder.path] = folder + Context("with target folders", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ctx = GinkgoT().Context() + fsys = &mockMusicFS{ + FS: fstest.MapFS{ + "Artist/Album1/track1.mp3": {}, + "Artist/Album1/track2.mp3": {}, + "Artist/Album2/track1.mp3": {}, + "Artist/Album2/track2.mp3": {}, + "Artist/Album2/Sub/track3.mp3": {}, + "OtherArtist/Album3/track1.mp3": {}, + }, + } + job = &scanJob{ + fs: fsys, + lib: model.Library{Path: "/music"}, } - return nil }) - _ = g.Wait() - return folders - } - DescribeTable("symlink handling", - func(followSymlinks bool, expectedFolderCount int) { - conf.Server.Scanner.FollowSymlinks = followSymlinks - folders := getFolders() + It("should recursively walk all subdirectories of target folders", func() { + results, err := walkDirTree(ctx, job, "Artist") + Expect(err).ToNot(HaveOccurred()) - Expect(folders).To(HaveLen(expectedFolderCount + 2)) // +2 for `.` and `root` + folders := map[string]*folderEntry{} + g := errgroup.Group{} + g.Go(func() error { + for folder := range results { + folders[folder.path] = folder + } + return nil + }) + _ = g.Wait() - // Basic folder structure checks - Expect(folders["root/a"].audioFiles).To(SatisfyAll( - HaveLen(2), - HaveKey("f1.mp3"), - HaveKey("f2.mp3"), + // Should include the target folder and all its descendants + Expect(folders).To(SatisfyAll( + HaveKey("Artist"), + HaveKey("Artist/Album1"), + HaveKey("Artist/Album2"), + HaveKey("Artist/Album2/Sub"), )) - Expect(folders["root/a"].imageFiles).To(BeEmpty()) - Expect(folders["root/b"].audioFiles).To(BeEmpty()) - Expect(folders["root/b"].imageFiles).To(SatisfyAll( - HaveLen(1), - HaveKey("cover.jpg"), - )) - Expect(folders["root/c"].audioFiles).To(BeEmpty()) - Expect(folders["root/c"].imageFiles).To(BeEmpty()) - Expect(folders).ToNot(HaveKey("root/d")) - // Symlink specific checks - if followSymlinks { - Expect(folders["root/e/symlink"].audioFiles).To(HaveLen(1)) - } else { - Expect(folders).ToNot(HaveKey("root/e/symlink")) + // Should not include folders outside the target + Expect(folders).ToNot(HaveKey("OtherArtist")) + Expect(folders).ToNot(HaveKey("OtherArtist/Album3")) + + // Verify audio files are present + Expect(folders["Artist/Album1"].audioFiles).To(HaveLen(2)) + Expect(folders["Artist/Album2"].audioFiles).To(HaveLen(2)) + Expect(folders["Artist/Album2/Sub"].audioFiles).To(HaveLen(1)) + }) + + It("should handle multiple target folders", func() { + results, err := walkDirTree(ctx, job, "Artist/Album1", "OtherArtist") + Expect(err).ToNot(HaveOccurred()) + + folders := map[string]*folderEntry{} + g := errgroup.Group{} + g.Go(func() error { + for folder := range results { + folders[folder.path] = folder + } + return nil + }) + _ = g.Wait() + + // Should include both target folders and their descendants + Expect(folders).To(SatisfyAll( + HaveKey("Artist/Album1"), + HaveKey("OtherArtist"), + HaveKey("OtherArtist/Album3"), + )) + + // Should not include other folders + Expect(folders).ToNot(HaveKey("Artist")) + Expect(folders).ToNot(HaveKey("Artist/Album2")) + Expect(folders).ToNot(HaveKey("Artist/Album2/Sub")) + }) + + It("should skip non-existent target folders and preserve them in lastUpdates", func() { + // Setup job with lastUpdates for both existing and non-existing folders + job.lastUpdates = map[string]model.FolderUpdateInfo{ + model.FolderID(job.lib, "Artist/Album1"): {}, + model.FolderID(job.lib, "NonExistent/DeletedFolder"): {}, + model.FolderID(job.lib, "OtherArtist/Album3"): {}, } - }, - Entry("with symlinks enabled", true, 7), - Entry("with symlinks disabled", false, 6), - ) + + // Try to scan existing folder and non-existing folder + results, err := walkDirTree(ctx, job, "Artist/Album1", "NonExistent/DeletedFolder") + Expect(err).ToNot(HaveOccurred()) + + // Collect results + folders := map[string]struct{}{} + for folder := range results { + folders[folder.path] = struct{}{} + } + + // Should only include the existing folder + Expect(folders).To(HaveKey("Artist/Album1")) + Expect(folders).ToNot(HaveKey("NonExistent/DeletedFolder")) + + // The non-existent folder should still be in lastUpdates (not removed by popLastUpdate) + Expect(job.lastUpdates).To(HaveKey(model.FolderID(job.lib, "NonExistent/DeletedFolder"))) + + // The existing folder should have been removed from lastUpdates + Expect(job.lastUpdates).ToNot(HaveKey(model.FolderID(job.lib, "Artist/Album1"))) + + // Folders not in targets should remain in lastUpdates + Expect(job.lastUpdates).To(HaveKey(model.FolderID(job.lib, "OtherArtist/Album3"))) + }) + }) }) Describe("helper functions", func() { @@ -115,6 +230,7 @@ var _ = Describe("walk_dir_tree", func() { Context("with symlinks enabled", func() { BeforeEach(func() { + tests.SkipOnWindows("symlink semantics") conf.Server.Scanner.FollowSymlinks = true }) diff --git a/scanner/watcher.go b/scanner/watcher.go index bf4f7f9d0..376db910c 100644 --- a/scanner/watcher.go +++ b/scanner/watcher.go @@ -5,49 +5,79 @@ import ( "fmt" "io/fs" "path/filepath" + "sync" "time" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core/storage" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/utils/singleton" ) type Watcher interface { Run(ctx context.Context) error + Watch(ctx context.Context, lib *model.Library) error + StopWatching(ctx context.Context, libraryID int) error } type watcher struct { - ds model.DataStore - scanner Scanner - triggerWait time.Duration + mainCtx context.Context + ds model.DataStore + scanner model.Scanner + triggerWait time.Duration + watcherNotify chan scanNotification + libraryWatchers map[int]*libraryWatcherInstance + mu sync.RWMutex } -func NewWatcher(ds model.DataStore, s Scanner) Watcher { - return &watcher{ds: ds, scanner: s, triggerWait: conf.Server.Scanner.WatcherWait} +type libraryWatcherInstance struct { + library *model.Library + cancel context.CancelFunc +} + +type scanNotification struct { + Library *model.Library + FolderPath string +} + +// GetWatcher returns the watcher singleton +func GetWatcher(ds model.DataStore, s model.Scanner) Watcher { + return singleton.GetInstance(func() *watcher { + return &watcher{ + ds: ds, + scanner: s, + triggerWait: conf.Server.Scanner.WatcherWait, + watcherNotify: make(chan scanNotification, 500), + libraryWatchers: make(map[int]*libraryWatcherInstance), + } + }) } func (w *watcher) Run(ctx context.Context) error { + // Keep the main context to be used in all watchers added later + w.mainCtx = ctx + + // Start watchers for all existing libraries libs, err := w.ds.Library(ctx).GetAll() if err != nil { return fmt.Errorf("getting libraries: %w", err) } - watcherChan := make(chan struct{}) - defer close(watcherChan) - - // Start a watcher for each library for _, lib := range libs { - go watchLib(ctx, lib, watcherChan) + if err := w.Watch(ctx, &lib); err != nil { + log.Warn(ctx, "Failed to start watcher for existing library", "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, err) + } } + // Main scan triggering loop trigger := time.NewTimer(w.triggerWait) trigger.Stop() - waiting := false + targets := make(map[model.ScanTarget]struct{}) for { select { case <-trigger.C: - log.Info("Watcher: Triggering scan") + log.Info("Watcher: Triggering scan for changed folders", "numTargets", len(targets)) status, err := w.scanner.Status(ctx) if err != nil { log.Error(ctx, "Watcher: Error retrieving Scanner status", err) @@ -58,9 +88,23 @@ func (w *watcher) Run(ctx context.Context) error { trigger.Reset(w.triggerWait * 3) continue } - waiting = false + + // Convert targets map to slice + targetSlice := make([]model.ScanTarget, 0, len(targets)) + for target := range targets { + targetSlice = append(targetSlice, target) + } + + // Clear targets for next batch + targets = make(map[model.ScanTarget]struct{}) + go func() { - _, err := w.scanner.ScanAll(ctx, false) + var err error + if conf.Server.DevSelectiveWatcher { + _, err = w.scanner.ScanFolders(ctx, false, targetSlice) + } else { + _, err = w.scanner.ScanAll(ctx, false) + } if err != nil { log.Error(ctx, "Watcher: Error scanning", err) } else { @@ -68,65 +112,213 @@ func (w *watcher) Run(ctx context.Context) error { } }() case <-ctx.Done(): - return nil - case <-watcherChan: - if !waiting { - log.Debug(ctx, "Watcher: Detected changes. Waiting for more changes before triggering scan") - waiting = true + // Stop all library watchers + w.mu.Lock() + for libraryID, instance := range w.libraryWatchers { + log.Debug(ctx, "Stopping library watcher due to context cancellation", "libraryID", libraryID) + instance.cancel() } - + w.libraryWatchers = make(map[int]*libraryWatcherInstance) + w.mu.Unlock() + return nil + case notification := <-w.watcherNotify: + // Reset the trigger timer for debounce trigger.Reset(w.triggerWait) + + lib := notification.Library + folderPath := notification.FolderPath + + // If already scheduled for scan, skip + target := model.ScanTarget{LibraryID: lib.ID, FolderPath: folderPath} + if _, exists := targets[target]; exists { + continue + } + targets[target] = struct{}{} + + log.Debug(ctx, "Watcher: Detected changes. Waiting for more changes before triggering scan", + "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, "folderPath", folderPath) } } } -func watchLib(ctx context.Context, lib model.Library, watchChan chan struct{}) { +func (w *watcher) Watch(ctx context.Context, lib *model.Library) error { + w.mu.Lock() + defer w.mu.Unlock() + + // If Run() hasn't been called yet, mainCtx will be nil - skip watching + if w.mainCtx == nil { + log.Debug(ctx, "Watcher not started yet, skipping watch for library", "libraryID", lib.ID, "name", lib.Name) + return nil + } + + // Stop existing watcher if any + if existingInstance, exists := w.libraryWatchers[lib.ID]; exists { + log.Debug(ctx, "Stopping existing watcher before starting new one", "libraryID", lib.ID, "name", lib.Name) + existingInstance.cancel() + } + + // Start new watcher + watcherCtx, cancel := context.WithCancel(w.mainCtx) //nolint:gosec // cancel is stored in instance and called on shutdown + instance := &libraryWatcherInstance{ + library: lib, + cancel: cancel, + } + + w.libraryWatchers[lib.ID] = instance + + // Start watching in a goroutine + go func() { + defer func() { + w.mu.Lock() + if currentInstance, exists := w.libraryWatchers[lib.ID]; exists && currentInstance == instance { + delete(w.libraryWatchers, lib.ID) + } + w.mu.Unlock() + }() + + err := w.watchLibrary(watcherCtx, lib) + if err != nil && watcherCtx.Err() == nil { // Only log error if not due to cancellation + log.Error(ctx, "Watcher error", "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, err) + } + }() + + log.Info(ctx, "Started watcher for library", "libraryID", lib.ID, "name", lib.Name, "path", lib.Path) + return nil +} + +func (w *watcher) StopWatching(ctx context.Context, libraryID int) error { + w.mu.Lock() + defer w.mu.Unlock() + + instance, exists := w.libraryWatchers[libraryID] + if !exists { + log.Debug(ctx, "No watcher found to stop", "libraryID", libraryID) + return nil + } + + instance.cancel() + delete(w.libraryWatchers, libraryID) + + log.Info(ctx, "Stopped watcher for library", "libraryID", libraryID, "name", instance.library.Name) + return nil +} + +// watchLibrary implements the core watching logic for a single library (extracted from old watchLib function) +func (w *watcher) watchLibrary(ctx context.Context, lib *model.Library) error { s, err := storage.For(lib.Path) if err != nil { - log.Error(ctx, "Watcher: Error creating storage", "library", lib.ID, "path", lib.Path, err) - return + return fmt.Errorf("creating storage: %w", err) } + fsys, err := s.FS() if err != nil { - log.Error(ctx, "Watcher: Error getting FS", "library", lib.ID, "path", lib.Path, err) - return + return fmt.Errorf("getting FS: %w", err) } + watcher, ok := s.(storage.Watcher) if !ok { - log.Info(ctx, "Watcher not supported", "library", lib.ID, "path", lib.Path) - return + log.Info(ctx, "Watcher not supported for storage type", "libraryID", lib.ID, "path", lib.Path) + return nil } + c, err := watcher.Start(ctx) if err != nil { - log.Error(ctx, "Watcher: Error watching library", "library", lib.ID, "path", lib.Path, err) - return + return fmt.Errorf("starting watcher: %w", err) } + absLibPath, err := filepath.Abs(lib.Path) if err != nil { - log.Error(ctx, "Watcher: Error converting lib.Path to absolute", "library", lib.ID, "path", lib.Path, err) - return + return fmt.Errorf("converting to absolute path: %w", err) } - log.Info(ctx, "Watcher started", "library", lib.ID, "libPath", lib.Path, "absoluteLibPath", absLibPath) + + log.Info(ctx, "Watcher started for library", "libraryID", lib.ID, "name", lib.Name, "path", lib.Path, "absoluteLibPath", absLibPath) + + return w.processLibraryEvents(ctx, lib, fsys, c, absLibPath) +} + +// processLibraryEvents processes filesystem events for a library. +func (w *watcher) processLibraryEvents(ctx context.Context, lib *model.Library, fsys storage.MusicFS, events <-chan string, absLibPath string) error { for { select { case <-ctx.Done(): - return - case path := <-c: - path, err = filepath.Rel(absLibPath, path) + log.Debug(ctx, "Watcher stopped due to context cancellation", "libraryID", lib.ID, "name", lib.Name) + return nil + case path := <-events: + path, err := filepath.Rel(absLibPath, path) if err != nil { - log.Error(ctx, "Watcher: Error getting relative path", "library", lib.ID, "libPath", absLibPath, "path", path, err) + log.Error(ctx, "Error getting relative path", "libraryID", lib.ID, "absolutePath", absLibPath, "path", path, err) continue } + if isIgnoredPath(ctx, fsys, path) { - log.Trace(ctx, "Watcher: Ignoring change", "library", lib.ID, "path", path) + log.Trace(ctx, "Ignoring change", "libraryID", lib.ID, "path", path) continue } - log.Trace(ctx, "Watcher: Detected change", "library", lib.ID, "path", path, "libPath", absLibPath) - watchChan <- struct{}{} + log.Trace(ctx, "Detected change", "libraryID", lib.ID, "path", path, "absoluteLibPath", absLibPath) + + // Check if the original path (before resolution) matches .ndignore patterns + // This is crucial for deleted folders - if a deleted folder matches .ndignore, + // we should ignore it BEFORE resolveFolderPath walks up to the parent + if w.shouldIgnoreFolderPath(ctx, fsys, path) { + log.Debug(ctx, "Ignoring change matching .ndignore pattern", "libraryID", lib.ID, "path", path) + continue + } + + // Find the folder to scan - validate path exists as directory, walk up if needed + folderPath := resolveFolderPath(fsys, path) + // Double-check after resolution in case the resolved path is different and also matches patterns + if folderPath != path && w.shouldIgnoreFolderPath(ctx, fsys, folderPath) { + log.Trace(ctx, "Ignoring change in folder matching .ndignore pattern", "libraryID", lib.ID, "folderPath", folderPath) + continue + } + + // Notify the main watcher of changes. This will trigger a scan after the debounce period. + w.watcherNotify <- scanNotification{Library: lib, FolderPath: folderPath} } } } +// resolveFolderPath takes a path (which may be a file or directory) and returns +// the folder path to scan. If the path is a file, it walks up to find the parent +// directory. Returns empty string if the path should scan the library root. +func resolveFolderPath(fsys fs.FS, path string) string { + // Handle root paths immediately + if path == "." || path == "" { + return "" + } + + folderPath := path + for { + info, err := fs.Stat(fsys, folderPath) + if err == nil && info.IsDir() { + // Found a valid directory + return folderPath + } + if folderPath == "." || folderPath == "" { + // Reached root, scan entire library + return "" + } + // Walk up the tree + dir, _ := filepath.Split(folderPath) + if dir == "" || dir == "." { + return "" + } + // Remove trailing slash + folderPath = filepath.Clean(dir) + } +} + +// shouldIgnoreFolderPath checks if the given folderPath should be ignored based on .ndignore patterns +// in the library. It pushes all parent folders onto the IgnoreChecker stack before checking. +func (w *watcher) shouldIgnoreFolderPath(ctx context.Context, fsys storage.MusicFS, folderPath string) bool { + checker := newIgnoreChecker(fsys) + err := checker.PushAllParents(ctx, folderPath) + if err != nil { + log.Warn(ctx, "Watcher: Error pushing ignore patterns for folder", "path", folderPath, err) + } + return checker.ShouldIgnore(ctx, folderPath) +} + func isIgnoredPath(_ context.Context, _ fs.FS, path string) bool { baseDir, name := filepath.Split(path) switch { diff --git a/scanner/watcher_test.go b/scanner/watcher_test.go new file mode 100644 index 000000000..9795129b0 --- /dev/null +++ b/scanner/watcher_test.go @@ -0,0 +1,493 @@ +package scanner + +import ( + "context" + "io/fs" + "path/filepath" + "testing/fstest" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Watcher", func() { + var ctx context.Context + var cancel context.CancelFunc + var mockScanner *tests.MockScanner + var mockDS *tests.MockDataStore + var w *watcher + var lib *model.Library + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Scanner.WatcherWait = 50 * time.Millisecond // Short wait for tests + + ctx, cancel = context.WithCancel(GinkgoT().Context()) + DeferCleanup(cancel) + + lib = &model.Library{ + ID: 1, + Name: "Test Library", + Path: "/test/library", + } + + // Set up mocks + mockScanner = tests.NewMockScanner() + mockDS = &tests.MockDataStore{} + mockLibRepo := &tests.MockLibraryRepo{} + mockLibRepo.SetData(model.Libraries{*lib}) + mockDS.MockedLibrary = mockLibRepo + + // Create a new watcher instance (not singleton) for testing + w = &watcher{ + ds: mockDS, + scanner: mockScanner, + triggerWait: conf.Server.Scanner.WatcherWait, + watcherNotify: make(chan scanNotification, 10), + libraryWatchers: make(map[int]*libraryWatcherInstance), + mainCtx: ctx, + } + }) + + Describe("Watch before Run", func() { + It("returns nil and does not panic when mainCtx is nil", func() { + w.mainCtx = nil + err := w.Watch(ctx, lib) + Expect(err).ToNot(HaveOccurred()) + Expect(w.libraryWatchers).To(BeEmpty()) + }) + }) + + Describe("Target Collection and Deduplication", func() { + BeforeEach(func() { + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("creates separate targets for different folders", FlakeAttempts(3), func() { + // Send notifications for different folders + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist2"} + + // Wait for a scan that collected both targets + Eventually(func() []model.ScanTarget { + calls := mockScanner.GetScanFoldersCalls() + if len(calls) == 0 { + return nil + } + return calls[0].Targets + }, 500*time.Millisecond, 10*time.Millisecond).Should(HaveLen(2)) + + // Verify targets + calls := mockScanner.GetScanFoldersCalls() + folderPaths := make(map[string]bool) + for _, target := range calls[0].Targets { + Expect(target.LibraryID).To(Equal(1)) + folderPaths[target.FolderPath] = true + } + Expect(folderPaths).To(HaveKey("artist1")) + Expect(folderPaths).To(HaveKey("artist2")) + }) + + It("handles different folder paths correctly", func() { + // Send notification for nested folder + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + + // Wait for watcher to process and trigger scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 500*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Verify the target + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + Expect(calls[0].Targets[0].FolderPath).To(Equal("artist1/album1")) + }) + + It("deduplicates folder and file within same folder", func() { + // Send multiple notifications for the same folder + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1/album1"} + + // Wait for watcher to process and trigger scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 500*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Verify only one target despite multiple file/folder changes + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + Expect(calls[0].Targets[0].FolderPath).To(Equal("artist1/album1")) + }) + }) + + Describe("Timer Behavior", func() { + BeforeEach(func() { + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("resets timer on each change (debouncing)", FlakeAttempts(3), func() { + // Send first notification + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + + // Verify no scan fires during a window shorter than the debounce wait + Consistently(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 20*time.Millisecond, 5*time.Millisecond).Should(Equal(0)) + + // Send another notification (resets timer) + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + + // Again, no scan should fire within a short window + Consistently(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 20*time.Millisecond, 5*time.Millisecond).Should(Equal(0)) + + // Now wait for the debounce timer to expire and trigger scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 500*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + }) + + It("triggers scan after quiet period", func() { + // Send notification + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + + // No scan immediately + Expect(mockScanner.GetScanFoldersCallCount()).To(Equal(0)) + + // Wait for quiet period + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 500*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + }) + }) + + Describe("Empty and Root Paths", func() { + BeforeEach(func() { + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("handles empty folder path (library root)", func() { + // Send notification with empty folder path + w.watcherNotify <- scanNotification{Library: lib, FolderPath: ""} + + // Wait for scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 500*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Should scan the library root + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + Expect(calls[0].Targets[0].FolderPath).To(Equal("")) + }) + + It("deduplicates empty and dot paths", func() { + // Send notifications with empty and dot paths + w.watcherNotify <- scanNotification{Library: lib, FolderPath: ""} + w.watcherNotify <- scanNotification{Library: lib, FolderPath: ""} + + // Wait for scan + Eventually(func() int { + return mockScanner.GetScanFoldersCallCount() + }, 500*time.Millisecond, 10*time.Millisecond).Should(Equal(1)) + + // Should have only one target + calls := mockScanner.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].Targets).To(HaveLen(1)) + }) + }) + + Describe("Multiple Libraries", func() { + var lib2 *model.Library + + BeforeEach(func() { + // Create second library + lib2 = &model.Library{ + ID: 2, + Name: "Test Library 2", + Path: "/test/library2", + } + + mockLibRepo := mockDS.MockedLibrary.(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{*lib, *lib2}) + + // Start watcher in background + go func() { + _ = w.Run(ctx) + }() + + // Give watcher time to initialize + time.Sleep(10 * time.Millisecond) + }) + + It("creates separate targets for different libraries", func() { + // Send notifications for both libraries + w.watcherNotify <- scanNotification{Library: lib, FolderPath: "artist1"} + w.watcherNotify <- scanNotification{Library: lib2, FolderPath: "artist2"} + + // Wait for a scan that collected both targets + Eventually(func() []model.ScanTarget { + calls := mockScanner.GetScanFoldersCalls() + if len(calls) == 0 { + return nil + } + return calls[0].Targets + }, 500*time.Millisecond, 10*time.Millisecond).Should(HaveLen(2)) + + // Verify library IDs are different + calls := mockScanner.GetScanFoldersCalls() + libraryIDs := make(map[int]bool) + for _, target := range calls[0].Targets { + libraryIDs[target.LibraryID] = true + } + Expect(libraryIDs).To(HaveKey(1)) + Expect(libraryIDs).To(HaveKey(2)) + }) + }) + + Describe(".ndignore handling", func() { + var ctx context.Context + var cancel context.CancelFunc + var w *watcher + var mockFS *mockMusicFS + var lib *model.Library + var eventChan chan string + var absLibPath string + + BeforeEach(func() { + ctx, cancel = context.WithCancel(GinkgoT().Context()) + DeferCleanup(cancel) + + // Set up library + var err error + absLibPath, err = filepath.Abs(".") + Expect(err).NotTo(HaveOccurred()) + + lib = &model.Library{ + ID: 1, + Name: "Test Library", + Path: absLibPath, + } + + // Create watcher with notification channel + w = &watcher{ + watcherNotify: make(chan scanNotification, 10), + } + + eventChan = make(chan string, 10) + }) + + // Helper to send an event - converts relative path to absolute + sendEvent := func(relativePath string) { + path := filepath.Join(absLibPath, relativePath) + eventChan <- path + } + + // Helper to start the real event processing loop + startEventProcessing := func() { + go func() { + defer GinkgoRecover() + // Call the actual processLibraryEvents method - testing the real implementation! + _ = w.processLibraryEvents(ctx, lib, mockFS, eventChan, absLibPath) + }() + } + + Context("when a folder matching .ndignore is deleted", func() { + BeforeEach(func() { + // Create filesystem with .ndignore containing _TEMP pattern + // The deleted folder (_TEMP) will NOT exist in the filesystem + mockFS = &mockMusicFS{ + FS: fstest.MapFS{ + "rock": &fstest.MapFile{Mode: fs.ModeDir}, + "rock/.ndignore": &fstest.MapFile{Data: []byte("_TEMP\n")}, + "rock/valid_album": &fstest.MapFile{Mode: fs.ModeDir}, + "rock/valid_album/track.mp3": &fstest.MapFile{Data: []byte("audio")}, + }, + } + }) + + It("should NOT send scan notification when deleted folder matches .ndignore", func() { + startEventProcessing() + + // Simulate deletion event for rock/_TEMP + sendEvent("rock/_TEMP") + + // Wait a bit to ensure event is processed + time.Sleep(50 * time.Millisecond) + + // No notification should have been sent + Consistently(eventChan, 100*time.Millisecond).Should(BeEmpty()) + }) + + It("should send scan notification for valid folder deletion", func() { + startEventProcessing() + + // Simulate deletion event for rock/other_folder (not in .ndignore and doesn't exist) + // Since it doesn't exist in mockFS, resolveFolderPath will walk up to "rock" + sendEvent("rock/other_folder") + + // Should receive notification for parent folder + Eventually(w.watcherNotify, 200*time.Millisecond).Should(Receive(Equal(scanNotification{ + Library: lib, + FolderPath: "rock", + }))) + }) + }) + + Context("with nested folder patterns", func() { + BeforeEach(func() { + mockFS = &mockMusicFS{ + FS: fstest.MapFS{ + "music": &fstest.MapFile{Mode: fs.ModeDir}, + "music/.ndignore": &fstest.MapFile{Data: []byte("**/temp\n**/cache\n")}, + "music/rock": &fstest.MapFile{Mode: fs.ModeDir}, + "music/rock/artist": &fstest.MapFile{Mode: fs.ModeDir}, + }, + } + }) + + It("should NOT send notification when nested ignored folder is deleted", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") + startEventProcessing() + + // Simulate deletion of music/rock/artist/temp (matches **/temp) + sendEvent("music/rock/artist/temp") + + // Wait to ensure event is processed + time.Sleep(50 * time.Millisecond) + + // No notification should be sent + Expect(w.watcherNotify).To(BeEmpty(), "Expected no scan notification for nested ignored folder") + }) + + It("should send notification for non-ignored nested folder", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") + startEventProcessing() + + // Simulate change in music/rock/artist (doesn't match any pattern) + sendEvent("music/rock/artist") + + // Should receive notification + Eventually(w.watcherNotify, 200*time.Millisecond).Should(Receive(Equal(scanNotification{ + Library: lib, + FolderPath: "music/rock/artist", + }))) + }) + }) + + Context("with file events in ignored folders", func() { + BeforeEach(func() { + mockFS = &mockMusicFS{ + FS: fstest.MapFS{ + "rock": &fstest.MapFile{Mode: fs.ModeDir}, + "rock/.ndignore": &fstest.MapFile{Data: []byte("_TEMP\n")}, + }, + } + }) + + It("should NOT send notification for file changes in ignored folders", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") + startEventProcessing() + + // Simulate file change in rock/_TEMP/file.mp3 + sendEvent("rock/_TEMP/file.mp3") + + // Wait to ensure event is processed + time.Sleep(50 * time.Millisecond) + + // No notification should be sent + Expect(w.watcherNotify).To(BeEmpty(), "Expected no scan notification for file in ignored folder") + }) + }) + }) +}) + +var _ = Describe("resolveFolderPath", func() { + var mockFS fs.FS + + BeforeEach(func() { + // Create a mock filesystem with some directories and files + mockFS = fstest.MapFS{ + "artist1": &fstest.MapFile{Mode: fs.ModeDir}, + "artist1/album1": &fstest.MapFile{Mode: fs.ModeDir}, + "artist1/album1/track1.mp3": &fstest.MapFile{Data: []byte("audio")}, + "artist1/album1/track2.mp3": &fstest.MapFile{Data: []byte("audio")}, + "artist1/album2": &fstest.MapFile{Mode: fs.ModeDir}, + "artist1/album2/song.flac": &fstest.MapFile{Data: []byte("audio")}, + "artist2": &fstest.MapFile{Mode: fs.ModeDir}, + "artist2/cover.jpg": &fstest.MapFile{Data: []byte("image")}, + } + }) + + It("returns directory path when given a directory", func() { + result := resolveFolderPath(mockFS, "artist1/album1") + Expect(result).To(Equal("artist1/album1")) + }) + + It("walks up to parent directory when given a file path", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") + result := resolveFolderPath(mockFS, "artist1/album1/track1.mp3") + Expect(result).To(Equal("artist1/album1")) + }) + + It("walks up multiple levels if needed", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") + result := resolveFolderPath(mockFS, "artist1/album1/nonexistent/file.mp3") + Expect(result).To(Equal("artist1/album1")) + }) + + It("returns empty string for non-existent paths at root", func() { + result := resolveFolderPath(mockFS, "nonexistent/path/file.mp3") + Expect(result).To(Equal("")) + }) + + It("returns empty string for dot path", func() { + result := resolveFolderPath(mockFS, ".") + Expect(result).To(Equal("")) + }) + + It("returns empty string for empty path", func() { + result := resolveFolderPath(mockFS, "") + Expect(result).To(Equal("")) + }) + + It("handles nested file paths correctly", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-scanner)") + result := resolveFolderPath(mockFS, "artist1/album2/song.flac") + Expect(result).To(Equal("artist1/album2")) + }) + + It("resolves to top-level directory", func() { + result := resolveFolderPath(mockFS, "artist2/cover.jpg") + Expect(result).To(Equal("artist2")) + }) +}) diff --git a/scheduler/crontab_schedule.go b/scheduler/crontab_schedule.go new file mode 100644 index 000000000..5de1ae145 --- /dev/null +++ b/scheduler/crontab_schedule.go @@ -0,0 +1,133 @@ +package scheduler + +import ( + "fmt" + "math/rand/v2" + "strconv" + "strings" + "time" + + "github.com/robfig/cron/v3" +) + +var parser = cron.NewParser( + cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor, +) + +// ParseCrontab parses a cron expression with support for the crontab(5) random ~ syntax. +// Random values are resolved once at parse time. If no ~ is present, it delegates to +// robfig/cron's standard parser. Duration strings (e.g., "5m") are converted to "@every 5m". +func ParseCrontab(spec string) (cron.Schedule, error) { + if spec == "" { + return nil, fmt.Errorf("empty spec string") + } + + if _, err := time.ParseDuration(spec); err == nil { + spec = "@every " + spec + } + + if !strings.Contains(spec, "~") { + return parser.Parse(spec) + } + + // Handle TZ=/CRON_TZ= prefix + var tzPrefix string + if strings.HasPrefix(spec, "TZ=") || strings.HasPrefix(spec, "CRON_TZ=") { + i := strings.Index(spec, " ") + if i == -1 { + return nil, fmt.Errorf("missing spec after timezone") + } + tzPrefix = spec[:i] + " " + spec = strings.TrimSpace(spec[i:]) + } + + // @ descriptors cannot contain ~ + if strings.HasPrefix(spec, "@") { + return nil, fmt.Errorf("random ~ syntax cannot be used with descriptors: %s", spec) + } + + fields := strings.Fields(spec) + fields, err := normalizeFields(fields) + if err != nil { + return nil, err + } + + // Resolve each ~ field to a concrete random value + for i, field := range fields { + if !strings.Contains(field, "~") { + continue + } + if strings.ContainsAny(field, ",/") { + return nil, fmt.Errorf("random ~ cannot be combined with lists or steps: %s", field) + } + v, parseErr := resolveRandomField(field, fieldBounds[i]) + if parseErr != nil { + return nil, parseErr + } + fields[i] = strconv.FormatUint(uint64(v), 10) + } + + // Re-assemble and parse with robfig + resolved := tzPrefix + strings.Join(fields, " ") + return parser.Parse(resolved) +} + +type bounds struct { + min, max uint +} + +var fieldBounds = [6]bounds{ + {0, 59}, // Second + {0, 59}, // Minute + {0, 23}, // Hour + {1, 31}, // Dom + {1, 12}, // Month + {0, 6}, // Dow +} + +// resolveRandomField parses a ~ field and returns a random value within the range. +func resolveRandomField(field string, b bounds) (uint, error) { + parts := strings.SplitN(field, "~", 2) + + min := b.min + max := b.max + + if parts[0] != "" { + v, err := strconv.ParseUint(parts[0], 10, 0) + if err != nil { + return 0, fmt.Errorf("invalid random range start: %s", parts[0]) + } + min = uint(v) + } + + if parts[1] != "" { + v, err := strconv.ParseUint(parts[1], 10, 0) + if err != nil { + return 0, fmt.Errorf("invalid random range end: %s", parts[1]) + } + max = uint(v) + } + + if min < b.min { + return 0, fmt.Errorf("random range start (%d) below minimum (%d): %s", min, b.min, field) + } + if max > b.max { + return 0, fmt.Errorf("random range end (%d) above maximum (%d): %s", max, b.max, field) + } + if min > max { + return 0, fmt.Errorf("random range start (%d) beyond end (%d): %s", min, max, field) + } + + return min + uint(rand.IntN(int(max-min+1))), nil //nolint:gosec // Cryptographic randomness not needed for schedule jitter +} + +func normalizeFields(fields []string) ([]string, error) { + switch len(fields) { + case 5: + return append([]string{"0"}, fields...), nil + case 6: + return fields, nil + default: + return nil, fmt.Errorf("expected 5 or 6 fields, found %d: %v", len(fields), fields) + } +} diff --git a/scheduler/crontab_schedule_test.go b/scheduler/crontab_schedule_test.go new file mode 100644 index 000000000..b616f0884 --- /dev/null +++ b/scheduler/crontab_schedule_test.go @@ -0,0 +1,194 @@ +package scheduler + +import ( + "time" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/robfig/cron/v3" +) + +var _ = Describe("ParseCrontab", func() { + Describe("standard expressions", func() { + It("parses a 5-field expression", func() { + sched, err := ParseCrontab("5 * * * *") + Expect(err).ToNot(HaveOccurred()) + Expect(sched).To(BeAssignableToTypeOf(&cron.SpecSchedule{})) + }) + + It("parses a 6-field expression with seconds", func() { + sched, err := ParseCrontab("30 5 * * * *") + Expect(err).ToNot(HaveOccurred()) + Expect(sched).To(BeAssignableToTypeOf(&cron.SpecSchedule{})) + }) + + It("converts duration string to @every", func() { + sched, err := ParseCrontab("5m") + Expect(err).ToNot(HaveOccurred()) + Expect(sched).To(BeAssignableToTypeOf(cron.ConstantDelaySchedule{})) + }) + + It("returns error for empty string", func() { + _, err := ParseCrontab("") + Expect(err).To(HaveOccurred()) + }) + }) + + Describe("random ~ syntax", func() { + It("resolves A~B to a value within range", func() { + sched, err := ParseCrontab("0~30 * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 0)) + Expect(minute).To(BeNumerically("<=", 30)) + }) + + It("resolves ~ alone to full field range", func() { + sched, err := ParseCrontab("~ * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 0)) + Expect(minute).To(BeNumerically("<=", 59)) + }) + + It("resolves ~B as min~B", func() { + sched, err := ParseCrontab("~15 * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 0)) + Expect(minute).To(BeNumerically("<=", 15)) + }) + + It("resolves A~ as A~max", func() { + sched, err := ParseCrontab("15~ * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + minute := findSetBit(spec.Minute) + Expect(minute).To(BeNumerically(">=", 15)) + Expect(minute).To(BeNumerically("<=", 59)) + }) + + It("resolves multiple random fields independently", func() { + sched, err := ParseCrontab("0~30 0~12 * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + Expect(findSetBit(spec.Minute)).To(BeNumerically("<=", 30)) + Expect(findSetBit(spec.Hour)).To(BeNumerically("<=", 12)) + }) + + It("resolves ~ in DOM field with correct bounds", func() { + sched, err := ParseCrontab("0 0 ~ * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + dom := findSetBit(spec.Dom) + Expect(dom).To(BeNumerically(">=", 1)) + Expect(dom).To(BeNumerically("<=", 31)) + }) + + It("resolves ~ in month field with correct bounds", func() { + sched, err := ParseCrontab("0 0 1 ~ *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + month := findSetBit(spec.Month) + Expect(month).To(BeNumerically(">=", 1)) + Expect(month).To(BeNumerically("<=", 12)) + }) + + It("resolves ~ in DOW field with correct bounds", func() { + sched, err := ParseCrontab("0 0 * * ~") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + dow := findSetBit(spec.Dow) + Expect(dow).To(BeNumerically(">=", 0)) + Expect(dow).To(BeNumerically("<=", 6)) + }) + + It("preserves TZ= prefix through resolution", func() { + sched, err := ParseCrontab("TZ=America/New_York 0~30 * * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + nyc, _ := time.LoadLocation("America/New_York") + Expect(spec.Location).To(Equal(nyc)) + }) + + It("preserves non-random fields", func() { + sched, err := ParseCrontab("0~30 10 * * *") + Expect(err).ToNot(HaveOccurred()) + spec := sched.(*cron.SpecSchedule) + Expect(spec.Hour & (1 << 10)).ToNot(BeZero()) + }) + + It("resolves to a stable value across repeated Next calls", func() { + sched, err := ParseCrontab("0~30 * * * *") + Expect(err).ToNot(HaveOccurred()) + + ref := time.Date(2025, 1, 1, 12, 0, 0, 0, time.UTC) + first := sched.Next(ref) + for range 50 { + Expect(sched.Next(ref)).To(Equal(first)) + } + }) + }) + + Describe("error cases", func() { + It("rejects min > max", func() { + _, err := ParseCrontab("30~0 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("beyond end")) + }) + + It("rejects value above field maximum", func() { + _, err := ParseCrontab("0~60 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("above maximum")) + }) + + It("rejects value below field minimum", func() { + _, err := ParseCrontab("0 0 0~15 * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("below minimum")) + }) + + It("rejects ~ mixed with comma (list)", func() { + _, err := ParseCrontab("0~30,45 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("cannot be combined")) + }) + + It("rejects ~ mixed with slash (step)", func() { + _, err := ParseCrontab("0~30/5 * * * *") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("cannot be combined")) + }) + + It("rejects @ descriptor with ~", func() { + _, err := ParseCrontab("@every 0~30m") + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("descriptor")) + }) + + It("rejects wrong number of fields", func() { + _, err := ParseCrontab("0~30 * *") + Expect(err).To(HaveOccurred()) + }) + + It("rejects non-numeric range values", func() { + _, err := ParseCrontab("a~b * * * *") + Expect(err).To(HaveOccurred()) + }) + }) +}) + +// findSetBit returns the lowest bit position set in v, ignoring the starBit (bit 63). +func findSetBit(v uint64) int { + v &^= 1 << 63 // clear starBit + for i := range 63 { + if v&(1<<uint(i)) != 0 { + return i + } + } + return -1 +} diff --git a/scheduler/log_adapter.go b/scheduler/log_adapter.go index ccaab0cd4..057818785 100644 --- a/scheduler/log_adapter.go +++ b/scheduler/log_adapter.go @@ -6,16 +6,16 @@ import ( type logger struct{} -func (l *logger) Info(msg string, keysAndValues ...interface{}) { - args := []interface{}{ +func (l *logger) Info(msg string, keysAndValues ...any) { + args := []any{ "Scheduler: " + msg, } args = append(args, keysAndValues...) log.Debug(args...) } -func (l *logger) Error(err error, msg string, keysAndValues ...interface{}) { - args := []interface{}{ +func (l *logger) Error(err error, msg string, keysAndValues ...any) { + args := []any{ "Scheduler: " + msg, } args = append(args, keysAndValues...) diff --git a/scheduler/scheduler.go b/scheduler/scheduler.go index 062bf4344..cb53af421 100644 --- a/scheduler/scheduler.go +++ b/scheduler/scheduler.go @@ -9,7 +9,8 @@ import ( type Scheduler interface { Run(ctx context.Context) - Add(crontab string, cmd func()) error + Add(crontab string, cmd func()) (int, error) + Remove(id int) } func GetInstance() Scheduler { @@ -31,7 +32,15 @@ func (s *scheduler) Run(ctx context.Context) { s.c.Stop() } -func (s *scheduler) Add(crontab string, cmd func()) error { - _, err := s.c.AddFunc(crontab, cmd) - return err +func (s *scheduler) Add(crontab string, cmd func()) (int, error) { + schedule, err := ParseCrontab(crontab) + if err != nil { + return 0, err + } + entryID := s.c.Schedule(schedule, cron.FuncJob(cmd)) + return int(entryID), nil +} + +func (s *scheduler) Remove(id int) { + s.c.Remove(cron.EntryID(id)) } diff --git a/scheduler/scheduler_test.go b/scheduler/scheduler_test.go new file mode 100644 index 000000000..8ae69c19b --- /dev/null +++ b/scheduler/scheduler_test.go @@ -0,0 +1,51 @@ +package scheduler + +import ( + "testing" + "time" + + "github.com/navidrome/navidrome/log" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "github.com/robfig/cron/v3" +) + +func TestScheduler(t *testing.T) { + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Scheduler Suite") +} + +var _ = Describe("Scheduler", func() { + var s *scheduler + + BeforeEach(func() { + c := cron.New(cron.WithLogger(&logger{})) + s = &scheduler{c: c} + s.c.Start() // Start the scheduler for tests + }) + + AfterEach(func() { + s.c.Stop() // Stop the scheduler after tests + }) + + It("adds and executes a job", FlakeAttempts(3), func() { + done := make(chan struct{}) + + id, err := s.Add("@every 50ms", func() { + close(done) + }) + + Expect(err).ToNot(HaveOccurred()) + Expect(id).ToNot(BeZero()) + + Eventually(done, 5*time.Second).Should(BeClosed()) + }) + + It("adds a job with random ~ syntax", func() { + id, err := s.Add("0~59 * * * *", func() {}) + Expect(err).ToNot(HaveOccurred()) + Expect(id).ToNot(BeZero()) + s.Remove(id) + }) +}) diff --git a/scripts/setup-worktree.sh b/scripts/setup-worktree.sh new file mode 100755 index 000000000..65113f3b2 --- /dev/null +++ b/scripts/setup-worktree.sh @@ -0,0 +1,57 @@ +#!/usr/bin/env bash +# +# Setup a git worktree for Navidrome development. +# This script is called automatically by `make worktree` and by Claude Code's +# worktree isolation, but can also be run standalone: +# +# ./scripts/setup-worktree.sh <worktree-path> [--go-only] +# +# Options: +# --go-only Skip frontend (npm) setup. Useful for agents working only on Go code. +# +set -euo pipefail + +WORKTREE_PATH="${1:?Usage: $0 <worktree-path> [--go-only]}" +GO_ONLY="${2:-}" + +# Resolve the main worktree root (where the original repo lives) +MAIN_WORKTREE="$(git -C "$WORKTREE_PATH" worktree list --porcelain | head -1 | sed 's/^worktree //')" + +if [ ! -d "$WORKTREE_PATH" ]; then + echo "ERROR: Worktree path does not exist: $WORKTREE_PATH" + exit 1 +fi + +cd "$WORKTREE_PATH" + +echo "==> Setting up worktree at $WORKTREE_PATH" + +# 1. Download Go dependencies +echo "==> Downloading Go dependencies..." +go mod download + +# 2. Install frontend dependencies (unless --go-only) +if [ "$GO_ONLY" != "--go-only" ]; then + echo "==> Installing frontend dependencies..." + (cd ui && npm ci --prefer-offline --no-audit 2>/dev/null || npm ci) +else + echo "==> Skipping frontend setup (--go-only)" +fi + +# 3. Create required directories +mkdir -p data + +# 4. Copy navidrome.toml from main worktree if it exists and not already present +if [ ! -f navidrome.toml ] && [ -f "$MAIN_WORKTREE/navidrome.toml" ]; then + echo "==> Copying navidrome.toml from main worktree..." + cp "$MAIN_WORKTREE/navidrome.toml" navidrome.toml +fi + +# 5. Copy existing database from main worktree (already migrated and scanned) +# This is much faster than running migrations + a full scan from scratch. +if [ ! -f data/navidrome.db ] && [ -f "$MAIN_WORKTREE/data/navidrome.db" ]; then + echo "==> Copying database from main worktree (pre-migrated, pre-scanned)..." + cp "$MAIN_WORKTREE/data/navidrome.db" data/navidrome.db +fi + +echo "==> Worktree setup complete: $WORKTREE_PATH" diff --git a/server/auth.go b/server/auth.go index 5b35f72ed..6a25f1406 100644 --- a/server/auth.go +++ b/server/auth.go @@ -68,8 +68,8 @@ func doLogin(ds model.DataStore, username string, password string, w http.Respon _ = rest.RespondWithJSON(w, http.StatusOK, payload) } -func buildAuthPayload(user *model.User) map[string]interface{} { - payload := map[string]interface{}{ +func buildAuthPayload(user *model.User) map[string]any { + payload := map[string]any{ "id": user.ID, "name": user.Name, "username": user.UserName, @@ -135,7 +135,6 @@ func createAdmin(ds model.DataStore) func(w http.ResponseWriter, r *http.Request func createAdminUser(ctx context.Context, ds model.DataStore, username, password string) error { log.Warn(ctx, "Creating initial user", "user", username) - now := time.Now() caser := cases.Title(language.Und) initialUser := model.User{ ID: id.NewRandom(), @@ -144,7 +143,7 @@ func createAdminUser(ctx context.Context, ds model.DataStore, username, password Email: "", NewPassword: password, IsAdmin: true, - LastLoginAt: &now, + LastLoginAt: new(time.Now()), } err := ds.User(ctx).Put(&initialUser) if err != nil { @@ -171,7 +170,7 @@ func validateLogin(userRepo model.UserRepository, userName, password string) (*m return u, nil } -func jwtVerifier(next http.Handler) http.Handler { +func JWTVerifier(next http.Handler) http.Handler { return jwtauth.Verify(auth.TokenAuth, tokenFromHeader, jwtauth.TokenFromCookie, jwtauth.TokenFromQuery)(next) } @@ -185,32 +184,45 @@ func tokenFromHeader(r *http.Request) string { } func UsernameFromToken(r *http.Request) string { - token, claims, err := jwtauth.FromContext(r.Context()) - if err != nil || claims["sub"] == nil || token == nil { + token, _, err := jwtauth.FromContext(r.Context()) + if err != nil || token == nil { return "" } - log.Trace(r, "Found username in JWT token", "username", token.Subject()) - return token.Subject() + sub, _ := token.Subject() + if sub == "" { + return "" + } + log.Trace(r, "Found username in JWT token", "username", sub) + return sub } -func UsernameFromReverseProxyHeader(r *http.Request) string { - if conf.Server.ReverseProxyWhitelist == "" { +func UsernameFromExtAuthHeader(r *http.Request) string { + if conf.Server.ExtAuth.TrustedSources == "" { return "" } reverseProxyIp, ok := request.ReverseProxyIpFrom(r.Context()) if !ok { - log.Error("ReverseProxyWhitelist enabled but no proxy IP found in request context. Please report this error.") + log.Error("ExtAuth enabled but no proxy IP found in request context. Please report this error.") return "" } - if !validateIPAgainstList(reverseProxyIp, conf.Server.ReverseProxyWhitelist) { - log.Warn(r.Context(), "IP is not whitelisted for reverse proxy login", "proxy-ip", reverseProxyIp, "client-ip", r.RemoteAddr) + if !validateIPAgainstList(reverseProxyIp, conf.Server.ExtAuth.TrustedSources) { + log.Warn(r.Context(), "IP is not whitelisted for external authentication", "proxy-ip", reverseProxyIp, "client-ip", r.RemoteAddr) return "" } - username := r.Header.Get(conf.Server.ReverseProxyUserHeader) + username := r.Header.Get(conf.Server.ExtAuth.UserHeader) if username == "" { return "" } - log.Trace(r, "Found username in ReverseProxyUserHeader", "username", username) + log.Trace(r, "Found username in ExtAuth.UserHeader", "username", username) + return username +} + +func InternalAuth(r *http.Request) string { + username, ok := request.InternalAuthFrom(r.Context()) + if !ok { + return "" + } + log.Trace(r, "Found username in InternalAuth", "username", username) return username } @@ -247,7 +259,7 @@ func authenticateRequest(ds model.DataStore, r *http.Request, findUsernameFns .. func Authenticator(ds model.DataStore) func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - ctx, err := authenticateRequest(ds, r, UsernameFromConfig, UsernameFromToken, UsernameFromReverseProxyHeader) + ctx, err := authenticateRequest(ds, r, UsernameFromConfig, UsernameFromToken, UsernameFromExtAuthHeader) if err != nil { _ = rest.RespondWithError(w, http.StatusUnauthorized, "Not authenticated") return @@ -279,10 +291,10 @@ func JWTRefresher(next http.Handler) http.Handler { }) } -func handleLoginFromHeaders(ds model.DataStore, r *http.Request) map[string]interface{} { +func handleLoginFromHeaders(ds model.DataStore, r *http.Request) map[string]any { username := UsernameFromConfig(r) if username == "" { - username = UsernameFromReverseProxyHeader(r) + username = UsernameFromExtAuthHeader(r) if username == "" { return nil } diff --git a/server/auth_test.go b/server/auth_test.go index 06ca2ea39..f6af6f0d6 100644 --- a/server/auth_test.go +++ b/server/auth_test.go @@ -53,7 +53,7 @@ var _ = Describe("Auth", func() { It("returns the expected payload", func() { Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["isAdmin"]).To(Equal(true)) Expect(parsed["username"]).To(Equal("johndoe")) @@ -80,7 +80,7 @@ var _ = Describe("Auth", func() { req.Header.Add("Remote-User", "janedoe") resp = httptest.NewRecorder() conf.Server.UILoginBackgroundURL = "" - conf.Server.ReverseProxyWhitelist = "192.168.0.0/16,2001:4860:4860::/48" + conf.Server.ExtAuth.TrustedSources = "192.168.0.0/16,2001:4860:4860::/48" }) It("sets auth data if IPv4 matches whitelist", func() { @@ -88,7 +88,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) }) @@ -106,7 +106,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) }) @@ -127,7 +127,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["username"]).To(Equal(newUser)) }) @@ -137,7 +137,7 @@ var _ = Describe("Auth", func() { serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) Expect(parsed["isAdmin"]).To(BeFalse()) @@ -155,7 +155,7 @@ var _ = Describe("Auth", func() { It("does not set auth data when listening on unix socket without whitelist", func() { conf.Server.Address = "unix:/tmp/navidrome-test" - conf.Server.ReverseProxyWhitelist = "" + conf.Server.ExtAuth.TrustedSources = "" // No ReverseProxyIp in request context serveIndex(ds, fs, nil)(resp, req) @@ -176,13 +176,13 @@ var _ = Describe("Auth", func() { It("sets auth data when listening on unix socket with correct whitelist", func() { conf.Server.Address = "unix:/tmp/navidrome-test" - conf.Server.ReverseProxyWhitelist = conf.Server.ReverseProxyWhitelist + ",@" + conf.Server.ExtAuth.TrustedSources = conf.Server.ExtAuth.TrustedSources + ",@" req = req.WithContext(request.WithReverseProxyIp(req.Context(), "@")) serveIndex(ds, fs, nil)(resp, req) config := extractAppConfig(resp.Body.String()) - parsed := config["auth"].(map[string]interface{}) + parsed := config["auth"].(map[string]any) Expect(parsed["id"]).To(Equal("111")) }) @@ -206,7 +206,7 @@ var _ = Describe("Auth", func() { login(ds)(resp, req) Expect(resp.Code).To(Equal(http.StatusOK)) - var parsed map[string]interface{} + var parsed map[string]any Expect(json.Unmarshal(resp.Body.Bytes(), &parsed)).To(BeNil()) Expect(parsed["isAdmin"]).To(Equal(false)) Expect(parsed["username"]).To(Equal("janedoe")) @@ -302,8 +302,8 @@ var _ = Describe("Auth", func() { ds = &tests.MockDataStore{} req = httptest.NewRequest("GET", "/", nil) req = req.WithContext(request.WithReverseProxyIp(req.Context(), trustedIP)) - conf.Server.ReverseProxyWhitelist = "192.168.0.0/16" - conf.Server.ReverseProxyUserHeader = "Remote-User" + conf.Server.ExtAuth.TrustedSources = "192.168.0.0/16" + conf.Server.ExtAuth.UserHeader = "Remote-User" }) It("makes the first user an admin", func() { diff --git a/server/backgrounds/handler.go b/server/backgrounds/handler.go index 61b7d48b8..b00a51696 100644 --- a/server/backgrounds/handler.go +++ b/server/backgrounds/handler.go @@ -80,7 +80,7 @@ func (h *Handler) serveImage(ctx context.Context, item cache.Item) (io.Reader, e } c := http.Client{Timeout: imageRequestTimeout} req, _ := http.NewRequestWithContext(ctx, http.MethodGet, imageURL(image), nil) - resp, err := c.Do(req) //nolint:bodyclose // No need to close resp.Body, it will be closed via the CachedStream wrapper + resp, err := c.Do(req) //nolint:bodyclose,gosec // No need to close resp.Body, it will be closed via the CachedStream wrapper if errors.Is(err, context.DeadlineExceeded) { defaultImage, _ := base64.StdEncoding.DecodeString(consts.DefaultUILoginBackgroundOffline) return strings.NewReader(string(defaultImage)), nil diff --git a/server/e2e/doc.go b/server/e2e/doc.go new file mode 100644 index 000000000..51ee6f047 --- /dev/null +++ b/server/e2e/doc.go @@ -0,0 +1,113 @@ +// Package e2e provides end-to-end integration tests for the Navidrome Subsonic API. +// +// These tests exercise the full HTTP request/response cycle through the Subsonic API router, +// using a real SQLite database and real repository implementations while stubbing out external +// services (artwork, streaming, scrobbling, etc.) with noop implementations. +// +// # Test Infrastructure +// +// The suite uses [Ginkgo] v2 as the test runner and [Gomega] for assertions. It is invoked +// through the standard Go test entry point [TestSubsonicE2E], which initializes the test +// environment, creates a temporary SQLite database, and runs the specs. +// +// # Setup and Teardown +// +// During [BeforeSuite], the test infrastructure: +// +// 1. Creates a temporary SQLite database with WAL journal mode. +// 2. Initializes the schema via [db.Init]. +// 3. Creates two test users: an admin ("admin") and a regular user ("regular"), +// both with the password "password". +// 4. Creates a single library ("Music Library") backed by a fake in-memory filesystem +// (scheme "fake:///music") using the [storagetest] package. +// 5. Populates the filesystem with a set of test tracks spanning multiple artists, +// albums, genres, and years. +// 6. Runs the scanner to import all metadata into the database. +// 7. Takes a snapshot of the database to serve as a golden baseline for test isolation. +// +// # Test Data +// +// The fake filesystem contains the following music library structure: +// +// Rock/The Beatles/Abbey Road/ +// 01 - Come Together.mp3 (1969, Rock) +// 02 - Something.mp3 (1969, Rock) +// Rock/The Beatles/Help!/ +// 01 - Help.mp3 (1965, Rock) +// Rock/Led Zeppelin/IV/ +// 01 - Stairway To Heaven.mp3 (1971, Rock) +// Jazz/Miles Davis/Kind of Blue/ +// 01 - So What.mp3 (1959, Jazz) +// Pop/ +// 01 - Standalone Track.mp3 (2020, Pop) +// +// # Database Isolation +// +// Before each top-level Describe block, the [setupTestDB] function restores the database +// to its golden snapshot state using SQLite's ATTACH DATABASE mechanism. This copies all +// table data from the snapshot back into the main database, providing each test group with +// a clean, consistent starting state without the overhead of re-scanning the filesystem. +// +// A fresh [subsonic.Router] is also created for each test group, wired with real data store +// repositories and noop stubs for external services: +// +// - noopArtwork: returns [model.ErrNotFound] for all artwork requests. +// - noopStreamer: returns [model.ErrNotFound] for all stream requests. +// - noopArchiver: returns [model.ErrNotFound] for all archive requests. +// - noopProvider: returns empty results for all external metadata lookups. +// - noopPlayTracker: silently discards all scrobble events. +// +// # Request Helpers +// +// Tests build HTTP requests using the [buildReq] helper, which constructs a Subsonic API +// request with authentication parameters (username, password, API version "1.16.1", client +// name "test-client", and JSON format). Convenience wrappers include: +// +// - [doReq]: sends a request as the admin user and returns the parsed JSON response. +// - [doReqWithUser]: sends a request as a specific user. +// - [doRawReq] / [doRawReqWithUser]: returns the raw [httptest.ResponseRecorder] for +// binary content or status code inspection. +// +// Responses are parsed via [parseJSONResponse], which unwraps the Subsonic JSON envelope +// and returns the inner response map. +// +// # Test Organization +// +// Each test file covers a logical group of Subsonic API endpoints: +// +// - subsonic_system_test.go: ping, getLicense, getOpenSubsonicExtensions +// - subsonic_browsing_test.go: getMusicFolders, getIndexes, getArtists, getMusicDirectory, +// getArtist, getAlbum, getSong, getGenres +// - subsonic_searching_test.go: search2, search3 +// - subsonic_album_lists_test.go: getAlbumList, getAlbumList2 +// - subsonic_playlists_test.go: createPlaylist, getPlaylist, getPlaylists, +// updatePlaylist, deletePlaylist +// - subsonic_media_annotation_test.go: star, unstar, getStarred, setRating, scrobble +// - subsonic_media_retrieval_test.go: stream, download, getCoverArt, getAvatar, +// getLyrics, getLyricsBySongId +// - subsonic_bookmarks_test.go: createBookmark, getBookmarks, deleteBookmark, +// savePlayQueue, getPlayQueue +// - subsonic_radio_test.go: getInternetRadioStations, createInternetRadioStation, +// updateInternetRadioStation, deleteInternetRadioStation +// - subsonic_sharing_test.go: createShare, getShares, updateShare, deleteShare +// - subsonic_users_test.go: getUser, getUsers +// - subsonic_scan_test.go: getScanStatus, startScan +// - subsonic_multiuser_test.go: multi-user isolation and permission enforcement +// - subsonic_multilibrary_test.go: multi-library access control and data isolation +// +// Some test groups use Ginkgo's Ordered decorator to run tests sequentially within a block, +// allowing later tests to depend on state created by earlier ones (e.g., creating a playlist +// and then verifying it can be retrieved). +// +// # Running +// +// The e2e tests are included in the standard test suite and can be run with: +// +// make test PKG=./server/e2e # Run only e2e tests +// make test # Run all tests including e2e +// make test-race # Run with race detector +// +// [Ginkgo]: https://onsi.github.io/ginkgo/ +// [Gomega]: https://onsi.github.io/gomega/ +// [storagetest]: /core/storage/storagetest +package e2e diff --git a/server/e2e/e2e_suite_test.go b/server/e2e/e2e_suite_test.go new file mode 100644 index 000000000..7ce8de2e6 --- /dev/null +++ b/server/e2e/e2e_suite_test.go @@ -0,0 +1,544 @@ +package e2e + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "io" + "net/http" + "net/http/httptest" + "net/url" + "os" + "path/filepath" + "strings" + "testing" + "testing/fstest" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/external" + "github.com/navidrome/navidrome/core/ffmpeg" + "github.com/navidrome/navidrome/core/lyrics" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/persistence" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/server/subsonic" + "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestSubsonicE2E(t *testing.T) { + tests.Init(t, false) + defer db.Close(t.Context()) + log.SetLevel(log.LevelFatal) + RegisterFailHandler(Fail) + RunSpecs(t, "Subsonic API E2E Suite") +} + +// Easy aliases for the storagetest package +type _t = map[string]any + +var template = storagetest.Template +var track = storagetest.Track +var file = storagetest.File + +// MusicBrainz ID constants for test data (valid UUID v4 values) +const ( + mbidBeatlesArtist = "b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d" + mbidAbbeyRoadAlbum = "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" + mbidAbbeyRoadRelGroup = "d4c3b2a1-f6e5-4b7a-9d8c-1f0e3a2b5c4d" + mbidComeTogether = "11111111-1111-4111-a111-111111111111" // mbz_release_track_id + mbidComeTogetherRec = "22222222-2222-4222-a222-222222222222" // mbz_recording_id + mbidSomething = "33333333-3333-4333-a333-333333333333" // mbz_release_track_id + mbidSomethingRec = "44444444-4444-4444-a444-444444444444" // mbz_recording_id +) + +// Shared test state +var ( + ctx context.Context + ds *tests.MockDataStore + router *subsonic.Router + streamerSpy *spyStreamer + lib model.Library + + // Snapshot paths for fast DB restore + dbFilePath string + snapshotPath string + + // Admin user used for most tests + adminUser = model.User{ + ID: "admin-1", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + } + + // Regular (non-admin) user for permission tests + regularUser = model.User{ + ID: "regular-1", + UserName: "regular", + Name: "Regular User", + IsAdmin: false, + } +) + +func createFS(files fstest.MapFS) storagetest.FakeFS { + fs := storagetest.FakeFS{} + fs.SetFiles(files) + storagetest.Register("fake", &fs) + return fs +} + +// buildTestFS creates the full test filesystem matching the plan +func buildTestFS() storagetest.FakeFS { + abbeyRoad := template(_t{ + "albumartist": "The Beatles", + "artist": "The Beatles", + "album": "Abbey Road", + "year": 1969, + "genre": "Rock", + "musicbrainz_artistid": mbidBeatlesArtist, + "musicbrainz_albumartistid": mbidBeatlesArtist, + "musicbrainz_albumid": mbidAbbeyRoadAlbum, + "musicbrainz_releasegroupid": mbidAbbeyRoadRelGroup, + }) + help := template(_t{"albumartist": "The Beatles", "artist": "The Beatles", "album": "Help!", "year": 1965, "genre": "Rock"}) + ledZepIV := template(_t{"albumartist": "Led Zeppelin", "artist": "Led Zeppelin", "album": "IV", "year": 1971, "genre": "Rock"}) + kindOfBlue := template(_t{"albumartist": "Miles Davis", "artist": "Miles Davis", "album": "Kind of Blue", "year": 1959, "genre": "Jazz"}) + popTrack := template(_t{"albumartist": "Various", "artist": "Various", "album": "Pop", "year": 2020, "genre": "Pop"}) + cowboyBebop := template(_t{"albumartist": "シートベルツ", "artist": "シートベルツ", "album": "COWBOY BEBOP", "year": 1998, "genre": "Jazz"}) + + // Template for diverse-format transcode test tracks + tcBase := _t{"albumartist": "Test Artist", "artist": "Test Artist", "album": "Transcode Formats", "year": 2024, "genre": "Test"} + + return createFS(fstest.MapFS{ + // Rock / The Beatles / Abbey Road (with MBIDs) + // Note: "musicbrainz_trackid" is an alias for the musicbrainz_recordingid tag (populates MbzRecordingID), + // "musicbrainz_releasetrackid" is an alias for the musicbrainz_trackid tag (populates MbzReleaseTrackID). + "Rock/The Beatles/Abbey Road/01 - Come Together.mp3": abbeyRoad(track(1, "Come Together", + _t{"musicbrainz_releasetrackid": mbidComeTogether, "musicbrainz_trackid": mbidComeTogetherRec})), + "Rock/The Beatles/Abbey Road/02 - Something.mp3": abbeyRoad(track(2, "Something", + _t{"musicbrainz_releasetrackid": mbidSomething, "musicbrainz_trackid": mbidSomethingRec})), + // Rock / The Beatles / Help! (no MBIDs) + "Rock/The Beatles/Help!/01 - Help.mp3": help(track(1, "Help!")), + // Rock / Led Zeppelin / IV (no MBIDs) + "Rock/Led Zeppelin/IV/01 - Stairway To Heaven.mp3": ledZepIV(track(1, "Stairway To Heaven")), + // Jazz / Miles Davis / Kind of Blue (no MBIDs) + "Jazz/Miles Davis/Kind of Blue/01 - So What.mp3": kindOfBlue(track(1, "So What")), + // Pop (standalone track, no MBIDs) + "Pop/01 - Standalone Track.mp3": popTrack(track(1, "Standalone Track")), + // CJK / シートベルツ / COWBOY BEBOP (Japanese artist, for CJK search tests) + "CJK/シートベルツ/COWBOY BEBOP/01 - プラチナ・ジェット.mp3": cowboyBebop(track(1, "プラチナ・ジェット")), + + // Diverse audio format tracks for transcode e2e tests + "Test/Transcode Formats/01 - TC FLAC Standard.flac": file(tcBase, _t{ + "title": "TC FLAC Standard", "track": 1, "suffix": "flac", + "bitrate": 900, "samplerate": 44100, "bitdepth": 16, "channels": 2, "duration": int64(240), + }), + "Test/Transcode Formats/02 - TC FLAC HiRes.flac": file(tcBase, _t{ + "title": "TC FLAC HiRes", "track": 2, "suffix": "flac", + "bitrate": 3000, "samplerate": 96000, "bitdepth": 24, "channels": 2, "duration": int64(180), + }), + "Test/Transcode Formats/03 - TC ALAC Track.m4a": file(tcBase, _t{ + "title": "TC ALAC Track", "track": 3, "suffix": "m4a", + "bitrate": 900, "samplerate": 44100, "bitdepth": 16, "channels": 2, "duration": int64(200), + }), + "Test/Transcode Formats/04 - TC DSD Track.dsf": file(tcBase, _t{ + "title": "TC DSD Track", "track": 4, "suffix": "dsf", + "bitrate": 5645, "samplerate": 2822400, "bitdepth": 1, "channels": 2, "duration": int64(300), + }), + "Test/Transcode Formats/05 - TC Opus Track.opus": file(tcBase, _t{ + "title": "TC Opus Track", "track": 5, "suffix": "opus", + "bitrate": 128, "samplerate": 48000, "bitdepth": 0, "channels": 2, "duration": int64(210), + }), + "Test/Transcode Formats/06 - TC MKA Opus.mka": file(tcBase, _t{ + "title": "TC MKA Opus", "track": 6, "suffix": "mka", "codec": "opus", + "bitrate": 128, "samplerate": 48000, "bitdepth": 0, "channels": 2, "duration": int64(220), + }), + "Test/Transcode Formats/07 - TC FLAC Multichannel.flac": file(tcBase, _t{ + "title": "TC FLAC Multichannel", "track": 7, "suffix": "flac", + "bitrate": 4500, "samplerate": 48000, "bitdepth": 24, "channels": 6, "duration": int64(180), + }), + + // _empty folder (directory with no audio) + "_empty/.keep": &fstest.MapFile{Data: []byte{}, ModTime: time.Now()}, + }) +} + +// createUser creates a user in the database with the given properties, assigns them to the test +// library, and returns the fully-loaded user (with Libraries populated). +func createUser(id, username, name string, isAdmin bool) model.User { + user := model.User{ + ID: id, + UserName: username, + Name: name, + IsAdmin: isAdmin, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&user)).To(Succeed()) + Expect(ds.User(ctx).SetUserLibraries(user.ID, []int{lib.ID})).To(Succeed()) + + loadedUser, err := ds.User(ctx).FindByUsername(user.UserName) + Expect(err).ToNot(HaveOccurred()) + user.Libraries = loadedUser.Libraries + return user +} + +// doReq makes a full HTTP round-trip through the router and returns the parsed Subsonic response. +func doReq(endpoint string, params ...string) *responses.Subsonic { + return doReqWithUser(adminUser, endpoint, params...) +} + +// doReqWithUser makes a full HTTP round-trip for the given user and returns the parsed Subsonic response. +func doReqWithUser(user model.User, endpoint string, params ...string) *responses.Subsonic { + w := httptest.NewRecorder() + r := buildReq(user, endpoint, params...) + router.ServeHTTP(w, r) + return parseJSONResponse(w) +} + +// doRawReq returns the raw ResponseRecorder for endpoints that write binary data (stream, download, getCoverArt). +func doRawReq(endpoint string, params ...string) *httptest.ResponseRecorder { + return doRawReqWithUser(adminUser, endpoint, params...) +} + +// doRawReqWithUser returns the raw ResponseRecorder for the given user. +func doRawReqWithUser(user model.User, endpoint string, params ...string) *httptest.ResponseRecorder { + w := httptest.NewRecorder() + r := buildReq(user, endpoint, params...) + router.ServeHTTP(w, r) + return w +} + +// buildReq creates a GET request with Subsonic auth params (u, p, v, c, f=json). +func buildReq(user model.User, endpoint string, params ...string) *http.Request { + if len(params)%2 != 0 { + panic("buildReq: odd number of parameters") + } + q := url.Values{} + q.Add("u", user.UserName) + q.Add("p", "password") + q.Add("v", "1.16.1") + q.Add("c", "test-client") + q.Add("f", "json") + for i := 0; i < len(params); i += 2 { + q.Add(params[i], params[i+1]) + } + return httptest.NewRequest("GET", "/"+endpoint+"?"+q.Encode(), nil) +} + +// buildPostReq creates a POST request with a JSON body and Subsonic auth params in the query string. +func buildPostReq(user model.User, endpoint string, body string, params ...string) *http.Request { + getReq := buildReq(user, endpoint, params...) + r := httptest.NewRequest("POST", getReq.URL.RequestURI(), bytes.NewReader([]byte(body))) + r.Header.Set("Content-Type", "application/json") + return r +} + +// doPostReq makes a POST round-trip as admin and returns the parsed Subsonic response. +func doPostReq(endpoint string, body string, params ...string) *responses.Subsonic { + w := httptest.NewRecorder() + r := buildPostReq(adminUser, endpoint, body, params...) + router.ServeHTTP(w, r) + return parseJSONResponse(w) +} + +// doRawPostReq makes a POST round-trip as admin and returns the raw recorder. +func doRawPostReq(endpoint string, body string, params ...string) *httptest.ResponseRecorder { + w := httptest.NewRecorder() + r := buildPostReq(adminUser, endpoint, body, params...) + router.ServeHTTP(w, r) + return w +} + +// parseJSONResponse parses the JSON response body into a Subsonic response struct. +func parseJSONResponse(w *httptest.ResponseRecorder) *responses.Subsonic { + Expect(w.Code).To(Equal(http.StatusOK)) + var wrapper responses.JsonWrapper + Expect(json.Unmarshal(w.Body.Bytes(), &wrapper)).To(Succeed()) + return &wrapper.Subsonic +} + +// --- Noop stub implementations for Router dependencies --- + +// noopArtwork implements artwork.Artwork +type noopArtwork struct{} + +func (n noopArtwork) Get(context.Context, model.ArtworkID, int, bool) (io.ReadCloser, time.Time, error) { + return nil, time.Time{}, model.ErrNotFound +} + +func (n noopArtwork) GetOrPlaceholder(_ context.Context, _ string, _ int, _ bool) (io.ReadCloser, time.Time, error) { + return io.NopCloser(io.LimitReader(nil, 0)), time.Time{}, nil +} + +// spyStreamer captures the Request passed to NewStream for test assertions, +// then returns a minimal fake Stream so the handler completes without error. +type spyStreamer struct { + LastRequest stream.Request + LastMediaFile *model.MediaFile + SimulateError error // When set, NewStream returns this error + SimulateEmptyStream bool // When true, returns a 0-byte stream (simulates ffmpeg producing no output) +} + +func (s *spyStreamer) NewStream(_ context.Context, mf *model.MediaFile, req stream.Request) (*stream.Stream, error) { + s.LastRequest = req + s.LastMediaFile = mf + if s.SimulateError != nil { + return nil, s.SimulateError + } + format := req.Format + if format == "" || format == "raw" { + format = mf.Suffix + } + content := "fake audio data" + if s.SimulateEmptyStream { + content = "" + } + r := io.NopCloser(strings.NewReader(content)) + return stream.NewStream(mf, format, req.BitRate, r), nil +} + +// noopFFmpeg implements ffmpeg.FFmpeg with no-op methods. +type noopFFmpeg struct{} + +func (n noopFFmpeg) Transcode(context.Context, ffmpeg.TranscodeOptions) (io.ReadCloser, error) { + return nil, errors.New("noop ffmpeg: transcode not supported") +} + +func (n noopFFmpeg) ExtractImage(context.Context, string) (io.ReadCloser, error) { + return nil, errors.New("noop ffmpeg: extract image not supported") +} + +func (n noopFFmpeg) Probe(context.Context, []string) (string, error) { + return "", nil +} + +func (n noopFFmpeg) ProbeAudioStream(context.Context, string) (*ffmpeg.AudioProbeResult, error) { + return nil, errors.New("noop ffmpeg: probe not supported") +} + +func (n noopFFmpeg) ConvertAnimatedImage(context.Context, io.Reader, int, int) (io.ReadCloser, error) { + return nil, errors.New("noop ffmpeg: convert animated image not supported") +} + +func (n noopFFmpeg) CmdPath() (string, error) { return "", nil } +func (n noopFFmpeg) IsAvailable() bool { return false } +func (n noopFFmpeg) IsProbeAvailable() bool { return true } +func (n noopFFmpeg) Version() string { return "noop" } + +// noopArchiver implements core.Archiver +type noopArchiver struct{} + +func (n noopArchiver) ZipAlbum(context.Context, string, string, int, io.Writer) error { + return model.ErrNotFound +} + +func (n noopArchiver) ZipArtist(context.Context, string, string, int, io.Writer) error { + return model.ErrNotFound +} + +func (n noopArchiver) ZipShare(context.Context, string, io.Writer) error { + return model.ErrNotFound +} + +func (n noopArchiver) ZipPlaylist(context.Context, string, string, int, io.Writer) error { + return model.ErrNotFound +} + +// noopProvider implements external.Provider +type noopProvider struct{} + +func (n noopProvider) UpdateAlbumInfo(_ context.Context, _ string) (*model.Album, error) { + return &model.Album{}, nil +} + +func (n noopProvider) UpdateArtistInfo(_ context.Context, _ string, _ int, _ bool) (*model.Artist, error) { + return &model.Artist{}, nil +} + +func (n noopProvider) SimilarSongs(context.Context, string, int) (model.MediaFiles, error) { + return nil, nil +} + +func (n noopProvider) TopSongs(context.Context, string, int) (model.MediaFiles, error) { + return nil, nil +} + +func (n noopProvider) ArtistImage(context.Context, string) (*url.URL, error) { + return nil, model.ErrNotFound +} + +func (n noopProvider) AlbumImage(context.Context, string) (*url.URL, error) { + return nil, model.ErrNotFound +} + +// Compile-time interface checks +var ( + _ artwork.Artwork = noopArtwork{} + _ stream.MediaStreamer = &spyStreamer{} + _ core.Archiver = noopArchiver{} + _ external.Provider = noopProvider{} + _ ffmpeg.FFmpeg = noopFFmpeg{} +) + +var _ = BeforeSuite(func() { + ctx = request.WithUser(GinkgoT().Context(), adminUser) + tmpDir := GinkgoT().TempDir() + dbFilePath = filepath.Join(tmpDir, "test-e2e.db") + snapshotPath = filepath.Join(tmpDir, "test-e2e.db.snapshot") + conf.Server.DbPath = dbFilePath + "?_journal_mode=WAL" + db.Db().SetMaxOpenConns(1) + + // Initial setup: schema, user, library, and full scan (runs once for the entire suite) + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + + db.Init(ctx) + + initDS := &tests.MockDataStore{RealDS: persistence.New(db.Db())} + auth.Init(initDS) + + adminUserWithPass := adminUser + adminUserWithPass.NewPassword = "password" + Expect(initDS.User(ctx).Put(&adminUserWithPass)).To(Succeed()) + + regularUserWithPass := regularUser + regularUserWithPass.NewPassword = "password" + Expect(initDS.User(ctx).Put(®ularUserWithPass)).To(Succeed()) + + lib = model.Library{ID: 1, Name: "Music Library", Path: "fake:///music"} + Expect(initDS.Library(ctx).Put(&lib)).To(Succeed()) + + Expect(initDS.User(ctx).SetUserLibraries(adminUser.ID, []int{lib.ID})).To(Succeed()) + Expect(initDS.User(ctx).SetUserLibraries(regularUser.ID, []int{lib.ID})).To(Succeed()) + + loadedUser, err := initDS.User(ctx).FindByUsername(adminUser.UserName) + Expect(err).ToNot(HaveOccurred()) + adminUser.Libraries = loadedUser.Libraries + + loadedRegular, err := initDS.User(ctx).FindByUsername(regularUser.UserName) + Expect(err).ToNot(HaveOccurred()) + regularUser.Libraries = loadedRegular.Libraries + + ctx = request.WithUser(GinkgoT().Context(), adminUser) + + buildTestFS() + s := scanner.New(ctx, initDS, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(initDS, core.NewImageUploadService()), metrics.NewNoopInstance()) + _, err = s.ScanAll(ctx, true) + Expect(err).ToNot(HaveOccurred()) + + // Checkpoint WAL and snapshot the golden DB state + _, err = db.Db().Exec("PRAGMA wal_checkpoint(TRUNCATE)") + Expect(err).ToNot(HaveOccurred()) + data, err := os.ReadFile(dbFilePath) + Expect(err).ToNot(HaveOccurred()) + Expect(os.WriteFile(snapshotPath, data, 0600)).To(Succeed()) +}) + +// Close the database before the suite's TempDir cleanup runs. Required on +// Windows where open SQLite handles hold file locks that block temp-dir +// removal; harmless on other OSes. +var _ = AfterSuite(func() { + db.Close(ctx) +}) + +// setupTestDB restores the database from the golden snapshot and creates the +// Subsonic Router. Call this from BeforeEach/BeforeAll in each test container. +func setupTestDB() { + ctx = request.WithUser(GinkgoT().Context(), adminUser) + + DeferCleanup(configtest.SetupConfig()) + DeferCleanup(func() { + // Wait for any background scan (e.g. from startScan endpoint) to finish + // before config cleanup runs, to avoid a data race on conf.Server. + Eventually(scanner.IsScanning).Should(BeFalse()) + }) + conf.Server.MusicFolder = "fake:///music" + conf.Server.DevExternalScanner = false + conf.Server.DevEnableMediaFileProbe = false + + // Restore DB to golden state (no scan needed) + restoreDB() + + ds = &tests.MockDataStore{RealDS: persistence.New(db.Db())} + auth.Init(ds) + + // Create the Subsonic Router with real DS, streamer spy, and real Decider + streamerSpy = &spyStreamer{} + decider := stream.NewTranscodeDecider(ds, noopFFmpeg{}) + s := scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + router = subsonic.New( + ds, + noopArtwork{}, + streamerSpy, + noopArchiver{}, + core.NewPlayers(ds), + noopProvider{}, + s, + events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), + scrobbler.NewPlayTracker(ds, events.NoopBroker(), nil), + core.NewShare(ds), + playback.PlaybackServer(nil), + metrics.NewNoopInstance(), + lyrics.NewLyrics(nil), + decider, + nil, + ) +} + +// restoreDB restores all table data from the snapshot using ATTACH DATABASE. +// This is much faster than re-running the scanner for each test. +func restoreDB() { + sqlDB := db.Db() + + _, err := sqlDB.Exec("PRAGMA foreign_keys = OFF") + Expect(err).ToNot(HaveOccurred()) + + _, err = sqlDB.Exec("ATTACH DATABASE ? AS snapshot", snapshotPath) + Expect(err).ToNot(HaveOccurred()) + + rows, err := sqlDB.Query("SELECT name FROM main.sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%' AND name NOT LIKE '%_fts' AND name NOT LIKE '%_fts_%'") + Expect(err).ToNot(HaveOccurred()) + var tables []string + for rows.Next() { + var name string + Expect(rows.Scan(&name)).To(Succeed()) + tables = append(tables, name) + } + Expect(rows.Err()).ToNot(HaveOccurred()) + rows.Close() + + for _, table := range tables { + // Table names come from sqlite_master, not user input, so concatenation is safe here + _, err = sqlDB.Exec(`DELETE FROM main."` + table + `"`) //nolint:gosec + Expect(err).ToNot(HaveOccurred()) + _, err = sqlDB.Exec(`INSERT INTO main."` + table + `" SELECT * FROM snapshot."` + table + `"`) //nolint:gosec + Expect(err).ToNot(HaveOccurred()) + } + + _, err = sqlDB.Exec("DETACH DATABASE snapshot") + Expect(err).ToNot(HaveOccurred()) + _, err = sqlDB.Exec("PRAGMA foreign_keys = ON") + Expect(err).ToNot(HaveOccurred()) +} diff --git a/server/e2e/subsonic_album_lists_test.go b/server/e2e/subsonic_album_lists_test.go new file mode 100644 index 000000000..d41d17dbc --- /dev/null +++ b/server/e2e/subsonic_album_lists_test.go @@ -0,0 +1,303 @@ +package e2e + +import ( + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Album List Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("GetAlbumList", func() { + It("type=newest returns albums sorted by creation date", func() { + resp := doReq("getAlbumList", "type", "newest") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(7)) + }) + + It("type=alphabeticalByName sorts albums by name", func() { + resp := doReq("getAlbumList", "type", "alphabeticalByName") + + Expect(resp.AlbumList).ToNot(BeNil()) + albums := resp.AlbumList.Album + Expect(albums).To(HaveLen(7)) + // Verify alphabetical order: Abbey Road, COWBOY BEBOP, Help!, IV, Kind of Blue, Pop, Transcode Formats + Expect(albums[0].Title).To(Equal("Abbey Road")) + Expect(albums[1].Title).To(Equal("COWBOY BEBOP")) + Expect(albums[2].Title).To(Equal("Help!")) + Expect(albums[3].Title).To(Equal("IV")) + Expect(albums[4].Title).To(Equal("Kind of Blue")) + Expect(albums[5].Title).To(Equal("Pop")) + Expect(albums[6].Title).To(Equal("Transcode Formats")) + }) + + It("type=alphabeticalByArtist sorts albums by artist name", func() { + resp := doReq("getAlbumList", "type", "alphabeticalByArtist") + + Expect(resp.AlbumList).ToNot(BeNil()) + albums := resp.AlbumList.Album + Expect(albums).To(HaveLen(7)) + // Articles like "The" are stripped for sorting, so "The Beatles" sorts as "Beatles" + // Non-compilations first: Beatles (x2), Led Zeppelin, Miles Davis, Test Artist, then compilations: Various, then CJK: シートベルツ + Expect(albums[0].Artist).To(Equal("The Beatles")) + Expect(albums[1].Artist).To(Equal("The Beatles")) + Expect(albums[2].Artist).To(Equal("Led Zeppelin")) + Expect(albums[3].Artist).To(Equal("Miles Davis")) + Expect(albums[4].Artist).To(Equal("Test Artist")) + Expect(albums[5].Artist).To(Equal("Various")) + Expect(albums[6].Artist).To(Equal("シートベルツ")) + }) + + It("type=random returns albums", func() { + resp := doReq("getAlbumList", "type", "random") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(7)) + }) + + It("type=byGenre filters by genre parameter", func() { + resp := doReq("getAlbumList", "type", "byGenre", "genre", "Jazz") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + for _, a := range resp.AlbumList.Album { + Expect(a.Genre).To(Equal("Jazz")) + } + }) + + It("type=byYear filters by fromYear/toYear range", func() { + resp := doReq("getAlbumList", "type", "byYear", "fromYear", "1965", "toYear", "1970") + + Expect(resp.AlbumList).ToNot(BeNil()) + // Should include Abbey Road (1969) and Help! (1965) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + years := make([]int32, len(resp.AlbumList.Album)) + for i, a := range resp.AlbumList.Album { + years[i] = a.Year + } + Expect(years).To(ConsistOf(int32(1965), int32(1969))) + }) + + It("respects size parameter", func() { + resp := doReq("getAlbumList", "type", "newest", "size", "2") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + }) + + It("supports offset for pagination", func() { + // First get all albums sorted by name to know the expected order + resp1 := doReq("getAlbumList", "type", "alphabeticalByName", "size", "5") + allAlbums := resp1.AlbumList.Album + + // Now get with offset=2, size=2 + resp2 := doReq("getAlbumList", "type", "alphabeticalByName", "size", "2", "offset", "2") + + Expect(resp2.AlbumList).ToNot(BeNil()) + Expect(resp2.AlbumList.Album).To(HaveLen(2)) + Expect(resp2.AlbumList.Album[0].Title).To(Equal(allAlbums[2].Title)) + Expect(resp2.AlbumList.Album[1].Title).To(Equal(allAlbums[3].Title)) + }) + + It("returns error when type parameter is missing", func() { + resp := doReq("getAlbumList") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for unknown type", func() { + resp := doReq("getAlbumList", "type", "invalid_type") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("type=frequent returns empty when no albums have been played", func() { + resp := doReq("getAlbumList", "type", "frequent") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(BeEmpty()) + }) + + It("type=recent returns empty when no albums have been played", func() { + resp := doReq("getAlbumList", "type", "recent") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(BeEmpty()) + }) + }) + + Describe("GetAlbumList - starred type", Ordered, func() { + BeforeAll(func() { + setupTestDB() + + // Star an album so the starred filter returns results + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + + resp := doReq("star", "albumId", albums[0].ID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("type=starred returns only starred albums", func() { + resp := doReq("getAlbumList", "type", "starred") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(1)) + Expect(resp.AlbumList.Album[0].Title).To(Equal("Abbey Road")) + }) + }) + + Describe("GetAlbumList - highest type", Ordered, func() { + BeforeAll(func() { + setupTestDB() + + // Rate an album so the highest filter returns results + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Kind of Blue"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + + resp := doReq("setRating", "id", albums[0].ID, "rating", "5") + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("type=highest returns only rated albums", func() { + resp := doReq("getAlbumList", "type", "highest") + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(1)) + Expect(resp.AlbumList.Album[0].Title).To(Equal("Kind of Blue")) + }) + }) + + Describe("GetAlbumList2", func() { + It("returns albums in AlbumID3 format", func() { + resp := doReq("getAlbumList2", "type", "alphabeticalByName") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumList2).ToNot(BeNil()) + albums := resp.AlbumList2.Album + Expect(albums).To(HaveLen(7)) + // Verify AlbumID3 format fields + Expect(albums[0].Name).To(Equal("Abbey Road")) + Expect(albums[0].Id).ToNot(BeEmpty()) + Expect(albums[0].Artist).ToNot(BeEmpty()) + }) + + It("type=newest works correctly", func() { + resp := doReq("getAlbumList2", "type", "newest") + + Expect(resp.AlbumList2).ToNot(BeNil()) + Expect(resp.AlbumList2.Album).To(HaveLen(7)) + }) + }) + + Describe("GetStarred", func() { + It("returns empty lists when nothing is starred", func() { + resp := doReq("getStarred") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Starred).ToNot(BeNil()) + Expect(resp.Starred.Artist).To(BeEmpty()) + Expect(resp.Starred.Album).To(BeEmpty()) + Expect(resp.Starred.Song).To(BeEmpty()) + }) + }) + + Describe("GetStarred2", func() { + It("returns empty lists when nothing is starred", func() { + resp := doReq("getStarred2") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Starred2).ToNot(BeNil()) + Expect(resp.Starred2.Artist).To(BeEmpty()) + Expect(resp.Starred2.Album).To(BeEmpty()) + Expect(resp.Starred2.Song).To(BeEmpty()) + }) + }) + + Describe("GetNowPlaying", func() { + It("returns empty list when nobody is playing", func() { + resp := doReq("getNowPlaying") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.NowPlaying).ToNot(BeNil()) + Expect(resp.NowPlaying.Entry).To(BeEmpty()) + }) + }) + + Describe("GetRandomSongs", func() { + It("returns random songs from library", func() { + resp := doReq("getRandomSongs") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.RandomSongs).ToNot(BeNil()) + Expect(resp.RandomSongs.Songs).ToNot(BeEmpty()) + Expect(resp.RandomSongs.Songs).To(HaveLen(10)) + }) + + It("respects size parameter", func() { + resp := doReq("getRandomSongs", "size", "2") + + Expect(resp.RandomSongs).ToNot(BeNil()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + }) + + It("filters by genre when specified", func() { + resp := doReq("getRandomSongs", "size", "500", "genre", "Jazz") + + Expect(resp.RandomSongs).ToNot(BeNil()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + for _, s := range resp.RandomSongs.Songs { + Expect(s.Genre).To(Equal("Jazz")) + } + }) + }) + + Describe("GetSongsByGenre", func() { + It("returns songs matching the genre", func() { + resp := doReq("getSongsByGenre", "genre", "Rock") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SongsByGenre).ToNot(BeNil()) + // 4 Rock songs: Come Together, Something, Help!, Stairway To Heaven + Expect(resp.SongsByGenre.Songs).To(HaveLen(4)) + for _, song := range resp.SongsByGenre.Songs { + Expect(song.Genre).To(Equal("Rock")) + } + }) + + It("supports count and offset parameters", func() { + // First get all Rock songs + resp1 := doReq("getSongsByGenre", "genre", "Rock", "count", "500") + allSongs := resp1.SongsByGenre.Songs + + // Now get with count=2, offset=1 + resp2 := doReq("getSongsByGenre", "genre", "Rock", "count", "2", "offset", "1") + + Expect(resp2.SongsByGenre).ToNot(BeNil()) + Expect(resp2.SongsByGenre.Songs).To(HaveLen(2)) + Expect(resp2.SongsByGenre.Songs[0].Id).To(Equal(allSongs[1].Id)) + }) + + It("returns empty for non-existent genre", func() { + resp := doReq("getSongsByGenre", "genre", "NonExistentGenre") + + Expect(resp.SongsByGenre).ToNot(BeNil()) + Expect(resp.SongsByGenre.Songs).To(BeEmpty()) + }) + }) +}) diff --git a/server/e2e/subsonic_bookmarks_test.go b/server/e2e/subsonic_bookmarks_test.go new file mode 100644 index 000000000..726b41743 --- /dev/null +++ b/server/e2e/subsonic_bookmarks_test.go @@ -0,0 +1,158 @@ +package e2e + +import ( + "fmt" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Bookmark and PlayQueue Endpoints", Ordered, func() { + BeforeAll(func() { + setupTestDB() + }) + + Describe("Bookmark Endpoints", Ordered, func() { + var trackID string + + BeforeAll(func() { + // Get a media file ID from the database to use for bookmarks + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1}) + Expect(err).ToNot(HaveOccurred()) + Expect(mfs).ToNot(BeEmpty()) + trackID = mfs[0].ID + }) + + It("getBookmarks returns empty initially", func() { + resp := doReq("getBookmarks") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Bookmarks).ToNot(BeNil()) + Expect(resp.Bookmarks.Bookmark).To(BeEmpty()) + }) + + It("createBookmark creates a bookmark with position", func() { + resp := doReq("createBookmark", "id", trackID, "position", "12345", "comment", "test bookmark") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getBookmarks shows the created bookmark", func() { + resp := doReq("getBookmarks") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Bookmarks).ToNot(BeNil()) + Expect(resp.Bookmarks.Bookmark).To(HaveLen(1)) + + bmk := resp.Bookmarks.Bookmark[0] + Expect(bmk.Entry.Id).To(Equal(trackID)) + Expect(bmk.Position).To(Equal(int64(12345))) + Expect(bmk.Comment).To(Equal("test bookmark")) + Expect(bmk.Username).To(Equal(adminUser.UserName)) + }) + + It("deleteBookmark removes the bookmark", func() { + resp := doReq("deleteBookmark", "id", trackID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify it's gone + resp = doReq("getBookmarks") + Expect(resp.Bookmarks.Bookmark).To(BeEmpty()) + }) + }) + + Describe("PlayQueue Endpoints", Ordered, func() { + var trackIDs []string + + BeforeAll(func() { + // Get multiple media file IDs from the database + mfs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 3, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(mfs)).To(BeNumerically(">=", 2)) + for _, mf := range mfs { + trackIDs = append(trackIDs, mf.ID) + } + }) + + It("getPlayQueue returns minimum required fields when nothing specified", func() { + resp := doReq("getPlayQueue") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueue).ToNot(BeNil()) + Expect(resp.PlayQueue.Entry).To(HaveLen(0)) + Expect(resp.PlayQueue.Current).To(BeEmpty()) + Expect(resp.PlayQueue.Position).To(Equal(int64(0))) + Expect(resp.PlayQueue.Username).To(Equal(adminUser.UserName)) + Expect(resp.PlayQueue.ChangedBy).To(BeEmpty()) + }) + + It("getPlayQueueByIndex returns minimum required fields when nothing specified", func() { + resp := doReq("getPlayQueueByIndex") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueueByIndex).ToNot(BeNil()) + Expect(resp.PlayQueueByIndex.Entry).To(HaveLen(0)) + Expect(resp.PlayQueueByIndex.CurrentIndex).To(BeNil()) + Expect(resp.PlayQueueByIndex.Position).To(Equal(int64(0))) + Expect(resp.PlayQueueByIndex.Username).To(Equal(adminUser.UserName)) + Expect(resp.PlayQueueByIndex.ChangedBy).To(BeEmpty()) + }) + + It("savePlayQueue stores current play queue", func() { + resp := doReq("savePlayQueue", + "id", trackIDs[0], + "id", trackIDs[1], + "current", trackIDs[1], + "position", "5000", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getPlayQueue returns saved queue with tracks", func() { + resp := doReq("getPlayQueue") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueue).ToNot(BeNil()) + Expect(resp.PlayQueue.Entry).To(HaveLen(2)) + Expect(resp.PlayQueue.Current).To(Equal(trackIDs[1])) + Expect(resp.PlayQueue.Position).To(Equal(int64(5000))) + Expect(resp.PlayQueue.Username).To(Equal(adminUser.UserName)) + Expect(resp.PlayQueue.ChangedBy).To(Equal("test-client")) + }) + + It("getPlayQueueByIndex returns data with current index", func() { + resp := doReq("getPlayQueueByIndex") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.PlayQueueByIndex).ToNot(BeNil()) + Expect(resp.PlayQueueByIndex.Entry).To(HaveLen(2)) + Expect(resp.PlayQueueByIndex.CurrentIndex).ToNot(BeNil()) + Expect(*resp.PlayQueueByIndex.CurrentIndex).To(Equal(1)) + Expect(resp.PlayQueueByIndex.Position).To(Equal(int64(5000))) + }) + + It("savePlayQueueByIndex stores queue by index", func() { + resp := doReq("savePlayQueueByIndex", + "id", trackIDs[0], + "id", trackIDs[1], + "id", trackIDs[2], + "currentIndex", fmt.Sprintf("%d", 0), + "position", "9999", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify with getPlayQueueByIndex + resp = doReq("getPlayQueueByIndex") + Expect(resp.PlayQueueByIndex).ToNot(BeNil()) + Expect(resp.PlayQueueByIndex.Entry).To(HaveLen(3)) + Expect(resp.PlayQueueByIndex.CurrentIndex).ToNot(BeNil()) + Expect(*resp.PlayQueueByIndex.CurrentIndex).To(Equal(0)) + Expect(resp.PlayQueueByIndex.Position).To(Equal(int64(9999))) + }) + }) +}) diff --git a/server/e2e/subsonic_browsing_test.go b/server/e2e/subsonic_browsing_test.go new file mode 100644 index 000000000..55aeb8e9e --- /dev/null +++ b/server/e2e/subsonic_browsing_test.go @@ -0,0 +1,464 @@ +package e2e + +import ( + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Browsing Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("getMusicFolders", func() { + It("returns the configured music library", func() { + resp := doReq("getMusicFolders") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.MusicFolders).ToNot(BeNil()) + Expect(resp.MusicFolders.Folders).To(HaveLen(1)) + Expect(resp.MusicFolders.Folders[0].Name).To(Equal("Music Library")) + Expect(resp.MusicFolders.Folders[0].Id).To(Equal(int32(lib.ID))) + }) + }) + + Describe("getIndexes", func() { + It("returns artist indexes", func() { + resp := doReq("getIndexes") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Indexes).ToNot(BeNil()) + Expect(resp.Indexes.Index).ToNot(BeEmpty()) + }) + + It("includes all artists across indexes", func() { + resp := doReq("getIndexes") + + var allArtistNames []string + for _, idx := range resp.Indexes.Index { + for _, a := range idx.Artists { + allArtistNames = append(allArtistNames, a.Name) + } + } + Expect(allArtistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis", "Various")) + }) + }) + + Describe("getArtists", func() { + It("returns artist indexes in ID3 format", func() { + resp := doReq("getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + Expect(resp.Artist.Index).ToNot(BeEmpty()) + }) + + It("includes all artists across ID3 indexes", func() { + resp := doReq("getArtists") + + var allArtistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + allArtistNames = append(allArtistNames, a.Name) + } + } + Expect(allArtistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis", "Various")) + }) + + It("reports correct album counts for artists", func() { + resp := doReq("getArtists") + + var beatlesAlbumCount int32 + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + if a.Name == "The Beatles" { + beatlesAlbumCount = a.AlbumCount + } + } + } + Expect(beatlesAlbumCount).To(Equal(int32(2))) + }) + }) + + Describe("getMusicDirectory", func() { + It("returns an artist directory with its albums as children", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getMusicDirectory", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Directory).ToNot(BeNil()) + Expect(resp.Directory.Name).To(Equal("The Beatles")) + Expect(resp.Directory.Child).To(HaveLen(2)) // Abbey Road, Help! + }) + + It("returns an album directory with its tracks as children", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getMusicDirectory", "id", abbeyRoadID) + + Expect(resp.Directory).ToNot(BeNil()) + Expect(resp.Directory.Name).To(Equal("Abbey Road")) + Expect(resp.Directory.Child).To(HaveLen(2)) // Come Together, Something + }) + + It("returns an error for a non-existent ID", func() { + resp := doReq("getMusicDirectory", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("getArtist", func() { + It("returns artist with albums in ID3 format", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtist", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ArtistWithAlbumsID3).ToNot(BeNil()) + Expect(resp.ArtistWithAlbumsID3.Name).To(Equal("The Beatles")) + Expect(resp.ArtistWithAlbumsID3.Album).To(HaveLen(2)) + }) + + It("returns album names for the artist", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtist", "id", beatlesID) + + var albumNames []string + for _, a := range resp.ArtistWithAlbumsID3.Album { + albumNames = append(albumNames, a.Name) + } + Expect(albumNames).To(ContainElements("Abbey Road", "Help!")) + }) + + It("returns an error for a non-existent artist", func() { + resp := doReq("getArtist", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns artist with a single album", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "Led Zeppelin"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + ledZepID := artists[0].ID + + resp := doReq("getArtist", "id", ledZepID) + + Expect(resp.ArtistWithAlbumsID3).ToNot(BeNil()) + Expect(resp.ArtistWithAlbumsID3.Name).To(Equal("Led Zeppelin")) + Expect(resp.ArtistWithAlbumsID3.Album).To(HaveLen(1)) + Expect(resp.ArtistWithAlbumsID3.Album[0].Name).To(Equal("IV")) + }) + }) + + Describe("getAlbum", func() { + It("returns album with its tracks", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbum", "id", abbeyRoadID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumWithSongsID3).ToNot(BeNil()) + Expect(resp.AlbumWithSongsID3.Name).To(Equal("Abbey Road")) + Expect(resp.AlbumWithSongsID3.Song).To(HaveLen(2)) + }) + + It("includes correct track metadata", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbum", "id", abbeyRoadID) + + var trackTitles []string + for _, s := range resp.AlbumWithSongsID3.Song { + trackTitles = append(trackTitles, s.Title) + } + Expect(trackTitles).To(ContainElements("Come Together", "Something")) + }) + + It("returns album with correct artist and year", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Kind of Blue"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + kindOfBlueID := albums[0].ID + + resp := doReq("getAlbum", "id", kindOfBlueID) + + Expect(resp.AlbumWithSongsID3).ToNot(BeNil()) + Expect(resp.AlbumWithSongsID3.Name).To(Equal("Kind of Blue")) + Expect(resp.AlbumWithSongsID3.Artist).To(Equal("Miles Davis")) + Expect(resp.AlbumWithSongsID3.Year).To(Equal(int32(1959))) + Expect(resp.AlbumWithSongsID3.Song).To(HaveLen(1)) + }) + + It("returns an error for a non-existent album", func() { + resp := doReq("getAlbum", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("getSong", func() { + It("returns a song by its ID", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSong", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Song).ToNot(BeNil()) + Expect(resp.Song.Title).To(Equal("Come Together")) + Expect(resp.Song.Album).To(Equal("Abbey Road")) + Expect(resp.Song.Artist).To(Equal("The Beatles")) + }) + + It("returns an error for a non-existent song", func() { + resp := doReq("getSong", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns correct metadata for a jazz track", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "So What"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSong", "id", songID) + + Expect(resp.Song).ToNot(BeNil()) + Expect(resp.Song.Title).To(Equal("So What")) + Expect(resp.Song.Album).To(Equal("Kind of Blue")) + Expect(resp.Song.Artist).To(Equal("Miles Davis")) + }) + }) + + Describe("getGenres", func() { + It("returns all genres", func() { + resp := doReq("getGenres") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Genres).ToNot(BeNil()) + Expect(resp.Genres.Genre).To(HaveLen(4)) + }) + + It("includes correct genre names", func() { + resp := doReq("getGenres") + + var genreNames []string + for _, g := range resp.Genres.Genre { + genreNames = append(genreNames, g.Name) + } + Expect(genreNames).To(ContainElements("Rock", "Jazz", "Pop")) + }) + + It("reports correct song and album counts for Rock", func() { + resp := doReq("getGenres") + + var rockGenre *responses.Genre + for i, g := range resp.Genres.Genre { + if g.Name == "Rock" { + rockGenre = &resp.Genres.Genre[i] + break + } + } + Expect(rockGenre).ToNot(BeNil()) + Expect(rockGenre.SongCount).To(Equal(int32(4))) + Expect(rockGenre.AlbumCount).To(Equal(int32(3))) + }) + + It("reports correct song and album counts for Jazz", func() { + resp := doReq("getGenres") + + var jazzGenre *responses.Genre + for i, g := range resp.Genres.Genre { + if g.Name == "Jazz" { + jazzGenre = &resp.Genres.Genre[i] + break + } + } + Expect(jazzGenre).ToNot(BeNil()) + Expect(jazzGenre.SongCount).To(Equal(int32(2))) + Expect(jazzGenre.AlbumCount).To(Equal(int32(2))) + }) + + It("reports correct song and album counts for Pop", func() { + resp := doReq("getGenres") + + var popGenre *responses.Genre + for i, g := range resp.Genres.Genre { + if g.Name == "Pop" { + popGenre = &resp.Genres.Genre[i] + break + } + } + Expect(popGenre).ToNot(BeNil()) + Expect(popGenre.SongCount).To(Equal(int32(1))) + Expect(popGenre.AlbumCount).To(Equal(int32(1))) + }) + }) + + Describe("getAlbumInfo", func() { + It("returns album info for a valid album", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbumInfo", "id", abbeyRoadID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumInfo).ToNot(BeNil()) + }) + }) + + Describe("getAlbumInfo2", func() { + It("returns album info for a valid album", func() { + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + abbeyRoadID := albums[0].ID + + resp := doReq("getAlbumInfo2", "id", abbeyRoadID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.AlbumInfo).ToNot(BeNil()) + }) + }) + + Describe("getArtistInfo", func() { + It("returns artist info for a valid artist", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtistInfo", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ArtistInfo).ToNot(BeNil()) + }) + }) + + Describe("getArtistInfo2", func() { + It("returns artist info2 for a valid artist", func() { + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"name": "The Beatles"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + beatlesID := artists[0].ID + + resp := doReq("getArtistInfo2", "id", beatlesID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ArtistInfo2).ToNot(BeNil()) + }) + }) + + Describe("getTopSongs", func() { + It("returns a response for a known artist name", func() { + resp := doReq("getTopSongs", "artist", "The Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TopSongs).ToNot(BeNil()) + // noopProvider returns empty list, so Songs may be empty + }) + + It("returns an empty list for an unknown artist", func() { + resp := doReq("getTopSongs", "artist", "Unknown Artist") + + Expect(resp.TopSongs).ToNot(BeNil()) + Expect(resp.TopSongs.Song).To(BeEmpty()) + }) + }) + + Describe("getSimilarSongs", func() { + It("returns a response for a valid song ID", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSimilarSongs", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SimilarSongs).ToNot(BeNil()) + // noopProvider returns empty list + }) + }) + + Describe("getSimilarSongs2", func() { + It("returns a response for a valid song ID", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID := songs[0].ID + + resp := doReq("getSimilarSongs2", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SimilarSongs2).ToNot(BeNil()) + // noopProvider returns empty list + }) + }) +}) diff --git a/server/e2e/subsonic_media_annotation_test.go b/server/e2e/subsonic_media_annotation_test.go new file mode 100644 index 000000000..ec9b070de --- /dev/null +++ b/server/e2e/subsonic_media_annotation_test.go @@ -0,0 +1,271 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Media Annotation Endpoints", Ordered, func() { + BeforeAll(func() { + setupTestDB() + }) + + Describe("Star/Unstar", Ordered, func() { + var songID, albumID, artistID string + + BeforeAll(func() { + // Look up a song from the scanned data + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + + // Look up an album + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "name"}) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + albumID = albums[0].ID + + // Look up an artist + artists, err := ds.Artist(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "name"}) + Expect(err).ToNot(HaveOccurred()) + Expect(artists).ToNot(BeEmpty()) + artistID = artists[0].ID + }) + + It("stars a song by id", func() { + resp := doReq("star", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("starred song appears in getStarred response", func() { + resp := doReq("getStarred") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Starred).ToNot(BeNil()) + Expect(resp.Starred.Song).To(HaveLen(1)) + Expect(resp.Starred.Song[0].Id).To(Equal(songID)) + }) + + It("unstars a previously starred song", func() { + resp := doReq("unstar", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify song no longer appears in starred + resp = doReq("getStarred") + + Expect(resp.Starred.Song).To(BeEmpty()) + }) + + It("stars an album by albumId", func() { + resp := doReq("star", "albumId", albumID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify album appears in starred + resp = doReq("getStarred") + + Expect(resp.Starred.Album).To(HaveLen(1)) + Expect(resp.Starred.Album[0].Id).To(Equal(albumID)) + }) + + It("stars an artist by artistId", func() { + resp := doReq("star", "artistId", artistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify artist appears in starred + resp = doReq("getStarred") + + Expect(resp.Starred.Artist).To(HaveLen(1)) + Expect(resp.Starred.Artist[0].Id).To(Equal(artistID)) + }) + + It("returns error when no id provided", func() { + resp := doReq("star") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("SetRating", Ordered, func() { + var songID, albumID string + + BeforeAll(func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "name"}) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + albumID = albums[0].ID + }) + + It("sets rating on a song", func() { + resp := doReq("setRating", "id", songID, "rating", "4") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("rated song has correct userRating in getSong", func() { + resp := doReq("getSong", "id", songID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Song).ToNot(BeNil()) + Expect(resp.Song.UserRating).To(Equal(int32(4))) + }) + + It("sets rating on an album", func() { + resp := doReq("setRating", "id", albumID, "rating", "3") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("returns error for missing parameters", func() { + // Missing both id and rating + resp := doReq("setRating") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + + // Missing rating + resp = doReq("setRating", "id", songID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + }) + + Describe("Scrobble", func() { + It("submits a scrobble for a song", func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + + resp := doReq("scrobble", "id", songs[0].ID, "submission", "true") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("returns error when id is missing", func() { + resp := doReq("scrobble") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("ReportPlayback", Ordered, func() { + var songID string + + BeforeAll(func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + }) + + It("returns error when required params are missing", func() { + resp := doReq("reportPlayback") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + + It("returns error for invalid state", func() { + resp := doReq("reportPlayback", + "mediaId", songID, + "mediaType", "song", + "positionMs", "0", + "state", "invalid", + ) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + + It("starting report creates a getNowPlaying entry", func() { + resp := doReq("reportPlayback", + "mediaId", songID, + "mediaType", "song", + "positionMs", "0", + "state", "starting", + ) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + np := doReq("getNowPlaying") + Expect(np.Status).To(Equal(responses.StatusOK)) + Expect(np.NowPlaying.Entry).To(HaveLen(1)) + Expect(np.NowPlaying.Entry[0].Id).To(Equal(songID)) + Expect(np.NowPlaying.Entry[0].State).To(Equal("starting")) + }) + + It("playing report updates getNowPlaying state and position", func() { + resp := doReq("reportPlayback", + "mediaId", songID, + "mediaType", "song", + "positionMs", "30000", + "state", "playing", + ) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + np := doReq("getNowPlaying") + Expect(np.NowPlaying.Entry).To(HaveLen(1)) + Expect(np.NowPlaying.Entry[0].State).To(Equal("playing")) + Expect(np.NowPlaying.Entry[0].PositionMs).To(BeNumerically(">=", int64(30000))) + }) + + It("paused report freezes position in getNowPlaying", func() { + resp := doReq("reportPlayback", + "mediaId", songID, + "mediaType", "song", + "positionMs", "30000", + "state", "paused", + ) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + np := doReq("getNowPlaying") + Expect(np.NowPlaying.Entry).To(HaveLen(1)) + Expect(np.NowPlaying.Entry[0].State).To(Equal("paused")) + Expect(np.NowPlaying.Entry[0].PositionMs).To(Equal(int64(30000))) + }) + + It("stopped report removes entry from getNowPlaying", func() { + resp := doReq("reportPlayback", + "mediaId", songID, + "mediaType", "song", + "positionMs", "90000", + "state", "stopped", + ) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + np := doReq("getNowPlaying") + Expect(np.NowPlaying.Entry).To(BeEmpty()) + }) + + It("accepts mediaType=podcast without error", func() { + resp := doReq("reportPlayback", + "mediaId", songID, + "mediaType", "podcast", + "positionMs", "0", + "state", "starting", + ) + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("accepts optional playbackRate and ignoreScrobble", func() { + resp := doReq("reportPlayback", + "mediaId", songID, + "mediaType", "song", + "positionMs", "5000", + "state", "playing", + "playbackRate", "1.5", + "ignoreScrobble", "true", + ) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + np := doReq("getNowPlaying") + Expect(np.NowPlaying.Entry).To(HaveLen(1)) + Expect(np.NowPlaying.Entry[0].PlaybackRate).To(Equal(1.5)) + }) + }) +}) diff --git a/server/e2e/subsonic_media_retrieval_test.go b/server/e2e/subsonic_media_retrieval_test.go new file mode 100644 index 000000000..079b131ff --- /dev/null +++ b/server/e2e/subsonic_media_retrieval_test.go @@ -0,0 +1,199 @@ +package e2e + +import ( + "net/http" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Media Retrieval Endpoints", Ordered, func() { + BeforeAll(func() { + setupTestDB() + }) + + Describe("Stream", func() { + var trackID string + + BeforeAll(func() { + // All test tracks are mp3 at 320kbps + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + trackID = songs[0].ID + }) + + It("returns error when id parameter is missing", func() { + resp := doReq("stream") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("streams raw when no format or bitrate specified", func() { + w := doRawReq("stream", "id", trackID) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("streams raw when format=raw", func() { + w := doRawReq("stream", "id", trackID, "format", "raw") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("transcodes to different format with bitrate", func() { + w := doRawReq("stream", "id", trackID, "format", "opus", "maxBitRate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("downsamples when only maxBitRate is specified (lower than source)", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DefaultDownsamplingFormat = "opus" + + w := doRawReq("stream", "id", trackID, "maxBitRate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("streams raw when maxBitRate is higher than source", func() { + w := doRawReq("stream", "id", trackID, "maxBitRate", "999") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("streams raw when format matches source and no bitrate reduction", func() { + w := doRawReq("stream", "id", trackID, "format", "mp3", "maxBitRate", "320") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("transcodes when same format but lower bitrate", func() { + w := doRawReq("stream", "id", trackID, "format", "mp3", "maxBitRate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("falls back to default downsampling format for unknown format", func() { + w := doRawReq("stream", "id", trackID, "format", "xyz") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + }) + + It("passes timeOffset through", func() { + w := doRawReq("stream", "id", trackID, "format", "opus", "maxBitRate", "128", "timeOffset", "30") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.Offset).To(Equal(30)) + }) + }) + + Describe("Download", func() { + var trackID string + + BeforeAll(func() { + // All test tracks are mp3 at 320kbps + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Max: 1, Sort: "title"}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + trackID = songs[0].ID + }) + + It("returns error when id parameter is missing", func() { + resp := doReq("download") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("downloads raw when no format specified and AutoTranscodeDownload is false", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.EnableDownloads = true + conf.Server.AutoTranscodeDownload = false + + w := doRawReq("download", "id", trackID) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + + It("downloads with explicit format and bitrate", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.EnableDownloads = true + + w := doRawReq("download", "id", trackID, "format", "opus", "bitrate", "128") + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("returns error when downloads are disabled", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.EnableDownloads = false + + resp := doReq("download", "id", trackID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + }) + + Describe("GetCoverArt", func() { + It("handles request without error", func() { + w := doRawReq("getCoverArt") + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + }) + + Describe("GetAvatar", func() { + It("returns placeholder avatar when gravatar disabled", func() { + w := doRawReq("getAvatar", "username", "admin") + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + }) + + Describe("GetLyrics", func() { + It("returns empty lyrics when no match found", func() { + resp := doReq("getLyrics", "artist", "NonExistentArtist", "title", "NonExistentTitle") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Lyrics).ToNot(BeNil()) + Expect(resp.Lyrics.Value).To(BeEmpty()) + }) + }) + + Describe("GetLyricsBySongId", func() { + It("returns error when id parameter is missing", func() { + resp := doReq("getLyricsBySongId") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for non-existent song id", func() { + resp := doReq("getLyricsBySongId", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) +}) diff --git a/server/e2e/subsonic_multilibrary_test.go b/server/e2e/subsonic_multilibrary_test.go new file mode 100644 index 000000000..a837da124 --- /dev/null +++ b/server/e2e/subsonic_multilibrary_test.go @@ -0,0 +1,296 @@ +package e2e + +import ( + "fmt" + "testing/fstest" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/storage/storagetest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/scanner" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Multi-Library Support", Ordered, func() { + var lib2 model.Library + var adminWithLibs model.User // admin reloaded with both libraries + var userLib1Only model.User // non-admin with lib1 access only + + BeforeAll(func() { + conf.Server.EnableSharing = true + setupTestDB() + + // Create a second FakeFS with Classical music content + classical := template(_t{ + "albumartist": "Ludwig van Beethoven", + "artist": "Ludwig van Beethoven", + "album": "Symphony No. 9", + "year": 1824, + "genre": "Classical", + }) + classicalFS := storagetest.FakeFS{} + classicalFS.SetFiles(fstest.MapFS{ + "Classical/Beethoven/Symphony No. 9/01 - Allegro ma non troppo.mp3": classical(track(1, "Allegro ma non troppo")), + "Classical/Beethoven/Symphony No. 9/02 - Ode to Joy.mp3": classical(track(2, "Ode to Joy")), + }) + storagetest.Register("fake2", &classicalFS) + + // Create the second library in the DB (Put auto-assigns admin users) + lib2 = model.Library{ID: 2, Name: "Classical Library", Path: "fake2:///classical"} + Expect(ds.Library(ctx).Put(&lib2)).To(Succeed()) + + // Reload admin user to get both libraries in the Libraries field + loadedAdmin, err := ds.User(ctx).FindByUsername(adminUser.UserName) + Expect(err).ToNot(HaveOccurred()) + adminWithLibs = *loadedAdmin + + // Run incremental scan to import lib2 content (lib1 files unchanged → skipped) + s := scanner.New(ctx, ds, artwork.NoopCacheWarmer(), events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), metrics.NewNoopInstance()) + _, err = s.ScanAll(ctx, false) + Expect(err).ToNot(HaveOccurred()) + + // Create a non-admin user with access only to lib1 + userLib1Only = model.User{ + ID: "multilib-user-1", + UserName: "lib1user", + Name: "Lib1 User", + IsAdmin: false, + NewPassword: "password", + } + Expect(ds.User(ctx).Put(&userLib1Only)).To(Succeed()) + Expect(ds.User(ctx).SetUserLibraries(userLib1Only.ID, []int{lib.ID})).To(Succeed()) + + loadedUser, err := ds.User(ctx).FindByUsername(userLib1Only.UserName) + Expect(err).ToNot(HaveOccurred()) + userLib1Only.Libraries = loadedUser.Libraries + }) + + Describe("getMusicFolders", func() { + It("returns both libraries for admin user", func() { + resp := doReqWithUser(adminWithLibs, "getMusicFolders") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.MusicFolders.Folders).To(HaveLen(2)) + + names := make([]string, len(resp.MusicFolders.Folders)) + for i, f := range resp.MusicFolders.Folders { + names[i] = f.Name + } + Expect(names).To(ConsistOf("Music Library", "Classical Library")) + }) + }) + + Describe("getArtists - library filtering", func() { + It("returns only lib1 artists when musicFolderId=1", func() { + resp := doReqWithUser(adminWithLibs, "getArtists", "musicFolderId", fmt.Sprintf("%d", lib.ID)) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis")) + Expect(artistNames).ToNot(ContainElement("Ludwig van Beethoven")) + }) + + It("returns only lib2 artists when musicFolderId=2", func() { + resp := doReqWithUser(adminWithLibs, "getArtists", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElement("Ludwig van Beethoven")) + Expect(artistNames).ToNot(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis")) + }) + + It("returns artists from all libraries when no musicFolderId is specified", func() { + resp := doReqWithUser(adminWithLibs, "getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis", "Ludwig van Beethoven")) + }) + }) + + Describe("getAlbumList - library filtering", func() { + It("returns only lib1 albums when musicFolderId=1", func() { + resp := doReqWithUser(adminWithLibs, "getAlbumList", "type", "alphabeticalByName", "musicFolderId", fmt.Sprintf("%d", lib.ID)) + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(7)) + for _, a := range resp.AlbumList.Album { + Expect(a.Title).ToNot(Equal("Symphony No. 9")) + } + }) + + It("returns only lib2 albums when musicFolderId=2", func() { + resp := doReqWithUser(adminWithLibs, "getAlbumList", "type", "alphabeticalByName", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.AlbumList).ToNot(BeNil()) + Expect(resp.AlbumList.Album).To(HaveLen(1)) + Expect(resp.AlbumList.Album[0].Title).To(Equal("Symphony No. 9")) + }) + }) + + Describe("search3 - library filtering", func() { + It("does not find lib1 content when searching in lib2 only", func() { + resp := doReqWithUser(adminWithLibs, "search3", "query", "Beatles", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(BeEmpty()) + Expect(resp.SearchResult3.Album).To(BeEmpty()) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + + It("finds lib2 content when searching in lib2", func() { + resp := doReqWithUser(adminWithLibs, "search3", "query", "Beethoven", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("Ludwig van Beethoven")) + }) + }) + + Describe("Cross-library playlists", Ordered, func() { + var playlistID string + var lib1SongID, lib2SongID string + + BeforeAll(func() { + // Look up one song from each library + lib1Songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"media_file.library_id": lib.ID}, + Max: 1, Sort: "title", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(lib1Songs).ToNot(BeEmpty()) + lib1SongID = lib1Songs[0].ID + + lib2Songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"media_file.library_id": lib2.ID}, + Max: 1, Sort: "title", + }) + Expect(err).ToNot(HaveOccurred()) + Expect(lib2Songs).ToNot(BeEmpty()) + lib2SongID = lib2Songs[0].ID + }) + + It("admin creates a playlist with songs from both libraries", func() { + resp := doReqWithUser(adminWithLibs, "createPlaylist", + "name", "Cross-Library Playlist", "songId", lib1SongID, "songId", lib2SongID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + Expect(resp.Playlist.Entry).To(HaveLen(2)) + playlistID = resp.Playlist.Id + }) + + It("admin makes the playlist public", func() { + resp := doReqWithUser(adminWithLibs, "updatePlaylist", + "playlistId", playlistID, "public", "true") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("non-admin user with lib1 only sees only lib1 tracks in the playlist", func() { + resp := doReqWithUser(userLib1Only, "getPlaylist", "id", playlistID) + + Expect(resp.Playlist).ToNot(BeNil()) + // The playlist has 2 songs total, but the non-admin user only has access to lib1 + Expect(resp.Playlist.Entry).To(HaveLen(1)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(lib1SongID)) + }) + }) + + Describe("Cross-library shares", Ordered, func() { + var lib2AlbumID string + + BeforeAll(func() { + lib2Albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.library_id": lib2.ID}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(lib2Albums).ToNot(BeEmpty()) + lib2AlbumID = lib2Albums[0].ID + }) + + It("admin creates a share for a lib2 album", func() { + resp := doReqWithUser(adminWithLibs, "createShare", + "id", lib2AlbumID, "description", "Classical album share") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + + share := resp.Shares.Share[0] + Expect(share.Description).To(Equal("Classical album share")) + Expect(share.Entry).ToNot(BeEmpty()) + Expect(share.Entry[0].Title).To(Equal("Symphony No. 9")) + }) + }) + + Describe("Library access control", func() { + It("returns error when non-admin user requests inaccessible library", func() { + resp := doReqWithUser(userLib1Only, "getArtists", "musicFolderId", fmt.Sprintf("%d", lib2.ID)) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("non-admin user sees only their library's content without musicFolderId", func() { + resp := doReqWithUser(userLib1Only, "getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + var artistNames []string + for _, idx := range resp.Artist.Index { + for _, a := range idx.Artists { + artistNames = append(artistNames, a.Name) + } + } + Expect(artistNames).To(ContainElements("The Beatles", "Led Zeppelin", "Miles Davis")) + Expect(artistNames).ToNot(ContainElement("Ludwig van Beethoven")) + }) + + It("non-admin user search returns only their library's content", func() { + resp := doReqWithUser(userLib1Only, "search3", "query", "Beethoven") + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(BeEmpty(), "userLib1Only should not see Beethoven (lib2)") + Expect(resp.SearchResult3.Album).To(BeEmpty()) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + + It("non-admin user search finds content from their library", func() { + resp := doReqWithUser(userLib1Only, "search3", "query", "Beatles") + + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty(), "userLib1Only should find Beatles (lib1)") + }) + }) +}) diff --git a/server/e2e/subsonic_multiuser_test.go b/server/e2e/subsonic_multiuser_test.go new file mode 100644 index 000000000..d8c5d3689 --- /dev/null +++ b/server/e2e/subsonic_multiuser_test.go @@ -0,0 +1,82 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Multi-User Isolation", Ordered, func() { + var regularUser model.User + + BeforeAll(func() { + setupTestDB() + + regularUser = createUser("regular-1", "regular", "Regular User", false) + }) + + Describe("Admin-only endpoint restrictions", func() { + It("startScan fails for regular user", func() { + resp := doReqWithUser(regularUser, "startScan") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("Browsing as regular user", func() { + It("regular user can browse the library", func() { + resp := doReqWithUser(regularUser, "getArtists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Artist).ToNot(BeNil()) + Expect(resp.Artist.Index).ToNot(BeEmpty()) + }) + + It("regular user can search", func() { + resp := doReqWithUser(regularUser, "search3", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + }) + }) + + Describe("getUser authorization", func() { + It("regular user can get their own info", func() { + resp := doReqWithUser(regularUser, "getUser", "username", "regular") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.User.Username).To(Equal("regular")) + Expect(resp.User.AdminRole).To(BeFalse()) + }) + + It("regular user cannot get another user's info", func() { + resp := doReqWithUser(regularUser, "getUser", "username", "admin") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("getUsers authorization", func() { + It("succeeds for admin user", func() { + resp := doReqWithUser(adminUser, "getUsers") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Users).ToNot(BeNil()) + Expect(resp.Users.User).To(HaveLen(1)) + Expect(resp.Users.User[0].Username).To(Equal(adminUser.UserName)) + Expect(resp.Users.User[0].AdminRole).To(BeTrue()) + }) + + It("fails for regular user because getUsers is admin-only", func() { + resp := doReqWithUser(regularUser, "getUsers") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorAuthorizationFail)) + }) + }) +}) diff --git a/server/e2e/subsonic_playlists_test.go b/server/e2e/subsonic_playlists_test.go new file mode 100644 index 000000000..466e68cf0 --- /dev/null +++ b/server/e2e/subsonic_playlists_test.go @@ -0,0 +1,650 @@ +package e2e + +import ( + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Playlist Endpoints", Ordered, func() { + var playlistID string + var songIDs []string + + BeforeAll(func() { + setupTestDB() + + // Look up song IDs from scanned data for playlist operations + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Sort: "title", Max: 6}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(songs)).To(BeNumerically(">=", 5)) + for _, s := range songs { + songIDs = append(songIDs, s.ID) + } + }) + + It("getPlaylists returns empty list initially", func() { + resp := doReq("getPlaylists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlists).ToNot(BeNil()) + Expect(resp.Playlists.Playlist).To(BeEmpty()) + }) + + It("createPlaylist creates a new playlist with songs", func() { + resp := doReq("createPlaylist", "name", "Test Playlist", + "songId", songIDs[0], "songId", songIDs[1], "songId", songIDs[2]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.Name).To(Equal("Test Playlist")) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[0])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[1])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[2])) + playlistID = resp.Playlist.Id + }) + + It("getPlaylist returns playlist with tracks in order", func() { + resp := doReq("getPlaylist", "id", playlistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.Name).To(Equal("Test Playlist")) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[0])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[1])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[2])) + }) + + It("createPlaylist without name or playlistId returns error", func() { + resp := doReq("createPlaylist", "songId", songIDs[0]) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("createPlaylist with playlistId replaces tracks on existing playlist", func() { + // Replace tracks: the playlist had [song0, song1, song2], replace with [song3, song4] + resp := doReq("createPlaylist", "playlistId", playlistID, + "songId", songIDs[3], "songId", songIDs[4]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist).ToNot(BeNil()) + Expect(resp.Playlist.Id).To(Equal(playlistID)) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + Expect(resp.Playlist.Entry).To(HaveLen(2)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[3])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[4])) + }) + + It("updatePlaylist can rename the playlist", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, "name", "Renamed Playlist") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify the rename + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Name).To(Equal("Renamed Playlist")) + // Tracks should be unchanged + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + + It("updatePlaylist can set comment", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, "comment", "My favorite songs") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Comment).To(Equal("My favorite songs")) + }) + + It("updatePlaylist can set public visibility", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, "public", "true") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Public).To(BeTrue()) + }) + + It("updatePlaylist can add songs", func() { + // Playlist currently has [song3, song4], add song0 + resp := doReq("updatePlaylist", "playlistId", playlistID, "songIdToAdd", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[3])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[4])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[0])) + }) + + It("updatePlaylist can add multiple songs at once", func() { + // Playlist currently has [song3, song4, song0], add song1 and song2 + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIdToAdd", songIDs[1], "songIdToAdd", songIDs[2]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(5))) + Expect(resp.Playlist.Entry).To(HaveLen(5)) + }) + + It("updatePlaylist can remove songs by index and verifies correct songs remain", func() { + // Playlist has [song3, song4, song0, song1, song2] + // Remove index 0 (song3) and index 2 (song0) + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIndexToRemove", "0", "songIndexToRemove", "2") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[4])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[1])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[2])) + }) + + It("updatePlaylist can remove and add songs in a single call", func() { + // Playlist has [song4, song1, song2] + // Remove index 1 (song1) and add song3 + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIndexToRemove", "1", "songIdToAdd", songIDs[3]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(3))) + Expect(resp.Playlist.Entry).To(HaveLen(3)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[4])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[2])) + Expect(resp.Playlist.Entry[2].Id).To(Equal(songIDs[3])) + }) + + It("updatePlaylist can combine metadata change with track removal", func() { + // Playlist has [song4, song2, song3] + // Rename + remove index 0 (song4) + resp := doReq("updatePlaylist", "playlistId", playlistID, + "name", "Final Playlist", "songIndexToRemove", "0") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.Name).To(Equal("Final Playlist")) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[2])) + Expect(resp.Playlist.Entry[1].Id).To(Equal(songIDs[3])) + }) + + It("updatePlaylist can remove all songs from playlist", func() { + // Playlist has [song2, song3] — remove both + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIndexToRemove", "0", "songIndexToRemove", "1") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(0))) + Expect(resp.Playlist.Entry).To(BeEmpty()) + }) + + It("updatePlaylist can add songs to an empty playlist", func() { + resp := doReq("updatePlaylist", "playlistId", playlistID, + "songIdToAdd", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", playlistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(1))) + Expect(resp.Playlist.Entry).To(HaveLen(1)) + Expect(resp.Playlist.Entry[0].Id).To(Equal(songIDs[0])) + }) + + It("updatePlaylist without playlistId returns error", func() { + resp := doReq("updatePlaylist", "name", "No ID") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("getPlaylists shows the playlist", func() { + resp := doReq("getPlaylists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlists.Playlist).To(HaveLen(1)) + Expect(resp.Playlists.Playlist[0].Id).To(Equal(playlistID)) + }) + + It("deletePlaylist removes the playlist", func() { + resp := doReq("deletePlaylist", "id", playlistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getPlaylist on deleted playlist returns error", func() { + resp := doReq("getPlaylist", "id", playlistID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("getPlaylists returns empty after deletion", func() { + resp := doReq("getPlaylists") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlists.Playlist).To(BeEmpty()) + }) + + Describe("Playlist Permissions", Ordered, func() { + var songIDs []string + var adminPrivateID string + var adminPublicID string + var regularPlaylistID string + + BeforeAll(func() { + setupTestDB() + + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Sort: "title", Max: 6}) + Expect(err).ToNot(HaveOccurred()) + Expect(len(songs)).To(BeNumerically(">=", 3)) + for _, s := range songs { + songIDs = append(songIDs, s.ID) + } + }) + + It("admin creates a private playlist", func() { + resp := doReqWithUser(adminUser, "createPlaylist", "name", "Admin Private", + "songId", songIDs[0], "songId", songIDs[1]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + adminPrivateID = resp.Playlist.Id + }) + + It("admin creates a public playlist", func() { + resp := doReqWithUser(adminUser, "createPlaylist", "name", "Admin Public", + "songId", songIDs[0], "songId", songIDs[1]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + adminPublicID = resp.Playlist.Id + + // Make it public + resp = doReqWithUser(adminUser, "updatePlaylist", + "playlistId", adminPublicID, "public", "true") + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("regular user creates a playlist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", "name", "Regular Playlist", + "songId", songIDs[0]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + regularPlaylistID = resp.Playlist.Id + }) + + // --- Private playlist: regular user gets "not found" (repo hides it entirely) --- + + It("regular user cannot see admin's private playlist", func() { + resp := doReqWithUser(regularUser, "getPlaylist", "id", adminPrivateID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("regular user cannot update admin's private playlist (not found)", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPrivateID, "name", "Hacked") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("regular user cannot delete admin's private playlist (not found)", func() { + resp := doReqWithUser(regularUser, "deletePlaylist", "id", adminPrivateID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + // --- Public playlist: regular user can see but cannot modify (authorization fail, code 50) --- + + It("regular user can see admin's public playlist", func() { + resp := doReqWithUser(regularUser, "getPlaylist", "id", adminPublicID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Admin Public")) + }) + + It("regular user cannot update admin's public playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPublicID, "name", "Hacked") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot add songs to admin's public playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPublicID, "songIdToAdd", songIDs[2]) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot remove songs from admin's public playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", adminPublicID, "songIndexToRemove", "0") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot delete admin's public playlist", func() { + resp := doReqWithUser(regularUser, "deletePlaylist", "id", adminPublicID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("regular user cannot replace tracks on admin's public playlist via createPlaylist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", + "playlistId", adminPublicID, "songId", songIDs[2]) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + // --- Regular user can manage their own playlists --- + + It("regular user can update their own playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", regularPlaylistID, "name", "My Updated Playlist") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(regularUser, "getPlaylist", "id", regularPlaylistID) + Expect(resp.Playlist.Name).To(Equal("My Updated Playlist")) + }) + + It("regular user can add songs to their own playlist", func() { + resp := doReqWithUser(regularUser, "updatePlaylist", + "playlistId", regularPlaylistID, "songIdToAdd", songIDs[1]) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(regularUser, "getPlaylist", "id", regularPlaylistID) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + + It("regular user can delete their own playlist", func() { + resp := doReqWithUser(regularUser, "deletePlaylist", "id", regularPlaylistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + // --- Admin can manage any user's playlists --- + + It("admin can update any user's playlist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", "name", "To Be Admin-Edited", + "songId", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + plsID := resp.Playlist.Id + + resp = doReqWithUser(adminUser, "updatePlaylist", + "playlistId", plsID, "name", "Admin Edited") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(adminUser, "getPlaylist", "id", plsID) + Expect(resp.Playlist.Name).To(Equal("Admin Edited")) + }) + + It("admin can delete any user's playlist", func() { + resp := doReqWithUser(regularUser, "createPlaylist", "name", "To Be Admin-Deleted", + "songId", songIDs[0]) + Expect(resp.Status).To(Equal(responses.StatusOK)) + plsID := resp.Playlist.Id + + resp = doReqWithUser(adminUser, "deletePlaylist", "id", plsID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReqWithUser(adminUser, "getPlaylist", "id", plsID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + + // --- Verify admin's playlists are unchanged --- + + It("admin's private playlist is unchanged after failed regular user operations", func() { + resp := doReqWithUser(adminUser, "getPlaylist", "id", adminPrivateID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Admin Private")) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + + It("admin's public playlist is unchanged after failed regular user operations", func() { + resp := doReqWithUser(adminUser, "getPlaylist", "id", adminPublicID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Admin Public")) + Expect(resp.Playlist.SongCount).To(Equal(int32(2))) + }) + }) + + Describe("Smart Playlist Protection", Ordered, func() { + var smartPlaylistID string + var songID string + + BeforeAll(func() { + setupTestDB() + + // Look up a song ID for mutation tests + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Sort: "title", Max: 1}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + + // Insert a smart playlist directly into the DB + smartPls := &model.Playlist{ + Name: "Smart Playlist", + OwnerID: adminUser.ID, + Public: false, + Rules: &criteria.Criteria{Expression: criteria.Contains{"title": ""}}, + } + Expect(ds.Playlist(ctx).Put(smartPls)).To(Succeed()) + smartPlaylistID = smartPls.ID + }) + + It("getPlaylist returns smart playlist with readonly flag and validUntil", func() { + resp := doReq("getPlaylist", "id", smartPlaylistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.Name).To(Equal("Smart Playlist")) + Expect(resp.Playlist.OpenSubsonicPlaylist).ToNot(BeNil()) + Expect(resp.Playlist.OpenSubsonicPlaylist.Readonly).To(BeTrue()) + expectedValidUntil := time.Now().Add(conf.Server.SmartPlaylistRefreshDelay) + Expect(*resp.Playlist.OpenSubsonicPlaylist.ValidUntil).To(BeTemporally("~", expectedValidUntil, time.Second)) + }) + + It("createPlaylist rejects replacing tracks on smart playlist", func() { + resp := doReq("createPlaylist", "playlistId", smartPlaylistID, "songId", songID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("updatePlaylist rejects adding songs to smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "songIdToAdd", songID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("updatePlaylist rejects removing songs from smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "songIndexToRemove", "0") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(int32(50))) + }) + + It("updatePlaylist allows renaming smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "name", "Renamed Smart") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", smartPlaylistID) + Expect(resp.Playlist.Name).To(Equal("Renamed Smart")) + }) + + It("updatePlaylist allows setting comment on smart playlist", func() { + resp := doReq("updatePlaylist", "playlistId", smartPlaylistID, + "comment", "Auto-generated playlist") + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", smartPlaylistID) + Expect(resp.Playlist.Comment).To(Equal("Auto-generated playlist")) + }) + + It("deletePlaylist can delete smart playlist", func() { + resp := doReq("deletePlaylist", "id", smartPlaylistID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + resp = doReq("getPlaylist", "id", smartPlaylistID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + }) + + Describe("Smart Playlist Boolean String Normalization (issue #4826)", Ordered, func() { + var songID string + var boolPlaylistID, stringPlaylistID, nestedPlaylistID string + + BeforeAll(func() { + setupTestDB() + + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{Sort: "title", Max: 1}) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + + // Star the song via the Subsonic API + resp := doReq("star", "id", songID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Force immediate refresh for all smart playlists + conf.Server.SmartPlaylistRefreshDelay = -1 * time.Second + + // Create smart playlist with boolean true + boolPls := &model.Playlist{ + Name: "Bool Loved", + OwnerID: adminUser.ID, + Rules: &criteria.Criteria{Expression: criteria.All{criteria.Is{"loved": true}}}, + } + Expect(ds.Playlist(ctx).Put(boolPls)).To(Succeed()) + boolPlaylistID = boolPls.ID + + // Create smart playlist with string "true" + stringPls := &model.Playlist{ + Name: "String Loved", + OwnerID: adminUser.ID, + Rules: &criteria.Criteria{Expression: criteria.All{criteria.Is{"loved": "true"}}}, + } + Expect(ds.Playlist(ctx).Put(stringPls)).To(Succeed()) + stringPlaylistID = stringPls.ID + + // Create smart playlist with string "true" in nested any group (exact issue #4826 scenario) + nestedPls := &model.Playlist{ + Name: "Nested String Loved", + OwnerID: adminUser.ID, + Rules: &criteria.Criteria{Expression: criteria.All{ + criteria.Any{ + criteria.Is{"loved": "true"}, + }, + }}, + } + Expect(ds.Playlist(ctx).Put(nestedPls)).To(Succeed()) + nestedPlaylistID = nestedPls.ID + }) + + It("smart playlist with bool loved=true returns starred song", func() { + resp := doReq("getPlaylist", "id", boolPlaylistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.SongCount).To(BeNumerically(">=", int32(1))) + entryIDs := make([]string, len(resp.Playlist.Entry)) + for i, e := range resp.Playlist.Entry { + entryIDs[i] = e.Id + } + Expect(entryIDs).To(ContainElement(songID)) + }) + + It("smart playlist with string loved='true' returns same results as bool (issue #4826)", func() { + boolResp := doReq("getPlaylist", "id", boolPlaylistID) + stringResp := doReq("getPlaylist", "id", stringPlaylistID) + + Expect(stringResp.Status).To(Equal(responses.StatusOK)) + Expect(stringResp.Playlist.SongCount).To(Equal(boolResp.Playlist.SongCount)) + }) + + It("nested any group with string loved='true' returns starred song (issue #4826)", func() { + resp := doReq("getPlaylist", "id", nestedPlaylistID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.SongCount).To(BeNumerically(">=", int32(1))) + entryIDs := make([]string, len(resp.Playlist.Entry)) + for i, e := range resp.Playlist.Entry { + entryIDs[i] = e.Id + } + Expect(entryIDs).To(ContainElement(songID)) + }) + + It("isPresent with string 'true' matches songs that have the tag", func() { + pls := &model.Playlist{ + Name: "Genre Present String", + OwnerID: adminUser.ID, + Rules: &criteria.Criteria{Expression: criteria.All{criteria.IsPresent{"genre": "true"}}}, + } + Expect(ds.Playlist(ctx).Put(pls)).To(Succeed()) + + resp := doReq("getPlaylist", "id", pls.ID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.SongCount).To(BeNumerically(">=", int32(1))) + }) + + It("isMissing with string 'true' excludes songs that have the tag", func() { + pls := &model.Playlist{ + Name: "Genre Missing String", + OwnerID: adminUser.ID, + Rules: &criteria.Criteria{Expression: criteria.All{criteria.IsMissing{"genre": "true"}}}, + } + Expect(ds.Playlist(ctx).Put(pls)).To(Succeed()) + + resp := doReq("getPlaylist", "id", pls.ID) + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Playlist.SongCount).To(Equal(int32(0))) + }) + + It("isMissing with string 'true' returns same results as bool true", func() { + boolPls := &model.Playlist{ + Name: "Genre Missing Bool", + OwnerID: adminUser.ID, + Rules: &criteria.Criteria{Expression: criteria.All{criteria.IsMissing{"genre": true}}}, + } + Expect(ds.Playlist(ctx).Put(boolPls)).To(Succeed()) + + stringPls := &model.Playlist{ + Name: "Genre Missing String2", + OwnerID: adminUser.ID, + Rules: &criteria.Criteria{Expression: criteria.All{criteria.IsMissing{"genre": "true"}}}, + } + Expect(ds.Playlist(ctx).Put(stringPls)).To(Succeed()) + + boolResp := doReq("getPlaylist", "id", boolPls.ID) + stringResp := doReq("getPlaylist", "id", stringPls.ID) + Expect(stringResp.Playlist.SongCount).To(Equal(boolResp.Playlist.SongCount)) + }) + }) +}) diff --git a/server/e2e/subsonic_radio_test.go b/server/e2e/subsonic_radio_test.go new file mode 100644 index 000000000..cd778fa79 --- /dev/null +++ b/server/e2e/subsonic_radio_test.go @@ -0,0 +1,133 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Internet Radio Endpoints", Ordered, func() { + var radioID string + + BeforeAll(func() { + setupTestDB() + }) + + It("getInternetRadioStations returns empty initially", func() { + resp := doReq("getInternetRadioStations") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.InternetRadioStations).ToNot(BeNil()) + Expect(resp.InternetRadioStations.Radios).To(BeEmpty()) + }) + + It("createInternetRadioStation adds a station", func() { + resp := doReq("createInternetRadioStation", + "streamUrl", "https://stream.example.com/radio", + "name", "Test Radio", + "homepageUrl", "https://example.com", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getInternetRadioStations returns the created station", func() { + resp := doReq("getInternetRadioStations") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.InternetRadioStations).ToNot(BeNil()) + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + + radio := resp.InternetRadioStations.Radios[0] + Expect(radio.Name).To(Equal("Test Radio")) + Expect(radio.StreamUrl).To(Equal("https://stream.example.com/radio")) + Expect(radio.HomepageUrl).To(Equal("https://example.com")) + radioID = radio.ID + Expect(radioID).ToNot(BeEmpty()) + }) + + It("getInternetRadioStations remains available to regular users", func() { + resp := doReqWithUser(regularUser, "getInternetRadioStations") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.InternetRadioStations).ToNot(BeNil()) + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + Expect(resp.InternetRadioStations.Radios[0].Name).To(Equal("Test Radio")) + }) + + It("createInternetRadioStation requires admin user", func() { + resp := doReqWithUser(regularUser, "createInternetRadioStation", + "streamUrl", "https://stream.example.com/hacked", + "name", "Hacked Radio", + ) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorAuthorizationFail)) + + resp = doReq("getInternetRadioStations") + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + Expect(resp.InternetRadioStations.Radios[0].Name).To(Equal("Test Radio")) + }) + + It("updateInternetRadioStation modifies the station", func() { + resp := doReq("updateInternetRadioStation", + "id", radioID, + "streamUrl", "https://stream.example.com/radio-v2", + "name", "Updated Radio", + "homepageUrl", "https://updated.example.com", + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify update + resp = doReq("getInternetRadioStations") + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + Expect(resp.InternetRadioStations.Radios[0].Name).To(Equal("Updated Radio")) + Expect(resp.InternetRadioStations.Radios[0].StreamUrl).To(Equal("https://stream.example.com/radio-v2")) + Expect(resp.InternetRadioStations.Radios[0].HomepageUrl).To(Equal("https://updated.example.com")) + }) + + It("updateInternetRadioStation requires admin user", func() { + resp := doReqWithUser(regularUser, "updateInternetRadioStation", + "id", radioID, + "streamUrl", "https://stream.example.com/hacked", + "name", "Hacked Radio", + ) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorAuthorizationFail)) + + resp = doReq("getInternetRadioStations") + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + Expect(resp.InternetRadioStations.Radios[0].Name).To(Equal("Updated Radio")) + Expect(resp.InternetRadioStations.Radios[0].StreamUrl).To(Equal("https://stream.example.com/radio-v2")) + }) + + It("deleteInternetRadioStation requires admin user", func() { + resp := doReqWithUser(regularUser, "deleteInternetRadioStation", "id", radioID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorAuthorizationFail)) + + resp = doReq("getInternetRadioStations") + Expect(resp.InternetRadioStations.Radios).To(HaveLen(1)) + Expect(resp.InternetRadioStations.Radios[0].ID).To(Equal(radioID)) + }) + + It("deleteInternetRadioStation removes it", func() { + resp := doReq("deleteInternetRadioStation", "id", radioID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getInternetRadioStations returns empty after deletion", func() { + resp := doReq("getInternetRadioStations") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.InternetRadioStations).ToNot(BeNil()) + Expect(resp.InternetRadioStations.Radios).To(BeEmpty()) + }) +}) diff --git a/server/e2e/subsonic_scan_test.go b/server/e2e/subsonic_scan_test.go new file mode 100644 index 000000000..8bac6fe96 --- /dev/null +++ b/server/e2e/subsonic_scan_test.go @@ -0,0 +1,37 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Scan Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + It("getScanStatus returns status", func() { + resp := doReq("getScanStatus") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ScanStatus).ToNot(BeNil()) + Expect(resp.ScanStatus.Scanning).To(BeFalse()) + Expect(resp.ScanStatus.Count).To(BeNumerically(">", 0)) + Expect(resp.ScanStatus.LastScan).ToNot(BeNil()) + }) + + It("startScan requires admin user", func() { + resp := doReqWithUser(regularUser, "startScan") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("startScan returns scan status response", func() { + resp := doReq("startScan") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.ScanStatus).ToNot(BeNil()) + }) +}) diff --git a/server/e2e/subsonic_searching_test.go b/server/e2e/subsonic_searching_test.go new file mode 100644 index 000000000..e348bc6b9 --- /dev/null +++ b/server/e2e/subsonic_searching_test.go @@ -0,0 +1,274 @@ +package e2e + +import ( + "github.com/google/uuid" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Search Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("Search2", func() { + It("finds artists by name", func() { + resp := doReq("search2", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Artist).ToNot(BeEmpty()) + + found := false + for _, a := range resp.SearchResult2.Artist { + if a.Name == "The Beatles" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find artist 'The Beatles'") + }) + + It("finds albums by name", func() { + resp := doReq("search2", "query", "Abbey Road") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Album).ToNot(BeEmpty()) + + found := false + for _, a := range resp.SearchResult2.Album { + if a.Title == "Abbey Road" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find album 'Abbey Road'") + }) + + It("finds songs by title", func() { + resp := doReq("search2", "query", "Come Together") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Song).ToNot(BeEmpty()) + + found := false + for _, s := range resp.SearchResult2.Song { + if s.Title == "Come Together" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find song 'Come Together'") + }) + + It("respects artistCount/albumCount/songCount limits", func() { + resp := doReq("search2", "query", "Beatles", + "artistCount", "1", "albumCount", "1", "songCount", "1") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(len(resp.SearchResult2.Artist)).To(BeNumerically("<=", 1)) + Expect(len(resp.SearchResult2.Album)).To(BeNumerically("<=", 1)) + Expect(len(resp.SearchResult2.Song)).To(BeNumerically("<=", 1)) + }) + + It("supports offset parameters", func() { + // First get all results for Beatles + resp1 := doReq("search2", "query", "Beatles", "songCount", "500") + allSongs := resp1.SearchResult2.Song + + if len(allSongs) > 1 { + // Get with offset to skip the first song + resp2 := doReq("search2", "query", "Beatles", "songOffset", "1", "songCount", "500") + + Expect(resp2.SearchResult2).ToNot(BeNil()) + Expect(len(resp2.SearchResult2.Song)).To(Equal(len(allSongs) - 1)) + } + }) + + It("returns empty results for non-matching query", func() { + resp := doReq("search2", "query", "ZZZZNONEXISTENT99999") + + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(resp.SearchResult2.Artist).To(BeEmpty()) + Expect(resp.SearchResult2.Album).To(BeEmpty()) + Expect(resp.SearchResult2.Song).To(BeEmpty()) + }) + }) + + Describe("Search3", func() { + It("returns results in ID3 format", func() { + resp := doReq("search3", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + // Verify ID3 format: Artist should be ArtistID3 with Name and AlbumCount + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + Expect(resp.SearchResult3.Artist[0].Name).ToNot(BeEmpty()) + Expect(resp.SearchResult3.Artist[0].Id).ToNot(BeEmpty()) + }) + + It("returns all results when query is empty (OpenSubsonic)", func() { + resp := doReq("search3", "query", "") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(6)) + Expect(resp.SearchResult3.Album).To(HaveLen(7)) + Expect(resp.SearchResult3.Song).To(HaveLen(14)) + }) + + It("finds across all entity types simultaneously", func() { + // "Beatles" should match artist, albums, and songs by The Beatles + resp := doReq("search3", "query", "Beatles") + + Expect(resp.SearchResult3).ToNot(BeNil()) + + // Should find at least the artist "The Beatles" + artistFound := false + for _, a := range resp.SearchResult3.Artist { + if a.Name == "The Beatles" { + artistFound = true + break + } + } + Expect(artistFound).To(BeTrue(), "expected to find artist 'The Beatles'") + + // Should find albums by The Beatles (albums contain "Beatles" in artist field) + // Albums are returned as AlbumID3 type + for _, a := range resp.SearchResult3.Album { + Expect(a.Id).ToNot(BeEmpty()) + Expect(a.Name).ToNot(BeEmpty()) + } + + // Songs are returned as Child type + for _, s := range resp.SearchResult3.Song { + Expect(s.Id).ToNot(BeEmpty()) + Expect(s.Title).ToNot(BeEmpty()) + } + }) + + Describe("MBID search", func() { + It("finds songs by mbz_recording_id", func() { + resp := doReq("search3", "query", mbidComeTogetherRec) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Song).To(HaveLen(1)) + Expect(resp.SearchResult3.Song[0].Title).To(Equal("Come Together")) + }) + + It("finds songs by mbz_release_track_id", func() { + resp := doReq("search3", "query", mbidSomething) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Song).To(HaveLen(1)) + Expect(resp.SearchResult3.Song[0].Title).To(Equal("Something")) + }) + + It("finds albums by mbz_album_id", func() { + resp := doReq("search3", "query", mbidAbbeyRoadAlbum) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Album).To(HaveLen(1)) + Expect(resp.SearchResult3.Album[0].Name).To(Equal("Abbey Road")) + }) + + It("finds albums by mbz_release_group_id", func() { + resp := doReq("search3", "query", mbidAbbeyRoadRelGroup) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Album).To(HaveLen(1)) + Expect(resp.SearchResult3.Album[0].Name).To(Equal("Abbey Road")) + }) + + It("finds artists by mbz_artist_id", func() { + resp := doReq("search3", "query", mbidBeatlesArtist) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(1)) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("The Beatles")) + }) + + It("returns empty results for non-matching UUID", func() { + nonMatchingUUID := uuid.NewString() + resp := doReq("search3", "query", nonMatchingUUID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(BeEmpty()) + Expect(resp.SearchResult3.Album).To(BeEmpty()) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + + It("does not return songs for artist MBID", func() { + // media_file MBID search only checks mbz_recording_id and mbz_release_track_id, + // so an artist MBID should return only the artist, not songs + resp := doReq("search3", "query", mbidBeatlesArtist) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(1)) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("The Beatles")) + Expect(resp.SearchResult3.Song).To(BeEmpty()) + }) + }) + + Describe("CJK search", func() { + It("finds songs by CJK title", func() { + resp := doReq("search3", "query", "プラチナ") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Song).To(HaveLen(1)) + Expect(resp.SearchResult3.Song[0].Title).To(Equal("プラチナ・ジェット")) + }) + + It("finds artists by CJK name", func() { + resp := doReq("search3", "query", "シートベルツ") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).To(HaveLen(1)) + Expect(resp.SearchResult3.Artist[0].Name).To(Equal("シートベルツ")) + }) + + It("finds albums by CJK artist name", func() { + resp := doReq("search3", "query", "シートベルツ") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Album).To(HaveLen(1)) + Expect(resp.SearchResult3.Album[0].Name).To(Equal("COWBOY BEBOP")) + }) + }) + + Describe("Legacy backend", func() { + It("returns results using legacy LIKE-based search when configured", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Search.Backend = "legacy" + + resp := doReq("search3", "query", "Beatles") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(resp.SearchResult3.Artist).ToNot(BeEmpty()) + + found := false + for _, a := range resp.SearchResult3.Artist { + if a.Name == "The Beatles" { + found = true + break + } + } + Expect(found).To(BeTrue(), "expected to find artist 'The Beatles' with legacy backend") + }) + }) + }) +}) diff --git a/server/e2e/subsonic_sharing_test.go b/server/e2e/subsonic_sharing_test.go new file mode 100644 index 000000000..03bf1f80f --- /dev/null +++ b/server/e2e/subsonic_sharing_test.go @@ -0,0 +1,206 @@ +package e2e + +import ( + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Sharing Endpoints", Ordered, func() { + var shareID string + var albumID string + var songID string + + BeforeAll(func() { + conf.Server.EnableSharing = true + setupTestDB() + + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + albumID = albums[0].ID + + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + songID = songs[0].ID + }) + + It("getShares returns empty initially", func() { + resp := doReq("getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(BeEmpty()) + }) + + It("createShare creates a share for an album", func() { + resp := doReq("createShare", "id", albumID, "description", "Check out this album") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + + share := resp.Shares.Share[0] + Expect(share.ID).ToNot(BeEmpty()) + Expect(share.Description).To(Equal("Check out this album")) + Expect(share.Username).To(Equal(adminUser.UserName)) + shareID = share.ID + }) + + It("getShares returns the created share", func() { + resp := doReq("getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + + share := resp.Shares.Share[0] + Expect(share.ID).To(Equal(shareID)) + Expect(share.Description).To(Equal("Check out this album")) + Expect(share.Username).To(Equal(adminUser.UserName)) + Expect(share.Entry).ToNot(BeEmpty()) + }) + + It("updateShare modifies the description", func() { + resp := doReq("updateShare", "id", shareID, "description", "Updated description") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + + // Verify update + resp = doReq("getShares") + Expect(resp.Shares.Share).To(HaveLen(1)) + Expect(resp.Shares.Share[0].Description).To(Equal("Updated description")) + }) + + It("deleteShare removes it", func() { + resp := doReq("deleteShare", "id", shareID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("getShares returns empty after deletion", func() { + resp := doReq("getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(BeEmpty()) + }) + + It("createShare works with a song ID", func() { + resp := doReq("createShare", "id", songID, "description", "Great song") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(HaveLen(1)) + Expect(resp.Shares.Share[0].Description).To(Equal("Great song")) + Expect(resp.Shares.Share[0].Entry).To(HaveLen(1)) + }) + + It("createShare returns error when id parameter is missing", func() { + resp := doReq("createShare") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("updateShare returns error when id parameter is missing", func() { + resp := doReq("updateShare") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("deleteShare returns error when id parameter is missing", func() { + resp := doReq("deleteShare") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) +}) + +var _ = Describe("Sharing Cross-User Isolation", Ordered, func() { + var userA, userB model.User + var shareID string + var albumID string + + BeforeAll(func() { + conf.Server.EnableSharing = true + setupTestDB() + + userA = createUser("share-user-a", "share-user-a", "Share User A", false) + userB = createUser("share-user-b", "share-user-b", "Share User B", false) + + albums, err := ds.Album(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"album.name": "Abbey Road"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(albums).ToNot(BeEmpty()) + albumID = albums[0].ID + + resp := doReqWithUser(userA, "createShare", "id", albumID, "description", "User A's share") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares.Share).To(HaveLen(1)) + shareID = resp.Shares.Share[0].ID + Expect(resp.Shares.Share[0].Username).To(Equal(userA.UserName)) + }) + + It("userB's getShares does not leak userA's share", func() { + resp := doReqWithUser(userB, "getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares).ToNot(BeNil()) + Expect(resp.Shares.Share).To(BeEmpty()) + }) + + It("userA still sees own share", func() { + resp := doReqWithUser(userA, "getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Shares.Share).To(HaveLen(1)) + Expect(resp.Shares.Share[0].ID).To(Equal(shareID)) + Expect(resp.Shares.Share[0].Description).To(Equal("User A's share")) + }) + + It("admin sees userA's share", func() { + resp := doReqWithUser(adminUser, "getShares") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + ids := make([]string, len(resp.Shares.Share)) + for i, s := range resp.Shares.Share { + ids[i] = s.ID + } + Expect(ids).To(ContainElement(shareID)) + }) + + It("userB cannot updateShare on userA's share", func() { + resp := doReqWithUser(userB, "updateShare", "id", shareID, "description", "hijacked") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + + // Confirm description unchanged for userA. + check := doReqWithUser(userA, "getShares") + Expect(check.Shares.Share).To(HaveLen(1)) + Expect(check.Shares.Share[0].Description).To(Equal("User A's share")) + }) + + It("userB cannot deleteShare on userA's share", func() { + resp := doReqWithUser(userB, "deleteShare", "id", shareID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + + // Confirm share still present for userA. + check := doReqWithUser(userA, "getShares") + Expect(check.Shares.Share).To(HaveLen(1)) + Expect(check.Shares.Share[0].ID).To(Equal(shareID)) + }) +}) diff --git a/server/e2e/subsonic_sonic_similarity_test.go b/server/e2e/subsonic_sonic_similarity_test.go new file mode 100644 index 000000000..40161470b --- /dev/null +++ b/server/e2e/subsonic_sonic_similarity_test.go @@ -0,0 +1,273 @@ +package e2e + +import ( + "context" + "encoding/json" + "net/http" + "net/http/httptest" + + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/agents" + "github.com/navidrome/navidrome/core/lyrics" + "github.com/navidrome/navidrome/core/matcher" + "github.com/navidrome/navidrome/core/metrics" + "github.com/navidrome/navidrome/core/playback" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/core/scrobbler" + "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/server/subsonic" + "github.com/navidrome/navidrome/server/subsonic/responses" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// buildSonicRouter creates a subsonic.Router with a real sonic.Sonic service +// backed by the given provider and the shared e2e DataStore. +func buildSonicRouter(provider sonic.Provider) *subsonic.Router { + loader := &mockSonicPluginLoader{provider: provider} + m := matcher.New(ds) + sonicSvc := sonic.New(ds, loader, m) + decider := stream.NewTranscodeDecider(ds, noopFFmpeg{}) + return subsonic.New( + ds, + noopArtwork{}, + &spyStreamer{}, + noopArchiver{}, + core.NewPlayers(ds), + noopProvider{}, + nil, // scanner + events.NoopBroker(), + playlists.NewPlaylists(ds, core.NewImageUploadService()), + scrobbler.NewPlayTracker(ds, events.NoopBroker(), nil), + core.NewShare(ds), + playback.PlaybackServer(nil), + metrics.NewNoopInstance(), + lyrics.NewLyrics(nil), + decider, + sonicSvc, + ) +} + +// doSonicReq makes a request through a sonic-enabled router and returns the parsed response. +func doSonicReq(sonicRouter *subsonic.Router, endpoint string, params ...string) *responses.Subsonic { + w := httptest.NewRecorder() + r := buildReq(adminUser, endpoint, params...) + sonicRouter.ServeHTTP(w, r) + return parseJSONResponse(w) +} + +// doSonicRawReq makes a request through a sonic-enabled router and returns the raw recorder. +func doSonicRawReq(sonicRouter *subsonic.Router, endpoint string, params ...string) *httptest.ResponseRecorder { + w := httptest.NewRecorder() + r := buildReq(adminUser, endpoint, params...) + sonicRouter.ServeHTTP(w, r) + return w +} + +var _ = Describe("Sonic Similarity Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Context("without sonic similarity plugin", func() { + Describe("getSonicSimilarTracks", func() { + It("returns 404 when no sonic similarity plugin is available", func() { + w := doRawReq("getSonicSimilarTracks", "id", "any-song-id") + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + + Describe("findSonicPath", func() { + It("returns 404 when no sonic similarity plugin is available", func() { + w := doRawReq("findSonicPath", "startSongId", "any-song-id", "endSongId", "another-song-id") + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + }) + + Context("with sonic similarity plugin", func() { + var ( + sonicRouter *subsonic.Router + comeTogether model.MediaFile + something model.MediaFile + ) + + BeforeEach(func() { + songs, err := ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Come Together"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + comeTogether = songs[0] + + songs, err = ds.MediaFile(ctx).GetAll(model.QueryOptions{ + Filters: squirrel.Eq{"title": "Something"}, + }) + Expect(err).ToNot(HaveOccurred()) + Expect(songs).ToNot(BeEmpty()) + something = songs[0] + + provider := &mockSonicProvider{ + similarIDs: []string{something.ID, comeTogether.ID}, + pathIDs: []string{comeTogether.ID, something.ID}, + } + sonicRouter = buildSonicRouter(provider) + }) + + Describe("getSonicSimilarTracks", func() { + It("returns similar tracks with similarity scores", func() { + resp := doSonicReq(sonicRouter, "getSonicSimilarTracks", "id", comeTogether.ID) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + matches := *resp.SonicMatches + Expect(matches).To(HaveLen(2)) + Expect(matches[0].Entry.Title).To(Equal("Something")) + Expect(matches[0].Similarity).To(Equal(1.0)) + Expect(matches[1].Entry.Title).To(Equal("Come Together")) + Expect(matches[1].Similarity).To(Equal(0.9)) + }) + + It("respects the count parameter", func() { + resp := doSonicReq(sonicRouter, "getSonicSimilarTracks", "id", comeTogether.ID, "count", "1") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(*resp.SonicMatches).To(HaveLen(1)) + }) + + It("returns an error for a missing id parameter", func() { + resp := doSonicReq(sonicRouter, "getSonicSimilarTracks") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns an error for a non-existent song ID", func() { + resp := doSonicReq(sonicRouter, "getSonicSimilarTracks", "id", "non-existent-id") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns correct JSON structure", func() { + w := doSonicRawReq(sonicRouter, "getSonicSimilarTracks", "id", comeTogether.ID) + Expect(w.Code).To(Equal(http.StatusOK)) + + var wrapper responses.JsonWrapper + Expect(json.Unmarshal(w.Body.Bytes(), &wrapper)).To(Succeed()) + matches := *wrapper.Subsonic.SonicMatches + Expect(matches).To(HaveLen(2)) + Expect(matches[0].Similarity).To(BeNumerically(">", 0)) + Expect(matches[0].Entry.Id).ToNot(BeEmpty()) + }) + }) + + Describe("findSonicPath", func() { + It("returns a path between two tracks with similarity scores", func() { + resp := doSonicReq(sonicRouter, "findSonicPath", + "startSongId", comeTogether.ID, + "endSongId", something.ID, + ) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + matches := *resp.SonicMatches + Expect(matches).To(HaveLen(2)) + Expect(matches[0].Entry.Title).To(Equal("Come Together")) + Expect(matches[0].Similarity).To(Equal(1.0)) + Expect(matches[1].Entry.Title).To(Equal("Something")) + Expect(matches[1].Similarity).To(Equal(0.95)) + }) + + It("returns an error for a missing startSongId parameter", func() { + resp := doSonicReq(sonicRouter, "findSonicPath", "endSongId", something.ID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns an error for a missing endSongId parameter", func() { + resp := doSonicReq(sonicRouter, "findSonicPath", "startSongId", comeTogether.ID) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns an error for a non-existent start song ID", func() { + resp := doSonicReq(sonicRouter, "findSonicPath", + "startSongId", "non-existent-id", + "endSongId", something.ID, + ) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns an error for a non-existent end song ID", func() { + resp := doSonicReq(sonicRouter, "findSonicPath", + "startSongId", comeTogether.ID, + "endSongId", "non-existent-id", + ) + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + }) +}) + +// mockSonicProvider returns results using IDs from the real test library, +// so that the matcher can resolve them back to actual MediaFiles. +type mockSonicProvider struct { + similarIDs []string + pathIDs []string +} + +func (m *mockSonicProvider) GetSonicSimilarTracks(_ context.Context, mf *model.MediaFile, count int) ([]sonic.SimilarResult, error) { + var results []sonic.SimilarResult + for i, id := range m.similarIDs { + if i >= count { + break + } + results = append(results, sonic.SimilarResult{ + Song: agents.Song{ID: id}, + Similarity: 1.0 - float64(i)*0.1, + }) + } + return results, nil +} + +func (m *mockSonicProvider) FindSonicPath(_ context.Context, startMf, endMf *model.MediaFile, count int) ([]sonic.SimilarResult, error) { + var results []sonic.SimilarResult + for i, id := range m.pathIDs { + if i >= count { + break + } + results = append(results, sonic.SimilarResult{ + Song: agents.Song{ID: id}, + Similarity: 1.0 - float64(i)*0.05, + }) + } + return results, nil +} + +type mockSonicPluginLoader struct { + provider sonic.Provider +} + +func (m *mockSonicPluginLoader) PluginNames(capability string) []string { + if capability == "SonicSimilarity" && m.provider != nil { + return []string{"mock-sonic"} + } + return nil +} + +func (m *mockSonicPluginLoader) LoadSonicSimilarity(_ string) (sonic.Provider, bool) { + if m.provider != nil { + return m.provider, true + } + return nil, false +} diff --git a/server/e2e/subsonic_stream_test.go b/server/e2e/subsonic_stream_test.go new file mode 100644 index 000000000..281524636 --- /dev/null +++ b/server/e2e/subsonic_stream_test.go @@ -0,0 +1,192 @@ +package e2e + +import ( + "encoding/json" + "errors" + "net/http" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("stream.view (legacy streaming)", Ordered, func() { + var ( + mp3TrackID string // Come Together (mp3, 320kbps) + flacTrackID string // TC FLAC Standard (flac, 900kbps) + flacMultichTrackID string // TC FLAC Multichannel (flac, 6ch) + ) + + BeforeAll(func() { + setupTestDB() + + songs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + byTitle := map[string]string{} + for _, s := range songs { + byTitle[s.Title] = s.ID + } + mp3TrackID = byTitle["Come Together"] + Expect(mp3TrackID).ToNot(BeEmpty()) + flacTrackID = byTitle["TC FLAC Standard"] + Expect(flacTrackID).ToNot(BeEmpty()) + flacMultichTrackID = byTitle["TC FLAC Multichannel"] + Expect(flacMultichTrackID).ToNot(BeEmpty()) + }) + + Describe("raw / direct play", func() { + It("streams raw when no format or maxBitRate is specified", func() { + w := doRawReq("stream", "id", flacTrackID) + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams raw when format=raw is explicitly requested", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "raw") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams raw when maxBitRate is >= source bitrate", func() { + w := doRawReq("stream", "id", flacTrackID, "maxBitRate", "1000") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams raw when format matches source and bitrate is not lower", func() { + w := doRawReq("stream", "id", mp3TrackID, "format", "mp3", "maxBitRate", "320") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("raw")) + }) + }) + + Describe("transcoding with explicit format", func() { + It("transcodes to mp3 when format=mp3 is requested", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "mp3") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + // Should use the mp3 default bitrate (192kbps) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(192)) + }) + + It("transcodes to opus when format=opus is requested (no maxBitRate)", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + // Should use the opus default bitrate (128kbps) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("transcodes to opus with specified maxBitRate", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus", "maxBitRate", "192") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(192)) + }) + + It("transcodes to mp3 with specified maxBitRate", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "mp3", "maxBitRate", "128") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("transcodes MP3 to opus when format=opus is requested", func() { + w := doRawReq("stream", "id", mp3TrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + }) + + It("transcodes same format when maxBitRate is lower than source", func() { + w := doRawReq("stream", "id", mp3TrackID, "format", "mp3", "maxBitRate", "128") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(128)) + }) + + It("clamps multichannel FLAC to 2 channels when transcoding to mp3 (#5336)", func() { + w := doRawReq("stream", "id", flacMultichTrackID, "format", "mp3", "maxBitRate", "256") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + Expect(streamerSpy.LastRequest.Channels).To(Equal(2)) + }) + }) + + Describe("downsampling with maxBitRate only", func() { + It("transcodes using default downsampling format when maxBitRate < source bitrate", func() { + conf.Server.DefaultDownsamplingFormat = "opus" + w := doRawReq("stream", "id", flacTrackID, "maxBitRate", "192") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("opus")) + Expect(streamerSpy.LastRequest.BitRate).To(Equal(192)) + }) + + It("streams raw when maxBitRate >= source bitrate (no downsampling needed)", func() { + conf.Server.DefaultDownsamplingFormat = "opus" + w := doRawReq("stream", "id", mp3TrackID, "maxBitRate", "320") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + }) + + Describe("timeOffset", func() { + It("passes timeOffset to the stream request", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "mp3", "timeOffset", "30") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Offset).To(Equal(30)) + }) + }) + + Describe("stream creation failure", func() { + BeforeEach(func() { + streamerSpy.SimulateError = errors.New("ffmpeg exited with non-zero status code: 1: Unknown encoder 'libopus'") + }) + AfterEach(func() { + streamerSpy.SimulateError = nil + }) + + It("returns a Subsonic error for stream endpoint", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) // Subsonic errors are returned as 200 + + var wrapper responses.JsonWrapper + Expect(json.Unmarshal(w.Body.Bytes(), &wrapper)).To(Succeed()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + Expect(wrapper.Subsonic.Error).ToNot(BeNil()) + }) + + It("returns a Subsonic error for download endpoint", func() { + conf.Server.EnableDownloads = true + w := doRawReq("download", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + + var wrapper responses.JsonWrapper + Expect(json.Unmarshal(w.Body.Bytes(), &wrapper)).To(Succeed()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + Expect(wrapper.Subsonic.Error).ToNot(BeNil()) + }) + }) + + Describe("empty transcoded output", func() { + BeforeEach(func() { + streamerSpy.SimulateEmptyStream = true + }) + AfterEach(func() { + streamerSpy.SimulateEmptyStream = false + }) + + It("returns 200 with empty body for stream endpoint", func() { + w := doRawReq("stream", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Body.Len()).To(Equal(0)) + }) + + It("returns 200 with empty body for download endpoint", func() { + conf.Server.EnableDownloads = true + w := doRawReq("download", "id", flacTrackID, "format", "opus") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Body.Len()).To(Equal(0)) + }) + }) +}) diff --git a/server/e2e/subsonic_system_test.go b/server/e2e/subsonic_system_test.go new file mode 100644 index 000000000..16078f702 --- /dev/null +++ b/server/e2e/subsonic_system_test.go @@ -0,0 +1,74 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("System Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + Describe("ping", func() { + It("returns a successful response", func() { + resp := doReq("ping") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + }) + + Describe("getLicense", func() { + It("returns a valid license", func() { + resp := doReq("getLicense") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.License).ToNot(BeNil()) + Expect(resp.License.Valid).To(BeTrue()) + }) + }) + + Describe("getOpenSubsonicExtensions", func() { + It("returns a list of supported extensions", func() { + resp := doReq("getOpenSubsonicExtensions") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.OpenSubsonicExtensions).ToNot(BeNil()) + Expect(*resp.OpenSubsonicExtensions).ToNot(BeEmpty()) + }) + + It("includes the transcodeOffset extension", func() { + resp := doReq("getOpenSubsonicExtensions") + + extensions := *resp.OpenSubsonicExtensions + var names []string + for _, ext := range extensions { + names = append(names, ext.Name) + } + Expect(names).To(ContainElement("transcodeOffset")) + }) + + It("includes the formPost extension", func() { + resp := doReq("getOpenSubsonicExtensions") + + extensions := *resp.OpenSubsonicExtensions + var names []string + for _, ext := range extensions { + names = append(names, ext.Name) + } + Expect(names).To(ContainElement("formPost")) + }) + + It("includes the songLyrics extension", func() { + resp := doReq("getOpenSubsonicExtensions") + + extensions := *resp.OpenSubsonicExtensions + var names []string + for _, ext := range extensions { + names = append(names, ext.Name) + } + Expect(names).To(ContainElement("songLyrics")) + }) + }) +}) diff --git a/server/e2e/subsonic_transcode_test.go b/server/e2e/subsonic_transcode_test.go new file mode 100644 index 000000000..ae3d6208c --- /dev/null +++ b/server/e2e/subsonic_transcode_test.go @@ -0,0 +1,641 @@ +package e2e + +import ( + "errors" + "net/http" + "time" + + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +// Client profile JSON bodies for getTranscodeDecision requests. +// All bitrate values are in bps (per OpenSubsonic spec). +const ( + // mp3OnlyClient can direct-play mp3 and transcode to mp3 + mp3OnlyClient = `{ + "name": "test-mp3-only", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // flacAndMp3Client can direct-play flac and mp3, transcode to mp3 + flacAndMp3Client = `{ + "name": "test-flac-mp3", + "directPlayProfiles": [ + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]}, + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // universalClient can direct-play most formats + universalClient = `{ + "name": "test-universal", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]}, + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]}, + {"containers": ["m4a"], "audioCodecs": ["alac", "aac"], "protocols": ["http"]}, + {"containers": ["opus", "ogg"], "audioCodecs": ["opus"], "protocols": ["http"]}, + {"containers": ["wav"], "audioCodecs": ["pcm"], "protocols": ["http"]}, + {"containers": ["dsf"], "audioCodecs": ["dsd"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // bitrateCapClient has maxAudioBitrate set to 320000 bps (320 kbps) + bitrateCapClient = `{ + "name": "test-bitrate-cap", + "maxAudioBitrate": 320000, + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]}, + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // opusTranscodeClient can direct-play mp3, transcode to opus + opusTranscodeClient = `{ + "name": "test-opus-transcode", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "opus", "audioCodec": "opus", "protocol": "http"} + ] + }` + + // flacOnlyClient can direct-play flac, transcode to flac (no mp3 support at all) + flacOnlyClient = `{ + "name": "test-flac-only", + "directPlayProfiles": [ + {"containers": ["flac"], "audioCodecs": ["flac"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "flac", "audioCodec": "flac", "protocol": "http"} + ] + }` + + // maxTranscodeBitrateClient has maxTranscodingAudioBitrate set + maxTranscodeBitrateClient = `{ + "name": "test-max-transcode-bitrate", + "maxTranscodingAudioBitrate": 192000, + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"} + ] + }` + + // dsdToFlacClient can direct-play mp3, transcode to flac + dsdToFlacClient = `{ + "name": "test-dsd-to-flac", + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "transcodingProfiles": [ + {"container": "flac", "audioCodec": "flac", "protocol": "http"} + ] + }` +) + +var _ = Describe("Transcode Endpoints", Ordered, func() { + // Track IDs resolved in BeforeAll + var ( + mp3TrackID string // Come Together (mp3, 320kbps) + flacTrackID string // TC FLAC Standard (flac, 900kbps) + flacHiResTrackID string // TC FLAC HiRes (flac, 3000kbps) + flacMultichTrackID string // TC FLAC Multichannel (flac, 6ch) + alacTrackID string // TC ALAC Track (m4a, alac) + dsdTrackID string // TC DSD Track (dsf, dsd) + opusTrackID string // TC Opus Track (opus, 128kbps) + mkaOpusTrackID string // TC MKA Opus (mka, opus via codec tag) + ) + + BeforeAll(func() { + setupTestDB() + + songs, err := ds.MediaFile(ctx).GetAll() + Expect(err).ToNot(HaveOccurred()) + byTitle := map[string]string{} + for _, s := range songs { + byTitle[s.Title] = s.ID + } + ensureGetTrackID := func(title string) string { + id := byTitle[title] + Expect(id).ToNot(BeEmpty()) + return id + } + mp3TrackID = ensureGetTrackID("Come Together") + flacTrackID = ensureGetTrackID("TC FLAC Standard") + flacHiResTrackID = ensureGetTrackID("TC FLAC HiRes") + flacMultichTrackID = ensureGetTrackID("TC FLAC Multichannel") + alacTrackID = ensureGetTrackID("TC ALAC Track") + dsdTrackID = ensureGetTrackID("TC DSD Track") + opusTrackID = ensureGetTrackID("TC Opus Track") + mkaOpusTrackID = ensureGetTrackID("TC MKA Opus") + }) + + Describe("getTranscodeDecision", func() { + // setPlayerMaxBitRate ensures a player exists for the test-client and sets its MaxBitRate. + // It makes a dummy request to register the player, then updates it via the repository. + setPlayerMaxBitRate := func(maxBitRate int) { + doReq("ping") + player, err := ds.Player(ctx).FindMatch(adminUser.ID, "test-client", "") + Expect(err).ToNot(HaveOccurred()) + player.MaxBitRate = maxBitRate + Expect(ds.Player(ctx).Put(player)).To(Succeed()) + } + + AfterEach(func() { + // Reset player MaxBitRate to 0 after each test + player, err := ds.Player(ctx).FindMatch(adminUser.ID, "test-client", "") + if err == nil { + player.MaxBitRate = 0 + _ = ds.Player(ctx).Put(player) + } + }) + + Describe("error cases", func() { + It("returns 405 for GET request", func() { + w := doRawReq("getTranscodeDecision", "mediaId", mp3TrackID, "mediaType", "song") + Expect(w.Code).To(Equal(http.StatusMethodNotAllowed)) + }) + + It("returns error when mediaId is missing", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorMissingParameter)) + }) + + It("returns error when mediaType is missing", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorMissingParameter)) + }) + + It("returns error for unsupported mediaType", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "video") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorGeneric)) + }) + + It("returns error for invalid JSON body", func() { + resp := doPostReq("getTranscodeDecision", "{invalid-json", "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for empty JSON body", func() { + w := doRawPostReq("getTranscodeDecision", "", "mediaId", mp3TrackID, "mediaType", "song") + Expect(w.Code).To(Equal(http.StatusOK)) // Subsonic errors are returned as 200 with error status + resp := parseJSONResponse(w) + Expect(resp.Status).To(Equal(responses.StatusFailed)) + }) + + It("returns error for non-existent media ID", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", "non-existent-id", "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + Expect(resp.Error.Code).To(Equal(responses.ErrorDataNotFound)) + }) + + It("returns error for invalid protocol in body", func() { + invalidBody := `{ + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["invalid-protocol"]} + ] + }` + resp := doPostReq("getTranscodeDecision", invalidBody, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("returns error for invalid comparison operator in body", func() { + invalidBody := `{ + "directPlayProfiles": [ + {"containers": ["mp3"], "audioCodecs": ["mp3"], "protocols": ["http"]} + ], + "codecProfiles": [{ + "type": "AudioCodec", "name": "mp3", + "limitations": [{"name": "audioBitrate", "comparison": "InvalidOp", "values": ["320000"]}] + }] + }` + resp := doPostReq("getTranscodeDecision", invalidBody, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + }) + + Describe("direct play decisions", func() { + It("allows MP3 direct play when client supports mp3", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).To(BeNil()) + Expect(resp.TranscodeDecision.TranscodeParams).ToNot(BeEmpty()) + }) + + It("allows FLAC direct play when client supports flac", func() { + resp := doPostReq("getTranscodeDecision", flacAndMp3Client, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("allows ALAC direct play via m4a container + alac codec matching", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", alacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("allows Opus direct play when client supports opus", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", opusTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("denies direct play when container mismatches", func() { + // mp3OnlyClient cannot play FLAC container + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + }) + + It("denies direct play when codec mismatches", func() { + // MKA container with opus codec — client only supports mp3 + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mkaOpusTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + }) + + It("denies direct play when maxAudioBitrate exceeded", func() { + // bitrateCapClient caps at 320kbps, FLAC is 900kbps + resp := doPostReq("getTranscodeDecision", bitrateCapClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + }) + }) + + Describe("transcode decisions", func() { + It("transcodes FLAC to MP3 when client only supports MP3", func() { + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Container).To(Equal("mp3")) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("mp3")) + Expect(resp.TranscodeDecision.TranscodeParams).ToNot(BeEmpty()) + }) + + It("transcodes FLAC hi-res to Opus with correct sample rate", func() { + resp := doPostReq("getTranscodeDecision", opusTranscodeClient, "mediaId", flacHiResTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("opus")) + // Opus always outputs 48000 Hz + Expect(resp.TranscodeDecision.TranscodeStream.AudioSamplerate).To(Equal(int32(48000))) + }) + + It("transcodes DSD to FLAC with normalized sample rate and bit depth", func() { + resp := doPostReq("getTranscodeDecision", dsdToFlacClient, "mediaId", dsdTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("flac")) + // DSD sample rate normalized: 2822400 / 8 = 352800 + Expect(resp.TranscodeDecision.TranscodeStream.AudioSamplerate).To(Equal(int32(352800))) + // DSD 1-bit → 24-bit PCM + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitdepth).To(Equal(int32(24))) + }) + + It("refuses lossy to lossless transcoding: MP3 to FLAC", func() { + // flacOnlyClient can't direct-play mp3, and lossy→lossless transcode is rejected + resp := doPostReq("getTranscodeDecision", flacOnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + // MP3 is lossy, FLAC is lossless — should not allow transcoding + Expect(resp.TranscodeDecision.CanTranscode).To(BeFalse()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeFalse()) + Expect(resp.TranscodeDecision.TranscodeParams).To(BeEmpty()) + }) + + It("caps transcode bitrate via maxTranscodingAudioBitrate", func() { + resp := doPostReq("getTranscodeDecision", maxTranscodeBitrateClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxTranscodingAudioBitrate is 192000 bps = 192 kbps → response in bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + + It("clamps multichannel FLAC to 2 channels when transcoding to MP3 (#5336)", func() { + // mp3OnlyClient has no MaxAudioChannels set, so this exercises the + // codec-intrinsic clamp in core/stream/codec.go (codecMaxChannels). + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacMultichTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.SourceStream.AudioChannels).To(Equal(int32(6))) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("mp3")) + Expect(resp.TranscodeDecision.TranscodeStream.AudioChannels).To(Equal(int32(2))) + }) + }) + + Describe("response structure", func() { + It("has correct sourceStream details", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + src := resp.TranscodeDecision.SourceStream + Expect(src).ToNot(BeNil()) + Expect(src.Container).To(Equal("flac")) + Expect(src.Codec).To(Equal("flac")) + // AudioBitrate is in bps: 900 kbps * 1000 = 900000 bps + Expect(src.AudioBitrate).To(Equal(int32(900000))) + Expect(src.AudioSamplerate).To(Equal(int32(44100))) + Expect(src.AudioChannels).To(Equal(int32(2))) + Expect(src.Protocol).To(Equal("http")) + }) + + It("reports audioBitrate in bps (kbps * 1000)", func() { + resp := doPostReq("getTranscodeDecision", universalClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + src := resp.TranscodeDecision.SourceStream + Expect(src).ToNot(BeNil()) + // MP3 is 320 kbps → 320000 bps + Expect(src.AudioBitrate).To(Equal(int32(320000))) + }) + }) + + Describe("player MaxBitRate cap is ignored", func() { + It("allows direct play even when source bitrate exceeds player MaxBitRate", func() { + setPlayerMaxBitRate(320) // 320 kbps cap + + // FLAC is 900kbps, player cap is 320, but getTranscodeDecision + // ignores server-side overrides — client profiles are used as-is + resp := doPostReq("getTranscodeDecision", flacAndMp3Client, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + }) + + It("uses only client limit, not player MaxBitRate", func() { + setPlayerMaxBitRate(192) // 192 kbps player cap + + // Client caps at 320kbps (bitrateCapClient), player is more restrictive at 192 + // but getTranscodeDecision ignores player cap → client limit (320kbps) applies + resp := doPostReq("getTranscodeDecision", bitrateCapClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // Only client limit (320kbps) applies → 320000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(320000))) + }) + }) + + Describe("format-aware default bitrate", func() { + It("uses mp3 format default (192kbps) for lossless-to-mp3 with no bitrate limits", func() { + // mp3OnlyClient has no maxAudioBitrate or maxTranscodingAudioBitrate + // FLAC → MP3 should use the mp3 default bitrate (192kbps), not hardcoded 256 + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Container).To(Equal("mp3")) + // mp3 default is 192kbps = 192000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + + It("uses opus format default (128kbps) for lossless-to-opus with no bitrate limits", func() { + // opusTranscodeClient has no maxAudioBitrate or maxTranscodingAudioBitrate + // FLAC → Opus should use the opus default bitrate (128kbps) + resp := doPostReq("getTranscodeDecision", opusTranscodeClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("opus")) + // opus default is 128kbps = 128000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(128000))) + }) + + It("uses maxAudioBitrate as fallback for lossless-to-lossy when no maxTranscodingAudioBitrate", func() { + // bitrateCapClient has maxAudioBitrate=320000 but no maxTranscodingAudioBitrate + // FLAC → MP3: maxAudioBitrate (320kbps) should be used as the target + resp := doPostReq("getTranscodeDecision", bitrateCapClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxAudioBitrate is 320kbps = 320000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(320000))) + }) + + It("prefers maxTranscodingAudioBitrate over maxAudioBitrate for lossless-to-lossy", func() { + // maxTranscodeBitrateClient has maxTranscodingAudioBitrate=192000 + // FLAC → MP3: should use 192kbps, not format default or maxAudioBitrate + resp := doPostReq("getTranscodeDecision", maxTranscodeBitrateClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxTranscodingAudioBitrate is 192kbps = 192000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + }) + + Describe("player MaxBitRate is ignored by getTranscodeDecision", func() { + It("does not inject maxAudioBitrate from player cap", func() { + setPlayerMaxBitRate(320) + + // opusTranscodeClient has no client bitrate limits + // Player cap is 320, but getTranscodeDecision ignores it + // FLAC (900kbps) → can't direct play → transcode to opus using format default + resp := doPostReq("getTranscodeDecision", opusTranscodeClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Codec).To(Equal("opus")) + // Bitrate should be opus format default (128kbps), not player cap (320kbps) + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(128000))) + }) + + It("uses only client maxTranscodingAudioBitrate, ignoring player cap", func() { + setPlayerMaxBitRate(320) + + // maxTranscodeBitrateClient: maxTranscodingAudioBitrate=192000 (192kbps) + // Player cap is 320, but getTranscodeDecision ignores it + // Only client maxTranscodingAudioBitrate=192 applies + resp := doPostReq("getTranscodeDecision", maxTranscodeBitrateClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + // maxTranscodingAudioBitrate=192 → 192000 bps + Expect(resp.TranscodeDecision.TranscodeStream.AudioBitrate).To(Equal(int32(192000))) + }) + }) + }) + + Describe("getTranscodeStream", func() { + Describe("error cases", func() { + It("returns 400 when mediaId is missing", func() { + w := doRawReq("getTranscodeStream", "mediaType", "song", "transcodeParams", "some-token") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 when mediaType is missing", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "transcodeParams", "some-token") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 when transcodeParams is missing", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 for unsupported mediaType", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "video", "transcodeParams", "some-token") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 410 for malformed token", func() { + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", "transcodeParams", "invalid-token") + Expect(w.Code).To(Equal(http.StatusGone)) + }) + + It("returns 410 for stale token (media file updated after token issued)", func() { + // Get a valid decision token + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Save original UpdatedAt and restore after test + mf, err := ds.MediaFile(ctx).Get(mp3TrackID) + Expect(err).ToNot(HaveOccurred()) + originalUpdatedAt := mf.UpdatedAt + + // Update the media file's UpdatedAt to simulate a change after token issuance + mf.UpdatedAt = time.Now().Add(time.Hour) + Expect(ds.MediaFile(ctx).Put(mf)).To(Succeed()) + + // Attempt to stream with the now-stale token + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusGone)) + + // Restore original UpdatedAt + mf.UpdatedAt = originalUpdatedAt + Expect(ds.MediaFile(ctx).Put(mf)).To(Succeed()) + }) + + It("returns 500 when stream creation fails", func() { + // Get a valid decision token + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Simulate streamer failure (e.g., ffmpeg missing codec) + streamerSpy.SimulateError = errors.New("ffmpeg exited with non-zero status code: 1: Unknown encoder 'libopus'") + defer func() { streamerSpy.SimulateError = nil }() + + w := doRawReq("getTranscodeStream", "mediaId", flacTrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + + It("returns 500 when transcoded stream is empty", func() { + // Get a valid decision token + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Simulate ffmpeg producing 0 bytes + streamerSpy.SimulateEmptyStream = true + defer func() { streamerSpy.SimulateEmptyStream = false }() + + w := doRawReq("getTranscodeStream", "mediaId", flacTrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Describe("round-trip: decision then stream", func() { + It("streams direct play for MP3", func() { + // Get decision + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Stream using the token + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusOK)) + // Direct play: format should be "raw" or empty + Expect(streamerSpy.LastRequest.Format).To(BeElementOf("raw", "")) + }) + + It("streams transcoded FLAC to MP3", func() { + // Get decision + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", flacTrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Stream using the token + w := doRawReq("getTranscodeStream", "mediaId", flacTrackID, "mediaType", "song", "transcodeParams", token) + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Format).To(Equal("mp3")) + }) + + It("passes offset through to stream request", func() { + // Get decision + resp := doPostReq("getTranscodeDecision", mp3OnlyClient, "mediaId", mp3TrackID, "mediaType", "song") + Expect(resp.Status).To(Equal(responses.StatusOK)) + token := resp.TranscodeDecision.TranscodeParams + Expect(token).ToNot(BeEmpty()) + + // Stream with offset + w := doRawReq("getTranscodeStream", "mediaId", mp3TrackID, "mediaType", "song", + "transcodeParams", token, "offset", "30") + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(streamerSpy.LastRequest.Offset).To(Equal(30)) + }) + }) + }) +}) diff --git a/server/e2e/subsonic_users_test.go b/server/e2e/subsonic_users_test.go new file mode 100644 index 000000000..849089f11 --- /dev/null +++ b/server/e2e/subsonic_users_test.go @@ -0,0 +1,49 @@ +package e2e + +import ( + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("User Endpoints", func() { + BeforeEach(func() { + setupTestDB() + }) + + It("getUser returns current user info", func() { + resp := doReq("getUser", "username", adminUser.UserName) + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.User).ToNot(BeNil()) + Expect(resp.User.Username).To(Equal(adminUser.UserName)) + Expect(resp.User.AdminRole).To(BeTrue()) + Expect(resp.User.StreamRole).To(BeTrue()) + Expect(resp.User.Folder).ToNot(BeEmpty()) + }) + + It("getUser with matching username case-insensitive succeeds", func() { + resp := doReq("getUser", "username", "Admin") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.User).ToNot(BeNil()) + Expect(resp.User.Username).To(Equal(adminUser.UserName)) + }) + + It("getUser with different username returns authorization error", func() { + resp := doReq("getUser", "username", "otheruser") + + Expect(resp.Status).To(Equal(responses.StatusFailed)) + Expect(resp.Error).ToNot(BeNil()) + }) + + It("getUsers returns list with current user only", func() { + resp := doReq("getUsers") + + Expect(resp.Status).To(Equal(responses.StatusOK)) + Expect(resp.Users).ToNot(BeNil()) + Expect(resp.Users.User).To(HaveLen(1)) + Expect(resp.Users.User[0].Username).To(Equal(adminUser.UserName)) + Expect(resp.Users.User[0].AdminRole).To(BeTrue()) + }) +}) diff --git a/server/events/events.go b/server/events/events.go index 73ff8eb5e..ff0a8a40a 100644 --- a/server/events/events.go +++ b/server/events/events.go @@ -13,8 +13,8 @@ type eventCtxKey string const broadcastToAllKey eventCtxKey = "broadcastToAll" -// BroadcastToAll is a context key that can be used to broadcast an event to all clients -func BroadcastToAll(ctx context.Context) context.Context { +// broadcastToAll is a context key that can be used to broadcast an event to all clients +func broadcastToAll(ctx context.Context) context.Context { return context.WithValue(ctx, broadcastToAllKey, true) } @@ -63,6 +63,11 @@ type RefreshResource struct { resources map[string][]string } +type NowPlayingCount struct { + baseEvent + Count int `json:"count"` +} + func (rr *RefreshResource) With(resource string, ids ...string) *RefreshResource { if rr.resources == nil { rr.resources = make(map[string][]string) diff --git a/server/events/sse.go b/server/events/sse.go index 690c79937..565d8c016 100644 --- a/server/events/sse.go +++ b/server/events/sse.go @@ -19,12 +19,14 @@ import ( type Broker interface { http.Handler SendMessage(ctx context.Context, event Event) + SendBroadcastMessage(ctx context.Context, event Event) } const ( keepAliveFrequency = 15 * time.Second - writeTimeOut = 5 * time.Second - bufferSize = 1 + // The timeout must be higher than the keepAliveFrequency, or the lack of activity will cause the channel to close. + writeTimeOut = keepAliveFrequency + 5*time.Second + bufferSize = 1 ) type ( @@ -77,6 +79,11 @@ func GetBroker() Broker { }) } +func (b *broker) SendBroadcastMessage(ctx context.Context, evt Event) { + ctx = broadcastToAll(ctx) + b.SendMessage(ctx, evt) +} + func (b *broker) SendMessage(ctx context.Context, evt Event) { msg := b.prepareMessage(ctx, evt) log.Trace("Broker received new event", "type", msg.event, "data", msg.data) @@ -98,7 +105,7 @@ func writeEvent(ctx context.Context, w io.Writer, event message, timeout time.Du log.Debug(ctx, "Error setting write timeout", err) } - _, err := fmt.Fprintf(w, "id: %d\nevent: %s\ndata: %s\n\n", event.id, event.event, event.data) + _, err := fmt.Fprintf(w, "id: %d\nevent: %s\ndata: %s\n\n", event.id, event.event, event.data) //nolint:gosec if err != nil { return err } @@ -280,4 +287,6 @@ type noopBroker struct { http.Handler } +func (b noopBroker) SendBroadcastMessage(context.Context, Event) {} + func (noopBroker) SendMessage(context.Context, Event) {} diff --git a/server/initial_setup.go b/server/initial_setup.go index ebfdad47a..7e974dc21 100644 --- a/server/initial_setup.go +++ b/server/initial_setup.go @@ -68,13 +68,16 @@ func createInitialAdminUser(ds model.DataStore, initialPassword string) error { func checkFFmpegInstallation() { f := ffmpeg.New() _, err := f.CmdPath() - if err == nil { + if err != nil { + log.Warn("Unable to find ffmpeg. Transcoding will fail if used", err) + if conf.Server.Scanner.Extractor == "ffmpeg" { + log.Warn("ffmpeg cannot be used for metadata extraction. Falling back to taglib") + conf.Server.Scanner.Extractor = "taglib" + } return } - log.Warn("Unable to find ffmpeg. Transcoding will fail if used", err) - if conf.Server.Scanner.Extractor == "ffmpeg" { - log.Warn("ffmpeg cannot be used for metadata extraction. Falling back to taglib") - conf.Server.Scanner.Extractor = "taglib" + if !f.IsProbeAvailable() { + log.Warn("Unable to find ffprobe. Transcoding decisions will be limited") } } @@ -91,11 +94,5 @@ func checkExternalCredentials() { } else { log.Debug("ListenBrainz integration is ENABLED", "ListenBrainz.BaseURL", conf.Server.ListenBrainz.BaseURL) } - - if conf.Server.Spotify.ID == "" || conf.Server.Spotify.Secret == "" { - log.Info("Spotify integration is not enabled: missing ID/Secret") - } else { - log.Debug("Spotify integration is ENABLED") - } } } diff --git a/server/middlewares.go b/server/middlewares.go index 2afe09a5a..5d6a1e59c 100644 --- a/server/middlewares.go +++ b/server/middlewares.go @@ -37,7 +37,7 @@ func requestLogger(next http.Handler) http.Handler { status := ww.Status() message := fmt.Sprintf("HTTP: %s %s://%s%s", r.Method, scheme, r.Host, r.RequestURI) - logArgs := []interface{}{ + logArgs := []any{ r.Context(), message, "remoteAddr", r.RemoteAddr, @@ -107,7 +107,7 @@ func secureMiddleware() func(http.Handler) http.Handler { FrameDeny: true, ReferrerPolicy: "same-origin", PermissionsPolicy: "autoplay=(), camera=(), microphone=(), usb=()", - CustomFrameOptionsValue: conf.Server.HTTPSecurityHeaders.CustomFrameOptionsValue, + CustomFrameOptionsValue: conf.Server.HTTPHeaders.FrameOptions, //ContentSecurityPolicy: "script-src 'self' 'unsafe-inline'", }) return sec.Handler @@ -168,7 +168,7 @@ func clientUniqueIDMiddleware(next http.Handler) http.Handler { // realIPMiddleware applies middleware.RealIP, and additionally saves the request's original RemoteAddr to the request's // context if navidrome is behind a trusted reverse proxy. func realIPMiddleware(next http.Handler) http.Handler { - if conf.Server.ReverseProxyWhitelist != "" { + if conf.Server.ExtAuth.TrustedSources != "" { return chi.Chain( reqToCtx(request.ReverseProxyIp, func(r *http.Request) any { return r.RemoteAddr }), middleware.RealIP, diff --git a/server/nativeapi/artists.go b/server/nativeapi/artists.go new file mode 100644 index 000000000..daa918d00 --- /dev/null +++ b/server/nativeapi/artists.go @@ -0,0 +1,70 @@ +package nativeapi + +import ( + "context" + "errors" + "io" + "net/http" + "time" + + "github.com/deluan/rest" + "github.com/go-chi/chi/v5" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" +) + +func (api *Router) addArtistRoute(r chi.Router) { + constructor := func(ctx context.Context) rest.Repository { + return api.ds.Resource(ctx, model.Artist{}) + } + r.Route("/artist", func(r chi.Router) { + r.Get("/", rest.GetAll(constructor)) + r.Route("/{id}", func(r chi.Router) { + r.Use(server.URLParamsMiddleware) + r.Get("/", rest.Get(constructor)) + r.Post("/image", api.uploadArtistImage()) + r.Delete("/image", api.deleteArtistImage()) + }) + }) +} + +func (api *Router) uploadArtistImage() http.HandlerFunc { + return handleImageUpload(func(ctx context.Context, reader io.Reader, ext string) error { + artistID := chi.URLParamFromCtx(ctx, "id") + ar, err := api.ds.Artist(ctx).Get(artistID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + oldPath := ar.UploadedImagePath() + filename, err := api.imgUpload.SetImage(ctx, consts.EntityArtist, ar.ID, ar.Name, oldPath, reader, ext) + if err != nil { + return err + } + ar.UploadedImage = filename + ar.UpdatedAt = new(time.Now()) + return api.ds.Artist(ctx).Put(ar, "uploaded_image", "updated_at") + }) +} + +func (api *Router) deleteArtistImage() http.HandlerFunc { + return handleImageDelete(func(ctx context.Context) error { + artistID := chi.URLParamFromCtx(ctx, "id") + ar, err := api.ds.Artist(ctx).Get(artistID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + if err := api.imgUpload.RemoveImage(ctx, ar.UploadedImagePath()); err != nil { + return err + } + ar.UploadedImage = "" + ar.UpdatedAt = new(time.Now()) + return api.ds.Artist(ctx).Put(ar, "uploaded_image", "updated_at") + }) +} diff --git a/server/nativeapi/config.go b/server/nativeapi/config.go new file mode 100644 index 000000000..cfecfa663 --- /dev/null +++ b/server/nativeapi/config.go @@ -0,0 +1,129 @@ +package nativeapi + +import ( + "context" + "encoding/json" + "fmt" + "net/http" + "slices" + "strings" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" +) + +// sensitiveFieldsPartialMask contains configuration field names that should be redacted +// using partial masking (first and last character visible, middle replaced with *). +// For values with 7+ characters: "secretvalue123" becomes "s***********3" +// For values with <7 characters: "short" becomes "****" +// Add field paths using dot notation (e.g., "LastFM.ApiKey") +var sensitiveFieldsPartialMask = []string{ + "LastFM.ApiKey", + "LastFM.Secret", + "Prometheus.MetricsPath", + "DevAutoLoginUsername", +} + +// sensitiveFieldsFullMask contains configuration field names that should always be +// completely masked with "****" regardless of their length. +// Add field paths using dot notation for any fields that should never show any content. +var sensitiveFieldsFullMask = []string{ + "DevAutoCreateAdminPassword", + "PasswordEncryptionKey", + "Prometheus.Password", +} + +type configResponse struct { + ID string `json:"id"` + ConfigFile string `json:"configFile"` + Config map[string]any `json:"config"` +} + +func redactValue(key string, value string) string { + // Return empty values as-is + if len(value) == 0 { + return value + } + + // Check if this field should be fully masked + if slices.Contains(sensitiveFieldsFullMask, key) { + return "****" + } + + // Check if this field should be partially masked + for _, field := range sensitiveFieldsPartialMask { + if field == key { + if len(value) < 7 { + return "****" + } + // Show first and last character with * in between + return string(value[0]) + strings.Repeat("*", len(value)-2) + string(value[len(value)-1]) + } + } + + // Return original value if not sensitive + return value +} + +// applySensitiveFieldMasking recursively applies masking to sensitive fields in the configuration map +func applySensitiveFieldMasking(ctx context.Context, config map[string]any, prefix string) { + for key, value := range config { + fullKey := key + if prefix != "" { + fullKey = prefix + "." + key + } + + switch v := value.(type) { + case map[string]any: + // Recursively process nested maps + applySensitiveFieldMasking(ctx, v, fullKey) + case string: + // Apply masking to string values + config[key] = redactValue(fullKey, v) + default: + // For other types (numbers, booleans, etc.), convert to string and check for masking + if str := fmt.Sprint(v); str != "" { + masked := redactValue(fullKey, str) + if masked != str { + // Only replace if masking was applied + config[key] = masked + } + } + } + } +} + +func getConfig(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + // Marshal the actual configuration struct to preserve original field names + configBytes, err := json.Marshal(conf.Server) + if err != nil { + log.Error(ctx, "Error marshaling config", err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + // Unmarshal back to map to get the structure with proper field names + var configMap map[string]any + err = json.Unmarshal(configBytes, &configMap) + if err != nil { + log.Error(ctx, "Error unmarshaling config to map", err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + // Apply sensitive field masking + applySensitiveFieldMasking(ctx, configMap, "") + + resp := configResponse{ + ID: "config", + ConfigFile: conf.Server.ConfigFile, + Config: configMap, + } + + w.Header().Set("Content-Type", "application/json") + if err := json.NewEncoder(w).Encode(resp); err != nil { + log.Error(ctx, "Error encoding config response", err) + } +} diff --git a/server/nativeapi/config_test.go b/server/nativeapi/config_test.go new file mode 100644 index 000000000..4e6e9e89b --- /dev/null +++ b/server/nativeapi/config_test.go @@ -0,0 +1,218 @@ +package nativeapi + +import ( + "bytes" + "context" + "encoding/json" + "net/http" + "net/http/httptest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Config API", func() { + var ds model.DataStore + var router http.Handler + var adminUser, regularUser model.User + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DevUIShowConfig = true // Enable config endpoint for tests + ds = &tests.MockDataStore{} + auth.Init(ds) + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) + router = server.JWTVerifier(nativeRouter) + + // Create test users + adminUser = model.User{ + ID: "admin-1", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "adminpass", + } + regularUser = model.User{ + ID: "user-1", + UserName: "regular", + Name: "Regular User", + IsAdmin: false, + NewPassword: "userpass", + } + + // Store in mock datastore + Expect(ds.User(context.TODO()).Put(&adminUser)).To(Succeed()) + Expect(ds.User(context.TODO()).Put(®ularUser)).To(Succeed()) + }) + + Describe("GET /api/config", func() { + Context("as admin user", func() { + var adminToken string + + BeforeEach(func() { + var err error + adminToken, err = auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + }) + + It("returns config successfully", func() { + req := createAuthenticatedConfigRequest(adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + var resp configResponse + Expect(json.Unmarshal(w.Body.Bytes(), &resp)).To(Succeed()) + Expect(resp.ID).To(Equal("config")) + Expect(resp.ConfigFile).To(Equal(conf.Server.ConfigFile)) + Expect(resp.Config).ToNot(BeEmpty()) + }) + + It("redacts sensitive fields", func() { + conf.Server.LastFM.ApiKey = "secretapikey123" + conf.Server.PasswordEncryptionKey = "encryptionkey789" + conf.Server.DevAutoCreateAdminPassword = "adminpassword123" + conf.Server.Prometheus.Password = "prometheuspass" + + req := createAuthenticatedConfigRequest(adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + var resp configResponse + Expect(json.Unmarshal(w.Body.Bytes(), &resp)).To(Succeed()) + + // Check LastFM.ApiKey (partially masked) + lastfm, ok := resp.Config["LastFM"].(map[string]any) + Expect(ok).To(BeTrue()) + Expect(lastfm["ApiKey"]).To(Equal("s*************3")) + + // Check PasswordEncryptionKey (fully masked) + Expect(resp.Config["PasswordEncryptionKey"]).To(Equal("****")) + + // Check DevAutoCreateAdminPassword (fully masked) + Expect(resp.Config["DevAutoCreateAdminPassword"]).To(Equal("****")) + + // Check Prometheus.Password (fully masked) + prometheus, ok := resp.Config["Prometheus"].(map[string]any) + Expect(ok).To(BeTrue()) + Expect(prometheus["Password"]).To(Equal("****")) + }) + + It("handles empty sensitive values", func() { + conf.Server.LastFM.ApiKey = "" + conf.Server.PasswordEncryptionKey = "" + + req := createAuthenticatedConfigRequest(adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + var resp configResponse + Expect(json.Unmarshal(w.Body.Bytes(), &resp)).To(Succeed()) + + // Check LastFM.ApiKey - should be preserved because it's sensitive + lastfm, ok := resp.Config["LastFM"].(map[string]any) + Expect(ok).To(BeTrue()) + Expect(lastfm["ApiKey"]).To(Equal("")) + + // Empty sensitive values should remain empty - should be preserved because it's sensitive + Expect(resp.Config["PasswordEncryptionKey"]).To(Equal("")) + }) + }) + + Context("as regular user", func() { + var userToken string + + BeforeEach(func() { + var err error + userToken, err = auth.CreateToken(®ularUser) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies access with forbidden status", func() { + req := createAuthenticatedConfigRequest(userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + }) + + Context("without authentication", func() { + It("denies access with unauthorized status", func() { + req := createUnauthenticatedConfigRequest("GET", "/config/", nil) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + }) + }) +}) + +var _ = Describe("redactValue function", func() { + It("partially masks long sensitive values", func() { + Expect(redactValue("LastFM.ApiKey", "ba46f0e84a")).To(Equal("b********a")) + }) + + It("fully masks long sensitive values that should be completely hidden", func() { + Expect(redactValue("PasswordEncryptionKey", "1234567890")).To(Equal("****")) + Expect(redactValue("DevAutoCreateAdminPassword", "1234567890")).To(Equal("****")) + Expect(redactValue("Prometheus.Password", "1234567890")).To(Equal("****")) + }) + + It("fully masks short sensitive values", func() { + Expect(redactValue("LastFM.Secret", "short")).To(Equal("****")) + Expect(redactValue("PasswordEncryptionKey", "12345")).To(Equal("****")) + Expect(redactValue("DevAutoCreateAdminPassword", "short")).To(Equal("****")) + Expect(redactValue("Prometheus.Password", "short")).To(Equal("****")) + }) + + It("does not mask non-sensitive values", func() { + Expect(redactValue("MusicFolder", "/path/to/music")).To(Equal("/path/to/music")) + Expect(redactValue("Port", "4533")).To(Equal("4533")) + Expect(redactValue("SomeOtherField", "secretvalue")).To(Equal("secretvalue")) + }) + + It("handles empty values", func() { + Expect(redactValue("LastFM.ApiKey", "")).To(Equal("")) + Expect(redactValue("NonSensitive", "")).To(Equal("")) + }) + + It("handles edge case values", func() { + Expect(redactValue("LastFM.ApiKey", "a")).To(Equal("****")) + Expect(redactValue("LastFM.ApiKey", "ab")).To(Equal("****")) + Expect(redactValue("LastFM.ApiKey", "abcdefg")).To(Equal("a*****g")) + }) +}) + +// Helper functions + +func createAuthenticatedConfigRequest(token string) *http.Request { + req := httptest.NewRequest(http.MethodGet, "/config/config", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+token) + req.Header.Set("Content-Type", "application/json") + return req +} + +func createUnauthenticatedConfigRequest(method, path string, body *bytes.Buffer) *http.Request { + if body == nil { + body = &bytes.Buffer{} + } + req := httptest.NewRequest(method, path, body) + req.Header.Set("Content-Type", "application/json") + return req +} diff --git a/server/nativeapi/image_upload.go b/server/nativeapi/image_upload.go new file mode 100644 index 000000000..5e2d29876 --- /dev/null +++ b/server/nativeapi/image_upload.go @@ -0,0 +1,129 @@ +package nativeapi + +import ( + "context" + "errors" + "fmt" + "image" + _ "image/gif" + _ "image/jpeg" + _ "image/png" + "io" + "net/http" + "path/filepath" + "strings" + + "github.com/dustin/go-humanize" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + _ "golang.org/x/image/webp" +) + +func maxImageUploadSize() int64 { + if size, err := humanize.ParseBytes(conf.Server.MaxImageUploadSize); err == nil && size > 0 { + return int64(size) + } + size, _ := humanize.ParseBytes(consts.DefaultMaxImageUploadSize) + return int64(size) +} + +func checkImageUploadPermission(w http.ResponseWriter, r *http.Request) bool { + user, _ := request.UserFrom(r.Context()) + if !conf.Server.EnableArtworkUpload && !user.IsAdmin { + http.Error(w, "artwork upload is disabled", http.StatusForbidden) + return false + } + return true +} + +func handleImageUpload(saveFn func(ctx context.Context, reader io.Reader, ext string) error) http.HandlerFunc { + maxImageSize := maxImageUploadSize() + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + if !checkImageUploadPermission(w, r) { + return + } + r.Body = http.MaxBytesReader(w, r.Body, maxImageSize) + if err := r.ParseMultipartForm(min(maxImageSize, 10<<20)); err != nil { + log.Error(ctx, "Error parsing multipart form", err) + http.Error(w, "file too large or invalid form", http.StatusBadRequest) + return + } + defer func() { + if r.MultipartForm != nil { + if err := r.MultipartForm.RemoveAll(); err != nil { + log.Warn(ctx, "Error removing multipart temp files", err) + } + } + }() + file, header, err := r.FormFile("image") + if err != nil { + log.Error(ctx, "Error reading uploaded file", err) + http.Error(w, "missing image file", http.StatusBadRequest) + return + } + defer file.Close() + _, format, err := image.DecodeConfig(file) + if err != nil { + log.Error(ctx, "Uploaded file is not a valid image", err) + http.Error(w, "invalid image file", http.StatusBadRequest) + return + } + if seeker, ok := file.(io.Seeker); ok { + if _, err := seeker.Seek(0, io.SeekStart); err != nil { + log.Error(ctx, "Error seeking file", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + } + ext := "." + format + if ext == "." { + ext = strings.ToLower(filepath.Ext(header.Filename)) + } + if ext == "" || ext == "." { + log.Error(ctx, "Could not determine image type", "filename", header.Filename) + http.Error(w, "could not determine image type", http.StatusBadRequest) + return + } + if err := saveFn(ctx, file, ext); err != nil { + if errors.Is(err, model.ErrNotAuthorized) { + http.Error(w, "not authorized", http.StatusForbidden) + return + } + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "not found", http.StatusNotFound) + return + } + log.Error(ctx, "Error saving image", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + _, _ = fmt.Fprintf(w, `{"status":"ok"}`) + } +} + +func handleImageDelete(deleteFn func(ctx context.Context) error) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + if !checkImageUploadPermission(w, r) { + return + } + if err := deleteFn(ctx); err != nil { + if errors.Is(err, model.ErrNotAuthorized) { + http.Error(w, "not authorized", http.StatusForbidden) + return + } + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "not found", http.StatusNotFound) + return + } + log.Error(ctx, "Error removing image", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + _, _ = fmt.Fprintf(w, `{"status":"ok"}`) + } +} diff --git a/server/nativeapi/image_upload_test.go b/server/nativeapi/image_upload_test.go new file mode 100644 index 000000000..291912e67 --- /dev/null +++ b/server/nativeapi/image_upload_test.go @@ -0,0 +1,34 @@ +package nativeapi + +import ( + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("maxImageUploadSize", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + + It("returns the configured size when valid", func() { + conf.Server.MaxImageUploadSize = "20MB" + Expect(maxImageUploadSize()).To(Equal(int64(20_000_000))) + }) + + It("returns the default size when config is empty", func() { + conf.Server.MaxImageUploadSize = "" + Expect(maxImageUploadSize()).To(Equal(int64(10_000_000))) + }) + + It("returns the default size when config is invalid", func() { + conf.Server.MaxImageUploadSize = "not-a-size" + Expect(maxImageUploadSize()).To(Equal(int64(10_000_000))) + }) + + It("parses raw byte values", func() { + conf.Server.MaxImageUploadSize = "52428800" + Expect(maxImageUploadSize()).To(Equal(int64(52_428_800))) + }) +}) diff --git a/server/nativeapi/inspect.go b/server/nativeapi/inspect.go index e74dc99c0..7c96312ed 100644 --- a/server/nativeapi/inspect.go +++ b/server/nativeapi/inspect.go @@ -9,7 +9,6 @@ import ( "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/utils/req" ) @@ -30,11 +29,6 @@ func inspect(ds model.DataStore) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { ctx := r.Context() - user, _ := request.UserFrom(ctx) - if !user.IsAdmin { - http.Error(w, "Inspect is only available to admin users", http.StatusUnauthorized) - } - p := req.Params(r) id, err := p.String("id") @@ -66,7 +60,7 @@ func inspect(ds model.DataStore) http.HandlerFunc { w.Header().Set("Content-Type", "application/json") - if _, err := w.Write(response); err != nil { + if _, err := w.Write(response); err != nil { //nolint:gosec log.Error(ctx, "Error sending response to client", err) } } diff --git a/server/nativeapi/library.go b/server/nativeapi/library.go new file mode 100644 index 000000000..1636e1dbb --- /dev/null +++ b/server/nativeapi/library.go @@ -0,0 +1,101 @@ +package nativeapi + +import ( + "context" + "encoding/json" + "errors" + "net/http" + + "github.com/go-chi/chi/v5" + "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" +) + +// User-library association endpoints (admin only) +func (api *Router) addUserLibraryRoute(r chi.Router) { + r.Route("/user/{id}/library", func(r chi.Router) { + r.Use(parseUserIDMiddleware) + r.Get("/", getUserLibraries(api.libs)) + r.Put("/", setUserLibraries(api.libs)) + }) +} + +// Middleware to parse user ID from URL +func parseUserIDMiddleware(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + userID := chi.URLParam(r, "id") + if userID == "" { + http.Error(w, "Invalid user ID", http.StatusBadRequest) + return + } + ctx := context.WithValue(r.Context(), "userID", userID) + next.ServeHTTP(w, r.WithContext(ctx)) + }) +} + +// User-library association handlers + +func getUserLibraries(service core.Library) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + userID := r.Context().Value("userID").(string) + + libraries, err := service.GetUserLibraries(r.Context(), userID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "User not found", http.StatusNotFound) + return + } + log.Error(r.Context(), "Error getting user libraries", "userID", userID, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + w.Header().Set("Content-Type", "application/json") + if err := json.NewEncoder(w).Encode(libraries); err != nil { + log.Error(r.Context(), "Error encoding user libraries response", err) + } + } +} + +func setUserLibraries(service core.Library) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + userID := r.Context().Value("userID").(string) + + var request struct { + LibraryIDs []int `json:"libraryIds"` + } + if err := json.NewDecoder(r.Body).Decode(&request); err != nil { + log.Error(r.Context(), "Error decoding request", err) + http.Error(w, "Invalid request body", http.StatusBadRequest) + return + } + + if err := service.SetUserLibraries(r.Context(), userID, request.LibraryIDs); err != nil { + log.Error(r.Context(), "Error setting user libraries", "userID", userID, err) + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "User not found", http.StatusNotFound) + return + } + if errors.Is(err, model.ErrValidation) { + http.Error(w, err.Error(), http.StatusBadRequest) + return + } + http.Error(w, "Failed to set user libraries", http.StatusInternalServerError) + return + } + + // Return updated user libraries + libraries, err := service.GetUserLibraries(r.Context(), userID) + if err != nil { + log.Error(r.Context(), "Error getting updated user libraries", "userID", userID, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + w.Header().Set("Content-Type", "application/json") + if err := json.NewEncoder(w).Encode(libraries); err != nil { + log.Error(r.Context(), "Error encoding user libraries response", err) + } + } +} diff --git a/server/nativeapi/library_test.go b/server/nativeapi/library_test.go new file mode 100644 index 000000000..ed5564a41 --- /dev/null +++ b/server/nativeapi/library_test.go @@ -0,0 +1,423 @@ +package nativeapi + +import ( + "bytes" + "context" + "encoding/json" + "fmt" + "net/http" + "net/http/httptest" + "strings" + + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Library API", func() { + var ds model.DataStore + var router http.Handler + var adminUser, regularUser model.User + var library1, library2 model.Library + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + ds = &tests.MockDataStore{} + auth.Init(ds) + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) + router = server.JWTVerifier(nativeRouter) + + // Create test users + adminUser = model.User{ + ID: "admin-1", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "adminpass", + } + regularUser = model.User{ + ID: "user-1", + UserName: "regular", + Name: "Regular User", + IsAdmin: false, + NewPassword: "userpass", + } + + // Create test libraries + library1 = model.Library{ + ID: 1, + Name: "Test Library 1", + Path: "/music/library1", + } + library2 = model.Library{ + ID: 2, + Name: "Test Library 2", + Path: "/music/library2", + } + + // Store in mock datastore + Expect(ds.User(context.TODO()).Put(&adminUser)).To(Succeed()) + Expect(ds.User(context.TODO()).Put(®ularUser)).To(Succeed()) + Expect(ds.Library(context.TODO()).Put(&library1)).To(Succeed()) + Expect(ds.Library(context.TODO()).Put(&library2)).To(Succeed()) + }) + + Describe("Library CRUD Operations", func() { + Context("as admin user", func() { + var adminToken string + + BeforeEach(func() { + var err error + adminToken, err = auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("GET /api/library", func() { + It("returns all libraries", func() { + req := createAuthenticatedRequest("GET", "/library", nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var libraries []model.Library + err := json.Unmarshal(w.Body.Bytes(), &libraries) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(2)) + Expect(libraries[0].Name).To(Equal("Test Library 1")) + Expect(libraries[1].Name).To(Equal("Test Library 2")) + }) + }) + + Describe("GET /api/library/{id}", func() { + It("returns a specific library", func() { + req := createAuthenticatedRequest("GET", "/library/1", nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var library model.Library + err := json.Unmarshal(w.Body.Bytes(), &library) + Expect(err).ToNot(HaveOccurred()) + Expect(library.Name).To(Equal("Test Library 1")) + Expect(library.Path).To(Equal("/music/library1")) + }) + + It("returns 404 for non-existent library", func() { + req := createAuthenticatedRequest("GET", "/library/999", nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns 400 for invalid library ID", func() { + req := createAuthenticatedRequest("GET", "/library/invalid", nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + + Describe("POST /api/library", func() { + It("creates a new library", func() { + newLibrary := model.Library{ + Name: "New Library", + Path: "/music/new", + } + body, _ := json.Marshal(newLibrary) + req := createAuthenticatedRequest("POST", "/library", bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + + It("validates required fields", func() { + invalidLibrary := model.Library{ + Name: "", // Missing name + Path: "/music/invalid", + } + body, _ := json.Marshal(invalidLibrary) + req := createAuthenticatedRequest("POST", "/library", bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("library name is required")) + }) + + It("validates path field", func() { + invalidLibrary := model.Library{ + Name: "Valid Name", + Path: "", // Missing path + } + body, _ := json.Marshal(invalidLibrary) + req := createAuthenticatedRequest("POST", "/library", bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("library path is required")) + }) + }) + + Describe("PUT /api/library/{id}", func() { + It("updates an existing library", func() { + updatedLibrary := model.Library{ + Name: "Updated Library 1", + Path: "/music/updated", + } + body, _ := json.Marshal(updatedLibrary) + req := createAuthenticatedRequest("PUT", "/library/1", bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var updated model.Library + err := json.Unmarshal(w.Body.Bytes(), &updated) + Expect(err).ToNot(HaveOccurred()) + Expect(updated.ID).To(Equal(1)) + Expect(updated.Name).To(Equal("Updated Library 1")) + Expect(updated.Path).To(Equal("/music/updated")) + }) + + It("validates required fields on update", func() { + invalidLibrary := model.Library{ + Name: "", + Path: "/music/path", + } + body, _ := json.Marshal(invalidLibrary) + req := createAuthenticatedRequest("PUT", "/library/1", bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + }) + + Describe("DELETE /api/library/{id}", func() { + It("deletes an existing library", func() { + req := createAuthenticatedRequest("DELETE", "/library/1", nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + + It("returns 404 for non-existent library", func() { + req := createAuthenticatedRequest("DELETE", "/library/999", nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + }) + + Context("as regular user", func() { + var userToken string + + BeforeEach(func() { + var err error + userToken, err = auth.CreateToken(®ularUser) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies access to library management endpoints", func() { + endpoints := []string{ + "GET /library", + "POST /library", + "GET /library/1", + "PUT /library/1", + "DELETE /library/1", + } + + for _, endpoint := range endpoints { + parts := strings.Split(endpoint, " ") + method, path := parts[0], parts[1] + + req := createAuthenticatedRequest(method, path, nil, userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + } + }) + }) + + Context("without authentication", func() { + It("denies access to library management endpoints", func() { + req := createUnauthenticatedRequest("GET", "/library", nil) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + }) + }) + + Describe("User-Library Association Operations", func() { + Context("as admin user", func() { + var adminToken string + + BeforeEach(func() { + var err error + adminToken, err = auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + }) + + Describe("GET /api/user/{id}/library", func() { + It("returns user's libraries", func() { + // Set up user libraries + err := ds.User(context.TODO()).SetUserLibraries(regularUser.ID, []int{1, 2}) + Expect(err).ToNot(HaveOccurred()) + + req := createAuthenticatedRequest("GET", fmt.Sprintf("/user/%s/library", regularUser.ID), nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var libraries []model.Library + err = json.Unmarshal(w.Body.Bytes(), &libraries) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(2)) + }) + + It("returns 404 for non-existent user", func() { + req := createAuthenticatedRequest("GET", "/user/non-existent/library", nil, adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + + Describe("PUT /api/user/{id}/library", func() { + It("sets user's libraries", func() { + request := map[string][]int{ + "libraryIds": {1, 2}, + } + body, _ := json.Marshal(request) + req := createAuthenticatedRequest("PUT", fmt.Sprintf("/user/%s/library", regularUser.ID), bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var libraries []model.Library + err := json.Unmarshal(w.Body.Bytes(), &libraries) + Expect(err).ToNot(HaveOccurred()) + Expect(libraries).To(HaveLen(2)) + }) + + It("validates library IDs exist", func() { + request := map[string][]int{ + "libraryIds": {999}, // Non-existent library + } + body, _ := json.Marshal(request) + req := createAuthenticatedRequest("PUT", fmt.Sprintf("/user/%s/library", regularUser.ID), bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("library ID 999 does not exist")) + }) + + It("requires at least one library for regular users", func() { + request := map[string][]int{ + "libraryIds": {}, // Empty libraries + } + body, _ := json.Marshal(request) + req := createAuthenticatedRequest("PUT", fmt.Sprintf("/user/%s/library", regularUser.ID), bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("at least one library must be assigned")) + }) + + It("prevents manual assignment to admin users", func() { + request := map[string][]int{ + "libraryIds": {1}, + } + body, _ := json.Marshal(request) + req := createAuthenticatedRequest("PUT", fmt.Sprintf("/user/%s/library", adminUser.ID), bytes.NewBuffer(body), adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("cannot manually assign libraries to admin users")) + }) + }) + }) + + Context("as regular user", func() { + var userToken string + + BeforeEach(func() { + var err error + userToken, err = auth.CreateToken(®ularUser) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies access to user-library association endpoints", func() { + req := createAuthenticatedRequest("GET", fmt.Sprintf("/user/%s/library", regularUser.ID), nil, userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + }) + }) +}) + +// Helper functions + +func createAuthenticatedRequest(method, path string, body *bytes.Buffer, token string) *http.Request { + if body == nil { + body = &bytes.Buffer{} + } + req := httptest.NewRequest(method, path, body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+token) + req.Header.Set("Content-Type", "application/json") + return req +} + +func createUnauthenticatedRequest(method, path string, body *bytes.Buffer) *http.Request { + if body == nil { + body = &bytes.Buffer{} + } + req := httptest.NewRequest(method, path, body) + req.Header.Set("Content-Type", "application/json") + return req +} diff --git a/server/nativeapi/missing.go b/server/nativeapi/missing.go index 5ccc15f55..2b455e622 100644 --- a/server/nativeapi/missing.go +++ b/server/nativeapi/missing.go @@ -8,6 +8,7 @@ import ( "github.com/Masterminds/squirrel" "github.com/deluan/rest" + "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/req" @@ -62,34 +63,32 @@ func (r *missingRepository) EntityName() string { return "missing_files" } -func deleteMissingFiles(ds model.DataStore, w http.ResponseWriter, r *http.Request) { - ctx := r.Context() - p := req.Params(r) - ids, _ := p.Strings("id") - err := ds.WithTx(func(tx model.DataStore) error { +func deleteMissingFiles(maintenance core.Maintenance) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + p := req.Params(r) + ids, _ := p.Strings("id") + + var err error if len(ids) == 0 { - _, err := tx.MediaFile(ctx).DeleteAllMissing() - return err + err = maintenance.DeleteAllMissingFiles(ctx) + } else { + err = maintenance.DeleteMissingFiles(ctx, ids) } - return tx.MediaFile(ctx).DeleteMissing(ids) - }) - if len(ids) == 1 && errors.Is(err, model.ErrNotFound) { - log.Warn(ctx, "Missing file not found", "id", ids[0]) - http.Error(w, "not found", http.StatusNotFound) - return + + if len(ids) == 1 && errors.Is(err, model.ErrNotFound) { + log.Warn(ctx, "Missing file not found", "id", ids[0]) + http.Error(w, "not found", http.StatusNotFound) + return + } + if err != nil { + http.Error(w, "failed to delete missing files", http.StatusInternalServerError) + return + } + + writeDeleteManyResponse(w, r, ids) } - if err != nil { - log.Error(ctx, "Error deleting missing tracks from DB", "ids", ids, err) - http.Error(w, err.Error(), http.StatusInternalServerError) - return - } - err = ds.GC(ctx) - if err != nil { - log.Error(ctx, "Error running GC after deleting missing tracks", err) - http.Error(w, err.Error(), http.StatusInternalServerError) - return - } - writeDeleteManyResponse(w, r, ids) } var _ model.ResourceRepository = &missingRepository{} diff --git a/server/nativeapi/native_api.go b/server/nativeapi/native_api.go index ddf5df1c3..669c4d7b5 100644 --- a/server/nativeapi/native_api.go +++ b/server/nativeapi/native_api.go @@ -14,81 +14,97 @@ import ( "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/metrics" + playlistsvc "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server" ) -type Router struct { - http.Handler - ds model.DataStore - share core.Share - playlists core.Playlists - insights metrics.Insights +// PluginManager defines the interface for plugin management operations. +// This interface is used by the API handlers to enable/disable plugins and update configuration. +type PluginManager interface { + EnablePlugin(ctx context.Context, id string) error + DisablePlugin(ctx context.Context, id string) error + ValidatePluginConfig(ctx context.Context, id, configJSON string) error + UpdatePluginConfig(ctx context.Context, id, configJSON string) error + UpdatePluginUsers(ctx context.Context, id, usersJSON string, allUsers bool) error + UpdatePluginLibraries(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error + RescanPlugins(ctx context.Context) error + UnloadDisabledPlugins(ctx context.Context) } -func New(ds model.DataStore, share core.Share, playlists core.Playlists, insights metrics.Insights) *Router { - r := &Router{ds: ds, share: share, playlists: playlists, insights: insights} +type Router struct { + http.Handler + ds model.DataStore + share core.Share + playlists playlistsvc.Playlists + insights metrics.Insights + libs core.Library + users core.User + maintenance core.Maintenance + pluginManager PluginManager + imgUpload core.ImageUploadService +} + +func New(ds model.DataStore, share core.Share, playlists playlistsvc.Playlists, insights metrics.Insights, libraryService core.Library, userService core.User, maintenance core.Maintenance, pluginManager PluginManager, imgUpload core.ImageUploadService) *Router { + r := &Router{ds: ds, share: share, playlists: playlists, insights: insights, libs: libraryService, users: userService, maintenance: maintenance, pluginManager: pluginManager, imgUpload: imgUpload} r.Handler = r.routes() return r } -func (n *Router) routes() http.Handler { +func (api *Router) routes() http.Handler { r := chi.NewRouter() // Public - n.RX(r, "/translation", newTranslationRepository, false) + api.RX(r, "/translation", newTranslationRepository, false) // Protected r.Group(func(r chi.Router) { - r.Use(server.Authenticator(n.ds)) + r.Use(server.Authenticator(api.ds)) r.Use(server.JWTRefresher) - r.Use(server.UpdateLastAccessMiddleware(n.ds)) - n.R(r, "/user", model.User{}, true) - n.R(r, "/song", model.MediaFile{}, false) - n.R(r, "/album", model.Album{}, false) - n.R(r, "/artist", model.Artist{}, false) - n.R(r, "/genre", model.Genre{}, false) - n.R(r, "/player", model.Player{}, true) - n.R(r, "/transcoding", model.Transcoding{}, conf.Server.EnableTranscodingConfig) - n.R(r, "/radio", model.Radio{}, true) - n.R(r, "/tag", model.Tag{}, true) + r.Use(server.UpdateLastAccessMiddleware(api.ds)) + api.RX(r, "/user", api.users.NewRepository, true) + api.R(r, "/song", model.MediaFile{}, false) + api.R(r, "/album", model.Album{}, false) + api.addArtistRoute(r) + api.R(r, "/genre", model.Genre{}, false) + api.R(r, "/player", model.Player{}, true) + api.R(r, "/transcoding", model.Transcoding{}, conf.Server.EnableTranscodingConfig) + api.addRadioRoute(r) + api.R(r, "/tag", model.Tag{}, true) if conf.Server.EnableSharing { - n.RX(r, "/share", n.share.NewRepository, true) + api.RX(r, "/share", api.share.NewRepository, true) } - n.addPlaylistRoute(r) - n.addPlaylistTrackRoute(r) - n.addMissingFilesRoute(r) - n.addInspectRoute(r) + api.addPlaylistRoute(r) + api.addPlaylistTrackRoute(r) + api.addSongPlaylistsRoute(r) + api.addQueueRoute(r) + api.addMissingFilesRoute(r) + api.addKeepAliveRoute(r) + api.addInsightsRoute(r) - // Keepalive endpoint to be used to keep the session valid (ex: while playing songs) - r.Get("/keepalive/*", func(w http.ResponseWriter, r *http.Request) { - _, _ = w.Write([]byte(`{"response":"ok", "id":"keepalive"}`)) - }) - - // Insights status endpoint - r.Get("/insights/*", func(w http.ResponseWriter, r *http.Request) { - last, success := n.insights.LastRun(r.Context()) - if conf.Server.EnableInsightsCollector { - _, _ = w.Write([]byte(`{"id":"insights_status", "lastRun":"` + last.Format("2006-01-02 15:04:05") + `", "success":` + strconv.FormatBool(success) + `}`)) - } else { - _, _ = w.Write([]byte(`{"id":"insights_status", "lastRun":"disabled", "success":false}`)) - } + r.With(adminOnlyMiddleware).Group(func(r chi.Router) { + api.addInspectRoute(r) + api.addConfigRoute(r) + api.addUserLibraryRoute(r) + api.addPluginRoute(r) + api.RX(r, "/library", api.libs.NewRepository, true) }) }) return r } -func (n *Router) R(r chi.Router, pathPrefix string, model interface{}, persistable bool) { +func (api *Router) R(r chi.Router, pathPrefix string, model any, persistable bool) { constructor := func(ctx context.Context) rest.Repository { - return n.ds.Resource(ctx, model) + return api.ds.Resource(ctx, model) } - n.RX(r, pathPrefix, constructor, persistable) + api.RX(r, pathPrefix, constructor, persistable) } -func (n *Router) RX(r chi.Router, pathPrefix string, constructor rest.RepositoryConstructor, persistable bool) { +func (api *Router) RX(r chi.Router, pathPrefix string, constructor rest.RepositoryConstructor, persistable bool) { r.Route(pathPrefix, func(r chi.Router) { r.Get("/", rest.GetAll(constructor)) if persistable { @@ -105,9 +121,9 @@ func (n *Router) RX(r chi.Router, pathPrefix string, constructor rest.Repository }) } -func (n *Router) addPlaylistRoute(r chi.Router) { +func (api *Router) addPlaylistRoute(r chi.Router) { constructor := func(ctx context.Context) rest.Repository { - return n.ds.Resource(ctx, model.Playlist{}) + return api.playlists.NewRepository(ctx) } r.Route("/playlist", func(r chi.Router) { @@ -117,7 +133,7 @@ func (n *Router) addPlaylistRoute(r chi.Router) { rest.Post(constructor)(w, r) return } - createPlaylistFromM3U(n.playlists)(w, r) + createPlaylistFromM3U(api.playlists)(w, r) }) r.Route("/{id}", func(r chi.Router) { @@ -125,41 +141,59 @@ func (n *Router) addPlaylistRoute(r chi.Router) { r.Get("/", rest.Get(constructor)) r.Put("/", rest.Put(constructor)) r.Delete("/", rest.Delete(constructor)) + r.Post("/image", uploadPlaylistImage(api.playlists)) + r.Delete("/image", deletePlaylistImage(api.playlists)) }) }) } -func (n *Router) addPlaylistTrackRoute(r chi.Router) { +func (api *Router) addPlaylistTrackRoute(r chi.Router) { r.Route("/playlist/{playlistId}/tracks", func(r chi.Router) { r.Get("/", func(w http.ResponseWriter, r *http.Request) { - getPlaylist(n.ds)(w, r) + getPlaylist(api.playlists)(w, r) }) r.With(server.URLParamsMiddleware).Route("/", func(r chi.Router) { r.Delete("/", func(w http.ResponseWriter, r *http.Request) { - deleteFromPlaylist(n.ds)(w, r) + deleteFromPlaylist(api.playlists)(w, r) }) r.Post("/", func(w http.ResponseWriter, r *http.Request) { - addToPlaylist(n.ds)(w, r) + addToPlaylist(api.playlists)(w, r) }) }) r.Route("/{id}", func(r chi.Router) { r.Use(server.URLParamsMiddleware) + r.Get("/", func(w http.ResponseWriter, r *http.Request) { + getPlaylistTrack(api.playlists)(w, r) + }) r.Put("/", func(w http.ResponseWriter, r *http.Request) { - reorderItem(n.ds)(w, r) + reorderItem(api.playlists)(w, r) }) r.Delete("/", func(w http.ResponseWriter, r *http.Request) { - deleteFromPlaylist(n.ds)(w, r) + deleteFromPlaylist(api.playlists)(w, r) }) }) }) } -func (n *Router) addMissingFilesRoute(r chi.Router) { +func (api *Router) addSongPlaylistsRoute(r chi.Router) { + r.With(server.URLParamsMiddleware).Get("/song/{id}/playlists", func(w http.ResponseWriter, r *http.Request) { + getSongPlaylists(api.playlists)(w, r) + }) +} + +func (api *Router) addQueueRoute(r chi.Router) { + r.Route("/queue", func(r chi.Router) { + r.Get("/", getQueue(api.ds)) + r.Post("/", saveQueue(api.ds)) + r.Put("/", updateQueue(api.ds)) + r.Delete("/", clearQueue(api.ds)) + }) +} + +func (api *Router) addMissingFilesRoute(r chi.Router) { r.Route("/missing", func(r chi.Router) { - n.RX(r, "/", newMissingRepository(n.ds), false) - r.Delete("/", func(w http.ResponseWriter, r *http.Request) { - deleteMissingFiles(n.ds, w, r) - }) + api.RX(r, "/", newMissingRepository(api.ds), false) + r.Delete("/", deleteMissingFiles(api.maintenance)) }) } @@ -177,13 +211,13 @@ func writeDeleteManyResponse(w http.ResponseWriter, r *http.Request, ids []strin http.Error(w, err.Error(), http.StatusInternalServerError) } } - _, err = w.Write(resp) + _, err = w.Write(resp) //nolint:gosec if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) } } -func (n *Router) addInspectRoute(r chi.Router) { +func (api *Router) addInspectRoute(r chi.Router) { if conf.Server.Inspect.Enabled { r.Group(func(r chi.Router) { if conf.Server.Inspect.MaxRequests > 0 { @@ -192,7 +226,42 @@ func (n *Router) addInspectRoute(r chi.Router) { conf.Server.Inspect.BacklogTimeout) r.Use(middleware.ThrottleBacklog(conf.Server.Inspect.MaxRequests, conf.Server.Inspect.BacklogLimit, time.Duration(conf.Server.Inspect.BacklogTimeout))) } - r.Get("/inspect", inspect(n.ds)) + r.Get("/inspect", inspect(api.ds)) }) } } + +func (api *Router) addConfigRoute(r chi.Router) { + if conf.Server.DevUIShowConfig { + r.Get("/config/*", getConfig) + } +} + +func (api *Router) addKeepAliveRoute(r chi.Router) { + r.Get("/keepalive/*", func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte(`{"response":"ok", "id":"keepalive"}`)) + }) +} + +func (api *Router) addInsightsRoute(r chi.Router) { + r.Get("/insights/*", func(w http.ResponseWriter, r *http.Request) { + last, success := api.insights.LastRun(r.Context()) + if conf.Server.EnableInsightsCollector { + _, _ = w.Write([]byte(`{"id":"insights_status", "lastRun":"` + last.Format("2006-01-02 15:04:05") + `", "success":` + strconv.FormatBool(success) + `}`)) //nolint:gosec + } else { + _, _ = w.Write([]byte(`{"id":"insights_status", "lastRun":"disabled", "success":false}`)) + } + }) +} + +// Middleware to ensure only admin users can access endpoints +func adminOnlyMiddleware(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + user, ok := request.UserFrom(r.Context()) + if !ok || !user.IsAdmin { + http.Error(w, "Access denied: admin privileges required", http.StatusForbidden) + return + } + next.ServeHTTP(w, r) + }) +} diff --git a/server/nativeapi/native_api_song_test.go b/server/nativeapi/native_api_song_test.go new file mode 100644 index 000000000..f0ee50ebb --- /dev/null +++ b/server/nativeapi/native_api_song_test.go @@ -0,0 +1,430 @@ +package nativeapi + +import ( + "bytes" + "encoding/json" + "net/http" + "net/http/httptest" + "net/url" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Song Endpoints", func() { + var ( + router http.Handler + ds *tests.MockDataStore + mfRepo *tests.MockMediaFileRepo + userRepo *tests.MockedUserRepo + w *httptest.ResponseRecorder + testUser model.User + testSongs model.MediaFiles + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.SessionTimeout = time.Minute + + // Setup mock repositories + mfRepo = tests.CreateMockMediaFileRepo() + userRepo = tests.CreateMockUserRepo() + + ds = &tests.MockDataStore{ + MockedMediaFile: mfRepo, + MockedUser: userRepo, + MockedProperty: &tests.MockedPropertyRepo{}, + } + + // Initialize auth system + auth.Init(ds) + + // Create test user + testUser = model.User{ + ID: "user-1", + UserName: "testuser", + Name: "Test User", + IsAdmin: false, + NewPassword: "testpass", + } + err := userRepo.Put(&testUser) + Expect(err).ToNot(HaveOccurred()) + + // Create test songs + testSongs = model.MediaFiles{ + { + ID: "song-1", + Title: "Test Song 1", + Artist: "Test Artist 1", + Album: "Test Album 1", + AlbumID: "album-1", + ArtistID: "artist-1", + Duration: 180.5, + BitRate: 320, + Path: "/music/song1.mp3", + Suffix: "mp3", + Size: 5242880, + CreatedAt: time.Now(), + UpdatedAt: time.Now(), + }, + { + ID: "song-2", + Title: "Test Song 2", + Artist: "Test Artist 2", + Album: "Test Album 2", + AlbumID: "album-2", + ArtistID: "artist-2", + Duration: 240.0, + BitRate: 256, + Path: "/music/song2.mp3", + Suffix: "mp3", + Size: 7340032, + CreatedAt: time.Now(), + UpdatedAt: time.Now(), + }, + } + mfRepo.SetData(testSongs) + + // Create the native API router and wrap it with the JWTVerifier middleware + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) + router = server.JWTVerifier(nativeRouter) + w = httptest.NewRecorder() + }) + + // Helper function to create unauthenticated request + createUnauthenticatedRequest := func(method, path string, body []byte) *http.Request { + var req *http.Request + if body != nil { + req = httptest.NewRequest(method, path, bytes.NewReader(body)) + req.Header.Set("Content-Type", "application/json") + } else { + req = httptest.NewRequest(method, path, nil) + } + return req + } + + // Helper function to create authenticated request with JWT token + createAuthenticatedRequest := func(method, path string, body []byte) *http.Request { + req := createUnauthenticatedRequest(method, path, body) + + // Create JWT token for the test user + token, err := auth.CreateToken(&testUser) + Expect(err).ToNot(HaveOccurred()) + + // Add JWT token to Authorization header + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+token) + + return req + } + + Describe("GET /song", func() { + Context("when user is authenticated", func() { + It("returns all songs", func() { + req := createAuthenticatedRequest("GET", "/song", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response []model.MediaFile + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + + Expect(response).To(HaveLen(2)) + Expect(response[0].ID).To(Equal("song-1")) + Expect(response[0].Title).To(Equal("Test Song 1")) + Expect(response[1].ID).To(Equal("song-2")) + Expect(response[1].Title).To(Equal("Test Song 2")) + }) + + It("handles repository errors gracefully", func() { + mfRepo.SetError(true) + + req := createAuthenticatedRequest("GET", "/song", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Context("when user is not authenticated", func() { + It("returns unauthorized", func() { + req := createUnauthenticatedRequest("GET", "/song", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + }) + }) + + Describe("GET /song/{id}", func() { + Context("when user is authenticated", func() { + It("returns the specific song", func() { + req := createAuthenticatedRequest("GET", "/song/song-1", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response model.MediaFile + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + + Expect(response.ID).To(Equal("song-1")) + Expect(response.Title).To(Equal("Test Song 1")) + Expect(response.Artist).To(Equal("Test Artist 1")) + }) + + It("returns 404 for non-existent song", func() { + req := createAuthenticatedRequest("GET", "/song/non-existent", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("handles repository errors gracefully", func() { + mfRepo.SetError(true) + + req := createAuthenticatedRequest("GET", "/song/song-1", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Context("when user is not authenticated", func() { + It("returns unauthorized", func() { + req := createUnauthenticatedRequest("GET", "/song/song-1", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + }) + }) + + Describe("Song endpoints are read-only", func() { + Context("POST /song", func() { + It("should not be available (songs are not persistable)", func() { + newSong := model.MediaFile{ + Title: "New Song", + Artist: "New Artist", + Album: "New Album", + Duration: 200.0, + } + + body, _ := json.Marshal(newSong) + req := createAuthenticatedRequest("POST", "/song", body) + router.ServeHTTP(w, req) + + // Should return 405 Method Not Allowed or 404 Not Found + Expect(w.Code).To(Equal(http.StatusMethodNotAllowed)) + }) + }) + + Context("PUT /song/{id}", func() { + It("should not be available (songs are not persistable)", func() { + updatedSong := model.MediaFile{ + ID: "song-1", + Title: "Updated Song", + Artist: "Updated Artist", + Album: "Updated Album", + Duration: 250.0, + } + + body, _ := json.Marshal(updatedSong) + req := createAuthenticatedRequest("PUT", "/song/song-1", body) + router.ServeHTTP(w, req) + + // Should return 405 Method Not Allowed or 404 Not Found + Expect(w.Code).To(Equal(http.StatusMethodNotAllowed)) + }) + }) + + Context("DELETE /song/{id}", func() { + It("should not be available (songs are not persistable)", func() { + req := createAuthenticatedRequest("DELETE", "/song/song-1", nil) + router.ServeHTTP(w, req) + + // Should return 405 Method Not Allowed or 404 Not Found + Expect(w.Code).To(Equal(http.StatusMethodNotAllowed)) + }) + }) + }) + + Describe("Query parameters and filtering", func() { + Context("when using query parameters", func() { + It("handles pagination parameters", func() { + req := createAuthenticatedRequest("GET", "/song?_start=0&_end=1", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response []model.MediaFile + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + + // Should still return all songs since our mock doesn't implement pagination + // but the request should be processed successfully + Expect(len(response)).To(BeNumerically(">=", 1)) + }) + + It("handles sort parameters", func() { + req := createAuthenticatedRequest("GET", "/song?_sort=title&_order=ASC", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response []model.MediaFile + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + + Expect(response).To(HaveLen(2)) + }) + + It("handles filter parameters", func() { + // Properly encode the URL with query parameters + baseURL := "/song" + params := url.Values{} + params.Add("title", "Test Song 1") + fullURL := baseURL + "?" + params.Encode() + + req := createAuthenticatedRequest("GET", fullURL, nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response []model.MediaFile + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + + // Mock doesn't implement filtering, but request should be processed + Expect(len(response)).To(BeNumerically(">=", 1)) + }) + }) + }) + + Describe("Response headers and content type", func() { + It("sets correct content type for JSON responses", func() { + req := createAuthenticatedRequest("GET", "/song", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Header().Get("Content-Type")).To(ContainSubstring("application/json")) + }) + + It("includes total count header when available", func() { + req := createAuthenticatedRequest("GET", "/song", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + // The X-Total-Count header might be set by the REST framework + // We just verify the request is processed successfully + }) + }) + + Describe("Edge cases and error handling", func() { + Context("when repository is unavailable", func() { + It("handles database connection errors", func() { + mfRepo.SetError(true) + + req := createAuthenticatedRequest("GET", "/song", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Context("when no songs exist", func() { + It("returns empty array when no songs are found", func() { + mfRepo.SetData(model.MediaFiles{}) // Empty dataset + + req := createAuthenticatedRequest("GET", "/song", nil) + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response []model.MediaFile + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + + Expect(response).To(HaveLen(0)) + }) + }) + }) + + Describe("Authentication middleware integration", func() { + Context("with different user types", func() { + It("works with admin users", func() { + adminUser := model.User{ + ID: "admin-1", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "adminpass", + } + err := userRepo.Put(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + // Create JWT token for admin user + token, err := auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + req := createUnauthenticatedRequest("GET", "/song", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+token) + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + + It("works with regular users", func() { + regularUser := model.User{ + ID: "user-2", + UserName: "regular", + Name: "Regular User", + IsAdmin: false, + NewPassword: "userpass", + } + err := userRepo.Put(®ularUser) + Expect(err).ToNot(HaveOccurred()) + + // Create JWT token for regular user + token, err := auth.CreateToken(®ularUser) + Expect(err).ToNot(HaveOccurred()) + + req := createUnauthenticatedRequest("GET", "/song", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+token) + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + }) + }) + + Context("with missing authentication context", func() { + It("rejects requests without user context", func() { + req := createUnauthenticatedRequest("GET", "/song", nil) + // No authentication header added + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + + It("rejects requests with invalid JWT tokens", func() { + req := createUnauthenticatedRequest("GET", "/song", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer invalid.token.here") + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + }) + }) +}) diff --git a/server/nativeapi/playlists.go b/server/nativeapi/playlists.go index 1e8e961ca..ea1cf579b 100644 --- a/server/nativeapi/playlists.go +++ b/server/nativeapi/playlists.go @@ -5,13 +5,14 @@ import ( "encoding/json" "errors" "fmt" + "io" "net/http" "strconv" "strings" "github.com/deluan/rest" "github.com/go-chi/chi/v5" - "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/req" @@ -19,36 +20,39 @@ import ( type restHandler = func(rest.RepositoryConstructor, ...rest.Logger) http.HandlerFunc -func getPlaylist(ds model.DataStore) http.HandlerFunc { - // Add a middleware to capture the playlistId - wrapper := func(handler restHandler) http.HandlerFunc { - return func(w http.ResponseWriter, r *http.Request) { - constructor := func(ctx context.Context) rest.Repository { - plsRepo := ds.Playlist(ctx) - plsId := chi.URLParam(r, "playlistId") - p := req.Params(r) - start := p.Int64Or("_start", 0) - return plsRepo.Tracks(plsId, start == 0) - } - - handler(constructor).ServeHTTP(w, r) - } - } - +func playlistTracksHandler(pls playlists.Playlists, handler restHandler, refreshSmartPlaylist func(*http.Request) bool) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { - accept := r.Header.Get("accept") - if strings.ToLower(accept) == "audio/x-mpegurl" { - handleExportPlaylist(ds)(w, r) + plsId := chi.URLParam(r, "playlistId") + tracks := pls.TracksRepository(r.Context(), plsId, refreshSmartPlaylist(r)) + if tracks == nil { + http.Error(w, "not found", http.StatusNotFound) return } - wrapper(rest.GetAll)(w, r) + handler(func(ctx context.Context) rest.Repository { return tracks }).ServeHTTP(w, r) } } -func createPlaylistFromM3U(playlists core.Playlists) http.HandlerFunc { +func getPlaylist(pls playlists.Playlists) http.HandlerFunc { + handler := playlistTracksHandler(pls, rest.GetAll, func(r *http.Request) bool { + return req.Params(r).Int64Or("_start", 0) == 0 + }) + return func(w http.ResponseWriter, r *http.Request) { + if strings.ToLower(r.Header.Get("accept")) == "audio/x-mpegurl" { + handleExportPlaylist(pls)(w, r) + return + } + handler(w, r) + } +} + +func getPlaylistTrack(pls playlists.Playlists) http.HandlerFunc { + return playlistTracksHandler(pls, rest.Get, func(*http.Request) bool { return true }) +} + +func createPlaylistFromM3U(pls playlists.Playlists) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { ctx := r.Context() - pls, err := playlists.ImportM3U(ctx, r.Body) + pl, err := pls.ImportM3U(ctx, r.Body) if err != nil { log.Error(r.Context(), "Error parsing playlist", err) // TODO: consider returning StatusBadRequest for playlists that are malformed @@ -56,7 +60,7 @@ func createPlaylistFromM3U(playlists core.Playlists) http.HandlerFunc { return } w.WriteHeader(http.StatusCreated) - _, err = w.Write([]byte(pls.ToM3U8())) + _, err = w.Write([]byte(pl.ToM3U8())) //nolint:gosec if err != nil { log.Error(ctx, "Error sending m3u contents", err) http.Error(w, err.Error(), http.StatusInternalServerError) @@ -65,45 +69,41 @@ func createPlaylistFromM3U(playlists core.Playlists) http.HandlerFunc { } } -func handleExportPlaylist(ds model.DataStore) http.HandlerFunc { +func handleExportPlaylist(pls playlists.Playlists) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { ctx := r.Context() - plsRepo := ds.Playlist(ctx) plsId := chi.URLParam(r, "playlistId") - pls, err := plsRepo.GetWithTracks(plsId, true, false) + playlist, err := pls.GetWithTracks(ctx, plsId) if errors.Is(err, model.ErrNotFound) { - log.Warn(r.Context(), "Playlist not found", "playlistId", plsId) + log.Warn(ctx, "Playlist not found", "playlistId", plsId) http.Error(w, "not found", http.StatusNotFound) return } if err != nil { - log.Error(r.Context(), "Error retrieving the playlist", "playlistId", plsId, err) + log.Error(ctx, "Error retrieving the playlist", "playlistId", plsId, err) http.Error(w, err.Error(), http.StatusInternalServerError) return } - log.Debug(ctx, "Exporting playlist as M3U", "playlistId", plsId, "name", pls.Name) + log.Debug(ctx, "Exporting playlist as M3U", "playlistId", plsId, "name", playlist.Name) w.Header().Set("Content-Type", "audio/x-mpegurl") - disposition := fmt.Sprintf("attachment; filename=\"%s.m3u\"", pls.Name) + disposition := fmt.Sprintf("attachment; filename=\"%s.m3u\"", playlist.Name) w.Header().Set("Content-Disposition", disposition) - _, err = w.Write([]byte(pls.ToM3U8())) + _, err = w.Write([]byte(playlist.ToM3U8())) //nolint:gosec if err != nil { - log.Error(ctx, "Error sending playlist", "name", pls.Name) + log.Error(ctx, "Error sending playlist", "name", playlist.Name) return } } } -func deleteFromPlaylist(ds model.DataStore) http.HandlerFunc { +func deleteFromPlaylist(pls playlists.Playlists) http.HandlerFunc { return func(w http.ResponseWriter, r *http.Request) { p := req.Params(r) playlistId, _ := p.String(":playlistId") ids, _ := p.Strings("id") - err := ds.WithTxImmediate(func(tx model.DataStore) error { - tracksRepo := tx.Playlist(r.Context()).Tracks(playlistId, true) - return tracksRepo.Delete(ids...) - }) + err := pls.RemoveTracks(r.Context(), playlistId, ids) if len(ids) == 1 && errors.Is(err, model.ErrNotFound) { log.Warn(r.Context(), "Track not found in playlist", "playlistId", playlistId, "id", ids[0]) http.Error(w, "not found", http.StatusNotFound) @@ -118,7 +118,7 @@ func deleteFromPlaylist(ds model.DataStore) http.HandlerFunc { } } -func addToPlaylist(ds model.DataStore) http.HandlerFunc { +func addToPlaylist(pls playlists.Playlists) http.HandlerFunc { type addTracksPayload struct { Ids []string `json:"ids"` AlbumIds []string `json:"albumIds"` @@ -127,6 +127,7 @@ func addToPlaylist(ds model.DataStore) http.HandlerFunc { } return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() p := req.Params(r) playlistId, _ := p.String(":playlistId") var payload addTracksPayload @@ -135,43 +136,43 @@ func addToPlaylist(ds model.DataStore) http.HandlerFunc { http.Error(w, err.Error(), http.StatusBadRequest) return } - tracksRepo := ds.Playlist(r.Context()).Tracks(playlistId, true) count, c := 0, 0 - if c, err = tracksRepo.Add(payload.Ids); err != nil { + if c, err = pls.AddTracks(ctx, playlistId, payload.Ids); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c - if c, err = tracksRepo.AddAlbums(payload.AlbumIds); err != nil { + if c, err = pls.AddAlbums(ctx, playlistId, payload.AlbumIds); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c - if c, err = tracksRepo.AddArtists(payload.ArtistIds); err != nil { + if c, err = pls.AddArtists(ctx, playlistId, payload.ArtistIds); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c - if c, err = tracksRepo.AddDiscs(payload.Discs); err != nil { + if c, err = pls.AddDiscs(ctx, playlistId, payload.Discs); err != nil { http.Error(w, err.Error(), http.StatusBadRequest) return } count += c // Must return an object with an ID, to satisfy ReactAdmin `create` call - _, err = fmt.Fprintf(w, `{"added":%d}`, count) + _, err = fmt.Fprintf(w, `{"added":%d}`, count) //nolint:gosec if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) } } } -func reorderItem(ds model.DataStore) http.HandlerFunc { +func reorderItem(pls playlists.Playlists) http.HandlerFunc { type reorderPayload struct { InsertBefore string `json:"insert_before"` } return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() p := req.Params(r) playlistId, _ := p.String(":playlistId") id := p.IntOr(":id", 0) @@ -190,9 +191,8 @@ func reorderItem(ds model.DataStore) http.HandlerFunc { http.Error(w, err.Error(), http.StatusBadRequest) return } - tracksRepo := ds.Playlist(r.Context()).Tracks(playlistId, true) - err = tracksRepo.Reorder(id, newPos) - if errors.Is(err, rest.ErrPermissionDenied) { + err = pls.ReorderTrack(ctx, playlistId, id, newPos) + if errors.Is(err, model.ErrNotAuthorized) { http.Error(w, err.Error(), http.StatusForbidden) return } @@ -201,9 +201,41 @@ func reorderItem(ds model.DataStore) http.HandlerFunc { return } - _, err = w.Write([]byte(fmt.Sprintf(`{"id":"%d"}`, id))) + _, err = w.Write(fmt.Appendf(nil, `{"id":"%d"}`, id)) //nolint:gosec if err != nil { http.Error(w, err.Error(), http.StatusInternalServerError) } } } + +func getSongPlaylists(svc playlists.Playlists) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + p := req.Params(r) + trackId, _ := p.String(":id") + playlists, err := svc.GetPlaylists(r.Context(), trackId) + if err != nil { + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + data, err := json.Marshal(playlists) + if err != nil { + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + _, _ = w.Write(data) //nolint:gosec + } +} + +func uploadPlaylistImage(pls playlists.Playlists) http.HandlerFunc { + return handleImageUpload(func(ctx context.Context, reader io.Reader, ext string) error { + playlistId := chi.URLParamFromCtx(ctx, "id") + return pls.SetImage(ctx, playlistId, reader, ext) + }) +} + +func deletePlaylistImage(pls playlists.Playlists) http.HandlerFunc { + return handleImageDelete(func(ctx context.Context) error { + playlistId := chi.URLParamFromCtx(ctx, "id") + return pls.RemoveImage(ctx, playlistId) + }) +} diff --git a/server/nativeapi/playlists_test.go b/server/nativeapi/playlists_test.go new file mode 100644 index 000000000..e1c933709 --- /dev/null +++ b/server/nativeapi/playlists_test.go @@ -0,0 +1,238 @@ +package nativeapi + +import ( + "context" + "encoding/json" + "io" + "net/http" + "net/http/httptest" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Playlist Image Endpoints", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + }) + + DescribeTable("uploadPlaylistImage guard", + func(enableArtworkUpload, isAdmin bool, expectedStatus int) { + conf.Server.EnableArtworkUpload = enableArtworkUpload + handler := uploadPlaylistImage(&mockPlaylistsService{}) + + req := httptest.NewRequest("POST", "/playlist/pls-1/image", nil) + ctx := request.WithUser(GinkgoT().Context(), model.User{ID: "user-1", IsAdmin: isAdmin}) + req = req.WithContext(ctx) + + w := httptest.NewRecorder() + handler.ServeHTTP(w, req) + Expect(w.Code).To(Equal(expectedStatus)) + }, + Entry("enabled, regular user passes guard", true, false, http.StatusBadRequest), + Entry("enabled, admin passes guard", true, true, http.StatusBadRequest), + Entry("disabled, admin passes guard", false, true, http.StatusBadRequest), + Entry("disabled, regular user is forbidden", false, false, http.StatusForbidden), + ) + + DescribeTable("deletePlaylistImage guard", + func(enableArtworkUpload, isAdmin bool, expectedStatus int) { + conf.Server.EnableArtworkUpload = enableArtworkUpload + handler := deletePlaylistImage(&mockPlaylistsService{}) + + req := httptest.NewRequest("DELETE", "/playlist/pls-1/image", nil) + ctx := request.WithUser(GinkgoT().Context(), model.User{ID: "user-1", IsAdmin: isAdmin}) + req = req.WithContext(ctx) + + w := httptest.NewRecorder() + handler.ServeHTTP(w, req) + Expect(w.Code).To(Equal(expectedStatus)) + }, + Entry("enabled, regular user passes guard", true, false, http.StatusNotFound), + Entry("enabled, admin passes guard", true, true, http.StatusNotFound), + Entry("disabled, admin passes guard", false, true, http.StatusNotFound), + Entry("disabled, regular user is forbidden", false, false, http.StatusForbidden), + ) +}) + +var _ = Describe("Playlist Tracks Endpoint", func() { + var ( + router http.Handler + plsSvc *mockPlaylistsService + userRepo *tests.MockedUserRepo + w *httptest.ResponseRecorder + ) + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.SessionTimeout = time.Minute + + plsSvc = &mockPlaylistsService{} + userRepo = tests.CreateMockUserRepo() + + ds := &tests.MockDataStore{ + MockedUser: userRepo, + MockedProperty: &tests.MockedPropertyRepo{}, + } + + auth.Init(ds) + + testUser := model.User{ + ID: "user-1", + UserName: "testuser", + Name: "Test User", + IsAdmin: false, + NewPassword: "testpass", + } + err := userRepo.Put(&testUser) + Expect(err).ToNot(HaveOccurred()) + + nativeRouter := New(ds, nil, plsSvc, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, nil, nil) + router = server.JWTVerifier(nativeRouter) + w = httptest.NewRecorder() + }) + + createAuthenticatedRequest := func(method, path string) *http.Request { + req := httptest.NewRequest(method, path, nil) + testUser := model.User{ID: "user-1", UserName: "testuser"} + token, err := auth.CreateToken(&testUser) + Expect(err).ToNot(HaveOccurred()) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+token) + return req + } + + Describe("GET /playlist/{playlistId}/tracks", func() { + It("returns 404 when playlist does not exist", func() { + req := createAuthenticatedRequest("GET", "/playlist/non-existent/tracks") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns tracks when playlist exists", func() { + plsSvc.tracksRepo = &mockPlaylistTrackRepo{ + tracks: model.PlaylistTracks{ + {ID: "1", MediaFileID: "mf-1", PlaylistID: "pls-1"}, + {ID: "2", MediaFileID: "mf-2", PlaylistID: "pls-1"}, + }, + } + + req := createAuthenticatedRequest("GET", "/playlist/pls-1/tracks") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response []model.PlaylistTrack + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + Expect(response).To(HaveLen(2)) + Expect(response[0].ID).To(Equal("1")) + Expect(response[1].ID).To(Equal("2")) + }) + }) + + Describe("GET /playlist/{playlistId}/tracks/{id}", func() { + It("returns 404 when playlist does not exist", func() { + req := createAuthenticatedRequest("GET", "/playlist/non-existent/tracks/1") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns the track when playlist exists", func() { + plsSvc.tracksRepo = &mockPlaylistTrackRepo{ + tracks: model.PlaylistTracks{ + {ID: "1", MediaFileID: "mf-1", PlaylistID: "pls-1"}, + }, + } + + req := createAuthenticatedRequest("GET", "/playlist/pls-1/tracks/1") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var response model.PlaylistTrack + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).ToNot(HaveOccurred()) + Expect(response.ID).To(Equal("1")) + Expect(response.MediaFileID).To(Equal("mf-1")) + }) + + It("returns 404 when track does not exist in playlist", func() { + plsSvc.tracksRepo = &mockPlaylistTrackRepo{ + tracks: model.PlaylistTracks{}, + } + + req := createAuthenticatedRequest("GET", "/playlist/pls-1/tracks/999") + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) +}) + +type mockPlaylistTrackRepo struct { + model.PlaylistTrackRepository + tracks model.PlaylistTracks +} + +func (m *mockPlaylistTrackRepo) Count(...rest.QueryOptions) (int64, error) { + return int64(len(m.tracks)), nil +} + +func (m *mockPlaylistTrackRepo) ReadAll(...rest.QueryOptions) (any, error) { + return m.tracks, nil +} + +func (m *mockPlaylistTrackRepo) EntityName() string { + return "playlist_track" +} + +func (m *mockPlaylistTrackRepo) NewInstance() any { + return &model.PlaylistTrack{} +} + +func (m *mockPlaylistTrackRepo) Read(id string) (any, error) { + for _, t := range m.tracks { + if t.ID == id { + return &t, nil + } + } + return nil, rest.ErrNotFound +} + +type mockPlaylistsService struct { + playlists.Playlists + tracksRepo rest.Repository + removeImageFn func(ctx context.Context, id string) error + setImageFn func(ctx context.Context, id string, reader io.Reader, ext string) error +} + +func (m *mockPlaylistsService) RemoveImage(ctx context.Context, id string) error { + if m.removeImageFn != nil { + return m.removeImageFn(ctx, id) + } + return model.ErrNotFound +} + +func (m *mockPlaylistsService) SetImage(ctx context.Context, id string, reader io.Reader, ext string) error { + if m.setImageFn != nil { + return m.setImageFn(ctx, id, reader, ext) + } + return model.ErrNotFound +} + +func (m *mockPlaylistsService) TracksRepository(_ context.Context, _ string, _ bool) rest.Repository { + return m.tracksRepo +} diff --git a/server/nativeapi/plugin.go b/server/nativeapi/plugin.go new file mode 100644 index 000000000..a7d261681 --- /dev/null +++ b/server/nativeapi/plugin.go @@ -0,0 +1,271 @@ +package nativeapi + +import ( + "context" + "encoding/json" + "errors" + "net/http" + + "github.com/deluan/rest" + "github.com/go-chi/chi/v5" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" +) + +func (api *Router) addPluginRoute(r chi.Router) { + constructor := func(ctx context.Context) rest.Repository { + return api.ds.Plugin(ctx) + } + + r.Route("/plugin", func(r chi.Router) { + r.Use(pluginsEnabledMiddleware) + r.Get("/", rest.GetAll(constructor)) + r.Post("/rescan", api.rescanPlugins) + r.Route("/{id}", func(r chi.Router) { + r.Use(server.URLParamsMiddleware) + r.Get("/", rest.Get(constructor)) + r.Put("/", api.updatePlugin) + }) + }) +} + +func (api *Router) rescanPlugins(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + if err := api.pluginManager.RescanPlugins(ctx); err != nil { + log.Error(ctx, "Error rescanning plugins", err) + http.Error(w, "Error rescanning plugins: "+err.Error(), http.StatusInternalServerError) + return + } + + w.WriteHeader(http.StatusOK) +} + +// Middleware to check if plugins feature is enabled +func pluginsEnabledMiddleware(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + if !conf.Server.Plugins.Enabled { + http.Error(w, "Not found", http.StatusNotFound) + return + } + next.ServeHTTP(w, r) + }) +} + +// PluginUpdateRequest represents the fields that can be updated via the API +type PluginUpdateRequest struct { + Enabled *bool `json:"enabled,omitempty"` + Config *string `json:"config,omitempty"` + Users *string `json:"users,omitempty"` + AllUsers *bool `json:"allUsers,omitempty"` + Libraries *string `json:"libraries,omitempty"` + AllLibraries *bool `json:"allLibraries,omitempty"` + AllowWriteAccess *bool `json:"allowWriteAccess,omitempty"` +} + +func (api *Router) updatePlugin(w http.ResponseWriter, r *http.Request) { + id := chi.URLParam(r, "id") + ctx := r.Context() + repo := api.ds.Plugin(ctx) + + // Get existing plugin to verify it exists + if _, err := repo.Get(id); err != nil { + if errors.Is(err, rest.ErrPermissionDenied) { + http.Error(w, "Access denied: admin privileges required", http.StatusForbidden) + return + } + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "Plugin not found", http.StatusNotFound) + return + } + log.Error(ctx, "Error getting plugin", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + // Parse update request + var req PluginUpdateRequest + if err := json.NewDecoder(r.Body).Decode(&req); err != nil { + log.Error(ctx, "Error decoding request", err) + http.Error(w, "Invalid request body", http.StatusBadRequest) + return + } + + // Handle config update (if provided) + if req.Config != nil { + if err := validateAndUpdateConfig(ctx, api.pluginManager, id, *req.Config, w); err != nil { + log.Error(ctx, "Error updating plugin config", err) + return + } + } + + // Handle users permission update (if provided) + if req.Users != nil || req.AllUsers != nil { + if err := validateAndUpdateUsers(ctx, api.pluginManager, repo, id, req, w); err != nil { + log.Error(ctx, "Error updating plugin users", err) + return + } + } + + // Handle libraries permission update (if provided) + if req.Libraries != nil || req.AllLibraries != nil || req.AllowWriteAccess != nil { + if err := validateAndUpdateLibraries(ctx, api.pluginManager, repo, id, req, w); err != nil { + log.Error(ctx, "Error updating plugin libraries", err) + return + } + } + + // Handle enable/disable + if req.Enabled != nil { + if *req.Enabled { + if enableErr := api.pluginManager.EnablePlugin(ctx, id); enableErr != nil { + log.Error(ctx, "Error enabling plugin", "id", id, enableErr) + // Refresh plugin from DB to get the error + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting updated plugin after enable failure", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + // Return error response with message field for React-Admin compatibility + // and include the plugin data so UI can update its state + errorResponse := struct { + Message string `json:"message"` + Plugin *model.Plugin `json:"plugin"` + }{ + Message: enableErr.Error(), + Plugin: plugin, + } + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(http.StatusUnprocessableEntity) + _ = json.NewEncoder(w).Encode(errorResponse) + return + } + } else { + if err := api.pluginManager.DisablePlugin(ctx, id); err != nil { + log.Error(ctx, "Error disabling plugin", "id", id, err) + http.Error(w, "Error disabling plugin: "+err.Error(), http.StatusInternalServerError) + return + } + } + } + + // Refresh and return updated plugin + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting updated plugin", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return + } + + w.Header().Set("Content-Type", "application/json") + if err := json.NewEncoder(w).Encode(plugin); err != nil { + log.Error(ctx, "Error encoding plugin response", err) + } +} + +// isValidJSON checks if a string is valid JSON +func isValidJSON(s string) bool { + var js json.RawMessage + return json.Unmarshal([]byte(s), &js) == nil +} + +// validateAndUpdateConfig validates the config JSON against the plugin's schema and updates the plugin. +// Returns an error if validation or update fails (error response already written). +func validateAndUpdateConfig(ctx context.Context, pm PluginManager, id, configJSON string, w http.ResponseWriter) error { + // Basic JSON syntax check + if configJSON != "" && !isValidJSON(configJSON) { + http.Error(w, "Invalid JSON in config field", http.StatusBadRequest) + return errors.New("invalid JSON") + } + + // Validate against plugin's config schema + if err := pm.ValidatePluginConfig(ctx, id, configJSON); err != nil { + log.Warn(ctx, "Config validation failed", "id", id, err) + w.Header().Set("Content-Type", "application/json") + w.WriteHeader(http.StatusBadRequest) + // Try to return structured validation errors if available + response := map[string]any{"message": err.Error()} + _ = json.NewEncoder(w).Encode(response) + return err + } + + if err := pm.UpdatePluginConfig(ctx, id, configJSON); err != nil { + log.Error(ctx, "Error updating plugin config", "id", id, err) + http.Error(w, "Error updating plugin configuration: "+err.Error(), http.StatusInternalServerError) + return err + } + return nil +} + +// validateAndUpdateUsers validates the users JSON and updates the plugin. +// Returns an error if validation or update fails (error response already written). +func validateAndUpdateUsers(ctx context.Context, pm PluginManager, repo model.PluginRepository, id string, req PluginUpdateRequest, w http.ResponseWriter) error { + // Get current values if not provided in request + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting plugin for users update", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return err + } + + usersJSON := plugin.Users + allUsers := plugin.AllUsers + + if req.Users != nil { + if *req.Users != "" && !isValidJSON(*req.Users) { + http.Error(w, "Invalid JSON in users field", http.StatusBadRequest) + return errors.New("invalid JSON") + } + usersJSON = *req.Users + } + if req.AllUsers != nil { + allUsers = *req.AllUsers + } + + if err := pm.UpdatePluginUsers(ctx, id, usersJSON, allUsers); err != nil { + log.Error(ctx, "Error updating plugin users", "id", id, err) + http.Error(w, "Error updating plugin users: "+err.Error(), http.StatusInternalServerError) + return err + } + return nil +} + +// validateAndUpdateLibraries validates the libraries JSON and updates the plugin. +// Returns an error if validation or update fails (error response already written). +func validateAndUpdateLibraries(ctx context.Context, pm PluginManager, repo model.PluginRepository, id string, req PluginUpdateRequest, w http.ResponseWriter) error { + // Get current values if not provided in request + plugin, err := repo.Get(id) + if err != nil { + log.Error(ctx, "Error getting plugin for libraries update", "id", id, err) + http.Error(w, "Internal server error", http.StatusInternalServerError) + return err + } + + librariesJSON := plugin.Libraries + allLibraries := plugin.AllLibraries + allowWriteAccess := plugin.AllowWriteAccess + + if req.Libraries != nil { + if *req.Libraries != "" && !isValidJSON(*req.Libraries) { + http.Error(w, "Invalid JSON in libraries field", http.StatusBadRequest) + return errors.New("invalid JSON") + } + librariesJSON = *req.Libraries + } + if req.AllLibraries != nil { + allLibraries = *req.AllLibraries + } + if req.AllowWriteAccess != nil { + allowWriteAccess = *req.AllowWriteAccess + } + + if err := pm.UpdatePluginLibraries(ctx, id, librariesJSON, allLibraries, allowWriteAccess); err != nil { + log.Error(ctx, "Error updating plugin libraries", "id", id, err) + http.Error(w, "Error updating plugin libraries: "+err.Error(), http.StatusInternalServerError) + return err + } + return nil +} diff --git a/server/nativeapi/plugin_test.go b/server/nativeapi/plugin_test.go new file mode 100644 index 000000000..8fc88e09c --- /dev/null +++ b/server/nativeapi/plugin_test.go @@ -0,0 +1,487 @@ +package nativeapi + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "net/http" + "net/http/httptest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Plugin API", func() { + var ds *tests.MockDataStore + var mockManager *tests.MockPluginManager + var router http.Handler + var adminUser, regularUser model.User + var testPlugin1, testPlugin2 model.Plugin + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Plugins.Enabled = true + ds = &tests.MockDataStore{} + mockManager = &tests.MockPluginManager{} + auth.Init(ds) + nativeRouter := New(ds, nil, nil, nil, tests.NewMockLibraryService(), tests.NewMockUserService(), nil, mockManager, nil) + router = server.JWTVerifier(nativeRouter) + + // Create test users + adminUser = model.User{ + ID: "admin-1", + UserName: "admin", + Name: "Admin User", + IsAdmin: true, + NewPassword: "adminpass", + } + regularUser = model.User{ + ID: "user-1", + UserName: "regular", + Name: "Regular User", + IsAdmin: false, + NewPassword: "userpass", + } + + // Create test plugins + testPlugin1 = model.Plugin{ + ID: "test-plugin-1", + Path: "/plugins/test1.wasm", + Manifest: `{"name":"Test Plugin 1","version":"1.0.0"}`, + SHA256: "abc123", + Enabled: false, + } + testPlugin2 = model.Plugin{ + ID: "test-plugin-2", + Path: "/plugins/test2.wasm", + Manifest: `{"name":"Test Plugin 2","version":"2.0.0"}`, + Config: `{"setting":"value"}`, + SHA256: "def456", + Enabled: true, + } + + // Store users in mock datastore + Expect(ds.User(GinkgoT().Context()).Put(&adminUser)).To(Succeed()) + Expect(ds.User(GinkgoT().Context()).Put(®ularUser)).To(Succeed()) + }) + + Context("when plugins are disabled", func() { + BeforeEach(func() { + conf.Server.Plugins.Enabled = false + }) + + It("returns 404 for all plugin endpoints", func() { + adminToken, err := auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + req := httptest.NewRequest("GET", "/plugin", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + + Context("when plugins are enabled", func() { + Describe("as admin user", func() { + var adminToken string + + BeforeEach(func() { + var err error + adminToken, err = auth.CreateToken(&adminUser) + Expect(err).ToNot(HaveOccurred()) + + // Store test plugins as admin + ctx := GinkgoT().Context() + adminCtx := request.WithUser(ctx, adminUser) + Expect(ds.Plugin(adminCtx).Put(&testPlugin1)).To(Succeed()) + Expect(ds.Plugin(adminCtx).Put(&testPlugin2)).To(Succeed()) + }) + + Describe("GET /api/plugin", func() { + It("returns all plugins", func() { + req := httptest.NewRequest("GET", "/plugin", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugins []model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugins) + Expect(err).ToNot(HaveOccurred()) + Expect(plugins).To(HaveLen(2)) + }) + }) + + Describe("GET /api/plugin/{id}", func() { + It("returns a specific plugin", func() { + req := httptest.NewRequest("GET", "/plugin/test-plugin-1", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.ID).To(Equal("test-plugin-1")) + Expect(plugin.Path).To(Equal("/plugins/test1.wasm")) + }) + + It("returns 404 for non-existent plugin", func() { + req := httptest.NewRequest("GET", "/plugin/non-existent", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + }) + + Describe("PUT /api/plugin/{id}", func() { + It("updates plugin enabled state", func() { + // Configure mock to update the repo when EnablePlugin is called + mockManager.EnablePluginFn = func(ctx context.Context, id string) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Enabled = true + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"enabled":true}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Enabled).To(BeTrue()) + Expect(mockManager.EnablePluginCalls).To(ContainElement("test-plugin-1")) + }) + + It("updates plugin config with valid JSON", func() { + // Configure mock to update the repo when UpdatePluginConfig is called + mockManager.UpdatePluginConfigFn = func(ctx context.Context, id, configJSON string) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Config = configJSON + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"config":"{\"key\":\"value\"}"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Config).To(Equal(`{"key":"value"}`)) + Expect(mockManager.UpdatePluginConfigCalls).To(HaveLen(1)) + Expect(mockManager.UpdatePluginConfigCalls[0].ConfigJSON).To(Equal(`{"key":"value"}`)) + }) + + It("rejects invalid JSON in config field", func() { + body := bytes.NewBufferString(`{"config":"not valid json"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("Invalid JSON")) + }) + + It("allows empty config", func() { + // Configure mock to update the repo when UpdatePluginConfig is called + mockManager.UpdatePluginConfigFn = func(ctx context.Context, id, configJSON string) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Config = configJSON + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"config":""}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Config).To(Equal("")) + }) + + It("updates users field", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"users":"[\"user1\",\"user2\"]"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Users).To(Equal(`["user1","user2"]`)) + Expect(mockManager.UpdatePluginUsersCalls).To(HaveLen(1)) + Expect(mockManager.UpdatePluginUsersCalls[0].UsersJSON).To(Equal(`["user1","user2"]`)) + }) + + It("updates allUsers field", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"allUsers":true}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.AllUsers).To(BeTrue()) + Expect(mockManager.UpdatePluginUsersCalls).To(HaveLen(1)) + Expect(mockManager.UpdatePluginUsersCalls[0].AllUsers).To(BeTrue()) + }) + + It("updates both users and allUsers fields together", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"users":"[\"user1\"]","allUsers":false}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Users).To(Equal(`["user1"]`)) + Expect(plugin.AllUsers).To(BeFalse()) + Expect(mockManager.UpdatePluginUsersCalls).To(HaveLen(1)) + }) + + It("rejects invalid JSON in users field", func() { + body := bytes.NewBufferString(`{"users":"not valid json"}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("Invalid JSON")) + }) + + It("allows empty users", func() { + // Configure mock to update the repo when UpdatePluginUsers is called + mockManager.UpdatePluginUsersFn = func(ctx context.Context, id, usersJSON string, allUsers bool) error { + adminCtx := request.WithUser(ctx, adminUser) + p, _ := ds.Plugin(adminCtx).Get(id) + p.Users = usersJSON + p.AllUsers = allUsers + return ds.Plugin(adminCtx).Put(p) + } + + body := bytes.NewBufferString(`{"users":""}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + + var plugin model.Plugin + err := json.Unmarshal(w.Body.Bytes(), &plugin) + Expect(err).ToNot(HaveOccurred()) + Expect(plugin.Users).To(Equal("")) + }) + + It("returns 404 for non-existent plugin", func() { + body := bytes.NewBufferString(`{"enabled":true}`) + req := httptest.NewRequest("PUT", "/plugin/non-existent", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns 400 for invalid request body", func() { + body := bytes.NewBufferString(`not json`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + }) + + Describe("POST /api/plugin/rescan", func() { + It("triggers plugin rescan", func() { + req := httptest.NewRequest("POST", "/plugin/rescan", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(mockManager.RescanPluginsCalls).To(Equal(1)) + }) + + It("returns error when rescan fails", func() { + mockManager.RescanError = errors.New("folder not configured") + + req := httptest.NewRequest("POST", "/plugin/rescan", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+adminToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + Expect(w.Body.String()).To(ContainSubstring("folder not configured")) + }) + }) + }) + + Describe("as regular user", func() { + var userToken string + + BeforeEach(func() { + var err error + userToken, err = auth.CreateToken(®ularUser) + Expect(err).ToNot(HaveOccurred()) + }) + + It("denies access to GET /api/plugin", func() { + req := httptest.NewRequest("GET", "/plugin", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + + It("denies access to GET /api/plugin/{id}", func() { + req := httptest.NewRequest("GET", "/plugin/test-plugin-1", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + + It("denies access to PUT /api/plugin/{id}", func() { + body := bytes.NewBufferString(`{"enabled":true}`) + req := httptest.NewRequest("PUT", "/plugin/test-plugin-1", body) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + req.Header.Set("Content-Type", "application/json") + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + + It("denies access to POST /api/plugin/rescan", func() { + req := httptest.NewRequest("POST", "/plugin/rescan", nil) + req.Header.Set(consts.UIAuthorizationHeader, "Bearer "+userToken) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusForbidden)) + }) + }) + + Describe("without authentication", func() { + It("denies access to plugin endpoints", func() { + req := httptest.NewRequest("GET", "/plugin", nil) + w := httptest.NewRecorder() + + router.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusUnauthorized)) + }) + }) + }) +}) diff --git a/server/nativeapi/queue.go b/server/nativeapi/queue.go new file mode 100644 index 000000000..a7700c02c --- /dev/null +++ b/server/nativeapi/queue.go @@ -0,0 +1,214 @@ +package nativeapi + +import ( + "context" + "encoding/json" + "errors" + "net/http" + + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + . "github.com/navidrome/navidrome/utils/gg" + "github.com/navidrome/navidrome/utils/slice" +) + +type updateQueuePayload struct { + Ids *[]string `json:"ids,omitempty"` + Current *int `json:"current,omitempty"` + Position *int64 `json:"position,omitempty"` +} + +// validateCurrentIndex validates that the current index is within bounds of the items array. +// Returns false if validation fails (and sends error response), true if validation passes. +func validateCurrentIndex(w http.ResponseWriter, current int, itemsLength int) bool { + if current < 0 || current >= itemsLength { + http.Error(w, "current index out of bounds", http.StatusBadRequest) + return false + } + return true +} + +// retrieveExistingQueue retrieves an existing play queue for a user with proper error handling. +// Returns the queue (nil if not found) and false if an error occurred and response was sent. +func retrieveExistingQueue(ctx context.Context, w http.ResponseWriter, ds model.DataStore, userID string) (*model.PlayQueue, bool) { + existing, err := ds.PlayQueue(ctx).Retrieve(userID) + if err != nil && !errors.Is(err, model.ErrNotFound) { + log.Error(ctx, "Error retrieving queue", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return nil, false + } + return existing, true +} + +// decodeUpdatePayload decodes the JSON payload from the request body. +// Returns false if decoding fails (and sends error response), true if successful. +func decodeUpdatePayload(w http.ResponseWriter, r *http.Request) (*updateQueuePayload, bool) { + var payload updateQueuePayload + if err := json.NewDecoder(r.Body).Decode(&payload); err != nil { + http.Error(w, err.Error(), http.StatusBadRequest) + return nil, false + } + return &payload, true +} + +// createMediaFileItems converts a slice of IDs to MediaFile items. +func createMediaFileItems(ids []string) []model.MediaFile { + return slice.Map(ids, func(id string) model.MediaFile { + return model.MediaFile{ID: id} + }) +} + +// extractUserAndClient extracts user and client from the request context. +func extractUserAndClient(ctx context.Context) (model.User, string) { + user, _ := request.UserFrom(ctx) + client, _ := request.ClientFrom(ctx) + return user, client +} + +func getQueue(ds model.DataStore) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + user, _ := request.UserFrom(ctx) + repo := ds.PlayQueue(ctx) + pq, err := repo.RetrieveWithMediaFiles(user.ID) + if err != nil && !errors.Is(err, model.ErrNotFound) { + log.Error(ctx, "Error retrieving queue", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + if pq == nil { + pq = &model.PlayQueue{} + } + resp, err := json.Marshal(pq) + if err != nil { + log.Error(ctx, "Error marshalling queue", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + w.Header().Set("Content-Type", "application/json") + _, _ = w.Write(resp) //nolint:gosec + } +} + +func saveQueue(ds model.DataStore) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + payload, ok := decodeUpdatePayload(w, r) + if !ok { + return + } + user, client := extractUserAndClient(ctx) + ids := V(payload.Ids) + items := createMediaFileItems(ids) + current := V(payload.Current) + if len(ids) > 0 && !validateCurrentIndex(w, current, len(ids)) { + return + } + pq := &model.PlayQueue{ + UserID: user.ID, + Current: current, + Position: max(V(payload.Position), 0), + ChangedBy: client, + Items: items, + } + if err := ds.PlayQueue(ctx).Store(pq); err != nil { + log.Error(ctx, "Error saving queue", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + w.WriteHeader(http.StatusNoContent) + } +} + +func updateQueue(ds model.DataStore) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + // Decode and validate the JSON payload + payload, ok := decodeUpdatePayload(w, r) + if !ok { + return + } + + // Extract user and client information from request context + user, client := extractUserAndClient(ctx) + + // Initialize play queue with user ID and client info + pq := &model.PlayQueue{UserID: user.ID, ChangedBy: client} + var cols []string // Track which columns to update in the database + + // Handle queue items update + if payload.Ids != nil { + pq.Items = createMediaFileItems(*payload.Ids) + cols = append(cols, "items") + + // If current index is not being updated, validate existing current index + // against the new items list to ensure it remains valid + if payload.Current == nil { + existing, ok := retrieveExistingQueue(ctx, w, ds, user.ID) + if !ok { + return + } + if existing != nil && !validateCurrentIndex(w, existing.Current, len(*payload.Ids)) { + return + } + } + } + + // Handle current track index update + if payload.Current != nil { + pq.Current = *payload.Current + cols = append(cols, "current") + + if payload.Ids != nil { + // If items are also being updated, validate current index against new items + if !validateCurrentIndex(w, *payload.Current, len(*payload.Ids)) { + return + } + } else { + // If only current index is being updated, validate against existing items + existing, ok := retrieveExistingQueue(ctx, w, ds, user.ID) + if !ok { + return + } + if existing != nil && !validateCurrentIndex(w, *payload.Current, len(existing.Items)) { + return + } + } + } + + // Handle playback position update + if payload.Position != nil { + pq.Position = max(*payload.Position, 0) // Ensure position is non-negative + cols = append(cols, "position") + } + + // If no fields were specified for update, return success without doing anything + if len(cols) == 0 { + w.WriteHeader(http.StatusNoContent) + return + } + + // Perform partial update of the specified columns only + if err := ds.PlayQueue(ctx).Store(pq, cols...); err != nil { + log.Error(ctx, "Error updating queue", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + w.WriteHeader(http.StatusNoContent) + } +} + +func clearQueue(ds model.DataStore) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + user, _ := request.UserFrom(ctx) + if err := ds.PlayQueue(ctx).Clear(user.ID); err != nil { + log.Error(ctx, "Error clearing queue", err) + http.Error(w, err.Error(), http.StatusInternalServerError) + return + } + w.WriteHeader(http.StatusNoContent) + } +} diff --git a/server/nativeapi/queue_test.go b/server/nativeapi/queue_test.go new file mode 100644 index 000000000..0aad09718 --- /dev/null +++ b/server/nativeapi/queue_test.go @@ -0,0 +1,281 @@ +package nativeapi + +import ( + "bytes" + "encoding/json" + "net/http" + "net/http/httptest" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Queue Endpoints", func() { + var ( + ds *tests.MockDataStore + repo *tests.MockPlayQueueRepo + user model.User + userRepo *tests.MockedUserRepo + ) + + BeforeEach(func() { + repo = &tests.MockPlayQueueRepo{} + user = model.User{ID: "u1", UserName: "user"} + userRepo = tests.CreateMockUserRepo() + _ = userRepo.Put(&user) + ds = &tests.MockDataStore{MockedPlayQueue: repo, MockedUser: userRepo, MockedProperty: &tests.MockedPropertyRepo{}} + }) + + Describe("POST /queue", func() { + It("saves the queue", func() { + payload := updateQueuePayload{Ids: new([]string{"s1", "s2"}), Current: new(1), Position: new(int64(10))} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("POST", "/queue", bytes.NewReader(body)) + ctx := request.WithUser(req.Context(), user) + ctx = request.WithClient(ctx, "TestClient") + req = req.WithContext(ctx) + w := httptest.NewRecorder() + + saveQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusNoContent)) + Expect(repo.Queue).ToNot(BeNil()) + Expect(repo.Queue.Current).To(Equal(1)) + Expect(repo.Queue.Items).To(HaveLen(2)) + Expect(repo.Queue.Items[1].ID).To(Equal("s2")) + Expect(repo.Queue.ChangedBy).To(Equal("TestClient")) + }) + + It("saves an empty queue", func() { + payload := updateQueuePayload{Ids: new([]string{}), Current: new(0), Position: new(int64(0))} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("POST", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + saveQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusNoContent)) + Expect(repo.Queue).ToNot(BeNil()) + Expect(repo.Queue.Items).To(HaveLen(0)) + }) + + It("returns bad request for invalid current index (negative)", func() { + payload := updateQueuePayload{Ids: new([]string{"s1", "s2"}), Current: new(-1), Position: new(int64(10))} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("POST", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + saveQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("current index out of bounds")) + }) + + It("returns bad request for invalid current index (too large)", func() { + payload := updateQueuePayload{Ids: new([]string{"s1", "s2"}), Current: new(2), Position: new(int64(10))} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("POST", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + saveQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + Expect(w.Body.String()).To(ContainSubstring("current index out of bounds")) + }) + + It("returns bad request for malformed JSON", func() { + req := httptest.NewRequest("POST", "/queue", bytes.NewReader([]byte("invalid json"))) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + saveQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns internal server error when store fails", func() { + repo.Err = true + payload := updateQueuePayload{Ids: new([]string{"s1"}), Current: new(0), Position: new(int64(10))} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("POST", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + saveQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Describe("GET /queue", func() { + It("returns the queue", func() { + queue := &model.PlayQueue{ + UserID: user.ID, + Current: 1, + Position: 55, + Items: model.MediaFiles{ + {ID: "track1", Title: "Song 1"}, + {ID: "track2", Title: "Song 2"}, + {ID: "track3", Title: "Song 3"}, + }, + } + repo.Queue = queue + req := httptest.NewRequest("GET", "/queue", nil) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + getQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + var resp model.PlayQueue + Expect(json.Unmarshal(w.Body.Bytes(), &resp)).To(Succeed()) + Expect(resp.Current).To(Equal(1)) + Expect(resp.Position).To(Equal(int64(55))) + Expect(resp.Items).To(HaveLen(3)) + Expect(resp.Items[0].ID).To(Equal("track1")) + Expect(resp.Items[1].ID).To(Equal("track2")) + Expect(resp.Items[2].ID).To(Equal("track3")) + }) + + It("returns empty queue when user has no queue", func() { + req := httptest.NewRequest("GET", "/queue", nil) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + getQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusOK)) + var resp model.PlayQueue + Expect(json.Unmarshal(w.Body.Bytes(), &resp)).To(Succeed()) + Expect(resp.Items).To(BeEmpty()) + Expect(resp.Current).To(Equal(0)) + Expect(resp.Position).To(Equal(int64(0))) + }) + + It("returns internal server error when retrieve fails", func() { + repo.Err = true + req := httptest.NewRequest("GET", "/queue", nil) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + getQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Describe("PUT /queue", func() { + It("updates the queue fields", func() { + repo.Queue = &model.PlayQueue{UserID: user.ID, Items: model.MediaFiles{{ID: "s1"}, {ID: "s2"}, {ID: "s3"}}} + payload := updateQueuePayload{Current: new(2), Position: new(int64(20))} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("PUT", "/queue", bytes.NewReader(body)) + ctx := request.WithUser(req.Context(), user) + ctx = request.WithClient(ctx, "TestClient") + req = req.WithContext(ctx) + w := httptest.NewRecorder() + + updateQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusNoContent)) + Expect(repo.Queue).ToNot(BeNil()) + Expect(repo.Queue.Current).To(Equal(2)) + Expect(repo.Queue.Position).To(Equal(int64(20))) + Expect(repo.Queue.ChangedBy).To(Equal("TestClient")) + }) + + It("updates only ids", func() { + repo.Queue = &model.PlayQueue{UserID: user.ID, Current: 1} + payload := updateQueuePayload{Ids: new([]string{"s1", "s2"})} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("PUT", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + updateQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusNoContent)) + Expect(repo.Queue.Items).To(HaveLen(2)) + Expect(repo.LastCols).To(ConsistOf("items")) + }) + + It("updates ids and current", func() { + repo.Queue = &model.PlayQueue{UserID: user.ID} + payload := updateQueuePayload{Ids: new([]string{"s1", "s2"}), Current: new(1)} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("PUT", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + updateQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusNoContent)) + Expect(repo.Queue.Items).To(HaveLen(2)) + Expect(repo.Queue.Current).To(Equal(1)) + Expect(repo.LastCols).To(ConsistOf("items", "current")) + }) + + It("returns bad request when new ids invalidate current", func() { + repo.Queue = &model.PlayQueue{UserID: user.ID, Current: 2} + payload := updateQueuePayload{Ids: new([]string{"s1", "s2"})} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("PUT", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + updateQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns bad request when current out of bounds", func() { + repo.Queue = &model.PlayQueue{UserID: user.ID, Items: model.MediaFiles{{ID: "s1"}}} + payload := updateQueuePayload{Current: new(3)} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("PUT", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + updateQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns bad request for malformed JSON", func() { + req := httptest.NewRequest("PUT", "/queue", bytes.NewReader([]byte("{"))) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + updateQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns internal server error when store fails", func() { + repo.Err = true + payload := updateQueuePayload{Position: new(int64(10))} + body, _ := json.Marshal(payload) + req := httptest.NewRequest("PUT", "/queue", bytes.NewReader(body)) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + updateQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) + + Describe("DELETE /queue", func() { + It("clears the queue", func() { + repo.Queue = &model.PlayQueue{UserID: user.ID, Items: model.MediaFiles{{ID: "s1"}}} + req := httptest.NewRequest("DELETE", "/queue", nil) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + clearQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusNoContent)) + Expect(repo.Queue).To(BeNil()) + }) + + It("returns internal server error when clear fails", func() { + repo.Err = true + req := httptest.NewRequest("DELETE", "/queue", nil) + req = req.WithContext(request.WithUser(req.Context(), user)) + w := httptest.NewRecorder() + + clearQueue(ds)(w, req) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + }) +}) diff --git a/server/nativeapi/radios.go b/server/nativeapi/radios.go new file mode 100644 index 000000000..701c6c926 --- /dev/null +++ b/server/nativeapi/radios.go @@ -0,0 +1,70 @@ +package nativeapi + +import ( + "context" + "errors" + "io" + "net/http" + + "github.com/deluan/rest" + "github.com/go-chi/chi/v5" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server" +) + +func (api *Router) addRadioRoute(r chi.Router) { + constructor := func(ctx context.Context) rest.Repository { + return api.ds.Resource(ctx, model.Radio{}) + } + r.Route("/radio", func(r chi.Router) { + r.Get("/", rest.GetAll(constructor)) + r.Post("/", rest.Post(constructor)) + r.Route("/{id}", func(r chi.Router) { + r.Use(server.URLParamsMiddleware) + r.Get("/", rest.Get(constructor)) + r.Put("/", rest.Put(constructor)) + r.Delete("/", rest.Delete(constructor)) + r.Post("/image", api.uploadRadioImage()) + r.Delete("/image", api.deleteRadioImage()) + }) + }) +} + +func (api *Router) uploadRadioImage() http.HandlerFunc { + return handleImageUpload(func(ctx context.Context, reader io.Reader, ext string) error { + radioID := chi.URLParamFromCtx(ctx, "id") + radio, err := api.ds.Radio(ctx).Get(radioID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + oldPath := radio.UploadedImagePath() + filename, err := api.imgUpload.SetImage(ctx, consts.EntityRadio, radio.ID, radio.Name, oldPath, reader, ext) + if err != nil { + return err + } + radio.UploadedImage = filename + return api.ds.Radio(ctx).Put(radio, "UploadedImage") + }) +} + +func (api *Router) deleteRadioImage() http.HandlerFunc { + return handleImageDelete(func(ctx context.Context) error { + radioID := chi.URLParamFromCtx(ctx, "id") + radio, err := api.ds.Radio(ctx).Get(radioID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return model.ErrNotFound + } + return err + } + if err := api.imgUpload.RemoveImage(ctx, radio.UploadedImagePath()); err != nil { + return err + } + radio.UploadedImage = "" + return api.ds.Radio(ctx).Put(radio, "UploadedImage") + }) +} diff --git a/server/nativeapi/translations.go b/server/nativeapi/translations.go index d47b6e224..685713083 100644 --- a/server/nativeapi/translations.go +++ b/server/nativeapi/translations.go @@ -28,7 +28,7 @@ func newTranslationRepository(context.Context) rest.Repository { type translationRepository struct{} -func (r *translationRepository) Read(id string) (interface{}, error) { +func (r *translationRepository) Read(id string) (any, error) { translations, _ := loadTranslations() if t, ok := translations[id]; ok { return t, nil @@ -43,7 +43,7 @@ func (r *translationRepository) Count(...rest.QueryOptions) (int64, error) { } // ReadAll simple implementation, only returns IDs. Does not support any `options` -func (r *translationRepository) ReadAll(...rest.QueryOptions) (interface{}, error) { +func (r *translationRepository) ReadAll(...rest.QueryOptions) (any, error) { translations, _ := loadTranslations() var result []translation for _, t := range translations { @@ -57,7 +57,7 @@ func (r *translationRepository) EntityName() string { return "translation" } -func (r *translationRepository) NewInstance() interface{} { +func (r *translationRepository) NewInstance() any { return &translation{} } @@ -103,7 +103,7 @@ func loadTranslation(fsys fs.FS, fileName string) (translation translation, err if err != nil { return } - var out map[string]interface{} + var out map[string]any if err = json.Unmarshal(data, &out); err != nil { return } diff --git a/server/nativeapi/translations_test.go b/server/nativeapi/translations_test.go index c49c26c67..6c834070c 100644 --- a/server/nativeapi/translations_test.go +++ b/server/nativeapi/translations_test.go @@ -9,6 +9,7 @@ import ( "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/resources" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -16,6 +17,7 @@ import ( var _ = Describe("Translations", func() { Describe("I18n files", func() { It("contains only valid json language files", func() { + tests.SkipOnWindows("path separator bug (#TBD-path-sep-nativeapi)") fsys := resources.FS() dir, _ := fsys.Open(consts.I18nFolder) files, _ := dir.(fs.ReadDirFile).ReadDir(-1) @@ -24,7 +26,7 @@ var _ = Describe("Translations", func() { filePath := filepath.Join(consts.I18nFolder, name) file, _ := fsys.Open(filePath) data, _ := io.ReadAll(file) - var out map[string]interface{} + var out map[string]any Expect(filepath.Ext(filePath)).To(Equal(".json"), filePath) Expect(json.Unmarshal(data, &out)).To(BeNil(), filePath) @@ -40,7 +42,7 @@ var _ = Describe("Translations", func() { Expect(err).To(BeNil()) Expect(tr.ID).To(Equal("en")) Expect(tr.Name).To(Equal("English")) - var out map[string]interface{} + var out map[string]any Expect(json.Unmarshal([]byte(tr.Data), &out)).To(BeNil()) }) }) diff --git a/server/public/encode_id.go b/server/public/encode_id.go deleted file mode 100644 index 6adf0e71f..000000000 --- a/server/public/encode_id.go +++ /dev/null @@ -1,71 +0,0 @@ -package public - -import ( - "context" - "errors" - "net/http" - "net/url" - "path" - "strconv" - - "github.com/lestrrat-go/jwx/v2/jwt" - "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/auth" - "github.com/navidrome/navidrome/model" - . "github.com/navidrome/navidrome/utils/gg" -) - -func ImageURL(r *http.Request, artID model.ArtworkID, size int) string { - token := encodeArtworkID(artID) - uri := path.Join(consts.URLPathPublicImages, token) - params := url.Values{} - if size > 0 { - params.Add("size", strconv.Itoa(size)) - } - return publicURL(r, uri, params) -} - -func encodeArtworkID(artID model.ArtworkID) string { - token, _ := auth.CreatePublicToken(map[string]any{"id": artID.String()}) - return token -} - -func decodeArtworkID(tokenString string) (model.ArtworkID, error) { - token, err := auth.TokenAuth.Decode(tokenString) - if err != nil { - return model.ArtworkID{}, err - } - if token == nil { - return model.ArtworkID{}, errors.New("unauthorized") - } - err = jwt.Validate(token, jwt.WithRequiredClaim("id")) - if err != nil { - return model.ArtworkID{}, err - } - claims, err := token.AsMap(context.Background()) - if err != nil { - return model.ArtworkID{}, err - } - id, ok := claims["id"].(string) - if !ok { - return model.ArtworkID{}, errors.New("invalid id type") - } - artID, err := model.ParseArtworkID(id) - if err == nil { - return artID, nil - } - // Try to default to mediafile artworkId (if used with a mediafileShare token) - return model.ParseArtworkID("mf-" + id) -} - -func encodeMediafileShare(s model.Share, id string) string { - claims := map[string]any{"id": id} - if s.Format != "" { - claims["f"] = s.Format - } - if s.MaxBitRate != 0 { - claims["b"] = s.MaxBitRate - } - token, _ := auth.CreateExpiringPublicToken(V(s.ExpiresAt), claims) - return token -} diff --git a/server/public/encode_id_test.go b/server/public/encode_id_test.go deleted file mode 100644 index efd252e4e..000000000 --- a/server/public/encode_id_test.go +++ /dev/null @@ -1,39 +0,0 @@ -package public - -import ( - "github.com/go-chi/jwtauth/v5" - "github.com/navidrome/navidrome/core/auth" - "github.com/navidrome/navidrome/model" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("encodeArtworkID", func() { - Context("Public ID Encoding", func() { - BeforeEach(func() { - auth.TokenAuth = jwtauth.New("HS256", []byte("super secret"), nil) - }) - It("returns a reversible string representation", func() { - id := model.NewArtworkID(model.KindArtistArtwork, "1234", nil) - encoded := encodeArtworkID(id) - decoded, err := decodeArtworkID(encoded) - Expect(err).ToNot(HaveOccurred()) - Expect(decoded).To(Equal(id)) - }) - It("fails to decode an invalid token", func() { - _, err := decodeArtworkID("xx-123") - Expect(err).To(MatchError("invalid JWT")) - }) - It("defaults to kind mediafile", func() { - encoded := encodeArtworkID(model.ArtworkID{}) - id, err := decodeArtworkID(encoded) - Expect(err).ToNot(HaveOccurred()) - Expect(id.Kind).To(Equal(model.KindMediaFileArtwork)) - }) - It("fails to decode a token without an id", func() { - token, _ := auth.CreatePublicToken(map[string]any{}) - _, err := decodeArtworkID(token) - Expect(err).To(HaveOccurred()) - }) - }) -}) diff --git a/server/public/handle_images.go b/server/public/handle_images.go index f178692f8..50f9238e5 100644 --- a/server/public/handle_images.go +++ b/server/public/handle_images.go @@ -8,6 +8,7 @@ import ( "time" "github.com/navidrome/navidrome/core/artwork" + "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/req" @@ -33,12 +34,13 @@ func (pub *Router) handleImages(w http.ResponseWriter, r *http.Request) { artId, err := decodeArtworkID(id) if err != nil { log.Error(r, "Error decoding artwork id", "id", id, err) - http.Error(w, err.Error(), http.StatusBadRequest) + http.Error(w, "invalid request", http.StatusBadRequest) return } size := p.IntOr("size", 0) + square := p.BoolOr("square", false) - imgReader, lastUpdate, err := pub.artwork.Get(ctx, artId, size, false) + imgReader, lastUpdate, err := pub.artwork.Get(ctx, artId, size, square) switch { case errors.Is(err, context.Canceled): return @@ -58,9 +60,29 @@ func (pub *Router) handleImages(w http.ResponseWriter, r *http.Request) { defer imgReader.Close() w.Header().Set("Cache-Control", "public, max-age=315360000") - w.Header().Set("Last-Modified", lastUpdate.Format(time.RFC1123)) + w.Header().Set("Last-Modified", lastUpdate.Format(http.TimeFormat)) cnt, err := io.Copy(w, imgReader) if err != nil { log.Warn(ctx, "Error sending image", "count", cnt, err) } } + +func decodeArtworkID(tokenString string) (model.ArtworkID, error) { + token, err := auth.TokenAuth.Decode(tokenString) + if err != nil { + return model.ArtworkID{}, err + } + if token == nil { + return model.ArtworkID{}, errors.New("unauthorized") + } + c := auth.ClaimsFromToken(token) + if c.ID == "" { + return model.ArtworkID{}, errors.New("required claim \"id\" not found") + } + artID, err := model.ParseArtworkID(c.ID) + if err == nil { + return artID, nil + } + // Try to default to mediafile artworkId (if used with a mediafileShare token) + return model.ParseArtworkID("mf-" + c.ID) +} diff --git a/server/public/handle_images_test.go b/server/public/handle_images_test.go new file mode 100644 index 000000000..6895241f6 --- /dev/null +++ b/server/public/handle_images_test.go @@ -0,0 +1,25 @@ +package public + +import ( + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/core/auth" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("decodeArtworkID", func() { + BeforeEach(func() { + auth.TokenAuth = jwtauth.New("HS256", []byte("super secret"), nil) + }) + + It("fails to decode an invalid token", func() { + _, err := decodeArtworkID("xx-123") + Expect(err).To(HaveOccurred()) + }) + + It("fails to decode a token without an id", func() { + token, _ := auth.CreatePublicToken(auth.Claims{}) + _, err := decodeArtworkID(token) + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/server/public/handle_shares.go b/server/public/handle_shares.go index 61f3fba71..18bfcc01c 100644 --- a/server/public/handle_shares.go +++ b/server/public/handle_shares.go @@ -6,11 +6,15 @@ import ( "net/http" "path" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/ui" + . "github.com/navidrome/navidrome/utils/gg" "github.com/navidrome/navidrome/utils/req" ) @@ -56,7 +60,7 @@ func (pub *Router) handleM3U(w http.ResponseWriter, r *http.Request) { s = pub.mapShareToM3U(r, *s) w.WriteHeader(http.StatusOK) w.Header().Set("Content-Type", "audio/x-mpegurl") - _, _ = w.Write([]byte(s.ToM3U8())) + _, _ = w.Write([]byte(s.ToM3U8())) //nolint:gosec } func checkShareError(ctx context.Context, w http.ResponseWriter, err error, id string) { @@ -78,7 +82,7 @@ func checkShareError(ctx context.Context, w http.ResponseWriter, err error, id s func (pub *Router) mapShareInfo(r *http.Request, s model.Share) *model.Share { s.URL = ShareURL(r, s.ID) - s.ImageURL = ImageURL(r, s.CoverArtID(), consts.UICoverArtSize) + s.ImageURL = publicurl.ImageURL(r, s.CoverArtID(), conf.Server.UICoverArtSize) for i := range s.Tracks { s.Tracks[i].ID = encodeMediafileShare(s, s.Tracks[i].ID) } @@ -88,7 +92,18 @@ func (pub *Router) mapShareInfo(r *http.Request, s model.Share) *model.Share { func (pub *Router) mapShareToM3U(r *http.Request, s model.Share) *model.Share { for i := range s.Tracks { id := encodeMediafileShare(s, s.Tracks[i].ID) - s.Tracks[i].Path = publicURL(r, path.Join(consts.URLPathPublic, "s", id), nil) + s.Tracks[i].Path = publicurl.PublicURL(r, path.Join(consts.URLPathPublic, "s", id), nil) } return &s } + +func encodeMediafileShare(s model.Share, id string) string { + claims := auth.Claims{ + ID: id, + Format: s.Format, + BitRate: s.MaxBitRate, + ShareID: s.ID, + } + token, _ := auth.CreateExpiringPublicToken(V(s.ExpiresAt), claims) + return token +} diff --git a/server/public/handle_streams.go b/server/public/handle_streams.go index cf120f0b5..c7b8a4d4f 100644 --- a/server/public/handle_streams.go +++ b/server/public/handle_streams.go @@ -1,15 +1,16 @@ package public import ( - "context" "errors" - "io" "net/http" "strconv" + "time" - "github.com/lestrrat-go/jwx/v2/jwt" "github.com/navidrome/navidrome/core/auth" + streampkg "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + . "github.com/navidrome/navidrome/utils/gg" "github.com/navidrome/navidrome/utils/req" ) @@ -24,10 +25,41 @@ func (pub *Router) handleStream(w http.ResponseWriter, r *http.Request) { return } - stream, err := pub.streamer.NewStream(ctx, info.id, info.format, info.bitrate, 0) + if info.shareID != "" { + share, err := pub.ds.Share(ctx).Get(info.shareID) + if err != nil { + checkShareError(ctx, w, err, info.shareID) + return + } + if expiresAt := V(share.ExpiresAt); !expiresAt.IsZero() && expiresAt.Before(time.Now()) { + checkShareError(ctx, w, model.ErrExpired, info.shareID) + return + } + } + + mf, err := pub.ds.MediaFile(ctx).Get(info.id) if err != nil { + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "not found", http.StatusNotFound) + } else { + log.Error(ctx, "Error retrieving media file for shared stream", "id", info.id, err) + http.Error(w, "internal error", http.StatusInternalServerError) + } + return + } + + stream, err := pub.streamer.NewStream(ctx, mf, streampkg.Request{ + Format: info.format, BitRate: info.bitrate, + }) + if err != nil { + if errors.Is(err, streampkg.ErrTooManyTranscodes) { + w.Header().Set("Retry-After", strconv.Itoa(streampkg.RetryAfterSeconds)) + http.Error(w, "too many concurrent transcodes, please retry shortly", http.StatusTooManyRequests) + return + } log.Error(ctx, "Error starting shared stream", err) http.Error(w, "invalid request", http.StatusInternalServerError) + return } // Make sure the stream will be closed at the end, to avoid leakage @@ -40,34 +72,9 @@ func (pub *Router) handleStream(w http.ResponseWriter, r *http.Request) { w.Header().Set("X-Content-Type-Options", "nosniff") w.Header().Set("X-Content-Duration", strconv.FormatFloat(float64(stream.Duration()), 'G', -1, 32)) - if stream.Seekable() { - http.ServeContent(w, r, stream.Name(), stream.ModTime(), stream) - } else { - // If the stream doesn't provide a size (i.e. is not seekable), we can't support ranges/content-length - w.Header().Set("Accept-Ranges", "none") - w.Header().Set("Content-Type", stream.ContentType()) - - estimateContentLength := p.BoolOr("estimateContentLength", false) - - // if Client requests the estimated content-length, send it - if estimateContentLength { - length := strconv.Itoa(stream.EstimatedContentLength()) - log.Trace(ctx, "Estimated content-length", "contentLength", length) - w.Header().Set("Content-Length", length) - } - - if r.Method == http.MethodHead { - go func() { _, _ = io.Copy(io.Discard, stream) }() - } else { - c, err := io.Copy(w, stream) - if log.IsGreaterOrEqualTo(log.LevelDebug) { - if err != nil { - log.Error(ctx, "Error sending shared transcoded file", "id", info.id, err) - } else { - log.Trace(ctx, "Success sending shared transcode file", "id", info.id, "size", c) - } - } - } + n, err := stream.Serve(ctx, w, r) + if err != nil || n == 0 { + http.Error(w, "internal error", http.StatusInternalServerError) } } @@ -75,31 +82,21 @@ type shareTrackInfo struct { id string format string bitrate int + shareID string } func decodeStreamInfo(tokenString string) (shareTrackInfo, error) { - token, err := auth.TokenAuth.Decode(tokenString) + c, err := auth.Validate(tokenString) if err != nil { return shareTrackInfo{}, err } - if token == nil { - return shareTrackInfo{}, errors.New("unauthorized") + if c.ID == "" { + return shareTrackInfo{}, errors.New("required claim \"id\" not found") } - err = jwt.Validate(token, jwt.WithRequiredClaim("id")) - if err != nil { - return shareTrackInfo{}, err - } - claims, err := token.AsMap(context.Background()) - if err != nil { - return shareTrackInfo{}, err - } - id, ok := claims["id"].(string) - if !ok { - return shareTrackInfo{}, errors.New("invalid id type") - } - resp := shareTrackInfo{} - resp.id = id - resp.format, _ = claims["f"].(string) - resp.bitrate, _ = claims["b"].(int) - return resp, nil + return shareTrackInfo{ + id: c.ID, + format: c.Format, + bitrate: c.BitRate, + shareID: c.ShareID, + }, nil } diff --git a/server/public/handle_streams_test.go b/server/public/handle_streams_test.go new file mode 100644 index 000000000..f43d75a26 --- /dev/null +++ b/server/public/handle_streams_test.go @@ -0,0 +1,194 @@ +package public + +import ( + "context" + "errors" + "net/http" + "net/http/httptest" + "time" + + "github.com/go-chi/jwtauth/v5" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +type mockStreamer struct { + req stream.Request + called bool +} + +func (m *mockStreamer) NewStream(_ context.Context, _ *model.MediaFile, r stream.Request) (*stream.Stream, error) { + m.called = true + m.req = r + return nil, errors.New("mock: not implemented") +} + +var _ = Describe("decodeStreamInfo", func() { + BeforeEach(func() { + auth.TokenAuth = jwtauth.New("HS256", []byte("test-secret"), nil) + }) + + It("decodes a valid token with all fields", func() { + claims := auth.Claims{ID: "mf-123", Format: "mp3", BitRate: 192, ShareID: "share123"} + token, _ := auth.CreateExpiringPublicToken(time.Now().Add(time.Hour), claims) + info, err := decodeStreamInfo(token) + Expect(err).NotTo(HaveOccurred()) + Expect(info.id).To(Equal("mf-123")) + Expect(info.format).To(Equal("mp3")) + Expect(info.bitrate).To(Equal(192)) + Expect(info.shareID).To(Equal("share123")) + }) + + It("rejects an expired token", func() { + claims := auth.Claims{ID: "mf-123", ShareID: "share123"} + token, _ := auth.CreateExpiringPublicToken(time.Now().Add(-time.Hour), claims) + _, err := decodeStreamInfo(token) + Expect(err).To(HaveOccurred()) + }) + + It("accepts a token without exp (non-expiring share)", func() { + claims := auth.Claims{ID: "mf-123", ShareID: "share123"} + token, _ := auth.CreatePublicToken(claims) + info, err := decodeStreamInfo(token) + Expect(err).NotTo(HaveOccurred()) + Expect(info.id).To(Equal("mf-123")) + Expect(info.shareID).To(Equal("share123")) + }) + + It("rejects a token without an id claim", func() { + claims := auth.Claims{ShareID: "share123"} + token, _ := auth.CreatePublicToken(claims) + _, err := decodeStreamInfo(token) + Expect(err).To(HaveOccurred()) + }) + + It("rejects an invalid token string", func() { + _, err := decodeStreamInfo("not-a-valid-token") + Expect(err).To(HaveOccurred()) + }) + + It("handles tokens without shareID (backward compat)", func() { + claims := auth.Claims{ID: "mf-123", Format: "opus"} + token, _ := auth.CreatePublicToken(claims) + info, err := decodeStreamInfo(token) + Expect(err).NotTo(HaveOccurred()) + Expect(info.id).To(Equal("mf-123")) + Expect(info.format).To(Equal("opus")) + Expect(info.shareID).To(BeEmpty()) + }) +}) + +var _ = Describe("encodeMediafileShare", func() { + BeforeEach(func() { + auth.TokenAuth = jwtauth.New("HS256", []byte("test-secret"), nil) + }) + + It("includes the share ID in the token", func() { + exp := new(time.Now().Add(time.Hour)) + s := model.Share{ID: "shareABC", Format: "mp3", MaxBitRate: 320, ExpiresAt: exp} + token := encodeMediafileShare(s, "mf-999") + info, err := decodeStreamInfo(token) + Expect(err).NotTo(HaveOccurred()) + Expect(info.shareID).To(Equal("shareABC")) + Expect(info.id).To(Equal("mf-999")) + Expect(info.format).To(Equal("mp3")) + Expect(info.bitrate).To(Equal(320)) + }) + + It("creates a non-expiring token when share has no expiry", func() { + s := model.Share{ID: "shareXYZ", ExpiresAt: nil} + token := encodeMediafileShare(s, "mf-111") + info, err := decodeStreamInfo(token) + Expect(err).NotTo(HaveOccurred()) + Expect(info.shareID).To(Equal("shareXYZ")) + Expect(info.id).To(Equal("mf-111")) + }) +}) + +var _ = Describe("handleStream", func() { + var ds *tests.MockDataStore + var shareRepo *tests.MockShareRepo + var streamer *mockStreamer + var pub *Router + + BeforeEach(func() { + auth.TokenAuth = jwtauth.New("HS256", []byte("test-secret"), nil) + ds = &tests.MockDataStore{} + shareRepo = &tests.MockShareRepo{} + ds.MockedShare = shareRepo + streamer = &mockStreamer{} + pub = &Router{ds: ds, streamer: streamer} + }) + + makeRequest := func(token string) *httptest.ResponseRecorder { + r := httptest.NewRequest("GET", "/public/s/token?%3Aid="+token, nil) + w := httptest.NewRecorder() + pub.handleStream(w, r) + return w + } + + It("passes all validation and reaches the streamer for a valid token", func() { + shareRepo.ID = "share123" + mfRepo := tests.CreateMockMediaFileRepo() + mfRepo.SetData(model.MediaFiles{{ID: "mf-123", Title: "Test Song"}}) + ds.MockedMediaFile = mfRepo + + claims := auth.Claims{ID: "mf-123", Format: "mp3", BitRate: 192, ShareID: "share123"} + token, _ := auth.CreateExpiringPublicToken(time.Now().Add(time.Hour), claims) + makeRequest(token) + + Expect(streamer.called).To(BeTrue()) + Expect(streamer.req.Format).To(Equal("mp3")) + Expect(streamer.req.BitRate).To(Equal(192)) + }) + + It("returns 400 for an expired token", func() { + claims := auth.Claims{ID: "mf-123", ShareID: "share123"} + token, _ := auth.CreateExpiringPublicToken(time.Now().Add(-time.Hour), claims) + w := makeRequest(token) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 404 when share has been deleted", func() { + shareRepo.ID = "other-share" + claims := auth.Claims{ID: "mf-123", ShareID: "deleted-share"} + token, _ := auth.CreateExpiringPublicToken(time.Now().Add(time.Hour), claims) + w := makeRequest(token) + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns 410 when share has been set to expired", func() { + shareRepo.ID = "share123" + shareRepo.Entity = &model.Share{ID: "share123", ExpiresAt: new(time.Now().Add(-time.Hour))} + + claims := auth.Claims{ID: "mf-123", ShareID: "share123"} + token, _ := auth.CreatePublicToken(claims) + w := makeRequest(token) + Expect(w.Code).To(Equal(http.StatusGone)) + }) + + It("returns 500 when share lookup fails", func() { + shareRepo.Error = errors.New("db error") + claims := auth.Claims{ID: "mf-123", ShareID: "share123"} + token, _ := auth.CreateExpiringPublicToken(time.Now().Add(time.Hour), claims) + w := makeRequest(token) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + }) + + It("skips share check for tokens without shareID (backward compat)", func() { + claims := auth.Claims{ID: "mf-123"} + token, _ := auth.CreatePublicToken(claims) + w := makeRequest(token) + // Should get past share check, then fail on media file lookup (no mock data) + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns 400 for an invalid token", func() { + w := makeRequest("not-a-valid-token") + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) +}) diff --git a/server/public/public.go b/server/public/public.go index 03ccaeebe..18867e1c4 100644 --- a/server/public/public.go +++ b/server/public/public.go @@ -2,16 +2,15 @@ package public import ( "net/http" - "net/url" "path" "github.com/go-chi/chi/v5" - "github.com/go-chi/chi/v5/middleware" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" - "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/core/publicurl" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/ui" @@ -20,14 +19,14 @@ import ( type Router struct { http.Handler artwork artwork.Artwork - streamer core.MediaStreamer + streamer stream.MediaStreamer archiver core.Archiver share core.Share assetsHandler http.Handler ds model.DataStore } -func New(ds model.DataStore, artwork artwork.Artwork, streamer core.MediaStreamer, share core.Share, archiver core.Archiver) *Router { +func New(ds model.DataStore, artwork artwork.Artwork, streamer stream.MediaStreamer, share core.Share, archiver core.Archiver) *Router { p := &Router{ds: ds, artwork: artwork, streamer: streamer, share: share, archiver: archiver} shareRoot := path.Join(conf.Server.BasePath, consts.URLPathPublic) p.assetsHandler = http.StripPrefix(shareRoot, http.FileServer(http.FS(ui.BuildAssets()))) @@ -42,13 +41,8 @@ func (pub *Router) routes() http.Handler { r.Group(func(r chi.Router) { r.Use(server.URLParamsMiddleware) r.Group(func(r chi.Router) { - if conf.Server.DevArtworkMaxRequests > 0 { - log.Debug("Throttling public images endpoint", "maxRequests", conf.Server.DevArtworkMaxRequests, - "backlogLimit", conf.Server.DevArtworkThrottleBacklogLimit, "backlogTimeout", - conf.Server.DevArtworkThrottleBacklogTimeout) - r.Use(middleware.ThrottleBacklog(conf.Server.DevArtworkMaxRequests, conf.Server.DevArtworkThrottleBacklogLimit, - conf.Server.DevArtworkThrottleBacklogTimeout)) - } + r.Use(server.ThrottleBacklog(conf.Server.DevArtworkMaxRequests, conf.Server.DevArtworkThrottleBacklogLimit, + conf.Server.DevArtworkThrottleBacklogTimeout)) r.HandleFunc("/img/{id}", pub.handleImages) }) if conf.Server.EnableSharing { @@ -67,19 +61,5 @@ func (pub *Router) routes() http.Handler { func ShareURL(r *http.Request, id string) string { uri := path.Join(consts.URLPathPublic, id) - return publicURL(r, uri, nil) -} - -func publicURL(r *http.Request, u string, params url.Values) string { - if conf.Server.ShareURL != "" { - shareUrl, _ := url.Parse(conf.Server.ShareURL) - buildUrl, _ := url.Parse(u) - buildUrl.Scheme = shareUrl.Scheme - buildUrl.Host = shareUrl.Host - if len(params) > 0 { - buildUrl.RawQuery = params.Encode() - } - return buildUrl.String() - } - return server.AbsoluteURL(r, u, params) + return publicurl.PublicURL(r, uri, nil) } diff --git a/server/public/public_test.go b/server/public/public_test.go deleted file mode 100644 index c45fadf65..000000000 --- a/server/public/public_test.go +++ /dev/null @@ -1,56 +0,0 @@ -package public - -import ( - "net/http" - "net/url" - "path" - - "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/consts" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -var _ = Describe("publicURL", func() { - When("ShareURL is set", func() { - BeforeEach(func() { - conf.Server.ShareURL = "http://share.myotherserver.com" - }) - It("uses the config value instead of AbsoluteURL", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublic, "123") - actual := publicURL(r, uri, nil) - Expect(actual).To(Equal("http://share.myotherserver.com/share/123")) - }) - It("concatenates params if provided", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublicImages, "123") - params := url.Values{ - "size": []string{"300"}, - } - actual := publicURL(r, uri, params) - Expect(actual).To(Equal("http://share.myotherserver.com/share/img/123?size=300")) - - }) - }) - When("ShareURL is not set", func() { - BeforeEach(func() { - conf.Server.ShareURL = "" - }) - It("uses AbsoluteURL", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublic, "123") - actual := publicURL(r, uri, nil) - Expect(actual).To(Equal("https://myserver.com/share/123")) - }) - It("concatenates params if provided", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/share/123", nil) - uri := path.Join(consts.URLPathPublicImages, "123") - params := url.Values{ - "size": []string{"300"}, - } - actual := publicURL(r, uri, params) - Expect(actual).To(Equal("https://myserver.com/share/img/123?size=300")) - }) - }) -}) diff --git a/server/serve_index.go b/server/serve_index.go index 9a457ac20..13fa4a9ce 100644 --- a/server/serve_index.go +++ b/server/serve_index.go @@ -39,13 +39,13 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl http.NotFound(w, r) return } - appConfig := map[string]interface{}{ + appConfig := map[string]any{ "version": consts.Version, "firstTime": firstTime, "variousArtistsId": consts.VariousArtistsID, "baseURL": str.SanitizeText(strings.TrimSuffix(conf.Server.BasePath, "/")), "loginBackgroundURL": str.SanitizeText(conf.Server.UILoginBackgroundURL), - "welcomeMessage": str.SanitizeText(conf.Server.UIWelcomeMessage), + "welcomeMessage": str.SanitizeHTML(conf.Server.UIWelcomeMessage), "maxSidebarPlaylists": conf.Server.MaxSidebarPlaylists, "enableTranscodingConfig": conf.Server.EnableTranscodingConfig, "enableDownloads": conf.Server.EnableDownloads, @@ -54,23 +54,32 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl "defaultTheme": conf.Server.DefaultTheme, "defaultLanguage": conf.Server.DefaultLanguage, "defaultUIVolume": conf.Server.DefaultUIVolume, + "uiSearchDebounceMs": conf.Server.UISearchDebounceMs, + "uiCoverArtSize": conf.Server.UICoverArtSize, "enableCoverAnimation": conf.Server.EnableCoverAnimation, + "enableNowPlaying": conf.Server.EnableNowPlaying, + "playbackReportIntervalMs": conf.Server.UIPlaybackReportInterval.Milliseconds(), "gaTrackingId": conf.Server.GATrackingID, "losslessFormats": strings.ToUpper(strings.Join(mime.LosslessFormats, ",")), "devActivityPanel": conf.Server.DevActivityPanel, "enableUserEditing": conf.Server.EnableUserEditing, + "enableArtworkUpload": conf.Server.EnableArtworkUpload, "enableSharing": conf.Server.EnableSharing, "shareURL": conf.Server.ShareURL, "defaultDownloadableShare": conf.Server.DefaultDownloadableShare, "devSidebarPlaylists": conf.Server.DevSidebarPlaylists, "lastFMEnabled": conf.Server.LastFM.Enabled, "devShowArtistPage": conf.Server.DevShowArtistPage, + "devUIShowConfig": conf.Server.DevUIShowConfig, + "devNewEventStream": conf.Server.DevNewEventStream, "listenBrainzEnabled": conf.Server.ListenBrainz.Enabled, "enableExternalServices": conf.Server.EnableExternalServices, "enableReplayGain": conf.Server.EnableReplayGain, "defaultDownsamplingFormat": conf.Server.DefaultDownsamplingFormat, "separator": string(os.PathSeparator), "enableInspect": conf.Server.Inspect.Enabled, + "pluginsEnabled": conf.Server.Plugins.Enabled, + "extAuthLogoutURL": conf.Server.ExtAuth.LogoutURL, } if strings.HasPrefix(conf.Server.UILoginBackgroundURL, "/") { appConfig["loginBackgroundURL"] = path.Join(conf.Server.BasePath, conf.Server.UILoginBackgroundURL) @@ -91,7 +100,7 @@ func serveIndex(ds model.DataStore, fs fs.FS, shareInfo *model.Share) http.Handl if version != "dev" { version = "v" + version } - data := map[string]interface{}{ + data := map[string]any{ "AppConfig": string(appConfigJson), "Version": version, } @@ -141,7 +150,7 @@ type shareTrack struct { Duration float32 `json:"duration,omitempty"` } -func addShareData(r *http.Request, data map[string]interface{}, shareInfo *model.Share) { +func addShareData(r *http.Request, data map[string]any, shareInfo *model.Share) { ctx := r.Context() if shareInfo == nil || shareInfo.ID == "" { return diff --git a/server/serve_index_test.go b/server/serve_index_test.go index 0f02153fd..78f3873b8 100644 --- a/server/serve_index_test.go +++ b/server/serve_index_test.go @@ -39,7 +39,7 @@ var _ = Describe("serveIndex", func() { Expect(w.Code).To(Equal(200)) config := extractAppConfig(w.Body.String()) - Expect(config).To(BeAssignableToTypeOf(map[string]interface{}{})) + Expect(config).To(BeAssignableToTypeOf(map[string]any{})) }) It("sets firstTime = true when User table is empty", func() { @@ -53,17 +53,6 @@ var _ = Describe("serveIndex", func() { Expect(config).To(HaveKeyWithValue("firstTime", true)) }) - It("includes the VariousArtistsID", func() { - mockUser.empty = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("variousArtistsId", consts.VariousArtistsID)) - }) - It("sets firstTime = false when User table is not empty", func() { mockUser.empty = false r := httptest.NewRequest("GET", "/index.html", nil) @@ -75,267 +64,80 @@ var _ = Describe("serveIndex", func() { Expect(config).To(HaveKeyWithValue("firstTime", false)) }) - It("sets baseURL", func() { - conf.Server.BasePath = "base_url_test" + DescribeTable("sets configuration values", + func(configSetter func(), configKey string, expectedValue any) { + configSetter() + r := httptest.NewRequest("GET", "/index.html", nil) + w := httptest.NewRecorder() + + serveIndex(ds, fs, nil)(w, r) + + config := extractAppConfig(w.Body.String()) + Expect(config).To(HaveKeyWithValue(configKey, expectedValue)) + }, + Entry("baseURL", func() { conf.Server.BasePath = "base_url_test" }, "baseURL", "base_url_test"), + Entry("welcomeMessage", func() { conf.Server.UIWelcomeMessage = "Hello" }, "welcomeMessage", "Hello"), + Entry("maxSidebarPlaylists", func() { conf.Server.MaxSidebarPlaylists = 42 }, "maxSidebarPlaylists", float64(42)), + Entry("enableTranscodingConfig", func() { conf.Server.EnableTranscodingConfig = true }, "enableTranscodingConfig", true), + Entry("enableDownloads", func() { conf.Server.EnableDownloads = true }, "enableDownloads", true), + Entry("enableFavourites", func() { conf.Server.EnableFavourites = true }, "enableFavourites", true), + Entry("enableStarRating", func() { conf.Server.EnableStarRating = true }, "enableStarRating", true), + Entry("defaultTheme", func() { conf.Server.DefaultTheme = "Light" }, "defaultTheme", "Light"), + Entry("defaultLanguage", func() { conf.Server.DefaultLanguage = "pt" }, "defaultLanguage", "pt"), + Entry("defaultUIVolume", func() { conf.Server.DefaultUIVolume = 45 }, "defaultUIVolume", float64(45)), + Entry("uiSearchDebounceMs", func() { conf.Server.UISearchDebounceMs = 500 }, "uiSearchDebounceMs", float64(500)), + Entry("uiCoverArtSize", func() { conf.Server.UICoverArtSize = 300 }, "uiCoverArtSize", float64(300)), + Entry("enableCoverAnimation", func() { conf.Server.EnableCoverAnimation = true }, "enableCoverAnimation", true), + Entry("enableNowPlaying", func() { conf.Server.EnableNowPlaying = true }, "enableNowPlaying", true), + Entry("gaTrackingId", func() { conf.Server.GATrackingID = "UA-12345" }, "gaTrackingId", "UA-12345"), + Entry("defaultDownloadableShare", func() { conf.Server.DefaultDownloadableShare = true }, "defaultDownloadableShare", true), + Entry("devSidebarPlaylists", func() { conf.Server.DevSidebarPlaylists = true }, "devSidebarPlaylists", true), + Entry("lastFMEnabled", func() { conf.Server.LastFM.Enabled = true }, "lastFMEnabled", true), + Entry("devShowArtistPage", func() { conf.Server.DevShowArtistPage = true }, "devShowArtistPage", true), + Entry("devUIShowConfig", func() { conf.Server.DevUIShowConfig = true }, "devUIShowConfig", true), + Entry("listenBrainzEnabled", func() { conf.Server.ListenBrainz.Enabled = true }, "listenBrainzEnabled", true), + Entry("enableReplayGain", func() { conf.Server.EnableReplayGain = true }, "enableReplayGain", true), + Entry("enableExternalServices", func() { conf.Server.EnableExternalServices = true }, "enableExternalServices", true), + Entry("devActivityPanel", func() { conf.Server.DevActivityPanel = true }, "devActivityPanel", true), + Entry("shareURL", func() { conf.Server.ShareURL = "https://share.example.com" }, "shareURL", "https://share.example.com"), + Entry("enableInspect", func() { conf.Server.Inspect.Enabled = true }, "enableInspect", true), + Entry("defaultDownsamplingFormat", func() { conf.Server.DefaultDownsamplingFormat = "mp3" }, "defaultDownsamplingFormat", "mp3"), + Entry("enableUserEditing", func() { conf.Server.EnableUserEditing = false }, "enableUserEditing", false), + Entry("enableSharing", func() { conf.Server.EnableSharing = true }, "enableSharing", true), + Entry("devNewEventStream", func() { conf.Server.DevNewEventStream = true }, "devNewEventStream", true), + Entry("extAuthLogoutURL", func() { conf.Server.ExtAuth.LogoutURL = "https://auth.example.com/logout" }, "extAuthLogoutURL", "https://auth.example.com/logout"), + Entry("playbackReportIntervalMs", func() { conf.Server.UIPlaybackReportInterval = 30 * time.Second }, "playbackReportIntervalMs", float64(30000)), + ) + + It("sanitizes entity-encoded welcomeMessage as html", func() { + conf.Server.UIWelcomeMessage = `<img src=x onerror=alert(1)><b>Hello</b>` r := httptest.NewRequest("GET", "/index.html", nil) w := httptest.NewRecorder() serveIndex(ds, fs, nil)(w, r) config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("baseURL", "base_url_test")) + Expect(config).To(HaveKey("welcomeMessage")) + Expect(config["welcomeMessage"]).To(Equal(`<img src="x"><b>Hello</b>`)) }) - It("sets the welcomeMessage", func() { - conf.Server.UIWelcomeMessage = "Hello" - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("welcomeMessage", "Hello")) - }) - - It("sets the maxSidebarPlaylists", func() { - conf.Server.MaxSidebarPlaylists = 42 - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("maxSidebarPlaylists", float64(42))) - }) - - It("sets the enableTranscodingConfig", func() { - conf.Server.EnableTranscodingConfig = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableTranscodingConfig", true)) - }) - - It("sets the enableDownloads", func() { - conf.Server.EnableDownloads = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableDownloads", true)) - }) - - It("sets the enableLoved", func() { - conf.Server.EnableFavourites = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableFavourites", true)) - }) - - It("sets the enableStarRating", func() { - conf.Server.EnableStarRating = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableStarRating", true)) - }) - - It("sets the defaultTheme", func() { - conf.Server.DefaultTheme = "Light" - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("defaultTheme", "Light")) - }) - - It("sets the defaultLanguage", func() { - conf.Server.DefaultLanguage = "pt" - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("defaultLanguage", "pt")) - }) - - It("sets the defaultUIVolume", func() { - conf.Server.DefaultUIVolume = 45 - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("defaultUIVolume", float64(45))) - }) - - It("sets the enableCoverAnimation", func() { - conf.Server.EnableCoverAnimation = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableCoverAnimation", true)) - }) - - It("sets the gaTrackingId", func() { - conf.Server.GATrackingID = "UA-12345" - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("gaTrackingId", "UA-12345")) - }) - - It("sets the version", func() { - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("version", consts.Version)) - }) - - It("sets the losslessFormats", func() { - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - expected := strings.ToUpper(strings.Join(mime.LosslessFormats, ",")) - Expect(config).To(HaveKeyWithValue("losslessFormats", expected)) - }) - - It("sets the enableUserEditing", func() { - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableUserEditing", true)) - }) - - It("sets the enableSharing", func() { - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableSharing", false)) - }) - - It("sets the defaultDownloadableShare", func() { - conf.Server.DefaultDownloadableShare = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("defaultDownloadableShare", true)) - }) - - It("sets the defaultDownsamplingFormat", func() { - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("defaultDownsamplingFormat", conf.Server.DefaultDownsamplingFormat)) - }) - - It("sets the devSidebarPlaylists", func() { - conf.Server.DevSidebarPlaylists = true - - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("devSidebarPlaylists", true)) - }) - - It("sets the lastFMEnabled", func() { - conf.Server.LastFM.Enabled = true - - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("lastFMEnabled", true)) - }) - - It("sets the devShowArtistPage", func() { - conf.Server.DevShowArtistPage = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("devShowArtistPage", true)) - }) - - It("sets the listenBrainzEnabled", func() { - conf.Server.ListenBrainz.Enabled = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("listenBrainzEnabled", true)) - }) - - It("sets the enableReplayGain", func() { - conf.Server.EnableReplayGain = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableReplayGain", true)) - }) - - It("sets the enableExternalServices", func() { - conf.Server.EnableExternalServices = true - r := httptest.NewRequest("GET", "/index.html", nil) - w := httptest.NewRecorder() - - serveIndex(ds, fs, nil)(w, r) - - config := extractAppConfig(w.Body.String()) - Expect(config).To(HaveKeyWithValue("enableExternalServices", true)) - }) + DescribeTable("sets other UI configuration values", + func(configKey string, expectedValueFunc func() any) { + r := httptest.NewRequest("GET", "/index.html", nil) + w := httptest.NewRecorder() + + serveIndex(ds, fs, nil)(w, r) + + config := extractAppConfig(w.Body.String()) + Expect(config).To(HaveKeyWithValue(configKey, expectedValueFunc())) + }, + Entry("version", "version", func() any { return consts.Version }), + Entry("variousArtistsId", "variousArtistsId", func() any { return consts.VariousArtistsID }), + Entry("losslessFormats", "losslessFormats", func() any { + return strings.ToUpper(strings.Join(mime.LosslessFormats, ",")) + }), + Entry("separator", "separator", func() any { return string(os.PathSeparator) }), + ) Describe("loginBackgroundURL", func() { Context("empty BaseURL", func() { @@ -426,12 +228,12 @@ var _ = Describe("serveIndex", func() { var _ = Describe("addShareData", func() { var ( r *http.Request - data map[string]interface{} + data map[string]any shareInfo *model.Share ) BeforeEach(func() { - data = make(map[string]interface{}) + data = make(map[string]any) r = httptest.NewRequest("GET", "/", nil) }) @@ -516,8 +318,8 @@ var _ = Describe("addShareData", func() { var appConfigRegex = regexp.MustCompile(`(?m)window.__APP_CONFIG__=(.*);</script>`) -func extractAppConfig(body string) map[string]interface{} { - config := make(map[string]interface{}) +func extractAppConfig(body string) map[string]any { + config := make(map[string]any) match := appConfigRegex.FindStringSubmatch(body) if match == nil { return config diff --git a/server/server.go b/server/server.go index 60350b6b4..b05c20cc5 100644 --- a/server/server.go +++ b/server/server.go @@ -1,13 +1,14 @@ package server import ( - "cmp" + "bytes" "context" + "crypto/tls" + "encoding/pem" "errors" "fmt" "net" "net/http" - "net/url" "os" "path" "strconv" @@ -69,11 +70,18 @@ func (s *Server) Run(ctx context.Context, addr string, port int, tlsCert string, // Determine if TLS is enabled tlsEnabled := tlsCert != "" && tlsKey != "" + // Validate TLS certificates before starting the server + if tlsEnabled { + if err := validateTLSCertificates(tlsCert, tlsKey); err != nil { + return err + } + } + // Create a listener based on the address type (either Unix socket or TCP) var listener net.Listener var err error - if strings.HasPrefix(addr, "unix:") { - socketPath := strings.TrimPrefix(addr, "unix:") + if after, ok := strings.CutPrefix(addr, "unix:"); ok { + socketPath := after listener, err = createUnixSocketFile(socketPath, conf.Server.UnixSocketPerm) if err != nil { return err @@ -89,17 +97,17 @@ func (s *Server) Run(ctx context.Context, addr string, port int, tlsCert string, // Start the server in a new goroutine and send an error signal to errC if there's an error errC := make(chan error) go func() { + var err error if tlsEnabled { // Start the HTTPS server log.Info("Starting server with TLS (HTTPS) enabled", "tlsCert", tlsCert, "tlsKey", tlsKey) - if err := server.ServeTLS(listener, tlsCert, tlsKey); !errors.Is(err, http.ErrServerClosed) { - errC <- err - } + err = server.ServeTLS(listener, tlsCert, tlsKey) } else { // Start the HTTP server - if err := server.Serve(listener); !errors.Is(err, http.ErrServerClosed) { - errC <- err - } + err = server.Serve(listener) + } + if !errors.Is(err, http.ErrServerClosed) { + errC <- err } }() @@ -173,7 +181,7 @@ func (s *Server) initRoutes() { clientUniqueIDMiddleware, compressMiddleware(), loggerInjector, - jwtVerifier, + JWTVerifier, } // Mount the Native API /events endpoint with all default middlewares, adding the authentication middlewares @@ -232,20 +240,55 @@ func (s *Server) frontendAssetsHandler() http.Handler { return r } -func AbsoluteURL(r *http.Request, u string, params url.Values) string { - buildUrl, _ := url.Parse(u) - if strings.HasPrefix(u, "/") { - buildUrl.Path = path.Join(conf.Server.BasePath, buildUrl.Path) - if conf.Server.BaseHost != "" { - buildUrl.Scheme = cmp.Or(conf.Server.BaseScheme, "http") - buildUrl.Host = conf.Server.BaseHost - } else { - buildUrl.Scheme = r.URL.Scheme - buildUrl.Host = r.Host +// validateTLSCertificates validates the TLS certificate and key files before starting the server. +// It provides detailed error messages for common issues like encrypted private keys. +func validateTLSCertificates(certFile, keyFile string) error { + // Read the key file to check for encryption + keyData, err := os.ReadFile(keyFile) //nolint:gosec + if err != nil { + return fmt.Errorf("reading TLS key file: %w", err) + } + + // Parse PEM blocks and check for encryption + block, _ := pem.Decode(keyData) + if block == nil { + return errors.New("TLS key file does not contain a valid PEM block") + } + + // Check for encrypted private key indicators + if isEncryptedPEM(block, keyData) { + return errors.New("TLS private key is encrypted (password-protected). " + + "Navidrome does not support encrypted private keys. " + + "Please decrypt your key using: openssl pkey -in <encrypted-key> -out <decrypted-key>") + } + + // Try to load the certificate pair to validate it + _, err = tls.LoadX509KeyPair(certFile, keyFile) + if err != nil { + return fmt.Errorf("loading TLS certificate/key pair: %w", err) + } + + return nil +} + +// isEncryptedPEM checks if a PEM block represents an encrypted private key. +func isEncryptedPEM(block *pem.Block, rawData []byte) bool { + // Check for PKCS#8 encrypted format (BEGIN ENCRYPTED PRIVATE KEY) + if block.Type == "ENCRYPTED PRIVATE KEY" { + return true + } + + // Check for legacy encrypted format with Proc-Type header + if block.Headers != nil { + if procType, ok := block.Headers["Proc-Type"]; ok && strings.Contains(procType, "ENCRYPTED") { + return true } } - if len(params) > 0 { - buildUrl.RawQuery = params.Encode() + + // Also check raw data for DEK-Info header (in case pem.Decode doesn't parse headers correctly) + if bytes.Contains(rawData, []byte("DEK-Info:")) || bytes.Contains(rawData, []byte("Proc-Type: 4,ENCRYPTED")) { + return true } - return buildUrl.String() + + return false } diff --git a/server/server_test.go b/server/server_test.go index f9a43a802..178c0015a 100644 --- a/server/server_test.go +++ b/server/server_test.go @@ -1,67 +1,22 @@ package server import ( + "context" + "crypto/tls" + "crypto/x509" + "fmt" "io/fs" "net/http" - "net/url" "os" "path/filepath" + "time" - "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) -var _ = Describe("AbsoluteURL", func() { - When("BaseURL is empty", func() { - BeforeEach(func() { - conf.Server.BasePath = "" - }) - It("uses the scheme/host from the request", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("https://myserver.com/share/img/123?a=xyz")) - }) - It("does not override provided schema/host", func() { - r, _ := http.NewRequest("GET", "http://localhost/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "http://public.myserver.com/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("http://public.myserver.com/share/img/123?a=xyz")) - }) - }) - When("BaseURL has only path", func() { - BeforeEach(func() { - conf.Server.BasePath = "/music" - }) - It("uses the scheme/host from the request", func() { - r, _ := http.NewRequest("GET", "https://myserver.com/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("https://myserver.com/music/share/img/123?a=xyz")) - }) - It("does not override provided schema/host", func() { - r, _ := http.NewRequest("GET", "http://localhost/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "http://public.myserver.com/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("http://public.myserver.com/share/img/123?a=xyz")) - }) - }) - When("BaseURL has full URL", func() { - BeforeEach(func() { - conf.Server.BaseScheme = "https" - conf.Server.BaseHost = "myserver.com:8080" - conf.Server.BasePath = "/music" - }) - It("use the configured scheme/host/path", func() { - r, _ := http.NewRequest("GET", "https://localhost:4533/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("https://myserver.com:8080/music/share/img/123?a=xyz")) - }) - It("does not override provided schema/host", func() { - r, _ := http.NewRequest("GET", "http://localhost/rest/ping?id=123", nil) - actual := AbsoluteURL(r, "http://public.myserver.com/share/img/123", url.Values{"a": []string{"xyz"}}) - Expect(actual).To(Equal("http://public.myserver.com/share/img/123?a=xyz")) - }) - }) -}) - var _ = Describe("createUnixSocketFile", func() { var socketPath string @@ -75,6 +30,7 @@ var _ = Describe("createUnixSocketFile", func() { When("unixSocketPerm is valid", func() { It("updates the permission of the unix socket file and returns nil", func() { + tests.SkipOnWindows("uses Unix file permission bits") _, err := createUnixSocketFile(socketPath, "0777") fileInfo, _ := os.Stat(socketPath) actualPermission := fileInfo.Mode().Perm() @@ -95,6 +51,7 @@ var _ = Describe("createUnixSocketFile", func() { When("file already exists", func() { It("recreates the file as a socket with the right permissions", func() { + tests.SkipOnWindows("uses Unix file permission bits") _, err := os.Create(socketPath) Expect(err).ToNot(HaveOccurred()) Expect(os.Chmod(socketPath, os.FileMode(0777))).To(Succeed()) @@ -107,3 +64,146 @@ var _ = Describe("createUnixSocketFile", func() { }) }) }) + +var _ = Describe("TLS support", func() { + Describe("validateTLSCertificates", func() { + const testDataDir = "server/testdata" + + When("certificate and key are valid and unencrypted", func() { + It("returns nil", func() { + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).ToNot(HaveOccurred()) + }) + }) + + When("private key is encrypted with PKCS#8 format", func() { + It("returns an error with helpful message", func() { + certFile := filepath.Join(testDataDir, "test_cert_encrypted.pem") + keyFile := filepath.Join(testDataDir, "test_key_encrypted.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("encrypted")) + Expect(err.Error()).To(ContainSubstring("openssl")) + }) + }) + + When("private key is encrypted with legacy format (Proc-Type header)", func() { + It("returns an error with helpful message", func() { + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key_encrypted_legacy.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("encrypted")) + Expect(err.Error()).To(ContainSubstring("openssl")) + }) + }) + + When("key file does not exist", func() { + It("returns an error", func() { + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "nonexistent.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("reading TLS key file")) + }) + }) + + When("key file does not contain valid PEM", func() { + It("returns an error", func() { + // Create a temp file with invalid PEM content + tmpFile, err := os.CreateTemp("", "invalid_key*.pem") + Expect(err).ToNot(HaveOccurred()) + DeferCleanup(func() { + _ = os.Remove(tmpFile.Name()) + }) + _, err = tmpFile.WriteString("not a valid PEM file") + Expect(err).ToNot(HaveOccurred()) + _ = tmpFile.Close() + + certFile := filepath.Join(testDataDir, "test_cert.pem") + err = validateTLSCertificates(certFile, tmpFile.Name()) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("valid PEM block")) + }) + }) + + When("certificate file does not exist", func() { + It("returns an error from tls.LoadX509KeyPair", func() { + certFile := filepath.Join(testDataDir, "nonexistent_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key.pem") + err := validateTLSCertificates(certFile, keyFile) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("loading TLS certificate/key pair")) + }) + }) + }) + + Describe("Server TLS", func() { + const testDataDir = "server/testdata" + + When("server is started with valid TLS certificates", func() { + It("accepts HTTPS connections", func() { + DeferCleanup(configtest.SetupConfig()) + + // Create server with mock dependencies + ds := &tests.MockDataStore{} + server := New(ds, nil, nil) + + // Load the test certificate to create a trusted CA pool + certFile := filepath.Join(testDataDir, "test_cert.pem") + keyFile := filepath.Join(testDataDir, "test_key.pem") + caCert, err := os.ReadFile(certFile) + Expect(err).ToNot(HaveOccurred()) + + caCertPool := x509.NewCertPool() + caCertPool.AppendCertsFromPEM(caCert) + + // Create an HTTPS client that trusts our test certificate + httpClient := &http.Client{ + Timeout: 5 * time.Second, + Transport: &http.Transport{ + TLSClientConfig: &tls.Config{ + RootCAs: caCertPool, + MinVersion: tls.VersionTLS12, + }, + }, + } + + // Start the server in a goroutine + ctx, cancel := context.WithCancel(GinkgoT().Context()) + defer cancel() + + errChan := make(chan error, 1) + go func() { + errChan <- server.Run(ctx, "127.0.0.1", 14534, certFile, keyFile) + }() + + Eventually(func() error { + // Make an HTTPS request to the server + resp, err := httpClient.Get("https://127.0.0.1:14534/ping") + if err != nil { + return err + } + defer resp.Body.Close() + if resp.StatusCode != http.StatusOK { + return fmt.Errorf("unexpected status code: %d", resp.StatusCode) + } + return nil + }, 2*time.Second, 100*time.Millisecond).Should(Succeed()) + + // Stop the server + cancel() + + // Wait for server to stop (with timeout) + select { + case <-errChan: + // Server stopped + case <-time.After(2 * time.Second): + Fail("Server did not stop in time") + } + }) + }) + }) +}) diff --git a/server/subsonic/album_lists.go b/server/subsonic/album_lists.go index 39a164500..0d82c8be9 100644 --- a/server/subsonic/album_lists.go +++ b/server/subsonic/album_lists.go @@ -12,6 +12,7 @@ import ( "github.com/navidrome/navidrome/server/subsonic/filter" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" + "github.com/navidrome/navidrome/utils/run" "github.com/navidrome/navidrome/utils/slice" ) @@ -61,6 +62,13 @@ func (api *Router) getAlbumList(r *http.Request) (model.Albums, int64, error) { return nil, 0, newError(responses.ErrorGeneric, "type '%s' not implemented", typ) } + // Get optional library IDs from musicFolderId parameter + musicFolderIds, err := selectedMusicFolderIds(r, false) + if err != nil { + return nil, 0, err + } + opts = filter.ApplyLibraryFilter(opts, musicFolderIds) + opts.Offset = p.IntOr("offset", 0) opts.Max = min(p.IntOr("size", 10), 500) albums, err := api.ds.Album(r.Context()).GetAll(opts) @@ -109,57 +117,87 @@ func (api *Router) GetAlbumList2(w http.ResponseWriter, r *http.Request) (*respo return response, nil } -func (api *Router) GetStarred(r *http.Request) (*responses.Subsonic, error) { +func (api *Router) getStarredItems(r *http.Request) (model.Artists, model.Albums, model.MediaFiles, error) { ctx := r.Context() - artists, err := api.ds.Artist(ctx).GetAll(filter.ArtistsByStarred()) + + // Get optional library IDs from musicFolderId parameter + musicFolderIds, err := selectedMusicFolderIds(r, false) if err != nil { - log.Error(r, "Error retrieving starred artists", err) - return nil, err + return nil, nil, nil, err } - options := filter.ByStarred() - albums, err := api.ds.Album(ctx).GetAll(options) + + // Prepare variables to capture results from parallel execution + var artists model.Artists + var albums model.Albums + var mediaFiles model.MediaFiles + + // Execute all three queries in parallel for better performance + err = run.Parallel( + // Query starred artists + func() error { + artistOpts := filter.ApplyArtistLibraryFilter(filter.ArtistsByStarred(), musicFolderIds) + var err error + artists, err = api.ds.Artist(ctx).GetAll(artistOpts) + if err != nil { + log.Error(r, "Error retrieving starred artists", err) + } + return err + }, + // Query starred albums + func() error { + albumOpts := filter.ApplyLibraryFilter(filter.ByStarred(), musicFolderIds) + var err error + albums, err = api.ds.Album(ctx).GetAll(albumOpts) + if err != nil { + log.Error(r, "Error retrieving starred albums", err) + } + return err + }, + // Query starred media files + func() error { + mediaFileOpts := filter.ApplyLibraryFilter(filter.ByStarred(), musicFolderIds) + var err error + mediaFiles, err = api.ds.MediaFile(ctx).GetAll(mediaFileOpts) + if err != nil { + log.Error(r, "Error retrieving starred mediaFiles", err) + } + return err + }, + )() + + // Return the first error if any occurred if err != nil { - log.Error(r, "Error retrieving starred albums", err) - return nil, err + return nil, nil, nil, err } - mediaFiles, err := api.ds.MediaFile(ctx).GetAll(options) + + return artists, albums, mediaFiles, nil +} + +func (api *Router) GetStarred(r *http.Request) (*responses.Subsonic, error) { + artists, albums, mediaFiles, err := api.getStarredItems(r) if err != nil { - log.Error(r, "Error retrieving starred mediaFiles", err) return nil, err } response := newResponse() response.Starred = &responses.Starred{} response.Starred.Artist = slice.MapWithArg(artists, r, toArtist) - response.Starred.Album = slice.MapWithArg(albums, ctx, childFromAlbum) - response.Starred.Song = slice.MapWithArg(mediaFiles, ctx, childFromMediaFile) + response.Starred.Album = slice.MapWithArg(albums, r.Context(), childFromAlbum) + response.Starred.Song = slice.MapWithArg(mediaFiles, r.Context(), childFromMediaFile) return response, nil } func (api *Router) GetStarred2(r *http.Request) (*responses.Subsonic, error) { - ctx := r.Context() - artists, err := api.ds.Artist(ctx).GetAll(filter.ArtistsByStarred()) + artists, albums, mediaFiles, err := api.getStarredItems(r) if err != nil { - log.Error(r, "Error retrieving starred artists", err) - return nil, err - } - options := filter.ByStarred() - albums, err := api.ds.Album(ctx).GetAll(options) - if err != nil { - log.Error(r, "Error retrieving starred albums", err) - return nil, err - } - mediaFiles, err := api.ds.MediaFile(ctx).GetAll(options) - if err != nil { - log.Error(r, "Error retrieving starred mediaFiles", err) return nil, err } response := newResponse() response.Starred2 = &responses.Starred2{} response.Starred2.Artist = slice.MapWithArg(artists, r, toArtistID3) - response.Starred2.Album = slice.MapWithArg(albums, ctx, buildAlbumID3) - response.Starred2.Song = slice.MapWithArg(mediaFiles, ctx, childFromMediaFile) + response.Starred2.Album = slice.MapWithArg(albums, r.Context(), buildAlbumID3) + response.Starred2.Song = slice.MapWithArg(mediaFiles, r.Context(), childFromMediaFile) return response, nil } @@ -174,13 +212,17 @@ func (api *Router) GetNowPlaying(r *http.Request) (*responses.Subsonic, error) { response := newResponse() response.NowPlaying = &responses.NowPlaying{} var i int32 - response.NowPlaying.Entry = slice.Map(npInfo, func(np scrobbler.NowPlayingInfo) responses.NowPlayingEntry { + response.NowPlaying.Entry = slice.Map(npInfo, func(np scrobbler.PlaybackSession) responses.NowPlayingEntry { + i++ return responses.NowPlayingEntry{ - Child: childFromMediaFile(ctx, np.MediaFile), - UserName: np.Username, - MinutesAgo: int32(time.Since(np.Start).Minutes()), - PlayerId: i + 1, // Fake numeric playerId, it does not seem to be used for anything - PlayerName: np.PlayerName, + Child: childFromMediaFile(ctx, np.MediaFile), + UserName: np.Username, + MinutesAgo: int32(time.Since(np.Start).Minutes()), + PlayerId: i, + PlayerName: np.PlayerName, + State: np.State, + PositionMs: np.PositionMs, + PlaybackRate: np.PlaybackRate, } }) return response, nil @@ -193,7 +235,15 @@ func (api *Router) GetRandomSongs(r *http.Request) (*responses.Subsonic, error) fromYear := p.IntOr("fromYear", 0) toYear := p.IntOr("toYear", 0) - songs, err := api.getSongs(r.Context(), 0, size, filter.SongsByRandom(genre, fromYear, toYear)) + // Get optional library IDs from musicFolderId parameter + musicFolderIds, err := selectedMusicFolderIds(r, false) + if err != nil { + return nil, err + } + opts := filter.SongsByRandom(genre, fromYear, toYear) + opts = filter.ApplyLibraryFilter(opts, musicFolderIds) + + songs, err := api.getSongs(r.Context(), 0, size, opts) if err != nil { log.Error(r, "Error retrieving random songs", err) return nil, err @@ -211,8 +261,16 @@ func (api *Router) GetSongsByGenre(r *http.Request) (*responses.Subsonic, error) offset := p.IntOr("offset", 0) genre, _ := p.String("genre") + // Get optional library IDs from musicFolderId parameter + musicFolderIds, err := selectedMusicFolderIds(r, false) + if err != nil { + return nil, err + } + opts := filter.ByGenre(genre) + opts = filter.ApplyLibraryFilter(opts, musicFolderIds) + ctx := r.Context() - songs, err := api.getSongs(ctx, offset, count, filter.ByGenre(genre)) + songs, err := api.getSongs(ctx, offset, count, opts) if err != nil { log.Error(r, "Error retrieving random songs", err) return nil, err diff --git a/server/subsonic/album_lists_test.go b/server/subsonic/album_lists_test.go index f187555e9..220376b15 100644 --- a/server/subsonic/album_lists_test.go +++ b/server/subsonic/album_lists_test.go @@ -5,12 +5,13 @@ import ( "errors" "net/http/httptest" - "github.com/navidrome/navidrome/server/subsonic/responses" - "github.com/navidrome/navidrome/utils/req" - + "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/tests" + "github.com/navidrome/navidrome/utils/req" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -24,8 +25,9 @@ var _ = Describe("Album Lists", func() { BeforeEach(func() { ds = &tests.MockDataStore{} + auth.Init(ds) mockRepo = ds.Album(ctx).(*tests.MockAlbumRepo) - router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) w = httptest.NewRecorder() }) @@ -63,6 +65,74 @@ var _ = Describe("Album Lists", func() { errors.As(err, &subErr) Expect(subErr.code).To(Equal(responses.ErrorGeneric)) }) + + Context("with musicFolderId parameter", func() { + var user model.User + var ctx context.Context + + BeforeEach(func() { + user = model.User{ + ID: "test-user", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + } + ctx = request.WithUser(context.Background(), user) + }) + + It("should filter albums by specific library when musicFolderId is provided", func() { + r := newGetRequest("type=newest", "musicFolderId=1") + r = r.WithContext(ctx) + mockRepo.SetData(model.Albums{ + {ID: "1"}, {ID: "2"}, + }) + + resp, err := router.GetAlbumList(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?)")) + Expect(args).To(ContainElement(1)) + }) + + It("should filter albums by multiple libraries when multiple musicFolderId are provided", func() { + r := newGetRequest("type=newest", "musicFolderId=1", "musicFolderId=2") + r = r.WithContext(ctx) + mockRepo.SetData(model.Albums{ + {ID: "1"}, {ID: "2"}, + }) + + resp, err := router.GetAlbumList(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?,?)")) + Expect(args).To(ContainElements(1, 2)) + }) + + It("should return all accessible albums when no musicFolderId is provided", func() { + r := newGetRequest("type=newest") + r = r.WithContext(ctx) + mockRepo.SetData(model.Albums{ + {ID: "1"}, {ID: "2"}, + }) + + resp, err := router.GetAlbumList(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.AlbumList.Album).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?,?,?)")) + Expect(args).To(ContainElements(1, 2, 3)) + }) + }) }) Describe("GetAlbumList2", func() { @@ -100,5 +170,373 @@ var _ = Describe("Album Lists", func() { errors.As(err, &subErr) Expect(subErr.code).To(Equal(responses.ErrorGeneric)) }) + + Context("with musicFolderId parameter", func() { + var user model.User + var ctx context.Context + + BeforeEach(func() { + user = model.User{ + ID: "test-user", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + } + ctx = request.WithUser(context.Background(), user) + }) + + It("should filter albums by specific library when musicFolderId is provided", func() { + r := newGetRequest("type=newest", "musicFolderId=1") + r = r.WithContext(ctx) + mockRepo.SetData(model.Albums{ + {ID: "1"}, {ID: "2"}, + }) + + resp, err := router.GetAlbumList2(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.AlbumList2.Album).To(HaveLen(2)) + // Verify that library filter was applied + Expect(mockRepo.Options.Filters).ToNot(BeNil()) + }) + + It("should filter albums by multiple libraries when multiple musicFolderId are provided", func() { + r := newGetRequest("type=newest", "musicFolderId=1", "musicFolderId=2") + r = r.WithContext(ctx) + mockRepo.SetData(model.Albums{ + {ID: "1"}, {ID: "2"}, + }) + + resp, err := router.GetAlbumList2(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.AlbumList2.Album).To(HaveLen(2)) + // Verify that library filter was applied + Expect(mockRepo.Options.Filters).ToNot(BeNil()) + }) + + It("should return all accessible albums when no musicFolderId is provided", func() { + r := newGetRequest("type=newest") + r = r.WithContext(ctx) + mockRepo.SetData(model.Albums{ + {ID: "1"}, {ID: "2"}, + }) + + resp, err := router.GetAlbumList2(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.AlbumList2.Album).To(HaveLen(2)) + }) + }) + }) + + Describe("GetRandomSongs", func() { + var mockMediaFileRepo *tests.MockMediaFileRepo + + BeforeEach(func() { + mockMediaFileRepo = ds.MediaFile(ctx).(*tests.MockMediaFileRepo) + }) + + It("should return random songs", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("size=2") + + resp, err := router.GetRandomSongs(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + }) + + Context("with musicFolderId parameter", func() { + var user model.User + var ctx context.Context + + BeforeEach(func() { + user = model.User{ + ID: "test-user", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + } + ctx = request.WithUser(context.Background(), user) + }) + + It("should filter songs by specific library when musicFolderId is provided", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("size=2", "musicFolderId=1") + r = r.WithContext(ctx) + + resp, err := router.GetRandomSongs(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockMediaFileRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?)")) + Expect(args).To(ContainElement(1)) + }) + + It("should filter songs by multiple libraries when multiple musicFolderId are provided", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("size=2", "musicFolderId=1", "musicFolderId=2") + r = r.WithContext(ctx) + + resp, err := router.GetRandomSongs(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockMediaFileRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?,?)")) + Expect(args).To(ContainElements(1, 2)) + }) + + It("should return all accessible songs when no musicFolderId is provided", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("size=2") + r = r.WithContext(ctx) + + resp, err := router.GetRandomSongs(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.RandomSongs.Songs).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockMediaFileRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?,?,?)")) + Expect(args).To(ContainElements(1, 2, 3)) + }) + }) + }) + + Describe("GetSongsByGenre", func() { + var mockMediaFileRepo *tests.MockMediaFileRepo + + BeforeEach(func() { + mockMediaFileRepo = ds.MediaFile(ctx).(*tests.MockMediaFileRepo) + }) + + It("should return songs by genre", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("count=2", "genre=rock") + + resp, err := router.GetSongsByGenre(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.SongsByGenre.Songs).To(HaveLen(2)) + }) + + Context("with musicFolderId parameter", func() { + var user model.User + var ctx context.Context + + BeforeEach(func() { + user = model.User{ + ID: "test-user", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + } + ctx = request.WithUser(context.Background(), user) + }) + + It("should filter songs by specific library when musicFolderId is provided", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("count=2", "genre=rock", "musicFolderId=1") + r = r.WithContext(ctx) + + resp, err := router.GetSongsByGenre(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.SongsByGenre.Songs).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockMediaFileRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?)")) + Expect(args).To(ContainElement(1)) + }) + + It("should filter songs by multiple libraries when multiple musicFolderId are provided", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("count=2", "genre=rock", "musicFolderId=1", "musicFolderId=2") + r = r.WithContext(ctx) + + resp, err := router.GetSongsByGenre(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.SongsByGenre.Songs).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockMediaFileRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?,?)")) + Expect(args).To(ContainElements(1, 2)) + }) + + It("should return all accessible songs when no musicFolderId is provided", func() { + mockMediaFileRepo.SetData(model.MediaFiles{ + {ID: "1", Title: "Song 1"}, + {ID: "2", Title: "Song 2"}, + }) + r := newGetRequest("count=2", "genre=rock") + r = r.WithContext(ctx) + + resp, err := router.GetSongsByGenre(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.SongsByGenre.Songs).To(HaveLen(2)) + // Verify that library filter was applied + query, args, _ := mockMediaFileRepo.Options.Filters.ToSql() + Expect(query).To(ContainSubstring("library_id IN (?,?,?)")) + Expect(args).To(ContainElements(1, 2, 3)) + }) + }) + }) + + Describe("GetStarred", func() { + var mockArtistRepo *tests.MockArtistRepo + var mockAlbumRepo *tests.MockAlbumRepo + var mockMediaFileRepo *tests.MockMediaFileRepo + + BeforeEach(func() { + mockArtistRepo = ds.Artist(ctx).(*tests.MockArtistRepo) + mockAlbumRepo = ds.Album(ctx).(*tests.MockAlbumRepo) + mockMediaFileRepo = ds.MediaFile(ctx).(*tests.MockMediaFileRepo) + }) + + It("should return starred items", func() { + mockArtistRepo.SetData(model.Artists{{ID: "1", Name: "Artist 1"}}) + mockAlbumRepo.SetData(model.Albums{{ID: "1", Name: "Album 1"}}) + mockMediaFileRepo.SetData(model.MediaFiles{{ID: "1", Title: "Song 1"}}) + r := newGetRequest() + + resp, err := router.GetStarred(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.Starred.Artist).To(HaveLen(1)) + Expect(resp.Starred.Album).To(HaveLen(1)) + Expect(resp.Starred.Song).To(HaveLen(1)) + }) + + Context("with musicFolderId parameter", func() { + var user model.User + var ctx context.Context + + BeforeEach(func() { + user = model.User{ + ID: "test-user", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + } + ctx = request.WithUser(context.Background(), user) + }) + + It("should filter starred items by specific library when musicFolderId is provided", func() { + mockArtistRepo.SetData(model.Artists{{ID: "1", Name: "Artist 1"}}) + mockAlbumRepo.SetData(model.Albums{{ID: "1", Name: "Album 1"}}) + mockMediaFileRepo.SetData(model.MediaFiles{{ID: "1", Title: "Song 1"}}) + r := newGetRequest("musicFolderId=1") + r = r.WithContext(ctx) + + resp, err := router.GetStarred(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.Starred.Artist).To(HaveLen(1)) + Expect(resp.Starred.Album).To(HaveLen(1)) + Expect(resp.Starred.Song).To(HaveLen(1)) + // Verify that library filter was applied to all types + artistQuery, artistArgs, _ := mockArtistRepo.Options.Filters.ToSql() + Expect(artistQuery).To(ContainSubstring("library_id IN (?)")) + Expect(artistArgs).To(ContainElement(1)) + }) + }) + }) + + Describe("GetStarred2", func() { + var mockArtistRepo *tests.MockArtistRepo + var mockAlbumRepo *tests.MockAlbumRepo + var mockMediaFileRepo *tests.MockMediaFileRepo + + BeforeEach(func() { + mockArtistRepo = ds.Artist(ctx).(*tests.MockArtistRepo) + mockAlbumRepo = ds.Album(ctx).(*tests.MockAlbumRepo) + mockMediaFileRepo = ds.MediaFile(ctx).(*tests.MockMediaFileRepo) + }) + + It("should return starred items in ID3 format", func() { + mockArtistRepo.SetData(model.Artists{{ID: "1", Name: "Artist 1"}}) + mockAlbumRepo.SetData(model.Albums{{ID: "1", Name: "Album 1"}}) + mockMediaFileRepo.SetData(model.MediaFiles{{ID: "1", Title: "Song 1"}}) + r := newGetRequest() + + resp, err := router.GetStarred2(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.Starred2.Artist).To(HaveLen(1)) + Expect(resp.Starred2.Album).To(HaveLen(1)) + Expect(resp.Starred2.Song).To(HaveLen(1)) + }) + + Context("with musicFolderId parameter", func() { + var user model.User + var ctx context.Context + + BeforeEach(func() { + user = model.User{ + ID: "test-user", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + } + ctx = request.WithUser(context.Background(), user) + }) + + It("should filter starred items by specific library when musicFolderId is provided", func() { + mockArtistRepo.SetData(model.Artists{{ID: "1", Name: "Artist 1"}}) + mockAlbumRepo.SetData(model.Albums{{ID: "1", Name: "Album 1"}}) + mockMediaFileRepo.SetData(model.MediaFiles{{ID: "1", Title: "Song 1"}}) + r := newGetRequest("musicFolderId=1") + r = r.WithContext(ctx) + + resp, err := router.GetStarred2(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.Starred2.Artist).To(HaveLen(1)) + Expect(resp.Starred2.Album).To(HaveLen(1)) + Expect(resp.Starred2.Song).To(HaveLen(1)) + // Verify that library filter was applied to all types + artistQuery, artistArgs, _ := mockArtistRepo.Options.Filters.ToSql() + Expect(artistQuery).To(ContainSubstring("library_id IN (?)")) + Expect(artistArgs).To(ContainElement(1)) + }) + }) }) }) diff --git a/server/subsonic/api.go b/server/subsonic/api.go index fd8c3af28..82e404228 100644 --- a/server/subsonic/api.go +++ b/server/subsonic/api.go @@ -6,18 +6,24 @@ import ( "errors" "fmt" "net/http" + "regexp" + "strconv" + "github.com/deluan/rest" "github.com/go-chi/chi/v5" - "github.com/go-chi/chi/v5/middleware" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/artwork" "github.com/navidrome/navidrome/core/external" + lyricssvc "github.com/navidrome/navidrome/core/lyrics" + "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/core/playback" + playlistsvc "github.com/navidrome/navidrome/core/playlists" "github.com/navidrome/navidrome/core/scrobbler" + sonicsvc "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/scanner" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/server/events" "github.com/navidrome/navidrome/server/subsonic/responses" @@ -26,42 +32,54 @@ import ( const Version = "1.16.1" +var validJSIdentifier = regexp.MustCompile(`^[a-zA-Z_$][a-zA-Z0-9_$.]*$`) + type handler = func(*http.Request) (*responses.Subsonic, error) type handlerRaw = func(http.ResponseWriter, *http.Request) (*responses.Subsonic, error) type Router struct { http.Handler - ds model.DataStore - artwork artwork.Artwork - streamer core.MediaStreamer - archiver core.Archiver - players core.Players - provider external.Provider - playlists core.Playlists - scanner scanner.Scanner - broker events.Broker - scrobbler scrobbler.PlayTracker - share core.Share - playback playback.PlaybackServer + ds model.DataStore + artwork artwork.Artwork + streamer stream.MediaStreamer + archiver core.Archiver + players core.Players + provider external.Provider + playlists playlistsvc.Playlists + scanner model.Scanner + broker events.Broker + scrobbler scrobbler.PlayTracker + share core.Share + playback playback.PlaybackServer + metrics metrics.Metrics + lyrics lyricssvc.Lyrics + transcodeDecision stream.TranscodeDecider + sonic *sonicsvc.Sonic } -func New(ds model.DataStore, artwork artwork.Artwork, streamer core.MediaStreamer, archiver core.Archiver, - players core.Players, provider external.Provider, scanner scanner.Scanner, broker events.Broker, - playlists core.Playlists, scrobbler scrobbler.PlayTracker, share core.Share, playback playback.PlaybackServer, +func New(ds model.DataStore, artwork artwork.Artwork, streamer stream.MediaStreamer, archiver core.Archiver, + players core.Players, provider external.Provider, scanner model.Scanner, broker events.Broker, + playlists playlistsvc.Playlists, scrobbler scrobbler.PlayTracker, share core.Share, playback playback.PlaybackServer, + metrics metrics.Metrics, lyrics lyricssvc.Lyrics, transcodeDecision stream.TranscodeDecider, + sonic *sonicsvc.Sonic, ) *Router { r := &Router{ - ds: ds, - artwork: artwork, - streamer: streamer, - archiver: archiver, - players: players, - provider: provider, - playlists: playlists, - scanner: scanner, - broker: broker, - scrobbler: scrobbler, - share: share, - playback: playback, + ds: ds, + artwork: artwork, + streamer: streamer, + archiver: archiver, + players: players, + provider: provider, + playlists: playlists, + scanner: scanner, + broker: broker, + scrobbler: scrobbler, + share: share, + playback: playback, + metrics: metrics, + lyrics: lyrics, + transcodeDecision: transcodeDecision, + sonic: sonic, } r.Handler = r.routes() return r @@ -69,6 +87,11 @@ func New(ds model.DataStore, artwork artwork.Artwork, streamer core.MediaStreame func (api *Router) routes() http.Handler { r := chi.NewRouter() + + if conf.Server.Prometheus.Enabled { + r.Use(recordStats(api.metrics)) + } + r.Use(postFormToQueryParams) // Public @@ -103,6 +126,8 @@ func (api *Router) routes() http.Handler { h(r, "getTopSongs", api.GetTopSongs) h(r, "getSimilarSongs", api.GetSimilarSongs) h(r, "getSimilarSongs2", api.GetSimilarSongs2) + hr(r, "getSonicSimilarTracks", api.GetSonicSimilarTracks) + hr(r, "findSonicPath", api.FindSonicPath) }) r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) @@ -120,6 +145,7 @@ func (api *Router) routes() http.Handler { h(r, "star", api.Star) h(r, "unstar", api.Unstar) h(r, "scrobble", api.Scrobble) + h(r, "reportPlayback", api.ReportPlayback) }) r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) @@ -135,7 +161,9 @@ func (api *Router) routes() http.Handler { h(r, "createBookmark", api.CreateBookmark) h(r, "deleteBookmark", api.DeleteBookmark) h(r, "getPlayQueue", api.GetPlayQueue) + h(r, "getPlayQueueByIndex", api.GetPlayQueueByIndex) h(r, "savePlayQueue", api.SavePlayQueue) + h(r, "savePlayQueueByIndex", api.SavePlayQueueByIndex) }) r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) @@ -145,12 +173,12 @@ func (api *Router) routes() http.Handler { r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) h(r, "getUser", api.GetUser) - h(r, "getUsers", api.GetUsers) + h(r.With(adminOnly), "getUsers", api.GetUsers) }) r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) h(r, "getScanStatus", api.GetScanStatus) - h(r, "startScan", api.StartScan) + h(r.With(adminOnly), "startScan", api.StartScan) }) r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) @@ -159,24 +187,23 @@ func (api *Router) routes() http.Handler { h(r, "getLyricsBySongId", api.GetLyricsBySongId) hr(r, "stream", api.Stream) hr(r, "download", api.Download) + hr(r, "getTranscodeDecision", api.GetTranscodeDecision) + hr(r, "getTranscodeStream", api.GetTranscodeStream) }) r.Group(func(r chi.Router) { - // configure request throttling - if conf.Server.DevArtworkMaxRequests > 0 { - log.Debug("Throttling Subsonic getCoverArt endpoint", "maxRequests", conf.Server.DevArtworkMaxRequests, - "backlogLimit", conf.Server.DevArtworkThrottleBacklogLimit, "backlogTimeout", - conf.Server.DevArtworkThrottleBacklogTimeout) - r.Use(middleware.ThrottleBacklog(conf.Server.DevArtworkMaxRequests, conf.Server.DevArtworkThrottleBacklogLimit, - conf.Server.DevArtworkThrottleBacklogTimeout)) - } + r.Use(server.ThrottleBacklog(conf.Server.DevArtworkMaxRequests, conf.Server.DevArtworkThrottleBacklogLimit, + conf.Server.DevArtworkThrottleBacklogTimeout)) hr(r, "getCoverArt", api.GetCoverArt) }) r.Group(func(r chi.Router) { r.Use(getPlayer(api.players)) - h(r, "createInternetRadioStation", api.CreateInternetRadio) - h(r, "deleteInternetRadioStation", api.DeleteInternetRadio) h(r, "getInternetRadioStations", api.GetInternetRadios) - h(r, "updateInternetRadioStation", api.UpdateInternetRadio) + r.Group(func(r chi.Router) { + r.Use(adminOnly) + h(r, "createInternetRadioStation", api.CreateInternetRadio) + h(r, "deleteInternetRadioStation", api.DeleteInternetRadio) + h(r, "updateInternetRadioStation", api.UpdateInternetRadio) + }) }) if conf.Server.EnableSharing { r.Group(func(r chi.Router) { @@ -219,7 +246,7 @@ func h(r chi.Router, path string, f handler) { }) } -// Add a Subsonic handler that requires a http.ResponseWriter (ex: stream, getCoverArt...) +// Add a Subsonic handler that requires an http.ResponseWriter (ex: stream, getCoverArt...) func hr(r chi.Router, path string, f handlerRaw) { handle := func(w http.ResponseWriter, r *http.Request) { res, err := f(w, r) @@ -275,8 +302,12 @@ func mapToSubsonicError(err error) subError { err = newError(responses.ErrorMissingParameter, err.Error()) case errors.Is(err, req.ErrInvalidParam): err = newError(responses.ErrorGeneric, err.Error()) - case errors.Is(err, model.ErrNotFound): + case errors.Is(err, model.ErrNotFound), errors.Is(err, rest.ErrNotFound): err = newError(responses.ErrorDataNotFound, "data not found") + case errors.Is(err, model.ErrNotAuthorized), errors.Is(err, rest.ErrPermissionDenied): + err = newError(responses.ErrorAuthorizationFail) + case errors.Is(err, stream.ErrTooManyTranscodes): + err = newError(responses.ErrorGeneric, "too many concurrent transcodes, please retry shortly") default: err = newError(responses.ErrorGeneric, fmt.Sprintf("Internal Server Error: %s", err)) } @@ -286,15 +317,31 @@ func mapToSubsonicError(err error) subError { } func sendError(w http.ResponseWriter, r *http.Request, err error) { + if errors.Is(err, stream.ErrTooManyTranscodes) { + w.Header().Set("Retry-After", strconv.Itoa(stream.RetryAfterSeconds)) + sendResponseWithStatus(w, r, errorResponse(err), http.StatusTooManyRequests) + return + } + sendResponse(w, r, errorResponse(err)) +} + +func errorResponse(err error) *responses.Subsonic { subErr := mapToSubsonicError(err) response := newResponse() response.Status = responses.StatusFailed response.Error = &responses.Error{Code: subErr.code, Message: subErr.Error()} - - sendResponse(w, r, response) + return response } func sendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Subsonic) { + sendResponseWithStatus(w, r, payload, 0) +} + +// sendResponseWithStatus writes the response body in the format requested by +// the client. When status is non-zero, WriteHeader is called with that code +// before the body is written; callers that need to set additional headers +// (e.g. Retry-After) must set them before calling. +func sendResponseWithStatus(w http.ResponseWriter, r *http.Request, payload *responses.Subsonic, status int) { p := req.Params(r) f, _ := p.String("f") var response []byte @@ -305,11 +352,20 @@ func sendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Sub wrapper := &responses.JsonWrapper{Subsonic: *payload} response, err = json.Marshal(wrapper) case "jsonp": - w.Header().Set("Content-Type", "application/javascript") callback, _ := p.String("callback") + if !validJSIdentifier.MatchString(callback) { + log.Warn(r.Context(), "Invalid JSONP callback parameter", "callback", callback) + w.Header().Set("Content-Type", "application/json") + errResp := newResponse() + errResp.Status = responses.StatusFailed + errResp.Error = &responses.Error{Code: responses.ErrorGeneric, Message: "invalid callback parameter"} + response, _ = json.Marshal(responses.JsonWrapper{Subsonic: *errResp}) + break + } + w.Header().Set("Content-Type", "application/javascript") wrapper := &responses.JsonWrapper{Subsonic: *payload} response, err = json.Marshal(wrapper) - response = []byte(fmt.Sprintf("%s(%s)", callback, response)) + response = fmt.Appendf(nil, "%s(%s)", callback, response) default: w.Header().Set("Content-Type", "application/xml") response, err = xml.Marshal(payload) @@ -320,6 +376,10 @@ func sendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Sub sendError(w, r, err) return } + if status != 0 { + w.WriteHeader(status) + } + if payload.Status == responses.StatusOK { if log.IsGreaterOrEqualTo(log.LevelTrace) { log.Debug(r.Context(), "API: Successful response", "endpoint", r.URL.Path, "status", "OK", "body", string(response)) @@ -329,7 +389,22 @@ func sendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Sub } else { log.Warn(r.Context(), "API: Failed response", "endpoint", r.URL.Path, "error", payload.Error.Code, "message", payload.Error.Message) } - if _, err := w.Write(response); err != nil { - log.Error(r, "Error sending response to client", "endpoint", r.URL.Path, "payload", string(response), err) + + statusPointer, ok := r.Context().Value(subsonicErrorPointer).(*int32) + + if ok && statusPointer != nil { + if payload.Status == responses.StatusOK { + *statusPointer = 0 + } else { + *statusPointer = payload.Error.Code + } + } + + if _, err := w.Write(response); err != nil { //nolint:gosec + if log.IsGreaterOrEqualTo(log.LevelTrace) { + log.Error(r, "Error sending response to client", "endpoint", r.URL.Path, "payload", string(response), err) + } else { + log.Error(r, "Error sending response to client", "endpoint", r.URL.Path, err) + } } } diff --git a/server/subsonic/api_test.go b/server/subsonic/api_test.go index 5d248c464..f8d5b6642 100644 --- a/server/subsonic/api_test.go +++ b/server/subsonic/api_test.go @@ -1,13 +1,19 @@ package subsonic import ( + "context" "encoding/json" "encoding/xml" + "errors" + "fmt" "math" "net/http" "net/http/httptest" "strings" + "github.com/deluan/rest" + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server/subsonic/responses" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -71,6 +77,49 @@ var _ = Describe("sendResponse", func() { Expect(err).NotTo(HaveOccurred()) Expect(wrapper.Subsonic.Status).To(Equal(payload.Status)) }) + + It("should accept valid callback names with dots", func() { + q := r.URL.Query() + q.Add("f", "jsonp") + q.Add("callback", "jQuery.callback_123") + r.URL.RawQuery = q.Encode() + + sendResponse(w, r, payload) + + body := w.Body.String() + Expect(body).To(HavePrefix("jQuery.callback_123(")) + }) + + It("should reject callback with invalid characters", func() { + q := r.URL.Query() + q.Add("f", "jsonp") + q.Add("callback", "alert(1)//") + r.URL.RawQuery = q.Encode() + + sendResponse(w, r, payload) + + Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + var wrapper responses.JsonWrapper + err := json.Unmarshal(w.Body.Bytes(), &wrapper) + Expect(err).NotTo(HaveOccurred()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + Expect(wrapper.Subsonic.Error.Message).To(ContainSubstring("invalid callback parameter")) + }) + + It("should reject empty callback parameter", func() { + q := r.URL.Query() + q.Add("f", "jsonp") + q.Add("callback", "") + r.URL.RawQuery = q.Encode() + + sendResponse(w, r, payload) + + Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + var wrapper responses.JsonWrapper + err := json.Unmarshal(w.Body.Bytes(), &wrapper) + Expect(err).NotTo(HaveOccurred()) + Expect(wrapper.Subsonic.Status).To(Equal(responses.StatusFailed)) + }) }) When("format is XML or unspecified", func() { @@ -91,7 +140,7 @@ var _ = Describe("sendResponse", func() { It("should return a fail response", func() { payload.Song = &responses.Child{OpenSubsonicChild: &responses.OpenSubsonicChild{}} // An +Inf value will cause an error when marshalling to JSON - payload.Song.ReplayGain = responses.ReplayGain{TrackGain: math.Inf(1)} + payload.Song.ReplayGain = responses.ReplayGain{TrackGain: new(math.Inf(1))} q := r.URL.Query() q.Add("f", "json") r.URL.RawQuery = q.Encode() @@ -108,4 +157,57 @@ var _ = Describe("sendResponse", func() { }) }) + It("responds with HTTP 429 and Retry-After when the transcode limiter rejects", func() { + w = httptest.NewRecorder() + r = httptest.NewRequest("GET", "/rest/stream", nil) + + sendError(w, r, fmt.Errorf("rejected: %w", stream.ErrTooManyTranscodes)) + + Expect(w.Code).To(Equal(http.StatusTooManyRequests)) + Expect(w.Header().Get("Retry-After")).ToNot(BeEmpty()) + + var subsonicResponse responses.Subsonic + err := xml.Unmarshal(w.Body.Bytes(), &subsonicResponse) + Expect(err).NotTo(HaveOccurred()) + Expect(subsonicResponse.Status).To(Equal(responses.StatusFailed)) + Expect(subsonicResponse.Error).ToNot(BeNil()) + Expect(subsonicResponse.Error.Code).To(Equal(responses.ErrorGeneric)) + Expect(subsonicResponse.Error.Message).To(ContainSubstring("transcode")) + }) + + It("updates status pointer when an error occurs", func() { + pointer := int32(0) + + ctx := context.WithValue(r.Context(), subsonicErrorPointer, &pointer) //nolint:govet + r = r.WithContext(ctx) + + payload.Status = responses.StatusFailed + payload.Error = &responses.Error{Code: responses.ErrorDataNotFound} + + sendResponse(w, r, payload) + Expect(w.Code).To(Equal(http.StatusOK)) + + Expect(pointer).To(Equal(responses.ErrorDataNotFound)) + }) +}) + +var _ = Describe("mapToSubsonicError", func() { + DescribeTable("maps repository errors to the correct Subsonic error code", + func(err error, expectedCode int32) { + subErr := mapToSubsonicError(err) + Expect(subErr.code).To(Equal(expectedCode)) + }, + Entry("rest.ErrPermissionDenied -> not authorized (50)", + rest.ErrPermissionDenied, responses.ErrorAuthorizationFail), + Entry("rest.ErrNotFound -> data not found (70)", + rest.ErrNotFound, responses.ErrorDataNotFound), + Entry("model.ErrNotAuthorized -> not authorized (50)", + model.ErrNotAuthorized, responses.ErrorAuthorizationFail), + Entry("model.ErrNotFound -> data not found (70)", + model.ErrNotFound, responses.ErrorDataNotFound), + Entry("wrapped rest.ErrPermissionDenied is still mapped", + fmt.Errorf("update share: %w", rest.ErrPermissionDenied), responses.ErrorAuthorizationFail), + Entry("unknown error -> generic (0)", + errors.New("boom"), responses.ErrorGeneric), + ) }) diff --git a/server/subsonic/bookmarks.go b/server/subsonic/bookmarks.go index f6fd1a99e..337712750 100644 --- a/server/subsonic/bookmarks.go +++ b/server/subsonic/bookmarks.go @@ -73,21 +73,29 @@ func (api *Router) GetPlayQueue(r *http.Request) (*responses.Subsonic, error) { user, _ := request.UserFrom(r.Context()) repo := api.ds.PlayQueue(r.Context()) - pq, err := repo.Retrieve(user.ID) + pq, err := repo.RetrieveWithMediaFiles(user.ID) if err != nil && !errors.Is(err, model.ErrNotFound) { return nil, err } if pq == nil || len(pq.Items) == 0 { - return newResponse(), nil + response := newResponse() + response.PlayQueue = &responses.PlayQueue{ + Username: user.UserName, + } + return response, nil } response := newResponse() + var currentID string + if pq.Current >= 0 && pq.Current < len(pq.Items) { + currentID = pq.Items[pq.Current].ID + } response.PlayQueue = &responses.PlayQueue{ Entry: slice.MapWithArg(pq.Items, r.Context(), childFromMediaFile), - Current: pq.Current, + Current: currentID, Position: pq.Position, Username: user.UserName, - Changed: &pq.UpdatedAt, + Changed: pq.UpdatedAt, ChangedBy: pq.ChangedBy, } return response, nil @@ -96,20 +104,27 @@ func (api *Router) GetPlayQueue(r *http.Request) (*responses.Subsonic, error) { func (api *Router) SavePlayQueue(r *http.Request) (*responses.Subsonic, error) { p := req.Params(r) ids, _ := p.Strings("id") - current, _ := p.String("current") + currentID, _ := p.String("current") position := p.Int64Or("position", 0) user, _ := request.UserFrom(r.Context()) client, _ := request.ClientFrom(r.Context()) - var items model.MediaFiles - for _, id := range ids { - items = append(items, model.MediaFile{ID: id}) + items := slice.Map(ids, func(id string) model.MediaFile { + return model.MediaFile{ID: id} + }) + + currentIndex := 0 + for i, id := range ids { + if id == currentID { + currentIndex = i + break + } } pq := &model.PlayQueue{ UserID: user.ID, - Current: current, + Current: currentIndex, Position: position, ChangedBy: client, Items: items, @@ -124,3 +139,78 @@ func (api *Router) SavePlayQueue(r *http.Request) (*responses.Subsonic, error) { } return newResponse(), nil } + +func (api *Router) GetPlayQueueByIndex(r *http.Request) (*responses.Subsonic, error) { + user, _ := request.UserFrom(r.Context()) + + repo := api.ds.PlayQueue(r.Context()) + pq, err := repo.RetrieveWithMediaFiles(user.ID) + if err != nil && !errors.Is(err, model.ErrNotFound) { + return nil, err + } + if pq == nil || len(pq.Items) == 0 { + response := newResponse() + response.PlayQueueByIndex = &responses.PlayQueueByIndex{ + Username: user.UserName, + } + return response, nil + } + + response := newResponse() + + var index *int + if len(pq.Items) > 0 { + index = &pq.Current + } + + response.PlayQueueByIndex = &responses.PlayQueueByIndex{ + Entry: slice.MapWithArg(pq.Items, r.Context(), childFromMediaFile), + CurrentIndex: index, + Position: pq.Position, + Username: user.UserName, + Changed: pq.UpdatedAt, + ChangedBy: pq.ChangedBy, + } + return response, nil +} + +func (api *Router) SavePlayQueueByIndex(r *http.Request) (*responses.Subsonic, error) { + p := req.Params(r) + ids, _ := p.Strings("id") + + position := p.Int64Or("position", 0) + + var err error + var currentIndex int + + if len(ids) > 0 { + currentIndex, err = p.Int("currentIndex") + if err != nil || currentIndex < 0 || currentIndex >= len(ids) { + return nil, newError(responses.ErrorMissingParameter, "missing parameter index, err: %s", err) + } + } + + items := slice.Map(ids, func(id string) model.MediaFile { + return model.MediaFile{ID: id} + }) + + user, _ := request.UserFrom(r.Context()) + client, _ := request.ClientFrom(r.Context()) + + pq := &model.PlayQueue{ + UserID: user.ID, + Current: currentIndex, + Position: position, + ChangedBy: client, + Items: items, + CreatedAt: time.Time{}, + UpdatedAt: time.Time{}, + } + + repo := api.ds.PlayQueue(r.Context()) + err = repo.Store(pq) + if err != nil { + return nil, err + } + return newResponse(), nil +} diff --git a/server/subsonic/browsing.go b/server/subsonic/browsing.go index 76023c862..817238aaf 100644 --- a/server/subsonic/browsing.go +++ b/server/subsonic/browsing.go @@ -7,9 +7,10 @@ import ( "time" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/server/public" "github.com/navidrome/navidrome/server/subsonic/filter" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" @@ -17,7 +18,8 @@ import ( ) func (api *Router) GetMusicFolders(r *http.Request) (*responses.Subsonic, error) { - libraries, _ := api.ds.Library(r.Context()).GetAll() + libraries := getUserAccessibleLibraries(r.Context()) + folders := make([]responses.MusicFolder, len(libraries)) for i, f := range libraries { folders[i].Id = int32(f.ID) @@ -28,28 +30,37 @@ func (api *Router) GetMusicFolders(r *http.Request) (*responses.Subsonic, error) return response, nil } -func (api *Router) getArtist(r *http.Request, libId int, ifModifiedSince time.Time) (model.ArtistIndexes, int64, error) { +func (api *Router) getArtist(r *http.Request, libIds []int, ifModifiedSince time.Time) (model.ArtistIndexes, int64, error) { ctx := r.Context() - lib, err := api.ds.Library(ctx).Get(libId) + + lastScanStr, err := api.ds.Property(ctx).DefaultGet(consts.LastScanStartTimeKey, "") if err != nil { - log.Error(ctx, "Error retrieving Library", "id", libId, err) + log.Error(ctx, "Error retrieving last scan start time", err) return nil, 0, err } + lastScan := time.Now() + if lastScanStr != "" { + lastScan, err = time.Parse(time.RFC3339, lastScanStr) + } var indexes model.ArtistIndexes - if lib.LastScanAt.After(ifModifiedSince) { - indexes, err = api.ds.Artist(ctx).GetIndex(false, model.RoleAlbumArtist) + if lastScan.After(ifModifiedSince) { + indexes, err = api.ds.Artist(ctx).GetIndex(false, libIds, model.RoleAlbumArtist) if err != nil { log.Error(ctx, "Error retrieving Indexes", err) return nil, 0, err } + if len(indexes) == 0 { + log.Debug(ctx, "No artists found in library", "libId", libIds) + return nil, 0, newError(responses.ErrorDataNotFound, "Library not found or empty") + } } - return indexes, lib.LastScanAt.UnixMilli(), err + return indexes, lastScan.UnixMilli(), err } -func (api *Router) getArtistIndex(r *http.Request, libId int, ifModifiedSince time.Time) (*responses.Indexes, error) { - indexes, modified, err := api.getArtist(r, libId, ifModifiedSince) +func (api *Router) getArtistIndex(r *http.Request, libIds []int, ifModifiedSince time.Time) (*responses.Indexes, error) { + indexes, modified, err := api.getArtist(r, libIds, ifModifiedSince) if err != nil { return nil, err } @@ -67,8 +78,8 @@ func (api *Router) getArtistIndex(r *http.Request, libId int, ifModifiedSince ti return res, nil } -func (api *Router) getArtistIndexID3(r *http.Request, libId int, ifModifiedSince time.Time) (*responses.Artists, error) { - indexes, modified, err := api.getArtist(r, libId, ifModifiedSince) +func (api *Router) getArtistIndexID3(r *http.Request, libIds []int, ifModifiedSince time.Time) (*responses.Artists, error) { + indexes, modified, err := api.getArtist(r, libIds, ifModifiedSince) if err != nil { return nil, err } @@ -88,10 +99,10 @@ func (api *Router) getArtistIndexID3(r *http.Request, libId int, ifModifiedSince func (api *Router) GetIndexes(r *http.Request) (*responses.Subsonic, error) { p := req.Params(r) - musicFolderId := p.IntOr("musicFolderId", 1) + musicFolderIds, _ := selectedMusicFolderIds(r, false) ifModifiedSince := p.TimeOr("ifModifiedSince", time.Time{}) - res, err := api.getArtistIndex(r, musicFolderId, ifModifiedSince) + res, err := api.getArtistIndex(r, musicFolderIds, ifModifiedSince) if err != nil { return nil, err } @@ -102,9 +113,9 @@ func (api *Router) GetIndexes(r *http.Request) (*responses.Subsonic, error) { } func (api *Router) GetArtists(r *http.Request) (*responses.Subsonic, error) { - p := req.Params(r) - musicFolderId := p.IntOr("musicFolderId", 1) - res, err := api.getArtistIndexID3(r, musicFolderId, time.Time{}) + musicFolderIds, _ := selectedMusicFolderIds(r, false) + + res, err := api.getArtistIndexID3(r, musicFolderIds, time.Time{}) if err != nil { return nil, err } @@ -219,9 +230,9 @@ func (api *Router) GetAlbumInfo(r *http.Request) (*responses.Subsonic, error) { response := newResponse() response.AlbumInfo = &responses.AlbumInfo{} response.AlbumInfo.Notes = album.Description - response.AlbumInfo.SmallImageUrl = public.ImageURL(r, album.CoverArtID(), 300) - response.AlbumInfo.MediumImageUrl = public.ImageURL(r, album.CoverArtID(), 600) - response.AlbumInfo.LargeImageUrl = public.ImageURL(r, album.CoverArtID(), 1200) + response.AlbumInfo.SmallImageUrl = publicurl.ImageURL(r, album.CoverArtID(), 300) + response.AlbumInfo.MediumImageUrl = publicurl.ImageURL(r, album.CoverArtID(), 600) + response.AlbumInfo.LargeImageUrl = publicurl.ImageURL(r, album.CoverArtID(), 1200) response.AlbumInfo.LastFmUrl = album.ExternalUrl response.AlbumInfo.MusicBrainzID = album.MbzAlbumID @@ -245,8 +256,7 @@ func (api *Router) GetSong(r *http.Request) (*responses.Subsonic, error) { } response := newResponse() - child := childFromMediaFile(ctx, *mf) - response.Song = &child + response.Song = new(childFromMediaFile(ctx, *mf)) return response, nil } @@ -285,9 +295,9 @@ func (api *Router) getArtistInfo(r *http.Request) (*responses.ArtistInfoBase, *m base := responses.ArtistInfoBase{} base.Biography = artist.Biography - base.SmallImageUrl = public.ImageURL(r, artist.CoverArtID(), 300) - base.MediumImageUrl = public.ImageURL(r, artist.CoverArtID(), 600) - base.LargeImageUrl = public.ImageURL(r, artist.CoverArtID(), 1200) + base.SmallImageUrl = publicurl.ImageURL(r, artist.CoverArtID(), 300) + base.MediumImageUrl = publicurl.ImageURL(r, artist.CoverArtID(), 600) + base.LargeImageUrl = publicurl.ImageURL(r, artist.CoverArtID(), 1200) base.LastFmUrl = artist.ExternalUrl base.MusicBrainzID = artist.MbzArtistID @@ -397,8 +407,11 @@ func (api *Router) buildArtistDirectory(ctx context.Context, artist *model.Artis if artist.PlayCount > 0 { dir.Played = artist.PlayDate } - dir.AlbumCount = int32(artist.AlbumCount) + dir.AlbumCount = getArtistAlbumCount(artist) dir.UserRating = int32(artist.Rating) + if conf.Server.Subsonic.EnableAverageRating { + dir.AverageRating = artist.AverageRating + } if artist.Starred { dir.Starred = artist.StarredAt } @@ -429,13 +442,16 @@ func (api *Router) buildArtist(r *http.Request, artist *model.Artist) (*response func (api *Router) buildAlbumDirectory(ctx context.Context, album *model.Album) (*responses.Directory, error) { dir := &responses.Directory{} dir.Id = album.ID - dir.Name = album.Name + dir.Name = album.FullName() dir.Parent = album.AlbumArtistID dir.PlayCount = album.PlayCount if album.PlayCount > 0 { dir.Played = album.PlayDate } dir.UserRating = int32(album.Rating) + if conf.Server.Subsonic.EnableAverageRating { + dir.AverageRating = album.AverageRating + } dir.SongCount = int32(album.SongCount) dir.CoverArt = album.CoverArtID().String() if album.Starred { diff --git a/server/subsonic/browsing_test.go b/server/subsonic/browsing_test.go new file mode 100644 index 000000000..b8f510aed --- /dev/null +++ b/server/subsonic/browsing_test.go @@ -0,0 +1,160 @@ +package subsonic + +import ( + "context" + "fmt" + "net/http/httptest" + + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func contextWithUser(ctx context.Context, userID string, libraryIDs ...int) context.Context { + libraries := make([]model.Library, len(libraryIDs)) + for i, id := range libraryIDs { + libraries[i] = model.Library{ID: id, Name: fmt.Sprintf("Test Library %d", id), Path: fmt.Sprintf("/music/library%d", id)} + } + user := model.User{ + ID: userID, + Libraries: libraries, + } + return request.WithUser(ctx, user) +} + +var _ = Describe("Browsing", func() { + var api *Router + var ctx context.Context + var ds model.DataStore + + BeforeEach(func() { + ds = &tests.MockDataStore{} + auth.Init(ds) + api = &Router{ds: ds} + ctx = context.Background() + }) + + Describe("GetMusicFolders", func() { + It("should return all libraries the user has access", func() { + // Create mock user with libraries + ctx := contextWithUser(ctx, "user-id", 1, 2, 3) + + // Create request + r := httptest.NewRequest("GET", "/rest/getMusicFolders", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.GetMusicFolders(r) + + // Verify results + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.MusicFolders).ToNot(BeNil()) + Expect(response.MusicFolders.Folders).To(HaveLen(3)) + Expect(response.MusicFolders.Folders[0].Name).To(Equal("Test Library 1")) + Expect(response.MusicFolders.Folders[1].Name).To(Equal("Test Library 2")) + Expect(response.MusicFolders.Folders[2].Name).To(Equal("Test Library 3")) + }) + }) + + Describe("GetIndexes", func() { + It("should validate user access to the specified musicFolderId", func() { + // Create mock user with access to library 1 only + ctx = contextWithUser(ctx, "user-id", 1) + + // Create request with musicFolderId=2 (not accessible) + r := httptest.NewRequest("GET", "/rest/getIndexes?musicFolderId=2", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.GetIndexes(r) + + // Should return error due to lack of access + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + }) + + It("should default to first accessible library when no musicFolderId specified", func() { + // Create mock user with access to libraries 2 and 3 + ctx = contextWithUser(ctx, "user-id", 2, 3) + + // Setup minimal mock library data for working tests + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{ + {ID: 2, Name: "Test Library 2", Path: "/music/library2"}, + {ID: 3, Name: "Test Library 3", Path: "/music/library3"}, + }) + + // Setup mock artist data + mockArtistRepo := ds.Artist(ctx).(*tests.MockArtistRepo) + mockArtistRepo.SetData(model.Artists{ + {ID: "1", Name: "Test Artist 1"}, + {ID: "2", Name: "Test Artist 2"}, + }) + + // Create request without musicFolderId + r := httptest.NewRequest("GET", "/rest/getIndexes", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.GetIndexes(r) + + // Should succeed and use first accessible library (2) + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.Indexes).ToNot(BeNil()) + }) + }) + + Describe("GetArtists", func() { + It("should validate user access to the specified musicFolderId", func() { + // Create mock user with access to library 1 only + ctx = contextWithUser(ctx, "user-id", 1) + + // Create request with musicFolderId=3 (not accessible) + r := httptest.NewRequest("GET", "/rest/getArtists?musicFolderId=3", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.GetArtists(r) + + // Should return error due to lack of access + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + }) + + It("should default to first accessible library when no musicFolderId specified", func() { + // Create mock user with access to libraries 1 and 2 + ctx = contextWithUser(ctx, "user-id", 1, 2) + + // Setup minimal mock library data for working tests + mockLibRepo := ds.Library(ctx).(*tests.MockLibraryRepo) + mockLibRepo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library 1", Path: "/music/library1"}, + {ID: 2, Name: "Test Library 2", Path: "/music/library2"}, + }) + + // Setup mock artist data + mockArtistRepo := ds.Artist(ctx).(*tests.MockArtistRepo) + mockArtistRepo.SetData(model.Artists{ + {ID: "1", Name: "Test Artist 1"}, + {ID: "2", Name: "Test Artist 2"}, + }) + + // Create request without musicFolderId + r := httptest.NewRequest("GET", "/rest/getArtists", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.GetArtists(r) + + // Should succeed and use first accessible library (1) + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.Artist).ToNot(BeNil()) + }) + }) +}) diff --git a/server/subsonic/filter/filters.go b/server/subsonic/filter/filters.go index 4ab4f9642..856870a6c 100644 --- a/server/subsonic/filter/filters.go +++ b/server/subsonic/filter/filters.go @@ -92,7 +92,7 @@ func SongsByAlbum(albumId string) Options { func SongsByRandom(genre string, fromYear, toYear int) Options { options := Options{ - Sort: "random", + Sort: "random()", } ff := And{} if genre != "" { @@ -108,14 +108,13 @@ func SongsByRandom(genre string, fromYear, toYear int) Options { return addDefaultFilters(options) } -func SongWithLyrics(artist, title string) Options { +func SongsByArtistTitleWithLyricsFirst(artist, title string) Options { return addDefaultFilters(Options{ - Sort: "updated_at", + Sort: "lyrics, updated_at", Order: "desc", Max: 1, Filters: And{ Eq{"title": title}, - NotEq{"lyrics": "[]"}, Or{ persistence.Exists("json_tree(participants, '$.albumartist')", Eq{"value": artist}), persistence.Exists("json_tree(participants, '$.artist')", Eq{"value": artist}), @@ -124,6 +123,38 @@ func SongWithLyrics(artist, title string) Options { }) } +func ApplyLibraryFilter(opts Options, musicFolderIds []int) Options { + if len(musicFolderIds) == 0 { + return opts + } + + libraryFilter := Eq{"library_id": musicFolderIds} + if opts.Filters == nil { + opts.Filters = libraryFilter + } else { + opts.Filters = And{opts.Filters, libraryFilter} + } + + return opts +} + +// ApplyArtistLibraryFilter applies a filter to the given Options to ensure that only artists +// that are associated with the specified music folders are included in the results. +func ApplyArtistLibraryFilter(opts Options, musicFolderIds []int) Options { + if len(musicFolderIds) == 0 { + return opts + } + + artistLibraryFilter := Eq{"library_artist.library_id": musicFolderIds} + if opts.Filters == nil { + opts.Filters = artistLibraryFilter + } else { + opts.Filters = And{opts.Filters, artistLibraryFilter} + } + + return opts +} + func ByGenre(genre string) Options { return addDefaultFilters(Options{ Sort: "name", @@ -132,7 +163,7 @@ func ByGenre(genre string) Options { } func filterByGenre(genre string) Sqlizer { - return persistence.Exists("json_tree(tags)", And{ + return persistence.Exists(`json_tree(tags, "$.genre")`, And{ Like{"value": genre}, NotEq{"atom": nil}, }) diff --git a/server/subsonic/helpers.go b/server/subsonic/helpers.go index 39f324654..e4c39e373 100644 --- a/server/subsonic/helpers.go +++ b/server/subsonic/helpers.go @@ -7,16 +7,19 @@ import ( "fmt" "mime" "net/http" + "slices" "sort" "strings" + "time" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" - "github.com/navidrome/navidrome/server/public" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/number" + "github.com/navidrome/navidrome/utils/req" "github.com/navidrome/navidrome/utils/slice" ) @@ -32,10 +35,10 @@ func newResponse() *responses.Subsonic { type subError struct { code int32 - messages []interface{} + messages []any } -func newError(code int32, message ...interface{}) error { +func newError(code int32, message ...any) error { return subError{ code: code, messages: message, @@ -77,18 +80,16 @@ func sortName(sortName, orderName string) string { return orderName } -func getArtistAlbumCount(a model.Artist) int32 { - albumStats := a.Stats[model.RoleAlbumArtist] - +func getArtistAlbumCount(a *model.Artist) int32 { // If ArtistParticipations are set, then `getArtist` will return albums - // where the artist is an album artist OR artist. While it may be an underestimate, - // guess the count by taking a max of the album artist and artist count. This is - // guaranteed to be <= the actual count. + // where the artist is an album artist OR artist. Use the custom stat + // main credit for this calculation. // Otherwise, return just the roles as album artist (precise) if conf.Server.Subsonic.ArtistParticipations { - artistStats := a.Stats[model.RoleArtist] - return int32(max(artistStats.AlbumCount, albumStats.AlbumCount)) + mainCreditStats := a.Stats[model.RoleMainCredit] + return int32(mainCreditStats.AlbumCount) } else { + albumStats := a.Stats[model.RoleAlbumArtist] return int32(albumStats.AlbumCount) } } @@ -99,7 +100,10 @@ func toArtist(r *http.Request, a model.Artist) responses.Artist { Name: a.Name, UserRating: int32(a.Rating), CoverArt: a.CoverArtID().String(), - ArtistImageUrl: public.ImageURL(r, a.CoverArtID(), 600), + ArtistImageUrl: publicurl.ImageURL(r, a.CoverArtID(), 600), + } + if conf.Server.Subsonic.EnableAverageRating { + artist.AverageRating = a.AverageRating } if a.Starred { artist.Starred = a.StarredAt @@ -111,11 +115,14 @@ func toArtistID3(r *http.Request, a model.Artist) responses.ArtistID3 { artist := responses.ArtistID3{ Id: a.ID, Name: a.Name, - AlbumCount: getArtistAlbumCount(a), + AlbumCount: getArtistAlbumCount(&a), CoverArt: a.CoverArtID().String(), - ArtistImageUrl: public.ImageURL(r, a.CoverArtID(), 600), + ArtistImageUrl: publicurl.ImageURL(r, a.CoverArtID(), 600), UserRating: int32(a.Rating), } + if conf.Server.Subsonic.EnableAverageRating { + artist.AverageRating = a.AverageRating + } if a.Starred { artist.Starred = a.StarredAt } @@ -166,13 +173,32 @@ func getTranscoding(ctx context.Context) (format string, bitRate int) { return } +func isClientInList(clientList, client string) bool { + if clientList == "" || client == "" { + return false + } + clients := strings.SplitSeq(clientList, ",") + for c := range clients { + if strings.TrimSpace(c) == client { + return true + } + } + return false +} + func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child { child := responses.Child{} child.Id = mf.ID child.Title = mf.FullTitle() child.IsDir = false + + player, ok := request.PlayerFrom(ctx) + if ok && isClientInList(conf.Server.Subsonic.MinimalClients, player.Client) { + return child + } + child.Parent = mf.AlbumID - child.Album = mf.Album + child.Album = mf.FullAlbumName() child.Year = int32(mf.Year) child.Artist = mf.Artist child.Genre = mf.Genre @@ -183,14 +209,14 @@ func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child child.BitRate = int32(mf.BitRate) child.CoverArt = mf.CoverArtID().String() child.ContentType = mf.ContentType() - player, ok := request.PlayerFrom(ctx) + if ok && player.ReportRealPath { child.Path = mf.AbsolutePath() } else { child.Path = fakePath(mf) } child.DiscNumber = int32(mf.DiscNumber) - child.Created = &mf.BirthTime + child.Created = new(mf.BirthTime) child.AlbumId = mf.AlbumID child.ArtistId = mf.ArtistID child.Type = "music" @@ -199,6 +225,9 @@ func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child child.Starred = mf.StarredAt } child.UserRating = int32(mf.Rating) + if conf.Server.Subsonic.EnableAverageRating { + child.AverageRating = mf.AverageRating + } format, _ := getTranscoding(ctx) if mf.Suffix != "" && format != "" && mf.Suffix != format { @@ -211,8 +240,8 @@ func childFromMediaFile(ctx context.Context, mf model.MediaFile) responses.Child } func osChildFromMediaFile(ctx context.Context, mf model.MediaFile) *responses.OpenSubsonicChild { - player, _ := request.PlayerFrom(ctx) - if strings.Contains(conf.Server.Subsonic.LegacyClients, player.Client) { + player, ok := request.PlayerFrom(ctx) + if ok && isClientInList(conf.Server.Subsonic.LegacyClients, player.Client) { return nil } child := responses.OpenSubsonicChild{} @@ -236,6 +265,7 @@ func osChildFromMediaFile(ctx context.Context, mf model.MediaFile) *responses.Op child.BitDepth = int32(mf.BitDepth) child.Genres = toItemGenres(mf.Genres) child.Moods = mf.Tags.Values(model.TagMood) + child.Groupings = mf.Tags.Values(model.TagGrouping) child.DisplayArtist = mf.Artist child.Artists = artistRefs(mf.Participants[model.RoleArtist]) child.DisplayAlbumArtist = mf.AlbumArtist @@ -274,7 +304,7 @@ func artistRefs(participants model.ParticipantList) []responses.ArtistID3Ref { func fakePath(mf model.MediaFile) string { builder := strings.Builder{} - builder.WriteString(fmt.Sprintf("%s/%s/", sanitizeSlashes(mf.AlbumArtist), sanitizeSlashes(mf.Album))) + builder.WriteString(fmt.Sprintf("%s/%s/", sanitizeSlashes(mf.AlbumArtist), sanitizeSlashes(mf.FullAlbumName()))) if mf.DiscNumber != 0 { builder.WriteString(fmt.Sprintf("%02d-", mf.DiscNumber)) } @@ -289,18 +319,33 @@ func sanitizeSlashes(target string) string { return strings.ReplaceAll(target, "/", "_") } +// albumCreatedAt returns a best-effort timestamp for the album's `created` +// field, which is required by the OpenSubsonic spec but may be zero on legacy +// DB rows. Falls back to UpdatedAt → ImportedAt; can still return zero if all +// three are unset. +func albumCreatedAt(al model.Album) time.Time { + if !al.CreatedAt.IsZero() { + return al.CreatedAt + } + if !al.UpdatedAt.IsZero() { + return al.UpdatedAt + } + return al.ImportedAt +} + func childFromAlbum(ctx context.Context, al model.Album) responses.Child { child := responses.Child{} child.Id = al.ID child.IsDir = true - child.Title = al.Name - child.Name = al.Name - child.Album = al.Name + fullName := al.FullName() + child.Title = fullName + child.Name = fullName + child.Album = fullName child.Artist = al.AlbumArtist child.Year = int32(cmp.Or(al.MaxOriginalYear, al.MaxYear)) child.Genre = al.Genre child.CoverArt = al.CoverArtID().String() - child.Created = &al.CreatedAt + child.Created = new(albumCreatedAt(al)) child.Parent = al.AlbumArtistID child.ArtistId = al.AlbumArtistID child.Duration = int32(al.Duration) @@ -310,6 +355,9 @@ func childFromAlbum(ctx context.Context, al model.Album) responses.Child { } child.PlayCount = al.PlayCount child.UserRating = int32(al.Rating) + if conf.Server.Subsonic.EnableAverageRating { + child.AverageRating = al.AverageRating + } child.OpenSubsonicChild = osChildFromAlbum(ctx, al) return child } @@ -327,6 +375,7 @@ func osChildFromAlbum(ctx context.Context, al model.Album) *responses.OpenSubson child.MusicBrainzId = al.MbzAlbumID child.Genres = toItemGenres(al.Genres) child.Moods = al.Tags.Values(model.TagMood) + child.Groupings = al.Tags.Values(model.TagGrouping) child.DisplayArtist = al.AlbumArtist child.Artists = artistRefs(al.Participants[model.RoleAlbumArtist]) child.DisplayAlbumArtist = al.AlbumArtist @@ -359,8 +408,17 @@ func buildDiscSubtitles(a model.Album) []responses.DiscTitle { return nil } var discTitles []responses.DiscTitle + // Hoist UpdatedAt to a single stack-local so &updatedAt doesn't force the + // whole model.Album parameter onto the heap. + updatedAt := a.UpdatedAt for num, title := range a.Discs { - discTitles = append(discTitles, responses.DiscTitle{Disc: int32(num), Title: title}) + artID := model.NewArtworkID(model.KindDiscArtwork, + model.DiscArtworkID(a.ID, num), &updatedAt) + discTitles = append(discTitles, responses.DiscTitle{ + Disc: int32(num), + Title: title, + CoverArt: artID.String(), + }) } if len(discTitles) == 1 && discTitles[0].Title == "" { return nil @@ -374,7 +432,7 @@ func buildDiscSubtitles(a model.Album) []responses.DiscTitle { func buildAlbumID3(ctx context.Context, album model.Album) responses.AlbumID3 { dir := responses.AlbumID3{} dir.Id = album.ID - dir.Name = album.Name + dir.Name = album.FullName() dir.Artist = album.AlbumArtist dir.ArtistId = album.AlbumArtistID dir.CoverArt = album.CoverArtID().String() @@ -383,9 +441,7 @@ func buildAlbumID3(ctx context.Context, album model.Album) responses.AlbumID3 { dir.PlayCount = album.PlayCount dir.Year = int32(cmp.Or(album.MaxOriginalYear, album.MaxYear)) dir.Genre = album.Genre - if !album.CreatedAt.IsZero() { - dir.Created = &album.CreatedAt - } + dir.Created = albumCreatedAt(album) if album.Starred { dir.Starred = album.StarredAt } @@ -403,6 +459,9 @@ func buildOSAlbumID3(ctx context.Context, album model.Album) *responses.OpenSubs dir.Played = album.PlayDate } dir.UserRating = int32(album.Rating) + if conf.Server.Subsonic.EnableAverageRating { + dir.AverageRating = album.AverageRating + } dir.RecordLabels = slice.Map(album.Tags.Values(model.TagRecordLabel), func(s string) responses.RecordLabel { return responses.RecordLabel{Name: s} }) @@ -476,3 +535,40 @@ func buildLyricsList(mf *model.MediaFile, lyricsList model.LyricList) *responses } return res } + +// getUserAccessibleLibraries returns the list of libraries the current user has access to. +func getUserAccessibleLibraries(ctx context.Context) []model.Library { + user := getUser(ctx) + return user.Libraries +} + +// selectedMusicFolderIds retrieves the music folder IDs from the request parameters. +// If no IDs are provided, it returns all libraries the user has access to (based on the user found in the context). +// If the parameter is required and not present, it returns an error. +// If any of the provided library IDs are invalid (don't exist or user doesn't have access), returns ErrorDataNotFound. +func selectedMusicFolderIds(r *http.Request, required bool) ([]int, error) { + p := req.Params(r) + musicFolderIds, err := p.Ints("musicFolderId") + + // If the parameter is not present, it returns an error if it is required. + if errors.Is(err, req.ErrMissingParam) && required { + return nil, err + } + + // Get user's accessible libraries for validation + libraries := getUserAccessibleLibraries(r.Context()) + accessibleLibraryIds := slice.Map(libraries, func(lib model.Library) int { return lib.ID }) + + if len(musicFolderIds) > 0 { + // Validate all provided library IDs - if any are invalid, return an error + for _, id := range musicFolderIds { + if !slices.Contains(accessibleLibraryIds, id) { + return nil, newError(responses.ErrorDataNotFound, "Library %d not found or not accessible", id) + } + } + return musicFolderIds, nil + } + + // If no musicFolderId is provided, return all libraries the user has access to. + return accessibleLibraryIds, nil +} diff --git a/server/subsonic/helpers_test.go b/server/subsonic/helpers_test.go index d703607ba..2ae6eb28e 100644 --- a/server/subsonic/helpers_test.go +++ b/server/subsonic/helpers_test.go @@ -1,10 +1,18 @@ package subsonic import ( + "context" + "net/http/httptest" + "time" + + "github.com/go-chi/jwtauth/v5" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/utils/req" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) @@ -12,6 +20,7 @@ import ( var _ = Describe("helpers", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) + auth.TokenAuth = jwtauth.New("HS256", []byte("test secret"), nil) }) Describe("fakePath", func() { @@ -95,27 +104,43 @@ var _ = Describe("helpers", func() { Expect(buildDiscSubtitles(album)).To(BeNil()) }) - It("should return the disc title for a single disc", func() { + It("should return the disc title with cover art for a single disc", func() { + updatedAt := time.Now().Truncate(time.Second) album := model.Album{ + ID: "album1", + UpdatedAt: updatedAt, Discs: map[int]string{ 1: "Special Edition", }, } - Expect(buildDiscSubtitles(album)).To(Equal([]responses.DiscTitle{{Disc: 1, Title: "Special Edition"}})) + result := buildDiscSubtitles(album) + Expect(result).To(HaveLen(1)) + Expect(result[0].Disc).To(Equal(int32(1))) + Expect(result[0].Title).To(Equal("Special Edition")) + expectedArtID := model.NewArtworkID(model.KindDiscArtwork, "album1:1", &updatedAt) + Expect(result[0].CoverArt).To(Equal(expectedArtID.String())) }) - It("should return correct disc titles when album has discs with valid disc numbers", func() { + It("should return correct disc titles with cover art when album has multiple discs", func() { + updatedAt := time.Now().Truncate(time.Second) album := model.Album{ + ID: "album1", + UpdatedAt: updatedAt, Discs: map[int]string{ 1: "Disc 1", 2: "Disc 2", }, } - expected := []responses.DiscTitle{ - {Disc: 1, Title: "Disc 1"}, - {Disc: 2, Title: "Disc 2"}, - } - Expect(buildDiscSubtitles(album)).To(Equal(expected)) + result := buildDiscSubtitles(album) + Expect(result).To(HaveLen(2)) + Expect(result[0].Disc).To(Equal(int32(1))) + Expect(result[0].Title).To(Equal("Disc 1")) + expectedArtID1 := model.NewArtworkID(model.KindDiscArtwork, "album1:1", &updatedAt) + Expect(result[0].CoverArt).To(Equal(expectedArtID1.String())) + Expect(result[1].Disc).To(Equal(int32(2))) + Expect(result[1].Title).To(Equal("Disc 2")) + expectedArtID2 := model.NewArtworkID(model.KindDiscArtwork, "album1:2", &updatedAt) + Expect(result[1].CoverArt).To(Equal(expectedArtID2.String())) }) }) @@ -145,7 +170,7 @@ var _ = Describe("helpers", func() { model.RoleAlbumArtist: { AlbumCount: 3, }, - model.RoleArtist: { + model.RoleMainCredit: { AlbumCount: 4, }, }, @@ -153,14 +178,466 @@ var _ = Describe("helpers", func() { It("Handles album count without artist participations", func() { conf.Server.Subsonic.ArtistParticipations = false - result := getArtistAlbumCount(artist) + result := getArtistAlbumCount(&artist) Expect(result).To(Equal(int32(3))) }) It("Handles album count without with participations", func() { conf.Server.Subsonic.ArtistParticipations = true - result := getArtistAlbumCount(artist) + result := getArtistAlbumCount(&artist) Expect(result).To(Equal(int32(4))) }) }) + + DescribeTable("isClientInList", + func(list, client string, expected bool) { + Expect(isClientInList(list, client)).To(Equal(expected)) + }, + Entry("returns false when clientList is empty", "", "some-client", false), + Entry("returns false when client is empty", "client1,client2", "", false), + Entry("returns false when both are empty", "", "", false), + Entry("returns true when client matches single entry", "my-client", "my-client", true), + Entry("returns true when client matches first in list", "client1,client2,client3", "client1", true), + Entry("returns true when client matches middle in list", "client1,client2,client3", "client2", true), + Entry("returns true when client matches last in list", "client1,client2,client3", "client3", true), + Entry("returns false when client does not match", "client1,client2", "client3", false), + Entry("trims whitespace from client list entries", "client1, client2 , client3", "client2", true), + Entry("does not trim the client parameter", "client1,client2", " client1", false), + ) + + Describe("childFromMediaFile", func() { + var mf model.MediaFile + var ctx context.Context + + BeforeEach(func() { + mf = model.MediaFile{ + ID: "mf-1", + Title: "Test Song", + Album: "Test Album", + AlbumID: "album-1", + Artist: "Test Artist", + ArtistID: "artist-1", + Year: 2023, + Genre: "Rock", + TrackNumber: 5, + Duration: 180.5, + Size: 5000000, + Suffix: "mp3", + BitRate: 320, + } + ctx = context.Background() + }) + + Context("with minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "minimal-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns only basic fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Id).To(Equal("mf-1")) + Expect(child.Title).To(Equal("Test Song")) + Expect(child.IsDir).To(BeFalse()) + + // These should not be set + Expect(child.Album).To(BeEmpty()) + Expect(child.Artist).To(BeEmpty()) + Expect(child.Parent).To(BeEmpty()) + Expect(child.Year).To(BeZero()) + Expect(child.Genre).To(BeEmpty()) + Expect(child.Track).To(BeZero()) + Expect(child.Duration).To(BeZero()) + Expect(child.Size).To(BeZero()) + Expect(child.Suffix).To(BeEmpty()) + Expect(child.BitRate).To(BeZero()) + Expect(child.CoverArt).To(BeEmpty()) + Expect(child.ContentType).To(BeEmpty()) + Expect(child.Path).To(BeEmpty()) + }) + + It("does not include OpenSubsonic extension", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.OpenSubsonicChild).To(BeNil()) + }) + }) + + Context("with non-minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Id).To(Equal("mf-1")) + Expect(child.Title).To(Equal("Test Song")) + Expect(child.IsDir).To(BeFalse()) + Expect(child.Album).To(Equal("Test Album")) + Expect(child.Artist).To(Equal("Test Artist")) + Expect(child.Parent).To(Equal("album-1")) + Expect(child.Year).To(Equal(int32(2023))) + Expect(child.Genre).To(Equal("Rock")) + Expect(child.Track).To(Equal(int32(5))) + Expect(child.Duration).To(Equal(int32(180))) + Expect(child.Size).To(Equal(int64(5000000))) + Expect(child.Suffix).To(Equal("mp3")) + Expect(child.BitRate).To(Equal(int32(320))) + }) + }) + + Context("when minimal clients list is empty", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Album).To(Equal("Test Album")) + Expect(child.Artist).To(Equal("Test Artist")) + }) + }) + + Context("when no player in context", func() { + It("returns all fields", func() { + child := childFromMediaFile(ctx, mf) + Expect(child.Album).To(Equal("Test Album")) + Expect(child.Artist).To(Equal("Test Artist")) + }) + }) + + Context("when MediaFile has an empty title", func() { + It("still includes the title field in the response", func() { + mf.Title = "" + child := childFromMediaFile(ctx, mf) + Expect(child.Title).To(Equal("")) + }) + }) + }) + + Describe("osChildFromMediaFile", func() { + var mf model.MediaFile + var ctx context.Context + + BeforeEach(func() { + mf = model.MediaFile{ + ID: "mf-1", + Title: "Test Song", + Artist: "Test Artist", + Comment: "Test Comment", + } + ctx = context.Background() + }) + + Context("with legacy client", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "legacy-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns nil", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).To(BeNil()) + }) + }) + + Context("with non-legacy client", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns OpenSubsonic child fields", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).ToNot(BeNil()) + Expect(osChild.Comment).To(Equal("Test Comment")) + }) + }) + + Context("when legacy clients list is empty", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns OpenSubsonic child fields", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).ToNot(BeNil()) + }) + }) + + Context("when no player in context", func() { + It("returns OpenSubsonic child fields", func() { + osChild := osChildFromMediaFile(ctx, mf) + Expect(osChild).ToNot(BeNil()) + }) + }) + }) + + Describe("selectedMusicFolderIds", func() { + var user model.User + var ctx context.Context + + BeforeEach(func() { + user = model.User{ + ID: "test-user", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + } + ctx = request.WithUser(context.Background(), user) + }) + + Context("when musicFolderId parameter is provided", func() { + It("should return the specified musicFolderId values", func() { + r := httptest.NewRequest("GET", "/test?musicFolderId=1&musicFolderId=3", nil) + r = r.WithContext(ctx) + + ids, err := selectedMusicFolderIds(r, false) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(Equal([]int{1, 3})) + }) + + It("should ignore invalid musicFolderId parameter values", func() { + r := httptest.NewRequest("GET", "/test?musicFolderId=invalid&musicFolderId=2", nil) + r = r.WithContext(ctx) + + ids, err := selectedMusicFolderIds(r, false) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(Equal([]int{2})) // Only valid ID is returned + }) + + It("should return error when any library ID is not accessible", func() { + r := httptest.NewRequest("GET", "/test?musicFolderId=1&musicFolderId=5&musicFolderId=2&musicFolderId=99", nil) + r = r.WithContext(ctx) + + ids, err := selectedMusicFolderIds(r, false) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("Library 5 not found or not accessible")) + Expect(ids).To(BeNil()) + }) + }) + + Context("when musicFolderId parameter is not provided", func() { + Context("and required is false", func() { + It("should return all user's library IDs", func() { + r := httptest.NewRequest("GET", "/test", nil) + r = r.WithContext(ctx) + + ids, err := selectedMusicFolderIds(r, false) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(Equal([]int{1, 2, 3})) + }) + + It("should return empty slice when user has no libraries", func() { + userWithoutLibs := model.User{ID: "no-libs-user", Libraries: []model.Library{}} + ctxWithoutLibs := request.WithUser(context.Background(), userWithoutLibs) + r := httptest.NewRequest("GET", "/test", nil) + r = r.WithContext(ctxWithoutLibs) + + ids, err := selectedMusicFolderIds(r, false) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(Equal([]int{})) + }) + }) + + Context("and required is true", func() { + It("should return ErrMissingParam error", func() { + r := httptest.NewRequest("GET", "/test", nil) + r = r.WithContext(ctx) + + ids, err := selectedMusicFolderIds(r, true) + Expect(err).To(MatchError(req.ErrMissingParam)) + Expect(ids).To(BeNil()) + }) + }) + }) + + Context("when musicFolderId parameter is empty", func() { + It("should return all user's library IDs even when empty parameter is provided", func() { + r := httptest.NewRequest("GET", "/test?musicFolderId=", nil) + r = r.WithContext(ctx) + + ids, err := selectedMusicFolderIds(r, false) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(Equal([]int{1, 2, 3})) + }) + }) + + Context("when all musicFolderId parameters are invalid", func() { + It("should return all user libraries when all musicFolderId parameters are invalid", func() { + r := httptest.NewRequest("GET", "/test?musicFolderId=invalid&musicFolderId=notanumber", nil) + r = r.WithContext(ctx) + + ids, err := selectedMusicFolderIds(r, false) + Expect(err).ToNot(HaveOccurred()) + Expect(ids).To(Equal([]int{1, 2, 3})) // Falls back to all user libraries + }) + }) + }) + + Describe("AverageRating in responses", func() { + var ctx context.Context + + BeforeEach(func() { + ctx = context.Background() + conf.Server.Subsonic.EnableAverageRating = true + }) + + Describe("childFromMediaFile", func() { + It("includes averageRating when set", func() { + mf := model.MediaFile{ + ID: "mf-avg-1", + Title: "Test Song", + Annotations: model.Annotations{ + AverageRating: 4.5, + }, + } + child := childFromMediaFile(ctx, mf) + Expect(child.AverageRating).To(Equal(4.5)) + }) + + It("returns 0 for averageRating when not set", func() { + mf := model.MediaFile{ + ID: "mf-avg-2", + Title: "Test Song No Rating", + } + child := childFromMediaFile(ctx, mf) + Expect(child.AverageRating).To(Equal(0.0)) + }) + }) + + Describe("childFromAlbum", func() { + It("includes averageRating when set", func() { + al := model.Album{ + ID: "al-avg-1", + Name: "Test Album", + Annotations: model.Annotations{ + AverageRating: 3.75, + }, + } + child := childFromAlbum(ctx, al) + Expect(child.AverageRating).To(Equal(3.75)) + }) + + It("returns 0 for averageRating when not set", func() { + al := model.Album{ + ID: "al-avg-2", + Name: "Test Album No Rating", + } + child := childFromAlbum(ctx, al) + Expect(child.AverageRating).To(Equal(0.0)) + }) + }) + + Describe("toArtist", func() { + It("includes averageRating when set", func() { + conf.Server.Subsonic.EnableAverageRating = true + r := httptest.NewRequest("GET", "/test", nil) + a := model.Artist{ + ID: "ar-avg-1", + Name: "Test Artist", + Annotations: model.Annotations{ + AverageRating: 5.0, + }, + } + artist := toArtist(r, a) + Expect(artist.AverageRating).To(Equal(5.0)) + }) + }) + + Describe("toArtistID3", func() { + It("includes averageRating when set", func() { + conf.Server.Subsonic.EnableAverageRating = true + r := httptest.NewRequest("GET", "/test", nil) + a := model.Artist{ + ID: "ar-avg-2", + Name: "Test Artist ID3", + Annotations: model.Annotations{ + AverageRating: 2.5, + }, + } + artist := toArtistID3(r, a) + Expect(artist.AverageRating).To(Equal(2.5)) + }) + }) + + Describe("buildAlbumID3 Created field", func() { + It("uses CreatedAt when set", func() { + t := time.Date(2020, 1, 2, 3, 4, 5, 0, time.UTC) + al := model.Album{ID: "a1", Name: "A", CreatedAt: t} + dir := buildAlbumID3(ctx, al) + Expect(dir.Created).To(Equal(t)) + }) + + It("falls back to UpdatedAt when CreatedAt is zero", func() { + updated := time.Date(2019, 5, 6, 7, 8, 9, 0, time.UTC) + al := model.Album{ID: "a2", Name: "A", UpdatedAt: updated} + dir := buildAlbumID3(ctx, al) + Expect(dir.Created).To(Equal(updated)) + }) + + It("falls back to ImportedAt when CreatedAt and UpdatedAt are zero", func() { + imported := time.Date(2021, 8, 9, 10, 11, 12, 0, time.UTC) + al := model.Album{ID: "a3", Name: "A", ImportedAt: imported} + dir := buildAlbumID3(ctx, al) + Expect(dir.Created).To(Equal(imported)) + }) + + It("leaves Created as zero time when all timestamps are zero", func() { + al := model.Album{ID: "a4", Name: "A"} + dir := buildAlbumID3(ctx, al) + Expect(dir.Created.IsZero()).To(BeTrue()) + }) + }) + + Describe("EnableAverageRating config", func() { + It("excludes averageRating when disabled", func() { + conf.Server.Subsonic.EnableAverageRating = false + + mf := model.MediaFile{ + ID: "mf-cfg-1", + Title: "Test Song", + Annotations: model.Annotations{ + AverageRating: 4.5, + }, + } + child := childFromMediaFile(ctx, mf) + Expect(child.AverageRating).To(Equal(0.0)) + + al := model.Album{ + ID: "al-cfg-1", + Name: "Test Album", + Annotations: model.Annotations{ + AverageRating: 3.75, + }, + } + albumChild := childFromAlbum(ctx, al) + Expect(albumChild.AverageRating).To(Equal(0.0)) + + r := httptest.NewRequest("GET", "/test", nil) + a := model.Artist{ + ID: "ar-cfg-1", + Name: "Test Artist", + Annotations: model.Annotations{ + AverageRating: 5.0, + }, + } + artist := toArtist(r, a) + Expect(artist.AverageRating).To(Equal(0.0)) + + artistID3 := toArtistID3(r, a) + Expect(artistID3.AverageRating).To(Equal(0.0)) + }) + }) + }) }) diff --git a/server/subsonic/library_scanning.go b/server/subsonic/library_scanning.go index b6ccb9ae6..e6f64456d 100644 --- a/server/subsonic/library_scanning.go +++ b/server/subsonic/library_scanning.go @@ -1,10 +1,13 @@ package subsonic import ( + "fmt" "net/http" + "slices" "time" "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" @@ -37,23 +40,92 @@ func (api *Router) StartScan(r *http.Request) (*responses.Subsonic, error) { return nil, newError(responses.ErrorGeneric, "Internal error") } - if !loggedUser.IsAdmin { - return nil, newError(responses.ErrorAuthorizationFail) - } - p := req.Params(r) fullScan := p.BoolOr("fullScan", false) + // Parse optional target parameters for selective scanning + var targets []model.ScanTarget + if targetParams, err := p.Strings("target"); err == nil && len(targetParams) > 0 { + targets, err = model.ParseTargets(targetParams) + if err != nil { + return nil, newError(responses.ErrorGeneric, fmt.Sprintf("Invalid target parameter: %v", err)) + } + + // Validate all libraries in targets exist and user has access to them + userLibraries, err := api.ds.User(ctx).GetUserLibraries(loggedUser.ID) + if err != nil { + return nil, newError(responses.ErrorGeneric, "Internal error") + } + + // Check each target library + for _, target := range targets { + if !slices.ContainsFunc(userLibraries, func(lib model.Library) bool { return lib.ID == target.LibraryID }) { + return nil, newError(responses.ErrorDataNotFound, fmt.Sprintf("Library with ID %d not found", target.LibraryID)) + } + } + + // Special case: if single library with empty path and it's the only library in DB, call ScanAll + if len(targets) == 1 && targets[0].FolderPath == "" { + allLibs, err := api.ds.Library(ctx).GetAll() + if err != nil { + return nil, newError(responses.ErrorGeneric, "Internal error") + } + if len(allLibs) == 1 { + targets = nil // This will trigger ScanAll below + } + } + } + + fastScanCompleted := make(chan struct{}) go func() { + defer close(fastScanCompleted) start := time.Now() - log.Info(ctx, "Triggering manual scan", "fullScan", fullScan, "user", loggedUser.UserName) - _, err := api.scanner.ScanAll(ctx, fullScan) + var err error + + if len(targets) > 0 { + log.Info(ctx, "Triggering on-demand scan", "fullScan", fullScan, "targets", len(targets), "user", loggedUser.UserName) + _, err = api.scanner.ScanFolders(ctx, fullScan, targets) + } else { + log.Info(ctx, "Triggering on-demand scan", "fullScan", fullScan, "user", loggedUser.UserName) + _, err = api.scanner.ScanAll(ctx, fullScan) + } + if err != nil { log.Error(ctx, "Error scanning", err) return } - log.Info(ctx, "Manual scan complete", "user", loggedUser.UserName, "elapsed", time.Since(start)) + log.Info(ctx, "On-demand scan complete", "user", loggedUser.UserName, "elapsed", time.Since(start)) }() + // Wait briefly for the scanner to start and update its status, so the response + // reflects the current scan (not stale data from a previous scan). + const ( + pollInterval = 50 * time.Millisecond + pollTimeout = 3 * time.Second + ) + ticker := time.NewTicker(pollInterval) + defer ticker.Stop() + timer := time.NewTimer(pollTimeout) + defer timer.Stop() + +loop: + for { + status, err := api.scanner.Status(ctx) + if err == nil && status.Scanning { + break + } + select { + case <-fastScanCompleted: + log.Info(ctx, "Fast scan completed", "user", loggedUser.UserName) + break loop + case <-timer.C: + log.Warn(ctx, "Timed out waiting for scanner to start; response may be stale") + break loop + case <-ctx.Done(): + return nil, newError(responses.ErrorGeneric, "Request cancelled while waiting for scanner to start") + case <-ticker.C: + } + } + return api.GetScanStatus(r) } diff --git a/server/subsonic/library_scanning_test.go b/server/subsonic/library_scanning_test.go new file mode 100644 index 000000000..771fc3352 --- /dev/null +++ b/server/subsonic/library_scanning_test.go @@ -0,0 +1,433 @@ +package subsonic + +import ( + "context" + "errors" + "net/http/httptest" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("LibraryScanning", func() { + var api *Router + var ms *tests.MockScanner + + BeforeEach(func() { + ms = tests.NewMockScanner() + api = &Router{scanner: ms} + }) + + Describe("StartScan", func() { + It("triggers a full scan with no parameters", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with no parameters + r := httptest.NewRequest("GET", "/rest/startScan", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanAll was called (eventually, since it's in a goroutine) + Eventually(func() int { + return ms.GetScanAllCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanAllCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].FullScan).To(BeFalse()) + }) + + It("triggers a full scan with fullScan=true", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with fullScan parameter + r := httptest.NewRequest("GET", "/rest/startScan?fullScan=true", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanAll was called with fullScan=true + Eventually(func() int { + return ms.GetScanAllCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanAllCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].FullScan).To(BeTrue()) + }) + + It("triggers a selective scan with single target parameter", func() { + // Setup mocks + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with single target parameter + r := httptest.NewRequest("GET", "/rest/startScan?target=1:Music/Rock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called with correct targets + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + targets := calls[0].Targets + Expect(targets).To(HaveLen(1)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Rock")) + }) + + It("triggers a selective scan with multiple target parameters", func() { + // Setup mocks + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with multiple target parameters + r := httptest.NewRequest("GET", "/rest/startScan?target=1:Music/Reggae&target=2:Classical/Bach", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called with correct targets + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + targets := calls[0].Targets + Expect(targets).To(HaveLen(2)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("Music/Reggae")) + Expect(targets[1].LibraryID).To(Equal(2)) + Expect(targets[1].FolderPath).To(Equal("Classical/Bach")) + }) + + It("triggers a selective full scan with target and fullScan parameters", func() { + // Setup mocks + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with target and fullScan parameters + r := httptest.NewRequest("GET", "/rest/startScan?target=1:Music/Jazz&fullScan=true", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called with fullScan=true + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + Expect(calls[0].FullScan).To(BeTrue()) + targets := calls[0].Targets + Expect(targets).To(HaveLen(1)) + }) + + It("returns error for invalid target format", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with invalid target format (missing colon) + r := httptest.NewRequest("GET", "/rest/startScan?target=1MusicRock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should return error + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorGeneric)) + }) + + It("returns error for invalid library ID in target", func() { + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with invalid library ID + r := httptest.NewRequest("GET", "/rest/startScan?target=0:Music/Rock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should return error + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorGeneric)) + }) + + It("returns error when library does not exist", func() { + // Setup mocks - user has access to library 1 and 2 only + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockDS := &tests.MockDataStore{MockedUser: mockUserRepo} + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with library ID that doesn't exist + r := httptest.NewRequest("GET", "/rest/startScan?target=999:Music/Rock", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should return ErrorDataNotFound + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorDataNotFound)) + }) + + It("calls ScanAll when single library with empty path and only one library exists", func() { + // Setup mocks - single library in DB + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1}) + mockLibraryRepo := &tests.MockLibraryRepo{} + mockLibraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Music Library", Path: "/music"}, + }) + mockDS := &tests.MockDataStore{ + MockedUser: mockUserRepo, + MockedLibrary: mockLibraryRepo, + } + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with single library and empty path + r := httptest.NewRequest("GET", "/rest/startScan?target=1:", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanAll was called instead of ScanFolders + Eventually(func() int { + return ms.GetScanAllCallCount() + }).Should(BeNumerically(">", 0)) + Expect(ms.GetScanFoldersCallCount()).To(Equal(0)) + }) + + It("calls ScanFolders when single library with empty path but multiple libraries exist", func() { + // Setup mocks - multiple libraries in DB + mockUserRepo := tests.CreateMockUserRepo() + _ = mockUserRepo.SetUserLibraries("admin-id", []int{1, 2}) + mockLibraryRepo := &tests.MockLibraryRepo{} + mockLibraryRepo.SetData(model.Libraries{ + {ID: 1, Name: "Music Library", Path: "/music"}, + {ID: 2, Name: "Audiobooks", Path: "/audiobooks"}, + }) + mockDS := &tests.MockDataStore{ + MockedUser: mockUserRepo, + MockedLibrary: mockLibraryRepo, + } + api.ds = mockDS + + // Create admin user + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + // Create request with single library and empty path + r := httptest.NewRequest("GET", "/rest/startScan?target=1:", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.StartScan(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + + // Verify ScanFolders was called (not ScanAll) + Eventually(func() int { + return ms.GetScanFoldersCallCount() + }).Should(BeNumerically(">", 0)) + calls := ms.GetScanFoldersCalls() + Expect(calls).To(HaveLen(1)) + targets := calls[0].Targets + Expect(targets).To(HaveLen(1)) + Expect(targets[0].LibraryID).To(Equal(1)) + Expect(targets[0].FolderPath).To(Equal("")) + }) + + It("returns correct scanType in response when fullScan=false", func() { + // Setup mock to update status when scan starts (simulating the real scanner) + ms.SetScanStatusFunc(func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus { + scanType := "quick" + if fullScan { + scanType = "full" + } + return &model.ScannerStatus{ + Scanning: true, + ScanType: scanType, + } + }) + + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + r := httptest.NewRequest("GET", "/rest/startScan", nil) + r = r.WithContext(ctx) + + response, err := api.StartScan(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.ScanStatus).ToNot(BeNil()) + Expect(response.ScanStatus.Scanning).To(BeTrue()) + Expect(response.ScanStatus.ScanType).To(Equal("quick")) + }) + + It("returns correct scanType in response when fullScan=true", func() { + // Setup mock to update status when scan starts (simulating the real scanner) + ms.SetScanStatusFunc(func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus { + scanType := "quick" + if fullScan { + scanType = "full" + } + return &model.ScannerStatus{ + Scanning: true, + ScanType: scanType, + } + }) + + ctx := request.WithUser(context.Background(), model.User{ + ID: "admin-id", + IsAdmin: true, + }) + + r := httptest.NewRequest("GET", "/rest/startScan?fullScan=true", nil) + r = r.WithContext(ctx) + + response, err := api.StartScan(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.ScanStatus).ToNot(BeNil()) + Expect(response.ScanStatus.Scanning).To(BeTrue()) + Expect(response.ScanStatus.ScanType).To(Equal("full")) + }) + }) + + Describe("GetScanStatus", func() { + It("returns scan status", func() { + // Setup mock scanner status + ms.SetStatusResponse(&model.ScannerStatus{ + Scanning: false, + Count: 100, + FolderCount: 10, + }) + + // Create request + ctx := context.Background() + r := httptest.NewRequest("GET", "/rest/getScanStatus", nil) + r = r.WithContext(ctx) + + // Call endpoint + response, err := api.GetScanStatus(r) + + // Should succeed + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.ScanStatus).ToNot(BeNil()) + Expect(response.ScanStatus.Scanning).To(BeFalse()) + Expect(response.ScanStatus.Count).To(Equal(int64(100))) + Expect(response.ScanStatus.FolderCount).To(Equal(int64(10))) + }) + }) +}) diff --git a/server/subsonic/media_annotation.go b/server/subsonic/media_annotation.go index 74000856f..e8b0278c1 100644 --- a/server/subsonic/media_annotation.go +++ b/server/subsonic/media_annotation.go @@ -3,6 +3,7 @@ package subsonic import ( "context" "fmt" + "math" "net/http" "time" @@ -165,6 +166,7 @@ func (api *Router) Scrobble(r *http.Request) (*responses.Subsonic, error) { return nil, newError(responses.ErrorGeneric, "Wrong number of timestamps: %d, should be %d", len(times), len(ids)) } submission := p.BoolOr("submission", true) + position := p.IntOr("position", 0) ctx := r.Context() if submission { @@ -173,7 +175,7 @@ func (api *Router) Scrobble(r *http.Request) (*responses.Subsonic, error) { log.Error(ctx, "Error registering scrobbles", "ids", ids, "times", times, err) } } else { - err := api.scrobblerNowPlaying(ctx, ids[0]) + err := api.scrobblerNowPlaying(ctx, ids[0], position) if err != nil { log.Error(ctx, "Error setting NowPlaying", "id", ids[0], err) } @@ -198,7 +200,7 @@ func (api *Router) scrobblerSubmit(ctx context.Context, ids []string, times []ti return api.scrobbler.Submit(ctx, submissions) } -func (api *Router) scrobblerNowPlaying(ctx context.Context, trackId string) error { +func (api *Router) scrobblerNowPlaying(ctx context.Context, trackId string, position int) error { mf, err := api.ds.MediaFile(ctx).Get(trackId) if err != nil { return err @@ -215,7 +217,74 @@ func (api *Router) scrobblerNowPlaying(ctx context.Context, trackId string) erro clientId = player.ID } - log.Info(ctx, "Now Playing", "title", mf.Title, "artist", mf.Artist, "user", username, "player", player.Name) - err = api.scrobbler.NowPlaying(ctx, clientId, client, trackId) - return err + log.Info(ctx, "Now Playing", "title", mf.Title, "artist", mf.Artist, "user", username, "player", player.Name, "position", position) + return api.scrobbler.ReportPlayback(ctx, scrobbler.ReportPlaybackParams{ + MediaId: trackId, + PositionMs: int64(position) * 1000, + State: scrobbler.StatePlaying, + PlaybackRate: 1.0, + ClientId: clientId, + ClientName: client, + }) +} + +func (api *Router) ReportPlayback(r *http.Request) (*responses.Subsonic, error) { + p := req.Params(r) + mediaId, err := p.String("mediaId") + if err != nil { + return nil, err + } + mediaType, err := p.String("mediaType") + if err != nil { + return nil, err + } + positionMs, err := p.Int64("positionMs") + if err != nil { + return nil, err + } + if positionMs < 0 { + return nil, newError(responses.ErrorGeneric, "positionMs must be non-negative") + } + state, err := p.String("state") + if err != nil { + return nil, err + } + + if !scrobbler.ValidStates[state] { + return nil, newError(responses.ErrorGeneric, "Invalid state: %s", state) + } + + playbackRate := p.Float64Or("playbackRate", 1.0) + if math.IsNaN(playbackRate) || math.IsInf(playbackRate, 0) || playbackRate <= 0 { + return nil, newError(responses.ErrorGeneric, "playbackRate must be a finite positive number") + } + ignoreScrobble := p.BoolOr("ignoreScrobble", false) + + ctx := r.Context() + if mediaType != "song" { + log.Warn(ctx, "reportPlayback received unsupported mediaType", "mediaType", mediaType, "mediaId", mediaId) + } + + player, _ := request.PlayerFrom(ctx) + client, _ := request.ClientFrom(ctx) + clientId, ok := request.ClientUniqueIdFrom(ctx) + if !ok { + clientId = player.ID + } + + err = api.scrobbler.ReportPlayback(ctx, scrobbler.ReportPlaybackParams{ + MediaId: mediaId, + PositionMs: positionMs, + State: state, + PlaybackRate: playbackRate, + IgnoreScrobble: ignoreScrobble, + ClientId: clientId, + ClientName: client, + }) + if err != nil { + log.Error(ctx, "Error in ReportPlayback", "mediaId", mediaId, "state", state, err) + return nil, err + } + + return newResponse(), nil } diff --git a/server/subsonic/media_annotation_test.go b/server/subsonic/media_annotation_test.go index 1611250d9..487335d1a 100644 --- a/server/subsonic/media_annotation_test.go +++ b/server/subsonic/media_annotation_test.go @@ -10,6 +10,7 @@ import ( "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/events" + "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/tests" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -27,12 +28,14 @@ var _ = Describe("MediaAnnotationController", func() { ds = &tests.MockDataStore{} playTracker = &fakePlayTracker{} eventBroker = &fakeEventBroker{} - router = New(ds, nil, nil, nil, nil, nil, nil, eventBroker, nil, playTracker, nil, nil) + router = New(ds, nil, nil, nil, nil, nil, nil, eventBroker, nil, playTracker, nil, nil, nil, nil, nil, nil) }) Describe("Scrobble", func() { It("submit all scrobbles with only the id", func() { - submissionTime := time.Now() + // Back-date the baseline so the assertion still passes on platforms + // with millisecond clock resolution (e.g. Windows). + submissionTime := time.Now().Add(-time.Second) r := newGetRequest("id=12", "id=34") _, err := router.Scrobble(r) @@ -87,35 +90,110 @@ var _ = Describe("MediaAnnotationController", func() { Expect(playTracker.Submissions).To(BeEmpty()) }) - It("registers a NowPlaying", func() { + It("registers a NowPlaying via ReportPlayback", func() { _, err := router.Scrobble(req) Expect(err).ToNot(HaveOccurred()) - Expect(playTracker.Playing).To(HaveLen(1)) - Expect(playTracker.Playing).To(HaveKey("player-1")) + Expect(playTracker.ReportedPlayback).To(HaveLen(1)) + Expect(playTracker.ReportedPlayback[0].MediaId).To(Equal("12")) + Expect(playTracker.ReportedPlayback[0].State).To(Equal(scrobbler.StatePlaying)) + Expect(playTracker.ReportedPlayback[0].ClientId).To(Equal("player-1")) }) }) }) + + Describe("ReportPlayback", func() { + It("returns error when mediaId is missing", func() { + r := newGetRequest("mediaType=song", "positionMs=0", "state=playing") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when mediaType is missing", func() { + r := newGetRequest("mediaId=123", "positionMs=0", "state=playing") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when positionMs is missing", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "state=playing") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when state is missing", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=0") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for invalid state value", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=0", "state=invalid") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for negative positionMs", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=-1", "state=playing") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for NaN playbackRate", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=0", "state=playing", "playbackRate=NaN") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for Inf playbackRate", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=0", "state=playing", "playbackRate=Inf") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for negative playbackRate", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=0", "state=playing", "playbackRate=-1.0") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for zero playbackRate", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=0", "state=playing", "playbackRate=0") + _, err := router.ReportPlayback(r) + Expect(err).To(HaveOccurred()) + }) + + It("accepts mediaType=podcast without error", func() { + r := newGetRequest("mediaId=123", "mediaType=podcast", "positionMs=0", "state=playing") + ctx := request.WithPlayer(r.Context(), model.Player{ID: "p1"}) + r = r.WithContext(ctx) + resp, err := router.ReportPlayback(r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp.Status).To(Equal(responses.StatusOK)) + }) + + It("defaults playbackRate to 1.0 and ignoreScrobble to false", func() { + r := newGetRequest("mediaId=123", "mediaType=song", "positionMs=5000", "state=playing") + ctx := request.WithPlayer(r.Context(), model.Player{ID: "p1"}) + r = r.WithContext(ctx) + _, err := router.ReportPlayback(r) + Expect(err).ToNot(HaveOccurred()) + Expect(playTracker.ReportedPlayback).To(HaveLen(1)) + Expect(playTracker.ReportedPlayback[0].PlaybackRate).To(Equal(1.0)) + Expect(playTracker.ReportedPlayback[0].IgnoreScrobble).To(BeFalse()) + Expect(playTracker.ReportedPlayback[0].ClientId).To(Equal("p1")) + Expect(playTracker.ReportedPlayback[0].ClientName).To(BeEmpty()) + }) + }) }) type fakePlayTracker struct { - Submissions []scrobbler.Submission - Playing map[string]string - Error error + Submissions []scrobbler.Submission + ReportedPlayback []scrobbler.ReportPlaybackParams + Error error } -func (f *fakePlayTracker) NowPlaying(_ context.Context, playerId string, _ string, trackId string) error { - if f.Error != nil { - return f.Error - } - if f.Playing == nil { - f.Playing = make(map[string]string) - } - f.Playing[playerId] = trackId - return nil -} - -func (f *fakePlayTracker) GetNowPlaying(_ context.Context) ([]scrobbler.NowPlayingInfo, error) { +func (f *fakePlayTracker) GetNowPlaying(_ context.Context) ([]scrobbler.PlaybackSession, error) { return nil, f.Error } @@ -127,6 +205,14 @@ func (f *fakePlayTracker) Submit(_ context.Context, submissions []scrobbler.Subm return nil } +func (f *fakePlayTracker) ReportPlayback(_ context.Context, params scrobbler.ReportPlaybackParams) error { + if f.Error != nil { + return f.Error + } + f.ReportedPlayback = append(f.ReportedPlayback, params) + return nil +} + var _ scrobbler.PlayTracker = (*fakePlayTracker)(nil) type fakeEventBroker struct { @@ -138,4 +224,8 @@ func (f *fakeEventBroker) SendMessage(_ context.Context, event events.Event) { f.Events = append(f.Events, event) } +func (f *fakeEventBroker) SendBroadcastMessage(_ context.Context, event events.Event) { + f.Events = append(f.Events, event) +} + var _ events.Broker = (*fakeEventBroker)(nil) diff --git a/server/subsonic/media_retrieval.go b/server/subsonic/media_retrieval.go index 5cca74c30..9ab3a20b0 100644 --- a/server/subsonic/media_retrieval.go +++ b/server/subsonic/media_retrieval.go @@ -5,11 +5,11 @@ import ( "errors" "io" "net/http" + "strings" "time" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" - "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/resources" @@ -37,7 +37,7 @@ func (api *Router) GetAvatar(w http.ResponseWriter, r *http.Request) (*responses log.Warn(ctx, "User needs an email for gravatar to work", "username", username) return api.getPlaceHolderAvatar(w, r) } - http.Redirect(w, r, gravatar.Url(u.Email, 0), http.StatusFound) + http.Redirect(w, r, gravatar.Url(u.Email, 0), http.StatusFound) //nolint:gosec // URL is not constructed from user input return nil, nil } @@ -81,7 +81,7 @@ func (api *Router) GetCoverArt(w http.ResponseWriter, r *http.Request) (*respons defer imgReader.Close() w.Header().Set("cache-control", "public, max-age=315360000") - w.Header().Set("last-modified", lastUpdate.Format(time.RFC1123)) + w.Header().Set("last-modified", lastUpdate.Format(http.TimeFormat)) cnt, err := io.Copy(w, imgReader) if err != nil { @@ -98,7 +98,7 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) { response := newResponse() lyricsResponse := responses.Lyrics{} response.Lyrics = &lyricsResponse - mediaFiles, err := api.ds.MediaFile(r.Context()).GetAll(filter.SongWithLyrics(artist, title)) + mediaFiles, err := api.ds.MediaFile(r.Context()).GetAll(filter.SongsByArtistTitleWithLyricsFirst(artist, title)) if err != nil { return nil, err @@ -108,7 +108,7 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) { return response, nil } - structuredLyrics, err := lyrics.GetLyrics(r.Context(), &mediaFiles[0]) + structuredLyrics, err := api.lyrics.GetLyrics(r.Context(), &mediaFiles[0]) if err != nil { return nil, err } @@ -120,12 +120,12 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) { lyricsResponse.Artist = artist lyricsResponse.Title = title - lyricsText := "" + var lyricsText strings.Builder for _, line := range structuredLyrics[0].Line { - lyricsText += line.Value + "\n" + lyricsText.WriteString(line.Value + "\n") } - lyricsResponse.Value = lyricsText + lyricsResponse.Value = lyricsText.String() return response, nil } @@ -141,7 +141,7 @@ func (api *Router) GetLyricsBySongId(r *http.Request) (*responses.Subsonic, erro return nil, err } - structuredLyrics, err := lyrics.GetLyrics(r.Context(), mediaFile) + structuredLyrics, err := api.lyrics.GetLyrics(r.Context(), mediaFile) if err != nil { return nil, err } diff --git a/server/subsonic/media_retrieval_test.go b/server/subsonic/media_retrieval_test.go index a0e9754ce..12c0dff56 100644 --- a/server/subsonic/media_retrieval_test.go +++ b/server/subsonic/media_retrieval_test.go @@ -2,17 +2,19 @@ package subsonic import ( "bytes" + "cmp" "context" "encoding/json" "errors" "io" "net/http/httptest" + "slices" "time" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/conf/configtest" "github.com/navidrome/navidrome/core/artwork" - "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/core/lyrics" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/tests" @@ -23,7 +25,7 @@ import ( var _ = Describe("MediaRetrievalController", func() { var router *Router var ds model.DataStore - mockRepo := &mockedMediaFile{} + mockRepo := &mockedMediaFile{MockMediaFileRepo: tests.MockMediaFileRepo{}} var artwork *fakeArtwork var w *httptest.ResponseRecorder @@ -31,8 +33,8 @@ var _ = Describe("MediaRetrievalController", func() { ds = &tests.MockDataStore{ MockedMediaFile: mockRepo, } - artwork = &fakeArtwork{} - router = New(ds, artwork, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + artwork = &fakeArtwork{data: "image data"} + router = New(ds, artwork, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, lyrics.NewLyrics(nil), nil, nil) w = httptest.NewRecorder() DeferCleanup(configtest.SetupConfig()) conf.Server.LyricsPriority = "embedded,.lrc" @@ -40,27 +42,27 @@ var _ = Describe("MediaRetrievalController", func() { Describe("GetCoverArt", func() { It("should return data for that id", func() { - artwork.data = "image data" - r := newGetRequest("id=34", "size=128") + r := newGetRequest("id=34", "size=128", "square=true") _, err := router.GetCoverArt(w, r) - Expect(err).To(BeNil()) - Expect(artwork.recvId).To(Equal("34")) + Expect(err).ToNot(HaveOccurred()) Expect(artwork.recvSize).To(Equal(128)) + Expect(artwork.recvSquare).To(BeTrue()) Expect(w.Body.String()).To(Equal(artwork.data)) }) It("should return placeholder if id parameter is missing (mimicking Subsonic)", func() { - r := newGetRequest() + r := newGetRequest() // No id parameter _, err := router.GetCoverArt(w, r) Expect(err).To(BeNil()) + Expect(artwork.recvId).To(BeEmpty()) Expect(w.Body.String()).To(Equal(artwork.data)) }) It("should fail when the file is not found", func() { artwork.err = model.ErrNotFound - r := newGetRequest("id=34", "size=128") + r := newGetRequest("id=34", "size=128", "square=true") _, err := router.GetCoverArt(w, r) Expect(err).To(MatchError("Artwork not found")) @@ -73,6 +75,39 @@ var _ = Describe("MediaRetrievalController", func() { Expect(err).To(MatchError("weird error")) }) + + When("client disconnects (context is cancelled)", func() { + It("should not call the service if cancelled before the call", func() { + ctx, cancel := context.WithCancel(context.Background()) + r := newGetRequest("id=34", "size=128", "square=true") + r = r.WithContext(ctx) + cancel() + + _, err := router.GetCoverArt(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(artwork.recvId).To(Equal("")) + Expect(artwork.recvSize).To(Equal(0)) + Expect(artwork.recvSquare).To(BeFalse()) + Expect(w.Body.String()).To(BeEmpty()) + }) + + It("should not return data if cancelled during the call", func() { + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + r := newGetRequest("id=34", "size=128", "square=true") + r = r.WithContext(ctx) + artwork.ctxCancelFunc = cancel + + _, err := router.GetCoverArt(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(artwork.recvId).To(Equal("34")) + Expect(artwork.recvSize).To(Equal(128)) + Expect(artwork.recvSquare).To(BeTrue()) + Expect(w.Body.String()).To(BeEmpty()) + }) + }) }) Describe("GetLyrics", func() { @@ -84,19 +119,32 @@ var _ = Describe("MediaRetrievalController", func() { }) Expect(err).ToNot(HaveOccurred()) + baseTime := time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC) mockRepo.SetData(model.MediaFiles{ { - ID: "1", - Artist: "Rick Astley", - Title: "Never Gonna Give You Up", - Lyrics: string(lyricsJson), + ID: "2", + Artist: "Rick Astley", + Title: "Never Gonna Give You Up", + Lyrics: "[]", + UpdatedAt: baseTime.Add(2 * time.Hour), // No lyrics, newer + }, + { + ID: "1", + Artist: "Rick Astley", + Title: "Never Gonna Give You Up", + Lyrics: string(lyricsJson), + UpdatedAt: baseTime.Add(1 * time.Hour), // Has lyrics, older + }, + { + ID: "3", + Artist: "Rick Astley", + Title: "Never Gonna Give You Up", + Lyrics: "[]", + UpdatedAt: baseTime.Add(3 * time.Hour), // No lyrics, newest }, }) response, err := router.GetLyrics(r) - if err != nil { - log.Error("You're missing something.", err) - } - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) Expect(response.Lyrics.Artist).To(Equal("Rick Astley")) Expect(response.Lyrics.Title).To(Equal("Never Gonna Give You Up")) Expect(response.Lyrics.Value).To(Equal("We're no strangers to love\nYou know the rules and so do I\n")) @@ -105,10 +153,7 @@ var _ = Describe("MediaRetrievalController", func() { r := newGetRequest("artist=Dheeraj", "title=Rinkiya+Ke+Papa") mockRepo.SetData(model.MediaFiles{}) response, err := router.GetLyrics(r) - if err != nil { - log.Error("You're missing something.", err) - } - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) Expect(response.Lyrics.Artist).To(Equal("")) Expect(response.Lyrics.Title).To(Equal("")) Expect(response.Lyrics.Value).To(Equal("")) @@ -122,16 +167,22 @@ var _ = Describe("MediaRetrievalController", func() { Artist: "Rick Astley", Title: "Never Gonna Give You Up", }, + { + Path: "tests/fixtures/test.mp3", + ID: "2", + Artist: "Rick Astley", + Title: "Never Gonna Give You Up", + }, }) response, err := router.GetLyrics(r) - Expect(err).To(BeNil()) + Expect(err).ToNot(HaveOccurred()) Expect(response.Lyrics.Artist).To(Equal("Rick Astley")) Expect(response.Lyrics.Title).To(Equal("Never Gonna Give You Up")) Expect(response.Lyrics.Value).To(Equal("We're no strangers to love\nYou know the rules and so do I\n")) }) }) - Describe("getLyricsBySongId", func() { + Describe("GetLyricsBySongId", func() { const syncedLyrics = "[00:18.80]We're no strangers to love\n[00:22.801]You know the rules and so do I" const unsyncedLyrics = "We're no strangers to love\nYou know the rules and so do I" const metadata = "[ar:Rick Astley]\n[ti:That one song]\n[offset:-100]" @@ -243,7 +294,6 @@ var _ = Describe("MediaRetrievalController", func() { response, err := router.GetLyricsBySongId(r) Expect(err).ToNot(HaveOccurred()) - offset := int64(-100) compareResponses(response.LyricsList, responses.LyricsList{ StructuredLyrics: responses.StructuredLyrics{ { @@ -261,7 +311,7 @@ var _ = Describe("MediaRetrievalController", func() { Value: "You know the rules and so do I", }, }, - Offset: &offset, + Offset: new(int64(-100)), }, }, }) @@ -271,10 +321,12 @@ var _ = Describe("MediaRetrievalController", func() { type fakeArtwork struct { artwork.Artwork - data string - err error - recvId string - recvSize int + data string + err error + ctxCancelFunc func() + recvId string + recvSize int + recvSquare bool } func (c *fakeArtwork) GetOrPlaceholder(_ context.Context, id string, size int, square bool) (io.ReadCloser, time.Time, error) { @@ -283,27 +335,37 @@ func (c *fakeArtwork) GetOrPlaceholder(_ context.Context, id string, size int, s } c.recvId = id c.recvSize = size + c.recvSquare = square + if c.ctxCancelFunc != nil { + c.ctxCancelFunc() + return nil, time.Time{}, context.Canceled + } return io.NopCloser(bytes.NewReader([]byte(c.data))), time.Time{}, nil } type mockedMediaFile struct { - model.MediaFileRepository - data model.MediaFiles + tests.MockMediaFileRepo } -func (m *mockedMediaFile) SetData(mfs model.MediaFiles) { - m.data = mfs -} - -func (m *mockedMediaFile) GetAll(...model.QueryOptions) (model.MediaFiles, error) { - return m.data, nil -} - -func (m *mockedMediaFile) Get(id string) (*model.MediaFile, error) { - for _, mf := range m.data { - if mf.ID == id { - return &mf, nil - } +func (m *mockedMediaFile) GetAll(opts ...model.QueryOptions) (model.MediaFiles, error) { + data, err := m.MockMediaFileRepo.GetAll(opts...) + if err != nil { + return nil, err } - return nil, model.ErrNotFound + if len(opts) == 0 || opts[0].Sort != "lyrics, updated_at" { + return data, nil + } + + result := slices.Clone(data) + slices.SortFunc(result, func(a, b model.MediaFile) int { + diff := cmp.Or( + cmp.Compare(a.Lyrics, b.Lyrics), + cmp.Compare(a.UpdatedAt.Unix(), b.UpdatedAt.Unix()), + ) + if opts[0].Order == "desc" { + return -diff + } + return diff + }) + return result, nil } diff --git a/server/subsonic/middlewares.go b/server/subsonic/middlewares.go index 04c484791..837852d18 100644 --- a/server/subsonic/middlewares.go +++ b/server/subsonic/middlewares.go @@ -11,25 +11,31 @@ import ( "net/http" "net/url" "strings" + "time" + "github.com/go-chi/chi/v5/middleware" ua "github.com/mileusna/useragent" "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/consts" "github.com/navidrome/navidrome/core" "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/core/metrics" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server" "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/navidrome/navidrome/utils/gg" "github.com/navidrome/navidrome/utils/req" ) func postFormToQueryParams(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + r.Body = http.MaxBytesReader(w, r.Body, 10<<20) // 10MB err := r.ParseForm() if err != nil { sendError(w, r, newError(responses.ErrorGeneric, err.Error())) + return } var parts []string for key, values := range r.Form { @@ -43,12 +49,24 @@ func postFormToQueryParams(next http.Handler) http.Handler { }) } +func fromInternalOrProxyAuth(r *http.Request) (string, bool) { + username := server.InternalAuth(r) + + // If the username comes from internal auth, do not also do reverse proxy auth, as + // the request will have no reverse proxy IP + if username != "" { + return username, true + } + + return server.UsernameFromExtAuthHeader(r), false +} + func checkRequiredParameters(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { var requiredParameters []string - var username string - if username = server.UsernameFromReverseProxyHeader(r); username != "" { + username, _ := fromInternalOrProxyAuth(r) + if username != "" { requiredParameters = []string{"v", "c"} } else { requiredParameters = []string{"u", "v", "c"} @@ -87,16 +105,18 @@ func authenticate(ds model.DataStore) func(next http.Handler) http.Handler { var usr *model.User var err error - if username := server.UsernameFromReverseProxyHeader(r); username != "" { + username, isInternalAuth := fromInternalOrProxyAuth(r) + if username != "" { + authType := If(isInternalAuth, "internal", "reverse-proxy") usr, err = ds.User(ctx).FindByUsername(username) if errors.Is(err, context.Canceled) { - log.Debug(ctx, "API: Request canceled when authenticating", "auth", "reverse-proxy", "username", username, "remoteAddr", r.RemoteAddr, err) + log.Debug(ctx, "API: Request canceled when authenticating", "auth", authType, "username", username, "remoteAddr", r.RemoteAddr, err) return } if errors.Is(err, model.ErrNotFound) { - log.Warn(ctx, "API: Invalid login", "auth", "reverse-proxy", "username", username, "remoteAddr", r.RemoteAddr, err) + log.Warn(ctx, "API: Invalid login", "auth", authType, "username", username, "remoteAddr", r.RemoteAddr, err) } else if err != nil { - log.Error(ctx, "API: Error authenticating username", "auth", "reverse-proxy", "username", username, "remoteAddr", r.RemoteAddr, err) + log.Error(ctx, "API: Error authenticating username", "auth", authType, "username", username, "remoteAddr", r.RemoteAddr, err) } } else { p := req.Params(r) @@ -135,13 +155,30 @@ func authenticate(ds model.DataStore) func(next http.Handler) http.Handler { } } +func adminOnly(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + loggedUser, ok := request.UserFrom(r.Context()) + if !ok { + sendError(w, r, newError(responses.ErrorGeneric, "Internal error")) + return + } + + if !loggedUser.IsAdmin { + sendError(w, r, newError(responses.ErrorAuthorizationFail)) + return + } + + next.ServeHTTP(w, r) + }) +} + func validateCredentials(user *model.User, pass, token, salt, jwt string) error { valid := false switch { case jwt != "": claims, err := auth.Validate(jwt) - valid = err == nil && claims["sub"] == user.UserName + valid = err == nil && claims.Subject == user.UserName case pass != "": if strings.HasPrefix(pass, "enc:") { if dec, err := hex.DecodeString(pass[4:]); err == nil { @@ -179,7 +216,7 @@ func getPlayer(players core.Players) func(next http.Handler) http.Handler { } r = r.WithContext(ctx) - cookie := &http.Cookie{ + cookie := &http.Cookie{ //nolint:gosec // Secure omitted: Navidrome may run over plain HTTP Name: playerIDCookieName(userName), Value: player.ID, MaxAge: consts.CookieExpiry, @@ -218,3 +255,39 @@ func playerIDCookieName(userName string) string { cookieName := fmt.Sprintf("nd-player-%x", userName) return cookieName } + +type contextKey string + +const subsonicErrorPointer contextKey = "subsonicErrorPointer" + +func recordStats(metrics metrics.Metrics) func(next http.Handler) http.Handler { + return func(next http.Handler) http.Handler { + fn := func(w http.ResponseWriter, r *http.Request) { + ww := middleware.NewWrapResponseWriter(w, r.ProtoMajor) + + status := int32(-1) + contextWithStatus := context.WithValue(r.Context(), subsonicErrorPointer, &status) + + start := time.Now() + defer func() { + elapsed := time.Since(start).Milliseconds() + + // We want to get the client name (even if not present for certain endpoints) + p := req.Params(r) + client, _ := p.String("c") + + // If there is no Subsonic status (e.g., HTTP 501 not implemented), fallback to HTTP + if status == -1 { + status = int32(ww.Status()) + } + + shortPath := strings.Replace(r.URL.Path, ".view", "", 1) + + metrics.RecordRequest(r.Context(), shortPath, r.Method, client, status, elapsed) + }() + + next.ServeHTTP(ww, r.WithContext(contextWithStatus)) + } + return http.HandlerFunc(fn) + } +} diff --git a/server/subsonic/middlewares_test.go b/server/subsonic/middlewares_test.go index 3fe577fad..3f8c07a56 100644 --- a/server/subsonic/middlewares_test.go +++ b/server/subsonic/middlewares_test.go @@ -95,8 +95,8 @@ var _ = Describe("Middlewares", func() { }) It("passes when all required params are available (reverse-proxy case)", func() { - conf.Server.ReverseProxyWhitelist = "127.0.0.234/32" - conf.Server.ReverseProxyUserHeader = "Remote-User" + conf.Server.ExtAuth.TrustedSources = "127.0.0.234/32" + conf.Server.ExtAuth.UserHeader = "Remote-User" r := newGetRequest("v=1.15", "c=test") r.Header.Add("Remote-User", "user") @@ -254,8 +254,8 @@ var _ = Describe("Middlewares", func() { When("using reverse proxy authentication", func() { BeforeEach(func() { DeferCleanup(configtest.SetupConfig()) - conf.Server.ReverseProxyWhitelist = "192.168.1.1/24" - conf.Server.ReverseProxyUserHeader = "Remote-User" + conf.Server.ExtAuth.TrustedSources = "192.168.1.1/24" + conf.Server.ExtAuth.UserHeader = "Remote-User" }) It("passes authentication with correct IP and header", func() { @@ -281,6 +281,61 @@ var _ = Describe("Middlewares", func() { Expect(next.called).To(BeFalse()) }) }) + + When("using internal authentication", func() { + It("passes authentication with correct internal credentials", func() { + // Simulate internal authentication by setting the context with WithInternalAuth + r := newGetRequest() + r = r.WithContext(request.WithInternalAuth(r.Context(), "admin")) + cp := authenticate(ds)(next) + cp.ServeHTTP(w, r) + + Expect(next.called).To(BeTrue()) + user, _ := request.UserFrom(next.req.Context()) + Expect(user.UserName).To(Equal("admin")) + }) + + It("fails authentication with missing internal context", func() { + r := newGetRequest("u=admin") + // Do not set the internal auth context + cp := authenticate(ds)(next) + cp.ServeHTTP(w, r) + + // Internal auth requires the context, so this should fail + Expect(w.Body.String()).To(ContainSubstring(`code="40"`)) + Expect(next.called).To(BeFalse()) + }) + }) + }) + + Describe("AdminOnly", func() { + It("passes admin users", func() { + r := newGetRequest() + r = r.WithContext(request.WithUser(r.Context(), model.User{ID: "admin-id", IsAdmin: true})) + + adminOnly(next).ServeHTTP(w, r) + + Expect(next.called).To(BeTrue()) + }) + + It("rejects non-admin users", func() { + r := newGetRequest() + r = r.WithContext(request.WithUser(r.Context(), model.User{ID: "user-id", IsAdmin: false})) + + adminOnly(next).ServeHTTP(w, r) + + Expect(w.Body.String()).To(ContainSubstring(`code="50"`)) + Expect(next.called).To(BeFalse()) + }) + + It("returns an internal error when user is missing from context", func() { + r := newGetRequest() + + adminOnly(next).ServeHTTP(w, r) + + Expect(w.Body.String()).To(ContainSubstring(`code="0"`)) + Expect(next.called).To(BeFalse()) + }) }) Describe("GetPlayer", func() { diff --git a/server/subsonic/opensubsonic.go b/server/subsonic/opensubsonic.go index 17ce3c2b0..85edb1012 100644 --- a/server/subsonic/opensubsonic.go +++ b/server/subsonic/opensubsonic.go @@ -8,10 +8,19 @@ import ( func (api *Router) GetOpenSubsonicExtensions(_ *http.Request) (*responses.Subsonic, error) { response := newResponse() - response.OpenSubsonicExtensions = &responses.OpenSubsonicExtensions{ + extensions := responses.OpenSubsonicExtensions{ {Name: "transcodeOffset", Versions: []int32{1}}, {Name: "formPost", Versions: []int32{1}}, {Name: "songLyrics", Versions: []int32{1}}, + {Name: "indexBasedQueue", Versions: []int32{1}}, + {Name: "transcoding", Versions: []int32{1}}, + {Name: "playbackReport", Versions: []int32{1}}, } + if api.sonic != nil && api.sonic.HasProvider() { + extensions = append(extensions, responses.OpenSubsonicExtension{ + Name: "sonicSimilarity", Versions: []int32{1}, + }) + } + response.OpenSubsonicExtensions = &extensions return response, nil } diff --git a/server/subsonic/opensubsonic_test.go b/server/subsonic/opensubsonic_test.go index d92ea4c67..3ccbf232e 100644 --- a/server/subsonic/opensubsonic_test.go +++ b/server/subsonic/opensubsonic_test.go @@ -5,12 +5,28 @@ import ( "net/http" "net/http/httptest" + sonicsvc "github.com/navidrome/navidrome/core/sonic" "github.com/navidrome/navidrome/server/subsonic" "github.com/navidrome/navidrome/server/subsonic/responses" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" ) +type mockSonicPluginLoader struct { + names []string +} + +func (m *mockSonicPluginLoader) PluginNames(capability string) []string { + if capability == "SonicSimilarity" { + return m.names + } + return nil +} + +func (m *mockSonicPluginLoader) LoadSonicSimilarity(_ string) (sonicsvc.Provider, bool) { + return nil, false +} + var _ = Describe("GetOpenSubsonicExtensions", func() { var ( router *subsonic.Router @@ -18,27 +34,66 @@ var _ = Describe("GetOpenSubsonicExtensions", func() { r *http.Request ) - BeforeEach(func() { - router = subsonic.New(nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + JustBeforeEach(func() { w = httptest.NewRecorder() r = httptest.NewRequest("GET", "/getOpenSubsonicExtensions?f=json", nil) }) - It("should return the correct OpenSubsonicExtensions", func() { - router.ServeHTTP(w, r) + Context("without sonic similarity plugin", func() { + BeforeEach(func() { + router = subsonic.New(nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + }) - // Make sure the endpoint is public, by not passing any authentication - Expect(w.Code).To(Equal(http.StatusOK)) - Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + It("should return the base 6 OpenSubsonicExtensions without sonicSimilarity", func() { + router.ServeHTTP(w, r) - var response responses.JsonWrapper - err := json.Unmarshal(w.Body.Bytes(), &response) - Expect(err).NotTo(HaveOccurred()) - Expect(*response.Subsonic.OpenSubsonicExtensions).To(SatisfyAll( - HaveLen(3), - ContainElement(responses.OpenSubsonicExtension{Name: "transcodeOffset", Versions: []int32{1}}), - ContainElement(responses.OpenSubsonicExtension{Name: "formPost", Versions: []int32{1}}), - ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1}}), - )) + // Make sure the endpoint is public, by not passing any authentication + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + + var response responses.JsonWrapper + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).NotTo(HaveOccurred()) + Expect(*response.Subsonic.OpenSubsonicExtensions).To(SatisfyAll( + HaveLen(6), + ContainElement(responses.OpenSubsonicExtension{Name: "transcodeOffset", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "formPost", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "indexBasedQueue", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "transcoding", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "playbackReport", Versions: []int32{1}}), + )) + Expect(*response.Subsonic.OpenSubsonicExtensions).NotTo( + ContainElement(responses.OpenSubsonicExtension{Name: "sonicSimilarity", Versions: []int32{1}}), + ) + }) + }) + + Context("with sonic similarity plugin", func() { + BeforeEach(func() { + sonicService := sonicsvc.New(nil, &mockSonicPluginLoader{names: []string{"test-plugin"}}, nil) + router = subsonic.New(nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, sonicService) + }) + + It("should return 7 extensions including sonicSimilarity", func() { + router.ServeHTTP(w, r) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Header().Get("Content-Type")).To(Equal("application/json")) + + var response responses.JsonWrapper + err := json.Unmarshal(w.Body.Bytes(), &response) + Expect(err).NotTo(HaveOccurred()) + Expect(*response.Subsonic.OpenSubsonicExtensions).To(SatisfyAll( + HaveLen(7), + ContainElement(responses.OpenSubsonicExtension{Name: "transcodeOffset", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "formPost", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "indexBasedQueue", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "transcoding", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "playbackReport", Versions: []int32{1}}), + ContainElement(responses.OpenSubsonicExtension{Name: "sonicSimilarity", Versions: []int32{1}}), + )) + }) }) }) diff --git a/server/subsonic/playlists.go b/server/subsonic/playlists.go index 555c9eb48..7101f9f15 100644 --- a/server/subsonic/playlists.go +++ b/server/subsonic/playlists.go @@ -7,8 +7,10 @@ import ( "net/http" "time" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" "github.com/navidrome/navidrome/utils/slice" @@ -16,14 +18,14 @@ import ( func (api *Router) GetPlaylists(r *http.Request) (*responses.Subsonic, error) { ctx := r.Context() - allPls, err := api.ds.Playlist(ctx).GetAll(model.QueryOptions{Sort: "name"}) + allPls, err := api.playlists.GetAll(ctx, model.QueryOptions{Sort: "name"}) if err != nil { log.Error(r, err) return nil, err } response := newResponse() response.Playlists = &responses.Playlists{ - Playlist: slice.Map(allPls, api.buildPlaylist), + Playlist: slice.MapWithArg(allPls, ctx, api.buildPlaylist), } return response, nil } @@ -39,7 +41,7 @@ func (api *Router) GetPlaylist(r *http.Request) (*responses.Subsonic, error) { } func (api *Router) getPlaylist(ctx context.Context, id string) (*responses.Subsonic, error) { - pls, err := api.ds.Playlist(ctx).GetWithTracks(id, true, false) + pls, err := api.playlists.GetWithTracks(ctx, id) if errors.Is(err, model.ErrNotFound) { log.Error(ctx, err.Error(), "id", id) return nil, newError(responses.ErrorDataNotFound, "playlist not found") @@ -51,40 +53,12 @@ func (api *Router) getPlaylist(ctx context.Context, id string) (*responses.Subso response := newResponse() response.Playlist = &responses.PlaylistWithSongs{ - Playlist: api.buildPlaylist(*pls), + Playlist: api.buildPlaylist(ctx, *pls), } response.Playlist.Entry = slice.MapWithArg(pls.MediaFiles(), ctx, childFromMediaFile) return response, nil } -func (api *Router) create(ctx context.Context, playlistId, name string, ids []string) (string, error) { - err := api.ds.WithTxImmediate(func(tx model.DataStore) error { - owner := getUser(ctx) - var pls *model.Playlist - var err error - - if playlistId != "" { - pls, err = tx.Playlist(ctx).Get(playlistId) - if err != nil { - return err - } - if owner.ID != pls.OwnerID { - return model.ErrNotAuthorized - } - } else { - pls = &model.Playlist{Name: name} - pls.OwnerID = owner.ID - } - pls.Tracks = nil - pls.AddTracks(ids) - - err = tx.Playlist(ctx).Put(pls) - playlistId = pls.ID - return err - }) - return playlistId, err -} - func (api *Router) CreatePlaylist(r *http.Request) (*responses.Subsonic, error) { ctx := r.Context() p := req.Params(r) @@ -94,7 +68,7 @@ func (api *Router) CreatePlaylist(r *http.Request) (*responses.Subsonic, error) if playlistId == "" && name == "" { return nil, errors.New("required parameter name is missing") } - id, err := api.create(ctx, playlistId, name, songIds) + id, err := api.playlists.Create(ctx, playlistId, name, songIds) if err != nil { log.Error(r, err) return nil, err @@ -108,7 +82,7 @@ func (api *Router) DeletePlaylist(r *http.Request) (*responses.Subsonic, error) if err != nil { return nil, err } - err = api.ds.Playlist(r.Context()).Delete(id) + err = api.playlists.Delete(r.Context(), id) if errors.Is(err, model.ErrNotAuthorized) { return nil, newError(responses.ErrorAuthorizationFail) } @@ -131,14 +105,8 @@ func (api *Router) UpdatePlaylist(r *http.Request) (*responses.Subsonic, error) if s, err := p.String("name"); err == nil { plsName = &s } - var comment *string - if s, err := p.String("comment"); err == nil { - comment = &s - } - var public *bool - if p, err := p.Bool("public"); err == nil { - public = &p - } + comment := p.StringPtr("comment") + public := p.BoolPtr("public") log.Debug(r, "Updating playlist", "id", playlistId) if plsName != nil { @@ -158,21 +126,54 @@ func (api *Router) UpdatePlaylist(r *http.Request) (*responses.Subsonic, error) return newResponse(), nil } -func (api *Router) buildPlaylist(p model.Playlist) responses.Playlist { +func (api *Router) buildPlaylist(ctx context.Context, p model.Playlist) responses.Playlist { pls := responses.Playlist{} pls.Id = p.ID pls.Name = p.Name - pls.Comment = p.Comment pls.SongCount = int32(p.SongCount) - pls.Owner = p.OwnerName pls.Duration = int32(p.Duration) - pls.Public = p.Public pls.Created = p.CreatedAt - pls.CoverArt = p.CoverArtID().String() if p.IsSmartPlaylist() { - pls.Changed = time.Now() + if p.EvaluatedAt != nil { + pls.Changed = *p.EvaluatedAt + } else { + pls.Changed = time.Now() + } } else { pls.Changed = p.UpdatedAt } + + player, ok := request.PlayerFrom(ctx) + if ok && isClientInList(conf.Server.Subsonic.MinimalClients, player.Client) { + return pls + } + + pls.Comment = p.Comment + pls.Owner = p.OwnerName + pls.Public = p.Public + pls.CoverArt = p.CoverArtID().String() + pls.OpenSubsonicPlaylist = buildOSPlaylist(ctx, p) + return pls } + +func buildOSPlaylist(ctx context.Context, p model.Playlist) *responses.OpenSubsonicPlaylist { + player, ok := request.PlayerFrom(ctx) + if ok && isClientInList(conf.Server.Subsonic.LegacyClients, player.Client) { + return nil + } + pls := responses.OpenSubsonicPlaylist{} + + if p.IsSmartPlaylist() { + pls.Readonly = true + + if p.EvaluatedAt != nil { + pls.ValidUntil = new(p.EvaluatedAt.Add(conf.Server.SmartPlaylistRefreshDelay)) + } + } else { + user, ok := request.UserFrom(ctx) + pls.Readonly = !ok || p.OwnerID != user.ID + } + + return &pls +} diff --git a/server/subsonic/playlists_test.go b/server/subsonic/playlists_test.go new file mode 100644 index 000000000..1d5f6a70a --- /dev/null +++ b/server/subsonic/playlists_test.go @@ -0,0 +1,326 @@ +package subsonic + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/core/playlists" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/criteria" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ playlists.Playlists = (*fakePlaylists)(nil) + +var _ = Describe("buildPlaylist", func() { + var router *Router + var ds model.DataStore + var ctx context.Context + var playlist model.Playlist + + BeforeEach(func() { + ds = &tests.MockDataStore{} + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + ctx = context.Background() + }) + + Describe("normal playlist", func() { + BeforeEach(func() { + createdAt := time.Date(2023, 1, 15, 10, 30, 0, 0, time.UTC) + updatedAt := time.Date(2023, 2, 20, 14, 45, 0, 0, time.UTC) + + playlist = model.Playlist{ + ID: "pls-1", + Name: "My Playlist", + Comment: "Test comment", + OwnerName: "admin", + OwnerID: "1234", + Public: true, + SongCount: 10, + Duration: 600, + CreatedAt: createdAt, + UpdatedAt: updatedAt, + } + }) + + Context("with minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "minimal-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns only basic fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(playlist.UpdatedAt)) + + // These should not be set + Expect(result.Comment).To(BeEmpty()) + Expect(result.Owner).To(BeEmpty()) + Expect(result.Public).To(BeFalse()) + Expect(result.CoverArt).To(BeEmpty()) + }) + }) + + Context("with non-minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(playlist.UpdatedAt)) + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.Readonly).To(BeTrue()) + }) + + It("returns all fields when as owner", func() { + ctx = request.WithUser(ctx, model.User{ID: "1234", UserName: "admin"}) + + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(playlist.UpdatedAt)) + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.Readonly).To(BeFalse()) + }) + }) + + Context("when minimal clients list is empty", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + }) + }) + + Context("with legacy client", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "legacy-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all standard fields but no OpenSubsonic extensions", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.OpenSubsonicPlaylist).To(BeNil()) + }) + }) + + Context("when no player in context", func() { + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + }) + }) + }) + + Describe("smart playlist", func() { + evaluatedAt := time.Date(2023, 2, 20, 15, 45, 0, 0, time.UTC) + validUntil := evaluatedAt.Add(5 * time.Second) + + BeforeEach(func() { + createdAt := time.Date(2023, 1, 15, 10, 30, 0, 0, time.UTC) + updatedAt := time.Date(2023, 2, 20, 14, 45, 0, 0, time.UTC) + + playlist = model.Playlist{ + ID: "pls-1", + Name: "My Playlist", + Comment: "Test comment", + OwnerName: "admin", + OwnerID: "1234", + Public: true, + SongCount: 10, + Duration: 600, + CreatedAt: createdAt, + UpdatedAt: updatedAt, + EvaluatedAt: &evaluatedAt, + Rules: &criteria.Criteria{ + Expression: criteria.All{criteria.Contains{"title": "title"}}, + }, + } + }) + + Context("with minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "minimal-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns only basic fields", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(evaluatedAt)) + + // These should not be set + Expect(result.Comment).To(BeEmpty()) + Expect(result.Owner).To(BeEmpty()) + Expect(result.Public).To(BeFalse()) + Expect(result.CoverArt).To(BeEmpty()) + Expect(result.OpenSubsonicPlaylist).To(BeNil()) + }) + }) + + Context("with non-minimal client", func() { + BeforeEach(func() { + conf.Server.Subsonic.MinimalClients = "minimal-client" + player := model.Player{Client: "regular-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns all fields", func() { + result := router.buildPlaylist(ctx, playlist) + Expect(result.Id).To(Equal("pls-1")) + Expect(result.Name).To(Equal("My Playlist")) + Expect(result.SongCount).To(Equal(int32(10))) + Expect(result.Duration).To(Equal(int32(600))) + Expect(result.Created).To(Equal(playlist.CreatedAt)) + Expect(result.Changed).To(Equal(*playlist.EvaluatedAt)) + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.Readonly).To(BeTrue()) + Expect(result.ValidUntil).To(Equal(&validUntil)) + }) + }) + + Context("with legacy client", func() { + BeforeEach(func() { + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "legacy-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("returns standard fields but no OpenSubsonic extensions", func() { + result := router.buildPlaylist(ctx, playlist) + + Expect(result.Comment).To(Equal("Test comment")) + Expect(result.Owner).To(Equal("admin")) + Expect(result.Public).To(BeTrue()) + Expect(result.OpenSubsonicPlaylist).To(BeNil()) + }) + }) + }) +}) + +var _ = Describe("UpdatePlaylist", func() { + var router *Router + var ds model.DataStore + var playlists *fakePlaylists + + BeforeEach(func() { + ds = &tests.MockDataStore{} + playlists = &fakePlaylists{} + router = New(ds, nil, nil, nil, nil, nil, nil, nil, playlists, nil, nil, nil, nil, nil, nil, nil) + }) + + It("clears the comment when parameter is empty", func() { + r := newGetRequest("playlistId=123", "comment=") + _, err := router.UpdatePlaylist(r) + Expect(err).ToNot(HaveOccurred()) + Expect(playlists.lastPlaylistID).To(Equal("123")) + Expect(playlists.lastComment).ToNot(BeNil()) + Expect(*playlists.lastComment).To(Equal("")) + }) + + It("leaves comment unchanged when parameter is missing", func() { + r := newGetRequest("playlistId=123") + _, err := router.UpdatePlaylist(r) + Expect(err).ToNot(HaveOccurred()) + Expect(playlists.lastPlaylistID).To(Equal("123")) + Expect(playlists.lastComment).To(BeNil()) + }) + + It("sets public to true when parameter is 'true'", func() { + r := newGetRequest("playlistId=123", "public=true") + _, err := router.UpdatePlaylist(r) + Expect(err).ToNot(HaveOccurred()) + Expect(playlists.lastPlaylistID).To(Equal("123")) + Expect(playlists.lastPublic).ToNot(BeNil()) + Expect(*playlists.lastPublic).To(BeTrue()) + }) + + It("sets public to false when parameter is 'false'", func() { + r := newGetRequest("playlistId=123", "public=false") + _, err := router.UpdatePlaylist(r) + Expect(err).ToNot(HaveOccurred()) + Expect(playlists.lastPlaylistID).To(Equal("123")) + Expect(playlists.lastPublic).ToNot(BeNil()) + Expect(*playlists.lastPublic).To(BeFalse()) + }) + + It("leaves public unchanged when parameter is missing", func() { + r := newGetRequest("playlistId=123") + _, err := router.UpdatePlaylist(r) + Expect(err).ToNot(HaveOccurred()) + Expect(playlists.lastPlaylistID).To(Equal("123")) + Expect(playlists.lastPublic).To(BeNil()) + }) +}) + +type fakePlaylists struct { + playlists.Playlists + lastPlaylistID string + lastName *string + lastComment *string + lastPublic *bool + lastAdd []string + lastRemove []int +} + +func (f *fakePlaylists) Update(ctx context.Context, playlistID string, name *string, comment *string, public *bool, idsToAdd []string, idxToRemove []int) error { + f.lastPlaylistID = playlistID + f.lastName = name + f.lastComment = comment + f.lastPublic = public + f.lastAdd = idsToAdd + f.lastRemove = idxToRemove + return nil +} diff --git a/server/subsonic/radio.go b/server/subsonic/radio.go index 9f2cd48f6..4fbd6a53d 100644 --- a/server/subsonic/radio.go +++ b/server/subsonic/radio.go @@ -2,8 +2,11 @@ package subsonic import ( "net/http" + "strings" + "github.com/navidrome/navidrome/conf" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" ) @@ -66,6 +69,19 @@ func (api *Router) GetInternetRadios(r *http.Request) (*responses.Subsonic, erro StreamUrl: g.StreamUrl, HomepageUrl: g.HomePageUrl, } + + player, _ := request.PlayerFrom(ctx) + if strings.Contains(conf.Server.Subsonic.LegacyClients, player.Client) { + continue + } + // Add coverArt if not legacy client + var coverArt string + if g.UploadedImage != "" { + coverArt = g.CoverArtID().String() + } + res[i].OpenSubsonicRadio = &responses.OpenSubsonicRadio{ + CoverArt: coverArt, + } } response := newResponse() @@ -103,7 +119,7 @@ func (api *Router) UpdateInternetRadio(r *http.Request) (*responses.Subsonic, er Name: name, } - err = api.ds.Radio(ctx).Put(radio) + err = api.ds.Radio(ctx).Put(radio, "StreamUrl", "HomePageUrl", "Name") if err != nil { return nil, err } diff --git a/server/subsonic/radio_test.go b/server/subsonic/radio_test.go new file mode 100644 index 000000000..e959ebe29 --- /dev/null +++ b/server/subsonic/radio_test.go @@ -0,0 +1,146 @@ +package subsonic + +import ( + "context" + "net/http/httptest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Radio", func() { + var api *Router + var ds *tests.MockDataStore + var ctx context.Context + var radioRepo *tests.MockedRadioRepo + + BeforeEach(func() { + ds = &tests.MockDataStore{} + auth.Init(ds) + api = &Router{ds: ds} + ctx = context.Background() + radioRepo = tests.CreateMockedRadioRepo() + ds.MockedRadio = radioRepo + }) + + Describe("GetInternetRadios", func() { + BeforeEach(func() { + radioRepo.All = model.Radios{ + {ID: "rd-1", Name: "Radio 1", StreamUrl: "http://stream1.example.com", HomePageUrl: "http://home1.example.com", UploadedImage: "rd-1_cover.jpg"}, + {ID: "rd-2", Name: "Radio 2", StreamUrl: "http://stream2.example.com"}, + } + }) + + It("returns all radios with basic fields", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios).To(HaveLen(2)) + Expect(response.InternetRadioStations.Radios[0].ID).To(Equal("rd-1")) + Expect(response.InternetRadioStations.Radios[0].Name).To(Equal("Radio 1")) + Expect(response.InternetRadioStations.Radios[0].StreamUrl).To(Equal("http://stream1.example.com")) + Expect(response.InternetRadioStations.Radios[0].HomepageUrl).To(Equal("http://home1.example.com")) + Expect(response.InternetRadioStations.Radios[1].ID).To(Equal("rd-2")) + Expect(response.InternetRadioStations.Radios[1].HomepageUrl).To(BeEmpty()) + }) + + Context("with a non-legacy client", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "modern-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("includes coverArt from UploadedImage", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios).To(HaveLen(2)) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios[0].CoverArt).To(Equal("ra-rd-1_0")) + Expect(response.InternetRadioStations.Radios[1].OpenSubsonicRadio).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios[1].CoverArt).To(BeEmpty()) + }) + }) + + Context("with a legacy client", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "legacy-client" + player := model.Player{Client: "legacy-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("does not include coverArt", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios).To(HaveLen(2)) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).To(BeNil()) + Expect(response.InternetRadioStations.Radios[1].OpenSubsonicRadio).To(BeNil()) + }) + }) + + Context("when no player in context", func() { + It("does not include coverArt (empty client matches legacy list)", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "legacy-client" + + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).To(BeNil()) + }) + }) + + Context("when legacy clients list is empty", func() { + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.Subsonic.LegacyClients = "" + player := model.Player{Client: "any-client"} + ctx = request.WithPlayer(ctx, player) + }) + + It("includes coverArt for all clients", func() { + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + response, err := api.GetInternetRadios(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(response.InternetRadioStations.Radios[0].OpenSubsonicRadio).ToNot(BeNil()) + Expect(response.InternetRadioStations.Radios[0].CoverArt).To(Equal("ra-rd-1_0")) + }) + }) + + It("returns error when repository fails", func() { + radioRepo.SetError(true) + + r := httptest.NewRequest("GET", "/rest/getInternetRadios", nil) + r = r.WithContext(ctx) + + _, err := api.GetInternetRadios(r) + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/server/subsonic/responses/.snapshots/.gitattributes b/server/subsonic/responses/.snapshots/.gitattributes new file mode 100644 index 000000000..44b4224b1 --- /dev/null +++ b/server/subsonic/responses/.snapshots/.gitattributes @@ -0,0 +1 @@ +* eol=lf \ No newline at end of file diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON index 0e6425f6a..9d9ae2195 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .JSON @@ -9,7 +9,7 @@ { "id": "1", "isDir": false, - "isVideo": false, + "title": "", "bpm": 0, "comment": "", "sortName": "sort name", @@ -56,7 +56,10 @@ "displayAlbumArtist": "Display album artist", "contributors": [], "displayComposer": "", - "explicitStatus": "explicit" + "explicitStatus": "explicit", + "groupings": [ + "Soundtrack" + ] } ] } diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML index 07200c0c5..d39fe2e7d 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with OS data should match .XML @@ -1,6 +1,6 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <albumList> - <album id="1" isDir="false" isVideo="false" sortName="sort name" mediaType="album" musicBrainzId="00000000-0000-0000-0000-000000000000" displayArtist="Display artist" displayAlbumArtist="Display album artist" explicitStatus="explicit"> + <album id="1" isDir="false" title="" sortName="sort name" mediaType="album" musicBrainzId="00000000-0000-0000-0000-000000000000" displayArtist="Display artist" displayAlbumArtist="Display album artist" explicitStatus="explicit"> <genres name="Genre 1"></genres> <genres name="Genre 2"></genres> <moods>mood1</moods> @@ -9,6 +9,7 @@ <artists id="artist-2" name="Artist 2"></artists> <albumArtists id="album-artist-1" name="Artist 1"></albumArtists> <albumArtists id="album-artist-2" name="Artist 2"></albumArtists> + <groupings>Soundtrack</groupings> </album> </albumList> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON index 946378755..7963b44f4 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML index 000b8c00c..693bbfa58 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumList with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <albumList> - <album id="1" isDir="false" title="title" isVideo="false"></album> + <album id="1" isDir="false" title="title"></album> </albumList> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON index 78b5c6e7a..bff0bd20c 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .JSON @@ -8,6 +8,9 @@ "id": "1", "name": "album", "artist": "artist", + "songCount": 0, + "duration": 292, + "created": "0001-01-01T00:00:00Z", "genre": "rock", "userRating": 4, "genres": [ @@ -93,7 +96,6 @@ "transcodedSuffix": "mp3", "duration": 146, "bitRate": 320, - "isVideo": false, "bpm": 127, "comment": "a comment", "sortName": "sorted song", @@ -165,7 +167,57 @@ } ], "displayComposer": "composer 1 \u0026 composer 2", - "explicitStatus": "clean" + "explicitStatus": "clean", + "groupings": [ + "Soundtrack", + "Live" + ] + }, + { + "id": "2", + "isDir": true, + "title": "title", + "album": "album", + "artist": "artist", + "track": 1, + "year": 1985, + "genre": "Rock", + "coverArt": "1", + "size": 8421341, + "contentType": "audio/flac", + "suffix": "flac", + "starred": "2016-03-02T20:30:00Z", + "transcodedContentType": "audio/mpeg", + "transcodedSuffix": "mp3", + "duration": 146, + "bitRate": 320, + "bpm": 0, + "comment": "", + "sortName": "", + "mediaType": "", + "musicBrainzId": "", + "isrc": [], + "genres": [], + "replayGain": { + "trackGain": 0, + "albumGain": 0, + "trackPeak": 0, + "albumPeak": 0, + "baseGain": 0, + "fallbackGain": 0 + }, + "channelCount": 0, + "samplingRate": 0, + "bitDepth": 0, + "moods": [], + "artists": [], + "displayArtist": "", + "albumArtists": [], + "displayAlbumArtist": "", + "contributors": [], + "displayComposer": "", + "explicitStatus": "", + "groupings": [] } ] } diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML index f3281d9ee..16a7748aa 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <album id="1" name="album" artist="artist" genre="rock" userRating="4" musicBrainzId="1234" isCompilation="true" sortName="sorted album" displayArtist="artist1 & artist2" explicitStatus="clean" version="Deluxe Edition"> + <album id="1" name="album" artist="artist" songCount="0" duration="292" created="0001-01-01T00:00:00Z" genre="rock" userRating="4" musicBrainzId="1234" isCompilation="true" sortName="sorted album" displayArtist="artist1 & artist2" explicitStatus="clean" version="Deluxe Edition"> <genres name="rock"></genres> <genres name="progressive"></genres> <discTitles disc="1" title="disc 1"></discTitles> @@ -15,7 +15,7 @@ <moods>sad</moods> <artists id="1" name="artist1"></artists> <artists id="2" name="artist2"></artists> - <song id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" isVideo="false" bpm="127" comment="a comment" sortName="sorted song" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist1 & artist2" displayAlbumArtist="album artist1 & album artist2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> + <song id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" bpm="127" comment="a comment" sortName="sorted song" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist1 & artist2" displayAlbumArtist="album artist1 & album artist2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> <isrc>ISRC-1</isrc> <genres name="rock"></genres> <genres name="progressive"></genres> @@ -32,6 +32,11 @@ <contributors role="role2" subRole="subrole4"> <artist id="2" name="artist2"></artist> </contributors> + <groupings>Soundtrack</groupings> + <groupings>Live</groupings> + </song> + <song id="2" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320"> + <replayGain trackGain="0" albumGain="0" trackPeak="0" albumPeak="0" baseGain="0" fallbackGain="0"></replayGain> </song> </album> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON index fbeded48a..030502618 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .JSON @@ -6,6 +6,9 @@ "openSubsonic": true, "album": { "id": "", - "name": "" + "name": "", + "songCount": 0, + "duration": 0, + "created": "0001-01-01T00:00:00Z" } } diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML index 159967c1d..0d3882080 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match .XML @@ -1,3 +1,3 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <album id="" name=""></album> + <album id="" name="" songCount="0" duration="0" created="0001-01-01T00:00:00Z"></album> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON index 758aef0cb..d3964663b 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .JSON @@ -7,6 +7,9 @@ "album": { "id": "", "name": "", + "songCount": 0, + "duration": 0, + "created": "0001-01-01T00:00:00Z", "userRating": 0, "genres": [], "musicBrainzId": "", diff --git a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML index 159967c1d..0d3882080 100644 --- a/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML +++ b/server/subsonic/responses/.snapshots/Responses AlbumWithSongsID3 without data should match OpenSubsonic .XML @@ -1,3 +1,3 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <album id="" name=""></album> + <album id="" name="" songCount="0" duration="0" created="0001-01-01T00:00:00Z"></album> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON index 7ca38d4db..5b3367e75 100644 --- a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .JSON @@ -10,8 +10,7 @@ "entry": { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" }, "position": 123, "username": "user2", diff --git a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML index 66c57820e..79200bb63 100644 --- a/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Bookmarks with data should match .XML @@ -1,7 +1,7 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <bookmarks> <bookmark position="123" username="user2" comment="a comment" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z"> - <entry id="1" isDir="false" title="title" isVideo="false"></entry> + <entry id="1" isDir="false" title="title"></entry> </bookmark> </bookmarks> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON index d64ae9e7f..4c0ea6c68 100644 --- a/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Child with data should match .JSON @@ -24,7 +24,6 @@ "transcodedSuffix": "mp3", "duration": 146, "bitRate": 320, - "isVideo": false, "bpm": 127, "comment": "a comment", "sortName": "sorted title", @@ -111,7 +110,43 @@ } ], "displayComposer": "composer 1 \u0026 composer 2", - "explicitStatus": "clean" + "explicitStatus": "clean", + "groupings": [ + "Soundtrack", + "Live" + ] + }, + { + "id": "", + "isDir": false, + "title": "", + "bpm": 0, + "comment": "", + "sortName": "", + "mediaType": "", + "musicBrainzId": "", + "isrc": [], + "genres": [], + "replayGain": { + "trackGain": 0, + "albumGain": 0, + "trackPeak": 0, + "albumPeak": 0, + "baseGain": 0, + "fallbackGain": 0 + }, + "channelCount": 0, + "samplingRate": 0, + "bitDepth": 0, + "moods": [], + "artists": [], + "displayArtist": "", + "albumArtists": [], + "displayAlbumArtist": "", + "contributors": [], + "displayComposer": "", + "explicitStatus": "", + "groupings": [] } ], "id": "1", diff --git a/server/subsonic/responses/.snapshots/Responses Child with data should match .XML b/server/subsonic/responses/.snapshots/Responses Child with data should match .XML index 639fd3f60..ddceb67d4 100644 --- a/server/subsonic/responses/.snapshots/Responses Child with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Child with data should match .XML @@ -1,6 +1,6 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="1" name="N"> - <child id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" isVideo="false" bpm="127" comment="a comment" sortName="sorted title" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist 1 & artist 2" displayAlbumArtist="album artist 1 & album artist 2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> + <child id="1" isDir="true" title="title" album="album" artist="artist" track="1" year="1985" genre="Rock" coverArt="1" size="8421341" contentType="audio/flac" suffix="flac" starred="2016-03-02T20:30:00Z" transcodedContentType="audio/mpeg" transcodedSuffix="mp3" duration="146" bitRate="320" bpm="127" comment="a comment" sortName="sorted title" mediaType="song" musicBrainzId="4321" channelCount="2" samplingRate="44100" bitDepth="16" displayArtist="artist 1 & artist 2" displayAlbumArtist="album artist 1 & album artist 2" displayComposer="composer 1 & composer 2" explicitStatus="clean"> <isrc>ISRC-1</isrc> <isrc>ISRC-2</isrc> <genres name="rock"></genres> @@ -24,6 +24,11 @@ <contributors role="composer"> <artist id="4" name="composer2"></artist> </contributors> + <groupings>Soundtrack</groupings> + <groupings>Live</groupings> + </child> + <child id="" isDir="false" title=""> + <replayGain trackGain="0" albumGain="0" trackPeak="0" albumPeak="0" baseGain="0" fallbackGain="0"></replayGain> </child> </directory> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON b/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON index 66b49830f..b66a2bdea 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match .JSON @@ -9,7 +9,7 @@ { "id": "1", "isDir": false, - "isVideo": false + "title": "" } ], "id": "", diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match .XML b/server/subsonic/responses/.snapshots/Responses Child without data should match .XML index d43b9d3ef..d64d526d6 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="" name=""> - <child id="1" isDir="false" isVideo="false"></child> + <child id="1" isDir="false" title=""></child> </directory> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON index 1af2ec4a1..9a9ab1ff6 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .JSON @@ -9,7 +9,7 @@ { "id": "1", "isDir": false, - "isVideo": false, + "title": "", "bpm": 0, "comment": "", "sortName": "", @@ -28,7 +28,8 @@ "displayAlbumArtist": "", "contributors": [], "displayComposer": "", - "explicitStatus": "" + "explicitStatus": "", + "groupings": [] } ], "id": "", diff --git a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML index d43b9d3ef..d64d526d6 100644 --- a/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML +++ b/server/subsonic/responses/.snapshots/Responses Child without data should match OpenSubsonic .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="" name=""> - <child id="1" isDir="false" isVideo="false"></child> + <child id="1" isDir="false" title=""></child> </directory> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON index daa7b9c7e..c984c70dc 100644 --- a/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Directory with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ], "id": "1", diff --git a/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML b/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML index 2ac4f9529..0b1191baf 100644 --- a/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Directory with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <directory id="1" name="N"> - <child id="1" isDir="false" title="title" isVideo="false"></child> + <child id="1" isDir="false" title="title"></child> </directory> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses NowPlaying with data should match .JSON b/server/subsonic/responses/.snapshots/Responses NowPlaying with data should match .JSON new file mode 100644 index 000000000..f99cb62af --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses NowPlaying with data should match .JSON @@ -0,0 +1,23 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "nowPlaying": { + "entry": [ + { + "id": "1", + "isDir": false, + "title": "Song", + "username": "testuser", + "minutesAgo": 2, + "playerId": 1, + "playerName": "TestPlayer", + "state": "playing", + "positionMs": 120000, + "playbackRate": 1.5 + } + ] + } +} diff --git a/server/subsonic/responses/.snapshots/Responses NowPlaying with data should match .XML b/server/subsonic/responses/.snapshots/Responses NowPlaying with data should match .XML new file mode 100644 index 000000000..ae05b68d0 --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses NowPlaying with data should match .XML @@ -0,0 +1,5 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> + <nowPlaying> + <entry id="1" isDir="false" title="Song" username="testuser" minutesAgo="2" playerId="1" playerName="TestPlayer" state="playing" positionMs="120000" playbackRate="1.5"></entry> + </nowPlaying> +</subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses NowPlaying without data should match .JSON b/server/subsonic/responses/.snapshots/Responses NowPlaying without data should match .JSON new file mode 100644 index 000000000..ab8f793fa --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses NowPlaying without data should match .JSON @@ -0,0 +1,8 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "nowPlaying": {} +} diff --git a/server/subsonic/responses/.snapshots/Responses NowPlaying without data should match .XML b/server/subsonic/responses/.snapshots/Responses NowPlaying without data should match .XML new file mode 100644 index 000000000..763b4b583 --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses NowPlaying without data should match .XML @@ -0,0 +1,3 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> + <nowPlaying></nowPlaying> +</subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON index eb771692b..e5875873d 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ], "current": "111", diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML index 1156af0a8..b7a054b8c 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <playQueue current="111" position="243" username="user1" changed="0001-01-01T00:00:00Z" changedBy="a_client"> - <entry id="1" isDir="false" title="title" isVideo="false"></entry> + <entry id="1" isDir="false" title="title"></entry> </playQueue> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON index 88eebb276..70b10c059 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .JSON @@ -6,6 +6,7 @@ "openSubsonic": true, "playQueue": { "username": "", + "changed": "0001-01-01T00:00:00Z", "changedBy": "" } } diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML index 5af3d9157..597781cbd 100644 --- a/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses PlayQueue without data should match .XML @@ -1,3 +1,3 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> - <playQueue username="" changedBy=""></playQueue> + <playQueue username="" changed="0001-01-01T00:00:00Z" changedBy=""></playQueue> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .JSON new file mode 100644 index 000000000..3fa5b6082 --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .JSON @@ -0,0 +1,21 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "playQueueByIndex": { + "entry": [ + { + "id": "1", + "isDir": false, + "title": "title" + } + ], + "currentIndex": 0, + "position": 243, + "username": "user1", + "changed": "0001-01-01T00:00:00Z", + "changedBy": "a_client" + } +} diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .XML new file mode 100644 index 000000000..20f4994da --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex with data should match .XML @@ -0,0 +1,5 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> + <playQueueByIndex currentIndex="0" position="243" username="user1" changed="0001-01-01T00:00:00Z" changedBy="a_client"> + <entry id="1" isDir="false" title="title"></entry> + </playQueueByIndex> +</subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .JSON b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .JSON new file mode 100644 index 000000000..ad49a35e5 --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .JSON @@ -0,0 +1,12 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "playQueueByIndex": { + "username": "", + "changed": "0001-01-01T00:00:00Z", + "changedBy": "" + } +} diff --git a/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .XML b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .XML new file mode 100644 index 000000000..d99681f4c --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses PlayQueueByIndex without data should match .XML @@ -0,0 +1,3 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> + <playQueueByIndex username="" changed="0001-01-01T00:00:00Z" changedBy=""></playQueueByIndex> +</subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON index b6e996d6e..963a207d5 100644 --- a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .JSON @@ -14,16 +14,26 @@ "duration": 120, "public": true, "owner": "admin", + "created": "2023-02-20T14:45:00Z", + "changed": "2023-02-20T14:45:00Z", + "coverArt": "pl-123123123123", + "readonly": true, + "validUntil": "2023-02-20T14:45:00Z" + }, + { + "id": "333", + "name": "ccc", + "songCount": 0, + "duration": 0, "created": "0001-01-01T00:00:00Z", "changed": "0001-01-01T00:00:00Z", - "coverArt": "pl-123123123123" + "readonly": false }, { "id": "222", "name": "bbb", "songCount": 0, "duration": 0, - "public": false, "created": "0001-01-01T00:00:00Z", "changed": "0001-01-01T00:00:00Z" } diff --git a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML index 100301afe..38e0944cf 100644 --- a/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Playlists with data should match .XML @@ -1,6 +1,7 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <playlists> - <playlist id="111" name="aaa" comment="comment" songCount="2" duration="120" public="true" owner="admin" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z" coverArt="pl-123123123123"></playlist> + <playlist id="111" name="aaa" comment="comment" songCount="2" duration="120" public="true" owner="admin" created="2023-02-20T14:45:00Z" changed="2023-02-20T14:45:00Z" coverArt="pl-123123123123" readonly="true" validUntil="2023-02-20T14:45:00Z"></playlist> + <playlist id="333" name="ccc" songCount="0" duration="0" public="false" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z"></playlist> <playlist id="222" name="bbb" songCount="0" duration="0" public="false" created="0001-01-01T00:00:00Z" changed="0001-01-01T00:00:00Z"></playlist> </playlists> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON b/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON index 0c08be37a..cca38ba52 100644 --- a/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses Shares with data should match .JSON @@ -14,8 +14,7 @@ "title": "title", "album": "album", "artist": "artist", - "duration": 120, - "isVideo": false + "duration": 120 }, { "id": "2", @@ -23,8 +22,7 @@ "title": "title 2", "album": "album", "artist": "artist", - "duration": 300, - "isVideo": false + "duration": 300 } ], "id": "ABC123", diff --git a/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML b/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML index 36cfc25fe..ba63071bf 100644 --- a/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses Shares with data should match .XML @@ -1,8 +1,8 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <shares> <share id="ABC123" url="http://localhost/p/ABC123" description="Check it out!" username="deluan" created="2016-03-02T20:30:00Z" expires="2016-03-02T20:30:00Z" lastVisited="2016-03-02T20:30:00Z" visitCount="2"> - <entry id="1" isDir="false" title="title" album="album" artist="artist" duration="120" isVideo="false"></entry> - <entry id="2" isDir="false" title="title 2" album="album" artist="artist" duration="300" isVideo="false"></entry> + <entry id="1" isDir="false" title="title" album="album" artist="artist" duration="120"></entry> + <entry id="2" isDir="false" title="title 2" album="album" artist="artist" duration="300"></entry> </share> </shares> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON index 7df08ded1..ff30c1a25 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML index b05443a91..06f07a3bb 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <similarSongs> - <song id="1" isDir="false" title="title" isVideo="false"></song> + <song id="1" isDir="false" title="title"></song> </similarSongs> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON index 73eda015e..49331cf11 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML index 0402f031e..4e80da12f 100644 --- a/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses SimilarSongs2 with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <similarSongs2> - <song id="1" isDir="false" title="title" isVideo="false"></song> + <song id="1" isDir="false" title="title"></song> </similarSongs2> </subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses SonicMatches with data should match .JSON b/server/subsonic/responses/.snapshots/Responses SonicMatches with data should match .JSON new file mode 100644 index 000000000..b22f18e83 --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses SonicMatches with data should match .JSON @@ -0,0 +1,25 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "sonicMatch": [ + { + "entry": { + "id": "1", + "isDir": false, + "title": "Bohemian Rhapsody" + }, + "similarity": 0.95 + }, + { + "entry": { + "id": "2", + "isDir": false, + "title": "We Will Rock You" + }, + "similarity": 0.78 + } + ] +} diff --git a/server/subsonic/responses/.snapshots/Responses SonicMatches with data should match .XML b/server/subsonic/responses/.snapshots/Responses SonicMatches with data should match .XML new file mode 100644 index 000000000..14d17d00d --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses SonicMatches with data should match .XML @@ -0,0 +1,10 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> + <sonicMatch> + <entry id="1" isDir="false" title="Bohemian Rhapsody"></entry> + <similarity>0.95</similarity> + </sonicMatch> + <sonicMatch> + <entry id="2" isDir="false" title="We Will Rock You"></entry> + <similarity>0.78</similarity> + </sonicMatch> +</subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses SonicMatches without data should match .JSON b/server/subsonic/responses/.snapshots/Responses SonicMatches without data should match .JSON new file mode 100644 index 000000000..75562871f --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses SonicMatches without data should match .JSON @@ -0,0 +1,8 @@ +{ + "status": "ok", + "version": "1.16.1", + "type": "navidrome", + "serverVersion": "v0.55.0", + "openSubsonic": true, + "sonicMatch": [] +} diff --git a/server/subsonic/responses/.snapshots/Responses SonicMatches without data should match .XML b/server/subsonic/responses/.snapshots/Responses SonicMatches without data should match .XML new file mode 100644 index 000000000..184228a0e --- /dev/null +++ b/server/subsonic/responses/.snapshots/Responses SonicMatches without data should match .XML @@ -0,0 +1 @@ +<subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"></subsonic-response> diff --git a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON index 575c9b7fd..1c871a43f 100644 --- a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON +++ b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .JSON @@ -9,8 +9,7 @@ { "id": "1", "isDir": false, - "title": "title", - "isVideo": false + "title": "title" } ] } diff --git a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML index 35a77cb6c..8991725b8 100644 --- a/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML +++ b/server/subsonic/responses/.snapshots/Responses TopSongs with data should match .XML @@ -1,5 +1,5 @@ <subsonic-response xmlns="http://subsonic.org/restapi" status="ok" version="1.16.1" type="navidrome" serverVersion="v0.55.0" openSubsonic="true"> <topSongs> - <song id="1" isDir="false" title="title" isVideo="false"></song> + <song id="1" isDir="false" title="title"></song> </topSongs> </subsonic-response> diff --git a/server/subsonic/responses/responses.go b/server/subsonic/responses/responses.go index 4a7ebbe83..dcb458932 100644 --- a/server/subsonic/responses/responses.go +++ b/server/subsonic/responses/responses.go @@ -60,6 +60,9 @@ type Subsonic struct { // OpenSubsonic extensions OpenSubsonicExtensions *OpenSubsonicExtensions `xml:"openSubsonicExtensions,omitempty" json:"openSubsonicExtensions,omitempty"` LyricsList *LyricsList `xml:"lyricsList,omitempty" json:"lyricsList,omitempty"` + PlayQueueByIndex *PlayQueueByIndex `xml:"playQueueByIndex,omitempty" json:"playQueueByIndex,omitempty"` + TranscodeDecision *TranscodeDecision `xml:"transcodeDecision,omitempty" json:"transcodeDecision,omitempty"` + SonicMatches *Array[SonicMatch] `xml:"sonicMatch,omitempty" json:"sonicMatch,omitempty"` } const ( @@ -94,11 +97,9 @@ type Artist struct { Name string `xml:"name,attr" json:"name"` Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` ArtistImageUrl string `xml:"artistImageUrl,attr,omitempty" json:"artistImageUrl,omitempty"` - /* TODO: - <xs:attribute name="averageRating" type="sub:AverageRating" use="optional"/> <!-- Added in 1.13.0 --> - */ } type Index struct { @@ -135,7 +136,7 @@ type Child struct { Id string `xml:"id,attr" json:"id"` Parent string `xml:"parent,attr,omitempty" json:"parent,omitempty"` IsDir bool `xml:"isDir,attr" json:"isDir"` - Title string `xml:"title,attr,omitempty" json:"title,omitempty"` + Title string `xml:"title,attr" json:"title"` Name string `xml:"name,attr,omitempty" json:"name,omitempty"` Album string `xml:"album,attr,omitempty" json:"album,omitempty"` Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"` @@ -159,13 +160,11 @@ type Child struct { ArtistId string `xml:"artistId,attr,omitempty" json:"artistId,omitempty"` Type string `xml:"type,attr,omitempty" json:"type,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` SongCount int32 `xml:"songCount,attr,omitempty" json:"songCount,omitempty"` - IsVideo bool `xml:"isVideo,attr" json:"isVideo"` + IsVideo bool `xml:"isVideo,attr,omitempty" json:"isVideo,omitempty"` BookmarkPosition int64 `xml:"bookmarkPosition,attr,omitempty" json:"bookmarkPosition,omitempty"` - /* - <xs:attribute name="averageRating" type="sub:AverageRating" use="optional"/> <!-- Added in 1.6.0 --> - */ - *OpenSubsonicChild `xml:",omitempty" json:",omitempty"` + *OpenSubsonicChild `xml:",omitempty" json:",omitempty"` } type OpenSubsonicChild struct { @@ -176,7 +175,7 @@ type OpenSubsonicChild struct { SortName string `xml:"sortName,attr,omitempty" json:"sortName"` MediaType MediaType `xml:"mediaType,attr,omitempty" json:"mediaType"` MusicBrainzId string `xml:"musicBrainzId,attr,omitempty" json:"musicBrainzId"` - Isrc Array[string] `xml:"isrc,omitempty" json:"isrc"` + Isrc Array[string] `xml:"isrc,omitempty" json:"isrc"` Genres Array[ItemGenre] `xml:"genres,omitempty" json:"genres"` ReplayGain ReplayGain `xml:"replayGain,omitempty" json:"replayGain"` ChannelCount int32 `xml:"channelCount,attr,omitempty" json:"channelCount"` @@ -190,6 +189,7 @@ type OpenSubsonicChild struct { Contributors Array[Contributor] `xml:"contributors,omitempty" json:"contributors"` DisplayComposer string `xml:"displayComposer,attr,omitempty" json:"displayComposer"` ExplicitStatus string `xml:"explicitStatus,attr,omitempty" json:"explicitStatus"` + Groupings Array[string] `xml:"groupings,omitempty" json:"groupings"` } type Songs struct { @@ -197,14 +197,15 @@ type Songs struct { } type Directory struct { - Child []Child `xml:"child" json:"child,omitempty"` - Id string `xml:"id,attr" json:"id"` - Name string `xml:"name,attr" json:"name"` - Parent string `xml:"parent,attr,omitempty" json:"parent,omitempty"` - Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` - PlayCount int64 `xml:"playCount,attr,omitempty" json:"playCount,omitempty"` - Played *time.Time `xml:"played,attr,omitempty" json:"played,omitempty"` - UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + Child []Child `xml:"child" json:"child,omitempty"` + Id string `xml:"id,attr" json:"id"` + Name string `xml:"name,attr" json:"name"` + Parent string `xml:"parent,attr,omitempty" json:"parent,omitempty"` + Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` + PlayCount int64 `xml:"playCount,attr,omitempty" json:"playCount,omitempty"` + Played *time.Time `xml:"played,attr,omitempty" json:"played,omitempty"` + UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` // ID3 Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"` @@ -216,10 +217,6 @@ type Directory struct { Created *time.Time `xml:"created,attr,omitempty" json:"created,omitempty"` Year int32 `xml:"year,attr,omitempty" json:"year,omitempty"` Genre string `xml:"genre,attr,omitempty" json:"genre,omitempty"` - - /* - <xs:attribute name="averageRating" type="sub:AverageRating" use="optional"/> <!-- Added in 1.13.0 --> - */ } // ArtistID3Ref is a reference to an artist, a simplified version of ArtistID3. This is used to resolve the @@ -236,6 +233,7 @@ type ArtistID3 struct { AlbumCount int32 `xml:"albumCount,attr" json:"albumCount"` Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating,omitempty"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` ArtistImageUrl string `xml:"artistImageUrl,attr,omitempty" json:"artistImageUrl,omitempty"` *OpenSubsonicArtistID3 `xml:",omitempty" json:",omitempty"` } @@ -253,10 +251,10 @@ type AlbumID3 struct { Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"` ArtistId string `xml:"artistId,attr,omitempty" json:"artistId,omitempty"` CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` - SongCount int32 `xml:"songCount,attr,omitempty" json:"songCount,omitempty"` - Duration int32 `xml:"duration,attr,omitempty" json:"duration,omitempty"` + SongCount int32 `xml:"songCount,attr" json:"songCount"` + Duration int32 `xml:"duration,attr" json:"duration"` PlayCount int64 `xml:"playCount,attr,omitempty" json:"playCount,omitempty"` - Created *time.Time `xml:"created,attr,omitempty" json:"created,omitempty"` + Created time.Time `xml:"created,attr" json:"created"` Starred *time.Time `xml:"starred,attr,omitempty" json:"starred,omitempty"` Year int32 `xml:"year,attr,omitempty" json:"year,omitempty"` Genre string `xml:"genre,attr,omitempty" json:"genre,omitempty"` @@ -267,6 +265,7 @@ type OpenSubsonicAlbumID3 struct { // OpenSubsonic extensions Played *time.Time `xml:"played,attr,omitempty" json:"played,omitempty"` UserRating int32 `xml:"userRating,attr,omitempty" json:"userRating"` + AverageRating float64 `xml:"averageRating,attr,omitempty" json:"averageRating,omitempty"` Genres Array[ItemGenre] `xml:"genres,omitempty" json:"genres"` MusicBrainzId string `xml:"musicBrainzId,attr,omitempty" json:"musicBrainzId"` IsCompilation bool `xml:"isCompilation,attr,omitempty" json:"isCompilation"` @@ -302,16 +301,17 @@ type AlbumList2 struct { } type Playlist struct { - Id string `xml:"id,attr" json:"id"` - Name string `xml:"name,attr" json:"name"` - Comment string `xml:"comment,attr,omitempty" json:"comment,omitempty"` - SongCount int32 `xml:"songCount,attr" json:"songCount"` - Duration int32 `xml:"duration,attr" json:"duration"` - Public bool `xml:"public,attr" json:"public"` - Owner string `xml:"owner,attr,omitempty" json:"owner,omitempty"` - Created time.Time `xml:"created,attr" json:"created"` - Changed time.Time `xml:"changed,attr" json:"changed"` - CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` + Id string `xml:"id,attr" json:"id"` + Name string `xml:"name,attr" json:"name"` + Comment string `xml:"comment,attr,omitempty" json:"comment,omitempty"` + SongCount int32 `xml:"songCount,attr" json:"songCount"` + Duration int32 `xml:"duration,attr" json:"duration"` + Public bool `xml:"public,attr" json:"public,omitempty"` + Owner string `xml:"owner,attr,omitempty" json:"owner,omitempty"` + Created time.Time `xml:"created,attr" json:"created"` + Changed time.Time `xml:"changed,attr" json:"changed"` + CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` + *OpenSubsonicPlaylist `xml:",omitempty" json:",omitempty"` /* <xs:sequence> <xs:element name="allowedUser" type="xs:string" minOccurs="0" maxOccurs="unbounded"/> <!--Added in 1.8.0--> @@ -319,6 +319,11 @@ type Playlist struct { */ } +type OpenSubsonicPlaylist struct { + Readonly bool `xml:"readonly,attr,omitempty" json:"readonly"` + ValidUntil *time.Time `xml:"validUntil,attr,omitempty" json:"validUntil,omitempty"` +} + type Playlists struct { Playlist []Playlist `xml:"playlist" json:"playlist,omitempty"` } @@ -354,10 +359,13 @@ type Starred2 struct { type NowPlayingEntry struct { Child - UserName string `xml:"username,attr" json:"username"` - MinutesAgo int32 `xml:"minutesAgo,attr" json:"minutesAgo"` - PlayerId int32 `xml:"playerId,attr" json:"playerId"` - PlayerName string `xml:"playerName,attr" json:"playerName,omitempty"` + UserName string `xml:"username,attr" json:"username"` + MinutesAgo int32 `xml:"minutesAgo,attr" json:"minutesAgo"` + PlayerId int32 `xml:"playerId,attr" json:"playerId"` + PlayerName string `xml:"playerName,attr" json:"playerName,omitempty"` + State string `xml:"state,attr" json:"state"` + PositionMs int64 `xml:"positionMs,attr" json:"positionMs"` + PlaybackRate float64 `xml:"playbackRate,attr" json:"playbackRate"` } type NowPlaying struct { @@ -438,17 +446,31 @@ type TopSongs struct { Song []Child `xml:"song,omitempty" json:"song,omitempty"` } +type SonicMatch struct { + Entry Child `xml:"entry" json:"entry"` + Similarity float64 `xml:"similarity" json:"similarity"` +} + type PlayQueue struct { - Entry []Child `xml:"entry,omitempty" json:"entry,omitempty"` - Current string `xml:"current,attr,omitempty" json:"current,omitempty"` - Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` - Username string `xml:"username,attr" json:"username"` - Changed *time.Time `xml:"changed,attr,omitempty" json:"changed,omitempty"` - ChangedBy string `xml:"changedBy,attr" json:"changedBy"` + Entry []Child `xml:"entry,omitempty" json:"entry,omitempty"` + Current string `xml:"current,attr,omitempty" json:"current,omitempty"` + Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` + Username string `xml:"username,attr" json:"username"` + Changed time.Time `xml:"changed,attr" json:"changed"` + ChangedBy string `xml:"changedBy,attr" json:"changedBy"` +} + +type PlayQueueByIndex struct { + Entry []Child `xml:"entry,omitempty" json:"entry,omitempty"` + CurrentIndex *int `xml:"currentIndex,attr,omitempty" json:"currentIndex,omitempty"` + Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` + Username string `xml:"username,attr" json:"username"` + Changed time.Time `xml:"changed,attr" json:"changed"` + ChangedBy string `xml:"changedBy,attr" json:"changedBy"` } type Bookmark struct { - Entry Child `xml:"entry,omitempty" json:"entry,omitempty"` + Entry Child `xml:"entry,omitempty" json:"entry"` Position int64 `xml:"position,attr,omitempty" json:"position,omitempty"` Username string `xml:"username,attr" json:"username"` Comment string `xml:"comment,attr" json:"comment"` @@ -497,10 +519,15 @@ type InternetRadioStations struct { } type Radio struct { - ID string `xml:"id,attr" json:"id"` - Name string `xml:"name,attr" json:"name"` - StreamUrl string `xml:"streamUrl,attr" json:"streamUrl"` - HomepageUrl string `xml:"homePageUrl,omitempty,attr" json:"homePageUrl,omitempty"` + ID string `xml:"id,attr" json:"id"` + Name string `xml:"name,attr" json:"name"` + StreamUrl string `xml:"streamUrl,attr" json:"streamUrl"` + HomepageUrl string `xml:"homePageUrl,omitempty,attr" json:"homePageUrl,omitempty"` + *OpenSubsonicRadio `xml:",omitempty" json:",omitempty"` +} + +type OpenSubsonicRadio struct { + CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt"` } type JukeboxStatus struct { @@ -546,16 +573,16 @@ type ItemGenre struct { } type ReplayGain struct { - TrackGain float64 `xml:"trackGain,omitempty,attr" json:"trackGain,omitempty"` - AlbumGain float64 `xml:"albumGain,omitempty,attr" json:"albumGain,omitempty"` - TrackPeak float64 `xml:"trackPeak,omitempty,attr" json:"trackPeak,omitempty"` - AlbumPeak float64 `xml:"albumPeak,omitempty,attr" json:"albumPeak,omitempty"` - BaseGain float64 `xml:"baseGain,omitempty,attr" json:"baseGain,omitempty"` - FallbackGain float64 `xml:"fallbackGain,omitempty,attr" json:"fallbackGain,omitempty"` + TrackGain *float64 `xml:"trackGain,omitempty,attr" json:"trackGain,omitempty"` + AlbumGain *float64 `xml:"albumGain,omitempty,attr" json:"albumGain,omitempty"` + TrackPeak *float64 `xml:"trackPeak,omitempty,attr" json:"trackPeak,omitempty"` + AlbumPeak *float64 `xml:"albumPeak,omitempty,attr" json:"albumPeak,omitempty"` + BaseGain *float64 `xml:"baseGain,omitempty,attr" json:"baseGain,omitempty"` + FallbackGain *float64 `xml:"fallbackGain,omitempty,attr" json:"fallbackGain,omitempty"` } func (r ReplayGain) MarshalXML(e *xml.Encoder, start xml.StartElement) error { - if r.TrackGain == 0 && r.AlbumGain == 0 && r.TrackPeak == 0 && r.AlbumPeak == 0 && r.BaseGain == 0 && r.FallbackGain == 0 { + if r.TrackGain == nil && r.AlbumGain == nil && r.TrackPeak == nil && r.AlbumPeak == nil && r.BaseGain == nil && r.FallbackGain == nil { return nil } type replayGain ReplayGain @@ -563,8 +590,9 @@ func (r ReplayGain) MarshalXML(e *xml.Encoder, start xml.StartElement) error { } type DiscTitle struct { - Disc int32 `xml:"disc,attr" json:"disc"` - Title string `xml:"title,attr" json:"title"` + Disc int32 `xml:"disc,attr" json:"disc"` + Title string `xml:"title,attr" json:"title"` + CoverArt string `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty"` } type ItemDate struct { @@ -606,3 +634,26 @@ func marshalJSONArray[T any](v []T) ([]byte, error) { } return json.Marshal(v) } + +// TranscodeDecision represents the response for getTranscodeDecision (OpenSubsonic transcoding extension) +type TranscodeDecision struct { + CanDirectPlay bool `xml:"canDirectPlay,attr" json:"canDirectPlay"` + CanTranscode bool `xml:"canTranscode,attr" json:"canTranscode"` + TranscodeReasons []string `xml:"transcodeReason,omitempty" json:"transcodeReason,omitempty"` + ErrorReason string `xml:"errorReason,attr,omitempty" json:"errorReason,omitempty"` + TranscodeParams string `xml:"transcodeParams,attr,omitempty" json:"transcodeParams,omitempty"` + SourceStream *StreamDetails `xml:"sourceStream,omitempty" json:"sourceStream,omitempty"` + TranscodeStream *StreamDetails `xml:"transcodeStream,omitempty" json:"transcodeStream,omitempty"` +} + +// StreamDetails describes audio stream properties for transcoding decisions +type StreamDetails struct { + Protocol string `xml:"protocol,attr,omitempty" json:"protocol,omitempty"` + Container string `xml:"container,attr,omitempty" json:"container,omitempty"` + Codec string `xml:"codec,attr,omitempty" json:"codec,omitempty"` + AudioChannels int32 `xml:"audioChannels,attr,omitempty" json:"audioChannels,omitempty"` + AudioBitrate int32 `xml:"audioBitrate,attr,omitempty" json:"audioBitrate,omitempty"` + AudioProfile string `xml:"audioProfile,attr,omitempty" json:"audioProfile,omitempty"` + AudioSamplerate int32 `xml:"audioSamplerate,attr,omitempty" json:"audioSamplerate,omitempty"` + AudioBitdepth int32 `xml:"audioBitdepth,attr,omitempty" json:"audioBitdepth,omitempty"` +} diff --git a/server/subsonic/responses/responses_suite_test.go b/server/subsonic/responses/responses_suite_test.go index 8728b949a..7fc10aa15 100644 --- a/server/subsonic/responses/responses_suite_test.go +++ b/server/subsonic/responses/responses_suite_test.go @@ -1,14 +1,17 @@ package responses import ( + "fmt" + "os" + "path/filepath" "strings" "testing" - "github.com/bradleyjkemp/cupaloy/v2" "github.com/navidrome/navidrome/log" "github.com/onsi/ginkgo/v2" "github.com/onsi/gomega" "github.com/onsi/gomega/types" + "github.com/pmezard/go-difflib/difflib" ) func TestSubsonicApiResponses(t *testing.T) { @@ -18,25 +21,61 @@ func TestSubsonicApiResponses(t *testing.T) { } func MatchSnapshot() types.GomegaMatcher { - c := cupaloy.New(cupaloy.FailOnUpdate(false)) - return &snapshotMatcher{c} + return &snapshotMatcher{} } type snapshotMatcher struct { - c *cupaloy.Config + diff string } -func (matcher snapshotMatcher) Match(actual interface{}) (success bool, err error) { - actualJson := strings.TrimSpace(string(actual.([]byte))) - err = matcher.c.SnapshotWithName(ginkgo.CurrentSpecReport().FullText(), actualJson) - success = err == nil - return +func (matcher *snapshotMatcher) Match(actual any) (success bool, err error) { + actualBytes, ok := actual.([]byte) + if !ok { + return false, fmt.Errorf("MatchSnapshot expects []byte, got %T", actual) + } + + name := ginkgo.CurrentSpecReport().FullText() + actualStr := strings.TrimSpace(string(actualBytes)) + + snapshotPath := filepath.Join(".snapshots", name) + + // Support UPDATE_SNAPSHOTS=true for `make snapshots` + if _, update := os.LookupEnv("UPDATE_SNAPSHOTS"); update { + err := os.MkdirAll(".snapshots", os.ModePerm) + if err != nil { + return false, err + } + return true, os.WriteFile(snapshotPath, []byte(actualStr+"\n"), 0600) + } + + expected, err := os.ReadFile(snapshotPath) + if err != nil { + return false, err + } + + // Normalize line endings so snapshots work on Windows (CRLF) and Unix (LF) + normalizedExpected := strings.ReplaceAll(string(expected), "\r\n", "\n") + normalizedExpected = strings.TrimSpace(normalizedExpected) + + if actualStr == normalizedExpected { + return true, nil + } + + diff, _ := difflib.GetUnifiedDiffString(difflib.UnifiedDiff{ + A: difflib.SplitLines(normalizedExpected), + B: difflib.SplitLines(actualStr), + FromFile: "snapshot", + ToFile: "actual", + Context: 3, + }) + matcher.diff = diff + return false, nil } -func (matcher snapshotMatcher) FailureMessage(_ interface{}) (message string) { - return "Expected to match saved snapshot\n" +func (matcher *snapshotMatcher) FailureMessage(_ any) (message string) { + return "Expected to match saved snapshot\n" + matcher.diff } -func (matcher snapshotMatcher) NegatedFailureMessage(_ interface{}) (message string) { +func (matcher *snapshotMatcher) NegatedFailureMessage(_ any) (message string) { return "Expected to not match saved snapshot\n" } diff --git a/server/subsonic/responses/responses_test.go b/server/subsonic/responses/responses_test.go index 9fcd6078e..3166df875 100644 --- a/server/subsonic/responses/responses_test.go +++ b/server/subsonic/responses/responses_test.go @@ -1,8 +1,3 @@ -//go:build unix - -// TODO Fix snapshot tests in Windows -// Response Snapshot tests. Only run in Linux and macOS, as they fail in Windows -// Probably because of EOL char differences package responses_test import ( @@ -11,6 +6,7 @@ import ( "time" "github.com/navidrome/navidrome/consts" + "github.com/navidrome/navidrome/server/subsonic/responses" . "github.com/navidrome/navidrome/server/subsonic/responses" . "github.com/onsi/ginkgo/v2" . "github.com/onsi/gomega" @@ -97,11 +93,10 @@ var _ = Describe("Responses", func() { Context("with data", func() { BeforeEach(func() { artists := make([]Artist, 1) - t := time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC) artists[0] = Artist{ Id: "111", Name: "aaa", - Starred: &t, + Starred: new(time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC)), UserRating: 3, ArtistImageUrl: "https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png", } @@ -136,11 +131,10 @@ var _ = Describe("Responses", func() { Context("with data", func() { BeforeEach(func() { artists := make([]ArtistID3, 1) - t := time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC) artists[0] = ArtistID3{ Id: "111", Name: "aaa", - Starred: &t, + Starred: new(time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC)), UserRating: 3, AlbumCount: 2, ArtistImageUrl: "https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png", @@ -161,11 +155,10 @@ var _ = Describe("Responses", func() { Context("with OpenSubsonic data", func() { BeforeEach(func() { artists := make([]ArtistID3, 1) - t := time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC) artists[0] = ArtistID3{ Id: "111", Name: "aaa", - Starred: &t, + Starred: new(time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC)), UserRating: 3, AlbumCount: 2, ArtistImageUrl: "https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png", @@ -213,13 +206,12 @@ var _ = Describe("Responses", func() { Context("with data", func() { BeforeEach(func() { response.Directory = &Directory{Id: "1", Name: "N"} - child := make([]Child, 1) - t := time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC) + child := make([]Child, 2) child[0] = Child{ Id: "1", IsDir: true, Title: "title", Album: "album", Artist: "artist", Track: 1, Year: 1985, Genre: "Rock", CoverArt: "1", Size: 8421341, ContentType: "audio/flac", Suffix: "flac", TranscodedContentType: "audio/mpeg", TranscodedSuffix: "mp3", - Duration: 146, BitRate: 320, Starred: &t, + Duration: 146, BitRate: 320, Starred: new(time.Date(2016, 03, 2, 20, 30, 0, 0, time.UTC)), } child[0].OpenSubsonicChild = &OpenSubsonicChild{ Genres: []ItemGenre{{Name: "rock"}, {Name: "progressive"}}, @@ -227,7 +219,8 @@ var _ = Describe("Responses", func() { Isrc: []string{"ISRC-1", "ISRC-2"}, BPM: 127, ChannelCount: 2, SamplingRate: 44100, BitDepth: 16, Moods: []string{"happy", "sad"}, - ReplayGain: ReplayGain{TrackGain: 1, AlbumGain: 2, TrackPeak: 3, AlbumPeak: 4, BaseGain: 5, FallbackGain: 6}, + Groupings: []string{"Soundtrack", "Live"}, + ReplayGain: ReplayGain{TrackGain: new(1.0), AlbumGain: new(2.0), TrackPeak: new(3.0), AlbumPeak: new(4.0), BaseGain: new(5.0), FallbackGain: new(6.0)}, DisplayArtist: "artist 1 & artist 2", Artists: []ArtistID3Ref{ {Id: "1", Name: "artist1"}, @@ -247,6 +240,9 @@ var _ = Describe("Responses", func() { }, ExplicitStatus: "clean", } + child[1].OpenSubsonicChild = &OpenSubsonicChild{ + ReplayGain: ReplayGain{TrackGain: new(0.0), AlbumGain: new(0.0), TrackPeak: new(0.0), AlbumPeak: new(0.0), BaseGain: new(0.0), FallbackGain: new(0.0)}, + } response.Directory.Child = child }) @@ -283,7 +279,7 @@ var _ = Describe("Responses", func() { Context("with data", func() { BeforeEach(func() { album := AlbumID3{ - Id: "1", Name: "album", Artist: "artist", Genre: "rock", + Id: "1", Name: "album", Artist: "artist", Duration: 292, Genre: "rock", } album.OpenSubsonicAlbumID3 = &OpenSubsonicAlbumID3{ Genres: []ItemGenre{{Name: "rock"}, {Name: "progressive"}}, @@ -309,13 +305,19 @@ var _ = Describe("Responses", func() { Year: 1985, Genre: "Rock", CoverArt: "1", Size: 8421341, ContentType: "audio/flac", Suffix: "flac", TranscodedContentType: "audio/mpeg", TranscodedSuffix: "mp3", Duration: 146, BitRate: 320, Starred: &t, + }, { + Id: "2", IsDir: true, Title: "title", Album: "album", Artist: "artist", Track: 1, + Year: 1985, Genre: "Rock", CoverArt: "1", Size: 8421341, ContentType: "audio/flac", + Suffix: "flac", TranscodedContentType: "audio/mpeg", TranscodedSuffix: "mp3", + Duration: 146, BitRate: 320, Starred: &t, }} songs[0].OpenSubsonicChild = &OpenSubsonicChild{ Genres: []ItemGenre{{Name: "rock"}, {Name: "progressive"}}, Comment: "a comment", MediaType: MediaTypeSong, MusicBrainzId: "4321", SortName: "sorted song", Isrc: []string{"ISRC-1"}, Moods: []string{"happy", "sad"}, - ReplayGain: ReplayGain{TrackGain: 1, AlbumGain: 2, TrackPeak: 3, AlbumPeak: 4, BaseGain: 5, FallbackGain: 6}, + Groupings: []string{"Soundtrack", "Live"}, + ReplayGain: ReplayGain{TrackGain: new(1.0), AlbumGain: new(2.0), TrackPeak: new(3.0), AlbumPeak: new(4.0), BaseGain: new(5.0), FallbackGain: new(6.0)}, BPM: 127, ChannelCount: 2, SamplingRate: 44100, BitDepth: 16, DisplayArtist: "artist1 & artist2", Artists: []ArtistID3Ref{ @@ -334,6 +336,9 @@ var _ = Describe("Responses", func() { DisplayComposer: "composer 1 & composer 2", ExplicitStatus: "clean", } + songs[1].OpenSubsonicChild = &OpenSubsonicChild{ + ReplayGain: ReplayGain{TrackGain: new(0.0), AlbumGain: new(0.0), TrackPeak: new(0.0), AlbumPeak: new(0.0), BaseGain: new(0.0), FallbackGain: new(0.0)}, + } response.AlbumWithSongsID3.AlbumID3 = album response.AlbumWithSongsID3.Song = songs }) @@ -416,6 +421,7 @@ var _ = Describe("Responses", func() { ItemGenre{Name: "Genre 2"}, }, Moods: []string{"mood1", "mood2"}, + Groupings: []string{"Soundtrack"}, DisplayArtist: "Display artist", Artists: Array[ArtistID3Ref]{ ArtistID3Ref{Id: "artist-1", Name: "Artist 1"}, @@ -519,9 +525,9 @@ var _ = Describe("Responses", func() { }) Context("with data", func() { - timestamp, _ := time.Parse(time.RFC3339, "2020-04-11T16:43:00Z04:00") + timestamp := time.Date(2023, 2, 20, 14, 45, 0, 0, time.UTC) BeforeEach(func() { - pls := make([]Playlist, 2) + pls := make([]Playlist, 3) pls[0] = Playlist{ Id: "111", Name: "aaa", @@ -533,8 +539,13 @@ var _ = Describe("Responses", func() { CoverArt: "pl-123123123123", Created: timestamp, Changed: timestamp, + OpenSubsonicPlaylist: &responses.OpenSubsonicPlaylist{ + Readonly: true, + ValidUntil: ×tamp, + }, } - pls[1] = Playlist{Id: "222", Name: "bbb"} + pls[1] = Playlist{Id: "333", Name: "ccc", OpenSubsonicPlaylist: &responses.OpenSubsonicPlaylist{}} + pls[2] = Playlist{Id: "222", Name: "bbb"} response.Playlists.Playlist = pls }) @@ -756,7 +767,7 @@ var _ = Describe("Responses", func() { response.PlayQueue.Username = "user1" response.PlayQueue.Current = "111" response.PlayQueue.Position = 243 - response.PlayQueue.Changed = &time.Time{} + response.PlayQueue.Changed = time.Time{} response.PlayQueue.ChangedBy = "a_client" child := make([]Child, 1) child[0] = Child{Id: "1", Title: "title", IsDir: false} @@ -771,6 +782,40 @@ var _ = Describe("Responses", func() { }) }) + Describe("PlayQueueByIndex", func() { + BeforeEach(func() { + response.PlayQueueByIndex = &PlayQueueByIndex{} + }) + + Context("without data", func() { + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + + Context("with data", func() { + BeforeEach(func() { + response.PlayQueueByIndex.Username = "user1" + response.PlayQueueByIndex.CurrentIndex = new(0) + response.PlayQueueByIndex.Position = 243 + response.PlayQueueByIndex.Changed = time.Time{} + response.PlayQueueByIndex.ChangedBy = "a_client" + child := make([]Child, 1) + child[0] = Child{Id: "1", Title: "title", IsDir: false} + response.PlayQueueByIndex.Entry = child + }) + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + }) + Describe("Shares", func() { BeforeEach(func() { response.Shares = &Shares{} @@ -1062,4 +1107,69 @@ var _ = Describe("Responses", func() { }) }) + Describe("NowPlaying", func() { + BeforeEach(func() { + response.NowPlaying = &NowPlaying{} + }) + + Describe("without data", func() { + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + + Describe("with data", func() { + BeforeEach(func() { + response.NowPlaying.Entry = []NowPlayingEntry{{ + Child: Child{Id: "1", Title: "Song", IsDir: false}, + UserName: "testuser", + MinutesAgo: 2, + PlayerId: 1, + PlayerName: "TestPlayer", + State: "playing", + PositionMs: 120000, + PlaybackRate: 1.5, + }} + }) + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + }) + + Describe("SonicMatches", func() { + Context("without data", func() { + BeforeEach(func() { + response.SonicMatches = &Array[SonicMatch]{} + }) + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + + Context("with data", func() { + BeforeEach(func() { + response.SonicMatches = &Array[SonicMatch]{ + {Entry: Child{Id: "1", Title: "Bohemian Rhapsody", IsDir: false}, Similarity: 0.95}, + {Entry: Child{Id: "2", Title: "We Will Rock You", IsDir: false}, Similarity: 0.78}, + } + }) + It("should match .XML", func() { + Expect(xml.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + It("should match .JSON", func() { + Expect(json.MarshalIndent(response, "", " ")).To(MatchSnapshot()) + }) + }) + }) + }) diff --git a/server/subsonic/searching.go b/server/subsonic/searching.go index f66846f35..fd7e29587 100644 --- a/server/subsonic/searching.go +++ b/server/subsonic/searching.go @@ -8,10 +8,11 @@ import ( "strings" "time" + . "github.com/Masterminds/squirrel" "github.com/deluan/sanitize" + "github.com/navidrome/navidrome/core/publicurl" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/server/public" "github.com/navidrome/navidrome/server/subsonic/responses" "github.com/navidrome/navidrome/utils/req" "github.com/navidrome/navidrome/utils/slice" @@ -41,17 +42,17 @@ func (api *Router) getSearchParams(r *http.Request) (*searchParams, error) { return sp, nil } -type searchFunc[T any] func(q string, offset int, size int, includeMissing bool) (T, error) +type searchFunc[T any] func(q string, options ...model.QueryOptions) (T, error) -func callSearch[T any](ctx context.Context, s searchFunc[T], q string, offset, size int, result *T) func() error { +func callSearch[T any](ctx context.Context, s searchFunc[T], q string, options model.QueryOptions, result *T) func() error { return func() error { - if size == 0 { + if options.Max == 0 { return nil } typ := strings.TrimPrefix(reflect.TypeOf(*result).String(), "model.") var err error start := time.Now() - *result, err = s(q, offset, size, false) + *result, err = s(q, options) if err != nil { log.Error(ctx, "Error searching "+typ, "query", q, "elapsed", time.Since(start), err) } else { @@ -61,15 +62,26 @@ func callSearch[T any](ctx context.Context, s searchFunc[T], q string, offset, s } } -func (api *Router) searchAll(ctx context.Context, sp *searchParams) (mediaFiles model.MediaFiles, albums model.Albums, artists model.Artists) { +func (api *Router) searchAll(ctx context.Context, sp *searchParams, musicFolderIds []int) (mediaFiles model.MediaFiles, albums model.Albums, artists model.Artists) { start := time.Now() q := sanitize.Accents(strings.ToLower(strings.TrimSuffix(sp.query, "*"))) + // Build options with offset/size/filters packed in + songOpts := model.QueryOptions{Max: sp.songCount, Offset: sp.songOffset} + albumOpts := model.QueryOptions{Max: sp.albumCount, Offset: sp.albumOffset} + artistOpts := model.QueryOptions{Max: sp.artistCount, Offset: sp.artistOffset} + + if len(musicFolderIds) > 0 { + songOpts.Filters = Eq{"library_id": musicFolderIds} + albumOpts.Filters = Eq{"library_id": musicFolderIds} + artistOpts.Filters = Eq{"library_artist.library_id": musicFolderIds} + } + // Run searches in parallel g, ctx := errgroup.WithContext(ctx) - g.Go(callSearch(ctx, api.ds.MediaFile(ctx).Search, q, sp.songOffset, sp.songCount, &mediaFiles)) - g.Go(callSearch(ctx, api.ds.Album(ctx).Search, q, sp.albumOffset, sp.albumCount, &albums)) - g.Go(callSearch(ctx, api.ds.Artist(ctx).Search, q, sp.artistOffset, sp.artistCount, &artists)) + g.Go(callSearch(ctx, api.ds.MediaFile(ctx).Search, q, songOpts, &mediaFiles)) + g.Go(callSearch(ctx, api.ds.Album(ctx).Search, q, albumOpts, &albums)) + g.Go(callSearch(ctx, api.ds.Artist(ctx).Search, q, artistOpts, &artists)) err := g.Wait() if err == nil { log.Debug(ctx, fmt.Sprintf("Search resulted in %d songs, %d albums and %d artists", @@ -86,7 +98,13 @@ func (api *Router) Search2(r *http.Request) (*responses.Subsonic, error) { if err != nil { return nil, err } - mfs, als, as := api.searchAll(ctx, sp) + + // Get optional library IDs from musicFolderId parameter + musicFolderIds, err := selectedMusicFolderIds(r, false) + if err != nil { + return nil, err + } + mfs, als, as := api.searchAll(ctx, sp, musicFolderIds) response := newResponse() searchResult2 := &responses.SearchResult2{} @@ -96,7 +114,7 @@ func (api *Router) Search2(r *http.Request) (*responses.Subsonic, error) { Name: artist.Name, UserRating: int32(artist.Rating), CoverArt: artist.CoverArtID().String(), - ArtistImageUrl: public.ImageURL(r, artist.CoverArtID(), 600), + ArtistImageUrl: publicurl.ImageURL(r, artist.CoverArtID(), 600), } if artist.Starred { a.Starred = artist.StarredAt @@ -115,7 +133,13 @@ func (api *Router) Search3(r *http.Request) (*responses.Subsonic, error) { if err != nil { return nil, err } - mfs, als, as := api.searchAll(ctx, sp) + + // Get optional library IDs from musicFolderId parameter + musicFolderIds, err := selectedMusicFolderIds(r, false) + if err != nil { + return nil, err + } + mfs, als, as := api.searchAll(ctx, sp, musicFolderIds) response := newResponse() searchResult3 := &responses.SearchResult3{} diff --git a/server/subsonic/searching_test.go b/server/subsonic/searching_test.go new file mode 100644 index 000000000..9a9c6af6f --- /dev/null +++ b/server/subsonic/searching_test.go @@ -0,0 +1,208 @@ +package subsonic + +import ( + "github.com/Masterminds/squirrel" + "github.com/navidrome/navidrome/core/auth" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Search", func() { + var router *Router + var ds model.DataStore + var mockAlbumRepo *tests.MockAlbumRepo + var mockArtistRepo *tests.MockArtistRepo + var mockMediaFileRepo *tests.MockMediaFileRepo + + BeforeEach(func() { + ds = &tests.MockDataStore{} + auth.Init(ds) + + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil) + + // Get references to the mock repositories so we can inspect their Options + mockAlbumRepo = ds.Album(nil).(*tests.MockAlbumRepo) + mockArtistRepo = ds.Artist(nil).(*tests.MockArtistRepo) + mockMediaFileRepo = ds.MediaFile(nil).(*tests.MockMediaFileRepo) + }) + + Context("musicFolderId parameter", func() { + assertQueryOptions := func(filter squirrel.Sqlizer, expectedQuery string, expectedArgs ...any) { + GinkgoHelper() + query, args, err := filter.ToSql() + Expect(err).ToNot(HaveOccurred()) + Expect(query).To(ContainSubstring(expectedQuery)) + Expect(args).To(ContainElements(expectedArgs...)) + } + + Describe("Search2", func() { + It("should accept musicFolderId parameter", func() { + r := newGetRequest("query=test", "musicFolderId=1") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{{ID: 1, Name: "Library 1"}}, + }) + r = r.WithContext(ctx) + + resp, err := router.Search2(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp).ToNot(BeNil()) + Expect(resp.SearchResult2).ToNot(BeNil()) + + // Verify that library filter was applied to all repositories + assertQueryOptions(mockAlbumRepo.Options.Filters, "library_id IN (?)", 1) + assertQueryOptions(mockArtistRepo.Options.Filters, "library_id IN (?)", 1) + assertQueryOptions(mockMediaFileRepo.Options.Filters, "library_id IN (?)", 1) + }) + + It("should return results from all accessible libraries when musicFolderId is not provided", func() { + r := newGetRequest("query=test") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + }) + r = r.WithContext(ctx) + + resp, err := router.Search2(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp).ToNot(BeNil()) + Expect(resp.SearchResult2).ToNot(BeNil()) + + // Verify that library filter was applied to all repositories with all accessible libraries + assertQueryOptions(mockAlbumRepo.Options.Filters, "library_id IN (?,?,?)", 1, 2, 3) + assertQueryOptions(mockArtistRepo.Options.Filters, "library_id IN (?,?,?)", 1, 2, 3) + assertQueryOptions(mockMediaFileRepo.Options.Filters, "library_id IN (?,?,?)", 1, 2, 3) + }) + + It("should return empty results when user has no accessible libraries", func() { + r := newGetRequest("query=test") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{}, // No libraries + }) + r = r.WithContext(ctx) + + resp, err := router.Search2(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp).ToNot(BeNil()) + Expect(resp.SearchResult2).ToNot(BeNil()) + Expect(mockAlbumRepo.Options.Filters).To(BeNil()) + Expect(mockArtistRepo.Options.Filters).To(BeNil()) + Expect(mockMediaFileRepo.Options.Filters).To(BeNil()) + }) + + It("should return error for inaccessible musicFolderId", func() { + r := newGetRequest("query=test", "musicFolderId=999") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{{ID: 1, Name: "Library 1"}}, + }) + r = r.WithContext(ctx) + + resp, err := router.Search2(r) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("Library 999 not found or not accessible")) + Expect(resp).To(BeNil()) + }) + }) + + Describe("Search3", func() { + It("should accept musicFolderId parameter", func() { + r := newGetRequest("query=test", "musicFolderId=1") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{{ID: 1, Name: "Library 1"}}, + }) + r = r.WithContext(ctx) + + resp, err := router.Search3(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp).ToNot(BeNil()) + Expect(resp.SearchResult3).ToNot(BeNil()) + + // Verify that library filter was applied to all repositories + assertQueryOptions(mockAlbumRepo.Options.Filters, "library_id IN (?)", 1) + assertQueryOptions(mockArtistRepo.Options.Filters, "library_id IN (?)", 1) + assertQueryOptions(mockMediaFileRepo.Options.Filters, "library_id IN (?)", 1) + }) + + It("should return results from all accessible libraries when musicFolderId is not provided", func() { + r := newGetRequest("query=test") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{ + {ID: 1, Name: "Library 1"}, + {ID: 2, Name: "Library 2"}, + {ID: 3, Name: "Library 3"}, + }, + }) + r = r.WithContext(ctx) + + resp, err := router.Search3(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp).ToNot(BeNil()) + Expect(resp.SearchResult3).ToNot(BeNil()) + + // Verify that library filter was applied to all repositories with all accessible libraries + assertQueryOptions(mockAlbumRepo.Options.Filters, "library_id IN (?,?,?)", 1, 2, 3) + assertQueryOptions(mockArtistRepo.Options.Filters, "library_id IN (?,?,?)", 1, 2, 3) + assertQueryOptions(mockMediaFileRepo.Options.Filters, "library_id IN (?,?,?)", 1, 2, 3) + }) + + It("should return empty results when user has no accessible libraries", func() { + r := newGetRequest("query=test") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{}, // No libraries + }) + r = r.WithContext(ctx) + + resp, err := router.Search3(r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp).ToNot(BeNil()) + Expect(resp.SearchResult3).ToNot(BeNil()) + Expect(mockAlbumRepo.Options.Filters).To(BeNil()) + Expect(mockArtistRepo.Options.Filters).To(BeNil()) + Expect(mockMediaFileRepo.Options.Filters).To(BeNil()) + }) + + It("should return error for inaccessible musicFolderId", func() { + // Test that the endpoint returns an error when user tries to access a library they don't have access to + r := newGetRequest("query=test", "musicFolderId=999") + ctx := request.WithUser(r.Context(), model.User{ + ID: "user1", + UserName: "testuser", + Libraries: []model.Library{{ID: 1, Name: "Library 1"}}, + }) + r = r.WithContext(ctx) + + resp, err := router.Search3(r) + + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("Library 999 not found or not accessible")) + Expect(resp).To(BeNil()) + }) + }) + }) +}) diff --git a/server/subsonic/sharing.go b/server/subsonic/sharing.go index 9cc8d7097..a9ccfdca4 100644 --- a/server/subsonic/sharing.go +++ b/server/subsonic/sharing.go @@ -58,12 +58,10 @@ func (api *Router) CreateShare(r *http.Request) (*responses.Subsonic, error) { } description, _ := p.String("description") - expires := p.TimeOr("expires", time.Time{}) - repo := api.share.NewRepository(r.Context()) share := &model.Share{ Description: description, - ExpiresAt: &expires, + ExpiresAt: new(p.TimeOr("expires", time.Time{})), ResourceIDs: strings.Join(ids, ","), } @@ -90,13 +88,11 @@ func (api *Router) UpdateShare(r *http.Request) (*responses.Subsonic, error) { } description, _ := p.String("description") - expires := p.TimeOr("expires", time.Time{}) - repo := api.share.NewRepository(r.Context()) share := &model.Share{ ID: id, Description: description, - ExpiresAt: &expires, + ExpiresAt: new(p.TimeOr("expires", time.Time{})), } err = repo.(rest.Persistable).Update(id, share) diff --git a/server/subsonic/sonic_similarity.go b/server/subsonic/sonic_similarity.go new file mode 100644 index 000000000..3640a116b --- /dev/null +++ b/server/subsonic/sonic_similarity.go @@ -0,0 +1,69 @@ +package subsonic + +import ( + "context" + "net/http" + + "github.com/navidrome/navidrome/core/sonic" + "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/utils/req" +) + +func (api *Router) GetSonicSimilarTracks(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { + if api.sonic == nil || !api.sonic.HasProvider() { + w.WriteHeader(http.StatusNotFound) + return nil, nil + } + ctx := r.Context() + p := req.Params(r) + id, err := p.String("id") + if err != nil { + return nil, err + } + count := p.IntOr("count", 10) + + matches, err := api.sonic.GetSonicSimilarTracks(ctx, id, count) + if err != nil { + return nil, err + } + + return sonicMatchResponse(ctx, matches), nil +} + +func (api *Router) FindSonicPath(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { + if api.sonic == nil || !api.sonic.HasProvider() { + w.WriteHeader(http.StatusNotFound) + return nil, nil + } + ctx := r.Context() + p := req.Params(r) + startSongID, err := p.String("startSongId") + if err != nil { + return nil, err + } + endSongID, err := p.String("endSongId") + if err != nil { + return nil, err + } + count := p.IntOr("count", 25) + + matches, err := api.sonic.FindSonicPath(ctx, startSongID, endSongID, count) + if err != nil { + return nil, err + } + + return sonicMatchResponse(ctx, matches), nil +} + +func sonicMatchResponse(ctx context.Context, matches []sonic.SimilarMatch) *responses.Subsonic { + response := newResponse() + resp := make(responses.Array[responses.SonicMatch], len(matches)) + for i, m := range matches { + resp[i] = responses.SonicMatch{ + Entry: childFromMediaFile(ctx, m.MediaFile), + Similarity: m.Similarity, + } + } + response.SonicMatches = &resp + return response +} diff --git a/server/subsonic/stream.go b/server/subsonic/stream.go index d0cbe2086..28b4585f0 100644 --- a/server/subsonic/stream.go +++ b/server/subsonic/stream.go @@ -2,14 +2,14 @@ package subsonic import ( "context" + "errors" "fmt" - "io" "net/http" "strconv" "strings" "github.com/navidrome/navidrome/conf" - "github.com/navidrome/navidrome/core" + "github.com/navidrome/navidrome/core/stream" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" @@ -17,38 +17,6 @@ import ( "github.com/navidrome/navidrome/utils/req" ) -func (api *Router) serveStream(ctx context.Context, w http.ResponseWriter, r *http.Request, stream *core.Stream, id string) { - if stream.Seekable() { - http.ServeContent(w, r, stream.Name(), stream.ModTime(), stream) - } else { - // If the stream doesn't provide a size (i.e. is not seekable), we can't support ranges/content-length - w.Header().Set("Accept-Ranges", "none") - w.Header().Set("Content-Type", stream.ContentType()) - - estimateContentLength := req.Params(r).BoolOr("estimateContentLength", false) - - // if Client requests the estimated content-length, send it - if estimateContentLength { - length := strconv.Itoa(stream.EstimatedContentLength()) - log.Trace(ctx, "Estimated content-length", "contentLength", length) - w.Header().Set("Content-Length", length) - } - - if r.Method == http.MethodHead { - go func() { _, _ = io.Copy(io.Discard, stream) }() - } else { - c, err := io.Copy(w, stream) - if log.IsGreaterOrEqualTo(log.LevelDebug) { - if err != nil { - log.Error(ctx, "Error sending transcoded file", "id", id, err) - } else { - log.Trace(ctx, "Success sending transcode file", "id", id, "size", c) - } - } - } - } -} - func (api *Router) Stream(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { ctx := r.Context() p := req.Params(r) @@ -60,7 +28,13 @@ func (api *Router) Stream(w http.ResponseWriter, r *http.Request) (*responses.Su format, _ := p.String("format") timeOffset := p.IntOr("timeOffset", 0) - stream, err := api.streamer.NewStream(ctx, id, format, maxBitRate, timeOffset) + mf, err := api.ds.MediaFile(ctx).Get(id) + if err != nil { + return nil, err + } + + streamReq := api.transcodeDecision.ResolveRequest(ctx, mf, format, maxBitRate, timeOffset) + stream, err := api.streamer.NewStream(ctx, mf, streamReq) if err != nil { return nil, err } @@ -75,9 +49,8 @@ func (api *Router) Stream(w http.ResponseWriter, r *http.Request) (*responses.Su w.Header().Set("X-Content-Type-Options", "nosniff") w.Header().Set("X-Content-Duration", strconv.FormatFloat(float64(stream.Duration()), 'G', -1, 32)) - api.serveStream(ctx, w, r, stream, id) - - return nil, nil + _, err = stream.Serve(ctx, w, r) + return nil, err } func (api *Router) Download(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { @@ -129,7 +102,8 @@ func (api *Router) Download(w http.ResponseWriter, r *http.Request) (*responses. switch v := entity.(type) { case *model.MediaFile: - stream, err := api.streamer.NewStream(ctx, id, format, maxBitRate, 0) + streamReq := api.transcodeDecision.ResolveRequest(ctx, v, format, maxBitRate, 0) + stream, err := api.streamer.NewStream(ctx, v, streamReq) if err != nil { return nil, err } @@ -144,20 +118,32 @@ func (api *Router) Download(w http.ResponseWriter, r *http.Request) (*responses. disposition := fmt.Sprintf("attachment; filename=\"%s\"", stream.Name()) w.Header().Set("Content-Disposition", disposition) - api.serveStream(ctx, w, r, stream, id) - return nil, nil + _, err = stream.Serve(ctx, w, r) + return nil, err case *model.Album: setHeaders(v.Name) - err = api.archiver.ZipAlbum(ctx, id, format, maxBitRate, w) + return nil, handleArchiveErr(ctx, id, api.archiver.ZipAlbum(ctx, id, format, maxBitRate, w)) case *model.Artist: setHeaders(v.Name) - err = api.archiver.ZipArtist(ctx, id, format, maxBitRate, w) + return nil, handleArchiveErr(ctx, id, api.archiver.ZipArtist(ctx, id, format, maxBitRate, w)) case *model.Playlist: setHeaders(v.Name) - err = api.archiver.ZipPlaylist(ctx, id, format, maxBitRate, w) + return nil, handleArchiveErr(ctx, id, api.archiver.ZipPlaylist(ctx, id, format, maxBitRate, w)) default: - err = model.ErrNotFound + return nil, model.ErrNotFound } - - return nil, err +} + +// handleArchiveErr swallows ErrTooManyTranscodes from archive downloads so the +// outer error handler does not try to write a 429 onto a response whose status +// and Content-Disposition have already been flushed. The archive ends up with +// the tracks that were written before the rejection (the rejected track and +// any following ones are omitted); the server-side log is the unambiguous +// signal operators can act on. +func handleArchiveErr(ctx context.Context, id string, err error) error { + if errors.Is(err, stream.ErrTooManyTranscodes) { + log.Warn(ctx, "Archive download finalized early: transcode cap reached", "id", id, err) + return nil + } + return err } diff --git a/server/subsonic/transcode.go b/server/subsonic/transcode.go new file mode 100644 index 000000000..578ad44fc --- /dev/null +++ b/server/subsonic/transcode.go @@ -0,0 +1,404 @@ +package subsonic + +import ( + "encoding/json" + "errors" + "fmt" + "net/http" + "slices" + "strconv" + + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/log" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/utils/req" +) + +// API-layer request structs for JSON unmarshaling (decoupled from core structs) + +// clientInfoRequest represents client playback capabilities from the request body +type clientInfoRequest struct { + Name string `json:"name,omitempty"` + Platform string `json:"platform,omitempty"` + MaxAudioBitrate int `json:"maxAudioBitrate,omitempty"` + MaxTranscodingAudioBitrate int `json:"maxTranscodingAudioBitrate,omitempty"` + DirectPlayProfiles []directPlayProfileRequest `json:"directPlayProfiles,omitempty"` + TranscodingProfiles []transcodingProfileRequest `json:"transcodingProfiles,omitempty"` + CodecProfiles []codecProfileRequest `json:"codecProfiles,omitempty"` +} + +// directPlayProfileRequest describes a format the client can play directly +type directPlayProfileRequest struct { + Containers []string `json:"containers,omitempty"` + AudioCodecs []string `json:"audioCodecs,omitempty"` + Protocols []string `json:"protocols,omitempty"` + MaxAudioChannels int `json:"maxAudioChannels,omitempty"` +} + +// transcodingProfileRequest describes a transcoding target the client supports +type transcodingProfileRequest struct { + Container string `json:"container,omitempty"` + AudioCodec string `json:"audioCodec,omitempty"` + Protocol string `json:"protocol,omitempty"` + MaxAudioChannels int `json:"maxAudioChannels,omitempty"` +} + +// codecProfileRequest describes codec-specific limitations +type codecProfileRequest struct { + Type string `json:"type,omitempty"` + Name string `json:"name,omitempty"` + Limitations []limitationRequest `json:"limitations,omitempty"` +} + +// limitationRequest describes a specific codec limitation +type limitationRequest struct { + Name string `json:"name,omitempty"` + Comparison string `json:"comparison,omitempty"` + Values []string `json:"values,omitempty"` + Required bool `json:"required,omitempty"` +} + +// toCoreClientInfo converts the API request struct to the stream.ClientInfo struct. +// The OpenSubsonic spec uses bps for bitrate values; core uses kbps. +func (r *clientInfoRequest) toCoreClientInfo() *stream.ClientInfo { + ci := &stream.ClientInfo{ + Name: r.Name, + Platform: r.Platform, + MaxAudioBitrate: bpsToKbps(r.MaxAudioBitrate), + MaxTranscodingAudioBitrate: bpsToKbps(r.MaxTranscodingAudioBitrate), + } + + for _, dp := range r.DirectPlayProfiles { + ci.DirectPlayProfiles = append(ci.DirectPlayProfiles, stream.DirectPlayProfile{ + Containers: dp.Containers, + AudioCodecs: dp.AudioCodecs, + Protocols: dp.Protocols, + MaxAudioChannels: dp.MaxAudioChannels, + }) + } + + for _, tp := range r.TranscodingProfiles { + ci.TranscodingProfiles = append(ci.TranscodingProfiles, stream.Profile{ + Container: tp.Container, + AudioCodec: tp.AudioCodec, + Protocol: tp.Protocol, + MaxAudioChannels: tp.MaxAudioChannels, + }) + } + + for _, cp := range r.CodecProfiles { + coreCP := stream.CodecProfile{ + Type: cp.Type, + Name: cp.Name, + } + for _, lim := range cp.Limitations { + coreLim := stream.Limitation{ + Name: lim.Name, + Comparison: lim.Comparison, + Values: lim.Values, + Required: lim.Required, + } + // Convert audioBitrate limitation values from bps to kbps + if lim.Name == stream.LimitationAudioBitrate { + coreLim.Values = convertBitrateValues(lim.Values) + } + coreCP.Limitations = append(coreCP.Limitations, coreLim) + } + ci.CodecProfiles = append(ci.CodecProfiles, coreCP) + } + + return ci +} + +// bpsToKbps converts bits per second to kilobits per second (rounded). +func bpsToKbps(bps int) int { + if bps < 0 { + return 0 + } + return (bps + 500) / 1000 +} + +// kbpsToBps converts kilobits per second to bits per second. +func kbpsToBps(kbps int) int { + return kbps * 1000 +} + +// convertBitrateValues converts a slice of bps string values to kbps string values. +func convertBitrateValues(bpsValues []string) []string { + result := make([]string, len(bpsValues)) + for i, v := range bpsValues { + n, err := strconv.Atoi(v) + if err == nil { + result[i] = strconv.Itoa(bpsToKbps(n)) + } else { + result[i] = v // preserve unparseable values as-is + } + } + return result +} + +// validate checks that all enum fields in the request contain valid values per the OpenSubsonic spec. +func (r *clientInfoRequest) validate() error { + for _, dp := range r.DirectPlayProfiles { + for _, p := range dp.Protocols { + if !isValidProtocol(p) { + return fmt.Errorf("invalid protocol: %s", p) + } + } + } + for _, tp := range r.TranscodingProfiles { + if tp.Protocol != "" && !isValidProtocol(tp.Protocol) { + return fmt.Errorf("invalid protocol: %s", tp.Protocol) + } + } + for _, cp := range r.CodecProfiles { + if !isValidCodecProfileType(cp.Type) { + return fmt.Errorf("invalid codec profile type: %s", cp.Type) + } + for _, lim := range cp.Limitations { + if !isValidLimitationName(lim.Name) { + return fmt.Errorf("invalid limitation name: %s", lim.Name) + } + if !isValidComparison(lim.Comparison) { + return fmt.Errorf("invalid comparison: %s", lim.Comparison) + } + } + } + return nil +} + +// Only support songs for now +var validMediaTypes = []string{ + "song", +} + +func isValidMediaType(mediaType string) bool { + return slices.Contains(validMediaTypes, mediaType) +} + +var validProtocols = []string{ + stream.ProtocolHTTP, + stream.ProtocolHLS, +} + +func isValidProtocol(p string) bool { + return slices.Contains(validProtocols, p) +} + +var validCodecProfileTypes = []string{ + stream.CodecProfileTypeAudio, +} + +func isValidCodecProfileType(t string) bool { + return slices.Contains(validCodecProfileTypes, t) +} + +var validLimitationNames = []string{ + stream.LimitationAudioChannels, + stream.LimitationAudioBitrate, + stream.LimitationAudioProfile, + stream.LimitationAudioSamplerate, + stream.LimitationAudioBitdepth, +} + +func isValidLimitationName(n string) bool { + return slices.Contains(validLimitationNames, n) +} + +var validComparisons = []string{ + stream.ComparisonEquals, + stream.ComparisonNotEquals, + stream.ComparisonLessThanEqual, + stream.ComparisonGreaterThanEqual, +} + +func isValidComparison(c string) bool { + return slices.Contains(validComparisons, c) +} + +// toResponseStreamDetails converts a core StreamDetails to the API response type. +func toResponseStreamDetails(sd *stream.Details) *responses.StreamDetails { + return &responses.StreamDetails{ + Protocol: stream.ProtocolHTTP, // TODO: derive from decision when HLS support is added + Container: sd.Container, + Codec: sd.Codec, + AudioBitrate: int32(kbpsToBps(sd.Bitrate)), + AudioProfile: sd.Profile, + AudioSamplerate: int32(sd.SampleRate), + AudioBitdepth: int32(sd.BitDepth), + AudioChannels: int32(sd.Channels), + } +} + +// GetTranscodeDecision handles the OpenSubsonic getTranscodeDecision endpoint. +// It receives client capabilities and returns a decision on whether to direct play or stream. +func (api *Router) GetTranscodeDecision(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { + if r.Method != http.MethodPost { + w.Header().Set("Allow", "POST") + http.Error(w, "Method Not Allowed", http.StatusMethodNotAllowed) + return nil, nil + } + + ctx := r.Context() + p := req.Params(r) + + mediaID, err := p.String("mediaId") + if err != nil { + return nil, newError(responses.ErrorMissingParameter, "missing required parameter: mediaId") + } + + mediaType, err := p.String("mediaType") + if err != nil { + return nil, newError(responses.ErrorMissingParameter, "missing required parameter: mediaType") + } + + if !isValidMediaType(mediaType) { + return nil, newError(responses.ErrorGeneric, "mediaType '%s' is not yet supported", mediaType) + } + + // Parse and validate ClientInfo from request body (required per OpenSubsonic spec) + var clientInfoReq clientInfoRequest + r.Body = http.MaxBytesReader(w, r.Body, 1<<20) // 1 MB limit + if err := json.NewDecoder(r.Body).Decode(&clientInfoReq); err != nil { + return nil, newError(responses.ErrorGeneric, "invalid JSON request body") + } + if err := clientInfoReq.validate(); err != nil { + return nil, newError(responses.ErrorGeneric, "%v", err) + } + clientInfo := clientInfoReq.toCoreClientInfo() + + // TODO: Remove this filter once AAC transcoding works reliably + // with streaming clients (Sonos, etc). + // See https://github.com/navidrome/navidrome/discussions/4832#discussioncomment-16068231 + clientInfo.TranscodingProfiles = slices.DeleteFunc(clientInfo.TranscodingProfiles, func(p stream.Profile) bool { + if p.AudioCodec != "" { + return stream.IsAACCodec(p.AudioCodec) + } + return stream.IsAACCodec(p.Container) + }) + + // Get media file + mf, err := api.ds.MediaFile(ctx).Get(mediaID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + return nil, newError(responses.ErrorDataNotFound, "media file not found: %s", mediaID) + } + log.Error(ctx, "Error retrieving media file", "mediaID", mediaID, err) + return nil, newError(responses.ErrorGeneric, "error retrieving media file") + } + + // Make the decision + decision, err := api.transcodeDecision.MakeDecision(ctx, mf, clientInfo, stream.TranscodeOptions{}) + if err != nil { + log.Error(ctx, "Failed to make transcode decision", "mediaID", mediaID, err) + return nil, newError(responses.ErrorGeneric, "failed to make transcode decision") + } + + // Only create a token when there is a valid playback path + var transcodeParams string + if decision.CanDirectPlay || decision.CanTranscode { + transcodeParams, err = api.transcodeDecision.CreateTranscodeParams(decision) + if err != nil { + log.Error(ctx, "Failed to create transcode token", "mediaID", mediaID, err) + return nil, newError(responses.ErrorGeneric, "failed to create transcode token") + } + } + + // Build response (convert kbps from core to bps for the API) + response := newResponse() + response.TranscodeDecision = &responses.TranscodeDecision{ + CanDirectPlay: decision.CanDirectPlay, + CanTranscode: decision.CanTranscode, + TranscodeReasons: decision.TranscodeReasons, + ErrorReason: decision.ErrorReason, + TranscodeParams: transcodeParams, + SourceStream: toResponseStreamDetails(&decision.SourceStream), + } + + if decision.TranscodeStream != nil { + response.TranscodeDecision.TranscodeStream = toResponseStreamDetails(decision.TranscodeStream) + } + + return response, nil +} + +// GetTranscodeStream handles the OpenSubsonic getTranscodeStream endpoint. +// It streams media using the decision encoded in the transcodeParams JWT token. +// All errors are returned as proper HTTP status codes (not Subsonic error responses). +func (api *Router) GetTranscodeStream(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { + ctx := r.Context() + p := req.Params(r) + + mediaID, err := p.String("mediaId") + if err != nil { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + mediaType, err := p.String("mediaType") + if err != nil { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + transcodeParamsToken, err := p.String("transcodeParams") + if err != nil { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + if !isValidMediaType(mediaType) { + http.Error(w, "Bad Request", http.StatusBadRequest) + return nil, nil + } + + // Fetch the media file + mf, err := api.ds.MediaFile(ctx).Get(mediaID) + if err != nil { + if errors.Is(err, model.ErrNotFound) { + http.Error(w, "Not Found", http.StatusNotFound) + } else { + log.Error(ctx, "Error retrieving media file", "mediaID", mediaID, err) + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + } + return nil, nil + } + + // Validate the token and resolve streaming parameters + streamReq, err := api.transcodeDecision.ResolveRequestFromToken(ctx, transcodeParamsToken, mf, p.IntOr("offset", 0)) + if err != nil { + switch { + case errors.Is(err, stream.ErrTokenInvalid), errors.Is(err, stream.ErrTokenStale): + log.Warn(ctx, "Invalid or stale transcode token", "mediaID", mediaID, err) + http.Error(w, "Gone", http.StatusGone) + default: + log.Error(ctx, "Error validating transcode params", err) + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + } + return nil, nil + } + + // Create stream + stream, err := api.streamer.NewStream(ctx, mf, streamReq) + if err != nil { + log.Error(ctx, "Error creating stream", "mediaID", mediaID, err) + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + return nil, nil + } + + // Make sure the stream will be closed at the end + defer func() { + if err := stream.Close(); err != nil && log.IsGreaterOrEqualTo(log.LevelDebug) { + log.Error("Error closing stream", "id", mediaID, "file", stream.Name(), err) + } + }() + + w.Header().Set("X-Content-Type-Options", "nosniff") + + n, err := stream.Serve(ctx, w, r) + if err != nil || n == 0 { + http.Error(w, "Internal Server Error", http.StatusInternalServerError) + } + return nil, nil +} diff --git a/server/subsonic/transcode_test.go b/server/subsonic/transcode_test.go new file mode 100644 index 000000000..adc7b7600 --- /dev/null +++ b/server/subsonic/transcode_test.go @@ -0,0 +1,424 @@ +package subsonic + +import ( + "bytes" + "context" + "errors" + "net/http" + "net/http/httptest" + + "github.com/navidrome/navidrome/core/stream" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/tests" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Transcode endpoints", func() { + var ( + router *Router + ds *tests.MockDataStore + mockTD *mockTranscodeDecision + w *httptest.ResponseRecorder + mockMFRepo *tests.MockMediaFileRepo + ) + + BeforeEach(func() { + mockMFRepo = &tests.MockMediaFileRepo{} + ds = &tests.MockDataStore{MockedMediaFile: mockMFRepo} + mockTD = &mockTranscodeDecision{} + router = New(ds, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, mockTD, nil) + w = httptest.NewRecorder() + }) + + Describe("GetTranscodeDecision", func() { + It("returns 405 for non-POST requests", func() { + r := newGetRequest("mediaId=123", "mediaType=song") + resp, err := router.GetTranscodeDecision(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusMethodNotAllowed)) + Expect(w.Header().Get("Allow")).To(Equal("POST")) + }) + + It("returns error when mediaId is missing", func() { + r := newJSONPostRequest("mediaType=song", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when mediaType is missing", func() { + r := newJSONPostRequest("mediaId=123", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for unsupported mediaType", func() { + r := newJSONPostRequest("mediaId=123&mediaType=podcast", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("not yet supported")) + }) + + It("returns ErrorDataNotFound when media file does not exist", func() { + // mockMFRepo has no data set, so Get() returns model.ErrNotFound + r := newJSONPostRequest("mediaId=nonexistent&mediaType=song", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("media file not found")) + }) + + It("returns error when media file retrieval fails", func() { + mockMFRepo.SetError(true) + r := newJSONPostRequest("mediaId=song-1&mediaType=song", "{}") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("error retrieving media file")) + }) + + It("returns error when body is empty", func() { + r := newJSONPostRequest("mediaId=song-1&mediaType=song", "") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error when body contains invalid JSON", func() { + r := newJSONPostRequest("mediaId=song-1&mediaType=song", "not-json{{{") + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + }) + + It("returns error for invalid protocol in direct play profile", func() { + body := `{"directPlayProfiles":[{"containers":["mp3"],"audioCodecs":["mp3"],"protocols":["ftp"]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid protocol")) + }) + + It("returns error for invalid comparison operator", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"audioBitrate","comparison":"InvalidOp","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid comparison")) + }) + + It("returns error for invalid limitation name", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"unknownField","comparison":"Equals","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid limitation name")) + }) + + It("returns error for invalid codec profile type", func() { + body := `{"codecProfiles":[{"type":"VideoCodec","name":"mp3"}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid codec profile type")) + }) + + It("rejects wrong-case protocol", func() { + body := `{"directPlayProfiles":[{"containers":["mp3"],"audioCodecs":["mp3"],"protocols":["HTTP"]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid protocol")) + }) + + It("rejects wrong-case codec profile type", func() { + body := `{"codecProfiles":[{"type":"audiocodec","name":"mp3"}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid codec profile type")) + }) + + It("rejects wrong-case comparison operator", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"audioBitrate","comparison":"lessthanequal","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid comparison")) + }) + + It("rejects wrong-case limitation name", func() { + body := `{"codecProfiles":[{"type":"AudioCodec","name":"mp3","limitations":[{"name":"AudioBitrate","comparison":"Equals","values":["320"]}]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + Expect(err).To(HaveOccurred()) + Expect(err.Error()).To(ContainSubstring("invalid limitation name")) + }) + + It("returns a valid decision response", func() { + mockMFRepo.SetData(model.MediaFiles{ + {ID: "song-1", Suffix: "mp3", Codec: "MP3", BitRate: 320, Channels: 2, SampleRate: 44100}, + }) + mockTD.decision = &stream.TranscodeDecision{ + MediaID: "song-1", + CanDirectPlay: true, + SourceStream: stream.Details{ + Container: "mp3", Codec: "mp3", Bitrate: 320, + SampleRate: 44100, Channels: 2, + }, + } + mockTD.token = "test-jwt-token" + + body := `{"directPlayProfiles":[{"containers":["mp3"],"protocols":["http"]}]}` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + resp, err := router.GetTranscodeDecision(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.TranscodeDecision).ToNot(BeNil()) + Expect(resp.TranscodeDecision.CanDirectPlay).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeParams).To(Equal("test-jwt-token")) + Expect(resp.TranscodeDecision.SourceStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.SourceStream.Protocol).To(Equal("http")) + Expect(resp.TranscodeDecision.SourceStream.Container).To(Equal("mp3")) + Expect(resp.TranscodeDecision.SourceStream.AudioBitrate).To(Equal(int32(320_000))) + }) + + It("filters AAC from transcoding profiles", func() { + mockMFRepo.SetData(model.MediaFiles{ + {ID: "song-1", Suffix: "opus", Codec: "opus", BitRate: 128, Channels: 2, SampleRate: 48000}, + }) + mockTD.decision = &stream.TranscodeDecision{MediaID: "song-1", CanDirectPlay: true} + mockTD.token = "token" + + body := `{ + "transcodingProfiles": [ + {"container": "aac", "audioCodec": "aac", "protocol": "http"}, + {"container": "mp3", "audioCodec": "mp3", "protocol": "http"}, + {"container": "m4a", "audioCodec": "aac", "protocol": "http"} + ] + }` + r := newJSONPostRequest("mediaId=song-1&mediaType=song", body) + _, err := router.GetTranscodeDecision(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(mockTD.capturedClient).ToNot(BeNil()) + Expect(mockTD.capturedClient.TranscodingProfiles).To(HaveLen(1)) + Expect(mockTD.capturedClient.TranscodingProfiles[0].AudioCodec).To(Equal("mp3")) + }) + + It("includes transcode stream when transcoding", func() { + mockMFRepo.SetData(model.MediaFiles{ + {ID: "song-2", Suffix: "flac", Codec: "FLAC", BitRate: 1000, Channels: 2, SampleRate: 96000, BitDepth: 24}, + }) + mockTD.decision = &stream.TranscodeDecision{ + MediaID: "song-2", + CanDirectPlay: false, + CanTranscode: true, + TargetFormat: "mp3", + TargetBitrate: 256, + TranscodeReasons: []string{"container not supported"}, + SourceStream: stream.Details{ + Container: "flac", Codec: "flac", Bitrate: 1000, + SampleRate: 96000, BitDepth: 24, Channels: 2, + }, + TranscodeStream: &stream.Details{ + Container: "mp3", Codec: "mp3", Bitrate: 256, + SampleRate: 96000, Channels: 2, + }, + } + mockTD.token = "transcode-token" + + r := newJSONPostRequest("mediaId=song-2&mediaType=song", "{}") + resp, err := router.GetTranscodeDecision(w, r) + + Expect(err).ToNot(HaveOccurred()) + Expect(resp.TranscodeDecision.CanTranscode).To(BeTrue()) + Expect(resp.TranscodeDecision.TranscodeReasons).To(ConsistOf("container not supported")) + Expect(resp.TranscodeDecision.TranscodeStream).ToNot(BeNil()) + Expect(resp.TranscodeDecision.TranscodeStream.Container).To(Equal("mp3")) + }) + }) + + Describe("GetTranscodeStream", func() { + It("returns 400 when mediaId is missing", func() { + r := newGetRequest("mediaType=song", "transcodeParams=abc") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 400 when transcodeParams is missing", func() { + r := newGetRequest("mediaId=123", "mediaType=song") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusBadRequest)) + }) + + It("returns 410 for invalid or mismatched token", func() { + mockMFRepo.SetData(model.MediaFiles{{ID: "123"}}) + mockTD.resolveErr = stream.ErrTokenInvalid + r := newGetRequest("mediaId=123", "mediaType=song", "transcodeParams=bad-token") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusGone)) + }) + + It("returns 404 when media file not found", func() { + // mockMFRepo has no data, so Get() returns ErrNotFound + r := newGetRequest("mediaId=gone-id", "mediaType=song", "transcodeParams=valid-token") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusNotFound)) + }) + + It("returns 410 when media file has changed (stale token)", func() { + mockMFRepo.SetData(model.MediaFiles{{ID: "song-1"}}) + mockTD.resolveErr = stream.ErrTokenStale + r := newGetRequest("mediaId=song-1", "mediaType=song", "transcodeParams=stale-token") + resp, err := router.GetTranscodeStream(w, r) + Expect(err).ToNot(HaveOccurred()) + Expect(resp).To(BeNil()) + Expect(w.Code).To(Equal(http.StatusGone)) + }) + + It("builds correct StreamRequest for direct play", func() { + fakeStreamer := &fakeMediaStreamer{} + router = New(ds, nil, fakeStreamer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, mockTD, nil) + mockMFRepo.SetData(model.MediaFiles{{ID: "song-1"}}) + mockTD.resolvedReq = stream.Request{} + + r := newGetRequest("mediaId=song-1", "mediaType=song", "transcodeParams=valid-token") + _, _ = router.GetTranscodeStream(w, r) + + Expect(fakeStreamer.captured).ToNot(BeNil()) + Expect(fakeStreamer.captured.Format).To(BeEmpty()) + Expect(fakeStreamer.captured.BitRate).To(BeZero()) + Expect(fakeStreamer.captured.SampleRate).To(BeZero()) + Expect(fakeStreamer.captured.BitDepth).To(BeZero()) + Expect(fakeStreamer.captured.Channels).To(BeZero()) + }) + + It("builds correct StreamRequest for transcoding", func() { + fakeStreamer := &fakeMediaStreamer{} + router = New(ds, nil, fakeStreamer, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, mockTD, nil) + mockMFRepo.SetData(model.MediaFiles{{ID: "song-2"}}) + mockTD.resolvedReq = stream.Request{ + Format: "mp3", + BitRate: 256, + SampleRate: 44100, + BitDepth: 16, + Channels: 2, + } + + r := newGetRequest("mediaId=song-2", "mediaType=song", "transcodeParams=valid-token", "offset=10") + _, _ = router.GetTranscodeStream(w, r) + + Expect(fakeStreamer.captured).ToNot(BeNil()) + Expect(fakeStreamer.captured.Format).To(Equal("mp3")) + Expect(fakeStreamer.captured.BitRate).To(Equal(256)) + Expect(fakeStreamer.captured.SampleRate).To(Equal(44100)) + Expect(fakeStreamer.captured.BitDepth).To(Equal(16)) + Expect(fakeStreamer.captured.Channels).To(Equal(2)) + Expect(fakeStreamer.captured.Offset).To(Equal(10)) + }) + }) + + Describe("bpsToKbps", func() { + It("converts standard bitrates", func() { + Expect(bpsToKbps(128000)).To(Equal(128)) + Expect(bpsToKbps(320000)).To(Equal(320)) + Expect(bpsToKbps(256000)).To(Equal(256)) + }) + It("returns 0 for 0", func() { + Expect(bpsToKbps(0)).To(Equal(0)) + }) + It("rounds instead of truncating", func() { + Expect(bpsToKbps(999)).To(Equal(1)) + Expect(bpsToKbps(500)).To(Equal(1)) + Expect(bpsToKbps(499)).To(Equal(0)) + }) + It("returns 0 for negative values", func() { + Expect(bpsToKbps(-1)).To(Equal(0)) + Expect(bpsToKbps(-1000)).To(Equal(0)) + Expect(bpsToKbps(-1000000)).To(Equal(0)) + }) + }) + + Describe("kbpsToBps", func() { + It("converts standard bitrates", func() { + Expect(kbpsToBps(128)).To(Equal(128000)) + Expect(kbpsToBps(320)).To(Equal(320000)) + }) + It("returns 0 for 0", func() { + Expect(kbpsToBps(0)).To(Equal(0)) + }) + }) + + Describe("convertBitrateValues", func() { + It("converts valid bps strings to kbps", func() { + Expect(convertBitrateValues([]string{"128000", "320000"})).To(Equal([]string{"128", "320"})) + }) + It("preserves unparseable values", func() { + Expect(convertBitrateValues([]string{"128000", "bad", "320000"})).To(Equal([]string{"128", "bad", "320"})) + }) + It("handles empty slice", func() { + Expect(convertBitrateValues([]string{})).To(Equal([]string{})) + }) + }) +}) + +// newJSONPostRequest creates an HTTP POST request with JSON body and query params +func newJSONPostRequest(queryParams string, jsonBody string) *http.Request { + r := httptest.NewRequest("POST", "/getTranscodeDecision?"+queryParams, bytes.NewBufferString(jsonBody)) + r.Header.Set("Content-Type", "application/json") + return r +} + +// mockTranscodeDecision is a test double for stream.TranscodeDecider +type mockTranscodeDecision struct { + decision *stream.TranscodeDecision + token string + tokenErr error + resolvedReq stream.Request + resolveErr error + capturedClient *stream.ClientInfo +} + +func (m *mockTranscodeDecision) MakeDecision(_ context.Context, _ *model.MediaFile, ci *stream.ClientInfo, _ stream.TranscodeOptions) (*stream.TranscodeDecision, error) { + m.capturedClient = ci + if m.decision != nil { + return m.decision, nil + } + return &stream.TranscodeDecision{}, nil +} + +func (m *mockTranscodeDecision) ResolveRequest(_ context.Context, _ *model.MediaFile, _ string, _ int, _ int) stream.Request { + return stream.Request{Format: "raw"} +} + +func (m *mockTranscodeDecision) CreateTranscodeParams(_ *stream.TranscodeDecision) (string, error) { + return m.token, m.tokenErr +} + +func (m *mockTranscodeDecision) ResolveRequestFromToken(_ context.Context, _ string, _ *model.MediaFile, offset int) (stream.Request, error) { + if m.resolveErr != nil { + return stream.Request{}, m.resolveErr + } + req := m.resolvedReq + req.Offset = offset + return req, nil +} + +// fakeMediaStreamer captures the StreamRequest and returns a sentinel error, +// allowing tests to verify parameter passing without constructing a real Stream. +var errStreamCaptured = errors.New("stream request captured") + +type fakeMediaStreamer struct { + captured *stream.Request +} + +func (f *fakeMediaStreamer) NewStream(_ context.Context, _ *model.MediaFile, req stream.Request) (*stream.Stream, error) { + f.captured = &req + return nil, errStreamCaptured +} diff --git a/server/subsonic/users.go b/server/subsonic/users.go index 0499b5ee0..acf8de3e8 100644 --- a/server/subsonic/users.go +++ b/server/subsonic/users.go @@ -2,28 +2,51 @@ package subsonic import ( "net/http" + "strings" "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/request" "github.com/navidrome/navidrome/server/subsonic/responses" + "github.com/navidrome/navidrome/utils/req" + "github.com/navidrome/navidrome/utils/slice" ) -// TODO This is a placeholder. The real one has to read this info from a config file or the database +// buildUserResponse creates a User response object from a User model +func buildUserResponse(user model.User) responses.User { + userResponse := responses.User{ + Username: user.UserName, + AdminRole: user.IsAdmin, + Email: user.Email, + StreamRole: true, + ScrobblingEnabled: true, + DownloadRole: conf.Server.EnableDownloads, + ShareRole: conf.Server.EnableSharing, + CoverArtRole: conf.Server.EnableArtworkUpload || user.IsAdmin, + Folder: slice.Map(user.Libraries, func(lib model.Library) int32 { return int32(lib.ID) }), + } + + if conf.Server.Jukebox.Enabled { + userResponse.JukeboxRole = !conf.Server.Jukebox.AdminOnly || user.IsAdmin + } + + return userResponse +} + func (api *Router) GetUser(r *http.Request) (*responses.Subsonic, error) { loggedUser, ok := request.UserFrom(r.Context()) if !ok { return nil, newError(responses.ErrorGeneric, "Internal error") } + username, err := req.Params(r).String("username") + if err != nil { + return nil, err + } + if !strings.EqualFold(username, loggedUser.UserName) { + return nil, newError(responses.ErrorAuthorizationFail) + } response := newResponse() - response.User = &responses.User{} - response.User.Username = loggedUser.UserName - response.User.AdminRole = loggedUser.IsAdmin - response.User.Email = loggedUser.Email - response.User.StreamRole = true - response.User.ScrobblingEnabled = true - response.User.DownloadRole = conf.Server.EnableDownloads - response.User.ShareRole = conf.Server.EnableSharing - response.User.JukeboxRole = conf.Server.Jukebox.Enabled + response.User = new(buildUserResponse(loggedUser)) return response, nil } @@ -32,17 +55,8 @@ func (api *Router) GetUsers(r *http.Request) (*responses.Subsonic, error) { if !ok { return nil, newError(responses.ErrorGeneric, "Internal error") } - user := responses.User{} - user.Username = loggedUser.Name - user.AdminRole = loggedUser.IsAdmin - user.Email = loggedUser.Email - user.StreamRole = true - user.ScrobblingEnabled = true - user.DownloadRole = conf.Server.EnableDownloads - user.ShareRole = conf.Server.EnableSharing - if conf.Server.Jukebox.Enabled { - user.JukeboxRole = !conf.Server.Jukebox.AdminOnly || loggedUser.IsAdmin - } + + user := buildUserResponse(loggedUser) response := newResponse() response.Users = &responses.Users{User: []responses.User{user}} return response, nil diff --git a/server/subsonic/users_test.go b/server/subsonic/users_test.go new file mode 100644 index 000000000..2d08b3377 --- /dev/null +++ b/server/subsonic/users_test.go @@ -0,0 +1,191 @@ +package subsonic + +import ( + "errors" + "net/http/httptest" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" + "github.com/navidrome/navidrome/server/subsonic/responses" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("Users", func() { + var router *Router + var testUser model.User + + BeforeEach(func() { + DeferCleanup(configtest.SetupConfig()) + router = &Router{} + + testUser = model.User{ + ID: "user123", + UserName: "testuser", + Name: "Test User", + Email: "test@example.com", + IsAdmin: false, + } + }) + + Describe("Happy path", func() { + It("should return consistent user data in both GetUser and GetUsers", func() { + conf.Server.EnableDownloads = true + conf.Server.EnableSharing = true + conf.Server.Jukebox.Enabled = false + + // Set up user with libraries + testUser.Libraries = model.Libraries{ + {ID: 10, Name: "Music"}, + {ID: 20, Name: "Podcasts"}, + } + + // Create request with user in context + req := httptest.NewRequest("GET", "/rest/getUser?username=testuser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) + req = req.WithContext(ctx) + + userResponse, err1 := router.GetUser(req) + usersResponse, err2 := router.GetUsers(req) + + Expect(err1).ToNot(HaveOccurred()) + Expect(err2).ToNot(HaveOccurred()) + + // Verify GetUser response structure + Expect(userResponse.Status).To(Equal(responses.StatusOK)) + Expect(userResponse.User).ToNot(BeNil()) + Expect(userResponse.User.Username).To(Equal("testuser")) + Expect(userResponse.User.Email).To(Equal("test@example.com")) + Expect(userResponse.User.AdminRole).To(BeFalse()) + Expect(userResponse.User.StreamRole).To(BeTrue()) + Expect(userResponse.User.ScrobblingEnabled).To(BeTrue()) + Expect(userResponse.User.DownloadRole).To(BeTrue()) + Expect(userResponse.User.ShareRole).To(BeTrue()) + Expect(userResponse.User.CoverArtRole).To(BeTrue()) + Expect(userResponse.User.Folder).To(ContainElements(int32(10), int32(20))) + + // Verify GetUsers response structure + Expect(usersResponse.Status).To(Equal(responses.StatusOK)) + Expect(usersResponse.Users).ToNot(BeNil()) + Expect(usersResponse.Users.User).To(HaveLen(1)) + + // Verify both methods return identical user data + singleUser := userResponse.User + userFromList := &usersResponse.Users.User[0] + + Expect(singleUser.Username).To(Equal(userFromList.Username)) + Expect(singleUser.Email).To(Equal(userFromList.Email)) + Expect(singleUser.AdminRole).To(Equal(userFromList.AdminRole)) + Expect(singleUser.StreamRole).To(Equal(userFromList.StreamRole)) + Expect(singleUser.ScrobblingEnabled).To(Equal(userFromList.ScrobblingEnabled)) + Expect(singleUser.DownloadRole).To(Equal(userFromList.DownloadRole)) + Expect(singleUser.ShareRole).To(Equal(userFromList.ShareRole)) + Expect(singleUser.CoverArtRole).To(Equal(userFromList.CoverArtRole)) + Expect(singleUser.JukeboxRole).To(Equal(userFromList.JukeboxRole)) + Expect(singleUser.Folder).To(Equal(userFromList.Folder)) + }) + }) + + DescribeTable("Jukebox role permissions", + func(jukeboxEnabled, adminOnly, isAdmin, expectedJukeboxRole bool) { + conf.Server.Jukebox.Enabled = jukeboxEnabled + conf.Server.Jukebox.AdminOnly = adminOnly + testUser.IsAdmin = isAdmin + + response := buildUserResponse(testUser) + Expect(response.JukeboxRole).To(Equal(expectedJukeboxRole)) + }, + Entry("jukebox disabled", false, false, false, false), + Entry("jukebox enabled, not admin-only, regular user", true, false, false, true), + Entry("jukebox enabled, not admin-only, admin user", true, false, true, true), + Entry("jukebox enabled, admin-only, regular user", true, true, false, false), + Entry("jukebox enabled, admin-only, admin user", true, true, true, true), + ) + + DescribeTable("CoverArt role permissions", + func(enableArtworkUpload, isAdmin, expectedCoverArtRole bool) { + conf.Server.EnableArtworkUpload = enableArtworkUpload + testUser.IsAdmin = isAdmin + + response := buildUserResponse(testUser) + Expect(response.CoverArtRole).To(Equal(expectedCoverArtRole)) + }, + Entry("enabled, regular user", true, false, true), + Entry("enabled, admin user", true, true, true), + Entry("disabled, regular user", false, false, false), + Entry("disabled, admin user", false, true, true), + ) + + Describe("Folder list population", func() { + It("should populate Folder field with user's accessible library IDs", func() { + testUser.Libraries = model.Libraries{ + {ID: 1, Name: "Music"}, + {ID: 2, Name: "Podcasts"}, + {ID: 5, Name: "Audiobooks"}, + } + + response := buildUserResponse(testUser) + + Expect(response.Folder).To(HaveLen(3)) + Expect(response.Folder).To(ContainElements(int32(1), int32(2), int32(5))) + }) + }) + + Describe("GetUser authorization", func() { + It("should allow user to request their own information", func() { + req := httptest.NewRequest("GET", "/rest/getUser?username=testuser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) + req = req.WithContext(ctx) + + response, err := router.GetUser(req) + + Expect(err).ToNot(HaveOccurred()) + Expect(response).ToNot(BeNil()) + Expect(response.User).ToNot(BeNil()) + Expect(response.User.Username).To(Equal("testuser")) + }) + + It("should deny user from requesting another user's information", func() { + req := httptest.NewRequest("GET", "/rest/getUser?username=anotheruser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) + req = req.WithContext(ctx) + + response, err := router.GetUser(req) + + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorAuthorizationFail)) + }) + + It("should return error when username parameter is missing", func() { + req := httptest.NewRequest("GET", "/rest/getUser", nil) + ctx := request.WithUser(GinkgoT().Context(), testUser) + req = req.WithContext(ctx) + + response, err := router.GetUser(req) + + Expect(err).To(MatchError("missing parameter: 'username'")) + Expect(response).To(BeNil()) + }) + + It("should return error when user context is missing", func() { + req := httptest.NewRequest("GET", "/rest/getUser?username=testuser", nil) + + response, err := router.GetUser(req) + + Expect(err).To(HaveOccurred()) + Expect(response).To(BeNil()) + + var subErr subError + ok := errors.As(err, &subErr) + Expect(ok).To(BeTrue()) + Expect(subErr.code).To(Equal(responses.ErrorGeneric)) + }) + }) +}) diff --git a/server/testdata/test_cert.pem b/server/testdata/test_cert.pem new file mode 100644 index 000000000..1dfa573d6 --- /dev/null +++ b/server/testdata/test_cert.pem @@ -0,0 +1,23 @@ +-----BEGIN CERTIFICATE----- +MIIDwzCCAqugAwIBAgIUXqdUxUOo8kmsDe71iTR+Vr7btP8wDQYJKoZIhvcNAQEL +BQAwYjELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFRlc3QxDTALBgNVBAcMBFRlc3Qx +EjAQBgNVBAoMCU5hdmlkcm9tZTENMAsGA1UECwwEVGVzdDESMBAGA1UEAwwJbG9j +YWxob3N0MCAXDTI1MTEyODE5NTkxNVoYDzIxMjUxMTA0MTk1OTE1WjBiMQswCQYD +VQQGEwJVUzENMAsGA1UECAwEVGVzdDENMAsGA1UEBwwEVGVzdDESMBAGA1UECgwJ +TmF2aWRyb21lMQ0wCwYDVQQLDARUZXN0MRIwEAYDVQQDDAlsb2NhbGhvc3QwggEi +MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCkB/TQgl5ei5KRSHt5OJim8rKS +MzRlkK4BjSEM4D9ESbebdpEVjX48QuBYACrCvgvVp7mQGF5anl8Hm89trvd8ooVQ +x9IPQQ6gRKM+4gLrt9FHvFGGzZQS8UTQXN5oBi11E+8/Vs47HLUNXC2TRtRLCMyK +LYXQIXbhdp9anImlt+IHUxIQUchK6Zkld/gCm56X1bbzN/Zq91PQLpx2FZ0eZTjN +KaNgztLa+K/BDnTuk3iTTs9GEp6VCvqQE/6fk/UN/tkk2dLwKIFvPVR/YeAhVdz/ +OHC4L3B36QN3+VQ2yDjsp1PVAPX07UnzXO3Oj7uGYnMQxwprGMEubm3nADDxAgMB +AAGjbzBtMB0GA1UdDgQWBBRAZHUVuLyzc0CfuZR9ApqMbawIqzAfBgNVHSMEGDAW +gBRAZHUVuLyzc0CfuZR9ApqMbawIqzAPBgNVHRMBAf8EBTADAQH/MBoGA1UdEQQT +MBGCCWxvY2FsaG9zdIcEfwAAATANBgkqhkiG9w0BAQsFAAOCAQEAmDLXcPx9LNHs +GxQIE6Q5BXbVO7c8qrWmJf5FK5VWaifNZ9U+IBi+VlB4jCLK/OkwsviN/jOnwRYx +owjq0QG0YdRT4uD9fEMrAj+EwbnrQYZQvT0yGEWA+KW5TW08wt+/qnGJDwEgbjYJ +HTdICVMhs/e8Ex48fAgO8WSsdTDekOrhuwzIfeJ1LU4ZptLsD2ePFxuzutdIuW51 +/mspQGsjXqZ1qnLsavLXh/lds2g602rTpYBNZVjV9WiOvaQS8vviOxBN6f+9vgRz +a8SEbHqBG6jeyVqVZ7MjxcYxaIkxeBwMyMwgb+wwDfVXo2FZzX2TVeB7ZppI+IKv +TXYurWPYsQ== +-----END CERTIFICATE----- diff --git a/server/testdata/test_cert_encrypted.pem b/server/testdata/test_cert_encrypted.pem new file mode 100644 index 000000000..6f8de623a --- /dev/null +++ b/server/testdata/test_cert_encrypted.pem @@ -0,0 +1,22 @@ +-----BEGIN CERTIFICATE----- +MIIDpzCCAo+gAwIBAgIUEa7gEJYwJqYEJjTY7otQ+oUyELwwDQYJKoZIhvcNAQEL +BQAwYjELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFRlc3QxDTALBgNVBAcMBFRlc3Qx +EjAQBgNVBAoMCU5hdmlkcm9tZTENMAsGA1UECwwEVGVzdDESMBAGA1UEAwwJbG9j +YWxob3N0MCAXDTI1MTEyODE5NTI0OVoYDzIxMjUxMTA0MTk1MjQ5WjBiMQswCQYD +VQQGEwJVUzENMAsGA1UECAwEVGVzdDENMAsGA1UEBwwEVGVzdDESMBAGA1UECgwJ +TmF2aWRyb21lMQ0wCwYDVQQLDARUZXN0MRIwEAYDVQQDDAlsb2NhbGhvc3QwggEi +MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDBHgqJ1d9EnNxqoSZ6xXrIz/mV +Y0nWJW16/qIAvCdovSeTZhG9iqG8dUqcuu2BdD9MMHndJ2oFn3iD8EJR92dH8KBA +8xOmtZ0BEEWgXPBivywZVd1ChIflEWj6m5wwLNjb57SPpUiwaLxBQB8ByEaAAZE/ +bLqvHI3vW/4s5apky17SPIqmkmqEYlRcg97tlRXsPuwoAVM9cvLMMEqtIR1CB/72 +gboY2Gi2r/plLF/Rg3Dom6QljMWi57XXWJFwGYSXaZuM0gvn04e3oLu+1E+WMoq/ +9rExWij2DlsmXd/RiScliFp6R4H84wQUyqrAUNytvgRO+oVnRjEA0l3oCYdRAgMB +AAGjUzBRMB0GA1UdDgQWBBQQKpB1UaKm98FnBdl8uKdRscrVTzAfBgNVHSMEGDAW +gBQQKpB1UaKm98FnBdl8uKdRscrVTzAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3 +DQEBCwUAA4IBAQBP07l+2LmpFtcxqMGmsiNYwFuHpQCxJd4YRZHjLX7O+oJExMgR +2yP4mpMKurgKOv7unTDLwvjQRa6ZTYJCsYtvC6hbyqlGc7AfNTu6DKz8r35/2/V5 +hPsG5lNb91HhvHE839mLAvpi02LoFH2Sr8BR7s6qxfNKYcP8PUOJQXltJ6yAa8YJ +syeXQQ3RIyGsJANeaC06S3UdkBM5H5BLfIHnHu3GybJjwL51va4WCdHe8QV6GI0g +RDiThDVkBSXAr136vnMdlrYCxMoxY56itJ0zbYg2ELQKU9o1w/ZJQo9uvmy9jCoZ +Hy1L5a2vUDbsdONdvRkYZRHqMpG4bdD8D3j2 +-----END CERTIFICATE----- diff --git a/server/testdata/test_key.pem b/server/testdata/test_key.pem new file mode 100644 index 000000000..bac61f4a4 --- /dev/null +++ b/server/testdata/test_key.pem @@ -0,0 +1,28 @@ +-----BEGIN PRIVATE KEY----- +MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCkB/TQgl5ei5KR +SHt5OJim8rKSMzRlkK4BjSEM4D9ESbebdpEVjX48QuBYACrCvgvVp7mQGF5anl8H +m89trvd8ooVQx9IPQQ6gRKM+4gLrt9FHvFGGzZQS8UTQXN5oBi11E+8/Vs47HLUN +XC2TRtRLCMyKLYXQIXbhdp9anImlt+IHUxIQUchK6Zkld/gCm56X1bbzN/Zq91PQ +Lpx2FZ0eZTjNKaNgztLa+K/BDnTuk3iTTs9GEp6VCvqQE/6fk/UN/tkk2dLwKIFv +PVR/YeAhVdz/OHC4L3B36QN3+VQ2yDjsp1PVAPX07UnzXO3Oj7uGYnMQxwprGMEu +bm3nADDxAgMBAAECggEABqJFvesP2v4FEvgd+kSWM+ZL34rPmy3zQ5/MDuPA20ep +89EjQ/5hdRl1TknPcOnTu7PZVuENa9fM2xdrl7GEU9eU0bQLJE/KwiOUgJYObS8V +eTO+DlghHXUBhfXDjux1CS+htOuTUqOyFNS+CR9Lta8o6ou1xjmcP7kW78i17mxF +TuH5SZlS8W9PFLXHCInbMtqGFaT2ss09kvoPk2FDvHfxEdy6M9tKkguz02g+4bqI +aAMp2N7AOfmRpC0HvVa1ZfZo5Z8/KMoNcIm3pV9DEVM369J9EzhnMNpkGben90aT +FqO2JNsy52wmXFZUc9xe8uPdfDahALCkBGncLyLNmQKBgQDZREjocjdzOoPSlCdx +mRNe9suHz2FpUpsHCPOCotG63hFVKpah/ZvpHSsQx5rXs/mawDTmzGY9GQiBrSvg +OhfHIyT3NOhVaNcMxTqJX7rs7OG8D0MBacD9ASSeZ89MUn8q1EHZr5qxLtXl5Ikw +mHtiGRdiKGFFrG9H0zncbGhy7QKBgQDBRhQ9RAasTdmUiNQly9GVFkXto4T/9UHx +rVU44htCI2IVZUMTGlNfclfxpByDrzyA56rMzN9SAkiIp4nPpMDs5hayXaaPoojs +CPzV7r2OjemZ6CTeQ1ODImRL8L/E3jJSgWd6YYoHSQ5hjEX4yT6ft0u0tZUfdMKd +VENWIJ/hlQKBgQCo2hXjeOi5R8+tN3EUKwhP9HOnX7dv+D/9jqpZa5qdpPpJeyjI +SmYCHKYci1Q+sWOaLiiu+km20B65UVFZGSzjmd+fs+GghzMifKGKo/iNK2ggFKhZ +j8vplRrVdQ45XZ/xNDbdLEmHzEN2QE+Skd7KFYADzCgU0vdFFdbRBPuD3QKBgGIq +fQctMRJ9LCE0akSURGwr9vKflmMHKCpfdqTAu0WZgS0K1Mm0GlqlUiPKzizYaauz +f14sRNV7kWnPZsDPlqn8p9SKmpnj3RW97uWeMCtiyx6/+VHm8ljts/GaY1zT2s1r +KqrPNfNDWQmU3MljNeqbh9lOTWK/xEVy0gzB31MNAoGAQNWrZvVdAbL95XW6STUu +JmQlqJTlluuqS0Rrd/uVEQwW0Vd1dZjRQcFAFiSiCQWTbtId5gFZd6hiIQl53Xz0 +5cd+9mcyA/TaoCJYbMOFYsKbZMCBhefsovJlVQXedqJrIY6BdeGlet4GTAH5Qyl0 +ytEIUnvn5YmmbI7PDz80XpU= +-----END PRIVATE KEY----- diff --git a/server/testdata/test_key_encrypted.pem b/server/testdata/test_key_encrypted.pem new file mode 100644 index 000000000..0ac715890 --- /dev/null +++ b/server/testdata/test_key_encrypted.pem @@ -0,0 +1,30 @@ +-----BEGIN ENCRYPTED PRIVATE KEY----- +MIIFNTBfBgkqhkiG9w0BBQ0wUjAxBgkqhkiG9w0BBQwwJAQQPH9PYzryCI3smm81 +J8rm+QICCAAwDAYIKoZIhvcNAgkFADAdBglghkgBZQMEASoEEI+9XxNfKSiMYIVB +UfcGfncEggTQVw7tPslGy3mlofCNnhBSnMViv9kj6M11smD6Y8vHG0k9Kq+6g+Dx +mQE9ILrSZBzM0uS3y484u+vkdqlT4KehhjIx0IiezurOcM45UdTAwLFLPzeEDlHI +lOWQ3gOTB3J5AxiUQOa6QsDIM7AZilidQG0BxQYWyRBA5B8evJwJoAvdzzA9wGSm +2YdNm3tA6rU5U8cVG+qTJP9pjbtRx0medC/CBZdxGkrWBQH+aySfahJdU8X1JI2e +SY4WJRw1rLCow+DnHjZS/IVHFJivJSRYvnvw8fwjOMVtkf+dAVctKlb1Fj9X+RdG +T1sq3i6zwFLE/RRz4qM4DKZ6UaD9wRFLow8FmNWVuJJiPgCLx2rrNMe32quS/kQP +iOsXAUeA/Yg1fdMCJORxl0nWDmLYcNtBghCmS1lyk+t+AKWwJudrds5tQQe8ha2t +Q41is+tDKwGDC1wt4WXJvBhgAJzuqFtr30H0M1eBhwwDdaDd9v0Zr3r8V49WZM2c +i3qkwPPYkQD+pOcR12xBV8ptvDxaUl7RGlVqnEWHagT51BaIaXQ9teUrG6UPt8o2 +LELJXF6CiwkbN6Y9sYx5XiKrIGxVhlQSZ1nB3XSFRHbu6e7VHPjnVwUeeg87J2Am +MEwqDzPU5sjKRn84+M91Y4uFAIeinaOJAQ0/tZVrf1iSeCMQyMUhW/8m7JPfG19F +NbJSPRXQuKmYKbWfXcMW2UFbp0zDs7s7p4zzbfde9IbVdq/o2nv3ZrNbrLak6O7y +FVt9q/xG4Tty6hSK6xtqtNZWcmfiMcTlk1Qcz2STvScbXtqgcgR6WUZfkLuzi09I +EDYFnzU5JNSY3U3VTv2hAPeU4xjTNM6kjF7L9JFGvdjH8Ko9UdxG9RZMd8xhBM/n +hxdzdVba4bDDz2z+0A2blSObrPrNsKr/3ZbnfuUiSs5NmqmUOifZ1t1PqGGO2Y5S +/cDKtrPk226hGomsUBfHtiIJPG1VRl4UaZiduqK3GGhtF491KU1mAfYzueok3TPq +JhLtLDIvEaFgmOmitFzROI/ifm6s4ssUvcvtbjwJumbjkU38OxYZFwbhwbe268G2 +vgspJamlEGJNdGDzrCFQlA2+A9kazCttztikfh5QGV6WFfkc3Bt1XTPL51vtliQy +MS2gUnJUY2fuYCfz8rxLH1kQmyYsHQz5rUYyBkeDffrG9MzarmzSJXR63FRzVMf1 +LQ7BSzei7dF6+J4KVCxjbGWF3GUGmGeOP5g5vJ3xb3YPJNJLT4Vai103pay59TGP +tESM2Vn0gJEvYApi707noFH5uFTW1cp7lloF41ddIUkL/QO7j+sjvBww+4DqBB7J +BmvLMnswa23yw9egYRG5jOXyCgIr+1rnNcph1HGJsvxvgJ2gwwo5NKCG8SC6LcZQ +fbDjX+ssmobLE3ktN03FZPMp32/ciexzuZoamfyiPXh7xE++ckifNEKJlNhx+kCG +mSR2wh+UGigQkgp/JxOzl6C4fhUbrEZr17oBqGim2p8h+GE0zD5JSHcn1rP86gGU +8JG/ilG4I8uMxUwhGj7amrWXUlJBd1by7e1EAL+utCo14/Tx3otB9/JtqY+lm9Ey +1ptPhMRQxvDNWrCmYM2kyrGghdNfEMir6GKDWI6PY9cwAFv/PLOxr1c= +-----END ENCRYPTED PRIVATE KEY----- diff --git a/server/testdata/test_key_encrypted_legacy.pem b/server/testdata/test_key_encrypted_legacy.pem new file mode 100644 index 000000000..4b9215cdf --- /dev/null +++ b/server/testdata/test_key_encrypted_legacy.pem @@ -0,0 +1,30 @@ +-----BEGIN RSA PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: AES-256-CBC,3C969050EAB73F121B7F0E6B75C42525 + +V6pSaAsrn9CQNo4p88QshJLbg8zkQJEom81dPbYSVqQSZa9YlPtpLZ9YtuLj/Ay0 +TScEKIj/gzQ32wNl6nhcSNIL9yy+X11r5gNv1kIHkecf+EbDW20VOiJsfD+6LUyW +hA96AIbPOwc76iCuvsKHPKU9MlEmjGipmk/C2RQLHCZJ3WkiDRgCM8KQ7vKhfACT +w908yj4cB1e/P0JPq8t/3F7kPJ+6SVM1vMEffHl0otQR3rAyrK8QikwJ0K9qX62d +cqchTVlEyyZBYovR8DrRRUDbsXS5j1ZmX3NQpvTSTFowr+33fMrY+4Oz8sdR4yx1 +CQc0A0sHHxSEIr2xu4KzczwOYVJN8PVdU0pgvFj9KEm66N6EY5CSFIBHyO/ycOt9 +U+wpkRjf3zS6ZaUU0NKdOcop4YX33i99/tZF2RNR1i7ETLYph+/LCf09286Bi3u/ +UCCuWedyECPdz0c6j0s27Fdfc/HEK90OEzeWh/fc+H2gJZhqJYK9V47HPTQNNMnB +U1a6FsJlrKE3E6nfSnTLxrSx9m/XTV7HV+HkgX+q8VhN7Q2VHUqkPzE7ZOPYpZ+A +dQzsm1TmEMxym6osYqFzQScXR1NZasrV2MTQ2J16dUgCdGAM2YMUD9JaoJR+u77M +WAjYzDiRg84rLr/KbJPAwHbsfo2KpiapJGSBBEDhz4W1/LOrFhsjaqIMSy4yZDGm +1KqXGHIlqmuHI7v4fD8vuzhj7GUujRx85HSZWakE/uc6s5WrhkSeVKYJWPfpsxTv +dT3oLOGJ+nRzWxM3aFtuJghX0nIGdKxT4EAUNXz0/vLT3OP1QCZR+oELrriFzmtj ++O30bGH2SAFZEQJ/uTQg6celoNh89IzH4DJkcn67hqpX6mUiU9CrIr/eR9C/en8Q +smTbbC1C1pDUaCwR26Z+zgM90amh4yfOFKK2geO2Kj+TmwFHUvi6ZnSzMzCvty3t ++wdIrUtf55Lw51JCpLGl70mg4b/zBj5hqBkU2YvAAnz/htjfH/wrD6ZAF1TCdlRO +gyODrJjGRnLd/v0XLk0wp+RkAjBcSlRlkUvZY5BtugL7dIdwiNGGQPcOni9IVeG0 +6vDUEQnDOLYDj4d/JcckTLuHdrP+SW+0RQl2HK5+/w1hScGXN4O48gccu7yR/MN8 +DmpCg5rD/nq8sxJosmSt07GrN36KppYt8LCXQbSg3NG2Ad715caS2C+0Qtdm5MPD +rM1UyTXQYSJXgUN9yZS/pmzlguCywnnvsBPU6j3ljZwcoD41QJ/1OU09/W6sIMQR +IAiM35JHiLJiccFgxSE1qx5F1UZqX4P47jF0Wzi/sE/DYXg5qw2DoauqXNzqnumH +71UDGK1V6wQIV7UCZDa0WUfFzu470XpuFb8VmMOuHSQxkZESc9cz8k/ueAuO438Q +jnlkF1Ge2EEPuaK2zeaTj/lGyYA1AUfHRRgt/EMUQSBntmhlpnwVPYTVvYtHO2N5 +wp7/y39KirnlTl99i3XiOJ4WF4gIU2IaSlqMo4+e/A32h2JFi9QfNyfItXe6Fm1X +d0j2XGHzwMfHEFKdWyrgtVZwc38/1d6xWYAhs02b2basV/0AQhFTaKf5Z268eBNJ +-----END RSA PRIVATE KEY----- diff --git a/server/throttle_backlog.go b/server/throttle_backlog.go new file mode 100644 index 000000000..0d31d289e --- /dev/null +++ b/server/throttle_backlog.go @@ -0,0 +1,149 @@ +package server + +import ( + "bytes" + "context" + "errors" + "maps" + "net/http" + "sync" + "time" + + "github.com/go-chi/chi/v5/middleware" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/log" +) + +var ( + ErrThrottleCapacityExceeded = errors.New("throttle: capacity exceeded") + ErrThrottleTimeout = errors.New("throttle: backlog timeout") +) + +type requestThrottle struct { + tokens chan struct{} + backlogTokens chan struct{} + backlogTimeout time.Duration +} + +// ThrottleBacklog creates a Chi-compatible middleware that limits concurrent +// request processing. Unlike Chi's ThrottleBacklog, it buffers the handler's +// response while holding the token, releases it, then flushes the buffer to +// the client with a write deadline. This prevents slow clients from holding +// throttle capacity. +// +// Because it buffers the entire response in memory, this middleware should only +// be used for endpoints that return small responses (e.g., artwork images). Do +// not use it for audio streaming or download endpoints. +func ThrottleBacklog(limit, backlogLimit int, backlogTimeout time.Duration) func(http.Handler) http.Handler { + if limit <= 0 { + return func(next http.Handler) http.Handler { return next } + } + if !conf.Server.DevArtworkThrottleBuffered { + return middleware.ThrottleBacklog(limit, backlogLimit, backlogTimeout) + } + t := &requestThrottle{ + tokens: make(chan struct{}, limit), + backlogTokens: make(chan struct{}, limit+backlogLimit), + backlogTimeout: backlogTimeout, + } + for range limit { + t.tokens <- struct{}{} + } + for range limit + backlogLimit { + t.backlogTokens <- struct{}{} + } + return t.handler +} + +func (t *requestThrottle) handler(next http.Handler) http.Handler { + return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + ctx := r.Context() + + release, err := t.acquire(ctx) + if err != nil { + switch { + case errors.Is(err, ErrThrottleCapacityExceeded): + log.Warn(ctx, "Request throttle capacity exceeded", "path", r.URL.Path) + case errors.Is(err, ErrThrottleTimeout): + log.Warn(ctx, "Request throttle backlog timeout", "path", r.URL.Path) + } + http.Error(w, http.StatusText(http.StatusTooManyRequests), http.StatusTooManyRequests) + return + } + + buf := &bufferedResponseWriter{header: make(http.Header)} + func() { + defer release() + next.ServeHTTP(buf, r) + }() + + maps.Copy(w.Header(), buf.header) + if buf.code > 0 { + w.WriteHeader(buf.code) + } + if _, err := w.Write(buf.body.Bytes()); err != nil { + log.Warn(ctx, "Error writing throttled response", err) + } + }) +} + +func (t *requestThrottle) acquire(ctx context.Context) (release func(), err error) { + select { + case <-ctx.Done(): + return nil, ctx.Err() + case <-t.backlogTokens: + default: + return nil, ErrThrottleCapacityExceeded + } + + select { + case <-t.tokens: + return t.releaseFunc(), nil + default: + } + + timer := time.NewTimer(t.backlogTimeout) + select { + case <-timer.C: + t.backlogTokens <- struct{}{} + return nil, ErrThrottleTimeout + case <-ctx.Done(): + timer.Stop() + t.backlogTokens <- struct{}{} + return nil, ctx.Err() + case <-t.tokens: + timer.Stop() + return t.releaseFunc(), nil + } +} + +func (t *requestThrottle) releaseFunc() func() { + var once sync.Once + return func() { + once.Do(func() { + t.tokens <- struct{}{} + t.backlogTokens <- struct{}{} + }) + } +} + +type bufferedResponseWriter struct { + header http.Header + body bytes.Buffer + code int +} + +func (w *bufferedResponseWriter) Header() http.Header { + return w.header +} + +func (w *bufferedResponseWriter) Write(b []byte) (int, error) { + return w.body.Write(b) +} + +func (w *bufferedResponseWriter) WriteHeader(code int) { + if w.code != 0 { + return + } + w.code = code +} diff --git a/server/throttle_backlog_test.go b/server/throttle_backlog_test.go new file mode 100644 index 000000000..4d8567db5 --- /dev/null +++ b/server/throttle_backlog_test.go @@ -0,0 +1,266 @@ +package server + +import ( + "bytes" + "io" + "net/http" + "net/http/httptest" + "strings" + "sync" + "sync/atomic" + "time" + + "github.com/go-chi/chi/v5" + "github.com/go-chi/chi/v5/middleware" + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("ThrottleBacklog", func() { + It("is a passthrough when limit is 0", func() { + m := ThrottleBacklog(0, 10, time.Second) + r := chi.NewRouter() + r.Use(m) + r.Get("/test", func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("ok")) + }) + + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + r.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Body.String()).To(Equal("ok")) + }) + + It("returns 429 when capacity is exceeded", func() { + _, secondStatus := runTwoRequests(ThrottleBacklog(1, 0, time.Second)) + Expect(secondStatus).To(Equal(http.StatusTooManyRequests)) + }) + + It("returns 429 when backlog times out", func() { + _, secondStatus := runTwoRequests(ThrottleBacklog(1, 1, 50*time.Millisecond)) + Expect(secondStatus).To(Equal(http.StatusTooManyRequests)) + }) + + It("releases capacity when the handler panics", func() { + m := ThrottleBacklog(1, 0, time.Second) + r := chi.NewRouter() + r.Use(middleware.Recoverer) + r.Use(m) + r.Get("/panic", func(w http.ResponseWriter, r *http.Request) { + panic("boom") + }) + r.Get("/test", func(w http.ResponseWriter, r *http.Request) { + _, _ = w.Write([]byte("ok")) + }) + + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/panic", nil) + r.ServeHTTP(w, req) + Expect(w.Code).To(Equal(http.StatusInternalServerError)) + + w = httptest.NewRecorder() + req, _ = http.NewRequest("GET", "/test", nil) + r.ServeHTTP(w, req) + Expect(w.Code).To(Equal(http.StatusOK)) + Expect(w.Body.String()).To(Equal("ok")) + }) + + It("preserves response headers and status code", func() { + m := ThrottleBacklog(2, 0, time.Second) + r := chi.NewRouter() + r.Use(m) + r.Get("/test", func(w http.ResponseWriter, r *http.Request) { + w.Header().Set("Content-Type", "image/jpeg") + w.Header().Set("Cache-Control", "public") + w.WriteHeader(http.StatusCreated) + _, _ = w.Write([]byte("body")) + }) + + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + r.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusCreated)) + Expect(w.Header().Get("Content-Type")).To(Equal("image/jpeg")) + Expect(w.Header().Get("Cache-Control")).To(Equal("public")) + Expect(w.Body.String()).To(Equal("body")) + }) + + It("uses the first response status code", func() { + m := ThrottleBacklog(2, 0, time.Second) + r := chi.NewRouter() + r.Use(m) + r.Get("/test", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusCreated) + w.WriteHeader(http.StatusAccepted) + _, _ = w.Write([]byte("body")) + }) + + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + r.ServeHTTP(w, req) + + Expect(w.Code).To(Equal(http.StatusCreated)) + Expect(w.Body.String()).To(Equal("body")) + }) + + It("never exceeds the concurrency limit", func() { + const limit = 3 + const goroutines = 20 + m := ThrottleBacklog(limit, goroutines, 5*time.Second) + + var concurrent atomic.Int32 + var maxConcurrent atomic.Int32 + + r := chi.NewRouter() + r.Use(m) + r.Get("/test", func(w http.ResponseWriter, r *http.Request) { + cur := concurrent.Add(1) + for { + old := maxConcurrent.Load() + if cur <= old || maxConcurrent.CompareAndSwap(old, cur) { + break + } + } + time.Sleep(5 * time.Millisecond) + concurrent.Add(-1) + _, _ = w.Write([]byte("ok")) + }) + + var wg sync.WaitGroup + for range goroutines { + wg.Go(func() { + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + r.ServeHTTP(w, req) + }) + } + + wg.Wait() + Expect(maxConcurrent.Load()).To(BeNumerically("<=", limit)) + }) + + // Regression: with only 1 token, a slow client blocking during response + // writing must NOT prevent other requests from being served. Chi's original + // ThrottleBacklog holds the token for the entire handler lifecycle including + // io.Copy, causing starvation. The buffered implementation releases it first. + Context("when a client is slow to read the response", func() { + slowClientTest := func(m func(http.Handler) http.Handler) (*chi.Mux, chan struct{}, chan struct{}) { + handlerReached := make(chan struct{}, 1) + router := chi.NewRouter() + router.Use(m) + router.Get("/test", func(w http.ResponseWriter, r *http.Request) { + select { + case handlerReached <- struct{}{}: + default: + } + _, _ = io.Copy(w, strings.NewReader("image data")) + }) + + unblocked := make(chan struct{}) + slow := newSlowTestWriter(unblocked) + + reqDone := make(chan struct{}) + go func() { + defer close(reqDone) + req, _ := http.NewRequest("GET", "/test", nil) + router.ServeHTTP(slow, req) + }() + <-handlerReached + + return router, unblocked, reqDone + } + + It("does not starve concurrent requests with buffered middleware", func() { + router, unblocked, reqDone := slowClientTest(ThrottleBacklog(1, 1, 500*time.Millisecond)) + + Eventually(func() int { + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + router.ServeHTTP(w, req) + return w.Code + }, 2*time.Second, 10*time.Millisecond).Should(Equal(http.StatusOK)) + + close(unblocked) + Eventually(reqDone, 2*time.Second).Should(BeClosed()) + }) + + It("starves concurrent requests with Chi's original middleware", func() { + DeferCleanup(configtest.SetupConfig()) + conf.Server.DevArtworkThrottleBuffered = false + + router, unblocked, reqDone := slowClientTest(ThrottleBacklog(1, 1, 500*time.Millisecond)) + + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + router.ServeHTTP(w, req) + Expect(w.Code).To(Equal(http.StatusTooManyRequests)) + + close(unblocked) + Eventually(reqDone, 2*time.Second).Should(BeClosed()) + }) + }) +}) + +// runTwoRequests sends two concurrent requests through a throttled router. The +// first request holds the token until the second has been dispatched. +func runTwoRequests(m func(http.Handler) http.Handler) (firstStatus, secondStatus int) { + held := make(chan struct{}, 1) + release := make(chan struct{}) + r := chi.NewRouter() + r.Use(m) + r.Get("/test", func(w http.ResponseWriter, r *http.Request) { + select { + case held <- struct{}{}: + default: + } + <-release + _, _ = w.Write([]byte("ok")) + }) + + done := make(chan int) + go func() { + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + r.ServeHTTP(w, req) + done <- w.Code + }() + <-held + + w := httptest.NewRecorder() + req, _ := http.NewRequest("GET", "/test", nil) + r.ServeHTTP(w, req) + secondStatus = w.Code + + close(release) + firstStatus = <-done + return firstStatus, secondStatus +} + +// slowTestWriter implements http.ResponseWriter without embedding +// httptest.ResponseRecorder. This is necessary because ResponseRecorder +// promotes io.ReaderFrom, which io.Copy prefers over Write — bypassing +// our blocking Write and defeating the slow-client simulation. +type slowTestWriter struct { + header http.Header + body bytes.Buffer + code int + unblocked chan struct{} +} + +func newSlowTestWriter(unblocked chan struct{}) *slowTestWriter { + return &slowTestWriter{header: make(http.Header), unblocked: unblocked} +} + +func (w *slowTestWriter) Header() http.Header { return w.header } + +func (w *slowTestWriter) WriteHeader(code int) { w.code = code } + +func (w *slowTestWriter) Write(p []byte) (int, error) { + <-w.unblocked + return w.body.Write(p) +} diff --git a/tests/fixtures/01 Invisible (RED) Edit Version.m4a b/tests/fixtures/01 Invisible (RED) Edit Version.m4a index 005792eb5..76b61a2d4 100644 Binary files a/tests/fixtures/01 Invisible (RED) Edit Version.m4a and b/tests/fixtures/01 Invisible (RED) Edit Version.m4a differ diff --git a/tests/fixtures/bom-test.lrc b/tests/fixtures/bom-test.lrc new file mode 100644 index 000000000..223c37de0 --- /dev/null +++ b/tests/fixtures/bom-test.lrc @@ -0,0 +1,4 @@ +[00:00.00] 作曲 : 柏大輔 +NOTE: This file intentionally contains a UTF-8 BOM (Byte Order Mark) at byte 0. +This tests BOM handling in lyrics parsing (GitHub issue #4631). +The BOM bytes are: 0xEF 0xBB 0xBF \ No newline at end of file diff --git a/tests/fixtures/bom-utf16-test.lrc b/tests/fixtures/bom-utf16-test.lrc new file mode 100644 index 000000000..e40ea3255 Binary files /dev/null and b/tests/fixtures/bom-utf16-test.lrc differ diff --git a/tests/fixtures/deezer.artist.bio.empty.json b/tests/fixtures/deezer.artist.bio.empty.json new file mode 100644 index 000000000..8bc0f6932 --- /dev/null +++ b/tests/fixtures/deezer.artist.bio.empty.json @@ -0,0 +1,10 @@ +{ + "data": { + "artist": { + "bio": null + } + }, + "extensions": { + "queryCost": 3 + } +} diff --git a/tests/fixtures/deezer.artist.bio.en.json b/tests/fixtures/deezer.artist.bio.en.json new file mode 100644 index 000000000..a1b838aa4 --- /dev/null +++ b/tests/fixtures/deezer.artist.bio.en.json @@ -0,0 +1,12 @@ +{ + "data": { + "artist": { + "bio": { + "full": "<p>Schoolmates Thomas and Guy-Manuel began their career in 1992 with the indie rock trio Darlin' (named after The Beach Boys song) but were scathingly dismissed by Melody Maker magazine as \"daft punk.\" Turning to house-inspired electronica, they used the put down as a name for their DJ-ing partnership and became a hugely successful and influential dance act. First major single <em>\"Da Funk\"</em> was accompanied by a Spike Jonze-directed video and more success followed with global dance floor anthem <em>\"Around the World,\" \"One More Time,\"</em> and <em>\"Harder, Faster, Better, Stronger\"</em> - which was sampled by Kanye West for his hit <em>\"Stronger.\"</em> Albums <em>Homework</em> (1997), <em>Discovery</em> (2001) and <em>Human After All</em> (2005) all made the UK Top 10 establishing a style of simple, Chicago house-inspired grooves exploding into a robotic, rave sound.</p>" + } + } + }, + "extensions": { + "queryCost": 3 + } +} diff --git a/tests/fixtures/deezer.artist.bio.fr.json b/tests/fixtures/deezer.artist.bio.fr.json new file mode 100644 index 000000000..435f6fcf0 --- /dev/null +++ b/tests/fixtures/deezer.artist.bio.fr.json @@ -0,0 +1,12 @@ +{ + "data": { + "artist": { + "bio": { + "full": "Guy-Manuel de Homem Christo et Thomas Bangalter se rencontrent en 1987 au lycée Carnot de Paris. Partageant une même passion pour la musique, les deux amis fondent en 1992 Darlin', un groupe de rock influencé par les Stooges et MC5, dont la production sera taxée par un critique de la presse anglaise de «daft punk» (« punk idiot »). <br />\n<br />\nDécouragés face à l'apathie du milieu rock, ils décident un peu plus tard de se lancer à corps perdus dans le courant Techno alors en pleine explosion. Arrive alors la découverte de la House, des clubs et des raves, dont une en particulier qui déterminera leur avenir : en 1993 est organisé à EuroDisney une rave où notre duo rencontre les dirigeants du label techno écossais Soma." + } + } + }, + "extensions": { + "queryCost": 3 + } +} diff --git a/tests/fixtures/deezer.artist.related.json b/tests/fixtures/deezer.artist.related.json new file mode 100644 index 000000000..2a55b303e --- /dev/null +++ b/tests/fixtures/deezer.artist.related.json @@ -0,0 +1 @@ +{"data":[{"id":6404,"name":"Justice","link":"https:\/\/www.deezer.com\/artist\/6404","picture":"https:\/\/api.deezer.com\/artist\/6404\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e5bf29cb99852f92a0079b184ace9479\/1000x1000-000000-80-0-0.jpg","nb_album":41,"nb_fan":774236,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/6404\/top?limit=50","type":"artist"},{"id":2049,"name":"Cassius","link":"https:\/\/www.deezer.com\/artist\/2049","picture":"https:\/\/api.deezer.com\/artist\/2049\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/7ed91fa11a9785a82e63fd9058821d8a\/1000x1000-000000-80-0-0.jpg","nb_album":25,"nb_fan":127692,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2049\/top?limit=50","type":"artist"},{"id":2318,"name":"Etienne de Cr\u00e9cy","link":"https:\/\/www.deezer.com\/artist\/2318","picture":"https:\/\/api.deezer.com\/artist\/2318\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/b9efa1b51be3c2a506006a77517967f7\/1000x1000-000000-80-0-0.jpg","nb_album":58,"nb_fan":104626,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2318\/top?limit=50","type":"artist"},{"id":72041,"name":"Yuksek","link":"https:\/\/www.deezer.com\/artist\/72041","picture":"https:\/\/api.deezer.com\/artist\/72041\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5e0fd4c6b670682861abcc825eb3db50\/1000x1000-000000-80-0-0.jpg","nb_album":102,"nb_fan":115772,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/72041\/top?limit=50","type":"artist"},{"id":81,"name":"The Chemical Brothers","link":"https:\/\/www.deezer.com\/artist\/81","picture":"https:\/\/api.deezer.com\/artist\/81\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/5294e68e9ef4f0359237935a4b8388f2\/1000x1000-000000-80-0-0.jpg","nb_album":83,"nb_fan":1433333,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/81\/top?limit=50","type":"artist"},{"id":3771,"name":"Mr. Oizo","link":"https:\/\/www.deezer.com\/artist\/3771","picture":"https:\/\/api.deezer.com\/artist\/3771\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/589305cb56ea3555b1f94341955bf875\/1000x1000-000000-80-0-0.jpg","nb_album":31,"nb_fan":172085,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/3771\/top?limit=50","type":"artist"},{"id":9905,"name":"Alex Gopher","link":"https:\/\/www.deezer.com\/artist\/9905","picture":"https:\/\/api.deezer.com\/artist\/9905\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c4676bdbf3259decd69491523a1ace8f\/1000x1000-000000-80-0-0.jpg","nb_album":46,"nb_fan":10430,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/9905\/top?limit=50","type":"artist"},{"id":7914,"name":"Demon","link":"https:\/\/www.deezer.com\/artist\/7914","picture":"https:\/\/api.deezer.com\/artist\/7914\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c7c1f4d1f1cf6bdf04a6fc54ea65ef78\/1000x1000-000000-80-0-0.jpg","nb_album":21,"nb_fan":9286,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/7914\/top?limit=50","type":"artist"},{"id":8937,"name":"SebastiAn","link":"https:\/\/www.deezer.com\/artist\/8937","picture":"https:\/\/api.deezer.com\/artist\/8937\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0151acdea8a8d5f8e3aefabf6f034575\/1000x1000-000000-80-0-0.jpg","nb_album":48,"nb_fan":74884,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/8937\/top?limit=50","type":"artist"},{"id":2508,"name":"Digitalism","link":"https:\/\/www.deezer.com\/artist\/2508","picture":"https:\/\/api.deezer.com\/artist\/2508\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/21e56c7147508853dcdfd9997cd8d271\/1000x1000-000000-80-0-0.jpg","nb_album":79,"nb_fan":158628,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2508\/top?limit=50","type":"artist"},{"id":11703,"name":"Alan Braxe","link":"https:\/\/www.deezer.com\/artist\/11703","picture":"https:\/\/api.deezer.com\/artist\/11703\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0de64f7a63728f09520f987249630d7e\/1000x1000-000000-80-0-0.jpg","nb_album":25,"nb_fan":12595,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/11703\/top?limit=50","type":"artist"},{"id":574,"name":"Para One","link":"https:\/\/www.deezer.com\/artist\/574","picture":"https:\/\/api.deezer.com\/artist\/574\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/2560ff01d72f5e4a768e55892ad066e4\/1000x1000-000000-80-0-0.jpg","nb_album":40,"nb_fan":30828,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/574\/top?limit=50","type":"artist"},{"id":4397,"name":"Kojak","link":"https:\/\/www.deezer.com\/artist\/4397","picture":"https:\/\/api.deezer.com\/artist\/4397\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/817caeb7fa22eb511371ac260680d5fa\/1000x1000-000000-80-0-0.jpg","nb_album":55,"nb_fan":1522,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/4397\/top?limit=50","type":"artist"},{"id":12439,"name":"Busy P","link":"https:\/\/www.deezer.com\/artist\/12439","picture":"https:\/\/api.deezer.com\/artist\/12439\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/6483408c3e46e8fa8872a805dfe6d5e0\/1000x1000-000000-80-0-0.jpg","nb_album":12,"nb_fan":65585,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/12439\/top?limit=50","type":"artist"},{"id":11656979,"name":"Mr Flash","link":"https:\/\/www.deezer.com\/artist\/11656979","picture":"https:\/\/api.deezer.com\/artist\/11656979\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f953922c8caa74c5b48feaa07622b1ee\/1000x1000-000000-80-0-0.jpg","nb_album":7,"nb_fan":769,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/11656979\/top?limit=50","type":"artist"},{"id":76,"name":"Fatboy Slim","link":"https:\/\/www.deezer.com\/artist\/76","picture":"https:\/\/api.deezer.com\/artist\/76\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/f6ea7bd64ec1902feff17935fdfea263\/1000x1000-000000-80-0-0.jpg","nb_album":76,"nb_fan":1231355,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/76\/top?limit=50","type":"artist"},{"id":11265,"name":"Lifelike","link":"https:\/\/www.deezer.com\/artist\/11265","picture":"https:\/\/api.deezer.com\/artist\/11265\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/04f88199a69a646f6253808b58753629\/1000x1000-000000-80-0-0.jpg","nb_album":38,"nb_fan":8316,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/11265\/top?limit=50","type":"artist"},{"id":2048,"name":"Groove Armada","link":"https:\/\/www.deezer.com\/artist\/2048","picture":"https:\/\/api.deezer.com\/artist\/2048\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0acbb71c44e4ecdefd102630f4cfc808\/1000x1000-000000-80-0-0.jpg","nb_album":92,"nb_fan":173879,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/2048\/top?limit=50","type":"artist"},{"id":71708,"name":"Surkin","link":"https:\/\/www.deezer.com\/artist\/71708","picture":"https:\/\/api.deezer.com\/artist\/71708\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/d2137c57fbdc9aa275b93e78b619b477\/1000x1000-000000-80-0-0.jpg","nb_album":15,"nb_fan":23101,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/71708\/top?limit=50","type":"artist"},{"id":166713,"name":"Fred Falke","link":"https:\/\/www.deezer.com\/artist\/166713","picture":"https:\/\/api.deezer.com\/artist\/166713\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/883821e7c5325cfa07fc660884a40624\/1000x1000-000000-80-0-0.jpg","nb_album":67,"nb_fan":9688,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/166713\/top?limit=50","type":"artist"}],"total":20} \ No newline at end of file diff --git a/tests/fixtures/deezer.artist.top.json b/tests/fixtures/deezer.artist.top.json new file mode 100644 index 000000000..e3f22a1aa --- /dev/null +++ b/tests/fixtures/deezer.artist.top.json @@ -0,0 +1 @@ +{"data":[{"id":67238732,"readable":true,"title":"Instant Crush (feat. Julian Casablancas)","title_short":"Instant Crush","title_version":"(feat. Julian Casablancas)","link":"https:\/\/www.deezer.com\/track\/67238732","duration":337,"rank":944042,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/d\/6\/b\/0\/d6bc80aadfa1d7625d59a6620f229371.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/d\/6\/b\/0\/d6bc80aadfa1d7625d59a6620f229371.mp3*~data=user_id=0,application_id=42~hmac=66213cecf953c7ef8b4d89e3539a1355d318679c5ab54cac2007d4effa6c3bf4","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"},{"id":295821,"name":"Julian Casablancas","link":"https:\/\/www.deezer.com\/artist\/295821","share":"https:\/\/www.deezer.com\/artist\/295821?utm_source=deezer&utm_content=artist-295821&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/295821\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/74e78538aefe2a6a49a851e569fc9f19\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/295821\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"311bba0fc112d15f72c8b5a65f0456c1","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":6575789,"title":"Random Access Memories","cover":"https:\/\/api.deezer.com\/album\/6575789\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/1000x1000-000000-80-0-0.jpg","md5_image":"311bba0fc112d15f72c8b5a65f0456c1","tracklist":"https:\/\/api.deezer.com\/album\/6575789\/tracks","type":"album"},"type":"track"},{"id":3135553,"readable":true,"title":"One More Time","title_short":"One More Time","title_version":"","link":"https:\/\/www.deezer.com\/track\/3135553","duration":320,"rank":888570,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/f\/8\/c\/0\/f8c5dc3837912dba37c9a1ab3170cc3f.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/f\/8\/c\/0\/f8c5dc3837912dba37c9a1ab3170cc3f.mp3*~data=user_id=0,application_id=42~hmac=0824ec7ad045b82c04904fcd5f2a8ec2175acbe3d1649030d457023fdef45620","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"5718f7c81c27e0b2417e2a4c45224f8a","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":302127,"title":"Discovery","cover":"https:\/\/api.deezer.com\/album\/302127\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/5718f7c81c27e0b2417e2a4c45224f8a\/1000x1000-000000-80-0-0.jpg","md5_image":"5718f7c81c27e0b2417e2a4c45224f8a","tracklist":"https:\/\/api.deezer.com\/album\/302127\/tracks","type":"album"},"type":"track"},{"id":66609426,"readable":true,"title":"Get Lucky (Radio Edit - feat. Pharrell Williams and Nile Rodgers)","title_short":"Get Lucky","title_version":"(Radio Edit - feat. Pharrell Williams and Nile Rodgers)","link":"https:\/\/www.deezer.com\/track\/66609426","duration":248,"rank":952197,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/1\/b\/f\/0\/1bf80a82992903ff685ba1b7275223f8.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/1\/b\/f\/0\/1bf80a82992903ff685ba1b7275223f8.mp3*~data=user_id=0,application_id=42~hmac=c6dfe58571df62f41e7b326dd9afebf87015541c06a521ebc88fc18671d8d06d","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"},{"id":103,"name":"Pharrell Williams","link":"https:\/\/www.deezer.com\/artist\/103","share":"https:\/\/www.deezer.com\/artist\/103?utm_source=deezer&utm_content=artist-103&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/103\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/103\/top?limit=50","type":"artist","role":"Main"},{"id":7207,"name":"Nile Rodgers","link":"https:\/\/www.deezer.com\/artist\/7207","share":"https:\/\/www.deezer.com\/artist\/7207?utm_source=deezer&utm_content=artist-7207&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/7207\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/7207\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"bc49adb87758e0c8c4e508a9c5cce85d","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":6516139,"title":"Get Lucky (Radio Edit - feat. Pharrell Williams and Nile Rodgers)","cover":"https:\/\/api.deezer.com\/album\/6516139\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/bc49adb87758e0c8c4e508a9c5cce85d\/1000x1000-000000-80-0-0.jpg","md5_image":"bc49adb87758e0c8c4e508a9c5cce85d","tracklist":"https:\/\/api.deezer.com\/album\/6516139\/tracks","type":"album"},"type":"track"},{"id":67238735,"readable":true,"title":"Get Lucky (feat. Pharrell Williams and Nile Rodgers)","title_short":"Get Lucky","title_version":"(feat. Pharrell Williams and Nile Rodgers)","link":"https:\/\/www.deezer.com\/track\/67238735","duration":367,"rank":873875,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/c\/8\/a\/0\/c8a61130657a2cf58e3ac751e7950617.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/c\/8\/a\/0\/c8a61130657a2cf58e3ac751e7950617.mp3*~data=user_id=0,application_id=42~hmac=92002e6bade5ff82dd44751e8998beaa60844210df1d73b8f1bf7dafb02dc5c3","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"},{"id":103,"name":"Pharrell Williams","link":"https:\/\/www.deezer.com\/artist\/103","share":"https:\/\/www.deezer.com\/artist\/103?utm_source=deezer&utm_content=artist-103&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/103\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/1267b8781c5bff065a20dca4a3c9fda7\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/103\/top?limit=50","type":"artist","role":"Main"},{"id":7207,"name":"Nile Rodgers","link":"https:\/\/www.deezer.com\/artist\/7207","share":"https:\/\/www.deezer.com\/artist\/7207?utm_source=deezer&utm_content=artist-7207&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/7207\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/64f826f318c84ce50ff538c01f62f1ff\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/7207\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"311bba0fc112d15f72c8b5a65f0456c1","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":6575789,"title":"Random Access Memories","cover":"https:\/\/api.deezer.com\/album\/6575789\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/311bba0fc112d15f72c8b5a65f0456c1\/1000x1000-000000-80-0-0.jpg","md5_image":"311bba0fc112d15f72c8b5a65f0456c1","tracklist":"https:\/\/api.deezer.com\/album\/6575789\/tracks","type":"album"},"type":"track"},{"id":3129775,"readable":true,"title":"Around the World","title_short":"Around the World","title_version":"","link":"https:\/\/www.deezer.com\/track\/3129775","duration":429,"rank":829911,"explicit_lyrics":false,"explicit_content_lyrics":0,"explicit_content_cover":0,"preview":"https:\/\/cdnt-preview.dzcdn.net\/api\/1\/1\/a\/4\/7\/0\/a47dbed01e6d9b0ac4e39a134f745ca2.mp3?hdnea=exp=1763672105~acl=\/api\/1\/1\/a\/4\/7\/0\/a47dbed01e6d9b0ac4e39a134f745ca2.mp3*~data=user_id=0,application_id=42~hmac=9b7aa12b647cabd3219779e0270e51e639dc326442071fceb6d723c331059a67","contributors":[{"id":27,"name":"Daft Punk","link":"https:\/\/www.deezer.com\/artist\/27","share":"https:\/\/www.deezer.com\/artist\/27?utm_source=deezer&utm_content=artist-27&utm_term=0_1763671205&utm_medium=web","picture":"https:\/\/api.deezer.com\/artist\/27\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/638e69b9caaf9f9f3f8826febea7b543\/1000x1000-000000-80-0-0.jpg","radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist","role":"Main"}],"md5_image":"b870579c8650cd59b1cce656dde2ef17","artist":{"id":27,"name":"Daft Punk","tracklist":"https:\/\/api.deezer.com\/artist\/27\/top?limit=50","type":"artist"},"album":{"id":301775,"title":"Homework","cover":"https:\/\/api.deezer.com\/album\/301775\/image","cover_small":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/56x56-000000-80-0-0.jpg","cover_medium":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/250x250-000000-80-0-0.jpg","cover_big":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/500x500-000000-80-0-0.jpg","cover_xl":"https:\/\/cdn-images.dzcdn.net\/images\/cover\/b870579c8650cd59b1cce656dde2ef17\/1000x1000-000000-80-0-0.jpg","md5_image":"b870579c8650cd59b1cce656dde2ef17","tracklist":"https:\/\/api.deezer.com\/album\/301775\/tracks","type":"album"},"type":"track"}],"total":100,"next":"https:\/\/api.deezer.com\/artist\/27\/top?index=5"} \ No newline at end of file diff --git a/tests/fixtures/deezer.search.artist.json b/tests/fixtures/deezer.search.artist.json new file mode 100644 index 000000000..29f138d34 --- /dev/null +++ b/tests/fixtures/deezer.search.artist.json @@ -0,0 +1 @@ +{"data":[{"id":259,"name":"Michael Jackson","link":"https:\/\/www.deezer.com\/artist\/259","picture":"https:\/\/api.deezer.com\/artist\/259\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/97fae13b2b30e4aec2e8c9e0c7839d92\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/97fae13b2b30e4aec2e8c9e0c7839d92\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/97fae13b2b30e4aec2e8c9e0c7839d92\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/97fae13b2b30e4aec2e8c9e0c7839d92\/1000x1000-000000-80-0-0.jpg","nb_album":43,"nb_fan":12074101,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/259\/top?limit=50","type":"artist"},{"id":719,"name":"Bob Marley & The Wailers","link":"https:\/\/www.deezer.com\/artist\/719","picture":"https:\/\/api.deezer.com\/artist\/719\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c8241e15efdefa9465c7b470643efb3b\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c8241e15efdefa9465c7b470643efb3b\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c8241e15efdefa9465c7b470643efb3b\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c8241e15efdefa9465c7b470643efb3b\/1000x1000-000000-80-0-0.jpg","nb_album":80,"nb_fan":12014466,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/719\/top?limit=50","type":"artist"},{"id":14031649,"name":"jay emcee, Micheal Jackson","link":"https:\/\/www.deezer.com\/artist\/14031649","picture":"https:\/\/api.deezer.com\/artist\/14031649\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":104,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/14031649\/top?limit=50","type":"artist"},{"id":137159102,"name":"Micheal Collins The Mic Jackson Of Rap","link":"https:\/\/www.deezer.com\/artist\/137159102","picture":"https:\/\/api.deezer.com\/artist\/137159102\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":13,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/137159102\/top?limit=50","type":"artist"},{"id":259786511,"name":"Consev","link":"https:\/\/www.deezer.com\/artist\/259786511","picture":"https:\/\/api.deezer.com\/artist\/259786511\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/342048482aae9fb1f1272510b1c1f54a\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/342048482aae9fb1f1272510b1c1f54a\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/342048482aae9fb1f1272510b1c1f54a\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/342048482aae9fb1f1272510b1c1f54a\/1000x1000-000000-80-0-0.jpg","nb_album":7,"nb_fan":1,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/259786511\/top?limit=50","type":"artist"},{"id":262255,"name":"Michael Jackson Tribute","link":"https:\/\/www.deezer.com\/artist\/262255","picture":"https:\/\/api.deezer.com\/artist\/262255\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c2f4036de3a412d9b84a213663163189\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c2f4036de3a412d9b84a213663163189\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c2f4036de3a412d9b84a213663163189\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/c2f4036de3a412d9b84a213663163189\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":9339,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/262255\/top?limit=50","type":"artist"},{"id":193820797,"name":"Michael Jackman","link":"https:\/\/www.deezer.com\/artist\/193820797","picture":"https:\/\/api.deezer.com\/artist\/193820797\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/da3f7e21c8e78bd2048f47ab60f5399c\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/da3f7e21c8e78bd2048f47ab60f5399c\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/da3f7e21c8e78bd2048f47ab60f5399c\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/da3f7e21c8e78bd2048f47ab60f5399c\/1000x1000-000000-80-0-0.jpg","nb_album":1,"nb_fan":0,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/193820797\/top?limit=50","type":"artist"},{"id":374060,"name":"Simply The Best Sax: The Hits Of Michael Jackson","link":"https:\/\/www.deezer.com\/artist\/374060","picture":"https:\/\/api.deezer.com\/artist\/374060\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/3bfd0455b269dd2ccb25776c6b26197c\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/3bfd0455b269dd2ccb25776c6b26197c\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/3bfd0455b269dd2ccb25776c6b26197c\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/3bfd0455b269dd2ccb25776c6b26197c\/1000x1000-000000-80-0-0.jpg","nb_album":1,"nb_fan":1507,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/374060\/top?limit=50","type":"artist"},{"id":4969823,"name":"Jackson Michael","link":"https:\/\/www.deezer.com\/artist\/4969823","picture":"https:\/\/api.deezer.com\/artist\/4969823\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e25091f350716af9f4484939de692de6\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e25091f350716af9f4484939de692de6\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e25091f350716af9f4484939de692de6\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/e25091f350716af9f4484939de692de6\/1000x1000-000000-80-0-0.jpg","nb_album":1,"nb_fan":17,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/4969823\/top?limit=50","type":"artist"},{"id":1278001,"name":"David Michael Jackson","link":"https:\/\/www.deezer.com\/artist\/1278001","picture":"https:\/\/api.deezer.com\/artist\/1278001\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/fe2e46ba3c550a4747ca5fd9026d6f95\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/fe2e46ba3c550a4747ca5fd9026d6f95\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/fe2e46ba3c550a4747ca5fd9026d6f95\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/fe2e46ba3c550a4747ca5fd9026d6f95\/1000x1000-000000-80-0-0.jpg","nb_album":54,"nb_fan":178,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/1278001\/top?limit=50","type":"artist"},{"id":4142968,"name":"Cheyenne Jackson, Michael Feinstein","link":"https:\/\/www.deezer.com\/artist\/4142968","picture":"https:\/\/api.deezer.com\/artist\/4142968\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":251,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/4142968\/top?limit=50","type":"artist"},{"id":766502,"name":"Michael Jackson Tribute Band","link":"https:\/\/www.deezer.com\/artist\/766502","picture":"https:\/\/api.deezer.com\/artist\/766502\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/82614ae5c3f98c571369f49aba675d1e\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/82614ae5c3f98c571369f49aba675d1e\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/82614ae5c3f98c571369f49aba675d1e\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/82614ae5c3f98c571369f49aba675d1e\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":623,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/766502\/top?limit=50","type":"artist"},{"id":1394615,"name":"Michael Jameson","link":"https:\/\/www.deezer.com\/artist\/1394615","picture":"https:\/\/api.deezer.com\/artist\/1394615\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0f680ba29a076b70d5027a68ad3a5c58\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0f680ba29a076b70d5027a68ad3a5c58\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0f680ba29a076b70d5027a68ad3a5c58\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/0f680ba29a076b70d5027a68ad3a5c58\/1000x1000-000000-80-0-0.jpg","nb_album":7,"nb_fan":78,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/1394615\/top?limit=50","type":"artist"},{"id":490836,"name":"Michael Blackson","link":"https:\/\/www.deezer.com\/artist\/490836","picture":"https:\/\/api.deezer.com\/artist\/490836\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/caa27786458e9459819f6ea28c4ed1cb\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/caa27786458e9459819f6ea28c4ed1cb\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/caa27786458e9459819f6ea28c4ed1cb\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/caa27786458e9459819f6ea28c4ed1cb\/1000x1000-000000-80-0-0.jpg","nb_album":1,"nb_fan":391,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/490836\/top?limit=50","type":"artist"},{"id":1229617,"name":"The Michael Jackson Tribute Band","link":"https:\/\/www.deezer.com\/artist\/1229617","picture":"https:\/\/api.deezer.com\/artist\/1229617\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":344,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/1229617\/top?limit=50","type":"artist"},{"id":3662911,"name":"Fran London feat. Michael Jackson","link":"https:\/\/www.deezer.com\/artist\/3662911","picture":"https:\/\/api.deezer.com\/artist\/3662911\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":247,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/3662911\/top?limit=50","type":"artist"},{"id":13014917,"name":"Scott Michael Bennett, Naomi Jackson, Gary Sewell & The Emmanuel Quartet","link":"https:\/\/www.deezer.com\/artist\/13014917","picture":"https:\/\/api.deezer.com\/artist\/13014917\/image","picture_small":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/56x56-000000-80-0-0.jpg","picture_medium":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/250x250-000000-80-0-0.jpg","picture_big":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/500x500-000000-80-0-0.jpg","picture_xl":"https:\/\/cdn-images.dzcdn.net\/images\/artist\/\/1000x1000-000000-80-0-0.jpg","nb_album":0,"nb_fan":66,"radio":true,"tracklist":"https:\/\/api.deezer.com\/artist\/13014917\/top?limit=50","type":"artist"}],"total":17} \ No newline at end of file diff --git a/tests/fixtures/lastfm.album.getinfo.empty.json b/tests/fixtures/lastfm.album.getinfo.empty.json new file mode 100644 index 000000000..06403ff8c --- /dev/null +++ b/tests/fixtures/lastfm.album.getinfo.empty.json @@ -0,0 +1 @@ +{"album":{"artist":"Legião Urbana","mbid":"1749dd07-5aa9-436e-babc-e3e982deb273","tags":{"tag":[{"url":"https:\/\/www.last.fm\/tag\/rock","name":"rock"},{"url":"https:\/\/www.last.fm\/tag\/80s","name":"80s"},{"url":"https:\/\/www.last.fm\/tag\/brazilian","name":"brazilian"},{"url":"https:\/\/www.last.fm\/tag\/brasil","name":"brasil"},{"url":"https:\/\/www.last.fm\/tag\/brazilian+rock","name":"brazilian rock"}]},"name":"Dois","image":[{"size":"small","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/34s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"medium","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/64s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"large","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/174s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"extralarge","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"mega","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"}],"tracks":{"track":[{"streamable":{"fulltrack":"0","#text":"0"},"duration":232,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Daniel+na+Cova+dos+Le%C3%B5es","name":"Daniel na Cova dos Leões","@attr":{"rank":1},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":null,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Quase+Sem+Querer","name":"Quase Sem Querer","@attr":{"rank":2},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":280,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Acrilic+On+Canvas","name":"Acrilic On Canvas","@attr":{"rank":3},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":271,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Eduardo+e+M%C3%B4nica","name":"Eduardo e Mônica","@attr":{"rank":4},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":94,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Central+Do+Brasil","name":"Central Do Brasil","@attr":{"rank":5},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":302,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Tempo+Perdido","name":"Tempo Perdido","@attr":{"rank":6},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":170,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Metr%C3%B3pole","name":"Metrópole","@attr":{"rank":7},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":175,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Plantas+Em+Baixo+Do+Aqu%C3%A1rio","name":"Plantas Em Baixo Do Aquário","@attr":{"rank":8},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":162,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/M%C3%BAsica+urbana+2","name":"Música urbana 2","@attr":{"rank":9},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":184,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Andrea+Doria","name":"Andrea Doria","@attr":{"rank":10},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":231,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/F%C3%A1brica","name":"Fábrica","@attr":{"rank":11},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":258,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/%C3%8Dndios","name":"Índios","@attr":{"rank":12},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}}]},"listeners":"494356","playcount":"9833783","url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois"}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.album.getinfo.en.json b/tests/fixtures/lastfm.album.getinfo.en.json new file mode 100644 index 000000000..f5444f35b --- /dev/null +++ b/tests/fixtures/lastfm.album.getinfo.en.json @@ -0,0 +1 @@ +{"album":{"artist":"Legião Urbana","mbid":"1749dd07-5aa9-436e-babc-e3e982deb273","tags":{"tag":[{"url":"https:\/\/www.last.fm\/tag\/rock","name":"rock"},{"url":"https:\/\/www.last.fm\/tag\/80s","name":"80s"},{"url":"https:\/\/www.last.fm\/tag\/brazilian","name":"brazilian"},{"url":"https:\/\/www.last.fm\/tag\/brasil","name":"brasil"},{"url":"https:\/\/www.last.fm\/tag\/brazilian+rock","name":"brazilian rock"}]},"playcount":"9833783","image":[{"size":"small","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/34s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"medium","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/64s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"large","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/174s\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"extralarge","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"mega","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"},{"size":"","#text":"https:\/\/lastfm.freetls.fastly.net\/i\/u\/300x300\/e7dbfc64cde5478484af18f0e30662e0.png"}],"tracks":{"track":[{"streamable":{"fulltrack":"0","#text":"0"},"duration":232,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Daniel+na+Cova+dos+Le%C3%B5es","name":"Daniel na Cova dos Leões","@attr":{"rank":1},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":null,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Quase+Sem+Querer","name":"Quase Sem Querer","@attr":{"rank":2},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":280,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Acrilic+On+Canvas","name":"Acrilic On Canvas","@attr":{"rank":3},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":271,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Eduardo+e+M%C3%B4nica","name":"Eduardo e Mônica","@attr":{"rank":4},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":94,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Central+Do+Brasil","name":"Central Do Brasil","@attr":{"rank":5},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":302,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Tempo+Perdido","name":"Tempo Perdido","@attr":{"rank":6},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":170,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Metr%C3%B3pole","name":"Metrópole","@attr":{"rank":7},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":175,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Plantas+Em+Baixo+Do+Aqu%C3%A1rio","name":"Plantas Em Baixo Do Aquário","@attr":{"rank":8},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":162,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/M%C3%BAsica+urbana+2","name":"Música urbana 2","@attr":{"rank":9},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":184,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/Andrea+Doria","name":"Andrea Doria","@attr":{"rank":10},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":231,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/F%C3%A1brica","name":"Fábrica","@attr":{"rank":11},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}},{"streamable":{"fulltrack":"0","#text":"0"},"duration":258,"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\/%C3%8Dndios","name":"Índios","@attr":{"rank":12},"artist":{"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana","name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99"}}]},"url":"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois","name":"Dois","listeners":"494356","wiki":{"published":"10 Oct 2023, 13:56","summary":"Dois é o segundo álbum de estúdio da banda brasileira de rock Legião Urbana, lançado em 20 de julho de 1986 pela EMI. Ocupa a 21ª posição da lista dos 100 maiores discos da música brasileira pela Rolling Stone Brasil. Em setembro de 2012, foi eleito pelo público da rádio Eldorado FM, do portal Estadao.com e do Caderno C2+Música (estes dois últimos pertencentes ao jornal O Estado de S. Paulo) como o terceiro melhor disco brasileiro da história. O álbum vendeu mais de 900 mil cópias no Brasil. \"Tempo Perdido\" fez um grande sucesso e se tornou num dos clássicos <a href=\"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\">Read more on Last.fm<\/a>.","content":"Dois é o segundo álbum de estúdio da banda brasileira de rock Legião Urbana, lançado em 20 de julho de 1986 pela EMI. Ocupa a 21ª posição da lista dos 100 maiores discos da música brasileira pela Rolling Stone Brasil. Em setembro de 2012, foi eleito pelo público da rádio Eldorado FM, do portal Estadao.com e do Caderno C2+Música (estes dois últimos pertencentes ao jornal O Estado de S. Paulo) como o terceiro melhor disco brasileiro da história. O álbum vendeu mais de 900 mil cópias no Brasil. \"Tempo Perdido\" fez um grande sucesso e se tornou num dos clássicos da Legião. \"Eduardo e Mônica\", \"\"Índios\"\" e \"Quase sem Querer\" também fizeram sucesso. <a href=\"https:\/\/www.last.fm\/music\/Legi%C3%A3o+Urbana\/Dois\">Read more on Last.fm<\/a>. User-contributed text is available under the Creative Commons By-SA License; additional terms may apply."}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.getinfo.empty.json b/tests/fixtures/lastfm.artist.getinfo.empty.json new file mode 100644 index 000000000..015b51701 --- /dev/null +++ b/tests/fixtures/lastfm.artist.getinfo.empty.json @@ -0,0 +1 @@ +{"artist":{"name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99","url":"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}],"streamable":"0","ontour":"0","stats":{"listeners":"740591","playcount":"44493504"},"similar":{"artist":[{"name":"Renato Russo","url":"https://www.last.fm/music/Renato+Russo","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Engenheiros Do Hawaii","url":"https://www.last.fm/music/Engenheiros+Do+Hawaii","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Os Paralamas Do Sucesso","url":"https://www.last.fm/music/Os+Paralamas+Do+Sucesso","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Barão Vermelho","url":"https://www.last.fm/music/Bar%C3%A3o+Vermelho","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Capital Inicial","url":"https://www.last.fm/music/Capital+Inicial","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]}]},"tags":{"tag":[{"name":"rock","url":"https://www.last.fm/tag/rock"},{"name":"brazilian rock","url":"https://www.last.fm/tag/brazilian+rock"},{"name":"80s","url":"https://www.last.fm/tag/80s"},{"name":"brazilian","url":"https://www.last.fm/tag/brazilian"},{"name":"brasil","url":"https://www.last.fm/tag/brasil"}]},"bio":{"links":{"link":{"#text":"","rel":"original","href":"https://last.fm/music/+noredirect/Legi%C3%A3o+Urbana/+wiki"}},"published":"01 Jan 1970, 00:00","summary":" <a href=\"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana\">Read more on Last.fm</a>","content":""}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.getinfo.en.json b/tests/fixtures/lastfm.artist.getinfo.en.json new file mode 100644 index 000000000..6c643b8e2 --- /dev/null +++ b/tests/fixtures/lastfm.artist.getinfo.en.json @@ -0,0 +1 @@ +{"artist":{"name":"Legião Urbana","mbid":"47685be0-926f-4be9-b1ae-e32da47a3b99","url":"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}],"streamable":"0","ontour":"0","stats":{"listeners":"740367","playcount":"44476703"},"similar":{"artist":[{"name":"Renato Russo","url":"https://www.last.fm/music/Renato+Russo","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Engenheiros Do Hawaii","url":"https://www.last.fm/music/Engenheiros+Do+Hawaii","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Os Paralamas Do Sucesso","url":"https://www.last.fm/music/Os+Paralamas+Do+Sucesso","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Barão Vermelho","url":"https://www.last.fm/music/Bar%C3%A3o+Vermelho","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]},{"name":"Capital Inicial","url":"https://www.last.fm/music/Capital+Inicial","image":[{"#text":"https://lastfm.freetls.fastly.net/i/u/34s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"small"},{"#text":"https://lastfm.freetls.fastly.net/i/u/64s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"medium"},{"#text":"https://lastfm.freetls.fastly.net/i/u/174s/2a96cbd8b46e442fc41c2b86b821562f.png","size":"large"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"extralarge"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":"mega"},{"#text":"https://lastfm.freetls.fastly.net/i/u/300x300/2a96cbd8b46e442fc41c2b86b821562f.png","size":""}]}]},"tags":{"tag":[{"name":"rock","url":"https://www.last.fm/tag/rock"},{"name":"brazilian rock","url":"https://www.last.fm/tag/brazilian+rock"},{"name":"80s","url":"https://www.last.fm/tag/80s"},{"name":"brazilian","url":"https://www.last.fm/tag/brazilian"},{"name":"brasil","url":"https://www.last.fm/tag/brasil"}]},"bio":{"links":{"link":{"#text":"","rel":"original","href":"https://last.fm/music/+noredirect/Legi%C3%A3o+Urbana/+wiki"}},"published":"03 Mar 2006, 04:04","summary":"Legião Urbana was a Brazilian post-punk band from Brasília, Distrito Federal, Brazil.\n\nFronted by lead singer and lyricist Renato Russo, Legião Urbana was founded in 1983 and existed until 1996, when Renato passed away due to complications caused by AIDS. Besides being the lead vocalist, Renato was an occasional guitar, bass and keyboards player. He also wrote most of the band's songs. In 13 years of career, they released 8 studio albums - the last being posthumous - and one live. <a href=\"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana\">Read more on Last.fm</a>","content":"Legião Urbana was a Brazilian post-punk band from Brasília, Distrito Federal, Brazil.\n\nFronted by lead singer and lyricist Renato Russo, Legião Urbana was founded in 1983 and existed until 1996, when Renato passed away due to complications caused by AIDS. Besides being the lead vocalist, Renato was an occasional guitar, bass and keyboards player. He also wrote most of the band's songs. In 13 years of career, they released 8 studio albums - the last being posthumous - and one live.\n\nLegião Urbana is probably the most famous Brazilian rock bands, especially known for Renato's poetic lyrics, which range from love and spiritualism to politics, family, sex and drugs.\n\nNowadays, Dado Villa-Lobos (ex-guitar player of Legião Urbana) has a solo career and recorded his first album, named \"Jardim De Cactus\", in 2005. Drum player Marcelo Bonfá also tried a solo career. <a href=\"https://www.last.fm/music/+noredirect/Legi%C3%A3o+Urbana\">Read more on Last.fm</a>. User-contributed text is available under the Creative Commons By-SA License; additional terms may apply."}}} \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.page.html b/tests/fixtures/lastfm.artist.page.html new file mode 100644 index 000000000..1922e313b --- /dev/null +++ b/tests/fixtures/lastfm.artist.page.html @@ -0,0 +1,7 @@ +<html> +<head> +<meta property="og:image" content="https://lastfm.freetls.fastly.net/i/u/ar0/818148bf682d429dc21b59a73ef6f68e.png" /> +</head> +<body> +</body> +</html> \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.page.ignored.html b/tests/fixtures/lastfm.artist.page.ignored.html new file mode 100644 index 000000000..96eda2377 --- /dev/null +++ b/tests/fixtures/lastfm.artist.page.ignored.html @@ -0,0 +1,7 @@ +<html> +<head> +<meta property="og:image" content="https://lastfm.freetls.fastly.net/i/u/ar0/2a96cbd8b46e442fc41c2b86b821562f.png" /> +</head> +<body> +</body> +</html> \ No newline at end of file diff --git a/tests/fixtures/lastfm.artist.page.no_meta.html b/tests/fixtures/lastfm.artist.page.no_meta.html new file mode 100644 index 000000000..aa7b9c934 --- /dev/null +++ b/tests/fixtures/lastfm.artist.page.no_meta.html @@ -0,0 +1,6 @@ +<html> +<head> +</head> +<body> +</body> +</html> \ No newline at end of file diff --git a/tests/fixtures/lastfm.track.getsimilar.json b/tests/fixtures/lastfm.track.getsimilar.json new file mode 100644 index 000000000..45041b289 --- /dev/null +++ b/tests/fixtures/lastfm.track.getsimilar.json @@ -0,0 +1 @@ +{"similartracks":{"track":[{"name":"Dreaming of Me","mbid":"027b553e-7c74-3ed4-a95e-1d4fea51f174","match":1.0,"url":"https://www.last.fm/music/Depeche+Mode/_/Dreaming+of+Me","artist":{"name":"Depeche Mode","mbid":"8538e728-ca0b-4321-b7e5-cff6565dd4c0","url":"https://www.last.fm/music/Depeche+Mode"}},{"name":"Everything Counts","mbid":"5a5a3ca4-bdb8-4641-a674-9b54b9b319a6","match":0.892602,"url":"https://www.last.fm/music/Depeche+Mode/_/Everything+Counts","artist":{"name":"Depeche Mode","mbid":"8538e728-ca0b-4321-b7e5-cff6565dd4c0","url":"https://www.last.fm/music/Depeche+Mode"}},{"name":"Don't You Want Me","mbid":"","match":0.491341,"url":"https://www.last.fm/music/The+Human+League/_/Don%27t+You+Want+Me","artist":{"name":"The Human League","mbid":"7adaabfb-acfb-47bc-8c7c-59471c2f0db8","url":"https://www.last.fm/music/The+Human+League"}},{"name":"Tainted Love","mbid":"","match":0.454811,"url":"https://www.last.fm/music/Soft+Cell/_/Tainted+Love","artist":{"name":"Soft Cell","mbid":"7fb50287-029d-47cc-825a-235ca28024b2","url":"https://www.last.fm/music/Soft+Cell"}},{"name":"Blue Monday","mbid":"727e84c6-1b56-31dd-a958-a5f46305cec0","match":0.381057,"url":"https://www.last.fm/music/New+Order/_/Blue+Monday","artist":{"name":"New Order","mbid":"f1106b17-dcbb-45f6-b938-199ccfab50cc","url":"https://www.last.fm/music/New+Order"}}],"@attr":{"artist":"Depeche Mode","track":"Just Can't Get Enough"}}} diff --git a/tests/fixtures/lastfm.track.getsimilar.unknown.json b/tests/fixtures/lastfm.track.getsimilar.unknown.json new file mode 100644 index 000000000..9b879fa05 --- /dev/null +++ b/tests/fixtures/lastfm.track.getsimilar.unknown.json @@ -0,0 +1 @@ +{"similartracks":{"track":[],"@attr":{"track":"UnknownTrack","artist":"UnknownArtist"}}} diff --git a/tests/fixtures/listenbrainz.artist.metadata.homepage.json b/tests/fixtures/listenbrainz.artist.metadata.homepage.json new file mode 100644 index 000000000..be15ea45f --- /dev/null +++ b/tests/fixtures/listenbrainz.artist.metadata.homepage.json @@ -0,0 +1,19 @@ +[ + { + "area": "Japan", + "artist_mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "begin_year": 2012, + "mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "name": "Mili", + "rels": { + "free streaming": "https://www.deezer.com/artist/56563392", + "official homepage": "http://projectmili.com/", + "purchase for download": "https://recochoku.jp/artist/2000285803/", + "social network": "https://www.instagram.com/projectmili/", + "streaming": "https://tidal.com/artist/3848902", + "wikidata": "https://www.wikidata.org/wiki/Q27309228", + "youtube": "https://www.youtube.com/channel/UCVh47EKH9VLresRqiYi9txw" + }, + "type": "Group" + } +] diff --git a/tests/fixtures/listenbrainz.artist.metadata.no_homepage.json b/tests/fixtures/listenbrainz.artist.metadata.no_homepage.json new file mode 100644 index 000000000..6105556a2 --- /dev/null +++ b/tests/fixtures/listenbrainz.artist.metadata.no_homepage.json @@ -0,0 +1,15 @@ +[ + { + "area": "Japan", + "artist_mbid": "7c2cc610-f998-43ef-a08f-dae3344b8973", + "mbid": "7c2cc610-f998-43ef-a08f-dae3344b8973", + "name": "Feryquitous", + "rels": { + "free streaming": "https://www.deezer.com/artist/9841008", + "purchase for download": "https://itunes.apple.com/jp/artist/id1083544578", + "social network": "https://twitter.com/Feryquitous_", + "youtube": "https://www.youtube.com/channel/UCj2nw_9puY3sJoDbkE-FCQA" + }, + "type": "Person" + } +] diff --git a/tests/fixtures/listenbrainz.labs.similar-artists.json b/tests/fixtures/listenbrainz.labs.similar-artists.json new file mode 100644 index 000000000..1cd2c85b5 --- /dev/null +++ b/tests/fixtures/listenbrainz.labs.similar-artists.json @@ -0,0 +1 @@ +[{"artist_mbid": "f27ec8db-af05-4f36-916e-3d57f91ecf5e", "name": "Michael Jackson", "comment": "\u201cKing of Pop\u201d", "type": "Person", "gender": "Male", "score": 800, "reference_mbid": "db92a151-1ac2-438b-bc43-b82e149ddd50"}, {"artist_mbid": "7364dea6-ca9a-48e3-be01-b44ad0d19897", "name": "a-ha", "comment": "Norwegian synth\u2010pop band", "type": "Group", "gender": null, "score": 792, "reference_mbid": "db92a151-1ac2-438b-bc43-b82e149ddd50"}] \ No newline at end of file diff --git a/tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json b/tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json new file mode 100644 index 000000000..61913bcf5 --- /dev/null +++ b/tests/fixtures/listenbrainz.labs.similar-recordings-real-out-of-order.json @@ -0,0 +1 @@ +[{"recording_mbid":"12f65dca-de8f-43fe-a65d-f12a02aaadf3","recording_name":"Take On Me","artist_credit_name":"a‐ha","artist_credit_mbids":null,"release_name":"Hunting High and Low","release_mbid":"4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc","caa_id":13015069966,"caa_release_mbid":"181b9a01-0446-4601-99be-b011ab615631","score":124,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"12f65dca-de8f-43fe-a65d-f12a02aaadf3","recording_name":"Take On Me","artist_credit_name":"a‐ha","artist_credit_mbids":null,"release_name":"Hunting High and Low","release_mbid":"4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc","caa_id":13015069966,"caa_release_mbid":"181b9a01-0446-4601-99be-b011ab615631","score":124,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"80033c72-aa19-4ba8-9227-afb075fec46e","recording_name":"Wake Me Up Before You Go‐Go","artist_credit_name":"Wham!","artist_credit_mbids":null,"release_name":"Make It Big","release_mbid":"c143d542-48dc-446b-b523-1762da721638","caa_id":2622532701,"caa_release_mbid":"ec01ad0c-a28f-4d45-bed7-d73014161c38","score":65,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"ef4c6855-949e-4e22-b41e-8e0a2d372d5f","recording_name":"Tainted Love","artist_credit_name":"Soft Cell","artist_credit_mbids":null,"release_name":"Non-Stop Erotic Cabaret","release_mbid":"1acaa870-6e0c-4b6e-9e91-fdec4e5ea4b1","caa_id":1031647403,"caa_release_mbid":"c3367d3a-2f6c-48d1-95c5-c1ee7a49c479","score":61,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"e4b347be-ecb2-44ff-aaa8-3d4c517d7ea5","recording_name":"Everybody Wants to Rule the World","artist_credit_name":"Tears for Fears","artist_credit_mbids":null,"release_name":"Songs From the Big Chair","release_mbid":"21f19b06-81f1-347a-add5-5d0c77696597","caa_id":19682986993,"caa_release_mbid":"9aefc6dd-216a-4271-ada1-d9cf67956f39","score":68,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"}] \ No newline at end of file diff --git a/tests/fixtures/listenbrainz.labs.similar-recordings.json b/tests/fixtures/listenbrainz.labs.similar-recordings.json new file mode 100644 index 000000000..87323f426 --- /dev/null +++ b/tests/fixtures/listenbrainz.labs.similar-recordings.json @@ -0,0 +1 @@ +[{"recording_mbid":"12f65dca-de8f-43fe-a65d-f12a02aaadf3","recording_name":"Take On Me","artist_credit_name":"a‐ha","artist_credit_mbids":null,"release_name":"Hunting High and Low","release_mbid":"4ec07fe8-e7c6-3106-a0aa-fdf92f13f7fc","caa_id":13015069966,"caa_release_mbid":"181b9a01-0446-4601-99be-b011ab615631","score":124,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"},{"recording_mbid":"80033c72-aa19-4ba8-9227-afb075fec46e","recording_name":"Wake Me Up Before You Go‐Go","artist_credit_name":"Wham!","artist_credit_mbids":null,"release_name":"Make It Big","release_mbid":"c143d542-48dc-446b-b523-1762da721638","caa_id":2622532701,"caa_release_mbid":"ec01ad0c-a28f-4d45-bed7-d73014161c38","score":65,"reference_mbid":"8f3471b5-7e6a-48da-86a9-c1c07a0f47ae"}] \ No newline at end of file diff --git a/tests/fixtures/listenbrainz.popularity.json b/tests/fixtures/listenbrainz.popularity.json new file mode 100644 index 000000000..ea459b120 --- /dev/null +++ b/tests/fixtures/listenbrainz.popularity.json @@ -0,0 +1,81 @@ +[ + { + "artist_mbids": ["d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"], + "artist_name": "Mili", + "artists": [ + { + "artist_credit_name": "Mili", + "artist_mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "join_phrase": "" + } + ], + "caa_id": 14987576054, + "caa_release_mbid": "38a8f6e1-0e34-4418-a89d-78240a367408", + "length": 211912, + "recording_mbid": "9980309d-3480-4e7e-89ce-fce971a452be", + "recording_name": "world.execute(me);", + "release_color": { "blue": 109, "green": 94, "red": 95 }, + "release_mbid": "38a8f6e1-0e34-4418-a89d-78240a367408", + "release_name": "Miracle Milk", + "tags": [ + { + "count": 1, + "genre_mbid": "911c7bbb-172d-4df8-9478-dbff4296e791", + "tag": "pop" + }, + { + "count": 1, + "genre_mbid": "b739a895-85ed-4ad3-8717-4e9ef5387dd8", + "tag": "dance-pop" + }, + { + "count": 1, + "genre_mbid": "9c8ba153-740e-4b88-b7ff-31d004944c95", + "tag": "nerdcore" + }, + { + "count": 1, + "genre_mbid": "c4a69842-f891-4569-9506-1882aa5db433", + "tag": "electronic rock" + }, + { "count": 1, "tag": "hackercore" }, + { "count": 1, "tag": "meter:4/4" }, + { "count": 1, "tag": "vocal:true" }, + { "count": 1, "tag": "bpm:130" }, + { + "count": 1, + "genre_mbid": "e5bba957-8c91-496a-a675-c6d0c6b51c33", + "tag": "dance" + }, + { + "count": 1, + "genre_mbid": "89255676-1f14-4dd8-bbad-fca839d6aff4", + "tag": "electronic" + } + ], + "total_listen_count": 19440, + "total_user_count": 1102 + }, + { + "artist_mbids": ["d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56"], + "artist_name": "Mili", + "artists": [ + { + "artist_credit_name": "Mili", + "artist_mbid": "d2a92ee2-27ce-4e71-bfc5-12e34fe8ef56", + "join_phrase": "" + } + ], + "caa_id": 31388973421, + "caa_release_mbid": "e58ed9ef-2bc1-4480-9d6d-2d799beb5ba9", + "length": 174000, + "recording_mbid": "afa2c83d-b17f-4029-b9da-790ea9250cf9", + "recording_name": "String Theocracy", + "release_color": { "blue": 92, "green": 147, "red": 164 }, + "release_mbid": "d79a38e3-7016-4f39-a31a-f495ce914b8e", + "release_name": "String Theocracy", + "tags": [], + "total_listen_count": 8986, + "total_user_count": 712 + } +] diff --git a/tests/fixtures/mixed-lyrics.flac b/tests/fixtures/mixed-lyrics.flac new file mode 100644 index 000000000..d048234f5 Binary files /dev/null and b/tests/fixtures/mixed-lyrics.flac differ diff --git a/tests/fixtures/no_replaygain.mp3 b/tests/fixtures/no_replaygain.mp3 new file mode 100644 index 000000000..45c2176e3 Binary files /dev/null and b/tests/fixtures/no_replaygain.mp3 differ diff --git a/tests/fixtures/playlists/bom-test-utf16.m3u b/tests/fixtures/playlists/bom-test-utf16.m3u new file mode 100644 index 000000000..9c2e9d599 Binary files /dev/null and b/tests/fixtures/playlists/bom-test-utf16.m3u differ diff --git a/tests/fixtures/playlists/bom-test.m3u b/tests/fixtures/playlists/bom-test.m3u new file mode 100644 index 000000000..f5a00806c --- /dev/null +++ b/tests/fixtures/playlists/bom-test.m3u @@ -0,0 +1,6 @@ +#EXTM3U +# NOTE: This file intentionally contains a UTF-8 BOM (Byte Order Mark) at the beginning +# (bytes 0xEF 0xBB 0xBF) to test BOM handling in playlist parsing. +#PLAYLIST:Test Playlist +#EXTINF:123,Test Artist - Test Song +test.mp3 diff --git a/tests/fixtures/playlists/pls-with-art-url.m3u b/tests/fixtures/playlists/pls-with-art-url.m3u new file mode 100644 index 000000000..9dbf180f8 --- /dev/null +++ b/tests/fixtures/playlists/pls-with-art-url.m3u @@ -0,0 +1,5 @@ +#EXTM3U +#PLAYLIST:Playlist With Art +#EXTALBUMARTURL:https://example.com/cover.jpg +test.mp3 +test.ogg diff --git a/tests/fixtures/playlists/private_playlist.nsp b/tests/fixtures/playlists/private_playlist.nsp new file mode 100644 index 000000000..de73b369c --- /dev/null +++ b/tests/fixtures/playlists/private_playlist.nsp @@ -0,0 +1,11 @@ +{ + "name": "Private Playlist", + "comment": "A smart playlist that is explicitly private", + "public": false, + "all": [ + {"is": {"loved": true}} + ], + "sort": "title", + "order": "asc", + "limit": 100 +} diff --git a/tests/fixtures/playlists/public_playlist.nsp b/tests/fixtures/playlists/public_playlist.nsp new file mode 100644 index 000000000..e303169e1 --- /dev/null +++ b/tests/fixtures/playlists/public_playlist.nsp @@ -0,0 +1,11 @@ +{ + "name": "Public Playlist", + "comment": "A smart playlist that is public", + "public": true, + "all": [ + {"inTheLast": {"lastPlayed": 30}} + ], + "sort": "lastPlayed", + "order": "desc", + "limit": 50 +} diff --git a/tests/fixtures/test.aiff b/tests/fixtures/test.aiff index 1435115d9..d179f0714 100644 Binary files a/tests/fixtures/test.aiff and b/tests/fixtures/test.aiff differ diff --git a/tests/fixtures/test.flac b/tests/fixtures/test.flac index 6c1270fd5..50430f539 100644 Binary files a/tests/fixtures/test.flac and b/tests/fixtures/test.flac differ diff --git a/tests/fixtures/test.m4a b/tests/fixtures/test.m4a index c469dd9e4..e9b54d44d 100644 Binary files a/tests/fixtures/test.m4a and b/tests/fixtures/test.m4a differ diff --git a/tests/fixtures/test.mp3 b/tests/fixtures/test.mp3 index 7333249ad..18cb90674 100644 Binary files a/tests/fixtures/test.mp3 and b/tests/fixtures/test.mp3 differ diff --git a/tests/fixtures/test.ogg b/tests/fixtures/test.ogg index 507da9050..2b1deea98 100644 Binary files a/tests/fixtures/test.ogg and b/tests/fixtures/test.ogg differ diff --git a/tests/fixtures/test.opus b/tests/fixtures/test.opus new file mode 100644 index 000000000..044947c70 Binary files /dev/null and b/tests/fixtures/test.opus differ diff --git a/tests/fixtures/test.wav b/tests/fixtures/test.wav index 155d88bdb..b8c1f9a65 100644 Binary files a/tests/fixtures/test.wav and b/tests/fixtures/test.wav differ diff --git a/tests/fixtures/test.wma b/tests/fixtures/test.wma index 2edb7260e..2e7341cf5 100644 Binary files a/tests/fixtures/test.wma and b/tests/fixtures/test.wma differ diff --git a/tests/fixtures/test.wv b/tests/fixtures/test.wv index 3722d28a2..7f4118bdb 100644 Binary files a/tests/fixtures/test.wv and b/tests/fixtures/test.wv differ diff --git a/tests/fixtures/zero_replaygain.mp3 b/tests/fixtures/zero_replaygain.mp3 new file mode 100644 index 000000000..96e6d21f0 Binary files /dev/null and b/tests/fixtures/zero_replaygain.mp3 differ diff --git a/tests/mock_album_repo.go b/tests/mock_album_repo.go index 58c33c97f..3428813f6 100644 --- a/tests/mock_album_repo.go +++ b/tests/mock_album_repo.go @@ -16,10 +16,12 @@ func CreateMockAlbumRepo() *MockAlbumRepo { type MockAlbumRepo struct { model.AlbumRepository - Data map[string]*model.Album - All model.Albums - Err bool - Options model.QueryOptions + Data map[string]*model.Album + All model.Albums + Err bool + Options model.QueryOptions + ReassignAnnotationCalls map[string]string // prevID -> newID + CopyAttributesCalls map[string]string // fromID -> toID } func (m *MockAlbumRepo) SetError(err bool) { @@ -117,4 +119,70 @@ func (m *MockAlbumRepo) UpdateExternalInfo(album *model.Album) error { return nil } +func (m *MockAlbumRepo) Search(q string, options ...model.QueryOptions) (model.Albums, error) { + if len(options) > 0 { + m.Options = options[0] + } + if m.Err { + return nil, errors.New("unexpected error") + } + // Simple mock implementation - just return all albums for testing + return m.All, nil +} + +// ReassignAnnotation reassigns annotations from one album to another +func (m *MockAlbumRepo) ReassignAnnotation(prevID string, newID string) error { + if m.Err { + return errors.New("unexpected error") + } + // Mock implementation - track the reassignment calls + if m.ReassignAnnotationCalls == nil { + m.ReassignAnnotationCalls = make(map[string]string) + } + m.ReassignAnnotationCalls[prevID] = newID + return nil +} + +// CopyAttributes copies attributes from one album to another +func (m *MockAlbumRepo) CopyAttributes(fromID, toID string, columns ...string) error { + if m.Err { + return errors.New("unexpected error") + } + from, ok := m.Data[fromID] + if !ok { + return model.ErrNotFound + } + to, ok := m.Data[toID] + if !ok { + return model.ErrNotFound + } + for _, col := range columns { + switch col { + case "created_at": + to.CreatedAt = from.CreatedAt + } + } + if m.CopyAttributesCalls == nil { + m.CopyAttributesCalls = make(map[string]string) + } + m.CopyAttributesCalls[fromID] = toID + return nil +} + +// SetRating sets the rating for an album +func (m *MockAlbumRepo) SetRating(rating int, itemID string) error { + if m.Err { + return errors.New("unexpected error") + } + return nil +} + +// SetStar sets the starred status for albums +func (m *MockAlbumRepo) SetStar(starred bool, itemIDs ...string) error { + if m.Err { + return errors.New("unexpected error") + } + return nil +} + var _ model.AlbumRepository = (*MockAlbumRepo)(nil) diff --git a/tests/mock_artist_repo.go b/tests/mock_artist_repo.go index 7058cead0..b7a6fb811 100644 --- a/tests/mock_artist_repo.go +++ b/tests/mock_artist_repo.go @@ -16,8 +16,9 @@ func CreateMockArtistRepo() *MockArtistRepo { type MockArtistRepo struct { model.ArtistRepository - Data map[string]*model.Artist - Err bool + Data map[string]*model.Artist + Err bool + Options model.QueryOptions } func (m *MockArtistRepo) SetError(err bool) { @@ -73,6 +74,9 @@ func (m *MockArtistRepo) IncPlayCount(id string, timestamp time.Time) error { } func (m *MockArtistRepo) GetAll(options ...model.QueryOptions) (model.Artists, error) { + if len(options) > 0 { + m.Options = options[0] + } if m.Err { return nil, errors.New("mock repo error") } @@ -94,4 +98,63 @@ func (m *MockArtistRepo) UpdateExternalInfo(artist *model.Artist) error { return nil } +func (m *MockArtistRepo) RefreshStats(allArtists bool) (int64, error) { + if m.Err { + return 0, errors.New("mock repo error") + } + return int64(len(m.Data)), nil +} + +func (m *MockArtistRepo) RefreshPlayCounts() (int64, error) { + if m.Err { + return 0, errors.New("mock repo error") + } + return int64(len(m.Data)), nil +} + +func (m *MockArtistRepo) GetIndex(includeMissing bool, libraryIds []int, roles ...model.Role) (model.ArtistIndexes, error) { + if m.Err { + return nil, errors.New("mock repo error") + } + + artists, err := m.GetAll() + if err != nil { + return nil, err + } + + // For mock purposes, if no artists available, return empty result + if len(artists) == 0 { + return model.ArtistIndexes{}, nil + } + + // Simple index grouping by first letter (simplified implementation for mocks) + indexMap := make(map[string]model.Artists) + for _, artist := range artists { + key := "#" + if len(artist.Name) > 0 { + key = string(artist.Name[0]) + } + indexMap[key] = append(indexMap[key], artist) + } + + var result model.ArtistIndexes + for k, artists := range indexMap { + result = append(result, model.ArtistIndex{ID: k, Artists: artists}) + } + + return result, nil +} + +func (m *MockArtistRepo) Search(q string, options ...model.QueryOptions) (model.Artists, error) { + if len(options) > 0 { + m.Options = options[0] + } + if m.Err { + return nil, errors.New("unexpected error") + } + // Simple mock implementation - just return all artists for testing + allArtists, err := m.GetAll() + return allArtists, err +} + var _ model.ArtistRepository = (*MockArtistRepo)(nil) diff --git a/tests/mock_data_store.go b/tests/mock_data_store.go index f380755e0..754f0c084 100644 --- a/tests/mock_data_store.go +++ b/tests/mock_data_store.go @@ -2,6 +2,7 @@ package tests import ( "context" + "sync" "github.com/navidrome/navidrome/model" ) @@ -19,196 +20,233 @@ type MockDataStore struct { MockedProperty model.PropertyRepository MockedPlayer model.PlayerRepository MockedPlaylist model.PlaylistRepository + MockedPlayQueue model.PlayQueueRepository MockedShare model.ShareRepository MockedTranscoding model.TranscodingRepository MockedUserProps model.UserPropsRepository MockedScrobbleBuffer model.ScrobbleBufferRepository + MockedScrobble model.ScrobbleRepository MockedRadio model.RadioRepository + MockedPlugin model.PluginRepository + scrobbleBufferMu sync.Mutex + repoMu sync.Mutex + + // GC tracking + GCCalled bool + GCError error } func (db *MockDataStore) Library(ctx context.Context) model.LibraryRepository { - if db.MockedLibrary == nil { - if db.RealDS != nil { - db.MockedLibrary = db.RealDS.Library(ctx) - } else { - db.MockedLibrary = &MockLibraryRepo{} - } + if db.MockedLibrary != nil { + return db.MockedLibrary } + if db.RealDS != nil { + return db.RealDS.Library(ctx) + } + db.MockedLibrary = &MockLibraryRepo{} return db.MockedLibrary } func (db *MockDataStore) Folder(ctx context.Context) model.FolderRepository { - if db.MockedFolder == nil { - if db.RealDS != nil { - db.MockedFolder = db.RealDS.Folder(ctx) - } else { - db.MockedFolder = struct{ model.FolderRepository }{} - } + if db.MockedFolder != nil { + return db.MockedFolder } + if db.RealDS != nil { + return db.RealDS.Folder(ctx) + } + db.MockedFolder = struct{ model.FolderRepository }{} return db.MockedFolder } func (db *MockDataStore) Tag(ctx context.Context) model.TagRepository { - if db.MockedTag == nil { - if db.RealDS != nil { - db.MockedTag = db.RealDS.Tag(ctx) - } else { - db.MockedTag = struct{ model.TagRepository }{} - } + if db.MockedTag != nil { + return db.MockedTag } + if db.RealDS != nil { + return db.RealDS.Tag(ctx) + } + db.MockedTag = struct{ model.TagRepository }{} return db.MockedTag } func (db *MockDataStore) Album(ctx context.Context) model.AlbumRepository { - if db.MockedAlbum == nil { - if db.RealDS != nil { - db.MockedAlbum = db.RealDS.Album(ctx) - } else { - db.MockedAlbum = CreateMockAlbumRepo() - } + if db.MockedAlbum != nil { + return db.MockedAlbum } + if db.RealDS != nil { + return db.RealDS.Album(ctx) + } + db.MockedAlbum = CreateMockAlbumRepo() return db.MockedAlbum } func (db *MockDataStore) Artist(ctx context.Context) model.ArtistRepository { - if db.MockedArtist == nil { - if db.RealDS != nil { - db.MockedArtist = db.RealDS.Artist(ctx) - } else { - db.MockedArtist = CreateMockArtistRepo() - } + if db.MockedArtist != nil { + return db.MockedArtist } + if db.RealDS != nil { + return db.RealDS.Artist(ctx) + } + db.MockedArtist = CreateMockArtistRepo() return db.MockedArtist } func (db *MockDataStore) MediaFile(ctx context.Context) model.MediaFileRepository { + if db.RealDS != nil && db.MockedMediaFile == nil { + return db.RealDS.MediaFile(ctx) + } + db.repoMu.Lock() + defer db.repoMu.Unlock() if db.MockedMediaFile == nil { - if db.RealDS != nil { - db.MockedMediaFile = db.RealDS.MediaFile(ctx) - } else { - db.MockedMediaFile = CreateMockMediaFileRepo() - } + db.MockedMediaFile = CreateMockMediaFileRepo() } return db.MockedMediaFile } func (db *MockDataStore) Genre(ctx context.Context) model.GenreRepository { - if db.MockedGenre == nil { - if db.RealDS != nil { - db.MockedGenre = db.RealDS.Genre(ctx) - } else { - db.MockedGenre = &MockedGenreRepo{} - } + if db.MockedGenre != nil { + return db.MockedGenre } + if db.RealDS != nil { + return db.RealDS.Genre(ctx) + } + db.MockedGenre = &MockedGenreRepo{} return db.MockedGenre } func (db *MockDataStore) Playlist(ctx context.Context) model.PlaylistRepository { - if db.MockedPlaylist == nil { - if db.RealDS != nil { - db.MockedPlaylist = db.RealDS.Playlist(ctx) - } else { - db.MockedPlaylist = &MockPlaylistRepo{} - } + if db.MockedPlaylist != nil { + return db.MockedPlaylist } + if db.RealDS != nil { + return db.RealDS.Playlist(ctx) + } + db.MockedPlaylist = CreateMockPlaylistRepo() return db.MockedPlaylist } func (db *MockDataStore) PlayQueue(ctx context.Context) model.PlayQueueRepository { + if db.MockedPlayQueue != nil { + return db.MockedPlayQueue + } if db.RealDS != nil { return db.RealDS.PlayQueue(ctx) } - return struct{ model.PlayQueueRepository }{} + db.MockedPlayQueue = &MockPlayQueueRepo{} + return db.MockedPlayQueue } func (db *MockDataStore) UserProps(ctx context.Context) model.UserPropsRepository { - if db.MockedUserProps == nil { - if db.RealDS != nil { - db.MockedUserProps = db.RealDS.UserProps(ctx) - } else { - db.MockedUserProps = &MockedUserPropsRepo{} - } + if db.MockedUserProps != nil { + return db.MockedUserProps } + if db.RealDS != nil { + return db.RealDS.UserProps(ctx) + } + db.MockedUserProps = &MockedUserPropsRepo{} return db.MockedUserProps } func (db *MockDataStore) Property(ctx context.Context) model.PropertyRepository { - if db.MockedProperty == nil { - if db.RealDS != nil { - db.MockedProperty = db.RealDS.Property(ctx) - } else { - db.MockedProperty = &MockedPropertyRepo{} - } + if db.MockedProperty != nil { + return db.MockedProperty } + if db.RealDS != nil { + return db.RealDS.Property(ctx) + } + db.MockedProperty = &MockedPropertyRepo{} return db.MockedProperty } func (db *MockDataStore) Share(ctx context.Context) model.ShareRepository { - if db.MockedShare == nil { - if db.RealDS != nil { - db.MockedShare = db.RealDS.Share(ctx) - } else { - db.MockedShare = &MockShareRepo{} - } + if db.MockedShare != nil { + return db.MockedShare } + if db.RealDS != nil { + return db.RealDS.Share(ctx) + } + db.MockedShare = &MockShareRepo{} return db.MockedShare } func (db *MockDataStore) User(ctx context.Context) model.UserRepository { - if db.MockedUser == nil { - if db.RealDS != nil { - db.MockedUser = db.RealDS.User(ctx) - } else { - db.MockedUser = CreateMockUserRepo() - } + if db.MockedUser != nil { + return db.MockedUser } + if db.RealDS != nil { + return db.RealDS.User(ctx) + } + db.MockedUser = CreateMockUserRepo() return db.MockedUser } func (db *MockDataStore) Transcoding(ctx context.Context) model.TranscodingRepository { - if db.MockedTranscoding == nil { - if db.RealDS != nil { - db.MockedTranscoding = db.RealDS.Transcoding(ctx) - } else { - db.MockedTranscoding = struct{ model.TranscodingRepository }{} - } + if db.MockedTranscoding != nil { + return db.MockedTranscoding } + if db.RealDS != nil { + return db.RealDS.Transcoding(ctx) + } + db.MockedTranscoding = struct{ model.TranscodingRepository }{} return db.MockedTranscoding } func (db *MockDataStore) Player(ctx context.Context) model.PlayerRepository { - if db.MockedPlayer == nil { - if db.RealDS != nil { - db.MockedPlayer = db.RealDS.Player(ctx) - } else { - db.MockedPlayer = struct{ model.PlayerRepository }{} - } + if db.MockedPlayer != nil { + return db.MockedPlayer } + if db.RealDS != nil { + return db.RealDS.Player(ctx) + } + db.MockedPlayer = struct{ model.PlayerRepository }{} return db.MockedPlayer } func (db *MockDataStore) ScrobbleBuffer(ctx context.Context) model.ScrobbleBufferRepository { + if db.RealDS != nil && db.MockedScrobbleBuffer == nil { + return db.RealDS.ScrobbleBuffer(ctx) + } + db.scrobbleBufferMu.Lock() + defer db.scrobbleBufferMu.Unlock() if db.MockedScrobbleBuffer == nil { - if db.RealDS != nil { - db.MockedScrobbleBuffer = db.RealDS.ScrobbleBuffer(ctx) - } else { - db.MockedScrobbleBuffer = CreateMockedScrobbleBufferRepo() - } + db.MockedScrobbleBuffer = &MockedScrobbleBufferRepo{} } return db.MockedScrobbleBuffer } -func (db *MockDataStore) Radio(ctx context.Context) model.RadioRepository { - if db.MockedRadio == nil { - if db.RealDS != nil { - db.MockedRadio = db.RealDS.Radio(ctx) - } else { - db.MockedRadio = CreateMockedRadioRepo() - } +func (db *MockDataStore) Scrobble(ctx context.Context) model.ScrobbleRepository { + if db.MockedScrobble != nil { + return db.MockedScrobble } + if db.RealDS != nil { + return db.RealDS.Scrobble(ctx) + } + db.MockedScrobble = &MockScrobbleRepo{ctx: ctx} + return db.MockedScrobble +} + +func (db *MockDataStore) Radio(ctx context.Context) model.RadioRepository { + if db.MockedRadio != nil { + return db.MockedRadio + } + if db.RealDS != nil { + return db.RealDS.Radio(ctx) + } + db.MockedRadio = CreateMockedRadioRepo() return db.MockedRadio } +func (db *MockDataStore) Plugin(ctx context.Context) model.PluginRepository { + if db.MockedPlugin != nil { + return db.MockedPlugin + } + if db.RealDS != nil { + return db.RealDS.Plugin(ctx) + } + db.MockedPlugin = CreateMockPluginRepo() + return db.MockedPlugin +} + func (db *MockDataStore) WithTx(block func(tx model.DataStore) error, label ...string) error { return block(db) } @@ -217,10 +255,41 @@ func (db *MockDataStore) WithTxImmediate(block func(tx model.DataStore) error, l return block(db) } -func (db *MockDataStore) Resource(context.Context, any) model.ResourceRepository { - return struct{ model.ResourceRepository }{} +func (db *MockDataStore) Resource(ctx context.Context, m any) model.ResourceRepository { + switch m.(type) { + case model.MediaFile, *model.MediaFile: + return db.MediaFile(ctx).(model.ResourceRepository) + case model.Album, *model.Album: + return db.Album(ctx).(model.ResourceRepository) + case model.Artist, *model.Artist: + return db.Artist(ctx).(model.ResourceRepository) + case model.User, *model.User: + return db.User(ctx).(model.ResourceRepository) + case model.Playlist, *model.Playlist: + return db.Playlist(ctx).(model.ResourceRepository) + case model.Radio, *model.Radio: + return db.Radio(ctx).(model.ResourceRepository) + case model.Share, *model.Share: + return db.Share(ctx).(model.ResourceRepository) + case model.Genre, *model.Genre: + return db.Genre(ctx).(model.ResourceRepository) + case model.Tag, *model.Tag: + return db.Tag(ctx).(model.ResourceRepository) + case model.Transcoding, *model.Transcoding: + return db.Transcoding(ctx).(model.ResourceRepository) + case model.Player, *model.Player: + return db.Player(ctx).(model.ResourceRepository) + case model.Plugin, *model.Plugin: + return db.Plugin(ctx).(model.ResourceRepository) + default: + return struct{ model.ResourceRepository }{} + } } -func (db *MockDataStore) GC(context.Context) error { +func (db *MockDataStore) GC(context.Context, ...int) error { + db.GCCalled = true + if db.GCError != nil { + return db.GCError + } return nil } diff --git a/tests/mock_ffmpeg.go b/tests/mock_ffmpeg.go index a792ae9d3..f9862767e 100644 --- a/tests/mock_ffmpeg.go +++ b/tests/mock_ffmpeg.go @@ -1,29 +1,38 @@ package tests import ( + "bytes" "context" "io" "strings" "sync" "sync/atomic" + + "github.com/navidrome/navidrome/core/ffmpeg" ) func NewMockFFmpeg(data string) *MockFFmpeg { - return &MockFFmpeg{Reader: strings.NewReader(data)} + return &MockFFmpeg{Reader: strings.NewReader(data), ProbeAvailable: true} } type MockFFmpeg struct { io.Reader - lock sync.Mutex - closed atomic.Bool - Error error + lock sync.Mutex + closed atomic.Bool + Error error + ProbeAudioResult *ffmpeg.AudioProbeResult + ProbeAvailable bool } func (ff *MockFFmpeg) IsAvailable() bool { return true } -func (ff *MockFFmpeg) Transcode(context.Context, string, string, int, int) (io.ReadCloser, error) { +func (ff *MockFFmpeg) IsProbeAvailable() bool { + return ff.ProbeAvailable +} + +func (ff *MockFFmpeg) Transcode(_ context.Context, _ ffmpeg.TranscodeOptions) (io.ReadCloser, error) { if ff.Error != nil { return nil, ff.Error } @@ -37,12 +46,30 @@ func (ff *MockFFmpeg) ExtractImage(context.Context, string) (io.ReadCloser, erro return ff, nil } +func (ff *MockFFmpeg) ConvertAnimatedImage(_ context.Context, reader io.Reader, _ int, _ int) (io.ReadCloser, error) { + if ff.Error != nil { + return nil, ff.Error + } + data, err := io.ReadAll(reader) + if err != nil { + return nil, err + } + return io.NopCloser(bytes.NewReader(data)), nil +} + func (ff *MockFFmpeg) Probe(context.Context, []string) (string, error) { if ff.Error != nil { return "", ff.Error } return "", nil } +func (ff *MockFFmpeg) ProbeAudioStream(context.Context, string) (*ffmpeg.AudioProbeResult, error) { + if ff.Error != nil { + return nil, ff.Error + } + return ff.ProbeAudioResult, nil +} + func (ff *MockFFmpeg) CmdPath() (string, error) { if ff.Error != nil { return "", ff.Error diff --git a/tests/mock_library_repo.go b/tests/mock_library_repo.go index 907a9d487..3f0e576e9 100644 --- a/tests/mock_library_repo.go +++ b/tests/mock_library_repo.go @@ -1,14 +1,22 @@ package tests import ( + "context" + "errors" + "fmt" + "slices" + "strconv" + + "github.com/Masterminds/squirrel" + "github.com/deluan/rest" "github.com/navidrome/navidrome/model" - "golang.org/x/exp/maps" ) type MockLibraryRepo struct { model.LibraryRepository - Data map[int]model.Library - Err error + Data map[int]model.Library + Err error + PutFn func(*model.Library) error // Allow custom Put behavior for testing } func (m *MockLibraryRepo) SetData(data model.Libraries) { @@ -22,7 +30,54 @@ func (m *MockLibraryRepo) GetAll(...model.QueryOptions) (model.Libraries, error) if m.Err != nil { return nil, m.Err } - return maps.Values(m.Data), nil + var libraries model.Libraries + for _, lib := range m.Data { + libraries = append(libraries, lib) + } + // Sort by ID for predictable order + slices.SortFunc(libraries, func(a, b model.Library) int { + return a.ID - b.ID + }) + return libraries, nil +} + +func (m *MockLibraryRepo) CountAll(qo ...model.QueryOptions) (int64, error) { + if m.Err != nil { + return 0, m.Err + } + + // If no query options, return total count + if len(qo) == 0 || qo[0].Filters == nil { + return int64(len(m.Data)), nil + } + + // Handle squirrel.Eq filter for ID validation + if eq, ok := qo[0].Filters.(squirrel.Eq); ok { + if idFilter, exists := eq["id"]; exists { + if ids, isSlice := idFilter.([]int); isSlice { + count := 0 + for _, id := range ids { + if _, exists := m.Data[id]; exists { + count++ + } + } + return int64(count), nil + } + } + } + + // Default to total count for other filters + return int64(len(m.Data)), nil +} + +func (m *MockLibraryRepo) Get(id int) (*model.Library, error) { + if m.Err != nil { + return nil, m.Err + } + if lib, ok := m.Data[id]; ok { + return &lib, nil + } + return nil, model.ErrNotFound } func (m *MockLibraryRepo) GetPath(id int) (string, error) { @@ -35,4 +90,223 @@ func (m *MockLibraryRepo) GetPath(id int) (string, error) { return "", model.ErrNotFound } -var _ model.LibraryRepository = &MockLibraryRepo{} +func (m *MockLibraryRepo) Put(library *model.Library) error { + if m.PutFn != nil { + return m.PutFn(library) + } + if m.Err != nil { + return m.Err + } + if m.Data == nil { + m.Data = make(map[int]model.Library) + } + m.Data[library.ID] = *library + return nil +} + +func (m *MockLibraryRepo) Delete(id int) error { + if m.Err != nil { + return m.Err + } + if _, ok := m.Data[id]; !ok { + return model.ErrNotFound + } + delete(m.Data, id) + return nil +} + +func (m *MockLibraryRepo) StoreMusicFolder() error { + if m.Err != nil { + return m.Err + } + return nil +} + +func (m *MockLibraryRepo) AddArtist(id int, artistID string) error { + if m.Err != nil { + return m.Err + } + return nil +} + +func (m *MockLibraryRepo) ScanBegin(id int, fullScan bool) error { + if m.Err != nil { + return m.Err + } + return nil +} + +func (m *MockLibraryRepo) ScanEnd(id int) error { + if m.Err != nil { + return m.Err + } + return nil +} + +func (m *MockLibraryRepo) ScanInProgress() (bool, error) { + if m.Err != nil { + return false, m.Err + } + return false, nil +} + +func (m *MockLibraryRepo) RefreshStats(id int) error { + return nil +} + +// User-library association methods - mock implementations + +func (m *MockLibraryRepo) GetUsersWithLibraryAccess(libraryID int) (model.Users, error) { + if m.Err != nil { + return nil, m.Err + } + // Mock: return empty users for now + return model.Users{}, nil +} + +func (m *MockLibraryRepo) Count(options ...rest.QueryOptions) (int64, error) { + return m.CountAll() +} + +func (m *MockLibraryRepo) Read(id string) (any, error) { + idInt, _ := strconv.Atoi(id) + mf, err := m.Get(idInt) + if errors.Is(err, model.ErrNotFound) { + return nil, rest.ErrNotFound + } + return mf, err +} + +func (m *MockLibraryRepo) ReadAll(options ...rest.QueryOptions) (any, error) { + return m.GetAll() +} + +func (m *MockLibraryRepo) EntityName() string { + return "library" +} + +func (m *MockLibraryRepo) NewInstance() any { + return &model.Library{} +} + +// REST Repository methods (string-based IDs) + +func (m *MockLibraryRepo) Save(entity any) (string, error) { + lib := entity.(*model.Library) + if m.Err != nil { + return "", m.Err + } + + // Validate required fields + if lib.Name == "" { + return "", &rest.ValidationError{Errors: map[string]string{"name": "library name is required"}} + } + if lib.Path == "" { + return "", &rest.ValidationError{Errors: map[string]string{"path": "library path is required"}} + } + + // Generate ID if not set + if lib.ID == 0 { + lib.ID = len(m.Data) + 1 + } + if m.Data == nil { + m.Data = make(map[int]model.Library) + } + m.Data[lib.ID] = *lib + return strconv.Itoa(lib.ID), nil +} + +func (m *MockLibraryRepo) Update(id string, entity any, cols ...string) error { + lib := entity.(*model.Library) + if m.Err != nil { + return m.Err + } + + // Validate required fields + if lib.Name == "" { + return &rest.ValidationError{Errors: map[string]string{"name": "library name is required"}} + } + if lib.Path == "" { + return &rest.ValidationError{Errors: map[string]string{"path": "library path is required"}} + } + + idInt, err := strconv.Atoi(id) + if err != nil { + return errors.New("invalid ID format") + } + if _, exists := m.Data[idInt]; !exists { + return rest.ErrNotFound + } + lib.ID = idInt + m.Data[idInt] = *lib + return nil +} + +func (m *MockLibraryRepo) DeleteByStringID(id string) error { + if m.Err != nil { + return m.Err + } + idInt, err := strconv.Atoi(id) + if err != nil { + return errors.New("invalid ID format") + } + if _, exists := m.Data[idInt]; !exists { + return rest.ErrNotFound + } + delete(m.Data, idInt) + return nil +} + +// Service-level methods for core.Library interface + +func (m *MockLibraryRepo) GetUserLibraries(ctx context.Context, userID string) (model.Libraries, error) { + if m.Err != nil { + return nil, m.Err + } + if userID == "non-existent" { + return nil, model.ErrNotFound + } + // Convert map to slice for return + var libraries model.Libraries + for _, lib := range m.Data { + libraries = append(libraries, lib) + } + // Sort by ID for predictable order + slices.SortFunc(libraries, func(a, b model.Library) int { + return a.ID - b.ID + }) + return libraries, nil +} + +func (m *MockLibraryRepo) SetUserLibraries(ctx context.Context, userID string, libraryIDs []int) error { + if m.Err != nil { + return m.Err + } + if userID == "non-existent" { + return model.ErrNotFound + } + if userID == "admin-1" { + return fmt.Errorf("%w: cannot manually assign libraries to admin users", model.ErrValidation) + } + if len(libraryIDs) == 0 { + return fmt.Errorf("%w: at least one library must be assigned to non-admin users", model.ErrValidation) + } + // Validate all library IDs exist + for _, id := range libraryIDs { + if _, exists := m.Data[id]; !exists { + return fmt.Errorf("%w: library ID %d does not exist", model.ErrValidation, id) + } + } + return nil +} + +func (m *MockLibraryRepo) ValidateLibraryAccess(ctx context.Context, userID string, libraryID int) error { + if m.Err != nil { + return m.Err + } + // For testing purposes, allow access to all libraries + return nil +} + +var _ model.LibraryRepository = (*MockLibraryRepo)(nil) +var _ model.ResourceRepository = (*MockLibraryRepo)(nil) diff --git a/tests/mock_library_service.go b/tests/mock_library_service.go new file mode 100644 index 000000000..78693197d --- /dev/null +++ b/tests/mock_library_service.go @@ -0,0 +1,44 @@ +package tests + +import ( + "context" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" +) + +// MockLibraryService provides a simple wrapper around MockLibraryRepo +// that implements the core.Library interface for testing. +// Returns concrete type to avoid import cycles - callers assign to core.Library. +type MockLibraryService struct { + *MockLibraryRepo +} + +// MockLibraryRestAdapter adapts MockLibraryRepo to rest.Repository interface +type MockLibraryRestAdapter struct { + *MockLibraryRepo +} + +// NewMockLibraryService creates a new mock library service for testing. +// Returns concrete type - assign to core.Library at call site. +func NewMockLibraryService() *MockLibraryService { + repo := &MockLibraryRepo{ + Data: make(map[int]model.Library), + } + // Set up default test data + repo.SetData(model.Libraries{ + {ID: 1, Name: "Test Library 1", Path: "/music/library1"}, + {ID: 2, Name: "Test Library 2", Path: "/music/library2"}, + }) + return &MockLibraryService{MockLibraryRepo: repo} +} + +func (m *MockLibraryService) NewRepository(ctx context.Context) rest.Repository { + return &MockLibraryRestAdapter{MockLibraryRepo: m.MockLibraryRepo} +} + +// rest.Repository interface implementation + +func (a *MockLibraryRestAdapter) Delete(id string) error { + return a.DeleteByStringID(id) +} diff --git a/tests/mock_mediafile_repo.go b/tests/mock_mediafile_repo.go index 85adb8a25..01eacae30 100644 --- a/tests/mock_mediafile_repo.go +++ b/tests/mock_mediafile_repo.go @@ -7,6 +7,7 @@ import ( "slices" "time" + "github.com/deluan/rest" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/model/id" "github.com/navidrome/navidrome/utils/slice" @@ -26,6 +27,10 @@ type MockMediaFileRepo struct { CountAllValue int64 CountAllOptions model.QueryOptions DeleteAllMissingValue int64 + Options model.QueryOptions + // Add fields for cross-library move detection tests + FindRecentFilesByMBZTrackIDFunc func(missing model.MediaFile, since time.Time) (model.MediaFiles, error) + FindRecentFilesByPropertiesFunc func(missing model.MediaFile, since time.Time) (model.MediaFiles, error) } func (m *MockMediaFileRepo) SetError(err bool) { @@ -71,14 +76,26 @@ func (m *MockMediaFileRepo) GetWithParticipants(id string) (*model.MediaFile, er return nil, model.ErrNotFound } -func (m *MockMediaFileRepo) GetAll(...model.QueryOptions) (model.MediaFiles, error) { +func (m *MockMediaFileRepo) GetAllByTags(_ model.TagName, _ []string, options ...model.QueryOptions) (model.MediaFiles, error) { + return m.GetAll(options...) +} + +func (m *MockMediaFileRepo) GetAll(qo ...model.QueryOptions) (model.MediaFiles, error) { + if len(qo) > 0 { + m.Options = qo[0] + } if m.Err { return nil, errors.New("error") } values := slices.Collect(maps.Values(m.Data)) - return slice.Map(values, func(p *model.MediaFile) model.MediaFile { + result := slice.Map(values, func(p *model.MediaFile) model.MediaFile { return *p - }), nil + }) + // Sort by ID to ensure deterministic ordering for tests + slices.SortFunc(result, func(a, b model.MediaFile) int { + return cmp.Compare(a.ID, b.ID) + }) + return result, nil } func (m *MockMediaFileRepo) Put(mf *model.MediaFile) error { @@ -92,6 +109,17 @@ func (m *MockMediaFileRepo) Put(mf *model.MediaFile) error { return nil } +func (m *MockMediaFileRepo) UpdateProbeData(id string, data string) error { + if m.Err { + return errors.New("error") + } + if d, ok := m.Data[id]; ok { + d.ProbeData = data + return nil + } + return model.ErrNotFound +} + func (m *MockMediaFileRepo) Delete(id string) error { if m.Err { return errors.New("error") @@ -196,4 +224,91 @@ func (m *MockMediaFileRepo) DeleteAllMissing() (int64, error) { return count, nil } +// ResourceRepository methods +func (m *MockMediaFileRepo) Count(...rest.QueryOptions) (int64, error) { + return m.CountAll() +} + +func (m *MockMediaFileRepo) Read(id string) (any, error) { + mf, err := m.Get(id) + if errors.Is(err, model.ErrNotFound) { + return nil, rest.ErrNotFound + } + return mf, err +} + +func (m *MockMediaFileRepo) ReadAll(...rest.QueryOptions) (any, error) { + return m.GetAll() +} + +func (m *MockMediaFileRepo) EntityName() string { + return "mediafile" +} + +func (m *MockMediaFileRepo) NewInstance() any { + return &model.MediaFile{} +} + +func (m *MockMediaFileRepo) Search(q string, options ...model.QueryOptions) (model.MediaFiles, error) { + if len(options) > 0 { + m.Options = options[0] + } + if m.Err { + return nil, errors.New("unexpected error") + } + // Simple mock implementation - just return all media files for testing + allFiles, err := m.GetAll() + return allFiles, err +} + +// Cross-library move detection mock methods +func (m *MockMediaFileRepo) FindRecentFilesByMBZTrackID(missing model.MediaFile, since time.Time) (model.MediaFiles, error) { + if m.Err { + return nil, errors.New("error") + } + if m.FindRecentFilesByMBZTrackIDFunc != nil { + return m.FindRecentFilesByMBZTrackIDFunc(missing, since) + } + // Default implementation: find files with same MBZ Track ID in other libraries + var result model.MediaFiles + for _, mf := range m.Data { + if mf.LibraryID != missing.LibraryID && + mf.MbzReleaseTrackID == missing.MbzReleaseTrackID && + mf.MbzReleaseTrackID != "" && + mf.Suffix == missing.Suffix && + mf.CreatedAt.After(since) && + !mf.Missing { + result = append(result, *mf) + } + } + return result, nil +} + +func (m *MockMediaFileRepo) FindRecentFilesByProperties(missing model.MediaFile, since time.Time) (model.MediaFiles, error) { + if m.Err { + return nil, errors.New("error") + } + if m.FindRecentFilesByPropertiesFunc != nil { + return m.FindRecentFilesByPropertiesFunc(missing, since) + } + // Default implementation: find files with same properties in other libraries + var result model.MediaFiles + for _, mf := range m.Data { + if mf.LibraryID != missing.LibraryID && + mf.Title == missing.Title && + mf.Size == missing.Size && + mf.Suffix == missing.Suffix && + mf.DiscNumber == missing.DiscNumber && + mf.TrackNumber == missing.TrackNumber && + mf.Album == missing.Album && + mf.MbzReleaseTrackID == "" && // Exclude files with MBZ Track ID + mf.CreatedAt.After(since) && + !mf.Missing { + result = append(result, *mf) + } + } + return result, nil +} + var _ model.MediaFileRepository = (*MockMediaFileRepo)(nil) +var _ model.ResourceRepository = (*MockMediaFileRepo)(nil) diff --git a/tests/mock_playlist_repo.go b/tests/mock_playlist_repo.go index 60dc98be9..9b38ea5b5 100644 --- a/tests/mock_playlist_repo.go +++ b/tests/mock_playlist_repo.go @@ -1,33 +1,111 @@ package tests import ( + "errors" + "github.com/deluan/rest" "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/id" ) +func CreateMockPlaylistRepo() *MockPlaylistRepo { + return &MockPlaylistRepo{ + Data: make(map[string]*model.Playlist), + PathMap: make(map[string]*model.Playlist), + } +} + type MockPlaylistRepo struct { model.PlaylistRepository - - Entity *model.Playlist - Error error + Data map[string]*model.Playlist // keyed by ID + PathMap map[string]*model.Playlist // keyed by path + Last *model.Playlist + Deleted []string + Err bool + TracksRepo model.PlaylistTrackRepository } -func (m *MockPlaylistRepo) Get(_ string) (*model.Playlist, error) { - if m.Error != nil { - return nil, m.Error +func (m *MockPlaylistRepo) SetError(err bool) { + m.Err = err +} + +func (m *MockPlaylistRepo) Get(id string) (*model.Playlist, error) { + if m.Err { + return nil, errors.New("error") } - if m.Entity == nil { - return nil, model.ErrNotFound + if m.Data != nil { + if pls, ok := m.Data[id]; ok { + return pls, nil + } } - return m.Entity, nil + return nil, model.ErrNotFound +} + +func (m *MockPlaylistRepo) GetWithTracks(id string, _, _ bool) (*model.Playlist, error) { + return m.Get(id) +} + +func (m *MockPlaylistRepo) Put(pls *model.Playlist, _ ...string) error { + if m.Err { + return errors.New("error") + } + if pls.ID == "" { + pls.ID = id.NewRandom() + } + m.Last = pls + if m.Data != nil { + m.Data[pls.ID] = pls + } + return nil +} + +func (m *MockPlaylistRepo) FindByPath(path string) (*model.Playlist, error) { + if m.Err { + return nil, errors.New("error") + } + if m.PathMap != nil { + if pls, ok := m.PathMap[path]; ok { + return pls, nil + } + } + return nil, model.ErrNotFound +} + +func (m *MockPlaylistRepo) Delete(id string) error { + if m.Err { + return errors.New("error") + } + m.Deleted = append(m.Deleted, id) + return nil +} + +func (m *MockPlaylistRepo) Tracks(_ string, _ bool) model.PlaylistTrackRepository { + return m.TracksRepo +} + +func (m *MockPlaylistRepo) Exists(id string) (bool, error) { + if m.Err { + return false, errors.New("error") + } + if m.Data != nil { + _, found := m.Data[id] + return found, nil + } + return false, nil } func (m *MockPlaylistRepo) Count(_ ...rest.QueryOptions) (int64, error) { - if m.Error != nil { - return 0, m.Error + if m.Err { + return 0, errors.New("error") } - if m.Entity == nil { - return 0, nil - } - return 1, nil + return int64(len(m.Data)), nil } + +func (m *MockPlaylistRepo) CountAll(_ ...model.QueryOptions) (int64, error) { + if m.Err { + return 0, errors.New("error") + } + return int64(len(m.Data)), nil +} + +var _ model.PlaylistRepository = (*MockPlaylistRepo)(nil) diff --git a/tests/mock_playlist_track_repo.go b/tests/mock_playlist_track_repo.go new file mode 100644 index 000000000..c11b077d2 --- /dev/null +++ b/tests/mock_playlist_track_repo.go @@ -0,0 +1,53 @@ +package tests + +import "github.com/navidrome/navidrome/model" + +type MockPlaylistTrackRepo struct { + model.PlaylistTrackRepository + AddedIds []string + DeletedIds []string + Reordered bool + AddCount int + Err error +} + +func (m *MockPlaylistTrackRepo) Add(ids []string) (int, error) { + m.AddedIds = append(m.AddedIds, ids...) + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) AddAlbums(_ []string) (int, error) { + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) AddArtists(_ []string) (int, error) { + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) AddDiscs(_ []model.DiscID) (int, error) { + if m.Err != nil { + return 0, m.Err + } + return m.AddCount, nil +} + +func (m *MockPlaylistTrackRepo) Delete(ids ...string) error { + m.DeletedIds = append(m.DeletedIds, ids...) + return m.Err +} + +func (m *MockPlaylistTrackRepo) Reorder(_, _ int) error { + m.Reordered = true + return m.Err +} + +var _ model.PlaylistTrackRepository = (*MockPlaylistTrackRepo)(nil) diff --git a/tests/mock_playqueue_repo.go b/tests/mock_playqueue_repo.go new file mode 100644 index 000000000..19976db57 --- /dev/null +++ b/tests/mock_playqueue_repo.go @@ -0,0 +1,65 @@ +package tests + +import ( + "errors" + + "github.com/navidrome/navidrome/model" +) + +type MockPlayQueueRepo struct { + model.PlayQueueRepository + Queue *model.PlayQueue + Err bool + LastCols []string +} + +func (m *MockPlayQueueRepo) Store(q *model.PlayQueue, cols ...string) error { + if m.Err { + return errors.New("error") + } + copyItems := make(model.MediaFiles, len(q.Items)) + copy(copyItems, q.Items) + qCopy := *q + qCopy.Items = copyItems + m.Queue = &qCopy + m.LastCols = cols + return nil +} + +func (m *MockPlayQueueRepo) RetrieveWithMediaFiles(userId string) (*model.PlayQueue, error) { + if m.Err { + return nil, errors.New("error") + } + if m.Queue == nil || m.Queue.UserID != userId { + return nil, model.ErrNotFound + } + copyItems := make(model.MediaFiles, len(m.Queue.Items)) + copy(copyItems, m.Queue.Items) + qCopy := *m.Queue + qCopy.Items = copyItems + return &qCopy, nil +} + +func (m *MockPlayQueueRepo) Retrieve(userId string) (*model.PlayQueue, error) { + if m.Err { + return nil, errors.New("error") + } + if m.Queue == nil || m.Queue.UserID != userId { + return nil, model.ErrNotFound + } + copyItems := make(model.MediaFiles, len(m.Queue.Items)) + for i, t := range m.Queue.Items { + copyItems[i] = model.MediaFile{ID: t.ID} + } + qCopy := *m.Queue + qCopy.Items = copyItems + return &qCopy, nil +} + +func (m *MockPlayQueueRepo) Clear(userId string) error { + if m.Err { + return errors.New("error") + } + m.Queue = nil + return nil +} diff --git a/tests/mock_plugin_manager.go b/tests/mock_plugin_manager.go new file mode 100644 index 000000000..05375f31c --- /dev/null +++ b/tests/mock_plugin_manager.go @@ -0,0 +1,132 @@ +package tests + +import ( + "context" +) + +// MockPluginManager is a mock implementation of plugins.PluginManager for testing. +// It implements EnablePlugin, DisablePlugin, UpdatePluginConfig, ValidatePluginConfig, UpdatePluginUsers, UpdatePluginLibraries and RescanPlugins methods. +type MockPluginManager struct { + // EnablePluginFn is called when EnablePlugin is invoked. If nil, returns EnableError. + EnablePluginFn func(ctx context.Context, id string) error + // DisablePluginFn is called when DisablePlugin is invoked. If nil, returns DisableError. + DisablePluginFn func(ctx context.Context, id string) error + // UpdatePluginConfigFn is called when UpdatePluginConfig is invoked. If nil, returns ConfigError. + UpdatePluginConfigFn func(ctx context.Context, id, configJSON string) error + // ValidatePluginConfigFn is called when ValidatePluginConfig is invoked. If nil, returns ValidateError. + ValidatePluginConfigFn func(ctx context.Context, id, configJSON string) error + // UpdatePluginUsersFn is called when UpdatePluginUsers is invoked. If nil, returns UsersError. + UpdatePluginUsersFn func(ctx context.Context, id, usersJSON string, allUsers bool) error + // UpdatePluginLibrariesFn is called when UpdatePluginLibraries is invoked. If nil, returns LibrariesError. + UpdatePluginLibrariesFn func(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error + // RescanPluginsFn is called when RescanPlugins is invoked. If nil, returns RescanError. + RescanPluginsFn func(ctx context.Context) error + + // Default errors to return when Fn callbacks are not set + EnableError error + DisableError error + ConfigError error + ValidateError error + UsersError error + LibrariesError error + RescanError error + + // Track calls for assertions + EnablePluginCalls []string + DisablePluginCalls []string + UpdatePluginConfigCalls []struct { + ID string + ConfigJSON string + } + ValidatePluginConfigCalls []struct { + ID string + ConfigJSON string + } + UpdatePluginUsersCalls []struct { + ID string + UsersJSON string + AllUsers bool + } + UpdatePluginLibrariesCalls []struct { + ID string + LibrariesJSON string + AllLibraries bool + AllowWriteAccess bool + } + RescanPluginsCalls int +} + +func (m *MockPluginManager) EnablePlugin(ctx context.Context, id string) error { + m.EnablePluginCalls = append(m.EnablePluginCalls, id) + if m.EnablePluginFn != nil { + return m.EnablePluginFn(ctx, id) + } + return m.EnableError +} + +func (m *MockPluginManager) DisablePlugin(ctx context.Context, id string) error { + m.DisablePluginCalls = append(m.DisablePluginCalls, id) + if m.DisablePluginFn != nil { + return m.DisablePluginFn(ctx, id) + } + return m.DisableError +} + +func (m *MockPluginManager) UpdatePluginConfig(ctx context.Context, id, configJSON string) error { + m.UpdatePluginConfigCalls = append(m.UpdatePluginConfigCalls, struct { + ID string + ConfigJSON string + }{ID: id, ConfigJSON: configJSON}) + if m.UpdatePluginConfigFn != nil { + return m.UpdatePluginConfigFn(ctx, id, configJSON) + } + return m.ConfigError +} + +func (m *MockPluginManager) ValidatePluginConfig(ctx context.Context, id, configJSON string) error { + m.ValidatePluginConfigCalls = append(m.ValidatePluginConfigCalls, struct { + ID string + ConfigJSON string + }{ID: id, ConfigJSON: configJSON}) + if m.ValidatePluginConfigFn != nil { + return m.ValidatePluginConfigFn(ctx, id, configJSON) + } + return m.ValidateError +} + +func (m *MockPluginManager) UpdatePluginUsers(ctx context.Context, id, usersJSON string, allUsers bool) error { + m.UpdatePluginUsersCalls = append(m.UpdatePluginUsersCalls, struct { + ID string + UsersJSON string + AllUsers bool + }{ID: id, UsersJSON: usersJSON, AllUsers: allUsers}) + if m.UpdatePluginUsersFn != nil { + return m.UpdatePluginUsersFn(ctx, id, usersJSON, allUsers) + } + return m.UsersError +} + +func (m *MockPluginManager) UpdatePluginLibraries(ctx context.Context, id, librariesJSON string, allLibraries, allowWriteAccess bool) error { + m.UpdatePluginLibrariesCalls = append(m.UpdatePluginLibrariesCalls, struct { + ID string + LibrariesJSON string + AllLibraries bool + AllowWriteAccess bool + }{ID: id, LibrariesJSON: librariesJSON, AllLibraries: allLibraries, AllowWriteAccess: allowWriteAccess}) + if m.UpdatePluginLibrariesFn != nil { + return m.UpdatePluginLibrariesFn(ctx, id, librariesJSON, allLibraries, allowWriteAccess) + } + return m.LibrariesError +} + +func (m *MockPluginManager) RescanPlugins(ctx context.Context) error { + m.RescanPluginsCalls++ + if m.RescanPluginsFn != nil { + return m.RescanPluginsFn(ctx) + } + return m.RescanError +} + +func (m *MockPluginManager) UnloadDisabledPlugins(ctx context.Context) { + // No-op for mock - plugins are not actually loaded in tests +} diff --git a/tests/mock_plugin_repo.go b/tests/mock_plugin_repo.go new file mode 100644 index 000000000..5d22c26aa --- /dev/null +++ b/tests/mock_plugin_repo.go @@ -0,0 +1,188 @@ +package tests + +import ( + "errors" + "time" + + "github.com/deluan/rest" + "github.com/navidrome/navidrome/model" +) + +func CreateMockPluginRepo() *MockPluginRepo { + return &MockPluginRepo{ + Data: make(map[string]*model.Plugin), + IsAdmin: true, // Default to admin access + Permitted: true, + } +} + +type MockPluginRepo struct { + Data map[string]*model.Plugin + All model.Plugins + Err bool + Options model.QueryOptions + IsAdmin bool + Permitted bool +} + +func (m *MockPluginRepo) SetError(err bool) { + m.Err = err +} + +func (m *MockPluginRepo) ClearErrors() error { + if m.Err { + return errors.New("unexpected error") + } + for i := range m.All { + m.All[i].LastError = "" + } + for k, p := range m.Data { + p.LastError = "" + m.Data[k] = p + } + return nil +} + +func (m *MockPluginRepo) SetData(plugins model.Plugins) { + m.Data = make(map[string]*model.Plugin, len(plugins)) + m.All = plugins + for i, p := range m.All { + m.Data[p.ID] = &m.All[i] + } +} + +func (m *MockPluginRepo) SetPermitted(permitted bool) { + m.Permitted = permitted +} + +func (m *MockPluginRepo) Get(id string) (*model.Plugin, error) { + if !m.Permitted { + return nil, rest.ErrPermissionDenied + } + if m.Err { + return nil, errors.New("unexpected error") + } + if d, ok := m.Data[id]; ok { + return d, nil + } + return nil, model.ErrNotFound +} + +func (m *MockPluginRepo) Read(id string) (any, error) { + p, err := m.Get(id) + if errors.Is(err, model.ErrNotFound) { + return nil, rest.ErrNotFound + } + return p, err +} + +func (m *MockPluginRepo) Put(p *model.Plugin) error { + if !m.Permitted { + return rest.ErrPermissionDenied + } + if m.Err { + return errors.New("unexpected error") + } + if p.ID == "" { + return errors.New("plugin ID cannot be empty") + } + now := time.Now() + if existing, ok := m.Data[p.ID]; ok { + p.CreatedAt = existing.CreatedAt + } else { + p.CreatedAt = now + } + p.UpdatedAt = now + m.Data[p.ID] = p + // Update All slice + found := false + for i, existing := range m.All { + if existing.ID == p.ID { + m.All[i] = *p + found = true + break + } + } + if !found { + m.All = append(m.All, *p) + } + return nil +} + +func (m *MockPluginRepo) Delete(id string) error { + if !m.Permitted { + return rest.ErrPermissionDenied + } + if m.Err { + return errors.New("unexpected error") + } + delete(m.Data, id) + // Update All slice + for i, p := range m.All { + if p.ID == id { + m.All = append(m.All[:i], m.All[i+1:]...) + break + } + } + return nil +} + +func (m *MockPluginRepo) GetAll(qo ...model.QueryOptions) (model.Plugins, error) { + if len(qo) > 0 { + m.Options = qo[0] + } + if !m.Permitted { + return nil, rest.ErrPermissionDenied + } + if m.Err { + return nil, errors.New("unexpected error") + } + return m.All, nil +} + +func (m *MockPluginRepo) CountAll(qo ...model.QueryOptions) (int64, error) { + if len(qo) > 0 { + m.Options = qo[0] + } + if !m.Permitted { + return 0, rest.ErrPermissionDenied + } + if m.Err { + return 0, errors.New("unexpected error") + } + return int64(len(m.All)), nil +} + +// rest.Repository interface methods +func (m *MockPluginRepo) Count(options ...rest.QueryOptions) (int64, error) { + if !m.Permitted { + return 0, rest.ErrPermissionDenied + } + return int64(len(m.All)), nil +} + +func (m *MockPluginRepo) EntityName() string { + return "plugin" +} + +func (m *MockPluginRepo) NewInstance() any { + return &model.Plugin{} +} + +func (m *MockPluginRepo) ReadAll(options ...rest.QueryOptions) (any, error) { + return m.GetAll() +} + +func (m *MockPluginRepo) Save(entity any) (string, error) { + p := entity.(*model.Plugin) + err := m.Put(p) + return p.ID, err +} + +func (m *MockPluginRepo) Update(id string, entity any, cols ...string) error { + p := entity.(*model.Plugin) + p.ID = id + return m.Put(p) +} + +var _ model.PluginRepository = (*MockPluginRepo)(nil) diff --git a/tests/mock_radio_repository.go b/tests/mock_radio_repository.go index 279b735db..c50a529e5 100644 --- a/tests/mock_radio_repository.go +++ b/tests/mock_radio_repository.go @@ -73,7 +73,7 @@ func (m *MockedRadioRepo) GetAll(qo ...model.QueryOptions) (model.Radios, error) return m.All, nil } -func (m *MockedRadioRepo) Put(radio *model.Radio) error { +func (m *MockedRadioRepo) Put(radio *model.Radio, _ ...string) error { if m.Err { return errors.New("error") } diff --git a/tests/mock_scanner.go b/tests/mock_scanner.go new file mode 100644 index 000000000..495e8fe53 --- /dev/null +++ b/tests/mock_scanner.go @@ -0,0 +1,143 @@ +package tests + +import ( + "context" + "sync" + + "github.com/navidrome/navidrome/model" +) + +// MockScanner implements scanner.Scanner for testing with proper synchronization +type MockScanner struct { + mu sync.Mutex + scanAllCalls []ScanAllCall + scanFoldersCalls []ScanFoldersCall + scanningStatus bool + statusResponse *model.ScannerStatus + scanStatusFunc func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus +} + +type ScanAllCall struct { + FullScan bool +} + +type ScanFoldersCall struct { + FullScan bool + Targets []model.ScanTarget +} + +func NewMockScanner() *MockScanner { + return &MockScanner{ + scanAllCalls: make([]ScanAllCall, 0), + scanFoldersCalls: make([]ScanFoldersCall, 0), + } +} + +func (m *MockScanner) ScanAll(_ context.Context, fullScan bool) ([]string, error) { + m.mu.Lock() + defer m.mu.Unlock() + + m.scanAllCalls = append(m.scanAllCalls, ScanAllCall{FullScan: fullScan}) + + // Simulate the scanner updating its status when the scan starts + if m.scanStatusFunc != nil { + m.statusResponse = m.scanStatusFunc(fullScan, nil) + } else { + m.scanningStatus = true + } + + return nil, nil +} + +func (m *MockScanner) ScanFolders(_ context.Context, fullScan bool, targets []model.ScanTarget) ([]string, error) { + m.mu.Lock() + defer m.mu.Unlock() + + // Make a copy of targets to avoid race conditions + targetsCopy := make([]model.ScanTarget, len(targets)) + copy(targetsCopy, targets) + + m.scanFoldersCalls = append(m.scanFoldersCalls, ScanFoldersCall{ + FullScan: fullScan, + Targets: targetsCopy, + }) + + // Simulate the scanner updating its status when the scan starts + if m.scanStatusFunc != nil { + m.statusResponse = m.scanStatusFunc(fullScan, targetsCopy) + } else { + m.scanningStatus = true + } + + return nil, nil +} + +func (m *MockScanner) Status(_ context.Context) (*model.ScannerStatus, error) { + m.mu.Lock() + defer m.mu.Unlock() + + if m.statusResponse != nil { + return m.statusResponse, nil + } + + return &model.ScannerStatus{ + Scanning: m.scanningStatus, + }, nil +} + +func (m *MockScanner) GetScanAllCallCount() int { + m.mu.Lock() + defer m.mu.Unlock() + return len(m.scanAllCalls) +} + +func (m *MockScanner) GetScanAllCalls() []ScanAllCall { + m.mu.Lock() + defer m.mu.Unlock() + // Return a copy to avoid race conditions + calls := make([]ScanAllCall, len(m.scanAllCalls)) + copy(calls, m.scanAllCalls) + return calls +} + +func (m *MockScanner) GetScanFoldersCallCount() int { + m.mu.Lock() + defer m.mu.Unlock() + return len(m.scanFoldersCalls) +} + +func (m *MockScanner) GetScanFoldersCalls() []ScanFoldersCall { + m.mu.Lock() + defer m.mu.Unlock() + // Return a copy to avoid race conditions + calls := make([]ScanFoldersCall, len(m.scanFoldersCalls)) + copy(calls, m.scanFoldersCalls) + return calls +} + +func (m *MockScanner) Reset() { + m.mu.Lock() + defer m.mu.Unlock() + m.scanAllCalls = make([]ScanAllCall, 0) + m.scanFoldersCalls = make([]ScanFoldersCall, 0) +} + +func (m *MockScanner) SetScanning(scanning bool) { + m.mu.Lock() + defer m.mu.Unlock() + m.scanningStatus = scanning +} + +func (m *MockScanner) SetStatusResponse(status *model.ScannerStatus) { + m.mu.Lock() + defer m.mu.Unlock() + m.statusResponse = status +} + +// SetScanStatusFunc sets a function that will be called when ScanAll/ScanFolders is invoked, +// simulating the scanner updating its status when the scan starts. +func (m *MockScanner) SetScanStatusFunc(fn func(fullScan bool, targets []model.ScanTarget) *model.ScannerStatus) { + m.mu.Lock() + defer m.mu.Unlock() + m.scanStatusFunc = fn +} diff --git a/tests/mock_scrobble_buffer_repo.go b/tests/mock_scrobble_buffer_repo.go index 407c673eb..5865f423a 100644 --- a/tests/mock_scrobble_buffer_repo.go +++ b/tests/mock_scrobble_buffer_repo.go @@ -1,6 +1,7 @@ package tests import ( + "sync" "time" "github.com/navidrome/navidrome/model" @@ -9,6 +10,7 @@ import ( type MockedScrobbleBufferRepo struct { Error error Data model.ScrobbleEntries + mu sync.RWMutex } func CreateMockedScrobbleBufferRepo() *MockedScrobbleBufferRepo { @@ -19,6 +21,8 @@ func (m *MockedScrobbleBufferRepo) UserIDs(service string) ([]string, error) { if m.Error != nil { return nil, m.Error } + m.mu.RLock() + defer m.mu.RUnlock() userIds := make(map[string]struct{}) for _, e := range m.Data { if e.Service == service { @@ -36,6 +40,8 @@ func (m *MockedScrobbleBufferRepo) Enqueue(service, userId, mediaFileId string, if m.Error != nil { return m.Error } + m.mu.Lock() + defer m.mu.Unlock() m.Data = append(m.Data, model.ScrobbleEntry{ MediaFile: model.MediaFile{ID: mediaFileId}, Service: service, @@ -50,6 +56,8 @@ func (m *MockedScrobbleBufferRepo) Next(service, userId string) (*model.Scrobble if m.Error != nil { return nil, m.Error } + m.mu.RLock() + defer m.mu.RUnlock() for _, e := range m.Data { if e.Service == service && e.UserID == userId { return &e, nil @@ -62,6 +70,8 @@ func (m *MockedScrobbleBufferRepo) Dequeue(entry *model.ScrobbleEntry) error { if m.Error != nil { return m.Error } + m.mu.Lock() + defer m.mu.Unlock() newData := model.ScrobbleEntries{} for _, e := range m.Data { if e.Service == entry.Service && e.UserID == entry.UserID && e.PlayTime == entry.PlayTime && e.MediaFile.ID == entry.MediaFile.ID { @@ -77,5 +87,7 @@ func (m *MockedScrobbleBufferRepo) Length() (int64, error) { if m.Error != nil { return 0, m.Error } + m.mu.RLock() + defer m.mu.RUnlock() return int64(len(m.Data)), nil } diff --git a/tests/mock_scrobble_repo.go b/tests/mock_scrobble_repo.go new file mode 100644 index 000000000..34561c257 --- /dev/null +++ b/tests/mock_scrobble_repo.go @@ -0,0 +1,24 @@ +package tests + +import ( + "context" + "time" + + "github.com/navidrome/navidrome/model" + "github.com/navidrome/navidrome/model/request" +) + +type MockScrobbleRepo struct { + RecordedScrobbles []model.Scrobble + ctx context.Context +} + +func (m *MockScrobbleRepo) RecordScrobble(fileID string, submissionTime time.Time) error { + user, _ := request.UserFrom(m.ctx) + m.RecordedScrobbles = append(m.RecordedScrobbles, model.Scrobble{ + MediaFileID: fileID, + UserID: user.ID, + SubmissionTime: submissionTime, + }) + return nil +} diff --git a/tests/mock_share_repo.go b/tests/mock_share_repo.go index ef026ca34..9fbf0057e 100644 --- a/tests/mock_share_repo.go +++ b/tests/mock_share_repo.go @@ -10,13 +10,13 @@ type MockShareRepo struct { rest.Repository rest.Persistable - Entity interface{} + Entity any ID string Cols []string Error error } -func (m *MockShareRepo) Save(entity interface{}) (string, error) { +func (m *MockShareRepo) Save(entity any) (string, error) { if m.Error != nil { return "", m.Error } @@ -28,7 +28,7 @@ func (m *MockShareRepo) Save(entity interface{}) (string, error) { return s.ID, nil } -func (m *MockShareRepo) Update(id string, entity interface{}, cols ...string) error { +func (m *MockShareRepo) Update(id string, entity any, cols ...string) error { if m.Error != nil { return m.Error } @@ -44,3 +44,16 @@ func (m *MockShareRepo) Exists(id string) (bool, error) { } return id == m.ID, nil } + +func (m *MockShareRepo) Get(id string) (*model.Share, error) { + if m.Error != nil { + return nil, m.Error + } + if id != m.ID { + return nil, model.ErrNotFound + } + if s, ok := m.Entity.(*model.Share); ok { + return s, nil + } + return &model.Share{ID: id}, nil +} diff --git a/tests/mock_transcoding_repo.go b/tests/mock_transcoding_repo.go index 12db0d7be..641daca8a 100644 --- a/tests/mock_transcoding_repo.go +++ b/tests/mock_transcoding_repo.go @@ -18,6 +18,10 @@ func (m *MockTranscodingRepo) FindByFormat(format string) (*model.Transcoding, e return &model.Transcoding{ID: "oga1", TargetFormat: "oga", DefaultBitRate: 128}, nil case "opus": return &model.Transcoding{ID: "opus1", TargetFormat: "opus", DefaultBitRate: 96}, nil + case "flac": + return &model.Transcoding{ID: "flac1", TargetFormat: "flac", DefaultBitRate: 0, Command: "ffmpeg -ss %t -i %s -map 0:a:0 -v 0 -c:a flac -f flac -"}, nil + case "aac": + return &model.Transcoding{ID: "aac1", TargetFormat: "aac", DefaultBitRate: 256, Command: "ffmpeg -ss %t -i %s -map 0:a:0 -b:a %bk -v 0 -c:a aac -f ipod -movflags frag_keyframe+empty_moov -"}, nil default: return nil, model.ErrNotFound } diff --git a/tests/mock_user_repo.go b/tests/mock_user_repo.go index 09d804ccd..7c7dadbc4 100644 --- a/tests/mock_user_repo.go +++ b/tests/mock_user_repo.go @@ -2,23 +2,25 @@ package tests import ( "encoding/base64" + "fmt" "strings" "time" "github.com/navidrome/navidrome/model" - "github.com/navidrome/navidrome/utils/gg" ) func CreateMockUserRepo() *MockedUserRepo { return &MockedUserRepo{ - Data: map[string]*model.User{}, + Data: map[string]*model.User{}, + UserLibraries: map[string][]int{}, } } type MockedUserRepo struct { model.UserRepository - Error error - Data map[string]*model.User + Error error + Data map[string]*model.User + UserLibraries map[string][]int // userID -> libraryIDs } func (u *MockedUserRepo) CountAll(qo ...model.QueryOptions) (int64, error) { @@ -55,10 +57,33 @@ func (u *MockedUserRepo) FindByUsernameWithPassword(username string) (*model.Use return u.FindByUsername(username) } +func (u *MockedUserRepo) Get(id string) (*model.User, error) { + if u.Error != nil { + return nil, u.Error + } + for _, usr := range u.Data { + if usr.ID == id { + return usr, nil + } + } + return nil, model.ErrNotFound +} + +func (u *MockedUserRepo) GetAll(options ...model.QueryOptions) (model.Users, error) { + if u.Error != nil { + return nil, u.Error + } + var users model.Users + for _, usr := range u.Data { + users = append(users, *usr) + } + return users, nil +} + func (u *MockedUserRepo) UpdateLastLoginAt(id string) error { for _, usr := range u.Data { if usr.ID == id { - usr.LastLoginAt = gg.P(time.Now()) + usr.LastLoginAt = new(time.Now()) return nil } } @@ -68,9 +93,74 @@ func (u *MockedUserRepo) UpdateLastLoginAt(id string) error { func (u *MockedUserRepo) UpdateLastAccessAt(id string) error { for _, usr := range u.Data { if usr.ID == id { - usr.LastAccessAt = gg.P(time.Now()) + usr.LastAccessAt = new(time.Now()) return nil } } return u.Error } + +// Library association methods - mock implementations + +func (u *MockedUserRepo) GetUserLibraries(userID string) (model.Libraries, error) { + if u.Error != nil { + return nil, u.Error + } + libraryIDs, exists := u.UserLibraries[userID] + if !exists { + return model.Libraries{}, nil + } + + // Mock: Create libraries based on IDs + var libraries model.Libraries + for _, id := range libraryIDs { + libraries = append(libraries, model.Library{ + ID: id, + Name: fmt.Sprintf("Test Library %d", id), + Path: fmt.Sprintf("/music/library%d", id), + }) + } + return libraries, nil +} + +func (u *MockedUserRepo) SetUserLibraries(userID string, libraryIDs []int) error { + if u.Error != nil { + return u.Error + } + if u.UserLibraries == nil { + u.UserLibraries = make(map[string][]int) + } + u.UserLibraries[userID] = libraryIDs + return nil +} + +func (u *MockedUserRepo) Delete(id string) error { + if u.Error != nil { + return u.Error + } + for key, usr := range u.Data { + if usr.ID == id { + delete(u.Data, key) + delete(u.UserLibraries, id) + return nil + } + } + return model.ErrNotFound +} + +func (u *MockedUserRepo) Save(entity any) (string, error) { + usr := entity.(*model.User) + if err := u.Put(usr); err != nil { + return "", err + } + return usr.ID, nil +} + +func (u *MockedUserRepo) Update(id string, entity any, cols ...string) error { + if u.Error != nil { + return u.Error + } + usr := entity.(*model.User) + usr.ID = id + return u.Put(usr) +} diff --git a/tests/mock_user_service.go b/tests/mock_user_service.go new file mode 100644 index 000000000..f2700de45 --- /dev/null +++ b/tests/mock_user_service.go @@ -0,0 +1,30 @@ +package tests + +import ( + "context" + + "github.com/deluan/rest" +) + +// MockUserService provides a simple wrapper around MockedUserRepo +// that implements the core.User interface for testing. +// Returns concrete type to avoid import cycles - callers assign to core.User. +type MockUserService struct { + *MockedUserRepo +} + +// MockUserRestAdapter adapts MockedUserRepo to rest.Repository interface +type MockUserRestAdapter struct { + *MockedUserRepo +} + +// NewMockUserService creates a new mock user service for testing. +// Returns concrete type - assign to core.User at call site. +func NewMockUserService() *MockUserService { + repo := CreateMockUserRepo() + return &MockUserService{MockedUserRepo: repo} +} + +func (m *MockUserService) NewRepository(ctx context.Context) rest.Repository { + return &MockUserRestAdapter{MockedUserRepo: m.MockedUserRepo} +} diff --git a/tests/navidrome-test.toml b/tests/navidrome-test.toml index 48f9f4c38..117178a76 100644 --- a/tests/navidrome-test.toml +++ b/tests/navidrome-test.toml @@ -1,5 +1,7 @@ User = "deluan" Password = "wordpass" DbPath = "file::memory:?cache=shared" -DataFolder = "data/tests" +DataFolder = "tmp/tests" ScanSchedule="0" +Plugins.Enabled = true +Plugins.Folder = "plugins/testdata" diff --git a/tests/test_helpers.go b/tests/test_helpers.go index 1251c90cd..bdcd40d00 100644 --- a/tests/test_helpers.go +++ b/tests/test_helpers.go @@ -4,11 +4,25 @@ import ( "context" "os" "path/filepath" + "runtime" "github.com/navidrome/navidrome/db" + "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model/id" + "github.com/onsi/ginkgo/v2" + "github.com/sirupsen/logrus" + "github.com/sirupsen/logrus/hooks/test" ) +// SkipOnWindows marks the current spec (or surrounding BeforeEach) as skipped +// when running on Windows. The reason is included in the Ginkgo output so the +// backlog of Windows-skipped tests stays auditable. +func SkipOnWindows(reason string) { + if runtime.GOOS == "windows" { + ginkgo.Skip("not supported on Windows: " + reason) + } +} + type testingT interface { TempDir() string } @@ -17,10 +31,20 @@ func TempFileName(t testingT, prefix, suffix string) string { return filepath.Join(t.TempDir(), prefix+id.NewRandom()+suffix) } +// TempFile creates an empty file in t.TempDir() and returns the closed handle. +// The handle is returned for backward compatibility, but is already closed so +// callers don't need to. On Windows, leaving the handle open would hold a file +// lock and block Ginkgo's TempDir cleanup. func TempFile(t testingT, prefix, suffix string) (*os.File, string, error) { name := TempFileName(t, prefix, suffix) f, err := os.Create(name) - return f, name, err + if err != nil { + return nil, name, err + } + if cerr := f.Close(); cerr != nil { + return f, name, cerr + } + return f, name, nil } // ClearDB deletes all tables and data from the database @@ -35,3 +59,23 @@ func ClearDB() error { `) return err } + +// LogHook sets up a logrus test hook and configures the default logger to use it. +// It returns the hook and a cleanup function to restore the default logger. +// Example usage: +// +// hook, cleanup := LogHook() +// defer cleanup() +// // ... perform logging operations ... +// Expect(hook.LastEntry()).ToNot(BeNil()) +// Expect(hook.LastEntry().Level).To(Equal(logrus.WarnLevel)) +// Expect(hook.LastEntry().Message).To(Equal("log message")) +func LogHook() (*test.Hook, func()) { + l, hook := test.NewNullLogger() + log.SetLevel(log.LevelWarn) + log.SetDefaultLogger(l) + return hook, func() { + // Restore default logger after test + log.SetDefaultLogger(logrus.New()) + } +} diff --git a/ui/index.html b/ui/index.html index 0e60ec678..827751856 100644 --- a/ui/index.html +++ b/ui/index.html @@ -27,6 +27,10 @@ <meta property="og:image:width" content="300"> <meta property="og:image:height" content="300"> <title>Navidrome + diff --git a/ui/package-lock.json b/ui/package-lock.json index 9e449c5e0..1f95f14f8 100644 --- a/ui/package-lock.json +++ b/ui/package-lock.json @@ -7,19 +7,23 @@ "name": "ui", "hasInstallScript": true, "dependencies": { + "@jsonforms/core": "^2.5.2", + "@jsonforms/material-renderers": "^2.5.2", + "@jsonforms/react": "^2.5.2", "@material-ui/core": "^4.12.4", "@material-ui/icons": "^4.11.3", - "@material-ui/lab": "^4.0.0-alpha.58", + "@material-ui/lab": "^4.0.0-alpha.61", "@material-ui/styles": "^4.11.5", "blueimp-md5": "^2.19.0", "clsx": "^2.1.1", "connected-react-router": "^6.9.3", "deepmerge": "^4.3.1", + "dompurify": "^3.3.2", "history": "^4.10.1", "inflection": "^3.0.2", "jwt-decode": "^4.0.0", "lodash.throttle": "^4.1.1", - "navidrome-music-player": "4.25.1", + "navidrome-music-player": "4.25.2", "prop-types": "^15.8.1", "ra-data-json-server": "^3.19.12", "ra-i18n-polyglot": "^3.19.12", @@ -37,8 +41,8 @@ "react-redux": "^7.2.9", "react-router-dom": "^5.3.4", "redux": "^4.2.1", - "redux-saga": "^1.3.0", - "uuid": "^11.1.0", + "redux-saga": "^1.4.2", + "uuid": "^13.0.0", "workbox-cli": "^7.3.0" }, "devDependencies": { @@ -46,52 +50,42 @@ "@testing-library/react": "^12.1.5", "@testing-library/react-hooks": "^7.0.2", "@testing-library/user-event": "^14.6.1", - "@types/node": "^22.15.21", - "@types/react": "^17.0.86", + "@types/node": "^24.9.1", + "@types/react": "^17.0.89", "@types/react-dom": "^17.0.26", "@typescript-eslint/eslint-plugin": "^6.21.0", "@typescript-eslint/parser": "^6.21.0", - "@vitejs/plugin-react": "^4.5.0", - "@vitest/coverage-v8": "^3.1.4", + "@vitejs/plugin-react": "^5.1.0", + "@vitest/coverage-v8": "^4.0.3", "eslint": "^8.57.1", - "eslint-config-prettier": "^10.1.5", + "eslint-config-prettier": "^10.1.8", "eslint-plugin-jsx-a11y": "^6.10.2", "eslint-plugin-react": "^7.37.5", "eslint-plugin-react-hooks": "^5.2.0", - "eslint-plugin-react-refresh": "^0.4.20", - "happy-dom": "^17.4.7", + "eslint-plugin-react-refresh": "^0.4.24", + "happy-dom": "^20.0.8", "jsdom": "^26.1.0", - "prettier": "^3.5.3", + "prettier": "^3.6.2", "ra-test": "^3.19.12", "typescript": "^5.8.3", - "vite": "^6.3.5", - "vite-plugin-pwa": "^0.21.2", - "vitest": "^3.1.4" + "vite": "^7.3.2", + "vite-plugin-pwa": "^1.1.0", + "vitest": "^4.0.3" } }, "node_modules/@adobe/css-tools": { - "version": "4.4.3", - "resolved": "https://registry.npmjs.org/@adobe/css-tools/-/css-tools-4.4.3.tgz", - "integrity": "sha512-VQKMkwriZbaOgVCby1UDY/LDk5fIjhQicCvVPFqfe+69fWaPWydbWJ3wRt59/YzIwda1I81loas3oCoHxnqvdA==", - "dev": true - }, - "node_modules/@ampproject/remapping": { - "version": "2.3.0", - "resolved": "https://registry.npmjs.org/@ampproject/remapping/-/remapping-2.3.0.tgz", - "integrity": "sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw==", - "dependencies": { - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" - } + "version": "4.4.4", + "resolved": "https://registry.npmjs.org/@adobe/css-tools/-/css-tools-4.4.4.tgz", + "integrity": "sha512-Elp+iwUx5rN5+Y8xLt5/GRoG20WGoDCQ/1Fb+1LiGtvwbDavuSk0jhD/eZdckHAuzcDzccnkv+rEjyWfRx18gg==", + "dev": true, + "license": "MIT" }, "node_modules/@asamuzakjp/css-color": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/@asamuzakjp/css-color/-/css-color-3.2.0.tgz", "integrity": "sha512-K1A6z8tS3XsmCMM86xoWdn7Fkdn9m6RSVtocUrJYIwZnFVkng/PvkEoWtOWmP+Scc6saYWHWZYbndEEXxl24jw==", "dev": true, + "license": "MIT", "dependencies": { "@csstools/css-calc": "^2.1.3", "@csstools/css-color-parser": "^3.0.9", @@ -104,14 +98,16 @@ "version": "10.4.3", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/@babel/code-frame": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.27.1.tgz", - "integrity": "sha512-cjQ7ZlQ0Mv3b47hABuTevyTuYN4i+loJKGeV9flcCgIK37cCXRh+L1bd3iBHlynerhQ7BhCkn2BPbQUL+rGqFg==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.29.0.tgz", + "integrity": "sha512-9NhCeYjq9+3uxgdtp20LSiJXJvN0FeCtNGpJxuMFZ1Kv3cWUNb6DOhJwUvcVCzKGR66cw4njwM6hrJLqgOwbcw==", + "license": "MIT", "dependencies": { - "@babel/helper-validator-identifier": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5", "js-tokens": "^4.0.0", "picocolors": "^1.1.1" }, @@ -120,28 +116,30 @@ } }, "node_modules/@babel/compat-data": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.27.2.tgz", - "integrity": "sha512-TUtMJYRPyUb/9aU8f3K0mjmjf6M9N5Woshn2CS6nqJSeJtTtQcpLUXjGt9vbF8ZGff0El99sWkLgzwW3VXnxZQ==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/compat-data/-/compat-data-7.29.0.tgz", + "integrity": "sha512-T1NCJqT/j9+cn8fvkt7jtwbLBfLC/1y1c7NtCeXFRgzGTsafi68MRv8yzkYSapBnFA6L3U2VSc02ciDzoAJhJg==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/core": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.27.1.tgz", - "integrity": "sha512-IaaGWsQqfsQWVLqMn9OB92MNN7zukfVA4s7KKAI0KfrrDsZ0yhi5uV4baBuLuN7n3vsZpwP8asPPcVwApxvjBQ==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.29.0.tgz", + "integrity": "sha512-CGOfOJqWjg2qW/Mb6zNsDm+u5vFQ8DxXfbM09z69p5Z6+mE1ikP2jUXw+j42Pf1XTYED2Rni5f95npYeuwMDQA==", + "license": "MIT", "dependencies": { - "@ampproject/remapping": "^2.2.0", - "@babel/code-frame": "^7.27.1", - "@babel/generator": "^7.27.1", - "@babel/helper-compilation-targets": "^7.27.1", - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helpers": "^7.27.1", - "@babel/parser": "^7.27.1", - "@babel/template": "^7.27.1", - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1", + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helpers": "^7.28.6", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/remapping": "^2.3.5", "convert-source-map": "^2.0.0", "debug": "^4.1.0", "gensync": "^1.0.0-beta.2", @@ -160,19 +158,21 @@ "version": "6.3.1", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.27.1.tgz", - "integrity": "sha512-UnJfnIpc/+JO0/+KRVQNGU+y5taA5vCbwN8+azkX6beii/ZF+enZJSOKo11ZSzGJjlNfJHfQtmQT8H+9TXPG2w==", + "version": "7.29.1", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.29.1.tgz", + "integrity": "sha512-qsaF+9Qcm2Qv8SRIMMscAvG4O3lJ0F1GuMo5HR/Bp02LopNgnZBC/EkbevHFeGs4ls/oPz9v+Bsmzbkbe+0dUw==", + "license": "MIT", "dependencies": { - "@babel/parser": "^7.27.1", - "@babel/types": "^7.27.1", - "@jridgewell/gen-mapping": "^0.3.5", - "@jridgewell/trace-mapping": "^0.3.25", + "@babel/parser": "^7.29.0", + "@babel/types": "^7.29.0", + "@jridgewell/gen-mapping": "^0.3.12", + "@jridgewell/trace-mapping": "^0.3.28", "jsesc": "^3.0.2" }, "engines": { @@ -180,22 +180,24 @@ } }, "node_modules/@babel/helper-annotate-as-pure": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.1.tgz", - "integrity": "sha512-WnuuDILl9oOBbKnb4L+DyODx7iC47XfzmNCpTttFsSp6hTG7XZxu60+4IO+2/hPfcGOoKbFiwoI/+zwARbNQow==", + "version": "7.27.3", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.27.3.tgz", + "integrity": "sha512-fXSwMQqitTGeHLBC08Eq5yXz2m37E4pJX1qAU1+2cNedz/ifv/bVXft90VeSav5nFO61EcNgwr0aJxbyPaWBPg==", + "license": "MIT", "dependencies": { - "@babel/types": "^7.27.1" + "@babel/types": "^7.27.3" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-compilation-targets": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.27.2.tgz", - "integrity": "sha512-2+1thGUUWWjLTYTHZWK1n8Yga0ijBz1XAhUXcKy81rd5g6yh7hGqMp45v7cadSbEHc9G3OTv45SyneRN3ps4DQ==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-compilation-targets/-/helper-compilation-targets-7.28.6.tgz", + "integrity": "sha512-JYtls3hqi15fcx5GaSNL7SCTJ2MNmjrkHXg4FSpOA/grxK8KwyZ5bubHsCq8FXCkua6xhuaaBit+3b7+VZRfcA==", + "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.27.2", + "@babel/compat-data": "^7.28.6", "@babel/helper-validator-option": "^7.27.1", "browserslist": "^4.24.0", "lru-cache": "^5.1.1", @@ -209,21 +211,23 @@ "version": "6.3.1", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/helper-create-class-features-plugin": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.27.1.tgz", - "integrity": "sha512-QwGAmuvM17btKU5VqXfb+Giw4JcN0hjuufz3DYnpeVDvZLAObloM77bhMXiqry3Iio+Ai4phVRDwl6WU10+r5A==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.28.6.tgz", + "integrity": "sha512-dTOdvsjnG3xNT9Y0AUg1wAl38y+4Rl4sf9caSQZOXdNqVn+H+HbbJ4IyyHaIqNR6SW9oJpA/RuRjsjCw2IdIow==", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-member-expression-to-functions": "^7.27.1", + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-member-expression-to-functions": "^7.28.5", "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1", + "@babel/helper-replace-supers": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", - "@babel/traverse": "^7.27.1", + "@babel/traverse": "^7.28.6", "semver": "^6.3.1" }, "engines": { @@ -237,17 +241,19 @@ "version": "6.3.1", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/helper-create-regexp-features-plugin": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.27.1.tgz", - "integrity": "sha512-uVDC72XVf8UbrH5qQTc18Agb8emwjTiZrQE11Nv3CuBEZmVvTwwE9CBUEvHku06gQCAyYf8Nv6ja1IN+6LMbxQ==", + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.28.5.tgz", + "integrity": "sha512-N1EhvLtHzOvj7QQOUCCS3NrPJP8c5W6ZXCHDn7Yialuy1iu4r5EmIYkXlKNqT99Ciw+W0mDqWoR6HWMZlFP3hw==", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "regexpu-core": "^6.2.0", + "@babel/helper-annotate-as-pure": "^7.27.3", + "regexpu-core": "^6.3.1", "semver": "^6.3.1" }, "engines": { @@ -261,31 +267,34 @@ "version": "6.3.1", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/@babel/helper-define-polyfill-provider": { - "version": "0.6.4", - "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.4.tgz", - "integrity": "sha512-jljfR1rGnXXNWnmQg2K3+bvhkxB51Rl32QRaOTuwwjviGrHzIbSc8+x9CpraDtbT7mfyjXObULP4w/adunNwAw==", + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/@babel/helper-define-polyfill-provider/-/helper-define-polyfill-provider-0.6.8.tgz", + "integrity": "sha512-47UwBLPpQi1NoWzLuHNjRoHlYXMwIJoBf7MFou6viC/sIHWYygpvr0B6IAyh5sBdA2nr2LPIRww8lfaUVQINBA==", + "license": "MIT", "dependencies": { - "@babel/helper-compilation-targets": "^7.22.6", - "@babel/helper-plugin-utils": "^7.22.5", - "debug": "^4.1.1", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "debug": "^4.4.3", "lodash.debounce": "^4.0.8", - "resolve": "^1.14.2" + "resolve": "^1.22.11" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "node_modules/@babel/helper-define-polyfill-provider/node_modules/resolve": { - "version": "1.22.10", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", - "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", + "version": "1.22.11", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", + "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "license": "MIT", "dependencies": { - "is-core-module": "^2.16.0", + "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -299,38 +308,50 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/@babel/helper-globals": { + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@babel/helper-globals/-/helper-globals-7.28.0.tgz", + "integrity": "sha512-+W6cISkXFa1jXsDEdYA8HeevQT/FULhxzR99pxphltZcVaugps53THCeiWA8SguxxpSp3gKPiuYfSWopkLQ4hw==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, "node_modules/@babel/helper-member-expression-to-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.27.1.tgz", - "integrity": "sha512-E5chM8eWjTp/aNoVpcbfM7mLxu9XGLWYise2eBKGQomAk/Mb4XoxyqXTZbuTohbsl8EKqdlMhnDI2CCLfcs9wA==", + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.28.5.tgz", + "integrity": "sha512-cwM7SBRZcPCLgl8a7cY0soT1SptSzAlMH39vwiRpOQkJlh53r5hdHwLSCZpQdVLT39sZt+CRpNwYG4Y2v77atg==", + "license": "MIT", "dependencies": { - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/traverse": "^7.28.5", + "@babel/types": "^7.28.5" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-module-imports": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.27.1.tgz", - "integrity": "sha512-0gSFWUPNXNopqtIPQvlD5WgXYI5GY2kP2cCvoT8kczjbfcfuIljTbcWrulD1CIPIX2gt1wghbDy08yE1p+/r3w==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.28.6.tgz", + "integrity": "sha512-l5XkZK7r7wa9LucGw9LwZyyCUscb4x37JWTPz7swwFE/0FMQAGpiWUZn8u9DzkSBWEcK25jmvubfpw2dnAMdbw==", + "license": "MIT", "dependencies": { - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-module-transforms": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.27.1.tgz", - "integrity": "sha512-9yHn519/8KvTU5BjTVEEeIM3w9/2yXNKoD82JifINImhpKkARMJKPP59kLo+BafpdN5zgNeIcS4jsGDmd3l58g==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.28.6.tgz", + "integrity": "sha512-67oXFAYr2cDLDVGLXTEABjdBJZ6drElUSI7WKp70NrpyISso3plG9SAGEF6y7zbha/wOzUByWWTJvEDVNIUGcA==", + "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.27.1", - "@babel/helper-validator-identifier": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -343,6 +364,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.27.1.tgz", "integrity": "sha512-URMGH08NzYFhubNSGJrpUEphGKQwMQYBySzat5cAByY1/YgIRkULnIy3tAMeszlL/so2HbeilYloUmSpd7GdVw==", + "license": "MIT", "dependencies": { "@babel/types": "^7.27.1" }, @@ -351,9 +373,10 @@ } }, "node_modules/@babel/helper-plugin-utils": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.27.1.tgz", - "integrity": "sha512-1gn1Up5YXka3YYAHGKpbideQ5Yjf1tDa9qYcgysz+cNCXukyLl6DjPXhD3VRwSb8c0J9tA4b2+rHEZtc6R0tlw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.28.6.tgz", + "integrity": "sha512-S9gzZ/bz83GRysI7gAD4wPT/AI3uCnY+9xn+Mx/KPs2JwHJIz1W8PZkg2cqyt3RNOBM8ejcXhV6y8Og7ly/Dug==", + "license": "MIT", "engines": { "node": ">=6.9.0" } @@ -362,6 +385,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.27.1.tgz", "integrity": "sha512-7fiA521aVw8lSPeI4ZOD3vRFkoqkJcS+z4hFo82bFSH/2tNd6eJ5qCVMS5OzDmZh/kaHQeBaeyxK6wljcPtveA==", + "license": "MIT", "dependencies": { "@babel/helper-annotate-as-pure": "^7.27.1", "@babel/helper-wrap-function": "^7.27.1", @@ -375,13 +399,14 @@ } }, "node_modules/@babel/helper-replace-supers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.27.1.tgz", - "integrity": "sha512-7EHz6qDZc8RYS5ElPoShMheWvEgERonFCs7IAonWLLUTXW59DP14bCZt89/GKyreYn8g3S83m21FelHKbeDCKA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.28.6.tgz", + "integrity": "sha512-mq8e+laIk94/yFec3DxSjCRD2Z0TAjhVbEJY3UQrlwVo15Lmt7C2wAUbK4bjnTs4APkwsYLTahXRraQXhb1WCg==", + "license": "MIT", "dependencies": { - "@babel/helper-member-expression-to-functions": "^7.27.1", + "@babel/helper-member-expression-to-functions": "^7.28.5", "@babel/helper-optimise-call-expression": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -394,6 +419,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.27.1.tgz", "integrity": "sha512-Tub4ZKEXqbPjXgWLl2+3JpQAYBJ8+ikpQ2Ocj/q/r0LwE3UhENh7EUabyHjz2kCEsrRY83ew2DQdHluuiDQFzg==", + "license": "MIT", "dependencies": { "@babel/traverse": "^7.27.1", "@babel/types": "^7.27.1" @@ -406,14 +432,16 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.27.1.tgz", - "integrity": "sha512-D2hP9eA+Sqx1kBZgzxZh0y1trbuU+JoDkiEwqhQ36nodYqJwyEIhPSdMNd7lOm/4io72luTPWH20Yda0xOuUow==", + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "license": "MIT", "engines": { "node": ">=6.9.0" } @@ -422,41 +450,45 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/helper-validator-option/-/helper-validator-option-7.27.1.tgz", "integrity": "sha512-YvjJow9FxbhFFKDSuFnVCe2WxXk1zWc22fFePVNEaWJEu8IrZVlda6N0uHwzZrUM1il7NC9Mlp4MaJYbYd9JSg==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helper-wrap-function": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.27.1.tgz", - "integrity": "sha512-NFJK2sHUvrjo8wAU/nQTWU890/zB2jj0qBcCbZbbf+005cAsv6tMjXz31fBign6M5ov1o0Bllu+9nbqkfsjjJQ==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.28.6.tgz", + "integrity": "sha512-z+PwLziMNBeSQJonizz2AGnndLsP2DeGHIxDAn+wdHOGuo4Fo1x1HBPPXeE9TAOPHNNWQKCSlA2VZyYyyibDnQ==", + "license": "MIT", "dependencies": { - "@babel/template": "^7.27.1", - "@babel/traverse": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/template": "^7.28.6", + "@babel/traverse": "^7.28.6", + "@babel/types": "^7.28.6" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/helpers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.27.1.tgz", - "integrity": "sha512-FCvFTm0sWV8Fxhpp2McP5/W53GPllQ9QeQ7SiqGWjMf/LVG07lFa5+pgK05IRhVwtvafT22KF+ZSnM9I545CvQ==", + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.29.2.tgz", + "integrity": "sha512-HoGuUs4sCZNezVEKdVcwqmZN8GoHirLUcLaYVNBK2J0DadGtdcqgr3BCbvH8+XUo4NGjNl3VOtSjEKNzqfFgKw==", + "license": "MIT", "dependencies": { - "@babel/template": "^7.27.1", - "@babel/types": "^7.27.1" + "@babel/template": "^7.28.6", + "@babel/types": "^7.29.0" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/parser": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.27.2.tgz", - "integrity": "sha512-QYLs8299NA7WM/bZAdp+CviYYkVoYXlDW2rzliy3chxd1PQjej7JORuMJDJXJUb9g0TT+B99EwaVLKmX+sPXWw==", + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.2.tgz", + "integrity": "sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA==", + "license": "MIT", "dependencies": { - "@babel/types": "^7.27.1" + "@babel/types": "^7.29.0" }, "bin": { "parser": "bin/babel-parser.js" @@ -466,12 +498,13 @@ } }, "node_modules/@babel/plugin-bugfix-firefox-class-in-computed-class-key": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.27.1.tgz", - "integrity": "sha512-QPG3C9cCVRQLxAVwmefEmwdTanECuUBMQZ/ym5kiw3XKCGA7qkuQLcjWWHcrD/GKbn/WmJwaezfuuAOcyKlRPA==", + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-firefox-class-in-computed-class-key/-/plugin-bugfix-firefox-class-in-computed-class-key-7.28.5.tgz", + "integrity": "sha512-87GDMS3tsmMSi/3bWOte1UblL+YUTFMV8SZPZ2eSEL17s74Cw/l63rR6NmGVKMYW2GYi85nE+/d6Hw5N0bEk2Q==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/traverse": "^7.28.5" }, "engines": { "node": ">=6.9.0" @@ -484,6 +517,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-class-field-initializer-scope/-/plugin-bugfix-safari-class-field-initializer-scope-7.27.1.tgz", "integrity": "sha512-qNeq3bCKnGgLkEXUuFry6dPlGfCdQNZbn7yUAPCInwAJHMU7THJfrBSozkcWq5sNM6RcF3S8XyQL2A52KNR9IA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -498,6 +532,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression/-/plugin-bugfix-safari-id-destructuring-collision-in-function-expression-7.27.1.tgz", "integrity": "sha512-g4L7OYun04N1WyqMNjldFwlfPCLVkgB54A/YCXICZYBsvJJE3kByKv9c9+R/nAfmIfjl2rKYLNyMHboYbZaWaA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -512,6 +547,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining/-/plugin-bugfix-v8-spread-parameters-in-optional-chaining-7.27.1.tgz", "integrity": "sha512-oO02gcONcD5O1iTLi/6frMJBIwWEHceWGSGqrpCmEL8nogiS6J9PBlE48CaK20/Jx1LuRml9aDftLgdjXT8+Cw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1", @@ -525,12 +561,13 @@ } }, "node_modules/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.27.1.tgz", - "integrity": "sha512-6BpaYGDavZqkI6yT+KSPdpZFfpnd68UKXbcjI9pJ13pvHhPrCKWOOLp+ysvMeA+DxnhuPpgIaRpxRxo5A9t5jw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly/-/plugin-bugfix-v8-static-class-fields-redefine-readonly-7.28.6.tgz", + "integrity": "sha512-a0aBScVTlNaiUe35UtfxAN7A/tehvvG4/ByO6+46VPKTRSlfnAFsgKy0FUh+qAkQrDTmhDkT+IBOKlOoMUxQ0g==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -543,6 +580,7 @@ "version": "7.21.0-placeholder-for-preset-env.2", "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-private-property-in-object/-/plugin-proposal-private-property-in-object-7.21.0-placeholder-for-preset-env.2.tgz", "integrity": "sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==", + "license": "MIT", "engines": { "node": ">=6.9.0" }, @@ -551,11 +589,12 @@ } }, "node_modules/@babel/plugin-syntax-import-assertions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.27.1.tgz", - "integrity": "sha512-UT/Jrhw57xg4ILHLFnzFpPDlMbcdEicaAtjPQpbj9wa8T4r5KVWCimHcL/460g8Ht0DMxDyjsLgiWSkVjnwPFg==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-assertions/-/plugin-syntax-import-assertions-7.28.6.tgz", + "integrity": "sha512-pSJUpFHdx9z5nqTSirOCMtYVP2wFgoWhP0p3g8ONK/4IHhLIBd0B9NYqAvIUAhq+OkhO4VM1tENCt0cjlsNShw==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -565,11 +604,12 @@ } }, "node_modules/@babel/plugin-syntax-import-attributes": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.27.1.tgz", - "integrity": "sha512-oFT0FrKHgF53f4vOsZGi2Hh3I35PfSmVs4IBFLFj4dnafP+hIWDLg3VyKmUHfLoLHlyxY4C7DGtmHuJgn+IGww==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-attributes/-/plugin-syntax-import-attributes-7.28.6.tgz", + "integrity": "sha512-jiLC0ma9XkQT3TKJ9uYvlakm66Pamywo+qwL+oL8HJOvc6TWdZXVfhqJr8CCzbSGUAbDOzlGHJC1U+vRfLQDvw==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -582,6 +622,7 @@ "version": "7.18.6", "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", "integrity": "sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==", + "license": "MIT", "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.18.6", "@babel/helper-plugin-utils": "^7.18.6" @@ -597,6 +638,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.27.1.tgz", "integrity": "sha512-8Z4TGic6xW70FKThA5HYEKKyBpOOsucTOD1DjU3fZxDg+K3zBJcXMFnt/4yQiZnf5+MiOMSXQ9PaEK/Ilh1DeA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -608,13 +650,14 @@ } }, "node_modules/@babel/plugin-transform-async-generator-functions": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.27.1.tgz", - "integrity": "sha512-eST9RrwlpaoJBDHShc+DS2SG4ATTi2MYNb4OxYkf3n+7eb49LWpnS+HSpVfW4x927qQwgk8A2hGNVaajAEw0EA==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-generator-functions/-/plugin-transform-async-generator-functions-7.29.0.tgz", + "integrity": "sha512-va0VdWro4zlBr2JsXC+ofCPB2iG12wPtVGTWFx2WLDOM3nYQZZIGP82qku2eW/JR83sD+k2k+CsNtyEbUqhU6w==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-remap-async-to-generator": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/traverse": "^7.29.0" }, "engines": { "node": ">=6.9.0" @@ -624,12 +667,13 @@ } }, "node_modules/@babel/plugin-transform-async-to-generator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.27.1.tgz", - "integrity": "sha512-NREkZsZVJS4xmTr8qzE5y8AfIPqsdQfRuUiLRTEzb7Qii8iFWCyDKaUV2c0rCuh4ljDZ98ALHP/PetiBV2nddA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.28.6.tgz", + "integrity": "sha512-ilTRcmbuXjsMmcZ3HASTe4caH5Tpo93PkTxF9oG2VZsSWsahydmcEHhix9Ik122RcTnZnUzPbmux4wh1swfv7g==", + "license": "MIT", "dependencies": { - "@babel/helper-module-imports": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-module-imports": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-remap-async-to-generator": "^7.27.1" }, "engines": { @@ -643,6 +687,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.27.1.tgz", "integrity": "sha512-cnqkuOtZLapWYZUYM5rVIdv1nXYuFVIltZ6ZJ7nIj585QsjKM5dhL2Fu/lICXZ1OyIAFc7Qy+bvDAtTXqGrlhg==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -654,11 +699,12 @@ } }, "node_modules/@babel/plugin-transform-block-scoping": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.27.1.tgz", - "integrity": "sha512-QEcFlMl9nGTgh1rn2nIeU5bkfb9BAjaQcWbiP4LvKxUot52ABcTkpcyJ7f2Q2U2RuQ84BNLgts3jRme2dTx6Fw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.28.6.tgz", + "integrity": "sha512-tt/7wOtBmwHPNMPu7ax4pdPz6shjFrmHDghvNC+FG9Qvj7D6mJcoRQIF5dy4njmxR941l6rgtvfSB2zX3VlUIw==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -668,12 +714,13 @@ } }, "node_modules/@babel/plugin-transform-class-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.27.1.tgz", - "integrity": "sha512-D0VcalChDMtuRvJIu3U/fwWjf8ZMykz5iZsg77Nuj821vCKI3zCyRLwRdWbsuJ/uRwZhZ002QtCqIkwC/ZkvbA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-properties/-/plugin-transform-class-properties-7.28.6.tgz", + "integrity": "sha512-dY2wS3I2G7D697VHndN91TJr8/AAfXQNt5ynCTI/MpxMsSzHp+52uNivYT5wCPax3whc47DR8Ba7cmlQMg24bw==", + "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -683,12 +730,13 @@ } }, "node_modules/@babel/plugin-transform-class-static-block": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.27.1.tgz", - "integrity": "sha512-s734HmYU78MVzZ++joYM+NkJusItbdRcbm+AGRgJCt3iA+yux0QpD9cBVdz3tKyrjVYWRl7j0mHSmv4lhV0aoA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-class-static-block/-/plugin-transform-class-static-block-7.28.6.tgz", + "integrity": "sha512-rfQ++ghVwTWTqQ7w8qyDxL1XGihjBss4CmTgGRCTAC9RIbhVpyp4fOeZtta0Lbf+dTNIVJer6ych2ibHwkZqsQ==", + "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -698,16 +746,17 @@ } }, "node_modules/@babel/plugin-transform-classes": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.27.1.tgz", - "integrity": "sha512-7iLhfFAubmpeJe/Wo2TVuDrykh/zlWXLzPNdL0Jqn/Xu8R3QQ8h9ff8FQoISZOsw74/HFqFI7NX63HN7QFIHKA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.28.6.tgz", + "integrity": "sha512-EF5KONAqC5zAqT783iMGuM2ZtmEBy+mJMOKl2BCvPZ2lVrwvXnB6o+OBWCS+CoeCCpVRF2sA2RBKUxvT8tQT5Q==", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-compilation-targets": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-replace-supers": "^7.27.1", - "@babel/traverse": "^7.27.1", - "globals": "^11.1.0" + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-globals": "^7.28.0", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-replace-supers": "^7.28.6", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -717,12 +766,13 @@ } }, "node_modules/@babel/plugin-transform-computed-properties": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.27.1.tgz", - "integrity": "sha512-lj9PGWvMTVksbWiDT2tW68zGS/cyo4AkZ/QTp0sQT0mjPopCmrSkzxeXkznjqBxzDI6TclZhOJbBmbBLjuOZUw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.28.6.tgz", + "integrity": "sha512-bcc3k0ijhHbc2lEfpFHgx7eYw9KNXqOerKWfzbxEHUGKnS3sz9C4CNL9OiFN1297bDNfUiSO7DaLzbvHQQQ1BQ==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/template": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/template": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -732,11 +782,13 @@ } }, "node_modules/@babel/plugin-transform-destructuring": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.27.1.tgz", - "integrity": "sha512-ttDCqhfvpE9emVkXbPD8vyxxh4TWYACVybGkDj+oReOGwnp066ITEivDlLwe0b1R0+evJ13IXQuLNB5w1fhC5Q==", + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.28.5.tgz", + "integrity": "sha512-Kl9Bc6D0zTUcFUvkNuQh4eGXPKKNDOJQXVyyM4ZAQPMveniJdxi8XMJwLo+xSoW3MIq81bD33lcUe9kZpl0MCw==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.27.1", + "@babel/traverse": "^7.28.5" }, "engines": { "node": ">=6.9.0" @@ -746,12 +798,13 @@ } }, "node_modules/@babel/plugin-transform-dotall-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.27.1.tgz", - "integrity": "sha512-gEbkDVGRvjj7+T1ivxrfgygpT7GUd4vmODtYpbs0gZATdkX8/iSnOtZSxiZnsgm1YjTgjI6VKBGSJJevkrclzw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.28.6.tgz", + "integrity": "sha512-SljjowuNKB7q5Oayv4FoPzeB74g3QgLt8IVJw9ADvWy3QnUb/01aw8I4AVv8wYnPvQz2GDDZ/g3GhcNyDBI4Bg==", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -764,6 +817,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.27.1.tgz", "integrity": "sha512-MTyJk98sHvSs+cvZ4nOauwTTG1JeonDjSGvGGUNHreGQns+Mpt6WX/dVzWBHgg+dYZhkC4X+zTDfkTU+Vy9y7Q==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -775,12 +829,13 @@ } }, "node_modules/@babel/plugin-transform-duplicate-named-capturing-groups-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.27.1.tgz", - "integrity": "sha512-hkGcueTEzuhB30B3eJCbCYeCaaEQOmQR0AdvzpD4LoN0GXMWzzGSuRrxR2xTnCrvNbVwK9N6/jQ92GSLfiZWoQ==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-named-capturing-groups-regex/-/plugin-transform-duplicate-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-zBPcW2lFGxdiD8PUnPwJjag2J9otbcLQzvbiOzDxpYXyCuYX9agOwMPGn1prVH0a4qzhCKu24rlH4c1f7yA8rw==", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -793,6 +848,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dynamic-import/-/plugin-transform-dynamic-import-7.27.1.tgz", "integrity": "sha512-MHzkWQcEmjzzVW9j2q8LGjwGWpG2mjwaaB0BNQwst3FIjqsg8Ct/mIZlvSPJvfi9y2AC8mi/ktxbFVL9pZ1I4A==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -803,12 +859,29 @@ "@babel/core": "^7.0.0-0" } }, - "node_modules/@babel/plugin-transform-exponentiation-operator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.27.1.tgz", - "integrity": "sha512-uspvXnhHvGKf2r4VVtBpeFnuDWsJLQ6MF6lGJLC89jBR1uoVeqM416AZtTuhTezOfgHicpJQmoD5YUakO/YmXQ==", + "node_modules/@babel/plugin-transform-explicit-resource-management": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-explicit-resource-management/-/plugin-transform-explicit-resource-management-7.28.6.tgz", + "integrity": "sha512-Iao5Konzx2b6g7EPqTy40UZbcdXE126tTxVFr/nAIj+WItNxjKSYTEw3RC+A2/ZetmdJsgueL1KhaMCQHkLPIg==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-transform-exponentiation-operator": { + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.28.6.tgz", + "integrity": "sha512-WitabqiGjV/vJ0aPOLSFfNY1u9U3R7W36B03r5I2KoNix+a3sOhJ3pKFB3R5It9/UiK78NiO0KE9P21cMhlPkw==", + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -821,6 +894,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-export-namespace-from/-/plugin-transform-export-namespace-from-7.27.1.tgz", "integrity": "sha512-tQvHWSZ3/jH2xuq/vZDy0jNn+ZdXJeM8gHvX4lnJmsc3+50yPlWdZXIc5ay+umX+2/tJIqHqiEqcJvxlmIvRvQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -835,6 +909,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.27.1.tgz", "integrity": "sha512-BfbWFFEJFQzLCQ5N8VocnCtA8J1CLkNTe2Ms2wocj75dd6VpiqS5Z5quTYcUoo4Yq+DN0rtikODccuv7RU81sw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" @@ -850,6 +925,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.27.1.tgz", "integrity": "sha512-1bQeydJF9Nr1eBCMMbC+hdwmRlsv5XYOMu03YSWFwNs0HsAmtSxxF1fyuYPqemVldVyFmlCU7w8UE14LupUSZQ==", + "license": "MIT", "dependencies": { "@babel/helper-compilation-targets": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1", @@ -863,11 +939,12 @@ } }, "node_modules/@babel/plugin-transform-json-strings": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.27.1.tgz", - "integrity": "sha512-6WVLVJiTjqcQauBhn1LkICsR2H+zm62I3h9faTDKt1qP4jn2o72tSvqMwtGFKGTpojce0gJs+76eZ2uCHRZh0Q==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-json-strings/-/plugin-transform-json-strings-7.28.6.tgz", + "integrity": "sha512-Nr+hEN+0geQkzhbdgQVPoqr47lZbm+5fCUmO70722xJZd0Mvb59+33QLImGj6F+DkK3xgDi1YVysP8whD6FQAw==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -880,6 +957,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.27.1.tgz", "integrity": "sha512-0HCFSepIpLTkLcsi86GG3mTUzxV5jpmbv97hTETW3yzrAij8aqlD36toB1D0daVFJM8NK6GvKO0gslVQmm+zZA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -891,11 +969,12 @@ } }, "node_modules/@babel/plugin-transform-logical-assignment-operators": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.27.1.tgz", - "integrity": "sha512-SJvDs5dXxiae4FbSL1aBJlG4wvl594N6YEVVn9e3JGulwioy6z3oPjx/sQBO3Y4NwUu5HNix6KJ3wBZoewcdbw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-logical-assignment-operators/-/plugin-transform-logical-assignment-operators-7.28.6.tgz", + "integrity": "sha512-+anKKair6gpi8VsM/95kmomGNMD0eLz1NQ8+Pfw5sAwWH9fGYXT50E55ZpV0pHUHWf6IUTWPM+f/7AAff+wr9A==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -908,6 +987,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.27.1.tgz", "integrity": "sha512-hqoBX4dcZ1I33jCSWcXrP+1Ku7kdqXf1oeah7ooKOIiAdKQ+uqftgCFNOSzA5AMS2XIHEYeGFg4cKRCdpxzVOQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -922,6 +1002,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.27.1.tgz", "integrity": "sha512-iCsytMg/N9/oFq6n+gFTvUYDZQOMK5kEdeYxmxt91fcJGycfxVP9CnrxoliM0oumFERba2i8ZtwRUCMhvP1LnA==", + "license": "MIT", "dependencies": { "@babel/helper-module-transforms": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" @@ -934,12 +1015,13 @@ } }, "node_modules/@babel/plugin-transform-modules-commonjs": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.27.1.tgz", - "integrity": "sha512-OJguuwlTYlN0gBZFRPqwOGNWssZjfIUdS7HMYtN8c1KmwpwHFBwTeFZrg9XZa+DFTitWOW5iTAG7tyCUPsCCyw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.28.6.tgz", + "integrity": "sha512-jppVbf8IV9iWWwWTQIxJMAJCWBuuKx71475wHwYytrRGQ2CWiDvYlADQno3tcYpS/T2UUWFQp3nVtYfK/YBQrA==", + "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -949,14 +1031,15 @@ } }, "node_modules/@babel/plugin-transform-modules-systemjs": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.27.1.tgz", - "integrity": "sha512-w5N1XzsRbc0PQStASMksmUeqECuzKuTJer7kFagK8AXgpCMkeDMO5S+aaFb7A51ZYDF7XI34qsTX+fkHiIm5yA==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.29.0.tgz", + "integrity": "sha512-PrujnVFbOdUpw4UHiVwKvKRLMMic8+eC0CuNlxjsyZUiBjhFdPsewdXCkveh2KqBA9/waD0W1b4hXSOBQJezpQ==", + "license": "MIT", "dependencies": { - "@babel/helper-module-transforms": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/helper-validator-identifier": "^7.27.1", - "@babel/traverse": "^7.27.1" + "@babel/helper-module-transforms": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/helper-validator-identifier": "^7.28.5", + "@babel/traverse": "^7.29.0" }, "engines": { "node": ">=6.9.0" @@ -969,6 +1052,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.27.1.tgz", "integrity": "sha512-iQBE/xC5BV1OxJbp6WG7jq9IWiD+xxlZhLrdwpPkTX3ydmXdvoCpyfJN7acaIBZaOqTfr76pgzqBJflNbeRK+w==", + "license": "MIT", "dependencies": { "@babel/helper-module-transforms": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" @@ -981,12 +1065,13 @@ } }, "node_modules/@babel/plugin-transform-named-capturing-groups-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.27.1.tgz", - "integrity": "sha512-SstR5JYy8ddZvD6MhV0tM/j16Qds4mIpJTOd1Yu9J9pJjH93bxHECF7pgtc28XvkzTD6Pxcm/0Z73Hvk7kb3Ng==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.29.0.tgz", + "integrity": "sha512-1CZQA5KNAD6ZYQLPw7oi5ewtDNxH/2vuCh+6SmvgDfhumForvs8a1o9n0UrEoBD8HU4djO2yWngTQlXl1NDVEQ==", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -999,6 +1084,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.27.1.tgz", "integrity": "sha512-f6PiYeqXQ05lYq3TIfIDu/MtliKUbNwkGApPUvyo6+tc7uaR4cPjPe7DFPr15Uyycg2lZU6btZ575CuQoYh7MQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1010,11 +1096,12 @@ } }, "node_modules/@babel/plugin-transform-nullish-coalescing-operator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.27.1.tgz", - "integrity": "sha512-aGZh6xMo6q9vq1JGcw58lZ1Z0+i0xB2x0XaauNIUXd6O1xXc3RwoWEBlsTQrY4KQ9Jf0s5rgD6SiNkaUdJegTA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-nullish-coalescing-operator/-/plugin-transform-nullish-coalescing-operator-7.28.6.tgz", + "integrity": "sha512-3wKbRgmzYbw24mDJXT7N+ADXw8BC/imU9yo9c9X9NKaLF1fW+e5H1U5QjMUBe4Qo4Ox/o++IyUkl1sVCLgevKg==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1024,11 +1111,12 @@ } }, "node_modules/@babel/plugin-transform-numeric-separator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.27.1.tgz", - "integrity": "sha512-fdPKAcujuvEChxDBJ5c+0BTaS6revLV7CJL08e4m3de8qJfNIuCc2nc7XJYOjBoTMJeqSmwXJ0ypE14RCjLwaw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-numeric-separator/-/plugin-transform-numeric-separator-7.28.6.tgz", + "integrity": "sha512-SJR8hPynj8outz+SlStQSwvziMN4+Bq99it4tMIf5/Caq+3iOc0JtKyse8puvyXkk3eFRIA5ID/XfunGgO5i6w==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1038,14 +1126,16 @@ } }, "node_modules/@babel/plugin-transform-object-rest-spread": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.27.2.tgz", - "integrity": "sha512-AIUHD7xJ1mCrj3uPozvtngY3s0xpv7Nu7DoUSnzNY6Xam1Cy4rUznR//pvMHOhQ4AvbCexhbqXCtpxGHOGOO6g==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-rest-spread/-/plugin-transform-object-rest-spread-7.28.6.tgz", + "integrity": "sha512-5rh+JR4JBC4pGkXLAcYdLHZjXudVxWMXbB6u6+E9lRL5TrGVbHt1TjxGbZ8CkmYw9zjkB7jutzOROArsqtncEA==", + "license": "MIT", "dependencies": { - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-plugin-utils": "^7.27.1", - "@babel/plugin-transform-destructuring": "^7.27.1", - "@babel/plugin-transform-parameters": "^7.27.1" + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/traverse": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1058,6 +1148,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.27.1.tgz", "integrity": "sha512-SFy8S9plRPbIcxlJ8A6mT/CxFdJx/c04JEctz4jf8YZaVS2px34j7NXRrlGlHkN/M2gnpL37ZpGRGVFLd3l8Ng==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1", "@babel/helper-replace-supers": "^7.27.1" @@ -1070,11 +1161,12 @@ } }, "node_modules/@babel/plugin-transform-optional-catch-binding": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.27.1.tgz", - "integrity": "sha512-txEAEKzYrHEX4xSZN4kJ+OfKXFVSWKB2ZxM9dpcE3wT7smwkNmXo5ORRlVzMVdJbD+Q8ILTgSD7959uj+3Dm3Q==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-catch-binding/-/plugin-transform-optional-catch-binding-7.28.6.tgz", + "integrity": "sha512-R8ja/Pyrv0OGAvAXQhSTmWyPJPml+0TMqXlO5w+AsMEiwb2fg3WkOvob7UxFSL3OIttFSGSRFKQsOhJ/X6HQdQ==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1084,11 +1176,12 @@ } }, "node_modules/@babel/plugin-transform-optional-chaining": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.27.1.tgz", - "integrity": "sha512-BQmKPPIuc8EkZgNKsv0X4bPmOoayeu4F1YCwx2/CfmDSXDbp7GnzlUH+/ul5VGfRg1AoFPsrIThlEBj2xb4CAg==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-optional-chaining/-/plugin-transform-optional-chaining-7.28.6.tgz", + "integrity": "sha512-A4zobikRGJTsX9uqVFdafzGkqD30t26ck2LmOzAuLL8b2x6k3TIqRiT2xVvA9fNmFeTX484VpsdgmKNA0bS23w==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" }, "engines": { @@ -1099,9 +1192,10 @@ } }, "node_modules/@babel/plugin-transform-parameters": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.1.tgz", - "integrity": "sha512-018KRk76HWKeZ5l4oTj2zPpSh+NbGdt0st5S6x0pga6HgrjBOJb24mMDHorFopOOd6YHkLgOZ+zaCjZGPO4aKg==", + "version": "7.27.7", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.27.7.tgz", + "integrity": "sha512-qBkYTYCb76RRxUM6CcZA5KRu8K4SM8ajzVeUgVdMVO9NN9uI/GaVmBg/WKJJGnNokV9SY8FxNOVWGXzqzUidBg==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1113,12 +1207,13 @@ } }, "node_modules/@babel/plugin-transform-private-methods": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.27.1.tgz", - "integrity": "sha512-10FVt+X55AjRAYI9BrdISN9/AQWHqldOeZDUoLyif1Kn05a56xVBXb8ZouL8pZ9jem8QpXaOt8TS7RHUIS+GPA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-methods/-/plugin-transform-private-methods-7.28.6.tgz", + "integrity": "sha512-piiuapX9CRv7+0st8lmuUlRSmX6mBcVeNQ1b4AYzJxfCMuBfB0vBXDiGSmm03pKJw1v6cZ8KSeM+oUnM6yAExg==", + "license": "MIT", "dependencies": { - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1128,13 +1223,14 @@ } }, "node_modules/@babel/plugin-transform-private-property-in-object": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.27.1.tgz", - "integrity": "sha512-5J+IhqTi1XPa0DXF83jYOaARrX+41gOewWbkPyjMNRDqgOCqdffGh8L3f/Ek5utaEBZExjSAzcyjmV9SSAWObQ==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-private-property-in-object/-/plugin-transform-private-property-in-object-7.28.6.tgz", + "integrity": "sha512-b97jvNSOb5+ehyQmBpmhOCiUC5oVK4PMnpRvO7+ymFBoqYjeDHIU9jnrNUuwHOiL9RpGDoKBpSViarV+BU+eVA==", + "license": "MIT", "dependencies": { - "@babel/helper-annotate-as-pure": "^7.27.1", - "@babel/helper-create-class-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-annotate-as-pure": "^7.27.3", + "@babel/helper-create-class-features-plugin": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1147,6 +1243,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.27.1.tgz", "integrity": "sha512-oThy3BCuCha8kDZ8ZkgOg2exvPYUlprMukKQXI1r1pJ47NCvxfkEy8vK+r/hT9nF0Aa4H1WUPZZjHTFtAhGfmQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1162,6 +1259,7 @@ "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-self/-/plugin-transform-react-jsx-self-7.27.1.tgz", "integrity": "sha512-6UzkCs+ejGdZ5mFFC/OCUrv028ab2fp1znZmCZjAOBKiBK2jXD1O+BPSfX8X2qjJ75fZBMSnQn3Rq2mrBJK2mw==", "dev": true, + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1177,6 +1275,7 @@ "resolved": "https://registry.npmjs.org/@babel/plugin-transform-react-jsx-source/-/plugin-transform-react-jsx-source-7.27.1.tgz", "integrity": "sha512-zbwoTsBruTeKB9hSq73ha66iFeJHuaFkUbwvqElnygoNbj/jHRsSeokowZFN3CZ64IvEqcmmkVe89OPXc7ldAw==", "dev": true, + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1188,11 +1287,12 @@ } }, "node_modules/@babel/plugin-transform-regenerator": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.27.1.tgz", - "integrity": "sha512-B19lbbL7PMrKr52BNPjCqg1IyNUIjTcxKj8uX9zHO+PmWN93s19NDr/f69mIkEp2x9nmDJ08a7lgHaTTzvW7mw==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.29.0.tgz", + "integrity": "sha512-FijqlqMA7DmRdg/aINBSs04y8XNTYw/lr1gJ2WsmBnnaNw1iS43EPkJW+zK7z65auG3AWRFXWj+NcTQwYptUog==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1202,12 +1302,13 @@ } }, "node_modules/@babel/plugin-transform-regexp-modifiers": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.27.1.tgz", - "integrity": "sha512-TtEciroaiODtXvLZv4rmfMhkCv8jx3wgKpL68PuiPh2M4fvz5jhsA7697N1gMvkvr/JTF13DrFYyEbY9U7cVPA==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regexp-modifiers/-/plugin-transform-regexp-modifiers-7.28.6.tgz", + "integrity": "sha512-QGWAepm9qxpaIs7UM9FvUSnCGlb8Ua1RhyM4/veAxLwt3gMat/LSGrZixyuj4I6+Kn9iwvqCyPTtbdxanYoWYg==", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1220,6 +1321,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.27.1.tgz", "integrity": "sha512-V2ABPHIJX4kC7HegLkYoDpfg9PVmuWy/i6vUM5eGK22bx4YVFD3M5F0QQnWQoDs6AGsUWTVOopBiMFQgHaSkVw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1234,6 +1336,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.27.1.tgz", "integrity": "sha512-N/wH1vcn4oYawbJ13Y/FxcQrWk63jhfNa7jef0ih7PHSIHX2LB7GWE1rkPrOnka9kwMxb6hMl19p7lidA+EHmQ==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1245,11 +1348,12 @@ } }, "node_modules/@babel/plugin-transform-spread": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.27.1.tgz", - "integrity": "sha512-kpb3HUqaILBJcRFVhFUs6Trdd4mkrzcGXss+6/mxUd273PfbWqSDHRzMT2234gIg2QYfAjvXLSquP1xECSg09Q==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.28.6.tgz", + "integrity": "sha512-9U4QObUC0FtJl05AsUcodau/RWDytrU6uKgkxu09mLR9HLDAtUMoPuuskm5huQsoktmsYpI+bGmq+iapDcriKA==", + "license": "MIT", "dependencies": { - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-skip-transparent-expression-wrappers": "^7.27.1" }, "engines": { @@ -1263,6 +1367,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.27.1.tgz", "integrity": "sha512-lhInBO5bi/Kowe2/aLdBAawijx+q1pQzicSgnkB6dUPc1+RC8QmJHKf2OjvU+NZWitguJHEaEmbV6VWEouT58g==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1277,6 +1382,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.27.1.tgz", "integrity": "sha512-fBJKiV7F2DxZUkg5EtHKXQdbsbURW3DZKQUWphDum0uRP6eHGGa/He9mc0mypL680pb+e/lDIthRohlv8NCHkg==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1291,6 +1397,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.27.1.tgz", "integrity": "sha512-RiSILC+nRJM7FY5srIyc4/fGIwUhyDuuBSdWn4y6yT6gm652DpCHZjIipgn6B7MQ1ITOUnAKWixEUjQRIBIcLw==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1305,6 +1412,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.27.1.tgz", "integrity": "sha512-Ysg4v6AmF26k9vpfFuTZg8HRfVWzsh1kVfowA23y9j/Gu6dOuahdUVhkLqpObp3JIv27MLSii6noRnuKN8H0Mg==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.27.1" }, @@ -1316,12 +1424,13 @@ } }, "node_modules/@babel/plugin-transform-unicode-property-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.27.1.tgz", - "integrity": "sha512-uW20S39PnaTImxp39O5qFlHLS9LJEmANjMG7SxIhap8rCHqu0Ik+tLEPX5DKmHn6CsWQ7j3lix2tFOa5YtL12Q==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-property-regex/-/plugin-transform-unicode-property-regex-7.28.6.tgz", + "integrity": "sha512-4Wlbdl/sIZjzi/8St0evF0gEZrgOswVO6aOzqxh1kDZOl9WmLrHq2HtGhnOJZmHZYKP8WZ1MDLCt5DAWwRo57A==", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1334,6 +1443,7 @@ "version": "7.27.1", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.27.1.tgz", "integrity": "sha512-xvINq24TRojDuyt6JGtHmkVkrfVV3FPT16uytxImLeBZqW3/H52yN+kM1MGuyPkIQxrzKwPHs5U/MP3qKyzkGw==", + "license": "MIT", "dependencies": { "@babel/helper-create-regexp-features-plugin": "^7.27.1", "@babel/helper-plugin-utils": "^7.27.1" @@ -1346,12 +1456,13 @@ } }, "node_modules/@babel/plugin-transform-unicode-sets-regex": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.27.1.tgz", - "integrity": "sha512-EtkOujbc4cgvb0mlpQefi4NTPBzhSIevblFevACNLUspmrALgmEBdL/XfnyyITfd8fKBZrZys92zOWcik7j9Tw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-sets-regex/-/plugin-transform-unicode-sets-regex-7.28.6.tgz", + "integrity": "sha512-/wHc/paTUmsDYN7SZkpWxogTOBNnlx7nBQYfy6JJlCT7G3mVhltk3e++N7zV0XfgGsrqBxd4rJQt9H16I21Y1Q==", + "license": "MIT", "dependencies": { - "@babel/helper-create-regexp-features-plugin": "^7.27.1", - "@babel/helper-plugin-utils": "^7.27.1" + "@babel/helper-create-regexp-features-plugin": "^7.28.5", + "@babel/helper-plugin-utils": "^7.28.6" }, "engines": { "node": ">=6.9.0" @@ -1361,78 +1472,80 @@ } }, "node_modules/@babel/preset-env": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.27.2.tgz", - "integrity": "sha512-Ma4zSuYSlGNRlCLO+EAzLnCmJK2vdstgv+n7aUP+/IKZrOfWHOJVdSJtuub8RzHTj3ahD37k5OKJWvzf16TQyQ==", + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.29.2.tgz", + "integrity": "sha512-DYD23veRYGvBFhcTY1iUvJnDNpuqNd/BzBwCvzOTKUnJjKg5kpUBh3/u9585Agdkgj+QuygG7jLfOPWMa2KVNw==", + "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.27.2", - "@babel/helper-compilation-targets": "^7.27.2", - "@babel/helper-plugin-utils": "^7.27.1", + "@babel/compat-data": "^7.29.0", + "@babel/helper-compilation-targets": "^7.28.6", + "@babel/helper-plugin-utils": "^7.28.6", "@babel/helper-validator-option": "^7.27.1", - "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.27.1", + "@babel/plugin-bugfix-firefox-class-in-computed-class-key": "^7.28.5", "@babel/plugin-bugfix-safari-class-field-initializer-scope": "^7.27.1", "@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression": "^7.27.1", "@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining": "^7.27.1", - "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.27.1", + "@babel/plugin-bugfix-v8-static-class-fields-redefine-readonly": "^7.28.6", "@babel/plugin-proposal-private-property-in-object": "7.21.0-placeholder-for-preset-env.2", - "@babel/plugin-syntax-import-assertions": "^7.27.1", - "@babel/plugin-syntax-import-attributes": "^7.27.1", + "@babel/plugin-syntax-import-assertions": "^7.28.6", + "@babel/plugin-syntax-import-attributes": "^7.28.6", "@babel/plugin-syntax-unicode-sets-regex": "^7.18.6", "@babel/plugin-transform-arrow-functions": "^7.27.1", - "@babel/plugin-transform-async-generator-functions": "^7.27.1", - "@babel/plugin-transform-async-to-generator": "^7.27.1", + "@babel/plugin-transform-async-generator-functions": "^7.29.0", + "@babel/plugin-transform-async-to-generator": "^7.28.6", "@babel/plugin-transform-block-scoped-functions": "^7.27.1", - "@babel/plugin-transform-block-scoping": "^7.27.1", - "@babel/plugin-transform-class-properties": "^7.27.1", - "@babel/plugin-transform-class-static-block": "^7.27.1", - "@babel/plugin-transform-classes": "^7.27.1", - "@babel/plugin-transform-computed-properties": "^7.27.1", - "@babel/plugin-transform-destructuring": "^7.27.1", - "@babel/plugin-transform-dotall-regex": "^7.27.1", + "@babel/plugin-transform-block-scoping": "^7.28.6", + "@babel/plugin-transform-class-properties": "^7.28.6", + "@babel/plugin-transform-class-static-block": "^7.28.6", + "@babel/plugin-transform-classes": "^7.28.6", + "@babel/plugin-transform-computed-properties": "^7.28.6", + "@babel/plugin-transform-destructuring": "^7.28.5", + "@babel/plugin-transform-dotall-regex": "^7.28.6", "@babel/plugin-transform-duplicate-keys": "^7.27.1", - "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.27.1", + "@babel/plugin-transform-duplicate-named-capturing-groups-regex": "^7.29.0", "@babel/plugin-transform-dynamic-import": "^7.27.1", - "@babel/plugin-transform-exponentiation-operator": "^7.27.1", + "@babel/plugin-transform-explicit-resource-management": "^7.28.6", + "@babel/plugin-transform-exponentiation-operator": "^7.28.6", "@babel/plugin-transform-export-namespace-from": "^7.27.1", "@babel/plugin-transform-for-of": "^7.27.1", "@babel/plugin-transform-function-name": "^7.27.1", - "@babel/plugin-transform-json-strings": "^7.27.1", + "@babel/plugin-transform-json-strings": "^7.28.6", "@babel/plugin-transform-literals": "^7.27.1", - "@babel/plugin-transform-logical-assignment-operators": "^7.27.1", + "@babel/plugin-transform-logical-assignment-operators": "^7.28.6", "@babel/plugin-transform-member-expression-literals": "^7.27.1", "@babel/plugin-transform-modules-amd": "^7.27.1", - "@babel/plugin-transform-modules-commonjs": "^7.27.1", - "@babel/plugin-transform-modules-systemjs": "^7.27.1", + "@babel/plugin-transform-modules-commonjs": "^7.28.6", + "@babel/plugin-transform-modules-systemjs": "^7.29.0", "@babel/plugin-transform-modules-umd": "^7.27.1", - "@babel/plugin-transform-named-capturing-groups-regex": "^7.27.1", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.29.0", "@babel/plugin-transform-new-target": "^7.27.1", - "@babel/plugin-transform-nullish-coalescing-operator": "^7.27.1", - "@babel/plugin-transform-numeric-separator": "^7.27.1", - "@babel/plugin-transform-object-rest-spread": "^7.27.2", + "@babel/plugin-transform-nullish-coalescing-operator": "^7.28.6", + "@babel/plugin-transform-numeric-separator": "^7.28.6", + "@babel/plugin-transform-object-rest-spread": "^7.28.6", "@babel/plugin-transform-object-super": "^7.27.1", - "@babel/plugin-transform-optional-catch-binding": "^7.27.1", - "@babel/plugin-transform-optional-chaining": "^7.27.1", - "@babel/plugin-transform-parameters": "^7.27.1", - "@babel/plugin-transform-private-methods": "^7.27.1", - "@babel/plugin-transform-private-property-in-object": "^7.27.1", + "@babel/plugin-transform-optional-catch-binding": "^7.28.6", + "@babel/plugin-transform-optional-chaining": "^7.28.6", + "@babel/plugin-transform-parameters": "^7.27.7", + "@babel/plugin-transform-private-methods": "^7.28.6", + "@babel/plugin-transform-private-property-in-object": "^7.28.6", "@babel/plugin-transform-property-literals": "^7.27.1", - "@babel/plugin-transform-regenerator": "^7.27.1", - "@babel/plugin-transform-regexp-modifiers": "^7.27.1", + "@babel/plugin-transform-regenerator": "^7.29.0", + "@babel/plugin-transform-regexp-modifiers": "^7.28.6", "@babel/plugin-transform-reserved-words": "^7.27.1", "@babel/plugin-transform-shorthand-properties": "^7.27.1", - "@babel/plugin-transform-spread": "^7.27.1", + "@babel/plugin-transform-spread": "^7.28.6", "@babel/plugin-transform-sticky-regex": "^7.27.1", "@babel/plugin-transform-template-literals": "^7.27.1", "@babel/plugin-transform-typeof-symbol": "^7.27.1", "@babel/plugin-transform-unicode-escapes": "^7.27.1", - "@babel/plugin-transform-unicode-property-regex": "^7.27.1", + "@babel/plugin-transform-unicode-property-regex": "^7.28.6", "@babel/plugin-transform-unicode-regex": "^7.27.1", - "@babel/plugin-transform-unicode-sets-regex": "^7.27.1", + "@babel/plugin-transform-unicode-sets-regex": "^7.28.6", "@babel/preset-modules": "0.1.6-no-external-plugins", - "babel-plugin-polyfill-corejs2": "^0.4.10", - "babel-plugin-polyfill-corejs3": "^0.11.0", - "babel-plugin-polyfill-regenerator": "^0.6.1", - "core-js-compat": "^3.40.0", + "babel-plugin-polyfill-corejs2": "^0.4.15", + "babel-plugin-polyfill-corejs3": "^0.14.0", + "babel-plugin-polyfill-regenerator": "^0.6.6", + "core-js-compat": "^3.48.0", "semver": "^6.3.1" }, "engines": { @@ -1446,6 +1559,7 @@ "version": "6.3.1", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } @@ -1454,6 +1568,7 @@ "version": "0.1.6-no-external-plugins", "resolved": "https://registry.npmjs.org/@babel/preset-modules/-/preset-modules-0.1.6-no-external-plugins.tgz", "integrity": "sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==", + "license": "MIT", "dependencies": { "@babel/helper-plugin-utils": "^7.0.0", "@babel/types": "^7.4.4", @@ -1464,62 +1579,67 @@ } }, "node_modules/@babel/runtime": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.27.1.tgz", - "integrity": "sha512-1x3D2xEk2fRo3PAhwQwu5UubzgiVWSXTBfWpVd2Mx2AzRqJuDJCsgaDVZ7HB5iGzDW1Hl1sWN2mFyKjmR9uAog==", + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.29.2.tgz", + "integrity": "sha512-JiDShH45zKHWyGe4ZNVRrCjBz8Nh9TMmZG1kh4QTK8hCBTWBi8Da+i7s1fJw7/lYpM4ccepSNfqzZ/QvABBi5g==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/runtime-corejs3": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.27.1.tgz", - "integrity": "sha512-909rVuj3phpjW6y0MCXAZ5iNeORePa6ldJvp2baWGcTjwqbBDDz6xoS5JHJ7lS88NlwLYj07ImL/8IUMtDZzTA==", + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/runtime-corejs3/-/runtime-corejs3-7.29.2.tgz", + "integrity": "sha512-Lc94FOD5+0aXhdb0Tdg3RUtqT6yWbI/BbFWvlaSJ3gAb9Ks+99nHRDKADVqC37er4eCB0fHyWT+y+K3QOvJKbw==", "dev": true, + "license": "MIT", "dependencies": { - "core-js-pure": "^3.30.2" + "core-js-pure": "^3.48.0" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/template": { - "version": "7.27.2", - "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.27.2.tgz", - "integrity": "sha512-LPDZ85aEJyYSd18/DkjNh4/y1ntkE5KwUHWTiqgRxruuZL2F1yuHligVHLvcHY2vMHXttKFpJn6LwfI7cw7ODw==", + "version": "7.28.6", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.28.6.tgz", + "integrity": "sha512-YA6Ma2KsCdGb+WC6UpBVFJGXL58MDA6oyONbjyF/+5sBgxY/dwkhLogbMT2GXXyU84/IhRw/2D1Os1B/giz+BQ==", + "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.27.1", - "@babel/parser": "^7.27.2", - "@babel/types": "^7.27.1" + "@babel/code-frame": "^7.28.6", + "@babel/parser": "^7.28.6", + "@babel/types": "^7.28.6" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/traverse": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.27.1.tgz", - "integrity": "sha512-ZCYtZciz1IWJB4U61UPu4KEaqyfj+r5T1Q5mqPo+IBpcG9kHv30Z0aD8LXPgC1trYa6rK0orRyAhqUgk4MjmEg==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.29.0.tgz", + "integrity": "sha512-4HPiQr0X7+waHfyXPZpWPfWL/J7dcN1mx9gL6WdQVMbPnF3+ZhSMs8tCxN7oHddJE9fhNE7+lxdnlyemKfJRuA==", + "license": "MIT", "dependencies": { - "@babel/code-frame": "^7.27.1", - "@babel/generator": "^7.27.1", - "@babel/parser": "^7.27.1", - "@babel/template": "^7.27.1", - "@babel/types": "^7.27.1", - "debug": "^4.3.1", - "globals": "^11.1.0" + "@babel/code-frame": "^7.29.0", + "@babel/generator": "^7.29.0", + "@babel/helper-globals": "^7.28.0", + "@babel/parser": "^7.29.0", + "@babel/template": "^7.28.6", + "@babel/types": "^7.29.0", + "debug": "^4.3.1" }, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/types": { - "version": "7.27.1", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.27.1.tgz", - "integrity": "sha512-+EzkxvLNfiUeKMgy/3luqfsCWFRXLb7U6wNQTk60tovuckwB15B191tJWvpp4HjiQWdJkCxO3Wbvc6jlk3Xb2Q==", + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", + "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", + "license": "MIT", "dependencies": { "@babel/helper-string-parser": "^7.27.1", - "@babel/helper-validator-identifier": "^7.27.1" + "@babel/helper-validator-identifier": "^7.28.5" }, "engines": { "node": ">=6.9.0" @@ -1530,14 +1650,15 @@ "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-1.0.2.tgz", "integrity": "sha512-6zABk/ECA/QYSCQ1NGiVwwbQerUCZ+TQbp64Q3AgmfNvurHH0j8TtXa1qbShXA6qqkpAj4V5W8pP6mLe1mcMqA==", "dev": true, + "license": "MIT", "engines": { "node": ">=18" } }, "node_modules/@csstools/color-helpers": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.0.2.tgz", - "integrity": "sha512-JqWH1vsgdGcw2RR6VliXXdA0/59LttzlU8UlRT/iUUsEeWfYq8I+K0yhihEUTTHLRm1EXvpsCx3083EU15ecsA==", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/@csstools/color-helpers/-/color-helpers-5.1.0.tgz", + "integrity": "sha512-S11EXWJyy0Mz5SYvRmY8nJYTFFd1LCNV+7cXyAgQtOOuzb4EsgfqDufL+9esx72/eLhsRdGZwaldu/h+E4t4BA==", "dev": true, "funding": [ { @@ -1549,14 +1670,15 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT-0", "engines": { "node": ">=18" } }, "node_modules/@csstools/css-calc": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.3.tgz", - "integrity": "sha512-XBG3talrhid44BY1x3MHzUx/aTG8+x/Zi57M4aTKK9RFB4aLlF3TTSzfzn8nWVHWL3FgAXAxmupmDd6VWww+pw==", + "version": "2.1.4", + "resolved": "https://registry.npmjs.org/@csstools/css-calc/-/css-calc-2.1.4.tgz", + "integrity": "sha512-3N8oaj+0juUw/1H3YwmDDJXCgTB1gKU6Hc/bB502u9zR0q2vd786XJH9QfrKIEgFlZmhZiq6epXl4rHqhzsIgQ==", "dev": true, "funding": [ { @@ -1568,18 +1690,19 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", "engines": { "node": ">=18" }, "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.4", - "@csstools/css-tokenizer": "^3.0.3" + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" } }, "node_modules/@csstools/css-color-parser": { - "version": "3.0.9", - "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.0.9.tgz", - "integrity": "sha512-wILs5Zk7BU86UArYBJTPy/FMPPKVKHMj1ycCEyf3VUptol0JNRLFU/BZsJ4aiIHJEbSLiizzRrw8Pc1uAEDrXw==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/@csstools/css-color-parser/-/css-color-parser-3.1.0.tgz", + "integrity": "sha512-nbtKwh3a6xNVIp/VRuXV64yTKnb1IjTAEEh3irzS+HkKjAOYLTGNb9pmVNntZ8iVBHcWDA2Dof0QtPgFI1BaTA==", "dev": true, "funding": [ { @@ -1591,22 +1714,23 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", "dependencies": { - "@csstools/color-helpers": "^5.0.2", - "@csstools/css-calc": "^2.1.3" + "@csstools/color-helpers": "^5.1.0", + "@csstools/css-calc": "^2.1.4" }, "engines": { "node": ">=18" }, "peerDependencies": { - "@csstools/css-parser-algorithms": "^3.0.4", - "@csstools/css-tokenizer": "^3.0.3" + "@csstools/css-parser-algorithms": "^3.0.5", + "@csstools/css-tokenizer": "^3.0.4" } }, "node_modules/@csstools/css-parser-algorithms": { - "version": "3.0.4", - "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.4.tgz", - "integrity": "sha512-Up7rBoV77rv29d3uKHUIVubz1BTcgyUK72IvCQAbfbMv584xHcGKCKbWh7i8hPrRJ7qU4Y8IO3IY9m+iTB7P3A==", + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@csstools/css-parser-algorithms/-/css-parser-algorithms-3.0.5.tgz", + "integrity": "sha512-DaDeUkXZKjdGhgYaHNJTV9pV7Y9B3b644jCLs9Upc3VeNGg6LWARAT6O+Q+/COo+2gg/bM5rhpMAtf70WqfBdQ==", "dev": true, "funding": [ { @@ -1618,17 +1742,18 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", "engines": { "node": ">=18" }, "peerDependencies": { - "@csstools/css-tokenizer": "^3.0.3" + "@csstools/css-tokenizer": "^3.0.4" } }, "node_modules/@csstools/css-tokenizer": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.3.tgz", - "integrity": "sha512-UJnjoFsmxfKUdNYdWgOB0mWUypuLvAfQPH1+pyvRJs6euowbFkFC6P13w1l8mJyi3vxYMxc9kld5jZEGRQs6bw==", + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@csstools/css-tokenizer/-/css-tokenizer-3.0.4.tgz", + "integrity": "sha512-Vd/9EVDiu6PPJt9yAh6roZP6El1xHrdvIVGjyBsHR0RYwNHgL7FJPyIIW4fANJNG6FtyZfvlRPpFI4ZM/lubvw==", "dev": true, "funding": [ { @@ -1640,23 +1765,44 @@ "url": "https://opencollective.com/csstools" } ], + "license": "MIT", "engines": { "node": ">=18" } }, + "node_modules/@date-io/core": { + "version": "1.3.13", + "resolved": "https://registry.npmjs.org/@date-io/core/-/core-1.3.13.tgz", + "integrity": "sha512-AlEKV7TxjeK+jxWVKcCFrfYAk8spX9aCyiToFIiLPtfQbsjmRGLIhb5VZgptQcJdHtLXo7+m0DuurwFgUToQuA==", + "license": "MIT" + }, + "node_modules/@date-io/moment": { + "version": "1.3.11", + "resolved": "https://registry.npmjs.org/@date-io/moment/-/moment-1.3.11.tgz", + "integrity": "sha512-pLEkqp8+P1DfC+QU8StaIANXoiadjJjoImLQCy0rhFAo0RVcJB9cM7mWr7fVgM49EjCwpA8a1JekNhuRLIJVwQ==", + "license": "MIT", + "dependencies": { + "@date-io/core": "^1.3.11" + }, + "peerDependencies": { + "moment": "^2.24.0" + } + }, "node_modules/@emotion/hash": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/@emotion/hash/-/hash-0.8.0.tgz", - "integrity": "sha512-kBJtf7PH6aWwZ6fka3zQ0p6SBYzx4fl1LoZXE2RrnYST9Xljm7WfKJrU4g/Xr3Beg72MLrp1AWNUmuYJTL7Cow==" + "integrity": "sha512-kBJtf7PH6aWwZ6fka3zQ0p6SBYzx4fl1LoZXE2RrnYST9Xljm7WfKJrU4g/Xr3Beg72MLrp1AWNUmuYJTL7Cow==", + "license": "MIT" }, "node_modules/@esbuild/aix-ppc64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.25.4.tgz", - "integrity": "sha512-1VCICWypeQKhVbE9oW/sJaAmjLxhVqacdkvPLEjwlttjfwENRSClS8EjBz0KzRyFSCPDIkuXW34Je/vk7zdB7Q==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.7.tgz", + "integrity": "sha512-EKX3Qwmhz1eMdEJokhALr0YiD0lhQNwDqkPYyPhiSwKrh7/4KRjQc04sZ8db+5DVVnZ1LmbNDI1uAMPEUBnQPg==", "cpu": [ "ppc64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "aix" @@ -1666,13 +1812,14 @@ } }, "node_modules/@esbuild/android-arm": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.25.4.tgz", - "integrity": "sha512-QNdQEps7DfFwE3hXiU4BZeOV68HHzYwGd0Nthhd3uCkkEKK7/R6MTgM0P7H7FAs5pU/DIWsviMmEGxEoxIZ+ZQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.7.tgz", + "integrity": "sha512-jbPXvB4Yj2yBV7HUfE2KHe4GJX51QplCN1pGbYjvsyCZbQmies29EoJbkEc+vYuU5o45AfQn37vZlyXy4YJ8RQ==", "cpu": [ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -1682,13 +1829,14 @@ } }, "node_modules/@esbuild/android-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.25.4.tgz", - "integrity": "sha512-bBy69pgfhMGtCnwpC/x5QhfxAz/cBgQ9enbtwjf6V9lnPI/hMyT9iWpR1arm0l3kttTr4L0KSLpKmLp/ilKS9A==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.7.tgz", + "integrity": "sha512-62dPZHpIXzvChfvfLJow3q5dDtiNMkwiRzPylSCfriLvZeq0a1bWChrGx/BbUbPwOrsWKMn8idSllklzBy+dgQ==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -1698,13 +1846,14 @@ } }, "node_modules/@esbuild/android-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.25.4.tgz", - "integrity": "sha512-TVhdVtQIFuVpIIR282btcGC2oGQoSfZfmBdTip2anCaVYcqWlZXGcdcKIUklfX2wj0JklNYgz39OBqh2cqXvcQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.7.tgz", + "integrity": "sha512-x5VpMODneVDb70PYV2VQOmIUUiBtY3D3mPBG8NxVk5CogneYhkR7MmM3yR/uMdITLrC1ml/NV1rj4bMJuy9MCg==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "android" @@ -1714,13 +1863,14 @@ } }, "node_modules/@esbuild/darwin-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.25.4.tgz", - "integrity": "sha512-Y1giCfM4nlHDWEfSckMzeWNdQS31BQGs9/rouw6Ub91tkK79aIMTH3q9xHvzH8d0wDru5Ci0kWB8b3up/nl16g==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.7.tgz", + "integrity": "sha512-5lckdqeuBPlKUwvoCXIgI2D9/ABmPq3Rdp7IfL70393YgaASt7tbju3Ac+ePVi3KDH6N2RqePfHnXkaDtY9fkw==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -1730,13 +1880,14 @@ } }, "node_modules/@esbuild/darwin-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.25.4.tgz", - "integrity": "sha512-CJsry8ZGM5VFVeyUYB3cdKpd/H69PYez4eJh1W/t38vzutdjEjtP7hB6eLKBoOdxcAlCtEYHzQ/PJ/oU9I4u0A==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.7.tgz", + "integrity": "sha512-rYnXrKcXuT7Z+WL5K980jVFdvVKhCHhUwid+dDYQpH+qu+TefcomiMAJpIiC2EM3Rjtq0sO3StMV/+3w3MyyqQ==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -1746,13 +1897,14 @@ } }, "node_modules/@esbuild/freebsd-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.25.4.tgz", - "integrity": "sha512-yYq+39NlTRzU2XmoPW4l5Ifpl9fqSk0nAJYM/V/WUGPEFfek1epLHJIkTQM6bBs1swApjO5nWgvr843g6TjxuQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.7.tgz", + "integrity": "sha512-B48PqeCsEgOtzME2GbNM2roU29AMTuOIN91dsMO30t+Ydis3z/3Ngoj5hhnsOSSwNzS+6JppqWsuhTp6E82l2w==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" @@ -1762,13 +1914,14 @@ } }, "node_modules/@esbuild/freebsd-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.25.4.tgz", - "integrity": "sha512-0FgvOJ6UUMflsHSPLzdfDnnBBVoCDtBTVyn/MrWloUNvq/5SFmh13l3dvgRPkDihRxb77Y17MbqbCAa2strMQQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.7.tgz", + "integrity": "sha512-jOBDK5XEjA4m5IJK3bpAQF9/Lelu/Z9ZcdhTRLf4cajlB+8VEhFFRjWgfy3M1O4rO2GQ/b2dLwCUGpiF/eATNQ==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "freebsd" @@ -1778,13 +1931,14 @@ } }, "node_modules/@esbuild/linux-arm": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.25.4.tgz", - "integrity": "sha512-kro4c0P85GMfFYqW4TWOpvmF8rFShbWGnrLqlzp4X1TNWjRY3JMYUfDCtOxPKOIY8B0WC8HN51hGP4I4hz4AaQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.7.tgz", + "integrity": "sha512-RkT/YXYBTSULo3+af8Ib0ykH8u2MBh57o7q/DAs3lTJlyVQkgQvlrPTnjIzzRPQyavxtPtfg0EopvDyIt0j1rA==", "cpu": [ "arm" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1794,13 +1948,14 @@ } }, "node_modules/@esbuild/linux-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.25.4.tgz", - "integrity": "sha512-+89UsQTfXdmjIvZS6nUnOOLoXnkUTB9hR5QAeLrQdzOSWZvNSAXAtcRDHWtqAUtAmv7ZM1WPOOeSxDzzzMogiQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.7.tgz", + "integrity": "sha512-RZPHBoxXuNnPQO9rvjh5jdkRmVizktkT7TCDkDmQ0W2SwHInKCAV95GRuvdSvA7w4VMwfCjUiPwDi0ZO6Nfe9A==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1810,13 +1965,14 @@ } }, "node_modules/@esbuild/linux-ia32": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.25.4.tgz", - "integrity": "sha512-yTEjoapy8UP3rv8dB0ip3AfMpRbyhSN3+hY8mo/i4QXFeDxmiYbEKp3ZRjBKcOP862Ua4b1PDfwlvbuwY7hIGQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.7.tgz", + "integrity": "sha512-GA48aKNkyQDbd3KtkplYWT102C5sn/EZTY4XROkxONgruHPU72l+gW+FfF8tf2cFjeHaRbWpOYa/uRBz/Xq1Pg==", "cpu": [ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1826,13 +1982,14 @@ } }, "node_modules/@esbuild/linux-loong64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.25.4.tgz", - "integrity": "sha512-NeqqYkrcGzFwi6CGRGNMOjWGGSYOpqwCjS9fvaUlX5s3zwOtn1qwg1s2iE2svBe4Q/YOG1q6875lcAoQK/F4VA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.7.tgz", + "integrity": "sha512-a4POruNM2oWsD4WKvBSEKGIiWQF8fZOAsycHOt6JBpZ+JN2n2JH9WAv56SOyu9X5IqAjqSIPTaJkqN8F7XOQ5Q==", "cpu": [ "loong64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1842,13 +1999,14 @@ } }, "node_modules/@esbuild/linux-mips64el": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.25.4.tgz", - "integrity": "sha512-IcvTlF9dtLrfL/M8WgNI/qJYBENP3ekgsHbYUIzEzq5XJzzVEV/fXY9WFPfEEXmu3ck2qJP8LG/p3Q8f7Zc2Xg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.7.tgz", + "integrity": "sha512-KabT5I6StirGfIz0FMgl1I+R1H73Gp0ofL9A3nG3i/cYFJzKHhouBV5VWK1CSgKvVaG4q1RNpCTR2LuTVB3fIw==", "cpu": [ "mips64el" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1858,13 +2016,14 @@ } }, "node_modules/@esbuild/linux-ppc64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.25.4.tgz", - "integrity": "sha512-HOy0aLTJTVtoTeGZh4HSXaO6M95qu4k5lJcH4gxv56iaycfz1S8GO/5Jh6X4Y1YiI0h7cRyLi+HixMR+88swag==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.7.tgz", + "integrity": "sha512-gRsL4x6wsGHGRqhtI+ifpN/vpOFTQtnbsupUF5R5YTAg+y/lKelYR1hXbnBdzDjGbMYjVJLJTd2OFmMewAgwlQ==", "cpu": [ "ppc64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1874,13 +2033,14 @@ } }, "node_modules/@esbuild/linux-riscv64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.25.4.tgz", - "integrity": "sha512-i8JUDAufpz9jOzo4yIShCTcXzS07vEgWzyX3NH2G7LEFVgrLEhjwL3ajFE4fZI3I4ZgiM7JH3GQ7ReObROvSUA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.7.tgz", + "integrity": "sha512-hL25LbxO1QOngGzu2U5xeXtxXcW+/GvMN3ejANqXkxZ/opySAZMrc+9LY/WyjAan41unrR3YrmtTsUpwT66InQ==", "cpu": [ "riscv64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1890,13 +2050,14 @@ } }, "node_modules/@esbuild/linux-s390x": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.25.4.tgz", - "integrity": "sha512-jFnu+6UbLlzIjPQpWCNh5QtrcNfMLjgIavnwPQAfoGx4q17ocOU9MsQ2QVvFxwQoWpZT8DvTLooTvmOQXkO51g==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.7.tgz", + "integrity": "sha512-2k8go8Ycu1Kb46vEelhu1vqEP+UeRVj2zY1pSuPdgvbd5ykAw82Lrro28vXUrRmzEsUV0NzCf54yARIK8r0fdw==", "cpu": [ "s390x" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1906,13 +2067,14 @@ } }, "node_modules/@esbuild/linux-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.25.4.tgz", - "integrity": "sha512-6e0cvXwzOnVWJHq+mskP8DNSrKBr1bULBvnFLpc1KY+d+irZSgZ02TGse5FsafKS5jg2e4pbvK6TPXaF/A6+CA==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.7.tgz", + "integrity": "sha512-hzznmADPt+OmsYzw1EE33ccA+HPdIqiCRq7cQeL1Jlq2gb1+OyWBkMCrYGBJ+sxVzve2ZJEVeePbLM2iEIZSxA==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "linux" @@ -1922,13 +2084,14 @@ } }, "node_modules/@esbuild/netbsd-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.25.4.tgz", - "integrity": "sha512-vUnkBYxZW4hL/ie91hSqaSNjulOnYXE1VSLusnvHg2u3jewJBz3YzB9+oCw8DABeVqZGg94t9tyZFoHma8gWZQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.7.tgz", + "integrity": "sha512-b6pqtrQdigZBwZxAn1UpazEisvwaIDvdbMbmrly7cDTMFnw/+3lVxxCTGOrkPVnsYIosJJXAsILG9XcQS+Yu6w==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "netbsd" @@ -1938,13 +2101,14 @@ } }, "node_modules/@esbuild/netbsd-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.25.4.tgz", - "integrity": "sha512-XAg8pIQn5CzhOB8odIcAm42QsOfa98SBeKUdo4xa8OvX8LbMZqEtgeWE9P/Wxt7MlG2QqvjGths+nq48TrUiKw==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.7.tgz", + "integrity": "sha512-OfatkLojr6U+WN5EDYuoQhtM+1xco+/6FSzJJnuWiUw5eVcicbyK3dq5EeV/QHT1uy6GoDhGbFpprUiHUYggrw==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "netbsd" @@ -1954,13 +2118,14 @@ } }, "node_modules/@esbuild/openbsd-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.25.4.tgz", - "integrity": "sha512-Ct2WcFEANlFDtp1nVAXSNBPDxyU+j7+tId//iHXU2f/lN5AmO4zLyhDcpR5Cz1r08mVxzt3Jpyt4PmXQ1O6+7A==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.7.tgz", + "integrity": "sha512-AFuojMQTxAz75Fo8idVcqoQWEHIXFRbOc1TrVcFSgCZtQfSdc1RXgB3tjOn/krRHENUB4j00bfGjyl2mJrU37A==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "openbsd" @@ -1970,13 +2135,14 @@ } }, "node_modules/@esbuild/openbsd-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.25.4.tgz", - "integrity": "sha512-xAGGhyOQ9Otm1Xu8NT1ifGLnA6M3sJxZ6ixylb+vIUVzvvd6GOALpwQrYrtlPouMqd/vSbgehz6HaVk4+7Afhw==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.7.tgz", + "integrity": "sha512-+A1NJmfM8WNDv5CLVQYJ5PshuRm/4cI6WMZRg1by1GwPIQPCTs1GLEUHwiiQGT5zDdyLiRM/l1G0Pv54gvtKIg==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "openbsd" @@ -1985,14 +2151,32 @@ "node": ">=18" } }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.7.tgz", + "integrity": "sha512-+KrvYb/C8zA9CU/g0sR6w2RBw7IGc5J2BPnc3dYc5VJxHCSF1yNMxTV5LQ7GuKteQXZtspjFbiuW5/dOj7H4Yw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, "node_modules/@esbuild/sunos-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.25.4.tgz", - "integrity": "sha512-Mw+tzy4pp6wZEK0+Lwr76pWLjrtjmJyUB23tHKqEDP74R3q95luY/bXqXZeYl4NYlvwOqoRKlInQialgCKy67Q==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.7.tgz", + "integrity": "sha512-ikktIhFBzQNt/QDyOL580ti9+5mL/YZeUPKU2ivGtGjdTYoqz6jObj6nOMfhASpS4GU4Q/Clh1QtxWAvcYKamA==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "sunos" @@ -2002,13 +2186,14 @@ } }, "node_modules/@esbuild/win32-arm64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.25.4.tgz", - "integrity": "sha512-AVUP428VQTSddguz9dO9ngb+E5aScyg7nOeJDrF1HPYu555gmza3bDGMPhmVXL8svDSoqPCsCPjb265yG/kLKQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.7.tgz", + "integrity": "sha512-7yRhbHvPqSpRUV7Q20VuDwbjW5kIMwTHpptuUzV+AA46kiPze5Z7qgt6CLCK3pWFrHeNfDd1VKgyP4O+ng17CA==", "cpu": [ "arm64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -2018,13 +2203,14 @@ } }, "node_modules/@esbuild/win32-ia32": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.25.4.tgz", - "integrity": "sha512-i1sW+1i+oWvQzSgfRcxxG2k4I9n3O9NRqy8U+uugaT2Dy7kLO9Y7wI72haOahxceMX8hZAzgGou1FhndRldxRg==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.7.tgz", + "integrity": "sha512-SmwKXe6VHIyZYbBLJrhOoCJRB/Z1tckzmgTLfFYOfpMAx63BJEaL9ExI8x7v0oAO3Zh6D/Oi1gVxEYr5oUCFhw==", "cpu": [ "ia32" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -2034,13 +2220,14 @@ } }, "node_modules/@esbuild/win32-x64": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.25.4.tgz", - "integrity": "sha512-nOT2vZNw6hJ+z43oP1SPea/G/6AbN6X+bGNhNuq8NtRHy4wsMhw765IKLNmnjek7GvjWBYQ8Q5VBoYTFg9y1UQ==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.7.tgz", + "integrity": "sha512-56hiAJPhwQ1R4i+21FVF7V8kSD5zZTdHcVuRFMW0hn753vVfQN8xlx4uOPT4xoGH0Z/oVATuR82AiqSTDIpaHg==", "cpu": [ "x64" ], "dev": true, + "license": "MIT", "optional": true, "os": [ "win32" @@ -2050,10 +2237,11 @@ } }, "node_modules/@eslint-community/eslint-utils": { - "version": "4.7.0", - "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.7.0.tgz", - "integrity": "sha512-dyybb3AcajC7uha6CvhdVRJqaKyn7w2YKqKyAN37NKYgZT36w+iRb0Dymmc5qEJ549c/S31cMMSFd75bteCpCw==", + "version": "4.9.1", + "resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz", + "integrity": "sha512-phrYmNiYppR7znFEdqgfWHXR6NCkZEK7hwWDHZUjit/2/U0r6XvkDl0SYnoM51Hq7FhCGdLDT6zxCCOY1hexsQ==", "dev": true, + "license": "MIT", "dependencies": { "eslint-visitor-keys": "^3.4.3" }, @@ -2068,10 +2256,11 @@ } }, "node_modules/@eslint-community/regexpp": { - "version": "4.12.1", - "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.1.tgz", - "integrity": "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ==", + "version": "4.12.2", + "resolved": "https://registry.npmjs.org/@eslint-community/regexpp/-/regexpp-4.12.2.tgz", + "integrity": "sha512-EriSTlt5OC9/7SXkRSCAhfSxxoSUgBm33OH+IkwbdpgoqsSsUg7y3uh+IICI/Qg4BBWr3U2i39RpmycbxMq4ew==", "dev": true, + "license": "MIT", "engines": { "node": "^12.0.0 || ^14.0.0 || >=16.0.0" } @@ -2081,6 +2270,7 @@ "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-2.1.4.tgz", "integrity": "sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==", "dev": true, + "license": "MIT", "dependencies": { "ajv": "^6.12.4", "debug": "^4.3.2", @@ -2100,35 +2290,22 @@ } }, "node_modules/@eslint/eslintrc/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.13.tgz", + "integrity": "sha512-9ZLprWS6EENmhEOpjCYW2c8VkmOvckIJZfkr7rBW6dObmfgJ/L1GpSYW5Hpo9lDz4D1+n0Ckz8rU7FwHDQiG/w==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, - "node_modules/@eslint/eslintrc/node_modules/globals": { - "version": "13.24.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", - "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", - "dev": true, - "dependencies": { - "type-fest": "^0.20.2" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/@eslint/eslintrc/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -2136,23 +2313,12 @@ "node": "*" } }, - "node_modules/@eslint/eslintrc/node_modules/type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/@eslint/js": { "version": "8.57.1", "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.1.tgz", "integrity": "sha512-d9zaMRSTIKDLhctzH12MtXvJKSSUhaHcjV+2Z+GK+EEY7XKpP5yR4x+N3TAcHTcu963nIr+TMcCb4DBCYX1z6Q==", "dev": true, + "license": "MIT", "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" } @@ -2163,6 +2329,7 @@ "integrity": "sha512-DZLEEqFWQFiyK6h5YIeynKx7JlvCYWL0cImfSRXZ9l4Sg2efkFGTuFf6vzXjK1cq6IYkU+Eg/JizXw+TD2vRNw==", "deprecated": "Use @eslint/config-array instead", "dev": true, + "license": "Apache-2.0", "dependencies": { "@humanwhocodes/object-schema": "^2.0.3", "debug": "^4.3.1", @@ -2173,20 +2340,22 @@ } }, "node_modules/@humanwhocodes/config-array/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.13.tgz", + "integrity": "sha512-9ZLprWS6EENmhEOpjCYW2c8VkmOvckIJZfkr7rBW6dObmfgJ/L1GpSYW5Hpo9lDz4D1+n0Ckz8rU7FwHDQiG/w==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "node_modules/@humanwhocodes/config-array/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -2199,6 +2368,7 @@ "resolved": "https://registry.npmjs.org/@humanwhocodes/module-importer/-/module-importer-1.0.1.tgz", "integrity": "sha512-bxveV4V8v5Yb4ncFTT3rPSgZBOpCkjfK0y4oVVVJwIuDVBRMDXrPyXRL988i5ap9m9bnyEEjWfm5WkBmtffLfA==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=12.22" }, @@ -2212,76 +2382,16 @@ "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.3.tgz", "integrity": "sha512-93zYdMES/c1D69yZiKDBj0V24vqNzB/koF26KPaagAfd3P/4gUlh3Dys5ogAK+Exi9QyzlD8x/08Zt7wIKcDcA==", "deprecated": "Use @eslint/object-schema instead", - "dev": true + "dev": true, + "license": "BSD-3-Clause" }, "node_modules/@isaacs/cliui": { - "version": "8.0.2", - "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz", - "integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==", - "dev": true, - "dependencies": { - "string-width": "^5.1.2", - "string-width-cjs": "npm:string-width@^4.2.0", - "strip-ansi": "^7.0.1", - "strip-ansi-cjs": "npm:strip-ansi@^6.0.1", - "wrap-ansi": "^8.1.0", - "wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0" - }, + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-9.0.0.tgz", + "integrity": "sha512-AokJm4tuBHillT+FpMtxQ60n8ObyXBatq7jD2/JA9dxbDDokKQm8KMht5ibGzLVU9IJDIKK4TPKgMHEYMn3lMg==", + "license": "BlueOak-1.0.0", "engines": { - "node": ">=12" - } - }, - "node_modules/@isaacs/cliui/node_modules/ansi-regex": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", - "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", - "dev": true, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/ansi-regex?sponsor=1" - } - }, - "node_modules/@isaacs/cliui/node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, - "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/@isaacs/cliui/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, - "dependencies": { - "ansi-regex": "^6.0.1" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/strip-ansi?sponsor=1" - } - }, - "node_modules/@istanbuljs/schema": { - "version": "0.1.3", - "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.3.tgz", - "integrity": "sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA==", - "dev": true, - "engines": { - "node": ">=8" + "node": ">=18" } }, "node_modules/@jest/types": { @@ -2289,6 +2399,7 @@ "resolved": "https://registry.npmjs.org/@jest/types/-/types-26.6.2.tgz", "integrity": "sha512-fC6QCp7Sc5sX6g8Tvbmj4XUTbyrik0akgRy03yjXbQaBWWNWGE7SGtJk98m0N8nzegD/7SggrUlivxo5ax4KWQ==", "dev": true, + "license": "MIT", "dependencies": { "@types/istanbul-lib-coverage": "^2.0.0", "@types/istanbul-reports": "^3.0.0", @@ -2301,62 +2412,133 @@ } }, "node_modules/@jridgewell/gen-mapping": { - "version": "0.3.8", - "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.8.tgz", - "integrity": "sha512-imAbBGkb+ebQyxKgzv5Hu2nmROxoDOXHh80evxdoXNOrvAnVx7zimzc1Oo5h9RlfV4vPXaE2iM5pOFbvOCClWA==", + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "license": "MIT", "dependencies": { - "@jridgewell/set-array": "^1.2.1", - "@jridgewell/sourcemap-codec": "^1.4.10", + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/remapping": { + "version": "2.3.5", + "resolved": "https://registry.npmjs.org/@jridgewell/remapping/-/remapping-2.3.5.tgz", + "integrity": "sha512-LI9u/+laYG4Ds1TDKSJW2YPrIlcVYOwi2fUC6xB43lueCjgxV4lffOCZCtYFiH6TNOX+tQKXx97T4IKHbhyHEQ==", + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.24" - }, - "engines": { - "node": ">=6.0.0" } }, "node_modules/@jridgewell/resolve-uri": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@jridgewell/set-array": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@jridgewell/set-array/-/set-array-1.2.1.tgz", - "integrity": "sha512-R8gLRTZeyp03ymzP/6Lil/28tGeGEzhx1q2k703KGWRAI1VdvPIXdG70VJc2pAMw3NA6JKL5hhFu1sJX0Mnn/A==", + "license": "MIT", "engines": { "node": ">=6.0.0" } }, "node_modules/@jridgewell/source-map": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.6.tgz", - "integrity": "sha512-1ZJTZebgqllO79ue2bm3rIGud/bOe0pP5BjSRCRxxYkEZS8STV7zN84UBbiYu7jy+eCKSnVIUgoWWE/tt+shMQ==", + "version": "0.3.11", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.11.tgz", + "integrity": "sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA==", + "license": "MIT", "dependencies": { "@jridgewell/gen-mapping": "^0.3.5", "@jridgewell/trace-mapping": "^0.3.25" } }, "node_modules/@jridgewell/sourcemap-codec": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz", - "integrity": "sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==" + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "license": "MIT" }, "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.25", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz", - "integrity": "sha512-vNk6aEwybGtawWmy/PzwnGDOjCkLWSD2wqvjGGAgOAwCGWySYXfYoxt00IJkTF+8Lb57DwOb3Aa0o9CApepiYQ==", + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "license": "MIT", "dependencies": { "@jridgewell/resolve-uri": "^3.1.0", "@jridgewell/sourcemap-codec": "^1.4.14" } }, + "node_modules/@jsonforms/core": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/@jsonforms/core/-/core-2.5.2.tgz", + "integrity": "sha512-tl64cLC2dUrGvu2nTHRDEA5Yv3RfwzMCIlVaoSUSq44LakKLGJdkPl8j/fb07llpFqz0a7gEAmy/8gLdmwgaLQ==", + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.3", + "ajv": "^6.10.2", + "json-schema-ref-parser": "7.1.3", + "lodash": "^4.17.15", + "uri-js": "^4.2.2", + "uuid": "^3.3.3" + } + }, + "node_modules/@jsonforms/core/node_modules/uuid": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", + "deprecated": "Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.", + "license": "MIT", + "bin": { + "uuid": "bin/uuid" + } + }, + "node_modules/@jsonforms/material-renderers": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/@jsonforms/material-renderers/-/material-renderers-2.5.2.tgz", + "integrity": "sha512-0C6MVyhLoMOf1Byhgs9ZNvV4NWHdbMce6m7hW2LF1Mt9mK1wDfTTst+xM3g7K5b8FSiBiF5kMnTggJcRweAEBA==", + "license": "MIT", + "dependencies": { + "@date-io/moment": "1.3.11", + "@material-ui/pickers": "^3.2.8", + "@types/uuid": "^3.4.6", + "moment": "^2.24.0", + "uuid": "^3.3.3" + }, + "peerDependencies": { + "@jsonforms/core": "^2.5.2", + "@jsonforms/react": "^2.5.2", + "@material-ui/core": "^4.7.0", + "@material-ui/icons": "^4.5.1" + } + }, + "node_modules/@jsonforms/material-renderers/node_modules/uuid": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", + "deprecated": "Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.", + "license": "MIT", + "bin": { + "uuid": "bin/uuid" + } + }, + "node_modules/@jsonforms/react": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/@jsonforms/react/-/react-2.5.2.tgz", + "integrity": "sha512-kZf2fq4urIBlFTCiBX95eKg8uojkyJj7FVDtIV739aVkJjE5+ihn1+kG1qLxYSxlGC7S24i12BZJzRetSRihBQ==", + "license": "MIT", + "dependencies": { + "lodash": "^4.17.15", + "object-hash": "^2.0.0" + }, + "peerDependencies": { + "@jsonforms/core": "^2.5.2", + "react": "^16.12.0 || ^17.0.0" + } + }, "node_modules/@material-ui/core": { "version": "4.12.4", "resolved": "https://registry.npmjs.org/@material-ui/core/-/core-4.12.4.tgz", "integrity": "sha512-tr7xekNlM9LjA6pagJmL8QCgZXaubWUwkJnoYcMKd4gw/t4XiyvnTkjdGrUVicyB2BsdaAv1tvow45bPM4sSwQ==", "deprecated": "Material UI v4 doesn't receive active development since September 2021. See the guide https://mui.com/material-ui/migration/migration-v4/ to upgrade to v5.", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "@material-ui/styles": "^4.11.5", @@ -2393,6 +2575,7 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", "engines": { "node": ">=6" } @@ -2401,6 +2584,7 @@ "version": "4.11.3", "resolved": "https://registry.npmjs.org/@material-ui/icons/-/icons-4.11.3.tgz", "integrity": "sha512-IKHlyx6LDh8n19vzwH5RtHIOHl9Tu90aAAxcbWME6kp4dmvODM3UvOHJeMIDzUbd4muuJKHmlNoBN+mDY4XkBA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4" }, @@ -2424,6 +2608,7 @@ "resolved": "https://registry.npmjs.org/@material-ui/lab/-/lab-4.0.0-alpha.61.tgz", "integrity": "sha512-rSzm+XKiNUjKegj8bzt5+pygZeckNLOr+IjykH8sYdVk7dE9y2ZuUSofiMV2bJk3qU+JHwexmw+q0RyNZB9ugg==", "deprecated": "Material UI v4 doesn't receive active development since September 2021. See the guide https://mui.com/material-ui/migration/migration-v4/ to upgrade to v5.", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "@material-ui/utils": "^4.11.3", @@ -2450,6 +2635,38 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/@material-ui/pickers": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/@material-ui/pickers/-/pickers-3.3.11.tgz", + "integrity": "sha512-pDYjbjUeabapijS2FpSwK/ruJdk7IGeAshpLbKDa3PRRKRy7Nv6sXxAvUg2F+lID/NwUKgBmCYS5bzrl7Xxqzw==", + "deprecated": "This package no longer supported. It has been relaced by @mui/x-date-pickers", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.6.0", + "@date-io/core": "1.x", + "@types/styled-jsx": "^2.2.8", + "clsx": "^1.0.2", + "react-transition-group": "^4.0.0", + "rifm": "^0.7.0" + }, + "peerDependencies": { + "@date-io/core": "^1.3.6", + "@material-ui/core": "^4.0.0", + "prop-types": "^15.6.0", + "react": "^16.8.0 || ^17.0.0", + "react-dom": "^16.8.0 || ^17.0.0" + } + }, + "node_modules/@material-ui/pickers/node_modules/clsx": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", + "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", "engines": { "node": ">=6" } @@ -2459,6 +2676,7 @@ "resolved": "https://registry.npmjs.org/@material-ui/styles/-/styles-4.11.5.tgz", "integrity": "sha512-o/41ot5JJiUsIETME9wVLAJrmIWL3j0R0Bj2kCOLbSfqEkKf0fmaPt+5vtblUh5eXr2S+J/8J3DaCb10+CzPGA==", "deprecated": "Material UI v4 doesn't receive active development since September 2021. See the guide https://mui.com/material-ui/migration/migration-v4/ to upgrade to v5.", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "@emotion/hash": "^0.8.0", @@ -2499,6 +2717,7 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", + "license": "MIT", "engines": { "node": ">=6" } @@ -2507,6 +2726,7 @@ "version": "4.12.2", "resolved": "https://registry.npmjs.org/@material-ui/system/-/system-4.12.2.tgz", "integrity": "sha512-6CSKu2MtmiJgcCGf6nBQpM8fLkuB9F55EKfbdTC80NND5wpTmKzwdhLYLH3zL4cLlK0gVaaltW7/wMuyTnN0Lw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "@material-ui/utils": "^4.11.3", @@ -2535,6 +2755,7 @@ "version": "5.1.0", "resolved": "https://registry.npmjs.org/@material-ui/types/-/types-5.1.0.tgz", "integrity": "sha512-7cqRjrY50b8QzRSYyhSpx4WRw2YuO0KKIGQEVk5J8uoz2BanawykgZGoWEqKm7pVIbzFDN0SpPcVV4IhOFkl8A==", + "license": "MIT", "peerDependencies": { "@types/react": "*" }, @@ -2548,6 +2769,7 @@ "version": "4.11.3", "resolved": "https://registry.npmjs.org/@material-ui/utils/-/utils-4.11.3.tgz", "integrity": "sha512-ZuQPV4rBK/V1j2dIkSSEcH5uT6AaHuKWFfotADHsC0wVL1NLd2WkFCm4ZZbX33iO4ydl6V0GPngKm8HZQ2oujg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.4.4", "prop-types": "^15.7.2", @@ -2566,6 +2788,7 @@ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" @@ -2579,6 +2802,7 @@ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", "dev": true, + "license": "MIT", "engines": { "node": ">= 8" } @@ -2588,6 +2812,7 @@ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" @@ -2596,50 +2821,86 @@ "node": ">= 8" } }, - "node_modules/@pkgjs/parseargs": { - "version": "0.11.0", - "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", - "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", - "dev": true, - "optional": true, + "node_modules/@pnpm/config.env-replace": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@pnpm/config.env-replace/-/config.env-replace-1.1.0.tgz", + "integrity": "sha512-htyl8TWnKL7K/ESFa1oW2UB5lVDxuF5DpM7tBi6Hu2LNL3mWkIzNLG6N4zoCUP1lCKNxWy/3iu8mS8MvToGd6w==", + "license": "MIT", "engines": { - "node": ">=14" + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/@pnpm/network.ca-file/-/network.ca-file-1.0.2.tgz", + "integrity": "sha512-YcPQ8a0jwYU9bTdJDpXjMi7Brhkr1mXsXrUJvjqM2mQDgkRiz8jFaQGOdaLxgjtUfQgZhKy/O3cG/YwmgKaxLA==", + "license": "MIT", + "dependencies": { + "graceful-fs": "4.2.10" + }, + "engines": { + "node": ">=12.22.0" + } + }, + "node_modules/@pnpm/network.ca-file/node_modules/graceful-fs": { + "version": "4.2.10", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.10.tgz", + "integrity": "sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==", + "license": "ISC" + }, + "node_modules/@pnpm/npm-conf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@pnpm/npm-conf/-/npm-conf-3.0.2.tgz", + "integrity": "sha512-h104Kh26rR8tm+a3Qkc5S4VLYint3FE48as7+/5oCEcKR2idC/pF1G6AhIXKI+eHPJa/3J9i5z0Al47IeGHPkA==", + "license": "MIT", + "dependencies": { + "@pnpm/config.env-replace": "^1.1.0", + "@pnpm/network.ca-file": "^1.0.1", + "config-chain": "^1.1.11" + }, + "engines": { + "node": ">=12" } }, "node_modules/@react-dnd/asap": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/@react-dnd/asap/-/asap-4.0.1.tgz", - "integrity": "sha512-kLy0PJDDwvwwTXxqTFNAAllPHD73AycE9ypWeln/IguoGBEbvFcPDbCV03G52bEcC5E+YgupBE0VzHGdC8SIXg==" + "integrity": "sha512-kLy0PJDDwvwwTXxqTFNAAllPHD73AycE9ypWeln/IguoGBEbvFcPDbCV03G52bEcC5E+YgupBE0VzHGdC8SIXg==", + "license": "MIT" }, "node_modules/@react-dnd/invariant": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/@react-dnd/invariant/-/invariant-2.0.0.tgz", - "integrity": "sha512-xL4RCQBCBDJ+GRwKTFhGUW8GXa4yoDfJrPbLblc3U09ciS+9ZJXJ3Qrcs/x2IODOdIE5kQxvMmE2UKyqUictUw==" + "integrity": "sha512-xL4RCQBCBDJ+GRwKTFhGUW8GXa4yoDfJrPbLblc3U09ciS+9ZJXJ3Qrcs/x2IODOdIE5kQxvMmE2UKyqUictUw==", + "license": "MIT" }, "node_modules/@react-dnd/shallowequal": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/@react-dnd/shallowequal/-/shallowequal-2.0.0.tgz", - "integrity": "sha512-Pc/AFTdwZwEKJxFJvlxrSmGe/di+aAOBn60sremrpLo6VI/6cmiUYNNwlI5KNYttg7uypzA3ILPMPgxB2GYZEg==" + "integrity": "sha512-Pc/AFTdwZwEKJxFJvlxrSmGe/di+aAOBn60sremrpLo6VI/6cmiUYNNwlI5KNYttg7uypzA3ILPMPgxB2GYZEg==", + "license": "MIT" }, "node_modules/@react-icons/all-files": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/@react-icons/all-files/-/all-files-4.1.0.tgz", "integrity": "sha512-hxBI2UOuVaI3O/BhQfhtb4kcGn9ft12RWAFVMUeNjqqhLsHvFtzIkFaptBJpFDANTKoDfdVoHTKZDlwKCACbMQ==", + "license": "MIT", "peerDependencies": { "react": "*" } }, "node_modules/@redux-saga/core": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@redux-saga/core/-/core-1.3.0.tgz", - "integrity": "sha512-L+i+qIGuyWn7CIg7k1MteHGfttKPmxwZR5E7OsGikCL2LzYA0RERlaUY00Y3P3ZV2EYgrsYlBrGs6cJP5OKKqA==", + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/@redux-saga/core/-/core-1.4.2.tgz", + "integrity": "sha512-nIMLGKo6jV6Wc1sqtVQs1iqbB3Kq20udB/u9XEaZQisT6YZ0NRB8+4L6WqD/E+YziYutd27NJbG8EWUPkb7c6Q==", + "license": "MIT", "dependencies": { - "@babel/runtime": "^7.6.3", - "@redux-saga/deferred": "^1.2.1", - "@redux-saga/delay-p": "^1.2.1", - "@redux-saga/is": "^1.1.3", - "@redux-saga/symbols": "^1.1.3", - "@redux-saga/types": "^1.2.1", + "@babel/runtime": "^7.28.4", + "@redux-saga/deferred": "^1.3.1", + "@redux-saga/delay-p": "^1.3.1", + "@redux-saga/is": "^1.2.1", + "@redux-saga/symbols": "^1.2.1", + "@redux-saga/types": "^1.3.1", "typescript-tuple": "^2.2.1" }, "funding": { @@ -2648,47 +2909,54 @@ } }, "node_modules/@redux-saga/deferred": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@redux-saga/deferred/-/deferred-1.2.1.tgz", - "integrity": "sha512-cmin3IuuzMdfQjA0lG4B+jX+9HdTgHZZ+6u3jRAOwGUxy77GSlTi4Qp2d6PM1PUoTmQUR5aijlA39scWWPF31g==" + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/@redux-saga/deferred/-/deferred-1.3.1.tgz", + "integrity": "sha512-0YZ4DUivWojXBqLB/TmuRRpDDz7tyq1I0AuDV7qi01XlLhM5m51W7+xYtIckH5U2cMlv9eAuicsfRAi1XHpXIg==", + "license": "MIT" }, "node_modules/@redux-saga/delay-p": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@redux-saga/delay-p/-/delay-p-1.2.1.tgz", - "integrity": "sha512-MdiDxZdvb1m+Y0s4/hgdcAXntpUytr9g0hpcOO1XFVyyzkrDu3SKPgBFOtHn7lhu7n24ZKIAT1qtKyQjHqRd+w==", + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/@redux-saga/delay-p/-/delay-p-1.3.1.tgz", + "integrity": "sha512-597I7L5MXbD/1i3EmcaOOjL/5suxJD7p5tnbV1PiWnE28c2cYiIHqmSMK2s7us2/UrhOL2KTNBiD0qBg6KnImg==", + "license": "MIT", "dependencies": { - "@redux-saga/symbols": "^1.1.3" + "@redux-saga/symbols": "^1.2.1" } }, "node_modules/@redux-saga/is": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@redux-saga/is/-/is-1.1.3.tgz", - "integrity": "sha512-naXrkETG1jLRfVfhOx/ZdLj0EyAzHYbgJWkXbB3qFliPcHKiWbv/ULQryOAEKyjrhiclmr6AMdgsXFyx7/yE6Q==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@redux-saga/is/-/is-1.2.1.tgz", + "integrity": "sha512-x3aWtX3GmQfEvn8dh0ovPbsXgK9JjpiR24wKztpGbZP8JZUWWvUgKrvnWZ/T/4iphOBftyVc9VrIwhAnsM+OFA==", + "license": "MIT", "dependencies": { - "@redux-saga/symbols": "^1.1.3", - "@redux-saga/types": "^1.2.1" + "@redux-saga/symbols": "^1.2.1", + "@redux-saga/types": "^1.3.1" } }, "node_modules/@redux-saga/symbols": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/@redux-saga/symbols/-/symbols-1.1.3.tgz", - "integrity": "sha512-hCx6ZvU4QAEUojETnX8EVg4ubNLBFl1Lps4j2tX7o45x/2qg37m3c6v+kSp8xjDJY+2tJw4QB3j8o8dsl1FDXg==" + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/@redux-saga/symbols/-/symbols-1.2.1.tgz", + "integrity": "sha512-3dh+uDvpBXi7EUp/eO+N7eFM4xKaU4yuGBXc50KnZGzIrR/vlvkTFQsX13zsY8PB6sCFYAgROfPSRUj8331QSA==", + "license": "MIT" }, "node_modules/@redux-saga/types": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/@redux-saga/types/-/types-1.2.1.tgz", - "integrity": "sha512-1dgmkh+3so0+LlBWRhGA33ua4MYr7tUOj+a9Si28vUi0IUFNbff1T3sgpeDJI/LaC75bBYnQ0A3wXjn0OrRNBA==" + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/@redux-saga/types/-/types-1.3.1.tgz", + "integrity": "sha512-YRCrJdhQLobGIQ8Cj1sta3nn6DrZDTSUnrIYhS2e5V590BmfVDleKoAquclAiKSBKWJwmuXTb+b4BL6rSHnahw==", + "license": "MIT" }, "node_modules/@rolldown/pluginutils": { - "version": "1.0.0-beta.9", - "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-beta.9.tgz", - "integrity": "sha512-e9MeMtVWo186sgvFFJOPGy7/d2j2mZhLJIdVW0C/xDluuOvymEATqz6zKsP0ZmXGzQtqlyjz5sC1sYQUoJG98w==", - "dev": true + "version": "1.0.0-rc.3", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-rc.3.tgz", + "integrity": "sha512-eybk3TjzzzV97Dlj5c+XrBFW57eTNhzod66y9HrBlzJ6NsCrWCp/2kaPS3K9wJmurBC0Tdw4yPjXKZqlznim3Q==", + "dev": true, + "license": "MIT" }, "node_modules/@rollup/plugin-node-resolve": { "version": "15.3.1", "resolved": "https://registry.npmjs.org/@rollup/plugin-node-resolve/-/plugin-node-resolve-15.3.1.tgz", "integrity": "sha512-tgg6b91pAybXHJQMAAwW9VuWBO6Thi+q7BCNARLwSqlmsHz0XYURtGvh/AuwSADXSI4h/2uHbs7s4FzlZDGSGA==", + "license": "MIT", "dependencies": { "@rollup/pluginutils": "^5.0.1", "@types/resolve": "1.20.2", @@ -2709,11 +2977,12 @@ } }, "node_modules/@rollup/plugin-node-resolve/node_modules/resolve": { - "version": "1.22.10", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", - "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", + "version": "1.22.11", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", + "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "license": "MIT", "dependencies": { - "is-core-module": "^2.16.0", + "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -2731,6 +3000,7 @@ "version": "0.4.4", "resolved": "https://registry.npmjs.org/@rollup/plugin-terser/-/plugin-terser-0.4.4.tgz", "integrity": "sha512-XHeJC5Bgvs8LfukDwWZp7yeqin6ns8RTl2B9avbejt6tZqsqvVoWI7ZTQrcNsfKEDWBTnTxM8nMDkO2IFFbd0A==", + "license": "MIT", "dependencies": { "serialize-javascript": "^6.0.1", "smob": "^1.0.0", @@ -2749,9 +3019,10 @@ } }, "node_modules/@rollup/pluginutils": { - "version": "5.1.4", - "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.1.4.tgz", - "integrity": "sha512-USm05zrsFxYLPdWWq+K3STlWiT/3ELn3RcV5hJMghpeAIhxfsUIg6mt12CBJBInWMV4VneoV7SfGv8xIwo2qNQ==", + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-5.3.0.tgz", + "integrity": "sha512-5EdhGZtnu3V88ces7s53hhfK5KSASnJZv8Lulpc04cWO3REESroJXg73DFsOmgbU2BhwV0E20bu2IDZb3VKW4Q==", + "license": "MIT", "dependencies": { "@types/estree": "^1.0.0", "estree-walker": "^2.0.2", @@ -2772,12 +3043,14 @@ "node_modules/@rollup/pluginutils/node_modules/estree-walker": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", - "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==" + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", + "license": "MIT" }, "node_modules/@rollup/pluginutils/node_modules/picomatch": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", - "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", + "license": "MIT", "engines": { "node": ">=12" }, @@ -2785,18 +3058,18 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/@sindresorhus/is": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/@sindresorhus/is/-/is-0.14.0.tgz", - "integrity": "sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ==", - "engines": { - "node": ">=6" - } + "node_modules/@standard-schema/spec": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/@standard-schema/spec/-/spec-1.1.0.tgz", + "integrity": "sha512-l2aFy5jALhniG5HgqrD6jXLi/rUWrKvqN/qJx6yoJsgKhblVd+iqqU4RCXavm/jPityDo5TCvKMnpjKnOriy0w==", + "dev": true, + "license": "MIT" }, "node_modules/@surma/rollup-plugin-off-main-thread": { "version": "2.2.3", "resolved": "https://registry.npmjs.org/@surma/rollup-plugin-off-main-thread/-/rollup-plugin-off-main-thread-2.2.3.tgz", "integrity": "sha512-lR8q/9W7hZpMWweNiAKU7NQerBnzQQLvi8qnTDU/fxItPhtZVMbPV3lbCwjhIlNBe9Bbr5V+KHshvWmVSG9cxQ==", + "license": "Apache-2.0", "dependencies": { "ejs": "^3.1.6", "json5": "^2.2.0", @@ -2808,35 +3081,26 @@ "version": "0.25.9", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", + "license": "MIT", "dependencies": { "sourcemap-codec": "^1.4.8" } }, - "node_modules/@szmarczak/http-timer": { - "version": "1.1.2", - "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-1.1.2.tgz", - "integrity": "sha512-XIB2XbzHTN6ieIjfIMV9hlVcfPU26s2vafYWQcZHWXHOxiaRZYEDKEwdl129Zyg50+foYV2jCgtrqSA6qNuNSA==", - "dependencies": { - "defer-to-connect": "^1.0.1" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/@testing-library/dom": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-10.4.0.tgz", - "integrity": "sha512-pemlzrSESWbdAloYml3bAJMEfNh1Z7EduzqPKprCH5S341frlpYnUEW0H72dLxa6IsYr+mPno20GiSm+h9dEdQ==", + "version": "10.4.1", + "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-10.4.1.tgz", + "integrity": "sha512-o4PXJQidqJl82ckFaXUeoAW+XysPLauYI43Abki5hABd853iMhitooc6znOnczgbTYmEP6U6/y1ZyKAIsvMKGg==", "dev": true, + "license": "MIT", "peer": true, "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", "@types/aria-query": "^5.0.1", "aria-query": "5.3.0", - "chalk": "^4.1.0", "dom-accessibility-api": "^0.5.9", "lz-string": "^1.5.0", + "picocolors": "1.1.1", "pretty-format": "^27.0.2" }, "engines": { @@ -2844,17 +3108,17 @@ } }, "node_modules/@testing-library/jest-dom": { - "version": "6.6.3", - "resolved": "https://registry.npmjs.org/@testing-library/jest-dom/-/jest-dom-6.6.3.tgz", - "integrity": "sha512-IteBhl4XqYNkM54f4ejhLRJiZNqcSCoXUOG2CPK7qbD322KjQozM4kHQOfkG2oln9b9HTYqs+Sae8vBATubxxA==", + "version": "6.9.1", + "resolved": "https://registry.npmjs.org/@testing-library/jest-dom/-/jest-dom-6.9.1.tgz", + "integrity": "sha512-zIcONa+hVtVSSep9UT3jZ5rizo2BsxgyDYU7WFD5eICBE7no3881HGeb/QkGfsJs6JTkY1aQhT7rIPC7e+0nnA==", "dev": true, + "license": "MIT", "dependencies": { "@adobe/css-tools": "^4.4.0", "aria-query": "^5.0.0", - "chalk": "^3.0.0", "css.escape": "^1.5.1", "dom-accessibility-api": "^0.6.3", - "lodash": "^4.17.21", + "picocolors": "^1.1.1", "redent": "^3.0.0" }, "engines": { @@ -2863,30 +3127,19 @@ "yarn": ">=1" } }, - "node_modules/@testing-library/jest-dom/node_modules/chalk": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", - "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", - "dev": true, - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/@testing-library/jest-dom/node_modules/dom-accessibility-api": { "version": "0.6.3", "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.6.3.tgz", "integrity": "sha512-7ZgogeTnjuHbo+ct10G9Ffp0mif17idi0IyWNVA/wcwcm7NPOD/WEHVP3n7n3MhXqxoIYm8d6MuZohYWIZ4T3w==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@testing-library/react": { "version": "12.1.5", "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-12.1.5.tgz", "integrity": "sha512-OfTXCJUFgjd/digLUuPxa0+/3ZxsQmE7ub9kcbW/wi96Bh3o/p5vrETcBGfP17NWPGqeYYl5LTRpwyGoMC4ysg==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5", "@testing-library/dom": "^8.0.0", @@ -2905,6 +3158,7 @@ "resolved": "https://registry.npmjs.org/@testing-library/react-hooks/-/react-hooks-7.0.2.tgz", "integrity": "sha512-dYxpz8u9m4q1TuzfcUApqi8iFfR6R0FaMbr2hjZJy1uC8z+bO/K4v8Gs9eogGKYQop7QsrBTFkv/BCF7MzD2Cg==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5", "@types/react": ">=16.9.0", @@ -2934,6 +3188,7 @@ "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-8.20.1.tgz", "integrity": "sha512-/DiOQ5xBxgdYRC8LNk7U+RWat0S3qRLeIw3ZIkMQ9kkVlRmwD/Eg8k8CqIpD6GW7u20JIUOfMKbxtiLutpjQ4g==", "dev": true, + "license": "MIT", "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", @@ -2953,6 +3208,7 @@ "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.1.3.tgz", "integrity": "sha512-R5iJ5lkuHybztUfuOAznmboyjWq8O6sqNqtK7CLOqdydi54VNbORp49mb14KbWgG1QD3JFO9hJdZ+y4KutfdOQ==", "dev": true, + "license": "Apache-2.0", "dependencies": { "deep-equal": "^2.0.5" } @@ -2962,6 +3218,7 @@ "resolved": "https://registry.npmjs.org/@testing-library/user-event/-/user-event-14.6.1.tgz", "integrity": "sha512-vq7fv0rnt+QTXgPxr5Hjc210p6YKq2kmdziLgnsZGgLJ9e6VAShx1pACLuRjd/AS/sr7phAR58OIIpf0LlmQNw==", "dev": true, + "license": "MIT", "engines": { "node": ">=12", "npm": ">=6" @@ -2974,13 +3231,15 @@ "version": "5.0.4", "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-5.0.4.tgz", "integrity": "sha512-rfT93uj5s0PRL7EzccGMs3brplhcrghnDoV26NqKhCAS1hVo+WdNsPvE/yb6ilfr5hi2MEk6d5EWJTKdxg8jVw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@types/babel__core": { "version": "7.20.5", "resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.20.5.tgz", "integrity": "sha512-qoQprZvz5wQFJwMDqeseRXWv3rqMvhgpbXFfVyWhbx9X47POIA6i/+dXefEmZKoAgOaTdaIgNSMqMIU61yRyzA==", "devOptional": true, + "license": "MIT", "dependencies": { "@babel/parser": "^7.20.7", "@babel/types": "^7.20.7", @@ -2994,6 +3253,7 @@ "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.27.0.tgz", "integrity": "sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg==", "devOptional": true, + "license": "MIT", "dependencies": { "@babel/types": "^7.0.0" } @@ -3003,45 +3263,71 @@ "resolved": "https://registry.npmjs.org/@types/babel__template/-/babel__template-7.4.4.tgz", "integrity": "sha512-h/NUaSyG5EyxBIp8YRxo4RMe2/qQgvyowRwVMzhYhBCONbW8PUsg4lkFMrhgZhUe5z3L3MiLDuvyJ/CaPa2A8A==", "devOptional": true, + "license": "MIT", "dependencies": { "@babel/parser": "^7.1.0", "@babel/types": "^7.0.0" } }, "node_modules/@types/babel__traverse": { - "version": "7.20.7", - "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.20.7.tgz", - "integrity": "sha512-dkO5fhS7+/oos4ciWxyEyjWe48zmG6wbCheo/G2ZnHx4fs3EU6YC6UM8rk56gAjNJ9P3MTH2jo5jb92/K6wbng==", + "version": "7.28.0", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.28.0.tgz", + "integrity": "sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q==", "devOptional": true, + "license": "MIT", "dependencies": { - "@babel/types": "^7.20.7" + "@babel/types": "^7.28.2" } }, + "node_modules/@types/chai": { + "version": "5.2.3", + "resolved": "https://registry.npmjs.org/@types/chai/-/chai-5.2.3.tgz", + "integrity": "sha512-Mw558oeA9fFbv65/y4mHtXDs9bPnFMZAL/jxdPFUpOHHIXX91mcgEHbS5Lahr+pwZFR8A7GQleRWeI6cGFC2UA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/deep-eql": "*", + "assertion-error": "^2.0.1" + } + }, + "node_modules/@types/deep-eql": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@types/deep-eql/-/deep-eql-4.0.2.tgz", + "integrity": "sha512-c9h9dVVMigMPc4bwTvC5dxqtqJZwQPePsWjPlpSOnojbor6pGqdk541lfA7AqFQr5pB1BRdq0juY9db81BwyFw==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/estree": { - "version": "1.0.7", - "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.7.tgz", - "integrity": "sha512-w28IoSUCJpidD/TGviZwwMJckNESJZXFu7NBZ5YJ4mEUnNraUn9Pm8HSZm/jDF1pDWYKspWE7oVphigUPRakIQ==" + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "license": "MIT" }, "node_modules/@types/hoist-non-react-statics": { - "version": "3.3.6", - "resolved": "https://registry.npmjs.org/@types/hoist-non-react-statics/-/hoist-non-react-statics-3.3.6.tgz", - "integrity": "sha512-lPByRJUer/iN/xa4qpyL0qmL11DqNW81iU/IG1S3uvRUq4oKagz8VCxZjiWkumgt66YT3vOdDgZ0o32sGKtCEw==", + "version": "3.3.7", + "resolved": "https://registry.npmjs.org/@types/hoist-non-react-statics/-/hoist-non-react-statics-3.3.7.tgz", + "integrity": "sha512-PQTyIulDkIDro8P+IHbKCsw7U2xxBYflVzW/FgWdCAePD9xGSidgA76/GeJ6lBKoblyhf9pBY763gbrN+1dI8g==", + "license": "MIT", "dependencies": { - "@types/react": "*", "hoist-non-react-statics": "^3.3.0" + }, + "peerDependencies": { + "@types/react": "*" } }, "node_modules/@types/istanbul-lib-coverage": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.6.tgz", "integrity": "sha512-2QF/t/auWm0lsy8XtKVPG19v3sSOQlJe/YHZgfjb/KBBHOGSV+J2q/S671rcq9uTBrLAXmZpqJiaQbMT+zNU1w==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@types/istanbul-lib-report": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/@types/istanbul-lib-report/-/istanbul-lib-report-3.0.3.tgz", "integrity": "sha512-NQn7AHQnk/RSLOxrBbGyJM/aVQ+pjj5HCgasFxc0K/KhoATfQ/47AyUl15I2yBUpihjmas+a+VJBOqecrFH+uA==", "dev": true, + "license": "MIT", "dependencies": { "@types/istanbul-lib-coverage": "*" } @@ -3051,6 +3337,7 @@ "resolved": "https://registry.npmjs.org/@types/istanbul-reports/-/istanbul-reports-3.0.4.tgz", "integrity": "sha512-pk2B1NWalF9toCRu6gjBzR69syFjP4Od8WRAX+0mmf9lAjCRicLOWc+ZrxZHx/0XRjotgkF9t6iaMJ+aXcOdZQ==", "dev": true, + "license": "MIT", "dependencies": { "@types/istanbul-lib-report": "*" } @@ -3059,40 +3346,45 @@ "version": "7.0.15", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", - "dev": true + "license": "MIT" }, "node_modules/@types/minimist": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.5.tgz", - "integrity": "sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==" + "integrity": "sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==", + "license": "MIT" }, "node_modules/@types/node": { - "version": "22.15.21", - "resolved": "https://registry.npmjs.org/@types/node/-/node-22.15.21.tgz", - "integrity": "sha512-EV/37Td6c+MgKAbkcLG6vqZ2zEYHD7bvSrzqqs2RIhbA6w3x+Dqz8MZM3sP6kGTeLrdoOgKZe+Xja7tUB2DNkQ==", + "version": "24.12.2", + "resolved": "https://registry.npmjs.org/@types/node/-/node-24.12.2.tgz", + "integrity": "sha512-A1sre26ke7HDIuY/M23nd9gfB+nrmhtYyMINbjI1zHJxYteKR6qSMX56FsmjMcDb3SMcjJg5BiRRgOCC/yBD0g==", "devOptional": true, + "license": "MIT", "dependencies": { - "undici-types": "~6.21.0" + "undici-types": "~7.16.0" } }, "node_modules/@types/normalize-package-data": { "version": "2.4.4", "resolved": "https://registry.npmjs.org/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz", - "integrity": "sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==" + "integrity": "sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==", + "license": "MIT" }, "node_modules/@types/prop-types": { - "version": "15.7.14", - "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.14.tgz", - "integrity": "sha512-gNMvNH49DJ7OJYv+KAKn0Xp45p8PLl6zo2YnvDIbTd4J6MER2BmWN49TG7n9LvkyihINxeKW8+3bfS2yDC9dzQ==" + "version": "15.7.15", + "resolved": "https://registry.npmjs.org/@types/prop-types/-/prop-types-15.7.15.tgz", + "integrity": "sha512-F6bEyamV9jKGAFBEmlQnesRPGOQqS2+Uwi0Em15xenOxHaf2hv6L8YCVn3rPdPJOiJfPiCnLIRyvwVaqMY3MIw==", + "license": "MIT" }, "node_modules/@types/react": { - "version": "17.0.86", - "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.86.tgz", - "integrity": "sha512-lPFuSjA85jecet6D4ZsPvCFuSrz6g2hkTSUw8MM0x5z2EndPV/itGnYQ39abjxd7F+cAcxLGtKQjnLn9cNUz3g==", + "version": "17.0.91", + "resolved": "https://registry.npmjs.org/@types/react/-/react-17.0.91.tgz", + "integrity": "sha512-xauZca6qMeCU3Moy0KxCM9jtf1vyk6qRYK39Ryf3afUqwgNUjRIGoDdS9BcGWgAMGSg1hvP4XcmlYrM66PtqeA==", + "license": "MIT", "dependencies": { "@types/prop-types": "*", "@types/scheduler": "^0.16", - "csstype": "^3.0.2" + "csstype": "^3.2.2" } }, "node_modules/@types/react-dom": { @@ -3100,6 +3392,7 @@ "resolved": "https://registry.npmjs.org/@types/react-dom/-/react-dom-17.0.26.tgz", "integrity": "sha512-Z+2VcYXJwOqQ79HreLU/1fyQ88eXSSFh6I3JdrEHQIfYSI0kCQpTGvOrbE6jFGGYXKsHuwY9tBa/w5Uo6KzrEg==", "dev": true, + "license": "MIT", "peerDependencies": { "@types/react": "^17.0.0" } @@ -3108,6 +3401,7 @@ "version": "7.1.34", "resolved": "https://registry.npmjs.org/@types/react-redux/-/react-redux-7.1.34.tgz", "integrity": "sha512-GdFaVjEbYv4Fthm2ZLvj1VSCedV7TqE5y1kNwnjSdBOTXuRSgowux6J8TAct15T3CKBr63UMk+2CO7ilRhyrAQ==", + "license": "MIT", "dependencies": { "@types/hoist-non-react-statics": "^3.3.0", "@types/react": "*", @@ -3120,6 +3414,7 @@ "resolved": "https://registry.npmjs.org/@types/react-test-renderer/-/react-test-renderer-19.1.0.tgz", "integrity": "sha512-XD0WZrHqjNrxA/MaR9O22w/RNidWR9YZmBdRGI7wcnWGrv/3dA8wKCJ8m63Sn+tLJhcjmuhOi629N66W6kgWzQ==", "dev": true, + "license": "MIT", "dependencies": { "@types/react": "*" } @@ -3128,41 +3423,80 @@ "version": "4.4.12", "resolved": "https://registry.npmjs.org/@types/react-transition-group/-/react-transition-group-4.4.12.tgz", "integrity": "sha512-8TV6R3h2j7a91c+1DXdJi3Syo69zzIZbz7Lg5tORM5LEJG7X/E6a1V3drRyBRZq7/utz7A+c4OgYLiLcYGHG6w==", + "license": "MIT", "peerDependencies": { "@types/react": "*" } }, "node_modules/@types/react/node_modules/csstype": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", - "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==" + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "license": "MIT" }, "node_modules/@types/resolve": { "version": "1.20.2", "resolved": "https://registry.npmjs.org/@types/resolve/-/resolve-1.20.2.tgz", - "integrity": "sha512-60BCwRFOZCQhDncwQdxxeOEEkbc5dIMccYLwbxsS4TUNeVECQ/pBJ0j09mrHOl/JJvpRPGwO9SvE4nR2Nb/a4Q==" + "integrity": "sha512-60BCwRFOZCQhDncwQdxxeOEEkbc5dIMccYLwbxsS4TUNeVECQ/pBJ0j09mrHOl/JJvpRPGwO9SvE4nR2Nb/a4Q==", + "license": "MIT" }, "node_modules/@types/scheduler": { "version": "0.16.8", "resolved": "https://registry.npmjs.org/@types/scheduler/-/scheduler-0.16.8.tgz", - "integrity": "sha512-WZLiwShhwLRmeV6zH+GkbOFT6Z6VklCItrDioxUnv+u4Ll+8vKeFySoFyK/0ctcRpOmwAicELfmys1sDc/Rw+A==" + "integrity": "sha512-WZLiwShhwLRmeV6zH+GkbOFT6Z6VklCItrDioxUnv+u4Ll+8vKeFySoFyK/0ctcRpOmwAicELfmys1sDc/Rw+A==", + "license": "MIT" }, "node_modules/@types/semver": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.0.tgz", - "integrity": "sha512-k107IF4+Xr7UHjwDc7Cfd6PRQfbdkiRabXGRjo07b4WyPahFBZCZ1sE+BNxYIJPPg73UkfOsVOLwqVc/6ETrIA==", - "dev": true + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/@types/semver/-/semver-7.7.1.tgz", + "integrity": "sha512-FmgJfu+MOcQ370SD0ev7EI8TlCAfKYU+B4m5T3yXc1CiRN94g/SZPtsCkk506aUDtlMnFZvasDwHHUcZUEaYuA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/styled-jsx": { + "version": "2.2.9", + "resolved": "https://registry.npmjs.org/@types/styled-jsx/-/styled-jsx-2.2.9.tgz", + "integrity": "sha512-W/iTlIkGEyTBGTEvZCey8EgQlQ5l0DwMqi3iOXlLs2kyBwYTXHKEiU6IZ5EwoRwngL8/dGYuzezSup89ttVHLw==", + "license": "MIT", + "dependencies": { + "@types/react": "*" + } }, "node_modules/@types/trusted-types": { "version": "2.0.7", "resolved": "https://registry.npmjs.org/@types/trusted-types/-/trusted-types-2.0.7.tgz", - "integrity": "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==" + "integrity": "sha512-ScaPdn1dQczgbl0QFTeTOmVHFULt394XJgOQNoyVhZ6r2vLnMLJfBPd53SB52T/3G36VI1/g2MZaX0cwDuXsfw==", + "license": "MIT" + }, + "node_modules/@types/uuid": { + "version": "3.4.13", + "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-3.4.13.tgz", + "integrity": "sha512-pAeZeUbLE4Z9Vi9wsWV2bYPTweEHeJJy0G4pEjOA/FSvy1Ad5U5Km8iDV6TKre1mjBiVNfAdVHKruP8bAh4Q5A==", + "license": "MIT" + }, + "node_modules/@types/whatwg-mimetype": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/@types/whatwg-mimetype/-/whatwg-mimetype-3.0.2.tgz", + "integrity": "sha512-c2AKvDT8ToxLIOUlN51gTiHXflsfIFisS4pO7pDPoKouJCESkhZnEy623gwP9laCy5lnLDAw1vAzu2vM2YLOrA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/ws": { + "version": "8.18.1", + "resolved": "https://registry.npmjs.org/@types/ws/-/ws-8.18.1.tgz", + "integrity": "sha512-ThVF6DCVhA8kUGy+aazFQ4kXQ7E1Ty7A3ypFOe0IcJV8O/M511G99AW24irKrW56Wt44yG9+ij8FaqoBGkuBXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*" + } }, "node_modules/@types/yargs": { - "version": "15.0.19", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.19.tgz", - "integrity": "sha512-2XUaGVmyQjgyAZldf0D0c14vvo/yv0MhQBSTJcejMMaitsn3nxCB6TmH4G0ZQf+uxROOa9mpanoSm8h6SG/1ZA==", + "version": "15.0.20", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.20.tgz", + "integrity": "sha512-KIkX+/GgfFitlASYCGoSF+T4XRXhOubJLhkLVtSfsRTe9jWMmuM2g28zQ41BtPTG7TRBb2xHW+LCNVE9QR/vsg==", "dev": true, + "license": "MIT", "dependencies": { "@types/yargs-parser": "*" } @@ -3171,13 +3505,15 @@ "version": "21.0.3", "resolved": "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.3.tgz", "integrity": "sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "6.21.0", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.21.0.tgz", "integrity": "sha512-oy9+hTPCUFpngkEZUSzbf9MxI65wbKFoQYsgPdILTfbUldp5ovUuphZVe4i30emU9M/kP+T64Di0mxl7dSw3MA==", "dev": true, + "license": "MIT", "dependencies": { "@eslint-community/regexpp": "^4.5.1", "@typescript-eslint/scope-manager": "6.21.0", @@ -3213,6 +3549,7 @@ "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-6.21.0.tgz", "integrity": "sha512-tbsV1jPne5CkFQCgPBcDOt30ItF7aJoZL997JSF7MhGQqOeT3svWRYxiqlfA5RUdlHN6Fi+EI9bxqbdyAUZjYQ==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "@typescript-eslint/scope-manager": "6.21.0", "@typescript-eslint/types": "6.21.0", @@ -3241,6 +3578,7 @@ "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-6.21.0.tgz", "integrity": "sha512-OwLUIWZJry80O99zvqXVEioyniJMa+d2GrqpUTqi5/v5D5rOrppJVBPa0yKCblcigC0/aYAzxxqQ1B+DS2RYsg==", "dev": true, + "license": "MIT", "dependencies": { "@typescript-eslint/types": "6.21.0", "@typescript-eslint/visitor-keys": "6.21.0" @@ -3258,6 +3596,7 @@ "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-6.21.0.tgz", "integrity": "sha512-rZQI7wHfao8qMX3Rd3xqeYSMCL3SoiSQLBATSiVKARdFGCYSRvmViieZjqc58jKgs8Y8i9YvVVhRbHSTA4VBag==", "dev": true, + "license": "MIT", "dependencies": { "@typescript-eslint/typescript-estree": "6.21.0", "@typescript-eslint/utils": "6.21.0", @@ -3285,6 +3624,7 @@ "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-6.21.0.tgz", "integrity": "sha512-1kFmZ1rOm5epu9NZEZm1kckCDGj5UJEf7P1kliH4LKu/RkwpsfqqGmY2OOcUs18lSlQBKLDYBOGxRVtrMN5lpg==", "dev": true, + "license": "MIT", "engines": { "node": "^16.0.0 || >=18.0.0" }, @@ -3298,6 +3638,7 @@ "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-6.21.0.tgz", "integrity": "sha512-6npJTkZcO+y2/kr+z0hc4HwNfrrP4kNYh57ek7yCNlrBjWQ1Y0OS7jiZTkgumrvkX5HkEKXFZkkdFNkaW2wmUQ==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "@typescript-eslint/types": "6.21.0", "@typescript-eslint/visitor-keys": "6.21.0", @@ -3326,6 +3667,7 @@ "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-6.21.0.tgz", "integrity": "sha512-NfWVaC8HP9T8cbKQxHcsJBY5YE1O33+jpMwN45qzWWaPDZgLIbo12toGMWnmhvCpd3sIxkpDw3Wv1B3dYrbDQQ==", "dev": true, + "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", "@types/json-schema": "^7.0.12", @@ -3351,6 +3693,7 @@ "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-6.21.0.tgz", "integrity": "sha512-JJtkDduxLi9bivAB+cYOVMtbkqdPOhZ+ZI5LC47MIRrDV4Yn2o+ZnW10Nkmr28xRpSpdJ6Sm42Hjf2+REYXm0A==", "dev": true, + "license": "MIT", "dependencies": { "@typescript-eslint/types": "6.21.0", "eslint-visitor-keys": "^3.4.1" @@ -3367,53 +3710,54 @@ "version": "1.3.0", "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/@vitejs/plugin-react": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/@vitejs/plugin-react/-/plugin-react-4.5.0.tgz", - "integrity": "sha512-JuLWaEqypaJmOJPLWwO335Ig6jSgC1FTONCWAxnqcQthLTK/Yc9aH6hr9z/87xciejbQcnP3GnA1FWUSWeXaeg==", + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-react/-/plugin-react-5.2.0.tgz", + "integrity": "sha512-YmKkfhOAi3wsB1PhJq5Scj3GXMn3WvtQ/JC0xoopuHoXSdmtdStOpFrYaT1kie2YgFBcIe64ROzMYRjCrYOdYw==", "dev": true, + "license": "MIT", "dependencies": { - "@babel/core": "^7.26.10", - "@babel/plugin-transform-react-jsx-self": "^7.25.9", - "@babel/plugin-transform-react-jsx-source": "^7.25.9", - "@rolldown/pluginutils": "1.0.0-beta.9", + "@babel/core": "^7.29.0", + "@babel/plugin-transform-react-jsx-self": "^7.27.1", + "@babel/plugin-transform-react-jsx-source": "^7.27.1", + "@rolldown/pluginutils": "1.0.0-rc.3", "@types/babel__core": "^7.20.5", - "react-refresh": "^0.17.0" + "react-refresh": "^0.18.0" }, "engines": { - "node": "^14.18.0 || >=16.0.0" + "node": "^20.19.0 || >=22.12.0" }, "peerDependencies": { - "vite": "^4.2.0 || ^5.0.0 || ^6.0.0" + "vite": "^4.2.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0" } }, "node_modules/@vitest/coverage-v8": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-3.1.4.tgz", - "integrity": "sha512-G4p6OtioySL+hPV7Y6JHlhpsODbJzt1ndwHAFkyk6vVjpK03PFsKnauZIzcd0PrK4zAbc5lc+jeZ+eNGiMA+iw==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/coverage-v8/-/coverage-v8-4.1.2.tgz", + "integrity": "sha512-sPK//PHO+kAkScb8XITeB1bf7fsk85Km7+rt4eeuRR3VS1/crD47cmV5wicisJmjNdfeokTZwjMk4Mj2d58Mgg==", "dev": true, + "license": "MIT", "dependencies": { - "@ampproject/remapping": "^2.3.0", "@bcoe/v8-coverage": "^1.0.2", - "debug": "^4.4.0", + "@vitest/utils": "4.1.2", + "ast-v8-to-istanbul": "^1.0.0", "istanbul-lib-coverage": "^3.2.2", "istanbul-lib-report": "^3.0.1", - "istanbul-lib-source-maps": "^5.0.6", - "istanbul-reports": "^3.1.7", - "magic-string": "^0.30.17", - "magicast": "^0.3.5", - "std-env": "^3.9.0", - "test-exclude": "^7.0.1", - "tinyrainbow": "^2.0.0" + "istanbul-reports": "^3.2.0", + "magicast": "^0.5.2", + "obug": "^2.1.1", + "std-env": "^4.0.0-rc.1", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { - "@vitest/browser": "3.1.4", - "vitest": "3.1.4" + "@vitest/browser": "4.1.2", + "vitest": "4.1.2" }, "peerDependenciesMeta": { "@vitest/browser": { @@ -3422,36 +3766,40 @@ } }, "node_modules/@vitest/expect": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-3.1.4.tgz", - "integrity": "sha512-xkD/ljeliyaClDYqHPNCiJ0plY5YIcM0OlRiZizLhlPmpXWpxnGMyTZXOHFhFeG7w9P5PBeL4IdtJ/HeQwTbQA==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/expect/-/expect-4.1.2.tgz", + "integrity": "sha512-gbu+7B0YgUJ2nkdsRJrFFW6X7NTP44WlhiclHniUhxADQJH5Szt9mZ9hWnJPJ8YwOK5zUOSSlSvyzRf0u1DSBQ==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/spy": "3.1.4", - "@vitest/utils": "3.1.4", - "chai": "^5.2.0", - "tinyrainbow": "^2.0.0" + "@standard-schema/spec": "^1.1.0", + "@types/chai": "^5.2.2", + "@vitest/spy": "4.1.2", + "@vitest/utils": "4.1.2", + "chai": "^6.2.2", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/mocker": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-3.1.4.tgz", - "integrity": "sha512-8IJ3CvwtSw/EFXqWFL8aCMu+YyYXG2WUSrQbViOZkWTKTVicVwZ/YiEZDSqD00kX+v/+W+OnxhNWoeVKorHygA==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/mocker/-/mocker-4.1.2.tgz", + "integrity": "sha512-Ize4iQtEALHDttPRCmN+FKqOl2vxTiNUhzobQFFt/BM1lRUTG7zRCLOykG/6Vo4E4hnUdfVLo5/eqKPukcWW7Q==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/spy": "3.1.4", + "@vitest/spy": "4.1.2", "estree-walker": "^3.0.3", - "magic-string": "^0.30.17" + "magic-string": "^0.30.21" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "msw": "^2.4.9", - "vite": "^5.0.0 || ^6.0.0" + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "msw": { @@ -3463,24 +3811,26 @@ } }, "node_modules/@vitest/pretty-format": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-3.1.4.tgz", - "integrity": "sha512-cqv9H9GvAEoTaoq+cYqUTCGscUjKqlJZC7PRwY5FMySVj5J+xOm1KQcCiYHJOEzOKRUhLH4R2pTwvFlWCEScsg==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/pretty-format/-/pretty-format-4.1.2.tgz", + "integrity": "sha512-dwQga8aejqeuB+TvXCMzSQemvV9hNEtDDpgUKDzOmNQayl2OG241PSWeJwKRH3CiC+sESrmoFd49rfnq7T4RnA==", "dev": true, + "license": "MIT", "dependencies": { - "tinyrainbow": "^2.0.0" + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/runner": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-3.1.4.tgz", - "integrity": "sha512-djTeF1/vt985I/wpKVFBMWUlk/I7mb5hmD5oP8K9ACRmVXgKTae3TUOtXAEBfslNKPzUQvnKhNd34nnRSYgLNQ==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/runner/-/runner-4.1.2.tgz", + "integrity": "sha512-Gr+FQan34CdiYAwpGJmQG8PgkyFVmARK8/xSijia3eTFgVfpcpztWLuP6FttGNfPLJhaZVP/euvujeNYar36OQ==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/utils": "3.1.4", + "@vitest/utils": "4.1.2", "pathe": "^2.0.3" }, "funding": { @@ -3488,13 +3838,15 @@ } }, "node_modules/@vitest/snapshot": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-3.1.4.tgz", - "integrity": "sha512-JPHf68DvuO7vilmvwdPr9TS0SuuIzHvxeaCkxYcCD4jTk67XwL45ZhEHFKIuCm8CYstgI6LZ4XbwD6ANrwMpFg==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/snapshot/-/snapshot-4.1.2.tgz", + "integrity": "sha512-g7yfUmxYS4mNxk31qbOYsSt2F4m1E02LFqO53Xpzg3zKMhLAPZAjjfyl9e6z7HrW6LvUdTwAQR3HHfLjpko16A==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.1.4", - "magic-string": "^0.30.17", + "@vitest/pretty-format": "4.1.2", + "@vitest/utils": "4.1.2", + "magic-string": "^0.30.21", "pathe": "^2.0.3" }, "funding": { @@ -3502,35 +3854,35 @@ } }, "node_modules/@vitest/spy": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-3.1.4.tgz", - "integrity": "sha512-Xg1bXhu+vtPXIodYN369M86K8shGLouNjoVI78g8iAq2rFoHFdajNvJJ5A/9bPMFcfQqdaCpOgWKEoMQg/s0Yg==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/spy/-/spy-4.1.2.tgz", + "integrity": "sha512-DU4fBnbVCJGNBwVA6xSToNXrkZNSiw59H8tcuUspVMsBDBST4nfvsPsEHDHGtWRRnqBERBQu7TrTKskmjqTXKA==", "dev": true, - "dependencies": { - "tinyspy": "^3.0.2" - }, + "license": "MIT", "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/@vitest/utils": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-3.1.4.tgz", - "integrity": "sha512-yriMuO1cfFhmiGc8ataN51+9ooHRuURdfAZfwFd3usWynjzpLslZdYnRegTv32qdgtJTsj15FoeZe2g15fY1gg==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/@vitest/utils/-/utils-4.1.2.tgz", + "integrity": "sha512-xw2/TiX82lQHA06cgbqRKFb5lCAy3axQ4H4SoUFhUsg+wztiet+co86IAMDtF6Vm1hc7J6j09oh/rgDn+JdKIQ==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/pretty-format": "3.1.4", - "loupe": "^3.1.3", - "tinyrainbow": "^2.0.0" + "@vitest/pretty-format": "4.1.2", + "convert-source-map": "^2.0.0", + "tinyrainbow": "^3.1.0" }, "funding": { "url": "https://opencollective.com/vitest" } }, "node_modules/acorn": { - "version": "8.14.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz", - "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==", + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", + "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", + "license": "MIT", "bin": { "acorn": "bin/acorn" }, @@ -3543,24 +3895,26 @@ "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", "dev": true, + "license": "MIT", "peerDependencies": { "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, "node_modules/agent-base": { - "version": "7.1.3", - "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz", - "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==", + "version": "7.1.4", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.4.tgz", + "integrity": "sha512-MnA+YT8fwfJPgBx3m60MNqakm30XOkyIoH1y6huTQvC0PwZG7ki8NacLBcrPbNoo8vEZy7Jpuk7+jMO+CUovTQ==", "dev": true, + "license": "MIT", "engines": { "node": ">= 14" } }, "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", + "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", @@ -3576,6 +3930,7 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz", "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==", + "license": "ISC", "dependencies": { "string-width": "^4.1.0" } @@ -3584,6 +3939,7 @@ "version": "4.3.2", "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz", "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==", + "license": "MIT", "dependencies": { "type-fest": "^0.21.3" }, @@ -3598,6 +3954,7 @@ "version": "0.21.3", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" }, @@ -3609,6 +3966,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "license": "MIT", "engines": { "node": ">=8" } @@ -3617,6 +3975,7 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "license": "MIT", "dependencies": { "color-convert": "^2.0.1" }, @@ -3631,6 +3990,7 @@ "version": "3.1.3", "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.3.tgz", "integrity": "sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==", + "license": "ISC", "dependencies": { "normalize-path": "^3.0.0", "picomatch": "^2.0.4" @@ -3643,13 +4003,15 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", - "dev": true + "dev": true, + "license": "Python-2.0" }, "node_modules/aria-query": { "version": "5.3.0", "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.0.tgz", "integrity": "sha512-b0P0sZPKtyu8HkeRAfCq0IfURZK+SuwMjY1UXGBU27wpAiTwQAIlq56IbIO+ytk/JjS1fMR14ee5WBBfKi5J6A==", "dev": true, + "license": "Apache-2.0", "dependencies": { "dequal": "^2.0.3" } @@ -3658,6 +4020,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", "integrity": "sha512-LHE+8BuR7RYGDKvnrmcuSq3tDcKv9OFEXQt/HpbZhY7V6h0zlUXutnAD82GiFx9rdieCMjkvtcsPqBwgUl1Iiw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "is-array-buffer": "^3.0.5" @@ -3670,17 +4033,20 @@ } }, "node_modules/array-includes": { - "version": "3.1.8", - "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.8.tgz", - "integrity": "sha512-itaWrbYbqpGXkGhZPGUulwnhVf5Hpy1xiCFsGqyIGglbBxmG5vSjxQen3/WGOjPpNEv1RtBLKxbmVXm8HpJStQ==", + "version": "3.1.9", + "resolved": "https://registry.npmjs.org/array-includes/-/array-includes-3.1.9.tgz", + "integrity": "sha512-FmeCCAenzH0KH381SPT5FZmiA/TmpndpcaShhfgEN9eCVjnFBqq3l1xrI42y8+PPLI6hypzou4GXw00WHmPBLQ==", "dev": true, + "license": "MIT", "dependencies": { - "call-bind": "^1.0.7", + "call-bind": "^1.0.8", + "call-bound": "^1.0.4", "define-properties": "^1.2.1", - "es-abstract": "^1.23.2", - "es-object-atoms": "^1.0.0", - "get-intrinsic": "^1.2.4", - "is-string": "^1.0.7" + "es-abstract": "^1.24.0", + "es-object-atoms": "^1.1.1", + "get-intrinsic": "^1.3.0", + "is-string": "^1.1.1", + "math-intrinsics": "^1.1.0" }, "engines": { "node": ">= 0.4" @@ -3694,6 +4060,7 @@ "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -3703,6 +4070,7 @@ "resolved": "https://registry.npmjs.org/array.prototype.findlast/-/array.prototype.findlast-1.2.5.tgz", "integrity": "sha512-CVvd6FHg1Z3POpBLxO6E6zr+rSKEQ9L6rZHAaY7lLfhKsWYUBBOuMs0e9o24oopj6H+geRCX0YJ+TJLBK2eHyQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -3723,6 +4091,7 @@ "resolved": "https://registry.npmjs.org/array.prototype.flat/-/array.prototype.flat-1.3.3.tgz", "integrity": "sha512-rwG/ja1neyLqCuGZ5YYrznA62D4mZXg0i1cIskIUKSiqF3Cje9/wXAls9B9s1Wa2fomMsIv8czB8jZcPmxCXFg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -3741,6 +4110,7 @@ "resolved": "https://registry.npmjs.org/array.prototype.flatmap/-/array.prototype.flatmap-1.3.3.tgz", "integrity": "sha512-Y7Wt51eKJSyi80hFrJCePGGNo5ktJCslFuboqJsbf57CCPcm5zztluPlc4/aD8sWsKvlwatezpV4U1efk8kpjg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -3759,6 +4129,7 @@ "resolved": "https://registry.npmjs.org/array.prototype.tosorted/-/array.prototype.tosorted-1.1.4.tgz", "integrity": "sha512-p6Fx8B7b7ZhL/gmUsAy0D15WhvDccw3mnGNbZpi3pmeJdxtWsj2jEaI4Y6oo3XiHfzuSgPwKc04MYt6KgvC/wA==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -3774,6 +4145,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/arraybuffer.prototype.slice/-/arraybuffer.prototype.slice-1.0.4.tgz", "integrity": "sha512-BNoCY6SXXPQ7gF2opIP4GBE+Xw7U+pHMYKuzjgCN3GwiaIR09UUeKfheyIry77QtrCBlC0KK0q5/TER/tYh3PQ==", + "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.1", "call-bind": "^1.0.8", @@ -3794,6 +4166,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/arrify/-/arrify-1.0.1.tgz", "integrity": "sha512-3CYzex9M9FGQjCGMGyi6/31c8GJbgb0qGyrx5HWxPd0aCwh4cB2YjMb2Xf9UuoogrMrlO9cTqnB5rI5GHZTcUA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -3803,6 +4176,7 @@ "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-2.0.1.tgz", "integrity": "sha512-Izi8RQcffqCeNVgFigKli1ssklIbpHnCYc6AknXGYoB6grJqyeby7jv12JUQgmTAnIDnbck1uxksT4dzN3PWBA==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" } @@ -3811,17 +4185,39 @@ "version": "0.0.8", "resolved": "https://registry.npmjs.org/ast-types-flow/-/ast-types-flow-0.0.8.tgz", "integrity": "sha512-OH/2E5Fg20h2aPrbe+QL8JZQFko0YZaF+j4mnQ7BGhfavO7OpSLa8a0y9sBwomHdSbkhTS8TQNayBfnW5DwbvQ==", - "dev": true + "dev": true, + "license": "MIT" + }, + "node_modules/ast-v8-to-istanbul": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/ast-v8-to-istanbul/-/ast-v8-to-istanbul-1.0.0.tgz", + "integrity": "sha512-1fSfIwuDICFA4LKkCzRPO7F0hzFf0B7+Xqrl27ynQaa+Rh0e1Es0v6kWHPott3lU10AyAr7oKHa65OppjLn3Rg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.31", + "estree-walker": "^3.0.3", + "js-tokens": "^10.0.0" + } + }, + "node_modules/ast-v8-to-istanbul/node_modules/js-tokens": { + "version": "10.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-10.0.0.tgz", + "integrity": "sha512-lM/UBzQmfJRo9ABXbPWemivdCW8V2G8FHaHdypQaIy523snUjog0W71ayWXTjiR+ixeMyVHN2XcpnTd/liPg/Q==", + "dev": true, + "license": "MIT" }, "node_modules/async": { "version": "3.2.6", "resolved": "https://registry.npmjs.org/async/-/async-3.2.6.tgz", - "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==" + "integrity": "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA==", + "license": "MIT" }, "node_modules/async-function": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/async-function/-/async-function-1.0.0.tgz", "integrity": "sha512-hsU18Ae8CDTR6Kgu9DYf0EbCr/a5iGL0rytQDobUcdpYOKokk8LEjVphnXkDkgpi0wYVsqrXuP0bZxJaTqdgoA==", + "license": "MIT", "engines": { "node": ">= 0.4" } @@ -3830,14 +4226,26 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz", "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==", + "license": "ISC", "engines": { "node": ">= 4.0.0" } }, + "node_modules/atomically": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/atomically/-/atomically-2.1.1.tgz", + "integrity": "sha512-P4w9o2dqARji6P7MHprklbfiArZAWvo07yW7qs3pdljb3BWr12FIB7W+p0zJiuiVsUpRO0iZn1kFFcpPegg0tQ==", + "license": "MIT", + "dependencies": { + "stubborn-fs": "^2.0.0", + "when-exit": "^2.1.4" + } + }, "node_modules/attr-accept": { "version": "2.2.5", "resolved": "https://registry.npmjs.org/attr-accept/-/attr-accept-2.2.5.tgz", "integrity": "sha512-0bDNnY/u6pPwHDMoF0FieU354oBi0a8rD9FcsLwzcGWbc8KS8KPIi7y+s13OlVY+gMWc/9xEMUgNE6Qm8ZllYQ==", + "license": "MIT", "engines": { "node": ">=4" } @@ -3846,6 +4254,7 @@ "version": "3.3.4", "resolved": "https://registry.npmjs.org/autosuggest-highlight/-/autosuggest-highlight-3.3.4.tgz", "integrity": "sha512-j6RETBD2xYnrVcoV1S5R4t3WxOlWZKyDQjkwnggDPSjF5L4jV98ZltBpvPvbkM1HtoSe5o+bNrTHyjPbieGeYA==", + "license": "MIT", "dependencies": { "remove-accents": "^0.4.2" } @@ -3854,6 +4263,7 @@ "version": "1.0.7", "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", + "license": "MIT", "dependencies": { "possible-typed-array-names": "^1.0.0" }, @@ -3865,10 +4275,11 @@ } }, "node_modules/axe-core": { - "version": "4.10.3", - "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.10.3.tgz", - "integrity": "sha512-Xm7bpRXnDSX2YE2YFfBk2FnF0ep6tmG7xPh8iHee8MIcrgq762Nkce856dYtJYLkuIoYZvGfTs/PbZhideTcEg==", + "version": "4.11.2", + "resolved": "https://registry.npmjs.org/axe-core/-/axe-core-4.11.2.tgz", + "integrity": "sha512-byD6KPdvo72y/wj2T/4zGEvvlis+PsZsn/yPS3pEO+sFpcrqRpX/TJCxvVaEsNeMrfQbCr7w163YqoD9IYwHXw==", "dev": true, + "license": "MPL-2.0", "engines": { "node": ">=4" } @@ -3878,17 +4289,19 @@ "resolved": "https://registry.npmjs.org/axobject-query/-/axobject-query-4.1.0.tgz", "integrity": "sha512-qIj0G9wZbMGNLjLmg1PT6v2mE9AH2zlnADJD/2tC6E00hgmhUOfEB6greHPAfLRSufHqROIUTkw6E+M3lH0PTQ==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">= 0.4" } }, "node_modules/babel-plugin-polyfill-corejs2": { - "version": "0.4.13", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.13.tgz", - "integrity": "sha512-3sX/eOms8kd3q2KZ6DAhKPc0dgm525Gqq5NtWKZ7QYYZEv57OQ54KtblzJzH1lQF/eQxO8KjWGIK9IPUJNus5g==", + "version": "0.4.17", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs2/-/babel-plugin-polyfill-corejs2-0.4.17.tgz", + "integrity": "sha512-aTyf30K/rqAsNwN76zYrdtx8obu0E4KoUME29B1xj+B3WxgvWkp943vYQ+z8Mv3lw9xHXMHpvSPOBxzAkIa94w==", + "license": "MIT", "dependencies": { - "@babel/compat-data": "^7.22.6", - "@babel/helper-define-polyfill-provider": "^0.6.4", + "@babel/compat-data": "^7.28.6", + "@babel/helper-define-polyfill-provider": "^0.6.8", "semver": "^6.3.1" }, "peerDependencies": { @@ -3899,28 +4312,31 @@ "version": "6.3.1", "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" } }, "node_modules/babel-plugin-polyfill-corejs3": { - "version": "0.11.1", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.11.1.tgz", - "integrity": "sha512-yGCqvBT4rwMczo28xkH/noxJ6MZ4nJfkVYdoDaC/utLtWrXxv27HVrzAeSbqR8SxDsp46n0YF47EbHoixy6rXQ==", + "version": "0.14.2", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-corejs3/-/babel-plugin-polyfill-corejs3-0.14.2.tgz", + "integrity": "sha512-coWpDLJ410R781Npmn/SIBZEsAetR4xVi0SxLMXPaMO4lSf1MwnkGYMtkFxew0Dn8B3/CpbpYxN0JCgg8mn67g==", + "license": "MIT", "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.3", - "core-js-compat": "^3.40.0" + "@babel/helper-define-polyfill-provider": "^0.6.8", + "core-js-compat": "^3.48.0" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" } }, "node_modules/babel-plugin-polyfill-regenerator": { - "version": "0.6.4", - "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.4.tgz", - "integrity": "sha512-7gD3pRadPrbjhjLyxebmx/WrFYcuSjZ0XbdUujQMZ/fcE9oeewk2U/7PCvez84UeuK3oSjmPZ0Ch0dlupQvGzw==", + "version": "0.6.8", + "resolved": "https://registry.npmjs.org/babel-plugin-polyfill-regenerator/-/babel-plugin-polyfill-regenerator-0.6.8.tgz", + "integrity": "sha512-M762rNHfSF1EV3SLtnCJXFoQbbIIz0OyRwnCmV0KPC7qosSfCO0QLTSuJX3ayAebubhE6oYBAYPrBA5ljowaZg==", + "license": "MIT", "dependencies": { - "@babel/helper-define-polyfill-provider": "^0.6.4" + "@babel/helper-define-polyfill-provider": "^0.6.8" }, "peerDependencies": { "@babel/core": "^7.4.0 || ^8.0.0-0 <8.0.0" @@ -3930,6 +4346,7 @@ "version": "6.26.0", "resolved": "https://registry.npmjs.org/babel-runtime/-/babel-runtime-6.26.0.tgz", "integrity": "sha512-ITKNuq2wKlW1fJg9sSW52eepoYgZBggvOAHC0u/CYu/qxQ9EVzThCgR69BnSXLHjy2f7SY5zaQ4yt7H9ZVxY2g==", + "license": "MIT", "dependencies": { "core-js": "^2.4.0", "regenerator-runtime": "^0.11.0" @@ -3938,7 +4355,8 @@ "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", - "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==" + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "license": "MIT" }, "node_modules/base64-js": { "version": "1.5.1", @@ -3957,12 +4375,26 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.10.15", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.15.tgz", + "integrity": "sha512-1nfKCq9wuAZFTkA2ey/3OXXx7GzFjLdkTiFVNwlJ9WqdI706CZRIhEqjuwanjMIja+84jDLa9rcyZDPDiVkASQ==", + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" + } }, "node_modules/binary-extensions": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/binary-extensions/-/binary-extensions-2.3.0.tgz", "integrity": "sha512-Ceh+7ox5qe7LJuLHoY0feh3pHuUDHAcRUeyL2VYghZwfpkNIy/+8Ocg0a3UuSoYzavmylwuLWQOf3hl0jjMMIw==", + "license": "MIT", "engines": { "node": ">=8" }, @@ -3974,6 +4406,7 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==", + "license": "MIT", "dependencies": { "buffer": "^5.5.0", "inherits": "^2.0.4", @@ -3983,53 +4416,122 @@ "node_modules/blueimp-md5": { "version": "2.19.0", "resolved": "https://registry.npmjs.org/blueimp-md5/-/blueimp-md5-2.19.0.tgz", - "integrity": "sha512-DRQrD6gJyy8FbiE4s+bDoXS9hiW3Vbx5uCdwvcCf3zLHL+Iv7LtGHLpr+GZV8rHG8tK766FGYBwRbu8pELTt+w==" + "integrity": "sha512-DRQrD6gJyy8FbiE4s+bDoXS9hiW3Vbx5uCdwvcCf3zLHL+Iv7LtGHLpr+GZV8rHG8tK766FGYBwRbu8pELTt+w==", + "license": "MIT" }, "node_modules/boxen": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/boxen/-/boxen-4.2.0.tgz", - "integrity": "sha512-eB4uT9RGzg2odpER62bBwSLvUeGC+WbRjjyyFhGsKnc8wp/m0+hQsMUvUe3H2V0D5vw0nBdO1hCJoZo5mKeuIQ==", + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/boxen/-/boxen-8.0.1.tgz", + "integrity": "sha512-F3PH5k5juxom4xktynS7MoFY+NUWH5LC4CnH11YB8NPew+HLpmBLCybSAEyb2F+4pRXhuhWqFesoQd6DAyc2hw==", + "license": "MIT", "dependencies": { - "ansi-align": "^3.0.0", - "camelcase": "^5.3.1", - "chalk": "^3.0.0", - "cli-boxes": "^2.2.0", - "string-width": "^4.1.0", - "term-size": "^2.1.0", - "type-fest": "^0.8.1", - "widest-line": "^3.1.0" + "ansi-align": "^3.0.1", + "camelcase": "^8.0.0", + "chalk": "^5.3.0", + "cli-boxes": "^3.0.0", + "string-width": "^7.2.0", + "type-fest": "^4.21.0", + "widest-line": "^5.0.0", + "wrap-ansi": "^9.0.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/boxen/node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/boxen/node_modules/camelcase": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-8.0.0.tgz", + "integrity": "sha512-8WB3Jcas3swSvjIeA2yvCJ+Miyz5l1ZmB6HFb9R1317dt9LCQoswg/BGrmAmkWVEszSrrg4RwmO46qIm2OEnSA==", + "license": "MIT", + "engines": { + "node": ">=16" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/boxen/node_modules/chalk": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", - "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", + "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", + "license": "MIT", + "engines": { + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/boxen/node_modules/emoji-regex": { + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", + "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==", + "license": "MIT" + }, + "node_modules/boxen/node_modules/string-width": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "license": "MIT", "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/boxen/node_modules/strip-ansi": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.2.2" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" } }, "node_modules/boxen/node_modules/type-fest": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", - "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz", + "integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==", + "license": "(MIT OR CC0-1.0)", "engines": { - "node": ">=8" + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.3.tgz", + "integrity": "sha512-MCV/fYJEbqx68aE58kv2cA/kiky1G8vux3OR6/jbS+jIMe/6fJWa0DTzJU7dqijOWYwHi1t29FlfYI9uytqlpA==", + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" } @@ -4038,6 +4540,7 @@ "version": "3.0.3", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "license": "MIT", "dependencies": { "fill-range": "^7.1.1" }, @@ -4046,9 +4549,9 @@ } }, "node_modules/browserslist": { - "version": "4.24.5", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.24.5.tgz", - "integrity": "sha512-FDToo4Wo82hIdgc1CQ+NQD0hEhmpPjrZ3hiUgwgOG6IuTdlpr8jdjyG24P6cNP1yJpTLzS5OcGgSw0xmDU1/Tw==", + "version": "4.28.2", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.2.tgz", + "integrity": "sha512-48xSriZYYg+8qXna9kwqjIVzuQxi+KYWp2+5nCYnYKPTr0LvD89Jqk2Or5ogxz0NUMfIjhh2lIUX/LyX9B4oIg==", "funding": [ { "type": "opencollective", @@ -4063,11 +4566,13 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "dependencies": { - "caniuse-lite": "^1.0.30001716", - "electron-to-chromium": "^1.5.149", - "node-releases": "^2.0.19", - "update-browserslist-db": "^1.1.3" + "baseline-browser-mapping": "^2.10.12", + "caniuse-lite": "^1.0.30001782", + "electron-to-chromium": "^1.5.328", + "node-releases": "^2.0.36", + "update-browserslist-db": "^1.2.3" }, "bin": { "browserslist": "cli.js" @@ -4094,6 +4599,7 @@ "url": "https://feross.org/support" } ], + "license": "MIT", "dependencies": { "base64-js": "^1.3.1", "ieee754": "^1.1.13" @@ -4102,73 +4608,14 @@ "node_modules/buffer-from": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", - "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==" - }, - "node_modules/cac": { - "version": "6.7.14", - "resolved": "https://registry.npmjs.org/cac/-/cac-6.7.14.tgz", - "integrity": "sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==", - "dev": true, - "engines": { - "node": ">=8" - } - }, - "node_modules/cacheable-request": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-6.1.0.tgz", - "integrity": "sha512-Oj3cAGPCqOZX7Rz64Uny2GYAZNliQSqfbePrgAQ1wKAihYmCUnraBtJtKcGR4xz7wF+LoJC+ssFZvv5BgF9Igg==", - "dependencies": { - "clone-response": "^1.0.2", - "get-stream": "^5.1.0", - "http-cache-semantics": "^4.0.0", - "keyv": "^3.0.0", - "lowercase-keys": "^2.0.0", - "normalize-url": "^4.1.0", - "responselike": "^1.0.2" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/cacheable-request/node_modules/get-stream": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.2.0.tgz", - "integrity": "sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==", - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/cacheable-request/node_modules/json-buffer": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.0.tgz", - "integrity": "sha512-CuUqjv0FUZIdXkHPI8MezCnFCdaTAacej1TZYulLoAg1h/PhwkdXFN4V/gzY4g+fMBCOV2xF+rp7t2XD2ns/NQ==" - }, - "node_modules/cacheable-request/node_modules/keyv": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-3.1.0.tgz", - "integrity": "sha512-9ykJ/46SN/9KPM/sichzQ7OvXyGDYKGTaDlKMGCAlg2UK8KRy4jb0d8sFc+0Tt0YYnThq8X2RZgCg74RPxgcVA==", - "dependencies": { - "json-buffer": "3.0.0" - } - }, - "node_modules/cacheable-request/node_modules/lowercase-keys": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-2.0.0.tgz", - "integrity": "sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==", - "engines": { - "node": ">=8" - } + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "license": "MIT" }, "node_modules/call-bind": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz", "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.0", "es-define-property": "^1.0.0", @@ -4186,6 +4633,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.2.tgz", "integrity": "sha512-Sp1ablJ0ivDkSzjcaJdxEunN5/XvksFJ2sMBFfq6x0ryhQV/2b/KwFe21cMpmHtPOSij8K99/wSfoEuTObmuMQ==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "function-bind": "^1.1.2" @@ -4198,6 +4646,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/call-bound/-/call-bound-1.0.4.tgz", "integrity": "sha512-+ys997U96po4Kx/ABpBCqhA9EuxJaQWDQg7295H4hBphv3IZg0boBKuwYpt4YXp6MZ5AmZQnU/tyMTlRpaSejg==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.2", "get-intrinsic": "^1.3.0" @@ -4209,11 +4658,18 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/call-me-maybe": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz", + "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==", + "license": "MIT" + }, "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } @@ -4222,6 +4678,7 @@ "version": "5.3.1", "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "license": "MIT", "engines": { "node": ">=6" } @@ -4230,6 +4687,7 @@ "version": "6.2.2", "resolved": "https://registry.npmjs.org/camelcase-keys/-/camelcase-keys-6.2.2.tgz", "integrity": "sha512-YrwaA0vEKazPBkn0ipTiMpSajYDSe+KjQfrjhcBMxJt/znbvlHd8Pw/Vamaz5EB4Wfhs3SUR3Z9mwRu/P3s3Yg==", + "license": "MIT", "dependencies": { "camelcase": "^5.3.1", "map-obj": "^4.0.0", @@ -4243,9 +4701,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001718", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001718.tgz", - "integrity": "sha512-AflseV1ahcSunK53NfEs9gFWgOEmzr0f+kaMFA4xiLZlr9Hzt7HxcSpIFcnNCUkz6R6dWKa54rUz3HUmI3nVcw==", + "version": "1.0.30001785", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001785.tgz", + "integrity": "sha512-blhOL/WNR+Km1RI/LCVAvA73xplXA7ZbjzI4YkMK9pa6T/P3F2GxjNpEkyw5repTw9IvkyrjyHpwjnhZ5FOvYQ==", "funding": [ { "type": "opencollective", @@ -4259,28 +4717,24 @@ "type": "github", "url": "https://github.com/sponsors/ai" } - ] + ], + "license": "CC-BY-4.0" }, "node_modules/chai": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/chai/-/chai-5.2.0.tgz", - "integrity": "sha512-mCuXncKXk5iCLhfhwTc0izo0gtEmpz5CtG2y8GiOINBlMVS6v8TMRc5TaLWKS6692m9+dVVfzgeVxR5UxWHTYw==", + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/chai/-/chai-6.2.2.tgz", + "integrity": "sha512-NUPRluOfOiTKBKvWPtSD4PhFvWCqOi0BGStNWs57X9js7XGTprSmFoz5F0tWhR4WPjNeR9jXqdC7/UpSJTnlRg==", "dev": true, - "dependencies": { - "assertion-error": "^2.0.1", - "check-error": "^2.1.1", - "deep-eql": "^5.0.1", - "loupe": "^3.1.0", - "pathval": "^2.0.0" - }, + "license": "MIT", "engines": { - "node": ">=12" + "node": ">=18" } }, "node_modules/chalk": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "license": "MIT", "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" @@ -4295,21 +4749,14 @@ "node_modules/chardet": { "version": "0.7.0", "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz", - "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==" - }, - "node_modules/check-error": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/check-error/-/check-error-2.1.1.tgz", - "integrity": "sha512-OAlb+T7V4Op9OwdkjmguYRqncdlx5JiofwOAUkmTF+jNdHwzTaTs4sRAGpzLF3oOz5xAyDGrPgeIDFQmDOTiJw==", - "dev": true, - "engines": { - "node": ">= 16" - } + "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==", + "license": "MIT" }, "node_modules/chokidar": { "version": "3.6.0", "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz", "integrity": "sha512-7VT13fmjotKpGipCW9JEQAusEPE+Ei8nl6/g4FBAmIm0GOOLMua9NDDo/DWp0ZAxCr3cPq5ZpBqmPAQgDda2Pw==", + "license": "MIT", "dependencies": { "anymatch": "~3.1.2", "braces": "~3.0.2", @@ -4333,6 +4780,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "license": "ISC", "dependencies": { "is-glob": "^4.0.1" }, @@ -4340,22 +4788,19 @@ "node": ">= 6" } }, - "node_modules/ci-info": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", - "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==" - }, "node_modules/classnames": { "version": "2.5.1", "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.5.1.tgz", - "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==" + "integrity": "sha512-saHYOzhIQs6wy2sVxTM6bUDsQO4F50V9RQ22qBpEdCW+I+/Wmke2HOl6lS6dTpdxVhb88/I6+Hs+438c3lfUow==", + "license": "MIT" }, "node_modules/cli-boxes": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-2.2.1.tgz", - "integrity": "sha512-y4coMcylgSCdVinjiDBuR8PCC2bLjyGTwEmPb9NHR/QaNU6EUOXcTY/s6VjGMD6ENSEaeQYHCY0GNGS5jfMwPw==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/cli-boxes/-/cli-boxes-3.0.0.tgz", + "integrity": "sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==", + "license": "MIT", "engines": { - "node": ">=6" + "node": ">=10" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -4365,6 +4810,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", "integrity": "sha512-I/zHAwsKf9FqGoXM4WWRACob9+SNukZTd94DWF57E4toouRulbCxcUh6RKUEOQlYTHJnzkPMySvPNaaSLNfLZw==", + "license": "MIT", "dependencies": { "restore-cursor": "^3.1.0" }, @@ -4376,6 +4822,7 @@ "version": "2.9.2", "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz", "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==", + "license": "MIT", "engines": { "node": ">=6" }, @@ -4387,6 +4834,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", "integrity": "sha512-FxqpkPPwu1HjuN93Omfm4h8uIanXofW0RxVEW3k5RKx+mJJYSthzNhp32Kzxxy3YAEZ/Dc/EWN1vZRY0+kOhbw==", + "license": "ISC", "engines": { "node": ">= 10" } @@ -4395,25 +4843,16 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/clone/-/clone-1.0.4.tgz", "integrity": "sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==", + "license": "MIT", "engines": { "node": ">=0.8" } }, - "node_modules/clone-response": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/clone-response/-/clone-response-1.0.3.tgz", - "integrity": "sha512-ROoL94jJH2dUVML2Y/5PEDNaSHgeOdSDicUyS7izcF63G6sTc/FTjLub4b8Il9S8S0beOfYt0TaA5qvFK+w0wA==", - "dependencies": { - "mimic-response": "^1.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/clsx": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/clsx/-/clsx-2.1.1.tgz", "integrity": "sha512-eYm0QWBtUrBWZWG0d386OGAw16Z995PiOVo2B7bjWSbHedGl5e0ZWaq65kOGgUSNesEIDkB9ISbTg/JK9dhCZA==", + "license": "MIT", "engines": { "node": ">=6" } @@ -4422,6 +4861,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "license": "MIT", "dependencies": { "color-name": "~1.1.4" }, @@ -4432,17 +4872,20 @@ "node_modules/color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "license": "MIT" }, "node_modules/commander": { "version": "2.20.3", "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==" + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "license": "MIT" }, "node_modules/common-tags": { "version": "1.8.2", "resolved": "https://registry.npmjs.org/common-tags/-/common-tags-1.8.2.tgz", "integrity": "sha512-gk/Z852D2Wtb//0I+kRFNKKE9dIIVirjoqPoA1wJU+XePVXZfGeBpk45+A1rKO4Q43prqWBNY/MiIeRLbPWUaA==", + "license": "MIT", "engines": { "node": ">=4.0.0" } @@ -4450,55 +4893,55 @@ "node_modules/compute-scroll-into-view": { "version": "1.0.20", "resolved": "https://registry.npmjs.org/compute-scroll-into-view/-/compute-scroll-into-view-1.0.20.tgz", - "integrity": "sha512-UCB0ioiyj8CRjtrvaceBLqqhZCVP+1B8+NWQhmdsm0VXOJtobBCf1dBQmebCCo34qZmUwZfIH2MZLqNHazrfjg==" + "integrity": "sha512-UCB0ioiyj8CRjtrvaceBLqqhZCVP+1B8+NWQhmdsm0VXOJtobBCf1dBQmebCCo34qZmUwZfIH2MZLqNHazrfjg==", + "license": "MIT" }, "node_modules/concat-map": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", - "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==" + "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", + "dev": true, + "license": "MIT" }, - "node_modules/configstore": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/configstore/-/configstore-5.0.1.tgz", - "integrity": "sha512-aMKprgk5YhBNyH25hj8wGt2+D52Sw1DRRIzqBwLp2Ya9mFmY8KPvvtvmna8SxVR9JMZ4kzMD68N22vlaRpkeFA==", + "node_modules/config-chain": { + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.13.tgz", + "integrity": "sha512-qj+f8APARXHrM0hraqXYb2/bOVSV4PvJQlNZ/DVj0QrmNM2q2euizkeuVckQ57J+W0mRH6Hvi+k50M4Jul2VRQ==", + "license": "MIT", "dependencies": { - "dot-prop": "^5.2.0", - "graceful-fs": "^4.1.2", - "make-dir": "^3.0.0", - "unique-string": "^2.0.0", - "write-file-atomic": "^3.0.0", - "xdg-basedir": "^4.0.0" - }, - "engines": { - "node": ">=8" + "ini": "^1.3.4", + "proto-list": "~1.2.1" } }, - "node_modules/configstore/node_modules/make-dir": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz", - "integrity": "sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==", + "node_modules/config-chain/node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "license": "ISC" + }, + "node_modules/configstore": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/configstore/-/configstore-7.1.0.tgz", + "integrity": "sha512-N4oog6YJWbR9kGyXvS7jEykLDXIE2C0ILYqNBZBp9iwiJpoCBWYsuAdW6PPFn6w06jjnC+3JstVvWHO4cZqvRg==", + "license": "BSD-2-Clause", "dependencies": { - "semver": "^6.0.0" + "atomically": "^2.0.3", + "dot-prop": "^9.0.0", + "graceful-fs": "^4.2.11", + "xdg-basedir": "^5.1.0" }, "engines": { - "node": ">=8" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/configstore/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "bin": { - "semver": "bin/semver.js" - } - }, "node_modules/connected-react-router": { "version": "6.9.3", "resolved": "https://registry.npmjs.org/connected-react-router/-/connected-react-router-6.9.3.tgz", "integrity": "sha512-4ThxysOiv/R2Dc4Cke1eJwjKwH1Y51VDwlOrOfs1LjpdYOVvCNjNkZDayo7+sx42EeGJPQUNchWkjAIJdXGIOQ==", + "license": "MIT", "dependencies": { "lodash.isequalwith": "^4.4.0", "prop-types": "^15.7.2" @@ -4518,21 +4961,24 @@ "node_modules/convert-source-map": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-2.0.0.tgz", - "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==" + "integrity": "sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==", + "license": "MIT" }, "node_modules/core-js": { "version": "2.6.12", "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.12.tgz", "integrity": "sha512-Kb2wC0fvsWfQrgk8HU5lW6U/Lcs8+9aaYcy4ZFc6DDlo4nZ7n70dEgE5rtR0oG6ufKDUnrwfWL1mXR5ljDatrQ==", "deprecated": "core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.", - "hasInstallScript": true + "hasInstallScript": true, + "license": "MIT" }, "node_modules/core-js-compat": { - "version": "3.42.0", - "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.42.0.tgz", - "integrity": "sha512-bQasjMfyDGyaeWKBIu33lHh9qlSR0MFE/Nmc6nMjf/iU9b3rSMdAYz1Baxrv4lPdGUsTqZudHA4jIGSJy0SWZQ==", + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.49.0.tgz", + "integrity": "sha512-VQXt1jr9cBz03b331DFDCCP90b3fanciLkgiOoy8SBHy06gNf+vQ1A3WFLqG7I8TipYIKeYK9wxd0tUrvHcOZA==", + "license": "MIT", "dependencies": { - "browserslist": "^4.24.4" + "browserslist": "^4.28.1" }, "funding": { "type": "opencollective", @@ -4540,11 +4986,12 @@ } }, "node_modules/core-js-pure": { - "version": "3.42.0", - "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.42.0.tgz", - "integrity": "sha512-007bM04u91fF4kMgwom2I5cQxAFIy8jVulgr9eozILl/SZE53QOqnW/+vviC+wQWLv+AunBG+8Q0TLoeSsSxRQ==", + "version": "3.49.0", + "resolved": "https://registry.npmjs.org/core-js-pure/-/core-js-pure-3.49.0.tgz", + "integrity": "sha512-XM4RFka59xATyJv/cS3O3Kml72hQXUeGRuuTmMYFxwzc9/7C8OYTaIR/Ji+Yt8DXzsFLNhat15cE/JP15HrCgw==", "dev": true, "hasInstallScript": true, + "license": "MIT", "funding": { "type": "opencollective", "url": "https://opencollective.com/core-js" @@ -4554,7 +5001,7 @@ "version": "7.0.6", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.6.tgz", "integrity": "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==", - "dev": true, + "license": "MIT", "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", @@ -4568,6 +5015,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/crypto-random-string/-/crypto-random-string-2.0.0.tgz", "integrity": "sha512-v1plID3y9r/lPhviJ1wrXpLeyUIGAZ2SHNYTEapm7/8A9nLPoyvVp3RK/EPFqn5kEznyWgYZNsRtYYIWbuG8KA==", + "license": "MIT", "engines": { "node": ">=8" } @@ -4575,12 +5023,14 @@ "node_modules/css-mediaquery": { "version": "0.1.2", "resolved": "https://registry.npmjs.org/css-mediaquery/-/css-mediaquery-0.1.2.tgz", - "integrity": "sha512-COtn4EROW5dBGlE/4PiKnh6rZpAPxDeFLaEEwt4i10jpDMFt2EhQGS79QmmrO+iKCHv0PU/HrOWEhijFd1x99Q==" + "integrity": "sha512-COtn4EROW5dBGlE/4PiKnh6rZpAPxDeFLaEEwt4i10jpDMFt2EhQGS79QmmrO+iKCHv0PU/HrOWEhijFd1x99Q==", + "license": "BSD" }, "node_modules/css-vendor": { "version": "2.0.8", "resolved": "https://registry.npmjs.org/css-vendor/-/css-vendor-2.0.8.tgz", "integrity": "sha512-x9Aq0XTInxrkuFeHKbYC7zWY8ai7qJ04Kxd9MnvbC1uO5DagxoHQjm4JvG+vCdXOoFtCjbL2XSZfxmoYa9uQVQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.8.3", "is-in-browser": "^1.0.2" @@ -4590,15 +5040,17 @@ "version": "1.5.1", "resolved": "https://registry.npmjs.org/css.escape/-/css.escape-1.5.1.tgz", "integrity": "sha512-YUifsXXuknHlUsmlgyY0PKzgPOr7/FjCePfHNt0jxm83wHZi44VDMQ7/fGNkjY3/jV1MC+1CmZbaHzugyeRtpg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/cssstyle": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-4.3.1.tgz", - "integrity": "sha512-ZgW+Jgdd7i52AaLYCriF8Mxqft0gD/R9i9wi6RWBhs1pqdPEzPjym7rvRKi397WmQFf3SlyUsszhw+VVCbx79Q==", + "version": "4.6.0", + "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-4.6.0.tgz", + "integrity": "sha512-2z+rWdzbbSZv6/rhtvzvqeZQHrBaqgogqt85sqFNbabZOuFbCVFb8kPeEtZjiKkbrm395irpNKiYeFeLiQnFPg==", "dev": true, + "license": "MIT", "dependencies": { - "@asamuzakjp/css-color": "^3.1.2", + "@asamuzakjp/css-color": "^3.2.0", "rrweb-cssom": "^0.8.0" }, "engines": { @@ -4608,19 +5060,22 @@ "node_modules/csstype": { "version": "2.6.21", "resolved": "https://registry.npmjs.org/csstype/-/csstype-2.6.21.tgz", - "integrity": "sha512-Z1PhmomIfypOpoMjRQB70jfvy/wxT50qW08YXO5lMIJkrdq4yOTR+AW7FqutScmB9NkLwxo+jU+kZLbofZZq/w==" + "integrity": "sha512-Z1PhmomIfypOpoMjRQB70jfvy/wxT50qW08YXO5lMIJkrdq4yOTR+AW7FqutScmB9NkLwxo+jU+kZLbofZZq/w==", + "license": "MIT" }, "node_modules/damerau-levenshtein": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/damerau-levenshtein/-/damerau-levenshtein-1.0.8.tgz", "integrity": "sha512-sdQSFB7+llfUcQHUQO3+B8ERRj0Oa4w9POWMI/puGtuf7gFywGmkaLCElnudfTiKZV+NvHqL0ifzdrI8Ro7ESA==", - "dev": true + "dev": true, + "license": "BSD-2-Clause" }, "node_modules/data-urls": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/data-urls/-/data-urls-5.0.0.tgz", "integrity": "sha512-ZYP5VBHshaDAiVZxjbRVcFJpc+4xGgT0bK3vzy1HLN8jTO975HEbuYzZJcHoQEY5K1a0z8YayJkyVETa08eNTg==", "dev": true, + "license": "MIT", "dependencies": { "whatwg-mimetype": "^4.0.0", "whatwg-url": "^14.0.0" @@ -4634,6 +5089,7 @@ "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", "dev": true, + "license": "MIT", "engines": { "node": ">=18" } @@ -4642,6 +5098,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/data-view-buffer/-/data-view-buffer-1.0.2.tgz", "integrity": "sha512-EmKO5V3OLXh1rtK2wgXRansaK1/mtVdTUEiEI0W8RkvgT05kfxaH29PliLnpLP73yYO6142Q72QNa8Wx/A5CqQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -4658,6 +5115,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/data-view-byte-length/-/data-view-byte-length-1.0.2.tgz", "integrity": "sha512-tuhGbE6CfTM9+5ANGf+oQb72Ky/0+s3xKUpHvShfiz2RxMFgFPjsXuRLBVMtvMs15awe45SRb83D6wH4ew6wlQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -4674,6 +5132,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/data-view-byte-offset/-/data-view-byte-offset-1.0.1.tgz", "integrity": "sha512-BS8PfmtDGnrgYdOonGZQdLZslWIeCGFP9tpan0hi1Co2Zr2NKADsvGYA8XxuG/4UWgJ6Cjtv+YJnB6MM69QGlQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -4689,12 +5148,14 @@ "node_modules/date-fns": { "version": "1.30.1", "resolved": "https://registry.npmjs.org/date-fns/-/date-fns-1.30.1.tgz", - "integrity": "sha512-hBSVCvSmWC+QypYObzwGOd9wqdDpOt+0wl0KbU+R+uuZBS1jN8VsD1ss3irQDknRj5NvxiTF6oj/nDRnN/UQNw==" + "integrity": "sha512-hBSVCvSmWC+QypYObzwGOd9wqdDpOt+0wl0KbU+R+uuZBS1jN8VsD1ss3irQDknRj5NvxiTF6oj/nDRnN/UQNw==", + "license": "MIT" }, "node_modules/debug": { - "version": "4.4.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.1.tgz", - "integrity": "sha512-KcKCqiftBJcZr++7ykoDIEwSa3XWowTfNPo92BYxjXiyYEVrUQh2aLyhxBCwww+heortUFxEJYcRzosstTEBYQ==", + "version": "4.4.3", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz", + "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==", + "license": "MIT", "dependencies": { "ms": "^2.1.3" }, @@ -4711,6 +5172,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", "integrity": "sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -4719,6 +5181,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/decamelize-keys/-/decamelize-keys-1.1.1.tgz", "integrity": "sha512-WiPxgEirIV0/eIOMcnFBA3/IJZAZqKnwAwWyvvdi4lsr1WCN22nhdf/3db3DoZcUjTV2SqfzIwNyp6y2xs3nmg==", + "license": "MIT", "dependencies": { "decamelize": "^1.1.0", "map-obj": "^1.0.0" @@ -4734,49 +5197,33 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-1.0.1.tgz", "integrity": "sha512-7N/q3lyZ+LVCp7PzuxrJr4KMbBE2hW7BT7YNia330OFxIf4d3r5zVpicP2650l7CPN6RM9zOJRl3NGpqSiw3Eg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/decimal.js": { - "version": "10.5.0", - "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.5.0.tgz", - "integrity": "sha512-8vDa8Qxvr/+d94hSh5P3IJwI5t8/c0KsMp+g8bNw9cY2icONa5aPfvKeieW1WlG0WQYwwhJ7mjui2xtiePQSXw==", - "dev": true + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/decimal.js/-/decimal.js-10.6.0.tgz", + "integrity": "sha512-YpgQiITW3JXGntzdUmyUR1V812Hn8T1YVXhCu+wO3OpS4eU9l4YdD3qjyiKdV6mvV29zapkMeD390UVEf2lkUg==", + "dev": true, + "license": "MIT" }, "node_modules/decode-uri-component": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz", "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==", + "license": "MIT", "engines": { "node": ">=0.10" } }, - "node_modules/decompress-response": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-3.3.0.tgz", - "integrity": "sha512-BzRPQuY1ip+qDonAOz42gRm/pg9F768C+npV/4JOsxRC2sq+Rlk+Q4ZCAsOhnIaMrgarILY+RMUIvMmmX1qAEA==", - "dependencies": { - "mimic-response": "^1.0.0" - }, - "engines": { - "node": ">=4" - } - }, - "node_modules/deep-eql": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-5.0.2.tgz", - "integrity": "sha512-h5k/5U50IJJFpzfL6nO9jaaumfjO/f2NjK/oYB2Djzm4p9L+3T9qWpZqZ2hAbLPuuYq9wrU08WQyBTL5GbPk5Q==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/deep-equal": { "version": "2.2.3", "resolved": "https://registry.npmjs.org/deep-equal/-/deep-equal-2.2.3.tgz", "integrity": "sha512-ZIwpnevOurS8bpT4192sqAowWM76JDKSHYzMLty3BZGSswgq6pBaH3DhCSW5xVAZICZyKdOBPjwww5wfgT/6PA==", "dev": true, + "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.0", "call-bind": "^1.0.5", @@ -4808,12 +5255,14 @@ "version": "2.0.5", "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/deep-extend": { "version": "0.6.0", "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "license": "MIT", "engines": { "node": ">=4.0.0" } @@ -4822,12 +5271,14 @@ "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/deepmerge": { "version": "4.3.1", "resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz", "integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -4836,6 +5287,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/defaults/-/defaults-1.0.4.tgz", "integrity": "sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==", + "license": "MIT", "dependencies": { "clone": "^1.0.2" }, @@ -4843,15 +5295,11 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/defer-to-connect": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/defer-to-connect/-/defer-to-connect-1.1.3.tgz", - "integrity": "sha512-0ISdNousHvZT2EiFlZeZAHBUvSxmKswVCEf8hW7KWgG4a8MVEu/3Vb6uWYozkjylyCxe0JBIiRB1jV45S70WVQ==" - }, "node_modules/define-data-property": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "license": "MIT", "dependencies": { "es-define-property": "^1.0.0", "es-errors": "^1.3.0", @@ -4868,6 +5316,7 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", + "license": "MIT", "dependencies": { "define-data-property": "^1.0.1", "has-property-descriptors": "^1.0.0", @@ -4885,6 +5334,7 @@ "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", "dev": true, + "license": "MIT", "engines": { "node": ">=6" } @@ -4894,6 +5344,7 @@ "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", "dev": true, + "license": "MIT", "dependencies": { "path-type": "^4.0.0" }, @@ -4905,6 +5356,7 @@ "version": "14.0.1", "resolved": "https://registry.npmjs.org/dnd-core/-/dnd-core-14.0.1.tgz", "integrity": "sha512-+PVS2VPTgKFPYWo3vAFEA8WPbTf7/xo43TifH9G8S1KqnrQu0o77A3unrF5yOugy4mIz7K5wAVFHUcha7wsz6A==", + "license": "MIT", "dependencies": { "@react-dnd/asap": "^4.0.0", "@react-dnd/invariant": "^2.0.0", @@ -4916,6 +5368,7 @@ "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", "dev": true, + "license": "Apache-2.0", "dependencies": { "esutils": "^2.0.2" }, @@ -4927,60 +5380,78 @@ "version": "0.5.16", "resolved": "https://registry.npmjs.org/dom-accessibility-api/-/dom-accessibility-api-0.5.16.tgz", "integrity": "sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/dom-align": { "version": "1.12.4", "resolved": "https://registry.npmjs.org/dom-align/-/dom-align-1.12.4.tgz", - "integrity": "sha512-R8LUSEay/68zE5c8/3BDxiTEvgb4xZTF0RKmAHfiEVN3klfIpXfi2/QCoiWPccVQ0J/ZGdz9OjzL4uJEP/MRAw==" + "integrity": "sha512-R8LUSEay/68zE5c8/3BDxiTEvgb4xZTF0RKmAHfiEVN3klfIpXfi2/QCoiWPccVQ0J/ZGdz9OjzL4uJEP/MRAw==", + "license": "MIT" }, "node_modules/dom-helpers": { "version": "5.2.1", "resolved": "https://registry.npmjs.org/dom-helpers/-/dom-helpers-5.2.1.tgz", "integrity": "sha512-nRCa7CK3VTrM2NmGkIy4cbK7IZlgBE/PYMn55rrXefr5xXDP0LdtfPnblFDoVdcAfslJ7or6iqAUnx0CCGIWQA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.8.7", "csstype": "^3.0.2" } }, "node_modules/dom-helpers/node_modules/csstype": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", - "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==" + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "license": "MIT" }, "node_modules/dompurify": { - "version": "2.5.8", - "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.5.8.tgz", - "integrity": "sha512-o1vSNgrmYMQObbSSvF/1brBYEQPHhV1+gsmrusO7/GXtp1T9rCS8cXFqVxK/9crT1jA6Ccv+5MTSjBNqr7Sovw==" - }, - "node_modules/dot-prop": { - "version": "5.3.0", - "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-5.3.0.tgz", - "integrity": "sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==", - "dependencies": { - "is-obj": "^2.0.0" - }, - "engines": { - "node": ">=8" + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-3.3.3.tgz", + "integrity": "sha512-Oj6pzI2+RqBfFG+qOaOLbFXLQ90ARpcGG6UePL82bJLtdsa6CYJD7nmiU8MW9nQNOtCHV3lZ/Bzq1X0QYbBZCA==", + "license": "(MPL-2.0 OR Apache-2.0)", + "optionalDependencies": { + "@types/trusted-types": "^2.0.7" } }, - "node_modules/dot-prop/node_modules/is-obj": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-2.0.0.tgz", - "integrity": "sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==", + "node_modules/dot-prop": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-9.0.0.tgz", + "integrity": "sha512-1gxPBJpI/pcjQhKgIU91II6Wkay+dLcN3M6rf2uwP8hRur3HtQXjVrdAK3sjC0piaEuxzMwjXChcETiJl47lAQ==", + "license": "MIT", + "dependencies": { + "type-fest": "^4.18.2" + }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/dot-prop/node_modules/type-fest": { + "version": "4.41.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.41.0.tgz", + "integrity": "sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==", + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/downloadjs": { "version": "1.4.7", "resolved": "https://registry.npmjs.org/downloadjs/-/downloadjs-1.4.7.tgz", - "integrity": "sha512-LN1gO7+u9xjU5oEScGFKvXhYf7Y/empUIIEAGBs1LzUq/rg5duiDrkuH5A2lQGd5jfMOb9X9usDa2oVXwJ0U/Q==" + "integrity": "sha512-LN1gO7+u9xjU5oEScGFKvXhYf7Y/empUIIEAGBs1LzUq/rg5duiDrkuH5A2lQGd5jfMOb9X9usDa2oVXwJ0U/Q==", + "license": "MIT" }, "node_modules/downshift": { "version": "3.2.7", "resolved": "https://registry.npmjs.org/downshift/-/downshift-3.2.7.tgz", "integrity": "sha512-mbUO9ZFhMGtksIeVWRFFjNOPN237VsUqZSEYi0VS0Wj38XNLzpgOBTUcUjdjFeB8KVgmrcRa6GGFkTbACpG6FA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.1.2", "compute-scroll-into-view": "^1.0.9", @@ -4994,12 +5465,14 @@ "node_modules/downshift/node_modules/react-is": { "version": "16.13.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "license": "MIT" }, "node_modules/dunder-proto": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.1.tgz", "integrity": "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-errors": "^1.3.0", @@ -5009,21 +5482,11 @@ "node": ">= 0.4" } }, - "node_modules/duplexer3": { - "version": "0.1.5", - "resolved": "https://registry.npmjs.org/duplexer3/-/duplexer3-0.1.5.tgz", - "integrity": "sha512-1A8za6ws41LQgv9HrE/66jyC5yuSjQ3L/KOpFtoBilsAK2iA2wuS5rTt1OCzIvtS2V7nVmedsUU+DGRcjBmOYA==" - }, - "node_modules/eastasianwidth": { - "version": "0.2.0", - "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", - "integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==", - "dev": true - }, "node_modules/ejs": { "version": "3.1.10", "resolved": "https://registry.npmjs.org/ejs/-/ejs-3.1.10.tgz", "integrity": "sha512-UeJmFfOrAQS8OJWPZ4qtgHyWExa088/MtK5UEyoJGFH67cDEXkZSviOiKRCZ4Xij0zxI3JECgYs3oKx+AizQBA==", + "license": "Apache-2.0", "dependencies": { "jake": "^10.8.5" }, @@ -5035,29 +5498,24 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.157", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.157.tgz", - "integrity": "sha512-/0ybgsQd1muo8QlnuTpKwtl0oX5YMlUGbm8xyqgDU00motRkKFFbUJySAQBWcY79rVqNLWIWa87BGVGClwAB2w==" + "version": "1.5.331", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.331.tgz", + "integrity": "sha512-IbxXrsTlD3hRodkLnbxAPP4OuJYdWCeM3IOdT+CpcMoIwIoDfCmRpEtSPfwBXxVkg9xmBeY7Lz2Eo2TDn/HC3Q==", + "license": "ISC" }, "node_modules/emoji-regex": { "version": "9.2.2", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz", "integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==", - "dev": true - }, - "node_modules/end-of-stream": { - "version": "1.4.4", - "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.4.tgz", - "integrity": "sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==", - "dependencies": { - "once": "^1.4.0" - } + "dev": true, + "license": "MIT" }, "node_modules/entities": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.0.tgz", - "integrity": "sha512-aKstq2TDOndCn4diEyp9Uq/Flu2i1GlLkc6XIDQSDMuaFE3OPW5OphLCyQ5SpSJZTb4reN+kTcYru5yIfXoRPw==", + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", + "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=0.12" }, @@ -5066,17 +5524,19 @@ } }, "node_modules/error-ex": { - "version": "1.3.2", - "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", - "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "version": "1.3.4", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.4.tgz", + "integrity": "sha512-sqQamAnR14VgCr1A618A3sGrygcpK+HEbenA/HiEAkkUwcZIIB/tgWqHFxWgOyDh4nB4JCRimh79dR5Ywc9MDQ==", + "license": "MIT", "dependencies": { "is-arrayish": "^0.2.1" } }, "node_modules/es-abstract": { - "version": "1.23.10", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.23.10.tgz", - "integrity": "sha512-MtUbM072wlJNyeYAe0mhzrD+M6DIJa96CZAOBBrhDbgKnB4MApIKefcyAB1eOdYn8cUNZgvwBvEzdoAYsxgEIw==", + "version": "1.24.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.24.1.tgz", + "integrity": "sha512-zHXBLhP+QehSSbsS9Pt23Gg964240DPd6QCf8WpkqEXxQ7fhdZzYsocOr5u7apWonsS5EjZDmTF+/slGMyasvw==", + "license": "MIT", "dependencies": { "array-buffer-byte-length": "^1.0.2", "arraybuffer.prototype.slice": "^1.0.4", @@ -5105,7 +5565,9 @@ "is-array-buffer": "^3.0.5", "is-callable": "^1.2.7", "is-data-view": "^1.0.2", + "is-negative-zero": "^2.0.3", "is-regex": "^1.2.1", + "is-set": "^2.0.3", "is-shared-array-buffer": "^1.0.4", "is-string": "^1.1.1", "is-typed-array": "^1.1.15", @@ -5120,6 +5582,7 @@ "safe-push-apply": "^1.0.0", "safe-regex-test": "^1.1.0", "set-proto": "^1.0.0", + "stop-iteration-iterator": "^1.1.0", "string.prototype.trim": "^1.2.10", "string.prototype.trimend": "^1.0.9", "string.prototype.trimstart": "^1.0.8", @@ -5141,6 +5604,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz", "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==", + "license": "MIT", "engines": { "node": ">= 0.4" } @@ -5149,6 +5613,7 @@ "version": "1.3.0", "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "license": "MIT", "engines": { "node": ">= 0.4" } @@ -5158,6 +5623,7 @@ "resolved": "https://registry.npmjs.org/es-get-iterator/-/es-get-iterator-1.1.3.tgz", "integrity": "sha512-sPZmqHBe6JIiTfN5q2pEi//TwxmAFHwj/XEuYjTuse78i8KxaqMTTzxPoFKuzRpDpTJ+0NAbpfenkmH2rePtuw==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.2", "get-intrinsic": "^1.1.3", @@ -5177,29 +5643,32 @@ "version": "2.0.5", "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/es-iterator-helpers": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.2.1.tgz", - "integrity": "sha512-uDn+FE1yrDzyC0pCo961B2IHbdM8y/ACZsKD4dG6WqrjV53BADjwa7D+1aom2rsNVfLyDgU/eigvlJGJ08OQ4w==", + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/es-iterator-helpers/-/es-iterator-helpers-1.3.1.tgz", + "integrity": "sha512-zWwRvqWiuBPr0muUG/78cW3aHROFCNIQ3zpmYDpwdbnt2m+xlNyRWpHBpa2lJjSBit7BQ+RXA1iwbSmu5yJ/EQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", - "call-bound": "^1.0.3", + "call-bound": "^1.0.4", "define-properties": "^1.2.1", - "es-abstract": "^1.23.6", + "es-abstract": "^1.24.1", "es-errors": "^1.3.0", - "es-set-tostringtag": "^2.0.3", + "es-set-tostringtag": "^2.1.0", "function-bind": "^1.1.2", - "get-intrinsic": "^1.2.6", + "get-intrinsic": "^1.3.0", "globalthis": "^1.0.4", "gopd": "^1.2.0", "has-property-descriptors": "^1.0.2", "has-proto": "^1.2.0", "has-symbols": "^1.1.0", "internal-slot": "^1.1.0", - "iterator.prototype": "^1.1.4", + "iterator.prototype": "^1.1.5", + "math-intrinsics": "^1.1.0", "safe-array-concat": "^1.1.3" }, "engines": { @@ -5207,15 +5676,17 @@ } }, "node_modules/es-module-lexer": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-1.7.0.tgz", - "integrity": "sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==", - "dev": true + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.0.0.tgz", + "integrity": "sha512-5POEcUuZybH7IdmGsD8wlf0AI55wMecM9rVBTI/qEAy2c1kTOm3DjFYjrBdI2K3BaJjJYfYFeRtM0t9ssnRuxw==", + "dev": true, + "license": "MIT" }, "node_modules/es-object-atoms": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/es-object-atoms/-/es-object-atoms-1.1.1.tgz", "integrity": "sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0" }, @@ -5227,6 +5698,7 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.1.0.tgz", "integrity": "sha512-j6vWzfrGVfyXxge+O0x5sh6cvxAog0a/4Rdd2K36zCMV5eJ+/+tOAngRO8cODMNWbVRdVlmGZQL2YS3yR8bIUA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "get-intrinsic": "^1.2.6", @@ -5242,6 +5714,7 @@ "resolved": "https://registry.npmjs.org/es-shim-unscopables/-/es-shim-unscopables-1.1.0.tgz", "integrity": "sha512-d9T8ucsEhh8Bi1woXCf+TIKDIROLG5WCkxg8geBCbvk22kzwC5G2OnXVMO6FUsvQlgUUXQ2itephWDLqDzbeCw==", "dev": true, + "license": "MIT", "dependencies": { "hasown": "^2.0.2" }, @@ -5253,6 +5726,7 @@ "version": "1.3.0", "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.3.0.tgz", "integrity": "sha512-w+5mJ3GuFL+NjVtJlvydShqE1eN3h3PbI7/5LAsYJP/2qtuMXjfL2LpHSRqo4b4eSF5K/DH1JXKUAHSB2UW50g==", + "license": "MIT", "dependencies": { "is-callable": "^1.2.7", "is-date-object": "^1.0.5", @@ -5266,11 +5740,12 @@ } }, "node_modules/esbuild": { - "version": "0.25.4", - "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.25.4.tgz", - "integrity": "sha512-8pgjLUcUjcgDg+2Q4NYXnPbo/vncAY4UmyaCm0jZevERqCHZIaWwdJHkf8XQtu4AxSKCdvrUbT0XUr1IdZzI8Q==", + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.7.tgz", + "integrity": "sha512-IxpibTjyVnmrIQo5aqNpCgoACA/dTKLTlhMHihVHhdkxKyPO1uBBthumT0rdHmcsk9uMonIWS0m4FljWzILh3w==", "dev": true, "hasInstallScript": true, + "license": "MIT", "bin": { "esbuild": "bin/esbuild" }, @@ -5278,47 +5753,53 @@ "node": ">=18" }, "optionalDependencies": { - "@esbuild/aix-ppc64": "0.25.4", - "@esbuild/android-arm": "0.25.4", - "@esbuild/android-arm64": "0.25.4", - "@esbuild/android-x64": "0.25.4", - "@esbuild/darwin-arm64": "0.25.4", - "@esbuild/darwin-x64": "0.25.4", - "@esbuild/freebsd-arm64": "0.25.4", - "@esbuild/freebsd-x64": "0.25.4", - "@esbuild/linux-arm": "0.25.4", - "@esbuild/linux-arm64": "0.25.4", - "@esbuild/linux-ia32": "0.25.4", - "@esbuild/linux-loong64": "0.25.4", - "@esbuild/linux-mips64el": "0.25.4", - "@esbuild/linux-ppc64": "0.25.4", - "@esbuild/linux-riscv64": "0.25.4", - "@esbuild/linux-s390x": "0.25.4", - "@esbuild/linux-x64": "0.25.4", - "@esbuild/netbsd-arm64": "0.25.4", - "@esbuild/netbsd-x64": "0.25.4", - "@esbuild/openbsd-arm64": "0.25.4", - "@esbuild/openbsd-x64": "0.25.4", - "@esbuild/sunos-x64": "0.25.4", - "@esbuild/win32-arm64": "0.25.4", - "@esbuild/win32-ia32": "0.25.4", - "@esbuild/win32-x64": "0.25.4" + "@esbuild/aix-ppc64": "0.27.7", + "@esbuild/android-arm": "0.27.7", + "@esbuild/android-arm64": "0.27.7", + "@esbuild/android-x64": "0.27.7", + "@esbuild/darwin-arm64": "0.27.7", + "@esbuild/darwin-x64": "0.27.7", + "@esbuild/freebsd-arm64": "0.27.7", + "@esbuild/freebsd-x64": "0.27.7", + "@esbuild/linux-arm": "0.27.7", + "@esbuild/linux-arm64": "0.27.7", + "@esbuild/linux-ia32": "0.27.7", + "@esbuild/linux-loong64": "0.27.7", + "@esbuild/linux-mips64el": "0.27.7", + "@esbuild/linux-ppc64": "0.27.7", + "@esbuild/linux-riscv64": "0.27.7", + "@esbuild/linux-s390x": "0.27.7", + "@esbuild/linux-x64": "0.27.7", + "@esbuild/netbsd-arm64": "0.27.7", + "@esbuild/netbsd-x64": "0.27.7", + "@esbuild/openbsd-arm64": "0.27.7", + "@esbuild/openbsd-x64": "0.27.7", + "@esbuild/openharmony-arm64": "0.27.7", + "@esbuild/sunos-x64": "0.27.7", + "@esbuild/win32-arm64": "0.27.7", + "@esbuild/win32-ia32": "0.27.7", + "@esbuild/win32-x64": "0.27.7" } }, "node_modules/escalade": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/escape-goat": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-2.1.1.tgz", - "integrity": "sha512-8/uIhbG12Csjy2JEW7D9pHbreaVaS/OpN3ycnyvElTdwM5n6GY6W6e2IPemfvGZeUMqZ9A/3GqIZMgKnBhAw/Q==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-4.0.0.tgz", + "integrity": "sha512-2Sd4ShcWxbx6OY1IHyla/CVNwvg7XwZVoXZHcSu9w9SReNP1EzzD5T8NWKIR38fIqEns9kDWKUQTXXAmlDrdPg==", + "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/escape-string-regexp": { @@ -5326,6 +5807,7 @@ "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -5339,6 +5821,7 @@ "integrity": "sha512-ypowyDxpVSYpkXr9WPv2PAZCtNip1Mv5KTW0SCurXv/9iOpcrH9PaqUElksqEB6pChqHGDRCFTyrZlGhnLNGiA==", "deprecated": "This version is no longer supported. Please see https://eslint.org/version-support for other options.", "dev": true, + "license": "MIT", "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", @@ -5390,9 +5873,9 @@ } }, "node_modules/eslint-config-prettier": { - "version": "10.1.5", - "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-10.1.5.tgz", - "integrity": "sha512-zc1UmCpNltmVY34vuLRV61r1K27sWuX39E+uyUnY8xS2Bex88VV9cugG+UZbRSRGtGyFboj+D8JODyme1plMpw==", + "version": "10.1.8", + "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-10.1.8.tgz", + "integrity": "sha512-82GZUjRS0p/jganf6q1rEO25VSoHH0hKPCTrgillPjdI/3bgBhAE1QzHrHTizjpRvy6pGAvKjDJtk2pF9NDq8w==", "dev": true, "license": "MIT", "bin": { @@ -5410,6 +5893,7 @@ "resolved": "https://registry.npmjs.org/eslint-plugin-jsx-a11y/-/eslint-plugin-jsx-a11y-6.10.2.tgz", "integrity": "sha512-scB3nz4WmG75pV8+3eRUQOHZlNSUhFNq37xnpgRkCCELU3XMvXAxLk1eqWWyE22Ki4Q01Fnsw9BA3cJHDPgn2Q==", "dev": true, + "license": "MIT", "dependencies": { "aria-query": "^5.3.2", "array-includes": "^3.1.8", @@ -5439,25 +5923,28 @@ "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-5.3.2.tgz", "integrity": "sha512-COROpnaoap1E2F000S62r6A60uHZnmlvomhfyT2DlTcrY1OrBKn2UhH7qn5wTC9zMvD0AY7csdPSNwKP+7WiQw==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">= 0.4" } }, "node_modules/eslint-plugin-jsx-a11y/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.13.tgz", + "integrity": "sha512-9ZLprWS6EENmhEOpjCYW2c8VkmOvckIJZfkr7rBW6dObmfgJ/L1GpSYW5Hpo9lDz4D1+n0Ckz8rU7FwHDQiG/w==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "node_modules/eslint-plugin-jsx-a11y/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -5470,6 +5957,7 @@ "resolved": "https://registry.npmjs.org/eslint-plugin-react/-/eslint-plugin-react-7.37.5.tgz", "integrity": "sha512-Qteup0SqU15kdocexFNAJMvCJEfa2xUKNV4CC1xsVMrIIqEy3SQ/rqyxCWNzfrd3/ldy6HMlD2e0JDVpDg2qIA==", "dev": true, + "license": "MIT", "dependencies": { "array-includes": "^3.1.8", "array.prototype.findlast": "^1.2.5", @@ -5502,6 +5990,7 @@ "resolved": "https://registry.npmjs.org/eslint-plugin-react-hooks/-/eslint-plugin-react-hooks-5.2.0.tgz", "integrity": "sha512-+f15FfK64YQwZdJNELETdn5ibXEUQmW1DZL6KXhNnc2heoy/sg9VJJeT7n8TlMWouzWqSWavFkIhHyIbIAEapg==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -5510,19 +5999,21 @@ } }, "node_modules/eslint-plugin-react-refresh": { - "version": "0.4.20", - "resolved": "https://registry.npmjs.org/eslint-plugin-react-refresh/-/eslint-plugin-react-refresh-0.4.20.tgz", - "integrity": "sha512-XpbHQ2q5gUF8BGOX4dHe+71qoirYMhApEPZ7sfhF/dNnOF1UXnCMGZf79SFTBO7Bz5YEIT4TMieSlJBWhP9WBA==", + "version": "0.4.26", + "resolved": "https://registry.npmjs.org/eslint-plugin-react-refresh/-/eslint-plugin-react-refresh-0.4.26.tgz", + "integrity": "sha512-1RETEylht2O6FM/MvgnyvT+8K21wLqDNg4qD51Zj3guhjt433XbnnkVttHMyaVyAFD03QSV4LPS5iE3VQmO7XQ==", "dev": true, + "license": "MIT", "peerDependencies": { "eslint": ">=8.40" } }, "node_modules/eslint-plugin-react/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.13.tgz", + "integrity": "sha512-9ZLprWS6EENmhEOpjCYW2c8VkmOvckIJZfkr7rBW6dObmfgJ/L1GpSYW5Hpo9lDz4D1+n0Ckz8rU7FwHDQiG/w==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" @@ -5533,6 +6024,7 @@ "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-2.1.0.tgz", "integrity": "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw==", "dev": true, + "license": "Apache-2.0", "dependencies": { "esutils": "^2.0.2" }, @@ -5541,10 +6033,11 @@ } }, "node_modules/eslint-plugin-react/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -5557,6 +6050,7 @@ "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", "dev": true, + "license": "ISC", "bin": { "semver": "bin/semver.js" } @@ -5566,6 +6060,7 @@ "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-7.2.2.tgz", "integrity": "sha512-dOt21O7lTMhDM+X9mB4GX+DZrZtCUJPL/wlcTqxyrx5IvO0IYtILdtrQGQp+8n5S0gwSVmOf9NQrjMOgfQZlIg==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "esrecurse": "^4.3.0", "estraverse": "^5.2.0" @@ -5582,6 +6077,7 @@ "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-3.4.3.tgz", "integrity": "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag==", "dev": true, + "license": "Apache-2.0", "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" }, @@ -5590,35 +6086,22 @@ } }, "node_modules/eslint/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.13.tgz", + "integrity": "sha512-9ZLprWS6EENmhEOpjCYW2c8VkmOvckIJZfkr7rBW6dObmfgJ/L1GpSYW5Hpo9lDz4D1+n0Ckz8rU7FwHDQiG/w==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, - "node_modules/eslint/node_modules/globals": { - "version": "13.24.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", - "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", - "dev": true, - "dependencies": { - "type-fest": "^0.20.2" - }, - "engines": { - "node": ">=8" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/eslint/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -5626,23 +6109,12 @@ "node": "*" } }, - "node_modules/eslint/node_modules/type-fest": { - "version": "0.20.2", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", - "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", - "dev": true, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/espree": { "version": "9.6.1", "resolved": "https://registry.npmjs.org/espree/-/espree-9.6.1.tgz", "integrity": "sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "acorn": "^8.9.0", "acorn-jsx": "^5.3.2", @@ -5655,11 +6127,25 @@ "url": "https://opencollective.com/eslint" } }, + "node_modules/esprima": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/esprima/-/esprima-4.0.1.tgz", + "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", + "license": "BSD-2-Clause", + "bin": { + "esparse": "bin/esparse.js", + "esvalidate": "bin/esvalidate.js" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/esquery": { - "version": "1.6.0", - "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.6.0.tgz", - "integrity": "sha512-ca9pw9fomFcKPvFLXhBKUK90ZvGibiGOvRJNbjljY7s7uq/5YO4BOzcYtJqExdx99rF6aAcnRxHmcUHcz6sQsg==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.7.0.tgz", + "integrity": "sha512-Ap6G0WQwcU/LHsvLwON1fAQX9Zp0A2Y6Y/cJBl9r/JbW90Zyg4/zbG6zzKa2OTALELarYHmKu0GhpM5EO+7T0g==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "estraverse": "^5.1.0" }, @@ -5672,6 +6158,7 @@ "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", "dev": true, + "license": "BSD-2-Clause", "dependencies": { "estraverse": "^5.2.0" }, @@ -5684,6 +6171,7 @@ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=4.0" } @@ -5693,6 +6181,7 @@ "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-3.0.3.tgz", "integrity": "sha512-7RUKfXgSMMkzt6ZuXmqapOurLGPPfgj6l9uRZ7lRGolvk0y2yocc35LdcxKC5PQZdn2DMqioAQ2NoWcrTKmm6g==", "dev": true, + "license": "MIT", "dependencies": { "@types/estree": "^1.0.0" } @@ -5701,6 +6190,7 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz", "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==", + "license": "BSD-2-Clause", "engines": { "node": ">=0.10.0" } @@ -5708,18 +6198,21 @@ "node_modules/eventemitter3": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/eventemitter3/-/eventemitter3-3.1.2.tgz", - "integrity": "sha512-tvtQIeLVHjDkJYnzf2dgVMxfuSGJeM/7UCG17TT4EumTfNtF+0nebF/4zWOIkCreAbtNqhGEboB6BWrwqNaw4Q==" + "integrity": "sha512-tvtQIeLVHjDkJYnzf2dgVMxfuSGJeM/7UCG17TT4EumTfNtF+0nebF/4zWOIkCreAbtNqhGEboB6BWrwqNaw4Q==", + "license": "MIT" }, "node_modules/exenv": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/exenv/-/exenv-1.2.2.tgz", - "integrity": "sha512-Z+ktTxTwv9ILfgKCk32OX3n/doe+OcLTRtqK9pcL+JsP3J1/VW8Uvl4ZjLlKqeW4rzK4oesDOGMEMRIZqtP4Iw==" + "integrity": "sha512-Z+ktTxTwv9ILfgKCk32OX3n/doe+OcLTRtqK9pcL+JsP3J1/VW8Uvl4ZjLlKqeW4rzK4oesDOGMEMRIZqtP4Iw==", + "license": "BSD-3-Clause" }, "node_modules/expect-type": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.2.1.tgz", - "integrity": "sha512-/kP8CAwxzLVEeFrMm4kMmy4CCDlpipyA7MYLVrdJIkV0fYF0UaigQHRsxHiuY/GEea+bh4KSv3TIlgr+2UL6bw==", + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/expect-type/-/expect-type-1.3.0.tgz", + "integrity": "sha512-knvyeauYhqjOYvQ66MznSMs83wmHrCycNEN6Ao+2AeYEfxUIkuiVxdEa1qlGEPK+We3n0THiDciYSsCcgW/DoA==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=12.0.0" } @@ -5728,6 +6221,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==", + "license": "MIT", "dependencies": { "chardet": "^0.7.0", "iconv-lite": "^0.4.24", @@ -5741,6 +6235,7 @@ "version": "0.4.24", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "license": "MIT", "dependencies": { "safer-buffer": ">= 2.1.2 < 3" }, @@ -5751,13 +6246,15 @@ "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "license": "MIT" }, "node_modules/fast-glob": { "version": "3.3.3", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz", "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -5774,6 +6271,7 @@ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, + "license": "ISC", "dependencies": { "is-glob": "^4.0.1" }, @@ -5784,18 +6282,20 @@ "node_modules/fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", - "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==" + "integrity": "sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==", + "license": "MIT" }, "node_modules/fast-levenshtein": { "version": "2.0.6", "resolved": "https://registry.npmjs.org/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz", "integrity": "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/fast-uri": { - "version": "3.0.6", - "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.0.6.tgz", - "integrity": "sha512-Atfo14OibSv5wAp4VWNsFYE1AchQRTv9cBGWET4pZWHzYshFSS9NQI6I57rdKn9croWVMbYFbLhJ+yJvmZIIHw==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", "funding": [ { "type": "github", @@ -5805,13 +6305,15 @@ "type": "opencollective", "url": "https://opencollective.com/fastify" } - ] + ], + "license": "BSD-3-Clause" }, "node_modules/fastq": { - "version": "1.19.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz", - "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==", + "version": "1.20.1", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.20.1.tgz", + "integrity": "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw==", "dev": true, + "license": "ISC", "dependencies": { "reusify": "^1.0.4" } @@ -5820,6 +6322,7 @@ "version": "3.2.0", "resolved": "https://registry.npmjs.org/figures/-/figures-3.2.0.tgz", "integrity": "sha512-yaduQFRKLXYOGgEn6AZau90j3ggSOyiqXU0F9JZfeXYhNa+Jk4X+s45A2zg5jns87GAFa34BBm2kXw4XpNcbdg==", + "license": "MIT", "dependencies": { "escape-string-regexp": "^1.0.5" }, @@ -5834,6 +6337,7 @@ "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "license": "MIT", "engines": { "node": ">=0.8.0" } @@ -5843,6 +6347,7 @@ "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", "dev": true, + "license": "MIT", "dependencies": { "flat-cache": "^3.0.4" }, @@ -5854,6 +6359,7 @@ "version": "0.1.19", "resolved": "https://registry.npmjs.org/file-selector/-/file-selector-0.1.19.tgz", "integrity": "sha512-kCWw3+Aai8Uox+5tHCNgMFaUdgidxvMnLWO6fM5sZ0hA2wlHP5/DHGF0ECe84BiB95qdJbKNEJhWKVDvMN+JDQ==", + "license": "MIT", "dependencies": { "tslib": "^2.0.1" }, @@ -5862,17 +6368,19 @@ } }, "node_modules/filelist": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.4.tgz", - "integrity": "sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q==", + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/filelist/-/filelist-1.0.6.tgz", + "integrity": "sha512-5giy2PkLYY1cP39p17Ech+2xlpTRL9HLspOfEgm0L6CwBXBTgsK5ou0JtzYuepxkaQ/tvhCFIJ5uXo0OrM2DxA==", + "license": "Apache-2.0", "dependencies": { "minimatch": "^5.0.1" } }, "node_modules/filelist/node_modules/minimatch": { - "version": "5.1.6", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", - "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "version": "5.1.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.9.tgz", + "integrity": "sha512-7o1wEA2RyMP7Iu7GNba9vc0RWWGACJOCZBJX2GJWip0ikV+wcOsgVuY9uE8CPiyQhkGFSlhuSkZPavN7u1c2Fw==", + "license": "ISC", "dependencies": { "brace-expansion": "^2.0.1" }, @@ -5884,6 +6392,7 @@ "version": "7.1.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "license": "MIT", "dependencies": { "to-regex-range": "^5.0.1" }, @@ -5895,6 +6404,7 @@ "version": "4.20.10", "resolved": "https://registry.npmjs.org/final-form/-/final-form-4.20.10.tgz", "integrity": "sha512-TL48Pi1oNHeMOHrKv1bCJUrWZDcD3DIG6AGYVNOnyZPr7Bd/pStN0pL+lfzF5BNoj/FclaoiaLenk4XUIFVYng==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.10.0" }, @@ -5910,6 +6420,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/final-form-arrays/-/final-form-arrays-3.1.0.tgz", "integrity": "sha512-TWBvun+AopgBLw9zfTFHBllnKMVNEwCEyDawphPuBGGqNsuhGzhT7yewHys64KFFwzIs6KEteGLpKOwvTQEscQ==", + "license": "MIT", "peerDependencies": { "final-form": "^4.20.8" } @@ -5919,6 +6430,7 @@ "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", "integrity": "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==", "dev": true, + "license": "MIT", "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" @@ -5935,6 +6447,7 @@ "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.2.0.tgz", "integrity": "sha512-CYcENa+FtcUKLmhhqyctpclsq7QF38pKjZHsGNiSQF5r4FtoKDWabFDl3hzaEQMvT1LHEysw5twgLvpYYb4vbw==", "dev": true, + "license": "MIT", "dependencies": { "flatted": "^3.2.9", "keyv": "^4.5.3", @@ -5945,15 +6458,17 @@ } }, "node_modules/flatted": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", - "integrity": "sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==", - "dev": true + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.4.2.tgz", + "integrity": "sha512-PjDse7RzhcPkIJwy5t7KPWQSZ9cAbzQXcafsetQoD7sOJRQlGikNbx7yZp2OotDnJyrDcbyRq3Ttb18iYOqkxA==", + "dev": true, + "license": "ISC" }, "node_modules/for-each": { "version": "0.3.5", "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.5.tgz", "integrity": "sha512-dKx12eRCVIzqCxFGplyFKJMPvLEWgmNtUrpTiJIR5u97zEhRG8ySrtboPHZXx7daLxQVrl643cTzbab2tkQjxg==", + "license": "MIT", "dependencies": { "is-callable": "^1.2.7" }, @@ -5968,7 +6483,7 @@ "version": "3.3.1", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.1.tgz", "integrity": "sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw==", - "dev": true, + "license": "ISC", "dependencies": { "cross-spawn": "^7.0.6", "signal-exit": "^4.0.1" @@ -5984,7 +6499,7 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz", "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==", - "dev": true, + "license": "ISC", "engines": { "node": ">=14" }, @@ -5996,6 +6511,7 @@ "version": "9.1.0", "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz", "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==", + "license": "MIT", "dependencies": { "at-least-node": "^1.0.0", "graceful-fs": "^4.2.0", @@ -6009,13 +6525,16 @@ "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", - "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==" + "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", + "dev": true, + "license": "ISC" }, "node_modules/fsevents": { "version": "2.3.3", "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", "hasInstallScript": true, + "license": "MIT", "optional": true, "os": [ "darwin" @@ -6028,6 +6547,7 @@ "version": "1.1.2", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -6036,6 +6556,7 @@ "version": "1.1.8", "resolved": "https://registry.npmjs.org/function.prototype.name/-/function.prototype.name-1.1.8.tgz", "integrity": "sha512-e5iwyodOHhbMr/yNrc7fDYG4qlbIvI5gajyzPnb5TCwyhjApznQh1BMFou9b30SevY43gCJKXycoCBjMbsuW0Q==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -6055,22 +6576,46 @@ "version": "1.2.3", "resolved": "https://registry.npmjs.org/functions-have-names/-/functions-have-names-1.2.3.tgz", "integrity": "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ==", + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/generator-function": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/generator-function/-/generator-function-2.0.1.tgz", + "integrity": "sha512-SFdFmIJi+ybC0vjlHN0ZGVGHc3lgE0DxPAT0djjVg+kjOnSqclqmj0KQ7ykTOLP6YxoqOvuAODGdcHJn+43q3g==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + } + }, "node_modules/gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", "integrity": "sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==", + "license": "MIT", "engines": { "node": ">=6.9.0" } }, + "node_modules/get-east-asian-width": { + "version": "1.5.0", + "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.5.0.tgz", + "integrity": "sha512-CQ+bEO+Tva/qlmw24dCejulK5pMzVnUOFOijVogd3KQs07HnRIgp8TGipvCCRT06xeYEbpbgwaCxglFyiuIcmA==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/get-intrinsic": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.3.0.tgz", "integrity": "sha512-9fSjSaos/fRIVIp+xSJlE6lfwhES7LNtKaCBIamHsjr2na1BiABJPo0mOjjz8GJDURarmCPGqaiVg5mfjb98CQ==", + "license": "MIT", "dependencies": { "call-bind-apply-helpers": "^1.0.2", "es-define-property": "^1.0.1", @@ -6093,17 +6638,20 @@ "node_modules/get-node-dimensions": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/get-node-dimensions/-/get-node-dimensions-1.2.1.tgz", - "integrity": "sha512-2MSPMu7S1iOTL+BOa6K1S62hB2zUAYNF/lV0gSVlOaacd087lc6nR1H1r0e3B1CerTo+RceOmi1iJW+vp21xcQ==" + "integrity": "sha512-2MSPMu7S1iOTL+BOa6K1S62hB2zUAYNF/lV0gSVlOaacd087lc6nR1H1r0e3B1CerTo+RceOmi1iJW+vp21xcQ==", + "license": "MIT" }, "node_modules/get-own-enumerable-property-symbols": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz", - "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==" + "integrity": "sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==", + "license": "ISC" }, "node_modules/get-proto": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/get-proto/-/get-proto-1.0.1.tgz", "integrity": "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g==", + "license": "MIT", "dependencies": { "dunder-proto": "^1.0.1", "es-object-atoms": "^1.0.0" @@ -6112,21 +6660,11 @@ "node": ">= 0.4" } }, - "node_modules/get-stream": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "dependencies": { - "pump": "^3.0.0" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/get-symbol-description": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.1.0.tgz", "integrity": "sha512-w9UMqWwJxHNOvoNzSJ2oPF5wvYcvP7jUvYzhp67yEhTi17ZDBBC1z9pTdGuzjD+EFIqLSYRweZjqfiPzQ06Ebg==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -6143,7 +6681,9 @@ "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", - "deprecated": "Glob versions prior to v9 are no longer supported", + "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me", + "dev": true, + "license": "ISC", "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -6164,6 +6704,7 @@ "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-6.0.2.tgz", "integrity": "sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==", "dev": true, + "license": "ISC", "dependencies": { "is-glob": "^4.0.3" }, @@ -6172,18 +6713,22 @@ } }, "node_modules/glob/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "version": "1.1.13", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.13.tgz", + "integrity": "sha512-9ZLprWS6EENmhEOpjCYW2c8VkmOvckIJZfkr7rBW6dObmfgJ/L1GpSYW5Hpo9lDz4D1+n0Ckz8rU7FwHDQiG/w==", + "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "node_modules/glob/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", + "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^1.1.7" }, @@ -6191,12 +6736,29 @@ "node": "*" } }, - "node_modules/global-dirs": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-2.1.0.tgz", - "integrity": "sha512-MG6kdOUh/xBnyo9cJFeIKkLEc1AyFq42QTU4XiX51i2NEdxLxLWXIjEjmqKeSuKR7pAZjTqUVoT2b2huxVLgYQ==", + "node_modules/global-directory": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/global-directory/-/global-directory-4.0.1.tgz", + "integrity": "sha512-wHTUcDUoZ1H5/0iVqEudYW4/kAlN5cZ3j/bXn0Dpbizl9iaUVeWSHqiOjsgk6OW2bkLclbBjzewBz6weQ1zA2Q==", + "license": "MIT", "dependencies": { - "ini": "1.3.7" + "ini": "4.1.1" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/globals": { + "version": "13.24.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.24.0.tgz", + "integrity": "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "type-fest": "^0.20.2" }, "engines": { "node": ">=8" @@ -6205,18 +6767,11 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/globals": { - "version": "11.12.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-11.12.0.tgz", - "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", - "engines": { - "node": ">=4" - } - }, "node_modules/globalthis": { "version": "1.0.4", "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz", "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==", + "license": "MIT", "dependencies": { "define-properties": "^1.2.1", "gopd": "^1.0.1" @@ -6233,6 +6788,7 @@ "resolved": "https://registry.npmjs.org/globby/-/globby-11.1.0.tgz", "integrity": "sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==", "dev": true, + "license": "MIT", "dependencies": { "array-union": "^2.1.0", "dir-glob": "^3.0.1", @@ -6252,6 +6808,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6259,55 +6816,42 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/got": { - "version": "9.6.0", - "resolved": "https://registry.npmjs.org/got/-/got-9.6.0.tgz", - "integrity": "sha512-R7eWptXuGYxwijs0eV+v3o6+XH1IqVK8dJOEecQfTmkncw9AV4dcw/Dhxi8MdlqPthxxpZyizMzyg8RTmEsG+Q==", - "dependencies": { - "@sindresorhus/is": "^0.14.0", - "@szmarczak/http-timer": "^1.1.2", - "cacheable-request": "^6.0.0", - "decompress-response": "^3.3.0", - "duplexer3": "^0.1.4", - "get-stream": "^4.1.0", - "lowercase-keys": "^1.0.1", - "mimic-response": "^1.0.1", - "p-cancelable": "^1.0.0", - "to-readable-stream": "^1.0.0", - "url-parse-lax": "^3.0.0" - }, - "engines": { - "node": ">=8.6" - } - }, "node_modules/graceful-fs": { "version": "4.2.11", "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", - "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==" + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "license": "ISC" }, "node_modules/graphemer": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", "integrity": "sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/happy-dom": { - "version": "17.4.7", - "resolved": "https://registry.npmjs.org/happy-dom/-/happy-dom-17.4.7.tgz", - "integrity": "sha512-NZypxadhCiV5NT4A+Y86aQVVKQ05KDmueja3sz008uJfDRwz028wd0aTiJPwo4RQlvlz0fznkEEBBCHVNWc08g==", + "version": "20.8.9", + "resolved": "https://registry.npmjs.org/happy-dom/-/happy-dom-20.8.9.tgz", + "integrity": "sha512-Tz23LR9T9jOGVZm2x1EPdXqwA37G/owYMxRwU0E4miurAtFsPMQ1d2Jc2okUaSjZqAFz2oEn3FLXC5a0a+siyA==", "dev": true, + "license": "MIT", "dependencies": { - "webidl-conversions": "^7.0.0", - "whatwg-mimetype": "^3.0.0" + "@types/node": ">=20.0.0", + "@types/whatwg-mimetype": "^3.0.2", + "@types/ws": "^8.18.1", + "entities": "^7.0.1", + "whatwg-mimetype": "^3.0.0", + "ws": "^8.18.3" }, "engines": { - "node": ">=18.0.0" + "node": ">=20.0.0" } }, "node_modules/hard-rejection": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/hard-rejection/-/hard-rejection-2.1.0.tgz", "integrity": "sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==", + "license": "MIT", "engines": { "node": ">=6" } @@ -6316,6 +6860,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-bigints/-/has-bigints-1.1.0.tgz", "integrity": "sha512-R3pbpkcIqv2Pm3dUwgjclDRVmWpTJW2DcMzcIhEXEx1oh/CEMObMm3KLmRJOdvhM7o4uQBnwr8pzRK2sJWIqfg==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6327,6 +6872,7 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "license": "MIT", "engines": { "node": ">=8" } @@ -6335,6 +6881,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "license": "MIT", "dependencies": { "es-define-property": "^1.0.0" }, @@ -6346,6 +6893,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.2.0.tgz", "integrity": "sha512-KIL7eQPfHQRC8+XluaIw7BHUwwqL19bQn4hzNgdr+1wXoU0KKj6rufu47lhY7KbJR2C6T6+PfyN0Ea7wkSS+qQ==", + "license": "MIT", "dependencies": { "dunder-proto": "^1.0.0" }, @@ -6360,6 +6908,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz", "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6371,6 +6920,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", + "license": "MIT", "dependencies": { "has-symbols": "^1.0.3" }, @@ -6381,18 +6931,11 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/has-yarn": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/has-yarn/-/has-yarn-2.1.0.tgz", - "integrity": "sha512-UqBRqi4ju7T+TqGNdqAO0PaSVGsDGJUBQvk9eUWNGRY1CFGDzYhLWoM7JQEemnlvVcv/YEmc2wNW8BC24EnUsw==", - "engines": { - "node": ">=8" - } - }, "node_modules/hasown": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "license": "MIT", "dependencies": { "function-bind": "^1.1.2" }, @@ -6404,6 +6947,7 @@ "version": "4.10.1", "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz", "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.1.2", "loose-envify": "^1.2.0", @@ -6417,6 +6961,7 @@ "version": "3.3.2", "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz", "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==", + "license": "BSD-3-Clause", "dependencies": { "react-is": "^16.7.0" } @@ -6424,18 +6969,21 @@ "node_modules/hoist-non-react-statics/node_modules/react-is": { "version": "16.13.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "license": "MIT" }, "node_modules/hosted-git-info": { "version": "2.8.9", "resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz", - "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==" + "integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==", + "license": "ISC" }, "node_modules/html-encoding-sniffer": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/html-encoding-sniffer/-/html-encoding-sniffer-4.0.0.tgz", "integrity": "sha512-Y22oTqIU4uuPgEemfz7NDJz6OeKf12Lsu+QC+s3BVpda64lTiMYCyGwg5ki4vFxkMwQdeZDl2adZoqUgdFuTgQ==", "dev": true, + "license": "MIT", "dependencies": { "whatwg-encoding": "^3.1.1" }, @@ -6447,18 +6995,15 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.2.tgz", "integrity": "sha512-H2iMtd0I4Mt5eYiapRdIDjp+XzelXQ0tFE4JS7YFwFevXXMmOp9myNrUvCg0D6ws8iqkRPBfKHgbwig1SmlLfg==", - "dev": true - }, - "node_modules/http-cache-semantics": { - "version": "4.2.0", - "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.2.0.tgz", - "integrity": "sha512-dTxcvPXqPvXBQpq5dUr6mEMJX4oIEFv6bwom3FDwKRDsuIjjJGANqhBuoAn9c1RQJIdAKav33ED65E2ys+87QQ==" + "dev": true, + "license": "MIT" }, "node_modules/http-proxy-agent": { "version": "7.0.2", "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz", "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==", "dev": true, + "license": "MIT", "dependencies": { "agent-base": "^7.1.0", "debug": "^4.3.4" @@ -6472,6 +7017,7 @@ "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", "dev": true, + "license": "MIT", "dependencies": { "agent-base": "^7.1.2", "debug": "4" @@ -6483,13 +7029,15 @@ "node_modules/hyphenate-style-name": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/hyphenate-style-name/-/hyphenate-style-name-1.1.0.tgz", - "integrity": "sha512-WDC/ui2VVRrz3jOVi+XtjqkDjiVjTtFaAGiW37k6b+ohyQ5wYDOGkvCZa8+H0nx3gyvv0+BST9xuOgIyGQ00gw==" + "integrity": "sha512-WDC/ui2VVRrz3jOVi+XtjqkDjiVjTtFaAGiW37k6b+ohyQ5wYDOGkvCZa8+H0nx3gyvv0+BST9xuOgIyGQ00gw==", + "license": "BSD-3-Clause" }, "node_modules/iconv-lite": { "version": "0.6.3", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", "dev": true, + "license": "MIT", "dependencies": { "safer-buffer": ">= 2.1.2 < 3.0.0" }, @@ -6500,7 +7048,8 @@ "node_modules/idb": { "version": "7.1.1", "resolved": "https://registry.npmjs.org/idb/-/idb-7.1.1.tgz", - "integrity": "sha512-gchesWBzyvGHRO9W8tzUWFDycow5gwjvFKfyV9FF32Y7F50yZMp7mP+T2mJIWFx49zicqyC4uefHM17o6xKIVQ==" + "integrity": "sha512-gchesWBzyvGHRO9W8tzUWFDycow5gwjvFKfyV9FF32Y7F50yZMp7mP+T2mJIWFx49zicqyC4uefHM17o6xKIVQ==", + "license": "ISC" }, "node_modules/ieee754": { "version": "1.2.1", @@ -6519,21 +7068,24 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "BSD-3-Clause" }, "node_modules/ignore": { "version": "5.3.2", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, + "license": "MIT", "engines": { "node": ">= 4" } }, "node_modules/immutable": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/immutable/-/immutable-4.3.7.tgz", - "integrity": "sha512-1hqclzwYwjRDFLjcFxOM5AYkkG0rpFPpr1RLPMEuGczoS7YA8gLhy8SWXYRAA/XwfEHpfo3cw5JGioS32fnMRw==", + "version": "4.3.8", + "resolved": "https://registry.npmjs.org/immutable/-/immutable-4.3.8.tgz", + "integrity": "sha512-d/Ld9aLbKpNwyl0KiM2CT1WYvkitQ1TSvmRtkcV8FKStiDoA7Slzgjmb/1G2yhKM1p0XeNOieaTbFZmU1d3Xuw==", + "license": "MIT", "optional": true }, "node_modules/import-fresh": { @@ -6541,6 +7093,7 @@ "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz", "integrity": "sha512-TR3KfrTZTYLPB6jUjfx6MF9WcWrHL9su5TObK4ZkYgBdWKPOFoSoQIdEuTuR82pmtxH2spWG9h6etwfr1pLBqQ==", "dev": true, + "license": "MIT", "dependencies": { "parent-module": "^1.0.0", "resolve-from": "^4.0.0" @@ -6552,18 +7105,12 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/import-lazy": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-2.1.0.tgz", - "integrity": "sha512-m7ZEHgtw69qOGw+jwxXkHlrlIPdTGkyh66zXZ1ajZbxkDBNjSY/LGbmjc7h0s2ELsUDTAhFr55TrPSSqJGPG0A==", - "engines": { - "node": ">=4" - } - }, "node_modules/imurmurhash": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz", "integrity": "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==", + "dev": true, + "license": "MIT", "engines": { "node": ">=0.8.19" } @@ -6572,6 +7119,7 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "license": "MIT", "engines": { "node": ">=8" } @@ -6580,6 +7128,7 @@ "version": "3.0.2", "resolved": "https://registry.npmjs.org/inflection/-/inflection-3.0.2.tgz", "integrity": "sha512-+Bg3+kg+J6JUWn8J6bzFmOWkTQ6L/NHfDRSYU+EVvuKHDxUDHAXgqixHfVlzuBQaPOTac8hn43aPhMNk6rMe3g==", + "license": "MIT", "engines": { "node": ">=18.0.0" } @@ -6589,6 +7138,8 @@ "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", + "dev": true, + "license": "ISC", "dependencies": { "once": "^1.3.0", "wrappy": "1" @@ -6597,17 +7148,23 @@ "node_modules/inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "license": "ISC" }, "node_modules/ini": { - "version": "1.3.7", - "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.7.tgz", - "integrity": "sha512-iKpRpXP+CrP2jyrxvg1kMUpXDyRUFDWurxbnVT1vQPx+Wz9uCYsMIqYuSBLV+PAaZG/d7kRLKRFc9oDMsH+mFQ==" + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ini/-/ini-4.1.1.tgz", + "integrity": "sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==", + "license": "ISC", + "engines": { + "node": "^14.17.0 || ^16.13.0 || >=18.0.0" + } }, "node_modules/inquirer": { "version": "7.3.3", "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-7.3.3.tgz", "integrity": "sha512-JG3eIAj5V9CwcGvuOmoo6LB9kbAYT8HXffUl6memuszlwDC/qvFAJw49XJ5NROSFNPxp3iQg1GqkFhaY/CR0IA==", + "license": "MIT", "dependencies": { "ansi-escapes": "^4.2.1", "chalk": "^4.1.0", @@ -6631,6 +7188,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/internal-slot/-/internal-slot-1.1.0.tgz", "integrity": "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "hasown": "^2.0.2", @@ -6645,6 +7203,7 @@ "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.2.0.tgz", "integrity": "sha512-7bVbi0huj/wrIAOzb8U1aszg9kdi3KN/CyU19CTI7tAoZYEZoL9yCDXpbXN+uPsuWnP02cyug1gleqq+TU+YCA==", "dev": true, + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "has-tostringtag": "^1.0.2" @@ -6660,6 +7219,7 @@ "version": "3.0.5", "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.5.tgz", "integrity": "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -6675,12 +7235,14 @@ "node_modules/is-arrayish": { "version": "0.2.1", "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", - "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==" + "integrity": "sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==", + "license": "MIT" }, "node_modules/is-async-function": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-async-function/-/is-async-function-2.1.1.tgz", "integrity": "sha512-9dgM/cZBnNvjzaMYHVoxxfPj2QXt22Ev7SuuPrs+xav0ukGB0S6d4ydZdEiM48kLx5kDV+QBPrpVnFyefL8kkQ==", + "license": "MIT", "dependencies": { "async-function": "^1.0.0", "call-bound": "^1.0.3", @@ -6699,6 +7261,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/is-bigint/-/is-bigint-1.1.0.tgz", "integrity": "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ==", + "license": "MIT", "dependencies": { "has-bigints": "^1.0.2" }, @@ -6713,6 +7276,7 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/is-binary-path/-/is-binary-path-2.1.0.tgz", "integrity": "sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==", + "license": "MIT", "dependencies": { "binary-extensions": "^2.0.0" }, @@ -6724,6 +7288,7 @@ "version": "1.2.2", "resolved": "https://registry.npmjs.org/is-boolean-object/-/is-boolean-object-1.2.2.tgz", "integrity": "sha512-wa56o2/ElJMYqjCjGkXri7it5FbebW5usLw/nPmCMs5DeZ7eziSYZhSmPRn0txqeW4LnAmQQU7FgqLpsEFKM4A==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-tostringtag": "^1.0.2" @@ -6739,6 +7304,7 @@ "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6746,21 +7312,11 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-ci": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-ci/-/is-ci-2.0.0.tgz", - "integrity": "sha512-YfJT7rkpQB0updsdHLGWrvhBJfcfzNNawYDNIyQXJz0IViGf75O8EBPKSdvw2rF+LGCsX4FZ8tcr3b19LcZq4w==", - "dependencies": { - "ci-info": "^2.0.0" - }, - "bin": { - "is-ci": "bin.js" - } - }, "node_modules/is-core-module": { "version": "2.16.1", "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.16.1.tgz", "integrity": "sha512-UfoeMA6fIJ8wTYFEUjelnaGI67v6+N7qXJEvQuIGa99l4xsCruSYOVSQ0uPANn4dAzm8lkYPaKLrrijLq7x23w==", + "license": "MIT", "dependencies": { "hasown": "^2.0.2" }, @@ -6775,6 +7331,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/is-data-view/-/is-data-view-1.0.2.tgz", "integrity": "sha512-RKtWF8pGmS87i2D6gqQu/l7EYRlVdfzemCJN/P3UOs//x1QE7mfhvzHIApBTRf7axvT6DMGwSwBXYCT0nfB9xw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "get-intrinsic": "^1.2.6", @@ -6791,6 +7348,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.1.0.tgz", "integrity": "sha512-PwwhEakHVKTdRNVOw+/Gyh0+MzlCl4R6qKvkhuvLtPMggI1WAHt9sOwZxQLSGpUaDnrdyDsomoRgNnCfKNSXXg==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "has-tostringtag": "^1.0.2" @@ -6806,6 +7364,7 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -6814,6 +7373,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-finalizationregistry/-/is-finalizationregistry-1.1.1.tgz", "integrity": "sha512-1pC6N8qWJbWoPtEjgcL2xyhQOP491EQjeUo3qTKcmV8YSDDJrOepfG8pcC7h/QgnQHYSv0mJ3Z/ZWxmatVrysg==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3" }, @@ -6828,17 +7388,20 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/is-generator-function": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.1.0.tgz", - "integrity": "sha512-nPUB5km40q9e8UfN/Zc24eLlzdSf9OfKByBw9CIdw4H1giPMeA0OIJvbchsCu4npfI2QcMVBsGEBHKZ7wLTWmQ==", + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.1.2.tgz", + "integrity": "sha512-upqt1SkGkODW9tsGNG5mtXTXtECizwtS2kA161M+gJPc1xdb/Ax629af6YrTwcOeQHbewrPNlE5Dx7kzvXTizA==", + "license": "MIT", "dependencies": { - "call-bound": "^1.0.3", - "get-proto": "^1.0.0", + "call-bound": "^1.0.4", + "generator-function": "^2.0.0", + "get-proto": "^1.0.1", "has-tostringtag": "^1.0.2", "safe-regex-test": "^1.1.0" }, @@ -6853,6 +7416,7 @@ "version": "4.0.3", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "license": "MIT", "dependencies": { "is-extglob": "^2.1.1" }, @@ -6863,18 +7427,47 @@ "node_modules/is-in-browser": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/is-in-browser/-/is-in-browser-1.1.3.tgz", - "integrity": "sha512-FeXIBgG/CPGd/WUxuEyvgGTEfwiG9Z4EKGxjNMRqviiIIfsmgrpnHLffEDdwUHqNva1VEW91o3xBT/m8Elgl9g==" + "integrity": "sha512-FeXIBgG/CPGd/WUxuEyvgGTEfwiG9Z4EKGxjNMRqviiIIfsmgrpnHLffEDdwUHqNva1VEW91o3xBT/m8Elgl9g==", + "license": "MIT" }, - "node_modules/is-installed-globally": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-0.3.2.tgz", - "integrity": "sha512-wZ8x1js7Ia0kecP/CHM/3ABkAmujX7WPvQk6uu3Fly/Mk44pySulQpnHG46OMjHGXApINnV4QhY3SWnECO2z5g==", - "dependencies": { - "global-dirs": "^2.0.1", - "is-path-inside": "^3.0.1" + "node_modules/is-in-ci": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-in-ci/-/is-in-ci-1.0.0.tgz", + "integrity": "sha512-eUuAjybVTHMYWm/U+vBO1sY/JOCgoPCXRxzdju0K+K0BiGW0SChEL1MLC0PoCIR1OlPo5YAp8HuQoUlsWEICwg==", + "license": "MIT", + "bin": { + "is-in-ci": "cli.js" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-installed-globally": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/is-installed-globally/-/is-installed-globally-1.0.0.tgz", + "integrity": "sha512-K55T22lfpQ63N4KEN57jZUAaAYqYHEe8veb/TycJRk9DdSCLLcovXz/mL6mOnhQaZsQGwPhuFopdQIlqGSEjiQ==", + "license": "MIT", + "dependencies": { + "global-directory": "^4.0.1", + "is-path-inside": "^4.0.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/is-installed-globally/node_modules/is-path-inside": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-4.0.0.tgz", + "integrity": "sha512-lJJV/5dYS+RcL8uQdBDW9c9uWFLLBNRyFhnAKXw5tVqLlKZ4RMGZKv+YQ/IA3OhD+RpbJa1LLFM1FQPGyIXvOA==", + "license": "MIT", + "engines": { + "node": ">=12" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" @@ -6884,6 +7477,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", "integrity": "sha512-2HvIEKRoqS62guEC+qBjpvRubdX910WCMuJTZ+I9yvqKU2/12eSL549HMwtabb4oupdj2sMP50k+XJfB/8JE6w==", + "license": "MIT", "engines": { "node": ">=8" } @@ -6892,6 +7486,7 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/is-map/-/is-map-2.0.3.tgz", "integrity": "sha512-1Qed0/Hr2m+YqxnM09CjA2d/i6YZNfF6R2oRAOj36eUdS6qIV/huPJNSEpKbupewFs+ZsJlxsjjPbc0/afW6Lw==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -6902,25 +7497,44 @@ "node_modules/is-mobile": { "version": "2.2.2", "resolved": "https://registry.npmjs.org/is-mobile/-/is-mobile-2.2.2.tgz", - "integrity": "sha512-wW/SXnYJkTjs++tVK5b6kVITZpAZPtUrt9SF80vvxGiF/Oywal+COk1jlRkiVq15RFNEQKQY31TkV24/1T5cVg==" + "integrity": "sha512-wW/SXnYJkTjs++tVK5b6kVITZpAZPtUrt9SF80vvxGiF/Oywal+COk1jlRkiVq15RFNEQKQY31TkV24/1T5cVg==", + "license": "MIT" }, "node_modules/is-module": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-module/-/is-module-1.0.0.tgz", - "integrity": "sha512-51ypPSPCoTEIN9dy5Oy+h4pShgJmPCygKfyRCISBI+JoWT/2oJvK8QPxmwv7b/p239jXrm9M1mlQbyKJ5A152g==" + "integrity": "sha512-51ypPSPCoTEIN9dy5Oy+h4pShgJmPCygKfyRCISBI+JoWT/2oJvK8QPxmwv7b/p239jXrm9M1mlQbyKJ5A152g==", + "license": "MIT" + }, + "node_modules/is-negative-zero": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", + "integrity": "sha512-5KoIu2Ngpyek75jXodFvnafB6DJgr3u8uuK0LEZJjrU19DrMD3EVERaR8sjz8CCGgpZvxPl9SuE1GMVPFHx1mw==", + "license": "MIT", + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/is-npm": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-4.0.0.tgz", - "integrity": "sha512-96ECIfh9xtDDlPylNPXhzjsykHsMJZ18ASpaWzQyBr4YRTcVjUvzaHayDAES2oU/3KpljhHUjtSRNiDwi0F0ig==", + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/is-npm/-/is-npm-6.1.0.tgz", + "integrity": "sha512-O2z4/kNgyjhQwVR1Wpkbfc19JIhggF97NZNCpWTnjH7kVcZMUrnut9XSN7txI7VdyIYk5ZatOq3zvSuWpU8hoA==", + "license": "MIT", "engines": { - "node": ">=8" + "node": "^12.20.0 || ^14.13.1 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/is-number": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "license": "MIT", "engines": { "node": ">=0.12.0" } @@ -6929,6 +7543,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.1.1.tgz", "integrity": "sha512-lZhclumE1G6VYD8VHe35wFaIif+CTy5SJIi5+3y4psDgWu4wPDoBhF8NxUOinEc7pHgiTsT6MaBb92rKhhD+Xw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-tostringtag": "^1.0.2" @@ -6944,6 +7559,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz", "integrity": "sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -6952,6 +7568,8 @@ "version": "3.0.3", "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz", "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==", + "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -6960,6 +7578,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/is-plain-obj/-/is-plain-obj-1.1.0.tgz", "integrity": "sha512-yvkRyxmFKEOQ4pNXCmJG5AEQNlXJS5LaONXo5/cLdTZdWvsZ1ioJEonLGAosKlMWE8lwUy/bJzMjcw8az73+Fg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -6968,12 +7587,14 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/is-potential-custom-element-name/-/is-potential-custom-element-name-1.0.1.tgz", "integrity": "sha512-bCYeRA2rVibKZd+s2625gGnGF/t7DSqDs4dP7CrLA1m7jKWz6pps0LpYLJN8Q64HtmPKJ1hrN3nzPNKFEKOUiQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/is-regex": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.2.1.tgz", "integrity": "sha512-MjYsKHO5O7mCsmRGxWcLWheFqN9DJ/2TmngvjKXihe6efViPqc274+Fx/4fYj/r03+ESvBdTXK0V6tA3rgez1g==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "gopd": "^1.2.0", @@ -6991,6 +7612,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-regexp/-/is-regexp-1.0.0.tgz", "integrity": "sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -6999,6 +7621,7 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/is-set/-/is-set-2.0.3.tgz", "integrity": "sha512-iPAjerrse27/ygGLxw+EBR9agv9Y6uLeYVJMu+QNCoouJ1/1ri0mGrcWpfCqFZuzzx3WjtwxG098X+n4OuRkPg==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -7010,6 +7633,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/is-shared-array-buffer/-/is-shared-array-buffer-1.0.4.tgz", "integrity": "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3" }, @@ -7024,6 +7648,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "license": "MIT", "engines": { "node": ">=8" }, @@ -7035,6 +7660,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.1.1.tgz", "integrity": "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-tostringtag": "^1.0.2" @@ -7050,6 +7676,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.1.1.tgz", "integrity": "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "has-symbols": "^1.1.0", @@ -7066,6 +7693,7 @@ "version": "1.1.15", "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.15.tgz", "integrity": "sha512-p3EcsicXjit7SaskXHs1hA91QxgTw46Fv6EFKKGS5DRFLD8yKnohjF3hxoju94b/OcMZoQukzpPpBE9uLVKzgQ==", + "license": "MIT", "dependencies": { "which-typed-array": "^1.1.16" }, @@ -7076,15 +7704,11 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-typedarray": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-typedarray/-/is-typedarray-1.0.0.tgz", - "integrity": "sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==" - }, "node_modules/is-unicode-supported": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", "integrity": "sha512-knxG2q4UC3u8stRGyAVJCOdxFmv5DZiRcdlIaAQXAbSfJya+OhopNotLQrstBhququ4ZpuKbDc/8S6mgXgPFPw==", + "license": "MIT", "engines": { "node": ">=10" }, @@ -7096,6 +7720,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/is-weakmap/-/is-weakmap-2.0.2.tgz", "integrity": "sha512-K5pXYOm9wqY1RgjpL3YTkF39tni1XajUIkawTLUo9EZEVUFga5gSQJF8nNS7ZwJQ02y+1YCNYcMh+HIf1ZqE+w==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -7107,6 +7732,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/is-weakref/-/is-weakref-1.1.1.tgz", "integrity": "sha512-6i9mGWSlqzNMEqpCp93KwRS1uUOodk2OJ6b+sq7ZPDSy2WuI5NFIxp/254TytR8ftefexkWn5xNiHUNpPOfSew==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3" }, @@ -7121,6 +7747,7 @@ "version": "2.0.4", "resolved": "https://registry.npmjs.org/is-weakset/-/is-weakset-2.0.4.tgz", "integrity": "sha512-mfcwb6IzQyOKTs84CQMrOwW4gQcaTOAWJ0zzJCl2WSPDrWk/OzDaImWFH3djXhb24g4eudZfLRozAvPGw4d9hQ==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "get-intrinsic": "^1.2.6" @@ -7132,27 +7759,24 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/is-yarn-global": { - "version": "0.3.0", - "resolved": "https://registry.npmjs.org/is-yarn-global/-/is-yarn-global-0.3.0.tgz", - "integrity": "sha512-VjSeb/lHmkoyd8ryPVIKvOCn4D1koMqY+vqyjjUfc3xyKtP4dYOxM44sZrnqQSzSds3xyOrUTLTC9LVCVgLngw==" - }, "node_modules/isarray": { "version": "0.0.1", "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==" + "integrity": "sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==", + "license": "MIT" }, "node_modules/isexe": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz", "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==", - "dev": true + "license": "ISC" }, "node_modules/istanbul-lib-coverage": { "version": "3.2.2", "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.2.2.tgz", "integrity": "sha512-O8dpsF+r0WV/8MNRKfnmrtCWhuKjxrq2w+jpzBL5UZKTi2LeVWnWOmWRxFlesJONmc+wLAGvKQZEOanko0LFTg==", "dev": true, + "license": "BSD-3-Clause", "engines": { "node": ">=8" } @@ -7162,6 +7786,7 @@ "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.1.tgz", "integrity": "sha512-GCfE1mtsHGOELCU8e/Z7YWzpmybrx/+dSTfLrvY8qRmaY6zXTKWn6WQIjaAFw069icm6GVMNkgu0NzI4iPZUNw==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "istanbul-lib-coverage": "^3.0.0", "make-dir": "^4.0.0", @@ -7171,25 +7796,12 @@ "node": ">=10" } }, - "node_modules/istanbul-lib-source-maps": { - "version": "5.0.6", - "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-5.0.6.tgz", - "integrity": "sha512-yg2d+Em4KizZC5niWhQaIomgf5WlL4vOOjZ5xGCmF8SnPE/mDWWXgvRExdcpCgh9lLRRa1/fSYp2ymmbJ1pI+A==", - "dev": true, - "dependencies": { - "@jridgewell/trace-mapping": "^0.3.23", - "debug": "^4.1.1", - "istanbul-lib-coverage": "^3.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/istanbul-reports": { - "version": "3.1.7", - "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.1.7.tgz", - "integrity": "sha512-BewmUXImeuRk2YY0PVbxgKAysvhRPUQE0h5QRM++nVWyubKGV0l8qQ5op8+B2DOmwSe63Jivj0BjkPQVf8fP5g==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.2.0.tgz", + "integrity": "sha512-HGYWWS/ehqTV3xN10i23tkPkpH46MLCIMFNCaaKNavAXTF1RkqxawEPtnjnGZ6XKSInBKkiOA5BKS+aZiY3AvA==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "html-escaper": "^2.0.0", "istanbul-lib-report": "^3.0.0" @@ -7203,6 +7815,7 @@ "resolved": "https://registry.npmjs.org/iterator.prototype/-/iterator.prototype-1.1.5.tgz", "integrity": "sha512-H0dkQoCa3b2VEeKQBOxFph+JAbcrQdE7KC0UkqwpLmv2EC4P41QXP+rqo9wYodACiG5/WM5s9oDApTU8utwj9g==", "dev": true, + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-object-atoms": "^1.0.0", @@ -7216,29 +7829,29 @@ } }, "node_modules/jackspeak": { - "version": "3.4.3", - "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-3.4.3.tgz", - "integrity": "sha512-OGlZQpz2yfahA/Rd1Y8Cd9SIEsqvXkLVoSw/cgwhnhFMDbsQFeZYoJJ7bIZBS9BcamUW96asq/npPWugM+RQBw==", - "dev": true, + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-4.2.3.tgz", + "integrity": "sha512-ykkVRwrYvFm1nb2AJfKKYPr0emF6IiXDYUaFx4Zn9ZuIH7MrzEZ3sD5RlqGXNRpHtvUHJyOnCEFxOlNDtGo7wg==", + "license": "BlueOak-1.0.0", "dependencies": { - "@isaacs/cliui": "^8.0.2" + "@isaacs/cliui": "^9.0.0" + }, + "engines": { + "node": "20 || >=22" }, "funding": { "url": "https://github.com/sponsors/isaacs" - }, - "optionalDependencies": { - "@pkgjs/parseargs": "^0.11.0" } }, "node_modules/jake": { - "version": "10.9.2", - "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.2.tgz", - "integrity": "sha512-2P4SQ0HrLQ+fw6llpLnOaGAvN2Zu6778SJMrCUwns4fOoG9ayrTiZk3VV8sCPkVZF8ab0zksVpS8FDY5pRCNBA==", + "version": "10.9.4", + "resolved": "https://registry.npmjs.org/jake/-/jake-10.9.4.tgz", + "integrity": "sha512-wpHYzhxiVQL+IV05BLE2Xn34zW1S223hvjtqk0+gsPrwd/8JNLXJgZZM/iPFsYc1xyphF+6M6EvdE5E9MBGkDA==", + "license": "Apache-2.0", "dependencies": { - "async": "^3.2.3", - "chalk": "^4.0.2", + "async": "^3.2.6", "filelist": "^1.0.4", - "minimatch": "^3.1.2" + "picocolors": "^1.1.1" }, "bin": { "jake": "bin/cli.js" @@ -7247,36 +7860,18 @@ "node": ">=10" } }, - "node_modules/jake/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, - "node_modules/jake/node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", - "dependencies": { - "brace-expansion": "^1.1.7" - }, - "engines": { - "node": "*" - } - }, "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "license": "MIT" }, "node_modules/js-yaml": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", - "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz", + "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==", "dev": true, + "license": "MIT", "dependencies": { "argparse": "^2.0.1" }, @@ -7289,6 +7884,7 @@ "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-26.1.0.tgz", "integrity": "sha512-Cvc9WUhxSMEo4McES3P7oK3QaXldCfNWp7pl2NNeiIFlCoLr3kfq9kb1fxftiwk1FLV7CvpvDfonxtzUDeSOPg==", "dev": true, + "license": "MIT", "dependencies": { "cssstyle": "^4.2.1", "data-urls": "^5.0.0", @@ -7328,6 +7924,7 @@ "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz", "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==", "dev": true, + "license": "MIT", "engines": { "node": ">=18" } @@ -7336,6 +7933,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.1.0.tgz", "integrity": "sha512-/sM3dO2FOzXjKQhJuo0Q173wf2KOo8t4I8vHy6lF9poUp7bKT0/NHE8fPX23PwfhnykfqnC2xRxOnVw5XuGIaA==", + "license": "MIT", "bin": { "jsesc": "bin/jsesc" }, @@ -7347,34 +7945,67 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/json-buffer/-/json-buffer-3.0.1.tgz", "integrity": "sha512-4bV5BfR2mqfQTJm+V5tPPdf+ZpuhiIvTuAB5g8kcrXOZpTT/QwwVRWBywX1ozr6lEuPdbHxwaJlm9G6mI2sfSQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/json-parse-even-better-errors": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", - "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==" + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "license": "MIT" }, - "node_modules/json-schema": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/json-schema/-/json-schema-0.4.0.tgz", - "integrity": "sha512-es94M3nTIfsEPisRafak+HDLfHXnKBhV3vU5eqPcS3flIWqcxJWgXHXiey3YrpaNsanY5ei1VoYEbOzijuq9BA==" + "node_modules/json-schema-ref-parser": { + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/json-schema-ref-parser/-/json-schema-ref-parser-7.1.3.tgz", + "integrity": "sha512-/Lmyl0PW27dOmCO03PI339+1gs4Z2PlqIyUgzIOtoRp08zkkMCB30TRbdppbPO7WWzZX0uT98HqkDiZSujkmbA==", + "deprecated": "Please switch to @apidevtools/json-schema-ref-parser", + "license": "MIT", + "dependencies": { + "call-me-maybe": "^1.0.1", + "js-yaml": "^3.13.1", + "ono": "^6.0.0" + } + }, + "node_modules/json-schema-ref-parser/node_modules/argparse": { + "version": "1.0.10", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", + "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", + "license": "MIT", + "dependencies": { + "sprintf-js": "~1.0.2" + } + }, + "node_modules/json-schema-ref-parser/node_modules/js-yaml": { + "version": "3.14.2", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz", + "integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==", + "license": "MIT", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } }, "node_modules/json-schema-traverse": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true + "license": "MIT" }, "node_modules/json-stable-stringify-without-jsonify": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/json-stable-stringify-without-jsonify/-/json-stable-stringify-without-jsonify-1.0.1.tgz", "integrity": "sha512-Bdboy+l7tA3OGW6FjyFHWkP5LuByj1Tk33Ljyq0axyzdk9//JSi2u3fP1QSmd1KNwq6VOKYGlAu87CisVir6Pw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/json5": { "version": "2.2.3", "resolved": "https://registry.npmjs.org/json5/-/json5-2.2.3.tgz", "integrity": "sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==", + "license": "MIT", "bin": { "json5": "lib/cli.js" }, @@ -7386,14 +8017,16 @@ "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsonexport/-/jsonexport-2.5.2.tgz", "integrity": "sha512-4joNLCxxUAmS22GN3GA5os/MYFnq8oqXOKvoCymmcT0MPz/QPZ5eA+Fh5sIPxUji45RKq8DdQ1yoKq91p4E9VA==", + "license": "Apache-2.0", "bin": { "jsonexport": "bin/jsonexport.js" } }, "node_modules/jsonfile": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", - "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", + "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", + "license": "MIT", "dependencies": { "universalify": "^2.0.0" }, @@ -7405,6 +8038,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/jsonpointer/-/jsonpointer-5.0.1.tgz", "integrity": "sha512-p/nXbhSEcu3pZRdkW1OfJhpsVtW1gd4Wa1fnQc9YLiTfAjn0312eMKimbdIQzuZl9aa9xUGaRlP9T/CJE/ditQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -7413,6 +8047,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss/-/jss-10.10.0.tgz", "integrity": "sha512-cqsOTS7jqPsPMjtKYDUpdFC0AbhYFLTcuGRqymgmdJIeQ8cH7+AgX7YSgQy79wXloZq2VvATYxUOUQEvS1V/Zw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "csstype": "^3.0.2", @@ -7428,6 +8063,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss-plugin-camel-case/-/jss-plugin-camel-case-10.10.0.tgz", "integrity": "sha512-z+HETfj5IYgFxh1wJnUAU8jByI48ED+v0fuTuhKrPR+pRBYS2EDwbusU8aFOpCdYhtRc9zhN+PJ7iNE8pAWyPw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "hyphenate-style-name": "^1.0.3", @@ -7438,6 +8074,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss-plugin-default-unit/-/jss-plugin-default-unit-10.10.0.tgz", "integrity": "sha512-SvpajxIECi4JDUbGLefvNckmI+c2VWmP43qnEy/0eiwzRUsafg5DVSIWSzZe4d2vFX1u9nRDP46WCFV/PXVBGQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0" @@ -7447,6 +8084,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss-plugin-global/-/jss-plugin-global-10.10.0.tgz", "integrity": "sha512-icXEYbMufiNuWfuazLeN+BNJO16Ge88OcXU5ZDC2vLqElmMybA31Wi7lZ3lf+vgufRocvPj8443irhYRgWxP+A==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0" @@ -7456,6 +8094,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss-plugin-nested/-/jss-plugin-nested-10.10.0.tgz", "integrity": "sha512-9R4JHxxGgiZhurDo3q7LdIiDEgtA1bTGzAbhSPyIOWb7ZubrjQe8acwhEQ6OEKydzpl8XHMtTnEwHXCARLYqYA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0", @@ -7466,6 +8105,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss-plugin-props-sort/-/jss-plugin-props-sort-10.10.0.tgz", "integrity": "sha512-5VNJvQJbnq/vRfje6uZLe/FyaOpzP/IH1LP+0fr88QamVrGJa0hpRRyAa0ea4U/3LcorJfBFVyC4yN2QC73lJg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0" @@ -7475,6 +8115,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss-plugin-rule-value-function/-/jss-plugin-rule-value-function-10.10.0.tgz", "integrity": "sha512-uEFJFgaCtkXeIPgki8ICw3Y7VMkL9GEan6SqmT9tqpwM+/t+hxfMUdU4wQ0MtOiMNWhwnckBV0IebrKcZM9C0g==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "jss": "10.10.0", @@ -7485,6 +8126,7 @@ "version": "10.10.0", "resolved": "https://registry.npmjs.org/jss-plugin-vendor-prefixer/-/jss-plugin-vendor-prefixer-10.10.0.tgz", "integrity": "sha512-UY/41WumgjW8r1qMCO8l1ARg7NHnfRVWRhZ2E2m0DMYsr2DD91qIXLyNhiX83hHswR7Wm4D+oDYNC1zWCJWtqg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.3.1", "css-vendor": "^2.0.8", @@ -7492,15 +8134,17 @@ } }, "node_modules/jss/node_modules/csstype": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.1.3.tgz", - "integrity": "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==" + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "license": "MIT" }, "node_modules/jsx-ast-utils": { "version": "3.3.5", "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.5.tgz", "integrity": "sha512-ZZow9HBI5O6EPgSJLUb8n2NKgmVWTwCvHGwFuJlMjvLFqlGG6pjirPhtdsseaLZjSibD8eegzmYpUZwoIlj2cQ==", "dev": true, + "license": "MIT", "dependencies": { "array-includes": "^3.1.6", "array.prototype.flat": "^1.3.1", @@ -7515,6 +8159,7 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/jwt-decode/-/jwt-decode-4.0.0.tgz", "integrity": "sha512-+KJGIyHgkGuIq3IEBNftfhW/LfWhXUIY6OmyVWjliu5KH1y0fw7VQ8YndE2O4qZdMSd9SqbnC8GOcZEy0Om7sA==", + "license": "MIT", "engines": { "node": ">=18" } @@ -7524,6 +8169,7 @@ "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", "dev": true, + "license": "MIT", "dependencies": { "json-buffer": "3.0.1" } @@ -7532,21 +8178,36 @@ "version": "6.0.3", "resolved": "https://registry.npmjs.org/kind-of/-/kind-of-6.0.3.tgz", "integrity": "sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, + "node_modules/ky": { + "version": "1.14.3", + "resolved": "https://registry.npmjs.org/ky/-/ky-1.14.3.tgz", + "integrity": "sha512-9zy9lkjac+TR1c2tG+mkNSVlyOpInnWdSMiue4F+kq8TwJSgv6o8jhLRg8Ho6SnZ9wOYUq/yozts9qQCfk7bIw==", + "license": "MIT", + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sindresorhus/ky?sponsor=1" + } + }, "node_modules/language-subtag-registry": { "version": "0.3.23", "resolved": "https://registry.npmjs.org/language-subtag-registry/-/language-subtag-registry-0.3.23.tgz", "integrity": "sha512-0K65Lea881pHotoGEa5gDlMxt3pctLi2RplBb7Ezh4rRdLEOtgi7n4EwK9lamnUCkKBqaeKRVebTq6BAxSkpXQ==", - "dev": true + "dev": true, + "license": "CC0-1.0" }, "node_modules/language-tags": { "version": "1.0.9", "resolved": "https://registry.npmjs.org/language-tags/-/language-tags-1.0.9.tgz", "integrity": "sha512-MbjN408fEndfiQXbFQ1vnd+1NoLDsnQW41410oQBXiyXDMYH5z505juWa4KUE1LqxRC7DgOgZDbKLxHIwm27hA==", "dev": true, + "license": "MIT", "dependencies": { "language-subtag-registry": "^0.3.20" }, @@ -7555,20 +8216,25 @@ } }, "node_modules/latest-version": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-5.1.0.tgz", - "integrity": "sha512-weT+r0kTkRQdCdYCNtkMwWXQTMEswKrFBkm4ckQOMVhhqhIMI1UT2hMj+1iigIhgSZm5gTmrRXBNoGUgaTY1xA==", + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/latest-version/-/latest-version-9.0.0.tgz", + "integrity": "sha512-7W0vV3rqv5tokqkBAFV1LbR7HPOWzXQDpDgEuib/aJ1jsZZx6x3c2mBI+TJhJzOhkGeaLbCKEHXEXLfirtG2JA==", + "license": "MIT", "dependencies": { - "package-json": "^6.3.0" + "package-json": "^10.0.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", "integrity": "sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==", + "license": "MIT", "engines": { "node": ">=6" } @@ -7578,6 +8244,7 @@ "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", "dev": true, + "license": "MIT", "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" @@ -7589,13 +8256,15 @@ "node_modules/lines-and-columns": { "version": "1.2.4", "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.2.4.tgz", - "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==" + "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", + "license": "MIT" }, "node_modules/locate-path": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-6.0.0.tgz", "integrity": "sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==", "dev": true, + "license": "MIT", "dependencies": { "p-locate": "^5.0.0" }, @@ -7607,40 +8276,47 @@ } }, "node_modules/lodash": { - "version": "4.17.21", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + "version": "4.18.1", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz", + "integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==", + "license": "MIT" }, "node_modules/lodash.debounce": { "version": "4.0.8", "resolved": "https://registry.npmjs.org/lodash.debounce/-/lodash.debounce-4.0.8.tgz", - "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==" + "integrity": "sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==", + "license": "MIT" }, "node_modules/lodash.isequalwith": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.isequalwith/-/lodash.isequalwith-4.4.0.tgz", - "integrity": "sha512-dcZON0IalGBpRmJBmMkaoV7d3I80R2O+FrzsZyHdNSFrANq/cgDqKQNmAHE8UEj4+QYWwwhkQOVdLHiAopzlsQ==" + "integrity": "sha512-dcZON0IalGBpRmJBmMkaoV7d3I80R2O+FrzsZyHdNSFrANq/cgDqKQNmAHE8UEj4+QYWwwhkQOVdLHiAopzlsQ==", + "license": "MIT" }, "node_modules/lodash.merge": { "version": "4.6.2", "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/lodash.sortby": { "version": "4.7.0", "resolved": "https://registry.npmjs.org/lodash.sortby/-/lodash.sortby-4.7.0.tgz", - "integrity": "sha512-HDWXG8isMntAyRF5vZ7xKuEvOhT4AhlRt/3czTSjvGUxjYCBVRQY48ViDHyfYz9VIoBkW4TMGQNapx+l3RUwdA==" + "integrity": "sha512-HDWXG8isMntAyRF5vZ7xKuEvOhT4AhlRt/3czTSjvGUxjYCBVRQY48ViDHyfYz9VIoBkW4TMGQNapx+l3RUwdA==", + "license": "MIT" }, "node_modules/lodash.throttle": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/lodash.throttle/-/lodash.throttle-4.1.1.tgz", - "integrity": "sha512-wIkUCfVKpVsWo3JSZlc+8MB5it+2AN5W8J7YVMST30UrvcQNZ1Okbj+rbVniijTWE6FGYy4XJq/rHkas8qJMLQ==" + "integrity": "sha512-wIkUCfVKpVsWo3JSZlc+8MB5it+2AN5W8J7YVMST30UrvcQNZ1Okbj+rbVniijTWE6FGYy4XJq/rHkas8qJMLQ==", + "license": "MIT" }, "node_modules/log-symbols": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", "integrity": "sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==", + "license": "MIT", "dependencies": { "chalk": "^4.1.0", "is-unicode-supported": "^0.1.0" @@ -7656,6 +8332,7 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", "integrity": "sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==", + "license": "MIT", "dependencies": { "js-tokens": "^3.0.0 || ^4.0.0" }, @@ -7663,24 +8340,11 @@ "loose-envify": "cli.js" } }, - "node_modules/loupe": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/loupe/-/loupe-3.1.3.tgz", - "integrity": "sha512-kkIp7XSkP78ZxJEsSxW3712C6teJVoeHHwgo9zJ380de7IYyJ2ISlxojcH2pC5OFLewESmnRi/+XCDIEEVyoug==", - "dev": true - }, - "node_modules/lowercase-keys": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/lowercase-keys/-/lowercase-keys-1.0.1.tgz", - "integrity": "sha512-G2Lj61tXDnVFFOi8VZds+SoQjtQC3dgokKdDG2mTm1tx4m50NUHBOZSBwQQHyy0V12A0JTG4icfZQH+xPyh8VA==", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/lru-cache": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", "integrity": "sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==", + "license": "ISC", "dependencies": { "yallist": "^3.0.2" } @@ -7690,28 +8354,31 @@ "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.5.0.tgz", "integrity": "sha512-h5bgJWpxJNswbU7qCrV0tIKQCaS3blPDrqKWx+QxzuzL1zGUzij9XCWLrSLsJPu5t+eWA/ycetzYAO5IOMcWAQ==", "dev": true, + "license": "MIT", "bin": { "lz-string": "bin/bin.js" } }, "node_modules/magic-string": { - "version": "0.30.17", - "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.17.tgz", - "integrity": "sha512-sNPKHvyjVf7gyjwS4xGTaW/mCnF8wnjtifKBEhxfZ7E/S8tQ0rssrwGNn6q8JH/ohItJfSQp9mBtQYuTlH5QnA==", + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", "dev": true, + "license": "MIT", "dependencies": { - "@jridgewell/sourcemap-codec": "^1.5.0" + "@jridgewell/sourcemap-codec": "^1.5.5" } }, "node_modules/magicast": { - "version": "0.3.5", - "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.3.5.tgz", - "integrity": "sha512-L0WhttDl+2BOsybvEOLK7fW3UA0OQ0IQ2d6Zl2x/a6vVRs3bAY0ECOSHHeL5jD+SbOpOCUEi0y1DgHEn9Qn1AQ==", + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/magicast/-/magicast-0.5.2.tgz", + "integrity": "sha512-E3ZJh4J3S9KfwdjZhe2afj6R9lGIN5Pher1pF39UGrXRqq/VDaGVIGN13BjHd2u8B61hArAGOnso7nBOouW3TQ==", "dev": true, + "license": "MIT", "dependencies": { - "@babel/parser": "^7.25.4", - "@babel/types": "^7.25.4", - "source-map-js": "^1.2.0" + "@babel/parser": "^7.29.0", + "@babel/types": "^7.29.0", + "source-map-js": "^1.2.1" } }, "node_modules/make-dir": { @@ -7719,6 +8386,7 @@ "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-4.0.0.tgz", "integrity": "sha512-hXdUTZYIVOt1Ex//jAQi+wTZZpUpwBj/0QsOzqegb3rGMMeJiSEu5xLHnYfBrRV4RH2+OCSOO95Is/7x1WJ4bw==", "dev": true, + "license": "MIT", "dependencies": { "semver": "^7.5.3" }, @@ -7733,6 +8401,7 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/map-obj/-/map-obj-4.3.0.tgz", "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", + "license": "MIT", "engines": { "node": ">=8" }, @@ -7744,6 +8413,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/math-intrinsics/-/math-intrinsics-1.1.0.tgz", "integrity": "sha512-/IXtbwEk5HTPyEwyKX6hGkYXxM9nbj64B+ilVJnC/R6B0pH5G4V3b0pVbL7DBj4tkhBAppbQUlf6F6Xl9LHu1g==", + "license": "MIT", "engines": { "node": ">= 0.4" } @@ -7752,6 +8422,7 @@ "version": "7.1.1", "resolved": "https://registry.npmjs.org/meow/-/meow-7.1.1.tgz", "integrity": "sha512-GWHvA5QOcS412WCo8vwKDlTelGLsCGBVevQB5Kva961rmNfun0PCbv5+xta2kUMFJyR8/oWnn7ddeKdosbAPbA==", + "license": "MIT", "dependencies": { "@types/minimist": "^1.2.0", "camelcase-keys": "^6.2.2", @@ -7776,6 +8447,7 @@ "version": "0.13.1", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.13.1.tgz", "integrity": "sha512-34R7HTnG0XIJcBSn5XhDd7nNFPRcXYRZrBB2O2jdKqYODldSzBAqzsWoZYYvduky73toYS/ESqxPvkDf/F0XMg==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" }, @@ -7788,6 +8460,7 @@ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", "dev": true, + "license": "MIT", "engines": { "node": ">= 8" } @@ -7797,6 +8470,7 @@ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, + "license": "MIT", "dependencies": { "braces": "^3.0.3", "picomatch": "^2.3.1" @@ -7809,22 +8483,16 @@ "version": "2.1.0", "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz", "integrity": "sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==", + "license": "MIT", "engines": { "node": ">=6" } }, - "node_modules/mimic-response": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-1.0.1.tgz", - "integrity": "sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==", - "engines": { - "node": ">=4" - } - }, "node_modules/min-indent": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz", "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==", + "license": "MIT", "engines": { "node": ">=4" } @@ -7834,6 +8502,7 @@ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^2.0.1" }, @@ -7848,6 +8517,7 @@ "version": "1.2.8", "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz", "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==", + "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -7856,6 +8526,7 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/minimist-options/-/minimist-options-4.1.0.tgz", "integrity": "sha512-Q4r8ghd80yhO/0j1O3B2BjweX3fiHg9cdOwjJd2J76Q135c+NDxGCqdYKQ1SKBuFfgWbAUzBfvYjPUEeNgqN1A==", + "license": "MIT", "dependencies": { "arrify": "^1.0.1", "is-plain-obj": "^1.1.0", @@ -7866,23 +8537,34 @@ } }, "node_modules/minipass": { - "version": "7.1.2", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", - "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", - "dev": true, + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.3.tgz", + "integrity": "sha512-tEBHqDnIoM/1rXME1zgka9g6Q2lcoCkxHLuc7ODJ5BxbP5d4c2Z5cGgtXAku59200Cx7diuHTOYfSBD8n6mm8A==", + "license": "BlueOak-1.0.0", "engines": { "node": ">=16 || 14 >=14.17" } }, + "node_modules/moment": { + "version": "2.30.1", + "resolved": "https://registry.npmjs.org/moment/-/moment-2.30.1.tgz", + "integrity": "sha512-uEmtNhbDOrWPFS+hdjFCBfy9f2YoyzRpwcl+DqpC6taX21FzsTLQVbMV/W7PzNSX6x/bhC1zA3c2UQ5NzH6how==", + "license": "MIT", + "engines": { + "node": "*" + } + }, "node_modules/ms": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "license": "MIT" }, "node_modules/mute-stream": { "version": "0.0.8", "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-0.0.8.tgz", - "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==" + "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", + "license": "ISC" }, "node_modules/nanoid": { "version": "3.3.11", @@ -7895,6 +8577,7 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "bin": { "nanoid": "bin/nanoid.cjs" }, @@ -7906,12 +8589,14 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/natural-compare/-/natural-compare-1.4.0.tgz", "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/navidrome-music-player": { - "version": "4.25.1", - "resolved": "https://registry.npmjs.org/navidrome-music-player/-/navidrome-music-player-4.25.1.tgz", - "integrity": "sha512-bHYr84ATUf/4+/PUoTpUSmpF4/igBx2UPhgnPqvda4FND+GJZtb1ikbMs1U+mhkNEUebe+2I29ob1zY7YZdtjg==", + "version": "4.25.2", + "resolved": "https://registry.npmjs.org/navidrome-music-player/-/navidrome-music-player-4.25.2.tgz", + "integrity": "sha512-k7RXHOOKHeJRCsfmpmQ+TkErndckFfvYMjzwVAKZvViw2PL9ubKWziPfruHZVQr4FiJd2oYKEuTNiWZgAK87CA==", + "license": "MIT", "dependencies": { "@react-icons/all-files": "^4.1.0", "classnames": "^2.3.1", @@ -7928,10 +8613,40 @@ "react-dom": ">=16.9.0" } }, + "node_modules/node-exports-info": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/node-exports-info/-/node-exports-info-1.6.0.tgz", + "integrity": "sha512-pyFS63ptit/P5WqUkt+UUfe+4oevH+bFeIiPPdfb0pFeYEu/1ELnJu5l+5EcTKYL5M7zaAa7S8ddywgXypqKCw==", + "dev": true, + "license": "MIT", + "dependencies": { + "array.prototype.flatmap": "^1.3.3", + "es-errors": "^1.3.0", + "object.entries": "^1.1.9", + "semver": "^6.3.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/node-exports-info/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + } + }, "node_modules/node-polyglot": { "version": "2.6.0", "resolved": "https://registry.npmjs.org/node-polyglot/-/node-polyglot-2.6.0.tgz", "integrity": "sha512-ZZFkaYzIfGfBvSM6QhA9dM8EEaUJOVewzGSRcXWbJELXDj0lajAtKaENCYxvF5yE+TgHg6NQb0CmgYMsMdcNJQ==", + "license": "BSD-2-Clause", "dependencies": { "hasown": "^2.0.2", "object.entries": "^1.1.8", @@ -7942,14 +8657,16 @@ } }, "node_modules/node-releases": { - "version": "2.0.19", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.19.tgz", - "integrity": "sha512-xxOWJsBKtzAq7DY0J+DTzuz58K8e7sJbdgwkbMWQe8UYB6ekmsQ45q0M/tJDsGaZmbC+l7n57UV8Hl5tHxO9uw==" + "version": "2.0.37", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.37.tgz", + "integrity": "sha512-1h5gKZCF+pO/o3Iqt5Jp7wc9rH3eJJ0+nh/CIoiRwjRxde/hAHyLPXYN4V3CqKAbiZPSeJFSWHmJsbkicta0Eg==", + "license": "MIT" }, "node_modules/normalize-package-data": { "version": "2.5.0", "resolved": "https://registry.npmjs.org/normalize-package-data/-/normalize-package-data-2.5.0.tgz", "integrity": "sha512-/5CMN3T0R4XTj4DcGaexo+roZSdSFW/0AOOTROrjxzCG1wrWXEsGbRKevjlIL+ZDE4sZlJr5ED4YW0yqmkK+eA==", + "license": "BSD-2-Clause", "dependencies": { "hosted-git-info": "^2.1.4", "resolve": "^1.10.0", @@ -7958,11 +8675,12 @@ } }, "node_modules/normalize-package-data/node_modules/resolve": { - "version": "1.22.10", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.10.tgz", - "integrity": "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w==", + "version": "1.22.11", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.11.tgz", + "integrity": "sha512-RfqAvLnMl313r7c9oclB1HhUEAezcpLjz95wFH4LVuhk9JF/r22qmVP9AMmOU4vMX7Q8pN8jwNg/CSpdFnMjTQ==", + "license": "MIT", "dependencies": { - "is-core-module": "^2.16.0", + "is-core-module": "^2.16.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -7980,6 +8698,7 @@ "version": "5.7.2", "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "license": "ISC", "bin": { "semver": "bin/semver" } @@ -7988,36 +8707,41 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, - "node_modules/normalize-url": { - "version": "4.5.1", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-4.5.1.tgz", - "integrity": "sha512-9UZCFRHQdNrfTpGg8+1INIg93B6zE0aXMVFkw1WFwvO4SlZywU6aLg5Of0Ap/PgcbSw4LNxvMWXMeugwMCX0AA==", - "engines": { - "node": ">=8" - } - }, "node_modules/nwsapi": { - "version": "2.2.20", - "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.20.tgz", - "integrity": "sha512-/ieB+mDe4MrrKMT8z+mQL8klXydZWGR5Dowt4RAGKbJ3kIGEx3X4ljUo+6V73IXtUPWgfOlU5B9MlGxFO5T+cA==", - "dev": true + "version": "2.2.23", + "resolved": "https://registry.npmjs.org/nwsapi/-/nwsapi-2.2.23.tgz", + "integrity": "sha512-7wfH4sLbt4M0gCDzGE6vzQBo0bfTKjU7Sfpqy/7gs1qBfYz2vEJH6vXcBKpO3+6Yu1telwd0t9HpyOoLEQQbIQ==", + "dev": true, + "license": "MIT" }, "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", "integrity": "sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==", + "license": "MIT", "engines": { "node": ">=0.10.0" } }, + "node_modules/object-hash": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-2.2.0.tgz", + "integrity": "sha512-gScRMn0bS5fH+IuwyIFgnh9zBdo4DV+6GhygmWM9HyNJSgS0hScp1f5vjtm7oIIOiT9trXrShAkLFSc2IqKNgw==", + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, "node_modules/object-inspect": { "version": "1.13.4", "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.4.tgz", "integrity": "sha512-W67iLl4J2EXEGTbfeHCffrjDfitvLANg0UlX3wFUUSTx92KXRFegMHUVgSqE+wvhAbi4WqjGg9czysTV2Epbew==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -8030,6 +8754,7 @@ "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1" @@ -8045,6 +8770,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "license": "MIT", "engines": { "node": ">= 0.4" } @@ -8053,6 +8779,7 @@ "version": "4.1.7", "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.7.tgz", "integrity": "sha512-nK28WOo+QIjBkDduTINE4JkF/UJJKyf2EJxvJKfblDpyg0Q+pkOHNTL0Qwy6NP6FhE/EnzV73BxxqcJaXY9anw==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -8072,6 +8799,7 @@ "version": "1.1.9", "resolved": "https://registry.npmjs.org/object.entries/-/object.entries-1.1.9.tgz", "integrity": "sha512-8u/hfXFRBD1O0hPUjioLhoWFHRmt6tKA4/vZPyckBr18l1KE9uHrFaFaUi8MDRTpi4uak2goyPTSNJLXX2k2Hw==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.4", @@ -8087,6 +8815,7 @@ "resolved": "https://registry.npmjs.org/object.fromentries/-/object.fromentries-2.0.8.tgz", "integrity": "sha512-k6E21FzySsSK5a21KRADBd/NGneRegFO5pLHfdQLpRDETUNJueLXs3WCzyQ3tFRDYgbq3KHGXfTbi2bs8WQ6rQ==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -8105,6 +8834,7 @@ "resolved": "https://registry.npmjs.org/object.values/-/object.values-1.2.1.tgz", "integrity": "sha512-gXah6aZrcUxjWg2zR2MwouP2eHlCBzdV4pygudehaKXSGW4v2AsRQUK+lwwXhii6KFZcunEnmSUoYp5CXibxtA==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -8118,10 +8848,23 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/obug": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/obug/-/obug-2.1.1.tgz", + "integrity": "sha512-uTqF9MuPraAQ+IsnPf366RG4cP9RtUi7MLO1N3KEc+wb0a6yKpeL0lmk2IB1jY5KHPAlTc6T/JRdC/YqxHNwkQ==", + "dev": true, + "funding": [ + "https://github.com/sponsors/sxzz", + "https://opencollective.com/debug" + ], + "license": "MIT" + }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==", + "dev": true, + "license": "ISC", "dependencies": { "wrappy": "1" } @@ -8130,6 +8873,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz", "integrity": "sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==", + "license": "MIT", "dependencies": { "mimic-fn": "^2.1.0" }, @@ -8140,11 +8884,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/ono": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/ono/-/ono-6.0.1.tgz", + "integrity": "sha512-5rdYW/106kHqLeG22GE2MHKq+FlsxMERZev9DCzQX1zwkxnFwBivSn5i17a5O/rDmOJOdf4Wyt80UZljzx9+DA==", + "license": "MIT" + }, "node_modules/optionator": { "version": "0.9.4", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.4.tgz", "integrity": "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g==", "dev": true, + "license": "MIT", "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", @@ -8161,6 +8912,7 @@ "version": "5.4.1", "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", + "license": "MIT", "dependencies": { "bl": "^4.1.0", "chalk": "^4.1.0", @@ -8183,6 +8935,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz", "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -8191,6 +8944,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/own-keys/-/own-keys-1.0.1.tgz", "integrity": "sha512-qFOyK5PjiWZd+QQIh+1jhdb9LpxTF0qs7Pm8o5QHYZ0M3vKqSqzsZaEB6oWlxZ+q2sJBMI/Ktgd2N5ZwQoRHfg==", + "license": "MIT", "dependencies": { "get-intrinsic": "^1.2.6", "object-keys": "^1.1.1", @@ -8203,19 +8957,12 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/p-cancelable": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/p-cancelable/-/p-cancelable-1.1.0.tgz", - "integrity": "sha512-s73XxOZ4zpt1edZYZzvhqFa6uvQc1vwUa0K0BdtIZgQMAJj9IbebH+JkgKZc9h+B05PKHLOTl4ajG1BmNrVZlw==", - "engines": { - "node": ">=6" - } - }, "node_modules/p-limit": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-3.1.0.tgz", "integrity": "sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==", "dev": true, + "license": "MIT", "dependencies": { "yocto-queue": "^0.1.0" }, @@ -8231,6 +8978,7 @@ "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-5.0.0.tgz", "integrity": "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==", "dev": true, + "license": "MIT", "dependencies": { "p-limit": "^3.0.2" }, @@ -8245,43 +8993,41 @@ "version": "2.2.0", "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/package-json": { - "version": "6.5.0", - "resolved": "https://registry.npmjs.org/package-json/-/package-json-6.5.0.tgz", - "integrity": "sha512-k3bdm2n25tkyxcjSKzB5x8kfVxlMdgsbPr0GkZcwHsLpba6cBjqCt1KlcChKEvxHIcTB1FVMuwoijZ26xex5MQ==", + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/package-json/-/package-json-10.0.1.tgz", + "integrity": "sha512-ua1L4OgXSBdsu1FPb7F3tYH0F48a6kxvod4pLUlGY9COeJAJQNX/sNH2IiEmsxw7lqYiAwrdHMjz1FctOsyDQg==", + "license": "MIT", "dependencies": { - "got": "^9.6.0", - "registry-auth-token": "^4.0.0", - "registry-url": "^5.0.0", - "semver": "^6.2.0" + "ky": "^1.2.0", + "registry-auth-token": "^5.0.2", + "registry-url": "^6.0.1", + "semver": "^7.6.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/package-json-from-dist": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", - "dev": true - }, - "node_modules/package-json/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "bin": { - "semver": "bin/semver.js" - } + "license": "BlueOak-1.0.0" }, "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", "dev": true, + "license": "MIT", "dependencies": { "callsites": "^3.0.0" }, @@ -8293,6 +9039,7 @@ "version": "5.2.0", "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.2.0.tgz", "integrity": "sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==", + "license": "MIT", "dependencies": { "@babel/code-frame": "^7.0.0", "error-ex": "^1.3.1", @@ -8311,6 +9058,7 @@ "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz", "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==", "dev": true, + "license": "MIT", "dependencies": { "entities": "^6.0.0" }, @@ -8318,10 +9066,24 @@ "url": "https://github.com/inikulin/parse5?sponsor=1" } }, + "node_modules/parse5/node_modules/entities": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.1.tgz", + "integrity": "sha512-aN97NXWF6AWBTahfVOIrB/NShkzi5H7F9r1s9mD3cDj4Ko5f2qhhVoYMibXF7GlLveb/D2ioWay8lxI97Ven3g==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "license": "MIT", "engines": { "node": ">=8" } @@ -8330,6 +9092,8 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==", + "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -8338,7 +9102,7 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", - "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -8346,34 +9110,39 @@ "node_modules/path-parse": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz", - "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==" + "integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==", + "license": "MIT" }, "node_modules/path-scurry": { - "version": "1.11.1", - "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.11.1.tgz", - "integrity": "sha512-Xa4Nw17FS9ApQFJ9umLiJS4orGjm7ZzwUrwamcGQuHSzDyth9boKDaycYdDcZDuqYATXw4HFXgaqWTctW/v1HA==", - "dev": true, + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.2.tgz", + "integrity": "sha512-3O/iVVsJAPsOnpwWIeD+d6z/7PmqApyQePUtCndjatj/9I5LylHvt5qluFaBT3I5h3r1ejfR056c+FCv+NnNXg==", + "license": "BlueOak-1.0.0", "dependencies": { - "lru-cache": "^10.2.0", - "minipass": "^5.0.0 || ^6.0.2 || ^7.0.0" + "lru-cache": "^11.0.0", + "minipass": "^7.1.2" }, "engines": { - "node": ">=16 || 14 >=14.18" + "node": "18 || 20 || >=22" }, "funding": { "url": "https://github.com/sponsors/isaacs" } }, "node_modules/path-scurry/node_modules/lru-cache": { - "version": "10.4.3", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.4.3.tgz", - "integrity": "sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==", - "dev": true + "version": "11.2.7", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.2.7.tgz", + "integrity": "sha512-aY/R+aEsRelme17KGQa/1ZSIpLpNYYrhcrepKTZgE+W3WM16YMCaPwOHLHsmopZHELU0Ojin1lPVxKR0MihncA==", + "license": "BlueOak-1.0.0", + "engines": { + "node": "20 || >=22" + } }, "node_modules/path-to-regexp": { "version": "1.9.0", "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.9.0.tgz", "integrity": "sha512-xIp7/apCFJuUHdDLWe8O1HIkb0kQrOMb/0u6FXQjemHn/ii5LrIzU6bdECnsiTF/GjZkMEKg1xdiZwNqDYlZ6g==", + "license": "MIT", "dependencies": { "isarray": "0.0.1" } @@ -8383,6 +9152,7 @@ "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -8391,26 +9161,20 @@ "version": "2.0.3", "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz", "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==", - "dev": true - }, - "node_modules/pathval": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/pathval/-/pathval-2.0.0.tgz", - "integrity": "sha512-vE7JKRyES09KiunauX7nd2Q9/L7lhok4smP9RZTDeD4MVs72Dp2qNFVz39Nz5a0FVEW0BJR6C0DYrq6unoziZA==", "dev": true, - "engines": { - "node": ">= 14.16" - } + "license": "MIT" }, "node_modules/picocolors": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", - "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==" + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "license": "ISC" }, "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "version": "2.3.2", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.2.tgz", + "integrity": "sha512-V7+vQEJ06Z+c5tSye8S+nHUfI51xoXIXjHQ99cQtKUkQqqO1kO/KCJUfZXuB47h/YBlDhah2H3hdUGXn8ie0oA==", + "license": "MIT", "engines": { "node": ">=8.6" }, @@ -8421,20 +9185,22 @@ "node_modules/popper.js": { "version": "1.16.1-lts", "resolved": "https://registry.npmjs.org/popper.js/-/popper.js-1.16.1-lts.tgz", - "integrity": "sha512-Kjw8nKRl1m+VrSFCoVGPph93W/qrSO7ZkqPpTf7F4bk/sqcfWK019dWBUpE/fBOsOQY1dks/Bmcbfn1heM/IsA==" + "integrity": "sha512-Kjw8nKRl1m+VrSFCoVGPph93W/qrSO7ZkqPpTf7F4bk/sqcfWK019dWBUpE/fBOsOQY1dks/Bmcbfn1heM/IsA==", + "license": "MIT" }, "node_modules/possible-typed-array-names": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.1.0.tgz", "integrity": "sha512-/+5VFTchJDoVj3bhoqi6UeymcD00DAwb1nJwamzPvHEszJ4FpF6SNNbUbOS8yI56qHzdV8eK0qEfOSiodkTdxg==", + "license": "MIT", "engines": { "node": ">= 0.4" } }, "node_modules/postcss": { - "version": "8.5.3", - "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.3.tgz", - "integrity": "sha512-dle9A3yYxlBSrt8Fu+IpjGT8SY8hN0mlaA6GY8t0P5PjIOZemULz/E2Bnm/2dcUOena75OTNkHI76uZBNUUq3A==", + "version": "8.5.8", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", + "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", "dev": true, "funding": [ { @@ -8450,8 +9216,9 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "dependencies": { - "nanoid": "^3.3.8", + "nanoid": "^3.3.11", "picocolors": "^1.1.1", "source-map-js": "^1.2.1" }, @@ -8464,23 +9231,17 @@ "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", "dev": true, + "license": "MIT", "engines": { "node": ">= 0.8.0" } }, - "node_modules/prepend-http": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/prepend-http/-/prepend-http-2.0.0.tgz", - "integrity": "sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA==", - "engines": { - "node": ">=4" - } - }, "node_modules/prettier": { - "version": "3.5.3", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz", - "integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==", + "version": "3.8.1", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.8.1.tgz", + "integrity": "sha512-UOnG6LftzbdaHZcKoPFtOcCKztrQ57WkHDeRD9t/PTQtmT0NHSeWWepj6pS0z/N7+08BHFDQVUrfmfMRcZwbMg==", "dev": true, + "license": "MIT", "bin": { "prettier": "bin/prettier.cjs" }, @@ -8496,6 +9257,7 @@ "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-6.1.1.tgz", "integrity": "sha512-mQUvGU6aUFQ+rNvTIAcZuWGRT9a6f6Yrg9bHs4ImKF+HZCEK+plBvnAZYSIQztknZF2qnzNtr6F8s0+IuptdlQ==", "dev": true, + "license": "MIT", "engines": { "node": "^14.13.1 || >=16.0.0" }, @@ -8508,6 +9270,7 @@ "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-27.5.1.tgz", "integrity": "sha512-Qb1gy5OrP5+zDf2Bvnzdl3jsTf1qXVMazbvCoKhtKqVs4/YK4ozX4gKQJJVyNe+cajNPn0KoC0MC3FUmaHWEmQ==", "dev": true, + "license": "MIT", "dependencies": { "ansi-regex": "^5.0.1", "ansi-styles": "^5.0.0", @@ -8522,6 +9285,7 @@ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-5.2.0.tgz", "integrity": "sha512-Cxwpt2SfTzTtXcfOlzGEee8O+c+MmUgGrNiBcXnuWxuFJHe6a5Hz7qwhwe5OgaSYI0IJvkLqWX1ASG+cJOkEiA==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, @@ -8533,6 +9297,7 @@ "version": "15.8.1", "resolved": "https://registry.npmjs.org/prop-types/-/prop-types-15.8.1.tgz", "integrity": "sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==", + "license": "MIT", "dependencies": { "loose-envify": "^1.4.0", "object-assign": "^4.1.1", @@ -8542,40 +9307,44 @@ "node_modules/prop-types/node_modules/react-is": { "version": "16.13.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "license": "MIT" }, - "node_modules/pump": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.2.tgz", - "integrity": "sha512-tUPXtzlGM8FE3P0ZL6DVs/3P58k9nk8/jZeQCurTJylQA8qFYzHFfhBJkuqyE0FifOsQ0uKWekiZ5g8wtr28cw==", - "dependencies": { - "end-of-stream": "^1.1.0", - "once": "^1.3.1" - } + "node_modules/proto-list": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.4.tgz", + "integrity": "sha512-vtK/94akxsTMhe0/cbfpR+syPuszcuwhqVjJq26CuNDgFGj682oRBXOP5MJpv2r7JtE8MsiepGIqvvOTBwn2vA==", + "license": "ISC" }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", + "license": "MIT", "engines": { "node": ">=6" } }, "node_modules/pupa": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/pupa/-/pupa-2.1.1.tgz", - "integrity": "sha512-l1jNAspIBSFqbT+y+5FosojNpVpF94nlI+wDUpqP9enwOTfHx9f0gh5nB96vl+6yTpsJsypeNrwfzPrKuHB41A==", + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/pupa/-/pupa-3.3.0.tgz", + "integrity": "sha512-LjgDO2zPtoXP2wJpDjZrGdojii1uqO0cnwKoIoUzkfS98HDmbeiGmYiXo3lXeFlq2xvne1QFQhwYXSUCLKtEuA==", + "license": "MIT", "dependencies": { - "escape-goat": "^2.0.0" + "escape-goat": "^4.0.0" }, "engines": { - "node": ">=8" + "node": ">=12.20" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/query-string": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/query-string/-/query-string-5.1.1.tgz", "integrity": "sha512-gjWOsm2SoGlgLEdAGt7a6slVOk9mGiXmPFMqrEhLQ68rhQuBnpfs3+EmlvqKyxnCo9/PPlF+9MtY02S1aFg+Jw==", + "license": "MIT", "dependencies": { "decode-uri-component": "^0.2.0", "object-assign": "^4.1.0", @@ -8603,12 +9372,14 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/quick-lru": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-4.0.1.tgz", "integrity": "sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g==", + "license": "MIT", "engines": { "node": ">=8" } @@ -8617,6 +9388,7 @@ "version": "3.19.12", "resolved": "https://registry.npmjs.org/ra-core/-/ra-core-3.19.12.tgz", "integrity": "sha512-E0cM6OjEUtccaR+dR5mL1MLiVVYML0Yf7aPhpLEq4iue73X3+CKcLztInoBhWgeevPbFQwgAtsXhlpedeyrNNg==", + "license": "MIT", "dependencies": { "classnames": "~2.3.1", "date-fns": "^1.29.0", @@ -8644,7 +9416,8 @@ "node_modules/ra-core/node_modules/classnames": { "version": "2.3.3", "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.3.3.tgz", - "integrity": "sha512-1inzZmicIFcmUya7PGtUQeXtcF7zZpPnxtQoYOrz0uiOBGlLFa4ik4361seYL2JCcRDIyfdFHiwQolESFlw+Og==" + "integrity": "sha512-1inzZmicIFcmUya7PGtUQeXtcF7zZpPnxtQoYOrz0uiOBGlLFa4ik4361seYL2JCcRDIyfdFHiwQolESFlw+Og==", + "license": "MIT" }, "node_modules/ra-core/node_modules/inflection": { "version": "1.13.4", @@ -8652,12 +9425,20 @@ "integrity": "sha512-6I/HUDeYFfuNCVS3td055BaXBwKYuzw7K3ExVMStBowKo9oOAMJIXIHvdyR3iboTCp1b+1i5DSkIZTcwIktuDw==", "engines": [ "node >= 0.4.0" - ] + ], + "license": "MIT" + }, + "node_modules/ra-core/node_modules/lodash": { + "version": "4.17.23", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", + "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", + "license": "MIT" }, "node_modules/ra-data-json-server": { "version": "3.19.12", "resolved": "https://registry.npmjs.org/ra-data-json-server/-/ra-data-json-server-3.19.12.tgz", "integrity": "sha512-SEa0ueZd9LUG6iuPnHd+MHWf7BTgLKjx3Eky16VvTsqf6ueHkMU8AZiH1pHzrdxV6ku5VL34MCYWVSIbm2iDnw==", + "license": "MIT", "dependencies": { "query-string": "^5.1.1", "ra-core": "^3.19.12" @@ -8667,6 +9448,7 @@ "version": "3.19.12", "resolved": "https://registry.npmjs.org/ra-i18n-polyglot/-/ra-i18n-polyglot-3.19.12.tgz", "integrity": "sha512-7VkNybY+RYVL5aDf8MdefYpRMkaELOjSXx7rrRY7PzVwmQzVe5ESoKBcH4Cob2M8a52pAlXY32dwmA3dZ91l/Q==", + "license": "MIT", "dependencies": { "node-polyglot": "^2.2.2", "ra-core": "^3.19.12" @@ -8676,6 +9458,7 @@ "version": "3.19.12", "resolved": "https://registry.npmjs.org/ra-language-english/-/ra-language-english-3.19.12.tgz", "integrity": "sha512-aYY0ma74eXLuflPT9iXEQtVEDZxebw1NiQZ5pPGiBCpsq+hoiDWuzerLU13OdBHbySD5FHLuk89SkyAdfMtUaQ==", + "license": "MIT", "dependencies": { "ra-core": "^3.19.12" } @@ -8685,6 +9468,7 @@ "resolved": "https://registry.npmjs.org/ra-test/-/ra-test-3.19.12.tgz", "integrity": "sha512-SX6oi+VPADIeQeQlGWUVj2kgEYgLbizpzYMq+oacCmnAqvHezwnQ2MXrLDRK6C56YIl+t8DyY/ipYBiRPZnHbA==", "dev": true, + "license": "MIT", "dependencies": { "@testing-library/react": "^11.2.3", "classnames": "~2.3.1", @@ -8705,6 +9489,7 @@ "resolved": "https://registry.npmjs.org/@testing-library/dom/-/dom-7.31.2.tgz", "integrity": "sha512-3UqjCpey6HiTZT92vODYLPxTBWlM8ZOOjr3LX5F37/VRipW2M1kX6I/Cm4VXzteZqfGfagg8yXywpcOgQBlNsQ==", "dev": true, + "license": "MIT", "dependencies": { "@babel/code-frame": "^7.10.4", "@babel/runtime": "^7.12.5", @@ -8724,6 +9509,7 @@ "resolved": "https://registry.npmjs.org/@testing-library/react/-/react-11.2.7.tgz", "integrity": "sha512-tzRNp7pzd5QmbtXNG/mhdcl7Awfu/Iz1RaVHY75zTdOkmHCuzMhRL83gWHSgOAcjS3CCbyfwUHMZgRJb4kAfpA==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5", "@testing-library/dom": "^7.28.1" @@ -8740,13 +9526,15 @@ "version": "4.2.2", "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-4.2.2.tgz", "integrity": "sha512-HnYpAE1Y6kRyKM/XkEuiRQhTHvkzMBurTHnpFLYLBGPIylZNPs9jJcuOOYWxPLJCSEtmZT0Y8rHDokKN7rRTig==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/ra-test/node_modules/aria-query": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/aria-query/-/aria-query-4.2.2.tgz", "integrity": "sha512-o/HelwhuKpTj/frsOsbNLNgnNGVIFsVP/SW2BSF14gVl7kAfMOJ6/8wUAUvG1R1NHKrfG+2sHZTu0yauT1qBrA==", "dev": true, + "license": "Apache-2.0", "dependencies": { "@babel/runtime": "^7.10.2", "@babel/runtime-corejs3": "^7.10.2" @@ -8759,13 +9547,22 @@ "version": "2.3.3", "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.3.3.tgz", "integrity": "sha512-1inzZmicIFcmUya7PGtUQeXtcF7zZpPnxtQoYOrz0uiOBGlLFa4ik4361seYL2JCcRDIyfdFHiwQolESFlw+Og==", - "dev": true + "dev": true, + "license": "MIT" + }, + "node_modules/ra-test/node_modules/lodash": { + "version": "4.17.23", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", + "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", + "dev": true, + "license": "MIT" }, "node_modules/ra-test/node_modules/pretty-format": { "version": "26.6.2", "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-26.6.2.tgz", "integrity": "sha512-7AeGuCYNGmycyQbCqd/3PWH4eOoX/OiCa0uphp57NVTeAGdJGaAliecxwBDHYQCIvrW7aDBZCYeNTP/WX69mkg==", "dev": true, + "license": "MIT", "dependencies": { "@jest/types": "^26.6.2", "ansi-regex": "^5.0.0", @@ -8780,6 +9577,7 @@ "version": "3.19.12", "resolved": "https://registry.npmjs.org/ra-ui-materialui/-/ra-ui-materialui-3.19.12.tgz", "integrity": "sha512-8Zz88r5yprmUxOw9/F0A/kjjVmFMb2n+sjpel8fuOWtS6y++JWonDsvTwo4yIuSF9mC0fht3f/hd2KEHQdmj6Q==", + "license": "MIT", "dependencies": { "autosuggest-highlight": "^3.1.1", "classnames": "~2.2.5", @@ -8815,7 +9613,14 @@ "node_modules/ra-ui-materialui/node_modules/classnames": { "version": "2.2.6", "resolved": "https://registry.npmjs.org/classnames/-/classnames-2.2.6.tgz", - "integrity": "sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==" + "integrity": "sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==", + "license": "MIT" + }, + "node_modules/ra-ui-materialui/node_modules/dompurify": { + "version": "2.5.9", + "resolved": "https://registry.npmjs.org/dompurify/-/dompurify-2.5.9.tgz", + "integrity": "sha512-i6mvVmWN4xo9LrhCOZrDgSs9noW6nOahbrmzjRbPF36YPyj5Ue5lgok0MHDWkG7xzpWFO2OYttXdzM7rJxHvNA==", + "license": "(MPL-2.0 OR Apache-2.0)" }, "node_modules/ra-ui-materialui/node_modules/inflection": { "version": "1.13.4", @@ -8823,12 +9628,20 @@ "integrity": "sha512-6I/HUDeYFfuNCVS3td055BaXBwKYuzw7K3ExVMStBowKo9oOAMJIXIHvdyR3iboTCp1b+1i5DSkIZTcwIktuDw==", "engines": [ "node >= 0.4.0" - ] + ], + "license": "MIT" + }, + "node_modules/ra-ui-materialui/node_modules/lodash": { + "version": "4.17.23", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", + "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", + "license": "MIT" }, "node_modules/randombytes": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/randombytes/-/randombytes-2.1.0.tgz", "integrity": "sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==", + "license": "MIT", "dependencies": { "safe-buffer": "^5.1.0" } @@ -8837,6 +9650,7 @@ "version": "1.2.8", "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz", "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==", + "license": "(BSD-2-Clause OR MIT OR Apache-2.0)", "dependencies": { "deep-extend": "^0.6.0", "ini": "~1.3.0", @@ -8851,6 +9665,7 @@ "version": "4.0.15", "resolved": "https://registry.npmjs.org/rc-align/-/rc-align-4.0.15.tgz", "integrity": "sha512-wqJtVH60pka/nOX7/IspElA8gjPNQKIx/ZqJ6heATCkXpe1Zg4cPVrMD2vC96wjsFFL8WsmhPbx9tdMo1qqlIA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.10.1", "classnames": "2.x", @@ -8867,6 +9682,7 @@ "version": "2.9.5", "resolved": "https://registry.npmjs.org/rc-motion/-/rc-motion-2.9.5.tgz", "integrity": "sha512-w+XTUrfh7ArbYEd2582uDrEhmBHwK1ZENJiSJVb7uRxdE7qJSYjbO2eksRXmndqyKqKoYPc9ClpPh5242mV1vA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.11.1", "classnames": "^2.2.1", @@ -8881,6 +9697,7 @@ "version": "9.7.5", "resolved": "https://registry.npmjs.org/rc-slider/-/rc-slider-9.7.5.tgz", "integrity": "sha512-LV/MWcXFjco1epPbdw1JlLXlTgmWpB9/Y/P2yinf8Pg3wElHxA9uajN21lJiWtZjf5SCUekfSP6QMJfDo4t1hg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.10.1", "classnames": "^2.2.5", @@ -8900,6 +9717,7 @@ "version": "3.2.2", "resolved": "https://registry.npmjs.org/rc-switch/-/rc-switch-3.2.2.tgz", "integrity": "sha512-+gUJClsZZzvAHGy1vZfnwySxj+MjLlGRyXKXScrtCTcmiYNPzxDFOxdQ/3pK1Kt/0POvwJ/6ALOR8gwdXGhs+A==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.10.1", "classnames": "^2.2.1", @@ -8914,6 +9732,7 @@ "version": "5.3.1", "resolved": "https://registry.npmjs.org/rc-tooltip/-/rc-tooltip-5.3.1.tgz", "integrity": "sha512-e6H0dMD38EPaSPD2XC8dRfct27VvT2TkPdoBSuNl3RRZ5tspiY/c5xYEmGC0IrABvMBgque4Mr2SMZuliCvoiQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.11.2", "classnames": "^2.3.1", @@ -8928,6 +9747,7 @@ "version": "5.3.4", "resolved": "https://registry.npmjs.org/rc-trigger/-/rc-trigger-5.3.4.tgz", "integrity": "sha512-mQv+vas0TwKcjAO2izNPkqR4j86OemLRmvL2nOzdP9OWNWA1ivoTt5hzFqYNW9zACwmTezRiN8bttrC7cZzYSw==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.18.3", "classnames": "^2.2.6", @@ -8947,6 +9767,7 @@ "version": "5.44.4", "resolved": "https://registry.npmjs.org/rc-util/-/rc-util-5.44.4.tgz", "integrity": "sha512-resueRJzmHG9Q6rI/DfK6Kdv9/Lfls05vzMs1Sk3M2P+3cJa+MakaZyWY8IPfehVuhPJFKrIY1IK4GqbiaiY5w==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.18.3", "react-is": "^18.2.0" @@ -8959,12 +9780,20 @@ "node_modules/rc-util/node_modules/react-is": { "version": "18.3.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", - "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==" + "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==", + "license": "MIT" + }, + "node_modules/rc/node_modules/ini": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz", + "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==", + "license": "ISC" }, "node_modules/rc/node_modules/strip-json-comments": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz", "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -8973,6 +9802,7 @@ "version": "17.0.2", "resolved": "https://registry.npmjs.org/react/-/react-17.0.2.tgz", "integrity": "sha512-gnhPt75i/dq/z3/6q/0asP78D0u592D5L1pd7M8P+dck6Fu/jJeL6iVVK23fptSUZj8Vjf++7wXA8UNclGQcbA==", + "license": "MIT", "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1" @@ -8985,6 +9815,7 @@ "version": "3.19.12", "resolved": "https://registry.npmjs.org/react-admin/-/react-admin-3.19.12.tgz", "integrity": "sha512-LanWS3Yjie7n5GZI8v7oP73DSvQyCeZD0dpkC65IC0+UOhkInxa1zedJc8CyD3+ZwlgVC+CGqi6jQ1fo73Cdqw==", + "license": "MIT", "dependencies": { "@material-ui/core": "^4.12.1", "@material-ui/icons": "^4.11.2", @@ -9013,6 +9844,7 @@ "version": "14.0.5", "resolved": "https://registry.npmjs.org/react-dnd/-/react-dnd-14.0.5.tgz", "integrity": "sha512-9i1jSgbyVw0ELlEVt/NkCUkxy1hmhJOkePoCH713u75vzHGyXhPDm28oLfc2NMSBjZRM1Y+wRjHXJT3sPrTy+A==", + "license": "MIT", "dependencies": { "@react-dnd/invariant": "^2.0.0", "@react-dnd/shallowequal": "^2.0.0", @@ -9042,6 +9874,7 @@ "version": "14.1.0", "resolved": "https://registry.npmjs.org/react-dnd-html5-backend/-/react-dnd-html5-backend-14.1.0.tgz", "integrity": "sha512-6ONeqEC3XKVf4eVmMTe0oPds+c5B9Foyj8p/ZKLb7kL2qh9COYxiBHv3szd6gztqi/efkmriywLUVlPotqoJyw==", + "license": "MIT", "dependencies": { "dnd-core": "14.0.1" } @@ -9050,6 +9883,7 @@ "version": "17.0.2", "resolved": "https://registry.npmjs.org/react-dom/-/react-dom-17.0.2.tgz", "integrity": "sha512-s4h96KtLDUQlsENhMn1ar8t2bEa+q/YAtj8pPPdIjPDGBDIVNsrD9aXNWqspUe6AzKCIG0C1HZZLqLV7qpOBGA==", + "license": "MIT", "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1", @@ -9063,17 +9897,19 @@ "version": "0.1.9", "resolved": "https://registry.npmjs.org/react-drag-listview/-/react-drag-listview-0.1.9.tgz", "integrity": "sha512-/OsYevKtCUlw4FhJIfZPH7INHEmyl89sSC5COzonHW5Z2c8rHg4DNYFnUxOyqH+65o7sHweL13oaf6wr7dFvPA==", + "license": "MIT", "dependencies": { "babel-runtime": "^6.26.0", "prop-types": "^15.5.8" } }, "node_modules/react-draggable": { - "version": "4.4.6", - "resolved": "https://registry.npmjs.org/react-draggable/-/react-draggable-4.4.6.tgz", - "integrity": "sha512-LtY5Xw1zTPqHkVmtM3X8MUOxNDOUhv/khTgBgrUvwaS064bwVvxT+q5El0uUFNx5IEPKXuRejr7UqLwBIg5pdw==", + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/react-draggable/-/react-draggable-4.5.0.tgz", + "integrity": "sha512-VC+HBLEZ0XJxnOxVAZsdRi8rD04Iz3SiiKOoYzamjylUcju/hP9np/aZdLHf/7WOD268WMoNJMvYfB5yAK45cw==", + "license": "MIT", "dependencies": { - "clsx": "^1.1.1", + "clsx": "^2.1.1", "prop-types": "^15.8.1" }, "peerDependencies": { @@ -9081,18 +9917,11 @@ "react-dom": ">= 16.3.0" } }, - "node_modules/react-draggable/node_modules/clsx": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/clsx/-/clsx-1.2.1.tgz", - "integrity": "sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==", - "engines": { - "node": ">=6" - } - }, "node_modules/react-dropzone": { "version": "10.2.2", "resolved": "https://registry.npmjs.org/react-dropzone/-/react-dropzone-10.2.2.tgz", "integrity": "sha512-U5EKckXVt6IrEyhMMsgmHQiWTGLudhajPPG77KFSvgsMqNEHSyGpqWvOMc5+DhEah/vH4E1n+J5weBNLd5VtyA==", + "license": "MIT", "dependencies": { "attr-accept": "^2.0.0", "file-selector": "^0.1.12", @@ -9110,6 +9939,7 @@ "resolved": "https://registry.npmjs.org/react-error-boundary/-/react-error-boundary-3.1.4.tgz", "integrity": "sha512-uM9uPzZJTF6wRQORmSrvOIgt4lJ9MC1sNgEOj2XGsDTRE4kmpWxg7ENK9EWNKJRMAOY9z0MuF4yIfl6gp4sotA==", "dev": true, + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.5" }, @@ -9125,6 +9955,7 @@ "version": "6.5.9", "resolved": "https://registry.npmjs.org/react-final-form/-/react-final-form-6.5.9.tgz", "integrity": "sha512-x3XYvozolECp3nIjly+4QqxdjSSWfcnpGEL5K8OBT6xmGrq5kBqbA6+/tOqoom9NwqIPPbxPNsOViFlbKgowbA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.15.4" }, @@ -9141,6 +9972,7 @@ "version": "3.1.4", "resolved": "https://registry.npmjs.org/react-final-form-arrays/-/react-final-form-arrays-3.1.4.tgz", "integrity": "sha512-siVFAolUAe29rMR6u8VwepoysUcUdh6MLV2OWnCtKpsPRUdT9VUgECjAPaVMAH2GROZNiVB9On1H9MMrm9gdpg==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.19.4" }, @@ -9155,6 +9987,7 @@ "version": "3.3.1", "resolved": "https://registry.npmjs.org/react-ga/-/react-ga-3.3.1.tgz", "integrity": "sha512-4Vc0W5EvXAXUN/wWyxvsAKDLLgtJ3oLmhYYssx+YzphJpejtOst6cbIHCIyF50Fdxuf5DDKqRYny24yJ2y7GFQ==", + "license": "Apache-2.0", "peerDependencies": { "prop-types": "^15.6.0", "react": "^15.6.2 || ^16.0 || ^17 || ^18" @@ -9164,6 +9997,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/react-hotkeys/-/react-hotkeys-2.0.0.tgz", "integrity": "sha512-3n3OU8vLX/pfcJrR3xJ1zlww6KS1kEJt0Whxc4FiGV+MJrQ1mYSYI3qS/11d2MJDFm8IhOXMTFQirfu6AVOF6Q==", + "license": "ISC", "dependencies": { "prop-types": "^15.6.1" }, @@ -9172,9 +10006,10 @@ } }, "node_modules/react-icons": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/react-icons/-/react-icons-5.5.0.tgz", - "integrity": "sha512-MEFcXdkP3dLo8uumGI5xN3lDFNsRtrjbOEKDLD7yv76v4wpnEq2Lt2qeHaQOr34I/wPN3s3+N08WkQ+CW37Xiw==", + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/react-icons/-/react-icons-5.6.0.tgz", + "integrity": "sha512-RH93p5ki6LfOiIt0UtDyNg/cee+HLVR6cHHtW3wALfo+eOHTp8RnU2kRkI6E+H19zMIs03DyxUG/GfZMOGvmiA==", + "license": "MIT", "peerDependencies": { "react": "*" } @@ -9184,6 +10019,7 @@ "resolved": "https://registry.npmjs.org/react-image-lightbox/-/react-image-lightbox-5.1.4.tgz", "integrity": "sha512-kTiAODz091bgT7SlWNHab0LSMZAPJtlNWDGKv7pLlLY1krmf7FuG1zxE0wyPpeA8gPdwfr3cu6sPwZRqWsc3Eg==", "deprecated": "Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.", + "license": "MIT", "dependencies": { "prop-types": "^15.7.2", "react-modal": "^3.11.1" @@ -9196,17 +10032,20 @@ "node_modules/react-is": { "version": "17.0.2", "resolved": "https://registry.npmjs.org/react-is/-/react-is-17.0.2.tgz", - "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==" + "integrity": "sha512-w2GsyukL62IJnlaff/nRegPQR94C/XXamvMWmSHRJ4y7Ts/4ocGRmTHvOs8PSE6pB3dWOrD/nueuU5sduBsQ4w==", + "license": "MIT" }, "node_modules/react-lifecycles-compat": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/react-lifecycles-compat/-/react-lifecycles-compat-3.0.4.tgz", - "integrity": "sha512-fBASbA6LnOU9dOU2eW7aQ8xmYBSXUIWr+UmF9b1efZBazGNO+rcXT/icdKnYm2pTwcRylVUYwW7H1PHfLekVzA==" + "integrity": "sha512-fBASbA6LnOU9dOU2eW7aQ8xmYBSXUIWr+UmF9b1efZBazGNO+rcXT/icdKnYm2pTwcRylVUYwW7H1PHfLekVzA==", + "license": "MIT" }, "node_modules/react-measure": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/react-measure/-/react-measure-2.5.2.tgz", "integrity": "sha512-M+rpbTLWJ3FD6FXvYV6YEGvQ5tMayQ3fGrZhRPHrE9bVlBYfDCLuDcgNttYfk8IqfOI03jz6cbpqMRTUclQnaA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.2.0", "get-node-dimensions": "^1.2.1", @@ -9222,6 +10061,7 @@ "version": "3.16.3", "resolved": "https://registry.npmjs.org/react-modal/-/react-modal-3.16.3.tgz", "integrity": "sha512-yCYRJB5YkeQDQlTt17WGAgFJ7jr2QYcWa1SHqZ3PluDmnKJ/7+tVU+E6uKyZ0nODaeEj+xCpK4LcSnKXLMC0Nw==", + "license": "MIT", "dependencies": { "exenv": "^1.2.0", "prop-types": "^15.7.2", @@ -9237,6 +10077,7 @@ "version": "7.2.9", "resolved": "https://registry.npmjs.org/react-redux/-/react-redux-7.2.9.tgz", "integrity": "sha512-Gx4L3uM182jEEayZfRbI/G11ZpYdNAnBs70lFVMNdHJI76XYtR+7m0MN+eAs7UHBPhWXcnFPaS+9owSCJQHNpQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.15.4", "@types/react-redux": "^7.1.20", @@ -9258,10 +10099,11 @@ } }, "node_modules/react-refresh": { - "version": "0.17.0", - "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.17.0.tgz", - "integrity": "sha512-z6F7K9bV85EfseRCp2bzrpyQ0Gkw1uLoCel9XBVWPg/TjRj94SkJzUTGfOa4bs7iJvBWtQG0Wq7wnI0syw3EBQ==", + "version": "0.18.0", + "resolved": "https://registry.npmjs.org/react-refresh/-/react-refresh-0.18.0.tgz", + "integrity": "sha512-QgT5//D3jfjJb6Gsjxv0Slpj23ip+HtOpnNgnb2S5zU3CB26G/IDPGoy4RJB42wzFE46DRsstbW6tKHoKbhAxw==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -9270,6 +10112,7 @@ "version": "5.3.4", "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.3.4.tgz", "integrity": "sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -9289,6 +10132,7 @@ "version": "5.3.4", "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.3.4.tgz", "integrity": "sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.12.13", "history": "^4.9.0", @@ -9305,12 +10149,14 @@ "node_modules/react-router/node_modules/react-is": { "version": "16.13.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.13.1.tgz", - "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==" + "integrity": "sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==", + "license": "MIT" }, "node_modules/react-transition-group": { "version": "4.4.5", "resolved": "https://registry.npmjs.org/react-transition-group/-/react-transition-group-4.4.5.tgz", "integrity": "sha512-pZcd1MCJoiKiBR2NRxeCRg13uCXbydPnmB4EOeRrY7480qNWO8IIgQG6zlDkm6uRMsURXPuKq0GWtiM59a5Q6g==", + "license": "BSD-3-Clause", "dependencies": { "@babel/runtime": "^7.5.5", "dom-helpers": "^5.0.1", @@ -9326,6 +10172,7 @@ "version": "5.2.0", "resolved": "https://registry.npmjs.org/read-pkg/-/read-pkg-5.2.0.tgz", "integrity": "sha512-Ug69mNOpfvKDAc2Q8DRpMjjzdtrnv9HcSMX+4VsZxD1aZ6ZzrIE7rlzXBtWTyhULSMKg076AW6WR5iZpD0JiOg==", + "license": "MIT", "dependencies": { "@types/normalize-package-data": "^2.4.0", "normalize-package-data": "^2.5.0", @@ -9340,6 +10187,7 @@ "version": "7.0.1", "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-7.0.1.tgz", "integrity": "sha512-zK0TB7Xd6JpCLmlLmufqykGE+/TlOePD6qKClNW7hHDKFh/J7/7gCWGR7joEQEW1bKq3a3yUZSObOoWLFQ4ohg==", + "license": "MIT", "dependencies": { "find-up": "^4.1.0", "read-pkg": "^5.2.0", @@ -9356,6 +10204,7 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "license": "MIT", "dependencies": { "locate-path": "^5.0.0", "path-exists": "^4.0.0" @@ -9368,6 +10217,7 @@ "version": "5.0.0", "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "license": "MIT", "dependencies": { "p-locate": "^4.1.0" }, @@ -9379,6 +10229,7 @@ "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "license": "MIT", "dependencies": { "p-try": "^2.0.0" }, @@ -9393,6 +10244,7 @@ "version": "4.1.0", "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "license": "MIT", "dependencies": { "p-limit": "^2.2.0" }, @@ -9404,6 +10256,7 @@ "version": "0.8.1", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz", "integrity": "sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=8" } @@ -9412,6 +10265,7 @@ "version": "0.6.0", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.6.0.tgz", "integrity": "sha512-q+MB8nYR1KDLrgr4G5yemftpMC7/QLqVndBmEEdqzmNj5dcFOO4Oo8qlwZE3ULT3+Zim1F8Kq4cBnikNhlCMlg==", + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=8" } @@ -9420,6 +10274,7 @@ "version": "3.6.2", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz", "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==", + "license": "MIT", "dependencies": { "inherits": "^2.0.3", "string_decoder": "^1.1.1", @@ -9433,6 +10288,7 @@ "version": "3.6.0", "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-3.6.0.tgz", "integrity": "sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==", + "license": "MIT", "dependencies": { "picomatch": "^2.2.1" }, @@ -9444,6 +10300,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/redent/-/redent-3.0.0.tgz", "integrity": "sha512-6tDA8g98We0zd0GvVeMT9arEOnTw9qM03L9cJXaCjrip1OO764RDBLBfrB4cwzNGDj5OA5ioymC9GkizgWJDUg==", + "license": "MIT", "dependencies": { "indent-string": "^4.0.0", "strip-indent": "^3.0.0" @@ -9456,22 +10313,25 @@ "version": "4.2.1", "resolved": "https://registry.npmjs.org/redux/-/redux-4.2.1.tgz", "integrity": "sha512-LAUYz4lc+Do8/g7aeRa8JkyDErK6ekstQaqWQrNRW//MY1TvCEpMtpTWvlQ+FPbWCx+Xixu/6SHt5N0HR+SB4w==", + "license": "MIT", "dependencies": { "@babel/runtime": "^7.9.2" } }, "node_modules/redux-saga": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/redux-saga/-/redux-saga-1.3.0.tgz", - "integrity": "sha512-J9RvCeAZXSTAibFY0kGw6Iy4EdyDNW7k6Q+liwX+bsck7QVsU78zz8vpBRweEfANxnnlG/xGGeOvf6r8UXzNJQ==", + "version": "1.4.2", + "resolved": "https://registry.npmjs.org/redux-saga/-/redux-saga-1.4.2.tgz", + "integrity": "sha512-QLIn/q+7MX/B+MkGJ/K6R3//60eJ4QNy65eqPsJrfGezbxdh1Jx+37VRKE2K4PsJnNET5JufJtgWdT30WBa+6w==", + "license": "MIT", "dependencies": { - "@redux-saga/core": "^1.3.0" + "@redux-saga/core": "^1.4.2" } }, "node_modules/reflect.getprototypeof": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.10.tgz", "integrity": "sha512-00o4I+DVrefhv+nX0ulyi3biSHCPDe+yLv5o/p6d/UVlirijB8E16FtfwSAi4g3tcqrQ4lRAqQSoFEZJehYEcw==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -9492,12 +10352,14 @@ "node_modules/regenerate": { "version": "1.4.2", "resolved": "https://registry.npmjs.org/regenerate/-/regenerate-1.4.2.tgz", - "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==" + "integrity": "sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==", + "license": "MIT" }, "node_modules/regenerate-unicode-properties": { - "version": "10.2.0", - "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.0.tgz", - "integrity": "sha512-DqHn3DwbmmPVzeKj9woBadqmXxLvQoQIwu7nopMc72ztvxVmVk2SBhSnx67zuye5TP+lJsb/TBQsjLKhnDf3MA==", + "version": "10.2.2", + "resolved": "https://registry.npmjs.org/regenerate-unicode-properties/-/regenerate-unicode-properties-10.2.2.tgz", + "integrity": "sha512-m03P+zhBeQd1RGnYxrGyDAPpWX/epKirLrp8e3qevZdVkKtnCrjjWczIbYc8+xd6vcTStVlqfycTx1KR4LOr0g==", + "license": "MIT", "dependencies": { "regenerate": "^1.4.2" }, @@ -9508,12 +10370,14 @@ "node_modules/regenerator-runtime": { "version": "0.11.1", "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.11.1.tgz", - "integrity": "sha512-MguG95oij0fC3QV3URf4V2SDYGJhJnJGqvIIgdECeODCT98wSWDAJ94SSuVpYQUoTcGUIL6L4yNB7j1DFFHSBg==" + "integrity": "sha512-MguG95oij0fC3QV3URf4V2SDYGJhJnJGqvIIgdECeODCT98wSWDAJ94SSuVpYQUoTcGUIL6L4yNB7j1DFFHSBg==", + "license": "MIT" }, "node_modules/regexp.prototype.flags": { "version": "1.5.4", "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.4.tgz", "integrity": "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", @@ -9530,79 +10394,78 @@ } }, "node_modules/regexpu-core": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.2.0.tgz", - "integrity": "sha512-H66BPQMrv+V16t8xtmq+UC0CBpiTBA60V8ibS1QVReIp8T1z8hwFxqcGzm9K6lgsN7sB5edVH8a+ze6Fqm4weA==", + "version": "6.4.0", + "resolved": "https://registry.npmjs.org/regexpu-core/-/regexpu-core-6.4.0.tgz", + "integrity": "sha512-0ghuzq67LI9bLXpOX/ISfve/Mq33a4aFRzoQYhnnok1JOFpmE/A2TBGkNVenOGEeSBCjIiWcc6MVOG5HEQv0sA==", + "license": "MIT", "dependencies": { "regenerate": "^1.4.2", - "regenerate-unicode-properties": "^10.2.0", + "regenerate-unicode-properties": "^10.2.2", "regjsgen": "^0.8.0", - "regjsparser": "^0.12.0", + "regjsparser": "^0.13.0", "unicode-match-property-ecmascript": "^2.0.0", - "unicode-match-property-value-ecmascript": "^2.1.0" + "unicode-match-property-value-ecmascript": "^2.2.1" }, "engines": { "node": ">=4" } }, "node_modules/registry-auth-token": { - "version": "4.2.2", - "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-4.2.2.tgz", - "integrity": "sha512-PC5ZysNb42zpFME6D/XlIgtNGdTl8bBOCw90xQLVMpzuuubJKYDWFAEuUNc+Cn8Z8724tg2SDhDRrkVEsqfDMg==", + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/registry-auth-token/-/registry-auth-token-5.1.1.tgz", + "integrity": "sha512-P7B4+jq8DeD2nMsAcdfaqHbssgHtZ7Z5+++a5ask90fvmJ8p5je4mOa+wzu+DB4vQ5tdJV/xywY+UnVFeQLV5Q==", + "license": "MIT", + "dependencies": { + "@pnpm/npm-conf": "^3.0.2" + }, + "engines": { + "node": ">=14" + } + }, + "node_modules/registry-url": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-6.0.1.tgz", + "integrity": "sha512-+crtS5QjFRqFCoQmvGduwYWEBng99ZvmFvF+cUJkGYF1L1BfU8C6Zp9T7f5vPAwyLkUExpvK+ANVZmGU49qi4Q==", + "license": "MIT", "dependencies": { "rc": "1.2.8" }, "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/registry-url": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/registry-url/-/registry-url-5.1.0.tgz", - "integrity": "sha512-8acYXXTI0AkQv6RAOjE3vOaIXZkT9wo4LOFbBKYQEEnnMNBpKqdUrI6S4NT0KPIo/WVvJ5tE/X5LF/TQUf0ekw==", - "dependencies": { - "rc": "^1.2.8" + "node": ">=12" }, - "engines": { - "node": ">=8" + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/regjsgen": { "version": "0.8.0", "resolved": "https://registry.npmjs.org/regjsgen/-/regjsgen-0.8.0.tgz", - "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==" + "integrity": "sha512-RvwtGe3d7LvWiDQXeQw8p5asZUmfU1G/l6WbUXeHta7Y2PEIvBTwH6E2EfmYUK8pxcxEdEmaomqyp0vZZ7C+3Q==", + "license": "MIT" }, "node_modules/regjsparser": { - "version": "0.12.0", - "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.12.0.tgz", - "integrity": "sha512-cnE+y8bz4NhMjISKbgeVJtqNbtf5QpjZP+Bslo+UqkIt9QPnX9q095eiRRASJG1/tz6dlNr6Z5NsBiWYokp6EQ==", + "version": "0.13.1", + "resolved": "https://registry.npmjs.org/regjsparser/-/regjsparser-0.13.1.tgz", + "integrity": "sha512-dLsljMd9sqwRkby8zhO1gSg3PnJIBFid8f4CQj/sXx+7cKx+E7u0PKhZ+U4wmhx7EfmtvnA318oVaIkAB1lRJw==", + "license": "BSD-2-Clause", "dependencies": { - "jsesc": "~3.0.2" + "jsesc": "~3.1.0" }, "bin": { "regjsparser": "bin/parser" } }, - "node_modules/regjsparser/node_modules/jsesc": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-3.0.2.tgz", - "integrity": "sha512-xKqzzWXDttJuOcawBt4KnKHHIf5oQ/Cxax+0PWFG+DFDgHNAdi+TXECADI+RYiFUMmx8792xsMbbgXj4CwnP4g==", - "bin": { - "jsesc": "bin/jsesc" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/remove-accents": { "version": "0.4.4", "resolved": "https://registry.npmjs.org/remove-accents/-/remove-accents-0.4.4.tgz", - "integrity": "sha512-EpFcOa/ISetVHEXqu+VwI96KZBmq+a8LJnGkaeFw45epGlxIZz5dhEEnNZMsQXgORu3qaMoLX4qJCzOik6ytAg==" + "integrity": "sha512-EpFcOa/ISetVHEXqu+VwI96KZBmq+a8LJnGkaeFw45epGlxIZz5dhEEnNZMsQXgORu3qaMoLX4qJCzOik6ytAg==", + "license": "MIT" }, "node_modules/require-from-string": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -9610,26 +10473,35 @@ "node_modules/reselect": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/reselect/-/reselect-3.0.1.tgz", - "integrity": "sha512-b/6tFZCmRhtBMa4xGqiiRp9jh9Aqi2A687Lo265cN0/QohJQEBPiQ52f4QB6i0eF3yp3hmLL21LSGBcML2dlxA==" + "integrity": "sha512-b/6tFZCmRhtBMa4xGqiiRp9jh9Aqi2A687Lo265cN0/QohJQEBPiQ52f4QB6i0eF3yp3hmLL21LSGBcML2dlxA==", + "license": "MIT" }, "node_modules/resize-observer-polyfill": { "version": "1.5.1", "resolved": "https://registry.npmjs.org/resize-observer-polyfill/-/resize-observer-polyfill-1.5.1.tgz", - "integrity": "sha512-LwZrotdHOo12nQuZlHEmtuXdqGoOD0OhaxopaNFxWzInpEgaLWoVuAMbTzixuosCx2nEG58ngzW3vxdWoxIgdg==" + "integrity": "sha512-LwZrotdHOo12nQuZlHEmtuXdqGoOD0OhaxopaNFxWzInpEgaLWoVuAMbTzixuosCx2nEG58ngzW3vxdWoxIgdg==", + "license": "MIT" }, "node_modules/resolve": { - "version": "2.0.0-next.5", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.5.tgz", - "integrity": "sha512-U7WjGVG9sH8tvjW5SmGbQuui75FiyjAX72HX15DwBBwF9dNiQZRQAg9nnPhYy+TUnE0+VcrttuvNI8oSxZcocA==", + "version": "2.0.0-next.6", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.6.tgz", + "integrity": "sha512-3JmVl5hMGtJ3kMmB3zi3DL25KfkCEyy3Tw7Gmw7z5w8M9WlwoPFnIvwChzu1+cF3iaK3sp18hhPz8ANeimdJfA==", "dev": true, + "license": "MIT", "dependencies": { - "is-core-module": "^2.13.0", + "es-errors": "^1.3.0", + "is-core-module": "^2.16.1", + "node-exports-info": "^1.6.0", + "object-keys": "^1.1.1", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, "bin": { "resolve": "bin/resolve" }, + "engines": { + "node": ">= 0.4" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -9639,6 +10511,7 @@ "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", "dev": true, + "license": "MIT", "engines": { "node": ">=4" } @@ -9646,20 +10519,14 @@ "node_modules/resolve-pathname": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz", - "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==" - }, - "node_modules/responselike": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/responselike/-/responselike-1.0.2.tgz", - "integrity": "sha512-/Fpe5guzJk1gPqdJLJR5u7eG/gNY4nImjbRDaVWVMRhne55TCmj2i9Q+54PBRfatRC8v/rIiv9BN0pMd9OV5EQ==", - "dependencies": { - "lowercase-keys": "^1.0.0" - } + "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==", + "license": "MIT" }, "node_modules/restore-cursor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", "integrity": "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA==", + "license": "MIT", "dependencies": { "onetime": "^5.1.0", "signal-exit": "^3.0.2" @@ -9673,17 +10540,31 @@ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz", "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==", "dev": true, + "license": "MIT", "engines": { "iojs": ">=1.0.0", "node": ">=0.10.0" } }, + "node_modules/rifm": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/rifm/-/rifm-0.7.0.tgz", + "integrity": "sha512-DSOJTWHD67860I5ojetXdEQRIBvF6YcpNe53j0vn1vp9EUb9N80EiZTxgP+FkDKorWC8PZw052kTF4C1GOivCQ==", + "license": "MIT", + "dependencies": { + "@babel/runtime": "^7.3.1" + }, + "peerDependencies": { + "react": ">=16.8" + } + }, "node_modules/rimraf": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", "deprecated": "Rimraf versions prior to v4 are no longer supported", "dev": true, + "license": "ISC", "dependencies": { "glob": "^7.1.3" }, @@ -9696,12 +10577,13 @@ }, "node_modules/rollup": { "name": "@rollup/wasm-node", - "version": "4.41.1", - "resolved": "https://registry.npmjs.org/@rollup/wasm-node/-/wasm-node-4.41.1.tgz", - "integrity": "sha512-70qfem+U3hAgwNgOlnUQiIdfKHLELUxsEWbFWg3aErPUvsyXYF1HALJBwoDgMUhRWyn+SqWVneDTnO/Kbey9hg==", + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/wasm-node/-/wasm-node-4.60.1.tgz", + "integrity": "sha512-FAfGj5Ferzyna11iUwGdkYus/Y9d/H75PEpsseP5DZOsEsyPvP/Q7mJiSXhUYSEmyfHPaZyC8EsJCjqzDbtcfg==", "devOptional": true, + "license": "MIT", "dependencies": { - "@types/estree": "1.0.7" + "@types/estree": "1.0.8" }, "bin": { "rollup": "dist/bin/rollup" @@ -9718,12 +10600,14 @@ "version": "0.8.0", "resolved": "https://registry.npmjs.org/rrweb-cssom/-/rrweb-cssom-0.8.0.tgz", "integrity": "sha512-guoltQEx+9aMf2gDZ0s62EcV8lsXR+0w8915TC3ITdn2YueuNjdAYh/levpU9nFaoChh9RUS5ZdQMrKfVEN9tw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/run-async": { "version": "2.4.1", "resolved": "https://registry.npmjs.org/run-async/-/run-async-2.4.1.tgz", "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==", + "license": "MIT", "engines": { "node": ">=0.12.0" } @@ -9747,6 +10631,7 @@ "url": "https://feross.org/support" } ], + "license": "MIT", "dependencies": { "queue-microtask": "^1.2.2" } @@ -9755,6 +10640,7 @@ "version": "6.6.7", "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.6.7.tgz", "integrity": "sha512-hTdwr+7yYNIT5n4AMYp85KA6yw2Va0FLa3Rguvbpa4W3I5xynaBZo41cM3XM+4Q6fRMj3sBYIR1VAmZMXYJvRQ==", + "license": "Apache-2.0", "dependencies": { "tslib": "^1.9.0" }, @@ -9765,12 +10651,14 @@ "node_modules/rxjs/node_modules/tslib": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==" + "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", + "license": "0BSD" }, "node_modules/safe-array-concat": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.1.3.tgz", "integrity": "sha512-AURm5f0jYEOydBj7VQlVvDrjeFgthDdEF5H1dP+6mNpoXOMo1quQqJ4wvJDyRZ9+pO3kGWoOdmV08cSv2aJV6Q==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", @@ -9788,7 +10676,8 @@ "node_modules/safe-array-concat/node_modules/isarray": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==" + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "license": "MIT" }, "node_modules/safe-buffer": { "version": "5.2.1", @@ -9807,12 +10696,14 @@ "type": "consulting", "url": "https://feross.org/support" } - ] + ], + "license": "MIT" }, "node_modules/safe-push-apply": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/safe-push-apply/-/safe-push-apply-1.0.0.tgz", "integrity": "sha512-iKE9w/Z7xCzUMIZqdBsp6pEQvwuEebH4vdpjcDWnyzaI6yl6O9FHvVpmGelvEHNsoY6wGblkxR6Zty/h00WiSA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "isarray": "^2.0.5" @@ -9827,12 +10718,14 @@ "node_modules/safe-push-apply/node_modules/isarray": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==" + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "license": "MIT" }, "node_modules/safe-regex-test": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/safe-regex-test/-/safe-regex-test-1.1.0.tgz", "integrity": "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -9848,13 +10741,15 @@ "node_modules/safer-buffer": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", - "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "license": "MIT" }, "node_modules/saxes": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/saxes/-/saxes-6.0.0.tgz", "integrity": "sha512-xAg7SOnEhrm5zI3puOOKyy1OMcMlIJZYNJY7xLBwSze0UjhPLnWfj2GF2EpT0jmzaJKIWKHLsaSSajf35bcYnA==", "dev": true, + "license": "ISC", "dependencies": { "xmlchars": "^2.2.0" }, @@ -9866,6 +10761,7 @@ "version": "0.20.2", "resolved": "https://registry.npmjs.org/scheduler/-/scheduler-0.20.2.tgz", "integrity": "sha512-2eWfGgAqqWFGqtdMmcL5zCMK1U8KlXv8SQFGglL3CEtd0aDVDWgeF/YoCmvln55m5zSk3J/20hTaSBeSObsQDQ==", + "license": "MIT", "dependencies": { "loose-envify": "^1.1.0", "object-assign": "^4.1.1" @@ -9875,13 +10771,14 @@ "version": "7.1.4", "resolved": "https://registry.npmjs.org/seamless-immutable/-/seamless-immutable-7.1.4.tgz", "integrity": "sha512-XiUO1QP4ki4E2PHegiGAlu6r82o5A+6tRh7IkGGTVg/h+UoeX4nFBeCGPOhb4CYjvkqsfm/TUtvOMYC1xmV30A==", + "license": "BSD-3-Clause", "optional": true }, "node_modules/semver": { - "version": "7.7.2", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz", - "integrity": "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==", - "dev": true, + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.4.tgz", + "integrity": "sha512-vFKC2IEtQnVhpT78h1Yp8wzwrf8CM+MzKMHGJZfBtzhZNycRFnXsHk6E5TxIkkMsgNS7mdX3AGB7x2QM2di4lA==", + "license": "ISC", "bin": { "semver": "bin/semver.js" }, @@ -9889,29 +10786,11 @@ "node": ">=10" } }, - "node_modules/semver-diff": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/semver-diff/-/semver-diff-3.1.1.tgz", - "integrity": "sha512-GX0Ix/CJcHyB8c4ykpHGIAvLyOwOobtM/8d+TQkAd81/bEjgPHrfba41Vpesr7jX/t8Uh+R3EX9eAS5be+jQYg==", - "dependencies": { - "semver": "^6.3.0" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/semver-diff/node_modules/semver": { - "version": "6.3.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", - "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", - "bin": { - "semver": "bin/semver.js" - } - }, "node_modules/serialize-javascript": { "version": "6.0.2", "resolved": "https://registry.npmjs.org/serialize-javascript/-/serialize-javascript-6.0.2.tgz", "integrity": "sha512-Saa1xPByTTq2gdeFZYLLo+RFE35NHZkAbqZeWNd3BpzppeVisAqpDjcp8dyf6uIvEqJRd46jemmyA4iFIeVk8g==", + "license": "BSD-3-Clause", "dependencies": { "randombytes": "^2.1.0" } @@ -9920,6 +10799,7 @@ "version": "1.2.2", "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", @@ -9936,6 +10816,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/set-function-name/-/set-function-name-2.0.2.tgz", "integrity": "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ==", + "license": "MIT", "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", @@ -9950,6 +10831,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/set-proto/-/set-proto-1.0.0.tgz", "integrity": "sha512-RJRdvCo6IAnPdsvP/7m6bsQqNnn1FCBX5ZNtFL98MmFF/4xAIJTIg1YbHW5DC2W5SKZanrC6i4HsJqlajw/dZw==", + "license": "MIT", "dependencies": { "dunder-proto": "^1.0.1", "es-errors": "^1.3.0", @@ -9962,13 +10844,14 @@ "node_modules/shallowequal": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/shallowequal/-/shallowequal-1.1.0.tgz", - "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==" + "integrity": "sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==", + "license": "MIT" }, "node_modules/shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", - "dev": true, + "license": "MIT", "dependencies": { "shebang-regex": "^3.0.0" }, @@ -9980,7 +10863,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", - "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -9989,6 +10872,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.1.0.tgz", "integrity": "sha512-ZX99e6tRweoUXqR+VBrslhda51Nh5MTQwou5tnUDgbtyM0dBgmhEDtWGP/xbKn6hqfPRHujUNwz5fy/wbbhnpw==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3", @@ -10007,6 +10891,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/side-channel-list/-/side-channel-list-1.0.0.tgz", "integrity": "sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==", + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "object-inspect": "^1.13.3" @@ -10022,6 +10907,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/side-channel-map/-/side-channel-map-1.0.1.tgz", "integrity": "sha512-VCjCNfgMsby3tTdo02nbjtM/ewra6jPHmpThenkTYh8pG9ucZ/1P8So4u4FGBek/BjpOVsDCMoLA/iuBKIFXRA==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -10039,6 +10925,7 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/side-channel-weakmap/-/side-channel-weakmap-1.0.2.tgz", "integrity": "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", @@ -10057,36 +10944,46 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/siginfo/-/siginfo-2.0.0.tgz", "integrity": "sha512-ybx0WO1/8bSBLEWXZvEd7gMW3Sn3JFlW3TvX1nREbDLRNQNaeNN8WK0meBwPdAaOI7TtRRRJn/Es1zhrrCHu7g==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/signal-exit": { "version": "3.0.7", "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz", - "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==" + "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==", + "license": "ISC" }, "node_modules/slash": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } }, "node_modules/smob": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/smob/-/smob-1.5.0.tgz", - "integrity": "sha512-g6T+p7QO8npa+/hNx9ohv1E5pVCmWrVCUzUXJyLdMmftX6ER0oiWY/w9knEonLpnOp6b6FenKnMfR8gqwWdwig==" + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/smob/-/smob-1.6.1.tgz", + "integrity": "sha512-KAkBqZl3c2GvNgNhcoyJae1aKldDW0LO279wF9bk1PnluRTETKBq0WyzRXxEhoQLk56yHaOY4JCBEKDuJIET5g==", + "license": "MIT", + "engines": { + "node": ">=20.0.0" + } }, "node_modules/sortablejs": { - "version": "1.15.6", - "resolved": "https://registry.npmjs.org/sortablejs/-/sortablejs-1.15.6.tgz", - "integrity": "sha512-aNfiuwMEpfBM/CN6LY0ibyhxPfPbyFeBTYJKCvzkJ2GkUpazIt3H+QIPAMHwqQ7tMKaHz1Qj+rJJCqljnf4p3A==" + "version": "1.15.7", + "resolved": "https://registry.npmjs.org/sortablejs/-/sortablejs-1.15.7.tgz", + "integrity": "sha512-Kk8wLQPlS+yi1ZEf48a4+fzHa4yxjC30M/Sr2AnQu+f/MPwvvX9XjZ6OWejiz8crBsLwSq8GHqaxaET7u6ux0A==", + "license": "MIT" }, "node_modules/source-map": { "version": "0.8.0-beta.0", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.8.0-beta.0.tgz", "integrity": "sha512-2ymg6oRBpebeZi9UUNsgQ89bhx01TcTkmNTGnNO88imTmbSgy4nfujrgVEFKWpMTEGA11EDkTt7mqObTPdigIA==", + "deprecated": "The work that was done in this beta branch won't be included in future versions", + "license": "BSD-3-Clause", "dependencies": { "whatwg-url": "^7.0.0" }, @@ -10099,6 +10996,7 @@ "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", "dev": true, + "license": "BSD-3-Clause", "engines": { "node": ">=0.10.0" } @@ -10107,6 +11005,7 @@ "version": "0.5.21", "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "license": "MIT", "dependencies": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" @@ -10116,6 +11015,7 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "license": "BSD-3-Clause", "engines": { "node": ">=0.10.0" } @@ -10124,6 +11024,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/tr46/-/tr46-1.0.1.tgz", "integrity": "sha512-dTpowEjclQ7Kgx5SdBkqRzVhERQXov8/l9Ft9dVM9fmg0W0KQSVaXX9T4i6twCPNtYiZM53lpSSUAwJbFPOHxA==", + "license": "MIT", "dependencies": { "punycode": "^2.1.0" } @@ -10131,12 +11032,14 @@ "node_modules/source-map/node_modules/webidl-conversions": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-4.0.2.tgz", - "integrity": "sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==" + "integrity": "sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==", + "license": "BSD-2-Clause" }, "node_modules/source-map/node_modules/whatwg-url": { "version": "7.1.0", "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", "integrity": "sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==", + "license": "MIT", "dependencies": { "lodash.sortby": "^4.7.0", "tr46": "^1.0.1", @@ -10147,12 +11050,14 @@ "version": "1.4.8", "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", "integrity": "sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==", - "deprecated": "Please use @jridgewell/sourcemap-codec instead" + "deprecated": "Please use @jridgewell/sourcemap-codec instead", + "license": "MIT" }, "node_modules/spdx-correct": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.2.0.tgz", "integrity": "sha512-kN9dJbvnySHULIluDHy32WHRUu3Og7B9sbY7tsFLctQkIqnMh3hErYgdMjTYuqmcXX+lK5T1lnUt3G7zNswmZA==", + "license": "Apache-2.0", "dependencies": { "spdx-expression-parse": "^3.0.0", "spdx-license-ids": "^3.0.0" @@ -10161,39 +11066,50 @@ "node_modules/spdx-exceptions": { "version": "2.5.0", "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.5.0.tgz", - "integrity": "sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==" + "integrity": "sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==", + "license": "CC-BY-3.0" }, "node_modules/spdx-expression-parse": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/spdx-expression-parse/-/spdx-expression-parse-3.0.1.tgz", "integrity": "sha512-cbqHunsQWnJNE6KhVSMsMeH5H/L9EpymbzqTQ3uLwNCLZ1Q481oWaofqH7nO6V07xlXwY6PhQdQ2IedWx/ZK4Q==", + "license": "MIT", "dependencies": { "spdx-exceptions": "^2.1.0", "spdx-license-ids": "^3.0.0" } }, "node_modules/spdx-license-ids": { - "version": "3.0.21", - "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.21.tgz", - "integrity": "sha512-Bvg/8F5XephndSK3JffaRqdT+gyhfqIPwDHpX80tJrF8QQRYMo8sNMeaZ2Dp5+jhwKnUmIOyFFQfHRkjJm5nXg==" + "version": "3.0.23", + "resolved": "https://registry.npmjs.org/spdx-license-ids/-/spdx-license-ids-3.0.23.tgz", + "integrity": "sha512-CWLcCCH7VLu13TgOH+r8p1O/Znwhqv/dbb6lqWy67G+pT1kHmeD/+V36AVb/vq8QMIQwVShJ6Ssl5FPh0fuSdw==", + "license": "CC0-1.0" + }, + "node_modules/sprintf-js": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", + "integrity": "sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==", + "license": "BSD-3-Clause" }, "node_modules/stackback": { "version": "0.0.2", "resolved": "https://registry.npmjs.org/stackback/-/stackback-0.0.2.tgz", "integrity": "sha512-1XMJE5fQo1jGH6Y/7ebnwPOBEkIEnT4QF32d5R1+VXdXveM0IBMJt8zfaxX1P3QhVwrYe+576+jkANtSS2mBbw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/std-env": { - "version": "3.9.0", - "resolved": "https://registry.npmjs.org/std-env/-/std-env-3.9.0.tgz", - "integrity": "sha512-UGvjygr6F6tpH7o2qyqR6QYpwraIjKSdtzyBdyytFOHmPZY917kwdwLG0RbOjWOnKmnm3PeHjaoLLMie7kPLQw==", - "dev": true + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/std-env/-/std-env-4.0.0.tgz", + "integrity": "sha512-zUMPtQ/HBY3/50VbpkupYHbRroTRZJPRLvreamgErJVys0ceuzMkD44J/QjqhHjOzK42GQ3QZIeFG1OYfOtKqQ==", + "dev": true, + "license": "MIT" }, "node_modules/stop-iteration-iterator": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/stop-iteration-iterator/-/stop-iteration-iterator-1.1.0.tgz", "integrity": "sha512-eLoXW/DHyl62zxY4SCaIgnRhuMr6ri4juEYARS8E6sCEqzKpOiE521Ucofdx+KnDZl5xmvGYaaKCk5FEOxJCoQ==", - "dev": true, + "license": "MIT", "dependencies": { "es-errors": "^1.3.0", "internal-slot": "^1.1.0" @@ -10206,6 +11122,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/strict-uri-encode/-/strict-uri-encode-1.1.0.tgz", "integrity": "sha512-R3f198pcvnB+5IpnBlRkphuE9n46WyVl8I39W/ZUTZLz4nqSP/oLYUrcnJrw462Ds8he4YKMov2efsTIw1BDGQ==", + "license": "MIT", "engines": { "node": ">=0.10.0" } @@ -10214,6 +11131,7 @@ "version": "1.3.0", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==", + "license": "MIT", "dependencies": { "safe-buffer": "~5.2.0" } @@ -10222,6 +11140,7 @@ "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "license": "MIT", "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -10231,37 +11150,18 @@ "node": ">=8" } }, - "node_modules/string-width-cjs": { - "name": "string-width", - "version": "4.2.3", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", - "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", - "dev": true, - "dependencies": { - "emoji-regex": "^8.0.0", - "is-fullwidth-code-point": "^3.0.0", - "strip-ansi": "^6.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/string-width-cjs/node_modules/emoji-regex": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", - "dev": true - }, "node_modules/string-width/node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "license": "MIT" }, "node_modules/string.prototype.includes": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/string.prototype.includes/-/string.prototype.includes-2.0.1.tgz", "integrity": "sha512-o7+c9bW6zpAdJHTtujeePODAhkuicdAryFsfVKwA+wGw89wJ4GTY484WTucM9hLtDEOpOvI+aHnzqnC5lHp4Rg==", "dev": true, + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -10275,6 +11175,7 @@ "version": "4.0.12", "resolved": "https://registry.npmjs.org/string.prototype.matchall/-/string.prototype.matchall-4.0.12.tgz", "integrity": "sha512-6CC9uyBL+/48dYizRf7H7VAYCMCNTBeM78x/VTUe9bFEaxBepPJDa1Ow99LqI/1yF7kuy7Q3cQsYMrcjGUcskA==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", @@ -10302,6 +11203,7 @@ "resolved": "https://registry.npmjs.org/string.prototype.repeat/-/string.prototype.repeat-1.0.0.tgz", "integrity": "sha512-0u/TldDbKD8bFCQ/4f5+mNRrXwZ8hg2w7ZR8wa16e8z9XpePWl3eGEcUD0OXpEH/VJH/2G3gjUtR3ZOiBe2S/w==", "dev": true, + "license": "MIT", "dependencies": { "define-properties": "^1.1.3", "es-abstract": "^1.17.5" @@ -10311,6 +11213,7 @@ "version": "1.2.10", "resolved": "https://registry.npmjs.org/string.prototype.trim/-/string.prototype.trim-1.2.10.tgz", "integrity": "sha512-Rs66F0P/1kedk5lyYyH9uBzuiI/kNRmwJAR9quK6VOtIpZ2G+hMZd+HQbbv25MgCA6gEffoMZYxlTod4WcdrKA==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", @@ -10331,6 +11234,7 @@ "version": "1.0.9", "resolved": "https://registry.npmjs.org/string.prototype.trimend/-/string.prototype.trimend-1.0.9.tgz", "integrity": "sha512-G7Ok5C6E/j4SGfyLCloXTrngQIQU3PWtXGst3yM7Bea9FRURf1S42ZHlZZtsNque2FN2PoUhfZXYLNWwEr4dLQ==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", @@ -10348,6 +11252,7 @@ "version": "1.0.8", "resolved": "https://registry.npmjs.org/string.prototype.trimstart/-/string.prototype.trimstart-1.0.8.tgz", "integrity": "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", @@ -10364,6 +11269,7 @@ "version": "3.3.0", "resolved": "https://registry.npmjs.org/stringify-object/-/stringify-object-3.3.0.tgz", "integrity": "sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==", + "license": "BSD-2-Clause", "dependencies": { "get-own-enumerable-property-symbols": "^3.0.0", "is-obj": "^1.0.1", @@ -10377,19 +11283,7 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dependencies": { - "ansi-regex": "^5.0.1" - }, - "engines": { - "node": ">=8" - } - }, - "node_modules/strip-ansi-cjs": { - "name": "strip-ansi", - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", - "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", - "dev": true, + "license": "MIT", "dependencies": { "ansi-regex": "^5.0.1" }, @@ -10401,6 +11295,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/strip-comments/-/strip-comments-2.0.1.tgz", "integrity": "sha512-ZprKx+bBLXv067WTCALv8SSz5l2+XhpYCsVtSqlMnkAXMWDq+/ekVbl1ghqP9rUHTzv6sm/DwCOiYutU/yp1fw==", + "license": "MIT", "engines": { "node": ">=10" } @@ -10409,6 +11304,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/strip-indent/-/strip-indent-3.0.0.tgz", "integrity": "sha512-laJTa3Jb+VQpaC6DseHhF7dXVqHTfJPCRDaEbid/drOhgitgYku/letMUqOXFoWV0zIIUbjpdH2t+tYj4bQMRQ==", + "license": "MIT", "dependencies": { "min-indent": "^1.0.0" }, @@ -10421,6 +11317,7 @@ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" }, @@ -10428,10 +11325,26 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/stubborn-fs": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/stubborn-fs/-/stubborn-fs-2.0.0.tgz", + "integrity": "sha512-Y0AvSwDw8y+nlSNFXMm2g6L51rBGdAQT20J3YSOqxC53Lo3bjWRtr2BKcfYoAf352WYpsZSTURrA0tqhfgudPA==", + "license": "MIT", + "dependencies": { + "stubborn-utils": "^1.0.1" + } + }, + "node_modules/stubborn-utils": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/stubborn-utils/-/stubborn-utils-1.0.2.tgz", + "integrity": "sha512-zOh9jPYI+xrNOyisSelgym4tolKTJCQd5GBhK0+0xJvcYDcwlOoxF/rnFKQ2KRZknXSG9jWAp66fwP6AxN9STg==", + "license": "MIT" + }, "node_modules/supports-color": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "license": "MIT", "dependencies": { "has-flag": "^4.0.0" }, @@ -10443,6 +11356,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz", "integrity": "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==", + "license": "MIT", "engines": { "node": ">= 0.4" }, @@ -10454,12 +11368,14 @@ "version": "3.2.4", "resolved": "https://registry.npmjs.org/symbol-tree/-/symbol-tree-3.2.4.tgz", "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/temp-dir": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/temp-dir/-/temp-dir-2.0.0.tgz", "integrity": "sha512-aoBAniQmmwtcKp/7BzsH8Cxzv8OL736p7v1ihGb5e9DJ9kTwGWHrQrVB5+lfVDzfGrdRzXch+ig7LHaY1JTOrg==", + "license": "MIT", "engines": { "node": ">=8" } @@ -10468,6 +11384,7 @@ "version": "0.6.0", "resolved": "https://registry.npmjs.org/tempy/-/tempy-0.6.0.tgz", "integrity": "sha512-G13vtMYPT/J8A4X2SjdtBTphZlrp1gKv6hZiOjw14RCWg6GbHuQBGtjlx75xLbYV/wEc0D7G5K4rxKP/cXk8Bw==", + "license": "MIT", "dependencies": { "is-stream": "^2.0.0", "temp-dir": "^2.0.0", @@ -10481,24 +11398,26 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/term-size": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/term-size/-/term-size-2.2.1.tgz", - "integrity": "sha512-wK0Ri4fOGjv/XPy8SBHZChl8CM7uMc5VML7SqiQ0zG7+J5Vr+RMQDoHa2CNT6KHUnTGIXH34UDMkPzAUyapBZg==", + "node_modules/tempy/node_modules/type-fest": { + "version": "0.16.0", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.16.0.tgz", + "integrity": "sha512-eaBzG6MxNzEn9kiwvtre90cXaNLkmadMWa1zQMs3XORCXNbsH/OewwbxC5ia9dCxIxnTAsSxXJaa/p5y8DlvJg==", + "license": "(MIT OR CC0-1.0)", "engines": { - "node": ">=8" + "node": ">=10" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/terser": { - "version": "5.39.2", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.39.2.tgz", - "integrity": "sha512-yEPUmWve+VA78bI71BW70Dh0TuV4HHd+I5SHOAfS1+QBOmvmCiiffgjR8ryyEd3KIfvPGFqoADt8LdQ6XpXIvg==", + "version": "5.46.1", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.46.1.tgz", + "integrity": "sha512-vzCjQO/rgUuK9sf8VJZvjqiqiHFaZLnOiimmUuOKODxWL8mm/xua7viT7aqX7dgPY60otQjUotzFMmCB4VdmqQ==", + "license": "BSD-2-Clause", "dependencies": { "@jridgewell/source-map": "^0.3.3", - "acorn": "^8.14.0", + "acorn": "^8.15.0", "commander": "^2.20.0", "source-map-support": "~0.5.20" }, @@ -10509,96 +11428,57 @@ "node": ">=10" } }, - "node_modules/test-exclude": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-7.0.1.tgz", - "integrity": "sha512-pFYqmTw68LXVjeWJMST4+borgQP2AyMNbg1BpZh9LbyhUeNkeaPF9gzfPGUAnSMV3qPYdWUwDIjjCLiSDOl7vg==", - "dev": true, - "dependencies": { - "@istanbuljs/schema": "^0.1.2", - "glob": "^10.4.1", - "minimatch": "^9.0.4" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/test-exclude/node_modules/glob": { - "version": "10.4.5", - "resolved": "https://registry.npmjs.org/glob/-/glob-10.4.5.tgz", - "integrity": "sha512-7Bv8RF0k6xjo7d4A/PxYLbUCfb6c+Vpd2/mB2yRDlew7Jb5hEXiCD9ibfO7wpk8i4sevK6DFny9h7EYbM3/sHg==", - "dev": true, - "dependencies": { - "foreground-child": "^3.1.0", - "jackspeak": "^3.1.2", - "minimatch": "^9.0.4", - "minipass": "^7.1.2", - "package-json-from-dist": "^1.0.0", - "path-scurry": "^1.11.1" - }, - "bin": { - "glob": "dist/esm/bin.mjs" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, - "node_modules/test-exclude/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", - "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/text-table": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/through": { "version": "2.3.8", "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", - "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==" + "integrity": "sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==", + "license": "MIT" }, "node_modules/tiny-invariant": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.3.3.tgz", - "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==" + "integrity": "sha512-+FbBPE1o9QAYvviau/qC5SE3caw21q3xkvWKBtja5vgqOWIHHJ3ioaq1VPfn/Szqctz2bU/oYeKd9/z5BL+PVg==", + "license": "MIT" }, "node_modules/tiny-warning": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", - "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==" + "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==", + "license": "MIT" }, "node_modules/tinybench": { "version": "2.9.0", "resolved": "https://registry.npmjs.org/tinybench/-/tinybench-2.9.0.tgz", "integrity": "sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/tinyexec": { - "version": "0.3.2", - "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz", - "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==", - "dev": true + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.4.tgz", + "integrity": "sha512-u9r3uZC0bdpGOXtlxUIdwf9pkmvhqJdrVCH9fapQtgy/OeTTMZ1nqH7agtvEfmGui6e1XxjcdrlxvxJvc3sMqw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=18" + } }, "node_modules/tinyglobby": { - "version": "0.2.13", - "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.13.tgz", - "integrity": "sha512-mEwzpUgrLySlveBwEVDMKk5B57bhLPYovRfPAXD5gA/98Opn0rCDj3GtLwFvCvH5RK9uPCExUROW5NjDwvqkxw==", + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", "dev": true, + "license": "MIT", "dependencies": { - "fdir": "^6.4.4", - "picomatch": "^4.0.2" + "fdir": "^6.5.0", + "picomatch": "^4.0.3" }, "engines": { "node": ">=12.0.0" @@ -10608,10 +11488,14 @@ } }, "node_modules/tinyglobby/node_modules/fdir": { - "version": "6.4.4", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", - "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, "peerDependencies": { "picomatch": "^3 || ^4" }, @@ -10622,10 +11506,11 @@ } }, "node_modules/tinyglobby/node_modules/picomatch": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", - "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" }, @@ -10633,29 +11518,12 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, - "node_modules/tinypool": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/tinypool/-/tinypool-1.0.2.tgz", - "integrity": "sha512-al6n+QEANGFOMf/dmUMsuS5/r9B06uwlyNjZZql/zv8J7ybHCgoihBNORZCY2mzUuAnomQa2JdhyHKzZxPCrFA==", - "dev": true, - "engines": { - "node": "^18.0.0 || >=20.0.0" - } - }, "node_modules/tinyrainbow": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-2.0.0.tgz", - "integrity": "sha512-op4nsTR47R6p0vMUUoYl/a+ljLFVtlfaXkLQmqfLR1qHma1h/ysYk4hEXZ880bf2CYgTskvTa/e196Vd5dDQXw==", - "dev": true, - "engines": { - "node": ">=14.0.0" - } - }, - "node_modules/tinyspy": { - "version": "3.0.2", - "resolved": "https://registry.npmjs.org/tinyspy/-/tinyspy-3.0.2.tgz", - "integrity": "sha512-n1cw8k1k0x4pgA2+9XrOkFydTerNcJ1zWCO5Nn9scWHTD+5tp8dghT2x1uduQePZTZgd3Tupf+x9BxJjeJi77Q==", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.1.0.tgz", + "integrity": "sha512-Bf+ILmBgretUrdJxzXM0SgXLZ3XfiaUuOj/IKQHuTXip+05Xn+uyEYdVg0kYDipTBcLrCVyUzAPz7QmArb0mmw==", "dev": true, + "license": "MIT", "engines": { "node": ">=14.0.0" } @@ -10665,6 +11533,7 @@ "resolved": "https://registry.npmjs.org/tldts/-/tldts-6.1.86.tgz", "integrity": "sha512-WMi/OQ2axVTf/ykqCQgXiIct+mSQDFdH2fkwhPwgEwvJ1kSzZRiinb0zF2Xb8u4+OqPChmyI6MEu4EezNJz+FQ==", "dev": true, + "license": "MIT", "dependencies": { "tldts-core": "^6.1.86" }, @@ -10676,12 +11545,14 @@ "version": "6.1.86", "resolved": "https://registry.npmjs.org/tldts-core/-/tldts-core-6.1.86.tgz", "integrity": "sha512-Je6p7pkk+KMzMv2XXKmAE3McmolOQFdxkKw0R8EYNr7sELW46JqnNeTX8ybPiQgvg1ymCoF8LXs5fzFaZvJPTA==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/tmp": { "version": "0.0.33", "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz", "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==", + "license": "MIT", "dependencies": { "os-tmpdir": "~1.0.2" }, @@ -10689,18 +11560,11 @@ "node": ">=0.6.0" } }, - "node_modules/to-readable-stream": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/to-readable-stream/-/to-readable-stream-1.0.0.tgz", - "integrity": "sha512-Iq25XBt6zD5npPhlLVXGFN3/gyR2/qODcKNNyTMd4vbm39HUaOiAM4PMq0eMVC/Tkxz+Zjdsc55g9yyz+Yq00Q==", - "engines": { - "node": ">=6" - } - }, "node_modules/to-regex-range": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "license": "MIT", "dependencies": { "is-number": "^7.0.0" }, @@ -10713,6 +11577,7 @@ "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-5.1.2.tgz", "integrity": "sha512-FVDYdxtnj0G6Qm/DhNPSb8Ju59ULcup3tuJxkFb5K8Bv2pUXILbf0xZWU8PX8Ov19OXljbUyveOFwRMwkXzO+A==", "dev": true, + "license": "BSD-3-Clause", "dependencies": { "tldts": "^6.1.32" }, @@ -10725,6 +11590,7 @@ "resolved": "https://registry.npmjs.org/tr46/-/tr46-5.1.1.tgz", "integrity": "sha512-hdF5ZgjTqgAntKkklYw0R03MG2x/bSzTtkxmIRw/sTNV8YXsCJ1tfLAX23lhxhHJlEf3CRCOCGGWw3vI3GaSPw==", "dev": true, + "license": "MIT", "dependencies": { "punycode": "^2.3.1" }, @@ -10736,6 +11602,7 @@ "version": "3.0.1", "resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.1.tgz", "integrity": "sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==", + "license": "MIT", "engines": { "node": ">=8" } @@ -10745,6 +11612,7 @@ "resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-1.4.3.tgz", "integrity": "sha512-i3eMG77UTMD0hZhgRS562pv83RC6ukSAC2GMNWc+9dieh/+jDM5u5YG+NHX6VNDRHQcHwmsTHctP9LhbC3WxVw==", "dev": true, + "license": "MIT", "engines": { "node": ">=16" }, @@ -10755,13 +11623,15 @@ "node_modules/tslib": { "version": "2.8.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", - "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==" + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "license": "0BSD" }, "node_modules/type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", "dev": true, + "license": "MIT", "dependencies": { "prelude-ls": "^1.2.1" }, @@ -10770,9 +11640,11 @@ } }, "node_modules/type-fest": { - "version": "0.16.0", - "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.16.0.tgz", - "integrity": "sha512-eaBzG6MxNzEn9kiwvtre90cXaNLkmadMWa1zQMs3XORCXNbsH/OewwbxC5ia9dCxIxnTAsSxXJaa/p5y8DlvJg==", + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "license": "(MIT OR CC0-1.0)", "engines": { "node": ">=10" }, @@ -10784,6 +11656,7 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/typed-array-buffer/-/typed-array-buffer-1.0.3.tgz", "integrity": "sha512-nAYYwfY3qnzX30IkA6AQZjVbtK6duGontcQm1WSG1MD94YLqK0515GNApXkoxKOWMusVssAHWLh9SeaoefYFGw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "es-errors": "^1.3.0", @@ -10797,6 +11670,7 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/typed-array-byte-length/-/typed-array-byte-length-1.0.3.tgz", "integrity": "sha512-BaXgOuIxz8n8pIq3e7Atg/7s+DpiYrxn4vdot3w9KbnBhcRQq6o3xemQdIfynqSeXeDrF32x+WvfzmOjPiY9lg==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.8", "for-each": "^0.3.3", @@ -10815,6 +11689,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/typed-array-byte-offset/-/typed-array-byte-offset-1.0.4.tgz", "integrity": "sha512-bTlAFB/FBYMcuX81gbL4OcpH5PmlFHqlCCpAl8AlEzMz5k53oNDvN8p1PNOWLEmI2x4orp3raOFB51tv9X+MFQ==", + "license": "MIT", "dependencies": { "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", @@ -10835,6 +11710,7 @@ "version": "1.0.7", "resolved": "https://registry.npmjs.org/typed-array-length/-/typed-array-length-1.0.7.tgz", "integrity": "sha512-3KS2b+kL7fsuk/eJZ7EQdnEmQoaho/r6KUef7hxvltNA5DR8NAUM+8wJMbJyZ4G9/7i3v5zPBIMN5aybAh2/Jg==", + "license": "MIT", "dependencies": { "call-bind": "^1.0.7", "for-each": "^0.3.3", @@ -10850,19 +11726,12 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/typedarray-to-buffer": { - "version": "3.1.5", - "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", - "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", - "dependencies": { - "is-typedarray": "^1.0.0" - } - }, "node_modules/typescript": { - "version": "5.8.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", - "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", "dev": true, + "license": "Apache-2.0", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -10875,6 +11744,7 @@ "version": "0.0.2", "resolved": "https://registry.npmjs.org/typescript-compare/-/typescript-compare-0.0.2.tgz", "integrity": "sha512-8ja4j7pMHkfLJQO2/8tut7ub+J3Lw2S3061eJLFQcvs3tsmJKp8KG5NtpLn7KcY2w08edF74BSVN7qJS0U6oHA==", + "license": "MIT", "dependencies": { "typescript-logic": "^0.0.0" } @@ -10882,12 +11752,14 @@ "node_modules/typescript-logic": { "version": "0.0.0", "resolved": "https://registry.npmjs.org/typescript-logic/-/typescript-logic-0.0.0.tgz", - "integrity": "sha512-zXFars5LUkI3zP492ls0VskH3TtdeHCqu0i7/duGt60i5IGPIpAHE/DWo5FqJ6EjQ15YKXrt+AETjv60Dat34Q==" + "integrity": "sha512-zXFars5LUkI3zP492ls0VskH3TtdeHCqu0i7/duGt60i5IGPIpAHE/DWo5FqJ6EjQ15YKXrt+AETjv60Dat34Q==", + "license": "MIT" }, "node_modules/typescript-tuple": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/typescript-tuple/-/typescript-tuple-2.2.1.tgz", "integrity": "sha512-Zcr0lbt8z5ZdEzERHAMAniTiIKerFCMgd7yjq1fPnDJ43et/k9twIFQMUYff9k5oXcsQ0WpvFcgzK2ZKASoW6Q==", + "license": "MIT", "dependencies": { "typescript-compare": "^0.0.2" } @@ -10896,6 +11768,7 @@ "version": "1.1.0", "resolved": "https://registry.npmjs.org/unbox-primitive/-/unbox-primitive-1.1.0.tgz", "integrity": "sha512-nWJ91DjeOkej/TA8pXQ3myruKpKEYgqvpw9lz4OPHj/NWFNluYrjbz9j01CJ8yKQd2g4jFoOkINCTW2I5LEEyw==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.3", "has-bigints": "^1.0.2", @@ -10910,15 +11783,17 @@ } }, "node_modules/undici-types": { - "version": "6.21.0", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.21.0.tgz", - "integrity": "sha512-iwDZqg0QAGrg9Rav5H4n0M64c3mkR59cJ6wQp+7C4nI0gsmExaedaYLNO44eT4AtBBwjbTiGPMlt2Md0T9H9JQ==", - "devOptional": true + "version": "7.16.0", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.16.0.tgz", + "integrity": "sha512-Zz+aZWSj8LE6zoxD+xrjh4VfkIG8Ya6LvYkZqtUQGJPZjYl53ypCaUwWqo7eI0x66KBGeRo+mlBEkMSeSZ38Nw==", + "devOptional": true, + "license": "MIT" }, "node_modules/unicode-canonical-property-names-ecmascript": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.1.tgz", "integrity": "sha512-dA8WbNeb2a6oQzAQ55YlT5vQAWGV9WXOsi3SskE3bcCdM0P4SDd+24zS/OCacdRq5BkdsRj9q3Pg6YyQoxIGqg==", + "license": "MIT", "engines": { "node": ">=4" } @@ -10927,6 +11802,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/unicode-match-property-ecmascript/-/unicode-match-property-ecmascript-2.0.0.tgz", "integrity": "sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==", + "license": "MIT", "dependencies": { "unicode-canonical-property-names-ecmascript": "^2.0.0", "unicode-property-aliases-ecmascript": "^2.0.0" @@ -10936,17 +11812,19 @@ } }, "node_modules/unicode-match-property-value-ecmascript": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.0.tgz", - "integrity": "sha512-4IehN3V/+kkr5YeSSDDQG8QLqO26XpL2XP3GQtqwlT/QYSECAwFztxVHjlbh0+gjJ3XmNLS0zDsbgs9jWKExLg==", + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/unicode-match-property-value-ecmascript/-/unicode-match-property-value-ecmascript-2.2.1.tgz", + "integrity": "sha512-JQ84qTuMg4nVkx8ga4A16a1epI9H6uTXAknqxkGF/aFfRLw1xC/Bp24HNLaZhHSkWd3+84t8iXnp1J0kYcZHhg==", + "license": "MIT", "engines": { "node": ">=4" } }, "node_modules/unicode-property-aliases-ecmascript": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.1.0.tgz", - "integrity": "sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/unicode-property-aliases-ecmascript/-/unicode-property-aliases-ecmascript-2.2.0.tgz", + "integrity": "sha512-hpbDzxUY9BFwX+UeBnxv3Sh1q7HFxj48DTmXchNgRa46lO8uj3/1iEn3MiNUYTg1g9ctIqXCCERn8gYZhHC5lQ==", + "license": "MIT", "engines": { "node": ">=4" } @@ -10955,6 +11833,7 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/unique-string/-/unique-string-2.0.0.tgz", "integrity": "sha512-uNaeirEPvpZWSgzwsPGtU2zVSTrn/8L5q/IexZmH0eH6SA73CmAA5U4GwORTxQAZs95TAXLNqeLoPPNO5gZfWg==", + "license": "MIT", "dependencies": { "crypto-random-string": "^2.0.0" }, @@ -10966,6 +11845,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "license": "MIT", "engines": { "node": ">= 10.0.0" } @@ -10974,15 +11854,16 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/upath/-/upath-1.2.0.tgz", "integrity": "sha512-aZwGpamFO61g3OlfT7OQCHqhGnW43ieH9WZeP7QxN/G/jS4jfqUkZxoryvJgVPEcrl5NL/ggHsSmLMHuH64Lhg==", + "license": "MIT", "engines": { "node": ">=4", "yarn": "*" } }, "node_modules/update-browserslist-db": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.1.3.tgz", - "integrity": "sha512-UxhIZQ+QInVdunkDAaiazvvT/+fXL5Osr0JZlJulepYu6Jd7qJtDZjlur0emRlT71EN3ScPoE7gvsuIKKNavKw==", + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", + "integrity": "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==", "funding": [ { "type": "opencollective", @@ -10997,6 +11878,7 @@ "url": "https://github.com/sponsors/ai" } ], + "license": "MIT", "dependencies": { "escalade": "^3.2.0", "picocolors": "^1.1.1" @@ -11009,84 +11891,74 @@ } }, "node_modules/update-notifier": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-4.1.3.tgz", - "integrity": "sha512-Yld6Z0RyCYGB6ckIjffGOSOmHXj1gMeE7aROz4MG+XMkmixBX4jUngrGXNYz7wPKBmtoD4MnBa2Anu7RSKht/A==", + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/update-notifier/-/update-notifier-7.3.1.tgz", + "integrity": "sha512-+dwUY4L35XFYEzE+OAL3sarJdUioVovq+8f7lcIJ7wnmnYQV5UD1Y/lcwaMSyaQ6Bj3JMj1XSTjZbNLHn/19yA==", + "license": "BSD-2-Clause", "dependencies": { - "boxen": "^4.2.0", - "chalk": "^3.0.0", - "configstore": "^5.0.1", - "has-yarn": "^2.1.0", - "import-lazy": "^2.1.0", - "is-ci": "^2.0.0", - "is-installed-globally": "^0.3.1", - "is-npm": "^4.0.0", - "is-yarn-global": "^0.3.0", - "latest-version": "^5.0.0", - "pupa": "^2.0.1", - "semver-diff": "^3.1.1", - "xdg-basedir": "^4.0.0" + "boxen": "^8.0.1", + "chalk": "^5.3.0", + "configstore": "^7.0.0", + "is-in-ci": "^1.0.0", + "is-installed-globally": "^1.0.0", + "is-npm": "^6.0.0", + "latest-version": "^9.0.0", + "pupa": "^3.1.0", + "semver": "^7.6.3", + "xdg-basedir": "^5.1.0" }, "engines": { - "node": ">=8" + "node": ">=18" }, "funding": { "url": "https://github.com/yeoman/update-notifier?sponsor=1" } }, "node_modules/update-notifier/node_modules/chalk": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", - "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, + "version": "5.6.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.6.2.tgz", + "integrity": "sha512-7NzBL0rN6fMUW+f7A6Io4h40qQlG+xGmtMxfbnH/K7TAtt8JQWVQK+6g0UXKMeVJoyV5EkkNsErQ8pVD3bLHbA==", + "license": "MIT", "engines": { - "node": ">=8" + "node": "^12.17.0 || ^14.13 || >=16.0.0" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" } }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, + "license": "BSD-2-Clause", "dependencies": { "punycode": "^2.1.0" } }, - "node_modules/url-parse-lax": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/url-parse-lax/-/url-parse-lax-3.0.0.tgz", - "integrity": "sha512-NjFKA0DidqPa5ciFcSrXnAltTtzz84ogy+NebPvfEgAck0+TNg4UJ4IN+fB7zRZfbgUf0syOo9MDxFkDSMuFaQ==", - "dependencies": { - "prepend-http": "^2.0.0" - }, - "engines": { - "node": ">=4" - } - }, "node_modules/util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", - "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==" + "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==", + "license": "MIT" }, "node_modules/uuid": { - "version": "11.1.0", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-11.1.0.tgz", - "integrity": "sha512-0/A9rDy9P7cJ+8w1c9WD9V//9Wj15Ce2MPz8Ri6032usz+NfePxx5AcN3bN+r6ZL6jEo066/yNYB3tn4pQEx+A==", + "version": "13.0.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-13.0.0.tgz", + "integrity": "sha512-XQegIaBTVUjSHliKqcnFqYypAd4S+WCYt5NIeRs6w/UAry7z8Y9j5ZwRRL4kzq9U3sD6v+85er9FvkEaBpji2w==", "funding": [ "https://github.com/sponsors/broofa", "https://github.com/sponsors/ctavan" ], + "license": "MIT", "bin": { - "uuid": "dist/esm/bin/uuid" + "uuid": "dist-node/bin/uuid" } }, "node_modules/validate-npm-package-license": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", "integrity": "sha512-DpKm2Ui/xN7/HQKCtpZxoRWBhZ9Z0kqtygG8XCgNQ8ZlDnxuQmWhj566j8fN4Cu3/JmbhsDo7fcAJq4s9h27Ew==", + "license": "Apache-2.0", "dependencies": { "spdx-correct": "^3.0.0", "spdx-expression-parse": "^3.0.0" @@ -11095,26 +11967,28 @@ "node_modules/value-equal": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz", - "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==" + "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==", + "license": "MIT" }, "node_modules/vite": { - "version": "6.3.5", - "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.5.tgz", - "integrity": "sha512-cZn6NDFE7wdTpINgs++ZJ4N49W2vRp8LCKrn3Ob1kYNtOo21vfDoaV5GzBfLU4MovSAB8uNRm4jgzVQZ+mBzPQ==", + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.2.tgz", + "integrity": "sha512-Bby3NOsna2jsjfLVOHKes8sGwgl4TT0E6vvpYgnAYDIF/tie7MRaFthmKuHx1NSXjiTueXH3do80FMQgvEktRg==", "dev": true, + "license": "MIT", "dependencies": { - "esbuild": "^0.25.0", - "fdir": "^6.4.4", - "picomatch": "^4.0.2", - "postcss": "^8.5.3", - "rollup": "^4.34.9", - "tinyglobby": "^0.2.13" + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" }, "bin": { "vite": "bin/vite.js" }, "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + "node": "^20.19.0 || >=22.12.0" }, "funding": { "url": "https://github.com/vitejs/vite?sponsor=1" @@ -11123,14 +11997,14 @@ "fsevents": "~2.3.3" }, "peerDependencies": { - "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", + "@types/node": "^20.19.0 || >=22.12.0", "jiti": ">=1.21.0", - "less": "*", + "less": "^4.0.0", "lightningcss": "^1.21.0", - "sass": "*", - "sass-embedded": "*", - "stylus": "*", - "sugarss": "*", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", "terser": "^5.16.0", "tsx": "^4.8.1", "yaml": "^2.4.2" @@ -11171,39 +12045,18 @@ } } }, - "node_modules/vite-node": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/vite-node/-/vite-node-3.1.4.tgz", - "integrity": "sha512-6enNwYnpyDo4hEgytbmc6mYWHXDHYEn0D1/rw4Q+tnHUGtKTJsn8T1YkX6Q18wI5LCrS8CTYlBaiCqxOy2kvUA==", - "dev": true, - "dependencies": { - "cac": "^6.7.14", - "debug": "^4.4.0", - "es-module-lexer": "^1.7.0", - "pathe": "^2.0.3", - "vite": "^5.0.0 || ^6.0.0" - }, - "bin": { - "vite-node": "vite-node.mjs" - }, - "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" - }, - "funding": { - "url": "https://opencollective.com/vitest" - } - }, "node_modules/vite-plugin-pwa": { - "version": "0.21.2", - "resolved": "https://registry.npmjs.org/vite-plugin-pwa/-/vite-plugin-pwa-0.21.2.tgz", - "integrity": "sha512-vFhH6Waw8itNu37hWUJxL50q+CBbNcMVzsKaYHQVrfxTt3ihk3PeLO22SbiP1UNWzcEPaTQv+YVxe4G0KOjAkg==", + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/vite-plugin-pwa/-/vite-plugin-pwa-1.2.0.tgz", + "integrity": "sha512-a2xld+SJshT9Lgcv8Ji4+srFJL4k/1bVbd1x06JIkvecpQkwkvCncD1+gSzcdm3s+owWLpMJerG3aN5jupJEVw==", "dev": true, + "license": "MIT", "dependencies": { "debug": "^4.3.6", "pretty-bytes": "^6.1.1", "tinyglobby": "^0.2.10", - "workbox-build": "^7.3.0", - "workbox-window": "^7.3.0" + "workbox-build": "^7.4.0", + "workbox-window": "^7.4.0" }, "engines": { "node": ">=16.0.0" @@ -11212,10 +12065,10 @@ "url": "https://github.com/sponsors/antfu" }, "peerDependencies": { - "@vite-pwa/assets-generator": "^0.2.6", - "vite": "^3.1.0 || ^4.0.0 || ^5.0.0 || ^6.0.0", - "workbox-build": "^7.3.0", - "workbox-window": "^7.3.0" + "@vite-pwa/assets-generator": "^1.0.0", + "vite": "^3.1.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0", + "workbox-build": "^7.4.0", + "workbox-window": "^7.4.0" }, "peerDependenciesMeta": { "@vite-pwa/assets-generator": { @@ -11224,10 +12077,14 @@ } }, "node_modules/vite/node_modules/fdir": { - "version": "6.4.4", - "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz", - "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==", + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", "dev": true, + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, "peerDependencies": { "picomatch": "^3 || ^4" }, @@ -11238,10 +12095,11 @@ } }, "node_modules/vite/node_modules/picomatch": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz", - "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" }, @@ -11250,62 +12108,71 @@ } }, "node_modules/vitest": { - "version": "3.1.4", - "resolved": "https://registry.npmjs.org/vitest/-/vitest-3.1.4.tgz", - "integrity": "sha512-Ta56rT7uWxCSJXlBtKgIlApJnT6e6IGmTYxYcmxjJ4ujuZDI59GUQgVDObXXJujOmPDBYXHK1qmaGtneu6TNIQ==", + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/vitest/-/vitest-4.1.2.tgz", + "integrity": "sha512-xjR1dMTVHlFLh98JE3i/f/WePqJsah4A0FK9cc8Ehp9Udk0AZk6ccpIZhh1qJ/yxVWRZ+Q54ocnD8TXmkhspGg==", "dev": true, + "license": "MIT", "dependencies": { - "@vitest/expect": "3.1.4", - "@vitest/mocker": "3.1.4", - "@vitest/pretty-format": "^3.1.4", - "@vitest/runner": "3.1.4", - "@vitest/snapshot": "3.1.4", - "@vitest/spy": "3.1.4", - "@vitest/utils": "3.1.4", - "chai": "^5.2.0", - "debug": "^4.4.0", - "expect-type": "^1.2.1", - "magic-string": "^0.30.17", + "@vitest/expect": "4.1.2", + "@vitest/mocker": "4.1.2", + "@vitest/pretty-format": "4.1.2", + "@vitest/runner": "4.1.2", + "@vitest/snapshot": "4.1.2", + "@vitest/spy": "4.1.2", + "@vitest/utils": "4.1.2", + "es-module-lexer": "^2.0.0", + "expect-type": "^1.3.0", + "magic-string": "^0.30.21", + "obug": "^2.1.1", "pathe": "^2.0.3", - "std-env": "^3.9.0", + "picomatch": "^4.0.3", + "std-env": "^4.0.0-rc.1", "tinybench": "^2.9.0", - "tinyexec": "^0.3.2", - "tinyglobby": "^0.2.13", - "tinypool": "^1.0.2", - "tinyrainbow": "^2.0.0", - "vite": "^5.0.0 || ^6.0.0", - "vite-node": "3.1.4", + "tinyexec": "^1.0.2", + "tinyglobby": "^0.2.15", + "tinyrainbow": "^3.1.0", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0", "why-is-node-running": "^2.3.0" }, "bin": { "vitest": "vitest.mjs" }, "engines": { - "node": "^18.0.0 || ^20.0.0 || >=22.0.0" + "node": "^20.0.0 || ^22.0.0 || >=24.0.0" }, "funding": { "url": "https://opencollective.com/vitest" }, "peerDependencies": { "@edge-runtime/vm": "*", - "@types/debug": "^4.1.12", - "@types/node": "^18.0.0 || ^20.0.0 || >=22.0.0", - "@vitest/browser": "3.1.4", - "@vitest/ui": "3.1.4", + "@opentelemetry/api": "^1.9.0", + "@types/node": "^20.0.0 || ^22.0.0 || >=24.0.0", + "@vitest/browser-playwright": "4.1.2", + "@vitest/browser-preview": "4.1.2", + "@vitest/browser-webdriverio": "4.1.2", + "@vitest/ui": "4.1.2", "happy-dom": "*", - "jsdom": "*" + "jsdom": "*", + "vite": "^6.0.0 || ^7.0.0 || ^8.0.0" }, "peerDependenciesMeta": { "@edge-runtime/vm": { "optional": true }, - "@types/debug": { + "@opentelemetry/api": { "optional": true }, "@types/node": { "optional": true }, - "@vitest/browser": { + "@vitest/browser-playwright": { + "optional": true + }, + "@vitest/browser-preview": { + "optional": true + }, + "@vitest/browser-webdriverio": { "optional": true }, "@vitest/ui": { @@ -11316,14 +12183,31 @@ }, "jsdom": { "optional": true + }, + "vite": { + "optional": false } } }, + "node_modules/vitest/node_modules/picomatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, "node_modules/w3c-xmlserializer": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/w3c-xmlserializer/-/w3c-xmlserializer-5.0.0.tgz", "integrity": "sha512-o8qghlI8NZHU1lLPrpi2+Uq7abh4GGPpYANlalzWxyWteJOCsr/P+oPBA49TOLu5FTZO4d3F9MnWJfiMo4BkmA==", "dev": true, + "license": "MIT", "dependencies": { "xml-name-validator": "^5.0.0" }, @@ -11335,6 +12219,7 @@ "version": "4.0.3", "resolved": "https://registry.npmjs.org/warning/-/warning-4.0.3.tgz", "integrity": "sha512-rpJyN222KWIvHJ/F53XSZv0Zl/accqHR8et1kpaMTD/fLCRxtV8iX8czMzY7sVZupTI3zcUTg8eycS2kNF9l6w==", + "license": "MIT", "dependencies": { "loose-envify": "^1.0.0" } @@ -11343,6 +12228,7 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/wcwidth/-/wcwidth-1.0.1.tgz", "integrity": "sha512-XHPEwS0q6TaxcvG85+8EYkbiCux2XtWG2mkc47Ng2A77BQu9+DqIOJldST4HgPkuea7dvKSj5VgX3P1d4rW8Tg==", + "license": "MIT", "dependencies": { "defaults": "^1.0.3" } @@ -11352,6 +12238,7 @@ "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-7.0.0.tgz", "integrity": "sha512-VwddBukDzu71offAQR975unBIGqfKZpM+8ZX6ySk8nYhVoo5CYaZyzt3YBvYtRtO+aoGlqxPg/B87NGVZ/fu6g==", "dev": true, + "license": "BSD-2-Clause", "engines": { "node": ">=12" } @@ -11360,7 +12247,9 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz", "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==", + "deprecated": "Use @exodus/bytes instead for a more spec-conformant and faster implementation", "dev": true, + "license": "MIT", "dependencies": { "iconv-lite": "0.6.3" }, @@ -11373,6 +12262,7 @@ "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-3.0.0.tgz", "integrity": "sha512-nt+N2dzIutVRxARx1nghPKGv1xHikU7HKdfafKkLNLindmPU/ch3U31NOCGGA/dmPcmb1VlofO0vnKAcsm0o/Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=12" } @@ -11382,6 +12272,7 @@ "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-14.2.0.tgz", "integrity": "sha512-De72GdQZzNTUBBChsXueQUnPKDkg/5A5zp7pFDuQAj5UFoENpiACU0wlCvzpAGnTkj++ihpKwKyYewn/XNUbKw==", "dev": true, + "license": "MIT", "dependencies": { "tr46": "^5.1.0", "webidl-conversions": "^7.0.0" @@ -11390,11 +12281,17 @@ "node": ">=18" } }, + "node_modules/when-exit": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/when-exit/-/when-exit-2.1.5.tgz", + "integrity": "sha512-VGkKJ564kzt6Ms1dbgPP/yuIoQCrsFAnRbptpC5wOEsDaNsbCB2bnfnaA8i/vRs5tjUSEOtIuvl9/MyVsvQZCg==", + "license": "MIT" + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", - "dev": true, + "license": "ISC", "dependencies": { "isexe": "^2.0.0" }, @@ -11409,6 +12306,7 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/which-boxed-primitive/-/which-boxed-primitive-1.1.1.tgz", "integrity": "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA==", + "license": "MIT", "dependencies": { "is-bigint": "^1.1.0", "is-boolean-object": "^1.2.1", @@ -11427,6 +12325,7 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/which-builtin-type/-/which-builtin-type-1.2.1.tgz", "integrity": "sha512-6iBczoX+kDQ7a3+YJBnh3T+KZRxM/iYNPXicqk66/Qfm1b93iu+yOImkg0zHbj5LNOcNv1TEADiZ0xa34B4q6Q==", + "license": "MIT", "dependencies": { "call-bound": "^1.0.2", "function.prototype.name": "^1.1.6", @@ -11452,12 +12351,14 @@ "node_modules/which-builtin-type/node_modules/isarray": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", - "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==" + "integrity": "sha512-xHjhDr3cNBK0BzdUJSPXZntQUx/mwMS5Rw4A7lPJ90XGAO6ISP/ePDNuo0vhqOZU+UD5JoodwCAAoZQd3FeAKw==", + "license": "MIT" }, "node_modules/which-collection": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/which-collection/-/which-collection-1.0.2.tgz", "integrity": "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw==", + "license": "MIT", "dependencies": { "is-map": "^2.0.3", "is-set": "^2.0.3", @@ -11472,9 +12373,10 @@ } }, "node_modules/which-typed-array": { - "version": "1.1.19", - "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.19.tgz", - "integrity": "sha512-rEvr90Bck4WZt9HHFC4DJMsjvu7x+r6bImz0/BrbWb7A2djJ8hnZMrWnHo9F8ssv0OMErasDhftrfROTyqSDrw==", + "version": "1.1.20", + "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.20.tgz", + "integrity": "sha512-LYfpUkmqwl0h9A2HL09Mms427Q1RZWuOHsukfVcKRq9q95iQxdw0ix1JQrqbcDR9PH1QDwf5Qo8OZb5lksZ8Xg==", + "license": "MIT", "dependencies": { "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", @@ -11496,6 +12398,7 @@ "resolved": "https://registry.npmjs.org/why-is-node-running/-/why-is-node-running-2.3.0.tgz", "integrity": "sha512-hUrmaWBdVDcxvYqnyh09zunKzROWjbZTiNy8dBEjkS7ehEDQibXJ7XvlmtbwuTclUiIyN+CyXQD4Vmko8fNm8w==", "dev": true, + "license": "MIT", "dependencies": { "siginfo": "^2.0.0", "stackback": "0.0.2" @@ -11508,14 +12411,68 @@ } }, "node_modules/widest-line": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz", - "integrity": "sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/widest-line/-/widest-line-5.0.0.tgz", + "integrity": "sha512-c9bZp7b5YtRj2wOe6dlj32MK+Bx/M/d+9VB2SHM1OtsUHR0aV0tdP6DWh/iMt0kWi1t5g1Iudu6hQRNd1A4PVA==", + "license": "MIT", "dependencies": { - "string-width": "^4.0.0" + "string-width": "^7.0.0" }, "engines": { - "node": ">=8" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/widest-line/node_modules/ansi-regex": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/ansi-regex?sponsor=1" + } + }, + "node_modules/widest-line/node_modules/emoji-regex": { + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", + "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==", + "license": "MIT" + }, + "node_modules/widest-line/node_modules/string-width": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "license": "MIT", + "dependencies": { + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" + }, + "engines": { + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/widest-line/node_modules/strip-ansi": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "license": "MIT", + "dependencies": { + "ansi-regex": "^6.2.2" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/chalk/strip-ansi?sponsor=1" } }, "node_modules/word-wrap": { @@ -11523,31 +12480,35 @@ "resolved": "https://registry.npmjs.org/word-wrap/-/word-wrap-1.2.5.tgz", "integrity": "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.10.0" } }, "node_modules/workbox-background-sync": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-background-sync/-/workbox-background-sync-7.3.0.tgz", - "integrity": "sha512-PCSk3eK7Mxeuyatb22pcSx9dlgWNv3+M8PqPaYDokks8Y5/FX4soaOqj3yhAZr5k6Q5JWTOMYgaJBpbw11G9Eg==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-background-sync/-/workbox-background-sync-7.4.0.tgz", + "integrity": "sha512-8CB9OxKAgKZKyNMwfGZ1XESx89GryWTfI+V5yEj8sHjFH8MFelUwYXEyldEK6M6oKMmn807GoJFUEA1sC4XS9w==", + "license": "MIT", "dependencies": { "idb": "^7.0.1", - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-broadcast-update": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-broadcast-update/-/workbox-broadcast-update-7.3.0.tgz", - "integrity": "sha512-T9/F5VEdJVhwmrIAE+E/kq5at2OY6+OXXgOWQevnubal6sO92Gjo24v6dCVwQiclAF5NS3hlmsifRrpQzZCdUA==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-broadcast-update/-/workbox-broadcast-update-7.4.0.tgz", + "integrity": "sha512-+eZQwoktlvo62cI0b+QBr40v5XjighxPq3Fzo9AWMiAosmpG5gxRHgTbGGhaJv/q/MFVxwFNGh/UwHZ/8K88lA==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-build": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-build/-/workbox-build-7.3.0.tgz", - "integrity": "sha512-JGL6vZTPlxnlqZRhR/K/msqg3wKP+m0wfEUVosK7gsYzSgeIxvZLi1ViJJzVL7CEeI8r7rGFV973RiEqkP3lWQ==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-build/-/workbox-build-7.4.0.tgz", + "integrity": "sha512-Ntk1pWb0caOFIvwz/hfgrov/OJ45wPEhI5PbTywQcYjyZiVhT3UrwwUPl6TRYbTm4moaFYithYnl1lvZ8UjxcA==", + "license": "MIT", "dependencies": { "@apideck/better-ajv-errors": "^0.3.1", "@babel/core": "^7.24.4", @@ -11562,42 +12523,42 @@ "common-tags": "^1.8.0", "fast-json-stable-stringify": "^2.1.0", "fs-extra": "^9.0.1", - "glob": "^7.1.6", + "glob": "^11.0.1", "lodash": "^4.17.20", "pretty-bytes": "^5.3.0", - "rollup": "^2.43.1", + "rollup": "^2.79.2", "source-map": "^0.8.0-beta.0", "stringify-object": "^3.3.0", "strip-comments": "^2.0.1", "tempy": "^0.6.0", "upath": "^1.2.0", - "workbox-background-sync": "7.3.0", - "workbox-broadcast-update": "7.3.0", - "workbox-cacheable-response": "7.3.0", - "workbox-core": "7.3.0", - "workbox-expiration": "7.3.0", - "workbox-google-analytics": "7.3.0", - "workbox-navigation-preload": "7.3.0", - "workbox-precaching": "7.3.0", - "workbox-range-requests": "7.3.0", - "workbox-recipes": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0", - "workbox-streams": "7.3.0", - "workbox-sw": "7.3.0", - "workbox-window": "7.3.0" + "workbox-background-sync": "7.4.0", + "workbox-broadcast-update": "7.4.0", + "workbox-cacheable-response": "7.4.0", + "workbox-core": "7.4.0", + "workbox-expiration": "7.4.0", + "workbox-google-analytics": "7.4.0", + "workbox-navigation-preload": "7.4.0", + "workbox-precaching": "7.4.0", + "workbox-range-requests": "7.4.0", + "workbox-recipes": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0", + "workbox-streams": "7.4.0", + "workbox-sw": "7.4.0", + "workbox-window": "7.4.0" }, "engines": { - "node": ">=16.0.0" + "node": ">=20.0.0" } }, "node_modules/workbox-build/node_modules/@apideck/better-ajv-errors": { - "version": "0.3.6", - "resolved": "https://registry.npmjs.org/@apideck/better-ajv-errors/-/better-ajv-errors-0.3.6.tgz", - "integrity": "sha512-P+ZygBLZtkp0qqOAJJVX4oX/sFo5JR3eBWwwuqHHhK0GIgQOKWrAfiAaWX0aArHkRWHMuggFEgAZNxVPwPZYaA==", + "version": "0.3.7", + "resolved": "https://registry.npmjs.org/@apideck/better-ajv-errors/-/better-ajv-errors-0.3.7.tgz", + "integrity": "sha512-TajUJwGWbDwkCx/CZi7tRE8PVB7simCvKJfHUsSdvps+aTM/PDPP4gkLmKnc+x3CE//y9i/nj74GqdL/hwk7Iw==", + "license": "MIT", "dependencies": { - "json-schema": "^0.4.0", - "jsonpointer": "^5.0.0", + "jsonpointer": "^5.0.1", "leven": "^3.1.0" }, "engines": { @@ -11611,6 +12572,7 @@ "version": "5.3.1", "resolved": "https://registry.npmjs.org/@rollup/plugin-babel/-/plugin-babel-5.3.1.tgz", "integrity": "sha512-WFfdLWU/xVWKeRQnKmIAQULUI7Il0gZnBIH/ZFO069wYIfPu+8zrfp/KMW0atmELoRDq8FbiP3VCss9MhCut7Q==", + "license": "MIT", "dependencies": { "@babel/helper-module-imports": "^7.10.4", "@rollup/pluginutils": "^3.1.0" @@ -11633,6 +12595,7 @@ "version": "2.4.2", "resolved": "https://registry.npmjs.org/@rollup/plugin-replace/-/plugin-replace-2.4.2.tgz", "integrity": "sha512-IGcu+cydlUMZ5En85jxHH4qj2hta/11BHq95iHEyb2sbgiN0eCdzvUcHw5gt9pBL5lTi4JDYJ1acCoMGpTvEZg==", + "license": "MIT", "dependencies": { "@rollup/pluginutils": "^3.1.0", "magic-string": "^0.25.7" @@ -11645,6 +12608,7 @@ "version": "3.1.0", "resolved": "https://registry.npmjs.org/@rollup/pluginutils/-/pluginutils-3.1.0.tgz", "integrity": "sha512-GksZ6pr6TpIjHm8h9lSQ8pi8BE9VeubNT0OMJ3B5uZJ8pz73NPiqOtCog/x2/QzM1ENChPKxMDhiQuRHsqc+lg==", + "license": "MIT", "dependencies": { "@types/estree": "0.0.39", "estree-walker": "^1.0.1", @@ -11660,12 +12624,14 @@ "node_modules/workbox-build/node_modules/@types/estree": { "version": "0.0.39", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-0.0.39.tgz", - "integrity": "sha512-EYNwp3bU+98cpU4lAWYYL7Zz+2gryWH1qbdDTidVd6hkiR6weksdbMadyXKXNPEkQFhXM+hVO9ZygomHXp+AIw==" + "integrity": "sha512-EYNwp3bU+98cpU4lAWYYL7Zz+2gryWH1qbdDTidVd6hkiR6weksdbMadyXKXNPEkQFhXM+hVO9ZygomHXp+AIw==", + "license": "MIT" }, "node_modules/workbox-build/node_modules/ajv": { - "version": "8.17.1", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.17.1.tgz", - "integrity": "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g==", + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", + "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", + "license": "MIT", "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", @@ -11677,28 +12643,92 @@ "url": "https://github.com/sponsors/epoberezkin" } }, + "node_modules/workbox-build/node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", + "license": "MIT", + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/workbox-build/node_modules/brace-expansion": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz", + "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==", + "license": "MIT", + "dependencies": { + "balanced-match": "^4.0.2" + }, + "engines": { + "node": "18 || 20 || >=22" + } + }, "node_modules/workbox-build/node_modules/estree-walker": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-1.0.1.tgz", - "integrity": "sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==" + "integrity": "sha512-1fMXF3YP4pZZVozF8j/ZLfvnR8NSIljt56UhbZ5PeeDmmGHpgpdwQt7ITlGvYaQukCvuBRMLEiKiYC+oeIg4cg==", + "license": "MIT" + }, + "node_modules/workbox-build/node_modules/glob": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-11.1.0.tgz", + "integrity": "sha512-vuNwKSaKiqm7g0THUBu2x7ckSs3XJLXE+2ssL7/MfTGPLLcrJQ/4Uq1CjPTtO5cCIiRxqvN6Twy1qOwhL0Xjcw==", + "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me", + "license": "BlueOak-1.0.0", + "dependencies": { + "foreground-child": "^3.3.1", + "jackspeak": "^4.1.1", + "minimatch": "^10.1.1", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^2.0.0" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } }, "node_modules/workbox-build/node_modules/json-schema-traverse": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "license": "MIT" }, "node_modules/workbox-build/node_modules/magic-string": { "version": "0.25.9", "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.25.9.tgz", "integrity": "sha512-RmF0AsMzgt25qzqqLc1+MbHmhdx0ojF2Fvs4XnOqz2ZOBXzzkEwc/dJQZCYHAn7v1jbVOjAZfK8msRn4BxO4VQ==", + "license": "MIT", "dependencies": { "sourcemap-codec": "^1.4.8" } }, + "node_modules/workbox-build/node_modules/minimatch": { + "version": "10.2.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.5.tgz", + "integrity": "sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg==", + "license": "BlueOak-1.0.0", + "dependencies": { + "brace-expansion": "^5.0.5" + }, + "engines": { + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/workbox-build/node_modules/pretty-bytes": { "version": "5.6.0", "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", "integrity": "sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg==", + "license": "MIT", "engines": { "node": ">=6" }, @@ -11707,9 +12737,10 @@ } }, "node_modules/workbox-build/node_modules/rollup": { - "version": "2.79.2", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.79.2.tgz", - "integrity": "sha512-fS6iqSPZDs3dr/y7Od6y5nha8dW1YnbgtsyotCVvoFGKbERG++CVRFv1meyGDE1SNItQA8BrnCw7ScdAhRJ3XQ==", + "version": "2.80.0", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.80.0.tgz", + "integrity": "sha512-cIFJOD1DESzpjOBl763Kp1AH7UE/0fcdHe6rZXUdQ9c50uvgigvW97u3IcSeBwOkgqL/PXPBktBCh0KEu5L8XQ==", + "license": "MIT", "bin": { "rollup": "dist/bin/rollup" }, @@ -11721,43 +12752,106 @@ } }, "node_modules/workbox-cacheable-response": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-cacheable-response/-/workbox-cacheable-response-7.3.0.tgz", - "integrity": "sha512-eAFERIg6J2LuyELhLlmeRcJFa5e16Mj8kL2yCDbhWE+HUun9skRQrGIFVUagqWj4DMaaPSMWfAolM7XZZxNmxA==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-cacheable-response/-/workbox-cacheable-response-7.4.0.tgz", + "integrity": "sha512-0Fb8795zg/x23ISFkAc7lbWes6vbw34DGFIMw31cwuHPgDEC/5EYm6m/ZkylLX0EnEbbOyOCLjKgFS/Z5g0HeQ==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-cli": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-cli/-/workbox-cli-7.3.0.tgz", - "integrity": "sha512-dB2Yz4s3PWcb2daHLUQC3Q0P+WGeoOKR6+LQqZ7ciWOHMhaWj7sWmomELa4IMVlNat53EF8MXOpXx2Ggd1o7+w==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-cli/-/workbox-cli-7.4.0.tgz", + "integrity": "sha512-BTc9CbW+aXMyIxBdW2mX+dLYHwTeCdKARX0zpjLvR/mZ2ho/7d9XWckwgFGLQRsJfcxml5WngNqp1PG7+qa9Ug==", + "license": "MIT", "dependencies": { "chalk": "^4.1.0", - "chokidar": "^3.5.2", + "chokidar": "^3.6.0", "common-tags": "^1.8.0", "fs-extra": "^9.0.1", - "glob": "^7.1.6", + "glob": "^11.0.1", "inquirer": "^7.3.3", "meow": "^7.1.0", "ora": "^5.0.0", "pretty-bytes": "^5.3.0", "stringify-object": "^3.3.0", "upath": "^1.2.0", - "update-notifier": "^4.1.0", - "workbox-build": "7.3.0" + "update-notifier": "^7.3.1", + "workbox-build": "7.4.0" }, "bin": { "workbox": "build/bin.js" }, "engines": { - "node": ">=16.0.0" + "node": ">=20.0.0" + } + }, + "node_modules/workbox-cli/node_modules/balanced-match": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-4.0.4.tgz", + "integrity": "sha512-BLrgEcRTwX2o6gGxGOCNyMvGSp35YofuYzw9h1IMTRmKqttAZZVU67bdb9Pr2vUHA8+j3i2tJfjO6C6+4myGTA==", + "license": "MIT", + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/workbox-cli/node_modules/brace-expansion": { + "version": "5.0.5", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-5.0.5.tgz", + "integrity": "sha512-VZznLgtwhn+Mact9tfiwx64fA9erHH/MCXEUfB/0bX/6Fz6ny5EGTXYltMocqg4xFAQZtnO3DHWWXi8RiuN7cQ==", + "license": "MIT", + "dependencies": { + "balanced-match": "^4.0.2" + }, + "engines": { + "node": "18 || 20 || >=22" + } + }, + "node_modules/workbox-cli/node_modules/glob": { + "version": "11.1.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-11.1.0.tgz", + "integrity": "sha512-vuNwKSaKiqm7g0THUBu2x7ckSs3XJLXE+2ssL7/MfTGPLLcrJQ/4Uq1CjPTtO5cCIiRxqvN6Twy1qOwhL0Xjcw==", + "deprecated": "Old versions of glob are not supported, and contain widely publicized security vulnerabilities, which have been fixed in the current version. Please update. Support for old versions may be purchased (at exorbitant rates) by contacting i@izs.me", + "license": "BlueOak-1.0.0", + "dependencies": { + "foreground-child": "^3.3.1", + "jackspeak": "^4.1.1", + "minimatch": "^10.1.1", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^2.0.0" + }, + "bin": { + "glob": "dist/esm/bin.mjs" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/workbox-cli/node_modules/minimatch": { + "version": "10.2.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.2.5.tgz", + "integrity": "sha512-MULkVLfKGYDFYejP07QOurDLLQpcjk7Fw+7jXS2R2czRQzR56yHRveU5NDJEOviH+hETZKSkIk5c+T23GjFUMg==", + "license": "BlueOak-1.0.0", + "dependencies": { + "brace-expansion": "^5.0.5" + }, + "engines": { + "node": "18 || 20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/workbox-cli/node_modules/pretty-bytes": { "version": "5.6.0", "resolved": "https://registry.npmjs.org/pretty-bytes/-/pretty-bytes-5.6.0.tgz", "integrity": "sha512-FFw039TmrBqFK8ma/7OL3sDz/VytdtJr044/QUJtH0wK9lb9jLq9tJyIxUwtQJHwar2BqtiA4iCWSwo9JLkzFg==", + "license": "MIT", "engines": { "node": ">=6" }, @@ -11766,148 +12860,142 @@ } }, "node_modules/workbox-core": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-core/-/workbox-core-7.3.0.tgz", - "integrity": "sha512-Z+mYrErfh4t3zi7NVTvOuACB0A/jA3bgxUN3PwtAVHvfEsZxV9Iju580VEETug3zYJRc0Dmii/aixI/Uxj8fmw==" + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-core/-/workbox-core-7.4.0.tgz", + "integrity": "sha512-6BMfd8tYEnN4baG4emG9U0hdXM4gGuDU3ectXuVHnj71vwxTFI7WOpQJC4siTOlVtGqCUtj0ZQNsrvi6kZZTAQ==", + "license": "MIT" }, "node_modules/workbox-expiration": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-expiration/-/workbox-expiration-7.3.0.tgz", - "integrity": "sha512-lpnSSLp2BM+K6bgFCWc5bS1LR5pAwDWbcKt1iL87/eTSJRdLdAwGQznZE+1czLgn/X05YChsrEegTNxjM067vQ==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-expiration/-/workbox-expiration-7.4.0.tgz", + "integrity": "sha512-V50p4BxYhtA80eOvulu8xVfPBgZbkxJ1Jr8UUn0rvqjGhLDqKNtfrDfjJKnLz2U8fO2xGQJTx/SKXNTzHOjnHw==", + "license": "MIT", "dependencies": { "idb": "^7.0.1", - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-google-analytics": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-google-analytics/-/workbox-google-analytics-7.3.0.tgz", - "integrity": "sha512-ii/tSfFdhjLHZ2BrYgFNTrb/yk04pw2hasgbM70jpZfLk0vdJAXgaiMAWsoE+wfJDNWoZmBYY0hMVI0v5wWDbg==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-google-analytics/-/workbox-google-analytics-7.4.0.tgz", + "integrity": "sha512-MVPXQslRF6YHkzGoFw1A4GIB8GrKym/A5+jYDUSL+AeJw4ytQGrozYdiZqUW1TPQHW8isBCBtyFJergUXyNoWQ==", + "license": "MIT", "dependencies": { - "workbox-background-sync": "7.3.0", - "workbox-core": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0" + "workbox-background-sync": "7.4.0", + "workbox-core": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0" } }, "node_modules/workbox-navigation-preload": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-navigation-preload/-/workbox-navigation-preload-7.3.0.tgz", - "integrity": "sha512-fTJzogmFaTv4bShZ6aA7Bfj4Cewaq5rp30qcxl2iYM45YD79rKIhvzNHiFj1P+u5ZZldroqhASXwwoyusnr2cg==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-navigation-preload/-/workbox-navigation-preload-7.4.0.tgz", + "integrity": "sha512-etzftSgdQfjMcfPgbfaZCfM2QuR1P+4o8uCA2s4rf3chtKTq/Om7g/qvEOcZkG6v7JZOSOxVYQiOu6PbAZgU6w==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-precaching": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-precaching/-/workbox-precaching-7.3.0.tgz", - "integrity": "sha512-ckp/3t0msgXclVAYaNndAGeAoWQUv7Rwc4fdhWL69CCAb2UHo3Cef0KIUctqfQj1p8h6aGyz3w8Cy3Ihq9OmIw==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-precaching/-/workbox-precaching-7.4.0.tgz", + "integrity": "sha512-VQs37T6jDqf1rTxUJZXRl3yjZMf5JX/vDPhmx2CPgDDKXATzEoqyRqhYnRoxl6Kr0rqaQlp32i9rtG5zTzIlNg==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0" + "workbox-core": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0" } }, "node_modules/workbox-range-requests": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-range-requests/-/workbox-range-requests-7.3.0.tgz", - "integrity": "sha512-EyFmM1KpDzzAouNF3+EWa15yDEenwxoeXu9bgxOEYnFfCxns7eAxA9WSSaVd8kujFFt3eIbShNqa4hLQNFvmVQ==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-range-requests/-/workbox-range-requests-7.4.0.tgz", + "integrity": "sha512-3Vq854ZNuP6Y0KZOQWLaLC9FfM7ZaE+iuQl4VhADXybwzr4z/sMmnLgTeUZLq5PaDlcJBxYXQ3U91V7dwAIfvw==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-recipes": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-recipes/-/workbox-recipes-7.3.0.tgz", - "integrity": "sha512-BJro/MpuW35I/zjZQBcoxsctgeB+kyb2JAP5EB3EYzePg8wDGoQuUdyYQS+CheTb+GhqJeWmVs3QxLI8EBP1sg==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-recipes/-/workbox-recipes-7.4.0.tgz", + "integrity": "sha512-kOkWvsAn4H8GvAkwfJTbwINdv4voFoiE9hbezgB1sb/0NLyTG4rE7l6LvS8lLk5QIRIto+DjXLuAuG3Vmt3cxQ==", + "license": "MIT", "dependencies": { - "workbox-cacheable-response": "7.3.0", - "workbox-core": "7.3.0", - "workbox-expiration": "7.3.0", - "workbox-precaching": "7.3.0", - "workbox-routing": "7.3.0", - "workbox-strategies": "7.3.0" + "workbox-cacheable-response": "7.4.0", + "workbox-core": "7.4.0", + "workbox-expiration": "7.4.0", + "workbox-precaching": "7.4.0", + "workbox-routing": "7.4.0", + "workbox-strategies": "7.4.0" } }, "node_modules/workbox-routing": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-routing/-/workbox-routing-7.3.0.tgz", - "integrity": "sha512-ZUlysUVn5ZUzMOmQN3bqu+gK98vNfgX/gSTZ127izJg/pMMy4LryAthnYtjuqcjkN4HEAx1mdgxNiKJMZQM76A==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-routing/-/workbox-routing-7.4.0.tgz", + "integrity": "sha512-C/ooj5uBWYAhAqwmU8HYQJdOjjDKBp9MzTQ+otpMmd+q0eF59K+NuXUek34wbL0RFrIXe/KKT+tUWcZcBqxbHQ==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-strategies": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-strategies/-/workbox-strategies-7.3.0.tgz", - "integrity": "sha512-tmZydug+qzDFATwX7QiEL5Hdf7FrkhjaF9db1CbB39sDmEZJg3l9ayDvPxy8Y18C3Y66Nrr9kkN1f/RlkDgllg==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-strategies/-/workbox-strategies-7.4.0.tgz", + "integrity": "sha512-T4hVqIi5A4mHi92+5EppMX3cLaVywDp8nsyUgJhOZxcfSV/eQofcOA6/EMo5rnTNmNTpw0rUgjAI6LaVullPpg==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/workbox-streams": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-streams/-/workbox-streams-7.3.0.tgz", - "integrity": "sha512-SZnXucyg8x2Y61VGtDjKPO5EgPUG5NDn/v86WYHX+9ZqvAsGOytP0Jxp1bl663YUuMoXSAtsGLL+byHzEuMRpw==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-streams/-/workbox-streams-7.4.0.tgz", + "integrity": "sha512-QHPBQrey7hQbnTs5GrEVoWz7RhHJXnPT+12qqWM378orDMo5VMJLCkCM1cnCk+8Eq92lccx/VgRZ7WAzZWbSLg==", + "license": "MIT", "dependencies": { - "workbox-core": "7.3.0", - "workbox-routing": "7.3.0" + "workbox-core": "7.4.0", + "workbox-routing": "7.4.0" } }, "node_modules/workbox-sw": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-sw/-/workbox-sw-7.3.0.tgz", - "integrity": "sha512-aCUyoAZU9IZtH05mn0ACUpyHzPs0lMeJimAYkQkBsOWiqaJLgusfDCR+yllkPkFRxWpZKF8vSvgHYeG7LwhlmA==" + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-sw/-/workbox-sw-7.4.0.tgz", + "integrity": "sha512-ltU+Kr3qWR6BtbdlMnCjobZKzeV1hN+S6UvDywBrwM19TTyqA03X66dzw1tEIdJvQ4lYKkBFox6IAEhoSEZ8Xw==", + "license": "MIT" }, "node_modules/workbox-window": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/workbox-window/-/workbox-window-7.3.0.tgz", - "integrity": "sha512-qW8PDy16OV1UBaUNGlTVcepzrlzyzNW/ZJvFQQs2j2TzGsg6IKjcpZC1RSquqQnTOafl5pCj5bGfAHlCjOOjdA==", + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/workbox-window/-/workbox-window-7.4.0.tgz", + "integrity": "sha512-/bIYdBLAVsNR3v7gYGaV4pQW3M3kEPx5E8vDxGvxo6khTrGtSSCS7QiFKv9ogzBgZiy0OXLP9zO28U/1nF1mfw==", + "license": "MIT", "dependencies": { "@types/trusted-types": "^2.0.2", - "workbox-core": "7.3.0" + "workbox-core": "7.4.0" } }, "node_modules/wrap-ansi": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz", - "integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==", - "dev": true, + "version": "9.0.2", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.2.tgz", + "integrity": "sha512-42AtmgqjV+X1VpdOfyTGOYRi0/zsoLqtXQckTmqTeybT+BDIbM/Guxo7x3pE2vtpr1ok6xRqM9OpBe+Jyoqyww==", + "license": "MIT", "dependencies": { - "ansi-styles": "^6.1.0", - "string-width": "^5.0.1", - "strip-ansi": "^7.0.1" + "ansi-styles": "^6.2.1", + "string-width": "^7.0.0", + "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/wrap-ansi?sponsor=1" - } - }, - "node_modules/wrap-ansi-cjs": { - "name": "wrap-ansi", - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", - "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", - "dev": true, - "dependencies": { - "ansi-styles": "^4.0.0", - "string-width": "^4.1.0", - "strip-ansi": "^6.0.0" - }, - "engines": { - "node": ">=10" + "node": ">=18" }, "funding": { "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, "node_modules/wrap-ansi/node_modules/ansi-regex": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz", - "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==", - "dev": true, + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.2.2.tgz", + "integrity": "sha512-Bq3SmSpyFHaWjPk8If9yc6svM8c56dB5BAtW4Qbw5jHTwwXXcTLoRMkpDJp6VL0XzlWaCHTXrkFURMYmD0sLqg==", + "license": "MIT", "engines": { "node": ">=12" }, @@ -11916,10 +13004,10 @@ } }, "node_modules/wrap-ansi/node_modules/ansi-styles": { - "version": "6.2.1", - "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz", - "integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==", - "dev": true, + "version": "6.2.3", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.3.tgz", + "integrity": "sha512-4Dj6M28JB+oAH8kFkTLUo+a2jwOFkuqb3yucU0CANcRRUbxS0cP0nZYCGjcc3BNXwRIsUVmDGgzawme7zvJHvg==", + "license": "MIT", "engines": { "node": ">=12" }, @@ -11927,30 +13015,36 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, + "node_modules/wrap-ansi/node_modules/emoji-regex": { + "version": "10.6.0", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.6.0.tgz", + "integrity": "sha512-toUI84YS5YmxW219erniWD0CIVOo46xGKColeNQRgOzDorgBi1v4D71/OFzgD9GO2UGKIv1C3Sp8DAn0+j5w7A==", + "license": "MIT" + }, "node_modules/wrap-ansi/node_modules/string-width": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz", - "integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==", - "dev": true, + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz", + "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==", + "license": "MIT", "dependencies": { - "eastasianwidth": "^0.2.0", - "emoji-regex": "^9.2.2", - "strip-ansi": "^7.0.1" + "emoji-regex": "^10.3.0", + "get-east-asian-width": "^1.0.0", + "strip-ansi": "^7.1.0" }, "engines": { - "node": ">=12" + "node": ">=18" }, "funding": { "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/wrap-ansi/node_modules/strip-ansi": { - "version": "7.1.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz", - "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==", - "dev": true, + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.2.0.tgz", + "integrity": "sha512-yDPMNjp4WyfYBkHnjIRLfca1i6KMyGCtsVgoKe/z1+6vukgaENdgGBZt+ZmKPc4gavvEZ5OgHfHdrazhgNyG7w==", + "license": "MIT", "dependencies": { - "ansi-regex": "^6.0.1" + "ansi-regex": "^6.2.2" }, "engines": { "node": ">=12" @@ -11962,24 +13056,16 @@ "node_modules/wrappy": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", - "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==" - }, - "node_modules/write-file-atomic": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.3.tgz", - "integrity": "sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==", - "dependencies": { - "imurmurhash": "^0.1.4", - "is-typedarray": "^1.0.0", - "signal-exit": "^3.0.2", - "typedarray-to-buffer": "^3.1.5" - } + "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==", + "dev": true, + "license": "ISC" }, "node_modules/ws": { - "version": "8.18.2", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.18.2.tgz", - "integrity": "sha512-DMricUmwGZUVr++AEAe2uiVM7UoO9MAVZMDu05UQOaUII0lp+zOzLLU4Xqh/JvTqklB1T4uELaaPBKyjE1r4fQ==", + "version": "8.20.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.20.0.tgz", + "integrity": "sha512-sAt8BhgNbzCtgGbt2OxmpuryO63ZoDk/sqaB/znQm94T4fCEsy/yV+7CdC1kJhOU9lboAEU7R3kquuycDoibVA==", "dev": true, + "license": "MIT", "engines": { "node": ">=10.0.0" }, @@ -11997,11 +13083,15 @@ } }, "node_modules/xdg-basedir": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-4.0.0.tgz", - "integrity": "sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/xdg-basedir/-/xdg-basedir-5.1.0.tgz", + "integrity": "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ==", + "license": "MIT", "engines": { - "node": ">=8" + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, "node_modules/xml-name-validator": { @@ -12009,6 +13099,7 @@ "resolved": "https://registry.npmjs.org/xml-name-validator/-/xml-name-validator-5.0.0.tgz", "integrity": "sha512-EvGK8EJ3DhaHfbRlETOWAS5pO9MZITeauHKJyb8wyajUfQUenkIg2MvLDTZ4T/TgIcm3HU0TFBgWWboAZ30UHg==", "dev": true, + "license": "Apache-2.0", "engines": { "node": ">=18" } @@ -12017,17 +13108,20 @@ "version": "2.2.0", "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/yallist": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/yallist/-/yallist-3.1.1.tgz", - "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==" + "integrity": "sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==", + "license": "ISC" }, "node_modules/yargs-parser": { "version": "18.1.3", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-18.1.3.tgz", "integrity": "sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ==", + "license": "ISC", "dependencies": { "camelcase": "^5.0.0", "decamelize": "^1.2.0" @@ -12041,6 +13135,7 @@ "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=10" }, diff --git a/ui/package.json b/ui/package.json index b9c93316b..b440f0595 100644 --- a/ui/package.json +++ b/ui/package.json @@ -16,19 +16,23 @@ "postinstall": "bin/update-workbox.sh" }, "dependencies": { + "@jsonforms/core": "^2.5.2", + "@jsonforms/material-renderers": "^2.5.2", + "@jsonforms/react": "^2.5.2", "@material-ui/core": "^4.12.4", "@material-ui/icons": "^4.11.3", - "@material-ui/lab": "^4.0.0-alpha.58", + "@material-ui/lab": "^4.0.0-alpha.61", "@material-ui/styles": "^4.11.5", "blueimp-md5": "^2.19.0", "clsx": "^2.1.1", "connected-react-router": "^6.9.3", "deepmerge": "^4.3.1", + "dompurify": "^3.3.2", "history": "^4.10.1", "inflection": "^3.0.2", "jwt-decode": "^4.0.0", "lodash.throttle": "^4.1.1", - "navidrome-music-player": "4.25.1", + "navidrome-music-player": "4.25.2", "prop-types": "^15.8.1", "ra-data-json-server": "^3.19.12", "ra-i18n-polyglot": "^3.19.12", @@ -46,8 +50,8 @@ "react-redux": "^7.2.9", "react-router-dom": "^5.3.4", "redux": "^4.2.1", - "redux-saga": "^1.3.0", - "uuid": "^11.1.0", + "redux-saga": "^1.4.2", + "uuid": "^13.0.0", "workbox-cli": "^7.3.0" }, "devDependencies": { @@ -55,27 +59,27 @@ "@testing-library/react": "^12.1.5", "@testing-library/react-hooks": "^7.0.2", "@testing-library/user-event": "^14.6.1", - "@types/node": "^22.15.21", - "@types/react": "^17.0.86", + "@types/node": "^24.9.1", + "@types/react": "^17.0.89", "@types/react-dom": "^17.0.26", "@typescript-eslint/eslint-plugin": "^6.21.0", "@typescript-eslint/parser": "^6.21.0", - "@vitejs/plugin-react": "^4.5.0", - "@vitest/coverage-v8": "^3.1.4", + "@vitejs/plugin-react": "^5.1.0", + "@vitest/coverage-v8": "^4.0.3", "eslint": "^8.57.1", - "eslint-config-prettier": "^10.1.5", + "eslint-config-prettier": "^10.1.8", "eslint-plugin-jsx-a11y": "^6.10.2", "eslint-plugin-react": "^7.37.5", "eslint-plugin-react-hooks": "^5.2.0", - "eslint-plugin-react-refresh": "^0.4.20", - "happy-dom": "^17.4.7", + "eslint-plugin-react-refresh": "^0.4.24", + "happy-dom": "^20.0.8", "jsdom": "^26.1.0", - "prettier": "^3.5.3", + "prettier": "^3.6.2", "ra-test": "^3.19.12", "typescript": "^5.8.3", - "vite": "^6.3.5", - "vite-plugin-pwa": "^0.21.2", - "vitest": "^3.1.4" + "vite": "^7.3.2", + "vite-plugin-pwa": "^1.1.0", + "vitest": "^4.0.3" }, "overrides": { "vite": { diff --git a/ui/public/fonts/Unbounded-Variable.woff2 b/ui/public/fonts/Unbounded-Variable.woff2 new file mode 100644 index 000000000..96d8ff5fa Binary files /dev/null and b/ui/public/fonts/Unbounded-Variable.woff2 differ diff --git a/ui/src/App.jsx b/ui/src/App.jsx index 107c6c9e4..d10aa5a33 100644 --- a/ui/src/App.jsx +++ b/ui/src/App.jsx @@ -20,9 +20,12 @@ import artist from './artist' import playlist from './playlist' import radio from './radio' import share from './share' +import library from './library' +import plugin from './plugin' import { Player } from './audioplayer' import customRoutes from './routes' import { + libraryReducer, themeReducer, addToPlaylistDialogReducer, expandInfoDialogReducer, @@ -35,6 +38,7 @@ import { replayGainReducer, downloadMenuDialogReducer, shareDialogReducer, + transcodingReducer, } from './reducers' import createAdminStore from './store/createAdminStore' import { i18nProvider, retrieveTranslation } from './i18n' @@ -62,6 +66,7 @@ const adminStore = createAdminStore({ dataProvider, history, customReducers: { + library: libraryReducer, player: playerReducer, albumView: albumViewReducer, theme: themeReducer, @@ -74,6 +79,7 @@ const adminStore = createAdminStore({ activity: activityReducer, settings: settingsReducer, replayGain: replayGainReducer, + transcoding: transcodingReducer, }, }) @@ -146,7 +152,13 @@ const Admin = (props) => { ) : ( ), - + permissions === 'admin' ? ( + + ) : null, permissions === 'admin' ? ( { options={{ subMenu: 'settings' }} /> ) : null, + permissions === 'admin' && config.pluginsEnabled ? ( + + ) : null, , , @@ -161,6 +180,7 @@ const Admin = (props) => { , , , + , , ]} diff --git a/ui/src/actions/index.js b/ui/src/actions/index.js index a319f7a69..9f35f86a9 100644 --- a/ui/src/actions/index.js +++ b/ui/src/actions/index.js @@ -1,3 +1,4 @@ +export * from './library' export * from './player' export * from './themes' export * from './albumView' diff --git a/ui/src/actions/library.js b/ui/src/actions/library.js new file mode 100644 index 000000000..4653ec739 --- /dev/null +++ b/ui/src/actions/library.js @@ -0,0 +1,12 @@ +export const SET_SELECTED_LIBRARIES = 'SET_SELECTED_LIBRARIES' +export const SET_USER_LIBRARIES = 'SET_USER_LIBRARIES' + +export const setSelectedLibraries = (libraryIds) => ({ + type: SET_SELECTED_LIBRARIES, + data: libraryIds, +}) + +export const setUserLibraries = (libraries) => ({ + type: SET_USER_LIBRARIES, + data: libraries, +}) diff --git a/ui/src/actions/player.js b/ui/src/actions/player.js index acef2e9b2..9056abeb6 100644 --- a/ui/src/actions/player.js +++ b/ui/src/actions/player.js @@ -7,6 +7,8 @@ export const PLAYER_PLAY_TRACKS = 'PLAYER_PLAY_TRACKS' export const PLAYER_CURRENT = 'PLAYER_CURRENT' export const PLAYER_SET_VOLUME = 'PLAYER_SET_VOLUME' export const PLAYER_SET_MODE = 'PLAYER_SET_MODE' +export const TRANSCODING_SET_PROFILE = 'TRANSCODING_SET_PROFILE' +export const PLAYER_REFRESH_QUEUE = 'PLAYER_REFRESH_QUEUE' export const setTrack = (data) => ({ type: PLAYER_SET_TRACK, @@ -102,3 +104,13 @@ export const setPlayMode = (mode) => ({ type: PLAYER_SET_MODE, data: { mode }, }) + +export const setTranscodingProfile = (profile) => ({ + type: TRANSCODING_SET_PROFILE, + data: profile, +}) + +export const refreshQueue = (resolvedUrls) => ({ + type: PLAYER_REFRESH_QUEUE, + data: resolvedUrls, +}) diff --git a/ui/src/actions/serverEvents.js b/ui/src/actions/serverEvents.js index 7d89c5feb..892f2e27e 100644 --- a/ui/src/actions/serverEvents.js +++ b/ui/src/actions/serverEvents.js @@ -1,6 +1,9 @@ export const EVENT_SCAN_STATUS = 'scanStatus' export const EVENT_SERVER_START = 'serverStart' export const EVENT_REFRESH_RESOURCE = 'refreshResource' +export const EVENT_NOW_PLAYING_COUNT = 'nowPlayingCount' +export const EVENT_NOW_PLAYING_COUNT_SYNC = 'nowPlayingCountSync' +export const EVENT_STREAM_RECONNECTED = 'streamReconnected' export const processEvent = (type, data) => ({ type, @@ -11,7 +14,22 @@ export const scanStatusUpdate = (data) => ({ data: data, }) +export const nowPlayingCountUpdate = (data) => ({ + type: EVENT_NOW_PLAYING_COUNT, + data: data, +}) + +export const nowPlayingCountSync = (data) => ({ + type: EVENT_NOW_PLAYING_COUNT_SYNC, + data: data, +}) + export const serverDown = () => ({ type: EVENT_SERVER_START, data: {}, }) + +export const streamReconnected = () => ({ + type: EVENT_STREAM_RECONNECTED, + data: {}, +}) diff --git a/ui/src/album/AlbumDatesField.jsx b/ui/src/album/AlbumDatesField.jsx index e4cdeedce..ce1301380 100644 --- a/ui/src/album/AlbumDatesField.jsx +++ b/ui/src/album/AlbumDatesField.jsx @@ -10,6 +10,12 @@ export const AlbumDatesField = ({ className, ...rest }) => { const releaseYear = releaseDate?.toString().substring(0, 4) const yearRange = formatRange(record, 'originalYear') || record['maxYear']?.toString() + + // Don't show anything if the year starts with "0" + if (yearRange === '0' || releaseYear?.startsWith('0')) { + return null + } + let label = yearRange if (releaseYear !== undefined && yearRange !== releaseYear) { diff --git a/ui/src/album/AlbumDatesField.test.jsx b/ui/src/album/AlbumDatesField.test.jsx new file mode 100644 index 000000000..9bcd41567 --- /dev/null +++ b/ui/src/album/AlbumDatesField.test.jsx @@ -0,0 +1,112 @@ +import { describe, test, expect, vi } from 'vitest' +import { render } from '@testing-library/react' +import { RecordContextProvider } from 'react-admin' +import { AlbumDatesField } from './AlbumDatesField' +import { formatRange } from '../common/index.js' + +// Mock the formatRange function +vi.mock('../common/index.js', () => ({ + formatRange: vi.fn(), +})) + +describe('AlbumDatesField', () => { + test('renders nothing when yearRange is "0"', () => { + const record = { + maxYear: '0', + releaseDate: '2020-01-01', + } + + vi.mocked(formatRange).mockReturnValue('0') + + const { container } = render( + + + , + ) + + expect(container.firstChild).toBeNull() + }) + + test('renders nothing when releaseYear is "0"', () => { + const record = { + maxYear: '2020', + releaseDate: '0-01-01', + } + + vi.mocked(formatRange).mockReturnValue('2020') + + const { container } = render( + + + , + ) + + expect(container.firstChild).toBeNull() + }) + + test('renders only yearRange when releaseYear is undefined', () => { + const record = { + maxYear: '2020', + } + + vi.mocked(formatRange).mockReturnValue('2020') + + const { container } = render( + + + , + ) + + expect(container.textContent).toBe('2020') + }) + + test('renders both years when they are different', () => { + const record = { + maxYear: '2018', + releaseDate: '2020-01-01', + } + + vi.mocked(formatRange).mockReturnValue('2018') + + const { container } = render( + + + , + ) + + expect(container.textContent).toBe('♫ 2018 · ○ 2020') + }) + + test('renders only yearRange when both years are the same', () => { + const record = { + maxYear: '2020', + releaseDate: '2020-01-01', + } + + vi.mocked(formatRange).mockReturnValue('2020') + + const { container } = render( + + + , + ) + + expect(container.textContent).toBe('2020') + }) + + test('applies className when provided', () => { + const record = { + maxYear: '2020', + } + + vi.mocked(formatRange).mockReturnValue('2020') + + const { container } = render( + + + , + ) + + expect(container.firstChild).toHaveClass('test-class') + }) +}) diff --git a/ui/src/album/AlbumDetails.jsx b/ui/src/album/AlbumDetails.jsx index f796f3b9d..cec66eb8b 100644 --- a/ui/src/album/AlbumDetails.jsx +++ b/ui/src/album/AlbumDetails.jsx @@ -1,4 +1,4 @@ -import { useCallback, useEffect, useState } from 'react' +import { useEffect, useState } from 'react' import { Card, CardContent, @@ -18,6 +18,7 @@ import { useTranslate, } from 'react-admin' import Lightbox from 'react-image-lightbox' +import config from '../config' import 'react-image-lightbox/style.css' import subsonic from '../subsonic' import { @@ -29,10 +30,11 @@ import { RatingField, SizeField, useAlbumsPerPage, + useImageLoadingState, } from '../common' -import config from '../config' import { formatFullDate, intersperse } from '../utils' import AlbumExternalLinks from './AlbumExternalLinks' +import { SafeHTML } from '../common/SafeHTML' const useStyles = makeStyles( (theme) => ({ @@ -72,6 +74,10 @@ const useStyles = makeStyles( width: '15em', minWidth: '15em', }, + backgroundColor: 'transparent', + display: 'flex', + alignItems: 'center', + justifyContent: 'center', }, cover: { objectFit: 'contain', @@ -79,6 +85,11 @@ const useStyles = makeStyles( display: 'block', width: '100%', height: '100%', + backgroundColor: 'transparent', + transition: 'opacity 0.3s ease-in-out', + }, + coverLoading: { + opacity: 0.5, }, loveButton: { top: theme.spacing(-0.2), @@ -210,14 +221,21 @@ const AlbumDetails = (props) => { const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('lg')) const classes = useStyles() - const [isLightboxOpen, setLightboxOpen] = useState(false) const [expanded, setExpanded] = useState(false) const [albumInfo, setAlbumInfo] = useState() + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) - let notes = - albumInfo?.notes?.replace(new RegExp('<.*>', 'g'), '') || record.notes + let notes = albumInfo?.notes || record.notes - if (notes !== undefined) { + if (notes) { notes += '..' } @@ -236,23 +254,27 @@ const AlbumDetails = (props) => { }) }, [record]) - const imageUrl = subsonic.getCoverArtUrl(record, 300) + const imageUrl = subsonic.getCoverArtUrl(record, config.uiCoverArtSize) const fullImageUrl = subsonic.getCoverArtUrl(record) - const handleOpenLightbox = useCallback(() => setLightboxOpen(true), []) - const handleCloseLightbox = useCallback(() => setLightboxOpen(false), []) return (
@@ -301,7 +323,7 @@ const AlbumDetails = (props) => { )} )} - {isDesktop && ( + {isDesktop && notes && ( { variant={'body1'} onClick={() => setExpanded(!expanded)} > - + + {notes} + )} @@ -325,19 +349,21 @@ const AlbumDetails = (props) => { {!isDesktop && record['comment'] && ( )} - {!isDesktop && ( + {!isDesktop && notes && (
setExpanded(!expanded)} > - + + {notes} +
)} - {isLightboxOpen && ( + {isLightboxOpen && !imageError && ( { } }) +// Mock formatFullDate to return deterministic results +vi.mock('../utils', async () => { + const actual = await import('../utils') + return { + ...actual, + formatFullDate: (date) => { + if (!date) return '' + // Use en-CA locale for consistent test results + return new Date(date).toLocaleDateString('en-CA', { + year: 'numeric', + month: 'short', + day: 'numeric', + timeZone: 'UTC', + }) + }, + } +}) + describe('Details component', () => { describe('Desktop view', () => { beforeEach(() => { diff --git a/ui/src/album/AlbumGridView.jsx b/ui/src/album/AlbumGridView.jsx index 475519fca..33db9e40f 100644 --- a/ui/src/album/AlbumGridView.jsx +++ b/ui/src/album/AlbumGridView.jsx @@ -13,7 +13,14 @@ import { linkToRecord, useListContext, Loading } from 'react-admin' import { withContentRect } from 'react-measure' import { useDrag } from 'react-dnd' import subsonic from '../subsonic' -import { AlbumContextMenu, PlayButton, ArtistLinkField } from '../common' +import { + AlbumContextMenu, + PlayButton, + ArtistLinkField, + OverflowTooltip, + useImageUrl, +} from '../common' +import config from '../config' import { DraggableTypes } from '../consts' import clsx from 'clsx' import { AlbumDatesField } from './AlbumDatesField.jsx' @@ -27,14 +34,13 @@ const useStyles = makeStyles( tileBar: { transition: 'all 150ms ease-out', opacity: 0, + pointerEvents: 'none', textAlign: 'left', - marginBottom: '3px', background: 'linear-gradient(to top, rgba(0,0,0,0.7) 0%,rgba(0,0,0,0.4) 70%,rgba(0,0,0,0) 100%)', }, tileBarMobile: { textAlign: 'left', - marginBottom: '3px', background: 'linear-gradient(to top, rgba(0,0,0,0.7) 0%,rgba(0,0,0,0.4) 70%,rgba(0,0,0,0) 100%)', }, @@ -73,8 +79,9 @@ const useStyles = makeStyles( position: 'relative', display: 'block', textDecoration: 'none', - '&:hover $tileBar': { + '&:hover $tileBar, &:focus-within $tileBar': { opacity: 1, + pointerEvents: 'auto', }, }, albumLink: { @@ -89,11 +96,20 @@ const useStyles = makeStyles( ) const useCoverStyles = makeStyles({ + coverContainer: { + width: '100%', + aspectRatio: '1', + overflow: 'hidden', + }, cover: { display: 'inline-block', width: '100%', objectFit: 'contain', height: (props) => props.height, + transition: 'opacity 0.3s ease-in-out', + }, + coverLoading: { + opacity: 0, }, }) @@ -121,13 +137,17 @@ const Cover = withContentRect('bounds')(({ }), [record], ) + + const url = subsonic.getCoverArtUrl(record, config.uiCoverArtSize, true) + const { imgUrl, loading: imageLoading } = useImageUrl(url) + return ( -
+
{record.name}
@@ -172,7 +192,9 @@ const AlbumGridTile = ({ showArtist, record, basePath, ...props }) => { to={linkToRecord(basePath, record.id, 'show')} > - {record.name} + + {record.name} + {record.tags && record.tags['albumversion'] && ( {record.tags['albumversion']} diff --git a/ui/src/album/AlbumInfo.jsx b/ui/src/album/AlbumInfo.jsx index 453dbb167..075841e43 100644 --- a/ui/src/album/AlbumInfo.jsx +++ b/ui/src/album/AlbumInfo.jsx @@ -37,7 +37,8 @@ const AlbumInfo = (props) => { const translate = useTranslate() const record = useRecordContext(props) const data = { - album: , + name: , + libraryName: , albumArtist: ( ), diff --git a/ui/src/album/AlbumList.jsx b/ui/src/album/AlbumList.jsx index 40b927a89..0b8c256df 100644 --- a/ui/src/album/AlbumList.jsx +++ b/ui/src/album/AlbumList.jsx @@ -10,6 +10,7 @@ import { ReferenceArrayInput, ReferenceInput, SearchInput, + useListContext, usePermissions, useRefresh, useTranslate, @@ -19,7 +20,6 @@ import FavoriteIcon from '@material-ui/icons/Favorite' import { withWidth } from '@material-ui/core' import { List, - QuickFilter, Title, useAlbumsPerPage, useResourceRefresh, @@ -42,6 +42,9 @@ const useStyles = makeStyles({ }, }) +const formatReleaseType = (record) => + record?.tagValue ? humanize(record?.tagValue) : '-- None --' + const AlbumFilter = (props) => { const classes = useStyles() const translate = useTranslate() @@ -142,18 +145,15 @@ const AlbumFilter = (props) => { > - record?.tagValue ? humanize(record?.tagValue) : '-- None --' - } + optionText={formatReleaseType} /> {config.enableFavourites && ( - } - defaultValue={true} /> )} {isAdmin && } @@ -173,6 +173,14 @@ const AlbumListTitle = ({ albumListType }) => { return } +const AlbumListPagination = ({ albumListType, ...rest }) => { + const { loading } = useListContext() + if (loading && albumListType === 'random') { + return null + } + return <Pagination {...rest} /> +} + const randomStartingSeed = Math.random().toString() const AlbumList = (props) => { @@ -233,7 +241,12 @@ const AlbumList = (props) => { actions={<AlbumListActions />} filters={<AlbumFilter />} perPage={perPage} - pagination={<Pagination rowsPerPageOptions={perPageOptions} />} + pagination={ + <AlbumListPagination + rowsPerPageOptions={perPageOptions} + albumListType={albumListType} + /> + } title={<AlbumListTitle albumListType={albumListType} />} > {albumView.grid ? ( diff --git a/ui/src/album/AlbumShow.jsx b/ui/src/album/AlbumShow.jsx index 79aab6d6b..c9e944999 100644 --- a/ui/src/album/AlbumShow.jsx +++ b/ui/src/album/AlbumShow.jsx @@ -4,12 +4,13 @@ import { ShowContextProvider, useShowContext, useShowController, + Title as RaTitle, } from 'react-admin' import { makeStyles } from '@material-ui/core/styles' import AlbumSongs from './AlbumSongs' import AlbumDetails from './AlbumDetails' import AlbumActions from './AlbumActions' -import { useResourceRefresh } from '../common' +import { useResourceRefresh, Title } from '../common' const useStyles = makeStyles( (theme) => ({ @@ -30,6 +31,7 @@ const AlbumShowLayout = (props) => { return ( <> + {record && <RaTitle title={<Title subTitle={record.name} />} />} {record && <AlbumDetails {...context} />} {record && ( <ReferenceManyField diff --git a/ui/src/album/AlbumSongs.jsx b/ui/src/album/AlbumSongs.jsx index d705617e1..8a7fd2ae4 100644 --- a/ui/src/album/AlbumSongs.jsx +++ b/ui/src/album/AlbumSongs.jsx @@ -108,6 +108,9 @@ const AlbumSongs = (props) => { /> ), artist: isDesktop && <ArtistLinkField source="artist" sortable={false} />, + composer: isDesktop && ( + <ArtistLinkField source="composer" sortable={false} /> + ), duration: <DurationField source="duration" sortable={false} />, year: isDesktop && ( <FunctionField @@ -148,6 +151,7 @@ const AlbumSongs = (props) => { columns: toggleableFields, omittedColumns: ['title'], defaultOff: [ + 'composer', 'channels', 'bpm', 'year', diff --git a/ui/src/album/AlbumTableView.jsx b/ui/src/album/AlbumTableView.jsx index 1fa33d769..d1a89d512 100644 --- a/ui/src/album/AlbumTableView.jsx +++ b/ui/src/album/AlbumTableView.jsx @@ -14,6 +14,7 @@ import { makeStyles } from '@material-ui/core/styles' import { useDrag } from 'react-dnd' import { ArtistLinkField, + CoverArtAvatar, DurationField, RangeField, SimpleList, @@ -161,12 +162,18 @@ const AlbumTableView = ({       </> )} + leftIcon={(r) => ( + <span style={{ marginRight: '8px' }}> + <CoverArtAvatar record={r} variant="square" /> + </span> + )} linkType={'show'} rightIcon={(r) => <AlbumContextMenu record={r} />} {...rest} /> ) : ( <AlbumDatagrid rowClick={'show'} classes={{ row: classes.row }} {...rest}> + <CoverArtAvatar source="id" variant="square" /> <TextField source="name" /> {columns} <AlbumContextMenu diff --git a/ui/src/artist/ArtistActions.jsx b/ui/src/artist/ArtistActions.jsx new file mode 100644 index 000000000..0b48f232d --- /dev/null +++ b/ui/src/artist/ArtistActions.jsx @@ -0,0 +1,149 @@ +import React from 'react' +import PropTypes from 'prop-types' +import { useDispatch } from 'react-redux' +import { useMediaQuery, CircularProgress } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import { + Button, + TopToolbar, + sanitizeListRestProps, + useDataProvider, + useNotify, + useTranslate, +} from 'react-admin' +import ShuffleIcon from '@material-ui/icons/Shuffle' +import PlayArrowIcon from '@material-ui/icons/PlayArrow' +import { IoIosRadio } from 'react-icons/io' +import { playShuffle, playTopSongs } from './actions.js' +import { playSimilar } from '../common/playbackActions.js' + +const useStyles = makeStyles((theme) => ({ + toolbar: { + minHeight: 'auto', + padding: '0 !important', + background: 'transparent', + boxShadow: 'none', + '& .MuiToolbar-root': { + minHeight: 'auto', + padding: '0 !important', + background: 'transparent', + }, + }, + button: { + [theme.breakpoints.down('xs')]: { + minWidth: 'auto', + padding: '8px 12px', + fontSize: '0.75rem', + '& .MuiButton-startIcon': { + marginRight: '4px', + }, + }, + }, + radioIcon: { + [theme.breakpoints.down('xs')]: { + fontSize: '1.5rem', + }, + }, +})) + +const LoadingButton = ({ loading, icon, ...rest }) => ( + <Button {...rest}> + {loading ? <CircularProgress size={20} color="inherit" /> : icon} + </Button> +) + +const ArtistActions = ({ className, record, ...rest }) => { + const dispatch = useDispatch() + const translate = useTranslate() + const dataProvider = useDataProvider() + const notify = useNotify() + const classes = useStyles() + const isMobile = useMediaQuery((theme) => theme.breakpoints.down('xs')) + const [loadingAction, setLoadingAction] = React.useState(null) + const isLoading = !!loadingAction + + const handlePlay = React.useCallback(async () => { + setLoadingAction('play') + try { + await playTopSongs(dispatch, notify, record.name) + } catch (e) { + // eslint-disable-next-line no-console + console.error('Error fetching top songs for artist:', e) + notify('ra.page.error', 'warning') + } finally { + setLoadingAction(null) + } + }, [dispatch, notify, record]) + + const handleShuffle = React.useCallback(async () => { + setLoadingAction('shuffle') + try { + await playShuffle(dataProvider, dispatch, record.id) + } catch (e) { + // eslint-disable-next-line no-console + console.error('Error fetching songs for shuffle:', e) + notify('ra.page.error', 'warning') + } finally { + setLoadingAction(null) + } + }, [dataProvider, dispatch, record, notify]) + + const handleRadio = React.useCallback(async () => { + setLoadingAction('radio') + try { + await playSimilar(dispatch, notify, record.id) + } catch (e) { + // eslint-disable-next-line no-console + console.error('Error starting radio for artist:', e) + notify('ra.page.error', 'warning') + } finally { + setLoadingAction(null) + } + }, [dispatch, notify, record]) + + return ( + <TopToolbar + className={`${className} ${classes.toolbar}`} + {...sanitizeListRestProps(rest)} + > + <LoadingButton + onClick={handlePlay} + label={translate('resources.artist.actions.topSongs')} + className={classes.button} + size={isMobile ? 'small' : 'medium'} + disabled={isLoading} + loading={loadingAction === 'play'} + icon={<PlayArrowIcon />} + /> + <LoadingButton + onClick={handleShuffle} + label={translate('resources.artist.actions.shuffle')} + className={classes.button} + size={isMobile ? 'small' : 'medium'} + disabled={isLoading} + loading={loadingAction === 'shuffle'} + icon={<ShuffleIcon />} + /> + <LoadingButton + onClick={handleRadio} + label={translate('resources.artist.actions.radio')} + className={classes.button} + size={isMobile ? 'small' : 'medium'} + disabled={isLoading} + loading={loadingAction === 'radio'} + icon={<IoIosRadio className={classes.radioIcon} />} + /> + </TopToolbar> + ) +} + +ArtistActions.propTypes = { + className: PropTypes.string, + record: PropTypes.object.isRequired, +} + +ArtistActions.defaultProps = { + className: '', +} + +export default ArtistActions diff --git a/ui/src/artist/ArtistActions.test.jsx b/ui/src/artist/ArtistActions.test.jsx new file mode 100644 index 000000000..a11ee50e3 --- /dev/null +++ b/ui/src/artist/ArtistActions.test.jsx @@ -0,0 +1,230 @@ +import React from 'react' +import { render, fireEvent, waitFor, screen } from '@testing-library/react' +import { TestContext } from 'ra-test' +import { describe, it, expect, vi, beforeEach } from 'vitest' +import ArtistActions from './ArtistActions' +import subsonic from '../subsonic' +import { ThemeProvider, createTheme } from '@material-ui/core/styles' + +const mockDispatch = vi.fn() +vi.mock('react-redux', () => ({ useDispatch: () => mockDispatch })) + +vi.mock('../subsonic', () => ({ + default: { getSimilarSongs2: vi.fn(), getTopSongs: vi.fn() }, +})) + +const mockNotify = vi.fn() +const mockGetList = vi.fn().mockResolvedValue({ data: [{ id: 's1' }] }) + +vi.mock('react-admin', async (importOriginal) => { + const actual = await importOriginal() + return { + ...actual, + useNotify: () => mockNotify, + useDataProvider: () => ({ getList: mockGetList }), + useTranslate: () => (x) => x, + } +}) + +describe('ArtistActions', () => { + const defaultRecord = { id: 'ar1', name: 'Artist' } + + const renderArtistActions = (record = defaultRecord) => { + const theme = createTheme() + return render( + <TestContext> + <ThemeProvider theme={theme}> + <ArtistActions record={record} /> + </ThemeProvider> + </TestContext>, + ) + } + + const clickActionButton = (actionKey) => { + fireEvent.click(screen.getByText(`resources.artist.actions.${actionKey}`)) + } + + beforeEach(() => { + vi.clearAllMocks() + // Mock console.error to suppress error logging in tests + vi.spyOn(console, 'error').mockImplementation(() => {}) + + const songWithReplayGain = { + id: 'rec1', + replayGain: { + albumGain: -5, + albumPeak: 1, + trackGain: -6, + trackPeak: 0.8, + }, + } + + subsonic.getSimilarSongs2.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + similarSongs2: { song: [songWithReplayGain] }, + }, + }, + }) + subsonic.getTopSongs.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + topSongs: { song: [songWithReplayGain] }, + }, + }, + }) + }) + + describe('Shuffle action', () => { + it('shuffles songs when clicked', async () => { + renderArtistActions() + clickActionButton('shuffle') + + await waitFor(() => + expect(mockGetList).toHaveBeenCalledWith('song', { + pagination: { page: 1, perPage: 500 }, + sort: { field: 'random', order: 'ASC' }, + filter: { album_artist_id: 'ar1', missing: false }, + }), + ) + expect(mockDispatch).toHaveBeenCalled() + }) + }) + + describe('Radio action', () => { + it('starts radio when clicked', async () => { + renderArtistActions() + clickActionButton('radio') + + await waitFor(() => + expect(subsonic.getSimilarSongs2).toHaveBeenCalledWith('ar1', 100), + ) + expect(mockDispatch).toHaveBeenCalled() + }) + + it('maps replaygain info', async () => { + renderArtistActions() + clickActionButton('radio') + + await waitFor(() => + expect(subsonic.getSimilarSongs2).toHaveBeenCalledWith('ar1', 100), + ) + const action = mockDispatch.mock.calls[0][0] + expect(action.data.rec1).toMatchObject({ + rgAlbumGain: -5, + rgAlbumPeak: 1, + rgTrackGain: -6, + rgTrackPeak: 0.8, + }) + }) + }) + + describe('Play action', () => { + it('plays top songs when clicked', async () => { + renderArtistActions() + clickActionButton('topSongs') + + await waitFor(() => + expect(subsonic.getTopSongs).toHaveBeenCalledWith('Artist', 100), + ) + expect(mockDispatch).toHaveBeenCalled() + }) + + it('maps replaygain info for top songs', async () => { + renderArtistActions() + clickActionButton('topSongs') + + await waitFor(() => + expect(subsonic.getTopSongs).toHaveBeenCalledWith('Artist', 100), + ) + const action = mockDispatch.mock.calls[0][0] + expect(action.data.rec1).toMatchObject({ + rgAlbumGain: -5, + rgAlbumPeak: 1, + rgTrackGain: -6, + rgTrackPeak: 0.8, + }) + }) + + it('handles API rejection', async () => { + subsonic.getTopSongs.mockRejectedValue(new Error('Network error')) + + renderArtistActions() + clickActionButton('topSongs') + + await waitFor(() => + expect(subsonic.getTopSongs).toHaveBeenCalledWith('Artist', 100), + ) + expect(mockNotify).toHaveBeenCalledWith('ra.page.error', 'warning') + expect(mockDispatch).not.toHaveBeenCalled() + }) + + it('handles failed API response', async () => { + subsonic.getTopSongs.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'failed', + error: { code: 40, message: 'Wrong username or password' }, + }, + }, + }) + + renderArtistActions() + clickActionButton('topSongs') + + await waitFor(() => + expect(subsonic.getTopSongs).toHaveBeenCalledWith('Artist', 100), + ) + expect(mockNotify).toHaveBeenCalledWith('ra.page.error', 'warning') + expect(mockDispatch).not.toHaveBeenCalled() + }) + + it('handles empty song list', async () => { + subsonic.getTopSongs.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + topSongs: { song: [] }, + }, + }, + }) + + renderArtistActions() + clickActionButton('topSongs') + + await waitFor(() => + expect(subsonic.getTopSongs).toHaveBeenCalledWith('Artist', 100), + ) + expect(mockNotify).toHaveBeenCalledWith( + 'message.noTopSongsFound', + 'warning', + ) + expect(mockDispatch).not.toHaveBeenCalled() + }) + + it('handles missing topSongs property', async () => { + subsonic.getTopSongs.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + // topSongs property is missing + }, + }, + }) + + renderArtistActions() + clickActionButton('topSongs') + + await waitFor(() => + expect(subsonic.getTopSongs).toHaveBeenCalledWith('Artist', 100), + ) + expect(mockNotify).toHaveBeenCalledWith( + 'message.noTopSongsFound', + 'warning', + ) + expect(mockDispatch).not.toHaveBeenCalled() + }) + }) +}) diff --git a/ui/src/artist/ArtistExternalLink.jsx b/ui/src/artist/ArtistExternalLink.jsx index 9efa3925b..a83972f17 100644 --- a/ui/src/artist/ArtistExternalLink.jsx +++ b/ui/src/artist/ArtistExternalLink.jsx @@ -4,10 +4,18 @@ import { IconButton, Tooltip, Link } from '@material-ui/core' import { ImLastfm2 } from 'react-icons/im' import MusicBrainz from '../icons/MusicBrainz' -import { intersperse } from '../utils' +import { intersperse, isLastFmURL } from '../utils' import config from '../config' +import { makeStyles } from '@material-ui/core/styles' + +const useStyles = makeStyles({ + linkBar: { + minHeight: '1.875em', + }, +}) const ArtistExternalLinks = ({ artistInfo, record }) => { + const classes = useStyles() const translate = useTranslate() let linkButtons = [] const lastFMlink = artistInfo?.biography?.match( @@ -30,13 +38,13 @@ const ArtistExternalLinks = ({ artistInfo, record }) => { } if (config.lastFMEnabled) { - if (lastFMlink) { + if (lastFMlink && isLastFmURL(lastFMlink[2])) { addLink( lastFMlink[2], 'message.openIn.lastfm', <ImLastfm2 className="lastfm-icon" />, ) - } else if (artistInfo?.lastFmUrl) { + } else if (isLastFmURL(artistInfo?.lastFmUrl)) { addLink( artistInfo?.lastFmUrl, 'message.openIn.lastfm', @@ -52,7 +60,7 @@ const ArtistExternalLinks = ({ artistInfo, record }) => { <MusicBrainz className="musicbrainz-icon" />, ) - return <div>{intersperse(linkButtons, ' ')}</div> + return <div className={classes.linkBar}>{intersperse(linkButtons, ' ')}</div> } export default ArtistExternalLinks diff --git a/ui/src/artist/ArtistList.jsx b/ui/src/artist/ArtistList.jsx index 7a14e9efe..4559aa8e6 100644 --- a/ui/src/artist/ArtistList.jsx +++ b/ui/src/artist/ArtistList.jsx @@ -22,8 +22,8 @@ import { useDrag } from 'react-dnd' import clsx from 'clsx' import { ArtistContextMenu, + CoverArtAvatar, List, - QuickFilter, useGetHandleArtistClick, RatingField, useSelectedFields, @@ -43,6 +43,10 @@ const useStyles = makeStyles({ verticalAlign: 'text-top', }, row: { + '& td': { + paddingTop: '4px !important', + paddingBottom: '4px !important', + }, '&:hover': { '& $contextMenu': { visibility: 'visible', @@ -83,10 +87,9 @@ const ArtistFilter = (props) => { <SearchInput id="search" source="name" alwaysOn /> <SelectInput source="role" choices={roles} alwaysOn /> {config.enableFavourites && ( - <QuickFilter + <NullableBooleanInput source="starred" label={<FavoriteIcon fontSize={'small'} />} - defaultValue={true} /> )} {isAdmin && <NullableBooleanInput source="missing" />} @@ -132,8 +135,10 @@ const ArtistListView = ({ hasShow, hasEdit, hasList, width, ...rest }) => { useResourceRefresh('artist') const role = filterValues?.role - const getCounter = (record, counter) => - role ? record?.stats[role]?.[counter] : record?.[counter] + const getCounter = (record, counter) => { + if (!record) return undefined + return role ? record?.stats?.[role]?.[counter] : record?.[counter] + } const getAlbumCount = (record) => getCounter(record, 'albumCount') const getSongCount = (record) => getCounter(record, 'songCount') const getSize = (record) => { @@ -168,6 +173,7 @@ const ArtistListView = ({ hasShow, hasEdit, hasList, width, ...rest }) => { /> ) : ( <ArtistDatagrid rowClick={handleArtistLink} classes={{ row: classes.row }}> + <CoverArtAvatar source="id" /> <TextField source="name" /> <FunctionField source="albumCount" diff --git a/ui/src/artist/ArtistShow.jsx b/ui/src/artist/ArtistShow.jsx index 86f82bf35..935b0bab7 100644 --- a/ui/src/artist/ArtistShow.jsx +++ b/ui/src/artist/ArtistShow.jsx @@ -1,4 +1,4 @@ -import React, { useState, createElement, useEffect } from 'react' +import { useState, useEffect } from 'react' import { useMediaQuery, withWidth } from '@material-ui/core' import { useShowController, @@ -7,21 +7,55 @@ import { useShowContext, ReferenceManyField, Pagination, + Title as RaTitle, } from 'react-admin' import subsonic from '../subsonic' import AlbumGridView from '../album/AlbumGridView' import MobileArtistDetails from './MobileArtistDetails' import DesktopArtistDetails from './DesktopArtistDetails' -import { useAlbumsPerPage, useResourceRefresh } from '../common/index.js' +import { useAlbumsPerPage, useResourceRefresh, Title } from '../common/index.js' +import ArtistActions from './ArtistActions' +import { makeStyles } from '@material-ui/core' + +const useStyles = makeStyles( + (theme) => ({ + actions: { + width: '100%', + justifyContent: 'flex-start', + display: 'flex', + paddingTop: '0.25em', + paddingBottom: '0.25em', + paddingLeft: '1em', + paddingRight: '1em', + flexWrap: 'wrap', + overflowX: 'auto', + [theme.breakpoints.down('xs')]: { + paddingLeft: '0.5em', + paddingRight: '0.5em', + gap: '0.5em', + justifyContent: 'space-around', + }, + }, + actionsContainer: { + paddingLeft: '.75rem', + [theme.breakpoints.down('xs')]: { + padding: '.5rem', + }, + }, + }), + { + name: 'NDArtistShow', + }, +) const ArtistDetails = (props) => { const record = useRecordContext(props) - const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('sm')) + const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('sm'), { + noSsr: true, + }) const [artistInfo, setArtistInfo] = useState() - const biography = - artistInfo?.biography?.replace(new RegExp('<.*>', 'g'), '') || - record.biography + const biography = artistInfo?.biography || record.biography useEffect(() => { subsonic @@ -38,15 +72,9 @@ const ArtistDetails = (props) => { }) }, [record.id]) - const component = isDesktop ? DesktopArtistDetails : MobileArtistDetails + const Component = isDesktop ? DesktopArtistDetails : MobileArtistDetails return ( - <> - {createElement(component, { - artistInfo, - record, - biography, - })} - </> + <Component artistInfo={artistInfo} record={record} biography={biography} /> ) } @@ -55,16 +83,17 @@ const ArtistShowLayout = (props) => { const record = useRecordContext() const { width } = props const [, perPageOptions] = useAlbumsPerPage(width) + const classes = useStyles() useResourceRefresh('artist', 'album') const maxPerPage = 90 let perPage = 0 let pagination = null - const count = Math.max( - record?.stats?.['albumartist']?.albumCount || 0, - record?.stats?.['artist']?.albumCount ?? 0, - ) + // Use the main credit count instead of total count, as this is a precise measure + // of the number of albums where the artist is credited as an album artist OR + // artist + const count = record?.stats?.['maincredit']?.albumCount || 0 if (count > maxPerPage) { perPage = Math.trunc(maxPerPage / perPageOptions[0]) * perPageOptions[0] @@ -76,7 +105,13 @@ const ArtistShowLayout = (props) => { return ( <> + {record && <RaTitle title={<Title subTitle={record.name} />} />} {record && <ArtistDetails />} + {record && ( + <div className={classes.actionsContainer}> + <ArtistActions record={record} className={classes.actions} /> + </div> + )} {record && ( <ReferenceManyField {...showContext} diff --git a/ui/src/artist/ArtistSimpleList.jsx b/ui/src/artist/ArtistSimpleList.jsx index deeb3edbc..55b6b1a0b 100644 --- a/ui/src/artist/ArtistSimpleList.jsx +++ b/ui/src/artist/ArtistSimpleList.jsx @@ -2,12 +2,13 @@ import React from 'react' import PropTypes from 'prop-types' import List from '@material-ui/core/List' import ListItem from '@material-ui/core/ListItem' +import ListItemAvatar from '@material-ui/core/ListItemAvatar' import ListItemIcon from '@material-ui/core/ListItemIcon' import ListItemSecondaryAction from '@material-ui/core/ListItemSecondaryAction' import ListItemText from '@material-ui/core/ListItemText' import { makeStyles } from '@material-ui/core/styles' import { sanitizeListRestProps } from 'react-admin' -import { ArtistContextMenu, RatingField } from '../common' +import { ArtistContextMenu, CoverArtAvatar, RatingField } from '../common' import config from '../config' const useStyles = makeStyles( @@ -47,7 +48,11 @@ const ArtistSimpleList = ({ data[id] && ( <span key={id} onClick={() => linkType(id)}> <ListItem className={classes.listItem} button={true}> + <ListItemAvatar> + <CoverArtAvatar record={data[id]} /> + </ListItemAvatar> <ListItemText + style={{ marginLeft: '8px' }} primary={ <> <div className={classes.title}>{data[id].name}</div> diff --git a/ui/src/artist/DesktopArtistDetails.jsx b/ui/src/artist/DesktopArtistDetails.jsx index 5d56bdef7..dda761097 100644 --- a/ui/src/artist/DesktopArtistDetails.jsx +++ b/ui/src/artist/DesktopArtistDetails.jsx @@ -6,11 +6,17 @@ import CardContent from '@material-ui/core/CardContent' import CardMedia from '@material-ui/core/CardMedia' import ArtistExternalLinks from './ArtistExternalLink' import config from '../config' -import { LoveButton, RatingField } from '../common' +import { + LoveButton, + RatingField, + ImageUploadOverlay, + useImageLoadingState, +} from '../common' import Lightbox from 'react-image-lightbox' import ExpandInfoDialog from '../dialogs/ExpandInfoDialog' import AlbumInfo from '../album/AlbumInfo' import subsonic from '../subsonic' +import { SafeHTML } from '../common/SafeHTML' const useStyles = makeStyles( (theme) => ({ @@ -29,6 +35,7 @@ const useStyles = makeStyles( float: 'left', wordBreak: 'break-word', cursor: 'pointer', + minHeight: '4.5em', }, content: { flex: '1 0 auto', @@ -38,12 +45,24 @@ const useStyles = makeStyles( height: '12rem', borderRadius: '6em', cursor: 'pointer', + backgroundColor: 'transparent', + transition: 'opacity 0.3s ease-in-out', + objectFit: 'cover', + }, + coverLoading: { + opacity: 0.5, }, artistImage: { maxHeight: '12rem', + minHeight: '12rem', + width: '12rem', + minWidth: '12rem', backgroundColor: 'inherit', display: 'flex', + alignItems: 'center', + justifyContent: 'center', boxShadow: 'none', + position: 'relative', }, artistDetail: { flex: '1', @@ -72,13 +91,15 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { const [expanded, setExpanded] = useState(false) const classes = useStyles() const title = record.name - const [isLightboxOpen, setLightboxOpen] = React.useState(false) - - const handleOpenLightbox = React.useCallback(() => setLightboxOpen(true), []) - const handleCloseLightbox = React.useCallback( - () => setLightboxOpen(false), - [], - ) + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) return ( <div className={classes.root}> @@ -86,12 +107,24 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { <Card className={classes.artistImage}> {artistInfo && ( <CardMedia - className={classes.cover} - image={subsonic.getCoverArtUrl(record, 300)} + key={record.id} + component="img" + src={subsonic.getCoverArtUrl(record, config.uiCoverArtSize)} + className={`${classes.cover} ${imageLoading ? classes.coverLoading : ''}`} onClick={handleOpenLightbox} + onLoad={handleImageLoad} + onError={handleImageError} title={title} + style={{ + cursor: imageError ? 'default' : 'pointer', + }} /> )} + <ImageUploadOverlay + entityType="artist" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> </Card> <div className={classes.details}> <CardContent className={classes.content}> @@ -130,7 +163,9 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { variant={'body1'} onClick={() => setExpanded(!expanded)} > - <span dangerouslySetInnerHTML={{ __html: biography }} /> + <span> + <SafeHTML>{biography}</SafeHTML> + </span> </Typography> </Collapse> </CardContent> @@ -140,7 +175,7 @@ const DesktopArtistDetails = ({ artistInfo, record, biography }) => { )} </Typography> </div> - {isLightboxOpen && ( + {isLightboxOpen && !imageError && ( <Lightbox imagePadding={50} animationDuration={200} diff --git a/ui/src/artist/MobileArtistDetails.jsx b/ui/src/artist/MobileArtistDetails.jsx index 4f1bac909..e82d4c28a 100644 --- a/ui/src/artist/MobileArtistDetails.jsx +++ b/ui/src/artist/MobileArtistDetails.jsx @@ -4,9 +4,15 @@ import { makeStyles } from '@material-ui/core/styles' import Card from '@material-ui/core/Card' import CardMedia from '@material-ui/core/CardMedia' import config from '../config' -import { LoveButton, RatingField } from '../common' +import { + LoveButton, + RatingField, + ImageUploadOverlay, + useImageLoadingState, +} from '../common' import Lightbox from 'react-image-lightbox' import subsonic from '../subsonic' +import { SafeHTML } from '../common/SafeHTML' const useStyles = makeStyles( (theme) => ({ @@ -50,6 +56,12 @@ const useStyles = makeStyles( width: 151, boxShadow: '0px 0px 6px 0px #565656', borderRadius: '5px', + backgroundColor: 'transparent', + transition: 'opacity 0.3s ease-in-out', + objectFit: 'cover', + }, + coverLoading: { + opacity: 0.5, }, artistImage: { marginLeft: '1em', @@ -60,6 +72,7 @@ const useStyles = makeStyles( minWidth: '7rem', display: 'flex', borderRadius: '5em', + position: 'relative', }, loveButton: { top: theme.spacing(-0.2), @@ -76,17 +89,19 @@ const useStyles = makeStyles( ) const MobileArtistDetails = ({ artistInfo, biography, record }) => { - const img = subsonic.getCoverArtUrl(record) + const img = subsonic.getCoverArtUrl(record, 800) const [expanded, setExpanded] = useState(false) const classes = useStyles({ img, expanded }) const title = record.name - const [isLightboxOpen, setLightboxOpen] = React.useState(false) - - const handleOpenLightbox = React.useCallback(() => setLightboxOpen(true), []) - const handleCloseLightbox = React.useCallback( - () => setLightboxOpen(false), - [], - ) + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) return ( <> @@ -95,12 +110,24 @@ const MobileArtistDetails = ({ artistInfo, biography, record }) => { <Card className={classes.artistImage}> {artistInfo && ( <CardMedia - className={classes.cover} - image={subsonic.getCoverArtUrl(record, 300)} + key={record.id} + component="img" + src={subsonic.getCoverArtUrl(record, config.uiCoverArtSize)} + className={`${classes.cover} ${imageLoading ? classes.coverLoading : ''}`} onClick={handleOpenLightbox} + onLoad={handleImageLoad} + onError={handleImageError} title={title} + style={{ + cursor: imageError ? 'default' : 'pointer', + }} /> )} + <ImageUploadOverlay + entityType="artist" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> </Card> <div className={classes.details}> <Typography @@ -132,11 +159,13 @@ const MobileArtistDetails = ({ artistInfo, biography, record }) => { <div className={classes.biography}> <Collapse collapsedHeight={'1.5em'} in={expanded} timeout={'auto'}> <Typography variant={'body1'} onClick={() => setExpanded(!expanded)}> - <span dangerouslySetInnerHTML={{ __html: biography }} /> + <span> + <SafeHTML>{biography}</SafeHTML> + </span> </Typography> </Collapse> </div> - {isLightboxOpen && ( + {isLightboxOpen && !imageError && ( <Lightbox imagePadding={50} animationDuration={200} diff --git a/ui/src/artist/actions.js b/ui/src/artist/actions.js new file mode 100644 index 000000000..94b3adf42 --- /dev/null +++ b/ui/src/artist/actions.js @@ -0,0 +1,39 @@ +import subsonic from '../subsonic/index.js' +import { playTracks } from '../actions/index.js' +import { processSongsForPlayback } from '../common/playbackActions.js' + +export const playTopSongs = async (dispatch, notify, artistName) => { + const res = await subsonic.getTopSongs(artistName, 100) + const data = res.json['subsonic-response'] + + if (data.status !== 'ok') { + throw new Error( + `Error fetching top songs: ${data.error?.message || 'Unknown error'} (Code: ${data.error?.code || 'unknown'})`, + ) + } + + const songs = data.topSongs?.song || [] + if (!songs.length) { + notify('message.noTopSongsFound', 'warning') + return + } + + const { songData, ids } = processSongsForPlayback(songs) + dispatch(playTracks(songData, ids)) +} + +export const playShuffle = async (dataProvider, dispatch, id) => { + const res = await dataProvider.getList('song', { + pagination: { page: 1, perPage: 500 }, + sort: { field: 'random', order: 'ASC' }, + filter: { album_artist_id: id, missing: false }, + }) + + const data = {} + const ids = [] + res.data.forEach((s) => { + data[s.id] = s + ids.push(s.id) + }) + dispatch(playTracks(data, ids)) +} diff --git a/ui/src/audioplayer/AudioTitle.jsx b/ui/src/audioplayer/AudioTitle.jsx index aebd37170..df37edfbb 100644 --- a/ui/src/audioplayer/AudioTitle.jsx +++ b/ui/src/audioplayer/AudioTitle.jsx @@ -3,6 +3,7 @@ import { useMediaQuery } from '@material-ui/core' import { Link } from 'react-router-dom' import clsx from 'clsx' import { QualityInfo } from '../common' +import { decisionService } from '../transcode' import useStyle from './styles' import { useDrag } from 'react-dnd' import { DraggableTypes } from '../consts' @@ -35,19 +36,25 @@ const AudioTitle = React.memo(({ audioInfo, gainInfo, isMobile }) => { rgTrackPeak: song.rgTrackPeak, } + const decision = decisionService.getCachedDecision(audioInfo.trackId) + const transcodeProps = decision + ? { + transcodeStream: decision.transcodeStream || null, + isDirectPlay: decision.canDirectPlay, + } + : {} + const subtitle = song.tags?.['subtitle'] const title = song.title + (subtitle ? ` (${subtitle})` : '') + const linkTo = audioInfo.isRadio + ? `/radio/${audioInfo.trackId}/show` + : song.playlistId + ? `/playlist/${song.playlistId}/show` + : `/album/${song.albumId}/show` + return ( - <Link - to={ - audioInfo.isRadio - ? `/radio/${audioInfo.trackId}/show` - : `/album/${song.albumId}/show` - } - className={className} - ref={dragSongRef} - > + <Link to={linkTo} className={className} ref={dragSongRef}> <span> <span className={clsx(classes.songTitle, 'songTitle')}>{title}</span> {isDesktop && ( @@ -55,6 +62,7 @@ const AudioTitle = React.memo(({ audioInfo, gainInfo, isMobile }) => { record={qi} className={classes.qualityInfo} {...gainInfo} + {...transcodeProps} /> )} </span> diff --git a/ui/src/audioplayer/AudioTitle.test.jsx b/ui/src/audioplayer/AudioTitle.test.jsx new file mode 100644 index 000000000..7b297c07e --- /dev/null +++ b/ui/src/audioplayer/AudioTitle.test.jsx @@ -0,0 +1,58 @@ +import React from 'react' +import { render, screen } from '@testing-library/react' +import { describe, it, expect, beforeEach, vi } from 'vitest' +import AudioTitle from './AudioTitle' + +vi.mock('@material-ui/core', async () => { + const actual = await import('@material-ui/core') + return { + ...actual, + useMediaQuery: vi.fn(), + } +}) + +vi.mock('react-router-dom', () => ({ + // eslint-disable-next-line react/display-name + Link: React.forwardRef(({ to, children, ...props }, ref) => ( + <a href={to} ref={ref} {...props}> + {children} + </a> + )), +})) + +vi.mock('react-dnd', () => ({ + useDrag: vi.fn(() => [null, () => {}]), +})) + +describe('<AudioTitle />', () => { + const baseSong = { + id: 'song-1', + albumId: 'album-1', + playlistId: 'playlist-1', + title: 'Test Song', + artist: 'Artist', + album: 'Album', + year: '2020', + } + + beforeEach(() => { + vi.clearAllMocks() + }) + + it('links to playlist when playlistId is provided', () => { + const audioInfo = { trackId: 'track-1', song: baseSong } + render(<AudioTitle audioInfo={audioInfo} gainInfo={{}} isMobile={false} />) + const link = screen.getByRole('link') + expect(link.getAttribute('href')).toBe('/playlist/playlist-1/show') + }) + + it('falls back to album link when no playlistId', () => { + const audioInfo = { + trackId: 'track-1', + song: { ...baseSong, playlistId: undefined }, + } + render(<AudioTitle audioInfo={audioInfo} gainInfo={{}} isMobile={false} />) + const link = screen.getByRole('link') + expect(link.getAttribute('href')).toBe('/album/album-1/show') + }) +}) diff --git a/ui/src/audioplayer/Player.jsx b/ui/src/audioplayer/Player.jsx index 1f57737d0..c3d795b26 100644 --- a/ui/src/audioplayer/Player.jsx +++ b/ui/src/audioplayer/Player.jsx @@ -1,4 +1,5 @@ -import React, { useCallback, useEffect, useMemo, useState } from 'react' +import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react' +import { useInterval } from '../common' import { useDispatch, useSelector } from 'react-redux' import { useMediaQuery } from '@material-ui/core' import { ThemeProvider } from '@material-ui/core/styles' @@ -19,7 +20,9 @@ import AudioTitle from './AudioTitle' import { clearQueue, currentPlaying, + refreshQueue, setPlayMode, + setTranscodingProfile, setVolume, syncQueue, } from '../actions' @@ -30,6 +33,7 @@ import locale from './locale' import { keyMap } from '../hotkeys' import keyHandlers from './keyHandlers' import { calculateGain } from '../utils/calculateReplayGain' +import { detectBrowserProfile, decisionService } from '../transcode' const Player = () => { const theme = useCurrentTheme() @@ -38,9 +42,11 @@ const Player = () => { const dataProvider = useDataProvider() const playerState = useSelector((state) => state.player) const dispatch = useDispatch() - const [startTime, setStartTime] = useState(null) - const [scrobbled, setScrobbled] = useState(false) - const [preloaded, setPreload] = useState(false) + const [currentTrackId, setCurrentTrackId] = useState(null) + const [heartbeatTrackId, setHeartbeatTrackId] = useState(null) + const lastPositionMsRef = useRef(0) + const currentTrackIdRef = useRef(null) + const stoppedRef = useRef(false) const [audioInstance, setAudioInstance] = useState(null) const isDesktop = useMediaQuery('(min-width:810px)') const isMobilePlayer = @@ -49,6 +55,76 @@ const Player = () => { ) const { authenticated } = useAuthState() + + // Keep a ref to playerState so the mount effect can read the latest value + // without re-triggering on every queue/position change + const playerStateRef = useRef(playerState) + playerStateRef.current = playerState + + currentTrackIdRef.current = currentTrackId + + useInterval( + () => { + if (heartbeatTrackId && !stoppedRef.current) { + subsonic.reportPlayback( + heartbeatTrackId, + lastPositionMsRef.current, + 'playing', + ) + } + }, + heartbeatTrackId ? config.playbackReportIntervalMs : null, + ) + + // Detect browser codec profile and eagerly resolve transcode URLs for the + // persisted queue once on mount (e.g. after a browser refresh) + useEffect(() => { + const profile = detectBrowserProfile() + decisionService.setProfile(profile) + dispatch(setTranscodingProfile(profile)) + + const state = playerStateRef.current + const currentIdx = state.savedPlayIndex || 0 + const trackIds = state.queue + .slice(currentIdx, currentIdx + 4) + .filter((item) => !item.isRadio && item.trackId) + .map((item) => item.trackId) + + if (trackIds.length === 0) { + dispatch(refreshQueue()) + return + } + + Promise.allSettled( + trackIds.map((id) => + decisionService.resolveStreamUrl(id).then((url) => [id, url]), + ), + ).then((results) => { + const resolvedUrls = {} + results.forEach((r) => { + if (r.status === 'fulfilled') { + resolvedUrls[r.value[0]] = r.value[1] + } + }) + dispatch(refreshQueue(resolvedUrls)) + }) + }, [dispatch]) + + // Pre-fetch transcode decisions for next 2-3 songs when queue or position changes + useEffect(() => { + if (!playerState.queue.length) return + + const currentIdx = playerState.savedPlayIndex || 0 + const nextSongIds = playerState.queue + .slice(currentIdx + 1, currentIdx + 4) + .filter((item) => !item.isRadio) + .map((item) => item.trackId) + + if (nextSongIds.length > 0) { + decisionService.prefetchDecisions(nextSongIds) + } + }, [playerState.queue, playerState.savedPlayIndex]) + const visible = authenticated && playerState.queue.length > 0 const isRadio = playerState.current?.isRadio || false const classes = useStyle({ @@ -95,6 +171,37 @@ const Player = () => { } }, [audioInstance, context, gainNode, playerState, gainInfo]) + useEffect(() => { + const handleBeforeUnload = (e) => { + if (playerState.current?.uuid && audioInstance && !audioInstance.paused) { + e.preventDefault() + e.returnValue = '' + } + } + + const handlePageHide = () => { + if (currentTrackIdRef.current && !playerState.current?.isRadio) { + stoppedRef.current = true + try { + subsonic.reportPlaybackKeepalive( + currentTrackIdRef.current, + lastPositionMsRef.current, + 'stopped', + ) + } catch { + // fetch/sendBeacon may throw; ignore + } + } + } + + window.addEventListener('beforeunload', handleBeforeUnload) + window.addEventListener('pagehide', handlePageHide) + return () => { + window.removeEventListener('beforeunload', handleBeforeUnload) + window.removeEventListener('pagehide', handlePageHide) + } + }, [playerState, audioInstance]) + const defaultOptions = useMemo( () => ({ theme: playerTheme, @@ -127,6 +234,7 @@ const Player = () => { /> ), locale: locale(translate), + sortableOptions: { delay: 200, delayOnTouchOnly: true }, }), [gainInfo, isDesktop, playerTheme, translate, playerState.mode], ) @@ -137,7 +245,10 @@ const Player = () => { ...defaultOptions, audioLists: playerState.queue.map((item) => item), playIndex: playerState.playIndex, - autoPlay: playerState.clear || playerState.playIndex === 0, + autoPlay: + playerState.queue.length > 0 && + playerState.autoPlay !== false && + (playerState.clear || playerState.playIndex === 0), clearPriorAudioLists: playerState.clear, extendsContent: ( <PlayerToolbar id={current.trackId} isRadio={current.isRadio} /> @@ -152,45 +263,14 @@ const Player = () => { [dispatch], ) - const nextSong = useCallback(() => { - const idx = playerState.queue.findIndex( - (item) => item.uuid === playerState.current.uuid, - ) - return idx !== null ? playerState.queue[idx + 1] : null - }, [playerState]) - - const onAudioProgress = useCallback( - (info) => { - if (info.ended) { - document.title = 'Navidrome' - } - - const progress = (info.currentTime / info.duration) * 100 - if (isNaN(info.duration) || (progress < 50 && info.currentTime < 240)) { - return - } - - if (info.isRadio) { - return - } - - if (!preloaded) { - const next = nextSong() - if (next != null) { - const audio = new Audio() - audio.src = next.musicSrc - } - setPreload(true) - return - } - - if (!scrobbled) { - info.trackId && subsonic.scrobble(info.trackId, startTime) - setScrobbled(true) - } - }, - [startTime, scrobbled, nextSong, preloaded], - ) + const onAudioProgress = useCallback((info) => { + if (info.ended) { + document.title = 'Navidrome' + } + if (!info.isRadio && info.currentTime != null) { + lastPositionMsRef.current = Math.floor(info.currentTime * 1000) + } + }, []) const onAudioVolumeChange = useCallback( // sqrt to compensate for the logarithmic volume @@ -200,23 +280,30 @@ const Player = () => { const onAudioPlay = useCallback( (info) => { - // Do this to start the context; on chrome-based browsers, the context - // will start paused since it is created prior to user interaction if (context && context.state !== 'running') { context.resume() } dispatch(currentPlaying(info)) - if (startTime === null) { - setStartTime(Date.now()) - } if (info.duration) { const song = info.song document.title = `${song.title} - ${song.artist} - Navidrome` if (!info.isRadio) { - subsonic.nowPlaying(info.trackId) + const posMs = Math.floor(info.currentTime * 1000) + lastPositionMsRef.current = posMs + const isNewTrack = info.trackId !== currentTrackId + if (isNewTrack) { + subsonic + .reportPlayback(info.trackId, posMs, 'starting') + .then(() => + subsonic.reportPlayback(info.trackId, posMs, 'playing'), + ) + setCurrentTrackId(info.trackId) + } else { + subsonic.reportPlayback(info.trackId, posMs, 'playing') + } + setHeartbeatTrackId(info.trackId) } - setPreload(false) if (config.gaTrackingId) { ReactGA.event({ category: 'Player', @@ -233,34 +320,49 @@ const Player = () => { } } }, - [context, dispatch, showNotifications, startTime], + [context, dispatch, showNotifications, currentTrackId], ) const onAudioPlayTrackChange = useCallback(() => { - if (scrobbled) { - setScrobbled(false) + if (currentTrackId) { + subsonic.reportPlayback( + currentTrackId, + lastPositionMsRef.current, + 'stopped', + ) } - if (startTime !== null) { - setStartTime(null) - } - }, [scrobbled, startTime]) + setHeartbeatTrackId(null) + setCurrentTrackId(null) + }, [currentTrackId]) const onAudioPause = useCallback( - (info) => dispatch(currentPlaying(info)), - [dispatch], + (info) => { + dispatch(currentPlaying(info)) + if (!info.isRadio && currentTrackId) { + const posMs = Math.floor(info.currentTime * 1000) + lastPositionMsRef.current = posMs + subsonic.reportPlayback(currentTrackId, posMs, 'paused') + } + setHeartbeatTrackId(null) + }, + [dispatch, currentTrackId], ) const onAudioEnded = useCallback( (currentPlayId, audioLists, info) => { - setScrobbled(false) - setStartTime(null) + if (currentTrackId && !info.isRadio) { + const posMs = Math.floor((info.duration || 0) * 1000) + subsonic.reportPlayback(currentTrackId, posMs, 'stopped') + } + setHeartbeatTrackId(null) + setCurrentTrackId(null) dispatch(currentPlaying(info)) dataProvider .getOne('keepalive', { id: info.trackId }) // eslint-disable-next-line no-console .catch((e) => console.log('Keepalive error:', e)) }, - [dispatch, dataProvider], + [dispatch, dataProvider, currentTrackId], ) const onCoverClick = useCallback((mode, audioLists, audioInfo) => { @@ -269,12 +371,43 @@ const Player = () => { } }, []) + const onAudioError = useCallback( + (error, currentPlayId, audioLists, audioInfo) => { + // Invalidate all cached decisions — token may be stale + decisionService.invalidateAll() + + // Pre-fetch decisions for upcoming songs with fresh tokens + const currentIdx = playerState.queue.findIndex( + (item) => item.uuid === currentPlayId, + ) + if (currentIdx >= 0) { + const nextSongIds = playerState.queue + .slice(currentIdx + 1, currentIdx + 4) + .filter((item) => !item.isRadio) + .map((item) => item.trackId) + if (nextSongIds.length > 0) { + decisionService.prefetchDecisions(nextSongIds) + } + } + }, + [playerState.queue], + ) + const onBeforeDestroy = useCallback(() => { return new Promise((resolve, reject) => { + if (currentTrackId && !playerStateRef.current?.current?.isRadio) { + subsonic.reportPlayback( + currentTrackId, + lastPositionMsRef.current, + 'stopped', + ) + } + setHeartbeatTrackId(null) + setCurrentTrackId(null) dispatch(clearQueue()) reject() }) - }, [dispatch]) + }, [dispatch, currentTrackId]) if (!visible) { document.title = 'Navidrome' @@ -291,6 +424,35 @@ const Player = () => { } }, [isMobilePlayer, audioInstance]) + // Report every seek (including programmatic ones the library does not surface + // via onAudioSeeked, e.g. restartCurrentOnPrev). Debounce coalesces drag + // bursts into one report at the final position. + useEffect(() => { + if (!audioInstance) return + let timer = null + const flush = () => { + timer = null + if ( + !currentTrackIdRef.current || + playerStateRef.current?.current?.isRadio + ) { + return + } + const posMs = Math.floor((audioInstance.currentTime || 0) * 1000) + const state = audioInstance.paused ? 'paused' : 'playing' + subsonic.reportPlayback(currentTrackIdRef.current, posMs, state) + } + const handleSeeked = () => { + if (timer) clearTimeout(timer) + timer = setTimeout(flush, 250) + } + audioInstance.addEventListener('seeked', handleSeeked) + return () => { + if (timer) clearTimeout(timer) + audioInstance.removeEventListener('seeked', handleSeeked) + } + }, [audioInstance]) + return ( <ThemeProvider theme={createMuiTheme(theme)}> <ReactJkMusicPlayer @@ -305,6 +467,7 @@ const Player = () => { onPlayModeChange={(mode) => dispatch(setPlayMode(mode))} onAudioEnded={onAudioEnded} onCoverClick={onCoverClick} + onAudioError={onAudioError} onBeforeDestroy={onBeforeDestroy} getAudioInstance={setAudioInstance} /> diff --git a/ui/src/audioplayer/PlayerToolbar.jsx b/ui/src/audioplayer/PlayerToolbar.jsx index 82f9e36f3..4812141ab 100644 --- a/ui/src/audioplayer/PlayerToolbar.jsx +++ b/ui/src/audioplayer/PlayerToolbar.jsx @@ -57,7 +57,7 @@ const useStyles = makeStyles((theme) => ({ const PlayerToolbar = ({ id, isRadio }) => { const dispatch = useDispatch() - const { data, loading } = useGetOne('song', id) + const { data, loading } = useGetOne('song', id, { enabled: !!id && !isRadio }) const [toggleLove, toggling] = useToggleLove('song', data) const isDesktop = useMediaQuery('(min-width:810px)') const classes = useStyles() diff --git a/ui/src/authProvider.js b/ui/src/authProvider.js index 4ae238eec..813a4f5b4 100644 --- a/ui/src/authProvider.js +++ b/ui/src/authProvider.js @@ -66,6 +66,10 @@ const authProvider = { logout: () => { removeItems() + if (config.extAuthLogoutURL) { + window.location.href = config.extAuthLogoutURL + return Promise.resolve(false) + } return Promise.resolve() }, diff --git a/ui/src/common/CoverArtAvatar.jsx b/ui/src/common/CoverArtAvatar.jsx new file mode 100644 index 000000000..f70403774 --- /dev/null +++ b/ui/src/common/CoverArtAvatar.jsx @@ -0,0 +1,52 @@ +import { useRecordContext } from 'react-admin' +import { Avatar } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import clsx from 'clsx' +import config from '../config' +import subsonic from '../subsonic' +import { useImageUrl } from './useImageUrl' + +const useStyles = makeStyles({ + avatar: { + width: '55px', + height: '55px', + }, + avatarEmpty: { + backgroundColor: 'transparent', + }, + square: { + borderRadius: '4px', + }, +}) + +export const CoverArtAvatar = ({ + record: recordProp, + variant = 'circular', +}) => { + const classes = useStyles() + const recordContext = useRecordContext() + const record = recordProp || recordContext + const square = variant !== 'circular' + const url = record + ? subsonic.getCoverArtUrl(record, config.uiCoverArtSize, square) + : null + const { imgUrl } = useImageUrl(url) + if (!record) return null + return ( + <Avatar + src={imgUrl || undefined} + variant={variant} + className={clsx( + classes.avatar, + square && classes.square, + !imgUrl && classes.avatarEmpty, + )} + alt={record.name} + > + {/* Empty child prevents default person icon while loading */} + {!imgUrl && <span />} + </Avatar> + ) +} + +CoverArtAvatar.defaultProps = { label: '', sortable: false } diff --git a/ui/src/common/DateField.jsx b/ui/src/common/DateField.jsx index fab15b53c..dce24a2b9 100644 --- a/ui/src/common/DateField.jsx +++ b/ui/src/common/DateField.jsx @@ -1,10 +1,11 @@ import React from 'react' +import { isDateSet } from '../utils/validations' import { DateField as RADateField } from 'react-admin' export const DateField = (props) => { const { record, source } = props const value = record?.[source] - if (value === '0001-01-01T00:00:00Z' || value === null) return null + if (!isDateSet(value)) return null return <RADateField {...props} /> } diff --git a/ui/src/common/ImageUploadOverlay.jsx b/ui/src/common/ImageUploadOverlay.jsx new file mode 100644 index 000000000..a370e40fe --- /dev/null +++ b/ui/src/common/ImageUploadOverlay.jsx @@ -0,0 +1,139 @@ +import { IconButton, Tooltip } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import PhotoCameraIcon from '@material-ui/icons/PhotoCamera' +import DeleteIcon from '@material-ui/icons/Delete' +import { useTranslate, useNotify, useRefresh } from 'react-admin' +import { useCallback, useRef } from 'react' +import config from '../config' +import { REST_URL } from '../consts' +import { httpClient } from '../dataProvider' + +const useStyles = makeStyles(() => ({ + coverOverlay: { + position: 'absolute', + bottom: 0, + right: 0, + display: 'flex', + gap: '2px', + padding: '2px', + backgroundColor: 'rgba(0,0,0,0.5)', + borderRadius: '4px 0 0 0', + opacity: 0, + transition: 'opacity 0.2s ease-in-out', + '*:hover > &': { + opacity: 1, + }, + }, + overlayButton: { + color: '#fff', + padding: '4px', + '&:hover': { + backgroundColor: 'rgba(255,255,255,0.2)', + }, + }, + overlayIcon: { + fontSize: '1.2rem', + }, +})) + +export const ImageUploadOverlay = ({ + entityType, + entityId, + hasUploadedImage, + onImageChange, +}) => { + const translate = useTranslate() + const notify = useNotify() + const refresh = useRefresh() + const classes = useStyles() + const fileInputRef = useRef(null) + + const canEdit = + config.enableArtworkUpload || localStorage.getItem('role') === 'admin' + + const handleUploadClick = useCallback((e) => { + e.stopPropagation() + if (fileInputRef.current) { + fileInputRef.current.click() + } + }, []) + + const handleFileChange = useCallback( + async (e) => { + const file = e.target.files[0] + if (!file || !entityId) return + + const formData = new FormData() + formData.append('image', file) + + try { + await httpClient(`${REST_URL}/${entityType}/${entityId}/image`, { + method: 'POST', + headers: new Headers({}), + body: formData, + }) + notify(`message.coverUploaded`, 'success') + if (onImageChange) onImageChange() + refresh() + } catch (err) { + notify(`message.coverUploadError`, 'warning') + } + + e.target.value = '' + }, + [entityType, entityId, notify, refresh, onImageChange], + ) + + const handleRemoveCover = useCallback( + async (e) => { + e.stopPropagation() + if (!entityId) return + + try { + await httpClient(`${REST_URL}/${entityType}/${entityId}/image`, { + method: 'DELETE', + }) + notify(`message.coverRemoved`, 'success') + if (onImageChange) onImageChange() + refresh() + } catch (err) { + notify(`message.coverRemoveError`, 'warning') + } + }, + [entityType, entityId, notify, refresh, onImageChange], + ) + + if (!canEdit) return null + + return ( + <div className={classes.coverOverlay}> + <Tooltip title={translate(`message.uploadCover`)}> + <IconButton + className={classes.overlayButton} + onClick={handleUploadClick} + size="small" + > + <PhotoCameraIcon className={classes.overlayIcon} /> + </IconButton> + </Tooltip> + {hasUploadedImage && ( + <Tooltip title={translate(`message.removeCover`)}> + <IconButton + className={classes.overlayButton} + onClick={handleRemoveCover} + size="small" + > + <DeleteIcon className={classes.overlayIcon} /> + </IconButton> + </Tooltip> + )} + <input + ref={fileInputRef} + type="file" + accept="image/*" + style={{ display: 'none' }} + onChange={handleFileChange} + /> + </div> + ) +} diff --git a/ui/src/common/LibrarySelector.jsx b/ui/src/common/LibrarySelector.jsx new file mode 100644 index 000000000..1e89d3ec6 --- /dev/null +++ b/ui/src/common/LibrarySelector.jsx @@ -0,0 +1,221 @@ +import React, { useState, useEffect, useCallback } from 'react' +import { useDispatch, useSelector } from 'react-redux' +import { useDataProvider, useTranslate, useRefresh } from 'react-admin' +import { + Box, + Chip, + ClickAwayListener, + FormControl, + FormGroup, + FormControlLabel, + Checkbox, + Typography, + Paper, + Popper, + makeStyles, +} from '@material-ui/core' +import { ExpandMore, ExpandLess, LibraryMusic } from '@material-ui/icons' +import { setSelectedLibraries, setUserLibraries } from '../actions' +import { useRefreshOnEvents } from './useRefreshOnEvents' + +const useStyles = makeStyles((theme) => ({ + root: { + marginTop: theme.spacing(3), + marginBottom: theme.spacing(3), + paddingLeft: theme.spacing(2), + paddingRight: theme.spacing(2), + display: 'flex', + justifyContent: 'center', + }, + chip: { + borderRadius: theme.spacing(1), + height: theme.spacing(4.8), + fontSize: '1rem', + fontWeight: 'normal', + minWidth: '210px', + justifyContent: 'flex-start', + paddingLeft: theme.spacing(1), + paddingRight: theme.spacing(1), + marginTop: theme.spacing(0.1), + '& .MuiChip-label': { + paddingLeft: theme.spacing(2), + paddingRight: theme.spacing(1), + }, + '& .MuiChip-icon': { + fontSize: '1.2rem', + marginLeft: theme.spacing(0.5), + }, + }, + popper: { + zIndex: 1300, + }, + paper: { + padding: theme.spacing(2), + marginTop: theme.spacing(1), + minWidth: 300, + maxWidth: 400, + }, + headerContainer: { + display: 'flex', + alignItems: 'center', + marginBottom: 0, + }, + masterCheckbox: { + padding: '7px', + marginLeft: '-9px', + marginRight: 0, + }, +})) + +const LibrarySelector = () => { + const classes = useStyles() + const dispatch = useDispatch() + const dataProvider = useDataProvider() + const translate = useTranslate() + const refresh = useRefresh() + const [anchorEl, setAnchorEl] = useState(null) + const [open, setOpen] = useState(false) + + const { userLibraries, selectedLibraries } = useSelector( + (state) => state.library, + ) + + // Load user's libraries when component mounts + const loadUserLibraries = useCallback(async () => { + const userId = localStorage.getItem('userId') + if (userId) { + try { + const { data } = await dataProvider.getOne('user', { id: userId }) + const libraries = data.libraries || [] + dispatch(setUserLibraries(libraries)) + } catch (error) { + // eslint-disable-next-line no-console + console.warn( + 'Could not load user libraries (this may be expected for non-admin users):', + error, + ) + } + } + }, [dataProvider, dispatch]) + + // Initial load + useEffect(() => { + loadUserLibraries() + }, [loadUserLibraries]) + + // Reload user libraries when library changes occur + useRefreshOnEvents({ + events: ['library', 'user'], + onRefresh: loadUserLibraries, + }) + + // Don't render if user has no libraries or only has one library + if (!userLibraries.length || userLibraries.length === 1) { + return null + } + + const handleToggle = (event) => { + setAnchorEl(event.currentTarget) + const wasOpen = open + setOpen(!open) + // Refresh data when closing the dropdown + if (wasOpen) { + refresh() + } + } + + const handleClose = () => { + setOpen(false) + refresh() + } + + const handleLibraryToggle = (libraryId) => { + const newSelection = selectedLibraries.includes(libraryId) + ? selectedLibraries.filter((id) => id !== libraryId) + : [...selectedLibraries, libraryId] + + dispatch(setSelectedLibraries(newSelection)) + } + + const handleMasterCheckboxChange = () => { + if (isAllSelected) { + dispatch(setSelectedLibraries([])) + } else { + const allIds = userLibraries.map((lib) => lib.id) + dispatch(setSelectedLibraries(allIds)) + } + } + + const selectedCount = selectedLibraries.length + const totalCount = userLibraries.length + const isAllSelected = selectedCount === totalCount + const isNoneSelected = selectedCount === 0 + const isIndeterminate = selectedCount > 0 && selectedCount < totalCount + + const displayText = isNoneSelected + ? translate('menu.librarySelector.none') + ` (0 of ${totalCount})` + : isAllSelected + ? translate('menu.librarySelector.allLibraries', { count: totalCount }) + : translate('menu.librarySelector.multipleLibraries', { + selected: selectedCount, + total: totalCount, + }) + + return ( + <Box className={classes.root}> + <Chip + icon={<LibraryMusic />} + label={displayText} + onClick={handleToggle} + onDelete={open ? handleToggle : undefined} + deleteIcon={open ? <ExpandLess /> : <ExpandMore />} + variant="outlined" + className={classes.chip} + /> + + <Popper + open={open} + anchorEl={anchorEl} + placement="bottom-start" + className={classes.popper} + > + <ClickAwayListener onClickAway={handleClose}> + <Paper className={classes.paper}> + <Box className={classes.headerContainer}> + <Checkbox + checked={isAllSelected} + indeterminate={isIndeterminate} + onChange={handleMasterCheckboxChange} + size="small" + className={classes.masterCheckbox} + /> + <Typography> + {translate('menu.librarySelector.selectLibraries')}: + </Typography> + </Box> + + <FormControl component="fieldset" variant="standard" fullWidth> + <FormGroup> + {userLibraries.map((library) => ( + <FormControlLabel + key={library.id} + control={ + <Checkbox + checked={selectedLibraries.includes(library.id)} + onChange={() => handleLibraryToggle(library.id)} + size="small" + /> + } + label={library.name} + /> + ))} + </FormGroup> + </FormControl> + </Paper> + </ClickAwayListener> + </Popper> + </Box> + ) +} + +export default LibrarySelector diff --git a/ui/src/common/LibrarySelector.test.jsx b/ui/src/common/LibrarySelector.test.jsx new file mode 100644 index 000000000..13b607887 --- /dev/null +++ b/ui/src/common/LibrarySelector.test.jsx @@ -0,0 +1,517 @@ +import React from 'react' +import { render, screen, fireEvent, waitFor } from '@testing-library/react' +import userEvent from '@testing-library/user-event' +import { describe, it, expect, beforeEach, vi } from 'vitest' +import LibrarySelector from './LibrarySelector' + +// Mock dependencies +const mockDispatch = vi.fn() +const mockDataProvider = { + getOne: vi.fn(), +} +const mockIdentity = { username: 'testuser' } +const mockRefresh = vi.fn() +const mockTranslate = vi.fn((key, options = {}) => { + const translations = { + 'menu.librarySelector.allLibraries': `All Libraries (${options.count || 0})`, + 'menu.librarySelector.multipleLibraries': `${options.selected || 0} of ${options.total || 0} Libraries`, + 'menu.librarySelector.none': 'None', + 'menu.librarySelector.selectLibraries': 'Select Libraries', + } + return translations[key] || key +}) + +vi.mock('react-redux', () => ({ + useDispatch: () => mockDispatch, + useSelector: vi.fn(), +})) + +vi.mock('react-admin', () => ({ + useDataProvider: () => mockDataProvider, + useGetIdentity: () => ({ identity: mockIdentity }), + useTranslate: () => mockTranslate, + useRefresh: () => mockRefresh, +})) + +// Mock Material-UI components +vi.mock('@material-ui/core', () => ({ + Box: ({ children, className, ...props }) => ( + <div className={className} {...props}> + {children} + </div> + ), + Chip: ({ label, onClick, onDelete, deleteIcon, icon, ...props }) => ( + <button onClick={onClick} {...props}> + {icon} + {label} + {deleteIcon && <span onClick={onDelete}>{deleteIcon}</span>} + </button> + ), + ClickAwayListener: ({ children, onClickAway }) => ( + <div data-testid="click-away-listener" onMouseDown={onClickAway}> + {children} + </div> + ), + Collapse: ({ children, in: inProp }) => + inProp ? <div>{children}</div> : null, + FormControl: ({ children }) => <div>{children}</div>, + FormGroup: ({ children }) => <div>{children}</div>, + FormControlLabel: ({ control, label }) => ( + <label> + {control} + {label} + </label> + ), + Checkbox: ({ + checked, + indeterminate, + onChange, + size, + className, + ...props + }) => ( + <input + type="checkbox" + checked={checked} + ref={(el) => { + if (el) el.indeterminate = indeterminate + }} + onChange={onChange} + className={className} + {...props} + /> + ), + Typography: ({ children, variant, ...props }) => ( + <span {...props}>{children}</span> + ), + Paper: ({ children, className }) => ( + <div className={className}>{children}</div> + ), + Popper: ({ open, children, anchorEl, placement, className }) => + open ? ( + <div className={className} data-testid="popper"> + {children} + </div> + ) : null, + makeStyles: (styles) => () => { + if (typeof styles === 'function') { + return styles({ + spacing: (value) => `${value * 8}px`, + palette: { divider: '#ccc' }, + shape: { borderRadius: 4 }, + }) + } + return styles + }, +})) + +vi.mock('@material-ui/icons', () => ({ + ExpandMore: () => <span data-testid="expand-more">▼</span>, + ExpandLess: () => <span data-testid="expand-less">▲</span>, + LibraryMusic: () => <span data-testid="library-music">🎵</span>, +})) + +// Mock actions +vi.mock('../actions', () => ({ + setSelectedLibraries: (libraries) => ({ + type: 'SET_SELECTED_LIBRARIES', + data: libraries, + }), + setUserLibraries: (libraries) => ({ + type: 'SET_USER_LIBRARIES', + data: libraries, + }), +})) + +describe('LibrarySelector', () => { + const mockLibraries = [ + { id: '1', name: 'Music Library', path: '/music' }, + { id: '2', name: 'Podcasts', path: '/podcasts' }, + { id: '3', name: 'Audiobooks', path: '/audiobooks' }, + ] + + const defaultState = { + userLibraries: mockLibraries, + selectedLibraries: ['1'], + } + + let mockUseSelector + + beforeEach(async () => { + vi.clearAllMocks() + const { useSelector } = await import('react-redux') + mockUseSelector = vi.mocked(useSelector) + mockDataProvider.getOne.mockResolvedValue({ + data: { libraries: mockLibraries }, + }) + // Setup localStorage mock + Object.defineProperty(window, 'localStorage', { + value: { + getItem: vi.fn(() => null), // Default to null to prevent API calls + setItem: vi.fn(), + }, + writable: true, + }) + }) + + const renderLibrarySelector = (selectorState = defaultState) => { + mockUseSelector.mockImplementation((selector) => + selector({ library: selectorState }), + ) + + return render(<LibrarySelector />) + } + + describe('when user has no libraries', () => { + it('should not render anything', () => { + const { container } = renderLibrarySelector({ + userLibraries: [], + selectedLibraries: [], + }) + expect(container.firstChild).toBeNull() + }) + }) + + describe('when user has only one library', () => { + it('should not render anything', () => { + const singleLibrary = [mockLibraries[0]] + const { container } = renderLibrarySelector({ + userLibraries: singleLibrary, + selectedLibraries: ['1'], + }) + expect(container.firstChild).toBeNull() + }) + }) + + describe('when user has multiple libraries', () => { + it('should render the chip with correct label when one library is selected', () => { + renderLibrarySelector() + + expect(screen.getByRole('button')).toBeInTheDocument() + expect(screen.getByText('1 of 3 Libraries')).toBeInTheDocument() + expect(screen.getByTestId('library-music')).toBeInTheDocument() + expect(screen.getByTestId('expand-more')).toBeInTheDocument() + }) + + it('should render the chip with "All Libraries" when all libraries are selected', () => { + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: ['1', '2', '3'], + }) + + expect(screen.getByText('All Libraries (3)')).toBeInTheDocument() + }) + + it('should render the chip with "None" when no libraries are selected', () => { + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: [], + }) + + expect(screen.getByText('None (0 of 3)')).toBeInTheDocument() + }) + + it('should show expand less icon when dropdown is open', async () => { + const user = userEvent.setup() + renderLibrarySelector() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + expect(screen.getByTestId('expand-less')).toBeInTheDocument() + }) + + it('should open dropdown when chip is clicked', async () => { + const user = userEvent.setup() + renderLibrarySelector() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + expect(screen.getByTestId('popper')).toBeInTheDocument() + expect(screen.getByText('Select Libraries:')).toBeInTheDocument() + }) + + it('should display all library names in dropdown', async () => { + const user = userEvent.setup() + renderLibrarySelector() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + expect(screen.getByText('Music Library')).toBeInTheDocument() + expect(screen.getByText('Podcasts')).toBeInTheDocument() + expect(screen.getByText('Audiobooks')).toBeInTheDocument() + }) + + it('should not display library paths', async () => { + const user = userEvent.setup() + renderLibrarySelector() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + expect(screen.queryByText('/music')).not.toBeInTheDocument() + expect(screen.queryByText('/podcasts')).not.toBeInTheDocument() + expect(screen.queryByText('/audiobooks')).not.toBeInTheDocument() + }) + + describe('master checkbox', () => { + it('should be checked when all libraries are selected', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: ['1', '2', '3'], + }) + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] // First checkbox is the master checkbox + expect(masterCheckbox.checked).toBe(true) + expect(masterCheckbox.indeterminate).toBe(false) + }) + + it('should be unchecked when no libraries are selected', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: [], + }) + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] + expect(masterCheckbox.checked).toBe(false) + expect(masterCheckbox.indeterminate).toBe(false) + }) + + it('should be indeterminate when some libraries are selected', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + }) + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] + expect(masterCheckbox.checked).toBe(false) + expect(masterCheckbox.indeterminate).toBe(true) + }) + + it('should select all libraries when clicked and none are selected', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: [], + }) + + // Clear the dispatch mock after initial mount (it sets user libraries) + mockDispatch.mockClear() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] + + // Use fireEvent.click to trigger the onChange event + fireEvent.click(masterCheckbox) + + expect(mockDispatch).toHaveBeenCalledWith({ + type: 'SET_SELECTED_LIBRARIES', + data: ['1', '2', '3'], + }) + }) + + it('should deselect all libraries when clicked and all are selected', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: ['1', '2', '3'], + }) + + // Clear the dispatch mock after initial mount (it sets user libraries) + mockDispatch.mockClear() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] + + fireEvent.click(masterCheckbox) + + expect(mockDispatch).toHaveBeenCalledWith({ + type: 'SET_SELECTED_LIBRARIES', + data: [], + }) + }) + + it('should select all libraries when clicked and some are selected', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: ['1'], + }) + + // Clear the dispatch mock after initial mount (it sets user libraries) + mockDispatch.mockClear() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] + + fireEvent.click(masterCheckbox) + + expect(mockDispatch).toHaveBeenCalledWith({ + type: 'SET_SELECTED_LIBRARIES', + data: ['1', '2', '3'], + }) + }) + }) + + describe('individual library checkboxes', () => { + it('should show correct checked state for each library', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: ['1', '3'], + }) + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + // Skip master checkbox (index 0) + expect(checkboxes[1].checked).toBe(true) // Music Library + expect(checkboxes[2].checked).toBe(false) // Podcasts + expect(checkboxes[3].checked).toBe(true) // Audiobooks + }) + + it('should toggle library selection when individual checkbox is clicked', async () => { + const user = userEvent.setup() + renderLibrarySelector() + + // Clear the dispatch mock after initial mount (it sets user libraries) + mockDispatch.mockClear() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const podcastsCheckbox = checkboxes[2] // Podcasts checkbox + + fireEvent.click(podcastsCheckbox) + + expect(mockDispatch).toHaveBeenCalledWith({ + type: 'SET_SELECTED_LIBRARIES', + data: ['1', '2'], + }) + }) + + it('should remove library from selection when clicking checked library', async () => { + const user = userEvent.setup() + renderLibrarySelector({ + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + }) + + // Clear the dispatch mock after initial mount (it sets user libraries) + mockDispatch.mockClear() + + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + const checkboxes = screen.getAllByRole('checkbox') + const musicCheckbox = checkboxes[1] // Music Library checkbox + + fireEvent.click(musicCheckbox) + + expect(mockDispatch).toHaveBeenCalledWith({ + type: 'SET_SELECTED_LIBRARIES', + data: ['2'], + }) + }) + }) + + it('should close dropdown when clicking away', async () => { + const user = userEvent.setup() + renderLibrarySelector() + + // Open dropdown + const chipButton = screen.getByRole('button') + await user.click(chipButton) + + expect(screen.getByTestId('popper')).toBeInTheDocument() + + // Click away + const clickAwayListener = screen.getByTestId('click-away-listener') + fireEvent.mouseDown(clickAwayListener) + + await waitFor(() => { + expect(screen.queryByTestId('popper')).not.toBeInTheDocument() + }) + + // Should trigger refresh when closing + expect(mockRefresh).toHaveBeenCalledTimes(1) + }) + + it('should load user libraries on mount', async () => { + // Override localStorage mock to return a userId for this test + window.localStorage.getItem.mockReturnValue('user123') + + mockDataProvider.getOne.mockResolvedValue({ + data: { libraries: mockLibraries }, + }) + + renderLibrarySelector({ userLibraries: [], selectedLibraries: [] }) + + await waitFor(() => { + expect(mockDataProvider.getOne).toHaveBeenCalledWith('user', { + id: 'user123', + }) + }) + + expect(mockDispatch).toHaveBeenCalledWith({ + type: 'SET_USER_LIBRARIES', + data: mockLibraries, + }) + }) + + it('should handle API error gracefully', async () => { + // Override localStorage mock to return a userId for this test + window.localStorage.getItem.mockReturnValue('user123') + + const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {}) + mockDataProvider.getOne.mockRejectedValue(new Error('API Error')) + + renderLibrarySelector({ userLibraries: [], selectedLibraries: [] }) + + await waitFor(() => { + expect(consoleSpy).toHaveBeenCalledWith( + 'Could not load user libraries (this may be expected for non-admin users):', + expect.any(Error), + ) + }) + + consoleSpy.mockRestore() + }) + + it('should not load libraries when userId is not available', () => { + window.localStorage.getItem.mockReturnValue(null) + + renderLibrarySelector({ userLibraries: [], selectedLibraries: [] }) + + expect(mockDataProvider.getOne).not.toHaveBeenCalled() + }) + }) +}) diff --git a/ui/src/common/Linkify.jsx b/ui/src/common/Linkify.jsx index 0a09e0d76..f1c8b28c9 100644 --- a/ui/src/common/Linkify.jsx +++ b/ui/src/common/Linkify.jsx @@ -53,12 +53,7 @@ const Linkify = ({ text, ...rest }) => { // Push remaining text if (text.length > lastIndex) { - elements.push( - <span - key={'last-span-key'} - dangerouslySetInnerHTML={{ __html: text.substring(lastIndex) }} - />, - ) + elements.push(text.substring(lastIndex)) } return elements.length === 1 ? elements[0] : elements diff --git a/ui/src/common/Linkify.test.jsx b/ui/src/common/Linkify.test.jsx index cef50b228..cd19ffa03 100644 --- a/ui/src/common/Linkify.test.jsx +++ b/ui/src/common/Linkify.test.jsx @@ -1,6 +1,5 @@ import React from 'react' import { render, screen } from '@testing-library/react' -import '@testing-library/jest-dom' import Linkify from './Linkify' const URL = 'http://www.example.com' diff --git a/ui/src/common/List.jsx b/ui/src/common/List.jsx index f74ab027e..72c2d9482 100644 --- a/ui/src/common/List.jsx +++ b/ui/src/common/List.jsx @@ -1,5 +1,6 @@ import React from 'react' import { List as RAList } from 'react-admin' +import config from '../config' import { Pagination } from './Pagination' import { Title } from './index' @@ -13,6 +14,7 @@ export const List = (props) => { args={{ smart_count: 2 }} /> } + debounce={config.uiSearchDebounceMs} perPage={15} pagination={<Pagination />} {...props} diff --git a/ui/src/common/LoveButton.jsx b/ui/src/common/LoveButton.jsx index f42d92ff4..492ba95b3 100644 --- a/ui/src/common/LoveButton.jsx +++ b/ui/src/common/LoveButton.jsx @@ -4,17 +4,26 @@ import FavoriteIcon from '@material-ui/icons/Favorite' import FavoriteBorderIcon from '@material-ui/icons/FavoriteBorder' import IconButton from '@material-ui/core/IconButton' import { makeStyles } from '@material-ui/core/styles' +import clsx from 'clsx' import { useToggleLove } from './useToggleLove' import { useRecordContext } from 'react-admin' import config from '../config' +import { isDateSet } from '../utils/validations' -const useStyles = makeStyles({ - love: { - color: (props) => props.color, - visibility: (props) => - props.visible === false ? 'hidden' : props.loved ? 'visible' : 'inherit', +const useStyles = makeStyles( + { + love: { + color: (props) => props.color, + visibility: (props) => + props.visible === false + ? 'hidden' + : props.loved + ? 'visible' + : 'inherit', + }, }, -}) + { name: 'NDLoveButton' }, +) export const LoveButton = ({ resource, @@ -24,9 +33,11 @@ export const LoveButton = ({ component: Button, addLabel, disabled, + className, + record: recordProp, ...rest }) => { - const record = useRecordContext(rest) || {} + const record = useRecordContext({ record: recordProp }) || {} const classes = useStyles({ color, visible, loved: record.starred }) const [toggleLove, loading] = useToggleLove(resource, record) @@ -46,8 +57,13 @@ export const LoveButton = ({ <Button onClick={handleToggleLove} size={'small'} - disabled={disabled || loading || record?.missing} - className={classes.love} + disabled={disabled || loading || record.missing} + className={clsx(classes.love, className)} + title={ + isDateSet(record.starredAt) + ? new Date(record.starredAt).toLocaleString() + : undefined + } {...rest} > {record.starred ? ( diff --git a/ui/src/common/MultiLineTextField.jsx b/ui/src/common/MultiLineTextField.jsx index f2a07ff86..1218d4bd6 100644 --- a/ui/src/common/MultiLineTextField.jsx +++ b/ui/src/common/MultiLineTextField.jsx @@ -28,19 +28,7 @@ export const MultiLineTextField = memo( component="span" {...sanitizeFieldRestProps(rest)} > - {lines.length === 0 && emptyText - ? emptyText - : lines.map((line, idx) => - line === '' ? ( - <br key={md5(line + idx)} /> - ) : ( - <div - data-testid={`${source}.${idx}`} - key={md5(line + idx)} - dangerouslySetInnerHTML={{ __html: line }} - /> - ), - )} + {lines.length === 0 && emptyText ? emptyText : lines} </Typography> ) }, diff --git a/ui/src/common/MultiLineTextField.test.jsx b/ui/src/common/MultiLineTextField.test.jsx deleted file mode 100644 index 8f29166a3..000000000 --- a/ui/src/common/MultiLineTextField.test.jsx +++ /dev/null @@ -1,28 +0,0 @@ -import * as React from 'react' -import { render, cleanup, screen } from '@testing-library/react' -import { MultiLineTextField } from './MultiLineTextField' - -describe('<MultiLineTextField />', () => { - afterEach(cleanup) - - it('should render each line in a separated div', () => { - const record = { comment: 'line1\nline2' } - render(<MultiLineTextField record={record} source={'comment'} />) - expect(screen.queryByTestId('comment.0').textContent).toBe('line1') - expect(screen.queryByTestId('comment.1').textContent).toBe('line2') - }) - - it.each([null, undefined])( - 'should render the emptyText when value is %s', - (body) => { - render( - <MultiLineTextField - record={{ id: 123, body }} - emptyText="NA" - source="body" - />, - ) - expect(screen.getByText('NA')).toBeInTheDocument() - }, - ) -}) diff --git a/ui/src/common/OverflowTooltip.jsx b/ui/src/common/OverflowTooltip.jsx new file mode 100644 index 000000000..c000bd9f0 --- /dev/null +++ b/ui/src/common/OverflowTooltip.jsx @@ -0,0 +1,90 @@ +import React from 'react' +import PropTypes from 'prop-types' +import { Tooltip } from '@material-ui/core' +import { makeStyles, alpha } from '@material-ui/core/styles' +import grey from '@material-ui/core/colors/grey' + +const useStyles = makeStyles( + (theme) => ({ + tooltip: { + backgroundColor: + theme.palette.type === 'dark' + ? alpha(grey[700], 0.92) + : alpha(grey[300], 0.92), + color: + theme.palette.type === 'dark' + ? theme.palette.common.white + : theme.palette.common.black, + borderRadius: theme.shape.borderRadius, + ...theme.typography.body2, + padding: theme.spacing(0.5, 1), + maxWidth: 300, + }, + }), + { name: 'NDOverflowTooltip' }, +) + +const transitionProps = { timeout: 0 } + +export const OverflowTooltip = ({ + children, + title, + placement = 'bottom-start', +}) => { + const classes = useStyles() + const textRef = React.useRef(null) + const [isOverflowing, setIsOverflowing] = React.useState(false) + const tooltipClasses = React.useMemo( + () => ({ tooltip: classes.tooltip }), + [classes.tooltip], + ) + + React.useLayoutEffect(() => { + const el = textRef.current + if (!el) return + + const checkOverflow = () => { + setIsOverflowing(el.scrollWidth > el.clientWidth) + } + + const resizeObserver = new ResizeObserver(checkOverflow) + resizeObserver.observe(el) + + checkOverflow() + + return () => resizeObserver.disconnect() + }, []) + + const mergedRef = React.useCallback( + (el) => { + textRef.current = el + + const { ref } = children + if (typeof ref === 'function') { + ref(el) + } else if (ref && typeof ref === 'object') { + ref.current = el + } + }, + [children], + ) + + return ( + <Tooltip + title={title} + disableHoverListener={!isOverflowing} + disableTouchListener + placement={placement} + TransitionProps={transitionProps} + classes={tooltipClasses} + > + {React.cloneElement(children, { ref: mergedRef })} + </Tooltip> + ) +} + +OverflowTooltip.propTypes = { + children: PropTypes.element.isRequired, + title: PropTypes.string.isRequired, + placement: PropTypes.string, +} diff --git a/ui/src/common/QualityInfo.jsx b/ui/src/common/QualityInfo.jsx index 171f5e0f0..57a8251a4 100644 --- a/ui/src/common/QualityInfo.jsx +++ b/ui/src/common/QualityInfo.jsx @@ -20,7 +20,15 @@ const useStyle = makeStyles( }, ) -export const QualityInfo = ({ record, size, gainMode, preAmp, className }) => { +export const QualityInfo = ({ + record, + size, + gainMode, + preAmp, + className, + transcodeStream, + isDirectPlay, +}) => { const classes = useStyle() let { suffix, bitRate, rgAlbumGain, rgAlbumPeak, rgTrackGain, rgTrackPeak } = record @@ -34,6 +42,20 @@ export const QualityInfo = ({ record, size, gainMode, preAmp, className }) => { } } + // Show transcode target when transcoding (not direct play) + if (transcodeStream && !isDirectPlay) { + const targetCodec = (transcodeStream.codec || '').toUpperCase() + const targetBitrate = transcodeStream.audioBitrate + ? Math.round(transcodeStream.audioBitrate / 1000) + : 0 + let targetInfo = targetCodec + if (targetBitrate > 0) { + targetInfo += ' ' + targetBitrate + } + const sourceSuffix = suffix || placeholder + info = `${sourceSuffix} → ${targetInfo}` + } + const extra = useMemo(() => { if (gainMode !== 'none') { const gainValue = calculateGain( @@ -63,6 +85,8 @@ QualityInfo.propTypes = { size: PropTypes.string, className: PropTypes.string, gainMode: PropTypes.string, + transcodeStream: PropTypes.object, + isDirectPlay: PropTypes.bool, } QualityInfo.defaultProps = { diff --git a/ui/src/common/QualityInfo.test.jsx b/ui/src/common/QualityInfo.test.jsx index ae1874715..174ee8a85 100644 --- a/ui/src/common/QualityInfo.test.jsx +++ b/ui/src/common/QualityInfo.test.jsx @@ -77,4 +77,30 @@ describe('<QualityInfo />', () => { ) expect(screen.getByText('FLAC (0.00 dB)')).toBeInTheDocument() }) + + it('shows transcode arrow when transcodeStream is provided', () => { + const info = { suffix: 'FLAC', bitRate: 1008 } + const transcodeStream = { codec: 'opus', audioBitrate: 128000 } + render(<QualityInfo record={info} transcodeStream={transcodeStream} />) + expect(screen.getByText('FLAC → OPUS 128')).toBeInTheDocument() + }) + + it('shows transcode with lossy source including bitrate', () => { + const info = { suffix: 'FLAC', bitRate: 1008 } + const transcodeStream = { codec: 'mp3', audioBitrate: 320000 } + render(<QualityInfo record={info} transcodeStream={transcodeStream} />) + expect(screen.getByText('FLAC → MP3 320')).toBeInTheDocument() + }) + + it('does not show arrow when isDirectPlay is true', () => { + const info = { suffix: 'MP3', bitRate: 320 } + render(<QualityInfo record={info} isDirectPlay={true} />) + expect(screen.getByText('MP3 320')).toBeInTheDocument() + }) + + it('behaves normally when no transcode props are passed', () => { + const info = { suffix: 'MP3', bitRate: 320 } + render(<QualityInfo record={info} />) + expect(screen.getByText('MP3 320')).toBeInTheDocument() + }) }) diff --git a/ui/src/common/RatingField.jsx b/ui/src/common/RatingField.jsx index 1b440c51e..f92b0d948 100644 --- a/ui/src/common/RatingField.jsx +++ b/ui/src/common/RatingField.jsx @@ -2,6 +2,7 @@ import React, { useCallback } from 'react' import PropTypes from 'prop-types' import Rating from '@material-ui/lab/Rating' import { makeStyles } from '@material-ui/core/styles' +import { isDateSet } from '../utils/validations' import StarBorderIcon from '@material-ui/icons/StarBorder' import clsx from 'clsx' import { useRating } from './useRating' @@ -38,15 +39,23 @@ export const RatingField = ({ const handleRating = useCallback( (e, val) => { - rate(val ?? 0, e.target.name) + const targetId = record.mediaFileId || record.id + rate(val ?? 0, targetId) }, - [rate], + [rate, record.mediaFileId, record.id], ) return ( - <span onClick={(e) => stopPropagation(e)}> + <span + onClick={(e) => stopPropagation(e)} + title={ + isDateSet(record.ratedAt) + ? new Date(record.ratedAt).toLocaleString() + : undefined + } + > <Rating - name={record.id} + name={record.mediaFileId || record.id} className={clsx( className, classes.rating, diff --git a/ui/src/common/SafeHTML.jsx b/ui/src/common/SafeHTML.jsx new file mode 100644 index 000000000..980883568 --- /dev/null +++ b/ui/src/common/SafeHTML.jsx @@ -0,0 +1,27 @@ +import DOMPurify from 'dompurify' +import { useMemo } from 'react' + +export const SafeHTML = ({ children }) => { + const purified = useMemo(() => { + const purify = DOMPurify() + + purify.addHook('afterSanitizeElements', async (node) => { + if (node instanceof HTMLElement) { + // Set referrer-policy for elements with src + switch (node.tagName.toLowerCase()) { + case 'a': + case 'area': + case 'img': + case 'video': + case 'iframe': + case 'script': + node.setAttribute('referrer-policy', 'no-referrer') + } + } + }) + + return purify.sanitize(children, { ADD_ATTR: ['referrer-policy'] }) + }, [children]) + + return <span dangerouslySetInnerHTML={{ __html: purified }} /> +} diff --git a/ui/src/common/SelectLibraryInput.jsx b/ui/src/common/SelectLibraryInput.jsx new file mode 100644 index 000000000..0ac9783f5 --- /dev/null +++ b/ui/src/common/SelectLibraryInput.jsx @@ -0,0 +1,228 @@ +import React, { useState, useEffect, useMemo } from 'react' +import Checkbox from '@material-ui/core/Checkbox' +import CheckBoxIcon from '@material-ui/icons/CheckBox' +import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank' +import { + List, + ListItem, + ListItemIcon, + ListItemText, + Typography, + Box, +} from '@material-ui/core' +import { useGetList, useTranslate } from 'react-admin' +import PropTypes from 'prop-types' +import { makeStyles } from '@material-ui/core' + +const useStyles = makeStyles((theme) => ({ + root: { + width: '960px', + maxWidth: '100%', + }, + headerContainer: { + display: 'flex', + alignItems: 'center', + marginBottom: theme.spacing(1), + paddingLeft: theme.spacing(1), + }, + masterCheckbox: { + padding: '7px', + marginLeft: '-9px', + marginRight: theme.spacing(1), + }, + libraryList: { + height: '120px', + overflow: 'auto', + border: `1px solid ${theme.palette.divider}`, + borderRadius: theme.shape.borderRadius, + backgroundColor: theme.palette.background.paper, + }, + listItem: { + paddingTop: 0, + paddingBottom: 0, + }, + emptyMessage: { + padding: theme.spacing(2), + textAlign: 'center', + color: theme.palette.text.secondary, + }, +})) + +const EmptyLibraryMessage = () => { + const classes = useStyles() + + return ( + <div className={classes.emptyMessage}> + <Typography variant="body2">No libraries available</Typography> + </div> + ) +} + +const LibraryListItem = ({ library, isSelected, onToggle }) => { + const classes = useStyles() + + return ( + <ListItem + className={classes.listItem} + button + onClick={() => onToggle(library)} + dense + > + <ListItemIcon> + <Checkbox + icon={<CheckBoxOutlineBlankIcon fontSize="small" />} + checkedIcon={<CheckBoxIcon fontSize="small" />} + checked={isSelected} + tabIndex={-1} + disableRipple + /> + </ListItemIcon> + <ListItemText primary={library.name} /> + </ListItem> + ) +} + +export const SelectLibraryInput = ({ + onChange, + value = [], + isNewUser = false, +}) => { + const classes = useStyles() + const translate = useTranslate() + const [selectedLibraryIds, setSelectedLibraryIds] = useState([]) + const [hasInitialized, setHasInitialized] = useState(false) + + const { ids, data, isLoading } = useGetList( + 'library', + { page: 1, perPage: -1 }, + { field: 'name', order: 'ASC' }, + ) + + const options = useMemo( + () => (ids && ids.map((id) => data[id])) || [], + [ids, data], + ) + + // Reset initialization state when isNewUser changes + useEffect(() => { + if (isNewUser) { + setHasInitialized(false) + } + }, [isNewUser]) + + // Pre-select default libraries for new users + useEffect(() => { + if ( + isNewUser && + !isLoading && + options.length > 0 && + !hasInitialized && + Array.isArray(value) && + value.length === 0 + ) { + const defaultLibraryIds = options + .filter((lib) => lib.defaultNewUsers) + .map((lib) => lib.id) + + if (defaultLibraryIds.length > 0) { + setSelectedLibraryIds(defaultLibraryIds) + onChange(defaultLibraryIds) + } + + setHasInitialized(true) + } + }, [isNewUser, isLoading, options, hasInitialized, value, onChange]) + + // Update selectedLibraryIds when value prop changes (for editing mode and pre-selection) + useEffect(() => { + // For new users, only sync from value prop if it has actual data + // This prevents empty initial state from overriding our pre-selection + if (isNewUser && Array.isArray(value) && value.length === 0) { + return + } + + if (Array.isArray(value)) { + const libraryIds = value.map((item) => + typeof item === 'object' ? item.id : item, + ) + setSelectedLibraryIds(libraryIds) + } else if (value.length === 0) { + // Handle case where value is explicitly set to empty array (for existing users) + setSelectedLibraryIds([]) + } + }, [value, isNewUser, hasInitialized]) + + const isLibrarySelected = (library) => selectedLibraryIds.includes(library.id) + + const handleLibraryToggle = (library) => { + const isSelected = selectedLibraryIds.includes(library.id) + let newSelection + + if (isSelected) { + newSelection = selectedLibraryIds.filter((id) => id !== library.id) + } else { + newSelection = [...selectedLibraryIds, library.id] + } + + setSelectedLibraryIds(newSelection) + onChange(newSelection) + } + + const handleMasterCheckboxChange = () => { + const isAllSelected = selectedLibraryIds.length === options.length + const newSelection = isAllSelected ? [] : options.map((lib) => lib.id) + + setSelectedLibraryIds(newSelection) + onChange(newSelection) + } + + const selectedCount = selectedLibraryIds.length + const totalCount = options.length + const isAllSelected = selectedCount === totalCount && totalCount > 0 + const isIndeterminate = selectedCount > 0 && selectedCount < totalCount + + return ( + <div className={classes.root}> + {options.length > 1 && ( + <Box className={classes.headerContainer}> + <Checkbox + checked={isAllSelected} + indeterminate={isIndeterminate} + onChange={handleMasterCheckboxChange} + size="small" + className={classes.masterCheckbox} + /> + <Typography variant="body2"> + {translate('resources.user.message.selectAllLibraries')} + </Typography> + </Box> + )} + <List className={classes.libraryList}> + {options.length === 0 ? ( + <EmptyLibraryMessage /> + ) : ( + options.map((library) => ( + <LibraryListItem + key={library.id} + library={library} + isSelected={isLibrarySelected(library)} + onToggle={handleLibraryToggle} + /> + )) + )} + </List> + </div> + ) +} + +SelectLibraryInput.propTypes = { + onChange: PropTypes.func.isRequired, + value: PropTypes.array, + isNewUser: PropTypes.bool, +} + +LibraryListItem.propTypes = { + library: PropTypes.object.isRequired, + isSelected: PropTypes.bool.isRequired, + onToggle: PropTypes.func.isRequired, +} diff --git a/ui/src/common/SelectLibraryInput.test.jsx b/ui/src/common/SelectLibraryInput.test.jsx new file mode 100644 index 000000000..8a7e56d3e --- /dev/null +++ b/ui/src/common/SelectLibraryInput.test.jsx @@ -0,0 +1,458 @@ +import * as React from 'react' +import { render, screen, fireEvent, cleanup } from '@testing-library/react' +import { SelectLibraryInput } from './SelectLibraryInput' +import { useGetList } from 'react-admin' +import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest' + +// Mock Material-UI components +vi.mock('@material-ui/core', () => ({ + List: ({ children }) => <div>{children}</div>, + ListItem: ({ children, button, onClick, dense, className }) => ( + <button onClick={onClick} className={className}> + {children} + </button> + ), + ListItemIcon: ({ children }) => <span>{children}</span>, + ListItemText: ({ primary }) => <span>{primary}</span>, + Typography: ({ children, variant }) => <span>{children}</span>, + Box: ({ children, className }) => <div className={className}>{children}</div>, + Checkbox: ({ + checked, + indeterminate, + onChange, + size, + className, + ...props + }) => ( + <input + type="checkbox" + checked={checked} + ref={(el) => { + if (el) el.indeterminate = indeterminate + }} + onChange={onChange} + className={className} + {...props} + /> + ), + makeStyles: () => () => ({}), +})) + +// Mock Material-UI icons +vi.mock('@material-ui/icons', () => ({ + CheckBox: () => <span>☑</span>, + CheckBoxOutlineBlank: () => <span>☐</span>, +})) + +// Mock the react-admin hook +vi.mock('react-admin', () => ({ + useGetList: vi.fn(), + useTranslate: vi.fn(() => (key) => key), // Simple translation mock +})) + +describe('<SelectLibraryInput />', () => { + const mockOnChange = vi.fn() + + beforeEach(() => { + // Reset the mock before each test + mockOnChange.mockClear() + }) + + afterEach(cleanup) + + it('should render empty message when no libraries available', () => { + // Mock empty library response + useGetList.mockReturnValue({ + ids: [], + data: {}, + }) + + render(<SelectLibraryInput onChange={mockOnChange} value={[]} />) + expect(screen.getByText('No libraries available')).not.toBeNull() + }) + + it('should render libraries when available', () => { + // Mock libraries + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + 2: { id: '2', name: 'Library 2' }, + } + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + + render(<SelectLibraryInput onChange={mockOnChange} value={[]} />) + expect(screen.getByText('Library 1')).not.toBeNull() + expect(screen.getByText('Library 2')).not.toBeNull() + }) + + it('should toggle selection when a library is clicked', () => { + // Mock libraries + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + 2: { id: '2', name: 'Library 2' }, + } + + // Test selecting an item + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + render(<SelectLibraryInput onChange={mockOnChange} value={[]} />) + + // Find the library buttons by their text content + const library1Button = screen.getByText('Library 1').closest('button') + fireEvent.click(library1Button) + expect(mockOnChange).toHaveBeenCalledWith(['1']) + + // Clean up to avoid DOM duplication + cleanup() + mockOnChange.mockClear() + + // Test deselecting an item + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + render(<SelectLibraryInput onChange={mockOnChange} value={['1']} />) + + // Find the library button again and click to deselect + const library1ButtonDeselect = screen + .getByText('Library 1') + .closest('button') + fireEvent.click(library1ButtonDeselect) + expect(mockOnChange).toHaveBeenCalledWith([]) + }) + + it('should correctly initialize with provided values', () => { + // Mock libraries + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + 2: { id: '2', name: 'Library 2' }, + } + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + + // Initial value as array of IDs + render(<SelectLibraryInput onChange={mockOnChange} value={['1']} />) + + // Check that checkbox for Library 1 is checked + const checkboxes = screen.getAllByRole('checkbox') + // With master checkbox, individual checkboxes start at index 1 + expect(checkboxes[1].checked).toBe(true) // Library 1 + expect(checkboxes[2].checked).toBe(false) // Library 2 + }) + + it('should handle value as array of objects', () => { + // Mock libraries + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + 2: { id: '2', name: 'Library 2' }, + } + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + + // Initial value as array of objects with id property + render(<SelectLibraryInput onChange={mockOnChange} value={[{ id: '2' }]} />) + + // Check that checkbox for Library 2 is checked + const checkboxes = screen.getAllByRole('checkbox') + // With master checkbox, index shifts by 1 + expect(checkboxes[1].checked).toBe(false) // Library 1 + expect(checkboxes[2].checked).toBe(true) // Library 2 + }) + + it('should render master checkbox when there are multiple libraries', () => { + // Mock libraries + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + 2: { id: '2', name: 'Library 2' }, + } + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + + render(<SelectLibraryInput onChange={mockOnChange} value={[]} />) + + // Should render master checkbox plus individual checkboxes + const checkboxes = screen.getAllByRole('checkbox') + expect(checkboxes).toHaveLength(3) // 1 master + 2 individual + expect( + screen.getByText('resources.user.message.selectAllLibraries'), + ).not.toBeNull() + }) + + it('should not render master checkbox when there is only one library', () => { + // Mock single library + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + } + useGetList.mockReturnValue({ + ids: ['1'], + data: mockLibraries, + }) + + render(<SelectLibraryInput onChange={mockOnChange} value={[]} />) + + // Should render only individual checkbox + const checkboxes = screen.getAllByRole('checkbox') + expect(checkboxes).toHaveLength(1) // Only 1 individual checkbox + }) + + it('should handle master checkbox selection and deselection', () => { + // Mock libraries + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + 2: { id: '2', name: 'Library 2' }, + } + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + + render(<SelectLibraryInput onChange={mockOnChange} value={[]} />) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] // Master is first + + // Click master checkbox to select all + fireEvent.click(masterCheckbox) + expect(mockOnChange).toHaveBeenCalledWith(['1', '2']) + + // Clean up and test deselect all + cleanup() + mockOnChange.mockClear() + + render(<SelectLibraryInput onChange={mockOnChange} value={['1', '2']} />) + const checkboxes2 = screen.getAllByRole('checkbox') + const masterCheckbox2 = checkboxes2[0] + + // Click master checkbox to deselect all + fireEvent.click(masterCheckbox2) + expect(mockOnChange).toHaveBeenCalledWith([]) + }) + + it('should show master checkbox as indeterminate when some libraries are selected', () => { + // Mock libraries + const mockLibraries = { + 1: { id: '1', name: 'Library 1' }, + 2: { id: '2', name: 'Library 2' }, + } + useGetList.mockReturnValue({ + ids: ['1', '2'], + data: mockLibraries, + }) + + render(<SelectLibraryInput onChange={mockOnChange} value={['1']} />) + + const checkboxes = screen.getAllByRole('checkbox') + const masterCheckbox = checkboxes[0] // Master is first + + // Master checkbox should not be checked when only some libraries are selected + expect(masterCheckbox.checked).toBe(false) + // Note: Testing indeterminate property directly through JSDOM can be unreliable + // The important behavior is that it's not checked when only some are selected + }) + + describe('New User Default Library Selection', () => { + // Helper function to create mock libraries with configurable default settings + const createMockLibraries = (libraryConfigs) => { + const libraries = {} + const ids = [] + + libraryConfigs.forEach(({ id, name, defaultNewUsers }) => { + libraries[id] = { + id, + name, + ...(defaultNewUsers !== undefined && { defaultNewUsers }), + } + ids.push(id) + }) + + return { libraries, ids } + } + + // Helper function to setup useGetList mock + const setupMockLibraries = (libraryConfigs, isLoading = false) => { + const { libraries, ids } = createMockLibraries(libraryConfigs) + useGetList.mockReturnValue({ + ids, + data: libraries, + isLoading, + }) + return { libraries, ids } + } + + beforeEach(() => { + mockOnChange.mockClear() + }) + + it('should pre-select default libraries for new users', () => { + setupMockLibraries([ + { id: '1', name: 'Library 1', defaultNewUsers: true }, + { id: '2', name: 'Library 2', defaultNewUsers: false }, + { id: '3', name: 'Library 3', defaultNewUsers: true }, + ]) + + render( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} + isNewUser={true} + />, + ) + + expect(mockOnChange).toHaveBeenCalledWith(['1', '3']) + }) + + it('should not pre-select default libraries if new user already has values', () => { + setupMockLibraries([ + { id: '1', name: 'Library 1', defaultNewUsers: true }, + { id: '2', name: 'Library 2', defaultNewUsers: false }, + ]) + + render( + <SelectLibraryInput + onChange={mockOnChange} + value={['2']} // Already has a value + isNewUser={true} + />, + ) + + expect(mockOnChange).not.toHaveBeenCalled() + }) + + it('should not pre-select libraries while data is still loading', () => { + setupMockLibraries( + [{ id: '1', name: 'Library 1', defaultNewUsers: true }], + true, + ) // isLoading = true + + render( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} + isNewUser={true} + />, + ) + + expect(mockOnChange).not.toHaveBeenCalled() + }) + + it('should not pre-select anything if no libraries have defaultNewUsers flag', () => { + setupMockLibraries([ + { id: '1', name: 'Library 1', defaultNewUsers: false }, + { id: '2', name: 'Library 2', defaultNewUsers: false }, + ]) + + render( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} + isNewUser={true} + />, + ) + + expect(mockOnChange).not.toHaveBeenCalled() + }) + + it('should reset initialization state when isNewUser prop changes', () => { + setupMockLibraries([ + { id: '1', name: 'Library 1', defaultNewUsers: true }, + ]) + + const { rerender } = render( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} + isNewUser={false} // Start as existing user + />, + ) + + expect(mockOnChange).not.toHaveBeenCalled() + + // Change to new user + rerender( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} + isNewUser={true} + />, + ) + + expect(mockOnChange).toHaveBeenCalledWith(['1']) + }) + + it('should not override pre-selection when value prop is empty for new users', () => { + setupMockLibraries([ + { id: '1', name: 'Library 1', defaultNewUsers: true }, + { id: '2', name: 'Library 2', defaultNewUsers: false }, + ]) + + const { rerender } = render( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} + isNewUser={true} + />, + ) + + expect(mockOnChange).toHaveBeenCalledWith(['1']) + mockOnChange.mockClear() + + // Re-render with empty value prop (simulating form state update) + rerender( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} // Still empty + isNewUser={true} + />, + ) + + expect(mockOnChange).not.toHaveBeenCalled() + }) + + it('should sync from value prop for existing users even when empty', () => { + setupMockLibraries([ + { id: '1', name: 'Library 1', defaultNewUsers: true }, + ]) + + render( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} // Empty value for existing user + isNewUser={false} + />, + ) + + // Check that no libraries are selected (checkboxes should be unchecked) + const checkboxes = screen.getAllByRole('checkbox') + // Only one checkbox since there's only one library and no master checkbox for single library + expect(checkboxes[0].checked).toBe(false) + }) + + it('should handle libraries with missing defaultNewUsers property', () => { + setupMockLibraries([ + { id: '1', name: 'Library 1', defaultNewUsers: true }, + { id: '2', name: 'Library 2' }, // Missing defaultNewUsers property + { id: '3', name: 'Library 3', defaultNewUsers: false }, + ]) + + render( + <SelectLibraryInput + onChange={mockOnChange} + value={[]} + isNewUser={true} + />, + ) + + expect(mockOnChange).toHaveBeenCalledWith(['1']) + }) + }) +}) diff --git a/ui/src/common/SongContextMenu.jsx b/ui/src/common/SongContextMenu.jsx index f2227dc72..ac5b10e13 100644 --- a/ui/src/common/SongContextMenu.jsx +++ b/ui/src/common/SongContextMenu.jsx @@ -1,7 +1,12 @@ import React, { useState } from 'react' import PropTypes from 'prop-types' import { useDispatch } from 'react-redux' -import { useNotify, usePermissions, useTranslate } from 'react-admin' +import { + useNotify, + usePermissions, + useTranslate, + useDataProvider, +} from 'react-admin' import { IconButton, Menu, MenuItem } from '@material-ui/core' import { makeStyles } from '@material-ui/core/styles' import MoreVertIcon from '@material-ui/icons/MoreVert' @@ -19,8 +24,9 @@ import { } from '../actions' import { LoveButton } from './LoveButton' import config from '../config' +import { playSimilar } from './playbackActions.js' import { formatBytes } from '../utils' -import { httpClient } from '../dataProvider' +import { useRedirect } from 'react-admin' const useStyles = makeStyles({ noWrap: { @@ -57,8 +63,13 @@ export const SongContextMenu = ({ const dispatch = useDispatch() const translate = useTranslate() const notify = useNotify() + const dataProvider = useDataProvider() const [anchorEl, setAnchorEl] = useState(null) + const [playlistAnchorEl, setPlaylistAnchorEl] = useState(null) + const [playlists, setPlaylists] = useState([]) + const [playlistsLoaded, setPlaylistsLoaded] = useState(false) const { permissions } = usePermissions() + const redirect = useRedirect() const options = { playNow: { @@ -76,6 +87,24 @@ export const SongContextMenu = ({ label: translate('resources.song.actions.addToQueue'), action: (record) => dispatch(addTracks({ [record.id]: record })), }, + instantMix: { + enabled: config.enableExternalServices, + label: translate('resources.song.actions.instantMix'), + action: async (record) => { + notify('message.startingInstantMix', { type: 'info' }) + try { + const id = record.mediaFileId || record.id + await playSimilar(dispatch, notify, id, { + seedRecord: record, + shuffle: false, + }) + } catch (e) { + // eslint-disable-next-line no-console + console.error('Error starting instant mix:', e) + notify('ra.page.error', { type: 'warning' }) + } + }, + }, addToPlaylist: { enabled: true, label: translate('resources.song.actions.addToPlaylist'), @@ -87,6 +116,15 @@ export const SongContextMenu = ({ }), ), }, + showInPlaylist: { + enabled: true, + label: + translate('resources.song.actions.showInPlaylist') + + (playlists.length > 0 ? ' ►' : ''), + action: (record, e) => { + setPlaylistAnchorEl(e.currentTarget) + }, + }, share: { enabled: config.enableSharing, label: translate('ra.action.share'), @@ -113,8 +151,8 @@ export const SongContextMenu = ({ if (permissions === 'admin' && !record.missing) { try { let id = record.mediaFileId ?? record.id - const data = await httpClient(`/api/inspect?id=${id}`) - fullRecord = { ...record, rawTags: data.json.rawTags } + const data = await dataProvider.inspect(id) + fullRecord = { ...record, rawTags: data.data.rawTags } } catch (error) { notify( translate('ra.notification.http_error') + ': ' + error.message, @@ -134,6 +172,21 @@ export const SongContextMenu = ({ const handleClick = (e) => { setAnchorEl(e.currentTarget) + if (!playlistsLoaded) { + const id = record.mediaFileId || record.id + dataProvider + .getPlaylists(id) + .then((res) => { + setPlaylists(res.data) + setPlaylistsLoaded(true) + }) + .catch((error) => { + // eslint-disable-next-line no-console + console.error('Failed to fetch playlists:', error) + setPlaylists([]) + setPlaylistsLoaded(true) + }) + } e.stopPropagation() } @@ -144,12 +197,39 @@ export const SongContextMenu = ({ const handleItemClick = (e) => { e.preventDefault() - setAnchorEl(null) const key = e.target.getAttribute('value') - options[key].action(record) + const action = options[key].action + + if (key === 'showInPlaylist') { + // For showInPlaylist, we keep the main menu open and show submenu + action(record, e) + } else { + // For other actions, close the main menu + setAnchorEl(null) + action(record) + } e.stopPropagation() } + const handlePlaylistClose = (e) => { + setPlaylistAnchorEl(null) + if (e) { + e.stopPropagation() + } + } + + const handleMainMenuClose = (e) => { + setAnchorEl(null) + setPlaylistAnchorEl(null) // Close both menus + e.stopPropagation() + } + + const handlePlaylistClick = (id, e) => { + e.stopPropagation() + redirect(`/playlist/${id}/show`) + handlePlaylistClose() + } + const open = Boolean(anchorEl) if (!record) { @@ -170,16 +250,50 @@ export const SongContextMenu = ({ id={'menu' + record.id} anchorEl={anchorEl} open={open} - onClose={handleClose} + onClose={handleMainMenuClose} > - {Object.keys(options).map( - (key) => + {Object.keys(options).map((key) => { + const showInPlaylistDisabled = + key === 'showInPlaylist' && !playlists.length + return ( options[key].enabled && ( - <MenuItem value={key} key={key} onClick={handleItemClick}> + <MenuItem + value={key} + key={key} + onClick={ + showInPlaylistDisabled + ? (e) => e.stopPropagation() + : handleItemClick + } + disabled={showInPlaylistDisabled} + style={ + showInPlaylistDisabled ? { pointerEvents: 'auto' } : undefined + } + > {options[key].label} </MenuItem> - ), - )} + ) + ) + })} + </Menu> + <Menu + anchorEl={playlistAnchorEl} + open={Boolean(playlistAnchorEl)} + onClose={handlePlaylistClose} + anchorOrigin={{ + vertical: 'top', + horizontal: 'right', + }} + transformOrigin={{ + vertical: 'top', + horizontal: 'left', + }} + > + {playlists.map((p) => ( + <MenuItem key={p.id} onClick={(e) => handlePlaylistClick(p.id, e)}> + {p.name} + </MenuItem> + ))} </Menu> </span> ) diff --git a/ui/src/common/SongContextMenu.test.jsx b/ui/src/common/SongContextMenu.test.jsx new file mode 100644 index 000000000..7172742d3 --- /dev/null +++ b/ui/src/common/SongContextMenu.test.jsx @@ -0,0 +1,227 @@ +import React from 'react' +import { render, fireEvent, screen, waitFor } from '@testing-library/react' +import { TestContext } from 'ra-test' +import { describe, it, expect, vi, beforeEach } from 'vitest' +import { SongContextMenu } from './SongContextMenu' +import subsonic from '../subsonic' + +vi.mock('../dataProvider', () => ({ + httpClient: vi.fn(), +})) + +vi.mock('../subsonic', () => ({ + default: { getSimilarSongs2: vi.fn() }, +})) + +vi.mock('../config', () => ({ + default: { + enableDownloads: true, + enableFavourites: true, + enableSharing: true, + enableExternalServices: true, + }, +})) + +const mockDispatch = vi.fn() +vi.mock('react-redux', () => ({ useDispatch: () => mockDispatch })) + +const getPlaylistsMock = vi.fn() +const mockNotify = vi.fn() + +vi.mock('react-admin', async (importOriginal) => { + const actual = await importOriginal() + return { + ...actual, + useNotify: () => mockNotify, + useRedirect: () => (url) => { + window.location.hash = `#${url}` + }, + useDataProvider: () => ({ + getPlaylists: getPlaylistsMock, + inspect: vi.fn().mockResolvedValue({ + data: { rawTags: {} }, + }), + }), + } +}) + +describe('SongContextMenu', () => { + beforeEach(() => { + vi.clearAllMocks() + window.location.hash = '' + getPlaylistsMock.mockResolvedValue({ + data: [{ id: 'pl1', name: 'Pl 1' }], + }) + subsonic.getSimilarSongs2.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + similarSongs2: { song: [{ id: 's1' }] }, + }, + }, + }) + }) + + it('navigates to playlist when selected', async () => { + render( + <TestContext> + <SongContextMenu record={{ id: 'song1', size: 1 }} resource="song" /> + </TestContext>, + ) + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.showInPlaylist/), + ) + fireEvent.click( + screen.getByText(/resources\.song\.actions\.showInPlaylist/), + ) + await waitFor(() => screen.getByText('Pl 1')) + fireEvent.click(screen.getByText('Pl 1')) + expect(window.location.hash).toBe('#/playlist/pl1/show') + }) + + it('stops event propagation when playlist submenu is closed', async () => { + const mockOnClick = vi.fn() + render( + <TestContext> + <div onClick={mockOnClick}> + <SongContextMenu record={{ id: 'song1', size: 1 }} resource="song" /> + </div> + </TestContext>, + ) + + // Open main menu + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.showInPlaylist/), + ) + + // Open playlist submenu + fireEvent.click( + screen.getByText(/resources\.song\.actions\.showInPlaylist/), + ) + await waitFor(() => screen.getByText('Pl 1')) + + // Click outside the playlist submenu (should close it without triggering parent click) + fireEvent.click(document.body) + + expect(mockOnClick).not.toHaveBeenCalled() + }) + + it('does nothing when "Show in Playlist" is disabled', async () => { + getPlaylistsMock.mockResolvedValue({ data: [] }) + const mockOnClick = vi.fn() + render( + <TestContext> + <div onClick={mockOnClick}> + <SongContextMenu record={{ id: 'song1', size: 1 }} resource="song" /> + </div> + </TestContext>, + ) + + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.showInPlaylist/), + ) + + fireEvent.click( + screen.getByText(/resources\.song\.actions\.showInPlaylist/), + ) + expect(mockOnClick).not.toHaveBeenCalled() + }) + + describe('Instant Mix action', () => { + it('calls getSimilarSongs2 with song id and shows loading notification', async () => { + render( + <TestContext> + <SongContextMenu record={{ id: 'song1', size: 1 }} resource="song" /> + </TestContext>, + ) + + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.instantMix/), + ) + fireEvent.click(screen.getByText(/resources\.song\.actions\.instantMix/)) + + // Verify loading notification is shown + expect(mockNotify).toHaveBeenCalledWith('message.startingInstantMix', { + type: 'info', + }) + + await waitFor(() => + expect(subsonic.getSimilarSongs2).toHaveBeenCalledWith('song1', 100), + ) + expect(mockDispatch).toHaveBeenCalled() + }) + + it('plays seed song first followed by similar songs', async () => { + const seedRecord = { id: 'song1', title: 'Seed Song', size: 1 } + render( + <TestContext> + <SongContextMenu record={seedRecord} resource="song" /> + </TestContext>, + ) + + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.instantMix/), + ) + fireEvent.click(screen.getByText(/resources\.song\.actions\.instantMix/)) + + await waitFor(() => expect(mockDispatch).toHaveBeenCalled()) + + // Verify dispatch was called with playTracks action + const dispatchCall = mockDispatch.mock.calls.find( + (call) => call[0]?.type === 'PLAYER_PLAY_TRACKS', + ) + expect(dispatchCall).toBeDefined() + + // Verify seed song is first (id property contains the first song to play) + const { id, data } = dispatchCall[0] + expect(id).toBe('song1') + // Verify seed song data is included + expect(data['song1']).toBeDefined() + }) + + it('uses mediaFileId when available (playlist context)', async () => { + render( + <TestContext> + <SongContextMenu + record={{ + id: 'playlistTrackId', + mediaFileId: 'actualSongId', + size: 1, + }} + resource="song" + /> + </TestContext>, + ) + + fireEvent.click(screen.getAllByRole('button')[1]) + await waitFor(() => + screen.getByText(/resources\.song\.actions\.instantMix/), + ) + fireEvent.click(screen.getByText(/resources\.song\.actions\.instantMix/)) + + await waitFor(() => + expect(subsonic.getSimilarSongs2).toHaveBeenCalledWith( + 'actualSongId', + 100, + ), + ) + + await waitFor(() => expect(mockDispatch).toHaveBeenCalled()) + + // Verify the mediaFileId is used as the seed song id + const dispatchCall = mockDispatch.mock.calls.find( + (call) => call[0]?.type === 'PLAYER_PLAY_TRACKS', + ) + expect(dispatchCall).toBeDefined() + const { id, data } = dispatchCall[0] + expect(id).toBe('actualSongId') + // Verify seed song data is included + expect(data['actualSongId']).toBeDefined() + }) + }) +}) diff --git a/ui/src/common/SongDatagrid.jsx b/ui/src/common/SongDatagrid.jsx index 3586cf225..d2c98bbe7 100644 --- a/ui/src/common/SongDatagrid.jsx +++ b/ui/src/common/SongDatagrid.jsx @@ -1,4 +1,10 @@ -import React, { isValidElement, useMemo, useCallback, forwardRef } from 'react' +import React, { + isValidElement, + useMemo, + useCallback, + useState, + forwardRef, +} from 'react' import { useDispatch } from 'react-redux' import { Datagrid, @@ -17,7 +23,10 @@ import { makeStyles } from '@material-ui/core/styles' import AlbumIcon from '@material-ui/icons/Album' import clsx from 'clsx' import { useDrag } from 'react-dnd' +import Lightbox from 'react-image-lightbox' +import 'react-image-lightbox/style.css' import { playTracks } from '../actions' +import subsonic from '../subsonic' import { AlbumContextMenu } from '../common' import { DraggableTypes } from '../consts' import { formatFullDate } from '../utils' @@ -28,10 +37,20 @@ const useStyles = makeStyles({ overflow: 'hidden', textOverflow: 'ellipsis', verticalAlign: 'middle', + display: 'flex', + alignItems: 'center', }, discIcon: { - verticalAlign: 'text-top', - marginRight: '4px', + marginRight: '14px', + }, + discCoverArt: { + width: '48px', + height: '48px', + marginRight: '14px', + objectFit: 'cover', + borderRadius: '4px', + flexShrink: 0, + cursor: 'pointer', }, row: { cursor: 'pointer', @@ -61,19 +80,55 @@ const useStyles = makeStyles({ const DiscSubtitleRow = forwardRef( ({ record, onClick, colSpan, contextAlwaysVisible }, ref) => { + const translate = useTranslate() const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('md')) const classes = useStyles({ isDesktop }) + const [imageError, setImageError] = useState(false) + const [isLightboxOpen, setLightboxOpen] = useState(false) + const lightboxClosedAt = React.useRef(0) const handlePlaySubset = (discNumber) => () => { + // Ignore clicks shortly after the lightbox was closed to prevent + // mobile touch events from "falling through" the overlay and + // triggering playback. + if (Date.now() - lightboxClosedAt.current < 400) { + return + } onClick(discNumber) } - let subtitle = [] - if (record.discNumber > 0) { - subtitle.push(record.discNumber) - } - if (record.discSubtitle) { - subtitle.push(record.discSubtitle) - } + const coverArtUrl = subsonic.getDiscCoverArtUrl( + record.albumId, + record.discNumber, + record.updatedAt, + 96, + ) + + const fullImageUrl = subsonic.getDiscCoverArtUrl( + record.albumId, + record.discNumber, + record.updatedAt, + ) + + const handleOpenLightbox = useCallback( + (e) => { + if (!imageError) { + e.stopPropagation() + setLightboxOpen(true) + } + }, + [imageError], + ) + + const handleCloseLightbox = useCallback(() => { + lightboxClosedAt.current = Date.now() + setLightboxOpen(false) + }, []) + + const subtitle = record.discSubtitle + ? record.discSubtitle + : translate('resources.song.fields.disc', { + discNumber: record.discNumber, + }) return ( <TableRow @@ -84,9 +139,28 @@ const DiscSubtitleRow = forwardRef( > <TableCell colSpan={colSpan}> <Typography variant="h6" className={classes.subtitle}> - <AlbumIcon className={classes.discIcon} fontSize={'small'} /> - {subtitle.join(': ')} + {!imageError ? ( + <img + src={coverArtUrl} + className={classes.discCoverArt} + alt="" + onClick={handleOpenLightbox} + onError={() => setImageError(true)} + /> + ) : ( + <AlbumIcon className={classes.discIcon} fontSize={'small'} /> + )} + {subtitle} </Typography> + {isLightboxOpen && !imageError && ( + <Lightbox + imagePadding={50} + animationDuration={200} + imageTitle={record.album + ' - ' + subtitle} + mainSrc={fullImageUrl} + onCloseRequest={handleCloseLightbox} + /> + )} </TableCell> <TableCell> <AlbumContextMenu diff --git a/ui/src/common/SongInfo.jsx b/ui/src/common/SongInfo.jsx index 77e91b653..1b1a014f1 100644 --- a/ui/src/common/SongInfo.jsx +++ b/ui/src/common/SongInfo.jsx @@ -59,6 +59,7 @@ export const SongInfo = (props) => { ] const data = { path: <PathField />, + libraryName: <TextField source="libraryName" />, album: ( <AlbumLinkField source="album" sortByOrder={'ASC'} record={record} /> ), @@ -138,7 +139,7 @@ export const SongInfo = (props) => { </Tabs> )} <div - hidden={tab == 1} + hidden={tab === 1} id="mapped-tags-body" aria-labelledby={record.rawTags ? 'mapped-tags-tab' : undefined} > diff --git a/ui/src/common/index.js b/ui/src/common/index.js index 1a43047c1..362a0ced3 100644 --- a/ui/src/common/index.js +++ b/ui/src/common/index.js @@ -27,6 +27,7 @@ export * from './useAlbumsPerPage' export * from './useGetHandleArtistClick' export * from './useInterval' export * from './useResourceRefresh' +export * from './useRefreshOnEvents' export * from './useToggleLove' export * from './useTraceUpdate' export * from './Writable' @@ -40,3 +41,9 @@ export * from './formatRange.js' export * from './playlistUtils.js' export * from './PathField.jsx' export * from './ParticipantsInfo' +export * from './OverflowTooltip' +export * from './useSearchRefocus' +export * from './ImageUploadOverlay' +export * from './CoverArtAvatar' +export * from './useImageLoadingState' +export * from './useImageUrl' diff --git a/ui/src/common/playbackActions.js b/ui/src/common/playbackActions.js new file mode 100644 index 000000000..414dbe413 --- /dev/null +++ b/ui/src/common/playbackActions.js @@ -0,0 +1,76 @@ +import subsonic from '../subsonic/index.js' +import { playTracks } from '../actions/index.js' + +const shuffleArray = (array) => { + const shuffled = [...array] + for (let i = shuffled.length - 1; i > 0; i--) { + const j = Math.floor(Math.random() * (i + 1)) + ;[shuffled[i], shuffled[j]] = [shuffled[j], shuffled[i]] + } + return shuffled +} + +const mapReplayGain = (song) => { + const { replayGain: rg } = song + if (!rg) { + return song + } + + return { + ...song, + ...(rg.albumGain !== undefined && { rgAlbumGain: rg.albumGain }), + ...(rg.albumPeak !== undefined && { rgAlbumPeak: rg.albumPeak }), + ...(rg.trackGain !== undefined && { rgTrackGain: rg.trackGain }), + ...(rg.trackPeak !== undefined && { rgTrackPeak: rg.trackPeak }), + } +} + +export const processSongsForPlayback = (songs) => { + const songData = {} + const ids = [] + songs.forEach((s) => { + const song = mapReplayGain(s) + songData[song.id] = song + ids.push(song.id) + }) + return { songData, ids } +} + +export const playSimilar = async (dispatch, notify, id, options = {}) => { + const { seedRecord = null, shuffle = false } = options + + const res = await subsonic.getSimilarSongs2(id, 100) + const data = res.json['subsonic-response'] + + if (data.status !== 'ok') { + throw new Error( + `Error fetching similar songs: ${data.error?.message || 'Unknown error'} (Code: ${data.error?.code || 'unknown'})`, + ) + } + + let songs = data.similarSongs2?.song || [] + + // Randomize similar songs if requested + if (shuffle) { + songs = shuffleArray(songs) + } + + // If no similar songs found and no seed, show warning + if (!songs.length && !seedRecord) { + notify('message.noSimilarSongsFound', 'warning') + return + } + + const { songData, ids } = processSongsForPlayback(songs) + + // Prepend seed song if provided + if (seedRecord) { + const seedId = seedRecord.mediaFileId || seedRecord.id + // Remove seed from similar songs if it appears there + const filteredIds = ids.filter((songId) => songId !== seedId) + songData[seedId] = mapReplayGain(seedRecord) + dispatch(playTracks(songData, [seedId, ...filteredIds])) + } else { + dispatch(playTracks(songData, ids)) + } +} diff --git a/ui/src/common/useImageLoadingState.js b/ui/src/common/useImageLoadingState.js new file mode 100644 index 000000000..3528b0f3f --- /dev/null +++ b/ui/src/common/useImageLoadingState.js @@ -0,0 +1,44 @@ +import { useState, useEffect, useCallback } from 'react' + +/** + * Manages image loading/error state and lightbox open/close. + * Resets when recordId changes. + */ +export const useImageLoadingState = (recordId) => { + const [imageLoading, setImageLoading] = useState(true) + const [imageError, setImageError] = useState(false) + const [isLightboxOpen, setLightboxOpen] = useState(false) + + useEffect(() => { + setImageLoading(true) + setImageError(false) + }, [recordId]) + + const handleImageLoad = useCallback(() => { + setImageLoading(false) + setImageError(false) + }, []) + + const handleImageError = useCallback(() => { + setImageLoading(false) + setImageError(true) + }, []) + + const handleOpenLightbox = useCallback(() => { + if (!imageError) { + setLightboxOpen(true) + } + }, [imageError]) + + const handleCloseLightbox = useCallback(() => setLightboxOpen(false), []) + + return { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } +} diff --git a/ui/src/common/useImageUrl.js b/ui/src/common/useImageUrl.js new file mode 100644 index 000000000..9bcc70d74 --- /dev/null +++ b/ui/src/common/useImageUrl.js @@ -0,0 +1,144 @@ +import { useEffect, useState, useRef } from 'react' + +// Persists across component mount/unmount cycles so that +// React Admin refreshes (which remount list items) don't re-fetch images. +const cache = new Map() +const MAX_CACHE_SIZE = 300 + +// Limit concurrent fetches to leave browser connections free for API requests. +// Browsers allow ~6 connections per origin on HTTP/1.1; reserving 2 for API +// calls prevents image fetches from blocking pagination/data requests. +const MAX_CONCURRENT = 4 +let activeFetches = 0 +const pendingQueue = [] + +const processQueue = () => { + while (pendingQueue.length > 0 && activeFetches < MAX_CONCURRENT) { + const next = pendingQueue.shift() + next() + } +} + +// Evicts oldest unused entries (Map iterates in insertion order). +const evictIfNeeded = () => { + if (cache.size <= MAX_CACHE_SIZE) return + for (const [key, entry] of cache) { + if (cache.size <= MAX_CACHE_SIZE) break + if (entry.refCount === 0) { + if (entry.blobUrl) URL.revokeObjectURL(entry.blobUrl) + cache.delete(key) + } + } +} + +/** + * Loads an image via fetch() with AbortController so that in-flight requests + * are canceled on unmount (e.g., during pagination). Uses a module-level cache + * so remounting returns the cached blob URL instantly. + */ +export const useImageUrl = (url) => { + const cached = url ? cache.get(url) : null + const [imgUrl, setImgUrl] = useState(cached?.blobUrl || null) + const [loading, setLoading] = useState(!!url && !cached) + const [error, setError] = useState(cached?.error || false) + const abortedRef = useRef(false) + + useEffect(() => { + abortedRef.current = false + + if (!url) { + setImgUrl(null) + setLoading(false) + setError(false) + return + } + + // Re-check: another component's effect may have populated the cache + // between this component's render and effect execution. + const entry = cache.get(url) + if (entry) { + entry.refCount++ + setImgUrl(entry.blobUrl) + setLoading(false) + setError(entry.error || false) + return () => { + entry.refCount-- + } + } + + const controller = new AbortController() + let queued = true + setImgUrl(null) + setLoading(true) + setError(false) + + const doFetch = () => { + queued = false + activeFetches++ + fetch(url, { signal: controller.signal }) + .then((res) => { + if (!res.ok) { + throw new Error(`HTTP ${res.status}`) + } + return res.blob() + }) + .then((blob) => { + activeFetches-- + processQueue() + // Guard against late resolution after abort + if (abortedRef.current) { + return + } + const objectUrl = URL.createObjectURL(blob) + // Handle concurrent fetches: if another component already cached + // this URL, use its entry and discard our blob. + const existing = cache.get(url) + if (existing && existing.blobUrl) { + existing.refCount++ + URL.revokeObjectURL(objectUrl) + setImgUrl(existing.blobUrl) + } else { + cache.set(url, { blobUrl: objectUrl, refCount: 1 }) + evictIfNeeded() + setImgUrl(objectUrl) + } + setLoading(false) + }) + .catch((err) => { + activeFetches-- + processQueue() + if (err.name === 'AbortError') { + return // Expected on unmount or URL change + } + // Cache the error so repeated mounts don't re-fetch broken URLs + cache.set(url, { blobUrl: null, error: true, refCount: 0 }) + setError(true) + setLoading(false) + }) + } + + if (activeFetches < MAX_CONCURRENT) { + queued = false + doFetch() + } else { + pendingQueue.push(doFetch) + } + + return () => { + abortedRef.current = true + if (queued) { + // Remove from queue if not yet started + const idx = pendingQueue.indexOf(doFetch) + if (idx !== -1) pendingQueue.splice(idx, 1) + } else { + controller.abort() + } + const entry = cache.get(url) + if (entry) { + entry.refCount-- + } + } + }, [url]) + + return { imgUrl, loading, error } +} diff --git a/ui/src/common/useImageUrl.test.js b/ui/src/common/useImageUrl.test.js new file mode 100644 index 000000000..976317105 --- /dev/null +++ b/ui/src/common/useImageUrl.test.js @@ -0,0 +1,234 @@ +import { renderHook, act } from '@testing-library/react-hooks' +import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest' + +// Helper to flush all pending promises +const flushPromises = () => new Promise((resolve) => setTimeout(resolve, 0)) + +// We need a fresh module for each test to reset the module-level cache +let useImageUrl + +describe('useImageUrl', () => { + let abortSpy + let OriginalAbortController + let originalCreateObjectURL + let originalRevokeObjectURL + let originalFetch + + beforeEach(async () => { + // Reset module to clear the cache + vi.resetModules() + const mod = await import('./useImageUrl') + useImageUrl = mod.useImageUrl + + abortSpy = vi.fn() + OriginalAbortController = global.AbortController + originalCreateObjectURL = global.URL.createObjectURL + originalRevokeObjectURL = global.URL.revokeObjectURL + originalFetch = global.fetch + + global.AbortController = function () { + this.signal = 'mock-signal' + this.abort = abortSpy + } + global.URL.createObjectURL = vi.fn(() => 'blob:mock-url') + global.URL.revokeObjectURL = vi.fn() + }) + + afterEach(() => { + global.AbortController = OriginalAbortController + global.URL.createObjectURL = originalCreateObjectURL + global.URL.revokeObjectURL = originalRevokeObjectURL + global.fetch = originalFetch + vi.restoreAllMocks() + }) + + it('should return null values when url is null', () => { + const { result } = renderHook(() => useImageUrl(null)) + + expect(result.current.loading).toBe(false) + expect(result.current.imgUrl).toBeNull() + expect(result.current.error).toBe(false) + }) + + it('should return loading state initially', () => { + global.fetch = vi.fn(() => new Promise(() => {})) + const { result } = renderHook(() => + useImageUrl('http://example.com/img.jpg'), + ) + + expect(result.current.loading).toBe(true) + expect(result.current.imgUrl).toBeNull() + expect(result.current.error).toBe(false) + }) + + it('should fetch image and return blob URL on success', async () => { + const mockBlob = new Blob(['image-data'], { type: 'image/png' }) + global.fetch = vi.fn(() => + Promise.resolve({ + ok: true, + blob: () => Promise.resolve(mockBlob), + }), + ) + + const { result } = renderHook(() => + useImageUrl('http://example.com/img.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + expect(result.current.loading).toBe(false) + expect(result.current.imgUrl).toBe('blob:mock-url') + expect(result.current.error).toBe(false) + expect(global.fetch).toHaveBeenCalledWith('http://example.com/img.jpg', { + signal: 'mock-signal', + }) + }) + + it('should set error on HTTP failure', async () => { + global.fetch = vi.fn(() => Promise.resolve({ ok: false, status: 404 })) + + const { result } = renderHook(() => + useImageUrl('http://example.com/missing.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + expect(result.current.loading).toBe(false) + expect(result.current.imgUrl).toBeNull() + expect(result.current.error).toBe(true) + }) + + it('should abort fetch on unmount', async () => { + global.fetch = vi.fn(() => new Promise(() => {})) + + const { unmount } = renderHook(() => + useImageUrl('http://example.com/img.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + unmount() + + expect(abortSpy).toHaveBeenCalled() + }) + + it('should abort previous fetch when URL changes', async () => { + const abortSpies = [] + global.AbortController = function () { + const spy = vi.fn() + abortSpies.push(spy) + this.signal = `signal-${abortSpies.length}` + this.abort = spy + } + + const mockBlob = new Blob(['data'], { type: 'image/png' }) + global.fetch = vi.fn(() => + Promise.resolve({ + ok: true, + blob: () => Promise.resolve(mockBlob), + }), + ) + + const { rerender } = renderHook(({ url }) => useImageUrl(url), { + initialProps: { url: 'http://example.com/img1.jpg' }, + }) + + await act(async () => { + await flushPromises() + }) + + // Change URL - should abort the first controller + rerender({ url: 'http://example.com/img2.jpg' }) + + expect(abortSpies[0]).toHaveBeenCalled() + }) + + it('should not set error on AbortError', async () => { + const abortError = new DOMException('Aborted', 'AbortError') + global.fetch = vi.fn(() => Promise.reject(abortError)) + + const { result } = renderHook(() => + useImageUrl('http://example.com/img.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + expect(result.current.error).toBe(false) + }) + + it('should use cached blob URL on remount without re-fetching', async () => { + const mockBlob = new Blob(['data'], { type: 'image/png' }) + global.fetch = vi.fn(() => + Promise.resolve({ + ok: true, + blob: () => Promise.resolve(mockBlob), + }), + ) + + // First mount — fetches and caches + const { unmount } = renderHook(() => + useImageUrl('http://example.com/img.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + expect(global.fetch).toHaveBeenCalledTimes(1) + + // Unmount (simulates React Admin refresh) + unmount() + + // Remount with same URL — should use cache + const { result: result2 } = renderHook(() => + useImageUrl('http://example.com/img.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + // Should NOT have fetched again + expect(global.fetch).toHaveBeenCalledTimes(1) + expect(result2.current.imgUrl).toBe('blob:mock-url') + expect(result2.current.loading).toBe(false) + }) + + it('should cache errors and not re-fetch broken URLs', async () => { + global.fetch = vi.fn(() => Promise.resolve({ ok: false, status: 404 })) + + // First mount — fetch fails and error is cached + const { unmount } = renderHook(() => + useImageUrl('http://example.com/broken.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + expect(global.fetch).toHaveBeenCalledTimes(1) + unmount() + + // Remount with same URL — should use cached error, not re-fetch + const { result: result2 } = renderHook(() => + useImageUrl('http://example.com/broken.jpg'), + ) + + await act(async () => { + await flushPromises() + }) + + expect(global.fetch).toHaveBeenCalledTimes(1) + expect(result2.current.error).toBe(true) + expect(result2.current.imgUrl).toBeNull() + expect(result2.current.loading).toBe(false) + }) +}) diff --git a/ui/src/common/useLibrarySelection.js b/ui/src/common/useLibrarySelection.js new file mode 100644 index 000000000..c5d84a61f --- /dev/null +++ b/ui/src/common/useLibrarySelection.js @@ -0,0 +1,44 @@ +import { useSelector } from 'react-redux' + +/** + * Hook to get the currently selected library IDs + * Returns an array of library IDs that should be used for filtering data + * If no libraries are selected (empty array), returns all user accessible libraries + */ +export const useSelectedLibraries = () => { + const { userLibraries, selectedLibraries } = useSelector( + (state) => state.library, + ) + + // If no specific selection, default to all accessible libraries + if (selectedLibraries.length === 0 && userLibraries.length > 0) { + return userLibraries.map((lib) => lib.id) + } + + return selectedLibraries +} + +/** + * Hook to get library filter parameters for data provider queries + * Returns an object that can be spread into query parameters + */ +export const useLibraryFilter = () => { + const selectedLibraryIds = useSelectedLibraries() + + // If user has access to only one library or no specific selection, no filter needed + if (selectedLibraryIds.length <= 1) { + return {} + } + + return { + libraryIds: selectedLibraryIds, + } +} + +/** + * Hook to check if a specific library is currently selected + */ +export const useIsLibrarySelected = (libraryId) => { + const selectedLibraryIds = useSelectedLibraries() + return selectedLibraryIds.includes(libraryId) +} diff --git a/ui/src/common/useLibrarySelection.test.js b/ui/src/common/useLibrarySelection.test.js new file mode 100644 index 000000000..30f109dc6 --- /dev/null +++ b/ui/src/common/useLibrarySelection.test.js @@ -0,0 +1,204 @@ +import { renderHook } from '@testing-library/react-hooks' +import { describe, it, expect, beforeEach, vi } from 'vitest' +import { + useSelectedLibraries, + useLibraryFilter, + useIsLibrarySelected, +} from './useLibrarySelection' + +// Mock dependencies +vi.mock('react-redux', () => ({ + useSelector: vi.fn(), +})) + +describe('Library Selection Hooks', () => { + const mockLibraries = [ + { id: '1', name: 'Music Library' }, + { id: '2', name: 'Podcasts' }, + { id: '3', name: 'Audiobooks' }, + ] + + let mockUseSelector + + beforeEach(async () => { + vi.clearAllMocks() + const { useSelector } = await import('react-redux') + mockUseSelector = vi.mocked(useSelector) + }) + + const setupSelector = ( + userLibraries = mockLibraries, + selectedLibraries = [], + ) => { + mockUseSelector.mockImplementation((selector) => + selector({ + library: { + userLibraries, + selectedLibraries, + }, + }), + ) + } + + describe('useSelectedLibraries', () => { + it('should return selected library IDs when libraries are explicitly selected', async () => { + setupSelector(mockLibraries, ['1', '2']) + + const { result } = renderHook(() => useSelectedLibraries()) + + expect(result.current).toEqual(['1', '2']) + }) + + it('should return all user library IDs when no libraries are selected and user has libraries', async () => { + setupSelector(mockLibraries, []) + + const { result } = renderHook(() => useSelectedLibraries()) + + expect(result.current).toEqual(['1', '2', '3']) + }) + + it('should return empty array when no libraries are selected and user has no libraries', async () => { + setupSelector([], []) + + const { result } = renderHook(() => useSelectedLibraries()) + + expect(result.current).toEqual([]) + }) + + it('should return selected libraries even if they are all user libraries', async () => { + setupSelector(mockLibraries, ['1', '2', '3']) + + const { result } = renderHook(() => useSelectedLibraries()) + + expect(result.current).toEqual(['1', '2', '3']) + }) + + it('should return single selected library', async () => { + setupSelector(mockLibraries, ['2']) + + const { result } = renderHook(() => useSelectedLibraries()) + + expect(result.current).toEqual(['2']) + }) + }) + + describe('useLibraryFilter', () => { + it('should return empty object when user has only one library', async () => { + setupSelector([mockLibraries[0]], ['1']) + + const { result } = renderHook(() => useLibraryFilter()) + + expect(result.current).toEqual({}) + }) + + it('should return empty object when no libraries are selected (defaults to all)', async () => { + setupSelector([mockLibraries[0]], []) + + const { result } = renderHook(() => useLibraryFilter()) + + expect(result.current).toEqual({}) + }) + + it('should return libraryIds filter when multiple libraries are available and some are selected', async () => { + setupSelector(mockLibraries, ['1', '2']) + + const { result } = renderHook(() => useLibraryFilter()) + + expect(result.current).toEqual({ + libraryIds: ['1', '2'], + }) + }) + + it('should return libraryIds filter when multiple libraries are available and all are selected', async () => { + setupSelector(mockLibraries, ['1', '2', '3']) + + const { result } = renderHook(() => useLibraryFilter()) + + expect(result.current).toEqual({ + libraryIds: ['1', '2', '3'], + }) + }) + + it('should return empty object when user has no libraries', async () => { + setupSelector([], []) + + const { result } = renderHook(() => useLibraryFilter()) + + expect(result.current).toEqual({}) + }) + + it('should return libraryIds filter for default selection when multiple libraries available', async () => { + setupSelector(mockLibraries, []) // No explicit selection, should default to all + + const { result } = renderHook(() => useLibraryFilter()) + + expect(result.current).toEqual({ + libraryIds: ['1', '2', '3'], + }) + }) + }) + + describe('useIsLibrarySelected', () => { + it('should return true when library is explicitly selected', async () => { + setupSelector(mockLibraries, ['1', '3']) + + const { result: result1 } = renderHook(() => useIsLibrarySelected('1')) + const { result: result2 } = renderHook(() => useIsLibrarySelected('3')) + + expect(result1.current).toBe(true) + expect(result2.current).toBe(true) + }) + + it('should return false when library is not explicitly selected', async () => { + setupSelector(mockLibraries, ['1', '3']) + + const { result } = renderHook(() => useIsLibrarySelected('2')) + + expect(result.current).toBe(false) + }) + + it('should return true when no explicit selection (defaults to all) and library exists', async () => { + setupSelector(mockLibraries, []) + + const { result: result1 } = renderHook(() => useIsLibrarySelected('1')) + const { result: result2 } = renderHook(() => useIsLibrarySelected('2')) + const { result: result3 } = renderHook(() => useIsLibrarySelected('3')) + + expect(result1.current).toBe(true) + expect(result2.current).toBe(true) + expect(result3.current).toBe(true) + }) + + it('should return false when library does not exist in user libraries', async () => { + setupSelector(mockLibraries, []) + + const { result } = renderHook(() => useIsLibrarySelected('999')) + + expect(result.current).toBe(false) + }) + + it('should return false when user has no libraries', async () => { + setupSelector([], []) + + const { result } = renderHook(() => useIsLibrarySelected('1')) + + expect(result.current).toBe(false) + }) + + it('should handle undefined libraryId', async () => { + setupSelector(mockLibraries, ['1']) + + const { result } = renderHook(() => useIsLibrarySelected(undefined)) + + expect(result.current).toBe(false) + }) + + it('should handle null libraryId', async () => { + setupSelector(mockLibraries, ['1']) + + const { result } = renderHook(() => useIsLibrarySelected(null)) + + expect(result.current).toBe(false) + }) + }) +}) diff --git a/ui/src/common/useRating.jsx b/ui/src/common/useRating.jsx index f1d9a4fe9..2eb5d9eca 100644 --- a/ui/src/common/useRating.jsx +++ b/ui/src/common/useRating.jsx @@ -17,18 +17,42 @@ export const useRating = (resource, record) => { }, []) const refreshRating = useCallback(() => { - dataProvider - .getOne(resource, { id: record.id }) - .then(() => { - if (mountedRef.current) { - setLoading(false) - } - }) - .catch((e) => { - // eslint-disable-next-line no-console - console.log('Error encountered: ' + e) - }) - }, [dataProvider, record, resource]) + // For playlist tracks, refresh both resources to keep data in sync + if (record.mediaFileId) { + // This is a playlist track - refresh both the playlist track and the song + const promises = [ + dataProvider.getOne('song', { id: record.mediaFileId }), + dataProvider.getOne('playlistTrack', { + id: record.id, + filter: { playlist_id: record.playlistId }, + }), + ] + + Promise.all(promises) + .catch((e) => { + // eslint-disable-next-line no-console + console.log('Error encountered: ' + e) + }) + .finally(() => { + if (mountedRef.current) { + setLoading(false) + } + }) + } else { + // Regular song or other resource + dataProvider + .getOne(resource, { id: record.id }) + .catch((e) => { + // eslint-disable-next-line no-console + console.log('Error encountered: ' + e) + }) + .finally(() => { + if (mountedRef.current) { + setLoading(false) + } + }) + } + }, [dataProvider, record.id, record.mediaFileId, record.playlistId, resource]) const rate = (val, id) => { setLoading(true) diff --git a/ui/src/common/useRating.test.js b/ui/src/common/useRating.test.js new file mode 100644 index 000000000..b1353512e --- /dev/null +++ b/ui/src/common/useRating.test.js @@ -0,0 +1,165 @@ +import { renderHook, act } from '@testing-library/react-hooks' +import { vi, describe, it, expect, beforeEach } from 'vitest' +import { useRating } from './useRating' +import subsonic from '../subsonic' +import { useDataProvider } from 'react-admin' + +vi.mock('../subsonic', () => ({ + default: { + setRating: vi.fn(() => Promise.resolve()), + }, +})) + +vi.mock('react-admin', async () => { + const actual = await vi.importActual('react-admin') + return { + ...actual, + useDataProvider: vi.fn(), + useNotify: vi.fn(() => vi.fn()), + } +}) + +describe('useRating', () => { + let getOne + beforeEach(() => { + getOne = vi.fn(() => Promise.resolve()) + useDataProvider.mockReturnValue({ getOne }) + vi.clearAllMocks() + }) + + it('returns rating value from record', () => { + const record = { id: 'sg-1', rating: 3 } + const { result } = renderHook(() => useRating('song', record)) + const [rate, rating, loading] = result.current + expect(rating).toBe(3) + expect(loading).toBe(false) + expect(typeof rate).toBe('function') + }) + + it('sets rating using targetId and calls setRating API', async () => { + const record = { id: 'sg-1', rating: 0 } + const { result } = renderHook(() => useRating('song', record)) + await act(async () => { + await result.current[0](4, 'sg-1') + }) + expect(subsonic.setRating).toHaveBeenCalledWith('sg-1', 4) + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + + it('handles zero rating (unrate)', async () => { + const record = { id: 'sg-1', rating: 5 } + const { result } = renderHook(() => useRating('song', record)) + await act(async () => { + await result.current[0](0, 'sg-1') + }) + expect(subsonic.setRating).toHaveBeenCalledWith('sg-1', 0) + }) + + describe('playlist track scenarios', () => { + it('refreshes both playlist track and song for playlist tracks', async () => { + const record = { + id: 'pt-1', + mediaFileId: 'sg-1', + playlistId: 'pl-1', + rating: 2, + } + const { result } = renderHook(() => useRating('playlistTrack', record)) + await act(async () => { + await result.current[0](5, 'sg-1') + }) + + // Should rate using the media file ID + expect(subsonic.setRating).toHaveBeenCalledWith('sg-1', 5) + + // Should refresh both the playlist track and the song + expect(getOne).toHaveBeenCalledTimes(2) + expect(getOne).toHaveBeenCalledWith('playlistTrack', { + id: 'pt-1', + filter: { playlist_id: 'pl-1' }, + }) + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + + it('includes playlist_id filter when refreshing playlist tracks', async () => { + const record = { + id: 'pt-5', + mediaFileId: 'sg-10', + playlistId: 'pl-123', + rating: 1, + } + const { result } = renderHook(() => useRating('playlistTrack', record)) + await act(async () => { + await result.current[0](3, 'sg-10') + }) + + // Should rate using the media file ID + expect(subsonic.setRating).toHaveBeenCalledWith('sg-10', 3) + + // Should refresh playlist track with correct playlist_id filter + expect(getOne).toHaveBeenCalledWith('playlistTrack', { + id: 'pt-5', + filter: { playlist_id: 'pl-123' }, + }) + // Should also refresh the underlying song + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-10' }) + }) + + it('only refreshes original resource when no mediaFileId present', async () => { + const record = { id: 'sg-1', rating: 4 } + const { result } = renderHook(() => useRating('song', record)) + await act(async () => { + await result.current[0](2, 'sg-1') + }) + + // Should only refresh the original resource (song) + expect(getOne).toHaveBeenCalledTimes(1) + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + + it('does not include playlist_id filter for non-playlist resources', async () => { + const record = { id: 'sg-1', rating: 0 } + const { result } = renderHook(() => useRating('song', record)) + await act(async () => { + await result.current[0](5, 'sg-1') + }) + + // Should refresh without any filter + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + }) + + describe('component integration scenarios', () => { + it('handles mediaFileId fallback correctly for playlist tracks', async () => { + const record = { + id: 'pt-1', + mediaFileId: 'sg-1', + playlistId: 'pl-1', + rating: 0, + } + const { result } = renderHook(() => useRating('playlistTrack', record)) + + // Simulate RatingField component behavior: uses mediaFileId || record.id + const targetId = record.mediaFileId || record.id + await act(async () => { + await result.current[0](4, targetId) + }) + + expect(subsonic.setRating).toHaveBeenCalledWith('sg-1', 4) + }) + + it('handles regular song rating without mediaFileId', async () => { + const record = { id: 'sg-1', rating: 2 } + const { result } = renderHook(() => useRating('song', record)) + + // Simulate RatingField component behavior: uses mediaFileId || record.id + const targetId = record.mediaFileId || record.id + await act(async () => { + await result.current[0](5, targetId) + }) + + expect(subsonic.setRating).toHaveBeenCalledWith('sg-1', 5) + expect(getOne).toHaveBeenCalledTimes(1) + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + }) +}) diff --git a/ui/src/common/useRefreshOnEvents.jsx b/ui/src/common/useRefreshOnEvents.jsx new file mode 100644 index 000000000..b5f1b1ede --- /dev/null +++ b/ui/src/common/useRefreshOnEvents.jsx @@ -0,0 +1,109 @@ +import { useEffect, useState } from 'react' +import { useSelector } from 'react-redux' + +/** + * A reusable hook for triggering custom reload logic when specific SSE events occur. + * + * This hook is ideal when: + * - Your component displays derived/related data that isn't directly managed by react-admin + * - You need custom loading logic that goes beyond simple dataProvider.getMany() calls + * - Your data comes from non-standard endpoints or requires special processing + * - You want to reload parent/related resources when child resources change + * + * @param {Object} options - Configuration options + * @param {Array<string>} options.events - Array of event types to listen for (e.g., ['library', 'user', '*']) + * @param {Function} options.onRefresh - Async function to call when events occur. + * Should be wrapped in useCallback with appropriate dependencies to avoid unnecessary re-renders. + * + * @example + * // Example 1: LibrarySelector - Reload user data when library changes + * const loadUserLibraries = useCallback(async () => { + * const userId = localStorage.getItem('userId') + * if (userId) { + * const { data } = await dataProvider.getOne('user', { id: userId }) + * dispatch(setUserLibraries(data.libraries || [])) + * } + * }, [dataProvider, dispatch]) + * + * useRefreshOnEvents({ + * events: ['library', 'user'], + * onRefresh: loadUserLibraries + * }) + * + * @example + * // Example 2: Statistics Dashboard - Reload stats when any music data changes + * const loadStats = useCallback(async () => { + * const stats = await dataProvider.customRequest('GET', 'stats') + * setDashboardStats(stats) + * }, [dataProvider, setDashboardStats]) + * + * useRefreshOnEvents({ + * events: ['album', 'song', 'artist'], + * onRefresh: loadStats + * }) + * + * @example + * // Example 3: Permission-based UI - Reload permissions when user changes + * const loadPermissions = useCallback(async () => { + * const authData = await authProvider.getPermissions() + * setUserPermissions(authData) + * }, [authProvider, setUserPermissions]) + * + * useRefreshOnEvents({ + * events: ['user'], + * onRefresh: loadPermissions + * }) + * + * @example + * // Example 4: Listen to all events (use sparingly) + * const reloadAll = useCallback(async () => { + * // This will trigger on ANY refresh event + * await reloadEverything() + * }, [reloadEverything]) + * + * useRefreshOnEvents({ + * events: ['*'], + * onRefresh: reloadAll + * }) + */ +export const useRefreshOnEvents = ({ events, onRefresh }) => { + const [lastRefreshTime, setLastRefreshTime] = useState(Date.now()) + + const refreshData = useSelector( + (state) => state.activity?.refresh || { lastReceived: lastRefreshTime }, + ) + + useEffect(() => { + const { resources, lastReceived } = refreshData + + // Only process if we have new events + if (lastReceived <= lastRefreshTime) { + return + } + + // Check if any of the events we're interested in occurred + const shouldRefresh = + resources && + // Global refresh event + (resources['*'] === '*' || + // Check for specific events we're listening to + events.some((eventType) => { + if (eventType === '*') { + return true // Listen to all events + } + return resources[eventType] // Check if this specific event occurred + })) + + if (shouldRefresh) { + setLastRefreshTime(lastReceived) + + // Call the custom refresh function + if (onRefresh) { + onRefresh().catch((error) => { + // eslint-disable-next-line no-console + console.warn('Error in useRefreshOnEvents onRefresh callback:', error) + }) + } + } + }, [refreshData, lastRefreshTime, events, onRefresh]) +} diff --git a/ui/src/common/useRefreshOnEvents.test.js b/ui/src/common/useRefreshOnEvents.test.js new file mode 100644 index 000000000..2306cd3c9 --- /dev/null +++ b/ui/src/common/useRefreshOnEvents.test.js @@ -0,0 +1,233 @@ +import { vi } from 'vitest' +import * as React from 'react' +import * as Redux from 'react-redux' +import { useRefreshOnEvents } from './useRefreshOnEvents' + +vi.mock('react', async () => { + const actual = await vi.importActual('react') + return { + ...actual, + useState: vi.fn(), + useEffect: vi.fn(), + } +}) + +vi.mock('react-redux', async () => { + const actual = await vi.importActual('react-redux') + return { + ...actual, + useSelector: vi.fn(), + } +}) + +describe('useRefreshOnEvents', () => { + const setState = vi.fn() + const useStateMock = (initState) => [initState, setState] + const onRefresh = vi.fn().mockResolvedValue() + let lastTime + let mockUseEffect + + beforeEach(() => { + vi.spyOn(React, 'useState').mockImplementation(useStateMock) + mockUseEffect = vi.spyOn(React, 'useEffect') + lastTime = new Date(new Date().valueOf() + 1000) + onRefresh.mockClear() + setState.mockClear() + }) + + afterEach(() => { + vi.clearAllMocks() + }) + + it('stores last time checked, to avoid redundant runs', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { library: ['lib-1'] }, // Need some resources to trigger the update + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + // Mock useEffect to immediately call the effect callback + mockUseEffect.mockImplementation((callback) => callback()) + + useRefreshOnEvents({ + events: ['library'], + onRefresh, + }) + + expect(setState).toHaveBeenCalledWith(lastTime) + }) + + it("does not run again if lastTime didn't change", () => { + vi.spyOn(React, 'useState').mockImplementation(() => [lastTime, setState]) + const useSelectorMock = () => ({ lastReceived: lastTime }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + // Mock useEffect to immediately call the effect callback + mockUseEffect.mockImplementation((callback) => callback()) + + useRefreshOnEvents({ + events: ['library'], + onRefresh, + }) + + expect(setState).not.toHaveBeenCalled() + expect(onRefresh).not.toHaveBeenCalled() + }) + + describe('Event listening and refresh triggering', () => { + beforeEach(() => { + // Mock useEffect to immediately call the effect callback + mockUseEffect.mockImplementation((callback) => callback()) + }) + + it('triggers refresh when a watched event occurs', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { library: ['lib-1', 'lib-2'] }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + useRefreshOnEvents({ + events: ['library'], + onRefresh, + }) + + expect(onRefresh).toHaveBeenCalledTimes(1) + expect(setState).toHaveBeenCalledWith(lastTime) + }) + + it('triggers refresh when multiple watched events occur', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { + library: ['lib-1'], + user: ['user-1'], + album: ['album-1'], // This shouldn't trigger since it's not watched + }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + useRefreshOnEvents({ + events: ['library', 'user'], + onRefresh, + }) + + expect(onRefresh).toHaveBeenCalledTimes(1) + expect(setState).toHaveBeenCalledWith(lastTime) + }) + + it('does not trigger refresh when unwatched events occur', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { album: ['album-1'], song: ['song-1'] }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + useRefreshOnEvents({ + events: ['library', 'user'], + onRefresh, + }) + + expect(onRefresh).not.toHaveBeenCalled() + expect(setState).not.toHaveBeenCalled() + }) + + it('triggers refresh on global refresh event', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { '*': '*' }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + useRefreshOnEvents({ + events: ['library'], + onRefresh, + }) + + expect(onRefresh).toHaveBeenCalledTimes(1) + expect(setState).toHaveBeenCalledWith(lastTime) + }) + + it('triggers refresh when listening to all events with "*"', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { song: ['song-1'] }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + useRefreshOnEvents({ + events: ['*'], + onRefresh, + }) + + expect(onRefresh).toHaveBeenCalledTimes(1) + expect(setState).toHaveBeenCalledWith(lastTime) + }) + + it('handles empty events array gracefully', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { library: ['lib-1'] }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + useRefreshOnEvents({ + events: [], + onRefresh, + }) + + expect(onRefresh).not.toHaveBeenCalled() + expect(setState).not.toHaveBeenCalled() + }) + + it('handles missing onRefresh function gracefully', () => { + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { library: ['lib-1'] }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + expect(() => { + useRefreshOnEvents({ + events: ['library'], + // onRefresh is undefined + }) + }).not.toThrow() + + expect(setState).toHaveBeenCalledWith(lastTime) + }) + + it('handles onRefresh errors gracefully', async () => { + const consoleWarnSpy = vi + .spyOn(console, 'warn') + .mockImplementation(() => {}) + const failingRefresh = vi + .fn() + .mockRejectedValue(new Error('Refresh failed')) + + const useSelectorMock = () => ({ + lastReceived: lastTime, + resources: { library: ['lib-1'] }, + }) + vi.spyOn(Redux, 'useSelector').mockImplementation(useSelectorMock) + + useRefreshOnEvents({ + events: ['library'], + onRefresh: failingRefresh, + }) + + expect(failingRefresh).toHaveBeenCalledTimes(1) + expect(setState).toHaveBeenCalledWith(lastTime) + + // Wait for the promise to be rejected and handled + await new Promise((resolve) => setTimeout(resolve, 10)) + + expect(consoleWarnSpy).toHaveBeenCalledWith( + 'Error in useRefreshOnEvents onRefresh callback:', + expect.any(Error), + ) + + consoleWarnSpy.mockRestore() + }) + }) +}) diff --git a/ui/src/common/useResourceRefresh.jsx b/ui/src/common/useResourceRefresh.jsx index d9f6aee52..eabff6f92 100644 --- a/ui/src/common/useResourceRefresh.jsx +++ b/ui/src/common/useResourceRefresh.jsx @@ -2,6 +2,67 @@ import { useSelector } from 'react-redux' import { useState } from 'react' import { useRefresh, useDataProvider } from 'react-admin' +/** + * A hook that automatically refreshes react-admin managed resources when refresh events are received via SSE. + * + * This hook is designed for components that display react-admin managed resources (like lists, shows, edits) + * and need to stay in sync when those resources are modified elsewhere in the application. + * + * **When to use this hook:** + * - Your component displays react-admin resources (albums, songs, artists, playlists, etc.) + * - You want automatic refresh when those resources are created/updated/deleted + * - Your data comes from standard dataProvider.getMany() calls + * - You're using react-admin's data management (queries, mutations, caching) + * + * **When NOT to use this hook:** + * - Your component displays derived/custom data not directly managed by react-admin + * - You need custom reload logic beyond dataProvider.getMany() + * - Your data comes from non-standard endpoints + * - Use `useRefreshOnEvents` instead for these scenarios + * + * @param {...string} visibleResources - Resource names to watch for changes. + * If no resources specified, watches all resources. + * If '*' is included in resources, triggers full page refresh. + * + * @example + * // Example 1: Album list - refresh when albums change + * const AlbumList = () => { + * useResourceRefresh('album') + * return <List resource="album">...</List> + * } + * + * @example + * // Example 2: Album show page - refresh when album or its songs change + * const AlbumShow = () => { + * useResourceRefresh('album', 'song') + * return <Show resource="album">...</Show> + * } + * + * @example + * // Example 3: Dashboard - refresh when any resource changes + * const Dashboard = () => { + * useResourceRefresh() // No parameters = watch all resources + * return <div>...</div> + * } + * + * @example + * // Example 4: Library management page - watch library resources + * const LibraryList = () => { + * useResourceRefresh('library') + * return <List resource="library">...</List> + * } + * + * **How it works:** + * - Listens to refresh events from the SSE connection + * - When events arrive, checks if they match the specified visible resources + * - For specific resource IDs: calls dataProvider.getMany(resource, {ids: [...]}) + * - For global refreshes: calls refresh() to reload the entire page + * - Uses react-admin's built-in data management and caching + * + * **Event format expected:** + * - Global refresh: { '*': '*' } or { someResource: ['*'] } + * - Specific resources: { album: ['id1', 'id2'], song: ['id3'] } + */ export const useResourceRefresh = (...visibleResources) => { const [lastTime, setLastTime] = useState(Date.now()) const refresh = useRefresh() diff --git a/ui/src/common/useSearchRefocus.js b/ui/src/common/useSearchRefocus.js new file mode 100644 index 000000000..4daad26f9 --- /dev/null +++ b/ui/src/common/useSearchRefocus.js @@ -0,0 +1,50 @@ +import { useEffect, useRef } from 'react' +import { useLocation } from 'react-router-dom' + +// Search field names used by SearchInput across different list views: +// - 'name': AlbumList, ArtistList, LibraryList, PlayerList, RadioList, UserList +// - 'title': SongList +// - 'q': PlaylistList +// If a new list view uses a different source field, add it here. +const SEARCH_FIELDS = ['name', 'title', 'q'] + +const getSearchValue = (filter) => { + for (const field of SEARCH_FIELDS) { + if (filter[field]) return filter[field] + } + return '' +} + +export const useSearchRefocus = () => { + const location = useLocation() + const prevSearchValue = useRef(null) + + useEffect(() => { + const params = new URLSearchParams(location.search) + const filterStr = params.get('filter') || '{}' + + let filter = {} + try { + filter = JSON.parse(filterStr) + } catch (e) { + // Invalid JSON, ignore + } + + const searchValue = getSearchValue(filter) + + if (prevSearchValue.current && !searchValue) { + // Use requestAnimationFrame to wait for React to finish re-rendering + // after the URL change before focusing the input + requestAnimationFrame(() => { + // Selector depends on react-admin's internal class naming. + // If react-admin changes these class names, this will need updating. + const input = document.querySelector('[class*="RaSearchInput"] input') + if (input) { + input.focus() + } + }) + } + + prevSearchValue.current = searchValue + }, [location.search]) +} diff --git a/ui/src/common/useSearchRefocus.test.js b/ui/src/common/useSearchRefocus.test.js new file mode 100644 index 000000000..2bce8320d --- /dev/null +++ b/ui/src/common/useSearchRefocus.test.js @@ -0,0 +1,84 @@ +import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest' +import { renderHook } from '@testing-library/react-hooks' +import { useSearchRefocus } from './useSearchRefocus' + +const mockLocation = { search: '' } +vi.mock('react-router-dom', () => ({ + useLocation: () => mockLocation, +})) + +describe('useSearchRefocus', () => { + let container + let rafCallbacks + + beforeEach(() => { + rafCallbacks = [] + vi.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => { + rafCallbacks.push(cb) + return rafCallbacks.length + }) + + container = document.createElement('div') + container.innerHTML = ` + <div class="RaSearchInput-input"> + <input type="text" /> + </div> + ` + document.body.appendChild(container) + mockLocation.search = '' + }) + + afterEach(() => { + vi.restoreAllMocks() + document.body.removeChild(container) + }) + + const flushRAF = () => { + rafCallbacks.forEach((cb) => cb()) + rafCallbacks = [] + } + + it('focuses the input when search filter is cleared', () => { + const input = container.querySelector('input') + const focusSpy = vi.spyOn(input, 'focus') + + mockLocation.search = '?filter={"name":"test"}' + const { rerender } = renderHook(() => useSearchRefocus()) + + expect(focusSpy).not.toHaveBeenCalled() + + mockLocation.search = '?filter={}' + rerender() + flushRAF() + + expect(focusSpy).toHaveBeenCalledTimes(1) + }) + + it('does not focus if filter was already empty', () => { + const input = container.querySelector('input') + const focusSpy = vi.spyOn(input, 'focus') + + mockLocation.search = '?filter={}' + const { rerender } = renderHook(() => useSearchRefocus()) + + mockLocation.search = '?filter={}' + rerender() + flushRAF() + + expect(focusSpy).not.toHaveBeenCalled() + }) + + it('does not focus if filter value changed but not cleared', () => { + const input = container.querySelector('input') + const focusSpy = vi.spyOn(input, 'focus') + + mockLocation.search = '?filter={"name":"test"}' + const { rerender } = renderHook(() => useSearchRefocus()) + + mockLocation.search = '?filter={"name":"other"}' + rerender() + flushRAF() + + expect(focusSpy).not.toHaveBeenCalled() + }) +}) diff --git a/ui/src/common/useToggleLove.jsx b/ui/src/common/useToggleLove.jsx index 6379d587e..3f98a2e21 100644 --- a/ui/src/common/useToggleLove.jsx +++ b/ui/src/common/useToggleLove.jsx @@ -17,18 +17,38 @@ export const useToggleLove = (resource, record = {}) => { const dataProvider = useDataProvider() const refreshRecord = useCallback(() => { - dataProvider.getOne(resource, { id: record.id }).then(() => { - if (mountedRef.current) { - setLoading(false) - } - }) - }, [dataProvider, record.id, resource]) + const promises = [] + + // Always refresh the original resource + const params = { id: record.id } + if (record.playlistId) { + params.filter = { playlist_id: record.playlistId } + } + promises.push(dataProvider.getOne(resource, params)) + + // If we have a mediaFileId, also refresh the song + if (record.mediaFileId) { + promises.push(dataProvider.getOne('song', { id: record.mediaFileId })) + } + + Promise.all(promises) + .catch((e) => { + // eslint-disable-next-line no-console + console.log('Error encountered: ' + e) + }) + .finally(() => { + if (mountedRef.current) { + setLoading(false) + } + }) + }, [dataProvider, record.mediaFileId, record.id, record.playlistId, resource]) const toggleLove = () => { const toggle = record.starred ? subsonic.unstar : subsonic.star + const id = record.mediaFileId || record.id setLoading(true) - toggle(record.id) + toggle(id) .then(refreshRecord) .catch((e) => { // eslint-disable-next-line no-console diff --git a/ui/src/common/useToggleLove.test.js b/ui/src/common/useToggleLove.test.js new file mode 100644 index 000000000..640e9ff89 --- /dev/null +++ b/ui/src/common/useToggleLove.test.js @@ -0,0 +1,136 @@ +import { renderHook, act } from '@testing-library/react-hooks' +import { vi, describe, it, expect, beforeEach } from 'vitest' +import { useToggleLove } from './useToggleLove' +import subsonic from '../subsonic' +import { useDataProvider } from 'react-admin' + +vi.mock('../subsonic', () => ({ + default: { + star: vi.fn(() => Promise.resolve()), + unstar: vi.fn(() => Promise.resolve()), + }, +})) + +vi.mock('react-admin', async () => { + const actual = await vi.importActual('react-admin') + return { + ...actual, + useDataProvider: vi.fn(), + useNotify: vi.fn(() => vi.fn()), + } +}) + +describe('useToggleLove', () => { + let getOne + beforeEach(() => { + getOne = vi.fn(() => Promise.resolve()) + useDataProvider.mockReturnValue({ getOne }) + vi.clearAllMocks() + }) + + it('uses mediaFileId when present', async () => { + const record = { id: 'pt-1', mediaFileId: 'sg-1', starred: false } + const { result } = renderHook(() => useToggleLove('song', record)) + await act(async () => { + await result.current[0]() + }) + expect(subsonic.star).toHaveBeenCalledWith('sg-1') + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + + it('falls back to id when mediaFileId not present', async () => { + const record = { id: 'sg-1', starred: false } + const { result } = renderHook(() => useToggleLove('song', record)) + await act(async () => { + await result.current[0]() + }) + expect(subsonic.star).toHaveBeenCalledWith('sg-1') + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + + it('calls unstar when record is already loved', async () => { + const record = { id: 'sg-1', starred: true } + const { result } = renderHook(() => useToggleLove('song', record)) + await act(async () => { + await result.current[0]() + }) + expect(subsonic.unstar).toHaveBeenCalledWith('sg-1') + }) + + describe('playlist track scenarios', () => { + it('refreshes both playlist track and song for playlist tracks', async () => { + const record = { + id: 'pt-1', + mediaFileId: 'sg-1', + playlistId: 'pl-1', + starred: false, + } + const { result } = renderHook(() => + useToggleLove('playlistTrack', record), + ) + await act(async () => { + await result.current[0]() + }) + + // Should star using the media file ID + expect(subsonic.star).toHaveBeenCalledWith('sg-1') + + // Should refresh both the playlist track and the song + expect(getOne).toHaveBeenCalledTimes(2) + expect(getOne).toHaveBeenCalledWith('playlistTrack', { + id: 'pt-1', + filter: { playlist_id: 'pl-1' }, + }) + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + + it('includes playlist_id filter when refreshing playlist tracks', async () => { + const record = { + id: 'pt-5', + mediaFileId: 'sg-10', + playlistId: 'pl-123', + starred: true, + } + const { result } = renderHook(() => + useToggleLove('playlistTrack', record), + ) + await act(async () => { + await result.current[0]() + }) + + // Should unstar using the media file ID + expect(subsonic.unstar).toHaveBeenCalledWith('sg-10') + + // Should refresh playlist track with correct playlist_id filter + expect(getOne).toHaveBeenCalledWith('playlistTrack', { + id: 'pt-5', + filter: { playlist_id: 'pl-123' }, + }) + // Should also refresh the underlying song + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-10' }) + }) + + it('only refreshes original resource when no mediaFileId present', async () => { + const record = { id: 'sg-1', starred: false } + const { result } = renderHook(() => useToggleLove('song', record)) + await act(async () => { + await result.current[0]() + }) + + // Should only refresh the original resource (song) + expect(getOne).toHaveBeenCalledTimes(1) + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + + it('does not include playlist_id filter for non-playlist resources', async () => { + const record = { id: 'sg-1', starred: false } + const { result } = renderHook(() => useToggleLove('song', record)) + await act(async () => { + await result.current[0]() + }) + + // Should refresh without any filter + expect(getOne).toHaveBeenCalledWith('song', { id: 'sg-1' }) + }) + }) +}) diff --git a/ui/src/config.js b/ui/src/config.js index 92ce07893..39f0cd467 100644 --- a/ui/src/config.js +++ b/ui/src/config.js @@ -20,7 +20,10 @@ const defaultConfig = { defaultTheme: 'Dark', defaultLanguage: '', defaultUIVolume: 100, + uiSearchDebounceMs: 200, + uiCoverArtSize: 600, enableUserEditing: true, + enableArtworkUpload: true, enableSharing: true, shareURL: '', defaultDownloadableShare: true, @@ -29,12 +32,17 @@ const defaultConfig = { listenBrainzEnabled: true, enableExternalServices: true, enableCoverAnimation: true, + enableNowPlaying: true, + playbackReportIntervalMs: 60000, devShowArtistPage: true, + devUIShowConfig: true, + devNewEventStream: false, enableReplayGain: true, defaultDownsamplingFormat: 'opus', publicBaseUrl: '/share', separator: '/', enableInspect: true, + pluginsEnabled: true, } let config diff --git a/ui/src/consts.js b/ui/src/consts.js index e3446c2fe..472cd4940 100644 --- a/ui/src/consts.js +++ b/ui/src/consts.js @@ -7,6 +7,8 @@ export const M3U_MIME_TYPE = 'audio/x-mpegurl' export const AUTO_THEME_ID = 'AUTO_THEME_ID' +export const AUTO_THEME_CONFIG_VALUE = 'Auto' + export const DraggableTypes = { SONG: 'song', ALBUM: 'album', @@ -22,6 +24,8 @@ DraggableTypes.ALL.push( DraggableTypes.ARTIST, ) +export const RADIO_PLACEHOLDER_IMAGE = 'internet-radio-icon.svg' + export const DEFAULT_SHARE_BITRATE = 128 export const BITRATE_CHOICES = [ diff --git a/ui/src/dataProvider/httpClient.js b/ui/src/dataProvider/httpClient.js index a8897aef8..3820f658d 100644 --- a/ui/src/dataProvider/httpClient.js +++ b/ui/src/dataProvider/httpClient.js @@ -6,8 +6,8 @@ import { jwtDecode } from 'jwt-decode' import { removeHomeCache } from '../utils/removeHomeCache' const customAuthorizationHeader = 'X-ND-Authorization' -const clientUniqueIdHeader = 'X-ND-Client-Unique-Id' -const clientUniqueId = uuidv4() +export const clientUniqueIdHeader = 'X-ND-Client-Unique-Id' +export const clientUniqueId = uuidv4() const httpClient = (url, options = {}) => { url = baseUrl(url) diff --git a/ui/src/dataProvider/index.js b/ui/src/dataProvider/index.js index e9ceea761..059023378 100644 --- a/ui/src/dataProvider/index.js +++ b/ui/src/dataProvider/index.js @@ -1,6 +1,6 @@ -import httpClient from './httpClient' +import httpClient, { clientUniqueId, clientUniqueIdHeader } from './httpClient' import wrapperDataProvider from './wrapperDataProvider' -export { httpClient } +export { httpClient, clientUniqueId, clientUniqueIdHeader } export default wrapperDataProvider diff --git a/ui/src/dataProvider/wrapperDataProvider.js b/ui/src/dataProvider/wrapperDataProvider.js index bf487dc7c..268d3668d 100644 --- a/ui/src/dataProvider/wrapperDataProvider.js +++ b/ui/src/dataProvider/wrapperDataProvider.js @@ -9,25 +9,73 @@ const isAdmin = () => { return role === 'admin' } +const getSelectedLibraries = () => { + try { + const state = JSON.parse(localStorage.getItem('state')) + const selectedLibraries = state?.library?.selectedLibraries || [] + const userLibraries = state?.library?.userLibraries || [] + + // Validate selected libraries against current user libraries + const userLibraryIds = userLibraries.map((lib) => lib.id) + const validatedSelection = selectedLibraries.filter((id) => + userLibraryIds.includes(id), + ) + + // If user has only one library, return empty array (no filter needed) + if (userLibraryIds.length === 1) { + return [] + } + + return validatedSelection + } catch (err) { + return [] + } +} + +// Function to apply library filtering to appropriate resources +const applyLibraryFilter = (resource, params) => { + // Content resources that should be filtered by selected libraries + const filteredResources = ['album', 'song', 'artist', 'playlistTrack', 'tag'] + + // Get selected libraries from localStorage + const selectedLibraries = getSelectedLibraries() + + // Add library filter for content resources if libraries are selected + if (filteredResources.includes(resource) && selectedLibraries.length > 0) { + if (!params.filter) { + params.filter = {} + } + params.filter.library_id = selectedLibraries + } + + return params +} + const mapResource = (resource, params) => { switch (resource) { + // /api/playlistTrack?playlist_id=123 => /api/playlist/123/tracks case 'playlistTrack': { - // /api/playlistTrack?playlist_id=123 => /api/playlist/123/tracks + params.filter = params.filter || {} + let plsId = '0' - if (params.filter) { - plsId = params.filter.playlist_id - if (!isAdmin()) { - params.filter.missing = false - } + plsId = params.filter.playlist_id + if (!isAdmin()) { + params.filter.missing = false } + params = applyLibraryFilter(resource, params) + return [`playlist/${plsId}/tracks`, params] } case 'album': case 'song': - case 'artist': { - if (params.filter && !isAdmin()) { + case 'artist': + case 'tag': { + params.filter = params.filter || {} + if (!isAdmin()) { params.filter.missing = false } + params = applyLibraryFilter(resource, params) + return [resource, params] } default: @@ -43,6 +91,60 @@ const callDeleteMany = (resource, params) => { }).then((response) => ({ data: response.json.ids || [] })) } +// Helper function to handle user-library associations +const handleUserLibraryAssociation = async (userId, libraryIds) => { + if (!libraryIds || libraryIds.length === 0) { + return // Admin users or users without library assignments + } + + try { + await httpClient(`${REST_URL}/user/${userId}/library`, { + method: 'PUT', + body: JSON.stringify({ libraryIds }), + }) + } catch (error) { + console.error('Error setting user libraries:', error) //eslint-disable-line no-console + throw error + } +} + +// Enhanced user creation that handles library associations +const createUser = async (params) => { + const { data } = params + const { libraryIds, ...userData } = data + + // First create the user + const userResponse = await dataProvider.create('user', { data: userData }) + const userId = userResponse.data.id + + // Then set library associations for non-admin users + if (!userData.isAdmin && libraryIds && libraryIds.length > 0) { + await handleUserLibraryAssociation(userId, libraryIds) + } + + return userResponse +} + +// Enhanced user update that handles library associations +const updateUser = async (params) => { + const { data } = params + const { libraryIds, ...userData } = data + const userId = params.id + + // First update the user + const userResponse = await dataProvider.update('user', { + ...params, + data: userData, + }) + + // Then handle library associations for non-admin users + if (!userData.isAdmin && libraryIds !== undefined) { + await handleUserLibraryAssociation(userId, libraryIds) + } + + return userResponse +} + const wrapperDataProvider = { ...dataProvider, getList: (resource, params) => { @@ -51,7 +153,19 @@ const wrapperDataProvider = { }, getOne: (resource, params) => { const [r, p] = mapResource(resource, params) - return dataProvider.getOne(r, p) + const response = dataProvider.getOne(r, p) + + // Transform user data to ensure libraryIds is present for form compatibility + if (resource === 'user') { + return response.then((result) => { + if (result.data.libraries && Array.isArray(result.data.libraries)) { + result.data.libraryIds = result.data.libraries.map((lib) => lib.id) + } + return result + }) + } + + return response }, getMany: (resource, params) => { const [r, p] = mapResource(resource, params) @@ -62,6 +176,9 @@ const wrapperDataProvider = { return dataProvider.getManyReference(r, p) }, update: (resource, params) => { + if (resource === 'user') { + return updateUser(params) + } const [r, p] = mapResource(resource, params) return dataProvider.update(r, p) }, @@ -70,6 +187,9 @@ const wrapperDataProvider = { return dataProvider.updateMany(r, p) }, create: (resource, params) => { + if (resource === 'user') { + return createUser(params) + } const [r, p] = mapResource(resource, params) return dataProvider.create(r, p) }, @@ -90,6 +210,16 @@ const wrapperDataProvider = { body: JSON.stringify(data), }).then(({ json }) => ({ data: json })) }, + getPlaylists: (songId) => { + return httpClient(`${REST_URL}/song/${songId}/playlists`).then( + ({ json }) => ({ data: json }), + ) + }, + inspect: (songId) => { + return httpClient(`${REST_URL}/inspect?id=${songId}`).then(({ json }) => ({ + data: json, + })) + }, } export default wrapperDataProvider diff --git a/ui/src/dialogs/AboutDialog.jsx b/ui/src/dialogs/AboutDialog.jsx index 4f074002b..486cc0492 100644 --- a/ui/src/dialogs/AboutDialog.jsx +++ b/ui/src/dialogs/AboutDialog.jsx @@ -9,15 +9,65 @@ import TableBody from '@material-ui/core/TableBody' import TableRow from '@material-ui/core/TableRow' import TableCell from '@material-ui/core/TableCell' import Paper from '@material-ui/core/Paper' +import CloudDownloadIcon from '@material-ui/icons/CloudDownload' import FavoriteBorderIcon from '@material-ui/icons/FavoriteBorder' +import FileCopyIcon from '@material-ui/icons/FileCopy' +import Button from '@material-ui/core/Button' import { humanize, underscore } from 'inflection' -import { useGetOne, usePermissions, useTranslate } from 'react-admin' +import { useGetOne, usePermissions, useTranslate, useNotify } from 'react-admin' +import { Tabs, Tab } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' import config from '../config' import { DialogTitle } from './DialogTitle' import { DialogContent } from './DialogContent' import { INSIGHTS_DOC_URL } from '../consts.js' import subsonic from '../subsonic/index.js' import { Typography } from '@material-ui/core' +import TableHead from '@material-ui/core/TableHead' +import { configToToml, separateAndSortConfigs } from './aboutUtils' + +const useStyles = makeStyles((theme) => ({ + configNameColumn: { + maxWidth: '200px', + width: '200px', + wordWrap: 'break-word', + overflowWrap: 'break-word', + }, + envVarColumn: { + maxWidth: '250px', + width: '250px', + fontFamily: 'monospace', + wordWrap: 'break-word', + overflowWrap: 'break-word', + }, + copyButton: { + marginBottom: theme.spacing(2), + marginTop: theme.spacing(1), + }, + devSectionHeader: { + '& td': { + paddingTop: theme.spacing(2), + paddingBottom: theme.spacing(2), + borderTop: `2px solid ${theme.palette.divider}`, + borderBottom: `1px solid ${theme.palette.divider}`, + textAlign: 'left', + fontWeight: 600, + }, + }, + configContainer: { + paddingTop: theme.spacing(1), + }, + tableContainer: { + maxHeight: '60vh', + overflow: 'auto', + }, + devFlagsTitle: { + fontWeight: 600, + }, + expandableDialog: { + transition: 'max-width 300ms ease', + }, +})) const links = { homepage: 'navidrome.org', @@ -54,7 +104,6 @@ const LinkToVersion = ({ version }) => { const ShowVersion = ({ uiVersion, serverVersion }) => { const translate = useTranslate() - const showRefresh = uiVersion !== serverVersion return ( @@ -73,12 +122,16 @@ const ShowVersion = ({ uiVersion, serverVersion }) => { UI {translate('menu.version')}: </TableCell> <TableCell align="left"> - <LinkToVersion version={uiVersion} /> - <Link onClick={() => window.location.reload()}> - <Typography variant={'caption'}> - {' ' + translate('ra.notification.new_version')} - </Typography> - </Link> + <div> + <LinkToVersion version={uiVersion} /> + </div> + <div> + <Link onClick={() => window.location.reload()}> + <Typography variant={'caption'}> + {translate('ra.notification.new_version')} + </Typography> + </Link> + </div> </TableCell> </TableRow> )} @@ -86,11 +139,312 @@ const ShowVersion = ({ uiVersion, serverVersion }) => { ) } -const AboutDialog = ({ open, onClose }) => { +const AboutTabContent = ({ + uiVersion, + serverVersion, + insightsData, + loading, + permissions, +}) => { const translate = useTranslate() + + const lastRun = !loading && insightsData?.lastRun + let insightsStatus = 'N/A' + if (lastRun === 'disabled') { + insightsStatus = translate('about.links.insights.disabled') + } else if (lastRun && lastRun?.startsWith('1969-12-31')) { + insightsStatus = translate('about.links.insights.waiting') + } else if (lastRun) { + insightsStatus = lastRun + } + + return ( + <Table aria-label={translate('menu.about')} size="small"> + <TableBody> + <ShowVersion uiVersion={uiVersion} serverVersion={serverVersion} /> + {Object.keys(links).map((key) => { + return ( + <TableRow key={key}> + <TableCell align="right" component="th" scope="row"> + {translate(`about.links.${key}`, { + _: humanize(underscore(key)), + })} + : + </TableCell> + <TableCell align="left"> + <Link + href={`https://${links[key]}`} + target="_blank" + rel="noopener noreferrer" + > + {links[key]} + </Link> + </TableCell> + </TableRow> + ) + })} + {permissions === 'admin' ? ( + <TableRow> + <TableCell align="right" component="th" scope="row"> + {translate(`about.links.lastInsightsCollection`)}: + </TableCell> + <TableCell align="left"> + <Link href={INSIGHTS_DOC_URL}>{insightsStatus}</Link> + </TableCell> + </TableRow> + ) : null} + <TableRow> + <TableCell align="right" component="th" scope="row"> + <Link + href={'https://github.com/sponsors/deluan'} + target="_blank" + rel="noopener noreferrer" + > + <IconButton size={'small'}> + <FavoriteBorderIcon fontSize={'small'} /> + </IconButton> + </Link> + </TableCell> + <TableCell align="left"> + <Link + href={'https://ko-fi.com/deluan'} + target="_blank" + rel="noopener noreferrer" + > + ko-fi.com/deluan + </Link> + </TableCell> + </TableRow> + </TableBody> + </Table> + ) +} + +const ConfigTabContent = ({ configData }) => { + const classes = useStyles() + const translate = useTranslate() + const notify = useNotify() + + if (!configData || !configData.config) { + return null + } + + // Use the shared separation and sorting logic + const { regularConfigs, devConfigs } = separateAndSortConfigs( + configData.config, + ) + + const handleCopyToml = async () => { + try { + const tomlContent = configToToml(configData, translate) + await navigator.clipboard.writeText(tomlContent) + notify(translate('about.config.exportSuccess'), 'info') + } catch (err) { + // eslint-disable-next-line no-console + console.error('Failed to copy TOML:', err) + notify(translate('about.config.exportFailed'), 'error') + } + } + + const handleDownloadToml = () => { + const tomlContent = configToToml(configData, translate) + const tomlFile = new File([tomlContent], 'navidrome.toml', { + type: 'text/plain', + }) + + const tomlFileLink = document.createElement('a') + const tomlFileUrl = URL.createObjectURL(tomlFile) + tomlFileLink.href = tomlFileUrl + tomlFileLink.download = tomlFile.name + tomlFileLink.click() + + URL.revokeObjectURL(tomlFileUrl) + } + + return ( + <div className={classes.configContainer}> + <Button + variant="outlined" + startIcon={<FileCopyIcon />} + onClick={handleCopyToml} + className={classes.copyButton} + disabled={ + !configData || !navigator.clipboard || !window.isSecureContext + } + size="small" + > + {translate('about.config.exportToml')} + </Button> + <Button + variant="outlined" + startIcon={<CloudDownloadIcon />} + onClick={handleDownloadToml} + className={classes.copyButton} + disabled={!configData} + size="small" + > + {translate('about.config.downloadToml')} + </Button> + <TableContainer className={classes.tableContainer}> + <Table size="small" stickyHeader> + <TableHead> + <TableRow> + <TableCell + align="left" + component="th" + scope="col" + className={classes.configNameColumn} + > + {translate('about.config.configName')} + </TableCell> + <TableCell align="left" component="th" scope="col"> + {translate('about.config.environmentVariable')} + </TableCell> + <TableCell align="left" component="th" scope="col"> + {translate('about.config.currentValue')} + </TableCell> + </TableRow> + </TableHead> + <TableBody> + {configData?.configFile && ( + <TableRow> + <TableCell + align="left" + component="th" + scope="row" + className={classes.configNameColumn} + > + {translate('about.config.configurationFile')} + </TableCell> + <TableCell align="left" className={classes.envVarColumn}> + ND_CONFIGFILE + </TableCell> + <TableCell align="left">{configData.configFile}</TableCell> + </TableRow> + )} + {regularConfigs.map(({ key, envVar, value }) => ( + <TableRow key={key}> + <TableCell + align="left" + component="th" + scope="row" + className={classes.configNameColumn} + > + {key} + </TableCell> + <TableCell align="left" className={classes.envVarColumn}> + {envVar} + </TableCell> + <TableCell align="left">{String(value)}</TableCell> + </TableRow> + ))} + {devConfigs.length > 0 && ( + <TableRow className={classes.devSectionHeader}> + <TableCell colSpan={3}> + <Typography + variant="subtitle1" + component="div" + className={classes.devFlagsTitle} + > + 🚧 {translate('about.config.devFlagsHeader')} + </Typography> + </TableCell> + </TableRow> + )} + {devConfigs.map(({ key, envVar, value }) => ( + <TableRow key={key}> + <TableCell + align="left" + component="th" + scope="row" + className={classes.configNameColumn} + > + {key} + </TableCell> + <TableCell align="left" className={classes.envVarColumn}> + {envVar} + </TableCell> + <TableCell align="left">{String(value)}</TableCell> + </TableRow> + ))} + </TableBody> + </Table> + </TableContainer> + </div> + ) +} + +const TabContent = ({ + tab, + setTab, + showConfigTab, + uiVersion, + serverVersion, + insightsData, + loading, + permissions, + configData, +}) => { + const translate = useTranslate() + + return ( + <TableContainer component={Paper}> + {showConfigTab && ( + <Tabs value={tab} onChange={(_, value) => setTab(value)}> + <Tab + label={translate('about.tabs.about')} + id="about-tab" + aria-controls="about-panel" + /> + <Tab + label={translate('about.tabs.config')} + id="config-tab" + aria-controls="config-panel" + /> + </Tabs> + )} + <div + id="about-panel" + role="tabpanel" + aria-labelledby="about-tab" + hidden={showConfigTab && tab === 1} + > + <AboutTabContent + uiVersion={uiVersion} + serverVersion={serverVersion} + insightsData={insightsData} + loading={loading} + permissions={permissions} + /> + </div> + {showConfigTab && ( + <div + id="config-panel" + role="tabpanel" + aria-labelledby="config-tab" + hidden={tab === 0} + > + <ConfigTabContent configData={configData} /> + </div> + )} + </TableContainer> + ) +} + +const AboutDialog = ({ open, onClose }) => { + const classes = useStyles() const { permissions } = usePermissions() - const { data, loading } = useGetOne('insights', 'insights_status') + const { data: insightsData, loading } = useGetOne( + 'insights', + 'insights_status', + ) const [serverVersion, setServerVersion] = useState('') + const showConfigTab = permissions === 'admin' && config.devUIShowConfig + const [tab, setTab] = useState(0) + const { data: configData } = useGetOne('config', 'config', { + enabled: showConfigTab, + }) + const expanded = showConfigTab && tab === 1 const uiVersion = config.version useEffect(() => { @@ -108,85 +462,30 @@ const AboutDialog = ({ open, onClose }) => { }) }, [setServerVersion]) - const lastRun = !loading && data?.lastRun - let insightsStatus = 'N/A' - if (lastRun === 'disabled') { - insightsStatus = translate('about.links.insights.disabled') - } else if (lastRun && lastRun?.startsWith('1969-12-31')) { - insightsStatus = translate('about.links.insights.waiting') - } else if (lastRun) { - insightsStatus = lastRun - } - return ( - <Dialog onClose={onClose} aria-labelledby="about-dialog-title" open={open}> + <Dialog + onClose={onClose} + aria-labelledby="about-dialog-title" + open={open} + fullWidth={true} + maxWidth={expanded ? 'lg' : 'sm'} + className={classes.expandableDialog} + > <DialogTitle id="about-dialog-title" onClose={onClose}> Navidrome Music Server </DialogTitle> <DialogContent dividers> - <TableContainer component={Paper}> - <Table aria-label={translate('menu.about')} size="small"> - <TableBody> - <ShowVersion - uiVersion={uiVersion} - serverVersion={serverVersion} - /> - {Object.keys(links).map((key) => { - return ( - <TableRow key={key}> - <TableCell align="right" component="th" scope="row"> - {translate(`about.links.${key}`, { - _: humanize(underscore(key)), - })} - : - </TableCell> - <TableCell align="left"> - <Link - href={`https://${links[key]}`} - target="_blank" - rel="noopener noreferrer" - > - {links[key]} - </Link> - </TableCell> - </TableRow> - ) - })} - {permissions === 'admin' ? ( - <TableRow> - <TableCell align="right" component="th" scope="row"> - {translate(`about.links.lastInsightsCollection`)}: - </TableCell> - <TableCell align="left"> - <Link href={INSIGHTS_DOC_URL}>{insightsStatus}</Link> - </TableCell> - </TableRow> - ) : null} - <TableRow> - <TableCell align="right" component="th" scope="row"> - <Link - href={'https://github.com/sponsors/deluan'} - target="_blank" - rel="noopener noreferrer" - > - <IconButton size={'small'}> - <FavoriteBorderIcon fontSize={'small'} /> - </IconButton> - </Link> - </TableCell> - <TableCell align="left"> - <Link - href={'https://ko-fi.com/deluan'} - target="_blank" - rel="noopener noreferrer" - > - ko-fi.com/deluan - </Link> - </TableCell> - </TableRow> - </TableBody> - </Table> - </TableContainer> + <TabContent + tab={tab} + setTab={setTab} + showConfigTab={showConfigTab} + uiVersion={uiVersion} + serverVersion={serverVersion} + insightsData={insightsData} + loading={loading} + permissions={permissions} + configData={configData} + /> </DialogContent> </Dialog> ) diff --git a/ui/src/dialogs/AddToPlaylistDialog.jsx b/ui/src/dialogs/AddToPlaylistDialog.jsx index d1f80a432..91521d1ce 100644 --- a/ui/src/dialogs/AddToPlaylistDialog.jsx +++ b/ui/src/dialogs/AddToPlaylistDialog.jsx @@ -12,6 +12,7 @@ import { DialogActions, DialogContent, DialogTitle, + makeStyles, } from '@material-ui/core' import { closeAddToPlaylist, @@ -23,7 +24,21 @@ import DuplicateSongDialog from './DuplicateSongDialog' import { httpClient } from '../dataProvider' import { REST_URL } from '../consts' +const useStyles = makeStyles({ + dialogPaper: { + height: '26em', + maxHeight: '26em', + }, + dialogContent: { + height: '17.5em', + overflowY: 'auto', + paddingTop: '0.5em', + paddingBottom: '0.5em', + }, +}) + export const AddToPlaylistDialog = () => { + const classes = useStyles() const { open, selectedIds, onSuccess, duplicateSong, duplicateIds } = useSelector((state) => state.addToPlaylistDialog) const dispatch = useDispatch() @@ -145,11 +160,14 @@ export const AddToPlaylistDialog = () => { aria-labelledby="form-dialog-new-playlist" fullWidth={true} maxWidth={'sm'} + classes={{ + paper: classes.dialogPaper, + }} > <DialogTitle id="form-dialog-new-playlist"> {translate('resources.playlist.actions.selectPlaylist')} </DialogTitle> - <DialogContent> + <DialogContent className={classes.dialogContent}> <SelectPlaylistInput onChange={handleChange} /> </DialogContent> <DialogActions> diff --git a/ui/src/dialogs/AddToPlaylistDialog.test.jsx b/ui/src/dialogs/AddToPlaylistDialog.test.jsx index a019ee03c..60d3cca0d 100644 --- a/ui/src/dialogs/AddToPlaylistDialog.test.jsx +++ b/ui/src/dialogs/AddToPlaylistDialog.test.jsx @@ -88,12 +88,18 @@ describe('AddToPlaylistDialog', () => { createTestUtils(mockDataProvider) + // Filter to see sample playlists let textBox = screen.getByRole('textbox') fireEvent.change(textBox, { target: { value: 'sample' } }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'Enter' }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'Enter' }) + + // Click on first playlist + const firstPlaylist = screen.getByText('sample playlist 1') + fireEvent.click(firstPlaylist) + + // Click on second playlist + const secondPlaylist = screen.getByText('sample playlist 2') + fireEvent.click(secondPlaylist) + await waitFor(() => { expect(screen.getByTestId('playlist-add')).not.toBeDisabled() }) @@ -133,12 +139,11 @@ describe('AddToPlaylistDialog', () => { createTestUtils(mockDataProvider) + // Type a new playlist name and press Enter to create it let textBox = screen.getByRole('textbox') fireEvent.change(textBox, { target: { value: 'sample' } }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) fireEvent.keyDown(textBox, { key: 'Enter' }) + await waitFor(() => { expect(screen.getByTestId('playlist-add')).not.toBeDisabled() }) @@ -171,14 +176,15 @@ describe('AddToPlaylistDialog', () => { createTestUtils(mockDataProvider) + // Create first playlist let textBox = screen.getByRole('textbox') fireEvent.change(textBox, { target: { value: 'sample' } }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) fireEvent.keyDown(textBox, { key: 'Enter' }) + + // Create second playlist fireEvent.change(textBox, { target: { value: 'new playlist' } }) fireEvent.keyDown(textBox, { key: 'Enter' }) + await waitFor(() => { expect(screen.getByTestId('playlist-add')).not.toBeDisabled() }) diff --git a/ui/src/dialogs/SaveQueueDialog.jsx b/ui/src/dialogs/SaveQueueDialog.jsx index 69f07dab7..f916a0793 100644 --- a/ui/src/dialogs/SaveQueueDialog.jsx +++ b/ui/src/dialogs/SaveQueueDialog.jsx @@ -57,7 +57,10 @@ export const SaveQueueDialog = () => { return res }) .then((res) => { - notify('ra.notification.created', 'info', { smart_count: 1 }) + notify('ra.notification.created', { + type: 'info', + messageArgs: { smart_count: 1 }, + }) dispatch(closeSaveQueueDialog()) refresh() history.push(`/playlist/${res.data.id}/show`) diff --git a/ui/src/dialogs/SelectPlaylistInput.jsx b/ui/src/dialogs/SelectPlaylistInput.jsx index 372d5f408..847107523 100644 --- a/ui/src/dialogs/SelectPlaylistInput.jsx +++ b/ui/src/dialogs/SelectPlaylistInput.jsx @@ -1,26 +1,265 @@ -import React from 'react' +import React, { useState } from 'react' import TextField from '@material-ui/core/TextField' import Checkbox from '@material-ui/core/Checkbox' import CheckBoxIcon from '@material-ui/icons/CheckBox' import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank' -import Autocomplete, { - createFilterOptions, -} from '@material-ui/lab/Autocomplete' +import { + List, + ListItem, + ListItemIcon, + ListItemText, + Typography, + Box, + InputAdornment, + IconButton, +} from '@material-ui/core' +import AddIcon from '@material-ui/icons/Add' import { useGetList, useTranslate } from 'react-admin' import PropTypes from 'prop-types' import { isWritable } from '../common' import { makeStyles } from '@material-ui/core' -const filter = createFilterOptions() +const useStyles = makeStyles((theme) => ({ + root: { + width: '100%', + height: '100%', + display: 'flex', + flexDirection: 'column', + }, + searchField: { + marginBottom: theme.spacing(2), + width: '100%', + flexShrink: 0, + }, + playlistList: { + flex: 1, + minHeight: 0, + overflow: 'auto', + border: `1px solid ${theme.palette.divider}`, + borderRadius: theme.shape.borderRadius, + backgroundColor: theme.palette.background.paper, + }, + listItem: { + paddingTop: 0, + paddingBottom: 0, + }, + createIcon: { + fontSize: '1.25rem', + margin: '9px', + }, + selectedPlaylistsContainer: { + marginTop: theme.spacing(2), + flexShrink: 0, + maxHeight: '30%', + overflow: 'auto', + }, + selectedPlaylist: { + display: 'inline-flex', + alignItems: 'center', + margin: theme.spacing(0.5), + padding: theme.spacing(0.5, 1), + backgroundColor: theme.palette.primary.main, + color: theme.palette.primary.contrastText, + borderRadius: theme.shape.borderRadius, + fontSize: '0.875rem', + }, + removeButton: { + marginLeft: theme.spacing(0.5), + padding: 2, + color: 'inherit', + }, + emptyMessage: { + padding: theme.spacing(2), + textAlign: 'center', + color: theme.palette.text.secondary, + }, +})) -const useStyles = makeStyles({ - root: { width: '100%' }, - checkbox: { marginRight: 8 }, -}) +const PlaylistSearchField = ({ + searchText, + onSearchChange, + onCreateNew, + onKeyDown, + canCreateNew, +}) => { + const classes = useStyles() + const translate = useTranslate() + + return ( + <TextField + autoFocus + variant="outlined" + className={classes.searchField} + label={translate('resources.playlist.fields.name')} + value={searchText} + onChange={(e) => onSearchChange(e.target.value)} + onKeyDown={onKeyDown} + placeholder={translate('resources.playlist.actions.searchOrCreate')} + InputProps={{ + endAdornment: canCreateNew && ( + <InputAdornment position="end"> + <IconButton + onClick={onCreateNew} + size="small" + title={translate('resources.playlist.actions.addNewPlaylist', { + name: searchText, + })} + > + <AddIcon /> + </IconButton> + </InputAdornment> + ), + }} + /> + ) +} + +const EmptyPlaylistMessage = ({ searchText, canCreateNew }) => { + const classes = useStyles() + const translate = useTranslate() + + return ( + <div className={classes.emptyMessage}> + <Typography variant="body2"> + {searchText + ? translate('resources.playlist.message.noPlaylistsFound') + : translate('resources.playlist.message.noPlaylists')} + </Typography> + {canCreateNew && ( + <Typography variant="body2" color="primary"> + {translate('resources.playlist.actions.pressEnterToCreate')} + </Typography> + )} + </div> + ) +} + +const PlaylistListItem = ({ playlist, isSelected, onToggle }) => { + const classes = useStyles() + + return ( + <ListItem + className={classes.listItem} + button + onClick={() => onToggle(playlist)} + dense + > + <ListItemIcon> + <Checkbox + icon={<CheckBoxOutlineBlankIcon fontSize="small" />} + checkedIcon={<CheckBoxIcon fontSize="small" />} + checked={isSelected} + tabIndex={-1} + disableRipple + /> + </ListItemIcon> + <ListItemText primary={playlist.name} /> + </ListItem> + ) +} + +const CreatePlaylistItem = ({ searchText, onCreateNew }) => { + const classes = useStyles() + const translate = useTranslate() + + return ( + <ListItem className={classes.listItem} button onClick={onCreateNew} dense> + <ListItemIcon> + <AddIcon className={classes.createIcon} /> + </ListItemIcon> + <ListItemText + primary={translate('resources.playlist.actions.addNewPlaylist', { + name: searchText, + })} + /> + </ListItem> + ) +} + +const PlaylistList = ({ + filteredOptions, + selectedPlaylists, + onPlaylistToggle, + searchText, + canCreateNew, + onCreateNew, +}) => { + const classes = useStyles() + + const isPlaylistSelected = (playlist) => + selectedPlaylists.some((p) => p.id === playlist.id) + + return ( + <List className={classes.playlistList}> + {filteredOptions.length === 0 ? ( + <EmptyPlaylistMessage + searchText={searchText} + canCreateNew={canCreateNew} + /> + ) : ( + filteredOptions.map((playlist) => ( + <PlaylistListItem + key={playlist.id} + playlist={playlist} + isSelected={isPlaylistSelected(playlist)} + onToggle={onPlaylistToggle} + /> + )) + )} + {canCreateNew && filteredOptions.length > 0 && ( + <CreatePlaylistItem searchText={searchText} onCreateNew={onCreateNew} /> + )} + </List> + ) +} + +const SelectedPlaylistChip = ({ playlist, onRemove }) => { + const classes = useStyles() + const translate = useTranslate() + + return ( + <span className={classes.selectedPlaylist}> + {playlist.name} + <IconButton + className={classes.removeButton} + size="small" + onClick={() => onRemove(playlist)} + title={translate('resources.playlist.actions.removeFromSelection')} + > + {'×'} + </IconButton> + </span> + ) +} + +const SelectedPlaylistsDisplay = ({ selectedPlaylists, onRemoveSelected }) => { + const classes = useStyles() + const translate = useTranslate() + + if (selectedPlaylists.length === 0) { + return null + } + + return ( + <Box className={classes.selectedPlaylistsContainer}> + <Box> + {selectedPlaylists.map((playlist, index) => ( + <SelectedPlaylistChip + key={playlist.id || `new-${index}`} + playlist={playlist} + onRemove={onRemoveSelected} + /> + ))} + </Box> + </Box> + ) +} export const SelectPlaylistInput = ({ onChange }) => { const classes = useStyles() - const translate = useTranslate() + const [searchText, setSearchText] = useState('') + const [selectedPlaylists, setSelectedPlaylists] = useState([]) + const { ids, data } = useGetList( 'playlist', { page: 1, perPage: -1 }, @@ -32,92 +271,130 @@ export const SelectPlaylistInput = ({ onChange }) => { ids && ids.map((id) => data[id]).filter((option) => isWritable(option.ownerId)) - const handleOnChange = (event, newValue) => { - let newState = [] - if (newValue && newValue.length) { - newValue.forEach((playlistObject) => { - if (playlistObject.inputValue) { - newState.push({ - name: playlistObject.inputValue, - }) - } else if (typeof playlistObject === 'string') { - newState.push({ - name: playlistObject, - }) - } else { - newState.push(playlistObject) - } - }) + // Filter playlists based on search text + const filteredOptions = + options?.filter((option) => + option.name.toLowerCase().includes(searchText.toLowerCase()), + ) || [] + + const handlePlaylistToggle = (playlist) => { + const isSelected = selectedPlaylists.some((p) => p.id === playlist.id) + let newSelection + + if (isSelected) { + newSelection = selectedPlaylists.filter((p) => p.id !== playlist.id) + } else { + newSelection = [...selectedPlaylists, playlist] } - onChange(newState) + + setSelectedPlaylists(newSelection) + onChange(newSelection) } - const icon = <CheckBoxOutlineBlankIcon fontSize="small" /> - const checkedIcon = <CheckBoxIcon fontSize="small" /> + const handleRemoveSelected = (playlistToRemove) => { + const newSelection = selectedPlaylists.filter( + (p) => p.id !== playlistToRemove.id, + ) + setSelectedPlaylists(newSelection) + onChange(newSelection) + } + + const handleCreateNew = () => { + if (searchText.trim()) { + const newPlaylist = { name: searchText.trim() } + const newSelection = [...selectedPlaylists, newPlaylist] + setSelectedPlaylists(newSelection) + onChange(newSelection) + setSearchText('') + } + } + + const handleKeyDown = (e) => { + if (e.key === 'Enter' && searchText.trim()) { + e.preventDefault() + handleCreateNew() + } + } + + const canCreateNew = Boolean( + searchText.trim() && + !filteredOptions.some( + (option) => option.name.toLowerCase() === searchText.toLowerCase().trim(), + ) && + !selectedPlaylists.some((p) => p.name === searchText.trim()), + ) return ( - <Autocomplete - multiple - disableCloseOnSelect - onChange={handleOnChange} - filterOptions={(options, params) => { - const filtered = filter(options, params) + <div className={classes.root}> + <PlaylistSearchField + searchText={searchText} + onSearchChange={setSearchText} + onCreateNew={handleCreateNew} + onKeyDown={handleKeyDown} + canCreateNew={canCreateNew} + /> - // Suggest the creation of a new value - if (params.inputValue !== '') { - filtered.push({ - inputValue: params.inputValue, - name: translate('resources.playlist.actions.addNewPlaylist', { - name: params.inputValue, - }), - }) - } + <PlaylistList + filteredOptions={filteredOptions} + selectedPlaylists={selectedPlaylists} + onPlaylistToggle={handlePlaylistToggle} + searchText={searchText} + canCreateNew={canCreateNew} + onCreateNew={handleCreateNew} + /> - return filtered - }} - clearOnBlur - handleHomeEndKeys - openOnFocus - selectOnFocus - id="select-playlist-input" - options={options} - getOptionLabel={(option) => { - // Value selected with enter, right from the input - if (typeof option === 'string') { - return option - } - // Add "xxx" option created dynamically - if (option.inputValue) { - return option.inputValue - } - // Regular option - return option.name - }} - renderOption={(option, { selected }) => ( - <React.Fragment> - <Checkbox - icon={icon} - checkedIcon={checkedIcon} - className={classes.checkbox} - checked={selected} - /> - {option.name} - </React.Fragment> - )} - className={classes.root} - freeSolo - renderInput={(params) => ( - <TextField - autoFocus - variant={'outlined'} - {...params} - label={translate('resources.playlist.fields.name')} - /> - )} - /> + <SelectedPlaylistsDisplay + selectedPlaylists={selectedPlaylists} + onRemoveSelected={handleRemoveSelected} + /> + </div> ) } SelectPlaylistInput.propTypes = { onChange: PropTypes.func.isRequired, } + +// PropTypes for sub-components +PlaylistSearchField.propTypes = { + searchText: PropTypes.string.isRequired, + onSearchChange: PropTypes.func.isRequired, + onCreateNew: PropTypes.func.isRequired, + onKeyDown: PropTypes.func.isRequired, + canCreateNew: PropTypes.bool.isRequired, +} + +EmptyPlaylistMessage.propTypes = { + searchText: PropTypes.string.isRequired, + canCreateNew: PropTypes.bool.isRequired, +} + +PlaylistListItem.propTypes = { + playlist: PropTypes.object.isRequired, + isSelected: PropTypes.bool.isRequired, + onToggle: PropTypes.func.isRequired, +} + +CreatePlaylistItem.propTypes = { + searchText: PropTypes.string.isRequired, + onCreateNew: PropTypes.func.isRequired, +} + +PlaylistList.propTypes = { + filteredOptions: PropTypes.array.isRequired, + selectedPlaylists: PropTypes.array.isRequired, + onPlaylistToggle: PropTypes.func.isRequired, + searchText: PropTypes.string.isRequired, + canCreateNew: PropTypes.bool.isRequired, + onCreateNew: PropTypes.func.isRequired, +} + +SelectedPlaylistChip.propTypes = { + playlist: PropTypes.object.isRequired, + onRemove: PropTypes.func.isRequired, +} + +SelectedPlaylistsDisplay.propTypes = { + selectedPlaylists: PropTypes.array.isRequired, + onRemoveSelected: PropTypes.func.isRequired, +} diff --git a/ui/src/dialogs/SelectPlaylistInput.test.jsx b/ui/src/dialogs/SelectPlaylistInput.test.jsx index 727126965..4ffcdf0b6 100644 --- a/ui/src/dialogs/SelectPlaylistInput.test.jsx +++ b/ui/src/dialogs/SelectPlaylistInput.test.jsx @@ -11,115 +11,479 @@ import { import { SelectPlaylistInput } from './SelectPlaylistInput' import { describe, beforeAll, afterEach, it, expect, vi } from 'vitest' -describe('SelectPlaylistInput', () => { - beforeAll(() => localStorage.setItem('userId', 'admin')) - afterEach(cleanup) - const onChangeHandler = vi.fn() +const mockPlaylists = [ + { id: 'playlist-1', name: 'Rock Classics', ownerId: 'admin' }, + { id: 'playlist-2', name: 'Jazz Collection', ownerId: 'admin' }, + { id: 'playlist-3', name: 'Electronic Beats', ownerId: 'admin' }, + { id: 'playlist-4', name: 'Chill Vibes', ownerId: 'user2' }, // Not writable by admin +] - it('should call the handler with the selections', async () => { - const mockData = [ - { id: 'sample-id1', name: 'sample playlist 1', ownerId: 'admin' }, - { id: 'sample-id2', name: 'sample playlist 2', ownerId: 'admin' }, - ] - const mockIndexedData = { - 'sample-id1': { - id: 'sample-id1', - name: 'sample playlist 1', - ownerId: 'admin', - }, - 'sample-id2': { - id: 'sample-id2', - name: 'sample playlist 2', - ownerId: 'admin', - }, - } +const mockIndexedData = { + 'playlist-1': { id: 'playlist-1', name: 'Rock Classics', ownerId: 'admin' }, + 'playlist-2': { id: 'playlist-2', name: 'Jazz Collection', ownerId: 'admin' }, + 'playlist-3': { + id: 'playlist-3', + name: 'Electronic Beats', + ownerId: 'admin', + }, + 'playlist-4': { id: 'playlist-4', name: 'Chill Vibes', ownerId: 'user2' }, +} - const mockDataProvider = { - getList: vi - .fn() - .mockResolvedValue({ data: mockData, total: mockData.length }), - } +const createTestComponent = ( + mockDataProvider = null, + onChangeMock = vi.fn(), + playlists = mockPlaylists, + indexedData = mockIndexedData, +) => { + const dataProvider = mockDataProvider || { + getList: vi.fn().mockResolvedValue({ + data: playlists, + total: playlists.length, + }), + } - render( - <DataProviderContext.Provider value={mockDataProvider}> - <TestContext - initialState={{ - addToPlaylistDialog: { open: true, duplicateSong: false }, - admin: { - ui: { optimistic: false }, - resources: { - playlist: { - data: mockIndexedData, - list: { - cachedRequests: { - '{"pagination":{"page":1,"perPage":-1},"sort":{"field":"name","order":"ASC"},"filter":{"smart":false}}': - { - ids: ['sample-id1', 'sample-id2'], - total: 2, - }, - }, + return render( + <DataProviderContext.Provider value={dataProvider}> + <TestContext + initialState={{ + admin: { + ui: { optimistic: false }, + resources: { + playlist: { + data: indexedData, + list: { + cachedRequests: { + '{"pagination":{"page":1,"perPage":-1},"sort":{"field":"name","order":"ASC"},"filter":{"smart":false}}': + { + ids: Object.keys(indexedData), + total: Object.keys(indexedData).length, + }, }, }, }, }, - }} - > - <SelectPlaylistInput onChange={onChangeHandler} /> - </TestContext> - </DataProviderContext.Provider>, - ) + }, + }} + > + <SelectPlaylistInput onChange={onChangeMock} /> + </TestContext> + </DataProviderContext.Provider>, + ) +} - await waitFor(() => { - expect(mockDataProvider.getList).toHaveBeenCalledWith('playlist', { - filter: { smart: false }, - pagination: { page: 1, perPage: -1 }, - sort: { field: 'name', order: 'ASC' }, +describe('SelectPlaylistInput', () => { + beforeAll(() => localStorage.setItem('userId', 'admin')) + afterEach(cleanup) + + describe('Basic Functionality', () => { + it('should render search field and playlist list', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + expect(screen.getByText('Jazz Collection')).toBeInTheDocument() + expect(screen.getByText('Electronic Beats')).toBeInTheDocument() + }) + + // Should not show playlists not owned by admin (not writable) + expect(screen.queryByText('Chill Vibes')).not.toBeInTheDocument() + }) + + it('should filter playlists based on search input', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'rock' } }) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + expect(screen.queryByText('Jazz Collection')).not.toBeInTheDocument() + expect(screen.queryByText('Electronic Beats')).not.toBeInTheDocument() }) }) - let textBox = screen.getByRole('textbox') - fireEvent.change(textBox, { target: { value: 'sample' } }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'Enter' }) - await waitFor(() => { - expect(onChangeHandler).toHaveBeenCalledWith([ - { id: 'sample-id1', name: 'sample playlist 1', ownerId: 'admin' }, - ]) + it('should handle case-insensitive search', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Jazz Collection')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'JAZZ' } }) + + await waitFor(() => { + expect(screen.getByText('Jazz Collection')).toBeInTheDocument() + expect(screen.queryByText('Rock Classics')).not.toBeInTheDocument() + }) + }) + }) + + describe('Playlist Selection', () => { + it('should select and deselect playlists by clicking', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + }) + + // Select first playlist + const rockPlaylist = screen.getByText('Rock Classics') + fireEvent.click(rockPlaylist) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([ + { id: 'playlist-1', name: 'Rock Classics', ownerId: 'admin' }, + ]) + }) + + // Select second playlist + const jazzPlaylist = screen.getByText('Jazz Collection') + fireEvent.click(jazzPlaylist) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([ + { id: 'playlist-1', name: 'Rock Classics', ownerId: 'admin' }, + { id: 'playlist-2', name: 'Jazz Collection', ownerId: 'admin' }, + ]) + }) + + // Deselect first playlist + fireEvent.click(rockPlaylist) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([ + { id: 'playlist-2', name: 'Jazz Collection', ownerId: 'admin' }, + ]) + }) }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'Enter' }) - await waitFor(() => { - expect(onChangeHandler).toHaveBeenCalledWith([ - { id: 'sample-id1', name: 'sample playlist 1', ownerId: 'admin' }, - { id: 'sample-id2', name: 'sample playlist 2', ownerId: 'admin' }, - ]) + it('should show selected playlists as chips', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + }) + + // Select a playlist + const rockPlaylist = screen.getByText('Rock Classics') + fireEvent.click(rockPlaylist) + + await waitFor(() => { + // Should show the selected playlist as a chip + const chips = screen.getAllByText('Rock Classics') + expect(chips.length).toBeGreaterThan(1) // One in list, one in chip + }) }) - fireEvent.change(textBox, { - target: { value: 'new playlist' }, + it('should remove selected playlists via chip remove button', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + }) + + // Select a playlist + const rockPlaylist = screen.getByText('Rock Classics') + fireEvent.click(rockPlaylist) + + await waitFor(() => { + // Should show selected playlist as chip + const chips = screen.getAllByText('Rock Classics') + expect(chips.length).toBeGreaterThan(1) + }) + + // Find and click the remove button (translation key) + const removeButton = screen.getByText('×') + fireEvent.click(removeButton) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([]) + // Should only have one instance (in the list) after removal + const remainingChips = screen.getAllByText('Rock Classics') + expect(remainingChips.length).toBe(1) + }) }) - fireEvent.keyDown(textBox, { key: 'ArrowDown' }) - fireEvent.keyDown(textBox, { key: 'Enter' }) - await waitFor(() => { - expect(onChangeHandler).toHaveBeenCalledWith([ - { id: 'sample-id1', name: 'sample playlist 1', ownerId: 'admin' }, - { id: 'sample-id2', name: 'sample playlist 2', ownerId: 'admin' }, - { name: 'new playlist' }, - ]) + }) + + describe('Create New Playlist', () => { + it('should create new playlist by pressing Enter', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'My New Playlist' } }) + fireEvent.keyDown(searchInput, { key: 'Enter' }) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([{ name: 'My New Playlist' }]) + }) + + // Input should be cleared after creating + expect(searchInput.value).toBe('') }) - fireEvent.change(textBox, { - target: { value: 'another new playlist' }, + it('should create new playlist by clicking add button', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'Another Playlist' } }) + + // Find the add button by the translation key title + const addButton = screen.getByTitle( + 'resources.playlist.actions.addNewPlaylist', + ) + fireEvent.click(addButton) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([ + { name: 'Another Playlist' }, + ]) + }) }) - fireEvent.keyDown(textBox, { key: 'Enter' }) - await waitFor(() => { - expect(onChangeHandler).toHaveBeenCalledWith([ - { id: 'sample-id1', name: 'sample playlist 1', ownerId: 'admin' }, - { id: 'sample-id2', name: 'sample playlist 2', ownerId: 'admin' }, - { name: 'new playlist' }, - { name: 'another new playlist' }, - ]) + + it('should not show create option for existing playlist names', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'Rock Classics' } }) + + await waitFor(() => { + expect( + screen.queryByText('resources.playlist.actions.addNewPlaylist'), + ).not.toBeInTheDocument() + }) + }) + + it('should not create playlist with empty name', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: ' ' } }) // Only spaces + fireEvent.keyDown(searchInput, { key: 'Enter' }) + + // Should not call onChange + expect(onChangeMock).not.toHaveBeenCalled() + }) + + it('should show create options in appropriate contexts', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + + // When typing a new name, should show create options + fireEvent.change(searchInput, { target: { value: 'My New Playlist' } }) + + await waitFor(() => { + // Should show the add button in the search field + expect( + screen.getByTitle('resources.playlist.actions.addNewPlaylist'), + ).toBeInTheDocument() + // Should also show hint in empty message when no matches + expect( + screen.getByText('resources.playlist.actions.pressEnterToCreate'), + ).toBeInTheDocument() + }) + }) + }) + + describe('Mixed Operations', () => { + it('should handle selecting existing playlists and creating new ones', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + }) + + // Select existing playlist + const rockPlaylist = screen.getByText('Rock Classics') + fireEvent.click(rockPlaylist) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([ + { id: 'playlist-1', name: 'Rock Classics', ownerId: 'admin' }, + ]) + }) + + // Create new playlist + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'New Mix' } }) + fireEvent.keyDown(searchInput, { key: 'Enter' }) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([ + { id: 'playlist-1', name: 'Rock Classics', ownerId: 'admin' }, + { name: 'New Mix' }, + ]) + }) + }) + + it('should maintain selections when searching', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + }) + + // Select a playlist + const rockPlaylist = screen.getByText('Rock Classics') + fireEvent.click(rockPlaylist) + + // Filter the list + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'jazz' } }) + + await waitFor(() => { + // Should still show selected playlists section + // Rock Classics should still be visible as a selected chip even though filtered out + expect(screen.getByText('Rock Classics')).toBeInTheDocument() // In selected chips + expect(screen.getByText('Jazz Collection')).toBeInTheDocument() + }) + }) + }) + + describe('Empty States', () => { + it('should show empty message when no playlists exist', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock, [], {}) + + await waitFor(() => { + expect( + screen.getByText('resources.playlist.message.noPlaylists'), + ).toBeInTheDocument() + }) + }) + + it('should show "no results" message when search returns no matches', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { + target: { value: 'NonExistentPlaylist' }, + }) + + await waitFor(() => { + expect( + screen.getByText('resources.playlist.message.noPlaylistsFound'), + ).toBeInTheDocument() + expect( + screen.getByText('resources.playlist.actions.pressEnterToCreate'), + ).toBeInTheDocument() + }) + }) + }) + + describe('Keyboard Navigation', () => { + it('should not create playlist on Enter if input is empty', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.keyDown(searchInput, { key: 'Enter' }) + + expect(onChangeMock).not.toHaveBeenCalled() + }) + + it('should handle other keys without side effects', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByRole('textbox')).toBeInTheDocument() + }) + + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'test' } }) + fireEvent.keyDown(searchInput, { key: 'ArrowDown' }) + fireEvent.keyDown(searchInput, { key: 'Tab' }) + fireEvent.keyDown(searchInput, { key: 'Escape' }) + + // Should not create playlist or trigger onChange + expect(onChangeMock).not.toHaveBeenCalled() + expect(searchInput.value).toBe('test') + }) + }) + + describe('Integration Scenarios', () => { + it('should handle complex workflow: search, select, create, remove', async () => { + const onChangeMock = vi.fn() + createTestComponent(null, onChangeMock) + + await waitFor(() => { + expect(screen.getByText('Rock Classics')).toBeInTheDocument() + }) + + // Search and select existing playlist + const searchInput = screen.getByRole('textbox') + fireEvent.change(searchInput, { target: { value: 'rock' } }) + + const rockPlaylist = screen.getByText('Rock Classics') + fireEvent.click(rockPlaylist) + + // Clear search and create new playlist + fireEvent.change(searchInput, { target: { value: 'My Custom Mix' } }) + fireEvent.keyDown(searchInput, { key: 'Enter' }) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([ + { id: 'playlist-1', name: 'Rock Classics', ownerId: 'admin' }, + { name: 'My Custom Mix' }, + ]) + }) + + // Remove the first selected playlist via chip + const removeButtons = screen.getAllByText('×') + fireEvent.click(removeButtons[0]) + + await waitFor(() => { + expect(onChangeMock).toHaveBeenCalledWith([{ name: 'My Custom Mix' }]) + }) }) }) }) diff --git a/ui/src/dialogs/aboutUtils.js b/ui/src/dialogs/aboutUtils.js new file mode 100644 index 000000000..7c92692de --- /dev/null +++ b/ui/src/dialogs/aboutUtils.js @@ -0,0 +1,278 @@ +/** + * TOML utility functions for configuration export + */ + +/** + * Flattens nested configuration object and generates environment variable names + * @param {Object} config - The nested configuration object from the backend + * @param {string} prefix - The current prefix for nested keys + * @returns {Array} - Array of config objects with key, envVar, and value properties + */ +export const flattenConfig = (config, prefix = '') => { + const result = [] + + if (!config || typeof config !== 'object') { + return result + } + + Object.keys(config).forEach((key) => { + const value = config[key] + const currentKey = prefix ? `${prefix}.${key}` : key + + if (value && typeof value === 'object' && !Array.isArray(value)) { + // Recursively flatten nested objects + result.push(...flattenConfig(value, currentKey)) + } else { + // Generate environment variable name: ND_ + uppercase with dots replaced by underscores + const envVar = 'ND_' + currentKey.toUpperCase().replace(/\./g, '_') + + // Convert value to string for display + let displayValue = value + if ( + Array.isArray(value) || + (typeof value === 'object' && value !== null) + ) { + displayValue = JSON.stringify(value) + } else { + displayValue = String(value) + } + + result.push({ + key: currentKey, + envVar: envVar, + value: displayValue, + }) + } + }) + + return result +} + +/** + * Separates and sorts configuration entries into regular and dev configs + * @param {Array|Object} configEntries - Array of config objects with key and value, or nested config object + * @returns {Object} - Object with regularConfigs and devConfigs arrays, both sorted + */ +export const separateAndSortConfigs = (configEntries) => { + const regularConfigs = [] + const devConfigs = [] + + // Handle both the old array format and new nested object format + let flattenedConfigs + if (Array.isArray(configEntries)) { + // Old format - already flattened + flattenedConfigs = configEntries + } else { + // New format - need to flatten + flattenedConfigs = flattenConfig(configEntries) + } + + flattenedConfigs?.forEach((config) => { + // Skip configFile as it's displayed separately + if (config.key === 'ConfigFile') { + return + } + + if (config.key.startsWith('Dev')) { + devConfigs.push(config) + } else { + regularConfigs.push(config) + } + }) + + // Sort configurations alphabetically + regularConfigs.sort((a, b) => a.key.localeCompare(b.key)) + devConfigs.sort((a, b) => a.key.localeCompare(b.key)) + + return { regularConfigs, devConfigs } +} + +/** + * Escapes TOML keys that contain special characters + * @param {string} key - The key to potentially escape + * @returns {string} - The escaped key if needed, or the original key + */ +export const escapeTomlKey = (key) => { + // Convert to string first to handle null/undefined + const keyStr = String(key) + + // Empty strings always need quotes + if (keyStr === '') { + return '""' + } + + // TOML bare keys can only contain letters, numbers, underscores, and hyphens + // If the key contains other characters, it needs to be quoted + if (/^[a-zA-Z0-9_-]+$/.test(keyStr)) { + return keyStr + } + + // Escape quotes in the key and wrap in quotes + return `"${keyStr.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"` +} + +/** + * Converts a value to proper TOML format + * @param {*} value - The value to format + * @returns {string} - The TOML-formatted value + */ +export const formatTomlValue = (value) => { + if (value === null || value === undefined) { + return '""' + } + + const str = String(value) + + // Boolean values + if (str === 'true' || str === 'false') { + return str + } + + // Numbers (integers and floats) + if (/^-?\d+$/.test(str)) { + return str // Integer + } + if (/^-?\d*\.\d+$/.test(str)) { + return str // Float + } + + // Duration values (like "300ms", "1s", "5m") + if (/^\d+(\.\d+)?(ns|us|µs|ms|s|m|h)$/.test(str)) { + return `"${str}"` + } + + // Handle arrays and objects + if (str.startsWith('[') || str.startsWith('{')) { + try { + const parsed = JSON.parse(str) + + // If it's an array, format as TOML array + if (Array.isArray(parsed)) { + const formattedItems = parsed.map((item) => { + if (typeof item === 'string') { + return `"${item.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"` + } else if (typeof item === 'number' || typeof item === 'boolean') { + return String(item) + } else { + return `"${String(item).replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"` + } + }) + + if (formattedItems.length === 0) { + return '[ ]' + } + return `[ ${formattedItems.join(', ')} ]` + } + + // For objects, keep the JSON string format with triple quotes + return `"""${str}"""` + } catch { + return `"${str.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"` + } + } + + // String values (escape backslashes and quotes) + return `"${str.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"` +} + +/** + * Converts nested keys to TOML sections + * @param {Array} configs - Array of config objects with key and value + * @returns {Object} - Object with sections and rootKeys + */ +export const buildTomlSections = (configs) => { + const sections = {} + const rootKeys = [] + + configs.forEach(({ key, value }) => { + if (key.includes('.')) { + const parts = key.split('.') + const sectionName = parts[0] + const keyName = parts.slice(1).join('.') + + if (!sections[sectionName]) { + sections[sectionName] = [] + } + sections[sectionName].push({ key: keyName, value }) + } else { + rootKeys.push({ key, value }) + } + }) + + return { sections, rootKeys } +} + +/** + * Converts configuration data to TOML format + * @param {Object} configData - The configuration data object + * @param {Function} translate - Translation function for internationalization + * @returns {string} - The TOML-formatted configuration + */ +export const configToToml = (configData, translate = (key) => key) => { + let tomlContent = `# Navidrome Configuration\n# Generated on ${new Date().toISOString()}\n\n` + + // Handle both old array format (configData.config is array) and new nested format (configData.config is object) + let configs + if (Array.isArray(configData.config)) { + // Old format - already flattened + configs = configData.config + } else { + // New format - need to flatten + configs = flattenConfig(configData.config) + } + + const { regularConfigs, devConfigs } = separateAndSortConfigs(configs) + + // Process regular configs + const { sections: regularSections, rootKeys: regularRootKeys } = + buildTomlSections(regularConfigs) + + // Add root-level keys first + if (regularRootKeys.length > 0) { + regularRootKeys.forEach(({ key, value }) => { + tomlContent += `${key} = ${formatTomlValue(value)}\n` + }) + tomlContent += '\n' + } + + // Add dev configs if any + if (devConfigs.length > 0) { + tomlContent += `# ${translate('about.config.devFlagsHeader')}\n` + tomlContent += `# ${translate('about.config.devFlagsComment')}\n\n` + + const { sections: devSections, rootKeys: devRootKeys } = + buildTomlSections(devConfigs) + + // Add dev root-level keys + devRootKeys.forEach(({ key, value }) => { + tomlContent += `${key} = ${formatTomlValue(value)}\n` + }) + if (devRootKeys.length > 0) { + tomlContent += '\n' + } + + // Add dev sections + Object.keys(devSections) + .sort() + .forEach((sectionName) => { + tomlContent += `[${sectionName}]\n` + devSections[sectionName].forEach(({ key, value }) => { + tomlContent += `${escapeTomlKey(key)} = ${formatTomlValue(value)}\n` + }) + tomlContent += '\n' + }) + } + + // Add sections + Object.keys(regularSections) + .sort() + .forEach((sectionName) => { + tomlContent += `[${sectionName}]\n` + regularSections[sectionName].forEach(({ key, value }) => { + tomlContent += `${escapeTomlKey(key)} = ${formatTomlValue(value)}\n` + }) + tomlContent += '\n' + }) + + return tomlContent +} diff --git a/ui/src/dialogs/aboutUtils.test.js b/ui/src/dialogs/aboutUtils.test.js new file mode 100644 index 000000000..4632c5aed --- /dev/null +++ b/ui/src/dialogs/aboutUtils.test.js @@ -0,0 +1,737 @@ +import { describe, it, expect } from 'vitest' +import { + formatTomlValue, + buildTomlSections, + configToToml, + separateAndSortConfigs, + flattenConfig, + escapeTomlKey, +} from './aboutUtils' + +describe('formatTomlValue', () => { + it('handles null and undefined values', () => { + expect(formatTomlValue(null)).toBe('""') + expect(formatTomlValue(undefined)).toBe('""') + }) + + it('handles boolean values', () => { + expect(formatTomlValue('true')).toBe('true') + expect(formatTomlValue('false')).toBe('false') + expect(formatTomlValue(true)).toBe('true') + expect(formatTomlValue(false)).toBe('false') + }) + + it('handles integer values', () => { + expect(formatTomlValue('123')).toBe('123') + expect(formatTomlValue('-456')).toBe('-456') + expect(formatTomlValue('0')).toBe('0') + expect(formatTomlValue(789)).toBe('789') + }) + + it('handles float values', () => { + expect(formatTomlValue('123.45')).toBe('123.45') + expect(formatTomlValue('-67.89')).toBe('-67.89') + expect(formatTomlValue('0.0')).toBe('0.0') + expect(formatTomlValue(12.34)).toBe('12.34') + }) + + it('handles duration values', () => { + expect(formatTomlValue('300ms')).toBe('"300ms"') + expect(formatTomlValue('5s')).toBe('"5s"') + expect(formatTomlValue('10m')).toBe('"10m"') + expect(formatTomlValue('2h')).toBe('"2h"') + expect(formatTomlValue('1.5s')).toBe('"1.5s"') + }) + + it('handles JSON arrays and objects', () => { + expect(formatTomlValue('["item1", "item2"]')).toBe('[ "item1", "item2" ]') + expect(formatTomlValue('{"key": "value"}')).toBe('"""{"key": "value"}"""') + }) + + it('formats different types of arrays correctly', () => { + // String array + expect(formatTomlValue('["genre", "tcon", "©gen"]')).toBe( + '[ "genre", "tcon", "©gen" ]', + ) + // Mixed array with numbers and strings + expect(formatTomlValue('[42, "test", true]')).toBe('[ 42, "test", true ]') + // Empty array + expect(formatTomlValue('[]')).toBe('[ ]') + // Array with special characters in strings + expect( + formatTomlValue('["item with spaces", "item\\"with\\"quotes"]'), + ).toBe('[ "item with spaces", "item\\"with\\"quotes" ]') + }) + + it('handles invalid JSON as regular strings', () => { + expect(formatTomlValue('[invalid json')).toBe('"[invalid json"') + expect(formatTomlValue('{broken')).toBe('"{broken"') + }) + + it('handles regular strings with quote escaping', () => { + expect(formatTomlValue('simple string')).toBe('"simple string"') + expect(formatTomlValue('string with "quotes"')).toBe( + '"string with \\"quotes\\""', + ) + expect(formatTomlValue('/path/to/file')).toBe('"/path/to/file"') + }) + + it('handles strings with backslashes and quotes', () => { + expect(formatTomlValue('C:\\Program Files\\app')).toBe( + '"C:\\\\Program Files\\\\app"', + ) + expect(formatTomlValue('path\\to"file')).toBe('"path\\\\to\\"file"') + expect(formatTomlValue('backslash\\ and "quote"')).toBe( + '"backslash\\\\ and \\"quote\\""', + ) + expect(formatTomlValue('single\\backslash')).toBe('"single\\\\backslash"') + }) + + it('handles empty strings', () => { + expect(formatTomlValue('')).toBe('""') + }) +}) + +describe('buildTomlSections', () => { + it('separates root keys from nested keys', () => { + const configs = [ + { key: 'RootKey1', value: 'value1' }, + { key: 'Section.NestedKey', value: 'value2' }, + { key: 'RootKey2', value: 'value3' }, + { key: 'Section.AnotherKey', value: 'value4' }, + { key: 'AnotherSection.Key', value: 'value5' }, + ] + + const result = buildTomlSections(configs) + + expect(result.rootKeys).toEqual([ + { key: 'RootKey1', value: 'value1' }, + { key: 'RootKey2', value: 'value3' }, + ]) + + expect(result.sections).toEqual({ + Section: [ + { key: 'NestedKey', value: 'value2' }, + { key: 'AnotherKey', value: 'value4' }, + ], + AnotherSection: [{ key: 'Key', value: 'value5' }], + }) + }) + + it('handles deeply nested keys', () => { + const configs = [{ key: 'Section.SubSection.DeepKey', value: 'deepValue' }] + + const result = buildTomlSections(configs) + + expect(result.rootKeys).toEqual([]) + expect(result.sections).toEqual({ + Section: [{ key: 'SubSection.DeepKey', value: 'deepValue' }], + }) + }) + + it('handles empty input', () => { + const result = buildTomlSections([]) + + expect(result.rootKeys).toEqual([]) + expect(result.sections).toEqual({}) + }) +}) + +describe('configToToml', () => { + const mockTranslate = (key) => { + const translations = { + 'about.config.devFlagsHeader': + 'Development Flags (subject to change/removal)', + 'about.config.devFlagsComment': + 'These are experimental settings and may be removed in future versions', + } + return translations[key] || key + } + + it('generates TOML with header and timestamp', () => { + const configData = { + config: [{ key: 'TestKey', value: 'testValue' }], + } + + const result = configToToml(configData, mockTranslate) + + expect(result).toContain('# Navidrome Configuration') + expect(result).toContain('# Generated on') + expect(result).toContain('TestKey = "testValue"') + }) + + it('separates and sorts regular and dev configs', () => { + const configData = { + config: [ + { key: 'ZRegularKey', value: 'regularValue' }, + { key: 'DevTestFlag', value: 'true' }, + { key: 'ARegularKey', value: 'anotherValue' }, + { key: 'DevAnotherFlag', value: 'false' }, + ], + } + + const result = configToToml(configData, mockTranslate) + + // Check that regular configs come first and are sorted + const lines = result.split('\n') + const aRegularIndex = lines.findIndex((line) => + line.includes('ARegularKey'), + ) + const zRegularIndex = lines.findIndex((line) => + line.includes('ZRegularKey'), + ) + const devHeaderIndex = lines.findIndex((line) => + line.includes('Development Flags'), + ) + const devAnotherIndex = lines.findIndex((line) => + line.includes('DevAnotherFlag'), + ) + const devTestIndex = lines.findIndex((line) => line.includes('DevTestFlag')) + + expect(aRegularIndex).toBeLessThan(zRegularIndex) + expect(zRegularIndex).toBeLessThan(devHeaderIndex) + expect(devHeaderIndex).toBeLessThan(devAnotherIndex) + expect(devAnotherIndex).toBeLessThan(devTestIndex) + }) + + it('skips ConfigFile entries', () => { + const configData = { + config: [ + { key: 'ConfigFile', value: '/path/to/config.toml' }, + { key: 'TestKey', value: 'testValue' }, + ], + } + + const result = configToToml(configData, mockTranslate) + + expect(result).not.toContain('ConfigFile =') + expect(result).toContain('TestKey = "testValue"') + }) + + it('handles sections correctly', () => { + const configData = { + config: [ + { key: 'RootKey', value: 'rootValue' }, + { key: 'Section.NestedKey', value: 'nestedValue' }, + { key: 'Section.AnotherKey', value: 'anotherValue' }, + { key: 'DevA', value: 'DevValue' }, + ], + } + + const result = configToToml(configData, mockTranslate) + // Fields in a section are sorted alphabetically + const fields = [ + 'RootKey = "rootValue"', + 'DevA = "DevValue"', + '[Section]', + 'AnotherKey = "anotherValue"', + 'NestedKey = "nestedValue"', + ] + + for (let idx = 0; idx < fields.length - 1; idx++) { + expect(result).toContain(fields[idx]) + + const idxA = result.indexOf(fields[idx]) + const idxB = result.indexOf(fields[idx + 1]) + + expect(idxA).toBeLessThan(idxB) + } + + expect(result).toContain(fields[fields.length - 1]) + }) + + it('includes dev flags header when dev configs exist', () => { + const configData = { + config: [ + { key: 'RegularKey', value: 'regularValue' }, + { key: 'DevTestFlag', value: 'true' }, + ], + } + + const result = configToToml(configData, mockTranslate) + + expect(result).toContain('# Development Flags (subject to change/removal)') + expect(result).toContain( + '# These are experimental settings and may be removed in future versions', + ) + expect(result).toContain('DevTestFlag = true') + }) + + it('does not include dev flags header when no dev configs exist', () => { + const configData = { + config: [{ key: 'RegularKey', value: 'regularValue' }], + } + + const result = configToToml(configData, mockTranslate) + + expect(result).not.toContain('Development Flags') + expect(result).toContain('RegularKey = "regularValue"') + }) + + it('handles empty config data', () => { + const configData = { config: [] } + + const result = configToToml(configData, mockTranslate) + + expect(result).toContain('# Navidrome Configuration') + expect(result).not.toContain('Development Flags') + }) + + it('handles missing config array', () => { + const configData = {} + + const result = configToToml(configData, mockTranslate) + + expect(result).toContain('# Navidrome Configuration') + expect(result).not.toContain('Development Flags') + }) + + it('works without translate function', () => { + const configData = { + config: [{ key: 'DevTestFlag', value: 'true' }], + } + + const result = configToToml(configData) + + expect(result).toContain('# about.config.devFlagsHeader') + expect(result).toContain('# about.config.devFlagsComment') + expect(result).toContain('DevTestFlag = true') + }) + + it('handles various data types correctly', () => { + const configData = { + config: [ + { key: 'StringValue', value: 'test string' }, + { key: 'BooleanValue', value: 'true' }, + { key: 'IntegerValue', value: '42' }, + { key: 'FloatValue', value: '3.14' }, + { key: 'DurationValue', value: '5s' }, + { key: 'ArrayValue', value: '["item1", "item2"]' }, + ], + } + + const result = configToToml(configData, mockTranslate) + + expect(result).toContain('StringValue = "test string"') + expect(result).toContain('BooleanValue = true') + expect(result).toContain('IntegerValue = 42') + expect(result).toContain('FloatValue = 3.14') + expect(result).toContain('DurationValue = "5s"') + expect(result).toContain('ArrayValue = [ "item1", "item2" ]') + }) + + it('handles nested config object format correctly', () => { + const configData = { + config: { + Address: '127.0.0.1', + Port: 4533, + EnableDownloads: true, + DevLogSourceLine: false, + LastFM: { + Enabled: true, + ApiKey: 'secret123', + Language: 'en', + }, + Scanner: { + Schedule: 'daily', + Enabled: true, + }, + }, + } + + const result = configToToml(configData, mockTranslate) + + // Should contain regular configs + expect(result).toContain('Address = "127.0.0.1"') + expect(result).toContain('Port = 4533') + expect(result).toContain('EnableDownloads = true') + + // Should contain dev configs with header + expect(result).toContain('# Development Flags (subject to change/removal)') + expect(result).toContain('DevLogSourceLine = false') + + // Should contain sections + expect(result).toContain('[LastFM]') + expect(result).toContain('Enabled = true') + expect(result).toContain('ApiKey = "secret123"') + expect(result).toContain('Language = "en"') + + expect(result).toContain('[Scanner]') + expect(result).toContain('Schedule = "daily"') + }) + + it('handles mixed nested and flat structure', () => { + const configData = { + config: { + MusicFolder: '/music', + DevAutoLoginUsername: 'testuser', + Jukebox: { + Enabled: false, + AdminOnly: true, + }, + }, + } + + const result = configToToml(configData, mockTranslate) + + expect(result).toContain('MusicFolder = "/music"') + expect(result).toContain('DevAutoLoginUsername = "testuser"') + expect(result).toContain('[Jukebox]') + expect(result).toContain('Enabled = false') + expect(result).toContain('AdminOnly = true') + }) + + it('properly escapes keys with special characters in sections', () => { + const configData = { + config: [ + { key: 'DevLogLevels.persistence/sql_base_repository', value: 'trace' }, + { key: 'DevLogLevels.core/scanner', value: 'debug' }, + { key: 'DevLogLevels.regular_key', value: 'info' }, + { key: 'Tags.genre.Aliases', value: '["tcon","genre","©gen"]' }, + ], + } + + const result = configToToml(configData, mockTranslate) + + // Keys with forward slashes should be quoted + expect(result).toContain('"persistence/sql_base_repository" = "trace"') + expect(result).toContain('"core/scanner" = "debug"') + + // Regular keys should not be quoted + expect(result).toContain('regular_key = "info"') + + // Arrays should be formatted correctly + expect(result).toContain('"genre.Aliases" = [ "tcon", "genre", "©gen" ]') + + // Should contain proper sections + expect(result).toContain('[DevLogLevels]') + expect(result).toContain('[Tags]') + }) +}) + +describe('flattenConfig', () => { + it('flattens simple nested objects correctly', () => { + const config = { + Address: '0.0.0.0', + Port: 4533, + EnableDownloads: true, + LastFM: { + Enabled: true, + ApiKey: 'secret123', + Language: 'en', + }, + } + + const result = flattenConfig(config) + + expect(result).toContainEqual({ + key: 'Address', + envVar: 'ND_ADDRESS', + value: '0.0.0.0', + }) + + expect(result).toContainEqual({ + key: 'Port', + envVar: 'ND_PORT', + value: '4533', + }) + + expect(result).toContainEqual({ + key: 'EnableDownloads', + envVar: 'ND_ENABLEDOWNLOADS', + value: 'true', + }) + + expect(result).toContainEqual({ + key: 'LastFM.Enabled', + envVar: 'ND_LASTFM_ENABLED', + value: 'true', + }) + + expect(result).toContainEqual({ + key: 'LastFM.ApiKey', + envVar: 'ND_LASTFM_APIKEY', + value: 'secret123', + }) + + expect(result).toContainEqual({ + key: 'LastFM.Language', + envVar: 'ND_LASTFM_LANGUAGE', + value: 'en', + }) + }) + + it('handles deeply nested objects', () => { + const config = { + Scanner: { + Schedule: 'daily', + Options: { + ExtractorType: 'taglib', + ArtworkPriority: 'cover.jpg', + }, + }, + } + + const result = flattenConfig(config) + + expect(result).toContainEqual({ + key: 'Scanner.Schedule', + envVar: 'ND_SCANNER_SCHEDULE', + value: 'daily', + }) + + expect(result).toContainEqual({ + key: 'Scanner.Options.ExtractorType', + envVar: 'ND_SCANNER_OPTIONS_EXTRACTORTYPE', + value: 'taglib', + }) + + expect(result).toContainEqual({ + key: 'Scanner.Options.ArtworkPriority', + envVar: 'ND_SCANNER_OPTIONS_ARTWORKPRIORITY', + value: 'cover.jpg', + }) + }) + + it('handles arrays correctly', () => { + const config = { + DeviceList: ['device1', 'device2'], + Settings: { + EnabledFormats: ['mp3', 'flac', 'ogg'], + }, + } + + const result = flattenConfig(config) + + expect(result).toContainEqual({ + key: 'DeviceList', + envVar: 'ND_DEVICELIST', + value: '["device1","device2"]', + }) + + expect(result).toContainEqual({ + key: 'Settings.EnabledFormats', + envVar: 'ND_SETTINGS_ENABLEDFORMATS', + value: '["mp3","flac","ogg"]', + }) + }) + + it('handles null and undefined values', () => { + const config = { + NullValue: null, + UndefinedValue: undefined, + EmptyString: '', + ZeroValue: 0, + } + + const result = flattenConfig(config) + + expect(result).toContainEqual({ + key: 'NullValue', + envVar: 'ND_NULLVALUE', + value: 'null', + }) + + expect(result).toContainEqual({ + key: 'UndefinedValue', + envVar: 'ND_UNDEFINEDVALUE', + value: 'undefined', + }) + + expect(result).toContainEqual({ + key: 'EmptyString', + envVar: 'ND_EMPTYSTRING', + value: '', + }) + + expect(result).toContainEqual({ + key: 'ZeroValue', + envVar: 'ND_ZEROVALUE', + value: '0', + }) + }) + + it('handles empty object', () => { + const result = flattenConfig({}) + expect(result).toEqual([]) + }) + + it('handles null/undefined input', () => { + expect(flattenConfig(null)).toEqual([]) + expect(flattenConfig(undefined)).toEqual([]) + }) + + it('handles non-object input', () => { + expect(flattenConfig('string')).toEqual([]) + expect(flattenConfig(123)).toEqual([]) + expect(flattenConfig(true)).toEqual([]) + }) +}) + +describe('separateAndSortConfigs', () => { + it('separates regular and dev configs correctly with array input', () => { + const configs = [ + { key: 'RegularKey1', value: 'value1' }, + { key: 'DevTestFlag', value: 'true' }, + { key: 'AnotherRegular', value: 'value2' }, + { key: 'DevAnotherFlag', value: 'false' }, + ] + + const result = separateAndSortConfigs(configs) + + expect(result.regularConfigs).toEqual([ + { key: 'AnotherRegular', value: 'value2' }, + { key: 'RegularKey1', value: 'value1' }, + ]) + + expect(result.devConfigs).toEqual([ + { key: 'DevAnotherFlag', value: 'false' }, + { key: 'DevTestFlag', value: 'true' }, + ]) + }) + + it('separates regular and dev configs correctly with nested object input', () => { + const config = { + Address: '127.0.0.1', + Port: 4533, + DevAutoLoginUsername: 'testuser', + DevLogSourceLine: true, + LastFM: { + Enabled: true, + ApiKey: 'secret123', + }, + } + + const result = separateAndSortConfigs(config) + + expect(result.regularConfigs).toEqual([ + { key: 'Address', envVar: 'ND_ADDRESS', value: '127.0.0.1' }, + { key: 'LastFM.ApiKey', envVar: 'ND_LASTFM_APIKEY', value: 'secret123' }, + { key: 'LastFM.Enabled', envVar: 'ND_LASTFM_ENABLED', value: 'true' }, + { key: 'Port', envVar: 'ND_PORT', value: '4533' }, + ]) + + expect(result.devConfigs).toEqual([ + { + key: 'DevAutoLoginUsername', + envVar: 'ND_DEVAUTOLOGINUSERNAME', + value: 'testuser', + }, + { key: 'DevLogSourceLine', envVar: 'ND_DEVLOGSOURCELINE', value: 'true' }, + ]) + }) + + it('skips ConfigFile entries', () => { + const configs = [ + { key: 'ConfigFile', value: '/path/to/config.toml' }, + { key: 'RegularKey', value: 'value' }, + { key: 'DevFlag', value: 'true' }, + ] + + const result = separateAndSortConfigs(configs) + + expect(result.regularConfigs).toEqual([ + { key: 'RegularKey', value: 'value' }, + ]) + expect(result.devConfigs).toEqual([{ key: 'DevFlag', value: 'true' }]) + }) + + it('skips ConfigFile entries with nested object input', () => { + const config = { + ConfigFile: '/path/to/config.toml', + RegularKey: 'value', + DevFlag: true, + } + + const result = separateAndSortConfigs(config) + + expect(result.regularConfigs).toEqual([ + { key: 'RegularKey', envVar: 'ND_REGULARKEY', value: 'value' }, + ]) + expect(result.devConfigs).toEqual([ + { key: 'DevFlag', envVar: 'ND_DEVFLAG', value: 'true' }, + ]) + }) + + it('handles empty input', () => { + const result = separateAndSortConfigs([]) + + expect(result.regularConfigs).toEqual([]) + expect(result.devConfigs).toEqual([]) + }) + + it('handles null/undefined input', () => { + const result1 = separateAndSortConfigs(null) + const result2 = separateAndSortConfigs(undefined) + + expect(result1.regularConfigs).toEqual([]) + expect(result1.devConfigs).toEqual([]) + expect(result2.regularConfigs).toEqual([]) + expect(result2.devConfigs).toEqual([]) + }) + + it('sorts configs alphabetically', () => { + const configs = [ + { key: 'ZRegular', value: 'z' }, + { key: 'ARegular', value: 'a' }, + { key: 'DevZ', value: 'z' }, + { key: 'DevA', value: 'a' }, + ] + + const result = separateAndSortConfigs(configs) + + expect(result.regularConfigs[0].key).toBe('ARegular') + expect(result.regularConfigs[1].key).toBe('ZRegular') + expect(result.devConfigs[0].key).toBe('DevA') + expect(result.devConfigs[1].key).toBe('DevZ') + }) +}) + +describe('escapeTomlKey', () => { + it('does not escape valid bare keys', () => { + expect(escapeTomlKey('RegularKey')).toBe('RegularKey') + expect(escapeTomlKey('regular_key')).toBe('regular_key') + expect(escapeTomlKey('regular-key')).toBe('regular-key') + expect(escapeTomlKey('key123')).toBe('key123') + expect(escapeTomlKey('Key_with_underscores')).toBe('Key_with_underscores') + expect(escapeTomlKey('Key-with-hyphens')).toBe('Key-with-hyphens') + }) + + it('escapes keys with special characters', () => { + // Keys with forward slashes (like DevLogLevels keys) + expect(escapeTomlKey('persistence/sql_base_repository')).toBe( + '"persistence/sql_base_repository"', + ) + expect(escapeTomlKey('core/scanner')).toBe('"core/scanner"') + + // Keys with dots + expect(escapeTomlKey('Section.NestedKey')).toBe('"Section.NestedKey"') + + // Keys with spaces + expect(escapeTomlKey('key with spaces')).toBe('"key with spaces"') + + // Keys with other special characters + expect(escapeTomlKey('key@with@symbols')).toBe('"key@with@symbols"') + expect(escapeTomlKey('key+with+plus')).toBe('"key+with+plus"') + }) + + it('escapes quotes in keys', () => { + expect(escapeTomlKey('key"with"quotes')).toBe('"key\\"with\\"quotes"') + expect(escapeTomlKey('key with "quotes" inside')).toBe( + '"key with \\"quotes\\" inside"', + ) + }) + + it('escapes backslashes in keys', () => { + expect(escapeTomlKey('key\\with\\backslashes')).toBe( + '"key\\\\with\\\\backslashes"', + ) + expect(escapeTomlKey('path\\to\\file')).toBe('"path\\\\to\\\\file"') + }) + + it('handles empty and null keys', () => { + expect(escapeTomlKey('')).toBe('""') + expect(escapeTomlKey(null)).toBe('null') + expect(escapeTomlKey(undefined)).toBe('undefined') + }) +}) diff --git a/ui/src/eventStream.js b/ui/src/eventStream.js index 34463e19c..c91dae875 100644 --- a/ui/src/eventStream.js +++ b/ui/src/eventStream.js @@ -1,7 +1,8 @@ import { baseUrl } from './utils' import throttle from 'lodash.throttle' -import { processEvent, serverDown } from './actions' +import { processEvent, serverDown, streamReconnected } from './actions' import { REST_URL } from './consts' +import config from './config' const newEventStream = async () => { let url = baseUrl(`${REST_URL}/events`) @@ -11,6 +12,51 @@ const newEventStream = async () => { return new EventSource(url) } +let eventStream +let reconnectTimer +const RECONNECT_DELAY = 5000 + +const setupHandlers = (stream, dispatchFn) => { + stream.addEventListener('serverStart', eventHandler(dispatchFn)) + stream.addEventListener('scanStatus', throttledEventHandler(dispatchFn)) + stream.addEventListener('refreshResource', eventHandler(dispatchFn)) + if (config.enableNowPlaying) { + stream.addEventListener('nowPlayingCount', eventHandler(dispatchFn)) + } + stream.addEventListener('keepAlive', eventHandler(dispatchFn)) + stream.onerror = (e) => { + // eslint-disable-next-line no-console + console.log('EventStream error', e) + dispatchFn(serverDown()) + if (stream) stream.close() + scheduleReconnect(dispatchFn) + } +} + +const scheduleReconnect = (dispatchFn) => { + if (!reconnectTimer) { + reconnectTimer = setTimeout(() => { + reconnectTimer = null + connect(dispatchFn) + }, RECONNECT_DELAY) + } +} + +const connect = async (dispatchFn) => { + try { + const stream = await newEventStream() + eventStream = stream + setupHandlers(stream, dispatchFn) + // Dispatch reconnection event to refresh critical data + dispatchFn(streamReconnected()) + return stream + } catch (e) { + // eslint-disable-next-line no-console + console.log(`Error connecting to server:`, e) + scheduleReconnect(dispatchFn) + } +} + const eventHandler = (dispatchFn) => (event) => { const data = JSON.parse(event.data) if (event.type !== 'keepAlive') { @@ -21,10 +67,7 @@ const eventHandler = (dispatchFn) => (event) => { const throttledEventHandler = (dispatchFn) => throttle(eventHandler(dispatchFn), 100, { trailing: true }) -const startEventStream = async (dispatchFn) => { - if (!localStorage.getItem('is-authenticated')) { - return Promise.resolve() - } +const startEventStreamLegacy = async (dispatchFn) => { return newEventStream() .then((newStream) => { newStream.addEventListener('serverStart', eventHandler(dispatchFn)) @@ -33,6 +76,9 @@ const startEventStream = async (dispatchFn) => { throttledEventHandler(dispatchFn), ) newStream.addEventListener('refreshResource', eventHandler(dispatchFn)) + if (config.enableNowPlaying) { + newStream.addEventListener('nowPlayingCount', eventHandler(dispatchFn)) + } newStream.addEventListener('keepAlive', eventHandler(dispatchFn)) newStream.onerror = (e) => { // eslint-disable-next-line no-console @@ -47,4 +93,22 @@ const startEventStream = async (dispatchFn) => { }) } +const startEventStreamNew = async (dispatchFn) => { + if (eventStream) { + eventStream.close() + eventStream = null + } + return connect(dispatchFn) +} + +const startEventStream = async (dispatchFn) => { + if (!localStorage.getItem('is-authenticated')) { + return Promise.resolve() + } + if (config.devNewEventStream) { + return startEventStreamNew(dispatchFn) + } + return startEventStreamLegacy(dispatchFn) +} + export { startEventStream } diff --git a/ui/src/eventStream.test.js b/ui/src/eventStream.test.js new file mode 100644 index 000000000..27f53c872 --- /dev/null +++ b/ui/src/eventStream.test.js @@ -0,0 +1,51 @@ +import { describe, it, beforeEach, vi, expect } from 'vitest' +import { startEventStream } from './eventStream' +import { serverDown } from './actions' +import config from './config' + +class MockEventSource { + constructor(url) { + this.url = url + this.readyState = 1 + this.listeners = {} + this.onerror = null + } + addEventListener(type, handler) { + this.listeners[type] = handler + } + close() { + this.readyState = 2 + } +} + +describe('startEventStream', () => { + vi.useFakeTimers() + let dispatch + let instance + + beforeEach(() => { + dispatch = vi.fn() + global.EventSource = vi.fn().mockImplementation(function (url) { + instance = new MockEventSource(url) + return instance + }) + localStorage.setItem('is-authenticated', 'true') + localStorage.setItem('token', 'abc') + config.devNewEventStream = true + // Mock console.log to suppress output during tests + vi.spyOn(console, 'log').mockImplementation(() => {}) + }) + + afterEach(() => { + config.devNewEventStream = false + }) + + it('reconnects after an error', async () => { + await startEventStream(dispatch) + expect(global.EventSource).toHaveBeenCalledTimes(1) + instance.onerror(new Event('error')) + expect(dispatch).toHaveBeenCalledWith(serverDown()) + vi.advanceTimersByTime(5000) + expect(global.EventSource).toHaveBeenCalledTimes(2) + }) +}) diff --git a/ui/src/i18n/en.json b/ui/src/i18n/en.json index 0695d62c2..74fb23ab9 100644 --- a/ui/src/i18n/en.json +++ b/ui/src/i18n/en.json @@ -10,8 +10,10 @@ "playCount": "Plays", "title": "Title", "artist": "Artist", + "composer": "Composer", "album": "Album", "path": "File path", + "libraryName": "Library", "genre": "Genre", "compilation": "Compilation", "year": "Year", @@ -20,7 +22,10 @@ "bitRate": "Bit rate", "bitDepth": "Bit depth", "sampleRate": "Sample rate", + "albumGain": "Album gain", + "trackGain": "Track gain", "channels": "Channels", + "disc": "Disc %{discNumber}", "discSubtitle": "Disc Subtitle", "starred": "Favourite", "comment": "Comment", @@ -41,10 +46,12 @@ "addToQueue": "Play Later", "playNow": "Play Now", "addToPlaylist": "Add to Playlist", + "showInPlaylist": "Show in Playlist", "shuffleAll": "Shuffle All", "download": "Download", "playNext": "Play Next", - "info": "Get Info" + "info": "Get Info", + "instantMix": "Instant Mix" } }, "album": { @@ -57,6 +64,7 @@ "playCount": "Plays", "size": "Size", "name": "Name", + "libraryName": "Library", "genre": "Genre", "compilation": "Compilation", "year": "Year", @@ -123,7 +131,13 @@ "mixer": "Mixer |||| Mixers", "remixer": "Remixer |||| Remixers", "djmixer": "DJ Mixer |||| DJ Mixers", - "performer": "Performer |||| Performers" + "performer": "Performer |||| Performers", + "maincredit": "Album Artist or Artist |||| Album Artists or Artists" + }, + "actions": { + "topSongs": "Top Songs", + "shuffle": "Shuffle", + "radio": "Radio" } }, "user": { @@ -140,19 +154,26 @@ "changePassword": "Change Password?", "currentPassword": "Current Password", "newPassword": "New Password", - "token": "Token" + "token": "Token", + "libraries": "Libraries" }, "helperTexts": { - "name": "Changes to your name will only be reflected on next login" + "name": "Changes to your name will only be reflected on next login", + "libraries": "Select specific libraries for this user, or leave empty to use default libraries" }, "notifications": { "created": "User created", "updated": "User updated", "deleted": "User deleted" }, + "validation": { + "librariesRequired": "At least one library must be selected for non-admin users" + }, "message": { "listenBrainzToken": "Enter your ListenBrainz user token.", - "clickHereForToken": "Click here to get your token" + "clickHereForToken": "Click here to get your token", + "selectAllLibraries": "Select all libraries", + "adminAutoLibraries": "Admin users automatically have access to all libraries" } }, "player": { @@ -197,11 +218,16 @@ "export": "Export", "saveQueue": "Save Queue to Playlist", "makePublic": "Make Public", - "makePrivate": "Make Private" + "makePrivate": "Make Private", + "searchOrCreate": "Search playlists or type to create new...", + "pressEnterToCreate": "Press Enter to create new playlist", + "removeFromSelection": "Remove from selection" }, "message": { "duplicate_song": "Add duplicated songs", - "song_exist": "There are duplicates being added to the playlist. Would you like to add the duplicates or skip them?" + "song_exist": "There are duplicates being added to the playlist. Would you like to add the duplicates or skip them?", + "noPlaylistsFound": "No playlists found", + "noPlaylists": "No playlists available" } }, "radio": { @@ -242,6 +268,7 @@ "fields": { "path": "Path", "size": "Size", + "libraryName": "Library", "updatedAt": "Disappeared on" }, "actions": { @@ -251,6 +278,139 @@ "notifications": { "removed": "Missing file(s) removed" } + }, + "library": { + "name": "Library |||| Libraries", + "fields": { + "name": "Name", + "path": "Path", + "remotePath": "Remote Path", + "lastScanAt": "Last Scan", + "songCount": "Songs", + "albumCount": "Albums", + "artistCount": "Artists", + "totalSongs": "Songs", + "totalAlbums": "Albums", + "totalArtists": "Artists", + "totalFolders": "Folders", + "totalFiles": "Files", + "totalMissingFiles": "Missing Files", + "totalSize": "Total Size", + "totalDuration": "Duration", + "defaultNewUsers": "Default for New Users", + "createdAt": "Created", + "updatedAt": "Updated" + }, + "sections": { + "basic": "Basic Information", + "statistics": "Statistics" + }, + "actions": { + "scan": "Scan Library", + "quickScan": "Quick Scan", + "fullScan": "Full Scan", + "manageUsers": "Manage User Access", + "viewDetails": "View Details" + }, + "notifications": { + "created": "Library created successfully", + "updated": "Library updated successfully", + "deleted": "Library deleted successfully", + "scanStarted": "Library scan started", + "quickScanStarted": "Quick scan started", + "fullScanStarted": "Full scan started", + "scanError": "Error starting scan. Check logs", + "scanCompleted": "Library scan completed" + }, + "validation": { + "nameRequired": "Library name is required", + "pathRequired": "Library path is required", + "pathNotDirectory": "Library path must be a directory", + "pathNotFound": "Library path not found", + "pathNotAccessible": "Library path is not accessible", + "pathInvalid": "Invalid library path" + }, + "messages": { + "deleteConfirm": "Are you sure you want to delete this library? This will remove all associated data and user access.", + "scanInProgress": "Scan in progress...", + "noLibrariesAssigned": "No libraries assigned to this user" + } + }, + "plugin": { + "name": "Plugin |||| Plugins", + "fields": { + "id": "ID", + "name": "Name", + "description": "Description", + "version": "Version", + "author": "Author", + "website": "Website", + "permissions": "Permissions", + "enabled": "Enabled", + "status": "Status", + "path": "Path", + "lastError": "Error", + "hasError": "Error", + "updatedAt": "Updated", + "createdAt": "Installed", + "configKey": "Key", + "configValue": "Value", + "allUsers": "Allow all users", + "selectedUsers": "Selected users", + "allLibraries": "Allow all libraries", + "selectedLibraries": "Selected libraries", + "allowWriteAccess": "Allow write access" + }, + "sections": { + "status": "Status", + "info": "Plugin Information", + "configuration": "Configuration", + "manifest": "Manifest", + "usersPermission": "Users Permission", + "libraryPermission": "Library Permission" + }, + "status": { + "enabled": "Enabled", + "disabled": "Disabled" + }, + "actions": { + "enable": "Enable", + "disable": "Disable", + "disabledDueToError": "Fix the error before enabling", + "disabledUsersRequired": "Select users before enabling", + "disabledLibrariesRequired": "Select libraries before enabling", + "addConfig": "Add Configuration", + "rescan": "Rescan" + }, + "notifications": { + "enabled": "Plugin enabled", + "disabled": "Plugin disabled", + "updated": "Plugin updated", + "error": "Error updating plugin" + }, + "validation": { + "invalidJson": "Configuration must be valid JSON" + }, + "messages": { + "configHelp": "Configure the plugin using key-value pairs. Leave empty if the plugin requires no configuration.", + "configValidationError": "Configuration validation failed:", + "schemaRenderError": "Unable to render configuration form. The plugin's schema may be invalid.", + "clickPermissions": "Click a permission for details", + "noConfig": "No configuration set", + "allUsersHelp": "When enabled, the plugin will have access to all users, including those created in the future.", + "noUsers": "No users selected", + "permissionReason": "Reason", + "usersRequired": "This plugin requires access to user information. Select which users the plugin can access, or enable 'Allow all users'.", + "allLibrariesHelp": "When enabled, the plugin will have access to all libraries, including those created in the future.", + "noLibraries": "No libraries selected", + "librariesRequired": "This plugin requires access to library information. Select which libraries the plugin can access, or enable 'Allow all libraries'.", + "allowWriteAccessHelp": "When enabled, the plugin can modify files in the library directories. By default, plugins have read-only access.", + "requiredHosts": "Required hosts" + }, + "placeholders": { + "configKey": "key", + "configValue": "value" + } } }, "ra": { @@ -399,10 +559,19 @@ } }, "message": { + "uploadCover": "Upload Cover", + "removeCover": "Remove Cover", + "coverUploaded": "Cover art updated", + "coverRemoved": "Cover art removed", + "coverUploadError": "Error uploading cover art", + "coverRemoveError": "Error removing cover art", "note": "NOTE", "transcodingDisabled": "Changing the transcoding configuration through the web interface is disabled for security reasons. If you would like to change (edit or add) transcoding options, restart the server with the %{config} configuration option.", "transcodingEnabled": "Navidrome is currently running with %{config}, making it possible to run system commands from the transcoding settings using the web interface. We recommend to disable it for security reasons and only enable it when configuring Transcoding options.", "songsAddedToPlaylist": "Added 1 song to playlist |||| Added %{smart_count} songs to playlist", + "noSimilarSongsFound": "No similar songs found", + "startingInstantMix": "Loading Instant Mix...", + "noTopSongsFound": "No top songs found", "noPlaylistsAvailable": "None available", "delete_user_title": "Delete user '%{name}'", "delete_user_content": "Are you sure you want to delete this user and all their data (including playlists and preferences)?", @@ -436,6 +605,12 @@ }, "menu": { "library": "Library", + "librarySelector": { + "allLibraries": "All Libraries (%{count})", + "multipleLibraries": "%{selected} of %{total} Libraries", + "selectLibraries": "Select Libraries", + "none": "None" + }, "settings": "Settings", "version": "Version", "theme": "Theme", @@ -498,19 +673,41 @@ "disabled": "Disabled", "waiting": "Waiting" } + }, + "tabs": { + "about": "About", + "config": "Configuration" + }, + "config": { + "configName": "Config Name", + "environmentVariable": "Environment Variable", + "currentValue": "Current Value", + "configurationFile": "Configuration File", + "exportToml": "Export Configuration (TOML)", + "downloadToml": "Download Configuration (TOML)", + "exportSuccess": "Configuration exported to clipboard in TOML format", + "exportFailed": "Failed to copy configuration", + "devFlagsHeader": "Development Flags (subject to change/removal)", + "devFlagsComment": "These are experimental settings and may be removed in future versions" } }, "activity": { "title": "Activity", "totalScanned": "Total Folders Scanned", - "quickScan": "Quick Scan", - "fullScan": "Full Scan", + "quickScan": "Quick", + "fullScan": "Full", + "selectiveScan": "Selective", "serverUptime": "Server Uptime", "serverDown": "OFFLINE", - "scanType": "Type", + "scanType": "Last Scan", "status": "Scan Error", "elapsedTime": "Elapsed Time" }, + "nowPlaying": { + "title": "Now Playing", + "empty": "Nothing playing", + "minutesAgo": "%{smart_count} minute ago |||| %{smart_count} minutes ago" + }, "help": { "title": "Navidrome Hotkeys", "hotkeys": { diff --git a/ui/src/layout/ActivityPanel.jsx b/ui/src/layout/ActivityPanel.jsx index 6b50cee0c..085911ed7 100644 --- a/ui/src/layout/ActivityPanel.jsx +++ b/ui/src/layout/ActivityPanel.jsx @@ -15,7 +15,7 @@ import { Typography, } from '@material-ui/core' import { FiActivity } from 'react-icons/fi' -import { BiError } from 'react-icons/bi' +import { BiError, BiMessageError } from 'react-icons/bi' import { VscSync } from 'react-icons/vsc' import { GiMagnifyingGlass } from 'react-icons/gi' import subsonic from '../subsonic' @@ -28,7 +28,12 @@ import config from '../config' const useStyles = makeStyles((theme) => ({ wrapper: { position: 'relative', - color: (props) => (props.up ? null : 'orange'), + color: (props) => + props.serverDown + ? theme.palette.error.main + : props.hasWarning + ? theme.palette.warning.main + : null, }, progress: { color: theme.palette.primary.light, @@ -75,15 +80,23 @@ const ActivityPanel = () => { scanStatus.scanning, scanStatus.elapsedTime, ) - const classes = useStyles({ up: up && !scanStatus.error }) + // Determine icon state: error (server down), warning (scan error), or normal + const serverDown = !up + const hasWarning = Boolean(scanStatus.error) + const classes = useStyles({ serverDown, hasWarning }) const translate = useTranslate() const notify = useNotify() const [anchorEl, setAnchorEl] = useState(null) const open = Boolean(anchorEl) useInitialScanStatus() - const handleMenuOpen = (event) => setAnchorEl(event.currentTarget) - const handleMenuClose = () => setAnchorEl(null) + const handleMenuOpen = (event) => { + setAnchorEl(event.currentTarget) + } + + const handleMenuClose = () => { + setAnchorEl(null) + } const triggerScan = (full) => () => subsonic.startScan({ fullScan: full }) useEffect(() => { @@ -102,6 +115,9 @@ const ActivityPanel = () => { return translate('activity.fullScan') case 'quick': return translate('activity.quickScan') + case 'full-selective': + case 'quick-selective': + return translate('activity.selectiveScan') default: return '' } @@ -111,10 +127,12 @@ const ActivityPanel = () => { <div className={classes.wrapper}> <Tooltip title={tooltipTitle}> <IconButton className={classes.button} onClick={handleMenuOpen}> - {!up || scanStatus.error ? ( - <BiError size={'20'} /> + {serverDown ? ( + <BiError data-testid="activity-error-icon" size={'20'} /> + ) : hasWarning ? ( + <BiMessageError data-testid="activity-warning-icon" size={'20'} /> ) : ( - <FiActivity size={'20'} /> + <FiActivity data-testid="activity-ok-icon" size={'20'} /> )} </IconButton> </Tooltip> @@ -141,7 +159,11 @@ const ActivityPanel = () => { <Box component="span" flex={2}> {translate('activity.serverUptime')}: </Box> - <Box component="span" flex={1}> + <Box + component="span" + flex={1} + className={!up ? classes.error : null} + > {up ? <Uptime /> : translate('activity.serverDown')} </Box> </Box> diff --git a/ui/src/layout/ActivityPanel.test.jsx b/ui/src/layout/ActivityPanel.test.jsx new file mode 100644 index 000000000..3a951df5d --- /dev/null +++ b/ui/src/layout/ActivityPanel.test.jsx @@ -0,0 +1,89 @@ +import React from 'react' +import { render, screen, fireEvent } from '@testing-library/react' +import { Provider } from 'react-redux' +import { createStore, combineReducers } from 'redux' +import { describe, it, beforeEach } from 'vitest' + +import ActivityPanel from './ActivityPanel' +import { activityReducer } from '../reducers' +import config from '../config' +import subsonic from '../subsonic' + +vi.mock('../subsonic', () => ({ + default: { + getScanStatus: vi.fn(() => + Promise.resolve({ + json: { + 'subsonic-response': { + status: 'ok', + scanStatus: { error: 'Scan failed' }, + }, + }, + }), + ), + startScan: vi.fn(), + }, +})) + +describe('<ActivityPanel />', () => { + let store + + beforeEach(() => { + store = createStore(combineReducers({ activity: activityReducer }), { + activity: { + scanStatus: { + scanning: false, + folderCount: 0, + count: 0, + error: 'Scan failed', + elapsedTime: 0, + }, + serverStart: { version: config.version, startTime: Date.now() }, + }, + }) + }) + + it('shows warning icon when server reports a scan error', () => { + render( + <Provider store={store}> + <ActivityPanel /> + </Provider>, + ) + + // Warning icon should be visible when there's a scan error + expect(screen.getByTestId('activity-warning-icon')).toBeInTheDocument() + + // Open the panel - warning icon should still be visible + const button = screen.getByRole('button') + fireEvent.click(button) + expect(screen.getByTestId('activity-warning-icon')).toBeInTheDocument() + expect(screen.getByText('Scan failed')).toBeInTheDocument() + }) + + it('shows error icon when server is down', () => { + const downStore = createStore( + combineReducers({ activity: activityReducer }), + { + activity: { + scanStatus: { + scanning: false, + folderCount: 0, + count: 0, + error: '', + elapsedTime: 0, + }, + serverStart: { version: config.version, startTime: null }, // null startTime = server down + }, + }, + ) + + render( + <Provider store={downStore}> + <ActivityPanel /> + </Provider>, + ) + + // Error icon should be visible when server is down + expect(screen.getByTestId('activity-error-icon')).toBeInTheDocument() + }) +}) diff --git a/ui/src/layout/AppBar.jsx b/ui/src/layout/AppBar.jsx index a8c36cd14..561701dce 100644 --- a/ui/src/layout/AppBar.jsx +++ b/ui/src/layout/AppBar.jsx @@ -14,6 +14,7 @@ import { Dialogs } from '../dialogs/Dialogs' import { AboutDialog } from '../dialogs' import PersonalMenu from './PersonalMenu' import ActivityPanel from './ActivityPanel' +import NowPlayingPanel from './NowPlayingPanel' import UserMenu from './UserMenu' import config from '../config' @@ -49,7 +50,7 @@ const AboutMenuItem = forwardRef(({ onClick, ...rest }, ref) => { <> <MenuItem ref={ref} onClick={handleOpen} className={classes.root}> <ListItemIcon className={classes.icon}> - <MdInfo titleAccess={label} size={24} /> + <MdInfo title={label} size={24} /> </ListItemIcon> {label} </MenuItem> @@ -119,6 +120,9 @@ const CustomUserMenu = ({ onClick, ...rest }) => { return ( <> + {config.devActivityPanel && + permissions === 'admin' && + config.enableNowPlaying && <NowPlayingPanel />} {config.devActivityPanel && permissions === 'admin' && <ActivityPanel />} <UserMenu {...rest}> <PersonalMenu sidebarIsOpen={true} onClick={onClick} /> diff --git a/ui/src/layout/AppBar.test.jsx b/ui/src/layout/AppBar.test.jsx new file mode 100644 index 000000000..f39dd75cb --- /dev/null +++ b/ui/src/layout/AppBar.test.jsx @@ -0,0 +1,65 @@ +import React from 'react' +import { render, screen } from '@testing-library/react' +import { describe, it, beforeEach, vi } from 'vitest' +import { Provider } from 'react-redux' +import { createStore, combineReducers } from 'redux' +import { activityReducer } from '../reducers' +import AppBar from './AppBar' +import config from '../config' + +let store + +vi.mock('react-admin', () => ({ + AppBar: ({ userMenu }) => <div data-testid="appbar">{userMenu}</div>, + useTranslate: () => (x) => x, + usePermissions: () => ({ permissions: 'admin' }), + getResources: () => [], +})) + +vi.mock('./NowPlayingPanel', () => ({ + default: () => <div data-testid="now-playing-panel" />, +})) +vi.mock('./ActivityPanel', () => ({ + default: () => <div data-testid="activity-panel" />, +})) +vi.mock('./PersonalMenu', () => ({ + default: () => <div />, +})) +vi.mock('./UserMenu', () => ({ + default: ({ children }) => <div>{children}</div>, +})) +vi.mock('../dialogs/Dialogs', () => ({ + Dialogs: () => <div />, +})) +vi.mock('../dialogs', () => ({ + AboutDialog: () => <div />, +})) + +describe('<AppBar />', () => { + beforeEach(() => { + config.devActivityPanel = true + config.enableNowPlaying = true + store = createStore(combineReducers({ activity: activityReducer }), { + activity: { nowPlayingCount: 0 }, + }) + }) + + it('renders NowPlayingPanel when enabled', () => { + render( + <Provider store={store}> + <AppBar /> + </Provider>, + ) + expect(screen.getByTestId('now-playing-panel')).toBeInTheDocument() + }) + + it('hides NowPlayingPanel when disabled', () => { + config.enableNowPlaying = false + render( + <Provider store={store}> + <AppBar /> + </Provider>, + ) + expect(screen.queryByTestId('now-playing-panel')).toBeNull() + }) +}) diff --git a/ui/src/layout/Layout.jsx b/ui/src/layout/Layout.jsx index e3f13d25f..44cf9b42c 100644 --- a/ui/src/layout/Layout.jsx +++ b/ui/src/layout/Layout.jsx @@ -7,6 +7,7 @@ import Menu from './Menu' import AppBar from './AppBar' import Notification from './Notification' import useCurrentTheme from '../themes/useCurrentTheme' +import { useSearchRefocus } from '../common' const useStyles = makeStyles({ root: { paddingBottom: (props) => (props.addPadding ? '80px' : 0) }, @@ -17,6 +18,7 @@ const Layout = (props) => { const queue = useSelector((state) => state.player?.queue) const classes = useStyles({ addPadding: queue.length > 0 }) const dispatch = useDispatch() + useSearchRefocus() const keyHandlers = { TOGGLE_MENU: useCallback(() => dispatch(toggleSidebar()), [dispatch]), diff --git a/ui/src/layout/Login.jsx b/ui/src/layout/Login.jsx index 7b1c752bf..a7763cff3 100644 --- a/ui/src/layout/Login.jsx +++ b/ui/src/layout/Login.jsx @@ -98,8 +98,13 @@ const renderInput = ({ }) => ( <TextField error={!!(touched && error)} + inputProps={{ + // mobile keyboards: suppress capitalization and correction for login related fields + autocapitalize: 'none', + autocorrect: 'off', + ...inputProps, + }} helperText={touched && error} - {...inputProps} {...props} fullWidth /> @@ -133,6 +138,8 @@ const FormLogin = ({ loading, handleSubmit, validate }) => { {config.welcomeMessage && ( <div className={classes.welcome} + // Use dangerouslySetInnerHTML to allow admins to configure + // whatever content they want dangerouslySetInnerHTML={{ __html: config.welcomeMessage }} /> )} diff --git a/ui/src/layout/Menu.jsx b/ui/src/layout/Menu.jsx index bd1e37ee0..45f40b26d 100644 --- a/ui/src/layout/Menu.jsx +++ b/ui/src/layout/Menu.jsx @@ -9,6 +9,7 @@ import SubMenu from './SubMenu' import { humanize, pluralize } from 'inflection' import albumLists from '../album/albumLists' import PlaylistsSubMenu from './PlaylistsSubMenu' +import LibrarySelector from '../common/LibrarySelector' import config from '../config' const useStyles = makeStyles((theme) => ({ @@ -111,6 +112,7 @@ const Menu = ({ dense = false }) => { [classes.closed]: !open, })} > + {open && <LibrarySelector />} <SubMenu handleToggle={() => handleToggle('menuAlbumList')} isOpen={state.menuAlbumList} diff --git a/ui/src/layout/NowPlayingPanel.jsx b/ui/src/layout/NowPlayingPanel.jsx new file mode 100644 index 000000000..509263b42 --- /dev/null +++ b/ui/src/layout/NowPlayingPanel.jsx @@ -0,0 +1,491 @@ +import React, { useState, useEffect, useCallback, useRef } from 'react' +import PropTypes from 'prop-types' +import { useSelector, useDispatch } from 'react-redux' +import { useTranslate, Link, useNotify } from 'react-admin' +import { + Popover, + IconButton, + makeStyles, + Tooltip, + List, + ListItem, + Avatar, + Badge, + Card, + CardContent, + Typography, + LinearProgress, + useTheme, + useMediaQuery, +} from '@material-ui/core' +import { FaRegCirclePlay, FaPause } from 'react-icons/fa6' +import subsonic from '../subsonic' +import { useInterval } from '../common' +import { nowPlayingCountSync } from '../actions' +import { formatDuration } from '../utils' +import config from '../config' + +const useStyles = makeStyles((theme) => ({ + button: { color: 'inherit' }, + list: { + width: '26em', + maxHeight: (props) => { + const entryHeight = 120 + const maxEntries = Math.min(props.entryCount || 0, 3) + return maxEntries > 0 ? `${maxEntries * entryHeight}px` : '12em' + }, + overflowY: 'auto', + padding: 0, + }, + card: { + padding: 0, + }, + cardContent: { + padding: `${theme.spacing(1)}px !important`, + '&:last-child': { + paddingBottom: `${theme.spacing(1)}px !important`, + }, + }, + listItem: { + display: 'flex', + alignItems: 'flex-start', + gap: theme.spacing(1.5), + padding: theme.spacing(1), + }, + avatarContainer: { + position: 'relative', + flexShrink: 0, + width: theme.spacing(8), + height: theme.spacing(8), + }, + avatar: { + width: '100%', + height: '100%', + cursor: 'pointer', + borderRadius: theme.spacing(0.5), + '&:hover': { + opacity: 0.8, + }, + }, + stateOverlay: { + position: 'absolute', + top: 0, + left: 0, + width: '100%', + height: '100%', + display: 'flex', + alignItems: 'center', + justifyContent: 'center', + backgroundColor: 'rgba(0, 0, 0, 0.45)', + borderRadius: theme.spacing(0.5), + pointerEvents: 'none', + }, + stateIcon: { + color: 'rgba(255, 255, 255, 0.85)', + fontSize: 18, + }, + entryContent: { + flex: 1, + minWidth: 0, + display: 'flex', + flexDirection: 'column', + gap: theme.spacing(0.25), + }, + trackTitle: { + fontWeight: 600, + fontSize: '0.875rem', + lineHeight: 1.3, + overflow: 'hidden', + textOverflow: 'ellipsis', + whiteSpace: 'nowrap', + }, + trackDetail: { + fontSize: '0.75rem', + color: theme.palette.text.secondary, + overflow: 'hidden', + textOverflow: 'ellipsis', + whiteSpace: 'nowrap', + }, + artistLink: { + cursor: 'pointer', + color: theme.palette.text.secondary, + fontSize: '0.75rem', + '&:hover': { + textDecoration: 'underline', + }, + }, + progressRow: { + display: 'flex', + alignItems: 'center', + gap: theme.spacing(0.75), + marginTop: theme.spacing(0.5), + }, + progressTime: { + fontSize: '0.65rem', + color: theme.palette.text.secondary, + fontVariantNumeric: 'tabular-nums', + flexShrink: 0, + }, + progressBar: { + flex: 1, + height: 3, + borderRadius: 2, + backgroundColor: theme.palette.action.disabledBackground, + '& .MuiLinearProgress-bar': { + borderRadius: 2, + }, + }, + userInfo: { + fontSize: '0.65rem', + color: theme.palette.text.disabled, + marginTop: theme.spacing(0.25), + }, + badge: { + '& .MuiBadge-badge': { + backgroundColor: theme.palette.primary.main, + color: theme.palette.primary.contrastText, + }, + }, +})) + +// NowPlayingButton component - handles the button with badge +const NowPlayingButton = React.memo(({ count, onClick }) => { + const classes = useStyles() + const translate = useTranslate() + + return ( + <Tooltip title={translate('nowPlaying.title')}> + <IconButton + className={classes.button} + onClick={onClick} + aria-label={translate('nowPlaying.title')} + aria-haspopup="true" + > + <Badge + badgeContent={count} + color="primary" + overlap="rectangular" + className={classes.badge} + > + <FaRegCirclePlay size={20} /> + </Badge> + </IconButton> + </Tooltip> + ) +}) + +NowPlayingButton.displayName = 'NowPlayingButton' + +NowPlayingButton.propTypes = { + count: PropTypes.number.isRequired, + onClick: PropTypes.func.isRequired, +} + +const NowPlayingItem = React.memo( + ({ nowPlayingEntry, onLinkClick, getArtistLink, now }) => { + const classes = useStyles() + const isPaused = nowPlayingEntry.state === 'paused' + const isPlaying = + nowPlayingEntry.state === 'playing' || + nowPlayingEntry.state === 'starting' + const basePositionMs = nowPlayingEntry.positionMs || 0 + const rate = nowPlayingEntry.playbackRate || 1 + const elapsedSinceFetch = now - (nowPlayingEntry._fetchedAt || now) + const interpolatedMs = isPlaying + ? basePositionMs + elapsedSinceFetch * rate + : basePositionMs + const durationMs = (nowPlayingEntry.duration || 0) * 1000 + const clampedMs = Math.max(0, interpolatedMs) + const positionMs = + durationMs > 0 ? Math.min(clampedMs, durationMs) : clampedMs + const positionSec = positionMs / 1000 + const durationSec = nowPlayingEntry.duration || 0 + const progress = durationSec > 0 ? (positionSec / durationSec) * 100 : 0 + const artistId = nowPlayingEntry.albumArtistId || nowPlayingEntry.artistId + const artistName = nowPlayingEntry.albumArtist || nowPlayingEntry.artist + + return ( + <ListItem className={classes.listItem}> + <div className={classes.avatarContainer}> + <Link + to={`/album/${nowPlayingEntry.albumId}/show`} + onClick={onLinkClick} + > + <Avatar + className={classes.avatar} + src={subsonic.getCoverArtUrl(nowPlayingEntry, 80)} + variant="square" + alt={`${nowPlayingEntry.album} cover art`} + loading="lazy" + /> + </Link> + {isPaused && ( + <div className={classes.stateOverlay}> + <FaPause className={classes.stateIcon} /> + </div> + )} + </div> + <div className={classes.entryContent}> + <Typography + className={classes.trackTitle} + title={nowPlayingEntry.title} + > + {nowPlayingEntry.title} + </Typography> + {artistId ? ( + <Link + to={getArtistLink(artistId)} + className={classes.artistLink} + onClick={onLinkClick} + > + {artistName} + </Link> + ) : ( + <Typography className={classes.trackDetail}> + {artistName} + </Typography> + )} + <Typography + className={classes.trackDetail} + title={nowPlayingEntry.album} + > + {nowPlayingEntry.album} + </Typography> + <div className={classes.progressRow}> + <span className={classes.progressTime}> + {formatDuration(positionSec)} + </span> + <LinearProgress + className={classes.progressBar} + variant="determinate" + value={Math.min(progress, 100)} + /> + <span className={classes.progressTime}> + {formatDuration(durationSec)} + </span> + </div> + <Typography className={classes.userInfo}> + {nowPlayingEntry.username} + {nowPlayingEntry.playerName + ? ` (${nowPlayingEntry.playerName})` + : ''} + </Typography> + </div> + </ListItem> + ) + }, +) + +NowPlayingItem.displayName = 'NowPlayingItem' + +NowPlayingItem.propTypes = { + nowPlayingEntry: PropTypes.shape({ + playerId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]) + .isRequired, + albumId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]) + .isRequired, + albumArtistId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]), + artistId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]), + albumArtist: PropTypes.string, + artist: PropTypes.string, + title: PropTypes.string.isRequired, + username: PropTypes.string.isRequired, + playerName: PropTypes.string, + album: PropTypes.string, + state: PropTypes.string, + positionMs: PropTypes.number, + duration: PropTypes.number, + }).isRequired, + onLinkClick: PropTypes.func.isRequired, + getArtistLink: PropTypes.func.isRequired, + now: PropTypes.number.isRequired, +} + +// NowPlayingList component - handles the popover content +const NowPlayingList = React.memo( + ({ anchorEl, open, onClose, entries, onLinkClick, getArtistLink, now }) => { + const classes = useStyles({ entryCount: entries.length }) + const translate = useTranslate() + + return ( + <Popover + id="panel-nowplaying" + anchorEl={anchorEl} + anchorOrigin={{ vertical: 'bottom', horizontal: 'right' }} + transformOrigin={{ vertical: 'top', horizontal: 'right' }} + open={open} + onClose={onClose} + aria-labelledby="now-playing-title" + > + <Card className={classes.card}> + <CardContent className={classes.cardContent}> + {entries.length === 0 ? ( + <Typography id="now-playing-title"> + {translate('nowPlaying.empty')} + </Typography> + ) : ( + <List + className={classes.list} + dense + aria-label={translate('nowPlaying.title')} + > + {entries.map((nowPlayingEntry) => ( + <NowPlayingItem + key={`${nowPlayingEntry.username}-${nowPlayingEntry.playerName}`} + nowPlayingEntry={nowPlayingEntry} + onLinkClick={onLinkClick} + getArtistLink={getArtistLink} + now={now} + /> + ))} + </List> + )} + </CardContent> + </Card> + </Popover> + ) + }, +) + +NowPlayingList.displayName = 'NowPlayingList' + +NowPlayingList.propTypes = { + anchorEl: PropTypes.object, + open: PropTypes.bool.isRequired, + onClose: PropTypes.func.isRequired, + entries: PropTypes.arrayOf(PropTypes.object).isRequired, + onLinkClick: PropTypes.func.isRequired, + getArtistLink: PropTypes.func.isRequired, + now: PropTypes.number.isRequired, +} + +// Main NowPlayingPanel component +const NowPlayingPanel = () => { + const dispatch = useDispatch() + const count = useSelector((state) => state.activity.nowPlayingCount) + const lastUpdate = useSelector((state) => state.activity.nowPlayingLastUpdate) + const streamReconnected = useSelector( + (state) => state.activity.streamReconnected, + ) + const serverUp = useSelector( + (state) => !!state.activity.serverStart.startTime, + ) + const translate = useTranslate() + const notify = useNotify() + const theme = useTheme() + const isSmallScreen = useMediaQuery(theme.breakpoints.down('sm')) + + const [anchorEl, setAnchorEl] = useState(null) + const [entries, setEntries] = useState([]) + const [now, setNow] = useState(Date.now()) + const open = Boolean(anchorEl) + + const handleMenuOpen = useCallback((event) => { + setAnchorEl(event.currentTarget) + }, []) + + const handleMenuClose = useCallback(() => { + setAnchorEl(null) + }, []) + + // Close panel when link is clicked on small screens + const handleLinkClick = useCallback(() => { + if (isSmallScreen) { + handleMenuClose() + } + }, [isSmallScreen, handleMenuClose]) + + const getArtistLink = useCallback((artistId) => { + if (!artistId) return null + return config.devShowArtistPage && artistId !== config.variousArtistsId + ? `/artist/${artistId}/show` + : `/album?filter={"artist_id":"${artistId}"}&order=ASC&sort=max_year&displayedFilters={"compilation":true}&perPage=15` + }, []) + + const fetchTimerRef = useRef(null) + const doFetchRef = useRef() + doFetchRef.current = () => + subsonic + .getNowPlaying() + .then((resp) => resp.json['subsonic-response']) + .then((data) => { + if (data.status === 'ok') { + const nowPlayingEntries = data.nowPlaying?.entry || [] + const fetchTime = Date.now() + setEntries( + nowPlayingEntries.map((e) => ({ ...e, _fetchedAt: fetchTime })), + ) + dispatch(nowPlayingCountSync({ count: nowPlayingEntries.length })) + } else { + throw new Error( + data.error?.message || 'Failed to fetch now playing data', + ) + } + }) + .catch((error) => { + notify('ra.page.error', 'warning', { + messageArgs: { error: error.message || 'Unknown error' }, + }) + }) + const fetchList = useCallback(() => { + if (fetchTimerRef.current) clearTimeout(fetchTimerRef.current) + fetchTimerRef.current = setTimeout(() => { + fetchTimerRef.current = null + doFetchRef.current() + }, 300) + }, []) + + useEffect(() => { + return () => { + if (fetchTimerRef.current) clearTimeout(fetchTimerRef.current) + } + }, []) + + // Initialize count and entries on mount, and refresh on server/stream changes + useEffect(() => { + if (serverUp) fetchList() + }, [fetchList, serverUp, streamReconnected]) + + // Refresh when NowPlaying updates from SSE events (if panel is open) + useEffect(() => { + if (open && serverUp) fetchList() + }, [lastUpdate, open, fetchList, serverUp]) + + // Update current time every second when open to animate progress bars + useInterval(() => setNow(Date.now()), open ? 1000 : null) + + // Periodic refresh when panel is open (10 seconds) + useInterval( + () => { + if (open && serverUp) fetchList() + }, + open ? 10000 : null, + ) + + // Periodic refresh when panel is closed (60 seconds) to keep badge accurate + useInterval( + () => { + if (!open && serverUp) fetchList() + }, + !open ? 60000 : null, + ) + + return ( + <div> + <NowPlayingButton count={count} onClick={handleMenuOpen} /> + <NowPlayingList + anchorEl={anchorEl} + open={open} + onClose={handleMenuClose} + entries={entries} + now={now} + onLinkClick={handleLinkClick} + getArtistLink={getArtistLink} + /> + </div> + ) +} + +NowPlayingPanel.propTypes = {} + +export default NowPlayingPanel diff --git a/ui/src/layout/NowPlayingPanel.test.jsx b/ui/src/layout/NowPlayingPanel.test.jsx new file mode 100644 index 000000000..ea4a3568b --- /dev/null +++ b/ui/src/layout/NowPlayingPanel.test.jsx @@ -0,0 +1,363 @@ +import React from 'react' +import { render, screen, fireEvent, waitFor } from '@testing-library/react' +import { describe, it, beforeEach, vi } from 'vitest' +import { Provider } from 'react-redux' +import { createStore, combineReducers } from 'redux' +import { activityReducer } from '../reducers' +import NowPlayingPanel from './NowPlayingPanel' +import subsonic from '../subsonic' + +vi.mock('../subsonic', () => ({ + default: { + getNowPlaying: vi.fn(), + getAvatarUrl: vi.fn(() => '/avatar'), + getCoverArtUrl: vi.fn(() => '/cover'), + }, +})) + +// Create a mock for useMediaQuery +const mockUseMediaQuery = vi.fn() + +vi.mock('react-admin', async (importOriginal) => { + const actual = await importOriginal() + const redux = await import('react-redux') + return { + ...actual, + useTranslate: () => (x) => x, + useSelector: redux.useSelector, + useDispatch: redux.useDispatch, + Link: ({ to, children, onClick, ...props }) => ( + <a + href={to} + onClick={(e) => { + e.preventDefault() // Prevent navigation in tests + if (onClick) onClick(e) + }} + {...props} + > + {children} + </a> + ), + } +}) + +// Mock the specific Material-UI hooks we need +vi.mock('@material-ui/core/useMediaQuery', () => ({ + default: () => mockUseMediaQuery(), +})) + +vi.mock('@material-ui/core/styles/useTheme', () => ({ + default: () => ({ + breakpoints: { + down: () => '(max-width:959.95px)', // Mock breakpoint string + }, + }), +})) + +describe('<NowPlayingPanel />', () => { + const createMockStore = (overrides = {}) => { + const defaultState = { + activity: { + nowPlayingCount: 1, + serverStart: { startTime: Date.now() }, // Server is up by default + streamReconnected: 0, + ...overrides, + }, + } + return createStore( + combineReducers({ activity: activityReducer }), + defaultState, + ) + } + + afterEach(() => { + vi.useRealTimers() + }) + + beforeEach(() => { + vi.useFakeTimers() + vi.clearAllMocks() + mockUseMediaQuery.mockReturnValue(false) // Default to large screen + + subsonic.getNowPlaying.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + nowPlaying: { + entry: [ + { + playerId: 1, + username: 'u1', + playerName: 'Chrome Browser', + title: 'Song', + albumArtist: 'Artist', + albumId: 'album1', + albumArtistId: 'artist1', + minutesAgo: 2, + }, + ], + }, + }, + }, + }) + }) + + it('fetches and displays entries when opened', async () => { + const store = createMockStore() + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + // Advance past debounce and flush promises + await vi.advanceTimersByTimeAsync(500) + + fireEvent.click(screen.getByRole('button')) + await waitFor(() => { + expect(screen.getByText('Artist')).toBeInTheDocument() + expect(screen.getByRole('link', { name: 'Artist' })).toHaveAttribute( + 'href', + '/artist/artist1/show', + ) + }) + }) + + it('displays player name after username', async () => { + const store = createMockStore() + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + await vi.advanceTimersByTimeAsync(500) + + fireEvent.click(screen.getByRole('button')) + await waitFor(() => { + expect(screen.getByText('u1 (Chrome Browser)')).toBeInTheDocument() + }) + }) + + it('handles entries without player name', async () => { + subsonic.getNowPlaying.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'ok', + nowPlaying: { + entry: [ + { + playerId: 1, + username: 'u1', + title: 'Song', + albumArtist: 'Artist', + albumId: 'album1', + albumArtistId: 'artist1', + minutesAgo: 2, + }, + ], + }, + }, + }, + }) + + const store = createMockStore() + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + await vi.advanceTimersByTimeAsync(500) + + fireEvent.click(screen.getByRole('button')) + await waitFor(() => { + expect(screen.getByText('u1')).toBeInTheDocument() + }) + }) + + it('shows empty message when no entries', async () => { + subsonic.getNowPlaying.mockResolvedValue({ + json: { + 'subsonic-response': { status: 'ok', nowPlaying: { entry: [] } }, + }, + }) + const store = createMockStore({ nowPlayingCount: 0 }) + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + await vi.advanceTimersByTimeAsync(500) + + fireEvent.click(screen.getByRole('button')) + await waitFor(() => { + expect(screen.getByText('nowPlaying.empty')).toBeInTheDocument() + }) + }) + + it('does not close panel when artist link is clicked on large screens', async () => { + mockUseMediaQuery.mockReturnValue(false) // Simulate large screen + + const store = createMockStore() + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + await vi.advanceTimersByTimeAsync(500) + + // Open the panel + fireEvent.click(screen.getByRole('button')) + await waitFor(() => { + expect(screen.getByText('Artist')).toBeInTheDocument() + }) + + // Check that the popover is open + expect(screen.getByRole('presentation')).toBeInTheDocument() + + // Click the artist link + fireEvent.click(screen.getByRole('link', { name: 'Artist' })) + + // Panel should remain open (popover should still be in document) + expect(screen.getByRole('presentation')).toBeInTheDocument() + expect(screen.getByText('Artist')).toBeInTheDocument() + }) + + it('does not fetch on mount when server is down', () => { + const store = createMockStore({ + nowPlayingCount: 1, + serverStart: { startTime: null }, // Server is down + }) + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + // Should not have made initial fetch request due to server being down + expect(subsonic.getNowPlaying).not.toHaveBeenCalled() + }) + + it('does not fetch on stream reconnection when server is down', () => { + const store = createMockStore({ + nowPlayingCount: 1, + serverStart: { startTime: null }, // Server is down + streamReconnected: Date.now(), // Stream reconnected + }) + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + // Should not have made fetch request due to server being down + expect(subsonic.getNowPlaying).not.toHaveBeenCalled() + }) + + it('does not double-fetch on server reconnection', async () => { + vi.useFakeTimers() + + const initialStore = createMockStore({ + nowPlayingCount: 1, + serverStart: { startTime: null }, // Server initially down + streamReconnected: 0, + }) + const { rerender } = render( + <Provider store={initialStore}> + <NowPlayingPanel /> + </Provider>, + ) + + // Clear initial (empty) calls + vi.clearAllMocks() + + // Simulate server coming back up with stream reconnection (both state changes happen) + const reconnectedStore = createMockStore({ + nowPlayingCount: 1, + serverStart: { startTime: Date.now() }, // Server back up + streamReconnected: Date.now(), // Stream reconnected + }) + rerender( + <Provider store={reconnectedStore}> + <NowPlayingPanel /> + </Provider>, + ) + + // Advance past the debounce window + vi.advanceTimersByTime(500) + + // Should only make one call despite both serverUp and streamReconnected changing + expect(subsonic.getNowPlaying).toHaveBeenCalledTimes(1) + + vi.useRealTimers() + }) + + it('skips polling when server is down', () => { + vi.useFakeTimers() + + const store = createMockStore({ + nowPlayingCount: 1, + serverStart: { startTime: null }, // Server is down + }) + render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + // Clear initial mount fetch + vi.clearAllMocks() + + // Advance time by 70 seconds to trigger polling interval + vi.advanceTimersByTime(70000) + + // Should not have made any additional requests due to server being down + expect(subsonic.getNowPlaying).not.toHaveBeenCalled() + + vi.useRealTimers() + }) + + it('resumes polling when server comes back up', () => { + vi.useFakeTimers() + + const store = createMockStore({ + nowPlayingCount: 1, + serverStart: { startTime: null }, // Server is down + }) + const { rerender } = render( + <Provider store={store}> + <NowPlayingPanel /> + </Provider>, + ) + + // Clear initial mount fetch + vi.clearAllMocks() + + // Advance time - should not poll when server is down + vi.advanceTimersByTime(70000) + expect(subsonic.getNowPlaying).not.toHaveBeenCalled() + + // Update state to indicate server is back up + const updatedStore = createMockStore({ + nowPlayingCount: 1, + serverStart: { startTime: Date.now() }, // Server is back up + }) + rerender( + <Provider store={updatedStore}> + <NowPlayingPanel /> + </Provider>, + ) + + // Clear the fetch that happens due to initial mount of rerender + vi.clearAllMocks() + + // Advance time again - should now poll since server is up + vi.advanceTimersByTime(70000) + expect(subsonic.getNowPlaying).toHaveBeenCalled() + + vi.useRealTimers() + }) +}) diff --git a/ui/src/layout/PlaylistsSubMenu.jsx b/ui/src/layout/PlaylistsSubMenu.jsx index a9f70b875..b94bebf86 100644 --- a/ui/src/layout/PlaylistsSubMenu.jsx +++ b/ui/src/layout/PlaylistsSubMenu.jsx @@ -12,7 +12,7 @@ import QueueMusicOutlinedIcon from '@material-ui/icons/QueueMusicOutlined' import { BiCog } from 'react-icons/bi' import { useDrop } from 'react-dnd' import SubMenu from './SubMenu' -import { canChangeTracks } from '../common' +import { canChangeTracks, OverflowTooltip } from '../common' import { DraggableTypes } from '../consts' import config from '../config' @@ -39,9 +39,11 @@ const PlaylistMenuItemLink = ({ pls, sidebarIsOpen }) => { <MenuItemLink to={`/playlist/${pls.id}/show`} primaryText={ - <Typography variant="inherit" noWrap ref={dropRef}> - {pls.name} - </Typography> + <OverflowTooltip title={pls.name} placement="right"> + <Typography variant="inherit" noWrap ref={dropRef}> + {pls.name} + </Typography> + </OverflowTooltip> } sidebarIsOpen={sidebarIsOpen} dense={false} diff --git a/ui/src/layout/UserMenu.jsx b/ui/src/layout/UserMenu.jsx index c7a3deaf4..e33185578 100644 --- a/ui/src/layout/UserMenu.jsx +++ b/ui/src/layout/UserMenu.jsx @@ -28,6 +28,9 @@ import { useDispatch } from 'react-redux' const useStyles = makeStyles((theme) => ({ user: {}, + button: { + color: 'inherit', + }, avatar: { width: theme.spacing(4), height: theme.spacing(4), @@ -72,12 +75,11 @@ const UserMenu = (props) => { <div className={classes.user}> <Tooltip title={label && translate(label, { _: label })}> <IconButton + className={classes.button} aria-label={label && translate(label, { _: label })} aria-owns={open ? 'menu-appbar' : null} aria-haspopup={true} - color="inherit" onClick={handleMenu} - size={'small'} > {loaded && identity.avatar ? ( <Avatar @@ -120,7 +122,7 @@ const UserMenu = (props) => { }) : null, )} - {!config.auth && logout} + {(!config.auth || !!config.extAuthLogoutURL) && logout} </MenuList> </Popover> </div> diff --git a/ui/src/library/DeleteLibraryButton.jsx b/ui/src/library/DeleteLibraryButton.jsx new file mode 100644 index 000000000..8d9ff6ed2 --- /dev/null +++ b/ui/src/library/DeleteLibraryButton.jsx @@ -0,0 +1,80 @@ +import React from 'react' +import DeleteIcon from '@material-ui/icons/Delete' +import { makeStyles, alpha } from '@material-ui/core/styles' +import clsx from 'clsx' +import { + useNotify, + useDeleteWithConfirmController, + Button, + Confirm, + useTranslate, + useRedirect, +} from 'react-admin' + +const useStyles = makeStyles( + (theme) => ({ + deleteButton: { + color: theme.palette.error.main, + '&:hover': { + backgroundColor: alpha(theme.palette.error.main, 0.12), + // Reset on mouse devices + '@media (hover: none)': { + backgroundColor: 'transparent', + }, + }, + }, + }), + { name: 'RaDeleteWithConfirmButton' }, +) + +const DeleteLibraryButton = ({ + record, + resource, + basePath, + className, + ...props +}) => { + const translate = useTranslate() + const notify = useNotify() + const redirect = useRedirect() + + const onSuccess = () => { + notify('resources.library.notifications.deleted', 'info', { + smart_count: 1, + }) + redirect('/library') + } + + const { open, loading, handleDialogOpen, handleDialogClose, handleDelete } = + useDeleteWithConfirmController({ + resource, + record, + basePath, + onSuccess, + }) + + const classes = useStyles(props) + return ( + <> + <Button + label="ra.action.delete" + onClick={handleDialogOpen} + disabled={loading} + className={clsx('ra-delete-button', classes.deleteButton, className)} + {...props} + > + <DeleteIcon /> + </Button> + <Confirm + isOpen={open} + loading={loading} + title={translate('resources.library.name', { smart_count: 1 })} + content={translate('resources.library.messages.deleteConfirm')} + onConfirm={handleDelete} + onClose={handleDialogClose} + /> + </> + ) +} + +export default DeleteLibraryButton diff --git a/ui/src/library/LibraryCreate.jsx b/ui/src/library/LibraryCreate.jsx new file mode 100644 index 000000000..0e69964b6 --- /dev/null +++ b/ui/src/library/LibraryCreate.jsx @@ -0,0 +1,84 @@ +import React, { useCallback } from 'react' +import { + Create, + SimpleForm, + TextInput, + BooleanInput, + required, + useTranslate, + useMutation, + useNotify, + useRedirect, +} from 'react-admin' +import { Title } from '../common' + +const LibraryCreate = (props) => { + const translate = useTranslate() + const [mutate] = useMutation() + const notify = useNotify() + const redirect = useRedirect() + const resourceName = translate('resources.library.name', { smart_count: 1 }) + const title = translate('ra.page.create', { + name: `${resourceName}`, + }) + + const save = useCallback( + async (values) => { + try { + await mutate( + { + type: 'create', + resource: 'library', + payload: { data: values }, + }, + { returnPromise: true }, + ) + notify('resources.library.notifications.created', 'info', { + smart_count: 1, + }) + redirect('/library') + } catch (error) { + // Handle validation errors with proper field mapping + if (error.body && error.body.errors) { + return error.body.errors + } + + // Handle other structured errors from the server + if (error.body && error.body.error) { + const errorMsg = error.body.error + + // Handle database constraint violations + if (errorMsg.includes('UNIQUE constraint failed: library.name')) { + return { name: 'ra.validation.unique' } + } + if (errorMsg.includes('UNIQUE constraint failed: library.path')) { + return { path: 'ra.validation.unique' } + } + + // Show a general notification for other server errors + notify(errorMsg, 'error') + return + } + + // Fallback for unexpected error formats + const fallbackMessage = + error.message || + (typeof error === 'string' ? error : 'An unexpected error occurred') + notify(fallbackMessage, 'error') + } + }, + [mutate, notify, redirect], + ) + + return ( + <Create title={<Title subTitle={title} />} {...props}> + <SimpleForm save={save} variant={'outlined'}> + <TextInput source="name" validate={[required()]} /> + <TextInput source="path" validate={[required()]} fullWidth /> + <BooleanInput source="defaultNewUsers" /> + </SimpleForm> + </Create> + ) +} + +export default LibraryCreate diff --git a/ui/src/library/LibraryEdit.jsx b/ui/src/library/LibraryEdit.jsx new file mode 100644 index 000000000..7e89c892c --- /dev/null +++ b/ui/src/library/LibraryEdit.jsx @@ -0,0 +1,273 @@ +import React, { useCallback } from 'react' +import { + Edit, + FormWithRedirect, + TextInput, + BooleanInput, + required, + SaveButton, + DateField, + useTranslate, + useMutation, + useNotify, + useRedirect, + Toolbar, +} from 'react-admin' +import { Typography, Box } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import DeleteLibraryButton from './DeleteLibraryButton' +import { Title } from '../common' +import { formatBytes, formatDuration2, formatNumber } from '../utils/index.js' + +const useStyles = makeStyles({ + toolbar: { + display: 'flex', + justifyContent: 'space-between', + }, +}) + +const LibraryTitle = ({ record }) => { + const translate = useTranslate() + const resourceName = translate('resources.library.name', { smart_count: 1 }) + return ( + <Title subTitle={`${resourceName} ${record ? `"${record.name}"` : ''}`} /> + ) +} + +const CustomToolbar = ({ showDelete, ...props }) => ( + <Toolbar {...props} classes={useStyles()}> + <SaveButton disabled={props.pristine} /> + {showDelete && ( + <DeleteLibraryButton + record={props.record} + resource="library" + basePath="/library" + /> + )} + </Toolbar> +) + +const LibraryEdit = (props) => { + const translate = useTranslate() + const [mutate] = useMutation() + const notify = useNotify() + const redirect = useRedirect() + + // Library ID 1 is protected (main library) + const canDelete = props.id !== '1' + const canEditPath = props.id !== '1' + + const save = useCallback( + async (values) => { + try { + await mutate( + { + type: 'update', + resource: 'library', + payload: { id: values.id, data: values }, + }, + { returnPromise: true }, + ) + notify('resources.library.notifications.updated', 'info', { + smart_count: 1, + }) + redirect('/library') + } catch (error) { + if (error.body && error.body.errors) { + return error.body.errors + } + } + }, + [mutate, notify, redirect], + ) + + return ( + <Edit title={<LibraryTitle />} undoable={false} {...props}> + <FormWithRedirect + {...props} + save={save} + render={(formProps) => ( + <form onSubmit={formProps.handleSubmit}> + <Box p="1em" maxWidth="800px"> + <Box display="flex"> + <Box flex={1} mr="1em"> + {/* Basic Information */} + <Typography variant="h6" gutterBottom> + {translate('resources.library.sections.basic')} + </Typography> + + <TextInput + source="name" + label={translate('resources.library.fields.name')} + validate={[required()]} + variant="outlined" + /> + <TextInput + source="path" + label={translate('resources.library.fields.path')} + validate={[required()]} + fullWidth + variant="outlined" + InputProps={{ readOnly: !canEditPath }} // Disable editing path for library 1 + /> + <BooleanInput + source="defaultNewUsers" + label={translate( + 'resources.library.fields.defaultNewUsers', + )} + variant="outlined" + /> + + <Box mt="2em" /> + + {/* Statistics - Two Column Layout */} + <Typography variant="h6" gutterBottom> + {translate('resources.library.sections.statistics')} + </Typography> + + <Box display="flex"> + <Box flex={1} mr="0.5em"> + <TextInput + InputProps={{ readOnly: true }} + resource={'library'} + source={'totalSongs'} + label={translate('resources.library.fields.totalSongs')} + fullWidth + variant="outlined" + /> + </Box> + <Box flex={1} ml="0.5em"> + <TextInput + InputProps={{ readOnly: true }} + resource={'library'} + source={'totalAlbums'} + label={translate( + 'resources.library.fields.totalAlbums', + )} + fullWidth + variant="outlined" + /> + </Box> + </Box> + + <Box display="flex"> + <Box flex={1} mr="0.5em"> + <TextInput + InputProps={{ readOnly: true }} + resource={'library'} + source={'totalArtists'} + label={translate( + 'resources.library.fields.totalArtists', + )} + fullWidth + variant="outlined" + /> + </Box> + <Box flex={1} ml="0.5em"> + <TextInput + InputProps={{ readOnly: true }} + resource={'library'} + source={'totalSize'} + label={translate('resources.library.fields.totalSize')} + format={(v) => formatBytes(v, 2)} + fullWidth + variant="outlined" + /> + </Box> + </Box> + + <Box display="flex"> + <Box flex={1} mr="0.5em"> + <TextInput + InputProps={{ readOnly: true }} + resource={'library'} + source={'totalDuration'} + label={translate( + 'resources.library.fields.totalDuration', + )} + format={formatDuration2} + fullWidth + variant="outlined" + /> + </Box> + <Box flex={1} ml="0.5em"> + <TextInput + InputProps={{ readOnly: true }} + resource={'library'} + source={'totalMissingFiles'} + label={translate( + 'resources.library.fields.totalMissingFiles', + )} + fullWidth + variant="outlined" + /> + </Box> + </Box> + + {/* Timestamps Section */} + <Box mb="1em"> + <Typography + variant="body2" + color="textSecondary" + gutterBottom + > + {translate('resources.library.fields.lastScanAt')} + </Typography> + <DateField + variant="body1" + source="lastScanAt" + showTime + record={formProps.record} + /> + </Box> + + <Box mb="1em"> + <Typography + variant="body2" + color="textSecondary" + gutterBottom + > + {translate('resources.library.fields.updatedAt')} + </Typography> + <DateField + variant="body1" + source="updatedAt" + showTime + record={formProps.record} + /> + </Box> + + <Box mb="2em"> + <Typography + variant="body2" + color="textSecondary" + gutterBottom + > + {translate('resources.library.fields.createdAt')} + </Typography> + <DateField + variant="body1" + source="createdAt" + showTime + record={formProps.record} + /> + </Box> + </Box> + </Box> + </Box> + + <CustomToolbar + handleSubmitWithRedirect={formProps.handleSubmitWithRedirect} + pristine={formProps.pristine} + saving={formProps.saving} + record={formProps.record} + showDelete={canDelete} + /> + </form> + )} + /> + </Edit> + ) +} + +export default LibraryEdit diff --git a/ui/src/library/LibraryList.jsx b/ui/src/library/LibraryList.jsx new file mode 100644 index 000000000..35d627cbb --- /dev/null +++ b/ui/src/library/LibraryList.jsx @@ -0,0 +1,57 @@ +import React from 'react' +import { + Datagrid, + Filter, + SearchInput, + SimpleList, + TextField, + NumberField, + BooleanField, +} from 'react-admin' +import { useMediaQuery } from '@material-ui/core' +import { List, DateField, useResourceRefresh, SizeField } from '../common' +import LibraryListBulkActions from './LibraryListBulkActions' +import LibraryListActions from './LibraryListActions' + +const LibraryFilter = (props) => ( + <Filter {...props} variant={'outlined'}> + <SearchInput source="name" alwaysOn /> + </Filter> +) + +const LibraryList = (props) => { + const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) + const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('lg')) + useResourceRefresh('library') + + return ( + <List + {...props} + sort={{ field: 'name', order: 'ASC' }} + exporter={false} + bulkActionButtons={!isXsmall && <LibraryListBulkActions />} + filters={<LibraryFilter />} + actions={<LibraryListActions />} + > + {isXsmall ? ( + <SimpleList + primaryText={(record) => record.name} + secondaryText={(record) => record.path} + /> + ) : ( + <Datagrid rowClick="edit"> + <TextField source="name" /> + {isDesktop && <TextField source="path" />} + <BooleanField source="defaultNewUsers" /> + <NumberField source="totalSongs" /> + <NumberField source="totalAlbums" /> + <NumberField source="totalMissingFiles" /> + <SizeField source="totalSize" /> + <DateField source="lastScanAt" sortByOrder={'DESC'} /> + </Datagrid> + )} + </List> + ) +} + +export default LibraryList diff --git a/ui/src/library/LibraryListActions.jsx b/ui/src/library/LibraryListActions.jsx new file mode 100644 index 000000000..f4d0913df --- /dev/null +++ b/ui/src/library/LibraryListActions.jsx @@ -0,0 +1,31 @@ +import React, { cloneElement } from 'react' +import { sanitizeListRestProps, TopToolbar, CreateButton } from 'react-admin' +import LibraryScanButton from './LibraryScanButton' + +const LibraryListActions = ({ + className, + filters, + resource, + showFilter, + displayedFilters, + filterValues, + ...rest +}) => { + return ( + <TopToolbar className={className} {...sanitizeListRestProps(rest)}> + {filters && + cloneElement(filters, { + resource, + showFilter, + displayedFilters, + filterValues, + context: 'button', + })} + <LibraryScanButton fullScan={false} /> + <LibraryScanButton fullScan={true} /> + <CreateButton /> + </TopToolbar> + ) +} + +export default LibraryListActions diff --git a/ui/src/library/LibraryListBulkActions.jsx b/ui/src/library/LibraryListBulkActions.jsx new file mode 100644 index 000000000..8862a4f51 --- /dev/null +++ b/ui/src/library/LibraryListBulkActions.jsx @@ -0,0 +1,11 @@ +import React from 'react' +import LibraryScanButton from './LibraryScanButton' + +const LibraryListBulkActions = (props) => ( + <> + <LibraryScanButton fullScan={false} {...props} /> + <LibraryScanButton fullScan={true} {...props} /> + </> +) + +export default LibraryListBulkActions diff --git a/ui/src/library/LibraryScanButton.jsx b/ui/src/library/LibraryScanButton.jsx new file mode 100644 index 000000000..50d90e615 --- /dev/null +++ b/ui/src/library/LibraryScanButton.jsx @@ -0,0 +1,77 @@ +import React, { useState } from 'react' +import PropTypes from 'prop-types' +import { + Button, + useNotify, + useRefresh, + useTranslate, + useUnselectAll, +} from 'react-admin' +import { useSelector } from 'react-redux' +import SyncIcon from '@material-ui/icons/Sync' +import CachedIcon from '@material-ui/icons/Cached' +import subsonic from '../subsonic' + +const LibraryScanButton = ({ fullScan, selectedIds, className }) => { + const [loading, setLoading] = useState(false) + const notify = useNotify() + const refresh = useRefresh() + const translate = useTranslate() + const unselectAll = useUnselectAll() + const scanStatus = useSelector((state) => state.activity.scanStatus) + + const handleClick = async () => { + setLoading(true) + try { + // Build scan options + const options = { fullScan } + + // If specific libraries are selected, scan only those + // Format: "libraryID:" to scan entire library (no folder path specified) + if (selectedIds && selectedIds.length > 0) { + options.target = selectedIds.map((id) => `${id}:`) + } + + await subsonic.startScan(options) + const notificationKey = fullScan + ? 'resources.library.notifications.fullScanStarted' + : 'resources.library.notifications.quickScanStarted' + notify(notificationKey, 'info') + refresh() + + // Unselect all items after successful scan + unselectAll('library') + } catch (error) { + notify('resources.library.notifications.scanError', 'warning') + } finally { + setLoading(false) + } + } + + const isDisabled = loading || scanStatus.scanning + + const label = fullScan + ? translate('resources.library.actions.fullScan') + : translate('resources.library.actions.quickScan') + + const icon = fullScan ? <CachedIcon /> : <SyncIcon /> + + return ( + <Button + onClick={handleClick} + disabled={isDisabled} + label={label} + className={className} + > + {icon} + </Button> + ) +} + +LibraryScanButton.propTypes = { + fullScan: PropTypes.bool.isRequired, + selectedIds: PropTypes.array, + className: PropTypes.string, +} + +export default LibraryScanButton diff --git a/ui/src/library/index.js b/ui/src/library/index.js new file mode 100644 index 000000000..3a8b71b52 --- /dev/null +++ b/ui/src/library/index.js @@ -0,0 +1,11 @@ +import { MdLibraryMusic } from 'react-icons/md' +import LibraryList from './LibraryList' +import LibraryEdit from './LibraryEdit' +import LibraryCreate from './LibraryCreate' + +export default { + icon: MdLibraryMusic, + list: LibraryList, + edit: LibraryEdit, + create: LibraryCreate, +} diff --git a/ui/src/missing/MissingFilesList.jsx b/ui/src/missing/MissingFilesList.jsx index 74711eed0..87d9f629f 100644 --- a/ui/src/missing/MissingFilesList.jsx +++ b/ui/src/missing/MissingFilesList.jsx @@ -5,10 +5,15 @@ import { TextField, downloadCSV, Pagination, + Filter, + ReferenceInput, + useTranslate, + SelectInput, } from 'react-admin' import jsonExport from 'jsonexport/dist' import DeleteMissingFilesButton from './DeleteMissingFilesButton.jsx' import MissingListActions from './MissingListActions.jsx' +import React from 'react' const exporter = (files) => { const filesToExport = files.map((file) => { @@ -20,6 +25,24 @@ const exporter = (files) => { }) } +const MissingFilesFilter = (props) => { + const translate = useTranslate() + return ( + <Filter {...props} variant={'outlined'}> + <ReferenceInput + label={translate('resources.missing.fields.libraryName')} + source="library_id" + reference="library" + sort={{ field: 'name', order: 'ASC' }} + filterToQuery={(searchText) => ({ name: [searchText] })} + alwaysOn + > + <SelectInput emptyText="-- All --" optionText="name" /> + </ReferenceInput> + </Filter> + ) +} + const BulkActionButtons = (props) => ( <> <DeleteMissingFilesButton {...props} /> @@ -38,11 +61,13 @@ const MissingFilesList = (props) => { sort={{ field: 'updated_at', order: 'DESC' }} exporter={exporter} actions={<MissingListActions />} + filters={<MissingFilesFilter />} bulkActionButtons={<BulkActionButtons />} perPage={50} pagination={<MissingPagination />} > <Datagrid> + <TextField source={'libraryName'} /> <TextField source={'path'} /> <SizeField source={'size'} /> <DateField source={'updatedAt'} showTime /> diff --git a/ui/src/missing/MissingListActions.jsx b/ui/src/missing/MissingListActions.jsx index 4bbf77115..fc5c4f7e3 100644 --- a/ui/src/missing/MissingListActions.jsx +++ b/ui/src/missing/MissingListActions.jsx @@ -1,12 +1,15 @@ import React from 'react' -import { TopToolbar, ExportButton } from 'react-admin' +import { TopToolbar, ExportButton, useListContext } from 'react-admin' import DeleteMissingFilesButton from './DeleteMissingFilesButton.jsx' -const MissingListActions = (props) => ( - <TopToolbar {...props}> - <ExportButton /> - <DeleteMissingFilesButton deleteAll /> - </TopToolbar> -) +const MissingListActions = (props) => { + const { total } = useListContext() + return ( + <TopToolbar {...props}> + <ExportButton maxResults={total} /> + <DeleteMissingFilesButton deleteAll /> + </TopToolbar> + ) +} export default MissingListActions diff --git a/ui/src/personal/LastfmScrobbleToggle.jsx b/ui/src/personal/LastfmScrobbleToggle.jsx index 67018d2bb..c8e07328f 100644 --- a/ui/src/personal/LastfmScrobbleToggle.jsx +++ b/ui/src/personal/LastfmScrobbleToggle.jsx @@ -13,21 +13,10 @@ import { baseUrl, openInNewTab } from '../utils' import { httpClient } from '../dataProvider' const Progress = (props) => { - const { setLinked, setCheckingLink, apiKey } = props + const { setLinked, setCheckingLink, openedTab } = props const notify = useNotify() let linkCheckDelay = 2000 let linkChecks = 30 - const openedTab = useRef() - - useEffect(() => { - const callbackEndpoint = baseUrl( - `/api/lastfm/link/callback?uid=${localStorage.getItem('userId')}`, - ) - const callbackUrl = `${window.location.origin}${callbackEndpoint}` - openedTab.current = openInNewTab( - `https://www.last.fm/api/auth/?api_key=${apiKey}&cb=${callbackUrl}`, - ) - }, [apiKey]) const endChecking = (success) => { linkCheckDelay = null @@ -76,6 +65,7 @@ export const LastfmScrobbleToggle = (props) => { const [linked, setLinked] = useState(null) const [checkingLink, setCheckingLink] = useState(false) const [apiKey, setApiKey] = useState(false) + const openedTab = useRef() useEffect(() => { httpClient('/api/lastfm/link') @@ -88,9 +78,42 @@ export const LastfmScrobbleToggle = (props) => { }) }, [setLinked, setApiKey]) + const startLink = () => { + // Open the tab synchronously so popup blockers attribute it to the click. + let tab + try { + tab = openInNewTab('about:blank') + } catch { + notify('message.lastfmLinkFailure', 'warning') + return + } + openedTab.current = tab + setCheckingLink(true) + httpClient('/api/lastfm/link') + .then((response) => { + const linkToken = response.json.linkToken + if (!linkToken) { + tab?.close() + notify('message.lastfmLinkFailure', 'warning') + setCheckingLink(false) + return + } + const callbackEndpoint = baseUrl( + `/api/lastfm/link/callback?uid=${encodeURIComponent(linkToken)}`, + ) + const callbackUrl = `${window.location.origin}${callbackEndpoint}` + tab.location.href = `https://www.last.fm/api/auth/?api_key=${apiKey}&cb=${callbackUrl}` + }) + .catch(() => { + tab?.close() + notify('message.lastfmLinkFailure', 'warning') + setCheckingLink(false) + }) + } + const toggleScrobble = () => { if (!linked) { - setCheckingLink(true) + startLink() } else { httpClient('/api/lastfm/link', { method: 'DELETE' }) .then(() => { @@ -121,7 +144,7 @@ export const LastfmScrobbleToggle = (props) => { <Progress setLinked={setLinked} setCheckingLink={setCheckingLink} - apiKey={apiKey} + openedTab={openedTab} /> )} {!apiKey && ( diff --git a/ui/src/playlist/PlaylistDetails.jsx b/ui/src/playlist/PlaylistDetails.jsx index f8c06bba7..c396cbbeb 100644 --- a/ui/src/playlist/PlaylistDetails.jsx +++ b/ui/src/playlist/PlaylistDetails.jsx @@ -1,37 +1,90 @@ -import { Card, CardContent, Typography } from '@material-ui/core' +import { + Card, + CardContent, + CardMedia, + Typography, + useMediaQuery, +} from '@material-ui/core' import { makeStyles } from '@material-ui/core/styles' import { useTranslate } from 'react-admin' -import { CollapsibleComment, DurationField, SizeField } from '../common' +import Lightbox from 'react-image-lightbox' +import 'react-image-lightbox/style.css' +import { + CollapsibleComment, + DurationField, + ImageUploadOverlay, + SizeField, + isWritable, + OverflowTooltip, + useImageLoadingState, +} from '../common' +import config from '../config' +import subsonic from '../subsonic' const useStyles = makeStyles( (theme) => ({ - container: { + root: { [theme.breakpoints.down('xs')]: { padding: '0.7em', - minWidth: '24em', + minWidth: '20em', }, [theme.breakpoints.up('sm')]: { padding: '1em', minWidth: '32em', }, }, + cardContents: { + display: 'flex', + }, details: { - display: 'inline-block', - verticalAlign: 'top', + display: 'flex', + flexDirection: 'column', + }, + content: { + flex: '2 0 auto', + }, + coverParent: { [theme.breakpoints.down('xs')]: { - width: '14em', + height: '8em', + width: '8em', + minWidth: '8em', }, [theme.breakpoints.up('sm')]: { - width: '26em', + height: '10em', + width: '10em', + minWidth: '10em', }, [theme.breakpoints.up('lg')]: { - width: '38em', + height: '15em', + width: '15em', + minWidth: '15em', }, + backgroundColor: 'transparent', + display: 'flex', + alignItems: 'center', + justifyContent: 'center', + position: 'relative', + }, + cover: { + objectFit: 'contain', + cursor: 'pointer', + display: 'block', + width: '100%', + height: '100%', + backgroundColor: 'transparent', + transition: 'opacity 0.3s ease-in-out', + }, + coverLoading: { + opacity: 0.5, }, title: { - whiteSpace: 'nowrap', overflow: 'hidden', textOverflow: 'ellipsis', + wordBreak: 'break-word', + }, + stats: { + marginTop: '1em', + marginBottom: '0.5em', }, }), { @@ -43,31 +96,86 @@ const PlaylistDetails = (props) => { const { record = {} } = props const translate = useTranslate() const classes = useStyles() + const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('lg')) + const { + imageLoading, + imageError, + isLightboxOpen, + handleImageLoad, + handleImageError, + handleOpenLightbox, + handleCloseLightbox, + } = useImageLoadingState(record.id) + + const imageUrl = subsonic.getCoverArtUrl(record, config.uiCoverArtSize, true) + const fullImageUrl = subsonic.getCoverArtUrl(record) return ( - <Card className={classes.container}> - <CardContent className={classes.details}> - <Typography variant="h5" className={classes.title}> - {record.name || translate('ra.page.loading')} - </Typography> - <Typography component="p"> - {record.songCount ? ( - <span> - {record.songCount}{' '} - {translate('resources.song.name', { - smart_count: record.songCount, - })} - {' · '} - <DurationField record={record} source={'duration'} /> - {' · '} - <SizeField record={record} source={'size'} /> - </span> - ) : ( - <span> </span> + <Card className={classes.root}> + <div className={classes.cardContents}> + <div className={classes.coverParent}> + <CardMedia + key={record.id} // Force re-render when playlist changes + component={'img'} + src={imageUrl} + width="400" + height="400" + className={`${classes.cover} ${imageLoading ? classes.coverLoading : ''}`} + onClick={handleOpenLightbox} + onLoad={handleImageLoad} + onError={handleImageError} + title={record.name} + style={{ + cursor: imageError ? 'default' : 'pointer', + }} + /> + {isWritable(record.ownerId) && ( + <ImageUploadOverlay + entityType="playlist" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> )} - </Typography> - <CollapsibleComment record={record} /> - </CardContent> + </div> + <div className={classes.details}> + <CardContent className={classes.content}> + <OverflowTooltip title={record.name || ''}> + <Typography + variant={isDesktop ? 'h5' : 'h6'} + className={classes.title} + > + {record.name || translate('ra.page.loading')} + </Typography> + </OverflowTooltip> + <Typography component="p" className={classes.stats}> + {record.songCount ? ( + <span> + {record.songCount}{' '} + {translate('resources.song.name', { + smart_count: record.songCount, + })} + {' · '} + <DurationField record={record} source={'duration'} /> + {' · '} + <SizeField record={record} source={'size'} /> + </span> + ) : ( + <span> </span> + )} + </Typography> + <CollapsibleComment record={record} /> + </CardContent> + </div> + </div> + {isLightboxOpen && !imageError && ( + <Lightbox + imagePadding={50} + animationDuration={200} + imageTitle={record.name} + mainSrc={fullImageUrl} + onCloseRequest={handleCloseLightbox} + /> + )} </Card> ) } diff --git a/ui/src/playlist/PlaylistEdit.jsx b/ui/src/playlist/PlaylistEdit.jsx index f8cee9b5f..f6882e366 100644 --- a/ui/src/playlist/PlaylistEdit.jsx +++ b/ui/src/playlist/PlaylistEdit.jsx @@ -34,7 +34,15 @@ const PlaylistEditForm = (props) => { return ( <SimpleForm redirect="list" variant={'outlined'} {...props}> <TextInput source="name" validate={required()} /> - <TextInput multiline source="comment" /> + <TextInput + multiline + minRows={3} + source="comment" + fullWidth + inputProps={{ + style: { resize: 'vertical' }, + }} + /> {permissions === 'admin' ? ( <ReferenceInput source="ownerId" diff --git a/ui/src/playlist/PlaylistList.jsx b/ui/src/playlist/PlaylistList.jsx index 920b3ebe5..8732725bc 100644 --- a/ui/src/playlist/PlaylistList.jsx +++ b/ui/src/playlist/PlaylistList.jsx @@ -16,8 +16,10 @@ import { usePermissions, } from 'react-admin' import Switch from '@material-ui/core/Switch' +import { makeStyles } from '@material-ui/core/styles' import { useMediaQuery } from '@material-ui/core' import { + CoverArtAvatar, DurationField, List, Writable, @@ -28,6 +30,12 @@ import { import PlaylistListActions from './PlaylistListActions' import ChangePublicStatusButton from './ChangePublicStatusButton' +const useStyles = makeStyles((theme) => ({ + button: { + color: theme.palette.type === 'dark' ? 'white' : undefined, + }, +})) + const PlaylistFilter = (props) => { const { permissions } = usePermissions() return ( @@ -112,13 +120,24 @@ const ToggleAutoImport = ({ resource, source }) => { ) : null } -const PlaylistListBulkActions = (props) => ( - <> - <ChangePublicStatusButton public={true} {...props} /> - <ChangePublicStatusButton public={false} {...props} /> - <BulkDeleteButton {...props} /> - </> -) +const PlaylistListBulkActions = (props) => { + const classes = useStyles() + return ( + <> + <ChangePublicStatusButton + public={true} + {...props} + className={classes.button} + /> + <ChangePublicStatusButton + public={false} + {...props} + className={classes.button} + /> + <BulkDeleteButton {...props} className={classes.button} /> + </> + ) +} const PlaylistList = (props) => { const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) @@ -137,7 +156,9 @@ const PlaylistList = (props) => { <TogglePublicInput source="public" sortByOrder={'DESC'} /> ), comment: <TextField source="comment" />, - sync: <ToggleAutoImport source="sync" sortByOrder={'DESC'} />, + sync: !isXsmall && ( + <ToggleAutoImport source="sync" sortByOrder={'DESC'} /> + ), }), [isDesktop, isXsmall], ) @@ -152,11 +173,13 @@ const PlaylistList = (props) => { <List {...props} exporter={false} + sort={{ field: 'name', order: 'ASC' }} filters={<PlaylistFilter />} actions={<PlaylistListActions />} bulkActionButtons={!isXsmall && <PlaylistListBulkActions />} > <Datagrid rowClick="show" isRowSelectable={(r) => isWritable(r?.ownerId)}> + <CoverArtAvatar source="id" variant="square" /> <TextField source="name" /> {columns} <Writable> diff --git a/ui/src/playlist/PlaylistShow.jsx b/ui/src/playlist/PlaylistShow.jsx index 64364897f..f0cb472b1 100644 --- a/ui/src/playlist/PlaylistShow.jsx +++ b/ui/src/playlist/PlaylistShow.jsx @@ -5,6 +5,7 @@ import { useShowContext, useShowController, Pagination, + Title as RaTitle, } from 'react-admin' import { makeStyles } from '@material-ui/core/styles' import PlaylistDetails from './PlaylistDetails' @@ -31,6 +32,7 @@ const PlaylistShowLayout = (props) => { return ( <> + {record && <RaTitle title={<Title subTitle={record.name} />} />} {record && <PlaylistDetails {...context} />} {record && ( <ReferenceManyField diff --git a/ui/src/playlist/PlaylistSongs.jsx b/ui/src/playlist/PlaylistSongs.jsx index f249c9793..bbe38b4d5 100644 --- a/ui/src/playlist/PlaylistSongs.jsx +++ b/ui/src/playlist/PlaylistSongs.jsx @@ -1,4 +1,4 @@ -import React, { useCallback, useMemo } from 'react' +import React, { useCallback, useEffect, useMemo } from 'react' import { BulkActionsToolbar, ListToolbar, @@ -26,11 +26,13 @@ import { useResourceRefresh, DateField, ArtistLinkField, + RatingField, } from '../common' import { AlbumLinkField } from '../song/AlbumLinkField' import { playTracks } from '../actions' import PlaylistSongBulkActions from './PlaylistSongBulkActions' import ExpandInfoDialog from '../dialogs/ExpandInfoDialog' +import config from '../config' const useStyles = makeStyles( (theme) => ({ @@ -66,11 +68,17 @@ const useStyles = makeStyles( '& $contextMenu': { visibility: 'visible', }, + '& $ratingField': { + visibility: 'visible', + }, }, }, contextMenu: { visibility: (props) => (props.isDesktop ? 'hidden' : 'visible'), }, + ratingField: { + visibility: 'hidden', + }, }), { name: 'RaList' }, ) @@ -84,7 +92,8 @@ const ReorderableList = ({ readOnly, children, ...rest }) => { const PlaylistSongs = ({ playlistId, readOnly, actions, ...props }) => { const listContext = useListContext() - const { data, ids, selectedIds, onUnselectItems, refetch } = listContext + const { data, ids, selectedIds, onUnselectItems, refetch, setPage } = + listContext const isDesktop = useMediaQuery((theme) => theme.breakpoints.up('md')) const classes = useStyles({ isDesktop }) const dispatch = useDispatch() @@ -93,6 +102,11 @@ const PlaylistSongs = ({ playlistId, readOnly, actions, ...props }) => { const version = useVersion() useResourceRefresh('song', 'playlist') + useEffect(() => { + setPage(1) + window.scrollTo({ top: 0, behavior: 'smooth' }) + }, [playlistId, setPage]) + const onAddToPlaylist = useCallback( (pls) => { if (pls.id === playlistId) { @@ -149,12 +163,23 @@ const PlaylistSongs = ({ playlistId, readOnly, actions, ...props }) => { playCount: isDesktop && ( <NumberField source="playCount" sortByOrder={'DESC'} /> ), - playDate: <DateField source="playDate" sortByOrder={'DESC'} showTime />, + playDate: isDesktop && ( + <DateField source="playDate" sortByOrder={'DESC'} showTime /> + ), quality: isDesktop && <QualityInfo source="quality" sortable={false} />, channels: isDesktop && <NumberField source="channels" />, bpm: isDesktop && <NumberField source="bpm" />, + genre: <TextField source="genre" />, + rating: config.enableStarRating && ( + <RatingField + source="rating" + sortByOrder={'DESC'} + resource={'song'} + className={classes.ratingField} + /> + ), } - }, [isDesktop, classes.draggable]) + }, [isDesktop, classes.draggable, classes.ratingField]) const columns = useSelectedFields({ resource: 'playlistTrack', @@ -166,6 +191,8 @@ const PlaylistSongs = ({ playlistId, readOnly, actions, ...props }) => { 'playCount', 'playDate', 'albumArtist', + 'genre', + 'rating', ], }) @@ -205,7 +232,7 @@ const PlaylistSongs = ({ playlistId, readOnly, actions, ...props }) => { {columns} <SongContextMenu onAddToPlaylist={onAddToPlaylist} - showLove={false} + showLove={true} className={classes.contextMenu} /> </SongDatagrid> diff --git a/ui/src/plugin/ConfigCard.jsx b/ui/src/plugin/ConfigCard.jsx new file mode 100644 index 000000000..d9815aa3e --- /dev/null +++ b/ui/src/plugin/ConfigCard.jsx @@ -0,0 +1,123 @@ +import React, { useCallback, useState, useMemo } from 'react' +import PropTypes from 'prop-types' +import { Card, CardContent, Typography, Box } from '@material-ui/core' +import Alert from '@material-ui/lab/Alert' +import { SchemaConfigEditor } from './SchemaConfigEditor' + +// Format error with field title and full path for nested fields +const formatError = (error, schema) => { + // Get path parts from various error formats + const rawPath = + error.dataPath || error.property || error.instancePath?.replace(/\//g, '.') + const parts = rawPath?.split('.').filter(Boolean) || [] + + // Navigate schema to find field title, build bracket-notation path + let currentSchema = schema + let fieldName = parts[parts.length - 1] + const pathParts = [] + + for (const part of parts) { + if (/^\d+$/.test(part)) { + pathParts.push(`[${part}]`) + currentSchema = currentSchema?.items + } else { + fieldName = currentSchema?.properties?.[part]?.title || part + pathParts.push(part) + currentSchema = currentSchema?.properties?.[part] + } + } + + const path = pathParts.join('.').replace(/\.\[/g, '[') + const isNested = path.includes('[') || path.includes('.') + // Replace property name in message with full path for nested fields + const message = isNested + ? error.message.replace(/'[^']+'\s*$/, `'${path}'`) + : error.message + + return { fieldName, message } +} + +export const ConfigCard = ({ + manifest, + configData, + onConfigDataChange, + classes, + translate, +}) => { + const [validationErrors, setValidationErrors] = useState([]) + + // Handle changes from JSONForms + const handleChange = useCallback( + (newData, errors) => { + setValidationErrors(errors || []) + onConfigDataChange(newData, errors) + }, + [onConfigDataChange], + ) + + // Only show config card if manifest has config schema defined + const hasConfigSchema = manifest?.config?.schema + + // Format validation errors with proper field names + const formattedErrors = useMemo(() => { + if (!hasConfigSchema) return [] + return validationErrors.map((error) => + formatError(error, manifest.config.schema), + ) + }, [validationErrors, manifest, hasConfigSchema]) + + if (!hasConfigSchema) { + return null + } + + const { schema, uiSchema } = manifest.config + + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.configuration')} + </Typography> + + {formattedErrors.length > 0 && ( + <Box mb={2}> + <Alert severity="error"> + {translate('resources.plugin.messages.configValidationError')} + <ul style={{ margin: '8px 0 0', paddingLeft: 20 }}> + {formattedErrors.map((error, index) => ( + <li key={index}> + {error.fieldName && <strong>{error.fieldName}</strong>} + {error.fieldName && ': '} + {error.message} + </li> + ))} + </ul> + </Alert> + </Box> + )} + + <Box mt={formattedErrors.length > 0 ? 0 : 2}> + <SchemaConfigEditor + schema={schema} + uiSchema={uiSchema} + data={configData} + onChange={handleChange} + /> + </Box> + </CardContent> + </Card> + ) +} + +ConfigCard.propTypes = { + manifest: PropTypes.shape({ + config: PropTypes.shape({ + schema: PropTypes.object, + uiSchema: PropTypes.object, + }), + }), + configData: PropTypes.object, + onConfigDataChange: PropTypes.func.isRequired, + classes: PropTypes.object.isRequired, + translate: PropTypes.func.isRequired, +} diff --git a/ui/src/plugin/ErrorSection.jsx b/ui/src/plugin/ErrorSection.jsx new file mode 100644 index 000000000..61c048e2a --- /dev/null +++ b/ui/src/plugin/ErrorSection.jsx @@ -0,0 +1,16 @@ +import React from 'react' +import { Typography } from '@material-ui/core' +import Alert from '@material-ui/lab/Alert' + +export const ErrorSection = ({ error, translate }) => { + if (!error) return null + + return ( + <Alert severity="error" style={{ marginBottom: 16 }}> + <Typography variant="subtitle2"> + {translate('resources.plugin.fields.lastError')} + </Typography> + <Typography variant="body2">{error}</Typography> + </Alert> + ) +} diff --git a/ui/src/plugin/InfoCard.jsx b/ui/src/plugin/InfoCard.jsx new file mode 100644 index 000000000..8fb6853fe --- /dev/null +++ b/ui/src/plugin/InfoCard.jsx @@ -0,0 +1,237 @@ +import React, { useState } from 'react' +import { + Card, + CardContent, + Typography, + Grid, + Box, + Chip, + Tooltip, + Link, + ClickAwayListener, +} from '@material-ui/core' +import { useTranslate } from 'react-admin' +import { DateField } from '../common' + +// Helper component for permission chips with clickable persistent tooltips +const PermissionChip = ({ label, permission, classes }) => { + const [open, setOpen] = useState(false) + const translate = useTranslate() + + if (!permission) return null + + const hasHosts = permission.requiredHosts?.length > 0 + const hasTooltip = permission.reason || hasHosts + + const handleClick = () => { + if (hasTooltip) { + setOpen((prev) => !prev) + } + } + + const handleClose = () => { + setOpen(false) + } + + const tooltipContent = ( + <Box className={classes.tooltipContent}> + {permission.reason && ( + <Typography variant="body2">{permission.reason}</Typography> + )} + {hasHosts && ( + <Box mt={permission.reason ? 0.5 : 0}> + <Typography variant="caption" component="div"> + {translate('resources.plugin.messages.requiredHosts')}:{' '} + {permission.requiredHosts.map((host, i) => ( + <span key={host}> + {i > 0 && ', '} + <code>{host}</code> + </span> + ))} + </Typography> + </Box> + )} + </Box> + ) + + const chip = ( + <Chip + size="small" + label={label} + className={classes.permissionChip} + onClick={hasTooltip ? handleClick : undefined} + clickable={hasTooltip} + /> + ) + + if (!hasTooltip) { + return chip + } + + return ( + <ClickAwayListener onClickAway={handleClose}> + <div> + <Tooltip + title={tooltipContent} + arrow + open={open} + disableFocusListener + disableHoverListener + disableTouchListener + PopperProps={{ + disablePortal: true, + }} + > + {chip} + </Tooltip> + </div> + </ClickAwayListener> + ) +} + +// Info row component for responsive grid +const InfoRow = ({ label, children, classes, isSmall }) => ( + <> + <Grid item xs={12} sm={3}> + <Typography + variant="body2" + className={classes.infoLabel} + component={isSmall ? 'div' : 'span'} + > + {label} + </Typography> + </Grid> + <Grid item xs={12} sm={9}> + <Typography variant="body2" component="div"> + {children} + </Typography> + </Grid> + </> +) + +// Plugin information card +export const InfoCard = ({ record, manifest, classes, translate, isSmall }) => ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.info')} + </Typography> + <Grid container spacing={1} className={classes.infoGrid}> + <InfoRow + label={translate('resources.plugin.fields.id')} + classes={classes} + isSmall={isSmall} + > + {record.id} + </InfoRow> + + {manifest?.name && ( + <InfoRow + label={translate('resources.plugin.fields.name')} + classes={classes} + isSmall={isSmall} + > + {manifest.name} + </InfoRow> + )} + + {manifest?.version && ( + <InfoRow + label={translate('resources.plugin.fields.version')} + classes={classes} + isSmall={isSmall} + > + {manifest.version} + </InfoRow> + )} + + {manifest?.description && ( + <InfoRow + label={translate('resources.plugin.fields.description')} + classes={classes} + isSmall={isSmall} + > + {manifest.description} + </InfoRow> + )} + + {manifest?.author && ( + <InfoRow + label={translate('resources.plugin.fields.author')} + classes={classes} + isSmall={isSmall} + > + {manifest.author} + </InfoRow> + )} + + {manifest?.website && ( + <InfoRow + label={translate('resources.plugin.fields.website')} + classes={classes} + isSmall={isSmall} + > + <Link + href={manifest.website} + target="_blank" + rel="noopener noreferrer" + > + {manifest.website} + </Link> + </InfoRow> + )} + + {manifest?.permissions && + Object.keys(manifest.permissions).length > 0 && ( + <InfoRow + label={translate('resources.plugin.fields.permissions')} + classes={classes} + isSmall={isSmall} + > + <Box className={classes.permissionsContainer}> + {Object.entries(manifest.permissions).map(([key, value]) => ( + <PermissionChip + key={key} + label={key} + permission={value} + classes={classes} + /> + ))} + </Box> + <Typography + variant="caption" + color="textSecondary" + style={{ marginTop: 4, display: 'block' }} + > + {translate('resources.plugin.messages.clickPermissions')} + </Typography> + </InfoRow> + )} + + <InfoRow + label={translate('resources.plugin.fields.path')} + classes={classes} + isSmall={isSmall} + > + <span className={classes.pathField}>{record.path}</span> + </InfoRow> + + <InfoRow + label={translate('resources.plugin.fields.updatedAt')} + classes={classes} + isSmall={isSmall} + > + <DateField record={record} source="updatedAt" showTime /> + </InfoRow> + + <InfoRow + label={translate('resources.plugin.fields.createdAt')} + classes={classes} + isSmall={isSmall} + > + <DateField record={record} source="createdAt" showTime /> + </InfoRow> + </Grid> + </CardContent> + </Card> +) diff --git a/ui/src/plugin/LibraryPermissionCard.jsx b/ui/src/plugin/LibraryPermissionCard.jsx new file mode 100644 index 000000000..d3c237279 --- /dev/null +++ b/ui/src/plugin/LibraryPermissionCard.jsx @@ -0,0 +1,201 @@ +import React from 'react' +import { + Card, + CardContent, + Typography, + Box, + FormControlLabel, + Switch, + List, + ListItem, + ListItemIcon, + ListItemText, + Checkbox, +} from '@material-ui/core' +import CheckBoxIcon from '@material-ui/icons/CheckBox' +import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank' +import Alert from '@material-ui/lab/Alert' +import { useGetList, useTranslate } from 'react-admin' +import PropTypes from 'prop-types' + +export const LibraryPermissionCard = ({ + manifest, + classes, + selectedLibraries, + allLibraries, + allowWriteAccess, + onSelectedLibrariesChange, + onAllLibrariesChange, + onAllowWriteAccessChange, +}) => { + const translate = useTranslate() + + // Fetch all libraries + const { data: librariesData, loading: librariesLoading } = useGetList( + 'library', + { + pagination: { page: 1, perPage: 1000 }, + sort: { field: 'name', order: 'ASC' }, + }, + ) + + const libraries = React.useMemo(() => { + return librariesData ? Object.values(librariesData) : [] + }, [librariesData]) + + const handleToggleLibrary = React.useCallback( + (libraryId) => { + const newSelected = selectedLibraries.includes(libraryId) + ? selectedLibraries.filter((id) => id !== libraryId) + : [...selectedLibraries, libraryId] + onSelectedLibrariesChange(newSelected) + }, + [selectedLibraries, onSelectedLibrariesChange], + ) + + const handleAllLibrariesToggle = React.useCallback( + (event) => { + onAllLibrariesChange(event.target.checked) + }, + [onAllLibrariesChange], + ) + + const handleAllowWriteAccessToggle = React.useCallback( + (event) => { + onAllowWriteAccessChange(event.target.checked) + }, + [onAllowWriteAccessChange], + ) + + // Get permission reason from manifest + const libraryPermission = manifest?.permissions?.library + const reason = libraryPermission?.reason + const hasFilesystem = libraryPermission?.filesystem === true + + // Check if permission is required but not configured + const isConfigurationRequired = + libraryPermission && !allLibraries && selectedLibraries.length === 0 + + if (!libraryPermission) { + return null + } + + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.libraryPermission')} + </Typography> + + {reason && ( + <Typography variant="body2" color="textSecondary" gutterBottom> + {translate('resources.plugin.messages.permissionReason')}: {reason} + </Typography> + )} + + {isConfigurationRequired && ( + <Box mb={2}> + <Alert severity="warning"> + {translate('resources.plugin.messages.librariesRequired')} + </Alert> + </Box> + )} + + <Box mb={2}> + <FormControlLabel + control={ + <Switch + checked={allLibraries} + onChange={handleAllLibrariesToggle} + color="primary" + /> + } + label={translate('resources.plugin.fields.allLibraries')} + /> + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.allLibrariesHelp')} + </Typography> + </Box> + + {hasFilesystem && ( + <Box mb={2}> + <FormControlLabel + control={ + <Switch + checked={allowWriteAccess} + onChange={handleAllowWriteAccessToggle} + color="primary" + /> + } + label={translate('resources.plugin.fields.allowWriteAccess')} + /> + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.allowWriteAccessHelp')} + </Typography> + </Box> + )} + + {!allLibraries && ( + <Box className={classes.usersList}> + <Typography variant="subtitle2" gutterBottom> + {translate('resources.plugin.fields.selectedLibraries')} + </Typography> + {librariesLoading ? ( + <Typography variant="body2" color="textSecondary"> + {translate('ra.message.loading')} + </Typography> + ) : libraries.length === 0 ? ( + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.noLibraries')} + </Typography> + ) : ( + <List + dense + style={{ + maxHeight: 200, + overflow: 'auto', + border: '1px solid rgba(0, 0, 0, 0.12)', + borderRadius: 4, + }} + > + {libraries.map((library) => ( + <ListItem + key={library.id} + button + onClick={() => handleToggleLibrary(library.id)} + dense + > + <ListItemIcon> + <Checkbox + icon={<CheckBoxOutlineBlankIcon fontSize="small" />} + checkedIcon={<CheckBoxIcon fontSize="small" />} + checked={selectedLibraries.includes(library.id)} + tabIndex={-1} + disableRipple + /> + </ListItemIcon> + <ListItemText + primary={library.name} + secondary={library.path} + /> + </ListItem> + ))} + </List> + )} + </Box> + )} + </CardContent> + </Card> + ) +} + +LibraryPermissionCard.propTypes = { + manifest: PropTypes.object, + classes: PropTypes.object.isRequired, + selectedLibraries: PropTypes.array.isRequired, + allLibraries: PropTypes.bool.isRequired, + allowWriteAccess: PropTypes.bool.isRequired, + onSelectedLibrariesChange: PropTypes.func.isRequired, + onAllLibrariesChange: PropTypes.func.isRequired, + onAllowWriteAccessChange: PropTypes.func.isRequired, +} diff --git a/ui/src/plugin/ManifestSection.jsx b/ui/src/plugin/ManifestSection.jsx new file mode 100644 index 000000000..3fef65f70 --- /dev/null +++ b/ui/src/plugin/ManifestSection.jsx @@ -0,0 +1,24 @@ +import React from 'react' +import { + Accordion, + AccordionSummary, + AccordionDetails, + Typography, + Box, +} from '@material-ui/core' +import { MdExpandMore } from 'react-icons/md' + +export const ManifestSection = ({ manifestJson, classes, translate }) => ( + <Accordion className={classes.section}> + <AccordionSummary expandIcon={<MdExpandMore />}> + <Typography variant="h6"> + {translate('resources.plugin.sections.manifest')} + </Typography> + </AccordionSummary> + <AccordionDetails> + <Box className={classes.manifestBox} width="100%"> + {manifestJson} + </Box> + </AccordionDetails> + </Accordion> +) diff --git a/ui/src/plugin/OutlinedRenderers.jsx b/ui/src/plugin/OutlinedRenderers.jsx new file mode 100644 index 000000000..8020a5e4f --- /dev/null +++ b/ui/src/plugin/OutlinedRenderers.jsx @@ -0,0 +1,266 @@ +/* eslint-disable react-refresh/only-export-components */ +import React, { useState } from 'react' +import { + rankWith, + isStringControl, + isIntegerControl, + isNumberControl, + isEnumControl, + isOneOfEnumControl, + and, + not, + or, + optionIs, + isDescriptionHidden, +} from '@jsonforms/core' +import { + withJsonFormsControlProps, + withJsonFormsEnumProps, + withJsonFormsOneOfEnumProps, +} from '@jsonforms/react' +import { + TextField, + FormControl, + FormHelperText, + InputLabel, + Select, + MenuItem, +} from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' +import merge from 'lodash/merge' + +const useStyles = makeStyles( + (theme) => ({ + control: { + marginBottom: theme.spacing(2), + }, + }), + { name: 'NDOutlinedRenderers' }, +) + +/** + * Hook for common control state (focus, validation, description visibility) + */ +const useControlState = (props) => { + const { config, uischema, description, visible, errors } = props + const [isFocused, setIsFocused] = useState(false) + + const appliedUiSchemaOptions = merge({}, config, uischema?.options) + // errors is a string when there are validation errors, empty/undefined when valid + const showError = errors && errors.length > 0 + + const showDescription = !isDescriptionHidden( + visible, + description, + isFocused, + appliedUiSchemaOptions.showUnfocusedDescription, + ) + + const helperText = showError ? errors : showDescription ? description : '' + + const handleFocus = () => setIsFocused(true) + const handleBlur = () => setIsFocused(false) + + return { + isFocused, + appliedUiSchemaOptions, + showError, + helperText, + handleFocus, + handleBlur, + } +} + +/** + * Base outlined control component that uses TextField with outlined variant + * instead of the default Input component used by JSONForms 2.x + */ +const OutlinedControl = (props) => { + const classes = useStyles() + const { + data, + id, + enabled, + label, + visible, + type = 'text', + inputProps: extraInputProps = {}, + onChange, + } = props + + const { + appliedUiSchemaOptions, + showError, + helperText, + handleFocus, + handleBlur, + } = useControlState(props) + + if (!visible) { + return null + } + + return ( + <TextField + id={id} + label={label} + type={type} + value={data ?? ''} + onChange={onChange} + onFocus={handleFocus} + onBlur={handleBlur} + disabled={!enabled} + autoFocus={appliedUiSchemaOptions.focus} + multiline={type === 'text' && appliedUiSchemaOptions.multi} + rows={appliedUiSchemaOptions.multi ? 3 : undefined} + variant="outlined" + fullWidth + size="small" + error={showError} + helperText={helperText} + inputProps={extraInputProps} + className={classes.control} + /> + ) +} + +// Text control wrapper +const OutlinedTextControl = (props) => { + const { path, handleChange, schema, config, uischema } = props + const appliedUiSchemaOptions = merge({}, config, uischema?.options) + + const inputProps = {} + if (appliedUiSchemaOptions.restrict && schema?.maxLength) { + inputProps.maxLength = schema.maxLength + } + + return ( + <OutlinedControl + {...props} + type={appliedUiSchemaOptions.format === 'password' ? 'password' : 'text'} + inputProps={inputProps} + onChange={(ev) => handleChange(path, ev.target.value)} + /> + ) +} + +// Number control wrapper +const OutlinedNumberControl = (props) => { + const { path, handleChange, schema } = props + const { minimum, maximum } = schema || {} + + const inputProps = {} + if (minimum !== undefined) inputProps.min = minimum + if (maximum !== undefined) inputProps.max = maximum + + const handleNumberChange = (ev) => { + const value = ev.target.value + if (value === '') { + handleChange(path, undefined) + } else { + const numValue = Number(value) + if (!isNaN(numValue)) { + handleChange(path, numValue) + } + } + } + + return ( + <OutlinedControl + {...props} + type="number" + inputProps={inputProps} + onChange={handleNumberChange} + /> + ) +} + +// Enum/Select control wrapper +const OutlinedEnumControl = (props) => { + const classes = useStyles() + const { + data, + id, + enabled, + path, + handleChange, + options, + label, + visible, + required, + } = props + const { + appliedUiSchemaOptions, + showError, + helperText, + handleFocus, + handleBlur, + } = useControlState(props) + + if (!visible) { + return null + } + + return ( + <FormControl + fullWidth + variant="outlined" + size="small" + error={showError} + className={classes.control} + > + <InputLabel id={`${id}-label`}>{label}</InputLabel> + <Select + labelId={`${id}-label`} + id={id} + value={data ?? ''} + onChange={(ev) => { + handleChange( + path, + ev.target.value === '' ? undefined : ev.target.value, + ) + }} + onFocus={handleFocus} + onBlur={handleBlur} + disabled={!enabled} + autoFocus={appliedUiSchemaOptions.focus} + label={label} + fullWidth + > + {!required && ( + <MenuItem value=""> + <em>None</em> + </MenuItem> + )} + {options?.map((option) => ( + <MenuItem key={option.value} value={option.value}> + {option.label} + </MenuItem> + ))} + </Select> + {helperText && <FormHelperText>{helperText}</FormHelperText>} + </FormControl> + ) +} + +// Testers - higher rank than default to override default renderers +// Enum renderers have highest rank since isStringControl also matches enum fields +export const OutlinedEnumRenderer = { + tester: rankWith(5, isEnumControl), + renderer: withJsonFormsEnumProps(OutlinedEnumControl), +} + +export const OutlinedOneOfEnumRenderer = { + tester: rankWith(5, isOneOfEnumControl), + renderer: withJsonFormsOneOfEnumProps(OutlinedEnumControl), +} + +export const OutlinedTextRenderer = { + tester: rankWith(3, and(isStringControl, not(optionIs('format', 'radio')))), + renderer: withJsonFormsControlProps(OutlinedTextControl), +} + +export const OutlinedNumberRenderer = { + tester: rankWith(3, or(isIntegerControl, isNumberControl)), + renderer: withJsonFormsControlProps(OutlinedNumberControl), +} diff --git a/ui/src/plugin/PluginList.jsx b/ui/src/plugin/PluginList.jsx new file mode 100644 index 000000000..346e1ceae --- /dev/null +++ b/ui/src/plugin/PluginList.jsx @@ -0,0 +1,178 @@ +import React, { useMemo, useState, useCallback } from 'react' +import { + Button, + Datagrid, + Empty, + TextField, + TopToolbar, + useNotify, + useRecordContext, + useRefresh, + useTranslate, +} from 'react-admin' +import { makeStyles } from '@material-ui/core/styles' +import { + useMediaQuery, + Tooltip, + Chip, + Typography, + Box, +} from '@material-ui/core' +import { MdError, MdRefresh } from 'react-icons/md' +import { List, DateField, SimpleList, useResourceRefresh } from '../common' +import { httpClient } from '../dataProvider' +import ToggleEnabledSwitch from './ToggleEnabledSwitch' + +const useStyles = makeStyles((theme) => ({ + errorIcon: { + color: theme.palette.error.main, + marginRight: theme.spacing(0.5), + verticalAlign: 'middle', + }, + errorChip: { + backgroundColor: theme.palette.error.light, + color: theme.palette.error.contrastText, + }, +})) + +const useManifest = () => { + const record = useRecordContext() + return useMemo(() => { + if (!record?.manifest) return null + try { + return JSON.parse(record.manifest) + } catch { + return null + } + }, [record?.manifest]) +} + +const EnabledOrErrorField = () => { + const record = useRecordContext() + const translate = useTranslate() + const classes = useStyles() + const manifest = useManifest() + + if (record.lastError) { + return ( + <Tooltip title={record.lastError}> + <Chip + size="small" + icon={<MdError className={classes.errorIcon} />} + label={translate('resources.plugin.fields.hasError')} + className={classes.errorChip} + /> + </Tooltip> + ) + } + + return <ToggleEnabledSwitch source={'enabled'} manifest={manifest} /> +} + +const ManifestField = ({ source }) => { + const manifest = useManifest() + + if (!manifest) { + return <Typography variant="body2">-</Typography> + } + + return <Typography variant="body2">{manifest[source] || '-'}</Typography> +} + +const RescanButton = () => { + const notify = useNotify() + const refresh = useRefresh() + const [loading, setLoading] = useState(false) + + const handleRescan = useCallback(() => { + setLoading(true) + httpClient('/api/plugin/rescan', { method: 'POST' }) + .then(() => { + refresh() + }) + .catch((error) => { + notify(error.message || 'ra.page.error', { type: 'warning' }) + }) + .finally(() => { + setLoading(false) + }) + }, [notify, refresh]) + + return ( + <Button + onClick={handleRescan} + disabled={loading} + label="resources.plugin.actions.rescan" + data-testid="rescan-button" + > + <MdRefresh /> + </Button> + ) +} + +const PluginListActions = () => { + return ( + <TopToolbar> + <RescanButton /> + </TopToolbar> + ) +} + +const PluginEmpty = () => { + return ( + <> + <Empty /> + <Box textAlign="center" mt={2}> + <RescanButton /> + </Box> + </> + ) +} + +const PluginList = (props) => { + const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) + const translate = useTranslate() + useResourceRefresh('plugin') + + return ( + <List + {...props} + sort={{ field: 'id', order: 'ASC' }} + exporter={false} + bulkActionButtons={false} + actions={<PluginListActions />} + empty={<PluginEmpty />} + > + {isXsmall ? ( + <SimpleList + primaryText={(record) => record.id} + secondaryText={(record) => { + try { + const manifest = JSON.parse(record.manifest) + return manifest.description || '' + } catch { + return '' + } + }} + tertiaryText={(record) => + record.enabled + ? translate('resources.plugin.status.enabled') + : translate('resources.plugin.status.disabled') + } + linkType="show" + /> + ) : ( + <Datagrid rowClick="show"> + <TextField source="id" /> + <ManifestField source="name" /> + {!isXsmall && <ManifestField source="description" />} + <ManifestField source="version" /> + <EnabledOrErrorField source={'enabled'} /> + <DateField source="updatedAt" sortByOrder={'DESC'} /> + </Datagrid> + )} + </List> + ) +} + +export default PluginList diff --git a/ui/src/plugin/PluginList.test.jsx b/ui/src/plugin/PluginList.test.jsx new file mode 100644 index 000000000..c2e0414eb --- /dev/null +++ b/ui/src/plugin/PluginList.test.jsx @@ -0,0 +1,173 @@ +import React from 'react' +import { + render, + screen, + fireEvent, + waitFor, + within, +} from '@testing-library/react' +import { describe, it, expect, vi, beforeEach } from 'vitest' + +const mockNotify = vi.fn() +const mockRefresh = vi.fn() + +// Mock react-admin hooks +vi.mock('react-admin', async () => { + const actual = await vi.importActual('react-admin') + return { + ...actual, + useUpdate: vi.fn(() => [vi.fn(), { loading: false }]), + useNotify: vi.fn(() => mockNotify), + useRefresh: vi.fn(() => mockRefresh), + useTranslate: vi.fn(() => (key) => key), + useResourceContext: vi.fn(() => 'plugin'), + useRecordContext: vi.fn(() => ({ + id: 'test-plugin', + manifest: JSON.stringify({ + name: 'Test Plugin', + version: '1.0.0', + description: 'Test plugin', + }), + enabled: true, + lastError: null, + })), + Button: ({ onClick, disabled, label, children }) => ( + <button onClick={onClick} disabled={disabled} data-testid="rescan-button"> + {children} + {label} + </button> + ), + TopToolbar: ({ children }) => ( + <div data-testid="top-toolbar">{children}</div> + ), + Empty: () => <div data-testid="ra-empty">No resources</div>, + Datagrid: ({ children }) => <div data-testid="datagrid">{children}</div>, + TextField: ({ source }) => <span data-testid={`text-${source}`} />, + } +}) + +// Mock common components +vi.mock('../common', async () => { + return { + List: ({ children, actions, empty, ...props }) => ( + <div data-testid="list"> + {actions} + {empty && <div data-testid="empty-state">{empty}</div>} + {children} + </div> + ), + DateField: ({ source }) => <span data-testid={`date-${source}`} />, + SimpleList: ({ primaryText, secondaryText }) => ( + <div data-testid="simple-list" /> + ), + useResourceRefresh: vi.fn(), + } +}) + +// Mock Material-UI +vi.mock('@material-ui/core', async () => { + const actual = await vi.importActual('@material-ui/core') + return { + ...actual, + useMediaQuery: vi.fn(() => false), + } +}) + +// Mock ToggleEnabledSwitch +vi.mock('./ToggleEnabledSwitch', () => ({ + default: () => <span data-testid="toggle-switch" />, +})) + +// Mock httpClient +const mockHttpClient = vi.fn() +vi.mock('../dataProvider', () => ({ + httpClient: (...args) => mockHttpClient(...args), +})) + +import PluginList from './PluginList' + +describe('PluginList', () => { + beforeEach(() => { + vi.clearAllMocks() + mockHttpClient.mockResolvedValue({}) + }) + + it('renders the list component', () => { + render(<PluginList />) + expect(screen.getByTestId('list')).toBeInTheDocument() + }) + + it('renders the datagrid on desktop', () => { + render(<PluginList />) + expect(screen.getByTestId('datagrid')).toBeInTheDocument() + }) + + it('renders the rescan button in the toolbar', () => { + render(<PluginList />) + const toolbar = screen.getByTestId('top-toolbar') + expect(within(toolbar).getByTestId('rescan-button')).toBeInTheDocument() + }) + + it('calls rescan endpoint when rescan button is clicked', async () => { + render(<PluginList />) + const toolbar = screen.getByTestId('top-toolbar') + const rescanButton = within(toolbar).getByTestId('rescan-button') + + fireEvent.click(rescanButton) + + await waitFor(() => { + expect(mockHttpClient).toHaveBeenCalledWith('/api/plugin/rescan', { + method: 'POST', + }) + }) + }) + + it('calls refresh after successful rescan', async () => { + render(<PluginList />) + const toolbar = screen.getByTestId('top-toolbar') + const rescanButton = within(toolbar).getByTestId('rescan-button') + + fireEvent.click(rescanButton) + + await waitFor(() => { + expect(mockRefresh).toHaveBeenCalled() + }) + }) + + it('shows error notification on rescan failure', async () => { + mockHttpClient.mockRejectedValue(new Error('Network error')) + + render(<PluginList />) + const toolbar = screen.getByTestId('top-toolbar') + const rescanButton = within(toolbar).getByTestId('rescan-button') + + fireEvent.click(rescanButton) + + await waitFor(() => { + expect(mockNotify).toHaveBeenCalledWith('Network error', { + type: 'warning', + }) + }) + }) + + it('renders a rescan button in the empty state', () => { + render(<PluginList />) + const emptyState = screen.getByTestId('empty-state') + expect(emptyState).toBeInTheDocument() + expect(within(emptyState).getByTestId('rescan-button')).toBeInTheDocument() + }) + + it('empty state rescan button triggers rescan', async () => { + render(<PluginList />) + const emptyState = screen.getByTestId('empty-state') + const rescanButton = within(emptyState).getByTestId('rescan-button') + + fireEvent.click(rescanButton) + + await waitFor(() => { + expect(mockHttpClient).toHaveBeenCalledWith('/api/plugin/rescan', { + method: 'POST', + }) + }) + }) +}) diff --git a/ui/src/plugin/PluginShow.jsx b/ui/src/plugin/PluginShow.jsx new file mode 100644 index 000000000..caea44a75 --- /dev/null +++ b/ui/src/plugin/PluginShow.jsx @@ -0,0 +1,350 @@ +import React, { useState, useCallback, useMemo } from 'react' +import { + ShowContextProvider, + useShowController, + useShowContext, + useTranslate, + useUpdate, + useNotify, + useRefresh, + Title as RaTitle, + Loading, +} from 'react-admin' +import { Box, useMediaQuery, Button } from '@material-ui/core' +import { MdSave } from 'react-icons/md' +import Alert from '@material-ui/lab/Alert' +import { Title, useResourceRefresh } from '../common' +import { usePluginShowStyles } from './styles.js' +import { ErrorSection } from './ErrorSection' +import { StatusCard } from './StatusCard' +import { InfoCard } from './InfoCard' +import { ManifestSection } from './ManifestSection' +import { ConfigCard } from './ConfigCard' +import { UsersPermissionCard } from './UsersPermissionCard' +import { LibraryPermissionCard } from './LibraryPermissionCard' + +// Main show layout component +const PluginShowLayout = () => { + const { record, isPending, error } = useShowContext() + const classes = usePluginShowStyles() + const translate = useTranslate() + const notify = useNotify() + const refresh = useRefresh() + const isSmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) + useResourceRefresh('plugin') + + const [configData, setConfigData] = useState({}) + const [configErrors, setConfigErrors] = useState([]) + const [isDirty, setIsDirty] = useState(false) + const [lastRecordConfig, setLastRecordConfig] = useState(null) + const [isConfigInitialized, setIsConfigInitialized] = useState(false) + + // Users permission state + const [selectedUsers, setSelectedUsers] = useState([]) + const [allUsers, setAllUsers] = useState(false) + const [lastRecordUsers, setLastRecordUsers] = useState(null) + const [lastRecordAllUsers, setLastRecordAllUsers] = useState(null) + + // Libraries permission state + const [selectedLibraries, setSelectedLibraries] = useState([]) + const [allLibraries, setAllLibraries] = useState(false) + const [allowWriteAccess, setAllowWriteAccess] = useState(false) + const [lastRecordLibraries, setLastRecordLibraries] = useState(null) + const [lastRecordAllLibraries, setLastRecordAllLibraries] = useState(null) + const [lastRecordAllowWriteAccess, setLastRecordAllowWriteAccess] = + useState(null) + + // Parse JSON config to object + const jsonToObject = useCallback((jsonString) => { + if (!jsonString || jsonString.trim() === '') return {} + try { + return JSON.parse(jsonString) + } catch { + return {} + } + }, []) + + // Initialize/update config when record loads or changes (e.g., from SSE refresh) + React.useEffect(() => { + const recordConfig = record?.config || '' + if (record && recordConfig !== lastRecordConfig && !isDirty) { + setConfigData(jsonToObject(recordConfig)) + setLastRecordConfig(recordConfig) + // Reset initialization flag - AJV will apply defaults on first render + setIsConfigInitialized(false) + } + }, [record, lastRecordConfig, isDirty, jsonToObject]) + + // Initialize/update users permission state when record loads or changes + React.useEffect(() => { + if (record && !isDirty) { + const recordUsers = record.users || '' + const recordAllUsers = record.allUsers || false + + if ( + recordUsers !== lastRecordUsers || + recordAllUsers !== lastRecordAllUsers + ) { + try { + setSelectedUsers(recordUsers ? JSON.parse(recordUsers) : []) + } catch { + setSelectedUsers([]) + } + setAllUsers(recordAllUsers) + setLastRecordUsers(recordUsers) + setLastRecordAllUsers(recordAllUsers) + } + } + }, [record, lastRecordUsers, lastRecordAllUsers, isDirty]) + + // Initialize/update libraries permission state when record loads or changes + React.useEffect(() => { + if (record && !isDirty) { + const recordLibraries = record.libraries || '' + const recordAllLibraries = record.allLibraries || false + const recordAllowWriteAccess = record.allowWriteAccess || false + + if ( + recordLibraries !== lastRecordLibraries || + recordAllLibraries !== lastRecordAllLibraries || + recordAllowWriteAccess !== lastRecordAllowWriteAccess + ) { + try { + setSelectedLibraries( + recordLibraries ? JSON.parse(recordLibraries) : [], + ) + } catch { + setSelectedLibraries([]) + } + setAllLibraries(recordAllLibraries) + setAllowWriteAccess(recordAllowWriteAccess) + setLastRecordLibraries(recordLibraries) + setLastRecordAllLibraries(recordAllLibraries) + setLastRecordAllowWriteAccess(recordAllowWriteAccess) + } + } + }, [ + record, + lastRecordLibraries, + lastRecordAllLibraries, + lastRecordAllowWriteAccess, + isDirty, + ]) + + const handleConfigDataChange = useCallback( + (newData, errors) => { + setConfigData(newData) + setConfigErrors(errors || []) + // Skip marking dirty on initial onChange (when AJV applies defaults) + if (isConfigInitialized) { + setIsDirty(true) + } else { + setIsConfigInitialized(true) + } + }, + [isConfigInitialized], + ) + + const handleSelectedUsersChange = useCallback((newSelectedUsers) => { + setSelectedUsers(newSelectedUsers) + setIsDirty(true) + }, []) + + const handleAllUsersChange = useCallback((newAllUsers) => { + setAllUsers(newAllUsers) + setIsDirty(true) + }, []) + + const handleSelectedLibrariesChange = useCallback((newSelectedLibraries) => { + setSelectedLibraries(newSelectedLibraries) + setIsDirty(true) + }, []) + + const handleAllLibrariesChange = useCallback((newAllLibraries) => { + setAllLibraries(newAllLibraries) + setIsDirty(true) + }, []) + + const handleAllowWriteAccessChange = useCallback((newAllowWriteAccess) => { + setAllowWriteAccess(newAllowWriteAccess) + setIsDirty(true) + }, []) + + const [updatePlugin, { loading }] = useUpdate( + 'plugin', + record?.id, + {}, + record, + { + undoable: false, + onSuccess: () => { + refresh() + setIsDirty(false) + setLastRecordConfig(null) // Reset to reinitialize from server + setLastRecordUsers(null) + setLastRecordAllUsers(null) + setLastRecordLibraries(null) + setLastRecordAllLibraries(null) + setLastRecordAllowWriteAccess(null) + notify('resources.plugin.notifications.updated', 'info') + }, + onFailure: (err) => { + notify( + err?.message || 'resources.plugin.notifications.error', + 'warning', + ) + }, + }, + ) + + const handleSaveConfig = useCallback(() => { + if (!record) return + const parsedManifest = record.manifest ? JSON.parse(record.manifest) : null + const data = {} + + // Only include config if the plugin has a config schema + if (parsedManifest?.config?.schema) { + data.config = + Object.keys(configData).length > 0 ? JSON.stringify(configData) : '' + } + + // Include users data if users permission is present + if (parsedManifest?.permissions?.users) { + data.users = JSON.stringify(selectedUsers) + data.allUsers = allUsers + } + + // Include libraries data if library permission is present + if (parsedManifest?.permissions?.library) { + data.libraries = JSON.stringify(selectedLibraries) + data.allLibraries = allLibraries + data.allowWriteAccess = allowWriteAccess + } + + updatePlugin('plugin', record.id, data, record) + }, [ + updatePlugin, + record, + configData, + selectedUsers, + allUsers, + selectedLibraries, + allLibraries, + allowWriteAccess, + ]) + + // Parse manifest + const { manifest, manifestJson } = useMemo(() => { + if (!record?.manifest) return { manifest: null, manifestJson: '' } + try { + const parsed = JSON.parse(record.manifest) + return { manifest: parsed, manifestJson: JSON.stringify(parsed, null, 2) } + } catch { + return { manifest: null, manifestJson: record.manifest } + } + }, [record?.manifest]) + + // Handle loading state + if (isPending) { + return <Loading /> + } + + // Handle error state + if (error) { + return ( + <Alert severity="error">{translate('ra.notification.http_error')}</Alert> + ) + } + + // Handle missing record + if (!record) { + return null + } + + return ( + <> + <RaTitle + title={ + <Title + subTitle={`${translate('resources.plugin.name', { smart_count: 1 })} "${record.id}"`} + /> + } + /> + <Box className={classes.root}> + <ErrorSection error={record.lastError} translate={translate} /> + + <StatusCard + classes={classes} + translate={translate} + manifest={manifest} + /> + + <InfoCard + record={record} + manifest={manifest} + classes={classes} + translate={translate} + isSmall={isSmall} + /> + + <ManifestSection + manifestJson={manifestJson} + classes={classes} + translate={translate} + /> + + <ConfigCard + manifest={manifest} + configData={configData} + onConfigDataChange={handleConfigDataChange} + classes={classes} + translate={translate} + /> + + <UsersPermissionCard + manifest={manifest} + classes={classes} + selectedUsers={selectedUsers} + allUsers={allUsers} + onSelectedUsersChange={handleSelectedUsersChange} + onAllUsersChange={handleAllUsersChange} + /> + + <LibraryPermissionCard + manifest={manifest} + classes={classes} + selectedLibraries={selectedLibraries} + allLibraries={allLibraries} + allowWriteAccess={allowWriteAccess} + onSelectedLibrariesChange={handleSelectedLibrariesChange} + onAllLibrariesChange={handleAllLibrariesChange} + onAllowWriteAccessChange={handleAllowWriteAccessChange} + /> + + <Box display="flex" justifyContent="flex-end"> + <Button + variant="contained" + color="primary" + startIcon={<MdSave />} + onClick={handleSaveConfig} + disabled={!isDirty || loading || configErrors.length > 0} + className={classes.saveButton} + > + {translate('ra.action.save')} + </Button> + </Box> + </Box> + </> + ) +} + +const PluginShow = (props) => { + const controllerProps = useShowController(props) + return ( + <ShowContextProvider value={controllerProps}> + <PluginShowLayout /> + </ShowContextProvider> + ) +} + +export default PluginShow diff --git a/ui/src/plugin/SchemaConfigEditor.jsx b/ui/src/plugin/SchemaConfigEditor.jsx new file mode 100644 index 000000000..dc8f8a0f1 --- /dev/null +++ b/ui/src/plugin/SchemaConfigEditor.jsx @@ -0,0 +1,239 @@ +import React, { useCallback, useEffect, useMemo, useRef } from 'react' +import PropTypes from 'prop-types' +import { JsonForms } from '@jsonforms/react' +import { materialRenderers, materialCells } from '@jsonforms/material-renderers' +import { makeStyles } from '@material-ui/core/styles' +import { Typography } from '@material-ui/core' +import { useTranslate } from 'react-admin' +import Ajv from 'ajv' +import { + OutlinedTextRenderer, + OutlinedNumberRenderer, + OutlinedEnumRenderer, + OutlinedOneOfEnumRenderer, +} from './OutlinedRenderers' + +// Error boundary for catching JSONForms rendering errors +class SchemaErrorBoundary extends React.Component { + constructor(props) { + super(props) + this.state = { hasError: false, error: null } + } + + static getDerivedStateFromError(error) { + return { hasError: true, error } + } + + render() { + if (this.state.hasError) { + return this.props.fallback(this.state.error) + } + return this.props.children + } +} + +SchemaErrorBoundary.propTypes = { + children: PropTypes.node.isRequired, + fallback: PropTypes.func.isRequired, +} + +// Custom AJV instance that fixes "required" error paths for JSONForms. +// AJV outputs required errors pointing to the parent (e.g., "/users/1") with +// params.missingProperty. We transform them to point to the field directly +// (e.g., "/users/1/username") so JSONForms displays them under the correct input. +const ajv = new Ajv({ + useDefaults: true, + allErrors: true, + verbose: true, + jsonPointers: true, +}) +const origCompile = ajv.compile.bind(ajv) +ajv.compile = (schema) => { + const validate = origCompile(schema) + const wrapped = (data) => { + const valid = validate(data) + validate.errors?.forEach((e) => { + if (e.keyword === 'required' && e.params?.missingProperty) { + e.dataPath = `${e.dataPath || ''}/${e.params.missingProperty}` + } + }) + wrapped.errors = validate.errors + return valid + } + wrapped.schema = validate.schema + return wrapped +} + +const useStyles = makeStyles( + (theme) => ({ + root: { + '& .MuiFormControl-root': { + marginBottom: theme.spacing(2), + }, + // Label elements (type: "Label" in UI schema) - make slightly smaller + '& .MuiTypography-h6': { + fontSize: '0.95rem', + }, + // Group/array styling + '& .MuiPaper-root': { + backgroundColor: 'transparent', + }, + // Array items styling + '& .MuiAccordion-root': { + marginBottom: theme.spacing(1), + '&:before': { + display: 'none', + }, + }, + '& .MuiAccordionSummary-root': { + backgroundColor: + theme.palette.type === 'dark' + ? theme.palette.grey[800] + : theme.palette.grey[100], + // Hide expand icon - items are always expanded + '& .MuiAccordionSummary-expandIcon': { + display: 'none', + }, + }, + // Checkbox/switch styling + '& .MuiCheckbox-root, & .MuiSwitch-root': { + color: theme.palette.text.secondary, + }, + '& .Mui-checked': { + color: theme.palette.primary.main, + }, + }, + errorContainer: { + padding: theme.spacing(2), + backgroundColor: + theme.palette.type === 'dark' + ? 'rgba(244, 67, 54, 0.1)' + : 'rgba(244, 67, 54, 0.05)', + borderRadius: theme.shape.borderRadius, + border: `1px solid ${theme.palette.error.main}`, + }, + errorMessage: { + color: theme.palette.error.main, + marginBottom: theme.spacing(1), + }, + errorDetails: { + color: theme.palette.text.secondary, + fontSize: '0.85em', + fontFamily: 'monospace', + whiteSpace: 'pre-wrap', + wordBreak: 'break-word', + }, + }), + { name: 'NDSchemaConfigEditor' }, +) + +// Custom renderers with outlined text inputs and always-expanded array layout +const customRenderers = [ + // Put our custom renderers first (higher priority) + OutlinedTextRenderer, + OutlinedNumberRenderer, + OutlinedEnumRenderer, + OutlinedOneOfEnumRenderer, + // Then all the standard material renderers + ...materialRenderers, +] + +export const SchemaConfigEditor = ({ + schema, + uiSchema, + data, + onChange, + readOnly = false, +}) => { + const classes = useStyles() + const translate = useTranslate() + const containerRef = useRef(null) + + // Disable browser autocomplete on all inputs + useEffect(() => { + if (!containerRef.current) return + + const disableAutocomplete = () => { + const inputs = containerRef.current.querySelectorAll('input') + inputs.forEach((input) => { + input.setAttribute('autocomplete', 'off') + }) + } + + // Run immediately and observe for changes (new inputs added) + disableAutocomplete() + const observer = new MutationObserver(disableAutocomplete) + observer.observe(containerRef.current, { childList: true, subtree: true }) + + return () => observer.disconnect() + }, [data]) + + // Memoize the change handler to extract just the data + const handleChange = useCallback( + ({ data: newData, errors }) => { + if (onChange) { + onChange(newData, errors) + } + }, + [onChange], + ) + + // Use custom renderers with always-expanded array layout + const renderers = useMemo(() => customRenderers, []) + const cells = useMemo(() => materialCells, []) + + // JSONForms config - always show descriptions + const config = { + showUnfocusedDescription: true, + } + + // Ensure schema has required fields for JSONForms + const normalizedSchema = useMemo(() => { + if (!schema) return null + // JSONForms requires type to be set at root level + return { + type: 'object', + ...schema, + } + }, [schema]) + + if (!normalizedSchema) { + return null + } + + const renderError = (error) => ( + <div className={classes.errorContainer}> + <Typography className={classes.errorMessage}> + {translate('resources.plugin.messages.schemaRenderError')} + </Typography> + <Typography className={classes.errorDetails}>{error?.message}</Typography> + </div> + ) + + return ( + <div ref={containerRef} className={classes.root}> + <SchemaErrorBoundary fallback={renderError}> + <JsonForms + schema={normalizedSchema} + uischema={uiSchema} + data={data || {}} + renderers={renderers} + cells={cells} + config={config} + onChange={handleChange} + readonly={readOnly} + ajv={ajv} + validationMode="ValidateAndShow" + /> + </SchemaErrorBoundary> + </div> + ) +} + +SchemaConfigEditor.propTypes = { + schema: PropTypes.object, + uiSchema: PropTypes.object, + data: PropTypes.object, + onChange: PropTypes.func, + readOnly: PropTypes.bool, +} diff --git a/ui/src/plugin/SchemaConfigEditor.test.jsx b/ui/src/plugin/SchemaConfigEditor.test.jsx new file mode 100644 index 000000000..ab93e3ac8 --- /dev/null +++ b/ui/src/plugin/SchemaConfigEditor.test.jsx @@ -0,0 +1,86 @@ +import React from 'react' +import { describe, it, expect, vi } from 'vitest' +import { render } from '@testing-library/react' +import { ThemeProvider, createTheme } from '@material-ui/core/styles' +import { Provider } from 'react-redux' +import { createStore } from 'redux' +import { SchemaConfigEditor } from './SchemaConfigEditor' + +const theme = createTheme() + +// JSONForms requires Redux +const mockStore = createStore(() => ({})) + +const renderWithProviders = (component) => { + return render( + <Provider store={mockStore}> + <ThemeProvider theme={theme}>{component}</ThemeProvider> + </Provider>, + ) +} + +describe('SchemaConfigEditor', () => { + const basicSchema = { + type: 'object', + properties: { + name: { + type: 'string', + title: 'Name', + }, + enabled: { + type: 'boolean', + title: 'Enabled', + }, + }, + } + + it('renders nothing when schema is null', () => { + const { container } = renderWithProviders( + <SchemaConfigEditor schema={null} data={{}} onChange={vi.fn()} />, + ) + expect(container.firstChild).toBeNull() + }) + + it('renders the component wrapper with valid schema', () => { + const { container } = renderWithProviders( + <SchemaConfigEditor schema={basicSchema} data={{}} onChange={vi.fn()} />, + ) + // Check that the wrapper div is rendered (class name is generated) + expect( + container.querySelector('[class*="NDSchemaConfigEditor-root"]'), + ).toBeTruthy() + }) + + it('calls onChange on initial render', () => { + const onChange = vi.fn() + renderWithProviders( + <SchemaConfigEditor + schema={basicSchema} + data={{ name: 'Test' }} + onChange={onChange} + />, + ) + + // JSONForms calls onChange on initial render with initial state + expect(onChange).toHaveBeenCalled() + }) + + it('passes data and errors to onChange callback', () => { + const onChange = vi.fn() + const initialData = { name: 'Test Value' } + + renderWithProviders( + <SchemaConfigEditor + schema={basicSchema} + data={initialData} + onChange={onChange} + />, + ) + + // Check that onChange was called with data and errors + expect(onChange).toHaveBeenCalledWith( + expect.objectContaining({ name: 'Test Value' }), + expect.any(Array), + ) + }) +}) diff --git a/ui/src/plugin/StatusCard.jsx b/ui/src/plugin/StatusCard.jsx new file mode 100644 index 000000000..323a4ec10 --- /dev/null +++ b/ui/src/plugin/StatusCard.jsx @@ -0,0 +1,23 @@ +import React from 'react' +import PropTypes from 'prop-types' +import { Card, CardContent, Typography } from '@material-ui/core' +import ToggleEnabledSwitch from './ToggleEnabledSwitch' + +export const StatusCard = ({ classes, translate, manifest }) => { + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.status')} + </Typography> + <ToggleEnabledSwitch showLabel size="medium" manifest={manifest} /> + </CardContent> + </Card> + ) +} + +StatusCard.propTypes = { + classes: PropTypes.object.isRequired, + translate: PropTypes.func.isRequired, + manifest: PropTypes.object, +} diff --git a/ui/src/plugin/ToggleEnabledSwitch.jsx b/ui/src/plugin/ToggleEnabledSwitch.jsx new file mode 100644 index 000000000..0b7b4d7d7 --- /dev/null +++ b/ui/src/plugin/ToggleEnabledSwitch.jsx @@ -0,0 +1,197 @@ +import React, { useCallback, useMemo } from 'react' +import { + useUpdate, + useNotify, + useRefresh, + useRecordContext, + useTranslate, + useResourceContext, +} from 'react-admin' +import Switch from '@material-ui/core/Switch' +import { makeStyles } from '@material-ui/core/styles' +import { Tooltip, FormControlLabel } from '@material-ui/core' +import PropTypes from 'prop-types' + +const useStyles = makeStyles((theme) => ({ + enabledSwitch: { + '& .MuiSwitch-colorSecondary.Mui-checked': { + color: theme.palette.success?.main || theme.palette.primary.main, + }, + '& .MuiSwitch-colorSecondary.Mui-checked + .MuiSwitch-track': { + backgroundColor: + theme.palette.success?.main || theme.palette.primary.main, + }, + }, + errorSwitch: { + '& .MuiSwitch-thumb': { + backgroundColor: theme.palette.warning.main, + }, + '& .MuiSwitch-track': { + backgroundColor: theme.palette.warning.light, + opacity: 0.7, + }, + }, +})) + +/** + * Shared toggle switch for enabling/disabling plugins. + * Used in both PluginList (compact) and PluginShow (with label). + * + * @param {Object} props + * @param {boolean} [props.showLabel=false] - Whether to show the enable/disable label + * @param {string} [props.size='small'] - Switch size ('small' or 'medium') + * @param {Object} [props.manifest=null] - Parsed manifest object for permission checking + */ +const ToggleEnabledSwitch = ({ + showLabel = false, + size = 'small', + manifest = null, +}) => { + const resource = useResourceContext() + const record = useRecordContext() + const notify = useNotify() + const refresh = useRefresh() + const translate = useTranslate() + const classes = useStyles() + + const [toggleEnabled, { loading }] = useUpdate( + resource, + record?.id, + { enabled: !record?.enabled }, + record, + { + undoable: false, + onSuccess: () => { + refresh() + notify( + record?.enabled + ? 'resources.plugin.notifications.disabled' + : 'resources.plugin.notifications.enabled', + 'info', + ) + }, + onFailure: (error) => { + refresh() + notify( + error?.message || 'resources.plugin.notifications.error', + 'warning', + ) + }, + }, + ) + + const handleClick = useCallback( + (e) => { + e.stopPropagation() + toggleEnabled() + }, + [toggleEnabled], + ) + + const hasError = !!record?.lastError + + // Check if users permission is required but not configured + const usersPermissionRequired = useMemo(() => { + if (!manifest?.permissions?.users) return false + if (record?.allUsers) return false + // Check if users array is empty or not set + if (!record?.users) return true + try { + const users = JSON.parse(record.users) + return users.length === 0 + } catch { + return true + } + }, [manifest, record?.allUsers, record?.users]) + + // Check if library permission is required but not configured + const libraryPermissionRequired = useMemo(() => { + if (!manifest?.permissions?.library) return false + if (record?.allLibraries) return false + // Check if libraries array is empty or not set + if (!record?.libraries) return true + try { + const libraries = JSON.parse(record.libraries) + return libraries.length === 0 + } catch { + return true + } + }, [manifest, record?.allLibraries, record?.libraries]) + + const permissionRequired = + usersPermissionRequired || libraryPermissionRequired + const isDisabled = + loading || hasError || (permissionRequired && !record?.enabled) + + const tooltipTitle = useMemo(() => { + if (hasError) { + return translate('resources.plugin.actions.disabledDueToError') + } + if (usersPermissionRequired && !record?.enabled) { + return translate('resources.plugin.actions.disabledUsersRequired') + } + if (libraryPermissionRequired && !record?.enabled) { + return translate('resources.plugin.actions.disabledLibrariesRequired') + } + if (!showLabel) { + return translate( + record?.enabled + ? 'resources.plugin.actions.disable' + : 'resources.plugin.actions.enable', + ) + } + return '' + }, [ + hasError, + usersPermissionRequired, + libraryPermissionRequired, + showLabel, + record?.enabled, + translate, + ]) + + const switchElement = ( + <Switch + checked={record?.enabled ?? false} + onClick={handleClick} + disabled={isDisabled} + className={isDisabled ? classes.errorSwitch : classes.enabledSwitch} + size={size} + color="primary" + /> + ) + + if (showLabel) { + const showTooltip = hasError || (permissionRequired && !record?.enabled) + return ( + <Tooltip + title={tooltipTitle} + disableHoverListener={!showTooltip} + disableFocusListener={!showTooltip} + > + <FormControlLabel + control={switchElement} + label={translate( + record?.enabled + ? 'resources.plugin.actions.disable' + : 'resources.plugin.actions.enable', + )} + /> + </Tooltip> + ) + } + + return ( + <Tooltip title={tooltipTitle}> + <span>{switchElement}</span> + </Tooltip> + ) +} + +ToggleEnabledSwitch.propTypes = { + showLabel: PropTypes.bool, + size: PropTypes.oneOf(['small', 'medium']), + manifest: PropTypes.object, +} + +export default ToggleEnabledSwitch diff --git a/ui/src/plugin/UsersPermissionCard.jsx b/ui/src/plugin/UsersPermissionCard.jsx new file mode 100644 index 000000000..54a004ce8 --- /dev/null +++ b/ui/src/plugin/UsersPermissionCard.jsx @@ -0,0 +1,168 @@ +import React from 'react' +import { + Card, + CardContent, + Typography, + Box, + FormControlLabel, + Switch, + List, + ListItem, + ListItemIcon, + ListItemText, + Checkbox, +} from '@material-ui/core' +import CheckBoxIcon from '@material-ui/icons/CheckBox' +import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank' +import Alert from '@material-ui/lab/Alert' +import { useGetList, useTranslate } from 'react-admin' +import PropTypes from 'prop-types' + +export const UsersPermissionCard = ({ + manifest, + classes, + selectedUsers, + allUsers, + onSelectedUsersChange, + onAllUsersChange, +}) => { + const translate = useTranslate() + + // Fetch all users + const { data: usersData, loading: usersLoading } = useGetList('user', { + pagination: { page: 1, perPage: 1000 }, + sort: { field: 'userName', order: 'ASC' }, + }) + + const users = React.useMemo(() => { + return usersData ? Object.values(usersData) : [] + }, [usersData]) + + const handleToggleUser = React.useCallback( + (userId) => { + const newSelected = selectedUsers.includes(userId) + ? selectedUsers.filter((id) => id !== userId) + : [...selectedUsers, userId] + onSelectedUsersChange(newSelected) + }, + [selectedUsers, onSelectedUsersChange], + ) + + const handleAllUsersToggle = React.useCallback( + (event) => { + onAllUsersChange(event.target.checked) + }, + [onAllUsersChange], + ) + + // Get permission reason from manifest + const usersPermission = manifest?.permissions?.users + const reason = usersPermission?.reason + + // Check if permission is required but not configured + const isConfigurationRequired = + usersPermission && !allUsers && selectedUsers.length === 0 + + if (!usersPermission) { + return null + } + + return ( + <Card className={classes.section}> + <CardContent> + <Typography variant="h6" className={classes.sectionTitle}> + {translate('resources.plugin.sections.usersPermission')} + </Typography> + + {reason && ( + <Typography variant="body2" color="textSecondary" gutterBottom> + {translate('resources.plugin.messages.permissionReason')}: {reason} + </Typography> + )} + + {isConfigurationRequired && ( + <Box mb={2}> + <Alert severity="warning"> + {translate('resources.plugin.messages.usersRequired')} + </Alert> + </Box> + )} + + <Box mb={2}> + <FormControlLabel + control={ + <Switch + checked={allUsers} + onChange={handleAllUsersToggle} + color="primary" + /> + } + label={translate('resources.plugin.fields.allUsers')} + /> + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.allUsersHelp')} + </Typography> + </Box> + + {!allUsers && ( + <Box className={classes.usersList}> + <Typography variant="subtitle2" gutterBottom> + {translate('resources.plugin.fields.selectedUsers')} + </Typography> + {usersLoading ? ( + <Typography variant="body2" color="textSecondary"> + {translate('ra.message.loading')} + </Typography> + ) : users.length === 0 ? ( + <Typography variant="body2" color="textSecondary"> + {translate('resources.plugin.messages.noUsers')} + </Typography> + ) : ( + <List + dense + style={{ + maxHeight: 200, + overflow: 'auto', + border: '1px solid rgba(0, 0, 0, 0.12)', + borderRadius: 4, + }} + > + {users.map((user) => ( + <ListItem + key={user.id} + button + onClick={() => handleToggleUser(user.id)} + dense + > + <ListItemIcon> + <Checkbox + icon={<CheckBoxOutlineBlankIcon fontSize="small" />} + checkedIcon={<CheckBoxIcon fontSize="small" />} + checked={selectedUsers.includes(user.id)} + tabIndex={-1} + disableRipple + /> + </ListItemIcon> + <ListItemText + primary={user.name || user.userName} + secondary={user.name ? user.userName : null} + /> + </ListItem> + ))} + </List> + )} + </Box> + )} + </CardContent> + </Card> + ) +} + +UsersPermissionCard.propTypes = { + manifest: PropTypes.object, + classes: PropTypes.object.isRequired, + selectedUsers: PropTypes.array.isRequired, + allUsers: PropTypes.bool.isRequired, + onSelectedUsersChange: PropTypes.func.isRequired, + onAllUsersChange: PropTypes.func.isRequired, +} diff --git a/ui/src/plugin/index.js b/ui/src/plugin/index.js new file mode 100644 index 000000000..2385308cc --- /dev/null +++ b/ui/src/plugin/index.js @@ -0,0 +1,9 @@ +import { VscExtensions } from 'react-icons/vsc' +import PluginList from './PluginList' +import PluginShow from './PluginShow' + +export default { + icon: VscExtensions, + list: PluginList, + show: PluginShow, +} diff --git a/ui/src/plugin/jsonValidation.js b/ui/src/plugin/jsonValidation.js new file mode 100644 index 000000000..408d6dac5 --- /dev/null +++ b/ui/src/plugin/jsonValidation.js @@ -0,0 +1,68 @@ +/** + * Validates a JSON string and returns validation result + * @param {string} value - The JSON string to validate + * @returns {{ valid: boolean, error: string|null, parsed: object|null }} + */ +export const validateJson = (value) => { + if (!value || value.trim() === '') { + return { valid: true, error: null, parsed: null } + } + + try { + const parsed = JSON.parse(value) + // Ensure config is an object, not an array or primitive + if ( + typeof parsed !== 'object' || + parsed === null || + Array.isArray(parsed) + ) { + return { + valid: false, + error: 'Configuration must be a JSON object', + parsed: null, + } + } + return { valid: true, error: null, parsed } + } catch (e) { + // Try to provide helpful error messages + let error = 'Invalid JSON' + + if (e instanceof SyntaxError) { + const message = e.message + + // Extract position information if available + const positionMatch = message.match(/position (\d+)/) + if (positionMatch) { + const position = parseInt(positionMatch[1], 10) + const lines = value.substring(0, position).split('\n') + const line = lines.length + const column = lines[lines.length - 1].length + 1 + error = `Invalid JSON at line ${line}, column ${column}` + } else if (message.includes('Unexpected end of JSON')) { + error = 'Incomplete JSON - check for missing brackets or quotes' + } else if (message.includes('Unexpected token')) { + error = 'Invalid JSON - unexpected character found' + } + } + + return { valid: false, error, parsed: null } + } +} + +/** + * Formats JSON string with proper indentation + * @param {string} value - The JSON string to format + * @returns {string} - Formatted JSON string or original if invalid + */ +export const formatJson = (value) => { + if (!value || value.trim() === '') { + return value + } + + try { + const parsed = JSON.parse(value) + return JSON.stringify(parsed, null, 2) + } catch { + return value + } +} diff --git a/ui/src/plugin/jsonValidation.test.js b/ui/src/plugin/jsonValidation.test.js new file mode 100644 index 000000000..f56549d79 --- /dev/null +++ b/ui/src/plugin/jsonValidation.test.js @@ -0,0 +1,97 @@ +import { describe, it, expect } from 'vitest' +import { validateJson, formatJson } from './jsonValidation' + +describe('validateJson', () => { + it('returns valid for empty string', () => { + const result = validateJson('') + expect(result.valid).toBe(true) + expect(result.error).toBeNull() + expect(result.parsed).toBeNull() + }) + + it('returns valid for whitespace only', () => { + const result = validateJson(' ') + expect(result.valid).toBe(true) + expect(result.error).toBeNull() + }) + + it('returns valid for valid JSON object', () => { + const result = validateJson('{"key": "value"}') + expect(result.valid).toBe(true) + expect(result.error).toBeNull() + expect(result.parsed).toEqual({ key: 'value' }) + }) + + it('returns valid for nested JSON object', () => { + const result = validateJson('{"outer": {"inner": 123}}') + expect(result.valid).toBe(true) + expect(result.parsed).toEqual({ outer: { inner: 123 } }) + }) + + it('returns invalid for JSON array', () => { + const result = validateJson('[1, 2, 3]') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for JSON primitive string', () => { + const result = validateJson('"hello"') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for JSON primitive number', () => { + const result = validateJson('42') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for JSON null', () => { + const result = validateJson('null') + expect(result.valid).toBe(false) + expect(result.error).toBe('Configuration must be a JSON object') + }) + + it('returns invalid for malformed JSON', () => { + const result = validateJson('{"key": }') + expect(result.valid).toBe(false) + expect(result.error).toContain('Invalid JSON') + }) + + it('returns invalid for incomplete JSON', () => { + const result = validateJson('{"key": "value"') + expect(result.valid).toBe(false) + expect(result.error).toContain('Invalid JSON') + }) + + it('returns invalid for JSON with trailing comma', () => { + const result = validateJson('{"key": "value",}') + expect(result.valid).toBe(false) + expect(result.error).toContain('Invalid JSON') + }) +}) + +describe('formatJson', () => { + it('returns empty string unchanged', () => { + expect(formatJson('')).toBe('') + }) + + it('returns whitespace unchanged', () => { + expect(formatJson(' ')).toBe(' ') + }) + + it('formats compact JSON with indentation', () => { + const result = formatJson('{"key":"value"}') + expect(result).toBe('{\n "key": "value"\n}') + }) + + it('formats nested JSON with proper indentation', () => { + const result = formatJson('{"outer":{"inner":123}}') + expect(result).toBe('{\n "outer": {\n "inner": 123\n }\n}') + }) + + it('returns invalid JSON unchanged', () => { + const invalid = '{"key": }' + expect(formatJson(invalid)).toBe(invalid) + }) +}) diff --git a/ui/src/plugin/styles.js b/ui/src/plugin/styles.js new file mode 100644 index 000000000..104d8bc0f --- /dev/null +++ b/ui/src/plugin/styles.js @@ -0,0 +1,85 @@ +import { makeStyles } from '@material-ui/core/styles' + +export const usePluginShowStyles = makeStyles( + (theme) => ({ + root: { + padding: theme.spacing(2), + maxWidth: 900, + }, + section: { + marginBottom: theme.spacing(3), + }, + sectionTitle: { + marginBottom: theme.spacing(1), + fontWeight: 600, + }, + manifestBox: { + backgroundColor: + theme.palette.type === 'dark' + ? theme.palette.grey[900] + : theme.palette.grey[100], + padding: theme.spacing(2), + borderRadius: theme.shape.borderRadius, + fontFamily: 'monospace', + fontSize: '0.85rem', + whiteSpace: 'pre-wrap', + wordBreak: 'break-word', + overflow: 'auto', + maxHeight: 400, + }, + saveButton: { + marginTop: theme.spacing(2), + }, + infoGrid: { + '& .MuiGrid-item': { + paddingTop: theme.spacing(0.5), + paddingBottom: theme.spacing(0.5), + }, + }, + infoLabel: { + fontWeight: 500, + color: theme.palette.text.secondary, + }, + pathField: { + fontFamily: 'monospace', + fontSize: '0.85rem', + wordBreak: 'break-all', + }, + permissionsContainer: { + display: 'flex', + flexWrap: 'wrap', + gap: theme.spacing(0.5), + }, + permissionChip: { + fontSize: '0.75rem', + }, + tooltipContent: { + '& code': { + fontFamily: 'monospace', + fontSize: '0.8em', + backgroundColor: 'rgba(255,255,255,0.1)', + padding: '1px 4px', + borderRadius: 2, + }, + }, + configTable: { + '& .MuiTableCell-root': { + padding: theme.spacing(1), + }, + }, + configTableInput: { + fontFamily: 'monospace', + fontSize: '0.85rem', + }, + configActionIconButton: { + backgroundColor: theme.palette.action.hover, + borderRadius: theme.shape.borderRadius, + padding: theme.spacing(0.5, 1), + fontWeight: 700, + '&:hover': { + backgroundColor: theme.palette.action.selected, + }, + }, + }), + { name: 'NDPluginShow' }, +) diff --git a/ui/src/radio/RadioEdit.jsx b/ui/src/radio/RadioEdit.jsx index f00f889f3..bbe001e6f 100644 --- a/ui/src/radio/RadioEdit.jsx +++ b/ui/src/radio/RadioEdit.jsx @@ -6,8 +6,38 @@ import { TextInput, useTranslate, } from 'react-admin' +import { CardMedia } from '@material-ui/core' +import { makeStyles } from '@material-ui/core/styles' import { urlValidate } from '../utils/validations' -import { Title } from '../common' +import { Title, ImageUploadOverlay, useImageLoadingState } from '../common' +import subsonic from '../subsonic' +import config from '../config' +import { RADIO_PLACEHOLDER_IMAGE } from '../consts' + +const useStyles = makeStyles({ + coverParent: { + display: 'inline-flex', + position: 'relative', + width: '8rem', + height: '8rem', + marginBottom: '1em', + }, + cover: { + width: '8rem', + height: '8rem', + objectFit: 'cover', + cursor: 'pointer', + transition: 'opacity 0.3s ease-in-out', + }, + coverLoading: { + opacity: 0.5, + }, + placeholder: { + width: '8rem', + height: '8rem', + objectFit: 'contain', + }, +}) const RadioTitle = ({ record }) => { const translate = useTranslate() @@ -21,6 +51,7 @@ const RadioEdit = (props) => { return ( <Edit title={<RadioTitle />} {...props}> <SimpleForm variant="outlined" {...props}> + <RadioCoverArt /> <TextInput source="name" validate={[required()]} /> <TextInput type="url" @@ -41,4 +72,39 @@ const RadioEdit = (props) => { ) } +const RadioCoverArt = ({ record }) => { + const classes = useStyles() + const { imageLoading, handleImageLoad, handleImageError } = + useImageLoadingState(record?.id) + + if (!record) return null + + return ( + <div className={classes.coverParent}> + {record.uploadedImage ? ( + <CardMedia + component="img" + src={subsonic.getCoverArtUrl(record, config.uiCoverArtSize, true)} + className={`${classes.cover} ${imageLoading ? classes.coverLoading : ''}`} + onLoad={handleImageLoad} + onError={handleImageError} + title={record.name} + alt={record.name} + /> + ) : ( + <img + src={RADIO_PLACEHOLDER_IMAGE} + className={classes.placeholder} + alt={record.name} + /> + )} + <ImageUploadOverlay + entityType="radio" + entityId={record.id} + hasUploadedImage={!!record.uploadedImage} + /> + </div> + ) +} + export default RadioEdit diff --git a/ui/src/radio/RadioList.jsx b/ui/src/radio/RadioList.jsx index 551c4c691..945bac519 100644 --- a/ui/src/radio/RadioList.jsx +++ b/ui/src/radio/RadioList.jsx @@ -1,4 +1,4 @@ -import { makeStyles, useMediaQuery } from '@material-ui/core' +import { Avatar, makeStyles, useMediaQuery } from '@material-ui/core' import React, { cloneElement } from 'react' import { CreateButton, @@ -6,7 +6,6 @@ import { DateField, EditButton, Filter, - List, sanitizeListRestProps, SearchInput, SimpleList, @@ -15,10 +14,17 @@ import { UrlField, useTranslate, } from 'react-admin' -import { ToggleFieldsMenu, useSelectedFields } from '../common' +import { + List, + useImageUrl, + ToggleFieldsMenu, + useSelectedFields, +} from '../common' +import subsonic from '../subsonic' import { StreamField } from './StreamField' import { setTrack } from '../actions' import { songFromRadio } from './helper' +import { RADIO_PLACEHOLDER_IMAGE } from '../consts' import { useDispatch } from 'react-redux' const useStyles = makeStyles({ @@ -73,6 +79,21 @@ const RadioListActions = ({ ) } +const avatarStyle = { width: 40, height: 40 } + +const CoverArtField = ({ record }) => { + const directUrl = record?.uploadedImage + ? subsonic.getCoverArtUrl(record, 40, true) + : null + const { imgUrl } = useImageUrl(directUrl) + if (!record) return null + const src = imgUrl || RADIO_PLACEHOLDER_IMAGE + return ( + <Avatar src={src} variant="rounded" style={avatarStyle} alt={record.name} /> + ) +} +CoverArtField.defaultProps = { label: '' } + const RadioList = ({ permissions, ...props }) => { const classes = useStyles() const isXsmall = useMediaQuery((theme) => theme.breakpoints.down('xs')) @@ -80,6 +101,7 @@ const RadioList = ({ permissions, ...props }) => { const isAdmin = permissions === 'admin' const toggleableFields = { + coverArt: <CoverArtField source="id" sortable={false} />, name: <TextField source="name" />, homePageUrl: ( <UrlField @@ -97,7 +119,7 @@ const RadioList = ({ permissions, ...props }) => { const columns = useSelectedFields({ resource: 'radio', columns: toggleableFields, - defaultOff: ['createdAt'], + defaultOff: ['streamUrl', 'createdAt'], }) const handleRowClick = async (id, basePath, record) => { @@ -117,6 +139,7 @@ const RadioList = ({ permissions, ...props }) => { > {isXsmall ? ( <SimpleList + leftAvatar={(r) => <CoverArtField record={r} />} leftIcon={(r) => ( <StreamField record={r} diff --git a/ui/src/radio/helper.jsx b/ui/src/radio/helper.jsx index 57de244b9..b451dae9a 100644 --- a/ui/src/radio/helper.jsx +++ b/ui/src/radio/helper.jsx @@ -1,16 +1,25 @@ +import subsonic from '../subsonic' +import config from '../config' +import { RADIO_PLACEHOLDER_IMAGE } from '../consts' + export async function songFromRadio(radio) { if (!radio) { return undefined } - let cover = 'internet-radio-icon.svg' - try { - const url = new URL(radio.homePageUrl ?? radio.streamUrl) - url.pathname = '/favicon.ico' - await resourceExists(url) - cover = url.toString() - } catch { - // ignore + let cover = RADIO_PLACEHOLDER_IMAGE + if (radio.uploadedImage) { + cover = subsonic.getCoverArtUrl(radio, config.uiCoverArtSize, true) + } else { + // Try favicon as fallback + try { + const url = new URL(radio.homePageUrl ?? radio.streamUrl) + url.pathname = '/favicon.ico' + await resourceExists(url) + cover = url.toString() + } catch { + // No cover available + } } return { diff --git a/ui/src/reducers/activityReducer.js b/ui/src/reducers/activityReducer.js index 2b6d2741c..d61ed6018 100644 --- a/ui/src/reducers/activityReducer.js +++ b/ui/src/reducers/activityReducer.js @@ -2,6 +2,9 @@ import { EVENT_REFRESH_RESOURCE, EVENT_SCAN_STATUS, EVENT_SERVER_START, + EVENT_NOW_PLAYING_COUNT, + EVENT_NOW_PLAYING_COUNT_SYNC, + EVENT_STREAM_RECONNECTED, } from '../actions' import config from '../config' @@ -14,6 +17,9 @@ const initialState = { elapsedTime: 0, }, serverStart: { version: config.version }, + nowPlayingCount: 0, + nowPlayingLastUpdate: 0, + streamReconnected: 0, // Timestamp of last reconnection } export const activityReducer = (previousState = initialState, payload) => { @@ -40,6 +46,16 @@ export const activityReducer = (previousState = initialState, payload) => { resources: data, }, } + case EVENT_NOW_PLAYING_COUNT: + return { + ...previousState, + nowPlayingCount: data.count, + nowPlayingLastUpdate: Date.now(), + } + case EVENT_NOW_PLAYING_COUNT_SYNC: + return { ...previousState, nowPlayingCount: data.count } + case EVENT_STREAM_RECONNECTED: + return { ...previousState, streamReconnected: Date.now() } default: return previousState } diff --git a/ui/src/reducers/activityReducer.test.js b/ui/src/reducers/activityReducer.test.js index a1389e3d2..e52a262c1 100644 --- a/ui/src/reducers/activityReducer.test.js +++ b/ui/src/reducers/activityReducer.test.js @@ -1,5 +1,10 @@ import { activityReducer } from './activityReducer' -import { EVENT_SCAN_STATUS, EVENT_SERVER_START } from '../actions' +import { + EVENT_SCAN_STATUS, + EVENT_SERVER_START, + EVENT_NOW_PLAYING_COUNT, + EVENT_STREAM_RECONNECTED, +} from '../actions' import config from '../config' describe('activityReducer', () => { @@ -12,6 +17,9 @@ describe('activityReducer', () => { elapsedTime: 0, }, serverStart: { version: config.version }, + nowPlayingCount: 0, + nowPlayingLastUpdate: 0, + streamReconnected: 0, } it('returns the initial state when no action is specified', () => { @@ -116,4 +124,42 @@ describe('activityReducer', () => { startTime: Date.parse('2023-01-01T00:00:00Z'), }) }) + + it('handles EVENT_NOW_PLAYING_COUNT', () => { + const action = { + type: EVENT_NOW_PLAYING_COUNT, + data: { count: 5 }, + } + const newState = activityReducer(initialState, action) + expect(newState.nowPlayingCount).toEqual(5) + }) + + it('handles EVENT_NOW_PLAYING_COUNT with nowPlayingLastUpdate', () => { + const action = { + type: EVENT_NOW_PLAYING_COUNT, + data: { count: 3 }, + } + const beforeTimestamp = Date.now() + const newState = activityReducer(initialState, action) + const afterTimestamp = Date.now() + + expect(newState.nowPlayingCount).toEqual(3) + expect(newState.nowPlayingLastUpdate).toBeGreaterThanOrEqual( + beforeTimestamp, + ) + expect(newState.nowPlayingLastUpdate).toBeLessThanOrEqual(afterTimestamp) + }) + + it('handles EVENT_STREAM_RECONNECTED', () => { + const action = { + type: EVENT_STREAM_RECONNECTED, + data: {}, + } + const beforeTimestamp = Date.now() + const newState = activityReducer(initialState, action) + const afterTimestamp = Date.now() + + expect(newState.streamReconnected).toBeGreaterThanOrEqual(beforeTimestamp) + expect(newState.streamReconnected).toBeLessThanOrEqual(afterTimestamp) + }) }) diff --git a/ui/src/reducers/index.js b/ui/src/reducers/index.js index b9414c864..64a0049b7 100644 --- a/ui/src/reducers/index.js +++ b/ui/src/reducers/index.js @@ -1,3 +1,4 @@ +export * from './libraryReducer' export * from './themeReducer' export * from './dialogReducer' export * from './playerReducer' @@ -5,3 +6,4 @@ export * from './albumView' export * from './activityReducer' export * from './settingsReducer' export * from './replayGainReducer' +export * from './transcodingReducer' diff --git a/ui/src/reducers/libraryReducer.js b/ui/src/reducers/libraryReducer.js new file mode 100644 index 000000000..ef613260f --- /dev/null +++ b/ui/src/reducers/libraryReducer.js @@ -0,0 +1,52 @@ +import { SET_SELECTED_LIBRARIES, SET_USER_LIBRARIES } from '../actions' + +const initialState = { + userLibraries: [], + selectedLibraries: [], // Empty means "all accessible libraries" +} + +export const libraryReducer = (previousState = initialState, payload) => { + const { type, data } = payload + switch (type) { + case SET_USER_LIBRARIES: { + const newUserLibraryIds = data.map((lib) => lib.id) + + // Validate and filter selected libraries to only include IDs that exist in new user libraries + const validatedSelection = previousState.selectedLibraries.filter((id) => + newUserLibraryIds.includes(id), + ) + + // Determine the final selection: + // 1. If first time setting libraries (no previous user libraries), select all + // 2. If user now has only one library, reset to empty (no filter needed) + // 3. Otherwise, use validated selection (may be empty if all previous selections were invalid) + let finalSelection + if ( + previousState.selectedLibraries.length === 0 && + previousState.userLibraries.length === 0 + ) { + // First time: select all libraries + finalSelection = newUserLibraryIds + } else if (newUserLibraryIds.length === 1) { + // Single library: reset selection (empty means "all accessible") + finalSelection = [] + } else { + // Multiple libraries: use validated selection + finalSelection = validatedSelection + } + + return { + ...previousState, + userLibraries: data, + selectedLibraries: finalSelection, + } + } + case SET_SELECTED_LIBRARIES: + return { + ...previousState, + selectedLibraries: data, + } + default: + return previousState + } +} diff --git a/ui/src/reducers/libraryReducer.test.js b/ui/src/reducers/libraryReducer.test.js new file mode 100644 index 000000000..b962c1036 --- /dev/null +++ b/ui/src/reducers/libraryReducer.test.js @@ -0,0 +1,186 @@ +import { describe, it, expect } from 'vitest' +import { libraryReducer } from './libraryReducer' +import { SET_SELECTED_LIBRARIES, SET_USER_LIBRARIES } from '../actions' + +describe('libraryReducer', () => { + const mockLibraries = [ + { id: '1', name: 'Music Library' }, + { id: '2', name: 'Podcasts' }, + { id: '3', name: 'Audiobooks' }, + ] + + const initialState = { + userLibraries: [], + selectedLibraries: [], + } + + describe('SET_USER_LIBRARIES', () => { + it('should set user libraries and select all on first load', () => { + const action = { + type: SET_USER_LIBRARIES, + data: mockLibraries, + } + + const result = libraryReducer(initialState, action) + + expect(result.userLibraries).toEqual(mockLibraries) + expect(result.selectedLibraries).toEqual(['1', '2', '3']) + }) + + it('should reset selection to empty when user has only one library', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: [mockLibraries[0]], // Only one library now + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([mockLibraries[0]]) + expect(result.selectedLibraries).toEqual([]) // Reset for single library + }) + + it('should filter out invalid library IDs from selection', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2', '3'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: [mockLibraries[0], mockLibraries[1]], // Only libraries 1 and 2 remain + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([mockLibraries[0], mockLibraries[1]]) + expect(result.selectedLibraries).toEqual(['1', '2']) // Library 3 removed + }) + + it('should keep valid selection when libraries change', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: mockLibraries, // Same libraries + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual(mockLibraries) + expect(result.selectedLibraries).toEqual(['1']) // Selection preserved + }) + + it('should handle selection becoming empty after filtering invalid IDs', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const newLibraries = [{ id: '4', name: 'New Library' }] + const action = { + type: SET_USER_LIBRARIES, + data: newLibraries, + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual(newLibraries) + expect(result.selectedLibraries).toEqual([]) // All selected IDs were invalid + }) + + it('should handle transition from multiple to single library with invalid selection', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['2', '3'], // User had libraries 2 and 3 selected + } + + const action = { + type: SET_USER_LIBRARIES, + data: [mockLibraries[0]], // Now only has access to library 1 + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([mockLibraries[0]]) + expect(result.selectedLibraries).toEqual([]) // Reset for single library + }) + + it('should handle empty library list', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const action = { + type: SET_USER_LIBRARIES, + data: [], + } + + const result = libraryReducer(previousState, action) + + expect(result.userLibraries).toEqual([]) + expect(result.selectedLibraries).toEqual([]) // All selections filtered out + }) + }) + + describe('SET_SELECTED_LIBRARIES', () => { + it('should update selected libraries', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1'], + } + + const action = { + type: SET_SELECTED_LIBRARIES, + data: ['2', '3'], + } + + const result = libraryReducer(previousState, action) + + expect(result.selectedLibraries).toEqual(['2', '3']) + expect(result.userLibraries).toEqual(mockLibraries) // Unchanged + }) + + it('should allow setting empty selection', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1', '2'], + } + + const action = { + type: SET_SELECTED_LIBRARIES, + data: [], + } + + const result = libraryReducer(previousState, action) + + expect(result.selectedLibraries).toEqual([]) + }) + }) + + describe('unknown action', () => { + it('should return previous state for unknown action', () => { + const previousState = { + userLibraries: mockLibraries, + selectedLibraries: ['1'], + } + + const action = { + type: 'UNKNOWN_ACTION', + data: null, + } + + const result = libraryReducer(previousState, action) + + expect(result).toBe(previousState) // Same reference + }) + }) +}) diff --git a/ui/src/reducers/playerReducer.js b/ui/src/reducers/playerReducer.js index 92fe85df4..d6ab7484b 100644 --- a/ui/src/reducers/playerReducer.js +++ b/ui/src/reducers/playerReducer.js @@ -1,5 +1,6 @@ import { v4 as uuidv4 } from 'uuid' import subsonic from '../subsonic' +import { decisionService } from '../transcode' import { PLAYER_ADD_TRACKS, PLAYER_CLEAR_QUEUE, @@ -10,6 +11,7 @@ import { PLAYER_SET_VOLUME, PLAYER_SYNC_QUEUE, PLAYER_SET_MODE, + PLAYER_REFRESH_QUEUE, } from '../actions' import config from '../config' @@ -30,6 +32,14 @@ const pad = (value) => { } } +const makeMusicSrc = (trackId) => + decisionService.getProfile() + ? () => + decisionService + .resolveStreamUrl(trackId) + .catch(() => subsonic.streamUrl(trackId)) + : subsonic.streamUrl(trackId) + const mapToAudioLists = (item) => { // If item comes from a playlist, trackId is mediaFileId const trackId = item.mediaFileId || item.id @@ -76,7 +86,7 @@ const mapToAudioLists = (item) => { lyric: lyricText, singer: item.artist, duration: item.duration, - musicSrc: subsonic.streamUrl(trackId), + musicSrc: makeMusicSrc(trackId), cover: subsonic.getCoverArtUrl( { id: trackId, @@ -124,6 +134,7 @@ const reduceAddTracks = (state, { data }) => { } const reducePlayNext = (state, { data }) => { + const newTracks = Object.keys(data).map((id) => mapToAudioLists(data[id])) const newQueue = [] const current = state.current || {} let foundPos = false @@ -131,15 +142,11 @@ const reducePlayNext = (state, { data }) => { newQueue.push(item) if (item.uuid === current.uuid) { foundPos = true - Object.keys(data).forEach((id) => { - newQueue.push(mapToAudioLists(data[id])) - }) + newQueue.push(...newTracks) } }) if (!foundPos) { - Object.keys(data).forEach((id) => { - newQueue.push(mapToAudioLists(data[id])) - }) + newQueue.push(...newTracks) } return { @@ -157,11 +164,20 @@ const reduceSetVolume = (state, { data: { volume } }) => { } const reduceSyncQueue = (state, { data: { audioInfo, audioLists } }) => { + // Keep clear and playIndex alive when there is a pending track switch. + // A switch is pending when playIndex is set AND either: + // - playIndex differs from savedPlayIndex, OR + // - clear is true (a new queue was loaded, e.g. after clearQueue + playTracks) + // The clear check handles the edge case where both playIndex and + // savedPlayIndex are 0 (close player then play a new album from track 1). + const hasPendingSwitch = + state.playIndex != null && + (state.clear || state.playIndex !== state.savedPlayIndex) return { ...state, queue: audioLists, - clear: false, - playIndex: undefined, + clear: hasPendingSwitch ? state.clear : false, + playIndex: hasPendingSwitch ? state.playIndex : undefined, } } @@ -170,11 +186,17 @@ const reduceCurrent = (state, { data }) => { const savedPlayIndex = state.queue.findIndex( (item) => item.uuid === current.uuid, ) + // When a track selection is pending (playIndex is set), keep it alive + // until the music player confirms it actually switched to the requested + // track. Without this, a premature onAudioPlay callback for the + // still-playing old track would overwrite the pending selection. + const pending = state.playIndex != null && savedPlayIndex !== state.playIndex return { ...state, current, - playIndex: undefined, - savedPlayIndex, + playIndex: pending ? state.playIndex : undefined, + clear: pending ? state.clear : false, + savedPlayIndex: pending ? state.savedPlayIndex : savedPlayIndex, volume: data.volume, } } @@ -207,6 +229,22 @@ export const playerReducer = (previousState = initialState, payload) => { return reduceCurrent(previousState, payload) case PLAYER_SET_MODE: return reduceMode(previousState, payload) + case PLAYER_REFRESH_QUEUE: { + const resolvedUrls = payload.data || {} + return { + ...previousState, + queue: previousState.queue.map((item) => ({ + ...item, + musicSrc: item.isRadio + ? item.musicSrc + : resolvedUrls[item.trackId] || subsonic.streamUrl(item.trackId), + })), + clear: true, + autoPlay: false, + playIndex: + previousState.savedPlayIndex >= 0 ? previousState.savedPlayIndex : 0, + } + } default: return previousState } diff --git a/ui/src/reducers/playerReducer.test.js b/ui/src/reducers/playerReducer.test.js new file mode 100644 index 000000000..110ce8c53 --- /dev/null +++ b/ui/src/reducers/playerReducer.test.js @@ -0,0 +1,227 @@ +import { describe, it, expect } from 'vitest' +import { playerReducer } from './playerReducer' +import { + PLAYER_SYNC_QUEUE, + PLAYER_CURRENT, + PLAYER_REFRESH_QUEUE, +} from '../actions' + +describe('playerReducer', () => { + describe('pending track selection survives SYNC_QUEUE and premature CURRENT', () => { + // Simulates the real sequence when clicking a new song while one is playing: + // 1. PLAYER_PLAY_TRACKS sets playIndex and clear + // 2. PLAYER_SYNC_QUEUE fires when music player syncs its internal queue + // 3. PLAYER_CURRENT fires for the OLD still-playing track + // 4. PLAYER_CURRENT fires for the NEW track (player switched) + const stateAfterPlayTracks = { + queue: [ + { trackId: 's1', uuid: 'aaa', name: 'Song 1' }, + { trackId: 's2', uuid: 'bbb', name: 'Song 2' }, + { trackId: 's3', uuid: 'ccc', name: 'Song 3' }, + ], + current: { uuid: 'ccc', name: 'Song 3' }, + playIndex: 0, // user clicked Song 1 + savedPlayIndex: 2, // Song 3 was playing + clear: true, + volume: 1, + } + + it('SYNC_QUEUE preserves pending playIndex and clear', () => { + const newQueue = [ + { trackId: 's1', uuid: 'xxx', name: 'Song 1' }, + { trackId: 's2', uuid: 'yyy', name: 'Song 2' }, + { trackId: 's3', uuid: 'zzz', name: 'Song 3' }, + ] + const action = { + type: PLAYER_SYNC_QUEUE, + data: { audioInfo: {}, audioLists: newQueue }, + } + const result = playerReducer(stateAfterPlayTracks, action) + expect(result.playIndex).toBe(0) + expect(result.clear).toBe(true) + expect(result.queue).toBe(newQueue) + }) + + it('SYNC_QUEUE clears playIndex when no pending selection', () => { + const stateNoPending = { ...stateAfterPlayTracks, playIndex: undefined } + const action = { + type: PLAYER_SYNC_QUEUE, + data: { audioInfo: {}, audioLists: stateNoPending.queue }, + } + const result = playerReducer(stateNoPending, action) + expect(result.playIndex).toBeUndefined() + expect(result.clear).toBe(false) + }) + + it('CURRENT for old track preserves pending playIndex', () => { + // After SYNC_QUEUE, queue has new UUIDs. The old track's UUID (zzz) + // is at index 2, but playIndex is 0. This is a premature callback. + const stateAfterSync = { + ...stateAfterPlayTracks, + queue: [ + { trackId: 's1', uuid: 'xxx', name: 'Song 1' }, + { trackId: 's2', uuid: 'yyy', name: 'Song 2' }, + { trackId: 's3', uuid: 'zzz', name: 'Song 3' }, + ], + } + const action = { + type: PLAYER_CURRENT, + data: { uuid: 'zzz', name: 'Song 3', volume: 1 }, + } + const result = playerReducer(stateAfterSync, action) + expect(result.playIndex).toBe(0) + expect(result.clear).toBe(true) + expect(result.savedPlayIndex).toBe(2) // preserved from before + }) + + it('CURRENT for correct track consumes pending playIndex', () => { + const stateAfterSync = { + ...stateAfterPlayTracks, + queue: [ + { trackId: 's1', uuid: 'xxx', name: 'Song 1' }, + { trackId: 's2', uuid: 'yyy', name: 'Song 2' }, + { trackId: 's3', uuid: 'zzz', name: 'Song 3' }, + ], + } + // Player switched to Song 1 (uuid 'xxx', index 0 == playIndex) + const action = { + type: PLAYER_CURRENT, + data: { uuid: 'xxx', name: 'Song 1', volume: 1 }, + } + const result = playerReducer(stateAfterSync, action) + expect(result.playIndex).toBeUndefined() + expect(result.clear).toBe(false) + expect(result.savedPlayIndex).toBe(0) + expect(result.current.name).toBe('Song 1') + }) + }) + + describe('play new album after closing player (issue #5440)', () => { + it('SYNC_QUEUE preserves pending playIndex=0 after clearQueue', () => { + // Scenario: user plays album A, advances to track 3, closes player, + // then plays album B. After clearQueue, savedPlayIndex=0. + // PLAYER_PLAY_TRACKS sets playIndex=0. SYNC_QUEUE must NOT clear it. + const stateAfterClearThenPlay = { + queue: [ + { trackId: 'b1', uuid: 'u1', name: 'B Song 1' }, + { trackId: 'b2', uuid: 'u2', name: 'B Song 2' }, + { trackId: 'b3', uuid: 'u3', name: 'B Song 3' }, + ], + current: {}, + playIndex: 0, + savedPlayIndex: 0, // reset by clearQueue + clear: true, + volume: 1, + } + + const action = { + type: PLAYER_SYNC_QUEUE, + data: { + audioInfo: {}, + audioLists: stateAfterClearThenPlay.queue, + }, + } + const result = playerReducer(stateAfterClearThenPlay, action) + expect(result.playIndex).toBe(0) + expect(result.clear).toBe(true) + }) + + it('CURRENT for wrong track preserves pending playIndex=0 after clearQueue', () => { + // The music player fires onAudioPlay for the old track (at index 3) + // before switching to the new track at index 0. + const stateAfterClearThenPlay = { + queue: [ + { trackId: 'b1', uuid: 'u1', name: 'B Song 1' }, + { trackId: 'b2', uuid: 'u2', name: 'B Song 2' }, + { trackId: 'b3', uuid: 'u3', name: 'B Song 3' }, + { trackId: 'b4', uuid: 'u4', name: 'B Song 4' }, + ], + current: {}, + playIndex: 0, + savedPlayIndex: 0, + clear: true, + volume: 1, + } + + // Player reports track at index 3 as current (stale callback) + const action = { + type: PLAYER_CURRENT, + data: { uuid: 'u4', name: 'B Song 4', volume: 1 }, + } + const result = playerReducer(stateAfterClearThenPlay, action) + expect(result.playIndex).toBe(0) + expect(result.clear).toBe(true) + }) + + it('CURRENT for correct track consumes pending playIndex=0', () => { + const stateAfterClearThenPlay = { + queue: [ + { trackId: 'b1', uuid: 'u1', name: 'B Song 1' }, + { trackId: 'b2', uuid: 'u2', name: 'B Song 2' }, + ], + current: {}, + playIndex: 0, + savedPlayIndex: 0, + clear: true, + volume: 1, + } + + // Player confirms it switched to track at index 0 + const action = { + type: PLAYER_CURRENT, + data: { uuid: 'u1', name: 'B Song 1', volume: 1 }, + } + const result = playerReducer(stateAfterClearThenPlay, action) + expect(result.playIndex).toBeUndefined() + expect(result.clear).toBe(false) + expect(result.savedPlayIndex).toBe(0) + }) + }) + + describe('PLAYER_REFRESH_QUEUE', () => { + it('clamps negative savedPlayIndex to 0', () => { + const state = { + queue: [ + { trackId: 'song-1', musicSrc: 'old-url', uuid: 'a' }, + { trackId: 'song-2', musicSrc: 'old-url', uuid: 'b' }, + ], + savedPlayIndex: -1, + current: {}, + clear: false, + volume: 1, + } + const action = { type: PLAYER_REFRESH_QUEUE, data: {} } + const result = playerReducer(state, action) + expect(result.playIndex).toBe(0) + }) + + it('preserves valid savedPlayIndex', () => { + const state = { + queue: [ + { trackId: 'song-1', musicSrc: 'old-url', uuid: 'a' }, + { trackId: 'song-2', musicSrc: 'old-url', uuid: 'b' }, + ], + savedPlayIndex: 1, + current: {}, + clear: false, + volume: 1, + } + const action = { type: PLAYER_REFRESH_QUEUE, data: {} } + const result = playerReducer(state, action) + expect(result.playIndex).toBe(1) + }) + + it('uses savedPlayIndex of 0 correctly', () => { + const state = { + queue: [{ trackId: 'song-1', musicSrc: 'old-url', uuid: 'a' }], + savedPlayIndex: 0, + current: {}, + clear: false, + volume: 1, + } + const action = { type: PLAYER_REFRESH_QUEUE, data: {} } + const result = playerReducer(state, action) + expect(result.playIndex).toBe(0) + }) + }) +}) diff --git a/ui/src/reducers/themeReducer.js b/ui/src/reducers/themeReducer.js index 2a5d5bac6..16d5fa87b 100644 --- a/ui/src/reducers/themeReducer.js +++ b/ui/src/reducers/themeReducer.js @@ -1,8 +1,12 @@ import { CHANGE_THEME } from '../actions' +import { AUTO_THEME_ID, AUTO_THEME_CONFIG_VALUE } from '../consts' import config from '../config' import themes from '../themes' const defaultTheme = () => { + if (config.defaultTheme === AUTO_THEME_CONFIG_VALUE) { + return AUTO_THEME_ID + } return ( Object.keys(themes).find( (t) => themes[t].themeName === config.defaultTheme, diff --git a/ui/src/reducers/themeReducer.test.js b/ui/src/reducers/themeReducer.test.js new file mode 100644 index 000000000..2a66ea851 --- /dev/null +++ b/ui/src/reducers/themeReducer.test.js @@ -0,0 +1,32 @@ +import { describe, it, expect, vi, beforeEach } from 'vitest' +import { AUTO_THEME_ID, AUTO_THEME_CONFIG_VALUE } from '../consts' + +describe('themeReducer', () => { + beforeEach(() => { + vi.resetModules() + }) + + it.each([ + { + configTheme: AUTO_THEME_CONFIG_VALUE, + expected: AUTO_THEME_ID, + description: 'is "Auto"', + }, + { configTheme: 'Dark', expected: 'DarkTheme', description: 'is "Dark"' }, + { + configTheme: 'NonExistent', + expected: 'DarkTheme', + description: 'is unrecognized', + }, + ])( + 'returns $expected when defaultTheme config $description', + async ({ configTheme, expected }) => { + vi.doMock('../config', () => ({ + default: { defaultTheme: configTheme }, + })) + const { themeReducer } = await import('./themeReducer') + const result = themeReducer(undefined, { type: 'UNKNOWN' }) + expect(result).toBe(expected) + }, + ) +}) diff --git a/ui/src/reducers/transcodingReducer.js b/ui/src/reducers/transcodingReducer.js new file mode 100644 index 000000000..db7a3708a --- /dev/null +++ b/ui/src/reducers/transcodingReducer.js @@ -0,0 +1,14 @@ +import { TRANSCODING_SET_PROFILE } from '../actions' + +const initialState = { + browserProfile: null, +} + +export const transcodingReducer = (state = initialState, { type, data }) => { + switch (type) { + case TRANSCODING_SET_PROFILE: + return { ...state, browserProfile: data } + default: + return state + } +} diff --git a/ui/src/reducers/transcodingReducer.test.js b/ui/src/reducers/transcodingReducer.test.js new file mode 100644 index 000000000..eb3e7a490 --- /dev/null +++ b/ui/src/reducers/transcodingReducer.test.js @@ -0,0 +1,23 @@ +import { describe, it, expect } from 'vitest' +import { transcodingReducer } from './transcodingReducer' +import { TRANSCODING_SET_PROFILE } from '../actions' + +describe('transcodingReducer', () => { + const initialState = { browserProfile: null } + + it('returns initial state', () => { + expect(transcodingReducer(undefined, {})).toEqual(initialState) + }) + + it('handles TRANSCODING_SET_PROFILE', () => { + const profile = { + name: 'NavidromeUI', + directPlayProfiles: [{ containers: ['mp3'] }], + } + const state = transcodingReducer(initialState, { + type: TRANSCODING_SET_PROFILE, + data: profile, + }) + expect(state.browserProfile).toEqual(profile) + }) +}) diff --git a/ui/src/share/ShareList.jsx b/ui/src/share/ShareList.jsx index 183d6af6b..48ab44e18 100644 --- a/ui/src/share/ShareList.jsx +++ b/ui/src/share/ShareList.jsx @@ -2,13 +2,13 @@ import { Datagrid, FunctionField, BooleanField, - List, NumberField, SimpleList, TextField, useNotify, useTranslate, } from 'react-admin' +import { List } from '../common' import React from 'react' import { IconButton, Link, useMediaQuery } from '@material-ui/core' import ShareIcon from '@material-ui/icons/Share' diff --git a/ui/src/share/SharePlayer.jsx b/ui/src/share/SharePlayer.jsx index 38493d3ce..a3a15e50a 100644 --- a/ui/src/share/SharePlayer.jsx +++ b/ui/src/share/SharePlayer.jsx @@ -29,7 +29,7 @@ const SharePlayer = () => { return { name: s.title, musicSrc: shareStreamUrl(s.id), - cover: shareCoverUrl(s.id), + cover: shareCoverUrl(s.id, true), singer: s.artist, duration: s.duration, } @@ -53,6 +53,7 @@ const SharePlayer = () => { remove: false, spaceBar: true, volumeFade: { fadeIn: 200, fadeOut: 200 }, + sortableOptions: { delay: 200, delayOnTouchOnly: true }, } return ( <ReactJkMusicPlayer diff --git a/ui/src/song/SongList.jsx b/ui/src/song/SongList.jsx index 2a2807964..d928af549 100644 --- a/ui/src/song/SongList.jsx +++ b/ui/src/song/SongList.jsx @@ -20,7 +20,6 @@ import { SongContextMenu, SongDatagrid, SongInfo, - QuickFilter, SongTitleField, SongSimpleList, RatingField, @@ -119,10 +118,9 @@ const SongFilter = (props) => { /> </ReferenceArrayInput> {config.enableFavourites && ( - <QuickFilter + <NullableBooleanInput source="starred" label={<FavoriteIcon fontSize={'small'} />} - defaultValue={true} /> )} {isAdmin && <NullableBooleanInput source="missing" />} @@ -145,6 +143,7 @@ const SongList = (props) => { return { album: isDesktop && <AlbumLinkField source="album" sortByOrder={'ASC'} />, artist: <ArtistLinkField source="artist" />, + composer: <ArtistLinkField source="composer" />, albumArtist: <ArtistLinkField source="albumArtist" />, trackNumber: isDesktop && <NumberField source="trackNumber" />, playCount: isDesktop && ( @@ -182,7 +181,9 @@ const SongList = (props) => { ), comment: <TextField source="comment" />, path: <PathField source="path" />, - createdAt: <DateField source="createdAt" showTime />, + createdAt: ( + <DateField source="createdAt" sortBy="recently_added" showTime /> + ), } }, [isDesktop, classes.ratingField]) @@ -190,6 +191,7 @@ const SongList = (props) => { resource: 'song', columns: toggleableFields, defaultOff: [ + 'composer', 'channels', 'bpm', 'playDate', diff --git a/ui/src/store/createAdminStore.js b/ui/src/store/createAdminStore.js index e4877eb14..4888e49e4 100644 --- a/ui/src/store/createAdminStore.js +++ b/ui/src/store/createAdminStore.js @@ -57,6 +57,7 @@ const createAdminStore = ({ const state = store.getState() saveState({ theme: state.theme, + library: state.library, player: (({ queue, volume, savedPlayIndex }) => ({ queue, volume, diff --git a/ui/src/subsonic/index.js b/ui/src/subsonic/index.js index ce5116bcb..7d93972e0 100644 --- a/ui/src/subsonic/index.js +++ b/ui/src/subsonic/index.js @@ -1,5 +1,9 @@ import { baseUrl } from '../utils' -import { httpClient } from '../dataProvider' +import { + httpClient, + clientUniqueId, + clientUniqueIdHeader, +} from '../dataProvider' const url = (command, id, options) => { const username = localStorage.getItem('username') @@ -23,7 +27,13 @@ const url = (command, id, options) => { delete options.ts } Object.keys(options).forEach((k) => { - params.append(k, options[k]) + const value = options[k] + // Handle array parameters by appending each value separately + if (Array.isArray(value)) { + value.forEach((v) => params.append(k, v)) + } else { + params.append(k, value) + } }) } return `/rest/${command}?${params.toString()}` @@ -31,15 +41,21 @@ const url = (command, id, options) => { const ping = () => httpClient(url('ping')) -const scrobble = (id, time, submission = true) => - httpClient( - url('scrobble', id, { - ...(submission && time && { time }), - submission, - }), - ) +const reportPlaybackUrl = (mediaId, positionMs, state) => + url('reportPlayback', null, { mediaId, mediaType: 'song', positionMs, state }) -const nowPlaying = (id) => scrobble(id, null, false) +const reportPlayback = (mediaId, positionMs, state) => + httpClient(reportPlaybackUrl(mediaId, positionMs, state)) + +const reportPlaybackKeepalive = (mediaId, positionMs, state) => { + const u = reportPlaybackUrl(mediaId, positionMs, state) + if (u) { + fetch(baseUrl(u), { + keepalive: true, + headers: { [clientUniqueIdHeader]: clientUniqueId }, + }) + } +} const star = (id) => httpClient(url('star', id)) @@ -54,6 +70,16 @@ const startScan = (options) => httpClient(url('startScan', null, options)) const getScanStatus = () => httpClient(url('getScanStatus')) +const getNowPlaying = () => httpClient(url('getNowPlaying')) + +const getAvatarUrl = (username, size) => + baseUrl( + url('getAvatar', null, { + username, + ...(size && { size }), + }), + ) + const getCoverArtUrl = (record, size, square) => { const options = { ...(record.updatedAt && { _: record.updatedAt }), @@ -61,16 +87,32 @@ const getCoverArtUrl = (record, size, square) => { ...(square && { square }), } - // TODO Move this logic to server. `song` and `album` should have a CoverArtID + // TODO Move this logic to server if (record.album) { return baseUrl(url('getCoverArt', 'mf-' + record.id, options)) } else if (record.albumArtist) { return baseUrl(url('getCoverArt', 'al-' + record.id, options)) + } else if (record.sync !== undefined) { + // This is a playlist + return baseUrl(url('getCoverArt', 'pl-' + record.id, options)) + } else if (record.streamUrl !== undefined) { + // This is a radio station + return baseUrl(url('getCoverArt', 'ra-' + record.id, options)) } else { return baseUrl(url('getCoverArt', 'ar-' + record.id, options)) } } +const getDiscCoverArtUrl = (albumId, discNumber, updatedAt, size) => { + const options = { + ...(updatedAt && { _: updatedAt }), + ...(size && { size }), + } + return baseUrl( + url('getCoverArt', 'dc-' + albumId + ':' + discNumber, options), + ) +} + const getArtistInfo = (id) => { return httpClient(url('getArtistInfo', id)) } @@ -79,6 +121,14 @@ const getAlbumInfo = (id) => { return httpClient(url('getAlbumInfo', id)) } +const getSimilarSongs2 = (id, count = 100) => { + return httpClient(url('getSimilarSongs2', id, { count })) +} + +const getTopSongs = (artist, count = 50) => { + return httpClient(url('getTopSongs', null, { artist, count })) +} + const streamUrl = (id, options) => { return baseUrl( url('stream', id, { @@ -91,16 +141,21 @@ const streamUrl = (id, options) => { export default { url, ping, - scrobble, - nowPlaying, + reportPlayback, + reportPlaybackKeepalive, download, star, unstar, setRating, startScan, getScanStatus, + getNowPlaying, getCoverArtUrl, + getDiscCoverArtUrl, + getAvatarUrl, streamUrl, getAlbumInfo, getArtistInfo, + getTopSongs, + getSimilarSongs2, } diff --git a/ui/src/subsonic/index.test.js b/ui/src/subsonic/index.test.js new file mode 100644 index 000000000..ad4764c24 --- /dev/null +++ b/ui/src/subsonic/index.test.js @@ -0,0 +1,226 @@ +import { vi } from 'vitest' +import config from '../config' +import subsonic from './index' + +describe('getCoverArtUrl', () => { + beforeEach(() => { + // Mock window.location + delete window.location + window.location = { href: 'http://localhost:3000/app' } + + // Mock localStorage values required by subsonic + const localStorageMock = { + getItem: vi.fn((key) => { + const values = { + username: 'testuser', + 'subsonic-token': 'testtoken', + 'subsonic-salt': 'testsalt', + } + return values[key] || null + }), + setItem: vi.fn(), + clear: vi.fn(), + } + Object.defineProperty(window, 'localStorage', { value: localStorageMock }) + }) + + it('should return playlist cover art URL for records with sync property', () => { + const playlistRecord = { + id: 'playlist-123', + sync: true, + updatedAt: '2023-01-01T00:00:00Z', + } + + const url = subsonic.getCoverArtUrl( + playlistRecord, + config.uiCoverArtSize, + true, + ) + + expect(url).toContain('pl-playlist-123') + expect(url).toContain('size=600') + expect(url).toContain('square=true') + expect(url).toContain('_=2023-01-01T00%3A00%3A00Z') + }) + + it('should add timestamp for playlists without updatedAt', () => { + const playlistRecord = { + id: 'playlist-123', + sync: true, + } + + const url = subsonic.getCoverArtUrl( + playlistRecord, + config.uiCoverArtSize, + true, + ) + + expect(url).toContain('pl-playlist-123') + expect(url).toContain('size=600') + expect(url).toContain('square=true') + expect(url).not.toContain('_=') + }) + + it('should return album cover art URL for records with albumArtist', () => { + const albumRecord = { + id: 'album-123', + albumArtist: 'Test Artist', + updatedAt: '2023-01-01T00:00:00Z', + } + + const url = subsonic.getCoverArtUrl( + albumRecord, + config.uiCoverArtSize, + true, + ) + + expect(url).toContain('al-album-123') + expect(url).toContain('size=600') + expect(url).toContain('square=true') + }) + + it('should return media file cover art URL for records with album', () => { + const songRecord = { + id: 'song-123', + album: 'Test Album', + updatedAt: '2023-01-01T00:00:00Z', + } + + const url = subsonic.getCoverArtUrl(songRecord, config.uiCoverArtSize, true) + + expect(url).toContain('mf-song-123') + expect(url).toContain('size=600') + expect(url).toContain('square=true') + }) + + it('should return artist cover art URL for other records', () => { + const artistRecord = { + id: 'artist-123', + updatedAt: '2023-01-01T00:00:00Z', + } + + const url = subsonic.getCoverArtUrl( + artistRecord, + config.uiCoverArtSize, + true, + ) + + expect(url).toContain('ar-artist-123') + expect(url).toContain('size=600') + expect(url).toContain('square=true') + }) + + it('should handle records without updatedAt', () => { + const record = { + id: 'test-123', + } + + const url = subsonic.getCoverArtUrl(record) + + expect(url).toContain('ar-test-123') + expect(url).not.toContain('_=') + }) +}) + +describe('getDiscCoverArtUrl', () => { + beforeEach(() => { + const localStorageMock = { + getItem: vi.fn((key) => { + const values = { + username: 'testuser', + 'subsonic-token': 'testtoken', + 'subsonic-salt': 'testsalt', + } + return values[key] || null + }), + } + Object.defineProperty(window, 'localStorage', { value: localStorageMock }) + }) + + it('should construct URL with dc-albumId:discNumber format, size, and cache param', () => { + const url = subsonic.getDiscCoverArtUrl( + 'album-123', + 2, + '2023-01-01T00:00:00Z', + 48, + ) + + expect(url).toContain('getCoverArt') + expect(url).toContain('id=dc-album-123%3A2') + expect(url).toContain('size=48') + expect(url).toContain('_=2023-01-01T00%3A00%3A00Z') + }) + + it('should handle missing updatedAt', () => { + const url = subsonic.getDiscCoverArtUrl('album-123', 1, undefined, 48) + + expect(url).toContain('id=dc-album-123%3A1') + expect(url).toContain('size=48') + expect(url).not.toContain('_=') + }) + + it('should handle missing size', () => { + const url = subsonic.getDiscCoverArtUrl( + 'album-123', + 1, + '2023-01-01T00:00:00Z', + ) + + expect(url).toContain('id=dc-album-123%3A1') + expect(url).toContain('_=2023-01-01T00%3A00%3A00Z') + expect(url).not.toContain('size=') + }) +}) + +describe('getAvatarUrl', () => { + beforeEach(() => { + // Mock localStorage values required by subsonic + const localStorageMock = { + getItem: vi.fn((key) => { + const values = { + username: 'testuser', + 'subsonic-token': 'testtoken', + 'subsonic-salt': 'testsalt', + } + return values[key] || null + }), + } + Object.defineProperty(window, 'localStorage', { value: localStorageMock }) + }) + + it('should include username parameter', () => { + const url = subsonic.getAvatarUrl('john') + expect(url).toContain('getAvatar') + expect(url).toContain('username=john') + }) +}) + +describe('reportPlayback', () => { + beforeEach(() => { + const localStorageMock = { + getItem: vi.fn((key) => { + const values = { + username: 'testuser', + 'subsonic-token': 'testtoken', + 'subsonic-salt': 'testsalt', + } + return values[key] || null + }), + } + Object.defineProperty(window, 'localStorage', { value: localStorageMock }) + }) + + it('should construct reportPlayback URL with correct parameters', () => { + const url = subsonic.url('reportPlayback', null, { + mediaId: 'song-123', + mediaType: 'song', + positionMs: 5000, + state: 'playing', + }) + expect(url).toContain('reportPlayback') + expect(url).toContain('mediaId=song-123') + expect(url).toContain('mediaType=song') + expect(url).toContain('positionMs=5000') + expect(url).toContain('state=playing') + }) +}) diff --git a/ui/src/themes/SquiddiesGlass.css.js b/ui/src/themes/SquiddiesGlass.css.js new file mode 100644 index 000000000..2c8e4f1d6 --- /dev/null +++ b/ui/src/themes/SquiddiesGlass.css.js @@ -0,0 +1,175 @@ +const stylesheet = ` + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle { + background: #c231ab +} +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track, +.react-jinke-music-player-mobile-progress .rc-slider-track { + background: linear-gradient(to left, #c231ab, #380eff) +} + +.react-jinke-music-player-mobile { + background-color: #171717 !important; +} + +.react-jinke-music-player-mobile-progress .rc-slider-handle { + background: #c231ab; + height: 20px; + width: 20px; + margin-top: -9px; +} + +.react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #c231ab; +} + +.react-jinke-music-player-pause-icon { + background-color: #c231ab; + border-radius: 50%; + outline: auto; + color: white; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content { + z-index: 99999; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .play-btn svg { + border-radius: 50%; + outline: auto; + color: white; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .play-btn svg:hover { + background-color: #c231ab; + border-radius: 50%; + outline: auto; + color: white; +} + +.react-jinke-music-player-main svg:hover { + color: #c231ab; +} + +.react-jinke-music-player .music-player-controller { + color: #c231ab; + border: 1px solid #e14ac2; +} + +.react-jinke-music-player .music-player-controller.music-player-playing:before { + border: 1px solid rgba(194, 49, 171, 0.3); +} + +.react-jinke-music-player .music-player .destroy-btn { + background-color: #c2c1c2; + top: -7px; + border-radius: 50%; + display: flex; +} + +.react-jinke-music-player .music-player .destroy-btn svg { + font-size: 20px; +} + +@media screen and (max-width: 767px) { + .react-jinke-music-player .music-player .destroy-btn { + right: -12px; + } +} + +.react-jinke-music-player-mobile-header-right { + right: 0; + top: 0; +} + +@media screen and (max-width: 767px) { + .react-jinke-music-player-main svg { + font-size: 32px; + } +} + +@keyframes gradientFlow { + 0% { background-position: 0% 50%; } + 50% { background-position: 100% 50%; } + 100% { background-position: 0% 50%; } +} + +.RaBulkActionsToolbar .MuiButton-label { + color: white; +} + +a[aria-current="page"] { + color: #c231ab !important; + font-weight: bold; +} + +a[aria-current="page"] .MuiListItemIcon-root { + color: #c231ab !important; +} + +.panel-content { + position: relative; + overflow: hidden; + background: linear-gradient(90deg, #311f2f, #0a0912, #2f0c28); + background-size: 300% 300%; + animation: gradientFlow 10s ease-in-out infinite; +} + +/* Equalizer bars */ +.panel-content::before { + content: ""; + position: absolute; + inset: 0; + background: repeating-linear-gradient( + 90deg, + rgba(255, 255, 255, 0.05) 0px, + rgba(255, 255, 255, 0.05) 2px, + transparent 1px, + transparent 3px + ); + animation: equalizer 1.8s infinite ease-in-out; + filter: blur(1px); + opacity: 0.5; +} + +@keyframes backgroundFlow { + 0% { + background-position: 0% 50%; + } + 50% { + background-position: 100% 50%; + } + 100% { + background-position: 0% 50%; + } +} + +/* Vertical movement, equalizer type */ +@keyframes equalizer { + 0%, 100% { + transform: scaleY(1); + opacity: 0.2; + } + 25% { + transform: scaleY(1.4); + opacity: 0.9; + } + 50% { + transform: scaleY(0.7); + opacity: 0.2; + } + 75% { + transform: scaleY(1.2); + opacity: 0.8; + } +} + +@keyframes pulse { + 0% { opacity: 0.5; } + 100% { opacity: 1; } +} + +@keyframes spin { + from { transform: rotate(0deg); } + to { transform: rotate(360deg); } +} +` + +export default stylesheet diff --git a/ui/src/themes/SquiddiesGlass.js b/ui/src/themes/SquiddiesGlass.js new file mode 100644 index 000000000..880b0be20 --- /dev/null +++ b/ui/src/themes/SquiddiesGlass.js @@ -0,0 +1,608 @@ +import stylesheet from './SquiddiesGlass.css.js' + +/** + * Color constants used throughout the Squiddies Glass theme. + * Provides a consistent color palette with pink, gray, purple, and basic colors. + * @type {Object} + */ +const colors = { + pink: { + 100: '#fbe3f4', + 200: '#f5b9e3', + 300: '#ec7cd6', + 400: '#e14ac2', + 500: '#c231ab', // base + 600: '#a31a92', + 700: '#8b0f7e', + 800: '#7a006d', + 900: '#670066', + }, + gray: { + 50: '#c2c1c2', + 100: '#b3b3b3', // light gray + 200: '#282828', // medium dark + 300: '#1d1d1d', // darker + 400: '#181818', // even darker + 500: '#171717', // darkest + }, + purple: { + 400: '#524590', + 500: '#4d3249', + 600: '#6d1c5e', + }, + black: '#000', + white: '#fff', + dark: '#121212', +} + +/** + * Shared style object for music list action buttons. + * Defines common styling for buttons in music lists, including hover effects and responsive scaling. + * @type {Object} + */ +const musicListActions = { + padding: '1rem 0', + alignItems: 'center', + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: 'inherit', + color: colors.gray[100], + '&:hover': { + border: `1px solid ${colors.gray[100]}`, + backgroundColor: 'inherit !important', + }, + }, + 'button:first-child:not(:only-child)': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.3)', + margin: '1em', + '&:hover': { + transform: 'scale(1.2) !important', + }, + }, + transform: 'scale(1.3)', + margin: '1em', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + background: colors.pink[500], + color: `${colors.black} !important`, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(1.2)', + backgroundColor: `${colors.pink[500]} !important`, + border: 0, + }, + }, + 'button:only-child': { + marginTop: '0.3em', + }, + 'button:first-child>span:first-child': { + padding: 0, + color: `${colors.black} !important`, + }, + 'button:first-child>span:first-child>span': { + display: 'none', + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: colors.gray[100], + }, + }, +} + +/** + * Squiddies Glass theme configuration object. + * Defines the complete theme structure including typography, palette, component overrides, and player settings. + * @type {Object} + */ +export default { + /** + * The name of the theme. + * @type {string} + */ + themeName: 'Squiddies Glass', + + /** + * Typography settings for the theme. + * Specifies font family and heading sizes. + * @type {Object} + */ + typography: { + fontFamily: "system-ui, 'Helvetica Neue', Helvetica, Arial, sans-serif", + h6: { + fontSize: '1rem', // AppBar title + }, + }, + + /** + * Color palette configuration. + * Defines primary, secondary, and background colors for the theme. + * @type {Object} + */ + palette: { + primary: { + light: colors.pink[300], + main: colors.pink[500], + }, + secondary: { + main: colors.white, + contrastText: colors.white, + }, + background: { + default: colors.dark, + paper: colors.dark, + }, + type: 'dark', + }, + + /** + * Component overrides for Material-UI and custom Navidrome components. + * Customizes the appearance and behavior of various UI components. + * @type {Object} + */ + overrides: { + // Material-UI Components + MuiAppBar: { + positionFixed: { + backgroundColor: `${colors.black} !important`, + boxShadow: 'none', + }, + }, + MuiButton: { + root: { + background: colors.pink[500], + color: colors.white, + border: '1px solid transparent', + borderRadius: 500, + '&:hover': { + background: `${colors.pink[900]} !important`, + }, + }, + textSecondary: { + border: `1px solid ${colors.gray[100]}`, + background: colors.black, + '&:hover': { + border: `1px solid ${colors.white} !important`, + background: `${colors.black} !important`, + }, + }, + label: { + color: colors.white, + paddingRight: '1rem', + paddingLeft: '0.7rem', + }, + }, + MuiCardMedia: { + root: { + position: 'relative', + overflow: 'hidden', + boxShadow: `0 2px 32px rgba(0,0,0,0.5), 0px 1px 5px rgba(0,0,0,0.1)`, + }, + }, + MuiDivider: { + root: { + margin: '.75rem 0', + }, + }, + MuiDrawer: { + root: { + background: colors.gray[500], + paddingTop: '10px', + }, + }, + MuiFormGroup: { + root: { + color: colors.pink[500], + }, + }, + MuiMenuItem: { + root: { + fontSize: '0.875rem', + }, + }, + MuiTableCell: { + root: { + borderBottom: `1px solid ${colors.gray[300]}`, + padding: '10px !important', + color: `${colors.gray[100]} !important`, + '& img[alt="playing"], & img[alt="paused"]': { + filter: + 'brightness(0) saturate(100%) invert(36%) sepia(93%) saturate(7463%) hue-rotate(289deg) brightness(95%) contrast(102%)', + }, + '& img[alt="playing"] + span, & img[alt="paused"] + span': { + color: colors.pink[500], + }, + }, + head: { + borderBottom: `1px solid ${colors.gray[200]}`, + fontSize: '0.75rem', + textTransform: 'uppercase', + letterSpacing: 1.2, + }, + }, + MuiTableRow: { + root: { + padding: '10px 0', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: `${colors.gray[300]} !important`, + }, + '@global': { + 'td:nth-child(4)': { + color: `${colors.white} !important`, + }, + }, + }, + }, + + // React Admin Components + RaBulkActionsToolbar: { + topToolbar: { + gap: '8px', + }, + }, + RaFilter: { + form: { + '& .MuiOutlinedInput-input:-webkit-autofill': { + '-webkit-box-shadow': `0 0 0 100px ${colors.gray[50]} inset`, + '-webkit-text-fill-color': colors.white, + }, + }, + }, + RaFilterButton: { + root: { + marginRight: '1rem', + }, + }, + RaLayout: { + content: { + padding: '0 !important', + background: `linear-gradient(${colors.dark}, ${colors.gray[500]})`, + borderTopRightRadius: '8px', + borderTopLeftRadius: '8px', + }, + contentWithSidebar: { + gap: '2px', + }, + }, + RaList: { + content: { + backgroundColor: 'inherit', + }, + bulkActionsDisplayed: { + marginTop: '-20px', + }, + }, + RaListToolbar: { + toolbar: { + padding: '0 .55rem !important', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: `1px solid ${colors.gray[100]}`, + }, + button: { + backgroundColor: 'inherit', + minWidth: 48, + margin: '0 4px', + border: `1px solid ${colors.gray[200]}`, + '@global': { + '> .MuiButton-label': { + padding: 0, + }, + }, + }, + actions: { + '@global': { + '.next-page': { + marginLeft: 8, + marginRight: 8, + }, + '.previous-page': { + marginRight: 8, + }, + }, + }, + }, + RaSearchInput: { + input: { + paddingLeft: '.9rem', + border: 0, + '& .MuiInputBase-root': { + backgroundColor: `${colors.white} !important`, + borderRadius: '20px !important', + color: colors.black, + border: '0px', + '& fieldset': { + borderColor: colors.white, + }, + '&:hover fieldset': { + borderColor: colors.white, + }, + '&.Mui-focused fieldset': { + borderColor: colors.white, + }, + '& svg': { + color: `${colors.black} !important`, + }, + '& .MuiOutlinedInput-input:-webkit-autofill': { + borderRadius: '20px 0px 0px 20px', + '-webkit-box-shadow': `0 0 0 100px ${colors.gray[50]} inset`, + '-webkit-text-fill-color': colors.black, + }, + }, + }, + }, + RaSidebar: { + root: { + height: 'initial', + borderTopRightRadius: '8px', + borderTopLeftRadius: '8px', + }, + }, + + // Navidrome Custom Components + NDAlbumDetails: { + root: { + boxShadow: 'none', + background: `linear-gradient(45deg, ${colors.purple[500]}, ${colors.purple[400]}, ${colors.purple[600]})`, + backgroundSize: '200% 200%', + animation: 'gradientFlow 8s ease-in-out infinite', + position: 'relative', + '&:before': { + content: '""', + position: 'absolute', + top: '0', + left: '0', + width: '100%', + height: '100%', + background: `linear-gradient(to bottom, transparent, ${colors.dark})`, + }, + }, + cardContents: { + alignItems: 'flex-start', + }, + coverParent: { + zIndex: '99999', + position: 'relative', + backgroundColor: 'rgba(0, 0, 0, 0.5)', + '&::before': { + content: '""', + position: 'absolute', + inset: '0', + width: '100%', + height: '100%', + borderRadius: '50%', + animation: 'pulse 1.5s ease-in-out infinite alternate', + zIndex: -1, + }, + '&::after': { + content: '""', + position: 'absolute', + inset: '0', + zIndex: '-1', + borderRadius: '50%', + background: + 'repeating-conic-gradient(from 0deg, rgba(255,255,255,0.08) 0deg, rgba(255,255,255,0.08) 0.5deg, rgba(0,0,0,1) 1deg)', + filter: 'contrast(999) sepia(1)', + boxShadow: + 'inset 0 0 25px rgba(255,255,255,0.05), inset 0 0 95px rgba(0,0,0,0.9)', + animation: 'spin 6s linear infinite', + }, + }, + details: { + zIndex: '99999', + }, + recordName: { + fontSize: 'calc(1rem + 1.5vw)', + fontWeight: 900, + }, + recordArtist: { + fontSize: '1.5rem', + fontWeight: 700, + textShadow: '0 2px 16px rgba(0, 0, 0, 0.3)', + }, + recordMeta: { + fontSize: '.875rem', + color: `rgba(${colors.white}, 0.8)`, + }, + content: { + paddingBottom: '0px !important', + paddingTop: '0px', + }, + }, + RaSingleFieldList: { + root: { + '& a:first-of-type > .MuiChip-root': { + marginLeft: '0px', + }, + '& a > .MuiChip-root': { + backgroundColor: colors.pink[500], + fontSize: '0.6rem', + height: '20px', + '& .MuiChip-label': { + color: colors.white, + paddingLeft: '5px', + paddingRight: '5px', + }, + }, + }, + }, + MuiGridListTile: { + tile: { + '&:hover': { + boxShadow: '0 2px 32px rgba(0,0,0,0.5), 0px 1px 5px rgba(0,0,0,0.1)', + }, + }, + }, + NDAlbumGridView: { + tileBar: { + background: + 'linear-gradient(to top, rgba(0, 0, 0, 0.7) 0%, rgba(0, 0, 0, 0.4) 50%, rgba(0, 0, 0, 0) 100%)', + marginBottom: '2px', + }, + albumName: { + marginTop: '0.5rem', + fontWeight: 700, + textTransform: 'none', + color: colors.white, + }, + albumSubtitle: { + color: colors.gray[100], + }, + albumContainer: { + backgroundColor: colors.gray[400], + borderRadius: '.5rem', + padding: '.75rem', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: colors.gray[200], + }, + }, + albumPlayButton: { + color: colors.black, + backgroundColor: colors.pink[500], + borderRadius: '50%', + boxShadow: '0 8px 8px rgb(0 0 0 / 30%)', + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + background: `${colors.pink[500]} !important`, + padding: '0.45rem', + }, + }, + }, + NDAlbumShow: { + albumActions: musicListActions, + }, + NDArtistShow: { + actions: { + padding: '2rem 0', + alignItems: 'center', + overflow: 'visible', + minHeight: '120px', + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: 'inherit', + color: colors.gray[100], + margin: '0 0.5rem', + '&:hover': { + border: `1px solid ${colors.gray[100]}`, + backgroundColor: 'inherit !important', + }, + }, + // Hide shuffle button label (first button) + 'button:first-child>span:first-child>span': { + display: 'none', + }, + // Style shuffle button (first button) + 'button:first-child': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.5)', + margin: '1rem', + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: '1.5rem', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + background: colors.pink[500], + color: colors.white, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${colors.pink[500]} !important`, + border: 0, + }, + }, + 'button:first-child>span:first-child': { + padding: 0, + color: `${colors.black} !important`, + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: colors.gray[100], + }, + }, + }, + actionsContainer: { + overflow: 'visible', + }, + }, + NDAudioPlayer: { + audioTitle: { + color: colors.white, + fontSize: '1.5rem', + '& span:nth-child(3)': { + fontSize: '0.8rem', + }, + }, + songTitle: { + fontWeight: 900, + }, + songInfo: { + fontSize: '0.9rem', + color: colors.gray[100], + }, + }, + NDCollapsibleComment: { + commentBlock: { + fontSize: '.875rem', + color: `rgba(${colors.white}, 0.8)`, + }, + }, + NDLogin: { + main: { + boxShadow: `inset 0 0 0 2000px rgba(${colors.black}, .75)`, + }, + systemNameLink: { + color: colors.white, + }, + card: { + border: `1px solid ${colors.gray[200]}`, + }, + avatar: { + marginBottom: 0, + }, + }, + NDPlaylistDetails: { + container: { + background: `linear-gradient(${colors.gray[300]}, transparent)`, + borderRadius: 0, + paddingTop: '2.5rem !important', + boxShadow: 'none', + }, + title: { + fontSize: 'calc(1.5rem + 1.5vw)', + fontWeight: 700, + color: colors.white, + }, + details: { + fontSize: '.875rem', + color: `rgba(${colors.white}, 0.8)`, + }, + }, + NDPlaylistShow: { + playlistActions: musicListActions, + }, + }, + + /** + * Player configuration settings. + * Specifies the player theme and associated stylesheet. + * @type {Object} + */ + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/amusic.css.js b/ui/src/themes/amusic.css.js new file mode 100644 index 000000000..dcdd8bee8 --- /dev/null +++ b/ui/src/themes/amusic.css.js @@ -0,0 +1,92 @@ +const stylesheet = ` +.react-jinke-music-player-main .music-player-panel svg { + color: #eee +} +.react-jinke-music-player-main .music-player-panel button:disabled svg { + opacity: 0.3 +} +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover { + color: #D60017 +} +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #ff4e6b +} +.react-jinke-music-player-main ::-webkit-scrollbar-thumb, +.react-jinke-music-player-mobile-progress .rc-slider-handle, +.react-jinke-music-player-mobile-progress .rc-slider-track { + background-color: #ff4e6b +} +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #ff4e6b +} +.audio-lists-panel-content .audio-item.playing, +.react-jinke-music-player-main .audio-item.playing svg, +.react-jinke-music-player-main .group player-delete { + color: #ff4e6b +} +.audio-lists-panel-content .audio-item:hover, +.audio-lists-panel-content .audio-item:hover svg +.audio-lists-panel-content .audio-item:active .group:not([class=".player-delete"]) svg, .audio-lists-panel-content .audio-item:hover .group:not([class=".player-delete"]) svg{ + color: #D60017 +} +.react-jinke-music-player-main .audio-item.playing .player-singer { + color: #ff4e6b !important +} +.react-jinke-music-player-main .lyric-btn-active svg{ + color: #ff4e6b !important +} +.react-jinke-music-player-main .lyric-btn-active { + color: #D60017 !important +} +.react-jinke-music-player-main .loading svg { + color: #ff4e6b !important +} +.react-jinke-music-player .music-player-controller .music-player-controller-setting{ + background: #ff4e6b4d +} +.react-jinke-music-player-main .music-player-lyric{ + color: #ff4e6b !important; + text-shadow: -1px -1px 0 #000, 1px -1px 0 #000, -1px 1px 0 #000, 1px 1px 0 #000 +} +.react-jinke-music-player-main .music-player-panel, +.react-jinke-music-player-mobile, +.ril__outer{ + background-color: #1a1a1a; + border: 1px solid #fff1; +} +.ril__toolbarItem{ + font-size: 100%; + color: #eee +} +.audio-lists-panel, +.ril__toolbar{ + background-color: #1f1f1f; + border: 1px solid #fff1; + border-radius: 6px 6px 0 0; +} +.react-jinke-music-player-main .music-player-panel .panel-content .img-rotate, +.react-jinke-music-player-mobile .react-jinke-music-player-mobile-cover img.cover, +.react-jinke-music-player-mobile-cover { + border-radius: 6px !important; + animation-duration: 0s !important +} +.react-jinke-music-player-main .music-player-panel .panel-content .img-content{ + width: 60px; + height: 60px +} +.react-jinke-music-player-main .songTitle{ + color: #eee +} +.react-jinke-music-player .music-player-controller{ + color: #ff4e6b +} +.audio-lists-panel-mobile .audio-item:not(.audio-lists-panel-sortable-highlight-bg){ + background: unset +} +.lastfm-icon, +.musicbrainz-icon{ + color: #eee +} +` +export default stylesheet diff --git a/ui/src/themes/amusic.js b/ui/src/themes/amusic.js new file mode 100644 index 000000000..55205baf3 --- /dev/null +++ b/ui/src/themes/amusic.js @@ -0,0 +1,244 @@ +import stylesheet from './amusic.css.js' + +export default { + themeName: 'AMusic', + typography: { + fontFamily: + '-apple-system, BlinkMacSystemFont, Apple Color Emoji, SF Pro, SF Pro Icons, Helvetica Neue, Helvetica, Arial, sans-serif', + h6: { + fontSize: '1rem', // AppBar title + }, + h5: { + fontSize: '2em', + fontWeight: '600', + }, + }, + palette: { + primary: { + main: '#ff4e6b', + }, + secondary: { + main: '#D60017', + contrastText: '#eee', + }, + background: { + default: '#1a1a1a', + paper: '#1a1a1a', + }, + type: 'dark', + }, + overrides: { + MuiFormGroup: { + root: { + color: 'white', + }, + }, + MuiAppBar: { + positionFixed: { + backgroundColor: '#1d1d1d !important', + boxShadow: 'none', + borderBottom: '1px solid #fff1', + }, + colorSecondary: { + color: '#eee', + }, + }, + MuiDrawer: { + root: { + background: '#1d1d1d', + borderRight: '1px solid #fff1', + }, + }, + MuiToolbar: { + root: { + background: 'transparent !important', + }, + }, + MuiCardMedia: { + img: { + borderRadius: '10px', + boxShadow: '5px 5px 20px #111', + }, + }, + MuiButton: { + root: { + background: '#D60017', + color: '#fff', + borderRadius: '6px', + paddingRight: '0.5rem', + paddingLeft: '0.5rem', + marginLeft: '0.5rem', + marginBottom: '0.5rem', + textTransform: 'capitalize', + fontWeight: 600, + }, + textPrimary: { + color: '#eee', + }, + textSecondary: { + color: '#eee', + backgroundColor: '#ff4e6b', + }, + textSizeSmall: { + fontSize: '0.8rem', + paddingRight: '0.5rem', + paddingLeft: '0.5rem', + }, + label: { + paddingRight: '1rem', + paddingLeft: '0.7rem', + }, + }, + MuiListItemIcon: { + root: { + color: '#ff4e6b', + }, + }, + MuiChip: { + root: { + borderRadius: '6px', + }, + }, + MuiIconButton: { + root: { + color: '#ff4e6b', + }, + }, + MuiTableBody: { + root: { + '&>tr:nth-child(odd)': { + background: 'rgba(255, 255, 255, 0.025)', + }, + }, + }, + MuiTableRow: { + root: { + background: 'transparent', + }, + }, + MuiTableCell: { + root: { + borderBottom: '0 none !important', + padding: '10px !important', + color: '#b3b3b3 !important', + }, + head: { + color: '#b3b3b3 !important', + }, + }, + MuiMenuItem: { + root: { + fontSize: '0.875rem', + borderRadius: '10px', + color: '#eee', + }, + }, + NDAlbumGridView: { + albumName: { + color: '#eee', + }, + albumPlayButton: { + color: '#ff4e6b', + }, + albumArtistName: { + color: '#ccc', + }, + cover: { + borderRadius: '6px', + }, + }, + NDLogin: { + systemNameLink: { + color: '#ff4e6b', + }, + welcome: { + color: '#eee', + }, + card: { + minWidth: 300, + backgroundColor: '#1d1d1d', + }, + icon: { + filter: 'hue-rotate(115deg)', + }, + }, + MuiPaper: { + elevation1: { + boxShadow: 'none', + }, + root: { + color: '#eee', + }, + rounded: { + borderRadius: '6px', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: '#1a1a1a', + }, + artistName: { + fontWeight: '600', + fontSize: '2em', + }, + }, + NDDesktopArtistDetails: { + artistName: { + fontWeight: '600', + fontSize: '2em', + }, + artistDetail: { + padding: 'unset', + paddingBottom: '1rem', + }, + }, + RaConfirm: { + confirmPrimary: { + color: '#fff', + }, + }, + RaDeleteWithConfirmButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaDeleteWithUndoButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaBulkDeleteWithConfirmButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaBulkDeleteWithUndoButton: { + deleteButton: { + color: '#fff !important', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: '2px solid #D60017', + background: 'transparent', + }, + button: { + border: '2px solid #D60017', + }, + actions: { + '@global': { + '.next-page': { + border: '0 none', + }, + '.previous-page': { + border: '0 none', + }, + }, + }, + }, + }, + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/catppuccinLatte.css.js b/ui/src/themes/catppuccinLatte.css.js new file mode 100644 index 000000000..84c8d2d7f --- /dev/null +++ b/ui/src/themes/catppuccinLatte.css.js @@ -0,0 +1,203 @@ +const stylesheet = ` + .react-jinke-music-player-main.light-theme svg, + .react-jinke-music-player .music-player-controller, + .react-jinke-music-player .audio-circle-process-bar circle[class='stroke'] { + color: #6c6f85; + stroke: #6c6f85; + } + + .react-jinke-music-player-main svg:active, + .react-jinke-music-player-main svg:hover { + color: #7c7f93; + } + + .react-jinke-music-player-main.light-theme svg:active, + .react-jinke-music-player-main.light-theme svg:hover { + color: #7c7f93; + } + + .react-jinke-music-player-mobile-play-model-tip, + .react-jinke-music-player-main.light-theme .play-mode-title { + background-color: #6c6f85; + color: #eff1f5; + } + + .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, + .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #6c6f85; + } + + .react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #6c6f85; + } + + .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #6c6f85; + } + + .react-jinke-music-player-main .audio-item.playing svg { + color: #6c6f85; + } + + .react-jinke-music-player-main .audio-item.playing .player-singer { + color: #6c6f85 !important; + } + + .react-jinke-music-player-main .loading svg { + color: #6c6f85 !important; + } + + .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle { + border: hidden; + box-shadow: + rgba(76, 79, 105, 0.12) 0px 4px 6px, + rgba(76, 79, 105, 0.08) 0px 5px 7px; + } + + .rc-slider-rail, + .rc-slider-track { + height: 6px; + } + + .rc-slider { + padding: 3px 0; + } + + .react-jinke-music-player-main.light-theme .rc-switch-checked { + background-color: #6c6f85 !important; + border: 1px solid #6c6f85; + } + + .sound-operation > div:nth-child(4) { + transform: translateX(-50%) translateY(5%) !important; + } + + .sound-operation { + padding: 4px 0; + } + + .react-jinke-music-player-main .music-player-panel { + background-color: #e6e9ef; + color: #4c4f69; + box-shadow: 0 0 8px rgba(76, 79, 105, 0.15); + } + + .react-jinke-music-player-main.light-theme .music-player-panel { + color: #4c4f69; + } + + .audio-lists-panel { + background-color: #e6e9ef; + bottom: 6.25rem; + box-shadow: + rgba(76, 79, 105, 0.12) 0px 4px 6px, + rgba(76, 79, 105, 0.08) 0px 5px 7px; + } + + .audio-lists-panel-content .audio-item.playing { + background-color: rgba(0, 0, 0, 0); + } + + .audio-lists-panel-content .audio-item:nth-child(2n+1) { + background-color: rgba(0, 0, 0, 0); + } + + .audio-lists-panel-content .audio-item:active, + .audio-lists-panel-content .audio-item:hover { + background-color: rgba(76, 79, 105, 0.08); + } + + .audio-lists-panel-header { + border-bottom: 1px solid #ccd0da; + box-shadow: none; + } + + .react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn { + background-color: rgba(0, 0, 0, 0); + box-shadow: 0 0 0 0; + } + + .react-jinke-music-player-main.light-theme .audio-lists-panel-header { + background-color: #e6e9ef; + color: #4c4f69; + } + + .audio-lists-panel-content .audio-item { + line-height: 32px; + color: #4c4f69; + } + + .react-jinke-music-player-main .music-player-panel .panel-content .img-content { + box-shadow: + rgba(76, 79, 105, 0.12) 0px 4px 6px, + rgba(76, 79, 105, 0.08) 0px 5px 7px; + } + + .react-jinke-music-player-main .music-player-lyric { + color: #6c6f85; /* subtext0 */ + -webkit-text-stroke: 0.35px #eff1f5; + font-weight: bolder; + } + + .react-jinke-music-player-main .lyric-btn-active, + .react-jinke-music-player-main .lyric-btn-active svg { + color: #6c6f85 !important; + } + + .audio-lists-panel-content .audio-item.playing, + .audio-lists-panel-content .audio-item.playing svg { + color: #6c6f85; + } + + .audio-lists-panel-content .audio-item:active .group:not([class=".player-delete"]) svg, + .audio-lists-panel-content .audio-item:hover .group:not([class=".player-delete"]) svg { + color: #6c6f85; + } + + .audio-lists-panel-content .audio-item .player-icons { + scale: 75%; + } + + .audio-lists-panel-content .audio-item:active, + .audio-lists-panel-content .audio-item:hover { + background-color: #dce0e8; /* surface1 */ + } + + /* Mobile */ + .react-jinke-music-player-mobile-cover { + border: none; + box-shadow: + rgba(76, 79, 105, 0.12) 0px 4px 6px, + rgba(76, 79, 105, 0.08) 0px 5px 7px; + } + + .react-jinke-music-player .music-player-controller { + border: none; + background-color: #e6e9ef; + border-color: #e6e9ef; + box-shadow: + rgba(76, 79, 105, 0.12) 0px 4px 6px, + rgba(76, 79, 105, 0.08) 0px 5px 7px; + color: #6c6f85; + } + + .react-jinke-music-player .music-player-controller.music-player-playing:before { + border: 1px solid rgba(76, 79, 105, 0.18); + } + + .react-jinke-music-player .music-player-controller .music-player-controller-setting { + background: rgba(108, 111, 133, 0.2); + color: #eff1f5; + } + + .react-jinke-music-player-mobile-progress .rc-slider-handle, + .react-jinke-music-player-mobile-progress .rc-slider-track { + background-color: #6c6f85; + } + + .react-jinke-music-player-mobile-progress .rc-slider-handle { + border: none; + } +` + +export default stylesheet diff --git a/ui/src/themes/catppuccinLatte.js b/ui/src/themes/catppuccinLatte.js new file mode 100644 index 000000000..3624cd853 --- /dev/null +++ b/ui/src/themes/catppuccinLatte.js @@ -0,0 +1,104 @@ +import stylesheet from './catppuccinLatte.css.js' + +export default { + themeName: 'Catppuccin Latte', + palette: { + primary: { main: '#8839ef' }, // mauve + secondary: { + main: '#ccd0da', // surface0 + contrastText: '#4c4f69', // text + }, + type: 'light', + background: { + default: '#eff1f5', // base + }, + }, + + overrides: { + MuiPaper: { + root: { + color: '#4c4f69', // text + backgroundColor: '#e6e9ef', // mantle + }, + }, + + MuiButton: { + textPrimary: { + color: '#1e66f5', // blue + }, + textSecondary: { + color: '#4c4f69', // text + }, + }, + + MuiChip: { + clickable: { + background: '#ccd0da', // surface0 + }, + }, + + MuiFormGroup: { + root: { + color: '#4c4f69', + }, + }, + + MuiFormHelperText: { + root: { + Mui: { + error: { + color: '#d20f39', // red + }, + }, + }, + }, + + MuiTableHead: { + root: { + color: '#4c4f69', + background: '#e6e9ef', + }, + }, + + MuiTableCell: { + root: { + color: '#4c4f69', + background: '#e6e9ef !important', + }, + head: { + color: '#4c4f69', + background: '#e6e9ef !important', + }, + }, + + NDLogin: { + systemNameLink: { + color: '#8839ef', // mauve + }, + icon: {}, + welcome: { + color: '#4c4f69', + }, + card: { + minWidth: 300, + background: '#eff1f5', + }, + avatar: {}, + button: { + boxShadow: '3px 3px 5px #ccd0da', + }, + }, + + NDMobileArtistDetails: { + bgContainer: { + background: + 'linear-gradient(to bottom, rgba(255 255 255 / 72%), rgb(239 241 245))!important', + }, + }, + }, + + player: { + theme: 'light', + stylesheet, + }, +} diff --git a/ui/src/themes/dark.js b/ui/src/themes/dark.js index 2f06b4337..15d8aa365 100644 --- a/ui/src/themes/dark.js +++ b/ui/src/themes/dark.js @@ -16,6 +16,11 @@ export default { color: 'white', }, }, + MuiButton: { + textPrimary: { + color: '#fff', + }, + }, NDLogin: { systemNameLink: { color: '#0085ff', diff --git a/ui/src/themes/dracula.css.js b/ui/src/themes/dracula.css.js new file mode 100644 index 000000000..0e837be24 --- /dev/null +++ b/ui/src/themes/dracula.css.js @@ -0,0 +1,181 @@ +const stylesheet = ` + +/* Icon hover: pink */ +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover { + color: #ff79c6 +} + +/* Progress bar: purple */ +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #bd93f9 +} + +/* Volume bar: green */ +.sound-operation .rc-slider-handle, .sound-operation .rc-slider-track { + background-color: #50fa7b !important +} + +.sound-operation .rc-slider-handle:active { + box-shadow: 0 0 2px #50fa7b !important +} + +/* Scrollbar: comment */ +.react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #6272a4; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #bd93f9 +} + +/* Now playing icon: cyan */ +.react-jinke-music-player-main .audio-item.playing svg { + color: #8be9fd +} + +/* Now playing artist: cyan */ +.react-jinke-music-player-main .audio-item.playing .player-singer { + color: #8be9fd !important +} + +/* Loading spinner: orange */ +.react-jinke-music-player-main .loading svg { + color: #ffb86c !important +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle { + border: hidden; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +.rc-slider-rail, .rc-slider-track { + height: 6px; +} + +.rc-slider { + padding: 3px 0; +} + +.sound-operation > div:nth-child(4) { + transform: translateX(-50%) translateY(5%) !important; +} + +.sound-operation { + padding: 4px 0; +} + +/* Player panel background */ +.react-jinke-music-player-main .music-player-panel { + background-color: #282a36; + color: #f8f8f2; + box-shadow: 0 0 8px rgba(0, 0, 0, 0.25); +} + +/* Song title in player: foreground */ +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-title { + color: #f8f8f2; +} + +/* Duration/time text: yellow */ +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .duration, .react-jinke-music-player-main .music-player-panel .panel-content .player-content .current-time { + color: #f1fa8c +} + +/* Audio list panel */ +.audio-lists-panel { + background-color: #282a36; + bottom: 6.25rem; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +.audio-lists-panel-content .audio-item.playing { + background-color: transparent; +} + +.audio-lists-panel-content .audio-item:nth-child(2n+1) { + background-color: transparent; +} + +/* Playlist hover: current line */ +.audio-lists-panel-content .audio-item:active, +.audio-lists-panel-content .audio-item:hover { + background-color: #44475a; +} + +.audio-lists-panel-header { + border-bottom: 1px solid rgba(0, 0, 0, 0.25); + box-shadow: none; +} + +/* Playlist header text: orange */ +.audio-lists-panel-header-title { + color: #ffb86c; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn { + background-color: transparent; + box-shadow: none; +} + +.audio-lists-panel-content .audio-item { + line-height: 32px; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .img-content { + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +/* Lyrics: yellow */ +.react-jinke-music-player-main .music-player-lyric { + color: #f1fa8c; + -webkit-text-stroke: 0.5px #282a36; + font-weight: bolder; +} + +/* Lyric button active: yellow */ +.react-jinke-music-player-main .lyric-btn-active, .react-jinke-music-player-main .lyric-btn-active svg { + color: #f1fa8c !important; +} + +/* Playlist now playing: cyan */ +.audio-lists-panel-content .audio-item.playing, .audio-lists-panel-content .audio-item.playing svg { + color: #8be9fd +} + +/* Playlist hover icons: pink */ +.audio-lists-panel-content .audio-item:active .group:not(.player-delete) svg, .audio-lists-panel-content .audio-item:hover .group:not(.player-delete) svg { + color: #ff79c6 +} + +.audio-lists-panel-content .audio-item .player-icons { + scale: 75%; +} + +/* Mobile */ + +.react-jinke-music-player-mobile-cover { + border: none; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; +} + +.react-jinke-music-player .music-player-controller { + border: none; + box-shadow: rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px; + color: #bd93f9; +} + +.react-jinke-music-player .music-player-controller .music-player-controller-setting { + color: rgba(189, 147, 249, 0.3); +} + +/* Mobile progress: green */ +.react-jinke-music-player-mobile-progress .rc-slider-handle, .react-jinke-music-player-mobile-progress .rc-slider-track { + background-color: #50fa7b; +} + +.react-jinke-music-player-mobile-progress .rc-slider-handle { + border: none; +} +` + +export default stylesheet diff --git a/ui/src/themes/dracula.js b/ui/src/themes/dracula.js new file mode 100644 index 000000000..2e4ae38e5 --- /dev/null +++ b/ui/src/themes/dracula.js @@ -0,0 +1,397 @@ +import stylesheet from './dracula.css.js' + +// Dracula color palette +const background = '#282a36' +const currentLine = '#44475a' +const foreground = '#f8f8f2' +const comment = '#6272a4' +const cyan = '#8be9fd' +const green = '#50fa7b' +const pink = '#ff79c6' +const purple = '#bd93f9' +const orange = '#ffb86c' +const red = '#ff5555' +const yellow = '#f1fa8c' + +// Darker shade for surfaces +const surface = '#21222c' + +// For Album, Playlist play button +const musicListActions = { + alignItems: 'center', + '@global': { + 'button:first-child:not(:only-child)': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.5)', + margin: '1rem', + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: '1.5rem', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + backgroundColor: `${green} !important`, + color: background, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${green} !important`, + border: 0, + }, + }, + 'button:only-child': { + margin: '1.5rem', + }, + 'button:first-child>span:first-child': { + padding: 0, + }, + 'button:first-child>span:first-child>span': { + display: 'none', + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: foreground, + }, + }, +} + +export default { + themeName: 'Dracula', + palette: { + primary: { + main: purple, + }, + secondary: { + main: currentLine, + contrastText: foreground, + }, + error: { + main: red, + }, + type: 'dark', + background: { + default: background, + paper: surface, + }, + }, + overrides: { + MuiPaper: { + root: { + color: foreground, + backgroundColor: surface, + }, + }, + MuiAppBar: { + positionFixed: { + backgroundColor: `${currentLine} !important`, + boxShadow: + 'rgba(20, 21, 28, 0.25) 0px 4px 6px, rgba(20, 21, 28, 0.1) 0px 5px 7px', + }, + }, + MuiDrawer: { + root: { + background: background, + }, + }, + MuiButton: { + textPrimary: { + color: purple, + }, + textSecondary: { + color: foreground, + }, + }, + MuiIconButton: { + root: { + color: foreground, + }, + }, + MuiChip: { + root: { + backgroundColor: currentLine, + }, + }, + MuiFormGroup: { + root: { + color: foreground, + }, + }, + MuiFormLabel: { + root: { + color: comment, + '&$focused': { + color: purple, + }, + }, + }, + MuiToolbar: { + root: { + backgroundColor: `${surface} !important`, + }, + }, + MuiOutlinedInput: { + root: { + '& $notchedOutline': { + borderColor: currentLine, + }, + '&:hover $notchedOutline': { + borderColor: comment, + }, + '&$focused $notchedOutline': { + borderColor: purple, + }, + }, + }, + MuiFilledInput: { + root: { + backgroundColor: currentLine, + '&:hover': { + backgroundColor: comment, + }, + '&$focused': { + backgroundColor: currentLine, + }, + }, + }, + MuiTableRow: { + root: { + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: `${currentLine} !important`, + }, + }, + }, + MuiTableHead: { + root: { + color: foreground, + background: surface, + }, + }, + MuiTableCell: { + root: { + color: foreground, + background: `${surface} !important`, + borderBottom: `1px solid ${currentLine}`, + }, + head: { + color: `${yellow} !important`, + background: `${currentLine} !important`, + }, + body: { + color: `${foreground} !important`, + }, + }, + MuiSwitch: { + colorSecondary: { + '&$checked': { + color: green, + }, + '&$checked + $track': { + backgroundColor: green, + }, + }, + }, + NDAlbumGridView: { + albumName: { + marginTop: '0.5rem', + fontWeight: 700, + color: foreground, + }, + albumSubtitle: { + color: comment, + }, + albumContainer: { + backgroundColor: surface, + borderRadius: '8px', + padding: '.75rem', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: currentLine, + }, + }, + albumPlayButton: { + backgroundColor: green, + borderRadius: '50%', + boxShadow: '0 8px 8px rgb(0 0 0 / 30%)', + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + background: `${green} !important`, + padding: '0.45rem', + }, + }, + }, + NDPlaylistDetails: { + container: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + paddingTop: '2.5rem !important', + boxShadow: 'none', + }, + title: { + fontWeight: 700, + color: foreground, + }, + details: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumDetails: { + root: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + boxShadow: 'none', + }, + cardContents: { + alignItems: 'center', + paddingTop: '1.5rem', + }, + recordName: { + fontWeight: 700, + color: foreground, + }, + recordArtist: { + fontSize: '.875rem', + fontWeight: 700, + color: pink, + }, + recordMeta: { + fontSize: '.875rem', + color: comment, + }, + }, + NDCollapsibleComment: { + commentBlock: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumShow: { + albumActions: musicListActions, + }, + NDPlaylistShow: { + playlistActions: musicListActions, + }, + NDAudioPlayer: { + audioTitle: { + color: foreground, + fontSize: '0.875rem', + }, + songTitle: { + fontWeight: 400, + }, + songInfo: { + fontSize: '0.675rem', + color: comment, + }, + }, + NDLogin: { + systemNameLink: { + color: purple, + }, + welcome: { + color: foreground, + }, + card: { + minWidth: 300, + background: background, + }, + button: { + boxShadow: '3px 3px 5px #191a21', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: `linear-gradient(to bottom, rgba(40 42 54 / 72%), ${surface})!important`, + }, + }, + RaLayout: { + content: { + padding: '0 !important', + background: surface, + }, + root: { + backgroundColor: background, + }, + }, + RaList: { + content: { + backgroundColor: surface, + }, + }, + RaListToolbar: { + toolbar: { + backgroundColor: background, + padding: '0 .55rem !important', + }, + }, + RaSidebar: { + fixed: { + backgroundColor: background, + }, + drawerPaper: { + backgroundColor: `${background} !important`, + }, + }, + MuiTableSortLabel: { + root: { + color: `${yellow} !important`, + '&:hover': { + color: `${orange} !important`, + }, + '&$active': { + color: `${orange} !important`, + '&& $icon': { + color: `${orange} !important`, + }, + }, + }, + }, + RaMenuItemLink: { + root: { + color: foreground, + '&[aria-current="page"]': { + color: `${pink} !important`, + }, + '&[aria-current="page"] .MuiListItemIcon-root': { + color: `${pink} !important`, + }, + }, + active: { + color: `${pink} !important`, + '& .MuiListItemIcon-root': { + color: `${pink} !important`, + }, + }, + }, + RaLink: { + link: { + color: cyan, + }, + }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: `2px solid ${purple}`, + }, + button: { + backgroundColor: currentLine, + minWidth: 48, + margin: '0 4px', + }, + }, + }, + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/gruvboxDark.css.js b/ui/src/themes/gruvboxDark.css.js index dc1f64041..f482451b2 100644 --- a/ui/src/themes/gruvboxDark.css.js +++ b/ui/src/themes/gruvboxDark.css.js @@ -5,7 +5,7 @@ const stylesheet = ` } .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { - background-color: #458588 + background-color: #ebdbb2 } .react-jinke-music-player-main ::-webkit-scrollbar-thumb { @@ -50,6 +50,13 @@ const stylesheet = ` .MuiCheckbox-colorSecondary.Mui-checked { color: #458588 !important } +.react-jinke-music-player-main .music-player-panel svg { + color: #ebdbb2; + fill: #ebdbb2; +} +.react-jinke-music-player-main .music-player-panel button { + color: #ebdbb2; +} ` export default stylesheet diff --git a/ui/src/themes/gruvboxDark.js b/ui/src/themes/gruvboxDark.js index b576e7713..0f4cbd7c4 100644 --- a/ui/src/themes/gruvboxDark.js +++ b/ui/src/themes/gruvboxDark.js @@ -14,22 +14,34 @@ export default { background: { default: '#282828', }, + text: { + primary: '#ebdbb2', + secondary: '#a89984', + }, }, overrides: { MuiPaper: { root: { color: '#ebdbb2', backgroundColor: '#3c3836', - MuiSnackbarContent: { - root: { - color: '#ebdbb2', - backgroundColor: '#cc241d', - }, - message: { - color: '#ebdbb2', - backgroundColor: '#cc241d', - }, - }, + }, + }, + MuiSnackbarContent: { + root: { + color: '#3c3836', + backgroundColor: '#a89984', + }, + message: { + color: '#3c3836', + backgroundColor: '#a89984', + }, + }, + MuiTypography: { + root: { + color: '#ebdbb2', + }, + colorTextSecondary: { + color: '#a89984', }, }, MuiButton: { @@ -40,6 +52,24 @@ export default { color: '#ebdbb2', }, }, + MuiIconButton: { + root: { + color: '#ebdbb2', + }, + }, + MuiListItemIcon: { + root: { + color: '#ebdbb2', + }, + }, + MuiListItemText: { + primary: { + color: '#ebdbb2', + }, + secondary: { + color: '#a89984', + }, + }, MuiChip: { clickable: { background: '#49483e', @@ -52,11 +82,10 @@ export default { }, MuiFormHelperText: { root: { - Mui: { - error: { - color: '#cc241d', - }, - }, + color: '#ebdbb2', + }, + error: { + color: '#cc241d', }, }, MuiTableHead: { @@ -92,12 +121,33 @@ export default { boxShadow: '3px 3px 5px #3c3836', }, }, + MuiSwitch: { + colorSecondary: { + '&$checked': { + color: '#458588', + }, + '&$checked + $track': { + backgroundColor: '#458588', + }, + }, + }, NDMobileArtistDetails: { bgContainer: { background: 'linear-gradient(to bottom, rgba(52 52 52 / 72%), rgb(48 48 48))!important', }, }, + NDAlbumGridView: { + albumName: { + marginTop: '0.5rem', + fontWeight: 700, + textTransform: 'none', + color: '#ebdbb2', + }, + albumSubtitle: { + color: '#a89984', + }, + }, }, player: { theme: 'dark', diff --git a/ui/src/themes/index.js b/ui/src/themes/index.js index 0234d416b..f79a6a999 100644 --- a/ui/src/themes/index.js +++ b/ui/src/themes/index.js @@ -9,7 +9,17 @@ import ElectricPurpleTheme from './electricPurple' import NordTheme from './nord' import GruvboxDarkTheme from './gruvboxDark' import CatppuccinMacchiatoTheme from './catppuccinMacchiato' +import CatppuccinLatteTheme from './catppuccinLatte' +import DraculaTheme from './dracula' import NuclearTheme from './nuclear' +import NutballTheme from './nutball' +import AmusicTheme from './amusic' +import SquiddiesGlassTheme from './SquiddiesGlass' +import NautilineTheme from './nautiline' +import MoonbaseAlphaTheme from './moonbaseAlpha' +import MoonbaseBravoTheme from './moonbaseBravo' +import TokyoNightLightTheme from './tokyoNightLight' +import TokyoNightTheme from './tokyoNight' export default { // Classic default themes @@ -17,14 +27,24 @@ export default { DarkTheme, // New themes should be added here, in alphabetic order + AmusicTheme, CatppuccinMacchiatoTheme, + CatppuccinLatteTheme, + DraculaTheme, ElectricPurpleTheme, ExtraDarkTheme, GreenTheme, GruvboxDarkTheme, LigeraTheme, MonokaiTheme, + MoonbaseAlphaTheme, + MoonbaseBravoTheme, + NautilineTheme, NordTheme, NuclearTheme, + NutballTheme, SpotifyTheme, + SquiddiesGlassTheme, + TokyoNightLightTheme, + TokyoNightTheme, } diff --git a/ui/src/themes/ligera.js b/ui/src/themes/ligera.js index 824cf7e67..363a379bc 100644 --- a/ui/src/themes/ligera.js +++ b/ui/src/themes/ligera.js @@ -70,7 +70,7 @@ export default { }, background: { default: '#f0f2f5', - paper: 'inherit', + paper: bLight['500'], }, text: { secondary: '#232323', @@ -448,15 +448,28 @@ export default { backgroundColor: bLight['500'], }, }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, RaPaginationActions: { button: { - backgroundColor: 'inherit', + backgroundColor: '#fff', + color: '#000', minWidth: 48, margin: '0 4px', - border: '1px solid #282828', + border: '1px solid #cccccc', '@global': { '> .MuiButton-label': { padding: 0, + color: '#656565', + '&:hover': { + color: '#fff !important', + }, + }, + '> .MuiButton-label > svg': { + color: '#656565', }, }, }, diff --git a/ui/src/themes/moonbaseAlpha.css.js b/ui/src/themes/moonbaseAlpha.css.js new file mode 100644 index 000000000..757cfc03c --- /dev/null +++ b/ui/src/themes/moonbaseAlpha.css.js @@ -0,0 +1,63 @@ +const stylesheet = ` + +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover { + color: #9a7420 +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #b8862e; + border-color: #9a7420 +} + +.react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #c9b896; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #b8862e +} + +.react-jinke-music-player-main .audio-item.playing svg { + color: #9a7420 +} + +.react-jinke-music-player-main .audio-item.playing .player-singer { + color: #9a7420 !important +} + +.react-jinke-music-player-main .rc-slider-rail { + background-color: #ddd7cc !important +} + +.react-jinke-music-player-main .lyric-btn { + color: #1a1917 !important +} + +.react-jinke-music-player-main .music-player-panel { + color: #1a1917 !important +} + +.react-jinke-music-player-main .lyric-btn-active svg { + color: #9a7420 !important +} + +.music-player-lyric { + color: #9a7420 !important +} + +.audio-lists-panel-content .audio-item.playing, .audio-lists-panel-content .audio-item.playing svg { + color: #9a7420 +} +.audio-lists-panel-content .audio-item:active .group:not(.player-delete) svg, .audio-lists-panel-content .audio-item:hover .group:not(.player-delete) svg { + color: #9a7420 +} + +.progress-bar-content .audio-title a { + color: #1a1917 +} + +.MuiCheckbox-colorSecondary.Mui-checked { + color: #b8862e !important +} +` +export default stylesheet diff --git a/ui/src/themes/moonbaseAlpha.js b/ui/src/themes/moonbaseAlpha.js new file mode 100644 index 000000000..51d8a2696 --- /dev/null +++ b/ui/src/themes/moonbaseAlpha.js @@ -0,0 +1,90 @@ +import stylesheet from './moonbaseAlpha.css.js' + +export default { + themeName: 'Moonbase - Alpha', + palette: { + primary: { + main: '#9a7420', + }, + secondary: { + main: '#ede8df', + contrastText: '#1a1917', + }, + type: 'light', + background: { + default: '#f5f0e8', + }, + }, + overrides: { + MuiPaper: { + root: { + color: '#1a1917', + backgroundColor: '#faf8f4', + }, + }, + MuiButton: { + textPrimary: { + color: '#9a7420', + }, + textSecondary: { + color: '#1a1917', + }, + }, + MuiChip: { + clickable: { + background: '#ede8df', + }, + }, + MuiFormGroup: { + root: { + color: '#1a1917', + }, + }, + MuiFormHelperText: { + error: { + color: '#b04a2e', + }, + }, + MuiTableHead: { + root: { + color: '#6b635a', + background: '#f5f0e8 !important', + }, + }, + MuiTableCell: { + root: { + color: '#1a1917', + background: '#faf8f4 !important', + }, + head: { + color: '#6b635a', + background: '#f5f0e8 !important', + }, + }, + NDLogin: { + systemNameLink: { + color: '#9a7420', + }, + welcome: { + color: '#1a1917', + }, + card: { + minWidth: 300, + background: '#faf8f4', + }, + button: { + boxShadow: '3px 3px 5px rgba(0, 0, 0, 0.12)', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: + 'linear-gradient(to bottom, rgba(245, 240, 232, 0.72), #faf8f4)!important', + }, + }, + }, + player: { + theme: 'light', + stylesheet, + }, +} diff --git a/ui/src/themes/moonbaseBravo.css.js b/ui/src/themes/moonbaseBravo.css.js new file mode 100644 index 000000000..580b054cc --- /dev/null +++ b/ui/src/themes/moonbaseBravo.css.js @@ -0,0 +1,63 @@ +const stylesheet = ` + +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover { + color: #d4a039 +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #d4a039; + border-color: #b8862e +} + +.react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #d4a039; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #d4a039 +} + +.react-jinke-music-player-main .audio-item.playing svg { + color: #d4a039 +} + +.react-jinke-music-player-main .audio-item.playing .player-singer { + color: #d4a039 !important +} + +.react-jinke-music-player-main .rc-slider-rail { + background-color: #2a2a27 !important +} + +.react-jinke-music-player-main .lyric-btn { + color: #e5ddd3 !important +} + +.react-jinke-music-player-main .music-player-panel { + color: #e5ddd3 !important +} + +.react-jinke-music-player-main .lyric-btn-active svg { + color: #d4a039 !important +} + +.music-player-lyric { + color: #d4a039 !important +} + +.audio-lists-panel-content .audio-item.playing, .audio-lists-panel-content .audio-item.playing svg { + color: #d4a039 +} +.audio-lists-panel-content .audio-item:active .group:not(.player-delete) svg, .audio-lists-panel-content .audio-item:hover .group:not(.player-delete) svg { + color: #d4a039 +} + +.progress-bar-content .audio-title a { + color: #e5ddd3 +} + +.MuiCheckbox-colorSecondary.Mui-checked { + color: #d4a039 !important +} +` +export default stylesheet diff --git a/ui/src/themes/moonbaseBravo.js b/ui/src/themes/moonbaseBravo.js new file mode 100644 index 000000000..87585df29 --- /dev/null +++ b/ui/src/themes/moonbaseBravo.js @@ -0,0 +1,90 @@ +import stylesheet from './moonbaseBravo.css.js' + +export default { + themeName: 'Moonbase - Bravo', + palette: { + primary: { + main: '#d4a039', + }, + secondary: { + main: '#1e1e1c', + contrastText: '#e5ddd3', + }, + type: 'dark', + background: { + default: '#0a0a09', + }, + }, + overrides: { + MuiPaper: { + root: { + color: '#e5ddd3', + backgroundColor: '#141413', + }, + }, + MuiButton: { + textPrimary: { + color: '#d4a039', + }, + textSecondary: { + color: '#e5ddd3', + }, + }, + MuiChip: { + clickable: { + background: '#1e1e1c', + }, + }, + MuiFormGroup: { + root: { + color: '#e5ddd3', + }, + }, + MuiFormHelperText: { + error: { + color: '#c45c3c', + }, + }, + MuiTableHead: { + root: { + color: '#8a8278', + background: '#0a0a09 !important', + }, + }, + MuiTableCell: { + root: { + color: '#e5ddd3', + background: '#141413 !important', + }, + head: { + color: '#8a8278', + background: '#0a0a09 !important', + }, + }, + NDLogin: { + systemNameLink: { + color: '#d4a039', + }, + welcome: { + color: '#e5ddd3', + }, + card: { + minWidth: 300, + background: '#1e1e1c', + }, + button: { + boxShadow: '3px 3px 5px #0a0a09', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: + 'linear-gradient(to bottom, rgba(10, 10, 9, 0.72), #141413)!important', + }, + }, + }, + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/nautiline.js b/ui/src/themes/nautiline.js new file mode 100644 index 000000000..65ded5fc5 --- /dev/null +++ b/ui/src/themes/nautiline.js @@ -0,0 +1,906 @@ +/** + * Nautiline Theme for Navidrome + * Light theme inspired by the Nautiline iOS app + */ + +// ============================================ +// CONFIGURATION +// ============================================ + +const ACCENT_COLOR = '#009688' // Material teal +const UNBOUNDED_FONT_PATH = 'fonts/Unbounded-Variable.woff2' + +// ============================================ +// DESIGN TOKENS +// ============================================ + +const hexToRgb = (hex) => { + const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex) + return result + ? { + r: parseInt(result[1], 16), + g: parseInt(result[2], 16), + b: parseInt(result[3], 16), + } + : null +} + +const rgb = hexToRgb(ACCENT_COLOR) +const rgba = (alpha) => + rgb ? `rgba(${rgb.r}, ${rgb.g}, ${rgb.b}, ${alpha})` : 'transparent' + +const tokens = { + colors: { + accent: { + main: ACCENT_COLOR, + faded: rgba(0.1), + hover: rgba(0.15), + }, + background: { + primary: '#FFFFFF', + secondary: '#F5F5F7', + tertiary: '#E5E5EA', + }, + text: { + primary: '#1A1A1A', + secondary: '#8E8E93', + tertiary: '#AEAEB2', + }, + ui: { + separator: 'rgba(0, 0, 0, 0.08)', + shadow: 'rgba(0, 0, 0, 0.04)', + glassBg: 'rgba(255, 255, 255, 0.72)', + }, + }, + typography: { + fontFamily: { + base: [ + '-apple-system', + 'BlinkMacSystemFont', + '"SF Pro Text"', + '"Helvetica Neue"', + 'Arial', + 'sans-serif', + ].join(','), + heading: '"Unbounded", sans-serif', + }, + fontFace: ` + @font-face { + font-family: 'Unbounded'; + font-style: normal; + font-weight: 300 800; + font-display: swap; + src: url('${UNBOUNDED_FONT_PATH}') format('woff2'); + } + `, + }, + spacing: { + xs: '0.25rem', + sm: '0.5rem', + md: '0.75rem', + lg: '1rem', + xl: '1.5rem', + }, + radii: { + sm: '0.25rem', + md: '0.5rem', + lg: '0.625rem', + xl: '0.75rem', + full: '50%', + pill: '1rem', + }, + breakpoints: { + xs: 599, + sm: 600, + md: 720, + lg: 1280, + }, + sizing: { + cover: { + sm: '14em', + lg: '18em', + }, + icon: '1.25rem', + iconMinWidth: '2.5rem', + }, + blur: '1.25rem', +} + +const { colors, typography, spacing, radii, sizing, breakpoints } = tokens + +// ============================================ +// REUSABLE STYLE FACTORIES +// ============================================ + +const headingStyle = (weight, letterSpacing) => ({ + fontFamily: typography.fontFamily.heading, + fontWeight: weight, + ...(letterSpacing && { letterSpacing }), +}) + +const coverSizing = () => ({ + [`@media (min-width: ${breakpoints.sm}px)`]: { + height: sizing.cover.sm, + width: sizing.cover.sm, + minWidth: sizing.cover.sm, + }, + [`@media (min-width: ${breakpoints.lg}px)`]: { + height: sizing.cover.lg, + width: sizing.cover.lg, + minWidth: sizing.cover.lg, + }, +}) + +const customTooltipStyle = () => ({ + display: 'inline', + position: 'absolute', + bottom: '100%', + left: '50%', + transform: 'translateX(-50%)', + marginBottom: spacing.xs, + fontSize: '0.75rem', + whiteSpace: 'nowrap', + backgroundColor: colors.text.primary, + color: colors.background.primary, + padding: `${spacing.xs} ${spacing.sm}`, + borderRadius: radii.sm, + zIndex: 9999, +}) + +const actionButtonsStyle = () => ({ + padding: `${spacing.lg} 0`, + alignItems: 'center', + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: colors.background.secondary, + color: colors.text.secondary, + margin: `0 ${spacing.sm}`, + borderRadius: radii.full, + minWidth: 0, + padding: spacing.lg, + position: 'relative', + '&:hover': { + backgroundColor: `${colors.background.tertiary} !important`, + border: '1px solid transparent', + }, + }, + 'button:first-child:not(:only-child)': { + [`@media screen and (max-width: ${breakpoints.md}px)`]: { + transform: 'scale(1.5)', + margin: spacing.lg, + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: spacing.xl, + minWidth: 0, + padding: '0.3125rem', + transition: 'transform .3s ease', + background: colors.accent.main, + color: '#fff', + borderRadius: radii.full, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${colors.accent.main} !important`, + border: 0, + }, + }, + 'button:only-child': { + margin: spacing.xl, + }, + 'button:first-child>span:first-child': { + padding: 0, + }, + 'button>span:first-child>span': { + display: 'none', + }, + 'button:not(:first-child):hover>span:first-child>span': + customTooltipStyle(), + 'button:not(:first-child)>span:first-child>svg': { + color: colors.text.secondary, + }, + }, +}) + +const menuIconStyle = () => ({ + color: colors.text.primary, + minWidth: sizing.iconMinWidth, + '& svg': { + fontSize: sizing.icon, + }, +}) + +const activeLinkStyle = { + color: `${colors.accent.main} !important`, + '& .MuiListItemIcon-root': { + color: `${colors.accent.main} !important`, + }, +} + +// ============================================ +// THEME DEFINITION +// ============================================ + +// Note: !important declarations are required to override react-admin and third-party component styles +const NautilineTheme = { + themeName: 'Nautiline', + palette: { + type: 'light', + primary: { + main: colors.accent.main, + contrastText: '#FFFFFF', + }, + secondary: { + main: colors.accent.main, + contrastText: '#FFFFFF', + }, + background: { + default: colors.background.primary, + paper: colors.background.primary, + }, + text: { + primary: colors.text.primary, + secondary: colors.text.secondary, + }, + action: { + active: colors.accent.main, + hover: colors.accent.faded, + selected: colors.accent.faded, + }, + }, + typography: { + fontFamily: typography.fontFamily.base, + h1: headingStyle(700, '-0.02em'), + h2: headingStyle(700, '-0.02em'), + h3: headingStyle(600, '-0.01em'), + h4: headingStyle(600), + h5: headingStyle(600), + h6: headingStyle(600), + subtitle1: { fontWeight: 500 }, + subtitle2: { fontWeight: 500 }, + body1: { fontWeight: 400 }, + body2: { fontWeight: 400 }, + button: { fontWeight: 500, textTransform: 'none' }, + }, + shape: { + borderRadius: radii.xl, + }, + overrides: { + MuiCssBaseline: { + '@global': { + '@font-face': { + fontFamily: 'Unbounded', + fontStyle: 'normal', + fontWeight: '300 800', + fontDisplay: 'swap', + src: `url('${UNBOUNDED_FONT_PATH}') format('woff2')`, + }, + body: { + backgroundColor: colors.background.primary, + }, + }, + }, + MuiAppBar: { + root: { + boxShadow: 'none', + borderBottom: `1px solid ${colors.ui.separator}`, + }, + colorSecondary: { + backgroundColor: colors.background.primary, + color: colors.text.primary, + }, + }, + MuiToolbar: { + root: { + backgroundColor: colors.background.primary, + }, + }, + MuiPaper: { + root: { + backgroundColor: colors.background.primary, + }, + elevation1: { + boxShadow: `0 0.0625rem 0.1875rem ${colors.ui.shadow}`, + }, + elevation2: { + boxShadow: `0 0.125rem ${spacing.sm} ${colors.ui.shadow}`, + }, + }, + MuiCard: { + root: { + backgroundColor: colors.background.primary, + borderRadius: radii.xl, + boxShadow: `0 0.125rem ${spacing.sm} ${colors.ui.shadow}`, + }, + }, + MuiButton: { + root: { + borderRadius: radii.md, + textTransform: 'none', + fontWeight: 600, + }, + contained: { + boxShadow: 'none', + '&:hover': { boxShadow: 'none' }, + }, + containedPrimary: { + backgroundColor: colors.accent.main, + '&:hover': { + backgroundColor: colors.accent.main, + filter: 'brightness(0.9)', + }, + }, + text: { + color: colors.accent.main, + }, + }, + MuiIconButton: { + root: { + color: colors.text.primary, + '&:hover': { + backgroundColor: colors.accent.faded, + }, + }, + colorPrimary: { + color: colors.accent.main, + }, + sizeSmall: { + padding: spacing.md, + }, + }, + MuiSvgIcon: { + colorPrimary: { + color: colors.accent.main, + }, + }, + MuiCheckbox: { + root: { + color: 'rgba(0, 0, 0, 0.15)', + '&$checked': { + color: colors.accent.main, + }, + }, + }, + MuiChip: { + root: { + backgroundColor: colors.background.secondary, + color: colors.text.primary, + borderRadius: radii.pill, + }, + colorPrimary: { + backgroundColor: colors.accent.faded, + color: colors.accent.main, + }, + }, + MuiTableRow: { + root: { + '&:hover': { + backgroundColor: `${colors.accent.faded} !important`, + }, + }, + }, + MuiTableCell: { + root: { + borderBottomColor: 'rgba(0, 0, 0, 0.04)', + }, + head: { + backgroundColor: colors.background.secondary, + color: colors.text.secondary, + fontWeight: 600, + fontSize: '0.75rem', + textTransform: 'uppercase', + letterSpacing: '0.05em', + }, + body: { + color: colors.text.primary, + }, + }, + MuiListItem: { + root: { + color: colors.text.primary, + '&:hover': { + backgroundColor: colors.accent.faded, + }, + '&$selected': { + backgroundColor: colors.accent.faded, + color: colors.accent.main, + '& .MuiListItemIcon-root': { + color: colors.accent.main, + }, + '&:hover': { + backgroundColor: colors.accent.faded, + }, + }, + }, + button: { + color: colors.text.primary, + '&:hover': { + backgroundColor: colors.accent.faded, + color: colors.text.primary, + }, + }, + }, + MuiListItemIcon: { + root: menuIconStyle(), + }, + MuiListItemText: { + primary: { + color: 'inherit', + }, + }, + MuiMenuItem: { + root: { + fontSize: '0.875rem', + paddingTop: '4px', + paddingBottom: '4px', + paddingLeft: '10px', + margin: '5px', + borderRadius: radii.md, + color: colors.text.primary, + }, + }, + MuiDrawer: { + paper: { + backgroundColor: colors.background.primary, + borderRight: `1px solid ${colors.ui.separator}`, + }, + }, + MuiSlider: { + root: { + color: colors.accent.main, + }, + track: { + backgroundColor: colors.accent.main, + }, + thumb: { + backgroundColor: colors.accent.main, + '&:hover': { + boxShadow: `0 0 0 ${spacing.sm} ${colors.accent.faded}`, + }, + }, + rail: { + backgroundColor: colors.background.tertiary, + }, + }, + MuiLinearProgress: { + root: { + backgroundColor: colors.background.tertiary, + borderRadius: radii.sm, + }, + bar: { + backgroundColor: colors.accent.main, + borderRadius: radii.sm, + }, + }, + MuiTabs: { + root: { + borderBottom: `1px solid ${colors.ui.separator}`, + }, + indicator: { + backgroundColor: colors.accent.main, + height: '0.1875rem', + borderRadius: '0.1875rem 0.1875rem 0 0', + }, + }, + MuiTab: { + root: { + textTransform: 'none', + fontWeight: 500, + fontFamily: typography.fontFamily.heading, + '&$selected': { + color: colors.accent.main, + fontWeight: 600, + }, + }, + }, + MuiInputBase: { + root: { + backgroundColor: colors.background.secondary, + borderRadius: radii.lg, + }, + }, + MuiOutlinedInput: { + root: { + borderRadius: radii.lg, + '& $notchedOutline': { + borderColor: colors.ui.separator, + }, + '&:hover $notchedOutline': { + borderColor: colors.text.tertiary, + }, + '&$focused $notchedOutline': { + borderColor: colors.accent.main, + borderWidth: '0.125rem', + }, + }, + }, + MuiFilledInput: { + root: { + backgroundColor: colors.background.secondary, + borderRadius: radii.lg, + '&:hover': { + backgroundColor: colors.background.tertiary, + }, + '&$focused': { + backgroundColor: colors.background.secondary, + }, + }, + }, + MuiFab: { + primary: { + backgroundColor: colors.accent.main, + '&:hover': { + backgroundColor: colors.accent.main, + filter: 'brightness(0.9)', + }, + }, + }, + MuiAvatar: { + root: { + borderRadius: radii.md, + }, + }, + MuiRating: { + iconFilled: { + color: colors.accent.main, + }, + iconHover: { + color: colors.accent.main, + }, + }, + MuiTooltip: { + tooltip: { + backgroundColor: colors.text.primary, + color: colors.background.primary, + fontSize: '0.75rem', + padding: `${spacing.xs} ${spacing.sm}`, + borderRadius: radii.sm, + }, + }, + MuiBottomNavigation: { + root: { + backgroundColor: colors.ui.glassBg, + backdropFilter: `blur(${tokens.blur})`, + borderTop: `1px solid ${colors.ui.separator}`, + }, + }, + MuiBottomNavigationAction: { + root: { + color: colors.text.secondary, + '&$selected': { + color: colors.accent.main, + }, + }, + label: { + fontFamily: typography.fontFamily.heading, + fontSize: '0.65rem', + '&$selected': { + fontSize: '0.65rem', + }, + }, + }, + NDAppBar: { + root: { + color: colors.text.primary, + }, + }, + NDLogin: { + main: { + backgroundColor: colors.background.primary, + }, + card: { + backgroundColor: colors.background.primary, + borderRadius: radii.pill, + boxShadow: `0 ${spacing.xs} ${spacing.xl} ${colors.ui.shadow}`, + }, + }, + NDAlbumGridView: { + albumContainer: { + borderRadius: radii.md, + '& img': { + borderRadius: radii.md, + }, + }, + albumTitle: { + fontWeight: 600, + color: colors.text.primary, + }, + albumSubtitle: { + color: colors.text.secondary, + }, + albumPlayButton: { + backgroundColor: colors.accent.main, + borderRadius: radii.full, + boxShadow: `0 ${spacing.sm} ${spacing.sm} rgba(0, 0, 0, 0.15)`, + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + backgroundColor: `${colors.accent.main} !important`, + padding: '0.45rem', + }, + }, + }, + NDAlbumDetails: { + root: { + [`@media (max-width: ${breakpoints.xs}px)`]: { + padding: '0.7em', + width: '100%', + minWidth: 'unset', + }, + }, + cardContents: { + [`@media (max-width: ${breakpoints.xs}px)`]: { + flexDirection: 'column', + alignItems: 'center', + }, + }, + details: { + [`@media (max-width: ${breakpoints.xs}px)`]: { + width: '100%', + }, + }, + cover: { + borderRadius: radii.md, + }, + coverParent: { + marginRight: spacing.xl, + [`@media (max-width: ${breakpoints.xs}px)`]: { + width: '100%', + height: 'auto', + minWidth: 'unset', + aspectRatio: '1', + marginRight: 0, + marginBottom: spacing.lg, + }, + ...coverSizing(), + }, + recordName: { + fontSize: '1.75rem', + fontWeight: 700, + marginBottom: '0.15rem', + }, + recordArtist: { + marginBottom: spacing.md, + }, + recordMeta: { + marginBottom: spacing.sm, + }, + genreList: { + marginTop: spacing.md, + }, + loveButton: { + marginLeft: spacing.sm, + }, + }, + NDAlbumShow: { + albumActions: actionButtonsStyle(), + }, + NDPlaylistShow: { + playlistActions: actionButtonsStyle(), + }, + NDSubMenu: { + icon: menuIconStyle(), + menuHeader: { + color: colors.text.primary, + '& .MuiTypography-root': { + color: colors.text.primary, + }, + }, + actionIcon: { + marginLeft: spacing.sm, + }, + }, + RaMenuItemLink: { + root: { + color: `${colors.text.primary} !important`, + '& .MuiListItemIcon-root': menuIconStyle(), + '&[class*="makeStyles-active"]': activeLinkStyle, + }, + active: activeLinkStyle, + }, + NDDesktopArtistDetails: { + root: { + [`@media (min-width: ${breakpoints.sm}px)`]: { + padding: '1em', + }, + [`@media (min-width: ${breakpoints.lg}px)`]: { + padding: '1em', + }, + }, + cover: { + borderRadius: radii.md, + ...coverSizing(), + }, + artistImage: { + borderRadius: radii.md, + marginRight: spacing.xl, + [`@media (min-width: ${breakpoints.sm}px)`]: { + height: sizing.cover.sm, + width: sizing.cover.sm, + minWidth: sizing.cover.sm, + maxHeight: sizing.cover.sm, + minHeight: sizing.cover.sm, + }, + [`@media (min-width: ${breakpoints.lg}px)`]: { + height: sizing.cover.lg, + width: sizing.cover.lg, + minWidth: sizing.cover.lg, + maxHeight: sizing.cover.lg, + minHeight: sizing.cover.lg, + }, + }, + artistName: { + fontSize: '1.75rem', + fontWeight: 700, + marginBottom: spacing.sm, + }, + }, + NDMobileArtistDetails: { + cover: { + borderRadius: radii.md, + }, + artistImage: { + borderRadius: radii.md, + }, + }, + RaList: { + content: { + overflow: 'visible', + }, + }, + RaBulkActionsToolbar: { + topToolbar: { + backgroundColor: 'transparent', + boxShadow: 'none', + padding: spacing.sm, + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: colors.background.secondary, + color: colors.text.secondary, + margin: `0 ${spacing.xs}`, + borderRadius: radii.full, + minWidth: 0, + padding: spacing.sm, + position: 'relative', + '&:hover': { + backgroundColor: `${colors.background.tertiary} !important`, + border: '1px solid transparent', + }, + }, + 'button>span:first-child>span': { + display: 'none', + }, + 'button:hover>span:first-child>span': customTooltipStyle(), + 'button>span:first-child>svg': { + color: colors.text.secondary, + }, + }, + }, + }, + RaPaginationActions: { + currentPageButton: { + backgroundColor: colors.accent.faded, + }, + }, + }, + player: { + theme: 'light', + stylesheet: ` + @font-face { + font-family: 'Unbounded'; + font-style: normal; + font-weight: 300 800; + font-display: swap; + src: url('${UNBOUNDED_FONT_PATH}') format('woff2'); + } + + .react-jinke-music-player-main { + background-color: ${colors.background.primary} !important; + font-family: ${typography.fontFamily.base} !important; + } + + .react-jinke-music-player-main .music-player-panel { + background-color: ${colors.ui.glassBg} !important; + backdrop-filter: blur(${tokens.blur}) !important; + -webkit-backdrop-filter: blur(${tokens.blur}) !important; + border-top: 1px solid ${colors.ui.separator} !important; + box-shadow: 0 -0.125rem 1.25rem rgba(0, 0, 0, 0.06) !important; + } + + .react-jinke-music-player-main svg { + color: ${colors.text.primary} !important; + } + + .react-jinke-music-player-main svg:hover { + color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .rc-slider-track, + .react-jinke-music-player-main .rc-slider-handle { + background-color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .rc-slider-handle { + border-color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .rc-slider-rail { + background-color: ${colors.background.secondary} !important; + } + + .react-jinke-music-player-main .rc-slider { + height: 4px !important; + } + + .react-jinke-music-player-main .rc-slider-rail, + .react-jinke-music-player-main .rc-slider-track { + height: 4px !important; + border-radius: 2px !important; + } + + .react-jinke-music-player-main .rc-slider-handle { + width: 12px !important; + height: 12px !important; + margin-top: -4px !important; + } + + .react-jinke-music-player-main .audio-lists-panel, + .react-jinke-music-player-main .audio-lists-panel-content { + background-color: ${colors.background.primary} !important; + } + + .react-jinke-music-player-main .audio-lists-panel-content .audio-item { + background-color: transparent !important; + color: ${colors.text.primary} !important; + } + + .react-jinke-music-player-main .audio-lists-panel-content .audio-item:hover { + background-color: ${colors.accent.faded} !important; + } + + .react-jinke-music-player-main .audio-lists-panel-content .audio-item.playing { + background-color: ${colors.accent.faded} !important; + color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .lyric-btn-active, + .react-jinke-music-player-main .play-mode-title { + color: ${colors.accent.main} !important; + } + + .react-jinke-music-player-main .music-player-panel .player-content .music-player-controller .music-player-info .music-player-title { + color: ${colors.text.primary} !important; + font-weight: 600 !important; + font-family: ${typography.fontFamily.heading} !important; + } + + .react-jinke-music-player-main .music-player-panel .player-content .music-player-controller .music-player-info .music-player-artist { + color: ${colors.text.secondary} !important; + } + + .react-jinke-music-player-main.mini-player { + background-color: ${colors.ui.glassBg} !important; + backdrop-filter: blur(${tokens.blur}) !important; + -webkit-backdrop-filter: blur(${tokens.blur}) !important; + border-radius: ${radii.xl} !important; + box-shadow: 0 ${spacing.xs} 1.25rem rgba(0, 0, 0, 0.08) !important; + } + + + .MuiTypography-h1, + .MuiTypography-h2, + .MuiTypography-h3, + .MuiTypography-h4, + .MuiTypography-h5, + .MuiTypography-h6 { + font-family: ${typography.fontFamily.heading} !important; + } + `, + }, +} + +export default NautilineTheme diff --git a/ui/src/themes/nord.js b/ui/src/themes/nord.js index 8c346eefe..5420bbc60 100644 --- a/ui/src/themes/nord.js +++ b/ui/src/themes/nord.js @@ -259,7 +259,6 @@ export default { }, details: { fontSize: '.875rem', - minWidth: '75vw', color: 'rgba(255,255,255, 0.8)', }, }, diff --git a/ui/src/themes/nutball.css.js b/ui/src/themes/nutball.css.js new file mode 100644 index 000000000..aaf1c0e16 --- /dev/null +++ b/ui/src/themes/nutball.css.js @@ -0,0 +1,380 @@ +const stylesheet = ` +html { + scrollbar-width: none; +} +body { + -ms-overflow-style: none; + font-family: monospace; +} +body::-webkit-scrollbar, body::-webkit-scrollbar-button { + display: none; +} +.react-jinke-music-player-main .music-player-panel { + background-color: white!important; + box-shadow: none; + font-family: monospace; + color: black; + border-top: 1px solid black; +} +.react-jinke-music-player-main .music-player-panel .panel-content div.img-content { + animation: none; + box-shadow: none; + border-radius: 5px; +} +.react-jinke-music-player-main .music-player-panel .panel-content .progress-bar-content { + flex: 0 0 auto; + width: calc(50% - 150px); + margin-left: 10px; + padding: 0; +} +section.audio-main { + position: absolute; + width: calc(100% - 131px)!important; + bottom: 0; + margin-bottom: 10px; +} +span.audio-title { + margin-bottom: 20px; +} +span.audio-title .songTitle { + color: black!important; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content { + flex: 1; + margin-bottom: 20px; + padding-left: 0; +} +div.player-content > span:first-child { + flex: 1!important; + justify-content: flex-start!important; +} +div.player-content > span:first-child svg { + width: 50px; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content > .group { + flex: 0; +} +.play-sounds svg, .loop-btn svg, .audio-lists-btn svg, .destroy-btn { + margin-left: 0!important; +} +.play-sounds svg, .loop-btn svg, .audio-lists-btn svg, .destroy-btn svg { + width: 20px; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn { + padding: 0; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn .audio-lists-icon svg { + height: .75em; +} +.react-jinke-music-player-main .music-player-panel .panel-content .progress-bar-content .audio-main .current-time, .react-jinke-music-player-main .music-player-panel .panel-content .progress-bar-content .audio-main .duration { + flex-basis: 0; +} +.progress-bar > div:nth-child(2) > div:nth-child(4) { + transform: translateX(-50%) translateY(5%) !important; +} +.progress-load-bar { + display: none; +} +.sound-operation > div:nth-child(4) { + transform: translateX(-50%) translateY(5%) !important; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .play-sounds .sound-operation { + width: 60px; +} +.rc-slider { + border-radius: 0px; + border: 1px solid black; + padding: 3px 0!important; +} +.rc-slider .rc-slider-handle { + box-shadow: none!important; + border-radius: 0px; + background-color: black!important; + border: hidden!important; +} +.rc-slider[style*="left: 0%"] { + transform: translateX(0) !important; +} +.rc-slider .rc-slider-track { + display: none; +} +.react-jinke-music-player-main .rc-slider-rail, .react-jinke-music-player-main.light-theme .rc-slider-rail { + background-color: white!important; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .play-sounds .sounds-icon { + margin-right: 10px; +} +.lyric-btn { + display: none!important; +} +button[data-testid="save-queue-button"] { + display: none!important; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn { + box-shadow: 0 0 0 0; + margin: 0; + margin-left: -8px; + margin-right: -5px; +} +.audio-lists-btn:hover span, +.audio-lists-btn:hover svg { + color: #a8fe40!important; +} +.react-jinke-music-player-main.light-theme .audio-lists-btn { + background-color: white!important; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn .audio-lists-num { + color: grey; + margin-left: 5px; + font-size: .7rem; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .hide-panel { + margin-left: 2px; +} +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .hide-panel svg { + stroke-width: 15px; + stroke: #fff; + height: .8em; +} +@media screen and (max-width: 810px) { + .react-jinke-music-player-main .music-player-panel .panel-content .player-content .play-sounds .sounds-icon { + margin-left: 5px; + margin-right: 0; + } + .react-jinke-music-player-main .music-player-panel .panel-content .player-content .loop-btn { + margin-left: 5px; + } + .play-sounds svg, .loop-btn svg, .audio-lists-btn svg, .destroy-btn { + margin-left: -3px!important; + } +} +.panel-content li { + flex-grow: 0; +} +.react-jinke-music-player .music-player-controller, +.react-jinke-music-player-main.light-theme .music-player-controller { + border-radius: 5px; + box-shadow: none; +} +.react-jinke-music-player .music-player-controller:hover, +.react-jinke-music-player .music-player-controller:has(+ .destroy-btn:hover) { + border: 1px solid black; +} +.react-jinke-music-player .music-player-controller .controller-title, +.react-jinke-music-player .music-player-controller .music-player-controller-setting { + display: none; +} +.react-jinke-music-player .music-player-controller.music-player-playing:before { + animation: none; + border: none; +} +@media screen and (max-width:767px) { + .react-jinke-music-player .music-player .destroy-btn { + right: 0; + } + .react-jinke-music-player-main .destroy-btn svg { + font-size: 10px; + } +} +.react-jinke-music-player-main svg { + transition: none; +} +.react-jinke-music-player-main svg, .react-jinke-music-player-main.light-theme svg { + color: black; +} +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover, +.react-jinke-music-player-main.light-theme svg:active, .react-jinke-music-player-main.light-theme svg:hover { + color: #a8fe40; +} +.react-jinke-music-player-main .play-mode-title { + font-family: monospace; + background-color: white; + color: black; +} +.react-jinke-music-player-mobile, +.react-jinke-music-player-main.light-theme .react-jinke-music-player-mobile { + font-family: monospace; + background-color: rgba(255, 255, 255, .9); + color: black!important; + justify-content: center; + padding: 50px; +} +.react-jinke-music-player-mobile:before { + content: " "; + display: block; + position: absolute; + margin-left: auto; + margin-right: auto; + left: 0; + right: 0; + text-align: center; + width: 90%; + height: 700px; + background-color: white; + border: 1px solid black; + z-index: -1; + border-radius: 4px; +} +.react-jinke-music-player-mobile-header { + align-items: start; + margin-bottom: 4rem; + justify-content: start; +} +.react-jinke-music-player-mobile-header-title { + text-align: left; + padding: 0; +} +.react-jinke-music-player-mobile-header-right { + color: black; +} +.react-jinke-music-player-mobile > .group { + flex: 0; +} +.react-jinke-music-player-mobile-cover, +.react-jinke-music-player-main.light-theme .react-jinke-music-player-mobile-cover { + border-radius: 5px; + box-shadow: none; + animation: none; + border: 1px solid black; + margin: 0 auto 4rem auto; + width: auto; + height: auto; +} +.react-jinke-music-player-mobile-cover .cover { + animation: none; +} +.react-jinke-music-player-mobile-progress .current-time { + /* margin-right: 17px; */ +} +.react-jinke-music-player-mobile-progress .current-time, .react-jinke-music-player-mobile-progress .duration { + color: black!important; +} +.react-jinke-music-player-mobile-progress .rc-slider { + height: 24px; +} +.react-jinke-music-player-mobile-progress .rc-slider-handle { + border: 2px solid black; + margin-top: -4px; + height: 24px; + width: 24px; +} +.react-jinke-music-player-mobile-toggle { + margin-bottom: 1rem; + padding: 2rem 0; +} +.react-jinke-music-player-mobile-operation .items .item svg { + color: black!important; + font-size: 2rem; + width: 2rem; +} +.react-jinke-music-player-mobile-operation .items .item svg:hover, +.react-jinke-music-player-mobile-operation .items .item button:hover svg { + color: #a8fe40!important; +} +.react-jinke-music-player-mobile-operation .items .item .MuiIconButton-root:hover { + background-color: rgba(0, 0, 0, 0.0); +} +.react-jinke-music-player-mobile-operation .MuiButtonBase-root.Mui-disabled { + cursor: pointer; + pointer-events: auto; +} +.react-jinke-music-player-mobile-operation .items li:nth-child(5) svg { + font-size: 1.4rem; +} +.react-jinke-music-player-mobile-operation .items li:nth-child(5) svg g path:nth-child(2) { + stroke-width: .4px; +} +.react-jinke-music-player-mobile-operation .items li:nth-child(2), +.react-jinke-music-player-mobile-operation .items li:nth-child(3) { + display: none; +} +.react-jinke-music-player-mobile-play-model-tip { + display: none; +} +.audio-lists-panel { + overflow-y: scroll; + scrollbar-width: none; + border-radius: .625rem; + bottom: 6.25rem; +} +.react-jinke-music-player-main.light-theme .audio-lists-panel { + font-family: monospace; + box-shadow: none; + border: 1px solid black; +} +.react-jinke-music-player-main.light-theme .audio-lists-panel-header { + text-shadow: none; + border-bottom: 1px solid black; +} +.audio-lists-panel-header-line { + width: 0; +} +.audio-lists-panel-header-close-btn:hover svg { + animation: none; +} +.audio-lists-panel-content .audio-item, +.react-jinke-music-player-main.light-theme .audio-item { + border-radius: 0px; + margin: 0; + border-bottom: none; + box-shadow: none; + transition: none; +} +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-lists-panel-content .audio-item:nth-child(2n+1) { + background-color: white!important; +} +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-lists-panel-content .audio-item:nth-child(2n+1):hover { + background-color: #fafafa!important; +} +.audio-lists-panel-content .audio-item .player-singer { + width: unset; + padding-right: 20px; +} +.audio-lists-panel-content .audio-item .player-delete:hover svg { + color: #a8fe40!important; + animation: none; +} +.react-jinke-music-player-main .audio-lists-panel-content .audio-item:active .group:not([class=".player-delete"]) svg, +.react-jinke-music-player-main .audio-lists-panel-content .audio-item:hover .group:not([class=".player-delete"]) svg, +.react-jinke-music-player-main.light-theme .audio-item:active svg, +.react-jinke-music-player-main.light-theme .audio-item:hover svg { + color: black; +} +.audio-lists-panel-content .audio-item .player-delete { + justify-content: center; + width: 25px; +} +.audio-lists-panel-content .audio-item .player-delete svg { + font-size: 20px; +} +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item.playing, .react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item.playing svg { + color: #a8fe40!important; +} +.audio-lists-panel-content .audio-item .player-name, +.audio-lists-panel-content .audio-item .player-singer, +.react-jinke-music-player-main.light-theme .audio-item.playing .player-singer, +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item.playing, .react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item.playing .player-delete svg { + color: black!important; +} +.audio-lists-panel-mobile { + height: 750px !important; + top: calc(100vh / 2 - 375px) !important; + width: 91% !important; + margin: 0 auto; +} +.audio-lists-panel-mobile .audio-lists-panel-content { + height: auto!important; +} +.audio-lists-panel-content { + scrollbar-width: none; +} +@keyframes fromOut { + 0% { + transform:scale(1) translateZ(0) + } + to { + transform:scale(1) translate3d(0,150%,0); + } +} +` +export default stylesheet diff --git a/ui/src/themes/nutball.js b/ui/src/themes/nutball.js new file mode 100644 index 000000000..f43250f5c --- /dev/null +++ b/ui/src/themes/nutball.js @@ -0,0 +1,684 @@ +import stylesheet from './nutball.css.js' + +export default { + themeName: 'Nutball', + palette: { + primary: { + main: '#80ea00', + light: '#fff', + }, + secondary: { + main: '#80ea00', + contrastText: '#fff', + }, + }, + typography: { + fontFamily: 'monospace', + h6: { + fontSize: '1rem', + }, + h4: { + fontSize: '1.2rem', + }, + h1: { + fontSize: '1.4rem', + }, + body: { + fontFamily: 'monospace', + }, + }, + overrides: { + MuiAppBar: { + root: { + borderBottom: '1px solid black', + }, + colorSecondary: { + color: 'black', + backgroundColor: 'white', + }, + }, + MuiPaper: { + elevation1: { + boxShadow: 'none', + }, + elevation4: { + boxShadow: 'none', + }, + elevation6: { + boxShadow: 'none', + }, + elevation8: { + boxShadow: 'none', + border: '1px solid black', + }, + elevation16: { + boxShadow: 'none', + borderRight: '1px solid grey!important', + }, + elevation24: { + boxShadow: 'none', + border: '1px solid black', + }, + }, + MuiButton: { + root: { + color: '#80ea00', + border: '1px solid rgba(0, 0, 0, 0.23)', + transition: 'none', + '&[aria-label="Grid"]': { + width: '50%', + marginLeft: '15px', + marginRight: '2px', + marginBottom: '10px', + '& .MuiButton-label': { + justifyContent: 'center', + }, + }, + '&[aria-label="Table"]': { + width: '50%', + marginRight: '15px', + marginLeft: '2px', + marginBottom: '10px', + '& .MuiButton-label': { + justifyContent: 'center', + }, + }, + }, + textPrimary: { + color: 'rgba(0,0,0,.57)', + '&:hover': { + borderColor: 'black', + backgroundColor: '#eaeaea', + }, + '&[aria-label="Grid"]': { + color: 'black', + borderColor: 'black!important', + }, + '&[aria-label="Table"]': { + color: 'black', + borderColor: 'black!important', + }, + }, + textSecondary: { + color: 'rgba(0,0,0,.57)', + '&:hover': { + borderColor: 'black', + backgroundColor: '#eaeaea', + }, + '&[aria-label="Grid"]': { + color: 'grey', + borderColor: 'grey!important', + }, + '&[aria-label="Table"]': { + color: 'grey', + borderColor: 'grey!important', + }, + }, + label: { + '& svg': { + display: 'none', + }, + '& span': { + paddingLeft: '0', + }, + }, + contained: { + boxShadow: 'none', + '&:hover': { + boxShadow: 'none', + }, + }, + }, + MuiButtonGroup: { + groupedTextHorizontal: { + justifyContent: 'flex-start', + margin: '0 .5rem', + '& button': { + width: '25%', + }, + }, + groupedTextPrimary: { + '&:not(:last-child)': { + border: 'none', + }, + }, + }, + MuiIconButton: { + root: { + '&[aria-label="Settings"]': { + padding: '12px!important', + marginRight: '-9px!important', + }, + }, + }, + MuiSwitch: { + thumb: { + color: '#eaeaea', + boxShadow: 'none', + borderRadius: '0', + }, + track: { + borderRadius: '0', + }, + switchBase: { + color: '#eaeaea', + }, + }, + MuiCheckbox: { + root: { + '& svg': { + width: '.8em', + }, + }, + }, + PrivateSwitchBase: { + root: { + padding: '8px 8px', + }, + }, + RaButton: { + button: { + marginRight: '10px', + lineHeight: 'normal', + }, + }, + MuiMenu: { + list: { + '& p': { + fontSize: '.85rem', + }, + '& p:first-of-type': { + margin: '6px 1rem', + }, + '& li:has(span.MuiCheckbox-root)': { + marginLeft: '-10px', + }, + '& span.MuiCheckbox-root .MuiSvgIcon-root': { + width: '.75em', + }, + }, + }, + MuiMenuItem: { + root: { + fontSize: '.85rem', + minHeight: 'inherit', + '&[aria-label="Clear value"]:before': { + display: 'block', + content: "'(any)'", + }, + }, + }, + MuiListItem: { + button: { + '& span.MuiCheckbox-root': { + padding: '0px 8px', + }, + }, + }, + MuiTooltip: { + tooltip: { + backgroundColor: 'rgb(117 117 117)', + }, + }, + MuiCircularProgress: { + root: { + color: '#80ea00!important', + }, + }, + MuiAvatar: { + img: { + borderRadius: '5px', + }, + }, + MuiFab: { + root: { + boxShadow: 'none', + }, + }, + MuiTableHead: { + root: { + boxShadow: 'none!important', + }, + }, + MuiTableCell: { + root: { + borderBottom: 'none', + }, + sizeSmall: { + '&:last-child': { + textAlign: 'right', + }, + '&:last-child:is(th)': { + paddingRight: '45px', + }, + }, + }, + MuiTablePagination: { + root: { + fontSize: '.6rem', + }, + caption: { + fontSize: '.6rem', + }, + menuItem: { + fontSize: '.6rem', + }, + }, + MuiTabs: { + root: { + marginBottom: '1rem', + }, + }, + MuiToolbar: { + gutters: { + '@media (min-width: 600px)': { + paddingLeft: '16px', + }, + }, + }, + RaListToolbar: { + toolbar: { + alignItems: 'start', + '& form:has(> div:nth-child(3))': { + paddingBottom: '.6rem', + }, + }, + actions: { + paddingRight: '0!important', + marginTop: '-8px', + textWrap: 'nowrap', + '@media (max-width: 599.95px)': { + marginTop: '3px', + }, + '& .MuiButton-text': { + height: '2.5rem', + padding: '7px 10px', + marginRight: '0', + }, + }, + }, + RaTopToolbar: { + root: { + '& div:first-of-type > div:first-of-type': { + display: 'flex', + flexWrap: 'wrap', + rowGap: '10px', + }, + '& div:first-of-type > div:first-of-type button': { + height: '2rem', + }, + '& div:first-of-type > div:first-of-type .MuiIconButton-root': { + padding: '0', + marginRight: '2rem', + }, + '& div:first-of-type > div:nth-of-type(2)': { + height: '2rem', + }, + }, + }, + RaToolbar: { + toolbar: { + backgroundColor: 'white', + }, + }, + RaFilterButton: { + root: { + textWrap: 'nowrap', + '& button': { + '@media (max-width: 599.95px)': { + padding: '12px', + }, + }, + "&[resource*='song']": { + marginLeft: '10px', + }, + }, + }, + RaDeleteWithUndoButton: { + deleteButton: { + color: 'rgba(0,0,0,.57)', + '&:hover': { + backgroundColor: 'rgba(0, 0, 0, 0.04)', + }, + }, + }, + RaAutocompleteSuggestionList: { + suggestionsContainer: { + borderRadius: '4px', + outline: '1px solid black', + backgroundColor: 'white', + }, + }, + RaEmpty: { + message: { + marginTop: '3rem', + }, + icon: { + display: 'none', + }, + }, + RaAutocompleteArrayInput: { + chipContainerOutlined: { + '&:empty': { + margin: '0', + }, + margin: '10px 0', + }, + chip: { + margin: '4px 4px 4px 0!important', + }, + inputInput: { + flexGrow: '0', + '& #genre_id': { + flexGrow: '0', + }, + }, + }, + RaLayout: { + content: { + width: '100%', + }, + }, + RaDatagrid: { + headerCell: { + fontWeight: 'bold', + }, + }, + NDAlbumShow: { + albumActions: { + padding: '0', + alignItems: 'center', + margin: '1rem 0', + }, + }, + MuiCardContent: { + root: { + fontFamily: 'monospace', + fontSize: '.8rem', + '& #now-playing-title': { + fontSize: '.8rem', + }, + '&:last-child': { + paddingBottom: '16px', + }, + '&[class*="makeStyles-usernameWrap-"]': { + paddingBottom: '16px', + }, + }, + }, + MuiDialogContent: { + root: { + '& .MuiTableCell-sizeSmall:last-child': { + textAlign: 'left', + }, + }, + }, + MuiGridList: { + root: { + '&:empty': { + display: 'none', + }, + backgroundColor: 'white', + borderRadius: '4px', + }, + }, + MuiGridListTile: { + root: { + '@media (max-width: 599.95px)': { + padding: '7px!important', + }, + }, + tile: { + '& img': { + borderRadius: '5px', + }, + }, + }, + NDAlbumGridView: { + root: { + '&:has(.MuiGridList-root:empty)': { + display: 'none', + }, + }, + albumContainer: { + border: '1px solid white', + borderRadius: '5px', + '& a:hover img': { + outline: '1px solid black', + }, + '& a:hover > div:nth-of-type(2)': { + border: 'none', + outline: '1px solid black', + }, + }, + albumLink: { + paddingRight: '6px', + }, + albumSubtitle: { + fontFamily: 'monospace', + }, + tileBar: { + transition: 'all 50ms ease-out', + }, + tileBarMobile: { + transition: 'all 50ms ease-out', + borderLeft: '1px solid black', + borderRight: '1px solid black', + borderBottom: '1px solid black', + }, + }, + MuiGridListTileBar: { + root: { + height: '30px!important', + background: 'white!important', + borderTop: '1px solid black', + borderBottom: '1px solid black', + borderRadius: '0 0 5px 5px', + }, + titleWrap: { + marginLeft: '0px', + }, + titlePositionBottom: { + bottom: '0', + }, + subtitle: { + '& button': { + color: 'black!important', + }, + }, + actionIcon: { + '& button': { + color: 'black!important', + }, + }, + }, + RaFilter: { + form: { + width: '100%', + '& div.filter-field:first-child': { + flex: '1 100%', + '& [class*="RaSearchInput-input-"]': { + width: '100%', + }, + }, + }, + }, + MuiInputAdornment: { + positionEnd: { + justifyContent: 'flex-end', + }, + }, + RaFilterFormInput: { + body: { + '& label': { + transform: 'translate(14px, -6px) scale(0.75)!important', + backgroundColor: '#fafafa', + padding: '0 5px', + }, + }, + hideButton: { + order: '1', + marginLeft: '2px', + top: '-7px', + padding: '8px', + }, + spacer: { + order: '2', + }, + }, + RaPaginationActions: { + actions: { + '& button': { + border: 'none', + fontSize: '.6rem', + }, + }, + }, + NDAlbumDetails: { + cover: { + borderRadius: '5px', + }, + content: { + padding: '0', + marginLeft: '1rem', + }, + externalLinks: { + marginTop: '5px', + }, + notes: { + display: 'none', + }, + root: { + '& p': { + fontSize: '.7rem', + backgroundColor: '#e0e0e0', + borderRadius: '10px', + width: 'fit-content', + padding: '2px 7px', + }, + }, + }, + NDPlaylistDetails: { + cover: { + borderRadius: '5px', + }, + }, + NDDesktopArtistDetails: { + cover: { + borderRadius: '0px', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: + 'linear-gradient(to bottom, rgb(255 255 255 / 51%), rgb(250 250 250))!important', + }, + }, + NDArtistShow: { + actionsContainer: { + '& button': { + padding: '4px 5px', + fontSize: '0.8125rem', + height: '2rem', + }, + }, + }, + NDAudioPlayer: { + audioTitle: { + color: 'black', + }, + }, + NDLogin: { + main: { + background: 'white', + '& .MuiFormLabel-root': { + color: '#000', + }, + '& .MuiFormLabel-root.Mui-error': { + color: '#000', + }, + '& .MuiInput-underline:before': { + borderBottom: 'none', + }, + '& .MuiInput-underline:after': { + borderBottom: 'none', + }, + '& .MuiFormHelperText-root.Mui-error': { + color: '#000', + paddingLeft: '10px', + }, + '& .MuiInput-underline:hover:not(.Mui-disabled):before': { + borderBottom: 'none', + }, + }, + card: { + minWidth: 300, + marginTop: '6em', + backgroundColor: '#ffffffe6', + border: '1px solid black', + }, + avatar: { + marginTop: '1rem', + '& img': { + filter: 'invert(1)', + }, + }, + icon: {}, + input: { + '& .MuiInput-root': { + border: '1px solid black', + borderRadius: '4px', + padding: '10px', + }, + '& .MuiInputLabel-root': { + padding: '10px', + }, + '& .MuiInputLabel-shrink': { + transform: 'translate(0, -5.5px) scale(0.75)', + }, + }, + actions: { + marginTop: '2rem', + }, + button: { + boxShadow: 'none', + '&:hover': { + boxShadow: 'none', + backgroundColor: 'rgb(117, 177, 44)', + }, + }, + systemNameLink: { + fontFamily: 'monospace', + marginBottom: '1rem', + color: 'black', + '&:before': { + content: "'Welcome to '", + }, + '&:after': { + content: "' *~*!'", + }, + }, + }, + MuiCssBaseline: { + '@global': { + '*::-webkit-scrollbar': { + display: 'none', + }, + }, + }, + MuiBackdrop: { + root: { + backgroundColor: 'rgba(255, 255, 255, 0.5)', + }, + }, + RaLoading: { + message: { + fontFamily: 'monospace', + }, + }, + }, + player: { + theme: 'light', + stylesheet, + }, +} diff --git a/ui/src/themes/spotify.js b/ui/src/themes/spotify.js index 703d8159e..725831cc7 100644 --- a/ui/src/themes/spotify.js +++ b/ui/src/themes/spotify.js @@ -204,7 +204,6 @@ export default { }, details: { fontSize: '.875rem', - minWidth: '75vw', color: 'rgba(255,255,255, 0.8)', }, }, @@ -243,6 +242,64 @@ export default { NDPlaylistShow: { playlistActions: musicListActions, }, + NDArtistShow: { + actions: { + padding: '2rem 0', + alignItems: 'center', + overflow: 'visible', + minHeight: '120px', + '@global': { + button: { + border: '1px solid transparent', + backgroundColor: 'inherit', + color: '#b3b3b3', + margin: '0 0.5rem', + '&:hover': { + border: '1px solid #b3b3b3', + backgroundColor: 'inherit !important', + }, + }, + // Hide shuffle button label (first button) + 'button:first-child>span:first-child>span': { + display: 'none', + }, + // Style shuffle button (first button) + 'button:first-child': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.5)', + margin: '1rem', + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: '1.5rem', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + background: spotifyGreen['500'], + color: '#fff', + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${spotifyGreen['500']} !important`, + border: 0, + }, + }, + 'button:first-child>span:first-child': { + padding: 0, + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: '#b3b3b3', + }, + }, + }, + actionsContainer: { + overflow: 'visible', + }, + }, NDAudioPlayer: { audioTitle: { color: '#fff', @@ -332,6 +389,11 @@ export default { marginRight: '1rem', }, }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, RaPaginationActions: { currentPageButton: { border: '1px solid #b3b3b3', diff --git a/ui/src/themes/theme.test.js b/ui/src/themes/theme.test.js new file mode 100644 index 000000000..b65c3a5fe --- /dev/null +++ b/ui/src/themes/theme.test.js @@ -0,0 +1,14 @@ +import themes from './index' +import { describe, it, expect } from 'vitest' + +describe('NDPlaylistDetails styles', () => { + const themeEntries = Object.entries(themes) + + it.each(themeEntries)( + '%s should not set minWidth on details', + (themeName, theme) => { + const details = theme.overrides?.NDPlaylistDetails?.details + expect(details?.minWidth).toBeUndefined() + }, + ) +}) diff --git a/ui/src/themes/tokyoNight.css.js b/ui/src/themes/tokyoNight.css.js new file mode 100644 index 000000000..882fcd3eb --- /dev/null +++ b/ui/src/themes/tokyoNight.css.js @@ -0,0 +1,143 @@ +const stylesheet = ` + +.react-jinke-music-player-main svg:active, .react-jinke-music-player-main svg:hover { + color: #7aa2f7 +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #7aa2f7 +} + +.react-jinke-music-player-main ::-webkit-scrollbar-thumb { + background-color: #7aa2f7; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #7aa2f7 +} + +.react-jinke-music-player-main .audio-item.playing svg { + color: #7aa2f7 +} + +.react-jinke-music-player-main .audio-item.playing .player-singer { + color: #7aa2f7 !important +} + +.react-jinke-music-player-main .loading svg { + color: #7aa2f7 !important +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle { + border: hidden; + box-shadow: rgba(15, 17, 21, 0.25) 0px 4px 6px, rgba(15, 17, 21, 0.1) 0px 5px 7px; +} + +.rc-slider-rail, .rc-slider-track { + height: 6px; +} + +.rc-slider { + padding: 3px 0; +} + +.sound-operation > div:nth-child(4) { + transform: translateX(-50%) translateY(5%) !important; +} + +.sound-operation { + padding: 4px 0; +} + +.react-jinke-music-player-main .music-player-panel { + background-color: #24283b; + color: #c0caf5; + box-shadow: 0 0 8px rgba(0, 0, 0, 0.25); +} + +.audio-lists-panel { + background-color: #24283b; + bottom: 6.25rem; + box-shadow: rgba(15, 17, 21, 0.25) 0px 4px 6px, rgba(15, 17, 21, 0.1) 0px 5px 7px; +} + +.audio-lists-panel-content .audio-item.playing { + background-color: rgba(0, 0, 0, 0); +} + +.audio-lists-panel-content .audio-item:nth-child(2n+1) { + background-color: rgba(0, 0, 0, 0); +} + +.audio-lists-panel-content .audio-item:active, +.audio-lists-panel-content .audio-item:hover { + background-color: #292e42; +} + +.audio-lists-panel-header { + border-bottom: 1px solid rgba(0, 0, 0, 0.25); + box-shadow: none; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .player-content .audio-lists-btn { + background-color: rgba(0, 0, 0, 0); + box-shadow: 0 0 0 0; +} + +.audio-lists-panel-content .audio-item { + line-height: 32px; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .img-content { + box-shadow: rgba(15, 17, 21, 0.25) 0px 4px 6px, rgba(15, 17, 21, 0.1) 0px 5px 7px; +} + +.react-jinke-music-player-main .music-player-lyric { + color: #c0caf5; + -webkit-text-stroke: 0.5px #1a1b26; + font-weight: bolder; +} + +.react-jinke-music-player-main .lyric-btn-active, .react-jinke-music-player-main .lyric-btn-active svg { + color: #7aa2f7 !important; +} + +.audio-lists-panel-content .audio-item.playing, .audio-lists-panel-content .audio-item.playing svg { + color: #7aa2f7 +} + +.audio-lists-panel-content .audio-item:active .group:not(.player-delete) svg, .audio-lists-panel-content .audio-item:hover .group:not(.player-delete) svg { + color: #7aa2f7 +} + +.audio-lists-panel-content .audio-item .player-icons { + scale: 75%; +} + +/* Mobile */ + +.react-jinke-music-player-mobile-cover { + border: none; + box-shadow: rgba(15, 17, 21, 0.25) 0px 4px 6px, rgba(15, 17, 21, 0.1) 0px 5px 7px; +} + +.react-jinke-music-player .music-player-controller { + border: none; + box-shadow: rgba(15, 17, 21, 0.25) 0px 4px 6px, rgba(15, 17, 21, 0.1) 0px 5px 7px; + color: #7aa2f7; +} + +.react-jinke-music-player .music-player-controller .music-player-controller-setting { + color: rgba(122, 162, 247, .3); +} + +.react-jinke-music-player-mobile-progress .rc-slider-handle, .react-jinke-music-player-mobile-progress .rc-slider-track { + background-color: #7aa2f7; +} + +.react-jinke-music-player-mobile-progress .rc-slider-handle { + border: none; +} +` + +export default stylesheet diff --git a/ui/src/themes/tokyoNight.js b/ui/src/themes/tokyoNight.js new file mode 100644 index 000000000..07d372a6b --- /dev/null +++ b/ui/src/themes/tokyoNight.js @@ -0,0 +1,382 @@ +import stylesheet from './tokyoNight.css.js' + +const background = '#1a1b26' +const surface = '#24283b' +const currentLine = '#292e42' +const foreground = '#c0caf5' +const comment = '#565f89' +const blue = '#7aa2f7' +const cyan = '#7dcfff' +const purple = '#bb9af7' +const red = '#f7768e' + +// For Album, Playlist play button +const musicListActions = { + alignItems: 'center', + '@global': { + 'button:first-child:not(:only-child)': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.5)', + margin: '1rem', + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: '1.5rem', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + backgroundColor: `${blue} !important`, + color: background, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${blue} !important`, + border: 0, + }, + }, + 'button:only-child': { + margin: '1.5rem', + }, + 'button:first-child>span:first-child': { + padding: 0, + }, + 'button:first-child>span:first-child>span': { + display: 'none', + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: foreground, + }, + }, +} + +export default { + themeName: 'Tokyo Night', + palette: { + primary: { + main: blue, + }, + secondary: { + main: purple, + contrastText: foreground, + }, + error: { + main: red, + }, + type: 'dark', + background: { + default: background, + paper: surface, + }, + }, + overrides: { + MuiPaper: { + root: { + color: foreground, + backgroundColor: surface, + }, + }, + MuiAppBar: { + positionFixed: { + backgroundColor: `${surface} !important`, + boxShadow: + 'rgba(15, 17, 21, 0.25) 0px 4px 6px, rgba(15, 17, 21, 0.1) 0px 5px 7px', + }, + }, + MuiDrawer: { + root: { + background: background, + }, + }, + MuiButton: { + textPrimary: { + color: blue, + }, + textSecondary: { + color: foreground, + }, + }, + MuiIconButton: { + root: { + color: foreground, + }, + }, + MuiChip: { + root: { + backgroundColor: currentLine, + }, + }, + MuiFormGroup: { + root: { + color: foreground, + }, + }, + MuiFormLabel: { + root: { + color: comment, + '&$focused': { + color: blue, + }, + }, + }, + MuiFormHelperText: { + error: { + color: red, + }, + }, + MuiToolbar: { + root: { + backgroundColor: `${surface} !important`, + }, + }, + MuiOutlinedInput: { + root: { + '& $notchedOutline': { + borderColor: currentLine, + }, + '&:hover $notchedOutline': { + borderColor: comment, + }, + '&$focused $notchedOutline': { + borderColor: blue, + }, + }, + }, + MuiFilledInput: { + root: { + backgroundColor: currentLine, + '&:hover': { + backgroundColor: comment, + }, + '&$focused': { + backgroundColor: currentLine, + }, + }, + }, + MuiTableRow: { + root: { + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: `${currentLine} !important`, + }, + }, + }, + MuiTableHead: { + root: { + color: foreground, + background: surface, + }, + }, + MuiTableCell: { + root: { + color: foreground, + background: `${surface} !important`, + borderBottom: `1px solid ${currentLine}`, + }, + head: { + color: `${blue} !important`, + background: `${currentLine} !important`, + }, + body: { + color: `${foreground} !important`, + }, + }, + MuiSwitch: { + colorSecondary: { + '&$checked': { + color: blue, + }, + '&$checked + $track': { + backgroundColor: blue, + }, + }, + }, + NDAlbumGridView: { + albumName: { + marginTop: '0.5rem', + fontWeight: 700, + color: foreground, + }, + albumSubtitle: { + color: comment, + }, + albumContainer: { + backgroundColor: surface, + borderRadius: '8px', + padding: '.75rem', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: currentLine, + }, + }, + albumPlayButton: { + backgroundColor: blue, + borderRadius: '50%', + boxShadow: '0 8px 8px rgb(0 0 0 / 30%)', + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + background: `${blue} !important`, + padding: '0.45rem', + }, + }, + }, + NDPlaylistDetails: { + container: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + paddingTop: '2.5rem !important', + boxShadow: 'none', + }, + title: { + fontWeight: 700, + color: foreground, + }, + details: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumDetails: { + root: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + boxShadow: 'none', + }, + cardContents: { + alignItems: 'center', + paddingTop: '1.5rem', + }, + recordName: { + fontWeight: 700, + color: foreground, + }, + recordArtist: { + fontSize: '.875rem', + fontWeight: 700, + color: purple, + }, + recordMeta: { + fontSize: '.875rem', + color: comment, + }, + }, + NDCollapsibleComment: { + commentBlock: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumShow: { + albumActions: musicListActions, + }, + NDPlaylistShow: { + playlistActions: musicListActions, + }, + NDAudioPlayer: { + audioTitle: { + color: foreground, + fontSize: '0.875rem', + }, + songTitle: { + fontWeight: 400, + }, + songInfo: { + fontSize: '0.675rem', + color: comment, + }, + }, + NDLogin: { + systemNameLink: { + color: blue, + }, + welcome: { + color: foreground, + }, + card: { + minWidth: 300, + background: surface, + }, + button: { + boxShadow: '3px 3px 5px #15161e', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: `linear-gradient(to bottom, rgba(26 27 38 / 72%), ${background})!important`, + }, + }, + RaLayout: { + content: { + padding: '0 !important', + background: background, + }, + root: { + backgroundColor: background, + }, + }, + RaList: { + content: { + backgroundColor: background, + }, + }, + RaListToolbar: { + toolbar: { + backgroundColor: background, + padding: '0 .55rem !important', + }, + }, + RaSidebar: { + fixed: { + backgroundColor: background, + }, + drawerPaper: { + backgroundColor: `${background} !important`, + }, + }, + RaMenuItemLink: { + root: { + color: foreground, + '&[aria-current="page"]': { + color: `${blue} !important`, + }, + '&[aria-current="page"] .MuiListItemIcon-root': { + color: `${blue} !important`, + }, + }, + active: { + color: `${blue} !important`, + '& .MuiListItemIcon-root': { + color: `${blue} !important`, + }, + }, + }, + RaLink: { + link: { + color: cyan, + }, + }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: `2px solid ${blue}`, + }, + button: { + backgroundColor: currentLine, + minWidth: 48, + margin: '0 4px', + }, + }, + }, + player: { + theme: 'dark', + stylesheet, + }, +} diff --git a/ui/src/themes/tokyoNightLight.css.js b/ui/src/themes/tokyoNightLight.css.js new file mode 100644 index 000000000..a22c82d03 --- /dev/null +++ b/ui/src/themes/tokyoNightLight.css.js @@ -0,0 +1,123 @@ +const stylesheet = ` +.react-jinke-music-player-main.light-theme .loading svg { + color: #2e7de9; + font-size: 24px +} + +.react-jinke-music-player-mobile-play-model-tip { + background-color: #2e7de9; +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle, .react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-track { + background-color: #2e7de9 +} + +.react-jinke-music-player-main .music-player-panel .panel-content .rc-slider-handle:active { + box-shadow: 0 0 2px #2e7de9 +} + +.react-jinke-music-player-main.light-theme .audio-item.playing svg { + color: #2e7de9 +} + +.react-jinke-music-player-main.light-theme .audio-item.playing .player-singer { + color: #2e7de9 !important +} + +.audio-lists-panel-content .audio-item.playing, .audio-lists-panel-content .audio-item.playing svg { + color: #2e7de9 +} + +.audio-lists-panel-content .audio-item:active .group:not(.player-delete) svg, .audio-lists-panel-content .audio-item:hover .group:not(.player-delete) svg { + color: #2e7de9 +} + +.react-jinke-music-player-main.light-theme ::-webkit-scrollbar-thumb { + background-color: #2e7de9; +} + +.react-jinke-music-player-main.light-theme svg { + color: #3760bf +} + +.react-jinke-music-player-main.light-theme svg:active, .react-jinke-music-player-main.light-theme svg:hover { + color: #2e7de9 +} + +.react-jinke-music-player-main.light-theme .rc-slider-rail { + background-color: rgba(55, 96, 191, .12) !important +} + +.react-jinke-music-player-main.light-theme .music-player-controller { + background-color: #d5d6db; + border-color: #d5d6db +} + +.react-jinke-music-player-main.light-theme .music-player-panel { + background-color: #d5d6db; + box-shadow: 0 1px 2px 0 rgba(0, 34, 77, .05); + color: #3760bf +} + +.react-jinke-music-player-main.light-theme .music-player-panel .img-content { + box-shadow: 0 0 10px #c4c8da +} + +.react-jinke-music-player-main.light-theme .music-player-panel .progress-load-bar { + background-color: rgba(55, 96, 191, .08) !important +} + +.react-jinke-music-player-main.light-theme .rc-switch { + color: #fff +} + +.react-jinke-music-player-main.light-theme .rc-switch:after { + background-color: #fff +} + +.react-jinke-music-player-main.light-theme .rc-switch-checked { + background-color: #2e7de9 !important; + border: 1px solid #2e7de9 +} + +.react-jinke-music-player-main.light-theme .rc-switch-inner { + color: #fff +} + +.react-jinke-music-player-main.light-theme .audio-lists-btn { + background-color: #e1e2e7 !important +} + +.react-jinke-music-player-main.light-theme .audio-lists-btn:active, .react-jinke-music-player-main.light-theme .audio-lists-btn:hover { + background-color: #ebebed; + color: #3760bf +} + +.react-jinke-music-player-main.light-theme .audio-lists-btn > .group:hover, .react-jinke-music-player-main.light-theme .audio-lists-btn > .group:hover > svg { + color: #2e7de9 +} + +.react-jinke-music-player-main.light-theme .audio-lists-panel { + background-color: #d5d6db; + box-shadow: 0 0 2px #c4c8da; + color: #3760bf +} + +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item { + background-color: #d5d6db +} + +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item:nth-child(odd) { + background-color: #dadbe0 !important +} + +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item.playing { + background-color: #c4c8da !important +} + +.react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item.playing, .react-jinke-music-player-main.light-theme .audio-lists-panel .audio-item.playing svg { + color: #2e7de9 !important +} +` + +export default stylesheet diff --git a/ui/src/themes/tokyoNightLight.js b/ui/src/themes/tokyoNightLight.js new file mode 100644 index 000000000..f84cd0be9 --- /dev/null +++ b/ui/src/themes/tokyoNightLight.js @@ -0,0 +1,382 @@ +import stylesheet from './tokyoNightLight.css.js' + +const background = '#e1e2e7' +const surface = '#d5d6db' +const currentLine = '#c4c8da' +const foreground = '#3760bf' +const comment = '#848cb5' +const blue = '#2e7de9' +const cyan = '#007197' +const purple = '#9854f1' +const red = '#f52a65' + +// For Album, Playlist play button +const musicListActions = { + alignItems: 'center', + '@global': { + 'button:first-child:not(:only-child)': { + '@media screen and (max-width: 720px)': { + transform: 'scale(1.5)', + margin: '1rem', + '&:hover': { + transform: 'scale(1.6) !important', + }, + }, + transform: 'scale(2)', + margin: '1.5rem', + minWidth: 0, + padding: 5, + transition: 'transform .3s ease', + backgroundColor: `${blue} !important`, + color: background, + borderRadius: 500, + border: 0, + '&:hover': { + transform: 'scale(2.1)', + backgroundColor: `${blue} !important`, + border: 0, + }, + }, + 'button:only-child': { + margin: '1.5rem', + }, + 'button:first-child>span:first-child': { + padding: 0, + }, + 'button:first-child>span:first-child>span': { + display: 'none', + }, + 'button>span:first-child>span, button:not(:first-child)>span:first-child>svg': + { + color: foreground, + }, + }, +} + +export default { + themeName: 'Tokyo Night Light', + palette: { + primary: { + main: blue, + }, + secondary: { + main: purple, + contrastText: foreground, + }, + error: { + main: red, + }, + type: 'light', + background: { + default: background, + paper: surface, + }, + }, + overrides: { + MuiPaper: { + root: { + color: foreground, + backgroundColor: surface, + }, + }, + MuiAppBar: { + positionFixed: { + backgroundColor: `${surface} !important`, + boxShadow: + 'rgba(15, 17, 21, 0.15) 0px 4px 6px, rgba(15, 17, 21, 0.08) 0px 5px 7px', + }, + }, + MuiDrawer: { + root: { + background: background, + }, + }, + MuiButton: { + textPrimary: { + color: blue, + }, + textSecondary: { + color: foreground, + }, + }, + MuiIconButton: { + root: { + color: foreground, + }, + }, + MuiChip: { + root: { + backgroundColor: currentLine, + }, + }, + MuiFormGroup: { + root: { + color: foreground, + }, + }, + MuiFormLabel: { + root: { + color: comment, + '&$focused': { + color: blue, + }, + }, + }, + MuiFormHelperText: { + error: { + color: red, + }, + }, + MuiToolbar: { + root: { + backgroundColor: `${surface} !important`, + }, + }, + MuiOutlinedInput: { + root: { + '& $notchedOutline': { + borderColor: currentLine, + }, + '&:hover $notchedOutline': { + borderColor: comment, + }, + '&$focused $notchedOutline': { + borderColor: blue, + }, + }, + }, + MuiFilledInput: { + root: { + backgroundColor: currentLine, + '&:hover': { + backgroundColor: comment, + }, + '&$focused': { + backgroundColor: currentLine, + }, + }, + }, + MuiTableRow: { + root: { + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: `${currentLine} !important`, + }, + }, + }, + MuiTableHead: { + root: { + color: foreground, + background: surface, + }, + }, + MuiTableCell: { + root: { + color: foreground, + background: `${surface} !important`, + borderBottom: `1px solid ${currentLine}`, + }, + head: { + color: `${blue} !important`, + background: `${currentLine} !important`, + }, + body: { + color: `${foreground} !important`, + }, + }, + MuiSwitch: { + colorSecondary: { + '&$checked': { + color: blue, + }, + '&$checked + $track': { + backgroundColor: blue, + }, + }, + }, + NDAlbumGridView: { + albumName: { + marginTop: '0.5rem', + fontWeight: 700, + color: foreground, + }, + albumSubtitle: { + color: comment, + }, + albumContainer: { + backgroundColor: surface, + borderRadius: '8px', + padding: '.75rem', + transition: 'background-color .3s ease', + '&:hover': { + backgroundColor: currentLine, + }, + }, + albumPlayButton: { + backgroundColor: blue, + borderRadius: '50%', + boxShadow: '0 8px 8px rgb(0 0 0 / 20%)', + padding: '0.35rem', + transition: 'padding .3s ease', + '&:hover': { + background: `${blue} !important`, + padding: '0.45rem', + }, + }, + }, + NDPlaylistDetails: { + container: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + paddingTop: '2.5rem !important', + boxShadow: 'none', + }, + title: { + fontWeight: 700, + color: foreground, + }, + details: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumDetails: { + root: { + background: `linear-gradient(${currentLine}, transparent)`, + borderRadius: 0, + boxShadow: 'none', + }, + cardContents: { + alignItems: 'center', + paddingTop: '1.5rem', + }, + recordName: { + fontWeight: 700, + color: foreground, + }, + recordArtist: { + fontSize: '.875rem', + fontWeight: 700, + color: purple, + }, + recordMeta: { + fontSize: '.875rem', + color: comment, + }, + }, + NDCollapsibleComment: { + commentBlock: { + fontSize: '.875rem', + color: comment, + }, + }, + NDAlbumShow: { + albumActions: musicListActions, + }, + NDPlaylistShow: { + playlistActions: musicListActions, + }, + NDAudioPlayer: { + audioTitle: { + color: foreground, + fontSize: '0.875rem', + }, + songTitle: { + fontWeight: 400, + }, + songInfo: { + fontSize: '0.675rem', + color: comment, + }, + }, + NDLogin: { + systemNameLink: { + color: blue, + }, + welcome: { + color: foreground, + }, + card: { + minWidth: 300, + background: surface, + }, + button: { + boxShadow: '3px 3px 5px #a8aecb', + }, + }, + NDMobileArtistDetails: { + bgContainer: { + background: `linear-gradient(to bottom, rgba(225 226 231 / 72%), ${background})!important`, + }, + }, + RaLayout: { + content: { + padding: '0 !important', + background: background, + }, + root: { + backgroundColor: background, + }, + }, + RaList: { + content: { + backgroundColor: background, + }, + }, + RaListToolbar: { + toolbar: { + backgroundColor: background, + padding: '0 .55rem !important', + }, + }, + RaSidebar: { + fixed: { + backgroundColor: background, + }, + drawerPaper: { + backgroundColor: `${background} !important`, + }, + }, + RaMenuItemLink: { + root: { + color: foreground, + '&[aria-current="page"]': { + color: `${blue} !important`, + }, + '&[aria-current="page"] .MuiListItemIcon-root': { + color: `${blue} !important`, + }, + }, + active: { + color: `${blue} !important`, + '& .MuiListItemIcon-root': { + color: `${blue} !important`, + }, + }, + }, + RaLink: { + link: { + color: cyan, + }, + }, + RaButton: { + button: { + margin: '0 5px 0 5px', + }, + }, + RaPaginationActions: { + currentPageButton: { + border: `2px solid ${blue}`, + }, + button: { + backgroundColor: currentLine, + minWidth: 48, + margin: '0 4px', + }, + }, + }, + player: { + theme: 'light', + stylesheet, + }, +} diff --git a/ui/src/themes/useCurrentTheme.js b/ui/src/themes/useCurrentTheme.js index 9793d1e15..0d986033d 100644 --- a/ui/src/themes/useCurrentTheme.js +++ b/ui/src/themes/useCurrentTheme.js @@ -42,6 +42,12 @@ const useCurrentTheme = () => { document.head.removeChild(style) } } + + // Set body background color to match theme (fixes white background on pull-to-refresh) + const isDark = theme.palette?.type === 'dark' + const bgColor = + theme.palette?.background?.default || (isDark ? '#303030' : '#fafafa') + document.body.style.backgroundColor = bgColor }, [theme]) return theme diff --git a/ui/src/themes/useCurrentTheme.test.jsx b/ui/src/themes/useCurrentTheme.test.jsx index 03775d34f..65c3be8c6 100644 --- a/ui/src/themes/useCurrentTheme.test.jsx +++ b/ui/src/themes/useCurrentTheme.test.jsx @@ -15,6 +15,10 @@ function createMatchMedia(theme) { }) } +beforeEach(() => { + document.body.style.backgroundColor = '' +}) + describe('useCurrentTheme', () => { describe('with user preference theme as light', () => { beforeAll(() => { @@ -117,4 +121,44 @@ describe('useCurrentTheme', () => { expect(result.current.themeName).toMatch('Spotify-ish') }) }) + describe('body background color', () => { + beforeAll(() => { + window.matchMedia = createMatchMedia('dark') + }) + it('sets body background for dark theme', () => { + renderHook(() => useCurrentTheme(), { + wrapper: ({ children }) => ( + <Provider store={createStore(themeReducer, { theme: 'DarkTheme' })}> + {children} + </Provider> + ), + }) + // Dark theme uses MUI default dark background + expect(document.body.style.backgroundColor).toBe('rgb(48, 48, 48)') + }) + it('sets body background for light theme', () => { + renderHook(() => useCurrentTheme(), { + wrapper: ({ children }) => ( + <Provider store={createStore(themeReducer, { theme: 'LightTheme' })}> + {children} + </Provider> + ), + }) + // Light theme uses MUI default light background + expect(document.body.style.backgroundColor).toBe('rgb(250, 250, 250)') + }) + it('sets body background for theme with custom background', () => { + renderHook(() => useCurrentTheme(), { + wrapper: ({ children }) => ( + <Provider + store={createStore(themeReducer, { theme: 'SpotifyTheme' })} + > + {children} + </Provider> + ), + }) + // Spotify theme has explicit background.default: #121212 + expect(document.body.style.backgroundColor).toBe('rgb(18, 18, 18)') + }) + }) }) diff --git a/ui/src/transcode/browserProfile.js b/ui/src/transcode/browserProfile.js new file mode 100644 index 000000000..d268af7c9 --- /dev/null +++ b/ui/src/transcode/browserProfile.js @@ -0,0 +1,80 @@ +// Each entry: { codec name for the server, container, mime: [MIME probe strings] } +export const CODEC_PROBES = [ + { codec: 'mp3', container: 'mp3', mime: ['audio/mpeg; codecs="mp3"'] }, + { codec: 'opus', container: 'ogg', mime: ['audio/ogg; codecs="opus"'] }, + { codec: 'vorbis', container: 'ogg', mime: ['audio/ogg; codecs="vorbis"'] }, + { + codec: 'flac', + container: 'flac', + mime: ['audio/flac', 'audio/flac; codecs="flac"'], + }, + { codec: 'wav', container: 'wav', mime: ['audio/wav; codecs="1"'] }, + { codec: 'alac', container: 'mp4', mime: ['audio/mp4; codecs="alac"'] }, + { codec: 'aac', container: 'mp4', mime: ['audio/mp4; codecs="mp4a.40.2"'] }, +] + +// Transcoding targets in preference order (lossless first, then lossy). +// Derived from CODEC_PROBES to avoid duplicating MIME strings. +// MP3 is always included as a universal fallback. +const TRANSCODE_CODECS = ['flac', 'opus', 'mp3'] + +// Safari transcoding is limited to mp3 only. Safari cannot reliably stream +// Ogg containers (reports canPlayType support but fails on non-seekable +// transcoded streams), and FLAC transcoding also fails in practice. +const SAFARI_TRANSCODE_CODECS = ['mp3'] + +function canPlay(audio, mimeList) { + return mimeList.some((m) => { + const result = audio.canPlayType(m) + return result === 'probably' || result === 'maybe' + }) +} + +function probeSupported(audio, probes) { + return probes.filter(({ mime }) => canPlay(audio, mime)) +} + +function isSafari() { + const ua = navigator.userAgent + return ( + ua.includes('Safari') && !ua.includes('Chrome') && !ua.includes('Chromium') + ) +} + +export function detectBrowserProfile() { + const audio = new Audio() + + const directPlayProfiles = probeSupported(audio, CODEC_PROBES).map( + ({ codec, container }) => ({ + containers: [container], + audioCodecs: [codec], + protocols: ['http'], + }), + ) + + // Build transcoding profiles from supported codecs, always keeping mp3 as fallback. + // Safari is limited to mp3 transcoding only. + const transcodeCodecs = isSafari() + ? SAFARI_TRANSCODE_CODECS + : TRANSCODE_CODECS + const transcodingProfiles = transcodeCodecs.reduce((profiles, codec) => { + const probe = CODEC_PROBES.find((p) => p.codec === codec) + if (!probe) return profiles + if (canPlay(audio, probe.mime) || codec === 'mp3') { + profiles.push({ + container: probe.container, + audioCodec: codec, + protocol: 'http', + }) + } + return profiles + }, []) + + return { + name: 'NavidromeUI', + platform: navigator.userAgent, + directPlayProfiles, + transcodingProfiles, + codecProfiles: [], + } +} diff --git a/ui/src/transcode/browserProfile.test.js b/ui/src/transcode/browserProfile.test.js new file mode 100644 index 000000000..e79b7a744 --- /dev/null +++ b/ui/src/transcode/browserProfile.test.js @@ -0,0 +1,179 @@ +import { describe, it, expect, beforeEach, vi } from 'vitest' +import { detectBrowserProfile, CODEC_PROBES } from './browserProfile' + +describe('detectBrowserProfile', () => { + let mockCanPlayType + + beforeEach(() => { + mockCanPlayType = vi.fn() + vi.stubGlobal( + 'Audio', + class { + canPlayType = mockCanPlayType + }, + ) + }) + + it('includes codecs that return "probably"', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/mpeg; codecs="mp3"') return 'probably' + if (mime === 'audio/ogg; codecs="opus"') return 'probably' + return '' + }) + + const profile = detectBrowserProfile() + + expect(profile.name).toBe('NavidromeUI') + expect(profile.directPlayProfiles.length).toBe(2) + + const codecs = profile.directPlayProfiles.flatMap((p) => p.audioCodecs) + expect(codecs).toContain('mp3') + expect(codecs).toContain('opus') + }) + + it('includes codecs that return "maybe"', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/flac') return 'maybe' + return '' + }) + + const profile = detectBrowserProfile() + const codecs = profile.directPlayProfiles.flatMap((p) => p.audioCodecs) + expect(codecs).toContain('flac') + }) + + it('excludes codecs that return empty string', () => { + mockCanPlayType.mockReturnValue('') + + const profile = detectBrowserProfile() + expect(profile.directPlayProfiles).toEqual([]) + }) + + it('sets protocol to "http" for all direct play profiles', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + profile.directPlayProfiles.forEach((p) => { + expect(p.protocols).toEqual(['http']) + }) + }) + + it('filters transcoding profiles by canPlayType', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/mpeg; codecs="mp3"') return 'probably' + if (mime === 'audio/ogg; codecs="opus"') return 'probably' + return '' + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['opus', 'mp3']) + expect(codecs).not.toContain('flac') + profile.transcodingProfiles.forEach((p) => { + expect(p.protocol).toBe('http') + }) + }) + + it('always includes mp3 fallback in transcoding profiles', () => { + mockCanPlayType.mockReturnValue('') + + const profile = detectBrowserProfile() + expect(profile.transcodingProfiles.length).toBe(1) + expect(profile.transcodingProfiles[0].audioCodec).toBe('mp3') + expect(profile.transcodingProfiles[0].protocol).toBe('http') + }) + + it('does not duplicate mp3 when canPlayType supports it', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + const mp3Count = profile.transcodingProfiles.filter( + (p) => p.audioCodec === 'mp3', + ).length + expect(mp3Count).toBe(1) + }) + + it('preserves transcoding profile preference order', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['flac', 'opus', 'mp3']) + }) + + it('sets codecProfiles to empty array', () => { + mockCanPlayType.mockReturnValue('probably') + + const profile = detectBrowserProfile() + expect(profile.codecProfiles).toEqual([]) + }) + + it('matches codec when any mime variant returns "probably"', () => { + mockCanPlayType.mockImplementation((mime) => { + if (mime === 'audio/flac; codecs="flac"') return 'probably' + return '' + }) + + const profile = detectBrowserProfile() + const codecs = profile.directPlayProfiles.flatMap((p) => p.audioCodecs) + expect(codecs).toContain('flac') + }) + + it('includes platform info', () => { + const profile = detectBrowserProfile() + expect(typeof profile.platform).toBe('string') + }) + + describe('Safari restrictions', () => { + beforeEach(() => { + // Safari reports canPlayType for Ogg as positive, but can't actually + // stream transcoded Ogg. Simulate Safari: supports everything. + mockCanPlayType.mockReturnValue('probably') + }) + + it('still includes ogg in direct play profiles on Safari', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/26.2 Safari/605.1.15', + }) + + const profile = detectBrowserProfile() + const containers = profile.directPlayProfiles.flatMap((p) => p.containers) + expect(containers).toContain('ogg') + }) + + it('limits Safari transcoding to mp3 only', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/26.2 Safari/605.1.15', + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['mp3']) + }) + + it('does NOT restrict transcoding on Chrome', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36', + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toContain('opus') + expect(codecs).toContain('flac') + }) + + it('applies same restrictions on iOS Safari', () => { + vi.stubGlobal('navigator', { + userAgent: + 'Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.0 Mobile/15E148 Safari/604.1', + }) + + const profile = detectBrowserProfile() + const codecs = profile.transcodingProfiles.map((p) => p.audioCodec) + expect(codecs).toEqual(['mp3']) + }) + }) +}) diff --git a/ui/src/transcode/decisionService.js b/ui/src/transcode/decisionService.js new file mode 100644 index 000000000..9228cc882 --- /dev/null +++ b/ui/src/transcode/decisionService.js @@ -0,0 +1,111 @@ +import { jwtDecode } from 'jwt-decode' +import subsonic from '../subsonic' +import { baseUrl } from '../utils' + +// Decode the exp claim from a JWT token (no signature verification needed client-side). +// The JWT token is meant to be opaque to the client, we are only allowing ourselves to do +// this here because the UI is tightly integrated with the server; normally we would +// need to rely on the getTranscodeStream returning an error on stale tokens. +export function decodeJwtExp(token) { + try { + if (!token) return null + const payload = jwtDecode(token) + return typeof payload.exp === 'number' ? payload.exp : null + } catch { + return null + } +} + +export function createDecisionService(fetchFn) { + const cache = new Map() + let currentProfile = null + + function isFresh(entry) { + const exp = decodeJwtExp(entry.decision?.transcodeParams) + if (exp == null) return false + // exp is in seconds, Date.now() in milliseconds; 60s buffer avoids mid-request expiry + return Date.now() < (exp - 60) * 1000 + } + + function setProfile(profile) { + currentProfile = profile + } + + function getProfile() { + return currentProfile + } + + async function getDecision(songId, browserProfile) { + const profile = browserProfile || currentProfile + if (!profile) return null + + const cached = cache.get(songId) + if (cached && isFresh(cached)) { + return cached.decision + } + + const decision = await fetchFn(songId, profile) + cache.set(songId, { decision }) + return decision + } + + async function prefetchDecisions(songIds, browserProfile) { + const profile = browserProfile || currentProfile + if (!profile) return + + const uncached = songIds.filter((id) => { + const entry = cache.get(id) + return !entry || !isFresh(entry) + }) + + await Promise.allSettled( + uncached.map(async (id) => { + const decision = await fetchFn(id, profile) + cache.set(id, { decision }) + }), + ) + } + + function invalidateAll() { + cache.clear() + } + + function buildStreamUrl(songId, transcodeParams, offset) { + const params = { + mediaId: songId, + mediaType: 'song', + transcodeParams, + } + if (offset != null && offset > 0) { + params.offset = offset + } + return baseUrl(subsonic.url('getTranscodeStream', null, params)) + } + + async function resolveStreamUrl(songId) { + const decision = await getDecision(songId) + if (!decision?.transcodeParams) { + return baseUrl(subsonic.streamUrl(songId)) + } + return buildStreamUrl(songId, decision.transcodeParams) + } + + function getCachedDecision(songId) { + const entry = cache.get(songId) + if (entry && isFresh(entry)) { + return entry.decision + } + return null + } + + return { + getDecision, + getCachedDecision, + prefetchDecisions, + resolveStreamUrl, + invalidateAll, + buildStreamUrl, + setProfile, + getProfile, + } +} diff --git a/ui/src/transcode/decisionService.test.js b/ui/src/transcode/decisionService.test.js new file mode 100644 index 000000000..a2718ade9 --- /dev/null +++ b/ui/src/transcode/decisionService.test.js @@ -0,0 +1,256 @@ +import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest' +import { createDecisionService, decodeJwtExp } from './decisionService' + +// Helper: create a fake JWT with a given exp (seconds since epoch) +function fakeJwt(expSeconds) { + const header = btoa(JSON.stringify({ alg: 'HS256', typ: 'JWT' })) + const payload = btoa(JSON.stringify({ exp: expSeconds })) + return `${header}.${payload}.fake-signature` +} + +// Helper: create a fake JWT with no exp claim +function fakeJwtNoExp() { + const header = btoa(JSON.stringify({ alg: 'HS256', typ: 'JWT' })) + const payload = btoa(JSON.stringify({ sub: 'test' })) + return `${header}.${payload}.fake-signature` +} + +describe('decodeJwtExp', () => { + it('extracts exp from a valid JWT', () => { + const exp = 1700000000 + expect(decodeJwtExp(fakeJwt(exp))).toBe(exp) + }) + + it('returns null for JWT without exp claim', () => { + expect(decodeJwtExp(fakeJwtNoExp())).toBeNull() + }) + + it('returns null for non-JWT string', () => { + expect(decodeJwtExp('not-a-jwt')).toBeNull() + }) + + it('returns null for empty string', () => { + expect(decodeJwtExp('')).toBeNull() + }) + + it('returns null for null/undefined', () => { + expect(decodeJwtExp(null)).toBeNull() + expect(decodeJwtExp(undefined)).toBeNull() + }) +}) + +describe('decisionService', () => { + let service + let mockFetchFn + + const fakeProfile = { + name: 'NavidromeUI', + platform: 'test', + directPlayProfiles: [], + transcodingProfiles: [], + codecProfiles: [], + } + + // Token that expires 1 hour from "now" (will be relative to fake timers) + function makeFakeDecision(expiresInMs = 3600 * 1000) { + const expSeconds = Math.floor((Date.now() + expiresInMs) / 1000) + return { + canDirectPlay: true, + canTranscode: false, + transcodeParams: fakeJwt(expSeconds), + sourceStream: { codec: 'mp3', container: 'mp3' }, + } + } + + beforeEach(() => { + localStorage.setItem('username', 'testuser') + localStorage.setItem('subsonic-token', 'testtoken') + localStorage.setItem('subsonic-salt', 'testsalt') + mockFetchFn = vi.fn().mockImplementation(() => { + return Promise.resolve(makeFakeDecision()) + }) + service = createDecisionService(mockFetchFn) + }) + + afterEach(() => { + vi.restoreAllMocks() + localStorage.clear() + }) + + describe('getDecision', () => { + it('fetches and caches a decision', async () => { + const result = await service.getDecision('song-1', fakeProfile) + expect(result.canDirectPlay).toBe(true) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + expect(mockFetchFn).toHaveBeenCalledWith('song-1', fakeProfile) + + // Second call uses cache + const result2 = await service.getDecision('song-1', fakeProfile) + expect(result2).toEqual(result) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + }) + + it('re-fetches after token expires', async () => { + vi.useFakeTimers() + + // Token expires in 1 hour + mockFetchFn.mockResolvedValue(makeFakeDecision(3600 * 1000)) + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + + // Advance past expiration + vi.advanceTimersByTime(3600 * 1000 + 1000) + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + vi.useRealTimers() + }) + + it('does not re-fetch before token expires', async () => { + vi.useFakeTimers() + + // Token expires in 1 hour + mockFetchFn.mockResolvedValue(makeFakeDecision(3600 * 1000)) + await service.getDecision('song-1', fakeProfile) + + // 30 minutes later — still fresh + vi.advanceTimersByTime(1800 * 1000) + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + vi.useRealTimers() + }) + + it('re-fetches immediately when token has no exp claim', async () => { + const noExpDecision = { + canDirectPlay: true, + canTranscode: false, + transcodeParams: fakeJwtNoExp(), + sourceStream: { codec: 'mp3', container: 'mp3' }, + } + mockFetchFn.mockResolvedValue(noExpDecision) + await service.getDecision('song-1', fakeProfile) + + // Should re-fetch because token has no exp + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + + it('caches different songs independently', async () => { + await service.getDecision('song-1', fakeProfile) + await service.getDecision('song-2', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + }) + + describe('getCachedDecision', () => { + it('returns null when song is not cached', () => { + expect(service.getCachedDecision('song-1')).toBeNull() + }) + + it('returns cached decision after getDecision', async () => { + await service.getDecision('song-1', fakeProfile) + const cached = service.getCachedDecision('song-1') + expect(cached).not.toBeNull() + expect(cached.canDirectPlay).toBe(true) + }) + + it('returns null after cache is invalidated', async () => { + await service.getDecision('song-1', fakeProfile) + service.invalidateAll() + expect(service.getCachedDecision('song-1')).toBeNull() + }) + + it('returns null after token expires', async () => { + vi.useFakeTimers() + mockFetchFn.mockResolvedValue(makeFakeDecision(3600 * 1000)) + await service.getDecision('song-1', fakeProfile) + + vi.advanceTimersByTime(3600 * 1000 + 1000) + expect(service.getCachedDecision('song-1')).toBeNull() + vi.useRealTimers() + }) + }) + + describe('prefetchDecisions', () => { + it('fetches decisions for uncached songs', async () => { + await service.prefetchDecisions(['song-1', 'song-2'], fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + + it('skips already cached songs', async () => { + await service.getDecision('song-1', fakeProfile) + mockFetchFn.mockClear() + + await service.prefetchDecisions(['song-1', 'song-2'], fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + expect(mockFetchFn).toHaveBeenCalledWith('song-2', fakeProfile) + }) + + it('silently ignores fetch errors', async () => { + mockFetchFn.mockRejectedValue(new Error('network error')) + await expect( + service.prefetchDecisions(['song-1'], fakeProfile), + ).resolves.not.toThrow() + }) + }) + + describe('invalidateAll', () => { + it('clears cache so next getDecision re-fetches', async () => { + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(1) + + service.invalidateAll() + + await service.getDecision('song-1', fakeProfile) + expect(mockFetchFn).toHaveBeenCalledTimes(2) + }) + }) + + describe('resolveStreamUrl', () => { + it('fetches decision and returns built URL', async () => { + service.setProfile(fakeProfile) + const url = await service.resolveStreamUrl('song-1') + expect(url).toContain('getTranscodeStream') + expect(url).toContain('mediaId=song-1') + expect(mockFetchFn).toHaveBeenCalledTimes(1) + }) + + it('falls back to stream URL when decision has no transcodeParams', async () => { + service.setProfile(fakeProfile) + mockFetchFn.mockResolvedValue({ + canDirectPlay: true, + canTranscode: false, + }) + const url = await service.resolveStreamUrl('song-1') + expect(url).toContain('stream') + expect(url).not.toContain('getTranscodeStream') + }) + + it('falls back to stream URL when decision is null', async () => { + service.setProfile(fakeProfile) + mockFetchFn.mockResolvedValue(null) + const url = await service.resolveStreamUrl('song-1') + expect(url).toContain('stream') + expect(url).not.toContain('getTranscodeStream') + }) + }) + + describe('buildStreamUrl', () => { + it('builds URL with required parameters', () => { + const url = service.buildStreamUrl('song-1', 'jwt-token-123') + expect(url).toContain('getTranscodeStream') + expect(url).toContain('mediaId=song-1') + expect(url).toContain('mediaType=song') + expect(url).toContain('transcodeParams=jwt-token-123') + }) + + it('includes offset when provided', () => { + const url = service.buildStreamUrl('song-1', 'jwt-token-123', 30) + expect(url).toContain('offset=30') + }) + + it('omits offset when not provided', () => { + const url = service.buildStreamUrl('song-1', 'jwt-token-123') + expect(url).not.toContain('offset') + }) + }) +}) diff --git a/ui/src/transcode/fetchDecision.js b/ui/src/transcode/fetchDecision.js new file mode 100644 index 000000000..1c794082b --- /dev/null +++ b/ui/src/transcode/fetchDecision.js @@ -0,0 +1,23 @@ +import subsonic from '../subsonic' +import { httpClient } from '../dataProvider' + +export async function fetchTranscodeDecision(songId, browserProfile) { + const fetchUrl = subsonic.url('getTranscodeDecision', null, { + mediaId: songId, + mediaType: 'song', + }) + + const { json } = await httpClient(fetchUrl, { + method: 'POST', + body: JSON.stringify(browserProfile), + }) + + const subsonicResponse = json['subsonic-response'] + + if (subsonicResponse.status !== 'ok') { + const err = subsonicResponse.error || {} + throw new Error(`getTranscodeDecision error: ${err.code} ${err.message}`) + } + + return subsonicResponse.transcodeDecision +} diff --git a/ui/src/transcode/fetchDecision.test.js b/ui/src/transcode/fetchDecision.test.js new file mode 100644 index 000000000..83f934f33 --- /dev/null +++ b/ui/src/transcode/fetchDecision.test.js @@ -0,0 +1,92 @@ +import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest' + +// Mock httpClient before importing module under test +vi.mock('../dataProvider', () => ({ + httpClient: vi.fn(), +})) + +import { fetchTranscodeDecision } from './fetchDecision' +import { httpClient } from '../dataProvider' + +describe('fetchTranscodeDecision', () => { + const fakeProfile = { + name: 'NavidromeUI', + platform: 'test', + directPlayProfiles: [ + { containers: ['mp3'], audioCodecs: ['mp3'], protocols: ['http'] }, + ], + transcodingProfiles: [], + codecProfiles: [], + } + + const fakeJson = { + 'subsonic-response': { + status: 'ok', + transcodeDecision: { + canDirectPlay: true, + canTranscode: false, + transcodeParams: 'jwt-token', + sourceStream: { codec: 'mp3' }, + }, + }, + } + + beforeEach(() => { + localStorage.setItem('username', 'testuser') + localStorage.setItem('subsonic-token', 'testtoken') + localStorage.setItem('subsonic-salt', 'testsalt') + + httpClient.mockResolvedValue({ json: fakeJson }) + }) + + afterEach(() => { + vi.restoreAllMocks() + localStorage.clear() + }) + + it('makes a POST request to getTranscodeDecision with correct URL', async () => { + await fetchTranscodeDecision('song-1', fakeProfile) + + expect(httpClient).toHaveBeenCalledTimes(1) + const [url, options] = httpClient.mock.calls[0] + expect(url).toContain('getTranscodeDecision') + expect(url).toContain('mediaId=song-1') + expect(url).toContain('mediaType=song') + expect(options.method).toBe('POST') + }) + + it('sends the browser profile as JSON body', async () => { + await fetchTranscodeDecision('song-1', fakeProfile) + + const [, options] = httpClient.mock.calls[0] + expect(JSON.parse(options.body)).toEqual(fakeProfile) + }) + + it('returns the transcodeDecision from response', async () => { + const result = await fetchTranscodeDecision('song-1', fakeProfile) + expect(result).toEqual(fakeJson['subsonic-response'].transcodeDecision) + }) + + it('throws on HTTP error (httpClient rejects)', async () => { + httpClient.mockRejectedValue(new Error('Server Error')) + + await expect( + fetchTranscodeDecision('song-1', fakeProfile), + ).rejects.toThrow() + }) + + it('throws on Subsonic error response', async () => { + httpClient.mockResolvedValue({ + json: { + 'subsonic-response': { + status: 'failed', + error: { code: 70, message: 'not found' }, + }, + }, + }) + + await expect( + fetchTranscodeDecision('song-1', fakeProfile), + ).rejects.toThrow() + }) +}) diff --git a/ui/src/transcode/index.js b/ui/src/transcode/index.js new file mode 100644 index 000000000..aa0cb216c --- /dev/null +++ b/ui/src/transcode/index.js @@ -0,0 +1,5 @@ +import { createDecisionService } from './decisionService' +import { fetchTranscodeDecision } from './fetchDecision' +export { detectBrowserProfile } from './browserProfile' + +export const decisionService = createDecisionService(fetchTranscodeDecision) diff --git a/ui/src/user/LibrarySelectionField.jsx b/ui/src/user/LibrarySelectionField.jsx new file mode 100644 index 000000000..4967720cd --- /dev/null +++ b/ui/src/user/LibrarySelectionField.jsx @@ -0,0 +1,55 @@ +import { useInput, useTranslate, useRecordContext } from 'react-admin' +import { Box, FormControl, FormLabel, Typography } from '@material-ui/core' +import { SelectLibraryInput } from '../common/SelectLibraryInput.jsx' +import React, { useMemo } from 'react' + +export const LibrarySelectionField = () => { + const translate = useTranslate() + const record = useRecordContext() + + const { + input: { name, onChange, value }, + meta: { error, touched }, + } = useInput({ source: 'libraryIds' }) + + // Extract library IDs from either 'libraries' array or 'libraryIds' array + const libraryIds = useMemo(() => { + // First check if form has libraryIds (create mode or already transformed) + if (value && Array.isArray(value)) { + return value + } + + // Then check if record has libraries array (edit mode from backend) + if (record?.libraries && Array.isArray(record.libraries)) { + return record.libraries.map((lib) => lib.id) + } + + return [] + }, [value, record]) + + // Determine if this is a new user (no ID means new record) + const isNewUser = !record?.id + + return ( + <FormControl error={!!(touched && error)} fullWidth margin="normal"> + <FormLabel component="legend"> + {translate('resources.user.fields.libraries')} + </FormLabel> + <Box mt={1} mb={1}> + <SelectLibraryInput + onChange={onChange} + value={libraryIds} + isNewUser={isNewUser} + /> + </Box> + {touched && error && ( + <Typography color="error" variant="caption"> + {error} + </Typography> + )} + <Typography variant="caption" color="textSecondary"> + {translate('resources.user.helperTexts.libraries')} + </Typography> + </FormControl> + ) +} diff --git a/ui/src/user/LibrarySelectionField.test.jsx b/ui/src/user/LibrarySelectionField.test.jsx new file mode 100644 index 000000000..9777bab99 --- /dev/null +++ b/ui/src/user/LibrarySelectionField.test.jsx @@ -0,0 +1,168 @@ +import * as React from 'react' +import { render, screen, cleanup } from '@testing-library/react' +import { LibrarySelectionField } from './LibrarySelectionField' +import { useInput, useTranslate, useRecordContext } from 'react-admin' +import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest' +import { SelectLibraryInput } from '../common/SelectLibraryInput' + +// Mock the react-admin hooks +vi.mock('react-admin', () => ({ + useInput: vi.fn(), + useTranslate: vi.fn(), + useRecordContext: vi.fn(), +})) + +// Mock the SelectLibraryInput component +vi.mock('../common/SelectLibraryInput.jsx', () => ({ + SelectLibraryInput: vi.fn(() => <div data-testid="select-library-input" />), +})) + +describe('<LibrarySelectionField />', () => { + const defaultProps = { + input: { + name: 'libraryIds', + value: [], + onChange: vi.fn(), + }, + meta: { + touched: false, + error: undefined, + }, + } + + const mockTranslate = vi.fn((key) => key) + + beforeEach(() => { + useInput.mockReturnValue(defaultProps) + useTranslate.mockReturnValue(mockTranslate) + useRecordContext.mockReturnValue({}) + SelectLibraryInput.mockClear() + }) + + afterEach(cleanup) + + it('should render field label from translations', () => { + render(<LibrarySelectionField />) + expect(screen.getByText('resources.user.fields.libraries')).not.toBeNull() + }) + + it('should render helper text from translations', () => { + render(<LibrarySelectionField />) + expect( + screen.getByText('resources.user.helperTexts.libraries'), + ).not.toBeNull() + }) + + it('should render SelectLibraryInput with correct props', () => { + render(<LibrarySelectionField />) + expect(screen.getByTestId('select-library-input')).not.toBeNull() + expect(SelectLibraryInput).toHaveBeenCalledWith( + expect.objectContaining({ + onChange: defaultProps.input.onChange, + value: defaultProps.input.value, + }), + expect.anything(), + ) + }) + + it('should render error message when touched and has error', () => { + useInput.mockReturnValue({ + ...defaultProps, + meta: { + touched: true, + error: 'This field is required', + }, + }) + + render(<LibrarySelectionField />) + expect(screen.getByText('This field is required')).not.toBeNull() + }) + + it('should not render error message when not touched', () => { + useInput.mockReturnValue({ + ...defaultProps, + meta: { + touched: false, + error: 'This field is required', + }, + }) + + render(<LibrarySelectionField />) + expect(screen.queryByText('This field is required')).toBeNull() + }) + + it('should initialize with empty array when value is null', () => { + useInput.mockReturnValue({ + ...defaultProps, + input: { + ...defaultProps.input, + value: null, + }, + }) + + render(<LibrarySelectionField />) + expect(SelectLibraryInput).toHaveBeenCalledWith( + expect.objectContaining({ + value: [], + }), + expect.anything(), + ) + }) + + it('should extract library IDs from record libraries array when editing user', () => { + // Mock a record with libraries array (from backend during edit) + useRecordContext.mockReturnValue({ + id: 'user123', + name: 'John Doe', + libraries: [ + { id: 1, name: 'Music Library 1', path: '/music1' }, + { id: 3, name: 'Music Library 3', path: '/music3' }, + ], + }) + + // Mock input without libraryIds (edit mode scenario) + useInput.mockReturnValue({ + ...defaultProps, + input: { + ...defaultProps.input, + value: undefined, + }, + }) + + render(<LibrarySelectionField />) + expect(SelectLibraryInput).toHaveBeenCalledWith( + expect.objectContaining({ + value: [1, 3], // Should extract IDs from libraries array + }), + expect.anything(), + ) + }) + + it('should prefer libraryIds when both libraryIds and libraries are present', () => { + // Mock a record with libraries array + useRecordContext.mockReturnValue({ + id: 'user123', + libraries: [ + { id: 1, name: 'Music Library 1', path: '/music1' }, + { id: 3, name: 'Music Library 3', path: '/music3' }, + ], + }) + + // Mock input with explicit libraryIds (create mode or already transformed) + useInput.mockReturnValue({ + ...defaultProps, + input: { + ...defaultProps.input, + value: [2, 4], // Different IDs than in libraries + }, + }) + + render(<LibrarySelectionField />) + expect(SelectLibraryInput).toHaveBeenCalledWith( + expect.objectContaining({ + value: [2, 4], // Should prefer libraryIds over libraries + }), + expect.anything(), + ) + }) +}) diff --git a/ui/src/user/UserCreate.jsx b/ui/src/user/UserCreate.jsx index 42ea1ce94..ce69b6542 100644 --- a/ui/src/user/UserCreate.jsx +++ b/ui/src/user/UserCreate.jsx @@ -2,17 +2,20 @@ import React, { useCallback } from 'react' import { BooleanInput, Create, - TextInput, + email, + FormDataConsumer, PasswordInput, required, - email, SimpleForm, - useTranslate, + TextInput, useMutation, useNotify, useRedirect, + useTranslate, } from 'react-admin' +import { Typography } from '@material-ui/core' import { Title } from '../common' +import { LibrarySelectionField } from './LibrarySelectionField.jsx' const UserCreate = (props) => { const translate = useTranslate() @@ -48,9 +51,17 @@ const UserCreate = (props) => { [mutate, notify, redirect], ) + // Custom validation function + const validateUserForm = (values) => { + const errors = {} + // Library selection is optional for non-admin users since they will be auto-assigned to default libraries + // No validation required for library selection + return errors + } + return ( <Create title={<Title subTitle={title} />} {...props}> - <SimpleForm save={save} variant={'outlined'}> + <SimpleForm save={save} validate={validateUserForm} variant={'outlined'}> <TextInput spellCheck={false} source="userName" @@ -64,6 +75,25 @@ const UserCreate = (props) => { validate={[required()]} /> <BooleanInput source="isAdmin" defaultValue={false} /> + + {/* Conditional Library Selection */} + <FormDataConsumer> + {({ formData }) => ( + <> + {!formData.isAdmin && <LibrarySelectionField />} + + {formData.isAdmin && ( + <Typography + variant="body2" + color="textSecondary" + style={{ marginTop: 16, marginBottom: 16 }} + > + {translate('resources.user.message.adminAutoLibraries')} + </Typography> + )} + </> + )} + </FormDataConsumer> </SimpleForm> </Create> ) diff --git a/ui/src/user/UserEdit.jsx b/ui/src/user/UserEdit.jsx index 445f9c6fd..2283dd8bc 100644 --- a/ui/src/user/UserEdit.jsx +++ b/ui/src/user/UserEdit.jsx @@ -18,9 +18,13 @@ import { useRefresh, FormDataConsumer, usePermissions, + useRecordContext, } from 'react-admin' +import { Typography } from '@material-ui/core' import { Title } from '../common' import DeleteUserButton from './DeleteUserButton' +import { LibrarySelectionField } from './LibrarySelectionField.jsx' +import { validateUserForm } from './userValidation' const useStyles = makeStyles({ toolbar: { @@ -100,12 +104,18 @@ const UserEdit = (props) => { [mutate, notify, permissions, redirect, refresh], ) + // Custom validation function + const validateForm = (values) => { + return validateUserForm(values, translate) + } + return ( <Edit title={<UserTitle />} undoable={false} {...props}> <SimpleForm variant={'outlined'} toolbar={<UserToolbar showDelete={canDelete} />} save={save} + validate={validateForm} > {permissions === 'admin' && ( <TextInput @@ -139,6 +149,28 @@ const UserEdit = (props) => { {permissions === 'admin' && ( <BooleanInput source="isAdmin" initialValue={false} /> )} + + {/* Conditional Library Selection for Admin Users Only */} + {permissions === 'admin' && ( + <FormDataConsumer> + {({ formData }) => ( + <> + {!formData.isAdmin && <LibrarySelectionField />} + + {formData.isAdmin && ( + <Typography + variant="body2" + color="textSecondary" + style={{ marginTop: 16, marginBottom: 16 }} + > + {translate('resources.user.message.adminAutoLibraries')} + </Typography> + )} + </> + )} + </FormDataConsumer> + )} + <DateField variant="body1" source="lastLoginAt" showTime /> <DateField variant="body1" source="lastAccessAt" showTime /> <DateField variant="body1" source="updatedAt" showTime /> diff --git a/ui/src/user/UserEdit.test.jsx b/ui/src/user/UserEdit.test.jsx new file mode 100644 index 000000000..75a9a1ada --- /dev/null +++ b/ui/src/user/UserEdit.test.jsx @@ -0,0 +1,130 @@ +import * as React from 'react' +import { render, screen } from '@testing-library/react' +import UserEdit from './UserEdit' +import { describe, it, expect, vi } from 'vitest' + +const defaultUser = { + id: 'user1', + userName: 'testuser', + name: 'Test User', + email: 'test@example.com', + isAdmin: false, + libraries: [ + { id: 1, name: 'Library 1', path: '/music1' }, + { id: 2, name: 'Library 2', path: '/music2' }, + ], + lastLoginAt: '2023-01-01T12:00:00Z', + lastAccessAt: '2023-01-02T12:00:00Z', + updatedAt: '2023-01-03T12:00:00Z', + createdAt: '2023-01-04T12:00:00Z', +} + +const adminUser = { + ...defaultUser, + id: 'admin1', + userName: 'admin', + name: 'Admin User', + isAdmin: true, +} + +// Mock React-Admin completely with simpler implementations +vi.mock('react-admin', () => ({ + Edit: ({ children, title }) => ( + <div data-testid="edit-component"> + {title} + {children} + </div> + ), + SimpleForm: ({ children }) => ( + <form data-testid="simple-form">{children}</form> + ), + TextInput: ({ source }) => <input data-testid={`text-input-${source}`} />, + BooleanInput: ({ source }) => ( + <input type="checkbox" data-testid={`boolean-input-${source}`} /> + ), + DateField: ({ source }) => ( + <div data-testid={`date-field-${source}`}>Date</div> + ), + PasswordInput: ({ source }) => ( + <input type="password" data-testid={`password-input-${source}`} /> + ), + Toolbar: ({ children }) => <div data-testid="toolbar">{children}</div>, + SaveButton: () => <button data-testid="save-button">Save</button>, + FormDataConsumer: ({ children }) => children({ formData: {} }), + Typography: ({ children }) => <p>{children}</p>, + required: () => () => null, + email: () => () => null, + useMutation: () => [vi.fn()], + useNotify: () => vi.fn(), + useRedirect: () => vi.fn(), + useRefresh: () => vi.fn(), + usePermissions: () => ({ permissions: 'admin' }), + useTranslate: () => (key) => key, +})) + +vi.mock('./LibrarySelectionField.jsx', () => ({ + LibrarySelectionField: () => <div data-testid="library-selection-field" />, +})) + +vi.mock('./DeleteUserButton', () => ({ + __esModule: true, + default: () => <button data-testid="delete-user-button">Delete</button>, +})) + +vi.mock('../common', () => ({ + Title: ({ subTitle }) => <div data-testid="title">{subTitle}</div>, +})) + +// Mock Material-UI +vi.mock('@material-ui/core/styles', () => ({ + makeStyles: () => () => ({}), +})) + +vi.mock('@material-ui/core', () => ({ + Typography: ({ children }) => <p>{children}</p>, +})) + +describe('<UserEdit />', () => { + it('should render the user edit form', () => { + render(<UserEdit id="user1" permissions="admin" />) + + // Check if the edit component renders + expect(screen.getByTestId('edit-component')).toBeInTheDocument() + expect(screen.getByTestId('simple-form')).toBeInTheDocument() + }) + + it('should render text inputs for admin users', () => { + render(<UserEdit id="user1" permissions="admin" />) + + // Should render username input for admin + expect(screen.getByTestId('text-input-userName')).toBeInTheDocument() + expect(screen.getByTestId('text-input-name')).toBeInTheDocument() + expect(screen.getByTestId('text-input-email')).toBeInTheDocument() + }) + + it('should render admin checkbox for admin permissions', () => { + render(<UserEdit id="user1" permissions="admin" />) + + // Should render isAdmin checkbox for admin users + expect(screen.getByTestId('boolean-input-isAdmin')).toBeInTheDocument() + }) + + it('should render date fields', () => { + render(<UserEdit id="user1" permissions="admin" />) + + expect(screen.getByTestId('date-field-lastLoginAt')).toBeInTheDocument() + expect(screen.getByTestId('date-field-lastAccessAt')).toBeInTheDocument() + expect(screen.getByTestId('date-field-updatedAt')).toBeInTheDocument() + expect(screen.getByTestId('date-field-createdAt')).toBeInTheDocument() + }) + + it('should not render username input for non-admin users', () => { + render(<UserEdit id="user1" permissions="user" />) + + // Should not render username input for non-admin + expect(screen.queryByTestId('text-input-userName')).not.toBeInTheDocument() + // But should still render name and email + expect(screen.getByTestId('text-input-name')).toBeInTheDocument() + expect(screen.getByTestId('text-input-email')).toBeInTheDocument() + }) +}) diff --git a/ui/src/user/userValidation.js b/ui/src/user/userValidation.js new file mode 100644 index 000000000..e90fd2acb --- /dev/null +++ b/ui/src/user/userValidation.js @@ -0,0 +1,19 @@ +// User form validation utilities +export const validateUserForm = (values, translate) => { + const errors = {} + + // Only require library selection for non-admin users + if (!values.isAdmin) { + // Check both libraryIds (array of IDs) and libraries (array of objects) + const hasLibraryIds = values.libraryIds && values.libraryIds.length > 0 + const hasLibraries = values.libraries && values.libraries.length > 0 + + if (!hasLibraryIds && !hasLibraries) { + errors.libraryIds = translate( + 'resources.user.validation.librariesRequired', + ) + } + } + + return errors +} diff --git a/ui/src/user/userValidation.test.js b/ui/src/user/userValidation.test.js new file mode 100644 index 000000000..2ee473910 --- /dev/null +++ b/ui/src/user/userValidation.test.js @@ -0,0 +1,70 @@ +import { describe, it, expect, vi } from 'vitest' +import { validateUserForm } from './userValidation' + +describe('User Validation Utilities', () => { + const mockTranslate = vi.fn((key) => key) + + describe('validateUserForm', () => { + it('should not return errors for admin users', () => { + const values = { + isAdmin: true, + libraryIds: [], + } + const errors = validateUserForm(values, mockTranslate) + expect(errors).toEqual({}) + }) + + it('should not return errors for non-admin users with libraries', () => { + const values = { + isAdmin: false, + libraryIds: [1, 2, 3], + } + const errors = validateUserForm(values, mockTranslate) + expect(errors).toEqual({}) + }) + + it('should return error for non-admin users without libraries', () => { + const values = { + isAdmin: false, + libraryIds: [], + } + const errors = validateUserForm(values, mockTranslate) + expect(errors.libraryIds).toBe( + 'resources.user.validation.librariesRequired', + ) + }) + + it('should return error for non-admin users with undefined libraryIds', () => { + const values = { + isAdmin: false, + } + const errors = validateUserForm(values, mockTranslate) + expect(errors.libraryIds).toBe( + 'resources.user.validation.librariesRequired', + ) + }) + + it('should not return errors for non-admin users with libraries array', () => { + const values = { + isAdmin: false, + libraries: [ + { id: 1, name: 'Library 1' }, + { id: 2, name: 'Library 2' }, + ], + } + const errors = validateUserForm(values, mockTranslate) + expect(errors).toEqual({}) + }) + + it('should return error for non-admin users with empty libraries array', () => { + const values = { + isAdmin: false, + libraries: [], + } + const errors = validateUserForm(values, mockTranslate) + expect(errors.libraryIds).toBe( + 'resources.user.validation.librariesRequired', + ) + }) + }) +}) diff --git a/ui/src/utils/formatters.js b/ui/src/utils/formatters.js index ae27f230f..cfcb84b05 100644 --- a/ui/src/utils/formatters.js +++ b/ui/src/utils/formatters.js @@ -25,6 +25,42 @@ export const formatDuration = (d) => { return `${days > 0 ? days + ':' : ''}${f}` } +export const formatDuration2 = (totalSeconds) => { + if (totalSeconds == null || totalSeconds < 0) { + return '0s' + } + const days = Math.floor(totalSeconds / 86400) + const hours = Math.floor((totalSeconds % 86400) / 3600) + const minutes = Math.floor((totalSeconds % 3600) / 60) + const seconds = Math.floor(totalSeconds % 60) + + const parts = [] + + if (days > 0) { + // When days are present, show only d h m (3 levels max) + parts.push(`${days}d`) + if (hours > 0) { + parts.push(`${hours}h`) + } + if (minutes > 0) { + parts.push(`${minutes}m`) + } + } else { + // When no days, show h m s (3 levels max) + if (hours > 0) { + parts.push(`${hours}h`) + } + if (minutes > 0) { + parts.push(`${minutes}m`) + } + if (seconds > 0 || parts.length === 0) { + parts.push(`${seconds}s`) + } + } + + return parts.join(' ') +} + export const formatShortDuration = (ns) => { // Convert nanoseconds to seconds const seconds = ns / 1e9 @@ -58,3 +94,8 @@ export const formatFullDate = (date, locale) => { } return new Date(date).toLocaleDateString(locale, options) } + +export const formatNumber = (value, locale) => { + if (value === null || value === undefined) return '0' + return value.toLocaleString(locale) +} diff --git a/ui/src/utils/formatters.test.js b/ui/src/utils/formatters.test.js index 87b40f16b..d633e96f2 100644 --- a/ui/src/utils/formatters.test.js +++ b/ui/src/utils/formatters.test.js @@ -1,7 +1,9 @@ import { formatBytes, formatDuration, + formatDuration2, formatFullDate, + formatNumber, formatShortDuration, } from './formatters' @@ -64,11 +66,90 @@ describe('formatShortDuration', () => { }) }) +describe('formatDuration2', () => { + it('handles null and undefined values', () => { + expect(formatDuration2(null)).toEqual('0s') + expect(formatDuration2(undefined)).toEqual('0s') + }) + + it('handles negative values', () => { + expect(formatDuration2(-10)).toEqual('0s') + expect(formatDuration2(-1)).toEqual('0s') + }) + + it('formats zero seconds', () => { + expect(formatDuration2(0)).toEqual('0s') + }) + + it('formats seconds only', () => { + expect(formatDuration2(1)).toEqual('1s') + expect(formatDuration2(30)).toEqual('30s') + expect(formatDuration2(59)).toEqual('59s') + }) + + it('formats minutes and seconds', () => { + expect(formatDuration2(60)).toEqual('1m') + expect(formatDuration2(90)).toEqual('1m 30s') + expect(formatDuration2(119)).toEqual('1m 59s') + expect(formatDuration2(120)).toEqual('2m') + }) + + it('formats hours, minutes and seconds', () => { + expect(formatDuration2(3600)).toEqual('1h') + expect(formatDuration2(3661)).toEqual('1h 1m 1s') + expect(formatDuration2(7200)).toEqual('2h') + expect(formatDuration2(7260)).toEqual('2h 1m') + expect(formatDuration2(7261)).toEqual('2h 1m 1s') + }) + + it('handles decimal values by flooring', () => { + expect(formatDuration2(59.9)).toEqual('59s') + expect(formatDuration2(60.1)).toEqual('1m') + expect(formatDuration2(3600.9)).toEqual('1h') + }) + + it('formats days with maximum 3 levels (d h m)', () => { + expect(formatDuration2(86400)).toEqual('1d') + expect(formatDuration2(86461)).toEqual('1d 1m') // seconds dropped when days present + expect(formatDuration2(90061)).toEqual('1d 1h 1m') // seconds dropped when days present + expect(formatDuration2(172800)).toEqual('2d') + expect(formatDuration2(176400)).toEqual('2d 1h') + expect(formatDuration2(176460)).toEqual('2d 1h 1m') + expect(formatDuration2(176461)).toEqual('2d 1h 1m') // seconds dropped when days present + }) +}) + +describe('formatNumber', () => { + it('handles null and undefined values', () => { + expect(formatNumber(null, 'en-CA')).toEqual('0') + expect(formatNumber(undefined, 'en-CA')).toEqual('0') + }) + + it('formats integers', () => { + expect(formatNumber(0, 'en-CA')).toEqual('0') + expect(formatNumber(1, 'en-CA')).toEqual('1') + expect(formatNumber(123, 'en-CA')).toEqual('123') + expect(formatNumber(1000, 'en-CA')).toEqual('1,000') + expect(formatNumber(1234567, 'en-CA')).toEqual('1,234,567') + }) + + it('formats decimal numbers', () => { + expect(formatNumber(123.45, 'en-CA')).toEqual('123.45') + expect(formatNumber(1234.567, 'en-CA')).toEqual('1,234.567') + }) + + it('formats negative numbers', () => { + expect(formatNumber(-123, 'en-CA')).toEqual('-123') + expect(formatNumber(-1234, 'en-CA')).toEqual('-1,234') + expect(formatNumber(-123.45, 'en-CA')).toEqual('-123.45') + }) +}) + describe('formatFullDate', () => { it('format dates', () => { - expect(formatFullDate('2011', 'en-US')).toEqual('2011') - expect(formatFullDate('2011-06', 'en-US')).toEqual('Jun 2011') - expect(formatFullDate('1985-01-01', 'en-US')).toEqual('Jan 1, 1985') + expect(formatFullDate('2011', 'en-CA')).toEqual('2011') + expect(formatFullDate('2011-06', 'en-CA')).toEqual('Jun 2011') + expect(formatFullDate('1985-01-01', 'en-CA')).toEqual('Jan 1, 1985') expect(formatFullDate('199704')).toEqual('') }) }) diff --git a/ui/src/utils/urls.js b/ui/src/utils/urls.js index fdae496e0..80207fe83 100644 --- a/ui/src/utils/urls.js +++ b/ui/src/utils/urls.js @@ -33,8 +33,27 @@ export const shareDownloadUrl = (id) => { return shareUrl(config.publicBaseUrl + '/d/' + id) } -export const shareCoverUrl = (id) => { - return shareUrl(config.publicBaseUrl + '/img/' + id + '?size=300') +export const shareCoverUrl = (id, square) => { + return shareUrl( + config.publicBaseUrl + + '/img/' + + id + + '?size=300' + + (square ? '&square=true' : ''), + ) } export const docsUrl = (path) => `https://www.navidrome.org${path}` + +export const isLastFmURL = (url) => { + try { + const parsed = new URL(url) + return ( + (parsed.protocol === 'http:' || parsed.protocol === 'https:') && + (parsed.hostname === 'last.fm' || parsed.hostname.endsWith('.last.fm')) && + parsed.pathname.startsWith('/music/') + ) + } catch (e) { + return false + } +} diff --git a/ui/src/utils/urls.test.js b/ui/src/utils/urls.test.js new file mode 100644 index 000000000..26bdd1283 --- /dev/null +++ b/ui/src/utils/urls.test.js @@ -0,0 +1,25 @@ +import { isLastFmURL } from './urls' + +describe('isLastFmURL', () => { + it('returns true for valid Last.fm music URLs', () => { + expect(isLastFmURL('https://last.fm/music/The+Beatles')).toBe(true) + expect(isLastFmURL('http://last.fm/music/Radiohead')).toBe(true) + expect(isLastFmURL('https://www.last.fm/music/Daft+Punk')).toBe(true) + }) + + it('returns false for non-http(s) protocols (XSS prevention)', () => { + expect(isLastFmURL('javascript:alert(1)//last.fm/music/')).toBe(false) + expect(isLastFmURL('data:text/html,<script>//last.fm/music/')).toBe(false) + }) + + it('returns false for non-last.fm domains', () => { + expect(isLastFmURL('https://example.com/?q=last.fm/music/')).toBe(false) + expect(isLastFmURL('https://fake-last.fm/music/Artist')).toBe(false) + }) + + it('returns false for invalid paths or inputs', () => { + expect(isLastFmURL('https://last.fm/user/someone')).toBe(false) + expect(isLastFmURL(null)).toBe(false) + expect(isLastFmURL('not-a-url')).toBe(false) + }) +}) diff --git a/ui/src/utils/validations.js b/ui/src/utils/validations.js index 8b163c156..792726e70 100644 --- a/ui/src/utils/validations.js +++ b/ui/src/utils/validations.js @@ -10,3 +10,16 @@ export const urlValidate = (value) => { return 'ra.validation.url' } } + +export function isDateSet(date) { + if (!date) { + return false + } + if (typeof date === 'string') { + return date !== '0001-01-01T00:00:00Z' + } + if (date instanceof Date) { + return date.toISOString() !== '0001-01-01T00:00:00Z' + } + return !!date +} diff --git a/ui/src/utils/validations.test.js b/ui/src/utils/validations.test.js new file mode 100644 index 000000000..10f67d186 --- /dev/null +++ b/ui/src/utils/validations.test.js @@ -0,0 +1,73 @@ +import { isDateSet, urlValidate } from './validations' + +describe('urlValidate', () => { + it('returns undefined for valid URLs', () => { + expect(urlValidate('https://example.com')).toBeUndefined() + expect(urlValidate('http://localhost:3000')).toBeUndefined() + expect(urlValidate('ftp://files.example.com')).toBeUndefined() + }) + + it('returns undefined for empty values', () => { + expect(urlValidate('')).toBeUndefined() + expect(urlValidate(null)).toBeUndefined() + expect(urlValidate(undefined)).toBeUndefined() + }) + + it('returns error for invalid URLs', () => { + expect(urlValidate('not-a-url')).toEqual('ra.validation.url') + expect(urlValidate('example.com')).toEqual('ra.validation.url') + expect(urlValidate('://missing-protocol')).toEqual('ra.validation.url') + }) +}) + +describe('isDateSet', () => { + describe('with falsy values', () => { + it('returns false for null', () => { + expect(isDateSet(null)).toBe(false) + }) + + it('returns false for undefined', () => { + expect(isDateSet(undefined)).toBe(false) + }) + + it('returns false for empty string', () => { + expect(isDateSet('')).toBe(false) + }) + }) + + describe('with Go zero date string', () => { + it('returns false for Go zero date', () => { + expect(isDateSet('0001-01-01T00:00:00Z')).toBe(false) + }) + }) + + describe('with valid date strings', () => { + it('returns true for ISO date strings', () => { + expect(isDateSet('2024-01-15T10:30:00Z')).toBe(true) + expect(isDateSet('2023-12-25T00:00:00Z')).toBe(true) + }) + + it('returns true for other date formats', () => { + expect(isDateSet('2024-01-15')).toBe(true) + }) + }) + + describe('with Date objects', () => { + it('returns true for valid Date objects', () => { + expect(isDateSet(new Date())).toBe(true) + expect(isDateSet(new Date('2024-01-15T10:30:00Z'))).toBe(true) + }) + + // Note: Date objects representing Go zero date would return true because + // toISOString() adds milliseconds (0001-01-01T00:00:00.000Z). + // In practice, dates from the API come as strings, not Date objects, + // so this edge case doesn't occur. + }) + + describe('with other truthy values', () => { + it('returns true for non-date truthy values', () => { + expect(isDateSet(123)).toBe(true) + expect(isDateSet({})).toBe(true) + }) + }) +}) diff --git a/ui/vite.config.js b/ui/vite.config.js index dee9d3939..9d9c845f1 100644 --- a/ui/vite.config.js +++ b/ui/vite.config.js @@ -14,6 +14,9 @@ export default defineConfig({ strategies: 'injectManifest', srcDir: 'src', filename: 'sw.js', + injectManifest: { + maximumFileSizeToCacheInBytes: 3 * 1024 * 1024, // 3 MiB + }, devOptions: { enabled: true, }, @@ -27,6 +30,10 @@ export default defineConfig({ }, }, base: './', + define: { + // JSONForms and other libraries use process.env + 'process.env': JSON.stringify({}), + }, build: { outDir: 'build', sourcemap: true, diff --git a/utils/cache/benchmark_test.go b/utils/cache/benchmark_test.go new file mode 100644 index 000000000..9ab07cf18 --- /dev/null +++ b/utils/cache/benchmark_test.go @@ -0,0 +1,171 @@ +package cache + +import ( + "context" + "fmt" + "io" + "os" + "runtime" + "strings" + "sync" + "testing" + + "github.com/navidrome/navidrome/conf" + "github.com/navidrome/navidrome/conf/configtest" +) + +type benchItem struct { + key string +} + +func (b *benchItem) Key() string { return b.key } + +// setupBenchCache creates a file cache in a temp directory. Returns the cache and cleanup function. +func setupBenchCache(b *testing.B, cacheSize string, getReader ReadFunc) (*fileCache, func()) { + b.Helper() + tmpDir, err := os.MkdirTemp("", "bench-cache-*") + if err != nil { + b.Fatal(err) + } + b.Cleanup(configtest.SetupConfig()) + conf.Server.CacheFolder = conf.NewDir(tmpDir) + + fc := NewFileCache("bench", cacheSize, "bench", 0, getReader).(*fileCache) + + // Wait for cache to be ready + for !fc.ready.Load() { + runtime.Gosched() // Yield to allow background init goroutine to run + } + + teardown := func() { + os.RemoveAll(tmpDir) + } + return fc, teardown +} + +func BenchmarkCacheWrite(b *testing.B) { + // Simulate writing 50KB images (typical 300px JPEG) + imageData := strings.Repeat("x", 50*1024) + + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + key := fmt.Sprintf("write-bench-%d", i) + s, err := fc.Get(context.Background(), &benchItem{key: key}) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(s) + s.Close() + } +} + +func BenchmarkCacheRead(b *testing.B) { + imageData := strings.Repeat("x", 50*1024) + + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + // Pre-populate cache + item := &benchItem{key: "read-bench"} + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(s) + s.Close() + + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Fatal(err) + } + _, _ = io.ReadAll(s) + s.Close() + } +} + +func BenchmarkConcurrentCacheRead(b *testing.B) { + imageData := strings.Repeat("x", 50*1024) + + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + // Pre-populate cache + item := &benchItem{key: "concurrent-read"} + s, _ := fc.Get(context.Background(), item) + _, _ = io.ReadAll(s) + s.Close() + + concurrencyLevels := []int{1, 10, 50} + for _, n := range concurrencyLevels { + b.Run(fmt.Sprintf("goroutines_%d", n), func(b *testing.B) { + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + var wg sync.WaitGroup + wg.Add(n) + for range n { + go func() { + defer wg.Done() + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Error(err) + return + } + _, _ = io.ReadAll(s) + s.Close() + }() + } + wg.Wait() + } + }) + } +} + +func BenchmarkConcurrentCacheMiss(b *testing.B) { + imageData := strings.Repeat("x", 50*1024) + + concurrencyLevels := []int{1, 10, 50} + for _, n := range concurrencyLevels { + b.Run(fmt.Sprintf("goroutines_%d", n), func(b *testing.B) { + fc, cleanup := setupBenchCache(b, "100MB", func(ctx context.Context, item Item) (io.Reader, error) { + return strings.NewReader(imageData), nil + }) + defer cleanup() + + b.SetBytes(int64(len(imageData))) + b.ResetTimer() + for i := 0; i < b.N; i++ { + var wg sync.WaitGroup + wg.Add(n) + // All goroutines request the SAME key (not yet cached) + item := &benchItem{key: fmt.Sprintf("miss-%d", i)} + for range n { + go func() { + defer wg.Done() + s, err := fc.Get(context.Background(), item) + if err != nil { + b.Error(err) + return + } + _, _ = io.ReadAll(s) + s.Close() + }() + } + wg.Wait() + } + }) + } +} diff --git a/utils/cache/cached_http_client.go b/utils/cache/cached_http_client.go index 94d33100b..4eed243dd 100644 --- a/utils/cache/cached_http_client.go +++ b/utils/cache/cached_http_client.go @@ -75,8 +75,7 @@ func (c *HTTPClient) serializeReq(req *http.Request) string { } if req.Body != nil { bodyData, _ := io.ReadAll(req.Body) - bodyStr := base64.StdEncoding.EncodeToString(bodyData) - data.Body = &bodyStr + data.Body = new(base64.StdEncoding.EncodeToString(bodyData)) } j, _ := json.Marshal(&data) return string(j) diff --git a/utils/cache/cached_http_client_test.go b/utils/cache/cached_http_client_test.go index 1ec1a3a27..5f8b0029c 100644 --- a/utils/cache/cached_http_client_test.go +++ b/utils/cache/cached_http_client_test.go @@ -20,6 +20,8 @@ var _ = Describe("HTTPClient", func() { var header string BeforeEach(func() { + requestsReceived = 0 + header = "" ts = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { requestsReceived++ header = r.Header.Get("head") diff --git a/utils/cache/file_caches.go b/utils/cache/file_caches.go index 5edc533f8..9788926d5 100644 --- a/utils/cache/file_caches.go +++ b/utils/cache/file_caches.go @@ -262,7 +262,7 @@ func newFSCache(name, cacheSize, cacheFolder string, maxItems int) (fscache.Cach lru := NewFileHaunter(name, maxItems, size, consts.DefaultCacheCleanUpInterval) h := fscache.NewLRUHaunterStrategy(lru) - cacheFolder = filepath.Join(conf.Server.CacheFolder, cacheFolder) + cacheFolder = filepath.Join(conf.Server.CacheFolder.MustPath(), cacheFolder) var fs *spreadFS log.Info(fmt.Sprintf("Creating %s cache", name), "path", cacheFolder, "maxSize", humanize.Bytes(size)) diff --git a/utils/cache/file_caches_test.go b/utils/cache/file_caches_test.go index 72f4463d1..9a9a9444f 100644 --- a/utils/cache/file_caches_test.go +++ b/utils/cache/file_caches_test.go @@ -28,14 +28,14 @@ var _ = Describe("File Caches", func() { configtest.SetupConfig() _ = os.RemoveAll(tmpDir) }) - conf.Server.CacheFolder = tmpDir + conf.Server.CacheFolder = conf.NewDir(tmpDir) }) Describe("NewFileCache", func() { It("creates the cache folder", func() { Expect(callNewFileCache("test", "1k", "test", 0, nil)).ToNot(BeNil()) - _, err := os.Stat(filepath.Join(conf.Server.CacheFolder, "test")) + _, err := os.Stat(filepath.Join(conf.Server.CacheFolder.String(), "test")) Expect(os.IsNotExist(err)).To(BeFalse()) }) diff --git a/utils/cache/file_haunter_test.go b/utils/cache/file_haunter_test.go index bd1eb568d..6c5151abb 100644 --- a/utils/cache/file_haunter_test.go +++ b/utils/cache/file_haunter_test.go @@ -29,15 +29,15 @@ var _ = Describe("FileHaunter", func() { Expect(err).ToNot(HaveOccurred()) DeferCleanup(func() { _ = os.RemoveAll(tempDir) }) + // Use a short haunter period so cleanup runs promptly; the assertions + // below poll with Eventually instead of racing a fixed sleep. fsCache, err = fscache.NewCacheWithHaunter(fs, fscache.NewLRUHaunterStrategy( - cache.NewFileHaunter("", maxItems, maxSize, 300*time.Millisecond), + cache.NewFileHaunter("", maxItems, maxSize, 100*time.Millisecond), )) Expect(err).ToNot(HaveOccurred()) DeferCleanup(fsCache.Clean) Expect(createTestFiles(fsCache)).To(Succeed()) - - <-time.After(400 * time.Millisecond) }) Context("When maxSize is defined", func() { @@ -46,31 +46,46 @@ var _ = Describe("FileHaunter", func() { }) It("removes files", func() { - Expect(os.ReadDir(cacheDir)).To(HaveLen(4)) - Expect(fsCache.Exists("stream-5")).To(BeFalse(), "stream-5 (empty file) should have been scrubbed") - // TODO Fix flaky tests - //Expect(fsCache.Exists("stream-0")).To(BeFalse(), "stream-0 should have been scrubbed") + // stream-0..4 hold "hello" (5 bytes each) and stream-5 is empty. + // With maxSize=20, the haunter scrubs the empty file plus enough of + // the oldest files to bring the total size down to <= 20 bytes. + // Which files survive (and therefore the exact count) depends on + // access-time ordering, so we only assert the haunter's guarantees: + // the empty file is always scrubbed and the total size stays within + // the configured limit. + Eventually(func(g Gomega) { + g.Expect(fsCache.Exists("stream-5")).To(BeFalse(), "stream-5 (empty file) should have been scrubbed") + size, err := dirSize(cacheDir) + g.Expect(err).ToNot(HaveOccurred()) + g.Expect(size).To(BeNumerically("<=", maxSize)) + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Succeed()) }) }) - XContext("When maxItems is defined", func() { + Context("When maxItems is defined", func() { BeforeEach(func() { maxItems = 3 }) It("removes files", func() { - Expect(os.ReadDir(cacheDir)).To(HaveLen(maxItems)) - Expect(fsCache.Exists("stream-5")).To(BeFalse(), "stream-5 (empty file) should have been scrubbed") - // TODO Fix flaky tests - //Expect(fsCache.Exists("stream-0")).To(BeFalse(), "stream-0 should have been scrubbed") - //Expect(fsCache.Exists("stream-1")).To(BeFalse(), "stream-1 should have been scrubbed") + // With maxItems=3, the haunter scrubs the empty file plus enough of + // the oldest files to bring the count within the limit. As above, the + // exact survivors depend on access-time ordering, so we assert the + // guaranteed invariants: the empty file is gone and the item count + // stays within the configured limit. + Eventually(func(g Gomega) { + g.Expect(fsCache.Exists("stream-5")).To(BeFalse(), "stream-5 (empty file) should have been scrubbed") + entries, readErr := os.ReadDir(cacheDir) + g.Expect(readErr).ToNot(HaveOccurred()) + g.Expect(len(entries)).To(BeNumerically("<=", maxItems)) + }).WithTimeout(5 * time.Second).WithPolling(50 * time.Millisecond).Should(Succeed()) }) }) }) func createTestFiles(c *fscache.FSCache) error { // Create 5 normal files and 1 empty - for i := 0; i < 6; i++ { + for i := range 6 { name := fmt.Sprintf("stream-%v", i) var r fscache.ReadAtCloser if i < 5 { @@ -93,6 +108,26 @@ func createTestFiles(c *fscache.FSCache) error { return nil } +// dirSize returns the total size in bytes of all regular files in dir. +func dirSize(dir string) (uint64, error) { + entries, err := os.ReadDir(dir) + if err != nil { + return 0, err + } + var total uint64 + for _, e := range entries { + info, err := e.Info() + if err != nil { + return 0, err + } + if !info.Mode().IsRegular() { + continue + } + total += uint64(info.Size()) + } + return total, nil +} + func createCachedStream(c *fscache.FSCache, name string, contents string) fscache.ReadAtCloser { r, w, _ := c.Get(name) _, _ = w.Write([]byte(contents)) diff --git a/utils/cache/simple_cache.go b/utils/cache/simple_cache.go index 182d1d12a..eb3c99995 100644 --- a/utils/cache/simple_cache.go +++ b/utils/cache/simple_cache.go @@ -1,13 +1,14 @@ package cache import ( + "context" "errors" "fmt" + "runtime" "sync/atomic" "time" "github.com/jellydator/ttlcache/v3" - . "github.com/navidrome/navidrome/utils/gg" ) type SimpleCache[K comparable, V any] interface { @@ -15,8 +16,11 @@ type SimpleCache[K comparable, V any] interface { AddWithTTL(key K, value V, ttl time.Duration) error Get(key K) (V, error) GetWithLoader(key K, loader func(key K) (V, time.Duration, error)) (V, error) + Remove(key K) Keys() []K Values() []V + Len() int + OnExpiration(fn func(K, V)) func() } type Options struct { @@ -39,9 +43,17 @@ func NewSimpleCache[K comparable, V any](options ...Options) SimpleCache[K, V] { } c := ttlcache.New[K, V](opts...) - return &simpleCache[K, V]{ + cache := &simpleCache[K, V]{ data: c, } + go cache.data.Start() + + // Automatic cleanup to prevent goroutine leak when cache is garbage collected + runtime.AddCleanup(cache, func(ttlCache *ttlcache.Cache[K, V]) { + ttlCache.Stop() + }, cache.data) + + return cache } const evictionTimeout = 1 * time.Hour @@ -65,6 +77,10 @@ func (c *simpleCache[K, V]) AddWithTTL(key K, value V, ttl time.Duration) error return nil } +func (c *simpleCache[K, V]) Remove(key K) { + c.data.Delete(key) +} + func (c *simpleCache[K, V]) Get(key K) (V, error) { item := c.data.Get(key) if item == nil { @@ -102,7 +118,7 @@ func (c *simpleCache[K, V]) GetWithLoader(key K, loader func(key K) (V, time.Dur func (c *simpleCache[K, V]) evictExpired() { if c.evictionDeadline.Load() == nil || c.evictionDeadline.Load().Before(time.Now()) { c.data.DeleteExpired() - c.evictionDeadline.Store(P(time.Now().Add(evictionTimeout))) + c.evictionDeadline.Store(new(time.Now().Add(evictionTimeout))) } } @@ -127,3 +143,15 @@ func (c *simpleCache[K, V]) Values() []V { }) return res } + +func (c *simpleCache[K, V]) Len() int { + return c.data.Len() +} + +func (c *simpleCache[K, V]) OnExpiration(fn func(K, V)) func() { + return c.data.OnEviction(func(_ context.Context, reason ttlcache.EvictionReason, item *ttlcache.Item[K, V]) { + if reason == ttlcache.EvictionReasonExpired { + fn(item.Key(), item.Value()) + } + }) +} diff --git a/utils/cache/simple_cache_test.go b/utils/cache/simple_cache_test.go index 88dab5e07..45ba2c966 100644 --- a/utils/cache/simple_cache_test.go +++ b/utils/cache/simple_cache_test.go @@ -143,5 +143,19 @@ var _ = Describe("SimpleCache", func() { Expect(cache.Get("key0")).To(Equal("value0")) }) }) + + Describe("OnExpiration", func() { + It("should call callback when item expires", func() { + cache = NewSimpleCache[string, string]() + expired := make(chan struct{}) + cache.OnExpiration(func(k, v string) { close(expired) }) + Expect(cache.AddWithTTL("key", "value", 10*time.Millisecond)).To(Succeed()) + select { + case <-expired: + case <-time.After(100 * time.Millisecond): + Fail("expiration callback not called") + } + }) + }) }) }) diff --git a/utils/chain/chain_test.go b/utils/chain/chain_test.go deleted file mode 100644 index 1c6010fb3..000000000 --- a/utils/chain/chain_test.go +++ /dev/null @@ -1,51 +0,0 @@ -package chain_test - -import ( - "errors" - "testing" - - "github.com/navidrome/navidrome/utils/chain" - . "github.com/onsi/ginkgo/v2" - . "github.com/onsi/gomega" -) - -func TestChain(t *testing.T) { - RegisterFailHandler(Fail) - RunSpecs(t, "chain Suite") -} - -var _ = Describe("RunSequentially", func() { - It("should return nil if no functions are provided", func() { - err := chain.RunSequentially() - Expect(err).To(BeNil()) - }) - - It("should return nil if all functions succeed", func() { - err := chain.RunSequentially( - func() error { return nil }, - func() error { return nil }, - ) - Expect(err).To(BeNil()) - }) - - It("should return the error from the first failing function", func() { - expectedErr := errors.New("error in function 2") - err := chain.RunSequentially( - func() error { return nil }, - func() error { return expectedErr }, - func() error { return errors.New("error in function 3") }, - ) - Expect(err).To(Equal(expectedErr)) - }) - - It("should not run functions after the first failing function", func() { - expectedErr := errors.New("error in function 1") - var runCount int - err := chain.RunSequentially( - func() error { runCount++; return expectedErr }, - func() error { runCount++; return nil }, - ) - Expect(err).To(Equal(expectedErr)) - Expect(runCount).To(Equal(1)) - }) -}) diff --git a/utils/chrono/meter.go b/utils/chrono/meter.go index 7b4786ed5..2a249f455 100644 --- a/utils/chrono/meter.go +++ b/utils/chrono/meter.go @@ -2,8 +2,6 @@ package chrono import ( "time" - - . "github.com/navidrome/navidrome/utils/gg" ) // Meter is a simple stopwatch @@ -13,7 +11,7 @@ type Meter struct { } func (m *Meter) Start() { - m.mark = P(time.Now()) + m.mark = new(time.Now()) } func (m *Meter) Stop() time.Duration { diff --git a/utils/chrono/meter_test.go b/utils/chrono/meter_test.go index 1e223ea04..8e18d37ad 100644 --- a/utils/chrono/meter_test.go +++ b/utils/chrono/meter_test.go @@ -16,7 +16,10 @@ func TestChrono(t *testing.T) { RunSpecs(t, "Chrono Suite") } -// Note: These tests may be flaky due to the use of time.Sleep. +// Note: These tests use longer sleep durations and generous tolerances to avoid flakiness +// due to system scheduling delays. For a more elegant approach in the future, consider +// using Go 1.24's experimental testing/synctest package with GOEXPERIMENT=synctest. + var _ = Describe("Meter", func() { var meter *Meter @@ -27,44 +30,62 @@ var _ = Describe("Meter", func() { Describe("Stop", func() { It("should return the elapsed time", func() { meter.Start() - time.Sleep(20 * time.Millisecond) + time.Sleep(50 * time.Millisecond) elapsed := meter.Stop() - Expect(elapsed).To(BeNumerically("~", 20*time.Millisecond, 10*time.Millisecond)) + // Use generous tolerance to account for system scheduling delays + Expect(elapsed).To(BeNumerically(">=", 30*time.Millisecond)) + Expect(elapsed).To(BeNumerically("<=", 200*time.Millisecond)) }) It("should accumulate elapsed time on multiple starts and stops", func() { + // First cycle meter.Start() - time.Sleep(20 * time.Millisecond) - meter.Stop() + time.Sleep(50 * time.Millisecond) + firstElapsed := meter.Stop() + // Second cycle meter.Start() - time.Sleep(20 * time.Millisecond) - elapsed := meter.Stop() + time.Sleep(50 * time.Millisecond) + totalElapsed := meter.Stop() - Expect(elapsed).To(BeNumerically("~", 40*time.Millisecond, 20*time.Millisecond)) + // Test that time accumulates (second measurement should be greater than first) + Expect(totalElapsed).To(BeNumerically(">", firstElapsed)) + + // Test that accumulated time is reasonable (should be roughly double the first) + Expect(totalElapsed).To(BeNumerically(">=", time.Duration(float64(firstElapsed)*1.5))) + Expect(totalElapsed).To(BeNumerically("<=", firstElapsed*3)) + + // Sanity check: total should be at least 60ms (allowing for some timing variance) + Expect(totalElapsed).To(BeNumerically(">=", 60*time.Millisecond)) }) }) Describe("Elapsed", func() { It("should return the total elapsed time", func() { meter.Start() - time.Sleep(20 * time.Millisecond) + time.Sleep(50 * time.Millisecond) meter.Stop() // Should not count the time the meter was stopped - time.Sleep(20 * time.Millisecond) + time.Sleep(50 * time.Millisecond) meter.Start() - time.Sleep(20 * time.Millisecond) + time.Sleep(50 * time.Millisecond) meter.Stop() - Expect(meter.Elapsed()).To(BeNumerically("~", 40*time.Millisecond, 20*time.Millisecond)) + elapsed := meter.Elapsed() + // Should be roughly 100ms (2 x 50ms), but allow for significant variance + Expect(elapsed).To(BeNumerically(">=", 60*time.Millisecond)) + Expect(elapsed).To(BeNumerically("<=", 300*time.Millisecond)) }) It("should include the current running time if started", func() { meter.Start() - time.Sleep(20 * time.Millisecond) - Expect(meter.Elapsed()).To(BeNumerically("~", 20*time.Millisecond, 10*time.Millisecond)) + time.Sleep(50 * time.Millisecond) + elapsed := meter.Elapsed() + // Use generous tolerance to account for system scheduling delays + Expect(elapsed).To(BeNumerically(">=", 30*time.Millisecond)) + Expect(elapsed).To(BeNumerically("<=", 200*time.Millisecond)) }) }) }) diff --git a/utils/files.go b/utils/files.go index 59988340c..2fce307ea 100644 --- a/utils/files.go +++ b/utils/files.go @@ -4,11 +4,14 @@ import ( "os" "path" "path/filepath" + "regexp" "strings" "github.com/navidrome/navidrome/model/id" ) +var cleanFileNameRe = regexp.MustCompile(`[^a-z0-9_-]`) + func TempFileName(prefix, suffix string) string { return filepath.Join(os.TempDir(), prefix+id.NewRandom()+suffix) } @@ -17,3 +20,23 @@ func BaseName(filePath string) string { p := path.Base(filePath) return strings.TrimSuffix(p, path.Ext(p)) } + +// CleanFileName produces a filesystem-safe, human-readable version of a name. +// It lowercases, replaces spaces with underscores, strips non-alphanumeric +// characters (except underscore and hyphen), and truncates to 50 characters. +func CleanFileName(name string) string { + s := strings.ToLower(strings.TrimSpace(name)) + s = strings.ReplaceAll(s, " ", "_") + s = cleanFileNameRe.ReplaceAllString(s, "") + if len(s) > 50 { + s = s[:50] + } + s = strings.TrimRight(s, "_-") + return s +} + +// FileExists checks if a file or directory exists +func FileExists(path string) bool { + _, err := os.Stat(path) + return err == nil || !os.IsNotExist(err) +} diff --git a/utils/files_test.go b/utils/files_test.go new file mode 100644 index 000000000..c6e578f05 --- /dev/null +++ b/utils/files_test.go @@ -0,0 +1,225 @@ +package utils_test + +import ( + "os" + "path/filepath" + "strings" + + "github.com/navidrome/navidrome/utils" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +var _ = Describe("TempFileName", func() { + It("creates a temporary file name with prefix and suffix", func() { + prefix := "test-" + suffix := ".tmp" + result := utils.TempFileName(prefix, suffix) + + Expect(result).To(ContainSubstring(prefix)) + Expect(result).To(HaveSuffix(suffix)) + Expect(result).To(ContainSubstring(os.TempDir())) + }) + + It("creates unique file names on multiple calls", func() { + prefix := "unique-" + suffix := ".test" + + result1 := utils.TempFileName(prefix, suffix) + result2 := utils.TempFileName(prefix, suffix) + + Expect(result1).NotTo(Equal(result2)) + }) + + It("handles empty prefix and suffix", func() { + result := utils.TempFileName("", "") + + Expect(result).To(ContainSubstring(os.TempDir())) + Expect(len(result)).To(BeNumerically(">", len(os.TempDir()))) + }) + + It("creates proper file path separators", func() { + prefix := "path-test-" + suffix := ".ext" + result := utils.TempFileName(prefix, suffix) + + expectedDir := os.TempDir() + Expect(result).To(HavePrefix(expectedDir)) + Expect(strings.Count(result, string(filepath.Separator))).To(BeNumerically(">=", strings.Count(expectedDir, string(filepath.Separator)))) + }) +}) + +var _ = Describe("BaseName", func() { + It("extracts basename from a simple filename", func() { + result := utils.BaseName("test.mp3") + Expect(result).To(Equal("test")) + }) + + It("extracts basename from a file path", func() { + result := utils.BaseName("/path/to/file.txt") + Expect(result).To(Equal("file")) + }) + + It("handles files without extension", func() { + result := utils.BaseName("/path/to/filename") + Expect(result).To(Equal("filename")) + }) + + It("handles files with multiple dots", func() { + result := utils.BaseName("archive.tar.gz") + Expect(result).To(Equal("archive.tar")) + }) + + It("handles hidden files", func() { + // For hidden files without additional extension, path.Ext returns the entire name + // So basename becomes empty string after TrimSuffix + result := utils.BaseName(".hidden") + Expect(result).To(Equal("")) + }) + + It("handles hidden files with extension", func() { + result := utils.BaseName(".config.json") + Expect(result).To(Equal(".config")) + }) + + It("handles empty string", func() { + // The actual behavior returns empty string for empty input + result := utils.BaseName("") + Expect(result).To(Equal("")) + }) + + It("handles path ending with separator", func() { + result := utils.BaseName("/path/to/dir/") + Expect(result).To(Equal("dir")) + }) + + It("handles complex nested path", func() { + result := utils.BaseName("/very/long/path/to/my/favorite/song.mp3") + Expect(result).To(Equal("song")) + }) +}) + +var _ = Describe("CleanFileName", func() { + It("lowercases and replaces spaces with underscores", func() { + Expect(utils.CleanFileName("My Cool Playlist")).To(Equal("my_cool_playlist")) + }) + + It("strips special characters", func() { + Expect(utils.CleanFileName("Rock & Roll! (2024)")).To(Equal("rock__roll_2024")) + }) + + It("handles unicode characters", func() { + Expect(utils.CleanFileName("Música Favorita")).To(Equal("msica_favorita")) + }) + + It("preserves hyphens", func() { + Expect(utils.CleanFileName("lo-fi beats")).To(Equal("lo-fi_beats")) + }) + + It("returns empty string for empty input", func() { + Expect(utils.CleanFileName("")).To(BeEmpty()) + }) + + It("returns empty string for whitespace-only input", func() { + Expect(utils.CleanFileName(" ")).To(BeEmpty()) + }) + + It("returns empty string when all characters are stripped", func() { + Expect(utils.CleanFileName("!!!@@@###")).To(BeEmpty()) + }) + + It("truncates to 50 characters", func() { + long := strings.Repeat("abcdefghij", 10) // 100 chars + result := utils.CleanFileName(long) + Expect(len(result)).To(Equal(50)) + }) + + It("trims trailing underscores and hyphens after truncation", func() { + // 49 a's + space + "b" = after clean: 49 a's + "_b" = 51 chars, truncated to 50 = 49 a's + "_" + name := strings.Repeat("a", 49) + " b" + result := utils.CleanFileName(name) + Expect(result).To(Equal(strings.Repeat("a", 49))) + }) +}) + +var _ = Describe("FileExists", func() { + var tempFile *os.File + var tempDir string + + BeforeEach(func() { + var err error + tempFile, err = os.CreateTemp("", "fileexists-test-*.txt") + Expect(err).NotTo(HaveOccurred()) + + tempDir, err = os.MkdirTemp("", "fileexists-test-dir-*") + Expect(err).NotTo(HaveOccurred()) + }) + + AfterEach(func() { + if tempFile != nil { + os.Remove(tempFile.Name()) + tempFile.Close() + } + if tempDir != "" { + os.RemoveAll(tempDir) + } + }) + + It("returns true for existing file", func() { + Expect(utils.FileExists(tempFile.Name())).To(BeTrue()) + }) + + It("returns true for existing directory", func() { + Expect(utils.FileExists(tempDir)).To(BeTrue()) + }) + + It("returns false for non-existing file", func() { + nonExistentPath := filepath.Join(tempDir, "does-not-exist.txt") + Expect(utils.FileExists(nonExistentPath)).To(BeFalse()) + }) + + It("returns false for empty path", func() { + Expect(utils.FileExists("")).To(BeFalse()) + }) + + It("handles nested non-existing path", func() { + nonExistentPath := "/this/path/definitely/does/not/exist/file.txt" + Expect(utils.FileExists(nonExistentPath)).To(BeFalse()) + }) + + Context("when file is deleted after creation", func() { + It("returns false after file deletion", func() { + filePath := tempFile.Name() + Expect(utils.FileExists(filePath)).To(BeTrue()) + + // Close the file before removing it. On Windows, an open handle + // holds a file lock and os.Remove fails; closing first makes the + // test cross-platform. + Expect(tempFile.Close()).To(Succeed()) + err := os.Remove(filePath) + Expect(err).NotTo(HaveOccurred()) + tempFile = nil // Prevent cleanup attempt + + Expect(utils.FileExists(filePath)).To(BeFalse()) + }) + }) + + Context("when directory is deleted after creation", func() { + It("returns false after directory deletion", func() { + dirPath := tempDir + Expect(utils.FileExists(dirPath)).To(BeTrue()) + + err := os.RemoveAll(dirPath) + Expect(err).NotTo(HaveOccurred()) + tempDir = "" // Prevent cleanup attempt + + Expect(utils.FileExists(dirPath)).To(BeFalse()) + }) + }) + + It("handles permission denied scenarios gracefully", func() { + // This test might be platform specific, but we test the general case + result := utils.FileExists("/root/.ssh/id_rsa") // Likely to not exist or be inaccessible + Expect(result).To(Or(BeTrue(), BeFalse())) // Should not panic + }) +}) diff --git a/utils/gg/gg.go b/utils/gg/gg.go index 208fe2952..674cacf20 100644 --- a/utils/gg/gg.go +++ b/utils/gg/gg.go @@ -1,11 +1,6 @@ // Package gg implements simple "extensions" to Go language. Based on https://github.com/icza/gog package gg -// P returns a pointer to the input value -func P[T any](v T) *T { - return &v -} - // V returns the value of the input pointer, or a zero value if the input pointer is nil. func V[T any](p *T) T { if p == nil { diff --git a/utils/gg/gg_test.go b/utils/gg/gg_test.go index 1d6dff484..a2dd8154f 100644 --- a/utils/gg/gg_test.go +++ b/utils/gg/gg_test.go @@ -16,22 +16,9 @@ func TestGG(t *testing.T) { } var _ = Describe("GG", func() { - Describe("P", func() { - It("returns a pointer to the input value", func() { - v := 123 - Expect(gg.P(123)).To(Equal(&v)) - }) - - It("returns nil if the input value is zero", func() { - v := 0 - Expect(gg.P(0)).To(Equal(&v)) - }) - }) - Describe("V", func() { It("returns the value of the input pointer", func() { - v := 123 - Expect(gg.V(&v)).To(Equal(123)) + Expect(gg.V(new(123))).To(Equal(123)) }) It("returns a zero value if the input pointer is nil", func() { diff --git a/utils/hasher/hasher_test.go b/utils/hasher/hasher_test.go index 30cda3d05..7ecfe6980 100644 --- a/utils/hasher/hasher_test.go +++ b/utils/hasher/hasher_test.go @@ -57,7 +57,7 @@ var _ = Describe("HashFunc", func() { }) It("does not cause race conditions", func() { - for i := 0; i < 1000; i++ { + for i := range 1000 { go func() { hashFunc := hasher.HashFunc() sum := hashFunc(strconv.Itoa(i), input) diff --git a/utils/index_group_parser.go b/utils/index_group_parser.go index 5622164c6..786f5c457 100644 --- a/utils/index_group_parser.go +++ b/utils/index_group_parser.go @@ -23,8 +23,8 @@ var indexGroupsRx = regexp.MustCompile(`(.+)\((.+)\)`) func ParseIndexGroups(spec string) IndexGroups { parsed := make(IndexGroups) - split := strings.Split(spec, " ") - for _, g := range split { + split := strings.SplitSeq(spec, " ") + for g := range split { sub := indexGroupsRx.FindStringSubmatch(g) if len(sub) > 0 { for _, c := range sub[2] { diff --git a/utils/ioutils/ioutils.go b/utils/ioutils/ioutils.go new file mode 100644 index 000000000..89d3997f3 --- /dev/null +++ b/utils/ioutils/ioutils.go @@ -0,0 +1,33 @@ +package ioutils + +import ( + "io" + "os" + + "golang.org/x/text/encoding/unicode" + "golang.org/x/text/transform" +) + +// UTF8Reader wraps an io.Reader to handle Byte Order Mark (BOM) properly. +// It strips UTF-8 BOM if present, and converts UTF-16 (LE/BE) to UTF-8. +// This is particularly useful for reading user-provided text files (like LRC lyrics, +// playlists) that may have been created on Windows, which often adds BOM markers. +// +// Reference: https://en.wikipedia.org/wiki/Byte_order_mark +func UTF8Reader(r io.Reader) io.Reader { + return transform.NewReader(r, unicode.BOMOverride(unicode.UTF8.NewDecoder())) +} + +// UTF8ReadFile reads the named file and returns its contents as a byte slice, +// automatically handling BOM markers. It's similar to os.ReadFile but strips +// UTF-8 BOM and converts UTF-16 encoded files to UTF-8. +func UTF8ReadFile(filename string) ([]byte, error) { + file, err := os.Open(filename) + if err != nil { + return nil, err + } + defer file.Close() + + reader := UTF8Reader(file) + return io.ReadAll(reader) +} diff --git a/utils/ioutils/ioutils_test.go b/utils/ioutils/ioutils_test.go new file mode 100644 index 000000000..7f5483879 --- /dev/null +++ b/utils/ioutils/ioutils_test.go @@ -0,0 +1,117 @@ +package ioutils + +import ( + "bytes" + "io" + "testing" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestIOUtils(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "IO Utils Suite") +} + +var _ = Describe("UTF8Reader", func() { + Context("when reading text with UTF-8 BOM", func() { + It("strips the UTF-8 BOM marker", func() { + // UTF-8 BOM is EF BB BF + input := []byte{0xEF, 0xBB, 0xBF, 'h', 'e', 'l', 'l', 'o'} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hello")) + }) + + It("strips UTF-8 BOM from multi-line text", func() { + // Test with the actual LRC file format + input := []byte{0xEF, 0xBB, 0xBF, '[', '0', '0', ':', '0', '0', '.', '0', '0', ']', ' ', 't', 'e', 's', 't'} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("[00:00.00] test")) + }) + }) + + Context("when reading text without BOM", func() { + It("passes through unchanged", func() { + input := []byte("hello world") + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hello world")) + }) + }) + + Context("when reading UTF-16 LE encoded text", func() { + It("converts to UTF-8 and strips BOM", func() { + // UTF-16 LE BOM (FF FE) followed by "hi" in UTF-16 LE + input := []byte{0xFF, 0xFE, 'h', 0x00, 'i', 0x00} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hi")) + }) + }) + + Context("when reading UTF-16 BE encoded text", func() { + It("converts to UTF-8 and strips BOM", func() { + // UTF-16 BE BOM (FE FF) followed by "hi" in UTF-16 BE + input := []byte{0xFE, 0xFF, 0x00, 'h', 0x00, 'i'} + reader := UTF8Reader(bytes.NewReader(input)) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("hi")) + }) + }) + + Context("when reading empty content", func() { + It("returns empty string", func() { + reader := UTF8Reader(bytes.NewReader([]byte{})) + + output, err := io.ReadAll(reader) + Expect(err).ToNot(HaveOccurred()) + Expect(string(output)).To(Equal("")) + }) + }) +}) + +var _ = Describe("UTF8ReadFile", func() { + Context("when reading a file with UTF-8 BOM", func() { + It("strips the BOM marker", func() { + // Use the actual fixture from issue #4631 + contents, err := UTF8ReadFile("../../tests/fixtures/bom-test.lrc") + Expect(err).ToNot(HaveOccurred()) + + // Should NOT start with BOM + Expect(contents[0]).ToNot(Equal(byte(0xEF))) + // Should start with '[' + Expect(contents[0]).To(Equal(byte('['))) + Expect(string(contents)).To(HavePrefix("[00:00.00]")) + }) + }) + + Context("when reading a file without BOM", func() { + It("reads the file normally", func() { + contents, err := UTF8ReadFile("../../tests/fixtures/test.lrc") + Expect(err).ToNot(HaveOccurred()) + + // Should contain the expected content + Expect(string(contents)).To(ContainSubstring("We're no strangers to love")) + }) + }) + + Context("when reading a non-existent file", func() { + It("returns an error", func() { + _, err := UTF8ReadFile("../../tests/fixtures/nonexistent.lrc") + Expect(err).To(HaveOccurred()) + }) + }) +}) diff --git a/utils/jsoncommentstrip/jsoncommentstrip.go b/utils/jsoncommentstrip/jsoncommentstrip.go new file mode 100644 index 000000000..54ddd88fa --- /dev/null +++ b/utils/jsoncommentstrip/jsoncommentstrip.go @@ -0,0 +1,128 @@ +// Package jsoncommentstrip provides an io.Reader that strips JavaScript-style +// comments (// line and /* block */) from JSON input while preserving +// comment-like sequences inside JSON string values. +package jsoncommentstrip + +import ( + "bufio" + "io" +) + +type state int + +const ( + stateNormal state = iota + stateInString + stateInStringEscape + stateMaybeComment // saw '/' + stateLineComment // inside // ... + stateBlockComment // inside /* ... */ + stateMaybeBlockEnd // saw '*' inside block comment +) + +type reader struct { + r *bufio.Reader + state state +} + +// NewReader returns an io.Reader that strips JSON comments from the +// underlying reader. It removes single-line comments (// to end of line) +// and block comments (/* ... */), while preserving comment-like sequences +// that appear inside JSON string values. +func NewReader(r io.Reader) io.Reader { + return &reader{ + r: bufio.NewReader(r), + state: stateNormal, + } +} + +func (cr *reader) Read(p []byte) (int, error) { + n := 0 + for n < len(p) { + b, err := cr.r.ReadByte() + if err != nil { + if cr.state == stateMaybeComment { + // Emit the pending '/' before returning EOF + p[n] = '/' + n++ + cr.state = stateNormal + } + return n, err + } + + switch cr.state { + case stateNormal: + switch b { + case '"': + p[n] = b + n++ + cr.state = stateInString + case '/': + cr.state = stateMaybeComment + default: + p[n] = b + n++ + } + + case stateInString: + p[n] = b + n++ + switch b { + case '\\': + cr.state = stateInStringEscape + case '"': + cr.state = stateNormal + } + + case stateInStringEscape: + p[n] = b + n++ + cr.state = stateInString + + case stateMaybeComment: + switch b { + case '/': + cr.state = stateLineComment + case '*': + cr.state = stateBlockComment + default: + // The '/' was not a comment start; emit it and the current byte + p[n] = '/' + n++ + if n < len(p) { + p[n] = b + n++ + } else { + // We need to "unread" the current byte since buffer is full + _ = cr.r.UnreadByte() + } + cr.state = stateNormal + } + + case stateLineComment: + if b == '\n' || b == '\r' { + p[n] = b + n++ + cr.state = stateNormal + } + // Otherwise, consume and discard + + case stateBlockComment: + if b == '*' { + cr.state = stateMaybeBlockEnd + } + // Otherwise, consume and discard + + case stateMaybeBlockEnd: + if b == '/' { + cr.state = stateNormal + } else if b == '*' { + // Stay in stateMaybeBlockEnd (consecutive *'s) + cr.state = stateMaybeBlockEnd + } else { + cr.state = stateBlockComment + } + } + } + return n, nil +} diff --git a/utils/jsoncommentstrip/jsoncommentstrip_test.go b/utils/jsoncommentstrip/jsoncommentstrip_test.go new file mode 100644 index 000000000..21e4bd0b1 --- /dev/null +++ b/utils/jsoncommentstrip/jsoncommentstrip_test.go @@ -0,0 +1,164 @@ +package jsoncommentstrip_test + +import ( + "bytes" + "encoding/json" + "io" + "strings" + "testing" + + "github.com/navidrome/navidrome/utils/jsoncommentstrip" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestJsonCommentStrip(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "JsonCommentStrip Suite") +} + +var _ = Describe("NewReader", func() { + read := func(input string) string { + r := jsoncommentstrip.NewReader(strings.NewReader(input)) + out, err := io.ReadAll(r) + Expect(err).ToNot(HaveOccurred()) + return string(out) + } + + // compact returns the compacted JSON form of s, for readable comparisons. + compact := func(s string) string { + var buf bytes.Buffer + ExpectWithOffset(1, json.Compact(&buf, []byte(s))).To(Succeed()) + return buf.String() + } + + It("passes through JSON without comments unchanged", func() { + input := `{"key": "value", "num": 42}` + Expect(read(input)).To(Equal(input)) + }) + + It("strips single-line comments", func() { + input := `{ + // this is a comment + "key": "value" + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "key": "value" + }`))) + }) + + It("strips single-line comments at end of line", func() { + input := `{ + "key": "value" // inline comment + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "key": "value" + }`))) + }) + + It("strips block comments", func() { + input := `{/* comment */"key": "value"}` + Expect(compact(read(input))).To(Equal(`{"key":"value"}`)) + }) + + It("strips multi-line block comments", func() { + input := `{ + /* this is + a multi-line + comment */ + "key": "value" + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "key": "value" + }`))) + }) + + It("preserves // inside JSON strings", func() { + input := `{"key": "value // not a comment"}` + Expect(read(input)).To(Equal(input)) + }) + + It("preserves /* inside JSON strings", func() { + input := `{"key": "value /* not a comment */"}` + Expect(read(input)).To(Equal(input)) + }) + + It("handles escaped quotes in strings", func() { + input := `{"key": "val\"ue // not a comment"}` + Expect(read(input)).To(Equal(input)) + }) + + It("handles / at end of input as literal", func() { + input := `{"key": "value"}/` + Expect(read(input)).To(Equal(input)) + }) + + It("handles * inside block comment not followed by /", func() { + input := `{/* a * b */"key": "value"}` + Expect(compact(read(input))).To(Equal(`{"key":"value"}`)) + }) + + It("handles empty input", func() { + Expect(read("")).To(Equal("")) + }) + + It("handles mixed comments with real content", func() { + input := `{ + // line comment + "name": "test", /* inline block */ + /* multi + line */ + "value": "hello // world", + "other": 123 // trailing + }` + Expect(compact(read(input))).To(Equal(compact(`{ + "name": "test", + "value": "hello // world", + "other": 123 + }`))) + }) + + It("handles consecutive slashes that are not comments", func() { + input := `{"path": "/a/b"}` + Expect(read(input)).To(Equal(input)) + }) + + It("handles block comment at end of input", func() { + input := `{"key": "value"}/* comment */` + Expect(compact(read(input))).To(Equal(`{"key":"value"}`)) + }) + + It("strips comment with windows-style line endings", func() { + input := "{\r\n// comment\r\n\"key\": \"value\"\r\n}" + Expect(compact(read(input))).To(Equal(compact(`{"key": "value"}`))) + }) + + It("strips line comments with mixed line endings", func() { + // From original library: // comments with both \n and \r\n, including multiple on same line + input := "{\n\"one\": 1, // test //\n\"two\": 2, //test //\r\n\"string\": \"value\"\n//test\n}" + expected := "{\n\"one\": 1, \n\"two\": 2, \r\n\"string\": \"value\"\n\n}" + Expect(read(input)).To(Equal(expected)) + }) + + It("strips line comment at start of JSON", func() { + // From original library: // comment as first thing in JSON + input := "{// woot\n\"one\": 1, // test //\n\"two\": 2, //test //\r\n\"string\": \"value\"\n//test\n}" + expected := "{\n\"one\": 1, \n\"two\": 2, \r\n\"string\": \"value\"\n\n}" + Expect(read(input)).To(Equal(expected)) + }) + + It("strips block comments with mixed line endings inside", func() { + // From original library: block comment containing \r\n + input := "{/* multi\nline\r\ncomment */\"one\":1}" + expected := "{\"one\":1}" + Expect(read(input)).To(Equal(expected)) + }) + + It("handles complex mix of escaped quotes, comments, and strings", func() { + // From original library TestQuotationEscape: escaped quote inside string followed by + // comment-like chars, then real comments of both types + input := "{/* multi\nline\r\ncomment */\"one\": \"a value \\\" // /*woot\"/* m\nl *///woot\r\n}" + expected := "{\"one\": \"a value \\\" // /*woot\"\r\n}" + Expect(read(input)).To(Equal(expected)) + }) +}) diff --git a/utils/nanoid/nanoid.go b/utils/nanoid/nanoid.go new file mode 100644 index 000000000..17d32e72f --- /dev/null +++ b/utils/nanoid/nanoid.go @@ -0,0 +1,52 @@ +package nanoid + +import ( + "crypto/rand" + "errors" + "math" +) + +// Generate returns a cryptographically secure random string of `size` characters +// drawn from `alphabet`. It uses bitmask with rejection sampling to avoid modulo bias. +// The alphabet must be non-empty, contain at most 255 characters, and consist only of +// ASCII characters. Non-ASCII alphabets (e.g., multi-byte UTF-8) are not supported. +func Generate(alphabet string, size int) (string, error) { + if len(alphabet) == 0 || len(alphabet) > 255 { + return "", errors.New("alphabet must be non-empty and at most 255 characters") + } + if size <= 0 { + return "", errors.New("size must be a positive integer") + } + + mask := getMask(len(alphabet)) + step := int(math.Ceil(1.6 * float64(mask) * float64(size) / float64(len(alphabet)))) + + id := make([]byte, size) + bytes := make([]byte, step) + for j := 0; ; { + if _, err := rand.Read(bytes); err != nil { + return "", err + } + for i := range step { + idx := int(bytes[i]) & mask + if idx < len(alphabet) { + id[j] = alphabet[idx] + j++ + if j == size { + return string(id), nil + } + } + } + } +} + +// getMask returns the smallest bitmask >= alphabetSize-1. +func getMask(alphabetSize int) int { + for i := 1; i <= 8; i++ { + mask := (2 << uint(i)) - 1 + if mask >= alphabetSize-1 { + return mask + } + } + return 0 +} diff --git a/utils/nanoid/nanoid_test.go b/utils/nanoid/nanoid_test.go new file mode 100644 index 000000000..99d4e5715 --- /dev/null +++ b/utils/nanoid/nanoid_test.go @@ -0,0 +1,85 @@ +package nanoid_test + +import ( + "testing" + + "github.com/navidrome/navidrome/utils/nanoid" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestNanoid(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Nanoid Suite") +} + +var _ = Describe("Generate", func() { + const alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz" + + It("generates a string of the requested length", func() { + id, err := nanoid.Generate(alphabet, 22) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(HaveLen(22)) + }) + + It("generates a short string of the requested length", func() { + id, err := nanoid.Generate(alphabet, 10) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(HaveLen(10)) + }) + + It("only contains characters from the alphabet", func() { + id, err := nanoid.Generate(alphabet, 100) + Expect(err).ToNot(HaveOccurred()) + for _, c := range id { + Expect(alphabet).To(ContainSubstring(string(c))) + } + }) + + It("generates unique IDs", func() { + seen := make(map[string]bool) + for range 1000 { + id, err := nanoid.Generate(alphabet, 22) + Expect(err).ToNot(HaveOccurred()) + Expect(seen).ToNot(HaveKey(id)) + seen[id] = true + } + }) + + It("works with a single-character alphabet", func() { + id, err := nanoid.Generate("a", 5) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(Equal("aaaaa")) + }) + + It("works with a small alphabet", func() { + id, err := nanoid.Generate("ab", 10) + Expect(err).ToNot(HaveOccurred()) + Expect(id).To(HaveLen(10)) + for _, c := range id { + Expect(string(c)).To(BeElementOf("a", "b")) + } + }) + + It("returns error on empty alphabet", func() { + _, err := nanoid.Generate("", 10) + Expect(err).To(HaveOccurred()) + }) + + It("returns error on alphabet larger than 255 characters", func() { + bigAlphabet := make([]byte, 256) + for i := range bigAlphabet { + bigAlphabet[i] = byte(i) + } + _, err := nanoid.Generate(string(bigAlphabet), 10) + Expect(err).To(HaveOccurred()) + }) + + It("returns error on non-positive size", func() { + _, err := nanoid.Generate(alphabet, 0) + Expect(err).To(HaveOccurred()) + + _, err = nanoid.Generate(alphabet, -1) + Expect(err).To(HaveOccurred()) + }) +}) diff --git a/utils/natural/natural.go b/utils/natural/natural.go new file mode 100644 index 000000000..fa0800e1d --- /dev/null +++ b/utils/natural/natural.go @@ -0,0 +1,98 @@ +// Package natural provides natural (alphanumeric) string comparison. +// When both strings have digit sequences at the same position, they are +// compared numerically (so "file2" < "file10"); otherwise bytes are +// compared one-by-one. No allocations are made. +package natural + +import "strings" + +// Compare returns a negative value if a < b, zero if a == b, +// or a positive value if a > b using natural sort ordering. +// +// When two numeric segments are numerically equal (e.g. "01" vs "1"), +// comparison continues with the remaining suffixes. If one or both +// strings end at the digit boundary, the raw strings are compared +// lexically, which makes leading zeros significant as a tie-breaker +// (e.g. "a01" < "a1", "a0" < "a00"). +func Compare(a, b string) int { + ia, ib := 0, 0 + for ia < len(a) && ib < len(b) { + ca, cb := a[ia], b[ib] + da, db := isDigit(ca), isDigit(cb) + + switch { + case da && db: + // Both are in digit sequences — compare numerically. + endA := ia + for endA < len(a) && isDigit(a[endA]) { + endA++ + } + endB := ib + for endB < len(b) && isDigit(b[endB]) { + endB++ + } + + if c := compareNumbers(a[ia:endA], b[ib:endB]); c != 0 { + return c + } + + // Numerically equal. If both sides have trailing data, continue + // comparing after the digit runs. Otherwise fall through to + // lexical comparison of the full remaining strings (which makes + // leading-zero differences significant as a tie-breaker). + if endA < len(a) && endB < len(b) { + ia = endA + ib = endB + continue + } + return strings.Compare(a[ia:], b[ib:]) + case da != db: + return int(ca) - int(cb) + default: + if ca != cb { + return int(ca) - int(cb) + } + ia++ + ib++ + } + } + return (len(a) - ia) - (len(b) - ib) +} + +// compareNumbers compares two digit strings numerically. +// Leading zeros are stripped before comparison. +func compareNumbers(a, b string) int { + // Strip leading zeros. + sa := stripZeros(a) + sb := stripZeros(b) + + // Different lengths after stripping means different magnitude. + if len(sa) != len(sb) { + return len(sa) - len(sb) + } + + // Same length — compare digit by digit. + for i := range len(sa) { + if sa[i] != sb[i] { + return int(sa[i]) - int(sb[i]) + } + } + return 0 +} + +// stripZeros returns s with leading '0' bytes removed. +// If s is all zeros, returns the last byte (a single "0"). +func stripZeros(s string) string { + i := 0 + for i < len(s) && s[i] == '0' { + i++ + } + if i == len(s) && len(s) > 0 { + return s[len(s)-1:] + } + return s[i:] +} + +func isDigit(c byte) bool { + return c >= '0' && c <= '9' +} diff --git a/utils/natural/natural_test.go b/utils/natural/natural_test.go new file mode 100644 index 000000000..825a944c0 --- /dev/null +++ b/utils/natural/natural_test.go @@ -0,0 +1,116 @@ +package natural_test + +import ( + "testing" + + "github.com/navidrome/navidrome/utils/natural" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestNatural(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Natural Suite") +} + +var _ = Describe("Compare", func() { + DescribeTable("returns correct ordering", + func(a, b string, expected int) { + result := natural.Compare(a, b) + if expected < 0 { + Expect(result).To(BeNumerically("<", 0), "expected %q < %q", a, b) + } else if expected > 0 { + Expect(result).To(BeNumerically(">", 0), "expected %q > %q", a, b) + } else { + Expect(result).To(Equal(0), "expected %q == %q", a, b) + } + }, + // Basic string ordering + Entry("a < b", "a", "b", -1), + Entry("b > a", "b", "a", 1), + Entry("a < aa (prefix)", "a", "aa", -1), + Entry("aa > a", "aa", "a", 1), + + // Equal strings + Entry("equal strings return 0", "abc", "abc", 0), + Entry("both empty", "", "", 0), + Entry("a01 == a01", "a01", "a01", 0), + Entry("a1 == a1", "a1", "a1", 0), + + // Empty string edge cases + Entry("empty < non-empty", "", "a", -1), + Entry("non-empty > empty", "a", "", 1), + + // Numeric comparison + Entry("2 < 10 numerically", "2", "10", -1), + Entry("10 > 2 numerically", "10", "2", 1), + Entry("equal numbers", "42", "42", 0), + Entry("9 < 10", "9", "10", -1), + Entry("99 < 100", "99", "100", -1), + + // Simple numeric segments (from original library) + Entry("a0 < a1", "a0", "a1", -1), + Entry("a0 < a00", "a0", "a00", -1), + Entry("a00 < a01", "a00", "a01", -1), + Entry("a01 < a1", "a01", "a1", -1), + Entry("a01 < a2", "a01", "a2", -1), + Entry("a01x < a2x", "a01x", "a2x", -1), + Entry("a01 > a00", "a01", "a00", 1), + Entry("a2 > a01", "a2", "a01", 1), + Entry("a2x > a01x", "a2x", "a01x", 1), + + // Multiple numeric groups (from original library) + Entry("a0b00 < a00b1", "a0b00", "a00b1", -1), + Entry("a0b00 < a00b01", "a0b00", "a00b01", -1), + Entry("a00b0 < a0b00", "a00b0", "a0b00", -1), + Entry("a00b00 < a0b01", "a00b00", "a0b01", -1), + Entry("a00b00 < a0b1", "a00b00", "a0b1", -1), + Entry("a00b00 > a0b0", "a00b00", "a0b0", 1), + Entry("a00b01 > a0b00", "a00b01", "a0b00", 1), + Entry("a00b00 == a0b00", "a00b00", "a0b00", 0), + + // Leading zeros at end of string — lexical tie-break + Entry("file01 < file1", "file01", "file1", -1), + + // Prefix comparison + Entry("abc < abcd", "abc", "abcd", -1), + Entry("abcd > abc", "abcd", "abc", 1), + + // Navidrome use cases: cover art sorting + Entry("cover < cover.1", "cover", "cover.1", -1), + Entry("cover.1 < cover.2", "cover.1", "cover.2", -1), + Entry("cover.2 < cover.10", "cover.2", "cover.10", -1), + + // Navidrome use cases: disc sorting + Entry("disc1 < disc2", "disc1", "disc2", -1), + Entry("disc2 < disc10", "disc2", "disc10", -1), + Entry("disc1 < disc10", "disc1", "disc10", -1), + + // Multiple numeric segments + Entry("a1b2 < a1b10", "a1b2", "a1b10", -1), + Entry("a2b1 > a1b2", "a2b1", "a1b2", 1), + + // Numbers at the start + Entry("2abc < 10abc", "2abc", "10abc", -1), + + // Numbers larger than uint64 max (from original library) + Entry("large: fewer digits < more digits", + "a99999999999999999999", "a100000000000000000000", -1), + Entry("large: digit-by-digit comparison", + "a123456789012345678901234567890", "a123456789012345678901234567891", -1), + Entry("large: more digits > fewer digits", + "a999999999999999999999", "a1000000000000000000000", -1), + Entry("large: 20 digits < 100 digits by length", + "a20000000000000000000", "a100000000000000000000", -1), + Entry("large: 100 digits > 20 digits", + "a100000000000000000000", "a20000000000000000000", 1), + Entry("large: reverse of above", + "a1000000000000000000000", "a999999999999999999999", 1), + Entry("large: equal", + "a100000000000000000000", "a100000000000000000000", 0), + Entry("large: leading zeros with trailing data", + "a00000000000000000000001x", "a1x", 0), + Entry("large: leading zeros with trailing data (2)", + "a099999999999999999999x", "a99999999999999999999x", 0), + ) +}) diff --git a/utils/number/number.go b/utils/number/number.go index 5176a83e4..daf3b4deb 100644 --- a/utils/number/number.go +++ b/utils/number/number.go @@ -2,11 +2,15 @@ package number import ( "strconv" - - "golang.org/x/exp/constraints" ) -func ParseInt[T constraints.Integer](s string) T { +// Integer is a constraint that permits any integer type. +type Integer interface { + ~int | ~int8 | ~int16 | ~int32 | ~int64 | + ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr +} + +func ParseInt[T Integer](s string) T { r, _ := strconv.ParseInt(s, 10, 64) return T(r) } diff --git a/utils/pl/pipelines.go b/utils/pl/pipelines.go index ed85c6b94..df4ee030c 100644 --- a/utils/pl/pipelines.go +++ b/utils/pl/pipelines.go @@ -29,7 +29,7 @@ func Stage[In any, Out any]( limit := int64(maxWorkers) sem1 := semaphore.NewWeighted(limit) - go func() { + go func() { //nolint:gosec // intentional context.Background() below to wait for workers after ctx cancellation defer close(outputChannel) defer close(errorChannel) @@ -58,7 +58,7 @@ func Stage[In any, Out any]( // By using context.Background() here we are assuming the fn will stop when the context // is canceled. This is required so we can wait for the workers to finish and avoid closing // the outputChannel before they are done. - if err := sem1.Acquire(context.Background(), limit); err != nil { + if err := sem1.Acquire(context.Background(), limit); err != nil { //nolint:gosec // intentional: must wait for workers after ctx cancellation log.Error(ctx, "Failed waiting for workers", err) } }() @@ -152,7 +152,7 @@ func Tee[T any](ctx context.Context, in <-chan T) (<-chan T, <-chan T) { defer close(out2) for val := range ReadOrDone(ctx, in) { var out1, out2 = out1, out2 - for i := 0; i < 2; i++ { + for range 2 { select { case <-ctx.Done(): case out1 <- val: diff --git a/utils/pl/pipelines_test.go b/utils/pl/pipelines_test.go index f5da6e49f..aa0b7faff 100644 --- a/utils/pl/pipelines_test.go +++ b/utils/pl/pipelines_test.go @@ -22,7 +22,7 @@ var _ = Describe("Pipeline", func() { Context("happy path", func() { It("calls the 'transform' function and returns values and errors", func() { inC := make(chan int, 4) - for i := 0; i < 4; i++ { + for i := range 4 { inC <- i } close(inC) @@ -48,7 +48,7 @@ var _ = Describe("Pipeline", func() { const numJobs = 100 It("starts multiple workers, respecting the limit", func() { inC := make(chan int, numJobs) - for i := 0; i < numJobs; i++ { + for i := range numJobs { inC <- i } close(inC) @@ -94,7 +94,7 @@ var _ = Describe("Pipeline", func() { BeforeEach(func() { in1 = make(chan int, 4) in2 = make(chan int, 4) - for i := 0; i < 4; i++ { + for i := range 4 { in1 <- i in2 <- i + 4 } @@ -126,7 +126,7 @@ var _ = Describe("Pipeline", func() { It("copies them to its output channel", func() { in := make(chan int) out := pl.ReadOrDone(context.Background(), in) - for i := 0; i < 4; i++ { + for i := range 4 { in <- i j := <-out Expect(i).To(Equal(j)) diff --git a/utils/random/number.go b/utils/random/number.go index 80c242c38..e93344c19 100644 --- a/utils/random/number.go +++ b/utils/random/number.go @@ -5,12 +5,12 @@ import ( "encoding/binary" "math/big" - "golang.org/x/exp/constraints" + "github.com/navidrome/navidrome/utils/number" ) // Int64N returns a random int64 between 0 and max. // This is a reimplementation of math/rand/v2.Int64N using a cryptographically secure random number generator. -func Int64N[T constraints.Integer](max T) int64 { +func Int64N[T number.Integer](max T) int64 { rnd, _ := rand.Int(rand.Reader, big.NewInt(int64(max))) return rnd.Int64() } diff --git a/utils/random/number_test.go b/utils/random/number_test.go index b591ae257..985a39426 100644 --- a/utils/random/number_test.go +++ b/utils/random/number_test.go @@ -16,7 +16,7 @@ func TestRandom(t *testing.T) { var _ = Describe("number package", func() { Describe("Int64N", func() { It("should return a random int64", func() { - for i := 0; i < 10000; i++ { + for range 10000 { Expect(random.Int64N(100)).To(BeNumerically("<", 100)) } }) diff --git a/utils/random/weighted_random_chooser_test.go b/utils/random/weighted_random_chooser_test.go index 026ee92cd..b336e6ca6 100644 --- a/utils/random/weighted_random_chooser_test.go +++ b/utils/random/weighted_random_chooser_test.go @@ -9,7 +9,7 @@ var _ = Describe("WeightedChooser", func() { var w *WeightedChooser[int] BeforeEach(func() { w = NewWeightedChooser[int]() - for i := 0; i < 10; i++ { + for i := range 10 { w.Add(i, i+1) } }) @@ -23,7 +23,7 @@ var _ = Describe("WeightedChooser", func() { It("removes items", func() { Expect(w.Size()).To(Equal(10)) - for i := 0; i < 10; i++ { + for range 10 { Expect(w.Remove(0)).To(Succeed()) } Expect(w.Size()).To(Equal(0)) @@ -43,7 +43,7 @@ var _ = Describe("WeightedChooser", func() { }) It("returns all items from the list", func() { - for i := 0; i < 10; i++ { + for range 10 { Expect(w.Pick()).To(BeElementOf(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)) } Expect(w.Size()).To(Equal(0)) @@ -61,11 +61,11 @@ var _ = Describe("WeightedChooser", func() { It("chooses based on weights", func() { counts := [10]int{} - for i := 0; i < 200000; i++ { + for range 200000 { c, _ := w.weightedChoice() counts[c] = counts[c] + 1 } - for i := 0; i < 9; i++ { + for i := range 9 { Expect(counts[i]).To(BeNumerically("<", counts[i+1])) } }) diff --git a/utils/req/req.go b/utils/req/req.go index cf498f322..2757fc3f5 100644 --- a/utils/req/req.go +++ b/utils/req/req.go @@ -35,6 +35,23 @@ func (r *Values) String(param string) (string, error) { return v, nil } +func (r *Values) StringPtr(param string) *string { + var v *string + if _, exists := r.URL.Query()[param]; exists { + v = new(r.URL.Query().Get(param)) + } + return v +} + +func (r *Values) BoolPtr(param string) *bool { + var v *bool + if _, exists := r.URL.Query()[param]; exists { + s := r.URL.Query().Get(param) + v = new(strings.Contains("/true/on/1/", "/"+strings.ToLower(s)+"/")) + } + return v +} + func (r *Values) StringOr(param, def string) string { v, _ := r.String(param) if v == "" { @@ -151,3 +168,15 @@ func (r *Values) BoolOr(param string, def bool) bool { } return v } + +func (r *Values) Float64Or(param string, def float64) float64 { + v, err := r.String(param) + if err != nil { + return def + } + f, err := strconv.ParseFloat(v, 64) + if err != nil { + return def + } + return f +} diff --git a/utils/req/req_test.go b/utils/req/req_test.go index 041aca220..d76b3b934 100644 --- a/utils/req/req_test.go +++ b/utils/req/req_test.go @@ -219,4 +219,76 @@ var _ = Describe("Request Helpers", func() { }) }) }) + + Describe("ParamStringPtr", func() { + BeforeEach(func() { + r = req.Params(httptest.NewRequest("GET", "/ping?a=123", nil)) + }) + + It("returns pointer to string if param exists", func() { + ptr := r.StringPtr("a") + Expect(ptr).ToNot(BeNil()) + Expect(*ptr).To(Equal("123")) + }) + + It("returns nil if param does not exist", func() { + ptr := r.StringPtr("xx") + Expect(ptr).To(BeNil()) + }) + + It("returns pointer to empty string if param exists but is empty", func() { + r = req.Params(httptest.NewRequest("GET", "/ping?a=", nil)) + ptr := r.StringPtr("a") + Expect(ptr).ToNot(BeNil()) + Expect(*ptr).To(Equal("")) + }) + }) + + Describe("Float64Or", func() { + It("returns parsed float value", func() { + r := req.Params(httptest.NewRequest("GET", "/test?rate=1.5", nil)) + Expect(r.Float64Or("rate", 1.0)).To(Equal(1.5)) + }) + + It("returns default when param is missing", func() { + r := req.Params(httptest.NewRequest("GET", "/test", nil)) + Expect(r.Float64Or("rate", 1.0)).To(Equal(1.0)) + }) + + It("returns default when param is not a valid float", func() { + r := req.Params(httptest.NewRequest("GET", "/test?rate=abc", nil)) + Expect(r.Float64Or("rate", 1.0)).To(Equal(1.0)) + }) + }) + + Describe("ParamBoolPtr", func() { + Context("value is true", func() { + BeforeEach(func() { + r = req.Params(httptest.NewRequest("GET", "/ping?b=true", nil)) + }) + + It("returns pointer to true if param is 'true'", func() { + ptr := r.BoolPtr("b") + Expect(ptr).ToNot(BeNil()) + Expect(*ptr).To(BeTrue()) + }) + }) + + Context("value is false", func() { + BeforeEach(func() { + r = req.Params(httptest.NewRequest("GET", "/ping?b=false", nil)) + }) + + It("returns pointer to false if param is 'false'", func() { + ptr := r.BoolPtr("b") + Expect(ptr).ToNot(BeNil()) + Expect(*ptr).To(BeFalse()) + }) + }) + + It("returns nil if param does not exist", func() { + ptr := r.BoolPtr("xx") + Expect(ptr).To(BeNil()) + }) + }) }) diff --git a/utils/chain/chain.go b/utils/run/run.go similarity index 68% rename from utils/chain/chain.go rename to utils/run/run.go index b93dbd93d..182eec42c 100644 --- a/utils/chain/chain.go +++ b/utils/run/run.go @@ -1,11 +1,11 @@ -package chain +package run import "golang.org/x/sync/errgroup" -// RunSequentially runs the given functions sequentially, +// Sequentially runs the given functions sequentially, // If any function returns an error, it stops the execution and returns that error. // If all functions return nil, it returns nil. -func RunSequentially(fs ...func() error) error { +func Sequentially(fs ...func() error) error { for _, f := range fs { if err := f(); err != nil { return err @@ -14,9 +14,9 @@ func RunSequentially(fs ...func() error) error { return nil } -// RunParallel runs the given functions in parallel, +// Parallel runs the given functions in parallel, // It waits for all functions to finish and returns the first error encountered. -func RunParallel(fs ...func() error) func() error { +func Parallel(fs ...func() error) func() error { return func() error { g := errgroup.Group{} for _, f := range fs { diff --git a/utils/run/run_test.go b/utils/run/run_test.go new file mode 100644 index 000000000..07d2d3994 --- /dev/null +++ b/utils/run/run_test.go @@ -0,0 +1,171 @@ +package run_test + +import ( + "errors" + "sync/atomic" + "testing" + "time" + + "github.com/navidrome/navidrome/utils/run" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestRun(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Run Suite") +} + +var _ = Describe("Sequentially", func() { + It("should return nil if no functions are provided", func() { + err := run.Sequentially() + Expect(err).To(BeNil()) + }) + + It("should return nil if all functions succeed", func() { + err := run.Sequentially( + func() error { return nil }, + func() error { return nil }, + ) + Expect(err).To(BeNil()) + }) + + It("should return the error from the first failing function", func() { + expectedErr := errors.New("error in function 2") + err := run.Sequentially( + func() error { return nil }, + func() error { return expectedErr }, + func() error { return errors.New("error in function 3") }, + ) + Expect(err).To(Equal(expectedErr)) + }) + + It("should not run functions after the first failing function", func() { + expectedErr := errors.New("error in function 1") + var runCount int + err := run.Sequentially( + func() error { runCount++; return expectedErr }, + func() error { runCount++; return nil }, + ) + Expect(err).To(Equal(expectedErr)) + Expect(runCount).To(Equal(1)) + }) +}) + +var _ = Describe("Parallel", func() { + It("should return a function that returns nil if no functions are provided", func() { + parallelFunc := run.Parallel() + err := parallelFunc() + Expect(err).To(BeNil()) + }) + + It("should return a function that returns nil if all functions succeed", func() { + parallelFunc := run.Parallel( + func() error { return nil }, + func() error { return nil }, + func() error { return nil }, + ) + err := parallelFunc() + Expect(err).To(BeNil()) + }) + + It("should return the first error encountered when functions fail", func() { + expectedErr := errors.New("parallel error") + parallelFunc := run.Parallel( + func() error { return nil }, + func() error { return expectedErr }, + func() error { return errors.New("another error") }, + ) + err := parallelFunc() + Expect(err).To(HaveOccurred()) + // Note: We can't guarantee which error will be returned first in parallel execution + // but we can ensure an error is returned + }) + + It("should run all functions in parallel", func() { + var runCount atomic.Int32 + sync := make(chan struct{}) + + parallelFunc := run.Parallel( + func() error { + runCount.Add(1) + <-sync + runCount.Add(-1) + return nil + }, + func() error { + runCount.Add(1) + <-sync + runCount.Add(-1) + return nil + }, + func() error { + runCount.Add(1) + <-sync + runCount.Add(-1) + return nil + }, + ) + + // Run the parallel function in a goroutine + go func() { + Expect(parallelFunc()).To(Succeed()) + }() + + // Wait for all functions to start running + Eventually(func() int32 { return runCount.Load() }).Should(Equal(int32(3))) + + // Release the functions to complete + close(sync) + + // Wait for all functions to finish + Eventually(func() int32 { return runCount.Load() }).Should(Equal(int32(0))) + }) + + It("should wait for all functions to complete before returning", func() { + var completedCount atomic.Int32 + + parallelFunc := run.Parallel( + func() error { + completedCount.Add(1) + return nil + }, + func() error { + completedCount.Add(1) + return nil + }, + func() error { + completedCount.Add(1) + return nil + }, + ) + + Expect(parallelFunc()).To(Succeed()) + Expect(completedCount.Load()).To(Equal(int32(3))) + }) + + It("should return an error even if other functions are still running", func() { + expectedErr := errors.New("fast error") + var slowFunctionCompleted bool + + parallelFunc := run.Parallel( + func() error { + return expectedErr // Return error immediately + }, + func() error { + time.Sleep(50 * time.Millisecond) // Slow function + slowFunctionCompleted = true + return nil + }, + ) + + start := time.Now() + err := parallelFunc() + duration := time.Since(start) + + Expect(err).To(HaveOccurred()) + // Should wait for all functions to complete, even if one fails early + Expect(duration).To(BeNumerically(">=", 50*time.Millisecond)) + Expect(slowFunctionCompleted).To(BeTrue()) + }) +}) diff --git a/utils/shellquote/shellquote.go b/utils/shellquote/shellquote.go new file mode 100644 index 000000000..685e3c2a7 --- /dev/null +++ b/utils/shellquote/shellquote.go @@ -0,0 +1,115 @@ +package shellquote + +import ( + "errors" + "strings" +) + +var ( + ErrUnterminatedSingleQuote = errors.New("unterminated single-quoted string") + ErrUnterminatedDoubleQuote = errors.New("unterminated double-quoted string") + ErrUnterminatedEscape = errors.New("unterminated backslash-escape") +) + +type state int + +const ( + stateUnquoted state = iota + stateSingleQuoted + stateDoubleQuoted +) + +// Split splits a string into words following POSIX-like shell quoting rules. +// It handles single quotes, double quotes, and backslash escapes. +func Split(input string) ([]string, error) { + var words []string + var word strings.Builder + inWord := false + parseState := stateUnquoted + + i := 0 + for i < len(input) { + ch := input[i] + + switch parseState { + case stateUnquoted: + switch { + case ch == '\\': + if i+1 >= len(input) { + return nil, ErrUnterminatedEscape + } + if input[i+1] == '\n' { + // Line continuation: skip both backslash and newline + i += 2 + continue + } + i++ + word.WriteByte(input[i]) + inWord = true + case ch == '\'': + parseState = stateSingleQuoted + inWord = true + case ch == '"': + parseState = stateDoubleQuoted + inWord = true + case ch == ' ' || ch == '\t' || ch == '\n': + if inWord { + words = append(words, word.String()) + word.Reset() + inWord = false + } + default: + word.WriteByte(ch) + inWord = true + } + + case stateSingleQuoted: + if ch == '\'' { + parseState = stateUnquoted + } else { + word.WriteByte(ch) + } + + case stateDoubleQuoted: + switch { + case ch == '"': + parseState = stateUnquoted + case ch == '\\': + if i+1 >= len(input) { + return nil, ErrUnterminatedEscape + } + next := input[i+1] + // In double quotes, backslash only escapes: $ ` " \n \ + if next == '$' || next == '`' || next == '"' || next == '\n' || next == '\\' { + if next == '\n' { + // Line continuation: skip both backslash and newline + i += 2 + continue + } + i++ + word.WriteByte(next) + } else { + // Backslash is literal for other characters + word.WriteByte(ch) + } + default: + word.WriteByte(ch) + } + } + + i++ + } + + switch parseState { + case stateSingleQuoted: + return nil, ErrUnterminatedSingleQuote + case stateDoubleQuoted: + return nil, ErrUnterminatedDoubleQuote + } + + if inWord { + words = append(words, word.String()) + } + + return words, nil +} diff --git a/utils/shellquote/shellquote_test.go b/utils/shellquote/shellquote_test.go new file mode 100644 index 000000000..889b83a5f --- /dev/null +++ b/utils/shellquote/shellquote_test.go @@ -0,0 +1,200 @@ +package shellquote_test + +import ( + "testing" + + "github.com/navidrome/navidrome/utils/shellquote" + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" +) + +func TestShellquote(t *testing.T) { + RegisterFailHandler(Fail) + RunSpecs(t, "Shellquote Suite") +} + +var _ = Describe("Split", func() { + It("splits simple space-separated words", func() { + words, err := shellquote.Split("a b c") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"a", "b", "c"})) + }) + + It("handles multiple spaces between words", func() { + words, err := shellquote.Split("a b") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"a", "b"})) + }) + + It("handles single-quoted strings", func() { + words, err := shellquote.Split("'hello world'") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("handles double-quoted strings", func() { + words, err := shellquote.Split(`"hello world"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("handles backslash escapes in unquoted mode", func() { + words, err := shellquote.Split(`hello\ world`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("handles escaped quotes inside double quotes", func() { + words, err := shellquote.Split(`"hello \" world"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`hello " world`})) + }) + + It("handles mixed quoting in a single argument", func() { + words, err := shellquote.Split("he'llo wo'rld") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"hello world"})) + }) + + It("returns empty slice for empty input", func() { + words, err := shellquote.Split("") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(BeEmpty()) + }) + + It("returns empty slice for whitespace-only input", func() { + words, err := shellquote.Split(" ") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(BeEmpty()) + }) + + It("returns error for unterminated single quote", func() { + _, err := shellquote.Split("'hello") + Expect(err).To(MatchError(shellquote.ErrUnterminatedSingleQuote)) + }) + + It("returns error for unterminated double quote", func() { + _, err := shellquote.Split(`"hello`) + Expect(err).To(MatchError(shellquote.ErrUnterminatedDoubleQuote)) + }) + + It("returns error for unterminated escape", func() { + _, err := shellquote.Split(`hello\`) + Expect(err).To(MatchError(shellquote.ErrUnterminatedEscape)) + }) + + It("handles tabs and newlines as delimiters", func() { + words, err := shellquote.Split("a\tb\nc") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"a", "b", "c"})) + }) + + It("parses the default MPV command template", func() { + words, err := shellquote.Split("mpv --audio-device=%d --no-audio-display --pause %f --input-ipc-server=%s") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(HaveLen(6)) + Expect(words).To(Equal([]string{ + "mpv", + "--audio-device=%d", + "--no-audio-display", + "--pause", + "%f", + "--input-ipc-server=%s", + })) + }) + + It("preserves spaces in quoted paths", func() { + words, err := shellquote.Split(`--ao-pcm-file="/audio/my folder/file"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`--ao-pcm-file=/audio/my folder/file`})) + }) + + It("handles backslash in double quotes for special chars", func() { + words, err := shellquote.Split(`"hello\\world"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`hello\world`})) + }) + + It("preserves backslash in double quotes for non-special chars", func() { + words, err := shellquote.Split(`"hello\nworld"`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{`hello\nworld`})) + }) + + It("handles escaped newline in double quotes", func() { + words, err := shellquote.Split("\"hello\\\nworld\"") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"helloworld"})) + }) + + // Cases from original go-shellquote test suite + It("handles shell glob characters as literals", func() { + words, err := shellquote.Split("glob* test?") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"glob*", "test?"})) + }) + + It("handles backslash-escaped special characters", func() { + words, err := shellquote.Split("don\\'t you know the dewey decimal system\\?") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"don't", "you", "know", "the", "dewey", "decimal", "system?"})) + }) + + It("handles single-quote escape idiom", func() { + // Shell idiom: end single-quote, escaped literal quote, start single-quote again + words, err := shellquote.Split("'don'\\''t you know the dewey decimal system?'") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"don't you know the dewey decimal system?"})) + }) + + It("handles empty string argument via quotes", func() { + words, err := shellquote.Split("one '' two") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"one", "", "two"})) + }) + + It("handles backslash-newline joining words in unquoted mode", func() { + words, err := shellquote.Split("text with\\\na backslash-escaped newline") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"text", "witha", "backslash-escaped", "newline"})) + }) + + It("handles quoted newline inside double quotes", func() { + words, err := shellquote.Split("text \"with\na\" quoted newline") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"text", "with\na", "quoted", "newline"})) + }) + + It("handles complex double-quoted escapes with backslash-newline", func() { + words, err := shellquote.Split("\"quoted\\d\\\\\\\" text with\\\na backslash-escaped newline\"") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"quoted\\d\\\" text witha backslash-escaped newline"})) + }) + + It("handles backslash-newline between words", func() { + words, err := shellquote.Split("text with an escaped \\\n newline in the middle") + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"text", "with", "an", "escaped", "newline", "in", "the", "middle"})) + }) + + It("handles double-quoted substring concatenation", func() { + words, err := shellquote.Split(`foo"bar"baz`) + Expect(err).ToNot(HaveOccurred()) + Expect(words).To(Equal([]string{"foobarbaz"})) + }) + + It("returns error for unterminated quote after escape idiom", func() { + _, err := shellquote.Split("'test'\\''ing") + Expect(err).To(MatchError(shellquote.ErrUnterminatedSingleQuote)) + }) + + It("returns error for unterminated double quote with single quote inside", func() { + _, err := shellquote.Split("\"foo'bar") + Expect(err).To(MatchError(shellquote.ErrUnterminatedDoubleQuote)) + }) + + It("returns error for unterminated escape with leading whitespace", func() { + _, err := shellquote.Split(" \\") + Expect(err).To(MatchError(shellquote.ErrUnterminatedEscape)) + }) +}) diff --git a/utils/singleton/singleton.go b/utils/singleton/singleton.go index 7f5c6a4e0..83f8c53ab 100644 --- a/utils/singleton/singleton.go +++ b/utils/singleton/singleton.go @@ -9,36 +9,61 @@ import ( ) var ( - instances = make(map[string]any) + instances = map[string]any{} + pending = map[string]chan struct{}{} lock sync.RWMutex ) -// GetInstance returns an existing instance of object. If it is not yet created, calls `constructor`, stores the -// result for future calls and returns it func GetInstance[T any](constructor func() T) T { var v T name := reflect.TypeOf(v).String() - v, available := func() (T, bool) { + // First check with read lock + lock.RLock() + if instance, ok := instances[name]; ok { + defer lock.RUnlock() + return instance.(T) + } + lock.RUnlock() + + // Now check if someone is already creating this type + lock.Lock() + + // Check again with the write lock - someone might have created it + if instance, ok := instances[name]; ok { + lock.Unlock() + return instance.(T) + } + + // Check if creation is pending + wait, isPending := pending[name] + if !isPending { + // We'll be the one creating it + pending[name] = make(chan struct{}) + wait = pending[name] + } + lock.Unlock() + + // If someone else is creating it, wait for them + if isPending { + <-wait // Wait for creation to complete + + // Now it should be in the instances map lock.RLock() defer lock.RUnlock() - v, available := instances[name].(T) - return v, available - }() - - if available { - return v + return instances[name].(T) } + // We're responsible for creating the instance + newInstance := constructor() + + // Store it and signal other goroutines lock.Lock() - defer lock.Unlock() - v, available = instances[name].(T) - if available { - return v - } + instances[name] = newInstance + close(wait) // Signal that creation is complete + delete(pending, name) // Clean up + log.Trace("Created new singleton", "type", name, "instance", fmt.Sprintf("%+v", newInstance)) + lock.Unlock() - v = constructor() - log.Trace("Created new singleton", "type", name, "instance", fmt.Sprintf("%+v", v)) - instances[name] = v - return v + return newInstance } diff --git a/utils/singleton/singleton_test.go b/utils/singleton/singleton_test.go index c58bafd93..08e635652 100644 --- a/utils/singleton/singleton_test.go +++ b/utils/singleton/singleton_test.go @@ -69,7 +69,7 @@ var _ = Describe("GetInstance", func() { done.Add(numCallsToDo) numInstancesCreated = 0 - for i := 0; i < numCallsToDo; i++ { + for range numCallsToDo { go func() { // This is needed to make sure the test does not hang if it fails defer GinkgoRecover() diff --git a/utils/slice/slice.go b/utils/slice/slice.go index 1d7c64f50..e87ac5388 100644 --- a/utils/slice/slice.go +++ b/utils/slice/slice.go @@ -6,9 +6,8 @@ import ( "cmp" "io" "iter" + "maps" "slices" - - "golang.org/x/exp/maps" ) func Map[T any, R any](t []T, mapFunc func(T) R) []R { @@ -49,11 +48,9 @@ func CompactByFrequency[T comparable](list []T) []T { counters[item]++ } - sorted := maps.Keys(counters) - slices.SortFunc(sorted, func(i, j T) int { + return slices.SortedFunc(maps.Keys(counters), func(i, j T) int { return cmp.Compare(counters[j], counters[i]) }) - return sorted } func MostFrequent[T comparable](list []T) T { @@ -171,3 +168,14 @@ func SeqFunc[I, O any](s []I, f func(I) O) iter.Seq[O] { } } } + +// Filter returns a new slice containing only the elements of s for which filterFunc returns true +func Filter[T any](s []T, filterFunc func(T) bool) []T { + var result []T + for _, item := range s { + if filterFunc(item) { + result = append(result, item) + } + } + return result +} diff --git a/utils/slice/slice_test.go b/utils/slice/slice_test.go index c6d4be1e0..64cb89d53 100644 --- a/utils/slice/slice_test.go +++ b/utils/slice/slice_test.go @@ -134,7 +134,7 @@ var _ = Describe("Slice Utils", func() { count := 0 file, _ := os.Open(path) defer file.Close() - for _ = range slice.LinesFrom(file) { + for range slice.LinesFrom(file) { count++ } Expect(count).To(Equal(expected)) @@ -172,4 +172,42 @@ var _ = Describe("Slice Utils", func() { Expect(result).To(ConsistOf("2", "4", "6", "8")) }) }) + + Describe("Filter", func() { + It("returns empty slice for an empty input", func() { + filterFunc := func(v int) bool { return v > 0 } + result := slice.Filter([]int{}, filterFunc) + Expect(result).To(BeEmpty()) + }) + + It("returns all elements when filter matches all", func() { + filterFunc := func(v int) bool { return v > 0 } + result := slice.Filter([]int{1, 2, 3, 4}, filterFunc) + Expect(result).To(HaveExactElements(1, 2, 3, 4)) + }) + + It("returns empty slice when filter matches none", func() { + filterFunc := func(v int) bool { return v > 10 } + result := slice.Filter([]int{1, 2, 3, 4}, filterFunc) + Expect(result).To(BeEmpty()) + }) + + It("returns only matching elements", func() { + filterFunc := func(v int) bool { return v%2 == 0 } + result := slice.Filter([]int{1, 2, 3, 4, 5, 6}, filterFunc) + Expect(result).To(HaveExactElements(2, 4, 6)) + }) + + It("works with string slices", func() { + filterFunc := func(s string) bool { return len(s) > 3 } + result := slice.Filter([]string{"a", "abc", "abcd", "ab", "abcde"}, filterFunc) + Expect(result).To(HaveExactElements("abcd", "abcde")) + }) + + It("preserves order of elements", func() { + filterFunc := func(v int) bool { return v%2 == 1 } + result := slice.Filter([]int{9, 8, 7, 6, 5, 4, 3, 2, 1}, filterFunc) + Expect(result).To(HaveExactElements(9, 7, 5, 3, 1)) + }) + }) }) diff --git a/utils/str/sanitize_strings.go b/utils/str/sanitize_strings.go index ff8b2fb47..11f828270 100644 --- a/utils/str/sanitize_strings.go +++ b/utils/str/sanitize_strings.go @@ -38,11 +38,36 @@ func SanitizeStrings(text ...string) string { var policy = bluemonday.UGCPolicy() +// SanitizeText unescapes the input string before sanitizing it as text. +// This should be used for fields rendered as plain text in the UI (e.g. lyrics, song titles, artist names) func SanitizeText(text string) string { s := policy.Sanitize(text) return html.UnescapeString(s) } +// SanitizeHTML unescapes the input string before sanitizing it as HTML. +// This should be used for fields rendered as HTML by clients (e.g. biographies, welcome messages) +// to prevent XSS bypasses via entity-encoded tags. +func SanitizeHTML(text string) string { + return policy.Sanitize(html.UnescapeString(text)) +} + +var filenameReplacer = strings.NewReplacer( + "/", "_", + "\\", "_", + ":", "_", + "*", "_", + "?", "_", + "\"", "_", + "<", "_", + ">", "_", + "|", "_", +) + +func SanitizeFilename(name string) string { + return filenameReplacer.Replace(name) +} + func SanitizeFieldForSorting(originalValue string) string { v := strings.TrimSpace(sanitize.Accents(originalValue)) return Clear(strings.ToLower(v)) @@ -54,8 +79,8 @@ func SanitizeFieldForSortingNoArticle(originalValue string) string { } func RemoveArticle(name string) string { - articles := strings.Split(conf.Server.IgnoredArticles, " ") - for _, a := range articles { + articles := strings.SplitSeq(conf.Server.IgnoredArticles, " ") + for a := range articles { n := strings.TrimPrefix(name, a+" ") if n != name { return n diff --git a/utils/str/sanitize_strings_test.go b/utils/str/sanitize_strings_test.go index ac28fe435..6527f326b 100644 --- a/utils/str/sanitize_strings_test.go +++ b/utils/str/sanitize_strings_test.go @@ -64,6 +64,35 @@ var _ = Describe("Sanitize Strings", func() { }) }) + Describe("SanitizeText", func() { + It("preserves decoded plaintext", func() { + Expect(str.SanitizeText("Tom & Jerry")).To(Equal("Tom & Jerry")) + Expect(str.SanitizeText("Tom & Jerry")).To(Equal("Tom & Jerry")) + }) + + It("keeps entity-encoded html readable", func() { + Expect(str.SanitizeText(`<b>ok</b>`)).To(Equal("<b>ok</b>")) + }) + }) + + Describe("SanitizeHTML", func() { + It("removes dangerous content from raw html", func() { + sanitized := str.SanitizeHTML(`<img src=x onerror=alert(1)><script>alert(2)</script><b>ok</b>`) + + Expect(sanitized).To(ContainSubstring("<b>ok</b>")) + Expect(sanitized).ToNot(ContainSubstring("onerror")) + Expect(sanitized).ToNot(ContainSubstring("<script")) + }) + + It("removes dangerous content from entity-encoded html", func() { + sanitized := str.SanitizeHTML(`<img src=x onerror=alert(1)><script>alert(2)</script><b>ok</b>`) + + Expect(sanitized).To(ContainSubstring("<b>ok</b>")) + Expect(sanitized).ToNot(ContainSubstring("onerror")) + Expect(sanitized).ToNot(ContainSubstring("<script")) + }) + }) + Describe("SanitizeFieldForSortingNoArticle", func() { BeforeEach(func() { conf.Server.IgnoredArticles = "The O" diff --git a/utils/str/str.go b/utils/str/str.go index 8a94488de..177b48191 100644 --- a/utils/str/str.go +++ b/utils/str/str.go @@ -2,6 +2,7 @@ package str import ( "strings" + "unicode/utf8" ) var utf8ToAscii = func() *strings.Replacer { @@ -39,3 +40,22 @@ func LongestCommonPrefix(list []string) string { } return list[0] } + +// TruncateRunes truncates a string to a maximum number of runes, adding a suffix if truncated. +// The suffix is included in the rune count, so if maxRunes is 30 and suffix is "...", the actual +// string content will be truncated to fit within the maxRunes limit including the suffix. +func TruncateRunes(s string, maxRunes int, suffix string) string { + if utf8.RuneCountInString(s) <= maxRunes { + return s + } + + suffixRunes := utf8.RuneCountInString(suffix) + truncateAt := max(maxRunes-suffixRunes, 0) + + runes := []rune(s) + if truncateAt >= len(runes) { + return s + suffix + } + + return string(runes[:truncateAt]) + suffix +} diff --git a/utils/str/str_test.go b/utils/str/str_test.go index 0c3524e4e..511805831 100644 --- a/utils/str/str_test.go +++ b/utils/str/str_test.go @@ -31,6 +31,72 @@ var _ = Describe("String Utils", func() { Expect(str.LongestCommonPrefix(albums)).To(Equal("/artist/album")) }) }) + + Describe("TruncateRunes", func() { + It("returns string unchanged if under max runes", func() { + Expect(str.TruncateRunes("hello", 10, "...")).To(Equal("hello")) + }) + + It("returns string unchanged if exactly at max runes", func() { + Expect(str.TruncateRunes("hello", 5, "...")).To(Equal("hello")) + }) + + It("truncates and adds suffix when over max runes", func() { + Expect(str.TruncateRunes("hello world", 8, "...")).To(Equal("hello...")) + }) + + It("handles unicode characters correctly", func() { + // 6 emoji characters, maxRunes=5, suffix="..." (3 runes) + // So content gets 5-3=2 runes + Expect(str.TruncateRunes("😀😁😂😃😄😅", 5, "...")).To(Equal("😀😁...")) + }) + + It("handles multi-byte UTF-8 characters", func() { + // Characters like é are single runes + Expect(str.TruncateRunes("Café au Lait", 5, "...")).To(Equal("Ca...")) + }) + + It("works with empty suffix", func() { + Expect(str.TruncateRunes("hello world", 5, "")).To(Equal("hello")) + }) + + It("accounts for suffix length in truncation", func() { + // maxRunes=10, suffix="..." (3 runes) -> leaves 7 runes for content + result := str.TruncateRunes("hello world this is long", 10, "...") + Expect(result).To(Equal("hello w...")) + // Verify total rune count is <= maxRunes + runeCount := len([]rune(result)) + Expect(runeCount).To(BeNumerically("<=", 10)) + }) + + It("handles very long suffix gracefully", func() { + // If suffix is longer than maxRunes, we still add it + // but the content will be truncated to 0 + result := str.TruncateRunes("hello world", 5, "... (truncated)") + // Result will be just the suffix (since truncateAt=0) + Expect(result).To(Equal("... (truncated)")) + }) + + It("handles empty string", func() { + Expect(str.TruncateRunes("", 10, "...")).To(Equal("")) + }) + + It("uses custom suffix", func() { + // maxRunes=11, suffix=" [...]" (6 runes) -> content gets 5 runes + // "hello world" is 11 runes exactly, so we need a longer string + Expect(str.TruncateRunes("hello world extra", 11, " [...]")).To(Equal("hello [...]")) + }) + + DescribeTable("truncates at rune boundaries (not byte boundaries)", + func(input string, maxRunes int, suffix string, expected string) { + Expect(str.TruncateRunes(input, maxRunes, suffix)).To(Equal(expected)) + }, + Entry("ASCII", "abcdefghij", 5, "...", "ab..."), + Entry("Mixed ASCII and Unicode", "ab😀cd", 4, ".", "ab😀."), + Entry("All emoji", "😀😁😂😃😄", 3, "…", "😀😁…"), + Entry("Japanese", "こんにちは世界", 3, "…", "こん…"), + ) + }) }) var testPaths = []string{